xapian-applications/omega/sample.h

   1 /** @file
   2  * @brief generate a sample from a utf-8 string.
   3  */
   4 /* Copyright (C) 2007,2013 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 OMEGA_INCLUDED_SAMPLE_H
  22 #define OMEGA_INCLUDED_SAMPLE_H
  23
  24 #include <string>
  25
  26 /* Take a utf-8 string and clean up whitespace to produce a sample of at most
  27  * maxlen bytes.  If the input string is too long, we try to avoid truncating
  28  * mid word, and then append ind2 (or ind if we have to truncate a word).
  29  */
  30 std::string generate_sample(const std::string & input, size_t maxlen,
  31                             const std::string & ind, const std::string & ind2);
  32
  33 #endif // OMEGA_INCLUDED_SAMPLE_H