LCOV - code coverage report
Current view: top level - include/xapian - eset.h (source / functions) Hit Total Coverage
Test: Test Coverage for xapian-core 7028d852e609 Lines: 24 24 100.0 %
Date: 2019-02-17 14:59:59 Functions: 19 19 100.0 %
Branches: 0 0 -

           Branch data     Line data    Source code
       1                 :            : /** @file  eset.h
       2                 :            :  *  @brief Class representing a list of query expansion terms
       3                 :            :  */
       4                 :            : /* Copyright (C) 2015,2016,2017 Olly Betts
       5                 :            :  *
       6                 :            :  * This program is free software; you can redistribute it and/or
       7                 :            :  * modify it under the terms of the GNU General Public License as
       8                 :            :  * published by the Free Software Foundation; either version 2 of the
       9                 :            :  * License, or (at your option) any later version.
      10                 :            :  *
      11                 :            :  * This program is distributed in the hope that it will be useful,
      12                 :            :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      13                 :            :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      14                 :            :  * GNU General Public License for more details.
      15                 :            :  *
      16                 :            :  * You should have received a copy of the GNU General Public License
      17                 :            :  * along with this program; if not, write to the Free Software
      18                 :            :  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
      19                 :            :  * USA
      20                 :            :  */
      21                 :            : 
      22                 :            : #ifndef XAPIAN_INCLUDED_ESET_H
      23                 :            : #define XAPIAN_INCLUDED_ESET_H
      24                 :            : 
      25                 :            : #if !defined XAPIAN_IN_XAPIAN_H && !defined XAPIAN_LIB_BUILD
      26                 :            : # error "Never use <xapian/eset.h> directly; include <xapian.h> instead."
      27                 :            : #endif
      28                 :            : 
      29                 :            : #include <iterator>
      30                 :            : #include <string>
      31                 :            : 
      32                 :            : #include <xapian/attributes.h>
      33                 :            : #include <xapian/intrusive_ptr.h>
      34                 :            : #include <xapian/stem.h>
      35                 :            : #include <xapian/types.h>
      36                 :            : #include <xapian/visibility.h>
      37                 :            : 
      38                 :            : namespace Xapian {
      39                 :            : 
      40                 :            : class ESetIterator;
      41                 :            : 
      42                 :            : /// Class representing a list of search results.
      43                 :       7206 : class XAPIAN_VISIBILITY_DEFAULT ESet {
      44                 :            :     friend class ESetIterator;
      45                 :            : 
      46                 :            :   public:
      47                 :            :     /// Class representing the ESet internals.
      48                 :            :     class Internal;
      49                 :            :     /// @private @internal Reference counted internals.
      50                 :            :     Xapian::Internal::intrusive_ptr_nonnull<Internal> internal;
      51                 :            : 
      52                 :            :     /** Copying is allowed.
      53                 :            :      *
      54                 :            :      *  The internals are reference counted, so copying is cheap.
      55                 :            :      */
      56                 :            :     ESet(const ESet & o);
      57                 :            : 
      58                 :            :     /** Copying is allowed.
      59                 :            :      *
      60                 :            :      *  The internals are reference counted, so assignment is cheap.
      61                 :            :      */
      62                 :            :     ESet & operator=(const ESet & o);
      63                 :            : 
      64                 :            :     /// Move constructor.
      65                 :            :     ESet(ESet && o);
      66                 :            : 
      67                 :            :     /// Move assignment operator.
      68                 :            :     ESet & operator=(ESet && o);
      69                 :            : 
      70                 :            :     /** Default constructor.
      71                 :            :      *
      72                 :            :      *  Creates an empty ESet, mostly useful as a placeholder.
      73                 :            :      */
      74                 :            :     ESet();
      75                 :            : 
      76                 :            :     /// Destructor.
      77                 :            :     ~ESet();
      78                 :            : 
      79                 :            :     /** Return number of items in this ESet object. */
      80                 :            :     Xapian::doccount size() const;
      81                 :            : 
      82                 :            :     /** Return true if this ESet object is empty. */
      83                 :            :     bool empty() const { return size() == 0; }
      84                 :            : 
      85                 :            :     /** Return a bound on the full size of this ESet object.
      86                 :            :      *
      87                 :            :      *  This is a bound on size() if get_eset() had been called with
      88                 :            :      *  maxitems set high enough that all results were returned.
      89                 :            :      */
      90                 :            :     Xapian::termcount get_ebound() const;
      91                 :            : 
      92                 :            :     /** Efficiently swap this ESet object with another. */
      93                 :            :     void swap(ESet & o) { internal.swap(o.internal); }
      94                 :            : 
      95                 :            :     /** Return iterator pointing to the first item in this ESet. */
      96                 :            :     ESetIterator begin() const;
      97                 :            : 
      98                 :            :     /** Return iterator pointing to just after the last item in this ESet. */
      99                 :            :     ESetIterator end() const;
     100                 :            : 
     101                 :            :     /** Return iterator pointing to the i-th object in this ESet. */
     102                 :            :     ESetIterator operator[](Xapian::doccount i) const;
     103                 :            : 
     104                 :            :     /** Return iterator pointing to the last object in this ESet. */
     105                 :            :     ESetIterator back() const;
     106                 :            : 
     107                 :            :     /// Return a string describing this object.
     108                 :            :     std::string get_description() const;
     109                 :            : 
     110                 :            :     /** @private @internal ESet is what the C++ STL calls a container.
     111                 :            :      *
     112                 :            :      *  The following typedefs allow the class to be used in templates in the
     113                 :            :      *  same way the standard containers can be.
     114                 :            :      *
     115                 :            :      *  These are deliberately hidden from the Doxygen-generated docs, as the
     116                 :            :      *  machinery here isn't interesting to API users.  They just need to know
     117                 :            :      *  that Xapian container classes are compatible with the STL.
     118                 :            :      *
     119                 :            :      *  See "The C++ Programming Language", 3rd ed. section 16.3.1:
     120                 :            :      */
     121                 :            :     // @{
     122                 :            :     /// @private
     123                 :            :     typedef Xapian::ESetIterator value_type;
     124                 :            :     /// @private
     125                 :            :     typedef Xapian::termcount size_type;
     126                 :            :     /// @private
     127                 :            :     typedef Xapian::termcount_diff difference_type;
     128                 :            :     /// @private
     129                 :            :     typedef Xapian::ESetIterator iterator;
     130                 :            :     /// @private
     131                 :            :     typedef Xapian::ESetIterator const_iterator;
     132                 :            :     /// @private
     133                 :            :     typedef value_type * pointer;
     134                 :            :     /// @private
     135                 :            :     typedef const value_type * const_pointer;
     136                 :            :     /// @private
     137                 :            :     typedef value_type & reference;
     138                 :            :     /// @private
     139                 :            :     typedef const value_type & const_reference;
     140                 :            :     // @}
     141                 :            :     //
     142                 :            :     /** @private @internal ESet is what the C++ STL calls a container.
     143                 :            :      *
     144                 :            :      *  The following methods allow the class to be used in templates in the
     145                 :            :      *  same way the standard containers can be.
     146                 :            :      *
     147                 :            :      *  These are deliberately hidden from the Doxygen-generated docs, as the
     148                 :            :      *  machinery here isn't interesting to API users.  They just need to know
     149                 :            :      *  that Xapian container classes are compatible with the STL.
     150                 :            :      */
     151                 :            :     // @{
     152                 :            :     // The size is fixed once created.
     153                 :            :     Xapian::doccount max_size() const { return size(); }
     154                 :            :     // @}
     155                 :            : };
     156                 :            : 
     157                 :            : /// Iterator over a Xapian::ESet.
     158                 :       7288 : class XAPIAN_VISIBILITY_DEFAULT ESetIterator {
     159                 :            :     friend class ESet;
     160                 :            : 
     161                 :       3506 :     ESetIterator(const Xapian::ESet & eset_, Xapian::doccount off_from_end_)
     162                 :       3506 :         : eset(eset_), off_from_end(off_from_end_) { }
     163                 :            : 
     164                 :            :   public:
     165                 :            :     /** @private @internal The ESet we are iterating over. */
     166                 :            :     Xapian::ESet eset;
     167                 :            : 
     168                 :            :     /** @private @internal The current position of the iterator.
     169                 :            :      *
     170                 :            :      *  We store the offset from the end of @a eset, since that means
     171                 :            :      *  ESet::end() just needs to set this member to 0.
     172                 :            :      */
     173                 :            :     Xapian::ESet::size_type off_from_end;
     174                 :            : 
     175                 :            :     /** Create an unpositioned ESetIterator. */
     176                 :         16 :     ESetIterator() : off_from_end(0) { }
     177                 :            : 
     178                 :            :     /** Get the term at the current position. */
     179                 :            :     std::string operator*() const;
     180                 :            : 
     181                 :            :     /// Advance the iterator to the next position.
     182                 :       2822 :     ESetIterator & operator++() {
     183                 :       2822 :         --off_from_end;
     184                 :       2822 :         return *this;
     185                 :            :     }
     186                 :            : 
     187                 :            :     /// Advance the iterator to the next position (postfix version).
     188                 :         14 :     ESetIterator operator++(int) {
     189                 :         14 :         ESetIterator retval = *this;
     190                 :         14 :         --off_from_end;
     191                 :         14 :         return retval;
     192                 :            :     }
     193                 :            : 
     194                 :            :     /// Move the iterator to the previous position.
     195                 :            :     ESetIterator & operator--() {
     196                 :            :         ++off_from_end;
     197                 :            :         return *this;
     198                 :            :     }
     199                 :            : 
     200                 :            :     /// Move the iterator to the previous position (postfix version).
     201                 :            :     ESetIterator operator--(int) {
     202                 :            :         ESetIterator retval = *this;
     203                 :            :         ++off_from_end;
     204                 :            :         return retval;
     205                 :            :     }
     206                 :            : 
     207                 :            :     /** @private @internal ESetIterator is what the C++ STL calls an
     208                 :            :      *  random_access_iterator.
     209                 :            :      *
     210                 :            :      *  The following typedefs allow std::iterator_traits<> to work so that
     211                 :            :      *  this iterator can be used with the STL.
     212                 :            :      *
     213                 :            :      *  These are deliberately hidden from the Doxygen-generated docs, as the
     214                 :            :      *  machinery here isn't interesting to API users.  They just need to know
     215                 :            :      *  that Xapian iterator classes are compatible with the STL.
     216                 :            :      */
     217                 :            :     // @{
     218                 :            :     /// @private
     219                 :            :     typedef std::random_access_iterator_tag iterator_category;
     220                 :            :     /// @private
     221                 :            :     typedef std::string value_type;
     222                 :            :     /// @private
     223                 :            :     typedef Xapian::termcount_diff difference_type;
     224                 :            :     /// @private
     225                 :            :     typedef std::string * pointer;
     226                 :            :     /// @private
     227                 :            :     typedef std::string & reference;
     228                 :            :     // @}
     229                 :            : 
     230                 :            :     /// Move the iterator forwards by n positions.
     231                 :            :     ESetIterator & operator+=(difference_type n) {
     232                 :            :         off_from_end -= n;
     233                 :            :         return *this;
     234                 :            :     }
     235                 :            : 
     236                 :            :     /// Move the iterator back by n positions.
     237                 :            :     ESetIterator & operator-=(difference_type n) {
     238                 :            :         off_from_end += n;
     239                 :            :         return *this;
     240                 :            :     }
     241                 :            : 
     242                 :            :     /** Return the iterator incremented by @a n positions.
     243                 :            :      *
     244                 :            :      *  If @a n is negative, decrements by (-n) positions.
     245                 :            :      */
     246                 :            :     ESetIterator operator+(difference_type n) const {
     247                 :            :         return ESetIterator(eset, off_from_end - n);
     248                 :            :     }
     249                 :            : 
     250                 :            :     /** Return the iterator decremented by @a n positions.
     251                 :            :      *
     252                 :            :      *  If @a n is negative, increments by (-n) positions.
     253                 :            :      */
     254                 :            :     ESetIterator operator-(difference_type n) const {
     255                 :            :         return ESetIterator(eset, off_from_end + n);
     256                 :            :     }
     257                 :            : 
     258                 :            :     /** Return the number of positions between @a o and this iterator. */
     259                 :            :     difference_type operator-(const ESetIterator& o) const {
     260                 :            :         return difference_type(o.off_from_end) - difference_type(off_from_end);
     261                 :            :     }
     262                 :            : 
     263                 :            :     /** Get the weight for the current position. */
     264                 :            :     double get_weight() const;
     265                 :            : 
     266                 :            :     /// Return a string describing this object.
     267                 :            :     std::string get_description() const;
     268                 :            : };
     269                 :            : 
     270                 :            : bool
     271                 :            : XAPIAN_NOTHROW(operator==(const ESetIterator &a, const ESetIterator &b));
     272                 :            : 
     273                 :            : /// Equality test for ESetIterator objects.
     274                 :            : inline bool
     275                 :       3356 : operator==(const ESetIterator &a, const ESetIterator &b) XAPIAN_NOEXCEPT
     276                 :            : {
     277                 :       3356 :     return a.off_from_end == b.off_from_end;
     278                 :            : }
     279                 :            : 
     280                 :            : inline bool
     281                 :            : XAPIAN_NOTHROW(operator!=(const ESetIterator &a, const ESetIterator &b));
     282                 :            : 
     283                 :            : /// Inequality test for ESetIterator objects.
     284                 :            : inline bool
     285                 :       3211 : operator!=(const ESetIterator &a, const ESetIterator &b) XAPIAN_NOEXCEPT
     286                 :            : {
     287                 :       3211 :     return !(a == b);
     288                 :            : }
     289                 :            : 
     290                 :            : bool
     291                 :            : XAPIAN_NOTHROW(operator<(const ESetIterator &a, const ESetIterator &b));
     292                 :            : 
     293                 :            : /// Inequality test for ESetIterator objects.
     294                 :            : inline bool
     295                 :            : operator<(const ESetIterator &a, const ESetIterator &b) XAPIAN_NOEXCEPT
     296                 :            : {
     297                 :            :     return a.off_from_end > b.off_from_end;
     298                 :            : }
     299                 :            : 
     300                 :            : inline bool
     301                 :            : XAPIAN_NOTHROW(operator>(const ESetIterator &a, const ESetIterator &b));
     302                 :            : 
     303                 :            : /// Inequality test for ESetIterator objects.
     304                 :            : inline bool
     305                 :            : operator>(const ESetIterator &a, const ESetIterator &b) XAPIAN_NOEXCEPT
     306                 :            : {
     307                 :            :     return b < a;
     308                 :            : }
     309                 :            : 
     310                 :            : inline bool
     311                 :            : XAPIAN_NOTHROW(operator>=(const ESetIterator &a, const ESetIterator &b));
     312                 :            : 
     313                 :            : /// Inequality test for ESetIterator objects.
     314                 :            : inline bool
     315                 :            : operator>=(const ESetIterator &a, const ESetIterator &b) XAPIAN_NOEXCEPT
     316                 :            : {
     317                 :            :     return !(a < b);
     318                 :            : }
     319                 :            : 
     320                 :            : inline bool
     321                 :            : XAPIAN_NOTHROW(operator<=(const ESetIterator &a, const ESetIterator &b));
     322                 :            : 
     323                 :            : /// Inequality test for ESetIterator objects.
     324                 :            : inline bool
     325                 :            : operator<=(const ESetIterator &a, const ESetIterator &b) XAPIAN_NOEXCEPT
     326                 :            : {
     327                 :            :     return !(b < a);
     328                 :            : }
     329                 :            : 
     330                 :            : /** Return ESetIterator @a it incremented by @a n positions.
     331                 :            :  *
     332                 :            :  *  If @a n is negative, decrements by (-n) positions.
     333                 :            :  */
     334                 :            : inline ESetIterator
     335                 :            : operator+(ESetIterator::difference_type n, const ESetIterator& it)
     336                 :            : {
     337                 :            :     return it + n;
     338                 :            : }
     339                 :            : 
     340                 :            : // Inlined methods of ESet which need ESetIterator to have been defined:
     341                 :            : 
     342                 :            : inline ESetIterator
     343                 :        122 : ESet::begin() const {
     344                 :        122 :     return ESetIterator(*this, size());
     345                 :            : }
     346                 :            : 
     347                 :            : inline ESetIterator
     348                 :       3209 : ESet::end() const {
     349                 :            :     // Decrementing the result of end() needs to work, so we must pass in
     350                 :            :     // *this here.
     351                 :       3209 :     return ESetIterator(*this, 0);
     352                 :            : }
     353                 :            : 
     354                 :            : inline ESetIterator
     355                 :        161 : ESet::operator[](Xapian::doccount i) const {
     356                 :        161 :     return ESetIterator(*this, size() - i);
     357                 :            : }
     358                 :            : 
     359                 :            : inline ESetIterator
     360                 :         14 : ESet::back() const {
     361                 :         14 :     return ESetIterator(*this, 1);
     362                 :            : }
     363                 :            : 
     364                 :            : }
     365                 :            : 
     366                 :            : #endif // XAPIAN_INCLUDED_ESET_H

Generated by: LCOV version 1.11