/usr/include/CLucene/store/FSDirectory.h is in libclucene-dev 2.3.3.4-4build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | /*------------------------------------------------------------------------------
* Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team
*
* Distributable under the terms of either the Apache License (Version 2.0) or
* the GNU Lesser General Public License, as specified in the COPYING file.
------------------------------------------------------------------------------*/
#ifndef _lucene_store_FSDirectory_
#define _lucene_store_FSDirectory_
#include "Directory.h"
#include "IndexInput.h"
#include "IndexOutput.h"
#include <string>
#include <vector>
CL_CLASS_DEF(util,StringBuffer)
CL_NS_DEF(store)
/**
* Straightforward implementation of {@link lucene::store::Directory} as a directory of files.
* <p>If the system property 'disableLuceneLocks' has the String value of
* "true", lock creation will be disabled.
*
* @see Directory
*/
class CLUCENE_EXPORT FSDirectory:public Directory{
private:
class FSIndexOutput;
class FSIndexInput;
friend class FSDirectory::FSIndexOutput;
friend class FSDirectory::FSIndexInput;
int filemode;
protected:
FSDirectory();
virtual void init(const char* path, LockFactory* lockFactory = NULL);
void priv_getFN(char* buffer, const char* name) const;
private:
std::string directory;
int refCount;
void create();
static const char* LOCK_DIR;
static const char* getLockDir();
char* getLockPrefix() const;
static bool disableLocks;
bool useMMap;
protected:
/// Removes an existing file in the directory.
bool doDeleteFile(const char* name);
public:
///Destructor - only call this if you are sure the directory
///is not being used anymore. Otherwise use the ref-counting
///facilities of _CLDECDELETE
virtual ~FSDirectory();
/// Get a list of strings, one for each file in the directory.
bool list(std::vector<std::string>* names) const;
/// Returns true iff a file with the given name exists.
bool fileExists(const char* name) const;
/// Returns the text name of the directory
const char* getDirName() const; ///<returns reference
/**
* Deprecated, see getDirectory(file, lockFactory)
* Use IndexWriter's create flag, instead, to
* create a new index.
*/
static _CL_DEPRECATED( getDirectory(file,lockFactory) )FSDirectory* getDirectory(const char* file, const bool create, LockFactory* lockFactory=NULL);
/**
Returns the directory instance for the named location.
Do not delete this instance, only use close, otherwise other instances
will lose this instance.
<p>Directories are cached, so that, for a given canonical path, the same
FSDirectory instance will always be returned. This permits
synchronization on directories.
@param file the path to the directory.
@param create if true, create, or erase any existing contents.
@return the FSDirectory for the named file.
*/
static FSDirectory* getDirectory(const char* file, LockFactory* lockFactory=NULL);
/// Returns the time the named file was last modified.
int64_t fileModified(const char* name) const;
//static
/// Returns the time the named file was last modified.
static int64_t fileModified(const char* dir, const char* name);
//static
/// Returns the length in bytes of a file in the directory.
int64_t fileLength(const char* name) const;
/// Returns a stream reading an existing file.
virtual bool openInput(const char* name, IndexInput*& ret, CLuceneError& err, int32_t bufferSize = -1);
/// Renames an existing file in the directory.
void renameFile(const char* from, const char* to);
/** Set the modified time of an existing file to now. */
void touchFile(const char* name);
/// Creates a new, empty file in the directory with the given name.
/// Returns a stream writing this file.
virtual IndexOutput* createOutput(const char* name);
///Decrease the ref-count to the directory by one. If
///the object is no longer needed, then the object is
///removed from the directory pool.
void close();
/**
* If MMap is available, this can disable use of
* mmap reading.
*/
void setUseMMap(bool value);
/**
* Gets whether the directory is using MMap for inputstreams.
*/
bool getUseMMap() const;
std::string toString() const;
static const char* getClassName();
const char* getObjectName() const;
/**
* Set whether Lucene's use of lock files is disabled. By default,
* lock files are enabled. They should only be disabled if the index
* is on a read-only medium like a CD-ROM.
*/
static void setDisableLocks(bool doDisableLocks);
/**
* Returns whether Lucene's use of lock files is disabled.
* @return true if locks are disabled, false if locks are enabled.
*/
static bool getDisableLocks();
/**
* Sets the file mode for new files. This is passed to new output streams
* and to the lock factory. The mode should be a valid octal file mode for
* the 3rd parameter of the file open function (such as 0644)
*
* Tip: _tcstoi64(_T("644"), NULL, 8) is also a valid way of
* creating a file mode
*/
void setFileMode(int mode);
/**
* Gets the file mode for new files
*/
int getFileMode();
};
CL_NS_END
#endif
|