////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2016 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
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGOD_AQL_FUNCTIONS_H
#define ARANGOD_AQL_FUNCTIONS_H 1

#include "Basics/Common.h"
#include "Aql/AqlValue.h"
#include "Utils/AqlTransaction.h"

#include <functional>

namespace arangodb {
namespace aql {

class Query;

typedef std::function<bool()> ExecutionCondition;

typedef std::vector<AqlValue$> VPackFunctionParameters;

typedef std::function<AqlValue$(arangodb::aql::Query*, arangodb::AqlTransaction*,
                                VPackFunctionParameters const&)>
    FunctionImplementation;

struct Functions {
  //////////////////////////////////////////////////////////////////////////////
  /// @brief called before a query starts
  /// has the chance to set up any thread-local storage
  //////////////////////////////////////////////////////////////////////////////

  static void InitializeThreadContext();

  //////////////////////////////////////////////////////////////////////////////
  /// @brief called when a query ends
  /// its responsibility is to clear any thread-local storage
  //////////////////////////////////////////////////////////////////////////////

  static void DestroyThreadContext();

  static AqlValue$ IsNull(arangodb::aql::Query*, arangodb::AqlTransaction*,
                          VPackFunctionParameters const&);
  static AqlValue$ IsBool(arangodb::aql::Query*, arangodb::AqlTransaction*,
                          VPackFunctionParameters const&);
  static AqlValue$ IsNumber(arangodb::aql::Query*, arangodb::AqlTransaction*,
                            VPackFunctionParameters const&);
  static AqlValue$ IsString(arangodb::aql::Query*, arangodb::AqlTransaction*,
                            VPackFunctionParameters const&);
  static AqlValue$ IsArray(arangodb::aql::Query*, arangodb::AqlTransaction*,
                           VPackFunctionParameters const&);
  static AqlValue$ IsObject(arangodb::aql::Query*, arangodb::AqlTransaction*,
                            VPackFunctionParameters const&);
  static AqlValue$ ToNumber(arangodb::aql::Query*, arangodb::AqlTransaction*,
                            VPackFunctionParameters const&);
  static AqlValue$ ToString(arangodb::aql::Query*, arangodb::AqlTransaction*,
                            VPackFunctionParameters const&);
  static AqlValue$ ToBool(arangodb::aql::Query*, arangodb::AqlTransaction*,
                          VPackFunctionParameters const&);
  static AqlValue$ ToArray(arangodb::aql::Query*, arangodb::AqlTransaction*,
                           VPackFunctionParameters const&);
  static AqlValue$ Length(arangodb::aql::Query*, arangodb::AqlTransaction*,
                          VPackFunctionParameters const&);
  static AqlValue$ First(arangodb::aql::Query*, arangodb::AqlTransaction*,
                         VPackFunctionParameters const&);
  static AqlValue$ Last(arangodb::aql::Query*, arangodb::AqlTransaction*,
                        VPackFunctionParameters const&);
  static AqlValue$ Nth(arangodb::aql::Query*, arangodb::AqlTransaction*,
                       VPackFunctionParameters const&);
  static AqlValue$ Concat(arangodb::aql::Query*, arangodb::AqlTransaction*,
                          VPackFunctionParameters const&);
  static AqlValue$ Like(arangodb::aql::Query*, arangodb::AqlTransaction*,
                        VPackFunctionParameters const&);
  static AqlValue$ Passthru(arangodb::aql::Query*, arangodb::AqlTransaction*,
                            VPackFunctionParameters const&);
  static AqlValue$ Unset(arangodb::aql::Query*, arangodb::AqlTransaction*,
                         VPackFunctionParameters const&);
  static AqlValue$ UnsetRecursive(arangodb::aql::Query*,
                                  arangodb::AqlTransaction*,
                                  VPackFunctionParameters const&);
  static AqlValue$ Keep(arangodb::aql::Query*, arangodb::AqlTransaction*,
                        VPackFunctionParameters const&);
  static AqlValue$ Merge(arangodb::aql::Query*, arangodb::AqlTransaction*,
                         VPackFunctionParameters const&);
  static AqlValue$ MergeRecursive(arangodb::aql::Query*,
                                  arangodb::AqlTransaction*,
                                  VPackFunctionParameters const&);
  static AqlValue$ Has(arangodb::aql::Query*, arangodb::AqlTransaction*,
                       VPackFunctionParameters const&);
  static AqlValue$ Attributes(arangodb::aql::Query*, arangodb::AqlTransaction*,
                              VPackFunctionParameters const&);
  static AqlValue$ Values(arangodb::aql::Query*, arangodb::AqlTransaction*,
                          VPackFunctionParameters const&);
  static AqlValue$ Min(arangodb::aql::Query*, arangodb::AqlTransaction*,
                       VPackFunctionParameters const&);
  static AqlValue$ Max(arangodb::aql::Query*, arangodb::AqlTransaction*,
                       VPackFunctionParameters const&);
  static AqlValue$ Sum(arangodb::aql::Query*, arangodb::AqlTransaction*,
                       VPackFunctionParameters const&);
  static AqlValue$ Average(arangodb::aql::Query*, arangodb::AqlTransaction*,
                           VPackFunctionParameters const&);
  static AqlValue$ Md5(arangodb::aql::Query*, arangodb::AqlTransaction*,
                       VPackFunctionParameters const&);
  static AqlValue$ Sha1(arangodb::aql::Query*, arangodb::AqlTransaction*,
                        VPackFunctionParameters const&);
  static AqlValue$ Unique(arangodb::aql::Query*, arangodb::AqlTransaction*,
                          VPackFunctionParameters const&);
  static AqlValue$ SortedUnique(arangodb::aql::Query*,
                                arangodb::AqlTransaction*,
                                VPackFunctionParameters const&);
  static AqlValue$ Union(arangodb::aql::Query*, arangodb::AqlTransaction*,
                         VPackFunctionParameters const&);
  static AqlValue$ UnionDistinct(arangodb::aql::Query*,
                                 arangodb::AqlTransaction*,
                                 VPackFunctionParameters const&);
  static AqlValue$ Intersection(arangodb::aql::Query*,
                                arangodb::AqlTransaction*,
                                VPackFunctionParameters const&);
  static AqlValue$ Neighbors(arangodb::aql::Query*, arangodb::AqlTransaction*,
                             VPackFunctionParameters const&);
  static AqlValue$ Near(arangodb::aql::Query*, arangodb::AqlTransaction*,
                        VPackFunctionParameters const&);
  static AqlValue$ Within(arangodb::aql::Query*, arangodb::AqlTransaction*,
                          VPackFunctionParameters const&);
  static AqlValue$ Flatten(arangodb::aql::Query*, arangodb::AqlTransaction*,
                           VPackFunctionParameters const&);
  static AqlValue$ Zip(arangodb::aql::Query*, arangodb::AqlTransaction*,
                       VPackFunctionParameters const&);
  static AqlValue$ ParseIdentifier(arangodb::aql::Query*,
                                   arangodb::AqlTransaction*,
                                   VPackFunctionParameters const&);
  static AqlValue$ Minus(arangodb::aql::Query*, arangodb::AqlTransaction*,
                         VPackFunctionParameters const&);
  static AqlValue$ Document(arangodb::aql::Query*, arangodb::AqlTransaction*,
                            VPackFunctionParameters const&);
  static AqlValue$ Edges(arangodb::aql::Query*, arangodb::AqlTransaction*,
                         VPackFunctionParameters const&);
  static AqlValue$ Round(arangodb::aql::Query*, arangodb::AqlTransaction*,
                         VPackFunctionParameters const&);
  static AqlValue$ Abs(arangodb::aql::Query*, arangodb::AqlTransaction*,
                       VPackFunctionParameters const&);
  static AqlValue$ Ceil(arangodb::aql::Query*, arangodb::AqlTransaction*,
                        VPackFunctionParameters const&);
  static AqlValue$ Floor(arangodb::aql::Query*, arangodb::AqlTransaction*,
                         VPackFunctionParameters const&);
  static AqlValue$ Sqrt(arangodb::aql::Query*, arangodb::AqlTransaction*,
                        VPackFunctionParameters const&);
  static AqlValue$ Pow(arangodb::aql::Query*, arangodb::AqlTransaction*,
                       VPackFunctionParameters const&);
  static AqlValue$ Rand(arangodb::aql::Query*, arangodb::AqlTransaction*,
                        VPackFunctionParameters const&);
  static AqlValue$ FirstDocument(arangodb::aql::Query*,
                                 arangodb::AqlTransaction*,
                                 VPackFunctionParameters const&);
  static AqlValue$ FirstList(arangodb::aql::Query*, arangodb::AqlTransaction*,
                             VPackFunctionParameters const&);
  static AqlValue$ Push(arangodb::aql::Query*, arangodb::AqlTransaction*,
                        VPackFunctionParameters const&);
  static AqlValue$ Pop(arangodb::aql::Query*, arangodb::AqlTransaction*,
                       VPackFunctionParameters const&);
  static AqlValue$ Append(arangodb::aql::Query*, arangodb::AqlTransaction*,
                          VPackFunctionParameters const&);
  static AqlValue$ Unshift(arangodb::aql::Query*, arangodb::AqlTransaction*,
                           VPackFunctionParameters const&);
  static AqlValue$ Shift(arangodb::aql::Query*, arangodb::AqlTransaction*,
                         VPackFunctionParameters const&);
  static AqlValue$ RemoveValue(arangodb::aql::Query*, arangodb::AqlTransaction*,
                               VPackFunctionParameters const&);
  static AqlValue$ RemoveValues(arangodb::aql::Query*,
                                arangodb::AqlTransaction*,
                                VPackFunctionParameters const&);
  static AqlValue$ RemoveNth(arangodb::aql::Query*, arangodb::AqlTransaction*,
                             VPackFunctionParameters const&);
  static AqlValue$ NotNull(arangodb::aql::Query*, arangodb::AqlTransaction*,
                           VPackFunctionParameters const&);
  static AqlValue$ CurrentDatabase(arangodb::aql::Query*,
                                   arangodb::AqlTransaction*,
                                   VPackFunctionParameters const&);
  static AqlValue$ CollectionCount(arangodb::aql::Query*,
                                   arangodb::AqlTransaction*,
                                   VPackFunctionParameters const&);
  static AqlValue$ VarianceSample(arangodb::aql::Query*,
                                  arangodb::AqlTransaction*,
                                  VPackFunctionParameters const&);
  static AqlValue$ VariancePopulation(arangodb::aql::Query*,
                                      arangodb::AqlTransaction*,
                                      VPackFunctionParameters const&);
  static AqlValue$ StdDevSample(arangodb::aql::Query*,
                                arangodb::AqlTransaction*,
                                VPackFunctionParameters const&);
  static AqlValue$ StdDevPopulation(arangodb::aql::Query*,
                                    arangodb::AqlTransaction*,
                                    VPackFunctionParameters const&);
  static AqlValue$ Median(arangodb::aql::Query*, arangodb::AqlTransaction*,
                          VPackFunctionParameters const&);
  static AqlValue$ Percentile(arangodb::aql::Query*, arangodb::AqlTransaction*,
                              VPackFunctionParameters const&);
  static AqlValue$ Range(arangodb::aql::Query*, arangodb::AqlTransaction*,
                         VPackFunctionParameters const&);
  static AqlValue$ Position(arangodb::aql::Query*, arangodb::AqlTransaction*,
                            VPackFunctionParameters const&);
  static AqlValue$ Fulltext(arangodb::aql::Query*, arangodb::AqlTransaction*,
                            VPackFunctionParameters const&);
  static AqlValue$ IsSameCollection(arangodb::aql::Query*,
                                    arangodb::AqlTransaction*,
                                    VPackFunctionParameters const&);
};
}
}

#endif