added doxygen documentation

Author: torpedro

Makefile

@@ -0,0 +1,17 @@
+
+
+test:
+	@echo "Compiling..."
+	@make clean -C src/ >/dev/null || exit 1
+	@make tests -C src/ >/dev/null || exit 1
+	@make grammar_test -C src/ >/dev/null || exit 1
+	@echo "Running tests:"
+	@./bin/grammar_test -f "test/valid_queries.sql"
+	@./bin/tests
+
+
+docs: FORCE
+	doxygen docs/doxy.conf
+
+
+FORCE:

docs/.gitignore

@@ -0,0 +1 @@
+__doxygen__/

docs/documentation.md

@@ -0,0 +1,21 @@
+# Developer Documentation
+
+This page contains information about how to extend this parser with new functionalities.
+
+
+
+## Extending the Grammar
+
+TODO
+
+
+## Implementing Statement Class
+
+TODO
+
+
+## Implementing Tests
+
+TODO
+
+

docs/doxy.conf

@@ -0,0 +1,14 @@
+@PROJECT_NAME = "SQL Parser for Hyrise (C++)"
+
+@OUTPUT_DIRECTORY = docs/__doxygen__/
+@GENERATE_LATEX = NO
+@GENERATE_HTML = YES
+
+@INPUT = 	README.md \
+			docs/ \
+			src/parser/SQLParser.h \
+			src/parser/SQLParser.cpp \
+			src/lib/ \
+
+
+@RECURSIVE = YES

run_tests.sh

@@ -24,6 +24,10 @@ typedef enum {
 
 typedef struct Expr Expr;
 
+/** 
+ * @class Expr
+ * @brief Represents SQL expressions (i.e. literals, operators, column_refs)
+ */
 struct Expr {
 	/**
 	 * Operator types. These are important for expressions of type kExprOperator

src/lib/Expr.h

@@ -8,6 +8,10 @@ namespace hsql {
 
 // TODO: try to replace the List wrapper by directly using std::vector
 
+/**
+ * @class List
+ * @brief Classed interface to std::vector (may be replaced with std::vector)
+ */
 template <typename _T>
 class List {
 public:

src/lib/List.h

@@ -9,9 +9,10 @@ struct SelectStatement;
 struct JoinDefinition;
 struct TableRef;
 
+
 /**
- * TableRef
- * Holds reference to tables. Can be either table names or a select statement.
+ * @enum TableRefType
+ * Types table references
  */
 typedef enum {
 	kTableName,
@@ -21,8 +22,10 @@ typedef enum {
 } TableRefType;
 
 
-
-
+/**
+ * @struct TableRef
+ * @brief Holds reference to tables. Can be either table names or a select statement.
+ */
 struct TableRef {
 	TableRef(TableRefType type) :
 		type(type),
@@ -33,7 +36,12 @@ struct TableRef {
 		list(NULL),
 		join(NULL) {}
 
-	virtual ~TableRef(); // defined in destructors.cpp
+	virtual ~TableRef() {
+		delete name;
+		delete alias;
+		delete select;
+		delete list;
+	}
 
 	TableRefType type;
 
@@ -59,18 +67,20 @@ struct TableRef {
 
 
 /**
- * Following are definitions needed to specify join tables
+ * @enum JoinType
+ * Types of joins
  */ 
-
 typedef enum {
 	kJoinInner,
 	kJoinOuter,
 	kJoinLeft,
 	kJoinRight,
 } JoinType;
 
+
 /**
- * Definition of a join table
+ * @struct JoinDefinition
+ * @brief Definition of a join table
  */
 struct JoinDefinition {
 	JoinDefinition() :
@@ -79,7 +89,11 @@ struct JoinDefinition {
 		condition(NULL),
 		type(kJoinInner) {}
 
-	virtual ~JoinDefinition(); // defined in destructors.cpp
+	virtual ~JoinDefinition() {
+		delete left;
+		delete right;
+		delete condition;
+	}
 
 	TableRef* left;
 	TableRef* right;

src/lib/Table.h

@@ -5,9 +5,9 @@
 
 namespace hsql {
 
-
 /**
  * @struct ColumnDefinition
+ * @brief Represents definition of a table column
  */
 struct ColumnDefinition {
 	enum DataType {
@@ -20,16 +20,18 @@ struct ColumnDefinition {
 		name(name),
 		type(type) {}
 
-	virtual ~ColumnDefinition(); // defined in destructors.cpp
+	virtual ~ColumnDefinition() {
+		delete name;
+	}
 
 	char* name;
 	DataType type;
 };
 
+
 /**
  * @struct CreateStatement
- * CREATE TABLE students (name TEXT, student_number INTEGER, city TEXT, grade DOUBLE)
- * CREATE TABLE students FROM TBL FILE 'test/students.tbl'
+ * @brief Represents "CREATE TABLE students (name TEXT, student_number INTEGER, city TEXT, grade DOUBLE)"
  */
 struct CreateStatement : SQLStatement {
 	enum CreateType {
@@ -45,7 +47,11 @@ struct CreateStatement : SQLStatement {
 		file_path(NULL),
 		table_name(NULL) {};
 
-	virtual ~CreateStatement(); // defined in destructors.cpp
+	virtual ~CreateStatement() {
+		delete columns;
+		delete file_path;
+		delete table_name;
+	}
 
 	CreateType type;
 	bool if_not_exists;

src/lib/destructors.cpp

@@ -8,8 +8,7 @@ namespace hsql {
 
 /**
  * @struct DeleteStatement
- * DELETE FROM students WHERE grade > 3.0
- * DELETE FROM students <=> TRUNCATE students
+ * @brief Represents "DELETE FROM students WHERE grade > 3.0"
  *
  * If expr == NULL => delete all rows (truncate)
  */
@@ -19,7 +18,11 @@ struct DeleteStatement : SQLStatement {
 		table_name(NULL),
 		expr(NULL) {};
 
-	virtual ~DeleteStatement(); // defined in destructors.cpp
+	virtual ~DeleteStatement() {
+		delete table_name;
+		delete expr;
+	}
+
 
 	char* table_name;
 	Expr* expr;

src/lib/statements/CreateStatement.h

@@ -5,6 +5,11 @@
 
 namespace hsql {
 
+
+/**
+ * @struct DropStatement
+ * @brief Represents "DROP TABLE"
+ */
 struct DropStatement : SQLStatement {
 	enum EntityType {
 		kTable,
@@ -19,14 +24,13 @@ struct DropStatement : SQLStatement {
 		type(type),
 		name(NULL) {}
 
-
-	EntityType type;
-	const char* name;
-
-
 	virtual ~DropStatement() {
 		delete name;
 	}
+
+
+	EntityType type;
+	const char* name;
 };
 
 

src/lib/statements/DeleteStatement.h

@@ -8,15 +8,18 @@ namespace hsql {
 
 /**
  * @struct ExecuteStatement
- *
+ * @brief Represents "EXECUTE ins_prep(100, "test", 2.3);"
  */
 struct ExecuteStatement : SQLStatement {
 	ExecuteStatement() :
 		SQLStatement(kStmtExecute),
 		name(NULL),
 		parameters(NULL) {}
 
-	virtual ~ExecuteStatement(); // defined in destructors.cpp
+	virtual ~ExecuteStatement() {
+		delete name;
+		delete parameters;
+	}
 
 	const char* name;
 	List<Expr*>* parameters;