////////////////////////////////////////////////////////////////////////////////
/// @brief Aql, built-in AQL function
///
/// @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_FUNCTION_H
#define ARANGODB_AQL_FUNCTION_H 1

#include "Basics/Common.h"
#include "Aql/Functions.h"

namespace triagens {
  namespace aql {

    struct Function {

      enum Conversion {
        CONVERSION_NONE,
        CONVERSION_OPTIONAL,
        CONVERSION_REQUIRED
      };

// -----------------------------------------------------------------------------
// --SECTION--                                        constructors / destructors
// -----------------------------------------------------------------------------

      Function () = delete;

////////////////////////////////////////////////////////////////////////////////
/// @brief create the function
////////////////////////////////////////////////////////////////////////////////

      Function (std::string const& externalName,
                std::string const& internalName,
                std::string const& arguments,
                bool isCacheable,
                bool isDeterministic,
                bool canThrow,
                bool canRunOnDBServer,
                bool canPassArgumentsByReference,
                FunctionImplementation implementation = nullptr,
                ExecutionCondition = nullptr);

////////////////////////////////////////////////////////////////////////////////
/// @brief destroy the function
////////////////////////////////////////////////////////////////////////////////

      ~Function ();
      
// -----------------------------------------------------------------------------
// --SECTION--                                                    public methods
// -----------------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////////////
/// @brief checks if the function has been deprecated
////////////////////////////////////////////////////////////////////////////////

      inline bool isDeprecated () const {
        // currently there are no deprecated functions
        return false;
      }

////////////////////////////////////////////////////////////////////////////////
/// @brief return the number of required arguments
////////////////////////////////////////////////////////////////////////////////

      inline std::pair<size_t, size_t> numArguments () const {
        return std::make_pair(minRequiredArguments, maxRequiredArguments);
      }

////////////////////////////////////////////////////////////////////////////////
/// @brief whether or not a positional argument needs to be converted from a
/// collection parameter to a collection name parameter
////////////////////////////////////////////////////////////////////////////////
      
      inline Conversion getArgumentConversion (size_t position) const {
        if (position >= conversions.size()) {
          return CONVERSION_NONE;
        }
        return conversions[position];
      }

////////////////////////////////////////////////////////////////////////////////
/// @brief parse the argument list and set the minimum and maximum number of
/// arguments
////////////////////////////////////////////////////////////////////////////////

      void initializeArguments ();
      
// -----------------------------------------------------------------------------
// --SECTION--                                                  public variables
// -----------------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////////////
/// @brief function name (name used in JavaScript implementation)
////////////////////////////////////////////////////////////////////////////////

      std::string const       internalName;

////////////////////////////////////////////////////////////////////////////////
/// @brief function name (name visible to the end user)
////////////////////////////////////////////////////////////////////////////////

      std::string const       externalName;

////////////////////////////////////////////////////////////////////////////////
/// @brief function arguments
////////////////////////////////////////////////////////////////////////////////

      std::string const       arguments;

////////////////////////////////////////////////////////////////////////////////
/// @brief whether or not the function results may be cached by the query cache
////////////////////////////////////////////////////////////////////////////////

      bool const              isCacheable;

////////////////////////////////////////////////////////////////////////////////
/// @brief whether or not the function is deterministic (i.e. its results are
/// identical when called repeatedly with the same input values)
////////////////////////////////////////////////////////////////////////////////

      bool const              isDeterministic;

////////////////////////////////////////////////////////////////////////////////
/// @brief whether or not the function may throw a runtime exception
////////////////////////////////////////////////////////////////////////////////
      
      bool const              canThrow;

////////////////////////////////////////////////////////////////////////////////
/// @brief whether or not the function may be executed on DB servers
////////////////////////////////////////////////////////////////////////////////

      bool const              canRunOnDBServer;

////////////////////////////////////////////////////////////////////////////////
/// @brief whether or not the function can get its arguments passed by reference
////////////////////////////////////////////////////////////////////////////////

      bool const              canPassArgumentsByReference;

////////////////////////////////////////////////////////////////////////////////
/// @brief minimum number of required arguments
////////////////////////////////////////////////////////////////////////////////

      size_t                  minRequiredArguments;

////////////////////////////////////////////////////////////////////////////////
/// @brief maximum number of required arguments
////////////////////////////////////////////////////////////////////////////////

      size_t                  maxRequiredArguments;

////////////////////////////////////////////////////////////////////////////////
/// @brief C++ implementation of the function (maybe nullptr)
////////////////////////////////////////////////////////////////////////////////

      FunctionImplementation  implementation;

////////////////////////////////////////////////////////////////////////////////
/// @brief condition under which the C++ implementation of the function is 
/// executed (if returns false, the function will be executed as its JavaScript
/// variant)
////////////////////////////////////////////////////////////////////////////////

      ExecutionCondition      condition;

////////////////////////////////////////////////////////////////////////////////
/// @brief function argument conversion information
////////////////////////////////////////////////////////////////////////////////

      std::vector<Conversion> conversions;

////////////////////////////////////////////////////////////////////////////////
/// @brief maximum number of function arguments that can be used
////////////////////////////////////////////////////////////////////////////////

      static size_t const     MaxArguments = 65536;

    };

  }
}

#endif

// -----------------------------------------------------------------------------
// --SECTION--                                                       END-OF-FILE
// -----------------------------------------------------------------------------

// Local Variables:
// mode: outline-minor
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
// End: