Merge branch 'aql2' of ssh://github.com/triAGENS/ArangoDB into aql2

Documentation/Books/Users/Transactions/Passing.mdpp

@@ -12,7 +12,7 @@ A basic example:
       params: [ 1, 2, 3 ]
     });
 
-The above example will return *1*.
+The above example will return *2*.
 
 Some example that uses collections:
 

arangod/Aql/QueryAst.cpp

@@ -1493,7 +1493,7 @@ AstNode* QueryAst::traverse (AstNode* node,
 /// @brief determines the variables referenced in an expression
 ////////////////////////////////////////////////////////////////////////////////
 
-std::unordered_set<int64_t> QueryAst::getReferencedVariables (AstNode const* node) {
+std::unordered_set<VariableId> QueryAst::getReferencedVariables (AstNode const* node) {
   auto func = [&](AstNode* node, void* data) -> AstNode* {
     if (node == nullptr) {
       return nullptr;
@@ -1507,14 +1507,14 @@ std::unordered_set<int64_t> QueryAst::getReferencedVariables (AstNode const* nod
         THROW_ARANGO_EXCEPTION(TRI_ERROR_OUT_OF_MEMORY);
       }
 
-      auto vars = static_cast<unordered_set<int64_t>*>(data);
+      auto vars = static_cast<unordered_set<VariableId>*>(data);
       vars->insert(variable->id);
     }
     
     return node;
   };
 
-  std::unordered_set<int64_t> vars;  
+  std::unordered_set<VariableId> vars;  
   traverse(_root, func, &vars); 
 
   return vars;

arangod/Aql/QueryAst.h

@@ -34,6 +34,7 @@
 #include "Aql/AstNode.h"
 #include "Aql/BindParameters.h"
 #include "Aql/Scopes.h"
+#include "Aql/Variable.h"
 #include "BasicsC/json.h"
 
 #include <functional>
@@ -568,7 +569,7 @@ namespace triagens {
 /// @brief determines the variables referenced in an expression
 ////////////////////////////////////////////////////////////////////////////////
 
-        std::unordered_set<int64_t> getReferencedVariables (AstNode const*);
+        std::unordered_set<VariableId> getReferencedVariables (AstNode const*);
 
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief normalize a function name

arangod/Aql/Scopes.cpp

@@ -217,7 +217,7 @@ Variable* Scopes::addVariable (char const* name,
     }
   }
 
-  int64_t id = ++_nextId;
+  VariableId id = ++_nextId;
 
   // if this fails, the exception will propagate and be caught somewhere else
   auto variable = new Variable(name, id, isUserDefined);
@@ -268,7 +268,7 @@ Variable* Scopes::getVariable (char const* name) const {
 /// @brief return a variable by id - this does not respect the scopes!
 ////////////////////////////////////////////////////////////////////////////////
         
-Variable* Scopes::getVariable (int64_t id) const {
+Variable* Scopes::getVariable (VariableId id) const {
   auto it = _variables.find(id);
 
   if (it == _variables.end()) {

arangod/Aql/Scopes.h

@@ -31,81 +31,11 @@
 #define ARANGODB_AQL_SCOPES_H 1
 
 #include "Basics/Common.h"
+#include "Aql/Variable.h"
 
 namespace triagens {
   namespace aql {
 
-// -----------------------------------------------------------------------------
-// --SECTION--                                                   struct Variable
-// -----------------------------------------------------------------------------
-
-    struct Variable {
-      Variable (std::string const& name,
-                int64_t id,
-                bool isUserDefined)
-        : name(name),
-          value(nullptr),
-          id(id),
-          refCount(0),
-          isUserDefined(isUserDefined) {
-      }
-
-      ~Variable () {
-      }
-
-////////////////////////////////////////////////////////////////////////////////
-/// @brief registers a constant value for the variable
-/// this constant value is used for constant propagation in optimizations
-////////////////////////////////////////////////////////////////////////////////
-
-      void constValue (void* node) {
-        value = node;
-      }
-
-////////////////////////////////////////////////////////////////////////////////
-/// @brief returns a constant value registered for this variable
-////////////////////////////////////////////////////////////////////////////////
-
-      inline void* constValue () const {
-        return value;
-      }
-
-////////////////////////////////////////////////////////////////////////////////
-/// @brief whether or not the variable is reference counted
-////////////////////////////////////////////////////////////////////////////////
-
-      inline bool isReferenceCounted () const {
-        return (refCount > 0);
-      }
-
-////////////////////////////////////////////////////////////////////////////////
-/// @brief increase the variable's reference counter
-////////////////////////////////////////////////////////////////////////////////
-
-      inline void increaseReferenceCount () {
-        ++refCount;
-      }
-
-////////////////////////////////////////////////////////////////////////////////
-/// @brief decrease the variable's reference counter
-////////////////////////////////////////////////////////////////////////////////
-
-      inline void decreaseReferenceCount () {
-        TRI_ASSERT(refCount > 0);
-        --refCount;
-      }
-
-// -----------------------------------------------------------------------------
-// --SECTION--                                                  public variables
-// -----------------------------------------------------------------------------
-
-      std::string const  name;
-      void*              value;
-      int64_t const      id;
-      uint32_t           refCount;
-      bool const         isUserDefined;
-    };
-
 // -----------------------------------------------------------------------------
 // --SECTION--                                                      public types
 // -----------------------------------------------------------------------------
@@ -274,7 +204,7 @@ namespace triagens {
 /// @brief return a variable by id - this does not respect the scopes!
 ////////////////////////////////////////////////////////////////////////////////
 
-        Variable* getVariable (int64_t) const;
+        Variable* getVariable (VariableId) const;
 
 // -----------------------------------------------------------------------------
 // --SECTION--                                                 private variables
@@ -286,7 +216,7 @@ namespace triagens {
 /// @brief all variables used in the query
 ////////////////////////////////////////////////////////////////////////////////
 
-        std::unordered_map<int64_t, Variable*>  _variables;
+        std::unordered_map<VariableId, Variable*>  _variables;
 
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief currently active scopes
@@ -304,7 +234,7 @@ namespace triagens {
 /// @brief next variable id
 ////////////////////////////////////////////////////////////////////////////////
 
-        int64_t                                 _nextId;
+        VariableId                              _nextId;
 
     };
 

arangod/Aql/Variable.h

@@ -0,0 +1,124 @@
+////////////////////////////////////////////////////////////////////////////////
+/// @brief Aql, AST variables
+///
+/// @file
+///
+/// DISCLAIMER
+///
+/// Copyright 2014 ArangoDB GmbH, Cologne, Germany
+/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
+///
+/// Licensed under the Apache License, Version 2.0 (the "License");
+/// you may not use this file except in compliance with the License.
+/// You may obtain a copy of the License at
+///
+///     http://www.apache.org/licenses/LICENSE-2.0
+///
+/// Unless required by applicable law or agreed to in writing, software
+/// distributed under the License is distributed on an "AS IS" BASIS,
+/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+/// See the License for the specific language governing permissions and
+/// limitations under the License.
+///
+/// Copyright holder is ArangoDB GmbH, Cologne, Germany
+///
+/// @author Jan Steemann
+/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
+/// @author Copyright 2012-2013, triAGENS GmbH, Cologne, Germany
+////////////////////////////////////////////////////////////////////////////////
+
+#ifndef ARANGODB_AQL_VARIABLE_H
+#define ARANGODB_AQL_VARIABLE_H 1
+
+#include "Basics/Common.h"
+
+namespace triagens {
+  namespace aql {
+
+    typedef uint32_t VariableId; 
+
+// -----------------------------------------------------------------------------
+// --SECTION--                                                   struct Variable
+// -----------------------------------------------------------------------------
+
+    struct Variable {
+      Variable (std::string const& name,
+                VariableId id,
+                bool isUserDefined)
+        : name(name),
+          value(nullptr),
+          id(id),
+          refCount(0),
+          isUserDefined(isUserDefined) {
+      }
+
+      ~Variable () {
+      }
+
+////////////////////////////////////////////////////////////////////////////////
+/// @brief registers a constant value for the variable
+/// this constant value is used for constant propagation in optimizations
+////////////////////////////////////////////////////////////////////////////////
+
+      void constValue (void* node) {
+        value = node;
+      }
+
+////////////////////////////////////////////////////////////////////////////////
+/// @brief returns a constant value registered for this variable
+////////////////////////////////////////////////////////////////////////////////
+
+      inline void* constValue () const {
+        return value;
+      }
+
+////////////////////////////////////////////////////////////////////////////////
+/// @brief whether or not the variable is reference counted
+////////////////////////////////////////////////////////////////////////////////
+
+      inline bool isReferenceCounted () const {
+        return (refCount > 0);
+      }
+
+////////////////////////////////////////////////////////////////////////////////
+/// @brief increase the variable's reference counter
+////////////////////////////////////////////////////////////////////////////////
+
+      inline void increaseReferenceCount () {
+        ++refCount;
+      }
+
+////////////////////////////////////////////////////////////////////////////////
+/// @brief decrease the variable's reference counter
+////////////////////////////////////////////////////////////////////////////////
+
+      inline void decreaseReferenceCount () {
+        TRI_ASSERT(refCount > 0);
+        --refCount;
+      }
+
+// -----------------------------------------------------------------------------
+// --SECTION--                                                  public variables
+// -----------------------------------------------------------------------------
+
+      std::string const  name;
+      void*              value;
+      VariableId const   id;
+      uint32_t           refCount;
+      bool const         isUserDefined;
+
+    };
+
+  }
+}
+
+#endif
+
+// -----------------------------------------------------------------------------
+// --SECTION--                                                       END-OF-FILE
+// -----------------------------------------------------------------------------
+
+// Local Variables:
+// mode: outline-minor
+// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
+// End:

lib/Utilities/DummyShell.cpp

@@ -33,7 +33,7 @@
 #include "BasicsC/files.h"
 
 using namespace std;
-using namespace triagentriagens;
+using namespace triagens;
 
 // -----------------------------------------------------------------------------
 // --SECTION--                                                  class DummyShell
@@ -47,10 +47,9 @@ using namespace triagentriagens;
 /// @brief constructs a new editor
 ////////////////////////////////////////////////////////////////////////////////
 
-DummyShell::DummyShell (std::string const& history)
-  : _current(),
-    _historyFilename(history),
-    _state(STATE_NONE) {
+DummyShell::DummyShell (std::string const& history,
+                        Completer* completer)
+  : ShellImplementation(history, completer) {
 }
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -83,29 +82,6 @@ bool DummyShell::close () {
   return true;
 }
 
-////////////////////////////////////////////////////////////////////////////////
-/// @brief get the history file path
-////////////////////////////////////////////////////////////////////////////////
-
-string DummyShell::historyPath () {
-  return "";
-}
-
-////////////////////////////////////////////////////////////////////////////////
-/// @brief add to history
-////////////////////////////////////////////////////////////////////////////////
-
-void DummyShell::addHistory (char const* str) {
-}
-
-////////////////////////////////////////////////////////////////////////////////
-/// @brief save history
-////////////////////////////////////////////////////////////////////////////////
-
-bool DummyShell::writeHistory () {
-  return true;
-}
-
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief line editor prompt
 ////////////////////////////////////////////////////////////////////////////////
@@ -137,7 +113,7 @@ char* DummyShell::prompt (char const* prompt) {
     p = dotdot.c_str();
 
     if (cin.eof()) {
-        return 0;
+      return nullptr;
     }
 
     _current += sep;
@@ -164,7 +140,7 @@ char* DummyShell::prompt (char const* prompt) {
     // extend line and check
     _current += result;
 
-    bool ok = isComplete(_current, lineno, strlen(result));
+    bool ok = _completer->isComplete(_current, lineno, strlen(result));
 
     // stop if line is complete
     if (ok) {
@@ -173,11 +149,46 @@ char* DummyShell::prompt (char const* prompt) {
   }
 
   char* line = TRI_DuplicateStringZ(TRI_UNKNOWN_MEM_ZONE, _current.c_str());
+
   _current.clear();
 
   return line;
 }
 
+////////////////////////////////////////////////////////////////////////////////
+/// @brief get the history file path
+////////////////////////////////////////////////////////////////////////////////
+
+string DummyShell::historyPath () {
+  return "";
+}
+
+////////////////////////////////////////////////////////////////////////////////
+/// @brief add to history
+////////////////////////////////////////////////////////////////////////////////
+
+void DummyShell::addHistory (char const* str) {
+}
+
+////////////////////////////////////////////////////////////////////////////////
+/// @brief save history
+////////////////////////////////////////////////////////////////////////////////
+
+bool DummyShell::writeHistory () {
+  return true;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+/// @brief returns the characters which the user has typed
+/// @arg  is the prompt of the shell
+/// Note: this is the interface between our shell world and some implementation
+///       of key events (linenoise, readline)
+////////////////////////////////////////////////////////////////////////////////
+
+char* DummyShell::getLine (char const* prompt) {
+  return this->prompt(prompt);
+}
+
 // -----------------------------------------------------------------------------
 // --SECTION--                                                       END-OF-FILE
 // -----------------------------------------------------------------------------

lib/Utilities/DummyShell.h

@@ -39,21 +39,17 @@
 #include "V8/v8-utils.h"
 
 namespace triagens {
-  using namespace std;
 
-////////////////////////////////////////////////////////////////////////////////
-/// @addtogroup Shell
-/// @{
-////////////////////////////////////////////////////////////////////////////////
-
-  class DummyShell: public ShellImplementation {
+  class DummyShell : public ShellImplementation {
 
     public:
+
 ////////////////////////////////////////////////////////////////////////////////
 ///                                               public constructor, destructor
 ////////////////////////////////////////////////////////////////////////////////
 
-    DummyShell(string const& history, Completer *);
+      DummyShell (std::string const& history,   
+                  Completer*);
   
       virtual ~DummyShell();
 
@@ -61,7 +57,7 @@ namespace triagens {
 /// @brief line editor open
 ////////////////////////////////////////////////////////////////////////////////
 
-    virtual bool open(bool autoComplete);
+      virtual bool open (bool autoComplete);
 
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief line editor shutdown
@@ -69,6 +65,12 @@ namespace triagens {
 
       virtual bool close();
 
+////////////////////////////////////////////////////////////////////////////////
+/// @brief line editor prompt
+////////////////////////////////////////////////////////////////////////////////
+
+      virtual char* prompt (char const* prompt);
+
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief get the history file path
 ///
@@ -82,7 +84,7 @@ namespace triagens {
 /// @brief add to history
 ////////////////////////////////////////////////////////////////////////////////
 
-    virtual void addHistory(const char*);
+      virtual void addHistory (const char*);
 
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief save the history
@@ -97,11 +99,7 @@ namespace triagens {
 ///       of key events (linenoise, readline)
 ////////////////////////////////////////////////////////////////////////////////
 
-    virtual char * getLine(char const *);
-
-////////////////////////////////////////////////////////////////////////////////
-/// @}
-////////////////////////////////////////////////////////////////////////////////
+      virtual char* getLine (char const*);
 
   };
 }

lib/Utilities/LinenoiseShell.cpp

@@ -157,7 +157,7 @@ bool LinenoiseShell::writeHistory() {
   return true;
 }
 
-char * LinenoiseShell::getLine(char const * input) {
+char* LinenoiseShell::getLine(char const* input) {
   return linenoise(input);
 }
 

lib/Utilities/LinenoiseShell.h

@@ -96,7 +96,7 @@ namespace triagens {
 ///       of key events (linenoise, readline)
 ////////////////////////////////////////////////////////////////////////////////
 
-    virtual char * getLine(char const *);
+    virtual char* getLine (char const*);
 
 ////////////////////////////////////////////////////////////////////////////////
 /// @}

lib/Utilities/ShellImplFactory.cpp

@@ -28,14 +28,14 @@
 /// @author Copyright 2011-2014, triAGENS GmbH, Cologne, Germany
 ////////////////////////////////////////////////////////////////////////////////
 
-
-
 #ifdef _WIN32
 #include "LinenoiseShell.h"
 #elif TRI_HAVE_LINENOISE
 #include "LinenoiseShell.h"
-#else
+#elif TRI_HAVE_READLINE
 #include "ReadlineShell.h"
+#else 
+#include "DummyShell.h"
 #endif
 
 #include "ShellImplFactory.h"
@@ -43,15 +43,19 @@
 using namespace triagens;
 using namespace std;
 
-ShellImplementation * ShellImplFactory::buildShell (string const & history, Completer * completer) {
+ShellImplementation* ShellImplFactory::buildShell (string const & history, 
+                                                   Completer* completer) {
 
 #ifdef _WIN32
   //under windows the readline is not compilable
   return new LinenoiseShell(history, completer);
 #elif defined TRI_HAVE_LINENOISE
   return new LinenoiseShell(history, completer);
-#else
+#elif defined TRI_HAVE_READLINE
   return new ReadlineShell(history, completer);
+#else
+  // last resort!
+  return new DummyShell(history, completer);
 #endif
 
 }

lib/Utilities/ShellImplementation.cpp

@@ -32,43 +32,46 @@
 #include "BasicsC/tri-strings.h"
 
 using namespace std;
-namespace triagens {
-  // -----------------------------------------------------------------------------
-  // --SECTION--                                         class ShellImplementation
-  // -----------------------------------------------------------------------------
 
-  // -----------------------------------------------------------------------------
-  // --SECTION--                                      constructors and destructors
-  // -----------------------------------------------------------------------------
+namespace triagens {
+
+// -----------------------------------------------------------------------------
+// --SECTION--                                         class ShellImplementation
+// -----------------------------------------------------------------------------
+
+// -----------------------------------------------------------------------------
+// --SECTION--                                      constructors and destructors
+// -----------------------------------------------------------------------------
 
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief constructs a new editor
 ////////////////////////////////////////////////////////////////////////////////
 
-  ShellImplementation::ShellImplementation (string const& history, Completer * completer)
+ShellImplementation::ShellImplementation (string const& history, 
+                                          Completer* completer)
   : _current(),
     _historyFilename(history),
     _state(STATE_NONE),
     _completer(completer) {
 
-  }
+}
 
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief destructor
 ////////////////////////////////////////////////////////////////////////////////
 
-  ShellImplementation::~ShellImplementation () {
-  }
+ShellImplementation::~ShellImplementation () {
+}
 
-  // -----------------------------------------------------------------------------
-  // --SECTION--                                                    public methods
-  // -----------------------------------------------------------------------------
+// -----------------------------------------------------------------------------
+// --SECTION--                                                    public methods
+// -----------------------------------------------------------------------------
 
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief line editor prompt
 ////////////////////////////////////////////////////////////////////////////////
 
-  char* ShellImplementation::prompt (char const* the_prompt) {
+char* ShellImplementation::prompt (char const* the_prompt) {
   string dotdot;
   char const* p = the_prompt;
   size_t len1 = strlen(the_prompt);
@@ -91,11 +94,11 @@ namespace triagens {
 
     p = dotdot.c_str();
 
-      if (result == 0) {
+    if (result == nullptr) {
 
       // give up, if the user pressed control-D on the top-most level
       if (_current.empty()) {
-          return 0;
+        return nullptr;
       }
 
       // otherwise clear current content
@@ -142,8 +145,10 @@ namespace triagens {
   _current.clear();
 
   return line;
-  }
 }
+
+}
+
 // -----------------------------------------------------------------------------
 // --SECTION--                                                       END-OF-FILE
 // -----------------------------------------------------------------------------

lib/Utilities/ShellImplementation.h

@@ -37,10 +37,13 @@
 namespace triagens {
 
   class ShellImplementation {
+
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief state of the console                                  protected types
 ////////////////////////////////////////////////////////////////////////////////
+
   protected:
+
     typedef enum {
       STATE_NONE = 0,
       STATE_OPENED,
@@ -49,11 +52,12 @@ namespace triagens {
     console_state_e;
 
   public:
+
 ////////////////////////////////////////////////////////////////////////////////
 ///                                               public constructor, destructor
 ////////////////////////////////////////////////////////////////////////////////
 
-    ShellImplementation (std::string const& history, Completer *);
+    ShellImplementation (std::string const& history, Completer*);
 
     virtual ~ShellImplementation ();
 
@@ -100,15 +104,11 @@ namespace triagens {
 /// @brief todo!!
 ////////////////////////////////////////////////////////////////////////////////
 
-    virtual char * getLine (const char*) = 0;
+    virtual char* getLine (const char*) = 0;
 
-////////////////////////////////////////////////////////////////////////////////
-/// @}
-////////////////////////////////////////////////////////////////////////////////
-
-    // -----------------------------------------------------------------------------
-    // --SECTION--                                               protected variables
-    // -----------------------------------------------------------------------------
+// -----------------------------------------------------------------------------
+// --SECTION--                                               protected variables
+// -----------------------------------------------------------------------------
 
   protected:
 
@@ -134,11 +134,13 @@ namespace triagens {
 /// @brief object which defines when the input is finished
 ////////////////////////////////////////////////////////////////////////////////
 
-    Completer * _completer;
+    Completer* _completer;
 
   };
 }
+
 #endif
+
 // -----------------------------------------------------------------------------
 // --SECTION--                                                       END-OF-FILE
 // -----------------------------------------------------------------------------