xapian-applications/omega/utf8truncate.h

   1 /** @file
   2  * @brief truncate a utf-8 string, ideally without splitting words.
   3  */
   4 /* Copyright (C) 2007 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_UTF8TRUNCATE_H
  22 #define OMEGA_INCLUDED_UTF8TRUNCATE_H
  23
  24 #include <string>
  25
  26 /* Truncate utf-8 string value to at most maxlen characters.  If possible,
  27  * split at a word break.  If not, make sure we don't truncate a multibyte
  28  * utf-8 * character sequence.  Return true if value was truncated, false
  29  * otherwise.
  30  */
  31 bool utf8_truncate(std::string & value, std::string::size_type maxlen);
  32
  33 #endif // OMEGA_INCLUDED_UTF8TRUNCATE_H