xapian-applications/omega/sample.h

   1 /* sample.h: generate a sample from a utf-8 string.
   2  *
   3  * Copyright (C) 2007 Olly Betts
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  18  */
  19
  20 #ifndef OMEGA_INCLUDED_SAMPLE_H
  21 #define OMEGA_INCLUDED_SAMPLE_H
  22
  23 #include <string>
  24
  25 /* Take a utf-8 string and clean up whitespace to produce a sample of at most
  26  * maxlen bytes.  If the input string is too long, we try to avoid truncating
  27  * mid word, and then append " ..." (or "..." if we have to truncate a word).
  28  */
  29 std::string generate_sample(const std::string & input, size_t maxlen);
  30
  31 #endif // OMEGA_INCLUDED_SAMPLE_H