mirror of https://gitee.com/bigwinds/arangodb
105 lines
3.7 KiB
C
105 lines
3.7 KiB
C
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief In-query functions
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2010-2012 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 triAGENS GmbH, Cologne, Germany
|
|
///
|
|
/// @author Jan Steemann
|
|
/// @author Copyright 2012, triagens GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef TRIAGENS_DURHAM_VOC_BASE_QUERY_FUNCTIONS_H
|
|
#define TRIAGENS_DURHAM_VOC_BASE_QUERY_FUNCTIONS_H 1
|
|
|
|
#include <BasicsC/common.h>
|
|
#include <BasicsC/associative.h>
|
|
#include <BasicsC/hashes.h>
|
|
#include <BasicsC/strings.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @addtogroup VocBase
|
|
/// @{
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief query function data structure
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
typedef struct TRI_query_function_s {
|
|
char* _externalName;
|
|
char* _internalName;
|
|
int _minArgs;
|
|
int _maxArgs;
|
|
}
|
|
TRI_query_function_t;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief initialise the array with the function declarations
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
TRI_associative_pointer_t* TRI_InitialiseQueryFunctions (void);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief free the array with the function declarations
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void TRI_FreeQueryFunctions (TRI_associative_pointer_t*);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief check if a function name is valid
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool TRI_IsValidQueryFunction (TRI_associative_pointer_t*, const char* const);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief get internal function name for an external one
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
char* TRI_GetInternalNameQueryFunction (TRI_associative_pointer_t*, const char* const);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief register a function name
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
bool TRI_RegisterQueryFunction (TRI_associative_pointer_t*,
|
|
const char* const,
|
|
const char* const,
|
|
const int,
|
|
const int);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @}
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @\\}\\)"
|
|
// End:
|