include/xapian.h

00001 // xapian.h: Public interfaces for core Xapian library
00002 //
00003 // Copyright (C) 2003,2004,2005,2007 Olly Betts
00004 //
00005 // This program is free software; you can redistribute it and/or
00006 // modify it under the terms of the GNU General Public License as
00007 // published by the Free Software Foundation; either version 2 of the
00008 // License, or (at your option) any later version.
00009 //
00010 // This program is distributed in the hope that it will be useful,
00011 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00012 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00013 // GNU General Public License for more details.
00014 //
00015 // You should have received a copy of the GNU General Public License
00016 // along with this program; if not, write to the Free Software
00017 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00018 // 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 
00051 // Stemming
00052 #include <xapian/stem.h>
00053 
00054 // Unicode support
00055 #include <xapian/unicode.h>
00056 
00057 // Methods returning library version:
00058 
00059 #include <xapian/deprecated.h>
00060 #include <xapian/visibility.h>
00061 
00062 namespace Xapian {
00068 XAPIAN_VISIBILITY_DEFAULT
00069 const char * version_string();
00070 
00076 XAPIAN_VISIBILITY_DEFAULT
00077 XAPIAN_DEPRECATED(const char * xapian_version_string());
00078 
00083 XAPIAN_VISIBILITY_DEFAULT
00084 int major_version();
00085 
00091 XAPIAN_VISIBILITY_DEFAULT
00092 XAPIAN_DEPRECATED(int xapian_major_version());
00093 
00098 XAPIAN_VISIBILITY_DEFAULT
00099 int minor_version();
00100 
00106 XAPIAN_VISIBILITY_DEFAULT
00107 XAPIAN_DEPRECATED(int xapian_minor_version());
00108 
00113 XAPIAN_VISIBILITY_DEFAULT
00114 int revision();
00115 
00121 XAPIAN_VISIBILITY_DEFAULT
00122 XAPIAN_DEPRECATED(int xapian_revision());
00123 }
00124 
00125 #endif /* XAPIAN_INCLUDED_XAPIAN_H */

Documentation for Xapian (version 1.0.0).
Generated on 18 May 2007 by Doxygen 1.4.6.