diff options
Diffstat (limited to 'rep/usr/include/xapian')
| -rw-r--r-- | rep/usr/include/xapian/base.h.gcov.html | 239 | ||||
| -rw-r--r-- | rep/usr/include/xapian/database.h.gcov.html | 803 | ||||
| -rw-r--r-- | rep/usr/include/xapian/document.h.gcov.html | 267 | ||||
| -rw-r--r-- | rep/usr/include/xapian/enquire.h.gcov.html | 1361 | ||||
| -rw-r--r-- | rep/usr/include/xapian/error.h.gcov.html | 822 | ||||
| -rw-r--r-- | rep/usr/include/xapian/expanddecider.h.gcov.html | 155 | ||||
| -rw-r--r-- | rep/usr/include/xapian/index.html | 173 | ||||
| -rw-r--r-- | rep/usr/include/xapian/postingiterator.h.gcov.html | 230 | ||||
| -rw-r--r-- | rep/usr/include/xapian/query.h.gcov.html | 520 | ||||
| -rw-r--r-- | rep/usr/include/xapian/termgenerator.h.gcov.html | 226 | ||||
| -rw-r--r-- | rep/usr/include/xapian/termiterator.h.gcov.html | 216 | ||||
| -rw-r--r-- | rep/usr/include/xapian/unicode.h.gcov.html | 433 |
12 files changed, 0 insertions, 5445 deletions
diff --git a/rep/usr/include/xapian/base.h.gcov.html b/rep/usr/include/xapian/base.h.gcov.html deleted file mode 100644 index 3717ae6..0000000 --- a/rep/usr/include/xapian/base.h.gcov.html +++ /dev/null @@ -1,239 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian/base.h</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - base.h</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">11</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">45.5 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">5</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <table cellpadding=0 cellspacing=0 border=0> - <tr> - <td><br></td> - </tr> - <tr> - <td><pre class="source"> -<span class="lineNum"> 1 </span> : /* base.h: Reference-counted pointers -<span class="lineNum"> 2 </span> : * -<span class="lineNum"> 3 </span> : * Copyright 1999,2000,2001 BrightStation PLC -<span class="lineNum"> 4 </span> : * Copyright 2002 Ananova Ltd -<span class="lineNum"> 5 </span> : * Copyright 2002,2003,2004,2007 Olly Betts -<span class="lineNum"> 6 </span> : * -<span class="lineNum"> 7 </span> : * This program is free software; you can redistribute it and/or -<span class="lineNum"> 8 </span> : * modify it under the terms of the GNU General Public License as -<span class="lineNum"> 9 </span> : * published by the Free Software Foundation; either version 2 of the -<span class="lineNum"> 10 </span> : * License, or (at your option) any later version. -<span class="lineNum"> 11 </span> : * -<span class="lineNum"> 12 </span> : * This program is distributed in the hope that it will be useful, -<span class="lineNum"> 13 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of -<span class="lineNum"> 14 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -<span class="lineNum"> 15 </span> : * GNU General Public License for more details. -<span class="lineNum"> 16 </span> : * -<span class="lineNum"> 17 </span> : * You should have received a copy of the GNU General Public License -<span class="lineNum"> 18 </span> : * along with this program; if not, write to the Free Software -<span class="lineNum"> 19 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 -<span class="lineNum"> 20 </span> : * USA -<span class="lineNum"> 21 </span> : */ -<span class="lineNum"> 22 </span> : -<span class="lineNum"> 23 </span> : #ifndef XAPIAN_INCLUDED_BASE_H -<span class="lineNum"> 24 </span> : #define XAPIAN_INCLUDED_BASE_H -<span class="lineNum"> 25 </span> : -<span class="lineNum"> 26 </span> : #include <xapian/deprecated.h> -<span class="lineNum"> 27 </span> : -<span class="lineNum"> 28 </span> : namespace Xapian { -<span class="lineNum"> 29 </span> : namespace Internal { -<span class="lineNum"> 30 </span> : -<span class="lineNum"> 31 </span> : /** @internal Reference counted internal classes should inherit from RefCntBase. -<span class="lineNum"> 32 </span> : * -<span class="lineNum"> 33 </span> : * This gives the object a reference count used by RefCntPtr. -<span class="lineNum"> 34 </span> : */ -<span class="lineNum"> 35 </span> : class RefCntBase { -<span class="lineNum"> 36 </span> : /* Note: We never delete a pointer to a subclass of RefCntBase using -<span class="lineNum"> 37 </span> : * a RefCntBase *, so we don't need a virtual destructor here. -<span class="lineNum"> 38 </span> : */ -<span class="lineNum"> 39 </span> : protected: -<span class="lineNum"> 40 </span> : /** The copy constructor. -<span class="lineNum"> 41 </span> : * -<span class="lineNum"> 42 </span> : * This is protected since it'll only be used by derived classes, -<span class="lineNum"> 43 </span> : * which should only rarely need copying (this is, after all, a -<span class="lineNum"> 44 </span> : * refcount implementation). Sometimes it's needed, though, -<span class="lineNum"> 45 </span> : * since we need to zero ref_count in the copy. -<span class="lineNum"> 46 </span> : */ -<span class="lineNum"> 47 </span> : RefCntBase(const RefCntBase &) : ref_count(0) { } -<span class="lineNum"> 48 </span> : -<span class="lineNum"> 49 </span> : public: -<span class="lineNum"> 50 </span> : /// The constructor, which initialises the ref_count to 0. -<span class="lineNum"> 51 </span> : RefCntBase() : ref_count(0) { } -<span class="lineNum"> 52 </span> : -<span class="lineNum"> 53 </span> : typedef unsigned int ref_count_t; -<span class="lineNum"> 54 </span> : -<span class="lineNum"> 55 </span> : /** The actual reference count. It's mutable so we can have reference -<span class="lineNum"> 56 </span> : * counting work with const pointers. -<span class="lineNum"> 57 </span> : */ -<span class="lineNum"> 58 </span> : mutable ref_count_t ref_count; -<span class="lineNum"> 59 </span> : }; -<span class="lineNum"> 60 </span> : -<span class="lineNum"> 61 </span> : /** @internal A reference-counted pointer. Can be used with any -<span class="lineNum"> 62 </span> : * class derived from RefCntBase, as long as it is allocated -<span class="lineNum"> 63 </span> : * on the heap by new (not new[]!). -<span class="lineNum"> 64 </span> : */ -<span class="lineNum"> 65 </span> : template <class T> -<span class="lineNum"> 66 </span> : class RefCntPtr { -<span class="lineNum"> 67 </span> : private: -<span class="lineNum"> 68 </span> : T *dest; -<span class="lineNum"> 69 </span> : -<span class="lineNum"> 70 </span> : public: -<span class="lineNum"> 71 </span> : T *operator->() const; -<span class="lineNum"> 72 </span> : T &operator*() const; -<span class="lineNum"> 73 </span> : T *get() const; -<span class="lineNum"> 74 </span> : /** Make a RefCntPtr for an object which may already -<span class="lineNum"> 75 </span> : * have reference counted pointers. -<span class="lineNum"> 76 </span> : * -<span class="lineNum"> 77 </span> : * You usually pass in a newly created object, or an object may pass -<span class="lineNum"> 78 </span> : * in "this" to get a RefCntPtr to itself to pass to other classes. -<span class="lineNum"> 79 </span> : * (e.g. a database might pass a newly created postlist a reference -<span class="lineNum"> 80 </span> : * counted pointer to itself.) -<span class="lineNum"> 81 </span> : */ -<span class="lineNum"> 82 </span> : RefCntPtr(T *dest_); -<span class="lineNum"> 83 </span> : RefCntPtr(); -<span class="lineNum"> 84 </span> : RefCntPtr(const RefCntPtr &other); -<span class="lineNum"> 85 </span> : void operator=(const RefCntPtr &other); -<span class="lineNum"> 86 </span> : void operator=(T *dest_); -<span class="lineNum"> 87 </span> : ~RefCntPtr(); -<span class="lineNum"> 88 </span> : -<span class="lineNum"> 89 </span> : template <class U> -<span class="lineNum"> 90 </span> : RefCntPtr(const RefCntPtr<U> &other); -<span class="lineNum"> 91 </span> : }; -<span class="lineNum"> 92 </span> : -<span class="lineNum"> 93 </span> : template <class T> -<span class="lineNum"> 94 </span><span class="lineCov"> 19 : inline RefCntPtr<T>::RefCntPtr(T *dest_) : dest(dest_)</span> -<span class="lineNum"> 95 </span> : { -<span class="lineNum"> 96 </span><span class="lineCov"> 19 : if (dest) ++dest->ref_count;</span> -<span class="lineNum"> 97 </span><span class="lineCov"> 19 : }</span> -<span class="lineNum"> 98 </span> : -<span class="lineNum"> 99 </span> : template <class T> -<span class="lineNum"> 100 </span> : inline RefCntPtr<T>::RefCntPtr() : dest(0) -<span class="lineNum"> 101 </span> : { -<span class="lineNum"> 102 </span> : } -<span class="lineNum"> 103 </span> : -<span class="lineNum"> 104 </span> : template <class T> -<span class="lineNum"> 105 </span> : inline RefCntPtr<T>::RefCntPtr(const RefCntPtr &other) : dest(other.dest) -<span class="lineNum"> 106 </span> : { -<span class="lineNum"> 107 </span> : if (dest) ++dest->ref_count; -<span class="lineNum"> 108 </span> : } -<span class="lineNum"> 109 </span> : -<span class="lineNum"> 110 </span> : template <class T> -<span class="lineNum"> 111 </span> : inline void RefCntPtr<T>::operator=(const RefCntPtr &other) { -<span class="lineNum"> 112 </span> : operator=(other.dest); -<span class="lineNum"> 113 </span> : } -<span class="lineNum"> 114 </span> : -<span class="lineNum"> 115 </span> : template <class T> -<span class="lineNum"> 116 </span> : inline void RefCntPtr<T>::operator=(T *dest_) { -<span class="lineNum"> 117 </span> : // check if we're assigning a pointer to itself -<span class="lineNum"> 118 </span> : if (dest == dest_) return; -<span class="lineNum"> 119 </span> : -<span class="lineNum"> 120 </span> : // copy the new dest in before we delete the old to avoid a small -<span class="lineNum"> 121 </span> : // window in which dest points to a deleted object -<span class="lineNum"> 122 </span> : // FIXME: if pointer assignment isn't atomic, we ought to use locking... -<span class="lineNum"> 123 </span> : T *old_dest = dest; -<span class="lineNum"> 124 </span> : dest = dest_; -<span class="lineNum"> 125 </span> : if (dest) ++dest->ref_count; -<span class="lineNum"> 126 </span> : if (old_dest && --old_dest->ref_count == 0) delete old_dest; -<span class="lineNum"> 127 </span> : } -<span class="lineNum"> 128 </span> : -<span class="lineNum"> 129 </span> : template <class T> -<span class="lineNum"> 130 </span><span class="lineNoCov"> 0 : inline RefCntPtr<T>::~RefCntPtr()</span> -<span class="lineNum"> 131 </span> : { -<span class="lineNum"> 132 </span><span class="lineNoCov"> 0 : if (dest && --dest->ref_count == 0) {</span> -<span class="lineNum"> 133 </span> : // zero before we delete to avoid a small window in which dest points -<span class="lineNum"> 134 </span> : // to a deleted object -<span class="lineNum"> 135 </span> : // FIXME: if pointer assignment isn't atomic, we ought to use locking... -<span class="lineNum"> 136 </span><span class="lineNoCov"> 0 : T * condemned = dest;</span> -<span class="lineNum"> 137 </span><span class="lineNoCov"> 0 : dest = 0;</span> -<span class="lineNum"> 138 </span><span class="lineNoCov"> 0 : delete condemned;</span> -<span class="lineNum"> 139 </span> : } -<span class="lineNum"> 140 </span><span class="lineNoCov"> 0 : }</span> -<span class="lineNum"> 141 </span> : -<span class="lineNum"> 142 </span> : template <class T> -<span class="lineNum"> 143 </span> : template <class U> -<span class="lineNum"> 144 </span> : inline -<span class="lineNum"> 145 </span> : RefCntPtr<T>::RefCntPtr(const RefCntPtr<U> &other) -<span class="lineNum"> 146 </span> : : dest(other.get()) -<span class="lineNum"> 147 </span> : { -<span class="lineNum"> 148 </span> : if (dest) ++dest->ref_count; -<span class="lineNum"> 149 </span> : } -<span class="lineNum"> 150 </span> : -<span class="lineNum"> 151 </span> : template <class T> -<span class="lineNum"> 152 </span> : inline T *RefCntPtr<T>::operator->() const -<span class="lineNum"> 153 </span> : { -<span class="lineNum"> 154 </span> : return dest; -<span class="lineNum"> 155 </span> : } -<span class="lineNum"> 156 </span> : -<span class="lineNum"> 157 </span> : template <class T> -<span class="lineNum"> 158 </span> : inline T &RefCntPtr<T>::operator*() const -<span class="lineNum"> 159 </span> : { -<span class="lineNum"> 160 </span> : return *dest; -<span class="lineNum"> 161 </span> : } -<span class="lineNum"> 162 </span> : -<span class="lineNum"> 163 </span> : template <class T> -<span class="lineNum"> 164 </span><span class="lineCov"> 30 : inline T *RefCntPtr<T>::get() const</span> -<span class="lineNum"> 165 </span> : { -<span class="lineNum"> 166 </span><span class="lineCov"> 30 : return dest;</span> -<span class="lineNum"> 167 </span> : } -<span class="lineNum"> 168 </span> : -<span class="lineNum"> 169 </span> : } -<span class="lineNum"> 170 </span> : } -<span class="lineNum"> 171 </span> : -<span class="lineNum"> 172 </span> : #endif /* XAPIAN_INCLUDED_BASE_H */ -</pre> - </td> - </tr> - </table> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> diff --git a/rep/usr/include/xapian/database.h.gcov.html b/rep/usr/include/xapian/database.h.gcov.html deleted file mode 100644 index 2a75331..0000000 --- a/rep/usr/include/xapian/database.h.gcov.html +++ /dev/null @@ -1,803 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian/database.h</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - database.h</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">4</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">100.0 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">4</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <table cellpadding=0 cellspacing=0 border=0> - <tr> - <td><br></td> - </tr> - <tr> - <td><pre class="source"> -<span class="lineNum"> 1 </span> : /** \file database.h -<span class="lineNum"> 2 </span> : * \brief API for working with Xapian databases -<span class="lineNum"> 3 </span> : */ -<span class="lineNum"> 4 </span> : /* Copyright 1999,2000,2001 BrightStation PLC -<span class="lineNum"> 5 </span> : * Copyright 2002 Ananova Ltd -<span class="lineNum"> 6 </span> : * Copyright 2002,2003,2004,2005,2006,2007 Olly Betts -<span class="lineNum"> 7 </span> : * Copyright 2006 Richard Boulton -<span class="lineNum"> 8 </span> : * -<span class="lineNum"> 9 </span> : * This program is free software; you can redistribute it and/or -<span class="lineNum"> 10 </span> : * modify it under the terms of the GNU General Public License as -<span class="lineNum"> 11 </span> : * published by the Free Software Foundation; either version 2 of the -<span class="lineNum"> 12 </span> : * License, or (at your option) any later version. -<span class="lineNum"> 13 </span> : * -<span class="lineNum"> 14 </span> : * This program is distributed in the hope that it will be useful, -<span class="lineNum"> 15 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of -<span class="lineNum"> 16 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -<span class="lineNum"> 17 </span> : * GNU General Public License for more details. -<span class="lineNum"> 18 </span> : * -<span class="lineNum"> 19 </span> : * You should have received a copy of the GNU General Public License -<span class="lineNum"> 20 </span> : * along with this program; if not, write to the Free Software -<span class="lineNum"> 21 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 -<span class="lineNum"> 22 </span> : * USA -<span class="lineNum"> 23 </span> : */ -<span class="lineNum"> 24 </span> : -<span class="lineNum"> 25 </span> : #ifndef XAPIAN_INCLUDED_DATABASE_H -<span class="lineNum"> 26 </span> : #define XAPIAN_INCLUDED_DATABASE_H -<span class="lineNum"> 27 </span> : -<span class="lineNum"> 28 </span> : #include <string> -<span class="lineNum"> 29 </span> : #include <vector> -<span class="lineNum"> 30 </span> : -<span class="lineNum"> 31 </span> : #include <xapian/base.h> -<span class="lineNum"> 32 </span> : #include <xapian/types.h> -<span class="lineNum"> 33 </span> : #include <xapian/positioniterator.h> -<span class="lineNum"> 34 </span> : #include <xapian/postingiterator.h> -<span class="lineNum"> 35 </span> : #include <xapian/termiterator.h> -<span class="lineNum"> 36 </span> : #include <xapian/visibility.h> -<span class="lineNum"> 37 </span> : -<span class="lineNum"> 38 </span> : /// The Xapian library lives in the Xapian namespace. -<span class="lineNum"> 39 </span> : namespace Xapian { -<span class="lineNum"> 40 </span> : -<span class="lineNum"> 41 </span> : class Document; -<span class="lineNum"> 42 </span> : -<span class="lineNum"> 43 </span> : /** This class is used to access a database, or a group of databases. -<span class="lineNum"> 44 </span> : * -<span class="lineNum"> 45 </span> : * For searching, this class is used in conjunction with an Enquire object. -<span class="lineNum"> 46 </span> : * -<span class="lineNum"> 47 </span> : * @exception InvalidArgumentError will be thrown if an invalid -<span class="lineNum"> 48 </span> : * argument is supplied, for example, an unknown database type. -<span class="lineNum"> 49 </span> : * -<span class="lineNum"> 50 </span> : * @exception DatabaseOpeningError may be thrown if the database cannot -<span class="lineNum"> 51 </span> : * be opened (for example, a required file cannot be found). -<span class="lineNum"> 52 </span> : * -<span class="lineNum"> 53 </span> : * @exception DatabaseVersionError may be thrown if the database is in an -<span class="lineNum"> 54 </span> : * unsupported format (for example, created by a newer version of Xapian -<span class="lineNum"> 55 </span> : * which uses an incompatible format). -<span class="lineNum"> 56 </span> : */ -<span class="lineNum"> 57 </span> : class XAPIAN_VISIBILITY_DEFAULT Database { -<span class="lineNum"> 58 </span> : public: -<span class="lineNum"> 59 </span> : class Internal; -<span class="lineNum"> 60 </span> : /// @private @internal Reference counted internals. -<span class="lineNum"> 61 </span> : std::vector<Xapian::Internal::RefCntPtr<Internal> > internal; -<span class="lineNum"> 62 </span> : -<span class="lineNum"> 63 </span> : /** Add an existing database (or group of databases) to those -<span class="lineNum"> 64 </span> : * accessed by this object. -<span class="lineNum"> 65 </span> : * -<span class="lineNum"> 66 </span> : * @param database the database(s) to add. -<span class="lineNum"> 67 </span> : */ -<span class="lineNum"> 68 </span> : void add_database(const Database & database); -<span class="lineNum"> 69 </span> : -<span class="lineNum"> 70 </span> : /** Create a Database with no databases in. -<span class="lineNum"> 71 </span> : */ -<span class="lineNum"> 72 </span> : Database(); -<span class="lineNum"> 73 </span> : -<span class="lineNum"> 74 </span> : /** Open a Database, automatically determining the database -<span class="lineNum"> 75 </span> : * backend to use. -<span class="lineNum"> 76 </span> : * -<span class="lineNum"> 77 </span> : * @param path directory that the database is stored in. -<span class="lineNum"> 78 </span> : */ -<span class="lineNum"> 79 </span> : explicit Database(const std::string &path); -<span class="lineNum"> 80 </span> : -<span class="lineNum"> 81 </span> : /** @private @internal Create a Database from its internals. -<span class="lineNum"> 82 </span> : */ -<span class="lineNum"> 83 </span> : explicit Database(Internal *internal); -<span class="lineNum"> 84 </span> : -<span class="lineNum"> 85 </span> : /** Destroy this handle on the database. -<span class="lineNum"> 86 </span> : * -<span class="lineNum"> 87 </span> : * If there are no copies of this object remaining, the database(s) -<span class="lineNum"> 88 </span> : * will be closed. -<span class="lineNum"> 89 </span> : */ -<span class="lineNum"> 90 </span> : virtual ~Database(); -<span class="lineNum"> 91 </span> : -<span class="lineNum"> 92 </span> : /** Copying is allowed. The internals are reference counted, so -<span class="lineNum"> 93 </span> : * copying is cheap. -<span class="lineNum"> 94 </span> : */ -<span class="lineNum"> 95 </span> : Database(const Database &other); -<span class="lineNum"> 96 </span> : -<span class="lineNum"> 97 </span> : /** Assignment is allowed. The internals are reference counted, -<span class="lineNum"> 98 </span> : * so assignment is cheap. -<span class="lineNum"> 99 </span> : */ -<span class="lineNum"> 100 </span> : void operator=(const Database &other); -<span class="lineNum"> 101 </span> : -<span class="lineNum"> 102 </span> : /** Re-open the database. -<span class="lineNum"> 103 </span> : * This re-opens the database(s) to the latest available version(s). -<span class="lineNum"> 104 </span> : * It can be used either to make sure the latest results are -<span class="lineNum"> 105 </span> : * returned, or to recover from a Xapian::DatabaseModifiedError. -<span class="lineNum"> 106 </span> : */ -<span class="lineNum"> 107 </span> : void reopen(); -<span class="lineNum"> 108 </span> : -<span class="lineNum"> 109 </span> : /// Return a string describing this object. -<span class="lineNum"> 110 </span> : virtual std::string get_description() const; -<span class="lineNum"> 111 </span> : -<span class="lineNum"> 112 </span> : /** An iterator pointing to the start of the postlist -<span class="lineNum"> 113 </span> : * for a given term. -<span class="lineNum"> 114 </span> : * -<span class="lineNum"> 115 </span> : * If the term name is the empty string, the iterator returned -<span class="lineNum"> 116 </span> : * will list all the documents in the database. Such an iterator -<span class="lineNum"> 117 </span> : * will always return a WDF value of 1, since there is no obvious -<span class="lineNum"> 118 </span> : * meaning for this quantity in this case. -<span class="lineNum"> 119 </span> : */ -<span class="lineNum"> 120 </span> : PostingIterator postlist_begin(const std::string &tname) const; -<span class="lineNum"> 121 </span> : -<span class="lineNum"> 122 </span> : /** Corresponding end iterator to postlist_begin(). -<span class="lineNum"> 123 </span> : */ -<span class="lineNum"> 124 </span><span class="lineCov"> 10 : PostingIterator postlist_end(const std::string &) const {</span> -<span class="lineNum"> 125 </span><span class="lineCov"> 10 : return PostingIterator(NULL);</span> -<span class="lineNum"> 126 </span> : } -<span class="lineNum"> 127 </span> : -<span class="lineNum"> 128 </span> : /** An iterator pointing to the start of the termlist -<span class="lineNum"> 129 </span> : * for a given document. -<span class="lineNum"> 130 </span> : */ -<span class="lineNum"> 131 </span> : TermIterator termlist_begin(Xapian::docid did) const; -<span class="lineNum"> 132 </span> : -<span class="lineNum"> 133 </span> : /** Corresponding end iterator to termlist_begin(). -<span class="lineNum"> 134 </span> : */ -<span class="lineNum"> 135 </span> : TermIterator termlist_end(Xapian::docid) const { -<span class="lineNum"> 136 </span> : return TermIterator(NULL); -<span class="lineNum"> 137 </span> : } -<span class="lineNum"> 138 </span> : -<span class="lineNum"> 139 </span> : /** Does this database have any positional information? */ -<span class="lineNum"> 140 </span> : bool has_positions() const; -<span class="lineNum"> 141 </span> : -<span class="lineNum"> 142 </span> : /** An iterator pointing to the start of the position list -<span class="lineNum"> 143 </span> : * for a given term in a given document. -<span class="lineNum"> 144 </span> : */ -<span class="lineNum"> 145 </span> : PositionIterator positionlist_begin(Xapian::docid did, const std::string &tname) const; -<span class="lineNum"> 146 </span> : -<span class="lineNum"> 147 </span> : /** Corresponding end iterator to positionlist_begin(). -<span class="lineNum"> 148 </span> : */ -<span class="lineNum"> 149 </span> : PositionIterator positionlist_end(Xapian::docid, const std::string &) const { -<span class="lineNum"> 150 </span> : return PositionIterator(NULL); -<span class="lineNum"> 151 </span> : } -<span class="lineNum"> 152 </span> : -<span class="lineNum"> 153 </span> : /** An iterator which runs across all terms in the database. -<span class="lineNum"> 154 </span> : */ -<span class="lineNum"> 155 </span> : TermIterator allterms_begin() const; -<span class="lineNum"> 156 </span> : -<span class="lineNum"> 157 </span> : /** Corresponding end iterator to allterms_begin(). -<span class="lineNum"> 158 </span> : */ -<span class="lineNum"> 159 </span> : TermIterator allterms_end() const { -<span class="lineNum"> 160 </span> : return TermIterator(NULL); -<span class="lineNum"> 161 </span> : } -<span class="lineNum"> 162 </span> : -<span class="lineNum"> 163 </span> : /** An iterator which runs across all terms with a given prefix. -<span class="lineNum"> 164 </span> : * -<span class="lineNum"> 165 </span> : * This is functionally similar to getting an iterator with -<span class="lineNum"> 166 </span> : * allterms_begin() and then calling skip_to(prefix) on that iterator -<span class="lineNum"> 167 </span> : * to move to the start of the prefix, but is more convenient (because -<span class="lineNum"> 168 </span> : * it detects the end of the prefixed terms), and may be more -<span class="lineNum"> 169 </span> : * efficient than simply calling skip_to() after opening the iterator, -<span class="lineNum"> 170 </span> : * particularly for network databases. -<span class="lineNum"> 171 </span> : * -<span class="lineNum"> 172 </span> : * @param prefix The prefix to restrict the returned terms to. -<span class="lineNum"> 173 </span> : */ -<span class="lineNum"> 174 </span> : TermIterator allterms_begin(const std::string & prefix) const; -<span class="lineNum"> 175 </span> : -<span class="lineNum"> 176 </span> : /** Corresponding end iterator to allterms_begin(prefix). -<span class="lineNum"> 177 </span> : */ -<span class="lineNum"> 178 </span><span class="lineCov"> 1 : TermIterator allterms_end(const std::string &) const {</span> -<span class="lineNum"> 179 </span><span class="lineCov"> 1 : return TermIterator(NULL);</span> -<span class="lineNum"> 180 </span> : } -<span class="lineNum"> 181 </span> : -<span class="lineNum"> 182 </span> : /// Get the number of documents in the database. -<span class="lineNum"> 183 </span> : Xapian::doccount get_doccount() const; -<span class="lineNum"> 184 </span> : -<span class="lineNum"> 185 </span> : /// Get the highest document id which has been used in the database. -<span class="lineNum"> 186 </span> : Xapian::docid get_lastdocid() const; -<span class="lineNum"> 187 </span> : -<span class="lineNum"> 188 </span> : /// Get the average length of the documents in the database. -<span class="lineNum"> 189 </span> : Xapian::doclength get_avlength() const; -<span class="lineNum"> 190 </span> : -<span class="lineNum"> 191 </span> : /// Get the number of documents in the database indexed by a given term. -<span class="lineNum"> 192 </span> : Xapian::doccount get_termfreq(const std::string & tname) const; -<span class="lineNum"> 193 </span> : -<span class="lineNum"> 194 </span> : /** Check if a given term exists in the database. -<span class="lineNum"> 195 </span> : * -<span class="lineNum"> 196 </span> : * Return true if and only if the term exists in the database. -<span class="lineNum"> 197 </span> : * This is the same as (get_termfreq(tname) != 0), but will often be -<span class="lineNum"> 198 </span> : * more efficient. -<span class="lineNum"> 199 </span> : */ -<span class="lineNum"> 200 </span> : bool term_exists(const std::string & tname) const; -<span class="lineNum"> 201 </span> : -<span class="lineNum"> 202 </span> : /** Return the total number of occurrences of the given term. -<span class="lineNum"> 203 </span> : * -<span class="lineNum"> 204 </span> : * This is the sum of the number of occurrences of the term in each -<span class="lineNum"> 205 </span> : * document it indexes: i.e., the sum of the within document -<span class="lineNum"> 206 </span> : * frequencies of the term. -<span class="lineNum"> 207 </span> : * -<span class="lineNum"> 208 </span> : * @param tname The term whose collection frequency is being -<span class="lineNum"> 209 </span> : * requested. -<span class="lineNum"> 210 </span> : */ -<span class="lineNum"> 211 </span> : Xapian::termcount get_collection_freq(const std::string & tname) const; -<span class="lineNum"> 212 </span> : -<span class="lineNum"> 213 </span> : /** Get the length of a document. -<span class="lineNum"> 214 </span> : */ -<span class="lineNum"> 215 </span> : Xapian::doclength get_doclength(Xapian::docid did) const; -<span class="lineNum"> 216 </span> : -<span class="lineNum"> 217 </span> : /** Send a "keep-alive" to remote databases to stop them timing -<span class="lineNum"> 218 </span> : * out. -<span class="lineNum"> 219 </span> : */ -<span class="lineNum"> 220 </span> : void keep_alive(); -<span class="lineNum"> 221 </span> : -<span class="lineNum"> 222 </span> : /** Get a document from the database, given its document id. -<span class="lineNum"> 223 </span> : * -<span class="lineNum"> 224 </span> : * This method returns a Xapian::Document object which provides the -<span class="lineNum"> 225 </span> : * information about a document. -<span class="lineNum"> 226 </span> : * -<span class="lineNum"> 227 </span> : * @param did The document id for which to retrieve the data. -<span class="lineNum"> 228 </span> : * -<span class="lineNum"> 229 </span> : * @return A Xapian::Document object containing the document data -<span class="lineNum"> 230 </span> : * -<span class="lineNum"> 231 </span> : * @exception Xapian::DocNotFoundError The document specified -<span class="lineNum"> 232 </span> : * could not be found in the database. -<span class="lineNum"> 233 </span> : */ -<span class="lineNum"> 234 </span> : Xapian::Document get_document(Xapian::docid did) const; -<span class="lineNum"> 235 </span> : -<span class="lineNum"> 236 </span> : /** Suggest a spelling correction. -<span class="lineNum"> 237 </span> : * -<span class="lineNum"> 238 </span> : * @param word The potentially misspelled word. -<span class="lineNum"> 239 </span> : * @param max_edit_distance Only consider words which are at most -<span class="lineNum"> 240 </span> : * @a max_edit_distance edits from @a word. An edit is a -<span class="lineNum"> 241 </span> : * character insertion, deletion, or the transposition of two -<span class="lineNum"> 242 </span> : * adjacent characters (default is 2). -<span class="lineNum"> 243 </span> : */ -<span class="lineNum"> 244 </span> : std::string get_spelling_suggestion(const std::string &word, -<span class="lineNum"> 245 </span> : unsigned max_edit_distance = 2) const; -<span class="lineNum"> 246 </span> : -<span class="lineNum"> 247 </span> : /** An iterator which returns all the spelling correction targets. -<span class="lineNum"> 248 </span> : * -<span class="lineNum"> 249 </span> : * This returns all the words which are considered as targets for the -<span class="lineNum"> 250 </span> : * spelling correction algorithm. The frequency of each word is -<span class="lineNum"> 251 </span> : * available as the term frequency of each entry in the returned -<span class="lineNum"> 252 </span> : * iterator. -<span class="lineNum"> 253 </span> : */ -<span class="lineNum"> 254 </span> : Xapian::TermIterator spellings_begin() const; -<span class="lineNum"> 255 </span> : -<span class="lineNum"> 256 </span> : /// Corresponding end iterator to spellings_begin(). -<span class="lineNum"> 257 </span> : Xapian::TermIterator spellings_end() const { -<span class="lineNum"> 258 </span> : return Xapian::TermIterator(NULL); -<span class="lineNum"> 259 </span> : } -<span class="lineNum"> 260 </span> : -<span class="lineNum"> 261 </span> : /** An iterator which returns all the synonyms for a given term. -<span class="lineNum"> 262 </span> : * -<span class="lineNum"> 263 </span> : * @param term The term to return synonyms for. -<span class="lineNum"> 264 </span> : */ -<span class="lineNum"> 265 </span> : Xapian::TermIterator synonyms_begin(const std::string &term) const; -<span class="lineNum"> 266 </span> : -<span class="lineNum"> 267 </span> : /// Corresponding end iterator to synonyms_begin(term). -<span class="lineNum"> 268 </span> : Xapian::TermIterator synonyms_end(const std::string &) const { -<span class="lineNum"> 269 </span> : return Xapian::TermIterator(NULL); -<span class="lineNum"> 270 </span> : } -<span class="lineNum"> 271 </span> : -<span class="lineNum"> 272 </span> : /** An iterator which returns all terms which have synonyms. -<span class="lineNum"> 273 </span> : * -<span class="lineNum"> 274 </span> : * @param prefix If non-empty, only terms with this prefix are -<span class="lineNum"> 275 </span> : * returned. -<span class="lineNum"> 276 </span> : */ -<span class="lineNum"> 277 </span> : Xapian::TermIterator synonym_keys_begin(const std::string &prefix = "") const; -<span class="lineNum"> 278 </span> : -<span class="lineNum"> 279 </span> : /// Corresponding end iterator to synonym_keys_begin(prefix). -<span class="lineNum"> 280 </span> : Xapian::TermIterator synonym_keys_end(const std::string & = "") const { -<span class="lineNum"> 281 </span> : return Xapian::TermIterator(NULL); -<span class="lineNum"> 282 </span> : } -<span class="lineNum"> 283 </span> : -<span class="lineNum"> 284 </span> : /** Get the user-specified metadata associated with a given key. -<span class="lineNum"> 285 </span> : * -<span class="lineNum"> 286 </span> : * User-specified metadata allows you to store arbitrary information -<span class="lineNum"> 287 </span> : * in the form of (key,tag) pairs. See @a -<span class="lineNum"> 288 </span> : * WritableDatabase::set_metadata() for more information. -<span class="lineNum"> 289 </span> : * -<span class="lineNum"> 290 </span> : * When invoked on a Xapian::Database object representing multiple -<span class="lineNum"> 291 </span> : * databases, currently only the metadata for the first is considered -<span class="lineNum"> 292 </span> : * but this behaviour may change in the future. -<span class="lineNum"> 293 </span> : * -<span class="lineNum"> 294 </span> : * If there is no piece of metadata associated with the specified -<span class="lineNum"> 295 </span> : * key, an empty string is returned (this applies even for backends -<span class="lineNum"> 296 </span> : * which don't support metadata). -<span class="lineNum"> 297 </span> : * -<span class="lineNum"> 298 </span> : * Empty keys are not valid, and specifying one will cause an -<span class="lineNum"> 299 </span> : * exception. -<span class="lineNum"> 300 </span> : * -<span class="lineNum"> 301 </span> : * @param key The key of the metadata item to access. -<span class="lineNum"> 302 </span> : * -<span class="lineNum"> 303 </span> : * @return The retrieved metadata item's value. -<span class="lineNum"> 304 </span> : * -<span class="lineNum"> 305 </span> : * @exception Xapian::InvalidArgumentError will be thrown if the -<span class="lineNum"> 306 </span> : * key supplied is empty. -<span class="lineNum"> 307 </span> : * -<span class="lineNum"> 308 </span> : * @exception Xapian::UnimplementedError will be thrown if the -<span class="lineNum"> 309 </span> : * database backend in use doesn't support user-specified -<span class="lineNum"> 310 </span> : * metadata. -<span class="lineNum"> 311 </span> : */ -<span class="lineNum"> 312 </span> : std::string get_metadata(const std::string & key) const; -<span class="lineNum"> 313 </span> : }; -<span class="lineNum"> 314 </span> : -<span class="lineNum"> 315 </span> : /** This class provides read/write access to a database. -<span class="lineNum"> 316 </span> : */ -<span class="lineNum"> 317 </span> : class XAPIAN_VISIBILITY_DEFAULT WritableDatabase : public Database { -<span class="lineNum"> 318 </span> : public: -<span class="lineNum"> 319 </span> : /** Destroy this handle on the database. -<span class="lineNum"> 320 </span> : * -<span class="lineNum"> 321 </span> : * If there are no copies of this object remaining, the database -<span class="lineNum"> 322 </span> : * will be closed. If there are any transactions in progress -<span class="lineNum"> 323 </span> : * these will be aborted as if cancel_transaction had been called. -<span class="lineNum"> 324 </span> : */ -<span class="lineNum"> 325 </span> : virtual ~WritableDatabase(); -<span class="lineNum"> 326 </span> : -<span class="lineNum"> 327 </span> : /** Create an empty WritableDatabase. -<span class="lineNum"> 328 </span> : */ -<span class="lineNum"> 329 </span> : WritableDatabase(); -<span class="lineNum"> 330 </span> : -<span class="lineNum"> 331 </span> : /** Open a database for update, automatically determining the database -<span class="lineNum"> 332 </span> : * backend to use. -<span class="lineNum"> 333 </span> : * -<span class="lineNum"> 334 </span> : * If the database is to be created, Xapian will try -<span class="lineNum"> 335 </span> : * to create the directory indicated by path if it doesn't already -<span class="lineNum"> 336 </span> : * exist (but only the leaf directory, not recursively). -<span class="lineNum"> 337 </span> : * -<span class="lineNum"> 338 </span> : * @param path directory that the database is stored in. -<span class="lineNum"> 339 </span> : * @param action one of: -<span class="lineNum"> 340 </span> : * - Xapian::DB_CREATE_OR_OPEN open for read/write; create if no db -<span class="lineNum"> 341 </span> : * exists -<span class="lineNum"> 342 </span> : * - Xapian::DB_CREATE create new database; fail if db exists -<span class="lineNum"> 343 </span> : * - Xapian::DB_CREATE_OR_OVERWRITE overwrite existing db; create if -<span class="lineNum"> 344 </span> : * none exists -<span class="lineNum"> 345 </span> : * - Xapian::DB_OPEN open for read/write; fail if no db exists -<span class="lineNum"> 346 </span> : */ -<span class="lineNum"> 347 </span> : WritableDatabase(const std::string &path, int action); -<span class="lineNum"> 348 </span> : -<span class="lineNum"> 349 </span> : /** @private @internal Create an WritableDatabase given its internals. -<span class="lineNum"> 350 </span> : */ -<span class="lineNum"> 351 </span> : explicit WritableDatabase(Database::Internal *internal); -<span class="lineNum"> 352 </span> : -<span class="lineNum"> 353 </span> : /** Copying is allowed. The internals are reference counted, so -<span class="lineNum"> 354 </span> : * copying is cheap. -<span class="lineNum"> 355 </span> : */ -<span class="lineNum"> 356 </span> : WritableDatabase(const WritableDatabase &other); -<span class="lineNum"> 357 </span> : -<span class="lineNum"> 358 </span> : /** Assignment is allowed. The internals are reference counted, -<span class="lineNum"> 359 </span> : * so assignment is cheap. -<span class="lineNum"> 360 </span> : * -<span class="lineNum"> 361 </span> : * Note that only an WritableDatabase may be assigned to an -<span class="lineNum"> 362 </span> : * WritableDatabase: an attempt to assign a Database is caught -<span class="lineNum"> 363 </span> : * at compile-time. -<span class="lineNum"> 364 </span> : */ -<span class="lineNum"> 365 </span> : void operator=(const WritableDatabase &other); -<span class="lineNum"> 366 </span> : -<span class="lineNum"> 367 </span> : /** Flush to disk any modifications made to the database. -<span class="lineNum"> 368 </span> : * -<span class="lineNum"> 369 </span> : * For efficiency reasons, when performing multiple updates to a -<span class="lineNum"> 370 </span> : * database it is best (indeed, almost essential) to make as many -<span class="lineNum"> 371 </span> : * modifications as memory will permit in a single pass through -<span class="lineNum"> 372 </span> : * the database. To ensure this, Xapian batches up modifications. -<span class="lineNum"> 373 </span> : * -<span class="lineNum"> 374 </span> : * Flush may be called at any time to -<span class="lineNum"> 375 </span> : * ensure that the modifications which have been made are written to -<span class="lineNum"> 376 </span> : * disk: if the flush succeeds, all the preceding modifications will -<span class="lineNum"> 377 </span> : * have been written to disk. -<span class="lineNum"> 378 </span> : * -<span class="lineNum"> 379 </span> : * If any of the modifications fail, an exception will be thrown and -<span class="lineNum"> 380 </span> : * the database will be left in a state in which each separate -<span class="lineNum"> 381 </span> : * addition, replacement or deletion operation has either been fully -<span class="lineNum"> 382 </span> : * performed or not performed at all: it is then up to the -<span class="lineNum"> 383 </span> : * application to work out which operations need to be repeated. -<span class="lineNum"> 384 </span> : * -<span class="lineNum"> 385 </span> : * It's not valid to call flush within a transaction. -<span class="lineNum"> 386 </span> : * -<span class="lineNum"> 387 </span> : * Beware of calling flush too frequently: this will have a severe -<span class="lineNum"> 388 </span> : * performance cost. -<span class="lineNum"> 389 </span> : * -<span class="lineNum"> 390 </span> : * Note that flush need not be called explicitly: it will be called -<span class="lineNum"> 391 </span> : * automatically when the database is closed, or when a sufficient -<span class="lineNum"> 392 </span> : * number of modifications have been made. -<span class="lineNum"> 393 </span> : * -<span class="lineNum"> 394 </span> : * @exception Xapian::DatabaseError will be thrown if a problem occurs -<span class="lineNum"> 395 </span> : * while modifying the database. -<span class="lineNum"> 396 </span> : * -<span class="lineNum"> 397 </span> : * @exception Xapian::DatabaseCorruptError will be thrown if the -<span class="lineNum"> 398 </span> : * database is in a corrupt state. -<span class="lineNum"> 399 </span> : * -<span class="lineNum"> 400 </span> : * @exception Xapian::DatabaseLockError will be thrown if a lock -<span class="lineNum"> 401 </span> : * couldn't be acquired on the database. -<span class="lineNum"> 402 </span> : */ -<span class="lineNum"> 403 </span> : void flush(); -<span class="lineNum"> 404 </span> : -<span class="lineNum"> 405 </span> : /** Begin a transaction. -<span class="lineNum"> 406 </span> : * -<span class="lineNum"> 407 </span> : * In Xapian a transaction is a group of modifications to the database -<span class="lineNum"> 408 </span> : * which are linked such that either all will be applied -<span class="lineNum"> 409 </span> : * simultaneously or none will be applied at all. Even in the case of -<span class="lineNum"> 410 </span> : * a power failure, this characteristic should be preserved (as long -<span class="lineNum"> 411 </span> : * as the filesystem isn't corrupted, etc). -<span class="lineNum"> 412 </span> : * -<span class="lineNum"> 413 </span> : * A transaction is started with begin_transaction() and can -<span class="lineNum"> 414 </span> : * either be committed by calling commit_transaction() or aborted -<span class="lineNum"> 415 </span> : * by calling cancel_transaction(). -<span class="lineNum"> 416 </span> : * -<span class="lineNum"> 417 </span> : * By default, a transaction implicitly calls flush before and after -<span class="lineNum"> 418 </span> : * so that the modifications stand and fall without affecting -<span class="lineNum"> 419 </span> : * modifications before or after. -<span class="lineNum"> 420 </span> : * -<span class="lineNum"> 421 </span> : * The downside of this flushing is that small transactions cause -<span class="lineNum"> 422 </span> : * modifications to be frequently flushed which can harm indexing -<span class="lineNum"> 423 </span> : * performance in the same way that explicitly calling flush -<span class="lineNum"> 424 </span> : * frequently can. -<span class="lineNum"> 425 </span> : * -<span class="lineNum"> 426 </span> : * If you're applying atomic groups of changes and only wish to -<span class="lineNum"> 427 </span> : * ensure that each group is either applied or not applied, then -<span class="lineNum"> 428 </span> : * you can prevent the automatic flush before and after the -<span class="lineNum"> 429 </span> : * transaction by starting the transaction with -<span class="lineNum"> 430 </span> : * begin_transaction(false). However, if cancel_transaction is -<span class="lineNum"> 431 </span> : * called (or if commit_transaction isn't called before the -<span class="lineNum"> 432 </span> : * WritableDatabase object is destroyed) then any changes which -<span class="lineNum"> 433 </span> : * were pending before the transaction began will also be discarded. -<span class="lineNum"> 434 </span> : * -<span class="lineNum"> 435 </span> : * Transactions aren't currently supported by the InMemory backend. -<span class="lineNum"> 436 </span> : * -<span class="lineNum"> 437 </span> : * @exception Xapian::UnimplementedError will be thrown if transactions -<span class="lineNum"> 438 </span> : * are not available for this database type. -<span class="lineNum"> 439 </span> : * -<span class="lineNum"> 440 </span> : * @exception Xapian::InvalidOperationError will be thrown if this is -<span class="lineNum"> 441 </span> : * called at an invalid time, such as when a transaction -<span class="lineNum"> 442 </span> : * is already in progress. -<span class="lineNum"> 443 </span> : */ -<span class="lineNum"> 444 </span> : void begin_transaction(bool flushed=true); -<span class="lineNum"> 445 </span> : -<span class="lineNum"> 446 </span> : /** Complete the transaction currently in progress. -<span class="lineNum"> 447 </span> : * -<span class="lineNum"> 448 </span> : * If this method completes successfully and this is a flushed -<span class="lineNum"> 449 </span> : * transaction, all the database modifications -<span class="lineNum"> 450 </span> : * made during the transaction will have been committed to the -<span class="lineNum"> 451 </span> : * database. -<span class="lineNum"> 452 </span> : * -<span class="lineNum"> 453 </span> : * If an error occurs, an exception will be thrown, and none of -<span class="lineNum"> 454 </span> : * the modifications made to the database during the transaction -<span class="lineNum"> 455 </span> : * will have been applied to the database. -<span class="lineNum"> 456 </span> : * -<span class="lineNum"> 457 </span> : * In all cases the transaction will no longer be in progress. -<span class="lineNum"> 458 </span> : * -<span class="lineNum"> 459 </span> : * @exception Xapian::DatabaseError will be thrown if a problem occurs -<span class="lineNum"> 460 </span> : * while modifying the database. -<span class="lineNum"> 461 </span> : * -<span class="lineNum"> 462 </span> : * @exception Xapian::DatabaseCorruptError will be thrown if the -<span class="lineNum"> 463 </span> : * database is in a corrupt state. -<span class="lineNum"> 464 </span> : * -<span class="lineNum"> 465 </span> : * @exception Xapian::InvalidOperationError will be thrown if a -<span class="lineNum"> 466 </span> : * transaction is not currently in progress. -<span class="lineNum"> 467 </span> : * -<span class="lineNum"> 468 </span> : * @exception Xapian::UnimplementedError will be thrown if transactions -<span class="lineNum"> 469 </span> : * are not available for this database type. -<span class="lineNum"> 470 </span> : */ -<span class="lineNum"> 471 </span> : void commit_transaction(); -<span class="lineNum"> 472 </span> : -<span class="lineNum"> 473 </span> : /** Abort the transaction currently in progress, discarding the -<span class="lineNum"> 474 </span> : * potential modifications made to the database. -<span class="lineNum"> 475 </span> : * -<span class="lineNum"> 476 </span> : * If an error occurs in this method, an exception will be thrown, -<span class="lineNum"> 477 </span> : * but the transaction will be cancelled anyway. -<span class="lineNum"> 478 </span> : * -<span class="lineNum"> 479 </span> : * @exception Xapian::DatabaseError will be thrown if a problem occurs -<span class="lineNum"> 480 </span> : * while modifying the database. -<span class="lineNum"> 481 </span> : * -<span class="lineNum"> 482 </span> : * @exception Xapian::DatabaseCorruptError will be thrown if the -<span class="lineNum"> 483 </span> : * database is in a corrupt state. -<span class="lineNum"> 484 </span> : * -<span class="lineNum"> 485 </span> : * @exception Xapian::InvalidOperationError will be thrown if a -<span class="lineNum"> 486 </span> : * transaction is not currently in progress. -<span class="lineNum"> 487 </span> : * -<span class="lineNum"> 488 </span> : * @exception Xapian::UnimplementedError will be thrown if transactions -<span class="lineNum"> 489 </span> : * are not available for this database type. -<span class="lineNum"> 490 </span> : */ -<span class="lineNum"> 491 </span> : void cancel_transaction(); -<span class="lineNum"> 492 </span> : -<span class="lineNum"> 493 </span> : /** Add a new document to the database. -<span class="lineNum"> 494 </span> : * -<span class="lineNum"> 495 </span> : * This method adds the specified document to the database, -<span class="lineNum"> 496 </span> : * returning a newly allocated document ID. Automatically allocated -<span class="lineNum"> 497 </span> : * document IDs come from a per-database monotonically increasing -<span class="lineNum"> 498 </span> : * counter, so IDs from deleted documents won't be reused. -<span class="lineNum"> 499 </span> : * -<span class="lineNum"> 500 </span> : * If you want to specify the document ID to be used, you should -<span class="lineNum"> 501 </span> : * call replace_document() instead. -<span class="lineNum"> 502 </span> : * -<span class="lineNum"> 503 </span> : * Note that changes to the database won't be immediately committed to -<span class="lineNum"> 504 </span> : * disk; see flush() for more details. -<span class="lineNum"> 505 </span> : * -<span class="lineNum"> 506 </span> : * As with all database modification operations, the effect is -<span class="lineNum"> 507 </span> : * atomic: the document will either be fully added, or the document -<span class="lineNum"> 508 </span> : * fails to be added and an exception is thrown (possibly at a -<span class="lineNum"> 509 </span> : * later time when flush is called or the database is closed). -<span class="lineNum"> 510 </span> : * -<span class="lineNum"> 511 </span> : * @param document The new document to be added. -<span class="lineNum"> 512 </span> : * -<span class="lineNum"> 513 </span> : * @return The document ID of the newly added document. -<span class="lineNum"> 514 </span> : * -<span class="lineNum"> 515 </span> : * @exception Xapian::DatabaseError will be thrown if a problem occurs -<span class="lineNum"> 516 </span> : * while writing to the database. -<span class="lineNum"> 517 </span> : * -<span class="lineNum"> 518 </span> : * @exception Xapian::DatabaseCorruptError will be thrown if the -<span class="lineNum"> 519 </span> : * database is in a corrupt state. -<span class="lineNum"> 520 </span> : */ -<span class="lineNum"> 521 </span> : Xapian::docid add_document(const Xapian::Document & document); -<span class="lineNum"> 522 </span> : -<span class="lineNum"> 523 </span> : /** Delete a document from the database. -<span class="lineNum"> 524 </span> : * -<span class="lineNum"> 525 </span> : * This method removes the document with the specified document ID -<span class="lineNum"> 526 </span> : * from the database. -<span class="lineNum"> 527 </span> : * -<span class="lineNum"> 528 </span> : * Note that changes to the database won't be immediately committed to -<span class="lineNum"> 529 </span> : * disk; see flush() for more details. -<span class="lineNum"> 530 </span> : * -<span class="lineNum"> 531 </span> : * As with all database modification operations, the effect is -<span class="lineNum"> 532 </span> : * atomic: the document will either be fully removed, or the document -<span class="lineNum"> 533 </span> : * fails to be removed and an exception is thrown (possibly at a -<span class="lineNum"> 534 </span> : * later time when flush is called or the database is closed). -<span class="lineNum"> 535 </span> : * -<span class="lineNum"> 536 </span> : * @param did The document ID of the document to be removed. -<span class="lineNum"> 537 </span> : * -<span class="lineNum"> 538 </span> : * @exception Xapian::DatabaseError will be thrown if a problem occurs -<span class="lineNum"> 539 </span> : * while writing to the database. -<span class="lineNum"> 540 </span> : * -<span class="lineNum"> 541 </span> : * @exception Xapian::DatabaseCorruptError will be thrown if the -<span class="lineNum"> 542 </span> : * database is in a corrupt state. -<span class="lineNum"> 543 </span> : */ -<span class="lineNum"> 544 </span> : void delete_document(Xapian::docid did); -<span class="lineNum"> 545 </span> : -<span class="lineNum"> 546 </span> : /** Delete any documents indexed by a term from the database. -<span class="lineNum"> 547 </span> : * -<span class="lineNum"> 548 </span> : * This method removes any documents indexed by the specified term -<span class="lineNum"> 549 </span> : * from the database. -<span class="lineNum"> 550 </span> : * -<span class="lineNum"> 551 </span> : * A major use is for convenience when UIDs from another system are -<span class="lineNum"> 552 </span> : * mapped to terms in Xapian, although this method has other uses -<span class="lineNum"> 553 </span> : * (for example, you could add a "deletion date" term to documents at -<span class="lineNum"> 554 </span> : * index time and use this method to delete all documents due for -<span class="lineNum"> 555 </span> : * deletion on a particular date). -<span class="lineNum"> 556 </span> : * -<span class="lineNum"> 557 </span> : * @param unique_term The term to remove references to. -<span class="lineNum"> 558 </span> : * -<span class="lineNum"> 559 </span> : * @exception Xapian::DatabaseError will be thrown if a problem occurs -<span class="lineNum"> 560 </span> : * while writing to the database. -<span class="lineNum"> 561 </span> : * -<span class="lineNum"> 562 </span> : * @exception Xapian::DatabaseCorruptError will be thrown if the -<span class="lineNum"> 563 </span> : * database is in a corrupt state. -<span class="lineNum"> 564 </span> : */ -<span class="lineNum"> 565 </span> : void delete_document(const std::string & unique_term); -<span class="lineNum"> 566 </span> : -<span class="lineNum"> 567 </span> : /** Replace a given document in the database. -<span class="lineNum"> 568 </span> : * -<span class="lineNum"> 569 </span> : * This method replaces the document with the specified document ID. -<span class="lineNum"> 570 </span> : * If document ID @a did isn't currently used, the document will be -<span class="lineNum"> 571 </span> : * added with document ID @a did. -<span class="lineNum"> 572 </span> : * -<span class="lineNum"> 573 </span> : * The monotonic counter used for automatically allocating document -<span class="lineNum"> 574 </span> : * IDs is increased so that the next automatically allocated document -<span class="lineNum"> 575 </span> : * ID will be did + 1. Be aware that if you use this method to -<span class="lineNum"> 576 </span> : * specify a high document ID for a new document, and also use -<span class="lineNum"> 577 </span> : * WritableDatabase::add_document(), Xapian may get to a state where -<span class="lineNum"> 578 </span> : * this counter wraps around and will be unable to automatically -<span class="lineNum"> 579 </span> : * allocate document IDs! -<span class="lineNum"> 580 </span> : * -<span class="lineNum"> 581 </span> : * Note that changes to the database won't be immediately committed to -<span class="lineNum"> 582 </span> : * disk; see flush() for more details. -<span class="lineNum"> 583 </span> : * -<span class="lineNum"> 584 </span> : * As with all database modification operations, the effect is -<span class="lineNum"> 585 </span> : * atomic: the document will either be fully replaced, or the document -<span class="lineNum"> 586 </span> : * fails to be replaced and an exception is thrown (possibly at a -<span class="lineNum"> 587 </span> : * later time when flush is called or the database is closed). -<span class="lineNum"> 588 </span> : * -<span class="lineNum"> 589 </span> : * @param did The document ID of the document to be replaced. -<span class="lineNum"> 590 </span> : * @param document The new document. -<span class="lineNum"> 591 </span> : * -<span class="lineNum"> 592 </span> : * @exception Xapian::DatabaseError will be thrown if a problem occurs -<span class="lineNum"> 593 </span> : * while writing to the database. -<span class="lineNum"> 594 </span> : * -<span class="lineNum"> 595 </span> : * @exception Xapian::DatabaseCorruptError will be thrown if the -<span class="lineNum"> 596 </span> : * database is in a corrupt state. -<span class="lineNum"> 597 </span> : */ -<span class="lineNum"> 598 </span> : void replace_document(Xapian::docid did, -<span class="lineNum"> 599 </span> : const Xapian::Document & document); -<span class="lineNum"> 600 </span> : -<span class="lineNum"> 601 </span> : /** Replace any documents matching a term. -<span class="lineNum"> 602 </span> : * -<span class="lineNum"> 603 </span> : * This method replaces any documents indexed by the specified term -<span class="lineNum"> 604 </span> : * with the specified document. If any documents are indexed by the -<span class="lineNum"> 605 </span> : * term, the lowest document ID will be used for the document, -<span class="lineNum"> 606 </span> : * otherwise a new document ID will be generated as for add_document. -<span class="lineNum"> 607 </span> : * -<span class="lineNum"> 608 </span> : * The intended use is to allow UIDs from another system to easily -<span class="lineNum"> 609 </span> : * be mapped to terms in Xapian, although this method probably has -<span class="lineNum"> 610 </span> : * other uses. -<span class="lineNum"> 611 </span> : * -<span class="lineNum"> 612 </span> : * Note that changes to the database won't be immediately committed to -<span class="lineNum"> 613 </span> : * disk; see flush() for more details. -<span class="lineNum"> 614 </span> : * -<span class="lineNum"> 615 </span> : * As with all database modification operations, the effect is -<span class="lineNum"> 616 </span> : * atomic: the document(s) will either be fully replaced, or the -<span class="lineNum"> 617 </span> : * document(s) fail to be replaced and an exception is thrown -<span class="lineNum"> 618 </span> : * (possibly at a -<span class="lineNum"> 619 </span> : * later time when flush is called or the database is closed). -<span class="lineNum"> 620 </span> : * -<span class="lineNum"> 621 </span> : * @param unique_term The "unique" term. -<span class="lineNum"> 622 </span> : * @param document The new document. -<span class="lineNum"> 623 </span> : * -<span class="lineNum"> 624 </span> : * @return The document ID that document was given. -<span class="lineNum"> 625 </span> : * -<span class="lineNum"> 626 </span> : * @exception Xapian::DatabaseError will be thrown if a problem occurs -<span class="lineNum"> 627 </span> : * while writing to the database. -<span class="lineNum"> 628 </span> : * -<span class="lineNum"> 629 </span> : * @exception Xapian::DatabaseCorruptError will be thrown if the -<span class="lineNum"> 630 </span> : * database is in a corrupt state. -<span class="lineNum"> 631 </span> : */ -<span class="lineNum"> 632 </span> : Xapian::docid replace_document(const std::string & unique_term, -<span class="lineNum"> 633 </span> : const Xapian::Document & document); -<span class="lineNum"> 634 </span> : -<span class="lineNum"> 635 </span> : /** Add a word to the spelling dictionary. -<span class="lineNum"> 636 </span> : * -<span class="lineNum"> 637 </span> : * If the word is already present, its frequency is increased. -<span class="lineNum"> 638 </span> : * -<span class="lineNum"> 639 </span> : * @param word The word to add. -<span class="lineNum"> 640 </span> : * @param freqinc How much to increase its frequency by (default 1). -<span class="lineNum"> 641 </span> : */ -<span class="lineNum"> 642 </span> : void add_spelling(const std::string & word, -<span class="lineNum"> 643 </span> : Xapian::termcount freqinc = 1) const; -<span class="lineNum"> 644 </span> : -<span class="lineNum"> 645 </span> : /** Remove a word from the spelling dictionary. -<span class="lineNum"> 646 </span> : * -<span class="lineNum"> 647 </span> : * The word's frequency is decreased, and if would become zero or less -<span class="lineNum"> 648 </span> : * then the word is removed completely. -<span class="lineNum"> 649 </span> : * -<span class="lineNum"> 650 </span> : * @param word The word to remove. -<span class="lineNum"> 651 </span> : * @param freqdec How much to decrease its frequency by (default 1). -<span class="lineNum"> 652 </span> : */ -<span class="lineNum"> 653 </span> : void remove_spelling(const std::string & word, -<span class="lineNum"> 654 </span> : Xapian::termcount freqdec = 1) const; -<span class="lineNum"> 655 </span> : -<span class="lineNum"> 656 </span> : /** Add a synonym for a term. -<span class="lineNum"> 657 </span> : * -<span class="lineNum"> 658 </span> : * If @a synonym is already a synonym for @a term, then no action is -<span class="lineNum"> 659 </span> : * taken. -<span class="lineNum"> 660 </span> : */ -<span class="lineNum"> 661 </span> : void add_synonym(const std::string & term, -<span class="lineNum"> 662 </span> : const std::string & synonym) const; -<span class="lineNum"> 663 </span> : -<span class="lineNum"> 664 </span> : /** Remove a synonym for a term. -<span class="lineNum"> 665 </span> : * -<span class="lineNum"> 666 </span> : * If @a synonym isn't a synonym for @a term, then no action is taken. -<span class="lineNum"> 667 </span> : */ -<span class="lineNum"> 668 </span> : void remove_synonym(const std::string & term, -<span class="lineNum"> 669 </span> : const std::string & synonym) const; -<span class="lineNum"> 670 </span> : -<span class="lineNum"> 671 </span> : /** Remove all synonyms for a term. -<span class="lineNum"> 672 </span> : * -<span class="lineNum"> 673 </span> : * If @a term has no synonyms, no action is taken. -<span class="lineNum"> 674 </span> : */ -<span class="lineNum"> 675 </span> : void clear_synonyms(const std::string & term) const; -<span class="lineNum"> 676 </span> : -<span class="lineNum"> 677 </span> : /** Set the user-specified metadata associated with a given key. -<span class="lineNum"> 678 </span> : * -<span class="lineNum"> 679 </span> : * This method sets the metadata value associated with a given key. -<span class="lineNum"> 680 </span> : * If there is already a metadata value stored in the database with -<span class="lineNum"> 681 </span> : * the same key, the old value is replaced. If you want to delete an -<span class="lineNum"> 682 </span> : * existing item of metadata, just set its value to the empty string. -<span class="lineNum"> 683 </span> : * -<span class="lineNum"> 684 </span> : * User-specified metadata allows you to store arbitrary information -<span class="lineNum"> 685 </span> : * in the form of (key,tag) pairs. -<span class="lineNum"> 686 </span> : * -<span class="lineNum"> 687 </span> : * There's no hard limit on the number of metadata items, or the size -<span class="lineNum"> 688 </span> : * of the metadata values. Metadata keys have a limited length, which -<span class="lineNum"> 689 </span> : * depends on the backend. We recommend limiting them to 200 bytes. -<span class="lineNum"> 690 </span> : * Empty keys are not valid, and specifying one will cause an -<span class="lineNum"> 691 </span> : * exception. -<span class="lineNum"> 692 </span> : * -<span class="lineNum"> 693 </span> : * Metadata modifications are committed to disk in the same way as -<span class="lineNum"> 694 </span> : * modifications to the documents in the database are: i.e., -<span class="lineNum"> 695 </span> : * modifications are atomic, and won't be committed to disk -<span class="lineNum"> 696 </span> : * immediately (see flush() for more details). This allows metadata -<span class="lineNum"> 697 </span> : * to be used to link databases with versioned external resources -<span class="lineNum"> 698 </span> : * by storing the appropriate version number in a metadata item. -<span class="lineNum"> 699 </span> : * -<span class="lineNum"> 700 </span> : * You can also use the metadata to store arbitrary extra information -<span class="lineNum"> 701 </span> : * associated with terms, documents, or postings by encoding the -<span class="lineNum"> 702 </span> : * termname and/or document id into the metadata key. -<span class="lineNum"> 703 </span> : * -<span class="lineNum"> 704 </span> : * @param key The key of the metadata item to set. -<span class="lineNum"> 705 </span> : * -<span class="lineNum"> 706 </span> : * @param value The value of the metadata item to set. -<span class="lineNum"> 707 </span> : * -<span class="lineNum"> 708 </span> : * @exception Xapian::DatabaseError will be thrown if a problem occurs -<span class="lineNum"> 709 </span> : * while writing to the database. -<span class="lineNum"> 710 </span> : * -<span class="lineNum"> 711 </span> : * @exception Xapian::DatabaseCorruptError will be thrown if the -<span class="lineNum"> 712 </span> : * database is in a corrupt state. -<span class="lineNum"> 713 </span> : * -<span class="lineNum"> 714 </span> : * @exception Xapian::InvalidArgumentError will be thrown if the -<span class="lineNum"> 715 </span> : * key supplied is empty. -<span class="lineNum"> 716 </span> : */ -<span class="lineNum"> 717 </span> : void set_metadata(const std::string & key, const std::string & value); -<span class="lineNum"> 718 </span> : -<span class="lineNum"> 719 </span> : /// Return a string describing this object. -<span class="lineNum"> 720 </span> : std::string get_description() const; -<span class="lineNum"> 721 </span> : }; -<span class="lineNum"> 722 </span> : -<span class="lineNum"> 723 </span> : /** Open for read/write; create if no db exists. */ -<span class="lineNum"> 724 </span> : const int DB_CREATE_OR_OPEN = 1; -<span class="lineNum"> 725 </span> : /** Create a new database; fail if db exists. */ -<span class="lineNum"> 726 </span> : const int DB_CREATE = 2; -<span class="lineNum"> 727 </span> : /** Overwrite existing db; create if none exists. */ -<span class="lineNum"> 728 </span> : const int DB_CREATE_OR_OVERWRITE = 3; -<span class="lineNum"> 729 </span> : /** Open for read/write; fail if no db exists. */ -<span class="lineNum"> 730 </span> : const int DB_OPEN = 4; -<span class="lineNum"> 731 </span> : // Can't see any sensible use for this one -<span class="lineNum"> 732 </span> : // const int DB_OVERWRITE = XXX; -<span class="lineNum"> 733 </span> : -<span class="lineNum"> 734 </span> : } -<span class="lineNum"> 735 </span> : -<span class="lineNum"> 736 </span> : #endif /* XAPIAN_INCLUDED_DATABASE_H */ -</pre> - </td> - </tr> - </table> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> diff --git a/rep/usr/include/xapian/document.h.gcov.html b/rep/usr/include/xapian/document.h.gcov.html deleted file mode 100644 index dace408..0000000 --- a/rep/usr/include/xapian/document.h.gcov.html +++ /dev/null @@ -1,267 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian/document.h</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - document.h</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">2</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">0.0 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">0</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <table cellpadding=0 cellspacing=0 border=0> - <tr> - <td><br></td> - </tr> - <tr> - <td><pre class="source"> -<span class="lineNum"> 1 </span> : /** \file document.h -<span class="lineNum"> 2 </span> : * \brief API for working with documents -<span class="lineNum"> 3 </span> : */ -<span class="lineNum"> 4 </span> : /* Copyright 1999,2000,2001 BrightStation PLC -<span class="lineNum"> 5 </span> : * Copyright 2002 Ananova Ltd -<span class="lineNum"> 6 </span> : * Copyright 2002,2003,2004,2006,2007 Olly Betts -<span class="lineNum"> 7 </span> : * -<span class="lineNum"> 8 </span> : * This program is free software; you can redistribute it and/or -<span class="lineNum"> 9 </span> : * modify it under the terms of the GNU General Public License as -<span class="lineNum"> 10 </span> : * published by the Free Software Foundation; either version 2 of the -<span class="lineNum"> 11 </span> : * License, or (at your option) any later version. -<span class="lineNum"> 12 </span> : * -<span class="lineNum"> 13 </span> : * This program is distributed in the hope that it will be useful, -<span class="lineNum"> 14 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of -<span class="lineNum"> 15 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -<span class="lineNum"> 16 </span> : * GNU General Public License for more details. -<span class="lineNum"> 17 </span> : * -<span class="lineNum"> 18 </span> : * You should have received a copy of the GNU General Public License -<span class="lineNum"> 19 </span> : * along with this program; if not, write to the Free Software -<span class="lineNum"> 20 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 -<span class="lineNum"> 21 </span> : * USA -<span class="lineNum"> 22 </span> : */ -<span class="lineNum"> 23 </span> : -<span class="lineNum"> 24 </span> : #ifndef XAPIAN_INCLUDED_DOCUMENT_H -<span class="lineNum"> 25 </span> : #define XAPIAN_INCLUDED_DOCUMENT_H -<span class="lineNum"> 26 </span> : -<span class="lineNum"> 27 </span> : #include <string> -<span class="lineNum"> 28 </span> : -<span class="lineNum"> 29 </span> : #include <xapian/base.h> -<span class="lineNum"> 30 </span> : #include <xapian/types.h> -<span class="lineNum"> 31 </span> : #include <xapian/termiterator.h> -<span class="lineNum"> 32 </span> : #include <xapian/visibility.h> -<span class="lineNum"> 33 </span> : -<span class="lineNum"> 34 </span> : namespace Xapian { -<span class="lineNum"> 35 </span> : -<span class="lineNum"> 36 </span> : class ValueIterator; -<span class="lineNum"> 37 </span> : -<span class="lineNum"> 38 </span> : /// A document in the database - holds data, values, terms, and postings -<span class="lineNum"> 39 </span> : class XAPIAN_VISIBILITY_DEFAULT Document { -<span class="lineNum"> 40 </span> : public: -<span class="lineNum"> 41 </span> : class Internal; -<span class="lineNum"> 42 </span> : /// @private @internal Reference counted internals. -<span class="lineNum"> 43 </span> : Xapian::Internal::RefCntPtr<Internal> internal; -<span class="lineNum"> 44 </span> : -<span class="lineNum"> 45 </span> : /** @private @internal Constructor is only used by internal classes. -<span class="lineNum"> 46 </span> : * -<span class="lineNum"> 47 </span> : * @param internal_ pointer to internal opaque class -<span class="lineNum"> 48 </span> : */ -<span class="lineNum"> 49 </span> : explicit Document(Internal *internal_); -<span class="lineNum"> 50 </span> : -<span class="lineNum"> 51 </span> : /** Copying is allowed. The internals are reference counted, so -<span class="lineNum"> 52 </span> : * copying is cheap. -<span class="lineNum"> 53 </span> : */ -<span class="lineNum"> 54 </span> : Document(const Document &other); -<span class="lineNum"> 55 </span> : -<span class="lineNum"> 56 </span> : /** Assignment is allowed. The internals are reference counted, -<span class="lineNum"> 57 </span> : * so assignment is cheap. -<span class="lineNum"> 58 </span> : */ -<span class="lineNum"> 59 </span> : void operator=(const Document &other); -<span class="lineNum"> 60 </span> : -<span class="lineNum"> 61 </span> : /// Make a new empty Document -<span class="lineNum"> 62 </span> : Document(); -<span class="lineNum"> 63 </span> : -<span class="lineNum"> 64 </span> : /// Destructor -<span class="lineNum"> 65 </span> : ~Document(); -<span class="lineNum"> 66 </span> : -<span class="lineNum"> 67 </span> : /** Get value by number. -<span class="lineNum"> 68 </span> : * -<span class="lineNum"> 69 </span> : * Returns an empty string if no value with the given number is present -<span class="lineNum"> 70 </span> : * in the document. -<span class="lineNum"> 71 </span> : * -<span class="lineNum"> 72 </span> : * @param valueno The number of the value. -<span class="lineNum"> 73 </span> : */ -<span class="lineNum"> 74 </span> : std::string get_value(Xapian::valueno valueno) const; -<span class="lineNum"> 75 </span> : -<span class="lineNum"> 76 </span> : /** Add a new value. It will replace any existing value with the -<span class="lineNum"> 77 </span> : * same number. -<span class="lineNum"> 78 </span> : */ -<span class="lineNum"> 79 </span> : void add_value(Xapian::valueno valueno, const std::string &value); -<span class="lineNum"> 80 </span> : -<span class="lineNum"> 81 </span> : /// Remove any value with the given number. -<span class="lineNum"> 82 </span> : void remove_value(Xapian::valueno valueno); -<span class="lineNum"> 83 </span> : -<span class="lineNum"> 84 </span> : /// Remove all values associated with the document. -<span class="lineNum"> 85 </span> : void clear_values(); -<span class="lineNum"> 86 </span> : -<span class="lineNum"> 87 </span> : /** Get data stored in the document. -<span class="lineNum"> 88 </span> : * This is a potentially expensive operation, and shouldn't normally -<span class="lineNum"> 89 </span> : * be used in a match decider functor. Put data for use by match -<span class="lineNum"> 90 </span> : * deciders in a value instead. -<span class="lineNum"> 91 </span> : */ -<span class="lineNum"> 92 </span> : std::string get_data() const; -<span class="lineNum"> 93 </span> : -<span class="lineNum"> 94 </span> : /// Set data stored in the document. -<span class="lineNum"> 95 </span> : void set_data(const std::string &data); -<span class="lineNum"> 96 </span> : -<span class="lineNum"> 97 </span> : /** Add an occurrence of a term at a particular position. -<span class="lineNum"> 98 </span> : * -<span class="lineNum"> 99 </span> : * Multiple occurrences of the term at the same position are -<span class="lineNum"> 100 </span> : * represented only once in the positional information, but do -<span class="lineNum"> 101 </span> : * increase the wdf. -<span class="lineNum"> 102 </span> : * -<span class="lineNum"> 103 </span> : * If the term is not already in the document, it will be added to -<span class="lineNum"> 104 </span> : * it. -<span class="lineNum"> 105 </span> : * -<span class="lineNum"> 106 </span> : * @param tname The name of the term. -<span class="lineNum"> 107 </span> : * @param tpos The position of the term. -<span class="lineNum"> 108 </span> : * @param wdfinc The increment that will be applied to the wdf -<span class="lineNum"> 109 </span> : * for this term. -<span class="lineNum"> 110 </span> : */ -<span class="lineNum"> 111 </span> : void add_posting(const std::string & tname, -<span class="lineNum"> 112 </span> : Xapian::termpos tpos, -<span class="lineNum"> 113 </span> : Xapian::termcount wdfinc = 1); -<span class="lineNum"> 114 </span> : -<span class="lineNum"> 115 </span> : /** Add a term to the document, without positional information. -<span class="lineNum"> 116 </span> : * -<span class="lineNum"> 117 </span> : * Any existing positional information for the term will be left -<span class="lineNum"> 118 </span> : * unmodified. -<span class="lineNum"> 119 </span> : * -<span class="lineNum"> 120 </span> : * @param tname The name of the term. -<span class="lineNum"> 121 </span> : * @param wdfinc The increment that will be applied to the wdf -<span class="lineNum"> 122 </span> : * for this term. -<span class="lineNum"> 123 </span> : */ -<span class="lineNum"> 124 </span> : void add_term(const std::string & tname, Xapian::termcount wdfinc = 1); -<span class="lineNum"> 125 </span> : -<span class="lineNum"> 126 </span> : /** Remove a posting of a term from the document. -<span class="lineNum"> 127 </span> : * -<span class="lineNum"> 128 </span> : * Note that the term will still index the document even if all -<span class="lineNum"> 129 </span> : * occurrences are removed. To remove a term from a document -<span class="lineNum"> 130 </span> : * completely, use remove_term(). -<span class="lineNum"> 131 </span> : * -<span class="lineNum"> 132 </span> : * @param tname The name of the term. -<span class="lineNum"> 133 </span> : * @param tpos The position of the term. -<span class="lineNum"> 134 </span> : * @param wdfdec The decrement that will be applied to the wdf -<span class="lineNum"> 135 </span> : * when removing this posting. The wdf will not go -<span class="lineNum"> 136 </span> : * below the value of 0. -<span class="lineNum"> 137 </span> : * -<span class="lineNum"> 138 </span> : * @exception Xapian::InvalidArgumentError will be thrown if the term -<span class="lineNum"> 139 </span> : * is not at the position specified in the position list for this term -<span class="lineNum"> 140 </span> : * in this document. -<span class="lineNum"> 141 </span> : * -<span class="lineNum"> 142 </span> : * @exception Xapian::InvalidArgumentError will be thrown if the term -<span class="lineNum"> 143 </span> : * is not in the document -<span class="lineNum"> 144 </span> : */ -<span class="lineNum"> 145 </span> : void remove_posting(const std::string & tname, -<span class="lineNum"> 146 </span> : Xapian::termpos tpos, -<span class="lineNum"> 147 </span> : Xapian::termcount wdfdec = 1); -<span class="lineNum"> 148 </span> : -<span class="lineNum"> 149 </span> : /** Remove a term and all postings associated with it. -<span class="lineNum"> 150 </span> : * -<span class="lineNum"> 151 </span> : * @param tname The name of the term. -<span class="lineNum"> 152 </span> : * -<span class="lineNum"> 153 </span> : * @exception Xapian::InvalidArgumentError will be thrown if the term -<span class="lineNum"> 154 </span> : * is not in the document -<span class="lineNum"> 155 </span> : */ -<span class="lineNum"> 156 </span> : void remove_term(const std::string & tname); -<span class="lineNum"> 157 </span> : -<span class="lineNum"> 158 </span> : /// Remove all terms (and postings) from the document. -<span class="lineNum"> 159 </span> : void clear_terms(); -<span class="lineNum"> 160 </span> : -<span class="lineNum"> 161 </span> : /** The length of the termlist - i.e. the number of different terms -<span class="lineNum"> 162 </span> : * which index this document. -<span class="lineNum"> 163 </span> : */ -<span class="lineNum"> 164 </span> : Xapian::termcount termlist_count() const; -<span class="lineNum"> 165 </span> : -<span class="lineNum"> 166 </span> : /// Iterator for the terms in this document. -<span class="lineNum"> 167 </span> : TermIterator termlist_begin() const; -<span class="lineNum"> 168 </span> : -<span class="lineNum"> 169 </span> : /// Equivalent end iterator for termlist_begin(). -<span class="lineNum"> 170 </span><span class="lineNoCov"> 0 : TermIterator termlist_end() const {</span> -<span class="lineNum"> 171 </span><span class="lineNoCov"> 0 : return TermIterator(NULL);</span> -<span class="lineNum"> 172 </span> : } -<span class="lineNum"> 173 </span> : -<span class="lineNum"> 174 </span> : /// Count the values in this document. -<span class="lineNum"> 175 </span> : Xapian::termcount values_count() const; -<span class="lineNum"> 176 </span> : -<span class="lineNum"> 177 </span> : /// Iterator for the values in this document. -<span class="lineNum"> 178 </span> : ValueIterator values_begin() const; -<span class="lineNum"> 179 </span> : -<span class="lineNum"> 180 </span> : /// Equivalent end iterator for values_begin(). -<span class="lineNum"> 181 </span> : ValueIterator values_end() const; -<span class="lineNum"> 182 </span> : -<span class="lineNum"> 183 </span> : /** Get the document id which is associated with this document (if any). -<span class="lineNum"> 184 </span> : * -<span class="lineNum"> 185 </span> : * NB If multiple databases are being searched together, then this -<span class="lineNum"> 186 </span> : * will be the document id in the individual database, not the merged -<span class="lineNum"> 187 </span> : * database! -<span class="lineNum"> 188 </span> : * -<span class="lineNum"> 189 </span> : * @return If this document came from a database, return the document -<span class="lineNum"> 190 </span> : * id in that database. Otherwise, return 0. -<span class="lineNum"> 191 </span> : */ -<span class="lineNum"> 192 </span> : docid get_docid() const; -<span class="lineNum"> 193 </span> : -<span class="lineNum"> 194 </span> : /// Return a string describing this object. -<span class="lineNum"> 195 </span> : std::string get_description() const; -<span class="lineNum"> 196 </span> : }; -<span class="lineNum"> 197 </span> : -<span class="lineNum"> 198 </span> : } -<span class="lineNum"> 199 </span> : -<span class="lineNum"> 200 </span> : #endif // XAPIAN_INCLUDED_DOCUMENT_H -</pre> - </td> - </tr> - </table> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> diff --git a/rep/usr/include/xapian/enquire.h.gcov.html b/rep/usr/include/xapian/enquire.h.gcov.html deleted file mode 100644 index 15ca5f0..0000000 --- a/rep/usr/include/xapian/enquire.h.gcov.html +++ /dev/null @@ -1,1361 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian/enquire.h</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - enquire.h</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">29</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">89.7 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">26</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <table cellpadding=0 cellspacing=0 border=0> - <tr> - <td><br></td> - </tr> - <tr> - <td><pre class="source"> -<span class="lineNum"> 1 </span> : /** \file enquire.h -<span class="lineNum"> 2 </span> : * \brief API for running queries -<span class="lineNum"> 3 </span> : */ -<span class="lineNum"> 4 </span> : /* Copyright 1999,2000,2001 BrightStation PLC -<span class="lineNum"> 5 </span> : * Copyright 2001,2002 Ananova Ltd -<span class="lineNum"> 6 </span> : * Copyright 2002,2003,2004,2005,2006,2007 Olly Betts -<span class="lineNum"> 7 </span> : * -<span class="lineNum"> 8 </span> : * This program is free software; you can redistribute it and/or -<span class="lineNum"> 9 </span> : * modify it under the terms of the GNU General Public License as -<span class="lineNum"> 10 </span> : * published by the Free Software Foundation; either version 2 of the -<span class="lineNum"> 11 </span> : * License, or (at your option) any later version. -<span class="lineNum"> 12 </span> : * -<span class="lineNum"> 13 </span> : * This program is distributed in the hope that it will be useful, -<span class="lineNum"> 14 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of -<span class="lineNum"> 15 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -<span class="lineNum"> 16 </span> : * GNU General Public License for more details. -<span class="lineNum"> 17 </span> : * -<span class="lineNum"> 18 </span> : * You should have received a copy of the GNU General Public License -<span class="lineNum"> 19 </span> : * along with this program; if not, write to the Free Software -<span class="lineNum"> 20 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 -<span class="lineNum"> 21 </span> : * USA -<span class="lineNum"> 22 </span> : */ -<span class="lineNum"> 23 </span> : -<span class="lineNum"> 24 </span> : #ifndef XAPIAN_INCLUDED_ENQUIRE_H -<span class="lineNum"> 25 </span> : #define XAPIAN_INCLUDED_ENQUIRE_H -<span class="lineNum"> 26 </span> : -<span class="lineNum"> 27 </span> : #include <string> -<span class="lineNum"> 28 </span> : -<span class="lineNum"> 29 </span> : #include <xapian/base.h> -<span class="lineNum"> 30 </span> : #include <xapian/deprecated.h> -<span class="lineNum"> 31 </span> : #include <xapian/sorter.h> -<span class="lineNum"> 32 </span> : #include <xapian/types.h> -<span class="lineNum"> 33 </span> : #include <xapian/termiterator.h> -<span class="lineNum"> 34 </span> : #include <xapian/visibility.h> -<span class="lineNum"> 35 </span> : -<span class="lineNum"> 36 </span> : namespace Xapian { -<span class="lineNum"> 37 </span> : -<span class="lineNum"> 38 </span> : class Database; -<span class="lineNum"> 39 </span> : class Document; -<span class="lineNum"> 40 </span> : class ErrorHandler; -<span class="lineNum"> 41 </span> : class ExpandDecider; -<span class="lineNum"> 42 </span> : class MSetIterator; -<span class="lineNum"> 43 </span> : class Query; -<span class="lineNum"> 44 </span> : class Weight; -<span class="lineNum"> 45 </span> : -<span class="lineNum"> 46 </span> : /** A match set (MSet). -<span class="lineNum"> 47 </span> : * This class represents (a portion of) the results of a query. -<span class="lineNum"> 48 </span> : */ -<span class="lineNum"> 49 </span> : class XAPIAN_VISIBILITY_DEFAULT MSet { -<span class="lineNum"> 50 </span> : public: -<span class="lineNum"> 51 </span> : class Internal; -<span class="lineNum"> 52 </span> : /// @internal Reference counted internals. -<span class="lineNum"> 53 </span> : Xapian::Internal::RefCntPtr<Internal> internal; -<span class="lineNum"> 54 </span> : -<span class="lineNum"> 55 </span> : /// @internal Constructor for internal use. -<span class="lineNum"> 56 </span> : explicit MSet(MSet::Internal * internal_); -<span class="lineNum"> 57 </span> : -<span class="lineNum"> 58 </span> : /// Create an empty Xapian::MSet. -<span class="lineNum"> 59 </span> : MSet(); -<span class="lineNum"> 60 </span> : -<span class="lineNum"> 61 </span> : /// Destroy a Xapian::MSet. -<span class="lineNum"> 62 </span> : ~MSet(); -<span class="lineNum"> 63 </span> : -<span class="lineNum"> 64 </span> : /// Copying is allowed (and is cheap). -<span class="lineNum"> 65 </span> : MSet(const MSet & other); -<span class="lineNum"> 66 </span> : -<span class="lineNum"> 67 </span> : /// Assignment is allowed (and is cheap). -<span class="lineNum"> 68 </span> : void operator=(const MSet &other); -<span class="lineNum"> 69 </span> : -<span class="lineNum"> 70 </span> : /** Fetch the document info for a set of items in the MSet. -<span class="lineNum"> 71 </span> : * -<span class="lineNum"> 72 </span> : * This method causes the documents in the range specified by the -<span class="lineNum"> 73 </span> : * iterators to be fetched from the database, and cached in the -<span class="lineNum"> 74 </span> : * Xapian::MSet object. This has little effect when performing a -<span class="lineNum"> 75 </span> : * search across a local database, but will greatly speed up -<span class="lineNum"> 76 </span> : * subsequent access to the document contents when the documents are -<span class="lineNum"> 77 </span> : * stored in a remote database. -<span class="lineNum"> 78 </span> : * -<span class="lineNum"> 79 </span> : * The iterators must be over this Xapian::MSet - undefined behaviour -<span class="lineNum"> 80 </span> : * will result otherwise. -<span class="lineNum"> 81 </span> : * -<span class="lineNum"> 82 </span> : * @param begin MSetIterator for first item to fetch. -<span class="lineNum"> 83 </span> : * @param end MSetIterator for item after last item to fetch. -<span class="lineNum"> 84 </span> : */ -<span class="lineNum"> 85 </span> : void fetch(const MSetIterator &begin, const MSetIterator &end) const; -<span class="lineNum"> 86 </span> : -<span class="lineNum"> 87 </span> : /** Fetch the single item specified. -<span class="lineNum"> 88 </span> : */ -<span class="lineNum"> 89 </span> : void fetch(const MSetIterator &item) const; -<span class="lineNum"> 90 </span> : -<span class="lineNum"> 91 </span> : /** Fetch all the items in the MSet. -<span class="lineNum"> 92 </span> : */ -<span class="lineNum"> 93 </span> : void fetch() const; -<span class="lineNum"> 94 </span> : -<span class="lineNum"> 95 </span> : /** This converts the weight supplied to a percentage score. -<span class="lineNum"> 96 </span> : * The return value will be in the range 0 to 100, and will be 0 if -<span class="lineNum"> 97 </span> : * and only if the item did not match the query at all. -<span class="lineNum"> 98 </span> : */ -<span class="lineNum"> 99 </span> : Xapian::percent convert_to_percent(Xapian::weight wt) const; -<span class="lineNum"> 100 </span> : -<span class="lineNum"> 101 </span> : /// Return the percentage score for a particular item. -<span class="lineNum"> 102 </span> : Xapian::percent convert_to_percent(const MSetIterator &it) const; -<span class="lineNum"> 103 </span> : -<span class="lineNum"> 104 </span> : /** Return the term frequency of the given query term. -<span class="lineNum"> 105 </span> : * -<span class="lineNum"> 106 </span> : * @param tname The term to look for. -<span class="lineNum"> 107 </span> : * -<span class="lineNum"> 108 </span> : * @exception Xapian::InvalidArgumentError is thrown if the term was -<span class="lineNum"> 109 </span> : * not in the query. -<span class="lineNum"> 110 </span> : */ -<span class="lineNum"> 111 </span> : Xapian::doccount get_termfreq(const std::string &tname) const; -<span class="lineNum"> 112 </span> : -<span class="lineNum"> 113 </span> : /** Return the term weight of the given query term. -<span class="lineNum"> 114 </span> : * -<span class="lineNum"> 115 </span> : * @param tname The term to look for. -<span class="lineNum"> 116 </span> : * -<span class="lineNum"> 117 </span> : * @exception Xapian::InvalidArgumentError is thrown if the term was -<span class="lineNum"> 118 </span> : * not in the query. -<span class="lineNum"> 119 </span> : */ -<span class="lineNum"> 120 </span> : Xapian::weight get_termweight(const std::string &tname) const; -<span class="lineNum"> 121 </span> : -<span class="lineNum"> 122 </span> : /** The index of the first item in the result which was put into the -<span class="lineNum"> 123 </span> : * MSet. -<span class="lineNum"> 124 </span> : * -<span class="lineNum"> 125 </span> : * This corresponds to the parameter "first" specified in -<span class="lineNum"> 126 </span> : * Xapian::Enquire::get_mset(). A value of 0 corresponds to the -<span class="lineNum"> 127 </span> : * highest result being the first item in the MSet. -<span class="lineNum"> 128 </span> : */ -<span class="lineNum"> 129 </span> : Xapian::doccount get_firstitem() const; -<span class="lineNum"> 130 </span> : -<span class="lineNum"> 131 </span> : /** A lower bound on the number of documents in the database which -<span class="lineNum"> 132 </span> : * match the query. -<span class="lineNum"> 133 </span> : * -<span class="lineNum"> 134 </span> : * This figure takes into account collapsing of duplicates, -<span class="lineNum"> 135 </span> : * and weighting cutoff values. -<span class="lineNum"> 136 </span> : * -<span class="lineNum"> 137 </span> : * This number is usually considerably less than the actual number -<span class="lineNum"> 138 </span> : * of documents which match the query. -<span class="lineNum"> 139 </span> : */ -<span class="lineNum"> 140 </span> : Xapian::doccount get_matches_lower_bound() const; -<span class="lineNum"> 141 </span> : -<span class="lineNum"> 142 </span> : /** An estimate for the number of documents in the database which -<span class="lineNum"> 143 </span> : * match the query. -<span class="lineNum"> 144 </span> : * -<span class="lineNum"> 145 </span> : * This figure takes into account collapsing of duplicates, -<span class="lineNum"> 146 </span> : * and weighting cutoff values. -<span class="lineNum"> 147 </span> : * -<span class="lineNum"> 148 </span> : * This value is returned because there is sometimes a request to -<span class="lineNum"> 149 </span> : * display such information. However, our experience is that -<span class="lineNum"> 150 </span> : * presenting this value to users causes them to worry about the -<span class="lineNum"> 151 </span> : * large number of results, rather than how useful those at the top -<span class="lineNum"> 152 </span> : * of the result set are, and is thus undesirable. -<span class="lineNum"> 153 </span> : */ -<span class="lineNum"> 154 </span> : Xapian::doccount get_matches_estimated() const; -<span class="lineNum"> 155 </span> : -<span class="lineNum"> 156 </span> : /** An upper bound on the number of documents in the database which -<span class="lineNum"> 157 </span> : * match the query. -<span class="lineNum"> 158 </span> : * -<span class="lineNum"> 159 </span> : * This figure takes into account collapsing of duplicates, -<span class="lineNum"> 160 </span> : * and weighting cutoff values. -<span class="lineNum"> 161 </span> : * -<span class="lineNum"> 162 </span> : * This number is usually considerably greater than the actual -<span class="lineNum"> 163 </span> : * number of documents which match the query. -<span class="lineNum"> 164 </span> : */ -<span class="lineNum"> 165 </span> : Xapian::doccount get_matches_upper_bound() const; -<span class="lineNum"> 166 </span> : -<span class="lineNum"> 167 </span> : /** The maximum possible weight in the MSet. -<span class="lineNum"> 168 </span> : * This weight is likely not to be attained in the set of results, -<span class="lineNum"> 169 </span> : * but represents an upper bound on the weight which a document -<span class="lineNum"> 170 </span> : * could attain for the given query. -<span class="lineNum"> 171 </span> : */ -<span class="lineNum"> 172 </span> : Xapian::weight get_max_possible() const; -<span class="lineNum"> 173 </span> : -<span class="lineNum"> 174 </span> : /** The greatest weight which is attained by any document in the -<span class="lineNum"> 175 </span> : * database. -<span class="lineNum"> 176 </span> : * -<span class="lineNum"> 177 </span> : * If firstitem == 0, this is the weight of the first entry in -<span class="lineNum"> 178 </span> : * items. -<span class="lineNum"> 179 </span> : * -<span class="lineNum"> 180 </span> : * If no documents are found by the query, this will be 0. -<span class="lineNum"> 181 </span> : * -<span class="lineNum"> 182 </span> : * Note that calculation of max_attained requires calculation -<span class="lineNum"> 183 </span> : * of at least one result item - therefore, if no items were -<span class="lineNum"> 184 </span> : * requested when the query was performed (by specifying -<span class="lineNum"> 185 </span> : * maxitems = 0 in Xapian::Enquire::get_mset()), this value will be 0. -<span class="lineNum"> 186 </span> : */ -<span class="lineNum"> 187 </span> : Xapian::weight get_max_attained() const; -<span class="lineNum"> 188 </span> : -<span class="lineNum"> 189 </span> : /** The number of items in this MSet */ -<span class="lineNum"> 190 </span> : Xapian::doccount size() const; -<span class="lineNum"> 191 </span> : -<span class="lineNum"> 192 </span> : /** Required to allow use as an STL container. */ -<span class="lineNum"> 193 </span> : Xapian::doccount max_size() const { return size(); } -<span class="lineNum"> 194 </span> : -<span class="lineNum"> 195 </span> : /** Test if this MSet is empty */ -<span class="lineNum"> 196 </span> : bool empty() const; -<span class="lineNum"> 197 </span> : -<span class="lineNum"> 198 </span> : /** Swap the MSet we point to with another */ -<span class="lineNum"> 199 </span> : void swap(MSet & other); -<span class="lineNum"> 200 </span> : -<span class="lineNum"> 201 </span> : /** Iterator for the terms in this MSet */ -<span class="lineNum"> 202 </span> : MSetIterator begin() const; -<span class="lineNum"> 203 </span> : -<span class="lineNum"> 204 </span> : /** End iterator corresponding to begin() */ -<span class="lineNum"> 205 </span> : MSetIterator end() const; -<span class="lineNum"> 206 </span> : -<span class="lineNum"> 207 </span> : /** Iterator pointing to the last element of this MSet */ -<span class="lineNum"> 208 </span> : MSetIterator back() const; -<span class="lineNum"> 209 </span> : -<span class="lineNum"> 210 </span> : /** This returns the document at position i in this MSet object. -<span class="lineNum"> 211 </span> : * -<span class="lineNum"> 212 </span> : * Note that this is not the same as the document at rank i in the -<span class="lineNum"> 213 </span> : * query, unless the "first" parameter to Xapian::Enquire::get_mset -<span class="lineNum"> 214 </span> : * was 0. Rather, it is the document at rank i + first. -<span class="lineNum"> 215 </span> : * -<span class="lineNum"> 216 </span> : * In other words, the offset is into the documents represented by -<span class="lineNum"> 217 </span> : * this object, not into the set of documents matching the query. -<span class="lineNum"> 218 </span> : */ -<span class="lineNum"> 219 </span> : MSetIterator operator[](Xapian::doccount i) const; -<span class="lineNum"> 220 </span> : -<span class="lineNum"> 221 </span> : /// Allow use as an STL container -<span class="lineNum"> 222 </span> : //@{ -<span class="lineNum"> 223 </span> : typedef MSetIterator value_type; // FIXME: not assignable... -<span class="lineNum"> 224 </span> : typedef MSetIterator iterator; -<span class="lineNum"> 225 </span> : typedef MSetIterator const_iterator; -<span class="lineNum"> 226 </span> : typedef MSetIterator & reference; // Hmm -<span class="lineNum"> 227 </span> : typedef MSetIterator & const_reference; -<span class="lineNum"> 228 </span> : typedef MSetIterator * pointer; // Hmm -<span class="lineNum"> 229 </span> : typedef Xapian::doccount_diff difference_type; -<span class="lineNum"> 230 </span> : typedef Xapian::doccount size_type; -<span class="lineNum"> 231 </span> : //@} -<span class="lineNum"> 232 </span> : -<span class="lineNum"> 233 </span> : /// Return a string describing this object. -<span class="lineNum"> 234 </span> : std::string get_description() const; -<span class="lineNum"> 235 </span> : }; -<span class="lineNum"> 236 </span> : -<span class="lineNum"> 237 </span> : /** An iterator pointing to items in an MSet. -<span class="lineNum"> 238 </span> : * This is used for access to individual results of a match. -<span class="lineNum"> 239 </span> : */ -<span class="lineNum"> 240 </span> : class XAPIAN_VISIBILITY_DEFAULT MSetIterator { -<span class="lineNum"> 241 </span> : private: -<span class="lineNum"> 242 </span> : friend class MSet; -<span class="lineNum"> 243 </span> : friend bool operator==(const MSetIterator &a, const MSetIterator &b); -<span class="lineNum"> 244 </span> : friend bool operator!=(const MSetIterator &a, const MSetIterator &b); -<span class="lineNum"> 245 </span> : -<span class="lineNum"> 246 </span> : MSetIterator(Xapian::doccount index_, const MSet & mset_) -<span class="lineNum"> 247 </span> : : index(index_), mset(mset_) { } -<span class="lineNum"> 248 </span> : -<span class="lineNum"> 249 </span> : Xapian::doccount index; -<span class="lineNum"> 250 </span> : MSet mset; -<span class="lineNum"> 251 </span> : -<span class="lineNum"> 252 </span> : public: -<span class="lineNum"> 253 </span> : /** Create an uninitialised iterator; this cannot be used, but is -<span class="lineNum"> 254 </span> : * convenient syntactically. -<span class="lineNum"> 255 </span> : */ -<span class="lineNum"> 256 </span><span class="lineCov"> 3 : MSetIterator() : index(0), mset() { }</span> -<span class="lineNum"> 257 </span> : -<span class="lineNum"> 258 </span><span class="lineCov"> 165 : ~MSetIterator() { }</span> -<span class="lineNum"> 259 </span> : -<span class="lineNum"> 260 </span> : /// Copying is allowed (and is cheap). -<span class="lineNum"> 261 </span><span class="lineCov"> 58 : MSetIterator(const MSetIterator &other) {</span> -<span class="lineNum"> 262 </span><span class="lineCov"> 58 : index = other.index;</span> -<span class="lineNum"> 263 </span><span class="lineCov"> 58 : mset = other.mset;</span> -<span class="lineNum"> 264 </span><span class="lineCov"> 58 : }</span> -<span class="lineNum"> 265 </span> : -<span class="lineNum"> 266 </span> : /// Assignment is allowed (and is cheap). -<span class="lineNum"> 267 </span><span class="lineCov"> 31 : void operator=(const MSetIterator &other) {</span> -<span class="lineNum"> 268 </span><span class="lineCov"> 31 : index = other.index;</span> -<span class="lineNum"> 269 </span><span class="lineCov"> 31 : mset = other.mset;</span> -<span class="lineNum"> 270 </span><span class="lineCov"> 31 : }</span> -<span class="lineNum"> 271 </span> : -<span class="lineNum"> 272 </span> : /// Advance the iterator. -<span class="lineNum"> 273 </span><span class="lineCov"> 61 : MSetIterator & operator++() {</span> -<span class="lineNum"> 274 </span><span class="lineCov"> 61 : ++index;</span> -<span class="lineNum"> 275 </span><span class="lineCov"> 61 : return *this;</span> -<span class="lineNum"> 276 </span> : } -<span class="lineNum"> 277 </span> : -<span class="lineNum"> 278 </span> : /// Advance the iterator (postfix variant). -<span class="lineNum"> 279 </span><span class="lineCov"> 28 : MSetIterator operator++(int) {</span> -<span class="lineNum"> 280 </span><span class="lineCov"> 28 : MSetIterator tmp = *this;</span> -<span class="lineNum"> 281 </span><span class="lineCov"> 28 : ++index;</span> -<span class="lineNum"> 282 </span> : return tmp; -<span class="lineNum"> 283 </span> : } -<span class="lineNum"> 284 </span> : -<span class="lineNum"> 285 </span> : /// Decrement the iterator. -<span class="lineNum"> 286 </span> : MSetIterator & operator--() { -<span class="lineNum"> 287 </span> : --index; -<span class="lineNum"> 288 </span> : return *this; -<span class="lineNum"> 289 </span> : } -<span class="lineNum"> 290 </span> : -<span class="lineNum"> 291 </span> : /// Decrement the iterator (postfix variant). -<span class="lineNum"> 292 </span> : MSetIterator operator--(int) { -<span class="lineNum"> 293 </span> : MSetIterator tmp = *this; -<span class="lineNum"> 294 </span> : --index; -<span class="lineNum"> 295 </span> : return tmp; -<span class="lineNum"> 296 </span> : } -<span class="lineNum"> 297 </span> : -<span class="lineNum"> 298 </span> : /// Get the document ID for the current position. -<span class="lineNum"> 299 </span> : Xapian::docid operator*() const; -<span class="lineNum"> 300 </span> : -<span class="lineNum"> 301 </span> : /** Get a Xapian::Document object for the current position. -<span class="lineNum"> 302 </span> : * -<span class="lineNum"> 303 </span> : * This method returns a Xapian::Document object which provides the -<span class="lineNum"> 304 </span> : * information about the document pointed to by the MSetIterator. -<span class="lineNum"> 305 </span> : * -<span class="lineNum"> 306 </span> : * If the underlying database has suitable support, using this call -<span class="lineNum"> 307 </span> : * (rather than asking the database for a document based on its -<span class="lineNum"> 308 </span> : * document ID) will enable the system to ensure that the correct -<span class="lineNum"> 309 </span> : * data is returned, and that the document has not been deleted -<span class="lineNum"> 310 </span> : * or changed since the query was performed. -<span class="lineNum"> 311 </span> : * -<span class="lineNum"> 312 </span> : * @return A Xapian::Document object containing the document data. -<span class="lineNum"> 313 </span> : * -<span class="lineNum"> 314 </span> : * @exception Xapian::DocNotFoundError The document specified could not -<span class="lineNum"> 315 </span> : * be found in the database. -<span class="lineNum"> 316 </span> : */ -<span class="lineNum"> 317 </span> : Xapian::Document get_document() const; -<span class="lineNum"> 318 </span> : -<span class="lineNum"> 319 </span> : /** Get the rank of the document at the current position. -<span class="lineNum"> 320 </span> : * -<span class="lineNum"> 321 </span> : * The rank is the position that this document is at in the ordered -<span class="lineNum"> 322 </span> : * list of results of the query. The result is 0-based - i.e. the -<span class="lineNum"> 323 </span> : * top-ranked document has a rank of 0. -<span class="lineNum"> 324 </span> : */ -<span class="lineNum"> 325 </span> : Xapian::doccount get_rank() const { -<span class="lineNum"> 326 </span> : return mset.get_firstitem() + index; -<span class="lineNum"> 327 </span> : } -<span class="lineNum"> 328 </span> : -<span class="lineNum"> 329 </span> : /// Get the weight of the document at the current position -<span class="lineNum"> 330 </span> : Xapian::weight get_weight() const; -<span class="lineNum"> 331 </span> : -<span class="lineNum"> 332 </span> : /** Get the collapse key for this document. -<span class="lineNum"> 333 </span> : */ -<span class="lineNum"> 334 </span> : std::string get_collapse_key() const; -<span class="lineNum"> 335 </span> : -<span class="lineNum"> 336 </span> : /** Get an estimate of the number of documents that have been collapsed -<span class="lineNum"> 337 </span> : * into this one. -<span class="lineNum"> 338 </span> : * -<span class="lineNum"> 339 </span> : * The estimate will always be less than or equal to the actual -<span class="lineNum"> 340 </span> : * number of other documents satisfying the match criteria with the -<span class="lineNum"> 341 </span> : * same collapse key as this document. -<span class="lineNum"> 342 </span> : * -<span class="lineNum"> 343 </span> : * This method may return 0 even though there are other documents with -<span class="lineNum"> 344 </span> : * the same collapse key which satisfying the match criteria. However -<span class="lineNum"> 345 </span> : * if this method returns non-zero, there definitely are other such -<span class="lineNum"> 346 </span> : * documents. So this method may be used to inform the user that -<span class="lineNum"> 347 </span> : * there are "at least N other matches in this group", or to control -<span class="lineNum"> 348 </span> : * whether to offer a "show other documents in this group" feature -<span class="lineNum"> 349 </span> : * (but note that it may not offer it in every case where it would -<span class="lineNum"> 350 </span> : * show other documents). -<span class="lineNum"> 351 </span> : */ -<span class="lineNum"> 352 </span> : Xapian::doccount get_collapse_count() const; -<span class="lineNum"> 353 </span> : -<span class="lineNum"> 354 </span> : /** This returns the weight of the document as a percentage score. -<span class="lineNum"> 355 </span> : * -<span class="lineNum"> 356 </span> : * The return value will be in the range 0 to 100: 0 meaning -<span class="lineNum"> 357 </span> : * that the item did not match the query at all. -<span class="lineNum"> 358 </span> : */ -<span class="lineNum"> 359 </span> : Xapian::percent get_percent() const; -<span class="lineNum"> 360 </span> : -<span class="lineNum"> 361 </span> : /// Return a string describing this object. -<span class="lineNum"> 362 </span> : std::string get_description() const; -<span class="lineNum"> 363 </span> : -<span class="lineNum"> 364 </span> : /// Allow use as an STL iterator -<span class="lineNum"> 365 </span> : //@{ -<span class="lineNum"> 366 </span> : typedef std::bidirectional_iterator_tag iterator_category; // FIXME: could enhance to be a randomaccess_iterator -<span class="lineNum"> 367 </span> : typedef Xapian::docid value_type; -<span class="lineNum"> 368 </span> : typedef Xapian::doccount_diff difference_type; -<span class="lineNum"> 369 </span> : typedef Xapian::docid * pointer; -<span class="lineNum"> 370 </span> : typedef Xapian::docid & reference; -<span class="lineNum"> 371 </span> : //@} -<span class="lineNum"> 372 </span> : }; -<span class="lineNum"> 373 </span> : -<span class="lineNum"> 374 </span><span class="lineCov"> 30 : inline bool operator==(const MSetIterator &a, const MSetIterator &b)</span> -<span class="lineNum"> 375 </span> : { -<span class="lineNum"> 376 </span><span class="lineCov"> 30 : return (a.index == b.index);</span> -<span class="lineNum"> 377 </span> : } -<span class="lineNum"> 378 </span> : -<span class="lineNum"> 379 </span><span class="lineCov"> 58 : inline bool operator!=(const MSetIterator &a, const MSetIterator &b)</span> -<span class="lineNum"> 380 </span> : { -<span class="lineNum"> 381 </span><span class="lineCov"> 58 : return (a.index != b.index);</span> -<span class="lineNum"> 382 </span> : } -<span class="lineNum"> 383 </span> : -<span class="lineNum"> 384 </span> : class ESetIterator; -<span class="lineNum"> 385 </span> : -<span class="lineNum"> 386 </span> : /** Class representing an ordered set of expand terms (an ESet). -<span class="lineNum"> 387 </span> : * This set represents the results of an expand operation, which is -<span class="lineNum"> 388 </span> : * performed by Xapian::Enquire::get_eset(). -<span class="lineNum"> 389 </span> : */ -<span class="lineNum"> 390 </span> : class XAPIAN_VISIBILITY_DEFAULT ESet { -<span class="lineNum"> 391 </span> : public: -<span class="lineNum"> 392 </span> : class Internal; -<span class="lineNum"> 393 </span> : /// @internal Reference counted internals. -<span class="lineNum"> 394 </span> : Xapian::Internal::RefCntPtr<Internal> internal; -<span class="lineNum"> 395 </span> : -<span class="lineNum"> 396 </span> : /// Construct an empty ESet -<span class="lineNum"> 397 </span> : ESet(); -<span class="lineNum"> 398 </span> : -<span class="lineNum"> 399 </span> : /// Destructor. -<span class="lineNum"> 400 </span> : ~ESet(); -<span class="lineNum"> 401 </span> : -<span class="lineNum"> 402 </span> : /// Copying is allowed (and is cheap). -<span class="lineNum"> 403 </span> : ESet(const ESet & other); -<span class="lineNum"> 404 </span> : -<span class="lineNum"> 405 </span> : /// Assignment is allowed (and is cheap). -<span class="lineNum"> 406 </span> : void operator=(const ESet &other); -<span class="lineNum"> 407 </span> : -<span class="lineNum"> 408 </span> : /** A lower bound on the number of terms which are in the full -<span class="lineNum"> 409 </span> : * set of results of the expand. This will be greater than or -<span class="lineNum"> 410 </span> : * equal to size() -<span class="lineNum"> 411 </span> : */ -<span class="lineNum"> 412 </span> : Xapian::termcount get_ebound() const; -<span class="lineNum"> 413 </span> : -<span class="lineNum"> 414 </span> : /** The number of terms in this E-Set */ -<span class="lineNum"> 415 </span> : Xapian::termcount size() const; -<span class="lineNum"> 416 </span> : -<span class="lineNum"> 417 </span> : /** Required to allow use as an STL container. */ -<span class="lineNum"> 418 </span> : Xapian::termcount max_size() const { return size(); } -<span class="lineNum"> 419 </span> : -<span class="lineNum"> 420 </span> : /** Test if this E-Set is empty */ -<span class="lineNum"> 421 </span> : bool empty() const; -<span class="lineNum"> 422 </span> : -<span class="lineNum"> 423 </span> : /** Swap the E-Set we point to with another */ -<span class="lineNum"> 424 </span> : void swap(ESet & other); -<span class="lineNum"> 425 </span> : -<span class="lineNum"> 426 </span> : /** Iterator for the terms in this E-Set */ -<span class="lineNum"> 427 </span> : ESetIterator begin() const; -<span class="lineNum"> 428 </span> : -<span class="lineNum"> 429 </span> : /** End iterator corresponding to begin() */ -<span class="lineNum"> 430 </span> : ESetIterator end() const; -<span class="lineNum"> 431 </span> : -<span class="lineNum"> 432 </span> : /** Iterator pointing to the last element of this E-Set */ -<span class="lineNum"> 433 </span> : ESetIterator back() const; -<span class="lineNum"> 434 </span> : -<span class="lineNum"> 435 </span> : /** This returns the term at position i in this E-Set. */ -<span class="lineNum"> 436 </span> : ESetIterator operator[](Xapian::termcount i) const; -<span class="lineNum"> 437 </span> : -<span class="lineNum"> 438 </span> : /// Return a string describing this object. -<span class="lineNum"> 439 </span> : std::string get_description() const; -<span class="lineNum"> 440 </span> : }; -<span class="lineNum"> 441 </span> : -<span class="lineNum"> 442 </span> : /** Iterate through terms in the ESet */ -<span class="lineNum"> 443 </span> : class XAPIAN_VISIBILITY_DEFAULT ESetIterator { -<span class="lineNum"> 444 </span> : private: -<span class="lineNum"> 445 </span> : friend class ESet; -<span class="lineNum"> 446 </span> : friend bool operator==(const ESetIterator &a, const ESetIterator &b); -<span class="lineNum"> 447 </span> : friend bool operator!=(const ESetIterator &a, const ESetIterator &b); -<span class="lineNum"> 448 </span> : -<span class="lineNum"> 449 </span> : ESetIterator(Xapian::termcount index_, const ESet & eset_) -<span class="lineNum"> 450 </span> : : index(index_), eset(eset_) { } -<span class="lineNum"> 451 </span> : -<span class="lineNum"> 452 </span> : Xapian::termcount index; -<span class="lineNum"> 453 </span> : ESet eset; -<span class="lineNum"> 454 </span> : -<span class="lineNum"> 455 </span> : public: -<span class="lineNum"> 456 </span> : /** Create an uninitialised iterator; this cannot be used, but is -<span class="lineNum"> 457 </span> : * convenient syntactically. -<span class="lineNum"> 458 </span> : */ -<span class="lineNum"> 459 </span> : ESetIterator() : index(0), eset() { } -<span class="lineNum"> 460 </span> : -<span class="lineNum"> 461 </span><span class="lineCov"> 8 : ~ESetIterator() { }</span> -<span class="lineNum"> 462 </span> : -<span class="lineNum"> 463 </span> : /// Copying is allowed (and is cheap). -<span class="lineNum"> 464 </span> : ESetIterator(const ESetIterator &other) { -<span class="lineNum"> 465 </span> : index = other.index; -<span class="lineNum"> 466 </span> : eset = other.eset; -<span class="lineNum"> 467 </span> : } -<span class="lineNum"> 468 </span> : -<span class="lineNum"> 469 </span> : /// Assignment is allowed (and is cheap). -<span class="lineNum"> 470 </span> : void operator=(const ESetIterator &other) { -<span class="lineNum"> 471 </span> : index = other.index; -<span class="lineNum"> 472 </span> : eset = other.eset; -<span class="lineNum"> 473 </span> : } -<span class="lineNum"> 474 </span> : -<span class="lineNum"> 475 </span> : /// Advance the iterator. -<span class="lineNum"> 476 </span><span class="lineNoCov"> 0 : ESetIterator & operator++() {</span> -<span class="lineNum"> 477 </span><span class="lineNoCov"> 0 : ++index;</span> -<span class="lineNum"> 478 </span><span class="lineNoCov"> 0 : return *this;</span> -<span class="lineNum"> 479 </span> : } -<span class="lineNum"> 480 </span> : -<span class="lineNum"> 481 </span> : /// Advance the iterator (postfix variant). -<span class="lineNum"> 482 </span> : ESetIterator operator++(int) { -<span class="lineNum"> 483 </span> : ESetIterator tmp = *this; -<span class="lineNum"> 484 </span> : ++index; -<span class="lineNum"> 485 </span> : return tmp; -<span class="lineNum"> 486 </span> : } -<span class="lineNum"> 487 </span> : -<span class="lineNum"> 488 </span> : /// Decrement the iterator. -<span class="lineNum"> 489 </span> : ESetIterator & operator--() { -<span class="lineNum"> 490 </span> : --index; -<span class="lineNum"> 491 </span> : return *this; -<span class="lineNum"> 492 </span> : } -<span class="lineNum"> 493 </span> : -<span class="lineNum"> 494 </span> : /// Decrement the iterator (postfix variant). -<span class="lineNum"> 495 </span> : ESetIterator operator--(int) { -<span class="lineNum"> 496 </span> : ESetIterator tmp = *this; -<span class="lineNum"> 497 </span> : --index; -<span class="lineNum"> 498 </span> : return tmp; -<span class="lineNum"> 499 </span> : } -<span class="lineNum"> 500 </span> : -<span class="lineNum"> 501 </span> : /// Get the term for the current position -<span class="lineNum"> 502 </span> : const std::string & operator *() const; -<span class="lineNum"> 503 </span> : -<span class="lineNum"> 504 </span> : /// Get the weight of the term at the current position -<span class="lineNum"> 505 </span> : Xapian::weight get_weight() const; -<span class="lineNum"> 506 </span> : -<span class="lineNum"> 507 </span> : /// Return a string describing this object. -<span class="lineNum"> 508 </span> : std::string get_description() const; -<span class="lineNum"> 509 </span> : -<span class="lineNum"> 510 </span> : /// Allow use as an STL iterator -<span class="lineNum"> 511 </span> : //@{ -<span class="lineNum"> 512 </span> : typedef std::bidirectional_iterator_tag iterator_category; // FIXME: go for randomaccess_iterator! -<span class="lineNum"> 513 </span> : typedef std::string value_type; -<span class="lineNum"> 514 </span> : typedef Xapian::termcount_diff difference_type; -<span class="lineNum"> 515 </span> : typedef std::string * pointer; -<span class="lineNum"> 516 </span> : typedef std::string & reference; -<span class="lineNum"> 517 </span> : //@} -<span class="lineNum"> 518 </span> : }; -<span class="lineNum"> 519 </span> : -<span class="lineNum"> 520 </span> : inline bool operator==(const ESetIterator &a, const ESetIterator &b) -<span class="lineNum"> 521 </span> : { -<span class="lineNum"> 522 </span> : return (a.index == b.index); -<span class="lineNum"> 523 </span> : } -<span class="lineNum"> 524 </span> : -<span class="lineNum"> 525 </span><span class="lineCov"> 4 : inline bool operator!=(const ESetIterator &a, const ESetIterator &b)</span> -<span class="lineNum"> 526 </span> : { -<span class="lineNum"> 527 </span><span class="lineCov"> 4 : return (a.index != b.index);</span> -<span class="lineNum"> 528 </span> : } -<span class="lineNum"> 529 </span> : -<span class="lineNum"> 530 </span> : /** A relevance set (R-Set). -<span class="lineNum"> 531 </span> : * This is the set of documents which are marked as relevant, for use -<span class="lineNum"> 532 </span> : * in modifying the term weights, and in performing query expansion. -<span class="lineNum"> 533 </span> : */ -<span class="lineNum"> 534 </span> : class XAPIAN_VISIBILITY_DEFAULT RSet { -<span class="lineNum"> 535 </span> : public: -<span class="lineNum"> 536 </span> : /// Class holding details of RSet -<span class="lineNum"> 537 </span> : class Internal; -<span class="lineNum"> 538 </span> : -<span class="lineNum"> 539 </span> : /// @internal Reference counted internals. -<span class="lineNum"> 540 </span> : Xapian::Internal::RefCntPtr<Internal> internal; -<span class="lineNum"> 541 </span> : -<span class="lineNum"> 542 </span> : /// Copy constructor -<span class="lineNum"> 543 </span> : RSet(const RSet &rset); -<span class="lineNum"> 544 </span> : -<span class="lineNum"> 545 </span> : /// Assignment operator -<span class="lineNum"> 546 </span> : void operator=(const RSet &rset); -<span class="lineNum"> 547 </span> : -<span class="lineNum"> 548 </span> : /// Default constructor -<span class="lineNum"> 549 </span> : RSet(); -<span class="lineNum"> 550 </span> : -<span class="lineNum"> 551 </span> : /// Destructor -<span class="lineNum"> 552 </span> : ~RSet(); -<span class="lineNum"> 553 </span> : -<span class="lineNum"> 554 </span> : /** The number of documents in this R-Set */ -<span class="lineNum"> 555 </span> : Xapian::doccount size() const; -<span class="lineNum"> 556 </span> : -<span class="lineNum"> 557 </span> : /** Test if this R-Set is empty */ -<span class="lineNum"> 558 </span> : bool empty() const; -<span class="lineNum"> 559 </span> : -<span class="lineNum"> 560 </span> : /// Add a document to the relevance set. -<span class="lineNum"> 561 </span> : void add_document(Xapian::docid did); -<span class="lineNum"> 562 </span> : -<span class="lineNum"> 563 </span> : /// Add a document to the relevance set. -<span class="lineNum"> 564 </span><span class="lineCov"> 20 : void add_document(const Xapian::MSetIterator & i) { add_document(*i); }</span> -<span class="lineNum"> 565 </span> : -<span class="lineNum"> 566 </span> : /// Remove a document from the relevance set. -<span class="lineNum"> 567 </span> : void remove_document(Xapian::docid did); -<span class="lineNum"> 568 </span> : -<span class="lineNum"> 569 </span> : /// Remove a document from the relevance set. -<span class="lineNum"> 570 </span> : void remove_document(const Xapian::MSetIterator & i) { remove_document(*i); } -<span class="lineNum"> 571 </span> : -<span class="lineNum"> 572 </span> : /// Test if a given document in the relevance set. -<span class="lineNum"> 573 </span> : bool contains(Xapian::docid did) const; -<span class="lineNum"> 574 </span> : -<span class="lineNum"> 575 </span> : /// Test if a given document in the relevance set. -<span class="lineNum"> 576 </span> : bool contains(const Xapian::MSetIterator & i) const { return contains(*i); } -<span class="lineNum"> 577 </span> : -<span class="lineNum"> 578 </span> : /// Return a string describing this object. -<span class="lineNum"> 579 </span> : std::string get_description() const; -<span class="lineNum"> 580 </span> : }; -<span class="lineNum"> 581 </span> : -<span class="lineNum"> 582 </span> : /** Base class for matcher decision functor. -<span class="lineNum"> 583 </span> : */ -<span class="lineNum"> 584 </span> : class XAPIAN_VISIBILITY_DEFAULT MatchDecider { -<span class="lineNum"> 585 </span> : public: -<span class="lineNum"> 586 </span> : /** Decide whether we want this document to be in the MSet. -<span class="lineNum"> 587 </span> : * -<span class="lineNum"> 588 </span> : * Return true if the document is acceptable, or false if the document -<span class="lineNum"> 589 </span> : * should be excluded from the MSet. -<span class="lineNum"> 590 </span> : */ -<span class="lineNum"> 591 </span> : virtual bool operator()(const Xapian::Document &doc) const = 0; -<span class="lineNum"> 592 </span> : -<span class="lineNum"> 593 </span> : /// Destructor. -<span class="lineNum"> 594 </span> : virtual ~MatchDecider(); -<span class="lineNum"> 595 </span> : }; -<span class="lineNum"> 596 </span> : -<span class="lineNum"> 597 </span> : /** This class provides an interface to the information retrieval -<span class="lineNum"> 598 </span> : * system for the purpose of searching. -<span class="lineNum"> 599 </span> : * -<span class="lineNum"> 600 </span> : * Databases are usually opened lazily, so exceptions may not be -<span class="lineNum"> 601 </span> : * thrown where you would expect them to be. You should catch -<span class="lineNum"> 602 </span> : * Xapian::Error exceptions when calling any method in Xapian::Enquire. -<span class="lineNum"> 603 </span> : * -<span class="lineNum"> 604 </span> : * @exception Xapian::InvalidArgumentError will be thrown if an invalid -<span class="lineNum"> 605 </span> : * argument is supplied, for example, an unknown database type. -<span class="lineNum"> 606 </span> : */ -<span class="lineNum"> 607 </span> : class XAPIAN_VISIBILITY_DEFAULT Enquire { -<span class="lineNum"> 608 </span> : public: -<span class="lineNum"> 609 </span> : /// Copying is allowed (and is cheap). -<span class="lineNum"> 610 </span> : Enquire(const Enquire & other); -<span class="lineNum"> 611 </span> : -<span class="lineNum"> 612 </span> : /// Assignment is allowed (and is cheap). -<span class="lineNum"> 613 </span> : void operator=(const Enquire & other); -<span class="lineNum"> 614 </span> : -<span class="lineNum"> 615 </span> : class Internal; -<span class="lineNum"> 616 </span> : /// @internal Reference counted internals. -<span class="lineNum"> 617 </span> : Xapian::Internal::RefCntPtr<Internal> internal; -<span class="lineNum"> 618 </span> : -<span class="lineNum"> 619 </span> : /** Create a Xapian::Enquire object. -<span class="lineNum"> 620 </span> : * -<span class="lineNum"> 621 </span> : * This specification cannot be changed once the Xapian::Enquire is -<span class="lineNum"> 622 </span> : * opened: you must create a new Xapian::Enquire object to access a -<span class="lineNum"> 623 </span> : * different database, or set of databases. -<span class="lineNum"> 624 </span> : * -<span class="lineNum"> 625 </span> : * The database supplied must have been initialised (ie, must not be -<span class="lineNum"> 626 </span> : * the result of calling the Database::Database() constructor). If -<span class="lineNum"> 627 </span> : * you need to handle a situation where you have no index gracefully, -<span class="lineNum"> 628 </span> : * a database created with InMemory::open() can be passed here, -<span class="lineNum"> 629 </span> : * which represents a completely empty database. -<span class="lineNum"> 630 </span> : * -<span class="lineNum"> 631 </span> : * @param database Specification of the database or databases to -<span class="lineNum"> 632 </span> : * use. -<span class="lineNum"> 633 </span> : * @param errorhandler_ A pointer to the error handler to use. -<span class="lineNum"> 634 </span> : * Ownership of the object pointed to is not assumed by the -<span class="lineNum"> 635 </span> : * Xapian::Enquire object - the user should delete the -<span class="lineNum"> 636 </span> : * Xapian::ErrorHandler object after the Xapian::Enquire object -<span class="lineNum"> 637 </span> : * is deleted. To use no error handler, this parameter -<span class="lineNum"> 638 </span> : * should be 0. -<span class="lineNum"> 639 </span> : * -<span class="lineNum"> 640 </span> : * @exception Xapian::InvalidArgumentError will be thrown if an -<span class="lineNum"> 641 </span> : * initialised Database object is supplied. -<span class="lineNum"> 642 </span> : */ -<span class="lineNum"> 643 </span> : explicit Enquire(const Database &database, ErrorHandler * errorhandler_ = 0); -<span class="lineNum"> 644 </span> : -<span class="lineNum"> 645 </span> : /** Close the Xapian::Enquire object. -<span class="lineNum"> 646 </span> : */ -<span class="lineNum"> 647 </span> : ~Enquire(); -<span class="lineNum"> 648 </span> : -<span class="lineNum"> 649 </span> : /** Set the query to run. -<span class="lineNum"> 650 </span> : * -<span class="lineNum"> 651 </span> : * @param query the new query to run. -<span class="lineNum"> 652 </span> : * @param qlen the query length to use in weight calculations - -<span class="lineNum"> 653 </span> : * by default the sum of the wqf of all terms is used. -<span class="lineNum"> 654 </span> : */ -<span class="lineNum"> 655 </span> : void set_query(const Xapian::Query & query, Xapian::termcount qlen = 0); -<span class="lineNum"> 656 </span> : -<span class="lineNum"> 657 </span> : /** Get the query which has been set. -<span class="lineNum"> 658 </span> : * This is only valid after set_query() has been called. -<span class="lineNum"> 659 </span> : * -<span class="lineNum"> 660 </span> : * @exception Xapian::InvalidArgumentError will be thrown if query has -<span class="lineNum"> 661 </span> : * not yet been set. -<span class="lineNum"> 662 </span> : */ -<span class="lineNum"> 663 </span> : const Xapian::Query & get_query() const; -<span class="lineNum"> 664 </span> : -<span class="lineNum"> 665 </span> : /** Set the weighting scheme to use for queries. -<span class="lineNum"> 666 </span> : * -<span class="lineNum"> 667 </span> : * @param weight_ the new weighting scheme. If no weighting scheme -<span class="lineNum"> 668 </span> : * is specified, the default is BM25 with the -<span class="lineNum"> 669 </span> : * default parameters. -<span class="lineNum"> 670 </span> : */ -<span class="lineNum"> 671 </span> : void set_weighting_scheme(const Weight &weight_); -<span class="lineNum"> 672 </span> : -<span class="lineNum"> 673 </span> : /** Set the collapse key to use for queries. -<span class="lineNum"> 674 </span> : * -<span class="lineNum"> 675 </span> : * @param collapse_key value number to collapse on - at most one MSet -<span class="lineNum"> 676 </span> : * entry with each particular value will be returned. -<span class="lineNum"> 677 </span> : * -<span class="lineNum"> 678 </span> : * The entry returned will be the best entry with that particular -<span class="lineNum"> 679 </span> : * value (highest weight or highest sorting key). -<span class="lineNum"> 680 </span> : * -<span class="lineNum"> 681 </span> : * An example use might be to create a value for each document -<span class="lineNum"> 682 </span> : * containing an MD5 hash of the document contents. Then -<span class="lineNum"> 683 </span> : * duplicate documents from different sources can be eliminated at -<span class="lineNum"> 684 </span> : * search time (it's better to eliminate duplicates at index time, -<span class="lineNum"> 685 </span> : * but this may not be always be possible - for example the search -<span class="lineNum"> 686 </span> : * may be over more than one Xapian database). -<span class="lineNum"> 687 </span> : * -<span class="lineNum"> 688 </span> : * Another use is to group matches in a particular category (e.g. -<span class="lineNum"> 689 </span> : * you might collapse a mailing list search on the Subject: so -<span class="lineNum"> 690 </span> : * that there's only one result per discussion thread). In this -<span class="lineNum"> 691 </span> : * case you can use get_collapse_count() to give the user some -<span class="lineNum"> 692 </span> : * idea how many other results there are. And if you index the -<span class="lineNum"> 693 </span> : * Subject: as a boolean term as well as putting it in a value, -<span class="lineNum"> 694 </span> : * you can offer a link to a non-collapsed search restricted to -<span class="lineNum"> 695 </span> : * that thread using a boolean filter. -<span class="lineNum"> 696 </span> : * -<span class="lineNum"> 697 </span> : * (default is Xapian::BAD_VALUENO which means no collapsing). -<span class="lineNum"> 698 </span> : */ -<span class="lineNum"> 699 </span> : void set_collapse_key(Xapian::valueno collapse_key); -<span class="lineNum"> 700 </span> : -<span class="lineNum"> 701 </span> : typedef enum { -<span class="lineNum"> 702 </span> : ASCENDING = 1, -<span class="lineNum"> 703 </span> : DESCENDING = 0, -<span class="lineNum"> 704 </span> : DONT_CARE = 2 -<span class="lineNum"> 705 </span> : } docid_order; -<span class="lineNum"> 706 </span> : -<span class="lineNum"> 707 </span> : /** Set the direction in which documents are ordered by document id -<span class="lineNum"> 708 </span> : * in the returned MSet. -<span class="lineNum"> 709 </span> : * -<span class="lineNum"> 710 </span> : * This order only has an effect on documents which would otherwise -<span class="lineNum"> 711 </span> : * have equal rank. For a weighted probabilistic match with no sort -<span class="lineNum"> 712 </span> : * value, this means documents with equal weight. For a boolean match, -<span class="lineNum"> 713 </span> : * with no sort value, this means all documents. And if a sort value -<span class="lineNum"> 714 </span> : * is used, this means documents with equal sort value (and also equal -<span class="lineNum"> 715 </span> : * weight if ordering on relevance after the sort). -<span class="lineNum"> 716 </span> : * -<span class="lineNum"> 717 </span> : * @param order This can be: -<span class="lineNum"> 718 </span> : * - Xapian::Enquire::ASCENDING -<span class="lineNum"> 719 </span> : * docids sort in ascending order (default) -<span class="lineNum"> 720 </span> : * - Xapian::Enquire::DESCENDING -<span class="lineNum"> 721 </span> : * docids sort in descending order -<span class="lineNum"> 722 </span> : * - Xapian::Enquire::DONT_CARE -<span class="lineNum"> 723 </span> : * docids sort in whatever order is most efficient for the backend -<span class="lineNum"> 724 </span> : * -<span class="lineNum"> 725 </span> : * Note: If you add documents in strict date order, then a boolean -<span class="lineNum"> 726 </span> : * search - i.e. set_weighting_scheme(Xapian::BoolWeight()) - with -<span class="lineNum"> 727 </span> : * set_docid_order(Xapian::Enquire::DESCENDING) is a very efficient -<span class="lineNum"> 728 </span> : * way to perform "sort by date, newest first". -<span class="lineNum"> 729 </span> : */ -<span class="lineNum"> 730 </span> : void set_docid_order(docid_order order); -<span class="lineNum"> 731 </span> : -<span class="lineNum"> 732 </span> : /** Set the percentage and/or weight cutoffs. -<span class="lineNum"> 733 </span> : * -<span class="lineNum"> 734 </span> : * @param percent_cutoff Minimum percentage score for returned -<span class="lineNum"> 735 </span> : * documents. If a document has a lower percentage score than this, -<span class="lineNum"> 736 </span> : * it will not appear in the MSet. If your intention is to return -<span class="lineNum"> 737 </span> : * only matches which contain all the terms in the query, then -<span class="lineNum"> 738 </span> : * it's more efficient to use Xapian::Query::OP_AND instead of -<span class="lineNum"> 739 </span> : * Xapian::Query::OP_OR in the query than to use set_cutoff(100). -<span class="lineNum"> 740 </span> : * (default 0 => no percentage cut-off). -<span class="lineNum"> 741 </span> : * @param weight_cutoff Minimum weight for a document to be returned. -<span class="lineNum"> 742 </span> : * If a document has a lower score that this, it will not appear -<span class="lineNum"> 743 </span> : * in the MSet. It is usually only possible to choose an -<span class="lineNum"> 744 </span> : * appropriate weight for cutoff based on the results of a -<span class="lineNum"> 745 </span> : * previous run of the same query; this is thus mainly useful for -<span class="lineNum"> 746 </span> : * alerting operations. The other potential use is with a user -<span class="lineNum"> 747 </span> : * specified weighting scheme. -<span class="lineNum"> 748 </span> : * (default 0 => no weight cut-off). -<span class="lineNum"> 749 </span> : */ -<span class="lineNum"> 750 </span> : void set_cutoff(Xapian::percent percent_cutoff, Xapian::weight weight_cutoff = 0); -<span class="lineNum"> 751 </span> : -<span class="lineNum"> 752 </span> : /** Set the sorting to be by relevance only. -<span class="lineNum"> 753 </span> : * -<span class="lineNum"> 754 </span> : * This is the default. -<span class="lineNum"> 755 </span> : */ -<span class="lineNum"> 756 </span> : void set_sort_by_relevance(); -<span class="lineNum"> 757 </span> : -<span class="lineNum"> 758 </span> : /** Set the sorting to be by value only. -<span class="lineNum"> 759 </span> : * -<span class="lineNum"> 760 </span> : * NB sorting of values uses a string comparison, so you'll need to -<span class="lineNum"> 761 </span> : * store numbers padded with leading zeros or spaces, or with the -<span class="lineNum"> 762 </span> : * number of digits prepended. -<span class="lineNum"> 763 </span> : * -<span class="lineNum"> 764 </span> : * @param sort_key value number to sort on. -<span class="lineNum"> 765 </span> : * -<span class="lineNum"> 766 </span> : * @param ascending If true, documents values which sort higher by -<span class="lineNum"> 767 </span> : * string compare are better. If false, the sort order -<span class="lineNum"> 768 </span> : * is reversed. (default true) -<span class="lineNum"> 769 </span> : */ -<span class="lineNum"> 770 </span> : void set_sort_by_value(Xapian::valueno sort_key, bool ascending = true); -<span class="lineNum"> 771 </span> : -<span class="lineNum"> 772 </span> : /** Set the sorting to be by key generated from values only. -<span class="lineNum"> 773 </span> : * -<span class="lineNum"> 774 </span> : * @param sorter The functor to use for generating keys. -<span class="lineNum"> 775 </span> : * -<span class="lineNum"> 776 </span> : * @param ascending If true, documents values which sort higher by -<span class="lineNum"> 777 </span> : * string compare are better. If false, the sort order -<span class="lineNum"> 778 </span> : * is reversed. (default true) -<span class="lineNum"> 779 </span> : */ -<span class="lineNum"> 780 </span> : void set_sort_by_key(Xapian::Sorter * sorter, bool ascending = true); -<span class="lineNum"> 781 </span> : -<span class="lineNum"> 782 </span> : /** Set the sorting to be by value, then by relevance for documents -<span class="lineNum"> 783 </span> : * with the same value. -<span class="lineNum"> 784 </span> : * -<span class="lineNum"> 785 </span> : * NB sorting of values uses a string comparison, so you'll need to -<span class="lineNum"> 786 </span> : * store numbers padded with leading zeros or spaces, or with the -<span class="lineNum"> 787 </span> : * number of digits prepended. -<span class="lineNum"> 788 </span> : * -<span class="lineNum"> 789 </span> : * @param sort_key value number to sort on. -<span class="lineNum"> 790 </span> : * -<span class="lineNum"> 791 </span> : * @param ascending If true, documents values which sort higher by -<span class="lineNum"> 792 </span> : * string compare are better. If false, the sort order -<span class="lineNum"> 793 </span> : * is reversed. (default true) -<span class="lineNum"> 794 </span> : */ -<span class="lineNum"> 795 </span> : void set_sort_by_value_then_relevance(Xapian::valueno sort_key, -<span class="lineNum"> 796 </span> : bool ascending = true); -<span class="lineNum"> 797 </span> : -<span class="lineNum"> 798 </span> : /** Set the sorting to be by keys generated from values, then by -<span class="lineNum"> 799 </span> : * relevance for documents with identical keys. -<span class="lineNum"> 800 </span> : * -<span class="lineNum"> 801 </span> : * @param sorter The functor to use for generating keys. -<span class="lineNum"> 802 </span> : * -<span class="lineNum"> 803 </span> : * @param ascending If true, keys which sort higher by -<span class="lineNum"> 804 </span> : * string compare are better. If false, the sort order -<span class="lineNum"> 805 </span> : * is reversed. (default true) -<span class="lineNum"> 806 </span> : */ -<span class="lineNum"> 807 </span> : void set_sort_by_key_then_relevance(Xapian::Sorter * sorter, -<span class="lineNum"> 808 </span> : bool ascending = true); -<span class="lineNum"> 809 </span> : -<span class="lineNum"> 810 </span> : /** Set the sorting to be by relevance then value. -<span class="lineNum"> 811 </span> : * -<span class="lineNum"> 812 </span> : * NB sorting of values uses a string comparison, so you'll need to -<span class="lineNum"> 813 </span> : * store numbers padded with leading zeros or spaces, or with the -<span class="lineNum"> 814 </span> : * number of digits prepended. -<span class="lineNum"> 815 </span> : * -<span class="lineNum"> 816 </span> : * Note that with the default BM25 weighting scheme parameters, -<span class="lineNum"> 817 </span> : * non-identical documents will rarely have the same weight, so -<span class="lineNum"> 818 </span> : * this setting will give very similar results to -<span class="lineNum"> 819 </span> : * set_sort_by_relevance(). It becomes more useful with particular -<span class="lineNum"> 820 </span> : * BM25 parameter settings (e.g. BM25Weight(1,0,1,0,0)) or custom -<span class="lineNum"> 821 </span> : * weighting schemes. -<span class="lineNum"> 822 </span> : * -<span class="lineNum"> 823 </span> : * @param sort_key value number to sort on. -<span class="lineNum"> 824 </span> : * -<span class="lineNum"> 825 </span> : * @param ascending If true, documents values which sort higher by -<span class="lineNum"> 826 </span> : * string compare are better. If false, the sort order -<span class="lineNum"> 827 </span> : * is reversed. (default true) -<span class="lineNum"> 828 </span> : */ -<span class="lineNum"> 829 </span> : void set_sort_by_relevance_then_value(Xapian::valueno sort_key, -<span class="lineNum"> 830 </span> : bool ascending = true); -<span class="lineNum"> 831 </span> : -<span class="lineNum"> 832 </span> : /** Set the sorting to be by relevance, then by keys generated from -<span class="lineNum"> 833 </span> : * values. -<span class="lineNum"> 834 </span> : * -<span class="lineNum"> 835 </span> : * Note that with the default BM25 weighting scheme parameters, -<span class="lineNum"> 836 </span> : * non-identical documents will rarely have the same weight, so -<span class="lineNum"> 837 </span> : * this setting will give very similar results to -<span class="lineNum"> 838 </span> : * set_sort_by_relevance(). It becomes more useful with particular -<span class="lineNum"> 839 </span> : * BM25 parameter settings (e.g. BM25Weight(1,0,1,0,0)) or custom -<span class="lineNum"> 840 </span> : * weighting schemes. -<span class="lineNum"> 841 </span> : * -<span class="lineNum"> 842 </span> : * @param sorter The functor to use for generating keys. -<span class="lineNum"> 843 </span> : * -<span class="lineNum"> 844 </span> : * @param ascending If true, keys which sort higher by -<span class="lineNum"> 845 </span> : * string compare are better. If false, the sort order -<span class="lineNum"> 846 </span> : * is reversed. (default true) -<span class="lineNum"> 847 </span> : */ -<span class="lineNum"> 848 </span> : void set_sort_by_relevance_then_key(Xapian::Sorter * sorter, -<span class="lineNum"> 849 </span> : bool ascending = true); -<span class="lineNum"> 850 </span> : -<span class="lineNum"> 851 </span> : /** Get (a portion of) the match set for the current query. -<span class="lineNum"> 852 </span> : * -<span class="lineNum"> 853 </span> : * @param first the first item in the result set to return. -<span class="lineNum"> 854 </span> : * A value of zero corresponds to the first item -<span class="lineNum"> 855 </span> : * returned being that with the highest score. -<span class="lineNum"> 856 </span> : * A value of 10 corresponds to the first 10 items -<span class="lineNum"> 857 </span> : * being ignored, and the returned items starting -<span class="lineNum"> 858 </span> : * at the eleventh. -<span class="lineNum"> 859 </span> : * @param maxitems the maximum number of items to return. -<span class="lineNum"> 860 </span> : * @param checkatleast the minimum number of items to check. Because -<span class="lineNum"> 861 </span> : * the matcher optimises, it won't consider every -<span class="lineNum"> 862 </span> : * document which might match, so the total number -<span class="lineNum"> 863 </span> : * of matches is estimated. Setting checkatleast -<span class="lineNum"> 864 </span> : * forces it to consider at least this many matches -<span class="lineNum"> 865 </span> : * and so allows for reliable paging links. -<span class="lineNum"> 866 </span> : * @param omrset the relevance set to use when performing the query. -<span class="lineNum"> 867 </span> : * @param mdecider a decision functor to use to decide whether a -<span class="lineNum"> 868 </span> : * given document should be put in the MSet. -<span class="lineNum"> 869 </span> : * @param matchspy a decision functor to use to decide whether a -<span class="lineNum"> 870 </span> : * given document should be put in the MSet. The -<span class="lineNum"> 871 </span> : * matchspy is applied to every document which is -<span class="lineNum"> 872 </span> : * a potential candidate for the MSet, so if there are -<span class="lineNum"> 873 </span> : * checkatleast or more such documents, the matchspy -<span class="lineNum"> 874 </span> : * will see at least checkatleast. The mdecider is -<span class="lineNum"> 875 </span> : * assumed to be a relatively expensive test so may -<span class="lineNum"> 876 </span> : * be applied in a lazier fashion. -<span class="lineNum"> 877 </span> : * -<span class="lineNum"> 878 </span> : * @return A Xapian::MSet object containing the results of the -<span class="lineNum"> 879 </span> : * query. -<span class="lineNum"> 880 </span> : * -<span class="lineNum"> 881 </span> : * @exception Xapian::InvalidArgumentError See class documentation. -<span class="lineNum"> 882 </span> : */ -<span class="lineNum"> 883 </span> : MSet get_mset(Xapian::doccount first, Xapian::doccount maxitems, -<span class="lineNum"> 884 </span> : Xapian::doccount checkatleast = 0, -<span class="lineNum"> 885 </span> : const RSet * omrset = 0, -<span class="lineNum"> 886 </span> : const MatchDecider * mdecider = 0) const; -<span class="lineNum"> 887 </span> : MSet get_mset(Xapian::doccount first, Xapian::doccount maxitems, -<span class="lineNum"> 888 </span> : Xapian::doccount checkatleast, -<span class="lineNum"> 889 </span> : const RSet * omrset, -<span class="lineNum"> 890 </span> : const MatchDecider * mdecider, -<span class="lineNum"> 891 </span> : const MatchDecider * matchspy) const; -<span class="lineNum"> 892 </span> : MSet get_mset(Xapian::doccount first, Xapian::doccount maxitems, -<span class="lineNum"> 893 </span> : const RSet * omrset, -<span class="lineNum"> 894 </span> : const MatchDecider * mdecider = 0) const { -<span class="lineNum"> 895 </span> : return get_mset(first, maxitems, 0, omrset, mdecider); -<span class="lineNum"> 896 </span> : } -<span class="lineNum"> 897 </span> : -<span class="lineNum"> 898 </span> : static const int INCLUDE_QUERY_TERMS = 1; -<span class="lineNum"> 899 </span> : static const int USE_EXACT_TERMFREQ = 2; -<span class="lineNum"> 900 </span> : #ifndef _MSC_VER -<span class="lineNum"> 901 </span> : /// Deprecated in Xapian 1.0.0, use INCLUDE_QUERY_TERMS instead. -<span class="lineNum"> 902 </span> : XAPIAN_DEPRECATED(static const int include_query_terms) = 1; -<span class="lineNum"> 903 </span> : /// Deprecated in Xapian 1.0.0, use USE_EXACT_TERMFREQ instead. -<span class="lineNum"> 904 </span> : XAPIAN_DEPRECATED(static const int use_exact_termfreq) = 2; -<span class="lineNum"> 905 </span> : #else -<span class="lineNum"> 906 </span> : // Work around MSVC stupidity (you get a warning for deprecating a -<span class="lineNum"> 907 </span> : // declaration). -<span class="lineNum"> 908 </span> : static const int include_query_terms = 1; -<span class="lineNum"> 909 </span> : static const int use_exact_termfreq = 2; -<span class="lineNum"> 910 </span> : #pragma deprecated("Xapian::Enquire::include_query_terms", "Xapian::Enquire::use_exact_termfreq") -<span class="lineNum"> 911 </span> : #endif -<span class="lineNum"> 912 </span> : -<span class="lineNum"> 913 </span> : /** Get the expand set for the given rset. -<span class="lineNum"> 914 </span> : * -<span class="lineNum"> 915 </span> : * @param maxitems the maximum number of items to return. -<span class="lineNum"> 916 </span> : * @param omrset the relevance set to use when performing -<span class="lineNum"> 917 </span> : * the expand operation. -<span class="lineNum"> 918 </span> : * @param flags zero or more of these values |-ed together: -<span class="lineNum"> 919 </span> : * - Xapian::Enquire::INCLUDE_QUERY_TERMS query -<span class="lineNum"> 920 </span> : * terms may be returned from expand -<span class="lineNum"> 921 </span> : * - Xapian::Enquire::USE_EXACT_TERMFREQ for multi -<span class="lineNum"> 922 </span> : * dbs, calculate the exact termfreq; otherwise an -<span class="lineNum"> 923 </span> : * approximation is used which can greatly improve -<span class="lineNum"> 924 </span> : * efficiency, but still returns good results. -<span class="lineNum"> 925 </span> : * @param k the parameter k in the query expansion algorithm -<span class="lineNum"> 926 </span> : * (default is 1.0) -<span class="lineNum"> 927 </span> : * @param edecider a decision functor to use to decide whether a -<span class="lineNum"> 928 </span> : * given term should be put in the ESet -<span class="lineNum"> 929 </span> : * -<span class="lineNum"> 930 </span> : * @return An ESet object containing the results of the -<span class="lineNum"> 931 </span> : * expand. -<span class="lineNum"> 932 </span> : * -<span class="lineNum"> 933 </span> : * @exception Xapian::InvalidArgumentError See class documentation. -<span class="lineNum"> 934 </span> : */ -<span class="lineNum"> 935 </span> : ESet get_eset(Xapian::termcount maxitems, -<span class="lineNum"> 936 </span> : const RSet & omrset, -<span class="lineNum"> 937 </span> : int flags = 0, -<span class="lineNum"> 938 </span> : double k = 1.0, -<span class="lineNum"> 939 </span> : const Xapian::ExpandDecider * edecider = 0) const; -<span class="lineNum"> 940 </span> : -<span class="lineNum"> 941 </span> : /** Get the expand set for the given rset. -<span class="lineNum"> 942 </span> : * -<span class="lineNum"> 943 </span> : * @param maxitems the maximum number of items to return. -<span class="lineNum"> 944 </span> : * @param omrset the relevance set to use when performing -<span class="lineNum"> 945 </span> : * the expand operation. -<span class="lineNum"> 946 </span> : * @param edecider a decision functor to use to decide whether a -<span class="lineNum"> 947 </span> : * given term should be put in the ESet -<span class="lineNum"> 948 </span> : * -<span class="lineNum"> 949 </span> : * @return An ESet object containing the results of the -<span class="lineNum"> 950 </span> : * expand. -<span class="lineNum"> 951 </span> : * -<span class="lineNum"> 952 </span> : * @exception Xapian::InvalidArgumentError See class documentation. -<span class="lineNum"> 953 </span> : */ -<span class="lineNum"> 954 </span> : inline ESet get_eset(Xapian::termcount maxitems, const RSet & omrset, -<span class="lineNum"> 955 </span><span class="lineCov"> 4 : const Xapian::ExpandDecider * edecider) const {</span> -<span class="lineNum"> 956 </span><span class="lineCov"> 4 : return get_eset(maxitems, omrset, 0, 1.0, edecider);</span> -<span class="lineNum"> 957 </span> : } -<span class="lineNum"> 958 </span> : -<span class="lineNum"> 959 </span> : /** Get terms which match a given document, by document id. -<span class="lineNum"> 960 </span> : * -<span class="lineNum"> 961 </span> : * This method returns the terms in the current query which match -<span class="lineNum"> 962 </span> : * the given document. -<span class="lineNum"> 963 </span> : * -<span class="lineNum"> 964 </span> : * It is possible for the document to have been removed from the -<span class="lineNum"> 965 </span> : * database between the time it is returned in an MSet, and the -<span class="lineNum"> 966 </span> : * time that this call is made. If possible, you should specify -<span class="lineNum"> 967 </span> : * an MSetIterator instead of a Xapian::docid, since this will enable -<span class="lineNum"> 968 </span> : * database backends with suitable support to prevent this -<span class="lineNum"> 969 </span> : * occurring. -<span class="lineNum"> 970 </span> : * -<span class="lineNum"> 971 </span> : * Note that a query does not need to have been run in order to -<span class="lineNum"> 972 </span> : * make this call. -<span class="lineNum"> 973 </span> : * -<span class="lineNum"> 974 </span> : * @param did The document id for which to retrieve the matching -<span class="lineNum"> 975 </span> : * terms. -<span class="lineNum"> 976 </span> : * -<span class="lineNum"> 977 </span> : * @return An iterator returning the terms which match the -<span class="lineNum"> 978 </span> : * document. The terms will be returned (as far as this -<span class="lineNum"> 979 </span> : * makes any sense) in the same order as the terms -<span class="lineNum"> 980 </span> : * in the query. Terms will not occur more than once, -<span class="lineNum"> 981 </span> : * even if they do in the query. -<span class="lineNum"> 982 </span> : * -<span class="lineNum"> 983 </span> : * @exception Xapian::InvalidArgumentError See class documentation. -<span class="lineNum"> 984 </span> : * @exception Xapian::DocNotFoundError The document specified -<span class="lineNum"> 985 </span> : * could not be found in the database. -<span class="lineNum"> 986 </span> : */ -<span class="lineNum"> 987 </span> : TermIterator get_matching_terms_begin(Xapian::docid did) const; -<span class="lineNum"> 988 </span> : -<span class="lineNum"> 989 </span> : /** End iterator corresponding to get_matching_terms_begin() */ -<span class="lineNum"> 990 </span> : TermIterator get_matching_terms_end(Xapian::docid /*did*/) const { -<span class="lineNum"> 991 </span> : return TermIterator(NULL); -<span class="lineNum"> 992 </span> : } -<span class="lineNum"> 993 </span> : -<span class="lineNum"> 994 </span> : /** Get terms which match a given document, by match set item. -<span class="lineNum"> 995 </span> : * -<span class="lineNum"> 996 </span> : * This method returns the terms in the current query which match -<span class="lineNum"> 997 </span> : * the given document. -<span class="lineNum"> 998 </span> : * -<span class="lineNum"> 999 </span> : * If the underlying database has suitable support, using this call -<span class="lineNum"> 1000 </span> : * (rather than passing a Xapian::docid) will enable the system to -<span class="lineNum"> 1001 </span> : * ensure that the correct data is returned, and that the document -<span class="lineNum"> 1002 </span> : * has not been deleted or changed since the query was performed. -<span class="lineNum"> 1003 </span> : * -<span class="lineNum"> 1004 </span> : * @param it The iterator for which to retrieve the matching terms. -<span class="lineNum"> 1005 </span> : * -<span class="lineNum"> 1006 </span> : * @return An iterator returning the terms which match the -<span class="lineNum"> 1007 </span> : * document. The terms will be returned (as far as this -<span class="lineNum"> 1008 </span> : * makes any sense) in the same order as the terms -<span class="lineNum"> 1009 </span> : * in the query. Terms will not occur more than once, -<span class="lineNum"> 1010 </span> : * even if they do in the query. -<span class="lineNum"> 1011 </span> : * -<span class="lineNum"> 1012 </span> : * @exception Xapian::InvalidArgumentError See class documentation. -<span class="lineNum"> 1013 </span> : * @exception Xapian::DocNotFoundError The document specified -<span class="lineNum"> 1014 </span> : * could not be found in the database. -<span class="lineNum"> 1015 </span> : */ -<span class="lineNum"> 1016 </span> : TermIterator get_matching_terms_begin(const MSetIterator &it) const; -<span class="lineNum"> 1017 </span> : -<span class="lineNum"> 1018 </span> : /** End iterator corresponding to get_matching_terms_begin() */ -<span class="lineNum"> 1019 </span> : TermIterator get_matching_terms_end(const MSetIterator &/*it*/) const { -<span class="lineNum"> 1020 </span> : return TermIterator(NULL); -<span class="lineNum"> 1021 </span> : } -<span class="lineNum"> 1022 </span> : -<span class="lineNum"> 1023 </span> : /** Register a MatchDecider. -<span class="lineNum"> 1024 </span> : * -<span class="lineNum"> 1025 </span> : * This is used to associate a name with a matchdecider. -<span class="lineNum"> 1026 </span> : * -<span class="lineNum"> 1027 </span> : * @deprecated This method is deprecated. It was added long ago with -<span class="lineNum"> 1028 </span> : * the intention that it would allow the remote backend to support -<span class="lineNum"> 1029 </span> : * use of MatchDecider objects, but there's a better approach. -<span class="lineNum"> 1030 </span> : * -<span class="lineNum"> 1031 </span> : * @param name The name to register this matchdecider as. -<span class="lineNum"> 1032 </span> : * @param mdecider The matchdecider. If omitted, then remove -<span class="lineNum"> 1033 </span> : * any matchdecider registered with this name. -<span class="lineNum"> 1034 </span> : */ -<span class="lineNum"> 1035 </span> : XAPIAN_DEPRECATED( -<span class="lineNum"> 1036 </span> : void register_match_decider(const std::string &name, -<span class="lineNum"> 1037 </span> : const MatchDecider *mdecider = NULL)); -<span class="lineNum"> 1038 </span> : -<span class="lineNum"> 1039 </span> : /// Return a string describing this object. -<span class="lineNum"> 1040 </span> : std::string get_description() const; -<span class="lineNum"> 1041 </span> : }; -<span class="lineNum"> 1042 </span> : -<span class="lineNum"> 1043 </span> : } -<span class="lineNum"> 1044 </span> : -<span class="lineNum"> 1045 </span> : class RemoteServer; -<span class="lineNum"> 1046 </span> : class ScaleWeight; -<span class="lineNum"> 1047 </span> : -<span class="lineNum"> 1048 </span> : namespace Xapian { -<span class="lineNum"> 1049 </span> : -<span class="lineNum"> 1050 </span> : /// Abstract base class for weighting schemes -<span class="lineNum"> 1051 </span> : class XAPIAN_VISIBILITY_DEFAULT Weight { -<span class="lineNum"> 1052 </span> : friend class Enquire; // So Enquire can clone us -<span class="lineNum"> 1053 </span> : friend class ::RemoteServer; // So RemoteServer can clone us - FIXME -<span class="lineNum"> 1054 </span> : friend class ::ScaleWeight; -<span class="lineNum"> 1055 </span> : public: -<span class="lineNum"> 1056 </span> : class Internal; -<span class="lineNum"> 1057 </span> : protected: -<span class="lineNum"> 1058 </span> : Weight(const Weight &); -<span class="lineNum"> 1059 </span> : private: -<span class="lineNum"> 1060 </span> : void operator=(Weight &); -<span class="lineNum"> 1061 </span> : -<span class="lineNum"> 1062 </span> : /** Return a new weight object of this type. -<span class="lineNum"> 1063 </span> : * -<span class="lineNum"> 1064 </span> : * A subclass called FooWeight taking parameters param1 and param2 -<span class="lineNum"> 1065 </span> : * should implement this as: -<span class="lineNum"> 1066 </span> : * -<span class="lineNum"> 1067 </span> : * virtual FooWeight * clone() const { -<span class="lineNum"> 1068 </span> : * return new FooWeight(param1, param2); -<span class="lineNum"> 1069 </span> : * } -<span class="lineNum"> 1070 </span> : */ -<span class="lineNum"> 1071 </span> : virtual Weight * clone() const = 0; -<span class="lineNum"> 1072 </span> : -<span class="lineNum"> 1073 </span> : protected: -<span class="lineNum"> 1074 </span> : const Internal * internal; // Weight::Internal == Stats -<span class="lineNum"> 1075 </span> : Xapian::doclength querysize; -<span class="lineNum"> 1076 </span> : Xapian::termcount wqf; -<span class="lineNum"> 1077 </span> : std::string tname; -<span class="lineNum"> 1078 </span> : -<span class="lineNum"> 1079 </span> : public: -<span class="lineNum"> 1080 </span> : // FIXME:1.1: initialise internal to NULL here -<span class="lineNum"> 1081 </span> : Weight() { } -<span class="lineNum"> 1082 </span> : virtual ~Weight(); -<span class="lineNum"> 1083 </span> : -<span class="lineNum"> 1084 </span> : /** Create a new weight object of the same type as this and initialise -<span class="lineNum"> 1085 </span> : * it with the specified statistics. -<span class="lineNum"> 1086 </span> : * -<span class="lineNum"> 1087 </span> : * You shouldn't call this method yourself - it's called by -<span class="lineNum"> 1088 </span> : * Enquire. -<span class="lineNum"> 1089 </span> : * -<span class="lineNum"> 1090 </span> : * @param internal_ Object to ask for collection statistics. -<span class="lineNum"> 1091 </span> : * @param querysize_ Query size. -<span class="lineNum"> 1092 </span> : * @param wqf_ Within query frequency of term this object is -<span class="lineNum"> 1093 </span> : * associated with. -<span class="lineNum"> 1094 </span> : * @param tname_ Term which this object is associated with. -<span class="lineNum"> 1095 </span> : */ -<span class="lineNum"> 1096 </span> : Weight * create(const Internal * internal_, Xapian::doclength querysize_, -<span class="lineNum"> 1097 </span> : Xapian::termcount wqf_, const std::string & tname_) const; -<span class="lineNum"> 1098 </span> : -<span class="lineNum"> 1099 </span> : /** Name of the weighting scheme. -<span class="lineNum"> 1100 </span> : * -<span class="lineNum"> 1101 </span> : * If the subclass is called FooWeight, this should return "Foo". -<span class="lineNum"> 1102 </span> : */ -<span class="lineNum"> 1103 </span> : virtual std::string name() const = 0; -<span class="lineNum"> 1104 </span> : -<span class="lineNum"> 1105 </span> : /// Serialise object parameters into a string. -<span class="lineNum"> 1106 </span> : virtual std::string serialise() const = 0; -<span class="lineNum"> 1107 </span> : -<span class="lineNum"> 1108 </span> : /// Create object given string serialisation returned by serialise(). -<span class="lineNum"> 1109 </span> : virtual Weight * unserialise(const std::string &s) const = 0; -<span class="lineNum"> 1110 </span> : -<span class="lineNum"> 1111 </span> : /** Get a weight which is part of the sum over terms being performed. -<span class="lineNum"> 1112 </span> : * This returns a weight for a given term and document. These -<span class="lineNum"> 1113 </span> : * weights are summed to give a total weight for the document. -<span class="lineNum"> 1114 </span> : * -<span class="lineNum"> 1115 </span> : * @param wdf the within document frequency of the term. -<span class="lineNum"> 1116 </span> : * @param len the (unnormalised) document length. -<span class="lineNum"> 1117 </span> : */ -<span class="lineNum"> 1118 </span> : virtual Xapian::weight get_sumpart(Xapian::termcount wdf, -<span class="lineNum"> 1119 </span> : Xapian::doclength len) const = 0; -<span class="lineNum"> 1120 </span> : -<span class="lineNum"> 1121 </span> : /** Gets the maximum value that get_sumpart() may return. This -<span class="lineNum"> 1122 </span> : * is used in optimising searches, by having the postlist tree -<span class="lineNum"> 1123 </span> : * decay appropriately when parts of it can have limited, or no, -<span class="lineNum"> 1124 </span> : * further effect. -<span class="lineNum"> 1125 </span> : */ -<span class="lineNum"> 1126 </span> : virtual Xapian::weight get_maxpart() const = 0; -<span class="lineNum"> 1127 </span> : -<span class="lineNum"> 1128 </span> : /** Get an extra weight for a document to add to the sum calculated -<span class="lineNum"> 1129 </span> : * over the query terms. -<span class="lineNum"> 1130 </span> : * This returns a weight for a given document, and is used by some -<span class="lineNum"> 1131 </span> : * weighting schemes to account for influence such as document -<span class="lineNum"> 1132 </span> : * length. -<span class="lineNum"> 1133 </span> : * -<span class="lineNum"> 1134 </span> : * @param len the (unnormalised) document length. -<span class="lineNum"> 1135 </span> : */ -<span class="lineNum"> 1136 </span> : virtual Xapian::weight get_sumextra(Xapian::doclength len) const = 0; -<span class="lineNum"> 1137 </span> : -<span class="lineNum"> 1138 </span> : /** Gets the maximum value that get_sumextra() may return. This -<span class="lineNum"> 1139 </span> : * is used in optimising searches. -<span class="lineNum"> 1140 </span> : */ -<span class="lineNum"> 1141 </span> : virtual Xapian::weight get_maxextra() const = 0; -<span class="lineNum"> 1142 </span> : -<span class="lineNum"> 1143 </span> : /// return false if the weight object doesn't need doclength -<span class="lineNum"> 1144 </span> : virtual bool get_sumpart_needs_doclength() const; /* { return true; } */ -<span class="lineNum"> 1145 </span> : }; -<span class="lineNum"> 1146 </span> : -<span class="lineNum"> 1147 </span> : /// Boolean weighting scheme (everything gets 0) -<span class="lineNum"> 1148 </span> : class XAPIAN_VISIBILITY_DEFAULT BoolWeight : public Weight { -<span class="lineNum"> 1149 </span> : public: -<span class="lineNum"> 1150 </span> : BoolWeight * clone() const; -<span class="lineNum"> 1151 </span> : BoolWeight() { } -<span class="lineNum"> 1152 </span> : ~BoolWeight(); -<span class="lineNum"> 1153 </span> : std::string name() const; -<span class="lineNum"> 1154 </span> : std::string serialise() const; -<span class="lineNum"> 1155 </span> : BoolWeight * unserialise(const std::string & s) const; -<span class="lineNum"> 1156 </span> : Xapian::weight get_sumpart(Xapian::termcount wdf, Xapian::doclength len) const; -<span class="lineNum"> 1157 </span> : Xapian::weight get_maxpart() const; -<span class="lineNum"> 1158 </span> : -<span class="lineNum"> 1159 </span> : Xapian::weight get_sumextra(Xapian::doclength len) const; -<span class="lineNum"> 1160 </span> : Xapian::weight get_maxextra() const; -<span class="lineNum"> 1161 </span> : -<span class="lineNum"> 1162 </span> : bool get_sumpart_needs_doclength() const; -<span class="lineNum"> 1163 </span> : }; -<span class="lineNum"> 1164 </span> : -<span class="lineNum"> 1165 </span> : /** BM25 weighting scheme -<span class="lineNum"> 1166 </span> : * -<span class="lineNum"> 1167 </span> : * BM25 weighting options : The BM25 formula is \f[ -<span class="lineNum"> 1168 </span> : * \frac{k_{2}.n_{q}}{1+L_{d}}+\sum_{t}\frac{(k_{3}+1)q_{t}}{k_{3}+q_{t}}.\frac{(k_{1}+1)f_{t,d}}{k_{1}((1-b)+bL_{d})+f_{t,d}}.w_{t} -<span class="lineNum"> 1169 </span> : * \f] where -<span class="lineNum"> 1170 </span> : * - \f$w_{t}\f$ is the termweight of term t -<span class="lineNum"> 1171 </span> : * - \f$f_{t,d}\f$ is the within document frequency of term t in document d -<span class="lineNum"> 1172 </span> : * - \f$q_{t}\f$ is the within query frequency of term t -<span class="lineNum"> 1173 </span> : * - \f$L_{d}\f$ is the normalised length of document d -<span class="lineNum"> 1174 </span> : * - \f$n_{q}\f$ is the size of the query -<span class="lineNum"> 1175 </span> : * - \f$k_{1}\f$, \f$k_{2}\f$, \f$k_{3}\f$ and \f$b\f$ are user specified parameters -<span class="lineNum"> 1176 </span> : */ -<span class="lineNum"> 1177 </span> : class XAPIAN_VISIBILITY_DEFAULT BM25Weight : public Weight { -<span class="lineNum"> 1178 </span> : private: -<span class="lineNum"> 1179 </span> : mutable Xapian::weight termweight; -<span class="lineNum"> 1180 </span> : mutable Xapian::doclength lenpart; -<span class="lineNum"> 1181 </span> : -<span class="lineNum"> 1182 </span> : double k1, k2, k3, b; -<span class="lineNum"> 1183 </span> : Xapian::doclength min_normlen; -<span class="lineNum"> 1184 </span> : -<span class="lineNum"> 1185 </span> : mutable bool weight_calculated; -<span class="lineNum"> 1186 </span> : -<span class="lineNum"> 1187 </span> : void calc_termweight() const; -<span class="lineNum"> 1188 </span> : -<span class="lineNum"> 1189 </span> : public: -<span class="lineNum"> 1190 </span> : /** Construct a BM25 weight. -<span class="lineNum"> 1191 </span> : * -<span class="lineNum"> 1192 </span> : * @param k1 governs the importance of within document frequency. -<span class="lineNum"> 1193 </span> : * Must be >= 0. 0 means ignore wdf. Default is 1. -<span class="lineNum"> 1194 </span> : * @param k2 compensation factor for the high wdf values in -<span class="lineNum"> 1195 </span> : * large documents. Must be >= 0. 0 means no -<span class="lineNum"> 1196 </span> : * compensation. Default is 0. -<span class="lineNum"> 1197 </span> : * @param k3 governs the importance of within query frequency. -<span class="lineNum"> 1198 </span> : * Must be >= 0. 0 means ignore wqf. Default is 1. -<span class="lineNum"> 1199 </span> : * @param b Relative importance of within document frequency and -<span class="lineNum"> 1200 </span> : * document length. Must be >= 0 and <= 1. Default -<span class="lineNum"> 1201 </span> : * is 0.5. -<span class="lineNum"> 1202 </span> : * @param min_normlen specifies a cutoff on the minimum value that -<span class="lineNum"> 1203 </span> : * can be used for a normalised document length - -<span class="lineNum"> 1204 </span> : * smaller values will be forced up to this cutoff. -<span class="lineNum"> 1205 </span> : * This prevents very small documents getting a huge -<span class="lineNum"> 1206 </span> : * bonus weight. Default is 0.5. -<span class="lineNum"> 1207 </span> : */ -<span class="lineNum"> 1208 </span> : BM25Weight(double k1_, double k2_, double k3_, double b_, -<span class="lineNum"> 1209 </span> : double min_normlen_) -<span class="lineNum"> 1210 </span> : : k1(k1_), k2(k2_), k3(k3_), b(b_), min_normlen(min_normlen_), -<span class="lineNum"> 1211 </span> : weight_calculated(false) -<span class="lineNum"> 1212 </span> : { -<span class="lineNum"> 1213 </span> : if (k1 < 0) k1 = 0; -<span class="lineNum"> 1214 </span> : if (k2 < 0) k2 = 0; -<span class="lineNum"> 1215 </span> : if (k3 < 0) k3 = 0; -<span class="lineNum"> 1216 </span> : if (b < 0) b = 0; else if (b > 1) b = 1; -<span class="lineNum"> 1217 </span> : } -<span class="lineNum"> 1218 </span> : BM25Weight() : k1(1), k2(0), k3(1), b(0.5), min_normlen(0.5), -<span class="lineNum"> 1219 </span> : weight_calculated(false) { } -<span class="lineNum"> 1220 </span> : -<span class="lineNum"> 1221 </span> : BM25Weight * clone() const; -<span class="lineNum"> 1222 </span> : ~BM25Weight() { } -<span class="lineNum"> 1223 </span> : std::string name() const; -<span class="lineNum"> 1224 </span> : std::string serialise() const; -<span class="lineNum"> 1225 </span> : BM25Weight * unserialise(const std::string & s) const; -<span class="lineNum"> 1226 </span> : Xapian::weight get_sumpart(Xapian::termcount wdf, Xapian::doclength len) const; -<span class="lineNum"> 1227 </span> : Xapian::weight get_maxpart() const; -<span class="lineNum"> 1228 </span> : -<span class="lineNum"> 1229 </span> : Xapian::weight get_sumextra(Xapian::doclength len) const; -<span class="lineNum"> 1230 </span> : Xapian::weight get_maxextra() const; -<span class="lineNum"> 1231 </span> : -<span class="lineNum"> 1232 </span> : bool get_sumpart_needs_doclength() const; -<span class="lineNum"> 1233 </span> : }; -<span class="lineNum"> 1234 </span> : -<span class="lineNum"> 1235 </span> : /** Traditional probabilistic weighting scheme. -<span class="lineNum"> 1236 </span> : * -<span class="lineNum"> 1237 </span> : * This class implements the Traditional Probabilistic Weighting scheme, as -<span class="lineNum"> 1238 </span> : * described by the early papers on Probabilistic Retrieval. BM25 generally -<span class="lineNum"> 1239 </span> : * gives better results. -<span class="lineNum"> 1240 </span> : * -<span class="lineNum"> 1241 </span> : * The Traditional weighting scheme formula is \f[ -<span class="lineNum"> 1242 </span> : * \sum_{t}\frac{f_{t,d}}{k.L_{d}+f_{t,d}}.w_{t} -<span class="lineNum"> 1243 </span> : * \f] where -<span class="lineNum"> 1244 </span> : * - \f$w_{t}\f$ is the termweight of term t -<span class="lineNum"> 1245 </span> : * - \f$f_{t,d}\f$ is the within document frequency of term t in document d -<span class="lineNum"> 1246 </span> : * - \f$L_{d}\f$ is the normalised length of document d -<span class="lineNum"> 1247 </span> : * - \f$k\f$ is a user specifiable parameter -<span class="lineNum"> 1248 </span> : * -<span class="lineNum"> 1249 </span> : * TradWeight(k) is equivalent to BM25Weight(k, 0, 0, 1, 0), except that -<span class="lineNum"> 1250 </span> : * the latter returns weights (k+1) times larger. -<span class="lineNum"> 1251 </span> : */ -<span class="lineNum"> 1252 </span> : class XAPIAN_VISIBILITY_DEFAULT TradWeight : public Weight { -<span class="lineNum"> 1253 </span> : private: -<span class="lineNum"> 1254 </span> : mutable Xapian::weight termweight; -<span class="lineNum"> 1255 </span> : mutable Xapian::doclength lenpart; -<span class="lineNum"> 1256 </span> : -<span class="lineNum"> 1257 </span> : double param_k; -<span class="lineNum"> 1258 </span> : -<span class="lineNum"> 1259 </span> : mutable bool weight_calculated; -<span class="lineNum"> 1260 </span> : -<span class="lineNum"> 1261 </span> : void calc_termweight() const; -<span class="lineNum"> 1262 </span> : -<span class="lineNum"> 1263 </span> : public: -<span class="lineNum"> 1264 </span> : /** Construct a TradWeight -<span class="lineNum"> 1265 </span> : * -<span class="lineNum"> 1266 </span> : * @param k parameter governing the importance of within -<span class="lineNum"> 1267 </span> : * document frequency and document length - any non-negative -<span class="lineNum"> 1268 </span> : * number (0 meaning to ignore wdf and doc length when -<span class="lineNum"> 1269 </span> : * calculating weights). Default is 1. -<span class="lineNum"> 1270 </span> : */ -<span class="lineNum"> 1271 </span> : explicit TradWeight(double k) : param_k(k), weight_calculated(false) { -<span class="lineNum"> 1272 </span> : if (param_k < 0) param_k = 0; -<span class="lineNum"> 1273 </span> : } -<span class="lineNum"> 1274 </span> : -<span class="lineNum"> 1275 </span> : TradWeight() : param_k(1.0), weight_calculated(false) { } -<span class="lineNum"> 1276 </span> : -<span class="lineNum"> 1277 </span> : TradWeight * clone() const; -<span class="lineNum"> 1278 </span> : ~TradWeight() { } -<span class="lineNum"> 1279 </span> : std::string name() const; -<span class="lineNum"> 1280 </span> : std::string serialise() const; -<span class="lineNum"> 1281 </span> : TradWeight * unserialise(const std::string & s) const; -<span class="lineNum"> 1282 </span> : -<span class="lineNum"> 1283 </span> : Xapian::weight get_sumpart(Xapian::termcount wdf, Xapian::doclength len) const; -<span class="lineNum"> 1284 </span> : Xapian::weight get_maxpart() const; -<span class="lineNum"> 1285 </span> : -<span class="lineNum"> 1286 </span> : Xapian::weight get_sumextra(Xapian::doclength len) const; -<span class="lineNum"> 1287 </span> : Xapian::weight get_maxextra() const; -<span class="lineNum"> 1288 </span> : -<span class="lineNum"> 1289 </span> : bool get_sumpart_needs_doclength() const; -<span class="lineNum"> 1290 </span> : }; -<span class="lineNum"> 1291 </span> : -<span class="lineNum"> 1292 </span> : } -<span class="lineNum"> 1293 </span> : -<span class="lineNum"> 1294 </span> : #endif /* XAPIAN_INCLUDED_ENQUIRE_H */ -</pre> - </td> - </tr> - </table> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> diff --git a/rep/usr/include/xapian/error.h.gcov.html b/rep/usr/include/xapian/error.h.gcov.html deleted file mode 100644 index 62fba9b..0000000 --- a/rep/usr/include/xapian/error.h.gcov.html +++ /dev/null @@ -1,822 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian/error.h</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - error.h</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">3</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">0.0 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">0</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <table cellpadding=0 cellspacing=0 border=0> - <tr> - <td><br></td> - </tr> - <tr> - <td><pre class="source"> -<span class="lineNum"> 1 </span> : /** @file error.h -<span class="lineNum"> 2 </span> : * @brief Hierarchy of classes which Xapian can throw as exceptions. -<span class="lineNum"> 3 </span> : */ -<span class="lineNum"> 4 </span> : /* Warning: This file is generated by ./generate-exceptions - do not modify directly! */ -<span class="lineNum"> 5 </span> : /* Copyright (C) 2003,2004,2006,2007 Olly Betts -<span class="lineNum"> 6 </span> : * -<span class="lineNum"> 7 </span> : * This program is free software; you can redistribute it and/or -<span class="lineNum"> 8 </span> : * modify it under the terms of the GNU General Public License as -<span class="lineNum"> 9 </span> : * published by the Free Software Foundation; either version 2 of the -<span class="lineNum"> 10 </span> : * License, or (at your option) any later version. -<span class="lineNum"> 11 </span> : * -<span class="lineNum"> 12 </span> : * This program is distributed in the hope that it will be useful, -<span class="lineNum"> 13 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of -<span class="lineNum"> 14 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -<span class="lineNum"> 15 </span> : * GNU General Public License for more details. -<span class="lineNum"> 16 </span> : * -<span class="lineNum"> 17 </span> : * You should have received a copy of the GNU General Public License -<span class="lineNum"> 18 </span> : * along with this program; if not, write to the Free Software -<span class="lineNum"> 19 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -<span class="lineNum"> 20 </span> : */ -<span class="lineNum"> 21 </span> : -<span class="lineNum"> 22 </span> : #ifndef XAPIAN_INCLUDED_ERROR_H -<span class="lineNum"> 23 </span> : #define XAPIAN_INCLUDED_ERROR_H -<span class="lineNum"> 24 </span> : -<span class="lineNum"> 25 </span> : #include <string> -<span class="lineNum"> 26 </span> : #include <xapian/deprecated.h> -<span class="lineNum"> 27 </span> : #include <xapian/visibility.h> -<span class="lineNum"> 28 </span> : -<span class="lineNum"> 29 </span> : namespace Xapian { -<span class="lineNum"> 30 </span> : -<span class="lineNum"> 31 </span> : class ErrorHandler; -<span class="lineNum"> 32 </span> : -<span class="lineNum"> 33 </span> : /** All exceptions thrown by Xapian are subclasses of Xapian::Error. -<span class="lineNum"> 34 </span> : * -<span class="lineNum"> 35 </span> : * This class can not be instantiated directly - instead a subclass should -<span class="lineNum"> 36 </span> : * be used. -<span class="lineNum"> 37 </span> : */ -<span class="lineNum"> 38 </span> : class XAPIAN_VISIBILITY_DEFAULT Error { -<span class="lineNum"> 39 </span> : // ErrorHandler needs to be able to access Error::already_handled. -<span class="lineNum"> 40 </span> : friend class ErrorHandler; -<span class="lineNum"> 41 </span> : -<span class="lineNum"> 42 </span> : /// Message giving details of the error, intended for human consumption. -<span class="lineNum"> 43 </span> : std::string msg; -<span class="lineNum"> 44 </span> : -<span class="lineNum"> 45 </span> : /** Optional context information. -<span class="lineNum"> 46 </span> : * -<span class="lineNum"> 47 </span> : * This context is intended for use by Xapian::ErrorHandler (for example -<span class="lineNum"> 48 </span> : * so it can know which remote server is unreliable and report the problem -<span class="lineNum"> 49 </span> : * and remove that server from those being searched). But it's typically -<span class="lineNum"> 50 </span> : * a plain-text string, and so also fit for human consumption. -<span class="lineNum"> 51 </span> : */ -<span class="lineNum"> 52 </span> : std::string context; -<span class="lineNum"> 53 </span> : -<span class="lineNum"> 54 </span> : /// The type of this error (e.g. DocNotFoundError.) -<span class="lineNum"> 55 </span> : const char * type; -<span class="lineNum"> 56 </span> : -<span class="lineNum"> 57 </span> : /** Optional value of 'errno' associated with this error. -<span class="lineNum"> 58 </span> : * -<span class="lineNum"> 59 </span> : * If no value is associated, this member variable will be 0. -<span class="lineNum"> 60 </span> : * -<span class="lineNum"> 61 </span> : * On UNIX, if this value is < 0, it's a negated h_errno value (giving -<span class="lineNum"> 62 </span> : * an error from gethostbyname() or similar). -<span class="lineNum"> 63 </span> : * -<span class="lineNum"> 64 </span> : * On Windows, if this value is < 0, it's a negated Windows error code -<span class="lineNum"> 65 </span> : * (as given by GetLastError() or WSAGetLastError()). -<span class="lineNum"> 66 </span> : * -<span class="lineNum"> 67 </span> : * NB We don't just call this member "errno" to avoid problems on -<span class="lineNum"> 68 </span> : * platforms where errno is a preprocessor macro. -<span class="lineNum"> 69 </span> : */ -<span class="lineNum"> 70 </span> : int my_errno; -<span class="lineNum"> 71 </span> : -<span class="lineNum"> 72 </span> : /** The error string derived from my_errno. -<span class="lineNum"> 73 </span> : * -<span class="lineNum"> 74 </span> : * This string is generated from my_errno lazily. -<span class="lineNum"> 75 </span> : */ -<span class="lineNum"> 76 </span> : mutable std::string error_string; -<span class="lineNum"> 77 </span> : -<span class="lineNum"> 78 </span> : /// True if this error has already been passed to an ErrorHandler. -<span class="lineNum"> 79 </span> : bool already_handled; -<span class="lineNum"> 80 </span> : -<span class="lineNum"> 81 </span> : /// Don't allow assignment of the base class. -<span class="lineNum"> 82 </span> : void operator=(const Error &o); -<span class="lineNum"> 83 </span> : -<span class="lineNum"> 84 </span> : protected: -<span class="lineNum"> 85 </span> : /** @private @internal -<span class="lineNum"> 86 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 87 </span> : */ -<span class="lineNum"> 88 </span> : Error(const std::string &msg_, const std::string &context_, -<span class="lineNum"> 89 </span> : const char * type_, const char * error_string_); -<span class="lineNum"> 90 </span> : -<span class="lineNum"> 91 </span> : /** @private @internal -<span class="lineNum"> 92 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 93 </span> : */ -<span class="lineNum"> 94 </span> : Error(const std::string &msg_, const std::string &context_, -<span class="lineNum"> 95 </span> : const char * type_, int errno_) -<span class="lineNum"> 96 </span> : : msg(msg_), context(context_), type(type_), my_errno(errno_), -<span class="lineNum"> 97 </span> : error_string(), already_handled(false) { } -<span class="lineNum"> 98 </span> : -<span class="lineNum"> 99 </span> : public: -<span class="lineNum"> 100 </span> : /// The type of this error (e.g. "DocNotFoundError".) -<span class="lineNum"> 101 </span><span class="lineNoCov"> 0 : const char * get_type() const { return type; }</span> -<span class="lineNum"> 102 </span> : -<span class="lineNum"> 103 </span> : /// Message giving details of the error, intended for human consumption. -<span class="lineNum"> 104 </span><span class="lineNoCov"> 0 : const std::string & get_msg() const { return msg; }</span> -<span class="lineNum"> 105 </span> : -<span class="lineNum"> 106 </span> : /** Optional context information. -<span class="lineNum"> 107 </span> : * -<span class="lineNum"> 108 </span> : * This context is intended for use by Xapian::ErrorHandler (for example -<span class="lineNum"> 109 </span> : * so it can know which remote server is unreliable and report the problem -<span class="lineNum"> 110 </span> : * and remove that server from those being searched). But it's typically -<span class="lineNum"> 111 </span> : * a plain-text string, and so also fit for human consumption. -<span class="lineNum"> 112 </span> : */ -<span class="lineNum"> 113 </span><span class="lineNoCov"> 0 : const std::string & get_context() const { return context; }</span> -<span class="lineNum"> 114 </span> : -<span class="lineNum"> 115 </span> : /** Returns any system error string associated with this exception. -<span class="lineNum"> 116 </span> : * -<span class="lineNum"> 117 </span> : * The system error string may come from errno, h_errno (on UNIX), or -<span class="lineNum"> 118 </span> : * GetLastError() (on MS Windows). If there is no associated system -<span class="lineNum"> 119 </span> : * error string, NULL is returned. -<span class="lineNum"> 120 </span> : */ -<span class="lineNum"> 121 </span> : const char * get_error_string() const; -<span class="lineNum"> 122 </span> : -<span class="lineNum"> 123 </span> : /** Optional value of 'errno' associated with this error. -<span class="lineNum"> 124 </span> : * -<span class="lineNum"> 125 </span> : * If no 'errno' value is associated, returns 0. If the returned value -<span class="lineNum"> 126 </span> : * is negative, it's a platform-specific error code (on UNIX, -h_errno; -<span class="lineNum"> 127 </span> : * on MS Windows, -GetLastError()). -<span class="lineNum"> 128 </span> : * -<span class="lineNum"> 129 </span> : * @deprecated This method is deprecated, because errno values aren't -<span class="lineNum"> 130 </span> : * portable between platforms, so we can't serialise them when passing -<span class="lineNum"> 131 </span> : * exceptions from a remote server to a client. Use the -<span class="lineNum"> 132 </span> : * get_error_string() method instead. -<span class="lineNum"> 133 </span> : */ -<span class="lineNum"> 134 </span> : XAPIAN_DEPRECATED(int get_errno() const); -<span class="lineNum"> 135 </span> : -<span class="lineNum"> 136 </span> : /// Return a string describing this object. -<span class="lineNum"> 137 </span> : std::string get_description() const; -<span class="lineNum"> 138 </span> : }; -<span class="lineNum"> 139 </span> : -<span class="lineNum"> 140 </span> : inline int Xapian::Error::get_errno() const { return my_errno; } -<span class="lineNum"> 141 </span> : -<span class="lineNum"> 142 </span> : /** The base class for exceptions indicating errors in the program logic. -<span class="lineNum"> 143 </span> : * -<span class="lineNum"> 144 </span> : * A subclass of LogicError will be thrown if Xapian detects a violation -<span class="lineNum"> 145 </span> : * of a class invariant or a logical precondition or postcondition, etc. -<span class="lineNum"> 146 </span> : */ -<span class="lineNum"> 147 </span> : class XAPIAN_VISIBILITY_DEFAULT LogicError : public Error { -<span class="lineNum"> 148 </span> : protected: -<span class="lineNum"> 149 </span> : /** @private @internal -<span class="lineNum"> 150 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 151 </span> : */ -<span class="lineNum"> 152 </span> : LogicError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 153 </span> : : Error(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 154 </span> : -<span class="lineNum"> 155 </span> : /** @private @internal -<span class="lineNum"> 156 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 157 </span> : */ -<span class="lineNum"> 158 </span> : LogicError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 159 </span> : : Error(msg_, context_, type_, errno_) {} -<span class="lineNum"> 160 </span> : }; -<span class="lineNum"> 161 </span> : -<span class="lineNum"> 162 </span> : /** The base class for exceptions indicating errors only detectable at runtime. -<span class="lineNum"> 163 </span> : * -<span class="lineNum"> 164 </span> : * A subclass of RuntimeError will be thrown if Xapian detects an error -<span class="lineNum"> 165 </span> : * which is exception derived from RuntimeError is thrown when an -<span class="lineNum"> 166 </span> : * error is caused by problems with the data or environment rather -<span class="lineNum"> 167 </span> : * than a programming mistake. -<span class="lineNum"> 168 </span> : */ -<span class="lineNum"> 169 </span> : class XAPIAN_VISIBILITY_DEFAULT RuntimeError : public Error { -<span class="lineNum"> 170 </span> : protected: -<span class="lineNum"> 171 </span> : /** @private @internal -<span class="lineNum"> 172 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 173 </span> : */ -<span class="lineNum"> 174 </span> : RuntimeError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 175 </span> : : Error(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 176 </span> : -<span class="lineNum"> 177 </span> : /** @private @internal -<span class="lineNum"> 178 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 179 </span> : */ -<span class="lineNum"> 180 </span> : RuntimeError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 181 </span> : : Error(msg_, context_, type_, errno_) {} -<span class="lineNum"> 182 </span> : }; -<span class="lineNum"> 183 </span> : -<span class="lineNum"> 184 </span> : /** AssertionError is thrown if a logical assertion inside Xapian fails. -<span class="lineNum"> 185 </span> : * -<span class="lineNum"> 186 </span> : * In a debug build of Xapian, a failed assertion in the core library code -<span class="lineNum"> 187 </span> : * will cause AssertionError to be thrown. -<span class="lineNum"> 188 </span> : * -<span class="lineNum"> 189 </span> : * This represents a bug in Xapian (either an invariant, precondition, etc -<span class="lineNum"> 190 </span> : * has been violated, or the assertion is incorrect!) -<span class="lineNum"> 191 </span> : */ -<span class="lineNum"> 192 </span> : class XAPIAN_VISIBILITY_DEFAULT AssertionError : public LogicError { -<span class="lineNum"> 193 </span> : public: -<span class="lineNum"> 194 </span> : /** @private @internal -<span class="lineNum"> 195 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 196 </span> : * -<span class="lineNum"> 197 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 198 </span> : */ -<span class="lineNum"> 199 </span> : AssertionError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 200 </span> : : LogicError(msg_, context_, "AssertionError", error_string_) {} -<span class="lineNum"> 201 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 202 </span> : explicit AssertionError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 203 </span> : : LogicError(msg_, context_, "AssertionError", errno_) {} -<span class="lineNum"> 204 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 205 </span> : AssertionError(const std::string &msg_, int errno_) -<span class="lineNum"> 206 </span> : : LogicError(msg_, "", "AssertionError", errno_) {} -<span class="lineNum"> 207 </span> : protected: -<span class="lineNum"> 208 </span> : /** @private @internal -<span class="lineNum"> 209 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 210 </span> : */ -<span class="lineNum"> 211 </span> : AssertionError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 212 </span> : : LogicError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 213 </span> : -<span class="lineNum"> 214 </span> : /** @private @internal -<span class="lineNum"> 215 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 216 </span> : */ -<span class="lineNum"> 217 </span> : AssertionError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 218 </span> : : LogicError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 219 </span> : }; -<span class="lineNum"> 220 </span> : -<span class="lineNum"> 221 </span> : /** InvalidArgumentError indicates an invalid parameter value was passed to the API. -<span class="lineNum"> 222 </span> : */ -<span class="lineNum"> 223 </span> : class XAPIAN_VISIBILITY_DEFAULT InvalidArgumentError : public LogicError { -<span class="lineNum"> 224 </span> : public: -<span class="lineNum"> 225 </span> : /** @private @internal -<span class="lineNum"> 226 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 227 </span> : * -<span class="lineNum"> 228 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 229 </span> : */ -<span class="lineNum"> 230 </span> : InvalidArgumentError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 231 </span> : : LogicError(msg_, context_, "InvalidArgumentError", error_string_) {} -<span class="lineNum"> 232 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 233 </span> : explicit InvalidArgumentError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 234 </span> : : LogicError(msg_, context_, "InvalidArgumentError", errno_) {} -<span class="lineNum"> 235 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 236 </span> : InvalidArgumentError(const std::string &msg_, int errno_) -<span class="lineNum"> 237 </span> : : LogicError(msg_, "", "InvalidArgumentError", errno_) {} -<span class="lineNum"> 238 </span> : protected: -<span class="lineNum"> 239 </span> : /** @private @internal -<span class="lineNum"> 240 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 241 </span> : */ -<span class="lineNum"> 242 </span> : InvalidArgumentError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 243 </span> : : LogicError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 244 </span> : -<span class="lineNum"> 245 </span> : /** @private @internal -<span class="lineNum"> 246 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 247 </span> : */ -<span class="lineNum"> 248 </span> : InvalidArgumentError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 249 </span> : : LogicError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 250 </span> : }; -<span class="lineNum"> 251 </span> : -<span class="lineNum"> 252 </span> : /** InvalidOperationError indicates the API was used in an invalid way. -<span class="lineNum"> 253 </span> : */ -<span class="lineNum"> 254 </span> : class XAPIAN_VISIBILITY_DEFAULT InvalidOperationError : public LogicError { -<span class="lineNum"> 255 </span> : public: -<span class="lineNum"> 256 </span> : /** @private @internal -<span class="lineNum"> 257 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 258 </span> : * -<span class="lineNum"> 259 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 260 </span> : */ -<span class="lineNum"> 261 </span> : InvalidOperationError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 262 </span> : : LogicError(msg_, context_, "InvalidOperationError", error_string_) {} -<span class="lineNum"> 263 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 264 </span> : explicit InvalidOperationError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 265 </span> : : LogicError(msg_, context_, "InvalidOperationError", errno_) {} -<span class="lineNum"> 266 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 267 </span> : InvalidOperationError(const std::string &msg_, int errno_) -<span class="lineNum"> 268 </span> : : LogicError(msg_, "", "InvalidOperationError", errno_) {} -<span class="lineNum"> 269 </span> : protected: -<span class="lineNum"> 270 </span> : /** @private @internal -<span class="lineNum"> 271 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 272 </span> : */ -<span class="lineNum"> 273 </span> : InvalidOperationError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 274 </span> : : LogicError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 275 </span> : -<span class="lineNum"> 276 </span> : /** @private @internal -<span class="lineNum"> 277 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 278 </span> : */ -<span class="lineNum"> 279 </span> : InvalidOperationError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 280 </span> : : LogicError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 281 </span> : }; -<span class="lineNum"> 282 </span> : -<span class="lineNum"> 283 </span> : /** UnimplementedError indicates an attempt to use an unimplemented feature. */ -<span class="lineNum"> 284 </span> : class XAPIAN_VISIBILITY_DEFAULT UnimplementedError : public LogicError { -<span class="lineNum"> 285 </span> : public: -<span class="lineNum"> 286 </span> : /** @private @internal -<span class="lineNum"> 287 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 288 </span> : * -<span class="lineNum"> 289 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 290 </span> : */ -<span class="lineNum"> 291 </span> : UnimplementedError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 292 </span> : : LogicError(msg_, context_, "UnimplementedError", error_string_) {} -<span class="lineNum"> 293 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 294 </span> : explicit UnimplementedError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 295 </span> : : LogicError(msg_, context_, "UnimplementedError", errno_) {} -<span class="lineNum"> 296 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 297 </span> : UnimplementedError(const std::string &msg_, int errno_) -<span class="lineNum"> 298 </span> : : LogicError(msg_, "", "UnimplementedError", errno_) {} -<span class="lineNum"> 299 </span> : protected: -<span class="lineNum"> 300 </span> : /** @private @internal -<span class="lineNum"> 301 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 302 </span> : */ -<span class="lineNum"> 303 </span> : UnimplementedError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 304 </span> : : LogicError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 305 </span> : -<span class="lineNum"> 306 </span> : /** @private @internal -<span class="lineNum"> 307 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 308 </span> : */ -<span class="lineNum"> 309 </span> : UnimplementedError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 310 </span> : : LogicError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 311 </span> : }; -<span class="lineNum"> 312 </span> : -<span class="lineNum"> 313 </span> : /** DatabaseError indicates some sort of database related error. */ -<span class="lineNum"> 314 </span> : class XAPIAN_VISIBILITY_DEFAULT DatabaseError : public RuntimeError { -<span class="lineNum"> 315 </span> : public: -<span class="lineNum"> 316 </span> : /** @private @internal -<span class="lineNum"> 317 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 318 </span> : * -<span class="lineNum"> 319 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 320 </span> : */ -<span class="lineNum"> 321 </span> : DatabaseError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 322 </span> : : RuntimeError(msg_, context_, "DatabaseError", error_string_) {} -<span class="lineNum"> 323 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 324 </span> : explicit DatabaseError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 325 </span> : : RuntimeError(msg_, context_, "DatabaseError", errno_) {} -<span class="lineNum"> 326 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 327 </span> : DatabaseError(const std::string &msg_, int errno_) -<span class="lineNum"> 328 </span> : : RuntimeError(msg_, "", "DatabaseError", errno_) {} -<span class="lineNum"> 329 </span> : protected: -<span class="lineNum"> 330 </span> : /** @private @internal -<span class="lineNum"> 331 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 332 </span> : */ -<span class="lineNum"> 333 </span> : DatabaseError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 334 </span> : : RuntimeError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 335 </span> : -<span class="lineNum"> 336 </span> : /** @private @internal -<span class="lineNum"> 337 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 338 </span> : */ -<span class="lineNum"> 339 </span> : DatabaseError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 340 </span> : : RuntimeError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 341 </span> : }; -<span class="lineNum"> 342 </span> : -<span class="lineNum"> 343 </span> : /** DatabaseCorruptError indicates database corruption was detected. */ -<span class="lineNum"> 344 </span> : class XAPIAN_VISIBILITY_DEFAULT DatabaseCorruptError : public DatabaseError { -<span class="lineNum"> 345 </span> : public: -<span class="lineNum"> 346 </span> : /** @private @internal -<span class="lineNum"> 347 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 348 </span> : * -<span class="lineNum"> 349 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 350 </span> : */ -<span class="lineNum"> 351 </span> : DatabaseCorruptError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 352 </span> : : DatabaseError(msg_, context_, "DatabaseCorruptError", error_string_) {} -<span class="lineNum"> 353 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 354 </span> : explicit DatabaseCorruptError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 355 </span> : : DatabaseError(msg_, context_, "DatabaseCorruptError", errno_) {} -<span class="lineNum"> 356 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 357 </span> : DatabaseCorruptError(const std::string &msg_, int errno_) -<span class="lineNum"> 358 </span> : : DatabaseError(msg_, "", "DatabaseCorruptError", errno_) {} -<span class="lineNum"> 359 </span> : protected: -<span class="lineNum"> 360 </span> : /** @private @internal -<span class="lineNum"> 361 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 362 </span> : */ -<span class="lineNum"> 363 </span> : DatabaseCorruptError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 364 </span> : : DatabaseError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 365 </span> : -<span class="lineNum"> 366 </span> : /** @private @internal -<span class="lineNum"> 367 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 368 </span> : */ -<span class="lineNum"> 369 </span> : DatabaseCorruptError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 370 </span> : : DatabaseError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 371 </span> : }; -<span class="lineNum"> 372 </span> : -<span class="lineNum"> 373 </span> : /** DatabaseCreateError indicates a failure to create a database. */ -<span class="lineNum"> 374 </span> : class XAPIAN_VISIBILITY_DEFAULT DatabaseCreateError : public DatabaseError { -<span class="lineNum"> 375 </span> : public: -<span class="lineNum"> 376 </span> : /** @private @internal -<span class="lineNum"> 377 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 378 </span> : * -<span class="lineNum"> 379 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 380 </span> : */ -<span class="lineNum"> 381 </span> : DatabaseCreateError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 382 </span> : : DatabaseError(msg_, context_, "DatabaseCreateError", error_string_) {} -<span class="lineNum"> 383 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 384 </span> : explicit DatabaseCreateError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 385 </span> : : DatabaseError(msg_, context_, "DatabaseCreateError", errno_) {} -<span class="lineNum"> 386 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 387 </span> : DatabaseCreateError(const std::string &msg_, int errno_) -<span class="lineNum"> 388 </span> : : DatabaseError(msg_, "", "DatabaseCreateError", errno_) {} -<span class="lineNum"> 389 </span> : protected: -<span class="lineNum"> 390 </span> : /** @private @internal -<span class="lineNum"> 391 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 392 </span> : */ -<span class="lineNum"> 393 </span> : DatabaseCreateError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 394 </span> : : DatabaseError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 395 </span> : -<span class="lineNum"> 396 </span> : /** @private @internal -<span class="lineNum"> 397 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 398 </span> : */ -<span class="lineNum"> 399 </span> : DatabaseCreateError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 400 </span> : : DatabaseError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 401 </span> : }; -<span class="lineNum"> 402 </span> : -<span class="lineNum"> 403 </span> : /** DatabaseLockError indicates failure to lock a database. */ -<span class="lineNum"> 404 </span> : class XAPIAN_VISIBILITY_DEFAULT DatabaseLockError : public DatabaseError { -<span class="lineNum"> 405 </span> : public: -<span class="lineNum"> 406 </span> : /** @private @internal -<span class="lineNum"> 407 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 408 </span> : * -<span class="lineNum"> 409 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 410 </span> : */ -<span class="lineNum"> 411 </span> : DatabaseLockError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 412 </span> : : DatabaseError(msg_, context_, "DatabaseLockError", error_string_) {} -<span class="lineNum"> 413 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 414 </span> : explicit DatabaseLockError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 415 </span> : : DatabaseError(msg_, context_, "DatabaseLockError", errno_) {} -<span class="lineNum"> 416 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 417 </span> : DatabaseLockError(const std::string &msg_, int errno_) -<span class="lineNum"> 418 </span> : : DatabaseError(msg_, "", "DatabaseLockError", errno_) {} -<span class="lineNum"> 419 </span> : protected: -<span class="lineNum"> 420 </span> : /** @private @internal -<span class="lineNum"> 421 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 422 </span> : */ -<span class="lineNum"> 423 </span> : DatabaseLockError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 424 </span> : : DatabaseError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 425 </span> : -<span class="lineNum"> 426 </span> : /** @private @internal -<span class="lineNum"> 427 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 428 </span> : */ -<span class="lineNum"> 429 </span> : DatabaseLockError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 430 </span> : : DatabaseError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 431 </span> : }; -<span class="lineNum"> 432 </span> : -<span class="lineNum"> 433 </span> : /** DatabaseModifiedError indicates a database was modified. -<span class="lineNum"> 434 </span> : * -<span class="lineNum"> 435 </span> : * To recover after catching this error, you need to call -<span class="lineNum"> 436 </span> : * Xapian::Database::reopen() on the Database and repeat the operation -<span class="lineNum"> 437 </span> : * which failed. -<span class="lineNum"> 438 </span> : */ -<span class="lineNum"> 439 </span> : class XAPIAN_VISIBILITY_DEFAULT DatabaseModifiedError : public DatabaseError { -<span class="lineNum"> 440 </span> : public: -<span class="lineNum"> 441 </span> : /** @private @internal -<span class="lineNum"> 442 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 443 </span> : * -<span class="lineNum"> 444 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 445 </span> : */ -<span class="lineNum"> 446 </span> : DatabaseModifiedError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 447 </span> : : DatabaseError(msg_, context_, "DatabaseModifiedError", error_string_) {} -<span class="lineNum"> 448 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 449 </span> : explicit DatabaseModifiedError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 450 </span> : : DatabaseError(msg_, context_, "DatabaseModifiedError", errno_) {} -<span class="lineNum"> 451 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 452 </span> : DatabaseModifiedError(const std::string &msg_, int errno_) -<span class="lineNum"> 453 </span> : : DatabaseError(msg_, "", "DatabaseModifiedError", errno_) {} -<span class="lineNum"> 454 </span> : protected: -<span class="lineNum"> 455 </span> : /** @private @internal -<span class="lineNum"> 456 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 457 </span> : */ -<span class="lineNum"> 458 </span> : DatabaseModifiedError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 459 </span> : : DatabaseError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 460 </span> : -<span class="lineNum"> 461 </span> : /** @private @internal -<span class="lineNum"> 462 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 463 </span> : */ -<span class="lineNum"> 464 </span> : DatabaseModifiedError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 465 </span> : : DatabaseError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 466 </span> : }; -<span class="lineNum"> 467 </span> : -<span class="lineNum"> 468 </span> : /** DatabaseOpeningError indicates failure to open a database. */ -<span class="lineNum"> 469 </span> : class XAPIAN_VISIBILITY_DEFAULT DatabaseOpeningError : public DatabaseError { -<span class="lineNum"> 470 </span> : public: -<span class="lineNum"> 471 </span> : /** @private @internal -<span class="lineNum"> 472 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 473 </span> : * -<span class="lineNum"> 474 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 475 </span> : */ -<span class="lineNum"> 476 </span> : DatabaseOpeningError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 477 </span> : : DatabaseError(msg_, context_, "DatabaseOpeningError", error_string_) {} -<span class="lineNum"> 478 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 479 </span> : explicit DatabaseOpeningError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 480 </span> : : DatabaseError(msg_, context_, "DatabaseOpeningError", errno_) {} -<span class="lineNum"> 481 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 482 </span> : DatabaseOpeningError(const std::string &msg_, int errno_) -<span class="lineNum"> 483 </span> : : DatabaseError(msg_, "", "DatabaseOpeningError", errno_) {} -<span class="lineNum"> 484 </span> : protected: -<span class="lineNum"> 485 </span> : /** @private @internal -<span class="lineNum"> 486 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 487 </span> : */ -<span class="lineNum"> 488 </span> : DatabaseOpeningError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 489 </span> : : DatabaseError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 490 </span> : -<span class="lineNum"> 491 </span> : /** @private @internal -<span class="lineNum"> 492 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 493 </span> : */ -<span class="lineNum"> 494 </span> : DatabaseOpeningError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 495 </span> : : DatabaseError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 496 </span> : }; -<span class="lineNum"> 497 </span> : -<span class="lineNum"> 498 </span> : /** DatabaseVersionError indicates that a database is in an unsupported format. -<span class="lineNum"> 499 </span> : * -<span class="lineNum"> 500 </span> : * From time to time, new versions of Xapian will require the database format -<span class="lineNum"> 501 </span> : * to be changed, to allow new information to be stored or new optimisations -<span class="lineNum"> 502 </span> : * to be performed. Backwards compatibility will sometimes be maintained, so -<span class="lineNum"> 503 </span> : * that new versions of Xapian can open old databases, but in some cases -<span class="lineNum"> 504 </span> : * Xapian will be unable to open a database because it is in too old (or new) -<span class="lineNum"> 505 </span> : * a format. This can be resolved either be upgrading or downgrading the -<span class="lineNum"> 506 </span> : * version of Xapian in use, or by rebuilding the database from scratch with -<span class="lineNum"> 507 </span> : * the current version of Xapian. -<span class="lineNum"> 508 </span> : */ -<span class="lineNum"> 509 </span> : class XAPIAN_VISIBILITY_DEFAULT DatabaseVersionError : public DatabaseOpeningError { -<span class="lineNum"> 510 </span> : public: -<span class="lineNum"> 511 </span> : /** @private @internal -<span class="lineNum"> 512 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 513 </span> : * -<span class="lineNum"> 514 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 515 </span> : */ -<span class="lineNum"> 516 </span> : DatabaseVersionError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 517 </span> : : DatabaseOpeningError(msg_, context_, "DatabaseVersionError", error_string_) {} -<span class="lineNum"> 518 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 519 </span> : explicit DatabaseVersionError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 520 </span> : : DatabaseOpeningError(msg_, context_, "DatabaseVersionError", errno_) {} -<span class="lineNum"> 521 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 522 </span> : DatabaseVersionError(const std::string &msg_, int errno_) -<span class="lineNum"> 523 </span> : : DatabaseOpeningError(msg_, "", "DatabaseVersionError", errno_) {} -<span class="lineNum"> 524 </span> : protected: -<span class="lineNum"> 525 </span> : /** @private @internal -<span class="lineNum"> 526 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 527 </span> : */ -<span class="lineNum"> 528 </span> : DatabaseVersionError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 529 </span> : : DatabaseOpeningError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 530 </span> : -<span class="lineNum"> 531 </span> : /** @private @internal -<span class="lineNum"> 532 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 533 </span> : */ -<span class="lineNum"> 534 </span> : DatabaseVersionError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 535 </span> : : DatabaseOpeningError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 536 </span> : }; -<span class="lineNum"> 537 </span> : -<span class="lineNum"> 538 </span> : /** Indicates an attempt to access a document not present in the database. */ -<span class="lineNum"> 539 </span> : class XAPIAN_VISIBILITY_DEFAULT DocNotFoundError : public RuntimeError { -<span class="lineNum"> 540 </span> : public: -<span class="lineNum"> 541 </span> : /** @private @internal -<span class="lineNum"> 542 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 543 </span> : * -<span class="lineNum"> 544 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 545 </span> : */ -<span class="lineNum"> 546 </span> : DocNotFoundError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 547 </span> : : RuntimeError(msg_, context_, "DocNotFoundError", error_string_) {} -<span class="lineNum"> 548 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 549 </span> : explicit DocNotFoundError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 550 </span> : : RuntimeError(msg_, context_, "DocNotFoundError", errno_) {} -<span class="lineNum"> 551 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 552 </span> : DocNotFoundError(const std::string &msg_, int errno_) -<span class="lineNum"> 553 </span> : : RuntimeError(msg_, "", "DocNotFoundError", errno_) {} -<span class="lineNum"> 554 </span> : protected: -<span class="lineNum"> 555 </span> : /** @private @internal -<span class="lineNum"> 556 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 557 </span> : */ -<span class="lineNum"> 558 </span> : DocNotFoundError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 559 </span> : : RuntimeError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 560 </span> : -<span class="lineNum"> 561 </span> : /** @private @internal -<span class="lineNum"> 562 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 563 </span> : */ -<span class="lineNum"> 564 </span> : DocNotFoundError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 565 </span> : : RuntimeError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 566 </span> : }; -<span class="lineNum"> 567 </span> : -<span class="lineNum"> 568 </span> : /** Indicates an attempt to use a feature which is unavailable. -<span class="lineNum"> 569 </span> : * -<span class="lineNum"> 570 </span> : * Typically a feature is unavailable because it wasn't compiled in, or -<span class="lineNum"> 571 </span> : * because it requires other software or facilities which aren't available. -<span class="lineNum"> 572 </span> : */ -<span class="lineNum"> 573 </span> : class XAPIAN_VISIBILITY_DEFAULT FeatureUnavailableError : public RuntimeError { -<span class="lineNum"> 574 </span> : public: -<span class="lineNum"> 575 </span> : /** @private @internal -<span class="lineNum"> 576 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 577 </span> : * -<span class="lineNum"> 578 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 579 </span> : */ -<span class="lineNum"> 580 </span> : FeatureUnavailableError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 581 </span> : : RuntimeError(msg_, context_, "FeatureUnavailableError", error_string_) {} -<span class="lineNum"> 582 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 583 </span> : explicit FeatureUnavailableError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 584 </span> : : RuntimeError(msg_, context_, "FeatureUnavailableError", errno_) {} -<span class="lineNum"> 585 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 586 </span> : FeatureUnavailableError(const std::string &msg_, int errno_) -<span class="lineNum"> 587 </span> : : RuntimeError(msg_, "", "FeatureUnavailableError", errno_) {} -<span class="lineNum"> 588 </span> : protected: -<span class="lineNum"> 589 </span> : /** @private @internal -<span class="lineNum"> 590 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 591 </span> : */ -<span class="lineNum"> 592 </span> : FeatureUnavailableError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 593 </span> : : RuntimeError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 594 </span> : -<span class="lineNum"> 595 </span> : /** @private @internal -<span class="lineNum"> 596 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 597 </span> : */ -<span class="lineNum"> 598 </span> : FeatureUnavailableError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 599 </span> : : RuntimeError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 600 </span> : }; -<span class="lineNum"> 601 </span> : -<span class="lineNum"> 602 </span> : /** InternalError indicates a runtime problem of some sort. */ -<span class="lineNum"> 603 </span> : class XAPIAN_VISIBILITY_DEFAULT InternalError : public RuntimeError { -<span class="lineNum"> 604 </span> : public: -<span class="lineNum"> 605 </span> : /** @private @internal -<span class="lineNum"> 606 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 607 </span> : * -<span class="lineNum"> 608 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 609 </span> : */ -<span class="lineNum"> 610 </span> : InternalError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 611 </span> : : RuntimeError(msg_, context_, "InternalError", error_string_) {} -<span class="lineNum"> 612 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 613 </span> : explicit InternalError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 614 </span> : : RuntimeError(msg_, context_, "InternalError", errno_) {} -<span class="lineNum"> 615 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 616 </span> : InternalError(const std::string &msg_, int errno_) -<span class="lineNum"> 617 </span> : : RuntimeError(msg_, "", "InternalError", errno_) {} -<span class="lineNum"> 618 </span> : protected: -<span class="lineNum"> 619 </span> : /** @private @internal -<span class="lineNum"> 620 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 621 </span> : */ -<span class="lineNum"> 622 </span> : InternalError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 623 </span> : : RuntimeError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 624 </span> : -<span class="lineNum"> 625 </span> : /** @private @internal -<span class="lineNum"> 626 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 627 </span> : */ -<span class="lineNum"> 628 </span> : InternalError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 629 </span> : : RuntimeError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 630 </span> : }; -<span class="lineNum"> 631 </span> : -<span class="lineNum"> 632 </span> : /** Indicates a problem communicating with a remote database. */ -<span class="lineNum"> 633 </span> : class XAPIAN_VISIBILITY_DEFAULT NetworkError : public RuntimeError { -<span class="lineNum"> 634 </span> : public: -<span class="lineNum"> 635 </span> : /** @private @internal -<span class="lineNum"> 636 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 637 </span> : * -<span class="lineNum"> 638 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 639 </span> : */ -<span class="lineNum"> 640 </span> : NetworkError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 641 </span> : : RuntimeError(msg_, context_, "NetworkError", error_string_) {} -<span class="lineNum"> 642 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 643 </span> : explicit NetworkError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 644 </span> : : RuntimeError(msg_, context_, "NetworkError", errno_) {} -<span class="lineNum"> 645 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 646 </span> : NetworkError(const std::string &msg_, int errno_) -<span class="lineNum"> 647 </span> : : RuntimeError(msg_, "", "NetworkError", errno_) {} -<span class="lineNum"> 648 </span> : protected: -<span class="lineNum"> 649 </span> : /** @private @internal -<span class="lineNum"> 650 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 651 </span> : */ -<span class="lineNum"> 652 </span> : NetworkError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 653 </span> : : RuntimeError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 654 </span> : -<span class="lineNum"> 655 </span> : /** @private @internal -<span class="lineNum"> 656 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 657 </span> : */ -<span class="lineNum"> 658 </span> : NetworkError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 659 </span> : : RuntimeError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 660 </span> : }; -<span class="lineNum"> 661 </span> : -<span class="lineNum"> 662 </span> : /** Indicates a timeout expired while communicating with a remote database. */ -<span class="lineNum"> 663 </span> : class XAPIAN_VISIBILITY_DEFAULT NetworkTimeoutError : public NetworkError { -<span class="lineNum"> 664 </span> : public: -<span class="lineNum"> 665 </span> : /** @private @internal -<span class="lineNum"> 666 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 667 </span> : * -<span class="lineNum"> 668 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 669 </span> : */ -<span class="lineNum"> 670 </span> : NetworkTimeoutError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 671 </span> : : NetworkError(msg_, context_, "NetworkTimeoutError", error_string_) {} -<span class="lineNum"> 672 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 673 </span> : explicit NetworkTimeoutError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 674 </span> : : NetworkError(msg_, context_, "NetworkTimeoutError", errno_) {} -<span class="lineNum"> 675 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 676 </span> : NetworkTimeoutError(const std::string &msg_, int errno_) -<span class="lineNum"> 677 </span> : : NetworkError(msg_, "", "NetworkTimeoutError", errno_) {} -<span class="lineNum"> 678 </span> : protected: -<span class="lineNum"> 679 </span> : /** @private @internal -<span class="lineNum"> 680 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 681 </span> : */ -<span class="lineNum"> 682 </span> : NetworkTimeoutError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 683 </span> : : NetworkError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 684 </span> : -<span class="lineNum"> 685 </span> : /** @private @internal -<span class="lineNum"> 686 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 687 </span> : */ -<span class="lineNum"> 688 </span> : NetworkTimeoutError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 689 </span> : : NetworkError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 690 </span> : }; -<span class="lineNum"> 691 </span> : -<span class="lineNum"> 692 </span> : /** Indicates a query string can't be parsed. */ -<span class="lineNum"> 693 </span> : class XAPIAN_VISIBILITY_DEFAULT QueryParserError : public RuntimeError { -<span class="lineNum"> 694 </span> : public: -<span class="lineNum"> 695 </span> : /** @private @internal -<span class="lineNum"> 696 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 697 </span> : * -<span class="lineNum"> 698 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 699 </span> : */ -<span class="lineNum"> 700 </span> : QueryParserError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 701 </span> : : RuntimeError(msg_, context_, "QueryParserError", error_string_) {} -<span class="lineNum"> 702 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 703 </span> : explicit QueryParserError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 704 </span> : : RuntimeError(msg_, context_, "QueryParserError", errno_) {} -<span class="lineNum"> 705 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 706 </span> : QueryParserError(const std::string &msg_, int errno_) -<span class="lineNum"> 707 </span> : : RuntimeError(msg_, "", "QueryParserError", errno_) {} -<span class="lineNum"> 708 </span> : protected: -<span class="lineNum"> 709 </span> : /** @private @internal -<span class="lineNum"> 710 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 711 </span> : */ -<span class="lineNum"> 712 </span> : QueryParserError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 713 </span> : : RuntimeError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 714 </span> : -<span class="lineNum"> 715 </span> : /** @private @internal -<span class="lineNum"> 716 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 717 </span> : */ -<span class="lineNum"> 718 </span> : QueryParserError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 719 </span> : : RuntimeError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 720 </span> : }; -<span class="lineNum"> 721 </span> : -<span class="lineNum"> 722 </span> : /** RangeError indicates an attempt to access outside the bounds of a container. -<span class="lineNum"> 723 </span> : */ -<span class="lineNum"> 724 </span> : class XAPIAN_VISIBILITY_DEFAULT RangeError : public RuntimeError { -<span class="lineNum"> 725 </span> : public: -<span class="lineNum"> 726 </span> : /** @private @internal -<span class="lineNum"> 727 </span> : * @brief Private constructor for use by remote backend. -<span class="lineNum"> 728 </span> : * -<span class="lineNum"> 729 </span> : * @param error_string_ Optional string describing error. May be NULL. -<span class="lineNum"> 730 </span> : */ -<span class="lineNum"> 731 </span> : RangeError(const std::string &msg_, const std::string &context_, const char * error_string_) -<span class="lineNum"> 732 </span> : : RuntimeError(msg_, context_, "RangeError", error_string_) {} -<span class="lineNum"> 733 </span> : /** General purpose constructor which allows setting errno. */ -<span class="lineNum"> 734 </span> : explicit RangeError(const std::string &msg_, const std::string &context_ = "", int errno_ = 0) -<span class="lineNum"> 735 </span> : : RuntimeError(msg_, context_, "RangeError", errno_) {} -<span class="lineNum"> 736 </span> : /** Construct from message and errno value. */ -<span class="lineNum"> 737 </span> : RangeError(const std::string &msg_, int errno_) -<span class="lineNum"> 738 </span> : : RuntimeError(msg_, "", "RangeError", errno_) {} -<span class="lineNum"> 739 </span> : protected: -<span class="lineNum"> 740 </span> : /** @private @internal -<span class="lineNum"> 741 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 742 </span> : */ -<span class="lineNum"> 743 </span> : RangeError(const std::string &msg_, const std::string &context_, const char * type_, const char * error_string_) -<span class="lineNum"> 744 </span> : : RuntimeError(msg_, context_, type_, error_string_) {} -<span class="lineNum"> 745 </span> : -<span class="lineNum"> 746 </span> : /** @private @internal -<span class="lineNum"> 747 </span> : * @brief Constructor for use by constructors of derived classes. -<span class="lineNum"> 748 </span> : */ -<span class="lineNum"> 749 </span> : RangeError(const std::string &msg_, const std::string &context_, const char * type_, int errno_) -<span class="lineNum"> 750 </span> : : RuntimeError(msg_, context_, type_, errno_) {} -<span class="lineNum"> 751 </span> : }; -<span class="lineNum"> 752 </span> : -<span class="lineNum"> 753 </span> : } -<span class="lineNum"> 754 </span> : -<span class="lineNum"> 755 </span> : #endif /* XAPIAN_INCLUDED_ERROR_H */ -</pre> - </td> - </tr> - </table> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> diff --git a/rep/usr/include/xapian/expanddecider.h.gcov.html b/rep/usr/include/xapian/expanddecider.h.gcov.html deleted file mode 100644 index fabaa14..0000000 --- a/rep/usr/include/xapian/expanddecider.h.gcov.html +++ /dev/null @@ -1,155 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian/expanddecider.h</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - expanddecider.h</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">1</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">100.0 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">1</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <table cellpadding=0 cellspacing=0 border=0> - <tr> - <td><br></td> - </tr> - <tr> - <td><pre class="source"> -<span class="lineNum"> 1 </span> : /** @file expanddecider.h -<span class="lineNum"> 2 </span> : * @brief Allow rejection of terms during ESet generation. -<span class="lineNum"> 3 </span> : */ -<span class="lineNum"> 4 </span> : /* Copyright (C) 2007 Olly Betts -<span class="lineNum"> 5 </span> : * -<span class="lineNum"> 6 </span> : * This program is free software; you can redistribute it and/or -<span class="lineNum"> 7 </span> : * modify it under the terms of the GNU General Public License as -<span class="lineNum"> 8 </span> : * published by the Free Software Foundation; either version 2 of the -<span class="lineNum"> 9 </span> : * License, or (at your option) any later version. -<span class="lineNum"> 10 </span> : * -<span class="lineNum"> 11 </span> : * This program is distributed in the hope that it will be useful, -<span class="lineNum"> 12 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of -<span class="lineNum"> 13 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -<span class="lineNum"> 14 </span> : * GNU General Public License for more details. -<span class="lineNum"> 15 </span> : * -<span class="lineNum"> 16 </span> : * You should have received a copy of the GNU General Public License -<span class="lineNum"> 17 </span> : * along with this program; if not, write to the Free Software -<span class="lineNum"> 18 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -<span class="lineNum"> 19 </span> : */ -<span class="lineNum"> 20 </span> : -<span class="lineNum"> 21 </span> : #ifndef XAPIAN_INCLUDED_EXPANDDECIDER_H -<span class="lineNum"> 22 </span> : #define XAPIAN_INCLUDED_EXPANDDECIDER_H -<span class="lineNum"> 23 </span> : -<span class="lineNum"> 24 </span> : #include <set> -<span class="lineNum"> 25 </span> : #include <string> -<span class="lineNum"> 26 </span> : -<span class="lineNum"> 27 </span> : #include <xapian/visibility.h> -<span class="lineNum"> 28 </span> : -<span class="lineNum"> 29 </span> : namespace Xapian { -<span class="lineNum"> 30 </span> : -<span class="lineNum"> 31 </span> : /** Virtual base class for expand decider functor. */ -<span class="lineNum"> 32 </span><span class="lineCov"> 5 : class XAPIAN_VISIBILITY_DEFAULT ExpandDecider {</span> -<span class="lineNum"> 33 </span> : public: -<span class="lineNum"> 34 </span> : /** Do we want this term in the ESet? */ -<span class="lineNum"> 35 </span> : virtual bool operator()(const std::string &term) const = 0; -<span class="lineNum"> 36 </span> : -<span class="lineNum"> 37 </span> : /** Virtual destructor, because we have virtual methods. */ -<span class="lineNum"> 38 </span> : virtual ~ExpandDecider(); -<span class="lineNum"> 39 </span> : }; -<span class="lineNum"> 40 </span> : -<span class="lineNum"> 41 </span> : /** ExpandDecider subclass which rejects terms using two ExpandDeciders. -<span class="lineNum"> 42 </span> : * -<span class="lineNum"> 43 </span> : * Terms are only accepted if they are accepted by both of the specified -<span class="lineNum"> 44 </span> : * ExpandDecider objects. -<span class="lineNum"> 45 </span> : */ -<span class="lineNum"> 46 </span> : class XAPIAN_VISIBILITY_DEFAULT ExpandDeciderAnd : public ExpandDecider { -<span class="lineNum"> 47 </span> : const ExpandDecider &first, &second; -<span class="lineNum"> 48 </span> : -<span class="lineNum"> 49 </span> : public: -<span class="lineNum"> 50 </span> : /** Terms will be checked with @a first, and if accepted, then checked -<span class="lineNum"> 51 </span> : * with @a second. -<span class="lineNum"> 52 </span> : */ -<span class="lineNum"> 53 </span> : ExpandDeciderAnd(const ExpandDecider &first_, -<span class="lineNum"> 54 </span> : const ExpandDecider &second_) -<span class="lineNum"> 55 </span> : : first(first_), second(second_) { } -<span class="lineNum"> 56 </span> : -<span class="lineNum"> 57 </span> : /** Compatibility method. */ -<span class="lineNum"> 58 </span> : ExpandDeciderAnd(const ExpandDecider *first_, -<span class="lineNum"> 59 </span> : const ExpandDecider *second_) -<span class="lineNum"> 60 </span> : : first(*first_), second(*second_) { } -<span class="lineNum"> 61 </span> : -<span class="lineNum"> 62 </span> : virtual bool operator()(const std::string &term) const; -<span class="lineNum"> 63 </span> : }; -<span class="lineNum"> 64 </span> : -<span class="lineNum"> 65 </span> : /** ExpandDecider subclass which rejects terms in a specified list. -<span class="lineNum"> 66 </span> : * -<span class="lineNum"> 67 </span> : * ExpandDeciderFilterTerms provides an easy way to filter out terms from -<span class="lineNum"> 68 </span> : * a fixed list when generating an ESet. -<span class="lineNum"> 69 </span> : */ -<span class="lineNum"> 70 </span> : class XAPIAN_VISIBILITY_DEFAULT ExpandDeciderFilterTerms : public ExpandDecider { -<span class="lineNum"> 71 </span> : std::set<std::string> rejects; -<span class="lineNum"> 72 </span> : -<span class="lineNum"> 73 </span> : public: -<span class="lineNum"> 74 </span> : /** The two iterators specify a list of terms to be rejected. -<span class="lineNum"> 75 </span> : * -<span class="lineNum"> 76 </span> : * @a reject_begin and @a reject_end can be any input_iterator type -<span class="lineNum"> 77 </span> : * which returns std::string or char * (e.g. TermIterator or char **). -<span class="lineNum"> 78 </span> : */ -<span class="lineNum"> 79 </span> : template <class Iterator> -<span class="lineNum"> 80 </span> : ExpandDeciderFilterTerms(Iterator reject_begin, Iterator reject_end) -<span class="lineNum"> 81 </span> : : rejects(reject_begin, reject_end) { } -<span class="lineNum"> 82 </span> : -<span class="lineNum"> 83 </span> : virtual bool operator()(const std::string &term) const; -<span class="lineNum"> 84 </span> : }; -<span class="lineNum"> 85 </span> : -<span class="lineNum"> 86 </span> : } -<span class="lineNum"> 87 </span> : -<span class="lineNum"> 88 </span> : #endif // XAPIAN_INCLUDED_EXPANDDECIDER_H -</pre> - </td> - </tr> - </table> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> diff --git a/rep/usr/include/xapian/index.html b/rep/usr/include/xapian/index.html deleted file mode 100644 index fbdbd2c..0000000 --- a/rep/usr/include/xapian/index.html +++ /dev/null @@ -1,173 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - /usr/include/xapian</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">77</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">76.6 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">59</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <center> - <table width="80%" cellpadding=2 cellspacing=1 border=0> - - <tr> - <td width="50%"><br></td> - <td width="15%"></td> - <td width="15%"></td> - <td width="20%"></td> - </tr> - - <tr> - <td class="tableHead">Filename</td> - <td class="tableHead" colspan=3>Coverage</td> - </tr> - - <tr> - <td class="coverFile"><a href="base.h.gcov.html">base.h</a></td> - <td class="coverBar" align="center"> - <table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../../../amber.png" width=45 height=10 alt="45.5%"><img src="../../../snow.png" width=55 height=10 alt="45.5%"></td></tr></table> - </td> - <td class="coverPerMed">45.5 %</td> - <td class="coverNumMed">5 / 11 lines</td> - </tr> - - <tr> - <td class="coverFile"><a href="database.h.gcov.html">database.h</a></td> - <td class="coverBar" align="center"> - <table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../../../emerald.png" width=100 height=10 alt="100.0%"></td></tr></table> - </td> - <td class="coverPerHi">100.0 %</td> - <td class="coverNumHi">4 / 4 lines</td> - </tr> - - <tr> - <td class="coverFile"><a href="document.h.gcov.html">document.h</a></td> - <td class="coverBar" align="center"> - <table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../../../snow.png" width=100 height=10 alt="0.0%"></td></tr></table> - </td> - <td class="coverPerLo">0.0 %</td> - <td class="coverNumLo">0 / 2 lines</td> - </tr> - - <tr> - <td class="coverFile"><a href="enquire.h.gcov.html">enquire.h</a></td> - <td class="coverBar" align="center"> - <table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../../../emerald.png" width=90 height=10 alt="89.7%"><img src="../../../snow.png" width=10 height=10 alt="89.7%"></td></tr></table> - </td> - <td class="coverPerHi">89.7 %</td> - <td class="coverNumHi">26 / 29 lines</td> - </tr> - - <tr> - <td class="coverFile"><a href="error.h.gcov.html">error.h</a></td> - <td class="coverBar" align="center"> - <table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../../../snow.png" width=100 height=10 alt="0.0%"></td></tr></table> - </td> - <td class="coverPerLo">0.0 %</td> - <td class="coverNumLo">0 / 3 lines</td> - </tr> - - <tr> - <td class="coverFile"><a href="expanddecider.h.gcov.html">expanddecider.h</a></td> - <td class="coverBar" align="center"> - <table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../../../emerald.png" width=100 height=10 alt="100.0%"></td></tr></table> - </td> - <td class="coverPerHi">100.0 %</td> - <td class="coverNumHi">1 / 1 lines</td> - </tr> - - <tr> - <td class="coverFile"><a href="postingiterator.h.gcov.html">postingiterator.h</a></td> - <td class="coverBar" align="center"> - <table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../../../emerald.png" width=100 height=10 alt="100.0%"></td></tr></table> - </td> - <td class="coverPerHi">100.0 %</td> - <td class="coverNumHi">2 / 2 lines</td> - </tr> - - <tr> - <td class="coverFile"><a href="query.h.gcov.html">query.h</a></td> - <td class="coverBar" align="center"> - <table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../../../emerald.png" width=73 height=10 alt="72.7%"><img src="../../../snow.png" width=27 height=10 alt="72.7%"></td></tr></table> - </td> - <td class="coverPerHi">72.7 %</td> - <td class="coverNumHi">8 / 11 lines</td> - </tr> - - <tr> - <td class="coverFile"><a href="termgenerator.h.gcov.html">termgenerator.h</a></td> - <td class="coverBar" align="center"> - <table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../../../emerald.png" width=100 height=10 alt="100.0%"></td></tr></table> - </td> - <td class="coverPerHi">100.0 %</td> - <td class="coverNumHi">2 / 2 lines</td> - </tr> - - <tr> - <td class="coverFile"><a href="termiterator.h.gcov.html">termiterator.h</a></td> - <td class="coverBar" align="center"> - <table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../../../emerald.png" width=100 height=10 alt="100.0%"></td></tr></table> - </td> - <td class="coverPerHi">100.0 %</td> - <td class="coverNumHi">4 / 4 lines</td> - </tr> - - <tr> - <td class="coverFile"><a href="unicode.h.gcov.html">unicode.h</a></td> - <td class="coverBar" align="center"> - <table border=0 cellspacing=0 cellpadding=1><tr><td class="coverBarOutline"><img src="../../../emerald.png" width=88 height=10 alt="87.5%"><img src="../../../snow.png" width=12 height=10 alt="87.5%"></td></tr></table> - </td> - <td class="coverPerHi">87.5 %</td> - <td class="coverNumHi">7 / 8 lines</td> - </tr> - - </table> - </center> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> diff --git a/rep/usr/include/xapian/postingiterator.h.gcov.html b/rep/usr/include/xapian/postingiterator.h.gcov.html deleted file mode 100644 index 7137a28..0000000 --- a/rep/usr/include/xapian/postingiterator.h.gcov.html +++ /dev/null @@ -1,230 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian/postingiterator.h</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - postingiterator.h</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">2</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">100.0 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">2</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <table cellpadding=0 cellspacing=0 border=0> - <tr> - <td><br></td> - </tr> - <tr> - <td><pre class="source"> -<span class="lineNum"> 1 </span> : /** \file postingiterator.h -<span class="lineNum"> 2 </span> : * \brief Classes for iterating through posting lists -<span class="lineNum"> 3 </span> : */ -<span class="lineNum"> 4 </span> : /* Copyright 1999,2000,2001 BrightStation PLC -<span class="lineNum"> 5 </span> : * Copyright 2002 Ananova Ltd -<span class="lineNum"> 6 </span> : * Copyright 2003,2004,2005,2007 Olly Betts -<span class="lineNum"> 7 </span> : * -<span class="lineNum"> 8 </span> : * This program is free software; you can redistribute it and/or -<span class="lineNum"> 9 </span> : * modify it under the terms of the GNU General Public License as -<span class="lineNum"> 10 </span> : * published by the Free Software Foundation; either version 2 of the -<span class="lineNum"> 11 </span> : * License, or (at your option) any later version. -<span class="lineNum"> 12 </span> : * -<span class="lineNum"> 13 </span> : * This program is distributed in the hope that it will be useful, -<span class="lineNum"> 14 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of -<span class="lineNum"> 15 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -<span class="lineNum"> 16 </span> : * GNU General Public License for more details. -<span class="lineNum"> 17 </span> : * -<span class="lineNum"> 18 </span> : * You should have received a copy of the GNU General Public License -<span class="lineNum"> 19 </span> : * along with this program; if not, write to the Free Software -<span class="lineNum"> 20 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 -<span class="lineNum"> 21 </span> : * USA -<span class="lineNum"> 22 </span> : */ -<span class="lineNum"> 23 </span> : -<span class="lineNum"> 24 </span> : #ifndef XAPIAN_INCLUDED_POSTINGITERATOR_H -<span class="lineNum"> 25 </span> : #define XAPIAN_INCLUDED_POSTINGITERATOR_H -<span class="lineNum"> 26 </span> : -<span class="lineNum"> 27 </span> : #include <iterator> -<span class="lineNum"> 28 </span> : #include <string> -<span class="lineNum"> 29 </span> : -<span class="lineNum"> 30 </span> : #include <xapian/base.h> -<span class="lineNum"> 31 </span> : #include <xapian/types.h> -<span class="lineNum"> 32 </span> : #include <xapian/positioniterator.h> -<span class="lineNum"> 33 </span> : #include <xapian/visibility.h> -<span class="lineNum"> 34 </span> : -<span class="lineNum"> 35 </span> : namespace Xapian { -<span class="lineNum"> 36 </span> : -<span class="lineNum"> 37 </span> : class Database; -<span class="lineNum"> 38 </span> : -<span class="lineNum"> 39 </span> : /** @internal A wrapper class for a docid which returns the docid if -<span class="lineNum"> 40 </span> : * dereferenced with *. We need this to implement input_iterator semantics. -<span class="lineNum"> 41 </span> : */ -<span class="lineNum"> 42 </span> : class DocIDWrapper { -<span class="lineNum"> 43 </span> : private: -<span class="lineNum"> 44 </span> : docid did; -<span class="lineNum"> 45 </span> : public: -<span class="lineNum"> 46 </span> : explicit DocIDWrapper(docid did_) : did(did_) { } -<span class="lineNum"> 47 </span> : docid operator*() const { return did; } -<span class="lineNum"> 48 </span> : }; -<span class="lineNum"> 49 </span> : -<span class="lineNum"> 50 </span> : /** An iterator pointing to items in a list of postings. -<span class="lineNum"> 51 </span> : */ -<span class="lineNum"> 52 </span> : class XAPIAN_VISIBILITY_DEFAULT PostingIterator { -<span class="lineNum"> 53 </span> : public: -<span class="lineNum"> 54 </span> : class Internal; -<span class="lineNum"> 55 </span> : /// @private @internal Reference counted internals. -<span class="lineNum"> 56 </span> : Xapian::Internal::RefCntPtr<Internal> internal; -<span class="lineNum"> 57 </span> : -<span class="lineNum"> 58 </span> : private: -<span class="lineNum"> 59 </span> : friend class Database; // So Database can construct us -<span class="lineNum"> 60 </span> : -<span class="lineNum"> 61 </span> : explicit PostingIterator(Internal *internal_); -<span class="lineNum"> 62 </span> : -<span class="lineNum"> 63 </span> : public: -<span class="lineNum"> 64 </span> : friend bool operator==(const PostingIterator &a, -<span class="lineNum"> 65 </span> : const PostingIterator &b); -<span class="lineNum"> 66 </span> : -<span class="lineNum"> 67 </span> : /// Default constructor - for declaring an uninitialised iterator -<span class="lineNum"> 68 </span> : PostingIterator(); -<span class="lineNum"> 69 </span> : -<span class="lineNum"> 70 </span> : /// Destructor -<span class="lineNum"> 71 </span> : ~PostingIterator(); -<span class="lineNum"> 72 </span> : -<span class="lineNum"> 73 </span> : /** Copying is allowed. The internals are reference counted, so -<span class="lineNum"> 74 </span> : * copying is also cheap. -<span class="lineNum"> 75 </span> : */ -<span class="lineNum"> 76 </span> : PostingIterator(const PostingIterator &other); -<span class="lineNum"> 77 </span> : -<span class="lineNum"> 78 </span> : /** Assignment is allowed. The internals are reference counted, -<span class="lineNum"> 79 </span> : * so assignment is also cheap. -<span class="lineNum"> 80 </span> : */ -<span class="lineNum"> 81 </span> : void operator=(const PostingIterator &other); -<span class="lineNum"> 82 </span> : -<span class="lineNum"> 83 </span> : PostingIterator & operator++(); -<span class="lineNum"> 84 </span> : -<span class="lineNum"> 85 </span> : DocIDWrapper operator++(int) { -<span class="lineNum"> 86 </span> : Xapian::docid tmp = **this; -<span class="lineNum"> 87 </span> : operator++(); -<span class="lineNum"> 88 </span> : return DocIDWrapper(tmp); -<span class="lineNum"> 89 </span> : } -<span class="lineNum"> 90 </span> : -<span class="lineNum"> 91 </span> : /** Skip the iterator to document did, or the first document after did -<span class="lineNum"> 92 </span> : * if did isn't in the list of documents being iterated. -<span class="lineNum"> 93 </span> : */ -<span class="lineNum"> 94 </span> : void skip_to(Xapian::docid did); -<span class="lineNum"> 95 </span> : -<span class="lineNum"> 96 </span> : // Get the weight of the posting at the current position: will -<span class="lineNum"> 97 </span> : // need to set a weight object for this to work. -<span class="lineNum"> 98 </span> : // Xapian::weight get_weight() const; -<span class="lineNum"> 99 </span> : -<span class="lineNum"> 100 </span> : /// Get the document id at the current position in the postlist. -<span class="lineNum"> 101 </span> : Xapian::docid operator *() const; -<span class="lineNum"> 102 </span> : -<span class="lineNum"> 103 </span> : /** Get the length of the document at the current position in the -<span class="lineNum"> 104 </span> : * postlist. -<span class="lineNum"> 105 </span> : * -<span class="lineNum"> 106 </span> : * This information may be stored in the postlist, in which case -<span class="lineNum"> 107 </span> : * this lookup should be extremely fast (indeed, not require further -<span class="lineNum"> 108 </span> : * disk access). If the information is not present in the postlist, -<span class="lineNum"> 109 </span> : * it will be retrieved from the database, at a greater performance -<span class="lineNum"> 110 </span> : * cost. -<span class="lineNum"> 111 </span> : */ -<span class="lineNum"> 112 </span> : Xapian::doclength get_doclength() const; -<span class="lineNum"> 113 </span> : -<span class="lineNum"> 114 </span> : /** Get the within document frequency of the document at the -<span class="lineNum"> 115 </span> : * current position in the postlist. -<span class="lineNum"> 116 </span> : */ -<span class="lineNum"> 117 </span> : Xapian::termcount get_wdf() const; -<span class="lineNum"> 118 </span> : -<span class="lineNum"> 119 </span> : /** Return PositionIterator pointing to start of positionlist for -<span class="lineNum"> 120 </span> : * current document. -<span class="lineNum"> 121 </span> : */ -<span class="lineNum"> 122 </span> : PositionIterator positionlist_begin() const; -<span class="lineNum"> 123 </span> : -<span class="lineNum"> 124 </span> : /** Return PositionIterator pointing to end of positionlist for -<span class="lineNum"> 125 </span> : * current document. -<span class="lineNum"> 126 </span> : */ -<span class="lineNum"> 127 </span> : PositionIterator positionlist_end() const { -<span class="lineNum"> 128 </span> : return PositionIterator(NULL); -<span class="lineNum"> 129 </span> : } -<span class="lineNum"> 130 </span> : -<span class="lineNum"> 131 </span> : // Don't expose these methods here. A container iterator doesn't -<span class="lineNum"> 132 </span> : // provide a method to find the size of the container... -<span class="lineNum"> 133 </span> : // Xapian::doccount get_termfreq() const; -<span class="lineNum"> 134 </span> : // Xapian::termcount get_collection_freq() const; -<span class="lineNum"> 135 </span> : -<span class="lineNum"> 136 </span> : /// Return a string describing this object. -<span class="lineNum"> 137 </span> : std::string get_description() const; -<span class="lineNum"> 138 </span> : -<span class="lineNum"> 139 </span> : /// Allow use as an STL iterator -<span class="lineNum"> 140 </span> : //@{ -<span class="lineNum"> 141 </span> : typedef std::input_iterator_tag iterator_category; -<span class="lineNum"> 142 </span> : typedef Xapian::docid value_type; -<span class="lineNum"> 143 </span> : typedef Xapian::doccount_diff difference_type; -<span class="lineNum"> 144 </span> : typedef Xapian::docid * pointer; -<span class="lineNum"> 145 </span> : typedef Xapian::docid & reference; -<span class="lineNum"> 146 </span> : //@} -<span class="lineNum"> 147 </span> : }; -<span class="lineNum"> 148 </span> : -<span class="lineNum"> 149 </span> : /// Test equality of two PostingIterators -<span class="lineNum"> 150 </span><span class="lineCov"> 10 : inline bool operator==(const PostingIterator &a, const PostingIterator &b)</span> -<span class="lineNum"> 151 </span> : { -<span class="lineNum"> 152 </span><span class="lineCov"> 10 : return (a.internal.get() == b.internal.get());</span> -<span class="lineNum"> 153 </span> : } -<span class="lineNum"> 154 </span> : -<span class="lineNum"> 155 </span> : /// Test inequality of two PostingIterators -<span class="lineNum"> 156 </span> : inline bool operator!=(const PostingIterator &a, const PostingIterator &b) -<span class="lineNum"> 157 </span> : { -<span class="lineNum"> 158 </span> : return !(a == b); -<span class="lineNum"> 159 </span> : } -<span class="lineNum"> 160 </span> : -<span class="lineNum"> 161 </span> : } -<span class="lineNum"> 162 </span> : -<span class="lineNum"> 163 </span> : #endif /* XAPIAN_INCLUDED_POSTINGITERATOR_H */ -</pre> - </td> - </tr> - </table> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> diff --git a/rep/usr/include/xapian/query.h.gcov.html b/rep/usr/include/xapian/query.h.gcov.html deleted file mode 100644 index da0ec8e..0000000 --- a/rep/usr/include/xapian/query.h.gcov.html +++ /dev/null @@ -1,520 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian/query.h</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - query.h</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">11</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">72.7 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">8</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <table cellpadding=0 cellspacing=0 border=0> - <tr> - <td><br></td> - </tr> - <tr> - <td><pre class="source"> -<span class="lineNum"> 1 </span> : /** \file query.h -<span class="lineNum"> 2 </span> : * \brief Classes for representing a query -<span class="lineNum"> 3 </span> : */ -<span class="lineNum"> 4 </span> : /* Copyright 1999,2000,2001 BrightStation PLC -<span class="lineNum"> 5 </span> : * Copyright 2002 Ananova Ltd -<span class="lineNum"> 6 </span> : * Copyright 2003,2004,2005,2006,2007 Olly Betts -<span class="lineNum"> 7 </span> : * Copyright 2006,2007,2008 Lemur Consulting Ltd -<span class="lineNum"> 8 </span> : * -<span class="lineNum"> 9 </span> : * This program is free software; you can redistribute it and/or -<span class="lineNum"> 10 </span> : * modify it under the terms of the GNU General Public License as -<span class="lineNum"> 11 </span> : * published by the Free Software Foundation; either version 2 of the -<span class="lineNum"> 12 </span> : * License, or (at your option) any later version. -<span class="lineNum"> 13 </span> : * -<span class="lineNum"> 14 </span> : * This program is distributed in the hope that it will be useful, -<span class="lineNum"> 15 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of -<span class="lineNum"> 16 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -<span class="lineNum"> 17 </span> : * GNU General Public License for more details. -<span class="lineNum"> 18 </span> : * -<span class="lineNum"> 19 </span> : * You should have received a copy of the GNU General Public License -<span class="lineNum"> 20 </span> : * along with this program; if not, write to the Free Software -<span class="lineNum"> 21 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 -<span class="lineNum"> 22 </span> : * USA -<span class="lineNum"> 23 </span> : */ -<span class="lineNum"> 24 </span> : -<span class="lineNum"> 25 </span> : #ifndef XAPIAN_INCLUDED_QUERY_H -<span class="lineNum"> 26 </span> : #define XAPIAN_INCLUDED_QUERY_H -<span class="lineNum"> 27 </span> : -<span class="lineNum"> 28 </span> : #include <string> -<span class="lineNum"> 29 </span> : #include <vector> -<span class="lineNum"> 30 </span> : -<span class="lineNum"> 31 </span> : #include <xapian/base.h> -<span class="lineNum"> 32 </span> : #include <xapian/deprecated.h> -<span class="lineNum"> 33 </span> : #include <xapian/types.h> -<span class="lineNum"> 34 </span> : #include <xapian/termiterator.h> -<span class="lineNum"> 35 </span> : #include <xapian/visibility.h> -<span class="lineNum"> 36 </span> : -<span class="lineNum"> 37 </span> : // FIXME: sort this out so we avoid exposing Xapian::Query::Internal -<span class="lineNum"> 38 </span> : // - we need to at present so that the Xapian::Query's template ctors -<span class="lineNum"> 39 </span> : // compile. -<span class="lineNum"> 40 </span> : class LocalSubMatch; -<span class="lineNum"> 41 </span> : class MultiMatch; -<span class="lineNum"> 42 </span> : class QueryOptimiser; -<span class="lineNum"> 43 </span> : struct SortPosName; -<span class="lineNum"> 44 </span> : -<span class="lineNum"> 45 </span> : namespace Xapian { -<span class="lineNum"> 46 </span> : -<span class="lineNum"> 47 </span> : /** Class representing a query. -<span class="lineNum"> 48 </span> : * -<span class="lineNum"> 49 </span> : * Queries are represented as a tree of objects. -<span class="lineNum"> 50 </span> : */ -<span class="lineNum"> 51 </span> : class XAPIAN_VISIBILITY_DEFAULT Query { -<span class="lineNum"> 52 </span> : public: -<span class="lineNum"> 53 </span> : /// Class holding details of the query -<span class="lineNum"> 54 </span> : class Internal; -<span class="lineNum"> 55 </span> : /// @private @internal Reference counted internals. -<span class="lineNum"> 56 </span> : Xapian::Internal::RefCntPtr<Internal> internal; -<span class="lineNum"> 57 </span> : -<span class="lineNum"> 58 </span> : /// Enum of possible query operations -<span class="lineNum"> 59 </span> : typedef enum { -<span class="lineNum"> 60 </span> : /// Return iff both subqueries are satisfied -<span class="lineNum"> 61 </span> : OP_AND, -<span class="lineNum"> 62 </span> : -<span class="lineNum"> 63 </span> : /// Return if either subquery is satisfied -<span class="lineNum"> 64 </span> : OP_OR, -<span class="lineNum"> 65 </span> : -<span class="lineNum"> 66 </span> : /// Return if left but not right satisfied -<span class="lineNum"> 67 </span> : OP_AND_NOT, -<span class="lineNum"> 68 </span> : -<span class="lineNum"> 69 </span> : /// Return if one query satisfied, but not both -<span class="lineNum"> 70 </span> : OP_XOR, -<span class="lineNum"> 71 </span> : -<span class="lineNum"> 72 </span> : /// Return iff left satisfied, but use weights from both -<span class="lineNum"> 73 </span> : OP_AND_MAYBE, -<span class="lineNum"> 74 </span> : -<span class="lineNum"> 75 </span> : /// As AND, but use only weights from left subquery -<span class="lineNum"> 76 </span> : OP_FILTER, -<span class="lineNum"> 77 </span> : -<span class="lineNum"> 78 </span> : /** Find occurrences of a list of terms with all the terms -<span class="lineNum"> 79 </span> : * occurring within a specified window of positions. -<span class="lineNum"> 80 </span> : * Each occurrence of a term must be at a different position, -<span class="lineNum"> 81 </span> : * but the order they appear in is irrelevant. -<span class="lineNum"> 82 </span> : * -<span class="lineNum"> 83 </span> : * The window parameter should be specified for this operation, -<span class="lineNum"> 84 </span> : * but will default to the number of terms in the list. -<span class="lineNum"> 85 </span> : */ -<span class="lineNum"> 86 </span> : OP_NEAR, -<span class="lineNum"> 87 </span> : -<span class="lineNum"> 88 </span> : /** Find occurrences of a list of terms with all the terms -<span class="lineNum"> 89 </span> : * occurring within a specified window of positions, and all -<span class="lineNum"> 90 </span> : * the terms appearing in the order specified. Each occurrence -<span class="lineNum"> 91 </span> : * of a term must be at a different position. -<span class="lineNum"> 92 </span> : * -<span class="lineNum"> 93 </span> : * The window parameter should be specified for this operation, -<span class="lineNum"> 94 </span> : * but will default to the number of terms in the list. -<span class="lineNum"> 95 </span> : */ -<span class="lineNum"> 96 </span> : OP_PHRASE, -<span class="lineNum"> 97 </span> : -<span class="lineNum"> 98 </span> : /** Filter by a range test on a document value. */ -<span class="lineNum"> 99 </span> : OP_VALUE_RANGE, -<span class="lineNum"> 100 </span> : -<span class="lineNum"> 101 </span> : /** Scale the weight of a subquery by the specified factor. -<span class="lineNum"> 102 </span> : * -<span class="lineNum"> 103 </span> : * A factor of 0 means this subquery will contribute no weight to -<span class="lineNum"> 104 </span> : * the query - it will act as a purely boolean subquery. -<span class="lineNum"> 105 </span> : * -<span class="lineNum"> 106 </span> : * If the factor is negative, Xapian::InvalidArgumentError will -<span class="lineNum"> 107 </span> : * be thrown. -<span class="lineNum"> 108 </span> : */ -<span class="lineNum"> 109 </span> : OP_SCALE_WEIGHT, -<span class="lineNum"> 110 </span> : -<span class="lineNum"> 111 </span> : /** Select an elite set from the subqueries, and perform -<span class="lineNum"> 112 </span> : * a query with these combined as an OR query. -<span class="lineNum"> 113 </span> : */ -<span class="lineNum"> 114 </span> : OP_ELITE_SET, -<span class="lineNum"> 115 </span> : -<span class="lineNum"> 116 </span> : /** Filter by a greater-than-or-equal test on a document value. */ -<span class="lineNum"> 117 </span> : OP_VALUE_GE, -<span class="lineNum"> 118 </span> : -<span class="lineNum"> 119 </span> : /** Filter by a less-than-or-equal test on a document value. */ -<span class="lineNum"> 120 </span> : OP_VALUE_LE -<span class="lineNum"> 121 </span> : } op; -<span class="lineNum"> 122 </span> : -<span class="lineNum"> 123 </span> : /** Copy constructor. */ -<span class="lineNum"> 124 </span> : Query(const Query & copyme); -<span class="lineNum"> 125 </span> : -<span class="lineNum"> 126 </span> : /** Assignment. */ -<span class="lineNum"> 127 </span> : Query & operator=(const Query & copyme); -<span class="lineNum"> 128 </span> : -<span class="lineNum"> 129 </span> : /** Default constructor: makes an empty query which matches no -<span class="lineNum"> 130 </span> : * documents. -<span class="lineNum"> 131 </span> : * -<span class="lineNum"> 132 </span> : * Also useful for defining a Query object to be assigned to later. -<span class="lineNum"> 133 </span> : * -<span class="lineNum"> 134 </span> : * An exception will be thrown if an attempt is made to use an -<span class="lineNum"> 135 </span> : * undefined query when building up a composite query. -<span class="lineNum"> 136 </span> : */ -<span class="lineNum"> 137 </span> : Query(); -<span class="lineNum"> 138 </span> : -<span class="lineNum"> 139 </span> : /** Destructor. */ -<span class="lineNum"> 140 </span> : ~Query(); -<span class="lineNum"> 141 </span> : -<span class="lineNum"> 142 </span> : /** A query consisting of a single term. */ -<span class="lineNum"> 143 </span> : Query(const std::string & tname_, Xapian::termcount wqf_ = 1, -<span class="lineNum"> 144 </span> : Xapian::termpos pos_ = 0); -<span class="lineNum"> 145 </span> : -<span class="lineNum"> 146 </span> : /** A query consisting of two subqueries, opp-ed together. */ -<span class="lineNum"> 147 </span> : Query(Query::op op_, const Query & left, const Query & right); -<span class="lineNum"> 148 </span> : -<span class="lineNum"> 149 </span> : /** A query consisting of two termnames opp-ed together. */ -<span class="lineNum"> 150 </span> : Query(Query::op op_, -<span class="lineNum"> 151 </span> : const std::string & left, const std::string & right); -<span class="lineNum"> 152 </span> : -<span class="lineNum"> 153 </span> : /** Combine a number of Xapian::Query-s with the specified operator. -<span class="lineNum"> 154 </span> : * -<span class="lineNum"> 155 </span> : * The Xapian::Query objects are specified with begin and end -<span class="lineNum"> 156 </span> : * iterators. -<span class="lineNum"> 157 </span> : * -<span class="lineNum"> 158 </span> : * AND, OR, NEAR and PHRASE can take any number of subqueries. -<span class="lineNum"> 159 </span> : * Other operators take exactly two subqueries. -<span class="lineNum"> 160 </span> : * -<span class="lineNum"> 161 </span> : * The iterators may be to Xapian::Query objects, pointers to -<span class="lineNum"> 162 </span> : * Xapian::Query objects, or termnames (std::string-s). -<span class="lineNum"> 163 </span> : * -<span class="lineNum"> 164 </span> : * For NEAR and PHRASE, a window size can be specified in parameter. -<span class="lineNum"> 165 </span> : * -<span class="lineNum"> 166 </span> : * For ELITE_SET, the elite set size can be specified in parameter. -<span class="lineNum"> 167 </span> : */ -<span class="lineNum"> 168 </span> : template <class Iterator> -<span class="lineNum"> 169 </span> : Query(Query::op op_, Iterator qbegin, Iterator qend, -<span class="lineNum"> 170 </span> : Xapian::termcount parameter = 0); -<span class="lineNum"> 171 </span> : -<span class="lineNum"> 172 </span> : /** Apply the specified operator to a single Xapian::Query object. -<span class="lineNum"> 173 </span> : * -<span class="lineNum"> 174 </span> : * @deprecated This method is deprecated because it isn't useful, -<span class="lineNum"> 175 </span> : * since none of the current query operators can be usefully -<span class="lineNum"> 176 </span> : * applied to a single subquery with a parameter value. -<span class="lineNum"> 177 </span> : */ -<span class="lineNum"> 178 </span> : XAPIAN_DEPRECATED(Query(Query::op op_, Xapian::Query q)); -<span class="lineNum"> 179 </span> : -<span class="lineNum"> 180 </span> : /** Apply the specified operator to a single Xapian::Query object, with -<span class="lineNum"> 181 </span> : * a double parameter. -<span class="lineNum"> 182 </span> : */ -<span class="lineNum"> 183 </span> : Query(Query::op op_, Xapian::Query q, double parameter); -<span class="lineNum"> 184 </span> : -<span class="lineNum"> 185 </span> : /** Construct a value range query on a document value. -<span class="lineNum"> 186 </span> : * -<span class="lineNum"> 187 </span> : * A value range query matches those documents which have a value -<span class="lineNum"> 188 </span> : * stored in the slot given by @a valno which is in the range -<span class="lineNum"> 189 </span> : * specified by @a begin and @a end (in lexicographical -<span class="lineNum"> 190 </span> : * order), including the endpoints. -<span class="lineNum"> 191 </span> : * -<span class="lineNum"> 192 </span> : * @param op_ The operator to use for the query. Currently, must -<span class="lineNum"> 193 </span> : * be OP_VALUE_RANGE. -<span class="lineNum"> 194 </span> : * @param valno The slot number to get the value from. -<span class="lineNum"> 195 </span> : * @param begin The start of the range. -<span class="lineNum"> 196 </span> : * @param end The end of the range. -<span class="lineNum"> 197 </span> : */ -<span class="lineNum"> 198 </span> : Query(Query::op op_, Xapian::valueno valno, -<span class="lineNum"> 199 </span> : const std::string &begin, const std::string &end); -<span class="lineNum"> 200 </span> : -<span class="lineNum"> 201 </span> : /** Construct a value comparison query on a document value. -<span class="lineNum"> 202 </span> : * -<span class="lineNum"> 203 </span> : * This query matches those documents which have a value stored in the -<span class="lineNum"> 204 </span> : * slot given by @a valno which compares, as specified by the -<span class="lineNum"> 205 </span> : * operator, to @a value. -<span class="lineNum"> 206 </span> : * -<span class="lineNum"> 207 </span> : * @param op_ The operator to use for the query. Currently, must -<span class="lineNum"> 208 </span> : * be OP_VALUE_GE or OP_VALUE_LE. -<span class="lineNum"> 209 </span> : * @param valno The slot number to get the value from. -<span class="lineNum"> 210 </span> : * @param value The value to compare. -<span class="lineNum"> 211 </span> : */ -<span class="lineNum"> 212 </span> : Query(Query::op op_, Xapian::valueno valno, const std::string &value); -<span class="lineNum"> 213 </span> : -<span class="lineNum"> 214 </span> : /** A query which matches all documents in the database. */ -<span class="lineNum"> 215 </span> : static Xapian::Query MatchAll; -<span class="lineNum"> 216 </span> : -<span class="lineNum"> 217 </span> : /** A query which matches no documents. */ -<span class="lineNum"> 218 </span> : static Xapian::Query MatchNothing; -<span class="lineNum"> 219 </span> : -<span class="lineNum"> 220 </span> : /** Get the length of the query, used by some ranking formulae. -<span class="lineNum"> 221 </span> : * This value is calculated automatically - if you want to override -<span class="lineNum"> 222 </span> : * it you can pass a different value to Enquire::set_query(). -<span class="lineNum"> 223 </span> : */ -<span class="lineNum"> 224 </span> : Xapian::termcount get_length() const; -<span class="lineNum"> 225 </span> : -<span class="lineNum"> 226 </span> : /** Return a Xapian::TermIterator returning all the terms in the query, -<span class="lineNum"> 227 </span> : * in order of termpos. If multiple terms have the same term -<span class="lineNum"> 228 </span> : * position, their order is unspecified. Duplicates (same term and -<span class="lineNum"> 229 </span> : * termpos) will be removed. -<span class="lineNum"> 230 </span> : */ -<span class="lineNum"> 231 </span> : TermIterator get_terms_begin() const; -<span class="lineNum"> 232 </span> : -<span class="lineNum"> 233 </span> : /** Return a Xapian::TermIterator to the end of the list of terms in the -<span class="lineNum"> 234 </span> : * query. -<span class="lineNum"> 235 </span> : */ -<span class="lineNum"> 236 </span> : TermIterator get_terms_end() const { -<span class="lineNum"> 237 </span> : return TermIterator(NULL); -<span class="lineNum"> 238 </span> : } -<span class="lineNum"> 239 </span> : -<span class="lineNum"> 240 </span> : /** Test if the query is empty (i.e. was constructed using -<span class="lineNum"> 241 </span> : * the default ctor or with an empty iterator ctor). -<span class="lineNum"> 242 </span> : */ -<span class="lineNum"> 243 </span> : bool empty() const; -<span class="lineNum"> 244 </span> : -<span class="lineNum"> 245 </span> : /// Return a string describing this object. -<span class="lineNum"> 246 </span> : std::string get_description() const; -<span class="lineNum"> 247 </span> : -<span class="lineNum"> 248 </span> : private: -<span class="lineNum"> 249 </span> : void add_subquery(const Query & subq); -<span class="lineNum"> 250 </span> : void add_subquery(const Query * subq); -<span class="lineNum"> 251 </span> : void add_subquery(const std::string & tname); -<span class="lineNum"> 252 </span> : void start_construction(Query::op op_, Xapian::termcount parameter); -<span class="lineNum"> 253 </span> : void end_construction(); -<span class="lineNum"> 254 </span> : void abort_construction(); -<span class="lineNum"> 255 </span> : }; -<span class="lineNum"> 256 </span> : -<span class="lineNum"> 257 </span> : template <class Iterator> -<span class="lineNum"> 258 </span><span class="lineCov"> 19 : Query::Query(Query::op op_, Iterator qbegin, Iterator qend, termcount parameter)</span> -<span class="lineNum"> 259 </span><span class="lineCov"> 19 : : internal(0)</span> -<span class="lineNum"> 260 </span> : { -<span class="lineNum"> 261 </span> : try { -<span class="lineNum"> 262 </span><span class="lineCov"> 19 : start_construction(op_, parameter);</span> -<span class="lineNum"> 263 </span> : -<span class="lineNum"> 264 </span> : /* Add all the elements */ -<span class="lineNum"> 265 </span><span class="lineCov"> 61 : while (qbegin != qend) {</span> -<span class="lineNum"> 266 </span><span class="lineCov"> 23 : add_subquery(*qbegin);</span> -<span class="lineNum"> 267 </span><span class="lineCov"> 23 : ++qbegin;</span> -<span class="lineNum"> 268 </span> : } -<span class="lineNum"> 269 </span> : -<span class="lineNum"> 270 </span><span class="lineCov"> 19 : end_construction();</span> -<span class="lineNum"> 271 </span><span class="lineNoCov"> 0 : } catch (...) {</span> -<span class="lineNum"> 272 </span><span class="lineNoCov"> 0 : abort_construction();</span> -<span class="lineNum"> 273 </span><span class="lineNoCov"> 0 : throw;</span> -<span class="lineNum"> 274 </span> : } -<span class="lineNum"> 275 </span><span class="lineCov"> 19 : }</span> -<span class="lineNum"> 276 </span> : -<span class="lineNum"> 277 </span> : /// @internal Internal class, implementing most of Xapian::Query. -<span class="lineNum"> 278 </span> : class XAPIAN_VISIBILITY_DEFAULT Query::Internal : public Xapian::Internal::RefCntBase { -<span class="lineNum"> 279 </span> : friend class ::LocalSubMatch; -<span class="lineNum"> 280 </span> : friend class ::MultiMatch; -<span class="lineNum"> 281 </span> : friend class ::QueryOptimiser; -<span class="lineNum"> 282 </span> : friend struct ::SortPosName; -<span class="lineNum"> 283 </span> : friend class Query; -<span class="lineNum"> 284 </span> : public: -<span class="lineNum"> 285 </span> : static const int OP_LEAF = -1; -<span class="lineNum"> 286 </span> : -<span class="lineNum"> 287 </span> : /// The container type for storing pointers to subqueries -<span class="lineNum"> 288 </span> : typedef std::vector<Internal *> subquery_list; -<span class="lineNum"> 289 </span> : -<span class="lineNum"> 290 </span> : /// Type storing the operation -<span class="lineNum"> 291 </span> : typedef int op_t; -<span class="lineNum"> 292 </span> : -<span class="lineNum"> 293 </span> : private: -<span class="lineNum"> 294 </span> : /// Operation to be performed at this node -<span class="lineNum"> 295 </span> : Xapian::Query::Internal::op_t op; -<span class="lineNum"> 296 </span> : -<span class="lineNum"> 297 </span> : /// Sub queries on which to perform operation -<span class="lineNum"> 298 </span> : subquery_list subqs; -<span class="lineNum"> 299 </span> : -<span class="lineNum"> 300 </span> : /** For NEAR or PHRASE, how close terms must be to match: all terms -<span class="lineNum"> 301 </span> : * within the operation must occur in a window of this size. -<span class="lineNum"> 302 </span> : * -<span class="lineNum"> 303 </span> : * For ELITE_SET, the number of terms to select from those specified. -<span class="lineNum"> 304 </span> : * -<span class="lineNum"> 305 </span> : * For RANGE, the value number to apply the range test to. -<span class="lineNum"> 306 </span> : */ -<span class="lineNum"> 307 </span> : Xapian::termcount parameter; -<span class="lineNum"> 308 </span> : -<span class="lineNum"> 309 </span> : /** Term that this node represents, or start of a range query. -<span class="lineNum"> 310 </span> : * -<span class="lineNum"> 311 </span> : * For a leaf node, this holds the term name. For an OP_VALUE_RANGE -<span class="lineNum"> 312 </span> : * query this holds the start of the range. For an OP_VALUE_GE or -<span class="lineNum"> 313 </span> : * OP_VALUE_LE query this holds the value to compare against. -<span class="lineNum"> 314 </span> : */ -<span class="lineNum"> 315 </span> : std::string tname; -<span class="lineNum"> 316 </span> : -<span class="lineNum"> 317 </span> : /** Used to store the end of a range query. */ -<span class="lineNum"> 318 </span> : std::string str_parameter; -<span class="lineNum"> 319 </span> : -<span class="lineNum"> 320 </span> : /// Position in query of this term - leaf node only -<span class="lineNum"> 321 </span> : Xapian::termpos term_pos; -<span class="lineNum"> 322 </span> : -<span class="lineNum"> 323 </span> : /// Within query frequency of this term - leaf node only -<span class="lineNum"> 324 </span> : Xapian::termcount wqf; -<span class="lineNum"> 325 </span> : -<span class="lineNum"> 326 </span> : /** swap the contents of this with another Xapian::Query::Internal, -<span class="lineNum"> 327 </span> : * in a way which is guaranteed not to throw. This is -<span class="lineNum"> 328 </span> : * used with the assignment operator to make it exception -<span class="lineNum"> 329 </span> : * safe. -<span class="lineNum"> 330 </span> : * It's important to adjust swap with any addition of -<span class="lineNum"> 331 </span> : * member variables! -<span class="lineNum"> 332 </span> : */ -<span class="lineNum"> 333 </span> : void swap(Query::Internal &other); -<span class="lineNum"> 334 </span> : -<span class="lineNum"> 335 </span> : /// Copy another Xapian::Query::Internal into self. -<span class="lineNum"> 336 </span> : void initialise_from_copy(const Query::Internal & copyme); -<span class="lineNum"> 337 </span> : -<span class="lineNum"> 338 </span> : void accumulate_terms( -<span class="lineNum"> 339 </span> : std::vector<std::pair<std::string, Xapian::termpos> > &terms) const; -<span class="lineNum"> 340 </span> : -<span class="lineNum"> 341 </span> : /** Simplify the query. -<span class="lineNum"> 342 </span> : * For example, an AND query with only one subquery would become the -<span class="lineNum"> 343 </span> : * subquery itself. -<span class="lineNum"> 344 </span> : */ -<span class="lineNum"> 345 </span> : Internal * simplify_query(); -<span class="lineNum"> 346 </span> : -<span class="lineNum"> 347 </span> : /** Perform checks that query is valid. (eg, has correct number of -<span class="lineNum"> 348 </span> : * sub queries.) Throw an exception if not. This is initially called -<span class="lineNum"> 349 </span> : * on the query before any simplifications have been made, and after -<span class="lineNum"> 350 </span> : * simplications. -<span class="lineNum"> 351 </span> : */ -<span class="lineNum"> 352 </span> : void validate_query() const; -<span class="lineNum"> 353 </span> : -<span class="lineNum"> 354 </span> : /** Simplify any matchnothing subqueries, either eliminating them, -<span class="lineNum"> 355 </span> : * or setting this query to matchnothing, depending on the query -<span class="lineNum"> 356 </span> : * operator. Returns true if simplification resulted in a -<span class="lineNum"> 357 </span> : * matchnothing query. -<span class="lineNum"> 358 </span> : */ -<span class="lineNum"> 359 </span> : bool simplify_matchnothing(); -<span class="lineNum"> 360 </span> : -<span class="lineNum"> 361 </span> : /** Get a string describing the given query type. -<span class="lineNum"> 362 </span> : */ -<span class="lineNum"> 363 </span> : static std::string get_op_name(Xapian::Query::Internal::op_t op); -<span class="lineNum"> 364 </span> : -<span class="lineNum"> 365 </span> : /** Collapse the subqueries together if appropriate. -<span class="lineNum"> 366 </span> : */ -<span class="lineNum"> 367 </span> : void collapse_subqs(); -<span class="lineNum"> 368 </span> : -<span class="lineNum"> 369 </span> : /** Flatten a query structure, by changing, for example, -<span class="lineNum"> 370 </span> : * "A NEAR (B AND C)" to "(A NEAR B) AND (A NEAR C)" -<span class="lineNum"> 371 </span> : */ -<span class="lineNum"> 372 </span> : void flatten_subqs(); -<span class="lineNum"> 373 </span> : -<span class="lineNum"> 374 </span> : /** Implementation of serialisation; called recursively. -<span class="lineNum"> 375 </span> : */ -<span class="lineNum"> 376 </span> : std::string serialise(Xapian::termpos & curpos) const; -<span class="lineNum"> 377 </span> : -<span class="lineNum"> 378 </span> : public: -<span class="lineNum"> 379 </span> : /** Copy constructor. */ -<span class="lineNum"> 380 </span> : Internal(const Query::Internal & copyme); -<span class="lineNum"> 381 </span> : -<span class="lineNum"> 382 </span> : /** Assignment. */ -<span class="lineNum"> 383 </span> : void operator=(const Query::Internal & copyme); -<span class="lineNum"> 384 </span> : -<span class="lineNum"> 385 </span> : /** A query consisting of a single term. */ -<span class="lineNum"> 386 </span> : explicit Internal(const std::string & tname_, Xapian::termcount wqf_ = 1, -<span class="lineNum"> 387 </span> : Xapian::termpos term_pos_ = 0); -<span class="lineNum"> 388 </span> : -<span class="lineNum"> 389 </span> : /** Create internals given only the operator and a parameter. */ -<span class="lineNum"> 390 </span> : Internal(op_t op_, Xapian::termcount parameter); -<span class="lineNum"> 391 </span> : -<span class="lineNum"> 392 </span> : /** Construct a range query on a document value. */ -<span class="lineNum"> 393 </span> : Internal(op_t op_, Xapian::valueno valno, -<span class="lineNum"> 394 </span> : const std::string &begin, const std::string &end); -<span class="lineNum"> 395 </span> : -<span class="lineNum"> 396 </span> : /** Construct a value greater-than-or-equal query on a document value. -<span class="lineNum"> 397 </span> : */ -<span class="lineNum"> 398 </span> : Internal(op_t op_, Xapian::valueno valno, const std::string &value); -<span class="lineNum"> 399 </span> : -<span class="lineNum"> 400 </span> : /** Destructor. */ -<span class="lineNum"> 401 </span> : ~Internal(); -<span class="lineNum"> 402 </span> : -<span class="lineNum"> 403 </span> : static Xapian::Query::Internal * unserialise(const std::string &s); -<span class="lineNum"> 404 </span> : -<span class="lineNum"> 405 </span> : /** Add a subquery. -<span class="lineNum"> 406 </span> : */ -<span class="lineNum"> 407 </span> : void add_subquery(const Query::Internal * subq); -<span class="lineNum"> 408 </span> : -<span class="lineNum"> 409 </span> : void set_dbl_parameter(double dbl_parameter_); -<span class="lineNum"> 410 </span> : -<span class="lineNum"> 411 </span> : double get_dbl_parameter() const; -<span class="lineNum"> 412 </span> : -<span class="lineNum"> 413 </span> : /** Finish off the construction. -<span class="lineNum"> 414 </span> : */ -<span class="lineNum"> 415 </span> : Query::Internal * end_construction(); -<span class="lineNum"> 416 </span> : -<span class="lineNum"> 417 </span> : /** Return a string in an easily parsed form -<span class="lineNum"> 418 </span> : * which contains all the information in a query. -<span class="lineNum"> 419 </span> : */ -<span class="lineNum"> 420 </span> : std::string serialise() const { -<span class="lineNum"> 421 </span> : Xapian::termpos curpos = 1; -<span class="lineNum"> 422 </span> : return serialise(curpos); -<span class="lineNum"> 423 </span> : } -<span class="lineNum"> 424 </span> : -<span class="lineNum"> 425 </span> : /// Return a string describing this object. -<span class="lineNum"> 426 </span> : std::string get_description() const; -<span class="lineNum"> 427 </span> : -<span class="lineNum"> 428 </span> : /** Get the numeric parameter used in this query. -<span class="lineNum"> 429 </span> : * -<span class="lineNum"> 430 </span> : * This is used by the QueryParser to get the value number for -<span class="lineNum"> 431 </span> : * VALUE_RANGE queries. It should be replaced by a public method on -<span class="lineNum"> 432 </span> : * the Query class at some point, but the API which should be used for -<span class="lineNum"> 433 </span> : * that is unclear, so this is a temporary workaround. -<span class="lineNum"> 434 </span> : */ -<span class="lineNum"> 435 </span> : Xapian::termcount get_parameter() const { return parameter; } -<span class="lineNum"> 436 </span> : -<span class="lineNum"> 437 </span> : /** Get the length of the query, used by some ranking formulae. -<span class="lineNum"> 438 </span> : * This value is calculated automatically - if you want to override -<span class="lineNum"> 439 </span> : * it you can pass a different value to Enquire::set_query(). -<span class="lineNum"> 440 </span> : */ -<span class="lineNum"> 441 </span> : Xapian::termcount get_length() const; -<span class="lineNum"> 442 </span> : -<span class="lineNum"> 443 </span> : /** Return an iterator over all the terms in the query, -<span class="lineNum"> 444 </span> : * in order of termpos. If multiple terms have the same term -<span class="lineNum"> 445 </span> : * position, their order is unspecified. Duplicates (same term and -<span class="lineNum"> 446 </span> : * termpos) will be removed. -<span class="lineNum"> 447 </span> : */ -<span class="lineNum"> 448 </span> : TermIterator get_terms() const; -<span class="lineNum"> 449 </span> : }; -<span class="lineNum"> 450 </span> : -<span class="lineNum"> 451 </span> : } -<span class="lineNum"> 452 </span> : -<span class="lineNum"> 453 </span> : #endif /* XAPIAN_INCLUDED_QUERY_H */ -</pre> - </td> - </tr> - </table> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> diff --git a/rep/usr/include/xapian/termgenerator.h.gcov.html b/rep/usr/include/xapian/termgenerator.h.gcov.html deleted file mode 100644 index dc59577..0000000 --- a/rep/usr/include/xapian/termgenerator.h.gcov.html +++ /dev/null @@ -1,226 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian/termgenerator.h</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - termgenerator.h</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">2</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">100.0 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">2</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <table cellpadding=0 cellspacing=0 border=0> - <tr> - <td><br></td> - </tr> - <tr> - <td><pre class="source"> -<span class="lineNum"> 1 </span> : /** @file termgenerator.h -<span class="lineNum"> 2 </span> : * @brief parse free text and generate terms -<span class="lineNum"> 3 </span> : */ -<span class="lineNum"> 4 </span> : /* Copyright (C) 2007 Olly Betts -<span class="lineNum"> 5 </span> : * -<span class="lineNum"> 6 </span> : * This program is free software; you can redistribute it and/or modify -<span class="lineNum"> 7 </span> : * it under the terms of the GNU General Public License as published by -<span class="lineNum"> 8 </span> : * the Free Software Foundation; either version 2 of the License, or -<span class="lineNum"> 9 </span> : * (at your option) any later version. -<span class="lineNum"> 10 </span> : * -<span class="lineNum"> 11 </span> : * This program is distributed in the hope that it will be useful, -<span class="lineNum"> 12 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of -<span class="lineNum"> 13 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -<span class="lineNum"> 14 </span> : * GNU General Public License for more details. -<span class="lineNum"> 15 </span> : * -<span class="lineNum"> 16 </span> : * You should have received a copy of the GNU General Public License -<span class="lineNum"> 17 </span> : * along with this program; if not, write to the Free Software -<span class="lineNum"> 18 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -<span class="lineNum"> 19 </span> : */ -<span class="lineNum"> 20 </span> : -<span class="lineNum"> 21 </span> : #ifndef XAPIAN_INCLUDED_TERMGENERATOR_H -<span class="lineNum"> 22 </span> : #define XAPIAN_INCLUDED_TERMGENERATOR_H -<span class="lineNum"> 23 </span> : -<span class="lineNum"> 24 </span> : #include <xapian/base.h> -<span class="lineNum"> 25 </span> : #include <xapian/types.h> -<span class="lineNum"> 26 </span> : #include <xapian/unicode.h> -<span class="lineNum"> 27 </span> : #include <xapian/visibility.h> -<span class="lineNum"> 28 </span> : -<span class="lineNum"> 29 </span> : #include <string> -<span class="lineNum"> 30 </span> : -<span class="lineNum"> 31 </span> : namespace Xapian { -<span class="lineNum"> 32 </span> : -<span class="lineNum"> 33 </span> : class Document; -<span class="lineNum"> 34 </span> : class Stem; -<span class="lineNum"> 35 </span> : class Stopper; -<span class="lineNum"> 36 </span> : class WritableDatabase; -<span class="lineNum"> 37 </span> : -<span class="lineNum"> 38 </span> : /** Parses a piece of text and generate terms. -<span class="lineNum"> 39 </span> : * -<span class="lineNum"> 40 </span> : * This module takes a piece of text and parses it to produce words which are -<span class="lineNum"> 41 </span> : * then used to generate suitable terms for indexing. The terms generated are -<span class="lineNum"> 42 </span> : * suitable for use with Query objects produced by the QueryParser class. -<span class="lineNum"> 43 </span> : */ -<span class="lineNum"> 44 </span> : class XAPIAN_VISIBILITY_DEFAULT TermGenerator { -<span class="lineNum"> 45 </span> : public: -<span class="lineNum"> 46 </span> : /// @private @internal Class representing the TermGenerator internals. -<span class="lineNum"> 47 </span> : class Internal; -<span class="lineNum"> 48 </span> : /// @private @internal Reference counted internals. -<span class="lineNum"> 49 </span> : Xapian::Internal::RefCntPtr<Internal> internal; -<span class="lineNum"> 50 </span> : -<span class="lineNum"> 51 </span> : /// Copy constructor. -<span class="lineNum"> 52 </span> : TermGenerator(const TermGenerator & o); -<span class="lineNum"> 53 </span> : -<span class="lineNum"> 54 </span> : /// Assignment. -<span class="lineNum"> 55 </span> : TermGenerator & operator=(const TermGenerator & o); -<span class="lineNum"> 56 </span> : -<span class="lineNum"> 57 </span> : /// Default constructor. -<span class="lineNum"> 58 </span> : TermGenerator(); -<span class="lineNum"> 59 </span> : -<span class="lineNum"> 60 </span> : /// Destructor. -<span class="lineNum"> 61 </span> : ~TermGenerator(); -<span class="lineNum"> 62 </span> : -<span class="lineNum"> 63 </span> : /// Set the Xapian::Stem object to be used for generating stemmed terms. -<span class="lineNum"> 64 </span> : void set_stemmer(const Xapian::Stem & stemmer); -<span class="lineNum"> 65 </span> : -<span class="lineNum"> 66 </span> : /// Set the Xapian::Stopper object to be used for identifying stopwords. -<span class="lineNum"> 67 </span> : void set_stopper(const Xapian::Stopper *stop = NULL); -<span class="lineNum"> 68 </span> : -<span class="lineNum"> 69 </span> : /// Set the current document. -<span class="lineNum"> 70 </span> : void set_document(const Xapian::Document & doc); -<span class="lineNum"> 71 </span> : -<span class="lineNum"> 72 </span> : /// Get the current document. -<span class="lineNum"> 73 </span> : const Xapian::Document & get_document() const; -<span class="lineNum"> 74 </span> : -<span class="lineNum"> 75 </span> : /// Set the database to index spelling data to. -<span class="lineNum"> 76 </span> : void set_database(const Xapian::WritableDatabase &db); -<span class="lineNum"> 77 </span> : -<span class="lineNum"> 78 </span> : /// Flags to OR together and pass to TermGenerator::set_flags(). -<span class="lineNum"> 79 </span> : enum flags { -<span class="lineNum"> 80 </span> : /// Index data required for spelling correction. -<span class="lineNum"> 81 </span> : FLAG_SPELLING = 128 // Value matches QueryParser flag. -<span class="lineNum"> 82 </span> : }; -<span class="lineNum"> 83 </span> : -<span class="lineNum"> 84 </span> : /** Set flags. -<span class="lineNum"> 85 </span> : * -<span class="lineNum"> 86 </span> : * The new value of flags is: (flags & mask) ^ toggle -<span class="lineNum"> 87 </span> : * -<span class="lineNum"> 88 </span> : * To just set the flags, pass the new flags in toggle and the -<span class="lineNum"> 89 </span> : * default value for mask. -<span class="lineNum"> 90 </span> : * -<span class="lineNum"> 91 </span> : * @param toggle Flags to XOR. -<span class="lineNum"> 92 </span> : * @param mask Flags to AND with first. -<span class="lineNum"> 93 </span> : * -<span class="lineNum"> 94 </span> : * @return The old flags setting. -<span class="lineNum"> 95 </span> : */ -<span class="lineNum"> 96 </span> : flags set_flags(flags toggle, flags mask = flags(0)); -<span class="lineNum"> 97 </span> : -<span class="lineNum"> 98 </span> : /** Index some text. -<span class="lineNum"> 99 </span> : * -<span class="lineNum"> 100 </span> : * @param weight The wdf increment (default 1). -<span class="lineNum"> 101 </span> : * @param prefix The term prefix to use (default is no prefix). -<span class="lineNum"> 102 </span> : */ -<span class="lineNum"> 103 </span> : void index_text(const Xapian::Utf8Iterator & itor, -<span class="lineNum"> 104 </span> : Xapian::termcount weight = 1, -<span class="lineNum"> 105 </span> : const std::string & prefix = ""); -<span class="lineNum"> 106 </span> : -<span class="lineNum"> 107 </span> : /** Index some text in a std::string. -<span class="lineNum"> 108 </span> : * -<span class="lineNum"> 109 </span> : * @param weight The wdf increment (default 1). -<span class="lineNum"> 110 </span> : * @param prefix The term prefix to use (default is no prefix). -<span class="lineNum"> 111 </span> : */ -<span class="lineNum"> 112 </span> : void index_text(const std::string & text, -<span class="lineNum"> 113 </span> : Xapian::termcount weight = 1, -<span class="lineNum"> 114 </span> : const std::string & prefix = "") { -<span class="lineNum"> 115 </span> : return index_text(Utf8Iterator(text), weight, prefix); -<span class="lineNum"> 116 </span> : } -<span class="lineNum"> 117 </span> : -<span class="lineNum"> 118 </span> : /** Index some text without positional information. -<span class="lineNum"> 119 </span> : * -<span class="lineNum"> 120 </span> : * Just like index_text, but no positional information is generated. This -<span class="lineNum"> 121 </span> : * means that the database will be significantly smaller, but that phrase -<span class="lineNum"> 122 </span> : * searching and NEAR won't be supported. -<span class="lineNum"> 123 </span> : */ -<span class="lineNum"> 124 </span> : void index_text_without_positions(const Xapian::Utf8Iterator & itor, -<span class="lineNum"> 125 </span> : Xapian::termcount weight = 1, -<span class="lineNum"> 126 </span> : const std::string & prefix = ""); -<span class="lineNum"> 127 </span> : -<span class="lineNum"> 128 </span> : /** Index some text in a std::string without positional information. -<span class="lineNum"> 129 </span> : * -<span class="lineNum"> 130 </span> : * Just like index_text, but no positional information is generated. This -<span class="lineNum"> 131 </span> : * means that the database will be significantly smaller, but that phrase -<span class="lineNum"> 132 </span> : * searching and NEAR won't be supported. -<span class="lineNum"> 133 </span> : */ -<span class="lineNum"> 134 </span> : void index_text_without_positions(const std::string & text, -<span class="lineNum"> 135 </span> : Xapian::termcount weight = 1, -<span class="lineNum"> 136 </span><span class="lineCov"> 5208 : const std::string & prefix = "") {</span> -<span class="lineNum"> 137 </span><span class="lineCov"> 5208 : return index_text_without_positions(Utf8Iterator(text), weight, prefix);</span> -<span class="lineNum"> 138 </span> : } -<span class="lineNum"> 139 </span> : -<span class="lineNum"> 140 </span> : /** Increase the termpos used by index_text by @a delta. -<span class="lineNum"> 141 </span> : * -<span class="lineNum"> 142 </span> : * This can be used to prevent phrase searches from spanning two -<span class="lineNum"> 143 </span> : * unconnected blocks of text (e.g. the title and body text). -<span class="lineNum"> 144 </span> : */ -<span class="lineNum"> 145 </span> : void increase_termpos(Xapian::termcount delta = 100); -<span class="lineNum"> 146 </span> : -<span class="lineNum"> 147 </span> : /// Get the current term position. -<span class="lineNum"> 148 </span> : Xapian::termcount get_termpos() const; -<span class="lineNum"> 149 </span> : -<span class="lineNum"> 150 </span> : /// Set the current term position. -<span class="lineNum"> 151 </span> : void set_termpos(Xapian::termcount termpos); -<span class="lineNum"> 152 </span> : -<span class="lineNum"> 153 </span> : /// Return a string describing this object. -<span class="lineNum"> 154 </span> : std::string get_description() const; -<span class="lineNum"> 155 </span> : }; -<span class="lineNum"> 156 </span> : -<span class="lineNum"> 157 </span> : } -<span class="lineNum"> 158 </span> : -<span class="lineNum"> 159 </span> : #endif // XAPIAN_INCLUDED_TERMGENERATOR_H -</pre> - </td> - </tr> - </table> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> diff --git a/rep/usr/include/xapian/termiterator.h.gcov.html b/rep/usr/include/xapian/termiterator.h.gcov.html deleted file mode 100644 index fbdbc0b..0000000 --- a/rep/usr/include/xapian/termiterator.h.gcov.html +++ /dev/null @@ -1,216 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian/termiterator.h</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - termiterator.h</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">4</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">100.0 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">4</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <table cellpadding=0 cellspacing=0 border=0> - <tr> - <td><br></td> - </tr> - <tr> - <td><pre class="source"> -<span class="lineNum"> 1 </span> : /** \file termiterator.h -<span class="lineNum"> 2 </span> : * \brief Classes for iterating through term lists -<span class="lineNum"> 3 </span> : */ -<span class="lineNum"> 4 </span> : /* Copyright 1999,2000,2001 BrightStation PLC -<span class="lineNum"> 5 </span> : * Copyright 2002 Ananova Ltd -<span class="lineNum"> 6 </span> : * Copyright 2003,2004,2005,2006,2007 Olly Betts -<span class="lineNum"> 7 </span> : * -<span class="lineNum"> 8 </span> : * This program is free software; you can redistribute it and/or -<span class="lineNum"> 9 </span> : * modify it under the terms of the GNU General Public License as -<span class="lineNum"> 10 </span> : * published by the Free Software Foundation; either version 2 of the -<span class="lineNum"> 11 </span> : * License, or (at your option) any later version. -<span class="lineNum"> 12 </span> : * -<span class="lineNum"> 13 </span> : * This program is distributed in the hope that it will be useful, -<span class="lineNum"> 14 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of -<span class="lineNum"> 15 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -<span class="lineNum"> 16 </span> : * GNU General Public License for more details. -<span class="lineNum"> 17 </span> : * -<span class="lineNum"> 18 </span> : * You should have received a copy of the GNU General Public License -<span class="lineNum"> 19 </span> : * along with this program; if not, write to the Free Software -<span class="lineNum"> 20 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 -<span class="lineNum"> 21 </span> : * USA -<span class="lineNum"> 22 </span> : */ -<span class="lineNum"> 23 </span> : -<span class="lineNum"> 24 </span> : #ifndef XAPIAN_INCLUDED_TERMITERATOR_H -<span class="lineNum"> 25 </span> : #define XAPIAN_INCLUDED_TERMITERATOR_H -<span class="lineNum"> 26 </span> : -<span class="lineNum"> 27 </span> : #include <iterator> -<span class="lineNum"> 28 </span> : #include <string> -<span class="lineNum"> 29 </span> : -<span class="lineNum"> 30 </span> : #include <xapian/base.h> -<span class="lineNum"> 31 </span> : #include <xapian/types.h> -<span class="lineNum"> 32 </span> : #include <xapian/positioniterator.h> -<span class="lineNum"> 33 </span> : #include <xapian/visibility.h> -<span class="lineNum"> 34 </span> : -<span class="lineNum"> 35 </span> : namespace Xapian { -<span class="lineNum"> 36 </span> : -<span class="lineNum"> 37 </span> : class Database; -<span class="lineNum"> 38 </span> : -<span class="lineNum"> 39 </span> : /** @internal A wrapper class for a termname which returns the termname if -<span class="lineNum"> 40 </span> : * dereferenced with *. We need this to implement input_iterator semantics. -<span class="lineNum"> 41 </span> : */ -<span class="lineNum"> 42 </span> : class TermNameWrapper { -<span class="lineNum"> 43 </span> : private: -<span class="lineNum"> 44 </span> : std::string tname; -<span class="lineNum"> 45 </span> : public: -<span class="lineNum"> 46 </span> : explicit TermNameWrapper(const std::string & tname_) : tname(tname_) { } -<span class="lineNum"> 47 </span> : const std::string & operator*() const { return tname; } -<span class="lineNum"> 48 </span> : }; -<span class="lineNum"> 49 </span> : -<span class="lineNum"> 50 </span> : /** An iterator pointing to items in a list of terms. -<span class="lineNum"> 51 </span> : */ -<span class="lineNum"> 52 </span> : class XAPIAN_VISIBILITY_DEFAULT TermIterator { -<span class="lineNum"> 53 </span> : public: -<span class="lineNum"> 54 </span> : class Internal; -<span class="lineNum"> 55 </span> : /// @internal Reference counted internals. -<span class="lineNum"> 56 </span> : Xapian::Internal::RefCntPtr<Internal> internal; -<span class="lineNum"> 57 </span> : -<span class="lineNum"> 58 </span> : /// @internal Reference counted internals. -<span class="lineNum"> 59 </span> : explicit TermIterator(Internal *internal_); -<span class="lineNum"> 60 </span> : -<span class="lineNum"> 61 </span> : /// Default constructor - for declaring an uninitialised iterator. -<span class="lineNum"> 62 </span> : TermIterator(); -<span class="lineNum"> 63 </span> : -<span class="lineNum"> 64 </span> : /// Destructor. -<span class="lineNum"> 65 </span> : ~TermIterator(); -<span class="lineNum"> 66 </span> : -<span class="lineNum"> 67 </span> : /** Copying is allowed. The internals are reference counted, so -<span class="lineNum"> 68 </span> : * copying is also cheap. -<span class="lineNum"> 69 </span> : */ -<span class="lineNum"> 70 </span> : TermIterator(const TermIterator &other); -<span class="lineNum"> 71 </span> : -<span class="lineNum"> 72 </span> : /** Assignment is allowed. The internals are reference counted, -<span class="lineNum"> 73 </span> : * so assignment is also cheap. -<span class="lineNum"> 74 </span> : */ -<span class="lineNum"> 75 </span> : void operator=(const TermIterator &other); -<span class="lineNum"> 76 </span> : -<span class="lineNum"> 77 </span> : /// Return the current term. -<span class="lineNum"> 78 </span> : std::string operator *() const; -<span class="lineNum"> 79 </span> : -<span class="lineNum"> 80 </span> : TermIterator & operator++(); -<span class="lineNum"> 81 </span> : -<span class="lineNum"> 82 </span> : TermNameWrapper operator++(int) { -<span class="lineNum"> 83 </span> : std::string tmp = **this; -<span class="lineNum"> 84 </span> : operator++(); -<span class="lineNum"> 85 </span> : return TermNameWrapper(tmp); -<span class="lineNum"> 86 </span> : } -<span class="lineNum"> 87 </span> : -<span class="lineNum"> 88 </span> : /** Skip the iterator to term tname, or the first term after tname -<span class="lineNum"> 89 </span> : * if tname isn't in the list of terms being iterated. -<span class="lineNum"> 90 </span> : */ -<span class="lineNum"> 91 </span> : void skip_to(const std::string & tname); -<span class="lineNum"> 92 </span> : -<span class="lineNum"> 93 </span> : /** Return the wdf of the current term (if meaningful). -<span class="lineNum"> 94 </span> : * -<span class="lineNum"> 95 </span> : * The wdf (within document frequency) is the number of occurences -<span class="lineNum"> 96 </span> : * of a term in a particular document. -<span class="lineNum"> 97 </span> : */ -<span class="lineNum"> 98 </span> : Xapian::termcount get_wdf() const; -<span class="lineNum"> 99 </span> : -<span class="lineNum"> 100 </span> : /** Return the term frequency of the current term (if meaningful). -<span class="lineNum"> 101 </span> : * -<span class="lineNum"> 102 </span> : * The term frequency is the number of documents which a term indexes. -<span class="lineNum"> 103 </span> : */ -<span class="lineNum"> 104 </span> : Xapian::doccount get_termfreq() const; -<span class="lineNum"> 105 </span> : -<span class="lineNum"> 106 </span> : /** Return length of positionlist for current term. -<span class="lineNum"> 107 </span> : */ -<span class="lineNum"> 108 </span> : Xapian::termcount positionlist_count() const; -<span class="lineNum"> 109 </span> : -<span class="lineNum"> 110 </span> : /** Return PositionIterator pointing to start of positionlist for -<span class="lineNum"> 111 </span> : * current term. -<span class="lineNum"> 112 </span> : */ -<span class="lineNum"> 113 </span> : PositionIterator positionlist_begin() const; -<span class="lineNum"> 114 </span> : -<span class="lineNum"> 115 </span> : /** Return PositionIterator pointing to end of positionlist for -<span class="lineNum"> 116 </span> : * current term. -<span class="lineNum"> 117 </span> : */ -<span class="lineNum"> 118 </span> : PositionIterator positionlist_end() const { -<span class="lineNum"> 119 </span> : return PositionIterator(NULL); -<span class="lineNum"> 120 </span> : } -<span class="lineNum"> 121 </span> : -<span class="lineNum"> 122 </span> : /// Return a string describing this object. -<span class="lineNum"> 123 </span> : std::string get_description() const; -<span class="lineNum"> 124 </span> : -<span class="lineNum"> 125 </span> : /// Allow use as an STL iterator -<span class="lineNum"> 126 </span> : //@{ -<span class="lineNum"> 127 </span> : typedef std::input_iterator_tag iterator_category; -<span class="lineNum"> 128 </span> : typedef std::string value_type; -<span class="lineNum"> 129 </span> : typedef Xapian::termcount_diff difference_type; -<span class="lineNum"> 130 </span> : typedef std::string * pointer; -<span class="lineNum"> 131 </span> : typedef std::string & reference; -<span class="lineNum"> 132 </span> : //@} -<span class="lineNum"> 133 </span> : }; -<span class="lineNum"> 134 </span> : -<span class="lineNum"> 135 </span> : inline bool -<span class="lineNum"> 136 </span><span class="lineCov"> 5 : operator==(const TermIterator &a, const TermIterator &b)</span> -<span class="lineNum"> 137 </span> : { -<span class="lineNum"> 138 </span><span class="lineCov"> 5 : return (a.internal.get() == b.internal.get());</span> -<span class="lineNum"> 139 </span> : } -<span class="lineNum"> 140 </span> : -<span class="lineNum"> 141 </span> : inline bool -<span class="lineNum"> 142 </span><span class="lineCov"> 5 : operator!=(const TermIterator &a, const TermIterator &b)</span> -<span class="lineNum"> 143 </span> : { -<span class="lineNum"> 144 </span><span class="lineCov"> 5 : return !(a == b);</span> -<span class="lineNum"> 145 </span> : } -<span class="lineNum"> 146 </span> : -<span class="lineNum"> 147 </span> : } -<span class="lineNum"> 148 </span> : -<span class="lineNum"> 149 </span> : #endif /* XAPIAN_INCLUDED_TERMITERATOR_H */ -</pre> - </td> - </tr> - </table> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> diff --git a/rep/usr/include/xapian/unicode.h.gcov.html b/rep/usr/include/xapian/unicode.h.gcov.html deleted file mode 100644 index 72c1ad3..0000000 --- a/rep/usr/include/xapian/unicode.h.gcov.html +++ /dev/null @@ -1,433 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> - -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> - <title>LCOV - lcov.info - /usr/include/xapian/unicode.h</title> - <link rel="stylesheet" type="text/css" href="../../../gcov.css"> -</head> - -<body> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="title">LTP GCOV extension - code coverage report</td></tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - - <tr> - <td width="100%"> - <table cellpadding=1 border=0 width="100%"> - <tr> - <td class="headerItem" width="20%">Current view:</td> - <td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - unicode.h</td> - </tr> - <tr> - <td class="headerItem" width="20%">Test:</td> - <td class="headerValue" width="80%" colspan=4>lcov.info</td> - </tr> - <tr> - <td class="headerItem" width="20%">Date:</td> - <td class="headerValue" width="20%">2008-08-14</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Instrumented lines:</td> - <td class="headerValue" width="20%">8</td> - </tr> - <tr> - <td class="headerItem" width="20%">Code covered:</td> - <td class="headerValue" width="20%">87.5 %</td> - <td width="20%"></td> - <td class="headerItem" width="20%">Executed lines:</td> - <td class="headerValue" width="20%">7</td> - </tr> - </table> - </td> - </tr> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - </table> - - <table cellpadding=0 cellspacing=0 border=0> - <tr> - <td><br></td> - </tr> - <tr> - <td><pre class="source"> -<span class="lineNum"> 1 </span> : /** @file unicode.h -<span class="lineNum"> 2 </span> : * @brief Unicode and UTF-8 related classes and functions. -<span class="lineNum"> 3 </span> : */ -<span class="lineNum"> 4 </span> : /* Copyright (C) 2006,2007,2008 Olly Betts -<span class="lineNum"> 5 </span> : * -<span class="lineNum"> 6 </span> : * This program is free software; you can redistribute it and/or modify -<span class="lineNum"> 7 </span> : * it under the terms of the GNU General Public License as published by -<span class="lineNum"> 8 </span> : * the Free Software Foundation; either version 2 of the License, or -<span class="lineNum"> 9 </span> : * (at your option) any later version. -<span class="lineNum"> 10 </span> : * -<span class="lineNum"> 11 </span> : * This program is distributed in the hope that it will be useful, -<span class="lineNum"> 12 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of -<span class="lineNum"> 13 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -<span class="lineNum"> 14 </span> : * GNU General Public License for more details. -<span class="lineNum"> 15 </span> : * -<span class="lineNum"> 16 </span> : * You should have received a copy of the GNU General Public License -<span class="lineNum"> 17 </span> : * along with this program; if not, write to the Free Software -<span class="lineNum"> 18 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -<span class="lineNum"> 19 </span> : */ -<span class="lineNum"> 20 </span> : -<span class="lineNum"> 21 </span> : #ifndef XAPIAN_INCLUDED_UNICODE_H -<span class="lineNum"> 22 </span> : #define XAPIAN_INCLUDED_UNICODE_H -<span class="lineNum"> 23 </span> : -<span class="lineNum"> 24 </span> : #include <xapian/visibility.h> -<span class="lineNum"> 25 </span> : -<span class="lineNum"> 26 </span> : #include <string> -<span class="lineNum"> 27 </span> : -<span class="lineNum"> 28 </span> : namespace Xapian { -<span class="lineNum"> 29 </span> : -<span class="lineNum"> 30 </span> : /** An iterator which returns unicode character values from a UTF-8 encoded -<span class="lineNum"> 31 </span> : * string. -<span class="lineNum"> 32 </span> : */ -<span class="lineNum"> 33 </span> : class XAPIAN_VISIBILITY_DEFAULT Utf8Iterator { -<span class="lineNum"> 34 </span> : const unsigned char *p; -<span class="lineNum"> 35 </span> : const unsigned char *end; -<span class="lineNum"> 36 </span> : mutable unsigned seqlen; -<span class="lineNum"> 37 </span> : -<span class="lineNum"> 38 </span> : void calculate_sequence_length() const; -<span class="lineNum"> 39 </span> : -<span class="lineNum"> 40 </span> : unsigned get_char() const; -<span class="lineNum"> 41 </span> : -<span class="lineNum"> 42 </span> : Utf8Iterator(const unsigned char *p_, const unsigned char *end_, unsigned seqlen_) -<span class="lineNum"> 43 </span> : : p(p_), end(end_), seqlen(seqlen_) { } -<span class="lineNum"> 44 </span> : -<span class="lineNum"> 45 </span> : public: -<span class="lineNum"> 46 </span> : /** Return the raw const char * pointer for the current position. */ -<span class="lineNum"> 47 </span> : const char * raw() const { -<span class="lineNum"> 48 </span> : return reinterpret_cast<const char *>(p ? p : end); -<span class="lineNum"> 49 </span> : } -<span class="lineNum"> 50 </span> : -<span class="lineNum"> 51 </span> : /** Return the number of bytes left in the iterator's buffer. */ -<span class="lineNum"> 52 </span> : size_t left() const { return p ? end - p : 0; } -<span class="lineNum"> 53 </span> : -<span class="lineNum"> 54 </span> : /** Assign a new string to the iterator. -<span class="lineNum"> 55 </span> : * -<span class="lineNum"> 56 </span> : * The iterator will forget the string it was iterating through, and -<span class="lineNum"> 57 </span> : * return characters from the start of the new string when next called. -<span class="lineNum"> 58 </span> : * The string is not copied into the iterator, so it must remain valid -<span class="lineNum"> 59 </span> : * while the iteration is in progress. -<span class="lineNum"> 60 </span> : * -<span class="lineNum"> 61 </span> : * @param p A pointer to the start of the string to read. -<span class="lineNum"> 62 </span> : * -<span class="lineNum"> 63 </span> : * @param len The length of the string to read. -<span class="lineNum"> 64 </span> : */ -<span class="lineNum"> 65 </span><span class="lineCov"> 5208 : void assign(const char *p_, size_t len) {</span> -<span class="lineNum"> 66 </span><span class="lineCov"> 5208 : if (len) {</span> -<span class="lineNum"> 67 </span><span class="lineCov"> 5208 : p = reinterpret_cast<const unsigned char*>(p_);</span> -<span class="lineNum"> 68 </span><span class="lineCov"> 5208 : end = p + len;</span> -<span class="lineNum"> 69 </span><span class="lineCov"> 5208 : seqlen = 0;</span> -<span class="lineNum"> 70 </span> : } else { -<span class="lineNum"> 71 </span><span class="lineNoCov"> 0 : p = NULL;</span> -<span class="lineNum"> 72 </span> : } -<span class="lineNum"> 73 </span><span class="lineCov"> 5208 : }</span> -<span class="lineNum"> 74 </span> : -<span class="lineNum"> 75 </span> : /** Assign a new string to the iterator. -<span class="lineNum"> 76 </span> : * -<span class="lineNum"> 77 </span> : * The iterator will forget the string it was iterating through, and -<span class="lineNum"> 78 </span> : * return characters from the start of the new string when next called. -<span class="lineNum"> 79 </span> : * The string is not copied into the iterator, so it must remain valid -<span class="lineNum"> 80 </span> : * while the iteration is in progress. -<span class="lineNum"> 81 </span> : * -<span class="lineNum"> 82 </span> : * @param s The string to read. Must not be modified while the iteration -<span class="lineNum"> 83 </span> : * is in progress. -<span class="lineNum"> 84 </span> : */ -<span class="lineNum"> 85 </span> : void assign(const std::string &s) { assign(s.data(), s.size()); } -<span class="lineNum"> 86 </span> : -<span class="lineNum"> 87 </span> : /** Create an iterator given a pointer to a null terminated string. -<span class="lineNum"> 88 </span> : * -<span class="lineNum"> 89 </span> : * The iterator will return characters from the start of the string when -<span class="lineNum"> 90 </span> : * next called. The string is not copied into the iterator, so it must -<span class="lineNum"> 91 </span> : * remain valid while the iteration is in progress. -<span class="lineNum"> 92 </span> : * -<span class="lineNum"> 93 </span> : * @param p A pointer to the start of the null terminated string to read. -<span class="lineNum"> 94 </span> : */ -<span class="lineNum"> 95 </span> : explicit Utf8Iterator(const char *p_); -<span class="lineNum"> 96 </span> : -<span class="lineNum"> 97 </span> : /** Create an iterator given a pointer and a length. -<span class="lineNum"> 98 </span> : * -<span class="lineNum"> 99 </span> : * The iterator will return characters from the start of the string when -<span class="lineNum"> 100 </span> : * next called. The string is not copied into the iterator, so it must -<span class="lineNum"> 101 </span> : * remain valid while the iteration is in progress. -<span class="lineNum"> 102 </span> : * -<span class="lineNum"> 103 </span> : * @param p A pointer to the start of the string to read. -<span class="lineNum"> 104 </span> : * -<span class="lineNum"> 105 </span> : * @param len The length of the string to read. -<span class="lineNum"> 106 </span> : */ -<span class="lineNum"> 107 </span> : Utf8Iterator(const char *p_, size_t len) { assign(p_, len); } -<span class="lineNum"> 108 </span> : -<span class="lineNum"> 109 </span> : /** Create an iterator given a string. -<span class="lineNum"> 110 </span> : * -<span class="lineNum"> 111 </span> : * The iterator will return characters from the start of the string when -<span class="lineNum"> 112 </span> : * next called. The string is not copied into the iterator, so it must -<span class="lineNum"> 113 </span> : * remain valid while the iteration is in progress. -<span class="lineNum"> 114 </span> : * -<span class="lineNum"> 115 </span> : * @param s The string to read. Must not be modified while the iteration -<span class="lineNum"> 116 </span> : * is in progress. -<span class="lineNum"> 117 </span> : */ -<span class="lineNum"> 118 </span><span class="lineCov"> 5208 : Utf8Iterator(const std::string &s) { assign(s.data(), s.size()); }</span> -<span class="lineNum"> 119 </span> : -<span class="lineNum"> 120 </span> : /** Create an iterator which is at the end of its iteration. -<span class="lineNum"> 121 </span> : * -<span class="lineNum"> 122 </span> : * This can be compared to another iterator to check if the other iterator -<span class="lineNum"> 123 </span> : * has reached its end. -<span class="lineNum"> 124 </span> : */ -<span class="lineNum"> 125 </span> : Utf8Iterator() : p(NULL), end(0), seqlen(0) { } -<span class="lineNum"> 126 </span> : -<span class="lineNum"> 127 </span> : /** Get the current unicode character value pointed to by the iterator. -<span class="lineNum"> 128 </span> : * -<span class="lineNum"> 129 </span> : * Returns unsigned(-1) if the iterator has reached the end of its buffer. -<span class="lineNum"> 130 </span> : */ -<span class="lineNum"> 131 </span> : unsigned operator*() const; -<span class="lineNum"> 132 </span> : -<span class="lineNum"> 133 </span> : /** Move forward to the next unicode character. -<span class="lineNum"> 134 </span> : * -<span class="lineNum"> 135 </span> : * @return An iterator pointing to the position before the move. -<span class="lineNum"> 136 </span> : */ -<span class="lineNum"> 137 </span> : Utf8Iterator operator++(int) { -<span class="lineNum"> 138 </span> : // If we've not calculated seqlen yet, do so. -<span class="lineNum"> 139 </span> : if (seqlen == 0) calculate_sequence_length(); -<span class="lineNum"> 140 </span> : const unsigned char *old_p = p; -<span class="lineNum"> 141 </span> : unsigned old_seqlen = seqlen; -<span class="lineNum"> 142 </span> : p += seqlen; -<span class="lineNum"> 143 </span> : if (p == end) p = NULL; -<span class="lineNum"> 144 </span> : seqlen = 0; -<span class="lineNum"> 145 </span> : return Utf8Iterator(old_p, end, old_seqlen); -<span class="lineNum"> 146 </span> : } -<span class="lineNum"> 147 </span> : -<span class="lineNum"> 148 </span> : /** Move forward to the next unicode character. -<span class="lineNum"> 149 </span> : * -<span class="lineNum"> 150 </span> : * @return A reference to this object. -<span class="lineNum"> 151 </span> : */ -<span class="lineNum"> 152 </span> : Utf8Iterator & operator++() { -<span class="lineNum"> 153 </span> : if (seqlen == 0) calculate_sequence_length(); -<span class="lineNum"> 154 </span> : p += seqlen; -<span class="lineNum"> 155 </span> : if (p == end) p = NULL; -<span class="lineNum"> 156 </span> : seqlen = 0; -<span class="lineNum"> 157 </span> : return *this; -<span class="lineNum"> 158 </span> : } -<span class="lineNum"> 159 </span> : -<span class="lineNum"> 160 </span> : /** Test two Utf8Iterators for equality. -<span class="lineNum"> 161 </span> : * -<span class="lineNum"> 162 </span> : * @return true iff the iterators point to the same position. -<span class="lineNum"> 163 </span> : */ -<span class="lineNum"> 164 </span> : bool operator==(const Utf8Iterator &other) const { return p == other.p; } -<span class="lineNum"> 165 </span> : -<span class="lineNum"> 166 </span> : /** Test two Utf8Iterators for inequality. -<span class="lineNum"> 167 </span> : * -<span class="lineNum"> 168 </span> : * @return true iff the iterators do not point to the same position. -<span class="lineNum"> 169 </span> : */ -<span class="lineNum"> 170 </span> : bool operator!=(const Utf8Iterator &other) const { return p != other.p; } -<span class="lineNum"> 171 </span> : -<span class="lineNum"> 172 </span> : /// We implement the semantics of an STL input_iterator. -<span class="lineNum"> 173 </span> : //@{ -<span class="lineNum"> 174 </span> : typedef std::input_iterator_tag iterator_category; -<span class="lineNum"> 175 </span> : typedef unsigned value_type; -<span class="lineNum"> 176 </span> : typedef size_t difference_type; -<span class="lineNum"> 177 </span> : typedef const unsigned * pointer; -<span class="lineNum"> 178 </span> : typedef const unsigned & reference; -<span class="lineNum"> 179 </span> : //@} -<span class="lineNum"> 180 </span> : }; -<span class="lineNum"> 181 </span> : -<span class="lineNum"> 182 </span> : namespace Unicode { -<span class="lineNum"> 183 </span> : -<span class="lineNum"> 184 </span> : /** Each unicode character is in one of these categories. */ -<span class="lineNum"> 185 </span> : typedef enum { -<span class="lineNum"> 186 </span> : UNASSIGNED, -<span class="lineNum"> 187 </span> : UPPERCASE_LETTER, -<span class="lineNum"> 188 </span> : LOWERCASE_LETTER, -<span class="lineNum"> 189 </span> : TITLECASE_LETTER, -<span class="lineNum"> 190 </span> : MODIFIER_LETTER, -<span class="lineNum"> 191 </span> : OTHER_LETTER, -<span class="lineNum"> 192 </span> : NON_SPACING_MARK, -<span class="lineNum"> 193 </span> : ENCLOSING_MARK, -<span class="lineNum"> 194 </span> : COMBINING_SPACING_MARK, -<span class="lineNum"> 195 </span> : DECIMAL_DIGIT_NUMBER, -<span class="lineNum"> 196 </span> : LETTER_NUMBER, -<span class="lineNum"> 197 </span> : OTHER_NUMBER, -<span class="lineNum"> 198 </span> : SPACE_SEPARATOR, -<span class="lineNum"> 199 </span> : LINE_SEPARATOR, -<span class="lineNum"> 200 </span> : PARAGRAPH_SEPARATOR, -<span class="lineNum"> 201 </span> : CONTROL, -<span class="lineNum"> 202 </span> : FORMAT, -<span class="lineNum"> 203 </span> : PRIVATE_USE, -<span class="lineNum"> 204 </span> : SURROGATE, -<span class="lineNum"> 205 </span> : CONNECTOR_PUNCTUATION, -<span class="lineNum"> 206 </span> : DASH_PUNCTUATION, -<span class="lineNum"> 207 </span> : OPEN_PUNCTUATION, -<span class="lineNum"> 208 </span> : CLOSE_PUNCTUATION, -<span class="lineNum"> 209 </span> : INITIAL_QUOTE_PUNCTUATION, -<span class="lineNum"> 210 </span> : FINAL_QUOTE_PUNCTUATION, -<span class="lineNum"> 211 </span> : OTHER_PUNCTUATION, -<span class="lineNum"> 212 </span> : MATH_SYMBOL, -<span class="lineNum"> 213 </span> : CURRENCY_SYMBOL, -<span class="lineNum"> 214 </span> : MODIFIER_SYMBOL, -<span class="lineNum"> 215 </span> : OTHER_SYMBOL -<span class="lineNum"> 216 </span> : } category; -<span class="lineNum"> 217 </span> : -<span class="lineNum"> 218 </span> : namespace Internal { -<span class="lineNum"> 219 </span> : /** @internal Extract the information about a character from the Unicode -<span class="lineNum"> 220 </span> : * character tables. -<span class="lineNum"> 221 </span> : * -<span class="lineNum"> 222 </span> : * ch must be a valid Unicode character value (i.e. < 0x110000) -<span class="lineNum"> 223 </span> : */ -<span class="lineNum"> 224 </span> : XAPIAN_VISIBILITY_DEFAULT -<span class="lineNum"> 225 </span> : int get_character_info(unsigned ch); -<span class="lineNum"> 226 </span> : -<span class="lineNum"> 227 </span> : /** @internal Extract how to convert the case of a unicode character from -<span class="lineNum"> 228 </span> : * its info. -<span class="lineNum"> 229 </span> : */ -<span class="lineNum"> 230 </span> : inline int get_case_type(int info) { return ((info & 0xe0) >> 5); } -<span class="lineNum"> 231 </span> : -<span class="lineNum"> 232 </span> : /// @internal Extract the category of a unicode character from its info. -<span class="lineNum"> 233 </span> : inline category get_category(int info) { return static_cast<category>(info & 0x1f); } -<span class="lineNum"> 234 </span> : -<span class="lineNum"> 235 </span> : /** @internal Extract the delta to use for case conversion of a character -<span class="lineNum"> 236 </span> : * from its info. -<span class="lineNum"> 237 </span> : */ -<span class="lineNum"> 238 </span> : inline int get_delta(int info) { -<span class="lineNum"> 239 </span> : /* It's implementation defined if sign extension happens on right shift -<span class="lineNum"> 240 </span> : * of a signed int, hence the conditional (hopefully the compiler will -<span class="lineNum"> 241 </span> : * spot this and optimise it to a sign-extending shift on architectures -<span class="lineNum"> 242 </span> : * with a suitable instruction). -<span class="lineNum"> 243 </span> : */ -<span class="lineNum"> 244 </span> : return (info >= 0) ? (info >> 15) : (~(~info >> 15)); -<span class="lineNum"> 245 </span> : } -<span class="lineNum"> 246 </span> : } -<span class="lineNum"> 247 </span> : -<span class="lineNum"> 248 </span> : /** Convert a single non-ASCII unicode character to UTF-8. -<span class="lineNum"> 249 </span> : * -<span class="lineNum"> 250 </span> : * This is intended mainly as a helper method for to_utf8(). -<span class="lineNum"> 251 </span> : * -<span class="lineNum"> 252 </span> : * The character @a ch (which must be > 128) is written to the buffer @a buf -<span class="lineNum"> 253 </span> : * and the length of the resultant UTF-8 character is returned. -<span class="lineNum"> 254 </span> : * -<span class="lineNum"> 255 </span> : * NB buf must have space for (at least) 4 bytes. -<span class="lineNum"> 256 </span> : */ -<span class="lineNum"> 257 </span> : XAPIAN_VISIBILITY_DEFAULT -<span class="lineNum"> 258 </span> : unsigned nonascii_to_utf8(unsigned ch, char * buf); -<span class="lineNum"> 259 </span> : -<span class="lineNum"> 260 </span> : /** Convert a single unicode character to UTF-8. -<span class="lineNum"> 261 </span> : * -<span class="lineNum"> 262 </span> : * The character @a ch is written to the buffer @a buf and the length of the -<span class="lineNum"> 263 </span> : * resultant UTF-8 character is returned. -<span class="lineNum"> 264 </span> : * -<span class="lineNum"> 265 </span> : * NB buf must have space for (at least) 4 bytes. -<span class="lineNum"> 266 </span> : */ -<span class="lineNum"> 267 </span> : inline unsigned to_utf8(unsigned ch, char *buf) { -<span class="lineNum"> 268 </span> : if (ch < 128) { -<span class="lineNum"> 269 </span> : *buf = static_cast<unsigned char>(ch); -<span class="lineNum"> 270 </span> : return 1; -<span class="lineNum"> 271 </span> : } -<span class="lineNum"> 272 </span> : return Xapian::Unicode::nonascii_to_utf8(ch, buf); -<span class="lineNum"> 273 </span> : } -<span class="lineNum"> 274 </span> : -<span class="lineNum"> 275 </span> : /** Append the UTF-8 representation of a single unicode character to a -<span class="lineNum"> 276 </span> : * std::string. -<span class="lineNum"> 277 </span> : */ -<span class="lineNum"> 278 </span> : inline void append_utf8(std::string &s, unsigned ch) { -<span class="lineNum"> 279 </span> : char buf[4]; -<span class="lineNum"> 280 </span> : s.append(buf, to_utf8(ch, buf)); -<span class="lineNum"> 281 </span> : } -<span class="lineNum"> 282 </span> : -<span class="lineNum"> 283 </span> : /// Return the category which a given unicode character falls into. -<span class="lineNum"> 284 </span> : inline category get_category(unsigned ch) { -<span class="lineNum"> 285 </span> : // Categorise non-Unicode values as UNASSIGNED. -<span class="lineNum"> 286 </span> : if (ch >= 0x110000) return Xapian::Unicode::UNASSIGNED; -<span class="lineNum"> 287 </span> : return Internal::get_category(Internal::get_character_info(ch)); -<span class="lineNum"> 288 </span> : } -<span class="lineNum"> 289 </span> : -<span class="lineNum"> 290 </span> : /// Test is a given unicode character is a letter or number. -<span class="lineNum"> 291 </span> : inline bool is_wordchar(unsigned ch) { -<span class="lineNum"> 292 </span> : const unsigned int WORDCHAR_MASK = -<span class="lineNum"> 293 </span> : (1 << Xapian::Unicode::UPPERCASE_LETTER) | -<span class="lineNum"> 294 </span> : (1 << Xapian::Unicode::LOWERCASE_LETTER) | -<span class="lineNum"> 295 </span> : (1 << Xapian::Unicode::TITLECASE_LETTER) | -<span class="lineNum"> 296 </span> : (1 << Xapian::Unicode::MODIFIER_LETTER) | -<span class="lineNum"> 297 </span> : (1 << Xapian::Unicode::OTHER_LETTER) | -<span class="lineNum"> 298 </span> : (1 << Xapian::Unicode::DECIMAL_DIGIT_NUMBER) | -<span class="lineNum"> 299 </span> : (1 << Xapian::Unicode::LETTER_NUMBER) | -<span class="lineNum"> 300 </span> : (1 << Xapian::Unicode::OTHER_NUMBER) | -<span class="lineNum"> 301 </span> : (1 << Xapian::Unicode::CONNECTOR_PUNCTUATION); -<span class="lineNum"> 302 </span> : return ((WORDCHAR_MASK >> get_category(ch)) & 1); -<span class="lineNum"> 303 </span> : } -<span class="lineNum"> 304 </span> : -<span class="lineNum"> 305 </span> : /// Test is a given unicode character is a whitespace character. -<span class="lineNum"> 306 </span> : inline bool is_whitespace(unsigned ch) { -<span class="lineNum"> 307 </span> : const unsigned int WHITESPACE_MASK = -<span class="lineNum"> 308 </span> : (1 << Xapian::Unicode::CONTROL) | // For TAB, CR, LF, FF. -<span class="lineNum"> 309 </span> : (1 << Xapian::Unicode::SPACE_SEPARATOR) | -<span class="lineNum"> 310 </span> : (1 << Xapian::Unicode::LINE_SEPARATOR) | -<span class="lineNum"> 311 </span> : (1 << Xapian::Unicode::PARAGRAPH_SEPARATOR); -<span class="lineNum"> 312 </span> : return ((WHITESPACE_MASK >> get_category(ch)) & 1); -<span class="lineNum"> 313 </span> : } -<span class="lineNum"> 314 </span> : -<span class="lineNum"> 315 </span> : /// Test is a given unicode character is a currency symbol. -<span class="lineNum"> 316 </span> : inline bool is_currency(unsigned ch) { -<span class="lineNum"> 317 </span> : return (get_category(ch) == Xapian::Unicode::CURRENCY_SYMBOL); -<span class="lineNum"> 318 </span> : } -<span class="lineNum"> 319 </span> : -<span class="lineNum"> 320 </span> : /// Convert a unicode character to lowercase. -<span class="lineNum"> 321 </span> : inline unsigned tolower(unsigned ch) { -<span class="lineNum"> 322 </span> : int info; -<span class="lineNum"> 323 </span> : // Leave non-Unicode values unchanged. -<span class="lineNum"> 324 </span> : if (ch >= 0x110000 || !(Internal::get_case_type((info = Xapian::Unicode::Internal::get_character_info(ch))) & 2)) -<span class="lineNum"> 325 </span> : return ch; -<span class="lineNum"> 326 </span> : return ch + Internal::get_delta(info); -<span class="lineNum"> 327 </span> : } -<span class="lineNum"> 328 </span> : -<span class="lineNum"> 329 </span> : /// Convert a unicode character to uppercase. -<span class="lineNum"> 330 </span> : inline unsigned toupper(unsigned ch) { -<span class="lineNum"> 331 </span> : int info; -<span class="lineNum"> 332 </span> : // Leave non-Unicode values unchanged. -<span class="lineNum"> 333 </span> : if (ch >= 0x110000 || !(Internal::get_case_type((info = Xapian::Unicode::Internal::get_character_info(ch))) & 4)) -<span class="lineNum"> 334 </span> : return ch; -<span class="lineNum"> 335 </span> : return ch - Internal::get_delta(info); -<span class="lineNum"> 336 </span> : } -<span class="lineNum"> 337 </span> : -<span class="lineNum"> 338 </span> : /// Convert a UTF-8 std::string to lowercase. -<span class="lineNum"> 339 </span> : inline std::string -<span class="lineNum"> 340 </span> : tolower(const std::string &term) -<span class="lineNum"> 341 </span> : { -<span class="lineNum"> 342 </span> : std::string result; -<span class="lineNum"> 343 </span> : result.reserve(term.size()); -<span class="lineNum"> 344 </span> : for (Utf8Iterator i(term); i != Utf8Iterator(); ++i) { -<span class="lineNum"> 345 </span> : append_utf8(result, tolower(*i)); -<span class="lineNum"> 346 </span> : } -<span class="lineNum"> 347 </span> : return result; -<span class="lineNum"> 348 </span> : } -<span class="lineNum"> 349 </span> : -<span class="lineNum"> 350 </span> : /// Convert a UTF-8 std::string to uppercase. -<span class="lineNum"> 351 </span> : inline std::string -<span class="lineNum"> 352 </span> : toupper(const std::string &term) -<span class="lineNum"> 353 </span> : { -<span class="lineNum"> 354 </span> : std::string result; -<span class="lineNum"> 355 </span> : result.reserve(term.size()); -<span class="lineNum"> 356 </span> : for (Utf8Iterator i(term); i != Utf8Iterator(); ++i) { -<span class="lineNum"> 357 </span> : append_utf8(result, toupper(*i)); -<span class="lineNum"> 358 </span> : } -<span class="lineNum"> 359 </span> : return result; -<span class="lineNum"> 360 </span> : } -<span class="lineNum"> 361 </span> : -<span class="lineNum"> 362 </span> : } -<span class="lineNum"> 363 </span> : -<span class="lineNum"> 364 </span> : } -<span class="lineNum"> 365 </span> : -<span class="lineNum"> 366 </span> : #endif // XAPIAN_INCLUDED_UNICODE_H -</pre> - </td> - </tr> - </table> - <br> - - <table width="100%" border=0 cellspacing=0 cellpadding=0> - <tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr> - <tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr> - </table> - <br> - -</body> -</html> |