src/support/docstring.h

   1 // -*- C++ -*-
   2 /**
   3  * \file docstring.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Georg Baum
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef LYX_DOCSTRING_H
  14 #define LYX_DOCSTRING_H
  15
  16 #include "support/strfwd.h"
  17
  18 #include <string>
  19
  20 namespace lyx {
  21
  22 /// Creates a docstring from a C string of ASCII characters
  23 docstring const from_ascii(char const *);
  24
  25 /// Creates a docstring from a std::string of ASCII characters
  26 docstring const from_ascii(std::string const &);
  27
  28 /// Creates a std::string of ASCII characters from a docstring
  29 std::string const to_ascii(docstring const &);
  30
  31 /// Creates a docstring from a UTF8 string. This should go eventually.
  32 docstring const from_utf8(std::string const &);
  33
  34 /// Creates a UTF8 string from a docstring. This should go eventually.
  35 std::string const to_utf8(docstring const &);
  36
  37 /// convert \p s from the encoding of the locale to ucs4.
  38 docstring const from_local8bit(std::string const & s);
  39
  40 /**
  41  * Convert \p s from ucs4 to the encoding of the locale.
  42  * This may fail and throw an exception, the caller is expected to act
  43  * appropriately.
  44  */
  45 std::string const to_local8bit(docstring const & s);
  46
  47 /// convert \p s from the encoding of the file system to ucs4.
  48 docstring const from_filesystem8bit(std::string const & s);
  49
  50 /// convert \p s from ucs4 to the encoding of the file system.
  51 std::string const to_filesystem8bit(docstring const & s);
  52
  53 /// convert \p s from ucs4 to the \p encoding.
  54 std::string const to_iconv_encoding(docstring const & s,
  55                                     std::string const & encoding);
  56
  57 /// convert \p s from \p encoding to ucs4.
  58 docstring const from_iconv_encoding(std::string const & s,
  59                                     std::string const & encoding);
  60
  61 /// normalize \p s to precomposed form c
  62 docstring const normalize_c(docstring const & s);
  63
  64 /// Compare a docstring with a C string of ASCII characters
  65 bool operator==(docstring const &, char const *);
  66
  67 /// Compare a C string of ASCII characters with a docstring
  68 inline bool operator==(char const * l, docstring const & r) { return r == l; }
  69
  70 /// Compare a docstring with a C string of ASCII characters
  71 inline bool operator!=(docstring const & l, char const * r) { return !(l == r); }
  72
  73 /// Compare a C string of ASCII characters with a docstring
  74 inline bool operator!=(char const * l, docstring const & r) { return !(r == l); }
  75
  76 /// Concatenate a docstring and a C string of ASCII characters
  77 docstring operator+(docstring const &, char const *);
  78
  79 /// Concatenate a C string of ASCII characters and a docstring
  80 docstring operator+(char const *, docstring const &);
  81
  82 /// Concatenate a docstring and a single ASCII character
  83 docstring operator+(docstring const & l, char r);
  84
  85 /// Concatenate a single ASCII character and a docstring
  86 docstring operator+(char l, docstring const & r);
  87
  88 /// Append a C string of ASCII characters to a docstring
  89 docstring & operator+=(docstring &, char const *);
  90
  91 /// Append a single ASCII character to a docstring
  92 docstring & operator+=(docstring & l, char r);
  93
  94 } // namespace lyx
  95
  96 #endif