////////////////////////////////////////////////////////////////////////////////
/// 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_MMFILES_MMFILES_FULLTEXT_LIST_H
#define ARANGOD_MMFILES_MMFILES_FULLTEXT_LIST_H 1

#include <set>

#include "VocBase/voc-types.h"
#include "mmfiles-fulltext-common.h"

/// @brief typedef for a fulltext list
typedef void TRI_fulltext_list_t;

/// @brief typedef for a fulltext list entry
typedef TRI_voc_rid_t TRI_fulltext_list_entry_t;

/// @brief clone a list
void TRI_CloneListMMFilesFulltextIndex(TRI_fulltext_list_t const*,
                                       std::set<TRI_voc_rid_t>& result);

TRI_fulltext_list_t* TRI_CloneListMMFilesFulltextIndex(TRI_fulltext_list_t const*);

/// @brief create a list
TRI_fulltext_list_t* TRI_CreateListMMFilesFulltextIndex(uint32_t);

/// @brief free a list
void TRI_FreeListMMFilesFulltextIndex(TRI_fulltext_list_t*);

/// @brief get the memory usage of a list
size_t TRI_MemoryListMMFilesFulltextIndex(TRI_fulltext_list_t const*);

/// @brief insert an element into a list
/// this might free the old list and allocate a new, bigger one
TRI_fulltext_list_t* TRI_InsertListMMFilesFulltextIndex(TRI_fulltext_list_t*,
                                                        TRI_fulltext_list_entry_t);

/// @brief remove an element from a list
/// this might free the old list and allocate a new, smaller one
TRI_fulltext_list_t* TRI_RemoveListMMFilesFulltextIndex(TRI_fulltext_list_t*,
                                                        TRI_fulltext_list_entry_t);

#endif