diff --git a/.github/workflows/ci-workflow.yml b/.github/workflows/ci-workflow.yml index 074185de5d..51e08002d7 100644 --- a/.github/workflows/ci-workflow.yml +++ b/.github/workflows/ci-workflow.yml @@ -24,7 +24,7 @@ concurrency: jobs: gcc-build-test: name: gcc build & test - needs: [clang-formatting-check, include-guard-and-no-std-assert] + needs: [clang-formatting-check, sanity-checks] runs-on: kuzu-self-hosted-testing env: NUM_THREADS: 32 @@ -127,7 +127,7 @@ jobs: clang-build-test: name: clang build and test - needs: [clang-formatting-check, include-guard-and-no-std-assert] + needs: [clang-formatting-check, sanity-checks] runs-on: kuzu-self-hosted-testing env: NUM_THREADS: 32 @@ -163,7 +163,7 @@ jobs: msvc-build-test: name: msvc build & test - needs: [clang-formatting-check, include-guard-and-no-std-assert] + needs: [clang-formatting-check, sanity-checks] runs-on: self-hosted-windows env: # Shorten build path as much as possible @@ -229,7 +229,7 @@ jobs: tidy-and-diagnostics: name: clang tidy & clangd diagnostics check - needs: [clang-formatting-check, include-guard-and-no-std-assert] + needs: [clang-formatting-check, sanity-checks] runs-on: kuzu-self-hosted-testing env: NUM_THREADS: 32 @@ -251,8 +251,8 @@ jobs: - name: Run clang-tidy analyzer run: make tidy-analyzer - include-guard-and-no-std-assert: - name: include guard & no std::assert check + sanity-checks: + name: sanity checks runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v3 @@ -263,6 +263,9 @@ jobs: - name: Checks files for std::assert run: ./scripts/check-no-std-assert.sh src + - name: Ensure generated grammar files are up to date + run: cmp src/antlr4/Cypher.g4 scripts/antlr4/Cypher.g4.copy + clang-formatting-check: name: clang-format check runs-on: ubuntu-22.04 @@ -311,7 +314,7 @@ jobs: macos-clang-tidy: name: macos clang tidy & clangd diagnostics check - needs: [clang-formatting-check, include-guard-and-no-std-assert] + needs: [clang-formatting-check, sanity-checks] runs-on: self-hosted-mac-x64 env: NUM_THREADS: 32 @@ -336,7 +339,7 @@ jobs: macos-build-test: name: apple clang build & test - needs: [clang-formatting-check, include-guard-and-no-std-assert, rustfmt-check] + needs: [clang-formatting-check, sanity-checks, rustfmt-check] runs-on: self-hosted-mac-x64 env: NUM_THREADS: 32 diff --git a/scripts/antlr4/Cypher.g4.copy b/scripts/antlr4/Cypher.g4.copy new file mode 100644 index 0000000000..8a55c1c7e3 --- /dev/null +++ b/scripts/antlr4/Cypher.g4.copy @@ -0,0 +1,854 @@ +/* +* OpenCypher grammar at "https://s3.amazonaws.com/artifacts.opencypher.org/legacy/Cypher.g4" +*/ +grammar Cypher; + +// provide ad-hoc error messages for common syntax errors +@parser::declarations { + virtual void notifyQueryNotConcludeWithReturn(antlr4::Token* startToken) {}; + virtual void notifyNodePatternWithoutParentheses(std::string nodeName, antlr4::Token* startToken) {}; + virtual void notifyInvalidNotEqualOperator(antlr4::Token* startToken) {}; + virtual void notifyEmptyToken(antlr4::Token* startToken) {}; + virtual void notifyReturnNotAtEnd(antlr4::Token* startToken) {}; + virtual void notifyNonBinaryComparison(antlr4::Token* startToken) {}; +} + +oC_Cypher + : SP ? oC_AnyCypherOption? SP? ( oC_Statement ) ( SP? ';' )? SP? EOF ; + +oC_Statement + : oC_Query + | kU_DDL + | kU_CopyFrom + | kU_CopyFromByColumn + | kU_CopyTO + | kU_StandaloneCall + | kU_CreateMacro + | kU_CommentOn + | kU_Transaction ; + +kU_CopyFrom + : COPY SP oC_SchemaName ( ( SP? '(' SP? kU_ColumnNames SP? ')' SP? ) | SP ) FROM SP kU_FilePaths ( SP? '(' SP? kU_ParsingOptions SP? ')' )? ; + +kU_ColumnNames + : oC_SchemaName ( SP? ',' SP? oC_SchemaName )* ; + +kU_CopyFromByColumn + : COPY SP oC_SchemaName SP FROM SP '(' SP? StringLiteral ( SP? ',' SP? StringLiteral )* ')' SP BY SP COLUMN ; + +kU_CopyTO + : COPY SP '(' SP? oC_Query SP? ')' SP TO SP StringLiteral ( SP? '(' SP? kU_ParsingOptions SP? ')' )? ; + +kU_StandaloneCall + : CALL SP oC_SymbolicName SP? '=' SP? oC_Literal ; + +CALL : ( 'C' | 'c' ) ( 'A' | 'a' ) ( 'L' | 'l' ) ( 'L' | 'l' ) ; + +kU_CommentOn + : COMMENT SP ON SP TABLE SP oC_SchemaName SP IS SP StringLiteral ; + +COMMENT : ( 'C' | 'c' ) ( 'O' | 'o' ) ( 'M' | 'm' ) ( 'M' | 'm' ) ( 'E' | 'e' ) ( 'N' | 'n' ) ( 'T' | 't' ) ; + +kU_CreateMacro + : CREATE SP MACRO SP oC_FunctionName SP? '(' SP? kU_PositionalArgs? SP? kU_DefaultArg? ( SP? ',' SP? kU_DefaultArg )* SP? ')' SP AS SP oC_Expression ; + +kU_PositionalArgs + : oC_SymbolicName ( SP? ',' SP? oC_SymbolicName )* ; + +kU_DefaultArg + : oC_SymbolicName SP? ':' '=' SP? oC_Literal ; + +MACRO : ( 'M' | 'm' ) ( 'A' | 'a' ) ( 'C' | 'c' ) ( 'R' | 'r' ) ( 'O' | 'o' ) ; + +kU_FilePaths + : '[' SP? StringLiteral ( SP? ',' SP? StringLiteral )* ']' + | StringLiteral + | GLOB SP? '(' SP? StringLiteral SP? ')' ; + +GLOB : ( 'G' | 'g' ) ( 'L' | 'l' ) ( 'O' | 'o' ) ( 'B' | 'b' ) ; + +kU_ParsingOptions + : kU_ParsingOption ( SP? ',' SP? kU_ParsingOption )* ; + +kU_ParsingOption + : oC_SymbolicName SP? '=' SP? oC_Literal; + +COPY : ( 'C' | 'c' ) ( 'O' | 'o' ) ( 'P' | 'p') ( 'Y' | 'y' ) ; + +FROM : ( 'F' | 'f' ) ( 'R' | 'r' ) ( 'O' | 'o' ) ( 'M' | 'm' ) ; + +COLUMN : ( 'C' | 'c' ) ( 'O' | 'o' ) ( 'L' | 'l' ) ( 'U' | 'u' ) ( 'M' | 'm' ) ( 'N' | 'n' ) ; + +kU_DDL + : kU_CreateNodeTable + | kU_CreateRelTable + | kU_CreateRelTableGroup + | kU_CreateRdfGraph + | kU_DropTable + | kU_AlterTable + ; + +kU_CreateNodeTable + : CREATE SP NODE SP TABLE SP oC_SchemaName SP? '(' SP? kU_PropertyDefinitions SP? ( ',' SP? kU_CreateNodeConstraint ) SP? ')' ; + +NODE : ( 'N' | 'n' ) ( 'O' | 'o' ) ( 'D' | 'd' ) ( 'E' | 'e' ) ; + +TABLE: ( 'T' | 't' ) ( 'A' | 'a' ) ( 'B' | 'b' ) ( 'L' | 'l' ) ( 'E' | 'e' ) ; + +kU_CreateRelTable + : CREATE SP REL SP TABLE SP oC_SchemaName SP? '(' SP? kU_RelTableConnection SP? ( ',' SP? kU_PropertyDefinitions SP? )? ( ',' SP? oC_SymbolicName SP? )? ')' ; + +kU_CreateRelTableGroup + : CREATE SP REL SP TABLE SP GROUP SP oC_SchemaName SP? '(' SP? kU_RelTableConnection SP ? (',' SP? kU_RelTableConnection)+ SP? ( ',' SP? kU_PropertyDefinitions SP? )? ( ',' SP? oC_SymbolicName SP? )? ')' ; + +GROUP : ( 'G' | 'g' ) ( 'R' | 'r' ) ( 'O' | 'o' ) ( 'U' | 'u' ) ( 'P' | 'p' ) ; + +kU_RelTableConnection + : FROM SP oC_SchemaName SP TO SP oC_SchemaName ; + +kU_CreateRdfGraph + : CREATE SP RDF SP GRAPH SP oC_SchemaName ; + +RDF : ('R' | 'r') ('D' | 'd') ('F' | 'f') ; + +GRAPH : ('G' | 'g') ('R' | 'r') ('A' | 'a') ('P' | 'p') ('H' | 'h') ; + +kU_DropTable + : DROP SP TABLE SP oC_SchemaName ; + +DROP : ( 'D' | 'd' ) ( 'R' | 'r' ) ( 'O' | 'o' ) ( 'P' | 'p' ) ; + +kU_AlterTable + : ALTER SP TABLE SP oC_SchemaName SP kU_AlterOptions ; + +ALTER: ( 'A' | 'a' ) ( 'L' | 'l' ) ( 'T' | 't' ) ( 'E' | 'e' ) ( 'R' | 'r' ) ; + +kU_AlterOptions + : kU_AddProperty + | kU_DropProperty + | kU_RenameTable + | kU_RenameProperty; + +kU_AddProperty + : ADD SP oC_PropertyKeyName SP kU_DataType ( SP DEFAULT SP oC_Expression )? ; + +DEFAULT : ( 'D' | 'd' ) ( 'E' | 'e' ) ( 'F' | 'f' ) ( 'A' | 'a' ) ( 'U' | 'u' ) ( 'L' | 'l' ) ( 'T' | 't' ) ; + +kU_DropProperty + : DROP SP oC_PropertyKeyName ; + +kU_RenameTable + : RENAME SP TO SP oC_SchemaName ; + +kU_RenameProperty + : RENAME SP oC_PropertyKeyName SP TO SP oC_PropertyKeyName ; + +RENAME: ( 'R' | 'r' ) ( 'E' | 'e' ) ( 'N' | 'n' ) ( 'A' | 'a' ) ( 'M' | 'm' ) ( 'E' | 'e' ) ; + +ADD: ( 'A' | 'a' ) ( 'D' | 'd' ) ( 'D' | 'd' ) ; + +kU_PropertyDefinitions : kU_PropertyDefinition ( SP? ',' SP? kU_PropertyDefinition )* ; + +kU_PropertyDefinition : oC_PropertyKeyName SP kU_DataType ; + +kU_CreateNodeConstraint : PRIMARY SP KEY SP? '(' SP? oC_PropertyKeyName SP? ')' ; + +PRIMARY: ( 'P' | 'p' ) ( 'R' | 'r' ) ( 'I' | 'i' ) ( 'M' | 'm' ) ( 'A' | 'a' ) ( 'R' | 'r' ) ( 'Y' | 'y' ) ; + +KEY : ( 'K' | 'k' ) ( 'E' | 'e' ) ( 'Y' | 'y' ) ; + +REL: ( 'R' | 'r' ) ( 'E' | 'e' ) ( 'L' | 'l' ) ; + +TO: ( 'T' | 't' ) ( 'O' | 'o' ) ; + +kU_DataType + : oC_SymbolicName + | kU_DataType kU_ListIdentifiers + | UNION SP? '(' SP? kU_PropertyDefinitions SP? ')' + | oC_SymbolicName SP? '(' SP? kU_PropertyDefinitions SP? ')' + | oC_SymbolicName SP? '(' SP? kU_DataType SP? ',' SP? kU_DataType SP? ')' ; + +kU_ListIdentifiers : kU_ListIdentifier ( kU_ListIdentifier )* ; + +kU_ListIdentifier : '[' oC_IntegerLiteral? ']' ; + +oC_AnyCypherOption + : oC_Explain + | oC_Profile ; + +oC_Explain + : EXPLAIN ; + +EXPLAIN : ( 'E' | 'e' ) ( 'X' | 'x' ) ( 'P' | 'p' ) ( 'L' | 'l' ) ( 'A' | 'a' ) ( 'I' | 'i' ) ( 'N' | 'n' ) ; + +oC_Profile + : PROFILE ; + +PROFILE : ( 'P' | 'p' ) ( 'R' | 'r' ) ( 'O' | 'o' ) ( 'F' | 'f' ) ( 'I' | 'i' ) ( 'L' | 'l' ) ( 'E' | 'e' ) ; + +kU_Transaction + : BEGIN SP TRANSACTION + | BEGIN SP TRANSACTION SP READ SP ONLY + | COMMIT + | COMMIT_SKIP_CHECKPOINT + | ROLLBACK + | ROLLBACK_SKIP_CHECKPOINT; + +BEGIN : ( 'B' | 'b' ) ( 'E' | 'e' ) ( 'G' | 'g' ) ( 'I' | 'i' ) ( 'N' | 'n' ) ; + +TRANSACTION : ( 'T' | 't' ) ( 'R' | 'r' ) ( 'A' | 'a' ) ( 'N' | 'n' ) ( 'S' | 's' ) ( 'A' | 'a' ) ( 'C' | 'c' ) ( 'T' | 't' ) ( 'I' | 'i' ) ( 'O' | 'o' ) ( 'N' | 'n' ) ; + +READ : ( 'R' | 'r' ) ( 'E' | 'e' ) ( 'A' | 'a' ) ( 'D' | 'd' ) ; + +ONLY : ('O' | 'o' ) ( 'N' | 'n' ) ( 'L' | 'l' ) ( 'Y' | 'y' ) ; + +WRITE : ( 'W' | 'w' ) ( 'R' | 'r' ) ( 'I' | 'i' ) ( 'T' | 't' ) ( 'E' | 'e' ) ; + +COMMIT : ( 'C' | 'c' ) ( 'O' | 'o' ) ( 'M' | 'm' ) ( 'M' | 'm' ) ( 'I' | 'i' ) ( 'T' | 't' ) ; + +COMMIT_SKIP_CHECKPOINT : ( 'C' | 'c' ) ( 'O' | 'o' ) ( 'M' | 'm' ) ( 'M' | 'm' ) ( 'I' | 'i' ) ( 'T' | 't' ) '_' ( 'S' | 's' ) ( 'K' | 'k' ) ( 'I' | 'i' ) ( 'P' | 'p' ) '_' ( 'C' | 'c' ) ( 'H' | 'h' ) ( 'E' | 'e' ) ( 'C' | 'c' ) ( 'K' | 'k' ) ( 'P' | 'p' ) ( 'O' | 'o' ) ( 'I' | 'i' ) ( 'N' | 'n' ) ( 'T' | 't' ) ; + +ROLLBACK : ( 'R' | 'r' ) ( 'O' | 'o' ) ( 'L' | 'l' ) ( 'L' | 'l' ) ( 'B' | 'b' ) ( 'A' | 'a' ) ( 'C' | 'c' ) ( 'K' | 'k' ) ; + +ROLLBACK_SKIP_CHECKPOINT: ( 'R' | 'r' ) ( 'O' | 'o' ) ( 'L' | 'l' ) ( 'L' | 'l' ) ( 'B' | 'b' ) ( 'A' | 'a' ) ( 'C' | 'c' ) ( 'K' | 'k' ) '_' ( 'S' | 's' ) ( 'K' | 'k' ) ( 'I' | 'i' ) ( 'P' | 'p' ) '_' ( 'C' | 'c' ) ( 'H' | 'h' ) ( 'E' | 'e' ) ( 'C' | 'c' ) ( 'K' | 'k' ) ( 'P' | 'p' ) ( 'O' | 'o' ) ( 'I' | 'i' ) ( 'N' | 'n' ) ( 'T' | 't' ) ; + +oC_Query + : oC_RegularQuery ; + +oC_RegularQuery + : oC_SingleQuery ( SP? oC_Union )* + | (oC_Return SP? )+ oC_SingleQuery { notifyReturnNotAtEnd($ctx->start); } + ; + +oC_Union + : ( UNION SP ALL SP? oC_SingleQuery ) + | ( UNION SP? oC_SingleQuery ) ; + +UNION : ( 'U' | 'u' ) ( 'N' | 'n' ) ( 'I' | 'i' ) ( 'O' | 'o' ) ( 'N' | 'n' ) ; + +ALL : ( 'A' | 'a' ) ( 'L' | 'l' ) ( 'L' | 'l' ) ; + +oC_SingleQuery + : oC_SinglePartQuery + | oC_MultiPartQuery + ; + +oC_SinglePartQuery + : ( oC_ReadingClause SP? )* oC_Return + | ( ( oC_ReadingClause SP? )* oC_UpdatingClause ( SP? oC_UpdatingClause )* ( SP? oC_Return )? ) + | ( oC_ReadingClause SP? )+ { notifyQueryNotConcludeWithReturn($ctx->start); } + ; + +oC_MultiPartQuery + : ( kU_QueryPart SP? )+ oC_SinglePartQuery; + +kU_QueryPart + : (oC_ReadingClause SP? )* ( oC_UpdatingClause SP? )* oC_With ; + +oC_UpdatingClause + : oC_Create + | oC_Merge + | oC_Set + | oC_Delete + ; + +oC_ReadingClause + : oC_Match + | oC_Unwind + | kU_InQueryCall + | kU_LoadFrom + ; + +kU_LoadFrom + : LOAD ( SP WITH SP HEADERS SP? '(' SP? kU_PropertyDefinitions SP? ')' )? SP FROM SP kU_FilePaths ( SP? '(' SP? kU_ParsingOptions SP? ')' )? (SP? oC_Where)? ; + +LOAD : ( 'L' | 'l' ) ( 'O' | 'o' ) ( 'A' | 'a' ) ( 'D' | 'd' ) ; + +HEADERS : ( 'H' | 'h' ) ( 'E' | 'e' ) ( 'A' | 'a' ) ( 'D' | 'd' ) ( 'E' | 'e' ) ( 'R' | 'r' ) ( 'S' | 's' ) ; + +kU_InQueryCall + : CALL SP oC_FunctionInvocation (SP? oC_Where)? ; + +oC_Match + : ( OPTIONAL SP )? MATCH SP? oC_Pattern (SP? oC_Where)? ; + +OPTIONAL : ( 'O' | 'o' ) ( 'P' | 'p' ) ( 'T' | 't' ) ( 'I' | 'i' ) ( 'O' | 'o' ) ( 'N' | 'n' ) ( 'A' | 'a' ) ( 'L' | 'l' ) ; + +MATCH : ( 'M' | 'm' ) ( 'A' | 'a' ) ( 'T' | 't' ) ( 'C' | 'c' ) ( 'H' | 'h' ) ; + +UNWIND : ( 'U' | 'u' ) ( 'N' | 'n' )( 'W' | 'w' ) ( 'I' | 'i' ) ( 'N' | 'n' ) ( 'D' | 'd' ) ; + +oC_Unwind : UNWIND SP? oC_Expression SP AS SP oC_Variable ; + +oC_Create + : CREATE SP? oC_Pattern ; + +CREATE : ( 'C' | 'c' ) ( 'R' | 'r' ) ( 'E' | 'e' ) ( 'A' | 'a' ) ( 'T' | 't' ) ( 'E' | 'e' ) ; + +// For unknown reason, openCypher use oC_PatternPart instead of oC_Pattern. There should be no difference in terms of planning. +// So we choose to be consistent with oC_Create and use oC_Pattern instead. +oC_Merge : MERGE SP? oC_Pattern ( SP oC_MergeAction )* ; + +MERGE : ( 'M' | 'm' ) ( 'E' | 'e' ) ( 'R' | 'r' ) ( 'G' | 'g' ) ( 'E' | 'e' ) ; + +oC_MergeAction + : ( ON SP MATCH SP oC_Set ) + | ( ON SP CREATE SP oC_Set ) + ; + +ON : ( 'O' | 'o' ) ( 'N' | 'n' ) ; + +oC_Set + : SET SP? oC_SetItem ( SP? ',' SP? oC_SetItem )* ; + +SET : ( 'S' | 's' ) ( 'E' | 'e' ) ( 'T' | 't' ) ; + +oC_SetItem + : ( oC_PropertyExpression SP? '=' SP? oC_Expression ) ; + +oC_Delete + : ( DETACH SP )? DELETE SP? oC_Expression ( SP? ',' SP? oC_Expression )*; + +DETACH : ( 'D' | 'd' ) ( 'E' | 'e' ) ( 'T' | 't' ) ( 'A' | 'a' ) ( 'C' | 'c' ) ( 'H' | 'h' ) ; + +DELETE : ( 'D' | 'd' ) ( 'E' | 'e' ) ( 'L' | 'l' ) ( 'E' | 'e' ) ( 'T' | 't' ) ( 'E' | 'e' ) ; + +oC_With + : WITH oC_ProjectionBody ( SP? oC_Where )? ; + +WITH : ( 'W' | 'w' ) ( 'I' | 'i' ) ( 'T' | 't' ) ( 'H' | 'h' ) ; + +oC_Return + : RETURN oC_ProjectionBody ; + +RETURN : ( 'R' | 'r' ) ( 'E' | 'e' ) ( 'T' | 't' ) ( 'U' | 'u' ) ( 'R' | 'r' ) ( 'N' | 'n' ) ; + +oC_ProjectionBody + : ( SP? DISTINCT )? SP oC_ProjectionItems (SP oC_Order )? ( SP oC_Skip )? ( SP oC_Limit )? ; + +DISTINCT : ( 'D' | 'd' ) ( 'I' | 'i' ) ( 'S' | 's' ) ( 'T' | 't' ) ( 'I' | 'i' ) ( 'N' | 'n' ) ( 'C' | 'c' ) ( 'T' | 't' ) ; + +oC_ProjectionItems + : ( STAR ( SP? ',' SP? oC_ProjectionItem )* ) + | ( oC_ProjectionItem ( SP? ',' SP? oC_ProjectionItem )* ) + ; + +STAR : '*' ; + +oC_ProjectionItem + : ( oC_Expression SP AS SP oC_Variable ) + | oC_Expression + ; + +AS : ( 'A' | 'a' ) ( 'S' | 's' ) ; + +oC_Order + : ORDER SP BY SP oC_SortItem ( ',' SP? oC_SortItem )* ; + +ORDER : ( 'O' | 'o' ) ( 'R' | 'r' ) ( 'D' | 'd' ) ( 'E' | 'e' ) ( 'R' | 'r' ) ; + +BY : ( 'B' | 'b' ) ( 'Y' | 'y' ) ; + +oC_Skip + : L_SKIP SP oC_Expression ; + +L_SKIP : ( 'S' | 's' ) ( 'K' | 'k' ) ( 'I' | 'i' ) ( 'P' | 'p' ) ; + +oC_Limit + : LIMIT SP oC_Expression ; + +LIMIT : ( 'L' | 'l' ) ( 'I' | 'i' ) ( 'M' | 'm' ) ( 'I' | 'i' ) ( 'T' | 't' ) ; + +oC_SortItem + : oC_Expression ( SP? ( ASCENDING | ASC | DESCENDING | DESC ) )? ; + +ASCENDING : ( 'A' | 'a' ) ( 'S' | 's' ) ( 'C' | 'c' ) ( 'E' | 'e' ) ( 'N' | 'n' ) ( 'D' | 'd' ) ( 'I' | 'i' ) ( 'N' | 'n' ) ( 'G' | 'g' ) ; + +ASC : ( 'A' | 'a' ) ( 'S' | 's' ) ( 'C' | 'c' ) ; + +DESCENDING : ( 'D' | 'd' ) ( 'E' | 'e' ) ( 'S' | 's' ) ( 'C' | 'c' ) ( 'E' | 'e' ) ( 'N' | 'n' ) ( 'D' | 'd' ) ( 'I' | 'i' ) ( 'N' | 'n' ) ( 'G' | 'g' ) ; + +DESC : ( 'D' | 'd' ) ( 'E' | 'e' ) ( 'S' | 's' ) ( 'C' | 'c' ) ; + +oC_Where + : WHERE SP oC_Expression ; + +WHERE : ( 'W' | 'w' ) ( 'H' | 'h' ) ( 'E' | 'e' ) ( 'R' | 'r' ) ( 'E' | 'e' ) ; + +oC_Pattern + : oC_PatternPart ( SP? ',' SP? oC_PatternPart )* ; + +oC_PatternPart + : ( oC_Variable SP? '=' SP? oC_AnonymousPatternPart ) + | oC_AnonymousPatternPart ; + +oC_AnonymousPatternPart + : oC_PatternElement ; + +oC_PatternElement + : ( oC_NodePattern ( SP? oC_PatternElementChain )* ) + | ( '(' oC_PatternElement ')' ) + ; + +oC_NodePattern + : '(' SP? ( oC_Variable SP? )? ( oC_NodeLabels SP? )? ( kU_Properties SP? )? ')' ; + +oC_PatternElementChain + : oC_RelationshipPattern SP? oC_NodePattern ; + +oC_RelationshipPattern + : ( oC_LeftArrowHead SP? oC_Dash SP? oC_RelationshipDetail? SP? oC_Dash ) + | ( oC_Dash SP? oC_RelationshipDetail? SP? oC_Dash SP? oC_RightArrowHead ) + | ( oC_Dash SP? oC_RelationshipDetail? SP? oC_Dash ) + ; + +oC_RelationshipDetail + : '[' SP? ( oC_Variable SP? )? ( oC_RelationshipTypes SP? )? ( oC_RangeLiteral SP? )? ( kU_Properties SP? )? ']' ; + +// The original oC_Properties definition is oC_MapLiteral | oC_Parameter. +// We choose to not support parameter as properties which will be the decision for a long time. +// We then substitute with oC_MapLiteral definition. We create oC_MapLiteral only when we decide to add MAP type. +kU_Properties + : '{' SP? ( oC_PropertyKeyName SP? ':' SP? oC_Expression SP? ( ',' SP? oC_PropertyKeyName SP? ':' SP? oC_Expression SP? )* )? '}'; + +oC_RelationshipTypes + : ':' SP? oC_RelTypeName ( SP? '|' ':'? SP? oC_RelTypeName )* ; + +oC_NodeLabels + : oC_NodeLabel ( SP? oC_NodeLabel )* ; + +oC_NodeLabel + : ':' SP? oC_LabelName ; + +oC_RangeLiteral + : '*' SP? ( SHORTEST | ALL SP SHORTEST )? SP? (oC_LowerBound? SP? '..' SP? oC_UpperBound? | oC_IntegerLiteral)? (SP? kU_RecursiveRelationshipComprehension)? ; + +kU_RecursiveRelationshipComprehension + : '(' SP? oC_Variable SP? ',' SP? oC_Variable ( SP? '|' SP? oC_Where )? ( SP? '|' SP? kU_IntermediateRelProjectionItems SP? ',' SP? kU_IntermediateNodeProjectionItems SP? )? ')' ; + +kU_IntermediateNodeProjectionItems + : '{' SP? oC_ProjectionItems? SP? '}' ; + +kU_IntermediateRelProjectionItems + : '{' SP? oC_ProjectionItems? SP? '}' ; + +oC_LowerBound + : DecimalInteger ; + +oC_UpperBound + : DecimalInteger ; + + +SHORTEST : ( 'S' | 's' ) ( 'H' | 'h' ) ( 'O' | 'o' ) ( 'R' | 'r' ) ( 'T' | 't' ) ( 'E' | 'e' ) ( 'S' | 's' ) ( 'T' | 't' ) ; + +oC_LabelName + : oC_SchemaName ; + +oC_RelTypeName + : oC_SchemaName ; + +oC_Expression + : oC_OrExpression ; + +oC_OrExpression + : oC_XorExpression ( SP OR SP oC_XorExpression )* ; + +OR : ( 'O' | 'o' ) ( 'R' | 'r' ) ; + +oC_XorExpression + : oC_AndExpression ( SP XOR SP oC_AndExpression )* ; + +XOR : ( 'X' | 'x' ) ( 'O' | 'o' ) ( 'R' | 'r' ) ; + +oC_AndExpression + : oC_NotExpression ( SP AND SP oC_NotExpression )* ; + +AND : ( 'A' | 'a' ) ( 'N' | 'n' ) ( 'D' | 'd' ) ; + +oC_NotExpression + : ( NOT SP? )? oC_ComparisonExpression ; + +NOT : ( 'N' | 'n' ) ( 'O' | 'o' ) ( 'T' | 't' ) ; + +oC_ComparisonExpression + : kU_BitwiseOrOperatorExpression ( SP? kU_ComparisonOperator SP? kU_BitwiseOrOperatorExpression )? + | kU_BitwiseOrOperatorExpression ( SP? INVALID_NOT_EQUAL SP? kU_BitwiseOrOperatorExpression ) { notifyInvalidNotEqualOperator($INVALID_NOT_EQUAL); } + | kU_BitwiseOrOperatorExpression SP? kU_ComparisonOperator SP? kU_BitwiseOrOperatorExpression ( SP? kU_ComparisonOperator SP? kU_BitwiseOrOperatorExpression )+ { notifyNonBinaryComparison($ctx->start); } + ; + +kU_ComparisonOperator : '=' | '<>' | '<' | '<=' | '>' | '>=' ; + +INVALID_NOT_EQUAL : '!=' ; + +kU_BitwiseOrOperatorExpression + : kU_BitwiseAndOperatorExpression ( SP? '|' SP? kU_BitwiseAndOperatorExpression )* ; + +kU_BitwiseAndOperatorExpression + : kU_BitShiftOperatorExpression ( SP? '&' SP? kU_BitShiftOperatorExpression )* ; + +kU_BitShiftOperatorExpression + : oC_AddOrSubtractExpression ( SP? kU_BitShiftOperator SP? oC_AddOrSubtractExpression )* ; + +kU_BitShiftOperator : '>>' | '<<' ; + +oC_AddOrSubtractExpression + : oC_MultiplyDivideModuloExpression ( SP? kU_AddOrSubtractOperator SP? oC_MultiplyDivideModuloExpression )* ; + +kU_AddOrSubtractOperator : '+' | '-' ; + +oC_MultiplyDivideModuloExpression + : oC_PowerOfExpression ( SP? kU_MultiplyDivideModuloOperator SP? oC_PowerOfExpression )* ; + +kU_MultiplyDivideModuloOperator : '*' | '/' | '%' ; + +oC_PowerOfExpression + : oC_UnaryAddSubtractOrFactorialExpression ( SP? '^' SP? oC_UnaryAddSubtractOrFactorialExpression )* ; + +oC_UnaryAddSubtractOrFactorialExpression + : ( MINUS SP? )? oC_StringListNullOperatorExpression (SP? FACTORIAL)? ; + +MINUS : '-' ; + +FACTORIAL : '!' ; + +oC_StringListNullOperatorExpression + : oC_PropertyOrLabelsExpression ( oC_StringOperatorExpression | oC_ListOperatorExpression+ | oC_NullOperatorExpression )? ; + +oC_ListOperatorExpression + : kU_ListExtractOperatorExpression | kU_ListSliceOperatorExpression ; + +kU_ListExtractOperatorExpression + : '[' oC_Expression ']' ; + +kU_ListSliceOperatorExpression + : '[' oC_Expression? ':' oC_Expression? ']' ; + +oC_StringOperatorExpression + : ( oC_RegularExpression | ( SP STARTS SP WITH ) | ( SP ENDS SP WITH ) | ( SP CONTAINS ) ) SP? oC_PropertyOrLabelsExpression ; + +oC_RegularExpression + : SP? '=~' ; + +STARTS : ( 'S' | 's' ) ( 'T' | 't' ) ( 'A' | 'a' ) ( 'R' | 'r' ) ( 'T' | 't' ) ( 'S' | 's' ) ; + +ENDS : ( 'E' | 'e' ) ( 'N' | 'n' ) ( 'D' | 'd' ) ( 'S' | 's' ) ; + +CONTAINS : ( 'C' | 'c' ) ( 'O' | 'o' ) ( 'N' | 'n' ) ( 'T' | 't' ) ( 'A' | 'a' ) ( 'I' | 'i' ) ( 'N' | 'n' ) ( 'S' | 's' ) ; + +oC_NullOperatorExpression + : ( SP IS SP NULL_ ) + | ( SP IS SP NOT SP NULL_ ) ; + +IS : ( 'I' | 'i' ) ( 'S' | 's' ) ; + +NULL_ : ( 'N' | 'n' ) ( 'U' | 'u' ) ( 'L' | 'l' ) ( 'L' | 'l' ) ; + +oC_PropertyOrLabelsExpression + : oC_Atom ( SP? oC_PropertyLookup )* ; + +oC_Atom + : oC_Literal + | oC_Parameter + | oC_CaseExpression + | oC_ParenthesizedExpression + | oC_FunctionInvocation + | oC_PathPatterns + | oC_ExistSubquery + | kU_CountSubquery + | oC_Variable + ; + +oC_Literal + : oC_NumberLiteral + | StringLiteral + | oC_BooleanLiteral + | NULL_ + | oC_ListLiteral + | kU_StructLiteral + ; + +oC_BooleanLiteral + : TRUE + | FALSE + ; + +TRUE : ( 'T' | 't' ) ( 'R' | 'r' ) ( 'U' | 'u' ) ( 'E' | 'e' ) ; + +FALSE : ( 'F' | 'f' ) ( 'A' | 'a' ) ( 'L' | 'l' ) ( 'S' | 's' ) ( 'E' | 'e' ) ; + +oC_ListLiteral + : '[' SP? ( oC_Expression SP? ( kU_ListEntry SP? )* )? ']' ; + +kU_ListEntry + : ',' SP? oC_Expression? ; + +kU_StructLiteral + : '{' SP? kU_StructField SP? ( ',' SP? kU_StructField SP? )* '}' ; + +kU_StructField + : ( oC_SymbolicName | StringLiteral ) SP? ':' SP? oC_Expression ; + +oC_ParenthesizedExpression + : '(' SP? oC_Expression SP? ')' ; + +oC_FunctionInvocation + : COUNT SP? '(' SP? '*' SP? ')' + | oC_FunctionName SP? '(' SP? ( DISTINCT SP? )? ( kU_FunctionParameter SP? ( ',' SP? kU_FunctionParameter SP? )* )? ')' ; + +COUNT : ( 'C' | 'c' ) ( 'O' | 'o' ) ( 'U' | 'u' ) ( 'N' | 'n' ) ( 'T' | 't' ) ; + +oC_FunctionName + : oC_SymbolicName ; + +kU_FunctionParameter + : ( oC_SymbolicName SP? ':' '=' SP? )? oC_Expression ; + +oC_PathPatterns + : oC_NodePattern ( SP? oC_PatternElementChain )+; + +oC_ExistSubquery + : EXISTS SP? '{' SP? MATCH SP? oC_Pattern ( SP? oC_Where )? SP? '}' ; + +kU_CountSubquery + : COUNT SP? '{' SP? MATCH SP? oC_Pattern ( SP? oC_Where )? SP? '}' ; + +EXISTS : ( 'E' | 'e' ) ( 'X' | 'x' ) ( 'I' | 'i' ) ( 'S' | 's' ) ( 'T' | 't' ) ( 'S' | 's' ) ; + +oC_PropertyLookup + : '.' SP? ( oC_PropertyKeyName | STAR ) ; + +oC_CaseExpression + : ( ( CASE ( SP? oC_CaseAlternative )+ ) | ( CASE SP? oC_Expression ( SP? oC_CaseAlternative )+ ) ) ( SP? ELSE SP? oC_Expression )? SP? END ; + +CASE : ( 'C' | 'c' ) ( 'A' | 'a' ) ( 'S' | 's' ) ( 'E' | 'e' ) ; + +ELSE : ( 'E' | 'e' ) ( 'L' | 'l' ) ( 'S' | 's' ) ( 'E' | 'e' ) ; + +END : ( 'E' | 'e' ) ( 'N' | 'n' ) ( 'D' | 'd' ) ; + +oC_CaseAlternative + : WHEN SP? oC_Expression SP? THEN SP? oC_Expression ; + +WHEN : ( 'W' | 'w' ) ( 'H' | 'h' ) ( 'E' | 'e' ) ( 'N' | 'n' ) ; + +THEN : ( 'T' | 't' ) ( 'H' | 'h' ) ( 'E' | 'e' ) ( 'N' | 'n' ) ; + +oC_Variable + : oC_SymbolicName ; + +StringLiteral + : ( '"' ( StringLiteral_0 | EscapedChar )* '"' ) + | ( '\'' ( StringLiteral_1 | EscapedChar )* '\'' ) + ; + +EscapedChar + : '\\' ( '\\' | '\'' | '"' | ( 'B' | 'b' ) | ( 'F' | 'f' ) | ( 'N' | 'n' ) | ( 'R' | 'r' ) | ( 'T' | 't' ) | ( ( 'U' | 'u' ) ( HexDigit HexDigit HexDigit HexDigit ) ) | ( ( 'U' | 'u' ) ( HexDigit HexDigit HexDigit HexDigit HexDigit HexDigit HexDigit HexDigit ) ) ) ; + +oC_NumberLiteral + : oC_DoubleLiteral + | oC_IntegerLiteral + ; + +oC_Parameter + : '$' ( oC_SymbolicName | DecimalInteger ) ; + +oC_PropertyExpression + : oC_Atom SP? oC_PropertyLookup ; + +oC_PropertyKeyName + : oC_SchemaName ; + +oC_IntegerLiteral + : DecimalInteger ; + +DecimalInteger + : ZeroDigit + | ( NonZeroDigit ( Digit )* ) + ; + +HexLetter + : ( 'A' | 'a' ) + | ( 'B' | 'b' ) + | ( 'C' | 'c' ) + | ( 'D' | 'd' ) + | ( 'E' | 'e' ) + | ( 'F' | 'f' ) + ; + +HexDigit + : Digit + | HexLetter + ; + +Digit + : ZeroDigit + | NonZeroDigit + ; + +NonZeroDigit + : NonZeroOctDigit + | '8' + | '9' + ; + +NonZeroOctDigit + : '1' + | '2' + | '3' + | '4' + | '5' + | '6' + | '7' + ; + +ZeroDigit + : '0' ; + +oC_DoubleLiteral + : RegularDecimalReal ; + +RegularDecimalReal + : ( Digit )* '.' ( Digit )+ ; + +oC_SchemaName + : oC_SymbolicName ; + +oC_SymbolicName + : UnescapedSymbolicName + | EscapedSymbolicName {if ($EscapedSymbolicName.text == "``") { notifyEmptyToken($EscapedSymbolicName); }} + | HexLetter + | kU_NonReservedKeywords + ; + +kU_NonReservedKeywords + : COMMENT + | COUNT ; + +UnescapedSymbolicName + : IdentifierStart ( IdentifierPart )* ; + +IdentifierStart + : ID_Start + | Pc + ; + +IdentifierPart + : ID_Continue + | Sc + ; + +EscapedSymbolicName + : ( '`' ( EscapedSymbolicName_0 )* '`' )+ ; + +SP + : ( WHITESPACE )+ ; + +WHITESPACE + : SPACE + | TAB + | LF + | VT + | FF + | CR + | FS + | GS + | RS + | US + | '\u1680' + | '\u180e' + | '\u2000' + | '\u2001' + | '\u2002' + | '\u2003' + | '\u2004' + | '\u2005' + | '\u2006' + | '\u2008' + | '\u2009' + | '\u200a' + | '\u2028' + | '\u2029' + | '\u205f' + | '\u3000' + | '\u00a0' + | '\u2007' + | '\u202f' + | Comment + ; + +Comment + : ( '/*' ( Comment_1 | ( '*' Comment_2 ) )* '*/' ) ; + +oC_LeftArrowHead + : '<' + | '\u27e8' + | '\u3008' + | '\ufe64' + | '\uff1c' + ; + +oC_RightArrowHead + : '>' + | '\u27e9' + | '\u3009' + | '\ufe65' + | '\uff1e' + ; + +oC_Dash + : '-' + | '\u00ad' + | '\u2010' + | '\u2011' + | '\u2012' + | '\u2013' + | '\u2014' + | '\u2015' + | '\u2212' + | '\ufe58' + | '\ufe63' + | '\uff0d' + ; + +fragment FF : [\f] ; + +fragment EscapedSymbolicName_0 : ~[`] ; + +fragment RS : [\u001E] ; + +fragment ID_Continue : [\p{ID_Continue}] ; + +fragment Comment_1 : ~[*] ; + +fragment StringLiteral_1 : ~['\\] ; + +fragment Comment_3 : ~[\n\r] ; + +fragment Comment_2 : ~[/] ; + +fragment GS : [\u001D] ; + +fragment FS : [\u001C] ; + +fragment CR : [\r] ; + +fragment Sc : [\p{Sc}] ; + +fragment SPACE : [ ] ; + +fragment Pc : [\p{Pc}] ; + +fragment TAB : [\t] ; + +fragment StringLiteral_0 : ~["\\] ; + +fragment LF : [\n] ; + +fragment VT : [\u000B] ; + +fragment US : [\u001F] ; + +fragment ID_Start : [\p{ID_Start}] ; + +// This is used to capture unknown lexer input (e.g. !) to avoid parser exception. +Unknown : .; diff --git a/scripts/antlr4/generate_grammar.cmake b/scripts/antlr4/generate_grammar.cmake new file mode 100644 index 0000000000..e366f17128 --- /dev/null +++ b/scripts/antlr4/generate_grammar.cmake @@ -0,0 +1,51 @@ +# Use a copy of the grammar file and compare since last run. +# This is to make sure clean build from source needn't have Java installed. +# We can't use checksums because of windows line ending normalization. +file(READ Cypher.g4.copy COPY_CONTENT) +file(READ ${ROOT_DIR}/src/antlr4/Cypher.g4 REAL_CONTENT) + +if("${COPY_CONTENT}" STREQUAL "${REAL_CONTENT}") + message(DEBUG " Not regenerating grammar files as Cypher.g4 is unchanged.") + return() # Exit. +endif() + +file(WRITE Cypher.g4.copy "${REAL_CONTENT}") + +message(INFO " Regenerating grammar files...") + +if(NOT EXISTS antlr4.jar) + message(INFO " Downloading antlr4.jar") + file( + DOWNLOAD https://www.antlr.org/download/antlr-4.13.1-complete.jar antlr4.jar + EXPECTED_HASH SHA256=bc13a9c57a8dd7d5196888211e5ede657cb64a3ce968608697e4f668251a8487) +endif() + +# create the directory for the generated grammar +file(MAKE_DIRECTORY generated) + +# copy grammar, because antlr4 does some weird things with output locations. +file(COPY ${ROOT_DIR}/src/antlr4/Cypher.g4 DESTINATION .) + +find_package(Java REQUIRED) + +# Generate files. +message(INFO " Generating files...") +execute_process(COMMAND + ${Java_JAVA_EXECUTABLE} -jar antlr4.jar -Dlanguage=Cpp -no-visitor -no-listener Cypher.g4 -o generated) + +# Edit source files. +file(READ generated/CypherLexer.cpp LexerContent) +string(REPLACE "#include \"CypherLexer.h\"" "#include \"cypher_lexer.h\"" LexerReplacedContent "${LexerContent}") +file(WRITE ${ROOT_DIR}/third_party/antlr4_cypher/cypher_lexer.cpp "${LexerReplacedContent}") + +file(READ generated/CypherParser.cpp ParserContent) +string(REPLACE "#include \"CypherParser.h\"" "#include \"cypher_parser.h\"" ParserReplacedContent "${ParserContent}") +file(WRITE ${ROOT_DIR}/third_party/antlr4_cypher/cypher_parser.cpp "${ParserReplacedContent}") + +# Move headers. +file(RENAME generated/CypherParser.h ${ROOT_DIR}/third_party/antlr4_cypher/include/cypher_parser.h) +file(RENAME generated/CypherLexer.h ${ROOT_DIR}/third_party/antlr4_cypher/include/cypher_lexer.h) + +# Cleanup +file(REMOVE_RECURSE generated) +file(REMOVE Cypher.g4) diff --git a/scripts/antlr4/generate_grammar.sh b/scripts/antlr4/generate_grammar.sh deleted file mode 100755 index a9417a7c48..0000000000 --- a/scripts/antlr4/generate_grammar.sh +++ /dev/null @@ -1,39 +0,0 @@ -#!/bin/bash - -# the root directory of the project -ROOT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )/../../" >/dev/null 2>&1 && pwd )" - -# download antlr4.jar if not exists -if [ ! -e antlr4.jar ] -then - echo "Downloading antlr4.jar" - curl --url 'https://www.antlr.org/download/antlr-4.13.1-complete.jar'\ - --output './antlr4.jar' -fi - -# create the directory for the generated grammar -mkdir -p ./generated - -# move grammar file to current directory -cp $ROOT_DIR/src/antlr4/Cypher.g4 ./Cypher.g4 - -# generate grammar -java -jar antlr4.jar -Dlanguage=Cpp -no-visitor -no-listener Cypher.g4 -o ./generated - -# rename include path -sed 's/#include "CypherLexer.h"/#include "cypher_lexer.h"/g' ./generated/CypherLexer.cpp > ./generated/cypher_lexer.cpp -sed 's/#include "CypherParser.h"/#include "cypher_parser.h"/g' ./generated/CypherParser.cpp > ./generated/cypher_parser.cpp -mv ./generated/CypherLexer.h ./generated/cypher_lexer.h -mv ./generated/CypherParser.h ./generated/cypher_parser.h - -# move generated files to the right place -mv ./generated/cypher_lexer.h $ROOT_DIR/third_party/antlr4_cypher/include/cypher_lexer.h -mv ./generated/cypher_lexer.cpp $ROOT_DIR/third_party/antlr4_cypher/cypher_lexer.cpp -mv ./generated/cypher_parser.h $ROOT_DIR/third_party/antlr4_cypher/include/cypher_parser.h -mv ./generated/cypher_parser.cpp $ROOT_DIR/third_party/antlr4_cypher/cypher_parser.cpp - -# remove the generated directory -rm -rf ./generated - -# remove the grammar file -rm ./Cypher.g4 diff --git a/third_party/antlr4_cypher/CMakeLists.txt b/third_party/antlr4_cypher/CMakeLists.txt index 02242a05d8..f893c87eb6 100644 --- a/third_party/antlr4_cypher/CMakeLists.txt +++ b/third_party/antlr4_cypher/CMakeLists.txt @@ -1,3 +1,15 @@ +add_custom_command( + OUTPUT + ${CMAKE_CURRENT_SOURCE_DIR}/cypher_lexer.cpp + ${CMAKE_CURRENT_SOURCE_DIR}/cypher_parser.cpp + ${CMAKE_CURRENT_SOURCE_DIR}/include/cypher_lexer.h + ${CMAKE_CURRENT_SOURCE_DIR}/include/cypher_parser.h + COMMAND cmake -D ROOT_DIR=${PROJECT_SOURCE_DIR} -P generate_grammar.cmake + DEPENDS + ${PROJECT_SOURCE_DIR}/src/antlr4/Cypher.g4 + ${PROJECT_SOURCE_DIR}/scripts/antlr4/generate_grammar.cmake + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/scripts/antlr4) + add_library(antlr4_cypher STATIC cypher_lexer.cpp