Merge branch 'release/3.1'

Author: jtnelson

.version

@@ -1 +1 @@
-3.0.0
+3.1.0

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+#### Version 3.1.0 (TBD)
+* Added support for parsing standalone `function statements` in a compiler. Now, the following forms will parse into a `FunctionTree` that contains a symbolic representation of the function expressed in the CCL statement:
+* `function(key)` produces a FunctionTree whose root node contains an `IndexFunction`
+* `function(key, record)` produces a FunctionTree whose root node contains a `KeyRecordsFunction`
+* `function(key, record1,record2,...,recordN)` produces a FunctionTree whose root node contains a `KeyRecordsFunction`
+* `function(key, condition)` produces a FunctionTree whose root node contains a `KeyConditionFunction`
+* `key \| function`  produces a FunctionTree whose root node contains an `ImplicitKeyRecordFunction`
+* Fixed a bug where the paramaterized type of `KeyRecordsFunction` was a `List<String>` instead of a `List<Long>`.
+* Added support for including an optional timestamp within a function value statement.
+
 #### Version 3.0.0 (June 15, 2020)
 ##### Function Statements
 In version `3.0.0` we added support for **function statements**.

grammar/grammar.jjt

@@ -27,9 +27,10 @@ package com.cinchapi.ccl.generated;
 
 import com.cinchapi.ccl.SyntaxException;
 import com.cinchapi.ccl.grammar.DirectionSymbol;
+import com.cinchapi.ccl.grammar.FunctionTokenSymbol;
 import com.cinchapi.ccl.grammar.KeySymbol;
 import com.cinchapi.ccl.grammar.ValueTokenSymbol;
-import com.cinchapi.ccl.type.function.KeyCclFunction;
+import com.cinchapi.ccl.type.function.KeyConditionFunction;
 import com.cinchapi.ccl.type.function.KeyRecordsFunction;
 import com.cinchapi.ccl.grammar.FunctionKeySymbol;
 import com.cinchapi.ccl.grammar.FunctionValueSymbol;
@@ -44,6 +45,7 @@ import com.cinchapi.ccl.grammar.ValueSymbol;
 import com.cinchapi.ccl.grammar.PageSymbol;
 import com.cinchapi.ccl.grammar.OrderSymbol;
 import com.cinchapi.ccl.syntax.AbstractSyntaxTree;
+import com.cinchapi.ccl.syntax.ConditionTree;
 import com.cinchapi.ccl.type.Operator;
 import com.cinchapi.ccl.util.NaturalLanguage;
 import com.cinchapi.common.base.AnyStrings;
@@ -109,6 +111,8 @@ SKIP :
 
 TOKEN : { < OPEN_PARENTHESES : "(" > }
 TOKEN : { < CLOSE_PARENTHESES : ")" > }
+TOKEN : { < OPEN_BRACKET : "[" > }
+TOKEN : { < CLOSE_BRACKET : "]" > }
 TOKEN [IGNORE_CASE]: { < TIMESTAMP: "at" | "on" | "during" | "in" > }
 TOKEN [IGNORE_CASE]: { < WHERE: "where" > }
 TOKEN [IGNORE_CASE]: { < RESERVED_IDENTIFIER: "$id$" > }
@@ -189,7 +193,7 @@ TOKEN :
 |
   < NON_ALPHANUMERIC_AND_ALPHANUMERIC: (<NON_ALPHANUMERIC>|<ALPHANUMERIC>)+ >
 |
-  < #NON_ALPHANUMERIC: ~[",", "_","a"-"z","A"-"Z", "\n", "\t", "\r", " ", "(", ")", "="] >
+  < #NON_ALPHANUMERIC: ~[",", "_","a"-"z","A"-"Z", "\n", "\t", "\r", " ", "(", ")", "[", "]", "="] >
 |
   < #LETTER: ["_","a"-"z","A"-"Z"] >
 |
@@ -200,24 +204,28 @@ TOKEN :
 
 ASTStart StartCommandLine() #Start : {}
 {
-   (
+   ( LOOKAHEAD(4)
      (<WHERE>)? DisjunctionExpression() (Order())? (Page())? "\n"
    |
      Page() "\n"
    |
      Order() "\n"
+   |
+     Function() "\n"
    )
    { return jjtThis; }
 }
 
 ASTStart generateAST() #Start : {}
 {
-   (
+   ( LOOKAHEAD(4)
      (<WHERE>)? DisjunctionExpression() (Order())? (Page())? <EOF>
    |
      Page() <EOF>
    |
      Order() <EOF>
+   |
+     Function() <EOF>
    )
    { return jjtThis; }
 }
@@ -258,13 +266,13 @@ void RelationalExpression() #Expression :
 {
     key=Key()
       (
-        operator=LinksToOperator() value1=LinksToValue() timestamp=Timestamp()
+        operator=LinksToOperator() value1=LinksToValue() (timestamp=Timestamp())?
       |
-        operator=RegexBasedOperator() value1=RegexValue() timestamp=Timestamp()
+        operator=RegexBasedOperator() value1=RegexValue() (timestamp=Timestamp())?
       |
-        operator=UnaryOperator() value1=UnaryValue() timestamp=Timestamp()
+        operator=UnaryOperator() value1=UnaryValue() (timestamp=Timestamp())?
       |
-        operator=BinaryOperator() value1=BinaryValue() value2=BinaryValue() timestamp=Timestamp()
+        operator=BinaryOperator() value1=BinaryValue() value2=BinaryValue() (timestamp=Timestamp())?
       ) { jjtThis.key(key);
           jjtThis.operator(operator);
           jjtThis.addValue(value1);
@@ -275,15 +283,15 @@ void RelationalExpression() #Expression :
 
 KeyTokenSymbol Key() :
 {
+  FunctionKeySymbol function;
   Token key;
-  Token function;
 }
 {
   (
     LOOKAHEAD(2)
 
-    (key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<NUMERIC> | key=<ALPHANUMERIC> | key=<PERIOD_SEPARATED_STRING>) <PIPE> function=<ALPHANUMERIC>
-    { return new FunctionKeySymbol(new ImplicitKeyRecordFunction(function.image, key.image.substring(0, key.image.length())));}
+    (function=KeyFunction())
+    { return function; }
   |
     (key=<RESERVED_IDENTIFIER> | key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<NUMERIC> | key=<ALPHANUMERIC>)
     { return new KeySymbol(key.image); }
@@ -295,7 +303,7 @@ KeyTokenSymbol Key() :
 
 ValueTokenSymbol UnaryValue() :
 {
-  Token function;
+  FunctionValueSymbol function;
   Token key;
   Token word;
   String value = "";
@@ -305,25 +313,8 @@ ValueTokenSymbol UnaryValue() :
 {
   LOOKAHEAD(2)
 
-  function=<ALPHANUMERIC> <OPEN_PARENTHESES>
-   (
-     LOOKAHEAD(3)
-
-     (key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<ALPHANUMERIC> | key=<PERIOD_SEPARATED_STRING>) <CLOSE_PARENTHESES>
-     { return new FunctionValueSymbol(new IndexFunction(function.image, key.image));}
-   |
-     LOOKAHEAD(3)
-
-     (key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<ALPHANUMERIC> | key=<PERIOD_SEPARATED_STRING>)
-     (<COMMA> (word=<SIGNED_INTEGER> | word=<NUMERIC>){ records.add(word.image); })+ <CLOSE_PARENTHESES>
-     { return new FunctionValueSymbol(new KeyRecordsFunction(function.image, key.image, records));}
-   |
-     (key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<ALPHANUMERIC> | key=<PERIOD_SEPARATED_STRING>) <COMMA> ccl=generateSubAST() <CLOSE_PARENTHESES>
-     {
-        AbstractSyntaxTree tree = (AbstractSyntaxTree) ccl.jjtAccept(visitor, null);
-
-        return new FunctionValueSymbol(new KeyCclFunction(function.image, key.image, tree));}
-   )
+  (function=ValueFunction())
+  { return function; }
 |
   ( LOOKAHEAD(2) (word=<SIGNED_INTEGER> | word=<SIGNED_DECIMAL> | word=<NUMERIC> | word=<ALPHANUMERIC> | word=<NON_ALPHANUMERIC_AND_ALPHANUMERIC>  | word=<PERIOD_SEPARATED_STRING>) { value += (value.equals("")) ? word.image : " " + word.image; })+
   {
@@ -379,7 +370,7 @@ ValueTokenSymbol RegexValue() :
 
 ValueTokenSymbol BinaryValue() :
 {
-  Token function;
+  FunctionValueSymbol function;
   Token key;
   Token word;
   String value = "";
@@ -389,25 +380,8 @@ ValueTokenSymbol BinaryValue() :
 {
   LOOKAHEAD(2)
 
-  function=<ALPHANUMERIC> <OPEN_PARENTHESES>
-   (
-     LOOKAHEAD(3)
-
-     (key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<ALPHANUMERIC>) <CLOSE_PARENTHESES>
-     { return new FunctionValueSymbol(new IndexFunction(function.image, key.image));}
-   |
-     LOOKAHEAD(3)
-
-     (key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<ALPHANUMERIC> | key=<PERIOD_SEPARATED_STRING>)
-     (<COMMA> (word=<SIGNED_INTEGER> | word=<NUMERIC>){ records.add(word.image); })+ <CLOSE_PARENTHESES>
-     { return new FunctionValueSymbol(new KeyRecordsFunction(function.image, key.image, records));}
-   |
-     (key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<ALPHANUMERIC> | key=<PERIOD_SEPARATED_STRING>) <COMMA> ccl=generateSubAST() <CLOSE_PARENTHESES>
-     {
-        AbstractSyntaxTree tree = (AbstractSyntaxTree) ccl.jjtAccept(visitor, null);
-
-        return new FunctionValueSymbol(new KeyCclFunction(function.image, key.image, tree));}
-   )
+  (function=ValueFunction())
+  { return function; }
 |
   (word=<SIGNED_INTEGER> | word=<SIGNED_DECIMAL> | word=<NUMERIC> | word=<ALPHANUMERIC> | word=<NON_ALPHANUMERIC_AND_ALPHANUMERIC>  | word=<PERIOD_SEPARATED_STRING>)
   {
@@ -438,7 +412,6 @@ ValueTokenSymbol BinaryValue() :
 |
   (word=<QUOTED_STRING>)
   { return new ValueSymbol(transformValue(word.image.replace("\\\"", "\""))); }
-
 }
 
 OperatorSymbol LinksToOperator() :
@@ -479,9 +452,8 @@ TimestampSymbol Timestamp() :
   String timestamp = "";
 }
 {
-  (<TIMESTAMP> (LOOKAHEAD(2) (word=<QUOTED_STRING> | word=<SIGNED_INTEGER> | word=<SIGNED_DECIMAL> | word=<NUMERIC> | word=<ALPHANUMERIC> | word=<NON_ALPHANUMERIC_AND_ALPHANUMERIC>) { timestamp += (timestamp.equals("")) ? word.image : " " + word.image; })+
-  { return new TimestampSymbol(NaturalLanguage.parseMicros(timestamp)); })?
-  { return null; }
+  <TIMESTAMP> (LOOKAHEAD(2) (word=<QUOTED_STRING> | word=<SIGNED_INTEGER> | word=<SIGNED_DECIMAL> | word=<NUMERIC> | word=<ALPHANUMERIC> | word=<NON_ALPHANUMERIC_AND_ALPHANUMERIC>) { timestamp += (timestamp.equals("")) ? word.image : " " + word.image; })+
+  { return new TimestampSymbol(NaturalLanguage.parseMicros(timestamp)); }
 }
 
 void Page() #Page :
@@ -546,7 +518,7 @@ OrderComponentSymbol OrderClause() :
   |
     key=Key() (direction=WordDirection())?
   )
-  timestamp=Timestamp())
+  (timestamp=Timestamp())?)
   {
       if(direction != null) {
           if(timestamp != null) {
@@ -595,4 +567,82 @@ DirectionSymbol WordDirection() :
       direction=<DESC>
       { return DirectionSymbol.DESCENDING; }
   )
+}
+
+void Function() #Function :
+{
+    FunctionTokenSymbol function;
+}
+{
+  ( LOOKAHEAD(2)
+    function = KeyFunction()
+  |
+    function = ValueFunction()
+  )
+  { jjtThis.function(function);}
+}
+
+FunctionKeySymbol KeyFunction() :
+{
+  Token key;
+  Token function;
+}
+{
+   (key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<NUMERIC> | key=<ALPHANUMERIC> | key=<PERIOD_SEPARATED_STRING>) <PIPE> function=<ALPHANUMERIC>
+   { return new FunctionKeySymbol(new ImplicitKeyRecordFunction(function.image, key.image.substring(0, key.image.length())));}
+}
+
+FunctionValueSymbol ValueFunction() :
+{
+  Token function;
+  Token key;
+  Token word;
+  List<String> records = Lists.newArrayList();
+  ASTStart ccl;
+  TimestampSymbol timestamp = null;
+}
+{
+  function=<ALPHANUMERIC> <OPEN_PARENTHESES>
+   (
+     LOOKAHEAD(3)
+
+     (key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<ALPHANUMERIC> | key=<PERIOD_SEPARATED_STRING>)
+     (
+         <CLOSE_PARENTHESES>
+         { return new FunctionValueSymbol(new IndexFunction(function.image, key.image));}
+     |
+         <COMMA> timestamp=Timestamp() <CLOSE_PARENTHESES>
+         { return new FunctionValueSymbol(new IndexFunction(function.image, key.image, timestamp.timestamp()));}
+     )
+   |
+     LOOKAHEAD(3)
+
+     (key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<ALPHANUMERIC> | key=<PERIOD_SEPARATED_STRING>) <COMMA>
+     (
+        (word=<SIGNED_INTEGER> | word=<NUMERIC>){ records.add(word.image);}
+        (<COMMA> (word=<SIGNED_INTEGER> | word=<NUMERIC>){ records.add(word.image); })* <CLOSE_PARENTHESES>
+        { return new FunctionValueSymbol(new KeyRecordsFunction(function.image, key.image, records));}
+     |
+        <OPEN_BRACKET>
+        (word=<SIGNED_INTEGER> | word=<NUMERIC>){ records.add(word.image);}
+        (<COMMA> (word=<SIGNED_INTEGER> | word=<NUMERIC>){ records.add(word.image); })*
+        <CLOSE_BRACKET> <COMMA> timestamp=Timestamp() <CLOSE_PARENTHESES>
+        { return new FunctionValueSymbol(new KeyRecordsFunction(function.image, key.image, records, timestamp.timestamp()));}
+     )
+   |
+     (key=<SIGNED_INTEGER> | key=<SIGNED_DECIMAL> | key=<ALPHANUMERIC> | key=<PERIOD_SEPARATED_STRING>) <COMMA> ccl=generateSubAST()
+     (
+        <CLOSE_PARENTHESES>
+        {
+          ConditionTree tree = (ConditionTree) ccl.jjtAccept(visitor, null);
+          return new FunctionValueSymbol(new KeyConditionFunction(function.image, key.image, tree));
+        }
+     |
+        <COMMA> timestamp=Timestamp() <CLOSE_PARENTHESES>
+        {
+          ConditionTree tree = (ConditionTree) ccl.jjtAccept(visitor, null);
+          return new FunctionValueSymbol(new KeyConditionFunction(function.image, key.image, tree, timestamp.timestamp()));
+        }
+     )
+   )
 }

src/main/java/com/cinchapi/ccl/Compiler.java

@@ -37,6 +37,7 @@
 import com.cinchapi.ccl.syntax.ConditionTree;
 import com.cinchapi.ccl.syntax.ConjunctionTree;
 import com.cinchapi.ccl.syntax.ExpressionTree;
+import com.cinchapi.ccl.syntax.FunctionTree;
 import com.cinchapi.ccl.syntax.OrTree;
 import com.cinchapi.ccl.syntax.OrderTree;
 import com.cinchapi.ccl.syntax.PageTree;
@@ -348,6 +349,15 @@ public List<Symbol> visit(PageTree tree, Object... data) {
                 return symbols;
             }
 
+            @SuppressWarnings("unchecked")
+            @Override
+            public List<Symbol> visit(FunctionTree tree,
+                    Object... data) {
+                List<Symbol> symbols = (List<Symbol>) data[0];
+                symbols.add(tree.root());
+                return symbols;
+            }
+
         };
         return ast.accept(visitor, Lists.newArrayList());
     }
@@ -358,7 +368,7 @@ public List<Symbol> visit(PageTree tree, Object... data) {
      * {@link ExpressionSymbol}s that are sorted by the proper order of
      * operations.
      * 
-     * @param ast
+     * @param tree
      * @return a {@link Queue} of {@link PostfixNotationSymbol
      *         PostfixNotationSymbols}
      */