Documentation & Result Move Constructor (hyrise#39)

Updates documentation, adds a move constructor to SQLParserResult, fixes compile-time warnings

Author: torpedro

Makefile

@@ -4,8 +4,8 @@ SRC        = src
 SRCPARSER  = src/parser
 
 # files
-PARSERFILES = $(SRCPARSER)/bison_parser.cpp $(SRCPARSER)/flex_lexer.cpp
-LIBCPP      = $(shell find $(SRC) -name '*.cpp' -not -path "$(SRCPARSER)/*") $(SRCPARSER)/bison_parser.cpp $(SRCPARSER)/flex_lexer.cpp
+PARSERCPP   = $(SRCPARSER)/bison_parser.cpp $(SRCPARSER)/flex_lexer.cpp
+LIBCPP      = $(shell find $(SRC) -name '*.cpp' -not -path "$(SRCPARSER)/*") $(PARSERCPP)
 LIBOBJ      = $(LIBCPP:%.cpp=%.o)
 TESTCPP     = $(shell find test/ -name '*.cpp')
 
@@ -27,13 +27,16 @@ library: $(TARGET)
 $(TARGET): $(LIBOBJ)
 	$(CXX) $(LIBFLAGS) -o $(TARGET) $(LIBOBJ)
 
-%.o: %.cpp $(PARSERFILES)
+$(SRCPARSER)/flex_lexer.o: $(SRCPARSER)/flex_lexer.cpp
+	$(CXX) $(CFLAGS) -c -o $@ $< -Wno-sign-compare -Wno-unneeded-internal-declaration -Wno-deprecated-register
+
+%.o: %.cpp $(PARSERCPP)
 	$(CXX) $(CFLAGS) -c -o $@ $<
 
-$(SRCPARSER)/bison_parser.cpp:
+$(SRCPARSER)/bison_parser.cpp: $(SRCPARSER)/bison_parser.y
 	make -C $(SRCPARSER)/ bison_parser.cpp
 
-$(SRCPARSER)/flex_lexer.cpp:
+$(SRCPARSER)/flex_lexer.cpp: $(SRCPARSER)/flex_lexer.l
 	make -C $(SRCPARSER)/ flex_lexer.cpp
 
 parser:
@@ -51,6 +54,7 @@ cleanall: clean cleanparser
 
 install:
 	cp $(TARGET) $(INSTALL)/lib/$(TARGET)
+	rm -rf $(INSTALL)/include/hsql
 	cp -r src $(INSTALL)/include/hsql
 	find $(INSTALL)/include/hsql -not -name '*.h' -type f | xargs rm
 

README.md

@@ -1,16 +1,16 @@
-C++ SQL Parser for Hyrise
+C++ SQL Parser
 =========================
 [![GitHub release](https://img.shields.io/github/release/hyrise/sql-parser.svg?maxAge=2592000)]()
 [![Build Status](https://img.shields.io/travis/hyrise/sql-parser.svg?maxAge=2592000)](https://travis-ci.org/hyrise/sql-parser)
 
 
 This is a SQL Parser for C++. It parses the given SQL query into C++ objects.
-It is developed for integration in hyrise (https://github.com/hyrise/hyrise), but can be used in other environments as well.
+It has been developed for integration in [Hyrise](https://github.com/hyrise/hyrise), but can be used perfectly well in other environments as well.
 
 In March 2015 we've also written a short paper outlining discussing some development details and the integration into our database Hyrise. You can find the paper [here](http://torpedro.com/paper/HyriseSQL-03-2015.pdf).
 
 
-### Usage
+## Usage
 
 **Note:** You can also find a detailed usage description at this [blog post](http://torpedro.github.io/tech/c++/sql/parser/2016/02/27/c++-sql-parser.html).
 
@@ -21,52 +21,53 @@ To use the SQL parser in your own projects you simply have to follow these few s
 
  1. Download the [latest release here](https://github.com/hyrise/sql-parser/releases)
  2. Compile the library `make` to create `libsqlparser.so`
- 3. *(Optional)* Run `make install` to copy the library to `/usr/local/lib/`
- 3. Run the tests `make test` to make sure everything worked
- 4. Take a look at the [example project here](https://github.com/hyrise/sql-parser/tree/master/example)
- 5. Include the `SQLParser.h` from `src/` and link the library in your project
-
-
-### Extending the parser
-
-**Requirements for development:**
- * gcc 4.8+ (or clang 3.4+)
- * [bison](https://www.gnu.org/software/bison/) (v3.0.2+)
- * [flex](http://flex.sourceforge.net/) (v2.5.5+)
-
-First step to extending this parser is cloning the repository `git clone [email protected]:hyrise/sql-parser.git` and making sure everything works by running the following steps:
-
-```bash
-make parser   # builds the bison parser and flex lexer
-make library  # builds the libsqlparser.so
-make test     # runs the tests with the library
+ 3. *(Optional, Recommended)* Run `make install` to copy the library to `/usr/local/lib/`
+ 4. Run the tests `make test` to make sure everything worked
+ 5. Include the `SQLParser.h` from `src/` (or from `/usr/local/lib/hsql/` if you installed it) and link the library in your project
+ 6. Take a look at the [example project here](https://github.com/hyrise/sql-parser/tree/master/example)
+
+```cpp
+#include "hsql/SQLParser.h"
+
+/* ... */
+
+{
+    // Basic Usage Example
+    
+    const std::string query = "...";
+    hsql::SQLParserResult result;
+    hsql::SQLParser::parseSQLString(query, &result);
+    
+    if (result.isValid() && result.size() > 0) {
+        const hsql::SQLStatement* statement = result.getStatement(0);
+        
+        if (statement.isType(hsql::SelectStatement)) {
+            const hsql::SelectStatement* select = (const hsql::SelectStatement*) statement;
+            /* ... */
+        }
+    }
+}
 ```
 
-Rerun these steps whenever you change part of the parse. To execute the entire pipeline automatically you can run:
+Quick Links:
 
-```bash
-make cleanall  # cleans the parser build and library build
-make test      # build parser, library and runs the tests
-```
+ * [SQLParser.h](src/SQLParser.h)
+ * [SQLParserResult.h](src/SQLParserResult.h)
+ * [SelectStatement.h](src/sql/SelectStatement.h)
 
+## How to Contribute
 
-#### How to contribute
+**[Developer Documentation](docs/)**
 
 We strongly encourage you to contribute to this project! If you want to contribute to this project there are several options. If you've noticed a bug or would like an improvement let us know by creating a [new issue](https://github.com/hyrise/sql-parser/issues). If you want to develop a new feature yourself or just improve the quality of the system, feel free to fork the reposistory and implement your changes. Open a pull request as soon as your done and we will look over it. If we think it's good then your pull request will be merged into this repository.
 
 
-### Resources
-
- * [Working Syntax Examples](docs/syntax.md)
- * [Developer Documentation](docs/dev-docs.md)
-
-
-### License
+## License
 
 HYRISE sql-parser is licensed as open source after the OpenSource "Licence of the Hasso-Plattner Institute" declared in the LICENSE file of this project.
 
 
-### Contributers
+## Contributers
 
 The following people contributed to HYRISE sql-parser in various forms.
 

docs/README.md

@@ -0,0 +1,15 @@
+Documentation
+=============
+
+Internal Links:
+
+ * [Developer Documentation](dev-docs.md)
+ * [Working SQL Syntax Examples](syntax-examples.md)
+
+
+External Resources:
+
+ * [Original Dev-Paper (2015)](http://torpedro.com/paper/HyriseSQL-03-2015.pdf)
+ * [Blog Post about Basic Usage](http://torpedro.github.io/tech/c++/sql/parser/2016/02/27/c++-sql-parser.html)
+
+

docs/dev-docs.md

@@ -1,6 +1,29 @@
 Developer Documentation
 =======================
 
+## Basic Requirements
+
+**Requirements for development:**
+ * gcc 4.8+ (or clang 3.4+)
+ * [bison](https://www.gnu.org/software/bison/) (v3.0.2+)
+ * [flex](http://flex.sourceforge.net/) (v2.5.5+)
+
+First step to extending this parser is cloning the repository `git clone [email protected]:hyrise/sql-parser.git` and making sure everything works by running the following steps:
+
+```bash
+make parser   # builds the bison parser and flex lexer
+make library  # builds the libsqlparser.so
+make test     # runs the tests with the library
+```
+
+Rerun these steps whenever you change part of the parse. To execute the entire pipeline automatically you can run:
+
+```bash
+make cleanall  # cleans the parser build and library build
+make test      # build parser, library and runs the tests
+```
+
+
 ## Developing New Functionality
 
 This section contains information about how to extend this parser with new functionalities.
@@ -18,7 +41,7 @@ Finally you will need to include your new file in `src/sql/statements.h`.
 ### Extending the Grammar
 
 Related files:
-````
+```
 src/parser/bison_parser.y
 src/parser/flex_lexer.l
 src/parser/keywordlist_generator.py

docs/syntax.md docs/syntax-examples.mddocs/syntax.md renamed to docs/syntax-examples.md

@@ -13,6 +13,16 @@ namespace hsql {
     addStatement(stmt);
   };
 
+  // Move constructor.
+  SQLParserResult::SQLParserResult(SQLParserResult&& moved) {
+    isValid_ = moved.isValid_;
+    errorMsg_ = moved.errorMsg_;
+    statements_ = std::move(moved.statements_);
+
+    moved.errorMsg_ = NULL;
+    moved.reset();
+  }
+
   SQLParserResult::~SQLParserResult() {
     reset();
   }

src/SQLParserResult.cpp

@@ -15,6 +15,9 @@ namespace hsql {
     // Takes ownership of the statement.
     SQLParserResult(SQLStatement* stmt);
 
+    // Move constructor.
+    SQLParserResult(SQLParserResult&& moved);
+
     // Deletes all statements in the result.
     virtual ~SQLParserResult();
 

src/SQLParserResult.h

@@ -1 +1,2 @@
-*.output
+*.output
+conflict_test.cpp

src/parser/.gitignore

@@ -3,7 +3,7 @@ all: bison_parser.cpp flex_lexer.cpp
 
 bison_parser.cpp: bison_parser.y
 	@bison --version | head -n 1
-	bison bison_parser.y -v
+	bison bison_parser.y --output=bison_parser.cpp --defines=bison_parser.h --verbose
 
 flex_lexer.cpp: flex_lexer.l
 	@flex --version
@@ -14,4 +14,4 @@ clean:
 
 # Tests if the parser builds correctly and doesn't contain conflicts.
 test:
-	! bison bison_parser.y -v 2>&1 | grep "conflict" >&2
+	! bison bison_parser.y -v --output=conflict_test.cpp 2>&1 | grep "conflict" >&2

src/parser/Makefile

@@ -2558,7 +2558,7 @@ YYLTYPE yylloc = yyloc_default;
   case 20:
 #line 315 "bison_parser.y" /* yacc.c:1646  */
     {
-			(yyval.import_stmt) = new ImportStatement((ImportStatement::ImportType) (yyvsp[-4].uval));
+			(yyval.import_stmt) = new ImportStatement((ImportType) (yyvsp[-4].uval));
 			(yyval.import_stmt)->filePath = (yyvsp[-2].sval);
 			(yyval.import_stmt)->tableName = (yyvsp[0].sval);
 		}
@@ -2567,7 +2567,7 @@ YYLTYPE yylloc = yyloc_default;
 
   case 21:
 #line 323 "bison_parser.y" /* yacc.c:1646  */
-    { (yyval.uval) = ImportStatement::kImportCSV; }
+    { (yyval.uval) = kImportCSV; }
 #line 2572 "bison_parser.cpp" /* yacc.c:1646  */
     break;
 
@@ -2580,7 +2580,7 @@ YYLTYPE yylloc = yyloc_default;
   case 23:
 #line 337 "bison_parser.y" /* yacc.c:1646  */
     {
-			(yyval.create_stmt) = new CreateStatement(CreateStatement::kTableFromTbl);
+			(yyval.create_stmt) = new CreateStatement(kCreateTableFromTbl);
 			(yyval.create_stmt)->ifNotExists = (yyvsp[-5].bval);
 			(yyval.create_stmt)->tableName = (yyvsp[-4].sval);
 			(yyval.create_stmt)->filePath = (yyvsp[0].sval);
@@ -2591,7 +2591,7 @@ YYLTYPE yylloc = yyloc_default;
   case 24:
 #line 343 "bison_parser.y" /* yacc.c:1646  */
     {
-			(yyval.create_stmt) = new CreateStatement(CreateStatement::kTable);
+			(yyval.create_stmt) = new CreateStatement(kCreateTable);
 			(yyval.create_stmt)->ifNotExists = (yyvsp[-4].bval);
 			(yyval.create_stmt)->tableName = (yyvsp[-3].sval);
 			(yyval.create_stmt)->columns = (yyvsp[-1].column_vec);
@@ -2602,7 +2602,7 @@ YYLTYPE yylloc = yyloc_default;
   case 25:
 #line 349 "bison_parser.y" /* yacc.c:1646  */
     {
-			(yyval.create_stmt) = new CreateStatement(CreateStatement::kView);
+			(yyval.create_stmt) = new CreateStatement(kCreateView);
 			(yyval.create_stmt)->ifNotExists = (yyvsp[-4].bval);
 			(yyval.create_stmt)->tableName = (yyvsp[-3].sval);
 			(yyval.create_stmt)->viewColumns = (yyvsp[-2].str_vec);
@@ -2670,7 +2670,7 @@ YYLTYPE yylloc = yyloc_default;
   case 35:
 #line 389 "bison_parser.y" /* yacc.c:1646  */
     {
-			(yyval.drop_stmt) = new DropStatement(DropStatement::kTable);
+			(yyval.drop_stmt) = new DropStatement(kDropTable);
 			(yyval.drop_stmt)->name = (yyvsp[0].sval);
 		}
 #line 2677 "bison_parser.cpp" /* yacc.c:1646  */
@@ -2679,7 +2679,7 @@ YYLTYPE yylloc = yyloc_default;
   case 36:
 #line 393 "bison_parser.y" /* yacc.c:1646  */
     {
-			(yyval.drop_stmt) = new DropStatement(DropStatement::kView);
+			(yyval.drop_stmt) = new DropStatement(kDropView);
 			(yyval.drop_stmt)->name = (yyvsp[0].sval);
 		}
 #line 2686 "bison_parser.cpp" /* yacc.c:1646  */
@@ -2688,7 +2688,7 @@ YYLTYPE yylloc = yyloc_default;
   case 37:
 #line 397 "bison_parser.y" /* yacc.c:1646  */
     {
-			(yyval.drop_stmt) = new DropStatement(DropStatement::kPreparedStatement);
+			(yyval.drop_stmt) = new DropStatement(kDropPreparedStatement);
 			(yyval.drop_stmt)->name = (yyvsp[0].sval);
 		}
 #line 2695 "bison_parser.cpp" /* yacc.c:1646  */
@@ -2716,7 +2716,7 @@ YYLTYPE yylloc = yyloc_default;
   case 40:
 #line 429 "bison_parser.y" /* yacc.c:1646  */
     {
-			(yyval.insert_stmt) = new InsertStatement(InsertStatement::kInsertValues);
+			(yyval.insert_stmt) = new InsertStatement(kInsertValues);
 			(yyval.insert_stmt)->tableName = (yyvsp[-5].sval);
 			(yyval.insert_stmt)->columns = (yyvsp[-4].str_vec);
 			(yyval.insert_stmt)->values = (yyvsp[-1].expr_vec);
@@ -2727,7 +2727,7 @@ YYLTYPE yylloc = yyloc_default;
   case 41:
 #line 435 "bison_parser.y" /* yacc.c:1646  */
     {
-			(yyval.insert_stmt) = new InsertStatement(InsertStatement::kInsertSelect);
+			(yyval.insert_stmt) = new InsertStatement(kInsertSelect);
 			(yyval.insert_stmt)->tableName = (yyvsp[-2].sval);
 			(yyval.insert_stmt)->columns = (yyvsp[-1].str_vec);
 			(yyval.insert_stmt)->select = (yyvsp[0].select_stmt);