LCOV - code coverage report
Current view: top level - backends/honey - honey_alldocspostlist.h (source / functions) Hit Total Coverage
Test: Test Coverage for xapian-core 7822d31adece Lines: 29 30 96.7 %
Date: 2019-05-23 11:15:29 Functions: 7 7 100.0 %
Branches: 13 18 72.2 %

           Branch data     Line data    Source code
       1                 :            : /** @file honey_alldocspostlist.h
       2                 :            :  * @brief A PostList which iterates over all documents in a HoneyDatabase.
       3                 :            :  */
       4                 :            : /* Copyright (C) 2006,2007,2008,2009,2017,2018 Olly Betts
       5                 :            :  * Copyright (C) 2008 Lemur Consulting Ltd
       6                 :            :  *
       7                 :            :  * This program is free software; you can redistribute it and/or modify
       8                 :            :  * it under the terms of the GNU General Public License as published by
       9                 :            :  * the Free Software Foundation; either version 2 of the License, or
      10                 :            :  * (at your option) any later version.
      11                 :            :  *
      12                 :            :  * This program is distributed in the hope that it will be useful,
      13                 :            :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      14                 :            :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      15                 :            :  * GNU General Public License for more details.
      16                 :            :  *
      17                 :            :  * You should have received a copy of the GNU General Public License
      18                 :            :  * along with this program; if not, write to the Free Software
      19                 :            :  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
      20                 :            :  */
      21                 :            : 
      22                 :            : #ifndef XAPIAN_INCLUDED_HONEY_ALLDOCSPOSTLIST_H
      23                 :            : #define XAPIAN_INCLUDED_HONEY_ALLDOCSPOSTLIST_H
      24                 :            : 
      25                 :            : #ifndef PACKAGE
      26                 :            : # error config.h must be included first in each C++ source file
      27                 :            : #endif
      28                 :            : 
      29                 :            : #include "api/leafpostlist.h"
      30                 :            : #include "honey_defs.h"
      31                 :            : #include "pack.h"
      32                 :            : #include "wordaccess.h"
      33                 :            : 
      34                 :            : #include <string>
      35                 :            : 
      36                 :            : class HoneyCursor;
      37                 :            : class HoneyDatabase;
      38                 :            : 
      39                 :            : namespace Honey {
      40                 :            : 
      41                 :            : /** Generate a key for a doclen chunk. */
      42                 :            : inline std::string
      43                 :        512 : make_doclenchunk_key(Xapian::docid last_did)
      44                 :            : {
      45         [ +  - ]:        512 :     std::string key(1, '\0');
      46                 :            :     Assert(last_did != 0);
      47                 :            : #ifdef DO_CLZ
      48                 :            :     int width = (do_clz(last_did) >> 3) + 1;
      49                 :            : #else
      50                 :        512 :     int width = 0;
      51         [ +  + ]:       1047 :     for (auto v = last_did; v; v >>= 8) {
      52                 :        535 :         ++width;
      53                 :            :     }
      54                 :            : #endif
      55         [ +  - ]:        512 :     key += char(Honey::KEY_DOCLEN_CHUNK + width - 1);
      56                 :        512 :     Xapian::docid v = last_did;
      57                 :            : #ifndef WORDS_BIGENDIAN
      58                 :        512 :     v = do_bswap(v);
      59                 :            : #endif
      60         [ +  - ]:        512 :     key.append(reinterpret_cast<const char*>(&v) + (sizeof(v) - width), width);
      61                 :        512 :     return key;
      62                 :            : }
      63                 :            : 
      64                 :            : inline Xapian::docid
      65                 :        288 : docid_from_key(const std::string& key)
      66                 :            : {
      67                 :        288 :     const char* p = key.data();
      68                 :        288 :     const char* end = p + key.length();
      69 [ +  + ][ +  + ]:        288 :     if (end - p < 3 || *p++ != '\0') {
                 [ +  + ]
      70                 :            :         // Not a doclen chunk key.
      71                 :         21 :         return 0;
      72                 :            :     }
      73                 :        267 :     unsigned char code = *p++;
      74 [ +  - ][ -  + ]:        267 :     if (code < Honey::KEY_DOCLEN_CHUNK || code > Honey::KEY_DOCLEN_CHUNK_HI) {
      75                 :            :         // Also not a doclen chunk key.
      76                 :          0 :         return 0;
      77                 :            :     }
      78                 :            : 
      79                 :        267 :     size_t width = (code - Honey::KEY_DOCLEN_CHUNK) + 1;
      80                 :            :     AssertEq(width, size_t(end - p));
      81                 :        267 :     Xapian::docid v = 0;
      82                 :        267 :     memcpy(reinterpret_cast<char*>(&v) + (sizeof(v) - width), p, width);
      83                 :            : #ifndef WORDS_BIGENDIAN
      84                 :        267 :     v = do_bswap(v);
      85                 :            : #endif
      86                 :            :     Assert(v != 0);
      87                 :        288 :     return v;
      88                 :            : }
      89                 :            : 
      90                 :            : class DocLenChunkReader {
      91                 :            :     unsigned const char *p;
      92                 :            :     unsigned const char *end;
      93                 :            : 
      94                 :            :     Xapian::docid did;
      95                 :            : 
      96                 :            :     Xapian::termcount doclen;
      97                 :            : 
      98                 :            :     unsigned width;
      99                 :            : 
     100                 :            :     bool read_doclen(const unsigned char* q);
     101                 :            : 
     102                 :            :   public:
     103                 :            :     /// Create a DocLenChunkReader which is already at_end().
     104                 :        347 :     DocLenChunkReader() : p(NULL) { }
     105                 :            : 
     106                 :            :     /// Update to use the chunk currently pointed to by @a cursor.
     107                 :            :     bool update(HoneyCursor* cursor);
     108                 :            : 
     109                 :       4892 :     bool at_end() const { return p == NULL; }
     110                 :            : 
     111                 :       6834 :     Xapian::docid get_docid() const { return did; }
     112                 :            : 
     113                 :   19025016 :     Xapian::termcount get_doclength() const { return doclen; }
     114                 :            : 
     115                 :            :     bool next();
     116                 :            : 
     117                 :            :     bool skip_to(Xapian::docid target);
     118                 :            : 
     119                 :            :     /** Searches the whole chunk (skip_to() only advances).
     120                 :            :      *
     121                 :            :      *  Don't call this method and any of next()/skip_to()/at_end() on the same
     122                 :            :      *  object (unless there's an intervening call to update()).
     123                 :            :      *
     124                 :            :      *  Return false if this isn't the right chunk.
     125                 :            :      */
     126                 :            :     bool find_doclength(Xapian::docid target);
     127                 :            : 
     128                 :            :     /// Return the last document length in this chunk.
     129                 :         19 :     Xapian::termcount back() {
     130                 :         19 :         (void)read_doclen(end - width);
     131                 :         19 :         return doclen;
     132                 :            :     }
     133                 :            : };
     134                 :            : 
     135                 :            : }
     136                 :            : 
     137                 :            : class HoneyAllDocsPostList : public LeafPostList {
     138                 :            :     /// Don't allow assignment.
     139                 :            :     HoneyAllDocsPostList& operator=(const HoneyAllDocsPostList&) = delete;
     140                 :            : 
     141                 :            :     /// Don't allow copying.
     142                 :            :     HoneyAllDocsPostList(const HoneyAllDocsPostList&) = delete;
     143                 :            : 
     144                 :            :     /// Cursor on the postlist table.
     145                 :            :     HoneyCursor* cursor;
     146                 :            : 
     147                 :            :     Honey::DocLenChunkReader reader;
     148                 :            : 
     149                 :            :     /// The number of documents in the database.
     150                 :            :     Xapian::doccount doccount;
     151                 :            : 
     152                 :            :   public:
     153                 :            :     HoneyAllDocsPostList(const HoneyDatabase* db_, Xapian::doccount doccount_);
     154                 :            : 
     155                 :            :     ~HoneyAllDocsPostList();
     156                 :            : 
     157                 :            :     Xapian::doccount get_termfreq() const;
     158                 :            : 
     159                 :            :     Xapian::termcount get_doclength() const;
     160                 :            : 
     161                 :            :     Xapian::docid get_docid() const;
     162                 :            : 
     163                 :            :     Xapian::termcount get_wdf() const;
     164                 :            : 
     165                 :            :     bool at_end() const;
     166                 :            : 
     167                 :            :     PostList* next(double w_min);
     168                 :            : 
     169                 :            :     PostList* skip_to(Xapian::docid did, double w_min);
     170                 :            : 
     171                 :            :     PostList* check(Xapian::docid did, double w_min, bool& valid);
     172                 :            : 
     173                 :            :     std::string get_description() const;
     174                 :            : };
     175                 :            : 
     176                 :            : #endif // XAPIAN_INCLUDED_HONEY_ALLDOCSPOSTLIST_H

Generated by: LCOV version 1.11