You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
82 lines
2.8 KiB
82 lines
2.8 KiB
#ifndef LPC_CREATE_H1118420718_INCLUDE_GUARD_
|
|
#define LPC_CREATE_H1118420718_INCLUDE_GUARD_
|
|
|
|
|
|
/* This file is part of indexlib.
|
|
* Copyright (C) 2005 Luís Pedro Coelho <luis@luispedro.org>
|
|
*
|
|
* Indexlib is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License, version 2, as
|
|
* published by the Free Software Foundation and available as file
|
|
* GPL_V2 which is distributed along with indexlib.
|
|
*
|
|
* Indexlib is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
* MA 02110-1301, USA
|
|
*
|
|
* In addition, as a special exception, the copyright holders give
|
|
* permission to link the code of this program with any edition of
|
|
* the TQt library by Trolltech AS, Norway (or with modified versions
|
|
* of TQt that use the same license as TQt), and distribute linked
|
|
* combinations including the two. You must obey the GNU General
|
|
* Public License in all respects for all of the code used other than
|
|
* TQt. If you modify this file, you may extend this exception to
|
|
* your version of the file, but you are not obligated to do so. If
|
|
* you do not wish to do so, delete this exception statement from
|
|
* your version.
|
|
*/
|
|
|
|
#include "index.h"
|
|
#include <memory>
|
|
|
|
|
|
namespace indexlib {
|
|
namespace index_type {
|
|
enum type {
|
|
none,
|
|
ifile = 1,
|
|
quotes = 2
|
|
};
|
|
}
|
|
/**
|
|
* Construct an index from a basename.
|
|
*
|
|
* Basename can be either a directory in which case the index will consist of a bunch of
|
|
* files in that directory all starting with "index" (this is the prefered usage: an index is a directory)
|
|
* or it can be any other partial file name in which casethis name will be the starting name of all the
|
|
* index files.
|
|
*
|
|
* If basename ends with '/' a directory is created if it does not exist.
|
|
*
|
|
* This will return something like "new quotes(basename)" but by using this, you do not need to include quotes.h
|
|
* which needs boost headers also.
|
|
*/
|
|
std::unique_ptr<index> create( const char* basename, index_type::type flags = index_type::quotes );
|
|
namespace open_flags {
|
|
enum type { none = 0,
|
|
create_ifile = index_type::ifile,
|
|
create_quotes = index_type::quotes,
|
|
fail_if_nonexistant };
|
|
}
|
|
std::unique_ptr<index> open( const char* basename, unsigned flags = open_flags::fail_if_nonexistant );
|
|
|
|
/**
|
|
* Removes the index.
|
|
*/
|
|
void remove( const char* basename );
|
|
/**
|
|
* Returns true if an index with that name exists, false otherwise
|
|
*/
|
|
bool exists( const char* basename );
|
|
}
|
|
|
|
|
|
|
|
#endif /* LPC_CREATE_H1118420718_INCLUDE_GUARD_ */
|