1
0
Fork 0
arangodb/Ahuacatl/ahuacatl-variable.c

143 lines
4.9 KiB
C

////////////////////////////////////////////////////////////////////////////////
/// @brief Ahuacatl, variables
///
/// @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
////////////////////////////////////////////////////////////////////////////////
#include "Ahuacatl/ahuacatl-variable.h"
// -----------------------------------------------------------------------------
// --SECTION-- constructors / destructors
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief register a new variable
////////////////////////////////////////////////////////////////////////////////
TRI_aql_variable_t* TRI_CreateVariableAql (const char* const name,
const size_t idx) {
TRI_aql_variable_t* variable;
variable = (TRI_aql_variable_t*) TRI_Allocate(TRI_UNKNOWN_MEM_ZONE, sizeof(TRI_aql_variable_t), false);
if (!variable) {
return NULL;
}
variable->_name = TRI_DuplicateString(name);
if (!variable->_name) {
TRI_FreeVariableAql(variable);
return NULL;
}
variable->_index = idx;
return variable;
}
////////////////////////////////////////////////////////////////////////////////
/// @brief free an existing variable
////////////////////////////////////////////////////////////////////////////////
void TRI_FreeVariableAql (TRI_aql_variable_t* const variable) {
assert(variable);
if (variable->_name) {
TRI_Free(TRI_UNKNOWN_MEM_ZONE, variable->_name);
}
TRI_Free(TRI_UNKNOWN_MEM_ZONE, variable);
}
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- public functions
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief hash variable
////////////////////////////////////////////////////////////////////////////////
uint64_t TRI_HashVariableAql (TRI_associative_pointer_t* array,
void const* element) {
TRI_aql_variable_t* variable = (TRI_aql_variable_t*) element;
return TRI_FnvHashString(variable->_name);
}
////////////////////////////////////////////////////////////////////////////////
/// @brief comparison function used to determine variable equality
////////////////////////////////////////////////////////////////////////////////
bool TRI_EqualVariableAql (TRI_associative_pointer_t* array,
void const* key,
void const* element) {
TRI_aql_variable_t* variable = (TRI_aql_variable_t*) element;
return TRI_EqualString(key, variable->_name);
}
////////////////////////////////////////////////////////////////////////////////
/// @brief checks if a variable name follows the required naming convention
////////////////////////////////////////////////////////////////////////////////
bool TRI_IsValidVariableNameAql (const char* const name) {
assert(name);
if (strlen(name) == 0) {
// name must be at least one char long
return false;
}
if (*name == '_') {
// name must not start with an underscore
return false;
}
// everything else is allowed
return true;
}
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// Local Variables:
// mode: outline-minor
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @\\}\\)"
// End: