LCOV - code coverage report
Current view: top level - common - pack.h (source / functions) Hit Total Coverage
Test: Test Coverage for xapian-core c2b6f1024d3a Lines: 148 172 86.0 %
Date: 2019-05-16 09:13:18 Functions: 22 22 100.0 %
Branches: 84 150 56.0 %

           Branch data     Line data    Source code
       1                 :            : /** @file pack.h
       2                 :            :  * @brief Pack types into strings and unpack them again.
       3                 :            :  */
       4                 :            : /* Copyright (C) 2009,2015,2016,2017,2018 Olly Betts
       5                 :            :  *
       6                 :            :  * This program is free software; you can redistribute it and/or modify
       7                 :            :  * it under the terms of the GNU General Public License as published by
       8                 :            :  * the Free Software Foundation; either version 2 of the License, or
       9                 :            :  * (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 USA
      19                 :            :  */
      20                 :            : 
      21                 :            : #ifndef XAPIAN_INCLUDED_PACK_H
      22                 :            : #define XAPIAN_INCLUDED_PACK_H
      23                 :            : 
      24                 :            : #ifndef PACKAGE
      25                 :            : # error config.h must be included first in each C++ source file
      26                 :            : #endif
      27                 :            : 
      28                 :            : #include <cstring>
      29                 :            : #include <string>
      30                 :            : #include <type_traits>
      31                 :            : 
      32                 :            : #include "omassert.h"
      33                 :            : 
      34                 :            : #include "xapian/types.h"
      35                 :            : 
      36                 :            : /** How many bits to store the length of a sortable uint in.
      37                 :            :  *
      38                 :            :  *  Setting this to 2 limits us to 2**32 documents in the database.  If set
      39                 :            :  *  to 3, then 2**64 documents are possible, but the database format isn't
      40                 :            :  *  compatible.
      41                 :            :  */
      42                 :            : const unsigned int SORTABLE_UINT_LOG2_MAX_BYTES = 2;
      43                 :            : 
      44                 :            : /// Calculated value used below.
      45                 :            : const unsigned int SORTABLE_UINT_MAX_BYTES = 1 << SORTABLE_UINT_LOG2_MAX_BYTES;
      46                 :            : 
      47                 :            : /// Calculated value used below.
      48                 :            : const unsigned int SORTABLE_UINT_1ST_BYTE_MASK =
      49                 :            :         (0xffu >> SORTABLE_UINT_LOG2_MAX_BYTES);
      50                 :            : 
      51                 :            : /** Append an encoded bool to a string.
      52                 :            :  *
      53                 :            :  *  @param s            The string to append to.
      54                 :            :  *  @param value        The bool to encode.
      55                 :            :  */
      56                 :            : inline void
      57                 :     690999 : pack_bool(std::string & s, bool value)
      58                 :            : {
      59                 :     690999 :     s += char('0' | static_cast<char>(value));
      60                 :     690999 : }
      61                 :            : 
      62                 :            : /** Decode a bool from a string.
      63                 :            :  *
      64                 :            :  *  @param p        Pointer to pointer to the current position in the string.
      65                 :            :  *  @param end      Pointer to the end of the string.
      66                 :            :  *  @param result   Where to store the result.
      67                 :            :  */
      68                 :            : inline bool
      69                 :    1110370 : unpack_bool(const char ** p, const char * end, bool * result)
      70                 :            : {
      71                 :            :     Assert(result);
      72                 :    1110370 :     const char * & ptr = *p;
      73                 :            :     Assert(ptr);
      74                 :            :     char ch;
      75 [ +  - ][ -  + ]:    1110370 :     if (rare(ptr == end || ((ch = *ptr++ - '0') &~ 1))) {
                 [ -  + ]
      76                 :          0 :         ptr = NULL;
      77                 :          0 :         return false;
      78                 :            :     }
      79                 :    1110370 :     *result = static_cast<bool>(ch);
      80                 :    1110370 :     return true;
      81                 :            : }
      82                 :            : 
      83                 :            : /** Append an encoded unsigned integer to a string as the last item.
      84                 :            :  *
      85                 :            :  *  This encoding is only suitable when this is the last thing encoded as
      86                 :            :  *  the encoding used doesn't contain its own length.
      87                 :            :  *
      88                 :            :  *  @param s            The string to append to.
      89                 :            :  *  @param value        The unsigned integer to encode.
      90                 :            :  */
      91                 :            : template<class U>
      92                 :            : inline void
      93                 :     451501 : pack_uint_last(std::string & s, U value)
      94                 :            : {
      95                 :            :     static_assert(std::is_unsigned<U>::value, "Unsigned type required");
      96                 :            : 
      97         [ +  + ]:    1337913 :     while (value) {
      98                 :     886412 :         s += char(value & 0xff);
      99                 :     886412 :         value >>= 8;
     100                 :            :     }
     101                 :     451501 : }
     102                 :            : 
     103                 :            : /** Decode an unsigned integer as the last item in a string.
     104                 :            :  *
     105                 :            :  *  @param p        Pointer to pointer to the current position in the string.
     106                 :            :  *  @param end      Pointer to the end of the string.
     107                 :            :  *  @param result   Where to store the result.
     108                 :            :  */
     109                 :            : template<class U>
     110                 :            : inline bool
     111                 :       4238 : unpack_uint_last(const char ** p, const char * end, U * result)
     112                 :            : {
     113                 :            :     static_assert(std::is_unsigned<U>::value, "Unsigned type required");
     114                 :            :     Assert(result);
     115                 :            : 
     116                 :       4238 :     const char * ptr = *p;
     117                 :            :     Assert(ptr);
     118                 :       4238 :     *p = end;
     119                 :            : 
     120                 :            :     // Check for overflow.
     121         [ -  + ]:       4238 :     if (rare(end - ptr > int(sizeof(U)))) {
     122                 :          0 :         return false;
     123                 :            :     }
     124                 :            : 
     125                 :       4238 :     *result = 0;
     126         [ +  + ]:       8183 :     while (end != ptr) {
     127                 :       3945 :         *result = (*result << 8) | U(static_cast<unsigned char>(*--end));
     128                 :            :     }
     129                 :            : 
     130                 :       4238 :     return true;
     131                 :            : }
     132                 :            : 
     133                 :            : #if HAVE_DECL___BUILTIN_CLZ && \
     134                 :            :     HAVE_DECL___BUILTIN_CLZL && \
     135                 :            :     HAVE_DECL___BUILTIN_CLZLL
     136                 :            : template<typename T>
     137                 :            : inline int
     138                 :            : do_clz(T value) {
     139                 :            :     extern int no_clz_builtin_for_this_type(T);
     140                 :            :     return no_clz_builtin_for_this_type(value);
     141                 :            : }
     142                 :            : 
     143                 :            : template<>
     144                 :            : inline int
     145                 :     730056 : do_clz(unsigned value) {
     146                 :     730056 :     return __builtin_clz(value);
     147                 :            : }
     148                 :            : 
     149                 :            : template<>
     150                 :            : inline int
     151                 :            : do_clz(unsigned long value) {
     152                 :            :     return __builtin_clzl(value);
     153                 :            : }
     154                 :            : 
     155                 :            : template<>
     156                 :            : inline int
     157                 :            : do_clz(unsigned long long value) {
     158                 :            :     return __builtin_clzll(value);
     159                 :            : }
     160                 :            : 
     161                 :            : # define HAVE_DO_CLZ
     162                 :            : #endif
     163                 :            : 
     164                 :            : /** Append an encoded unsigned integer to a string, preserving the sort order.
     165                 :            :  *
     166                 :            :  *  The appended string data will sort in the same order as the unsigned
     167                 :            :  *  integer being encoded.
     168                 :            :  *
     169                 :            :  *  Note that the first byte of the encoding will never be \xff, so it is
     170                 :            :  *  safe to store the result of this function immediately after the result of
     171                 :            :  *  pack_string_preserving_sort().
     172                 :            :  *
     173                 :            :  *  @param s            The string to append to.
     174                 :            :  *  @param value        The unsigned integer to encode.
     175                 :            :  */
     176                 :            : template<class U>
     177                 :            : inline void
     178                 :    6790533 : pack_uint_preserving_sort(std::string & s, U value)
     179                 :            : {
     180                 :            :     static_assert(std::is_unsigned<U>::value, "Unsigned type required");
     181                 :            :     static_assert(sizeof(U) <= 8,
     182                 :            :                   "Template type U too wide for database format");
     183                 :            :     // The clz() functions are undefined for 0, so handle the smallest band
     184                 :            :     // as a special case.
     185         [ +  + ]:    6790533 :     if (value < 0x8000) {
     186                 :    6789482 :         s.resize(s.size() + 2);
     187                 :    6789482 :         s[s.size() - 2] = static_cast<unsigned char>(value >> 8);
     188                 :            :         Assert(s[s.size() - 2] != '\xff');
     189                 :    6789482 :         s[s.size() - 1] = static_cast<unsigned char>(value);
     190                 :    6789482 :         return;
     191                 :            :     }
     192                 :            : 
     193                 :            : #ifdef HAVE_DO_CLZ
     194                 :       1051 :     size_t len = ((sizeof(U) * 8 + 5) - do_clz(value)) / 7;
     195                 :            : #else
     196                 :            :     size_t len = 3;
     197                 :            :     for (U x = value >> 22; x; x >>= 7) ++len;
     198                 :            : #endif
     199                 :       1051 :     unsigned mask = 0xff << (10 - len);
     200                 :            : 
     201                 :       1051 :     s.resize(s.size() + len);
     202         [ +  + ]:       3309 :     for (size_t i = 1; i != len; ++i) {
     203                 :       2258 :         s[s.size() - i] = static_cast<unsigned char>(value);
     204                 :       2258 :         value >>= 8;
     205                 :            :     }
     206                 :            : 
     207                 :       1051 :     s[s.size() - len] = static_cast<unsigned char>(value | mask);
     208                 :            :     Assert(s[s.size() - len] != '\xff');
     209                 :            : 
     210                 :            :     AssertRel(len, >, 2);
     211                 :            :     AssertRel(len, <=, 9);
     212                 :            : }
     213                 :            : 
     214                 :            : /** Decode an "sort preserved" unsigned integer from a string.
     215                 :            :  *
     216                 :            :  *  The unsigned integer must have been encoded with
     217                 :            :  *  pack_uint_preserving_sort().
     218                 :            :  *
     219                 :            :  *  @param p        Pointer to pointer to the current position in the string.
     220                 :            :  *  @param end      Pointer to the end of the string.
     221                 :            :  *  @param result   Where to store the result.
     222                 :            :  */
     223                 :            : template<class U>
     224                 :            : inline bool
     225                 :    2887659 : unpack_uint_preserving_sort(const char ** p, const char * end, U * result)
     226                 :            : {
     227                 :            :     static_assert(std::is_unsigned<U>::value, "Unsigned type required");
     228                 :            :     static_assert(sizeof(U) <= 8,
     229                 :            :                   "Template type U too wide for database format");
     230                 :            :     Assert(result);
     231                 :            : 
     232                 :    2887659 :     const char * ptr = *p;
     233                 :            :     Assert(ptr);
     234                 :            : 
     235         [ -  + ]:    2887659 :     if (rare(ptr == end)) {
     236                 :          0 :         return false;
     237                 :            :     }
     238                 :            : 
     239                 :    2887659 :     unsigned char len_byte = static_cast<unsigned char>(*ptr++);
     240         [ +  + ]:    2887659 :     if (len_byte < 0x80) {
     241                 :    2886709 :         *result = (U(len_byte) << 8) | static_cast<unsigned char>(*ptr++);
     242                 :    2886709 :         *p = ptr;
     243                 :    2886709 :         return true;
     244                 :            :     }
     245                 :            : 
     246         [ -  + ]:        950 :     if (len_byte == 0xff) {
     247                 :          0 :         return false;
     248                 :            :     }
     249                 :            : 
     250                 :            :     // len is how many bytes there are after the length byte.
     251                 :            : #ifdef HAVE_DO_CLZ
     252                 :        950 :     size_t len = do_clz(len_byte ^ 0xffu) + 9 - sizeof(unsigned) * 8;
     253                 :            : #else
     254                 :            :     size_t len = 2;
     255                 :            :     for (unsigned char m = 0x40; len_byte & m; m >>= 1) ++len;
     256                 :            : #endif
     257         [ -  + ]:        950 :     if (rare(size_t(end - ptr) < len)) {
     258                 :          0 :         return false;
     259                 :            :     }
     260                 :        950 :     unsigned mask = 0xff << (9 - len);
     261                 :        950 :     len_byte &= ~mask;
     262                 :            : 
     263                 :            :     // Check for overflow.
     264         [ -  + ]:        950 :     if (rare(len > int(sizeof(U)))) return false;
     265                 :            :     if (sizeof(U) != 8) {
     266                 :            :         // Need to check the top byte too.
     267 [ +  + ][ -  + ]:        950 :         if (rare(len == int(sizeof(U)) && len_byte != 0)) return false;
                 [ -  + ]
     268                 :            :     }
     269                 :            : 
     270                 :        950 :     end = ptr + len;
     271                 :        950 :     *p = end;
     272                 :            : 
     273                 :        950 :     U r = len_byte;
     274         [ +  + ]:       2863 :     while (ptr != end) {
     275                 :       1913 :         r = (r << 8) | U(static_cast<unsigned char>(*ptr++));
     276                 :            :     }
     277                 :        950 :     *result = r;
     278                 :            : 
     279                 :        950 :     return true;
     280                 :            : }
     281                 :            : 
     282                 :            : /** Append an encoded unsigned integer to a string.
     283                 :            :  *
     284                 :            :  *  @param s            The string to append to.
     285                 :            :  *  @param value        The unsigned integer to encode.
     286                 :            :  */
     287                 :            : template<class U>
     288                 :            : inline void
     289                 :   17168386 : pack_uint(std::string & s, U value)
     290                 :            : {
     291                 :            :     static_assert(std::is_unsigned<U>::value, "Unsigned type required");
     292                 :            : 
     293 [ +  + ][ +  + ]:   20337021 :     while (value >= 128) {
                 [ #  # ]
     294                 :    3168635 :         s += static_cast<char>(static_cast<unsigned char>(value) | 0x80);
     295                 :    3168635 :         value >>= 7;
     296                 :            :     }
     297                 :   17168386 :     s += static_cast<char>(value);
     298                 :   17168386 : }
     299                 :            : 
     300                 :            : /** Append an encoded unsigned integer (bool type) to a string.
     301                 :            :  *
     302                 :            :  *  @param s            The string to append to.
     303                 :            :  *  @param value        The unsigned integer to encode.
     304                 :            :  */
     305                 :            : template<>
     306                 :            : inline void
     307                 :            : pack_uint(std::string & s, bool value)
     308                 :            : {
     309                 :            :     s += static_cast<char>(value);
     310                 :            : }
     311                 :            : 
     312                 :            : /** Decode an unsigned integer from a string.
     313                 :            :  *
     314                 :            :  *  @param p        Pointer to pointer to the current position in the string.
     315                 :            :  *  @param end      Pointer to the end of the string.
     316                 :            :  *  @param result   Where to store the result (or NULL to just skip it).
     317                 :            :  */
     318                 :            : template<class U>
     319                 :            : inline bool
     320                 :  961128326 : unpack_uint(const char ** p, const char * end, U * result)
     321                 :            : {
     322                 :            :     static_assert(std::is_unsigned<U>::value, "Unsigned type required");
     323                 :            : 
     324                 :  961128326 :     const char * ptr = *p;
     325                 :            :     Assert(ptr);
     326                 :  961128326 :     const char * start = ptr;
     327                 :            : 
     328                 :            :     // Check the length of the encoded integer first.
     329 [ +  + ][ +  + ]:  990559719 :     do {
                 [ #  # ]
     330 [ +  + ][ -  + ]:  990559725 :         if (rare(ptr == end)) {
                 [ #  # ]
     331                 :            :             // Out of data.
     332                 :          6 :             *p = NULL;
     333                 :          6 :             return false;
     334                 :            :         }
     335                 :            :     } while (static_cast<unsigned char>(*ptr++) >= 128);
     336                 :            : 
     337                 :  961128320 :     *p = ptr;
     338                 :            : 
     339 [ +  + ][ -  + ]:  961128320 :     if (!result) return true;
                 [ #  # ]
     340                 :            : 
     341                 :  942416481 :     *result = U(*--ptr);
     342 [ +  + ][ +  + ]:  942416481 :     if (ptr == start) {
                 [ #  # ]
     343                 :            :         // Special case for small values.
     344                 :  915207344 :         return true;
     345                 :            :     }
     346                 :            : 
     347                 :   27209137 :     size_t maxbits = size_t(ptr - start) * 7;
     348 [ +  - ][ +  - ]:   27209137 :     if (maxbits <= sizeof(U) * 8) {
                 [ #  # ]
     349                 :            :         // No possibility of overflow.
     350 [ +  + ][ +  + ]:   28450645 :         do {
                 [ #  # ]
     351                 :   28450645 :             unsigned char chunk = static_cast<unsigned char>(*--ptr) & 0x7f;
     352                 :   28450645 :             *result = (*result << 7) | U(chunk);
     353                 :            :         } while (ptr != start);
     354                 :   27209137 :         return true;
     355                 :            :     }
     356                 :            : 
     357                 :          0 :     size_t minbits = maxbits - 6;
     358 [ #  # ][ #  # ]:          0 :     if (rare(minbits > sizeof(U) * 8)) {
                 [ #  # ]
     359                 :            :         // Overflow.
     360                 :          0 :         return false;
     361                 :            :     }
     362                 :            : 
     363 [ #  # ][ #  # ]:          0 :     while (--ptr != start) {
                 [ #  # ]
     364                 :          0 :         unsigned char chunk = static_cast<unsigned char>(*--ptr) & 0x7f;
     365                 :          0 :         *result = (*result << 7) | U(chunk);
     366                 :            :     }
     367                 :            : 
     368                 :          0 :     U tmp = *result;
     369                 :          0 :     *result <<= 7;
     370 [ #  # ][ #  # ]:          0 :     if (rare(*result < tmp)) {
                 [ #  # ]
     371                 :            :         // Overflow.
     372                 :          0 :         return false;
     373                 :            :     }
     374                 :          0 :     *result |= U(static_cast<unsigned char>(*ptr) & 0x7f);
     375                 :          0 :     return true;
     376                 :            : }
     377                 :            : 
     378                 :            : /** Decode an unsigned integer from a string, going backwards.
     379                 :            :  *
     380                 :            :  *  @param p        Pointer to pointer just after the position in the string.
     381                 :            :  *  @param start    Pointer to the start of the string.
     382                 :            :  *  @param result   Where to store the result (or NULL to just skip it).
     383                 :            :  */
     384                 :            : template<class U>
     385                 :            : inline bool
     386                 :         26 : unpack_uint_backwards(const char ** p, const char * start, U * result)
     387                 :            : {
     388                 :            :     static_assert(std::is_unsigned<U>::value, "Unsigned type required");
     389                 :            : 
     390                 :         26 :     const char * ptr = *p;
     391                 :            :     Assert(ptr);
     392                 :            : 
     393                 :            :     // Check it's not empty and that the final byte is valid.
     394 [ +  - ][ -  + ]:         26 :     if (rare(ptr == start || static_cast<unsigned char>(ptr[-1]) >= 128)) {
                 [ -  + ]
     395                 :            :         // Out of data.
     396                 :          0 :         *p = NULL;
     397                 :          0 :         return false;
     398                 :            :     }
     399                 :            : 
     400         [ -  + ]:         26 :     do {
     401         [ -  + ]:         26 :         if (rare(--ptr == start))
     402                 :          0 :             break;
     403                 :         26 :     } while (static_cast<unsigned char>(ptr[-1]) >= 128);
     404                 :            : 
     405                 :         26 :     const char* end = *p;
     406                 :         26 :     *p = ptr;
     407                 :         26 :     return unpack_uint(&ptr, end, result);
     408                 :            : }
     409                 :            : 
     410                 :            : /** Append an encoded std::string to a string.
     411                 :            :  *
     412                 :            :  *  @param s            The string to append to.
     413                 :            :  *  @param value        The std::string to encode.
     414                 :            :  */
     415                 :            : inline void
     416                 :     877792 : pack_string(std::string & s, const std::string & value)
     417                 :            : {
     418                 :     877792 :     pack_uint(s, value.size());
     419                 :     877792 :     s += value;
     420                 :     877792 : }
     421                 :            : 
     422                 :            : /** Append an encoded C-style string to a string.
     423                 :            :  *
     424                 :            :  *  @param s            The string to append to.
     425                 :            :  *  @param ptr          The C-style string to encode.
     426                 :            :  */
     427                 :            : inline void
     428                 :            : pack_string(std::string & s, const char * ptr)
     429                 :            : {
     430                 :            :     Assert(ptr);
     431                 :            :     size_t len = std::strlen(ptr);
     432                 :            :     pack_uint(s, len);
     433                 :            :     s.append(ptr, len);
     434                 :            : }
     435                 :            : 
     436                 :            : /** Decode a std::string from a string.
     437                 :            :  *
     438                 :            :  *  @param p        Pointer to pointer to the current position in the string.
     439                 :            :  *  @param end      Pointer to the end of the string.
     440                 :            :  *  @param result   Where to store the result.
     441                 :            :  */
     442                 :            : inline bool
     443                 :    2720766 : unpack_string(const char ** p, const char * end, std::string & result)
     444                 :            : {
     445                 :            :     size_t len;
     446         [ -  + ]:    2720766 :     if (rare(!unpack_uint(p, end, &len))) {
     447                 :          0 :         return false;
     448                 :            :     }
     449                 :            : 
     450                 :    2720766 :     const char * & ptr = *p;
     451         [ -  + ]:    2720766 :     if (rare(len > size_t(end - ptr))) {
     452                 :          0 :         ptr = NULL;
     453                 :          0 :         return false;
     454                 :            :     }
     455                 :            : 
     456         [ +  - ]:    2720766 :     result.assign(ptr, len);
     457                 :    2720766 :     ptr += len;
     458                 :    2720766 :     return true;
     459                 :            : }
     460                 :            : 
     461                 :            : /** Append an encoded std::string to a string, preserving the sort order.
     462                 :            :  *
     463                 :            :  *  The byte which follows this encoded value *must not* be \xff, or the sort
     464                 :            :  *  order won't be correct.  You may need to store a padding byte (\0 say) to
     465                 :            :  *  ensure this.  Note that pack_uint_preserving_sort() can never produce
     466                 :            :  *  \xff as its first byte so is safe to use immediately afterwards.
     467                 :            :  *
     468                 :            :  *  @param s            The string to append to.
     469                 :            :  *  @param value        The std::string to encode.
     470                 :            :  *  @param last         If true, this is the last thing to be encoded in this
     471                 :            :  *                      string - see note below (default: false)
     472                 :            :  *
     473                 :            :  *  It doesn't make sense to use pack_string_preserving_sort() if nothing can
     474                 :            :  *  ever follow, but if optional items can, you can set last=true in cases
     475                 :            :  *  where nothing does and get a shorter encoding in those cases.
     476                 :            :  */
     477                 :            : inline void
     478                 :    5092827 : pack_string_preserving_sort(std::string & s, const std::string & value,
     479                 :            :                             bool last = false)
     480                 :            : {
     481                 :    5092827 :     std::string::size_type b = 0, e;
     482         [ +  + ]:    5097523 :     while ((e = value.find('\0', b)) != std::string::npos) {
     483                 :       4696 :         ++e;
     484                 :       4696 :         s.append(value, b, e - b);
     485                 :       4696 :         s += '\xff';
     486                 :       4696 :         b = e;
     487                 :            :     }
     488                 :    5092827 :     s.append(value, b, std::string::npos);
     489         [ +  + ]:    5092827 :     if (!last) s += '\0';
     490                 :    5092827 : }
     491                 :            : 
     492                 :            : /** Decode a "sort preserved" std::string from a string.
     493                 :            :  *
     494                 :            :  *  The std::string must have been encoded with pack_string_preserving_sort().
     495                 :            :  *
     496                 :            :  *  @param p        Pointer to pointer to the current position in the string.
     497                 :            :  *  @param end      Pointer to the end of the string.
     498                 :            :  *  @param result   Where to store the result.
     499                 :            :  */
     500                 :            : inline bool
     501                 :    1422017 : unpack_string_preserving_sort(const char ** p, const char * end,
     502                 :            :                               std::string & result)
     503                 :            : {
     504                 :    1422017 :     result.resize(0);
     505                 :            : 
     506                 :    1422017 :     const char *ptr = *p;
     507                 :            :     Assert(ptr);
     508                 :            : 
     509         [ +  + ]:    8462368 :     while (ptr != end) {
     510                 :    7946815 :         char ch = *ptr++;
     511         [ +  + ]:    7946815 :         if (rare(ch == '\0')) {
     512 [ +  - ][ +  + ]:     906491 :             if (usual(ptr == end || *ptr != '\xff')) {
                 [ +  + ]
     513                 :     906464 :                 break;
     514                 :            :             }
     515                 :         27 :             ++ptr;
     516                 :            :         }
     517                 :    7040351 :         result += ch;
     518                 :            :     }
     519                 :    1422017 :     *p = ptr;
     520                 :    1422017 :     return true;
     521                 :            : }
     522                 :            : 
     523                 :            : inline std::string
     524                 :    1768592 : pack_glass_postlist_key(const std::string &term)
     525                 :            : {
     526                 :            :     // Special case for doclen lists.
     527         [ +  + ]:    1768592 :     if (term.empty())
     528         [ +  - ]:      18980 :         return std::string("\x00\xe0", 2);
     529                 :            : 
     530         [ +  - ]:    1749612 :     std::string key;
     531         [ +  - ]:    1749612 :     pack_string_preserving_sort(key, term, true);
     532                 :    1768592 :     return key;
     533                 :            : }
     534                 :            : 
     535                 :            : inline std::string
     536                 :     490530 : pack_glass_postlist_key(const std::string &term, Xapian::docid did)
     537                 :            : {
     538                 :            :     // Special case for doclen lists.
     539         [ +  + ]:     490530 :     if (term.empty()) {
     540         [ +  - ]:     148755 :         std::string key("\x00\xe0", 2);
     541         [ +  - ]:     148755 :         pack_uint_preserving_sort(key, did);
     542                 :     148755 :         return key;
     543                 :            :     }
     544                 :            : 
     545         [ +  - ]:     341775 :     std::string key;
     546         [ +  - ]:     341775 :     pack_string_preserving_sort(key, term);
     547         [ +  - ]:     341775 :     pack_uint_preserving_sort(key, did);
     548                 :     490530 :     return key;
     549                 :            : }
     550                 :            : 
     551                 :            : inline std::string
     552                 :        210 : pack_honey_postlist_key(const std::string& term)
     553                 :            : {
     554                 :            :     Assert(!term.empty());
     555                 :        210 :     std::string key;
     556         [ +  - ]:        210 :     pack_string_preserving_sort(key, term, true);
     557                 :        210 :     return key;
     558                 :            : }
     559                 :            : 
     560                 :            : inline std::string
     561                 :         89 : pack_honey_postlist_key(const std::string& term, Xapian::docid did)
     562                 :            : {
     563                 :            :     Assert(!term.empty());
     564                 :         89 :     std::string key;
     565         [ +  - ]:         89 :     pack_string_preserving_sort(key, term);
     566         [ +  - ]:         89 :     pack_uint_preserving_sort(key, did);
     567                 :         89 :     return key;
     568                 :            : }
     569                 :            : 
     570                 :            : #endif // XAPIAN_INCLUDED_PACK_H

Generated by: LCOV version 1.11