LCOV - code coverage report
Current view: top level - common - bitstream.h (source / functions) Hit Total Coverage
Test: Test Coverage for xapian-core c2b6f1024d3a Lines: 44 44 100.0 %
Date: 2019-05-16 09:13:18 Functions: 16 16 100.0 %
Branches: 5 8 62.5 %

           Branch data     Line data    Source code
       1                 :            : /** @file bitstream.h
       2                 :            :  * @brief Classes to encode/decode a bitstream.
       3                 :            :  */
       4                 :            : /* Copyright (C) 2004,2005,2006,2008,2012,2013,2014,2017,2018 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_BITSTREAM_H
      23                 :            : #define XAPIAN_INCLUDED_BITSTREAM_H
      24                 :            : 
      25                 :            : #include <xapian/types.h>
      26                 :            : 
      27                 :            : #include "api/smallvector.h"
      28                 :            : 
      29                 :            : #include <string>
      30                 :            : #include <vector>
      31                 :            : 
      32                 :            : namespace Xapian {
      33                 :            : 
      34                 :            : /// Create a stream to which non-byte-aligned values can be written.
      35                 :     421004 : class BitWriter {
      36                 :            :     std::string buf;
      37                 :            :     int n_bits;
      38                 :            :     Xapian::termpos acc;
      39                 :            : 
      40                 :            :   public:
      41                 :            :     /// Construct empty.
      42                 :            :     BitWriter() : n_bits(0), acc(0) { }
      43                 :            : 
      44                 :            :     /// Construct with the contents of seed already in the stream.
      45                 :     210502 :     explicit BitWriter(const std::string & seed)
      46                 :     210502 :         : buf(seed), n_bits(0), acc(0) { }
      47                 :            : 
      48                 :            :     /// Encode value, known to be less than outof.
      49                 :            :     void encode(Xapian::termpos value, Xapian::termpos outof);
      50                 :            : 
      51                 :            :     /// Finish encoding and return the encoded data as a std::string.
      52                 :     210502 :     std::string & freeze() {
      53         [ +  + ]:     210502 :         if (n_bits) {
      54                 :     170375 :             buf += char(acc);
      55                 :     170375 :             n_bits = 0;
      56                 :     170375 :             acc = 0;
      57                 :            :         }
      58                 :     210502 :         return buf;
      59                 :            :     }
      60                 :            : 
      61                 :            :     /// Perform interpolative encoding of pos elements between j and k.
      62                 :            :     void encode_interpolative(const Xapian::VecCOW<Xapian::termpos> &pos, int j, int k);
      63                 :            : };
      64                 :            : 
      65                 :            : /// Read a stream created by BitWriter.
      66                 :     157764 : class BitReader {
      67                 :            :     const char* p;
      68                 :            : 
      69                 :            :     const char* end;
      70                 :            : 
      71                 :            :     int n_bits;
      72                 :            : 
      73                 :            :     Xapian::termpos acc;
      74                 :            : 
      75                 :            :     Xapian::termpos read_bits(int count);
      76                 :            : 
      77                 :      78882 :     struct DIStack {
      78                 :            :         int j, k;
      79                 :            :         Xapian::termpos pos_k;
      80                 :            :     };
      81                 :            : 
      82                 :            :     struct DIState : public DIStack {
      83                 :            :         Xapian::termpos pos_j;
      84                 :            : 
      85                 :      37686 :         void set_j(int j_, Xapian::termpos pos_j_) {
      86                 :      37686 :             j = j_;
      87                 :      37686 :             pos_j = pos_j_;
      88                 :      37686 :         }
      89                 :      72505 :         void set_k(int k_, Xapian::termpos pos_k_) {
      90                 :      72505 :             k = k_;
      91                 :      72505 :             pos_k = pos_k_;
      92                 :      72505 :         }
      93                 :      81577 :         void uninit() {
      94                 :      81577 :             j = 1;
      95                 :      81577 :             k = 0;
      96                 :      81577 :         }
      97                 :     157764 :         DIState() { uninit(); }
      98                 :            :         DIState(int j_, int k_,
      99                 :            :                 Xapian::termpos pos_j_, Xapian::termpos pos_k_) {
     100                 :            :             set_j(j_, pos_j_);
     101                 :            :             set_k(k_, pos_k_);
     102                 :            :         }
     103                 :      34789 :         void operator=(const DIStack & o) {
     104                 :      34789 :             j = o.j;
     105                 :      34789 :             set_k(o.k, o.pos_k);
     106                 :      34789 :         }
     107                 :     147798 :         bool is_next() const { return j + 1 < k; }
     108                 :            :         bool is_initialized() const {
     109                 :            :             return j <= k;
     110                 :            :         }
     111                 :            :         // Given pos[j] = pos_j and pos[k] = pos_k, how many possible position
     112                 :            :         // values are there for the value midway between?
     113                 :      34819 :         Xapian::termpos outof() const {
     114                 :      34819 :             return pos_k - pos_j - Xapian::termpos(k - j) + 1;
     115                 :            :         }
     116                 :            :     };
     117                 :            : 
     118                 :            :     std::vector<DIStack> di_stack;
     119                 :            :     DIState di_current;
     120                 :            : 
     121                 :            :   public:
     122                 :            :     // Construct.
     123                 :     155874 :     BitReader() { }
     124                 :            : 
     125                 :            :     // Construct and set data.
     126                 :        945 :     BitReader(const char* p_, const char* end_)
     127                 :        945 :         : p(p_), end(end_), n_bits(0), acc(0) { }
     128                 :            : 
     129                 :            :     // Initialise with fresh data.
     130                 :       2695 :     void init(const char* p_, const char* end_) {
     131                 :       2695 :         p = p_;
     132                 :       2695 :         end = end_;
     133                 :       2695 :         n_bits = 0;
     134                 :       2695 :         acc = 0;
     135                 :       2695 :         di_stack.clear();
     136                 :       2695 :         di_current.uninit();
     137                 :       2695 :     }
     138                 :            : 
     139                 :            :     // Decode value, known to be less than outof.
     140                 :            :     Xapian::termpos decode(Xapian::termpos outof, bool force = false);
     141                 :            : 
     142                 :            :     // Check all the data has been read.  Because it'll be zero padded
     143                 :            :     // to fill a byte, the best we can actually do is check that
     144                 :            :     // there's less than a byte left and that all remaining bits are
     145                 :            :     // zero.
     146                 :        152 :     bool check_all_gone() const {
     147 [ +  - ][ +  - ]:        152 :         return (p == end && n_bits <= 7 && acc == 0);
                 [ +  - ]
     148                 :            :     }
     149                 :            : 
     150                 :            :     /// Perform interpolative decoding between elements between j and k.
     151                 :            :     void decode_interpolative(int j, int k,
     152                 :            :                               Xapian::termpos pos_j, Xapian::termpos pos_k);
     153                 :            : 
     154                 :            :     /// Perform on-demand interpolative decoding.
     155                 :            :     Xapian::termpos decode_interpolative_next();
     156                 :            : };
     157                 :            : 
     158                 :            : }
     159                 :            : 
     160                 :            : using Xapian::BitWriter;
     161                 :            : using Xapian::BitReader;
     162                 :            : 
     163                 :            : #endif // XAPIAN_INCLUDED_BITSTREAM_H

Generated by: LCOV version 1.11