src/support/docstream.C

   1 /**
   2  * \file docstream.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Georg Baum
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "docstream.h"
  14 #include "unicode.h"
  15
  16 #include <cerrno>
  17 #include <cstdio>
  18 #include <iconv.h>
  19 #include <locale>
  20
  21
  22 using lyx::ucs4_codeset;
  23 using lyx::ucs2_codeset;
  24
  25 using std::string;
  26
  27
  28 namespace {
  29
  30 char const * utf8_codeset = "UTF-8";
  31
  32 // We use C IO throughout this file, because the facets might be used with
  33 // lyxerr in the future.
  34
  35
  36 /// codecvt facet for conversion of UCS4 (internal representation) to UTF8
  37 /// (external representation) or vice versa
  38 class iconv_codecvt_facet : public std::codecvt<lyx::char_type, char, std::mbstate_t>
  39 {
  40         typedef std::codecvt<lyx::char_type, char, std::mbstate_t> base;
  41 public:
  42         /// Constructor. You have to specify with \p inout whether you want
  43         /// to use this facet only for input, only for output or for both.
  44         explicit iconv_codecvt_facet(string const & encoding = "UTF-8",
  45                         std::ios_base::openmode inout = std::ios_base::in | std::ios_base::out,
  46                         size_t refs = 0)
  47                 : base(refs), utf8_(encoding == "UTF-8")
  48         {
  49                 if (inout & std::ios_base::in) {
  50                         in_cd_ = iconv_open(ucs4_codeset, encoding.c_str());
  51                         if (in_cd_ == (iconv_t)(-1)) {
  52                                 fprintf(stderr, "Error %d returned from iconv_open(in_cd_): %s\n",
  53                                         errno, strerror(errno));
  54                                 fflush(stderr);
  55                                 throw lyx::iconv_codecvt_facet_exception();
  56                         }
  57                 } else
  58                         in_cd_ = (iconv_t)(-1);
  59                 if (inout & std::ios_base::out) {
  60                         out_cd_ = iconv_open(encoding.c_str(), ucs4_codeset);
  61                         if (out_cd_ == (iconv_t)(-1)) {
  62                                 fprintf(stderr, "Error %d returned from iconv_open(out_cd_): %s\n",
  63                                         errno, strerror(errno));
  64                                 fflush(stderr);
  65                                 throw lyx::iconv_codecvt_facet_exception();
  66                         }
  67                 } else
  68                         out_cd_ = (iconv_t)(-1);
  69         }
  70 protected:
  71         virtual ~iconv_codecvt_facet()
  72         {
  73                 if (in_cd_ != (iconv_t)(-1))
  74                         if (iconv_close(in_cd_) == -1) {
  75                                 fprintf(stderr, "Error %d returned from iconv_close(in_cd_): %s\n",
  76                                         errno, strerror(errno));
  77                                 fflush(stderr);
  78                         }
  79                 if (out_cd_ != (iconv_t)(-1))
  80                         if (iconv_close(out_cd_) == -1) {
  81                                 fprintf(stderr, "Error %d returned from iconv_close(out_cd_): %s\n",
  82                                         errno, strerror(errno));
  83                                 fflush(stderr);
  84                         }
  85         }
  86         virtual result do_out(state_type &, intern_type const * from,
  87                         intern_type const * from_end, intern_type const *& from_next,
  88                         extern_type * to, extern_type * to_end,
  89                         extern_type *& to_next) const
  90         {
  91                 size_t inbytesleft = (from_end - from) * sizeof(intern_type);
  92                 size_t outbytesleft = (to_end - to) * sizeof(extern_type);
  93                 from_next = from;
  94                 to_next = to;
  95                 return do_iconv(out_cd_, reinterpret_cast<char const **>(&from_next),
  96                                 &inbytesleft, &to_next, &outbytesleft);
  97         }
  98         virtual result do_unshift(state_type &, extern_type * to,
  99                         extern_type *, extern_type *& to_next) const
 100         {
 101                 // utf8 does not use shifting
 102                 to_next = to;
 103                 return base::noconv;
 104         }
 105         virtual result do_in(state_type &,
 106                         extern_type const * from, extern_type const * from_end,
 107                         extern_type const *& from_next,
 108                         intern_type * to, intern_type * to_end,
 109                         intern_type *& to_next) const
 110         {
 111                 size_t inbytesleft = (from_end - from) * sizeof(extern_type);
 112                 size_t outbytesleft = (to_end - to) * sizeof(intern_type);
 113                 from_next = from;
 114                 to_next = to;
 115                 return do_iconv(in_cd_, &from_next, &inbytesleft,
 116                                 reinterpret_cast<char **>(&to_next),
 117                                 &outbytesleft);
 118         }
 119         virtual int do_encoding() const throw()
 120         {
 121                 return 0;
 122         }
 123         virtual bool do_always_noconv() const throw()
 124         {
 125                 return false;
 126         }
 127         virtual int do_length(state_type & /*state*/, extern_type const * from,
 128                         extern_type const * end, size_t max) const
 129         {
 130                 // The docs are a bit unclear about this method.
 131                 // It seems that we should calculate the actual length of the
 132                 // converted sequence, but that would not make sense, since
 133                 // once could just do the conversion directly.
 134                 // Therefore we just return the number of unconverted
 135                 // characters, since that is the best guess we can do.
 136 #if 0
 137                 intern_type * to = new intern_type[max];
 138                 intern_type * to_end = to + max;
 139                 intern_type * to_next = to;
 140                 extern_type const * from_next = from;
 141                 do_in(state, from, end, from_next, to, to_end, to_next);
 142                 delete[] to;
 143                 return to_next - to;
 144 #else
 145                 size_t const length = end - from;
 146                 return std::min(length, max);
 147 #endif
 148         }
 149         virtual int do_max_length() const throw()
 150         {
 151                 // UTF8 uses at most 4 bytes to represent one UCS4 code point
 152                 // (see RFC 3629). RFC 2279 specifies 6 bytes, but that
 153                 // information is outdated, and RFC 2279 has been superseded by
 154                 // RFC 3629.
 155                 // All other encodings encode one UCS4 code point in one byte
 156                 // (and can therefore only encode a subset of UCS4)
 157                 return utf8_ ? 4 : 1;
 158         }
 159 private:
 160         /// Do the actual conversion. The interface is equivalent to that of
 161         /// iconv() (but const correct).
 162         inline base::result do_iconv(iconv_t cd, char const ** from,
 163                         size_t * inbytesleft, char ** to, size_t * outbytesleft) const
 164         {
 165                 char const * to_start = *to;
 166                 size_t converted = iconv(cd, const_cast<char ICONV_CONST **>(from),
 167                                 inbytesleft, to, outbytesleft);
 168                 if (converted == (size_t)(-1)) {
 169                         switch(errno) {
 170                         case EINVAL:
 171                         case E2BIG:
 172                                 return base::partial;
 173                         case EILSEQ:
 174                         default:
 175                                 fprintf(stderr, "Error %d returned from iconv: %s\n",
 176                                         errno, strerror(errno));
 177                                 fflush(stderr);
 178                                 return base::error;
 179                         }
 180                 }
 181                 if (*to == to_start)
 182                         return base::noconv;
 183                 return base::ok;
 184         }
 185         iconv_t in_cd_;
 186         iconv_t out_cd_;
 187         /// Is the narrow encoding UTF8?
 188         bool utf8_;
 189 };
 190
 191 } // namespace anon
 192
 193
 194 namespace lyx {
 195
 196
 197 const char * iconv_codecvt_facet_exception::what() const throw()
 198 {
 199         return "iconv problem in iconv_codecvt_facet initialization";
 200 }
 201
 202
 203 idocfstream::idocfstream() : base()
 204 {
 205         std::locale global;
 206         std::locale locale(global, new iconv_codecvt_facet(utf8_codeset, in));
 207         imbue(locale);
 208 }
 209
 210
 211 idocfstream::idocfstream(const char* s, std::ios_base::openmode mode)
 212         : base()
 213 {
 214         // We must imbue the stream before openening the file
 215         std::locale global;
 216         std::locale locale(global, new iconv_codecvt_facet(utf8_codeset, in));
 217         imbue(locale);
 218         open(s, mode);
 219 }
 220
 221
 222 odocfstream::odocfstream(string const & encoding) : base()
 223 {
 224         std::locale global;
 225         std::locale locale(global, new iconv_codecvt_facet(encoding, out));
 226         imbue(locale);
 227 }
 228
 229
 230 odocfstream::odocfstream(const char* s, std::ios_base::openmode mode,
 231                          string const & encoding)
 232         : base()
 233 {
 234         // We must imbue the stream before openening the file
 235         std::locale global;
 236         std::locale locale(global, new iconv_codecvt_facet(encoding, out));
 237         imbue(locale);
 238         open(s, mode);
 239 }
 240
 241 }
 242
 243 #if (!defined(HAVE_WCHAR_T) || SIZEOF_WCHAR_T != 4) && defined(__GNUC__)
 244 // We get undefined references to these virtual methods. This looks like
 245 // a bug in gcc. The implementation here does not do anything useful, since
 246 // it is overriden in iconv_codecvt_facet.
 247 namespace std {
 248 template<> codecvt<lyx::char_type, char, mbstate_t>::result
 249 codecvt<lyx::char_type, char, mbstate_t>::do_out(mbstate_t &, const lyx::char_type *, const lyx::char_type *, const lyx::char_type *&,
 250                 char *, char *, char *&) const { return error; }
 251 template<> codecvt<lyx::char_type, char, mbstate_t>::result
 252 codecvt<lyx::char_type, char, mbstate_t>::do_unshift(mbstate_t &, char *, char *, char *&) const { return error; }
 253 template<> codecvt<lyx::char_type, char, mbstate_t>::result
 254 codecvt<lyx::char_type, char, mbstate_t>::do_in(mbstate_t &, const char *, const char *, const char *&,
 255                 lyx::char_type *, lyx::char_type *, lyx::char_type *&) const { return error; }
 256 template<> int codecvt<lyx::char_type, char, mbstate_t>::do_encoding() const throw() { return 0; }
 257 template<> bool codecvt<lyx::char_type, char, mbstate_t>::do_always_noconv() const throw() { return true; }
 258 #if __GNUC__ == 3 && __GNUC_MINOR__ < 4
 259 template<> int codecvt<lyx::char_type, char, mbstate_t>::do_length(mbstate_t const &, const char *, const char *, size_t) const { return 1; }
 260 #else
 261 template<> int codecvt<lyx::char_type, char, mbstate_t>::do_length(mbstate_t &, const char *, const char *, size_t) const { return 1; }
 262 #endif
 263 template<> int codecvt<lyx::char_type, char, mbstate_t>::do_max_length() const throw() { return 4; }
 264 }
 265 #endif