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