include/xapian.h

Go to the documentation of this file.
00001 
00004 // Copyright (C) 2003,2004,2005,2007 Olly Betts
00005 //
00006 // This program is free software; you can redistribute it and/or modify
00007 // it under the terms of the GNU General Public License as published by
00008 // the Free Software Foundation; either version 2 of the License, or
00009 // (at your option) any later version.
00010 //
00011 // This program is distributed in the hope that it will be useful,
00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014 // GNU General Public License for more details.
00015 //
00016 // You should have received a copy of the GNU General Public License
00017 // along with this program; if not, write to the Free Software
00018 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
00019 
00020 #ifndef XAPIAN_INCLUDED_XAPIAN_H
00021 #define XAPIAN_INCLUDED_XAPIAN_H
00022 
00023 // Set defines for library version and check C++ ABI versions match.
00024 #include <xapian/version.h>
00025 
00026 // Types
00027 #include <xapian/types.h>
00028 
00029 // Exceptions
00030 #include <xapian/error.h>
00031 #include <xapian/errorhandler.h>
00032 
00033 // Access to databases, documents, etc.
00034 #include <xapian/database.h>
00035 #include <xapian/dbfactory.h>
00036 #include <xapian/document.h>
00037 #include <xapian/positioniterator.h>
00038 #include <xapian/postingiterator.h>
00039 #include <xapian/termiterator.h>
00040 #include <xapian/valueiterator.h>
00041 
00042 // Indexing
00043 #include <xapian/termgenerator.h>
00044 
00045 // Searching
00046 #include <xapian/enquire.h>
00047 #include <xapian/expanddecider.h>
00048 #include <xapian/query.h>
00049 #include <xapian/queryparser.h>
00050 #include <xapian/sorter.h>
00051 
00052 // Stemming
00053 #include <xapian/stem.h>
00054 
00055 // Unicode support
00056 #include <xapian/unicode.h>
00057 
00058 // ELF visibility annotations for GCC.
00059 #include <xapian/visibility.h>
00060 
00061 #include <xapian/deprecated.h>
00062 
00063 // Functions returning library version:
00064 
00065 namespace Xapian {
00071 XAPIAN_VISIBILITY_DEFAULT
00072 const char * version_string();
00073 
00079 XAPIAN_VISIBILITY_DEFAULT
00080 XAPIAN_DEPRECATED(const char * xapian_version_string());
00081 
00087 XAPIAN_VISIBILITY_DEFAULT
00088 int major_version();
00089 
00095 XAPIAN_VISIBILITY_DEFAULT
00096 XAPIAN_DEPRECATED(int xapian_major_version());
00097 
00103 XAPIAN_VISIBILITY_DEFAULT
00104 int minor_version();
00105 
00111 XAPIAN_VISIBILITY_DEFAULT
00112 XAPIAN_DEPRECATED(int xapian_minor_version());
00113 
00119 XAPIAN_VISIBILITY_DEFAULT
00120 int revision();
00121 
00127 XAPIAN_VISIBILITY_DEFAULT
00128 XAPIAN_DEPRECATED(int xapian_revision());
00129 }
00130 
00131 #endif /* XAPIAN_INCLUDED_XAPIAN_H */

Documentation for Xapian (version 1.0.10).
Generated on 24 Dec 2008 by Doxygen 1.5.2.