/usr/include/cxxtools/textcodec.h is in libcxxtools-dev 2.2.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | /*
* Copyright (C) 2004-2009 Marc Boris Duerner
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* As a special exception, you may use this file as part of a free
* software library without restriction. Specifically, if other files
* instantiate templates or use macros or inline functions from this
* file, or you compile this file and link it with other files to
* produce an executable, this file does not by itself cause the
* resulting executable to be covered by the GNU General Public
* License. This exception does not however invalidate any other
* reasons why the executable file might be covered by the GNU Library
* General Public License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef cxxtools_TextCodec_h
#define cxxtools_TextCodec_h
#include <cxxtools/api.h>
#include <cxxtools/char.h>
#include <cxxtools/conversionerror.h>
#include <string>
#ifdef CXXTOOLS_WITH_STD_LOCALE
namespace std {
template<>
class CXXTOOLS_API codecvt<cxxtools::Char, char, cxxtools::MBState> : public codecvt_base, public locale::facet
{
public:
static locale::id id;
virtual locale::id& __get_id (void) const { return id; }
public:
explicit codecvt(size_t ref = 0);
virtual ~codecvt();
codecvt_base::result out(cxxtools::MBState& state,
const cxxtools::Char* from,
const cxxtools::Char* from_end,
const cxxtools::Char*& from_next,
char* to,
char* to_end,
char*& to_next) const
{ return this->do_out(state, from, from_end, from_next, to, to_end, to_next); }
codecvt_base::result unshift(cxxtools::MBState& state,
char* to,
char* to_end,
char*& to_next) const
{ return this->do_unshift(state, to, to_end, to_next); }
codecvt_base::result in(cxxtools::MBState& state,
const char* from,
const char* from_end,
const char*& from_next,
cxxtools::Char* to,
cxxtools::Char* to_end,
cxxtools::Char*& to_next) const
{ return this->do_in(state, from, from_end, from_next, to, to_end, to_next); }
int encoding() const
{ return this->do_encoding(); }
bool always_noconv() const
{ return this->do_always_noconv(); }
int length(cxxtools::MBState& state, const char* from,
const char* end, size_t max) const
{ return this->do_length(state, from, end, max); }
int max_length() const
{ return this->do_max_length(); }
protected:
virtual codecvt_base::result do_out(cxxtools::MBState& state,
const cxxtools::Char* from,
const cxxtools::Char* from_end,
const cxxtools::Char*& from_next,
char* to,
char* to_end,
char*& to_next) const = 0;
virtual codecvt_base::result do_unshift(cxxtools::MBState& state,
char* to,
char* to_end,
char*& to_next) const = 0;
virtual codecvt_base::result do_in(cxxtools::MBState& state,
const char* from,
const char* from_end,
const char*& from_next,
cxxtools::Char* to,
cxxtools::Char* to_end,
cxxtools::Char*& to_next) const = 0;
virtual int do_encoding() const throw() = 0;
virtual bool do_always_noconv() const throw() = 0;
virtual int do_length(cxxtools::MBState&,
const char* from,
const char* end,
size_t max) const = 0;
virtual int do_max_length() const throw() = 0;
};
template<>
class CXXTOOLS_API codecvt<char, char, cxxtools::MBState> : public codecvt_base, public locale::facet
{
public:
static locale::id id;
virtual locale::id& __get_id (void) const { return id; }
public:
explicit codecvt(size_t ref = 0);
virtual ~codecvt();
codecvt_base::result out(cxxtools::MBState& state,
const char* from,
const char* from_end,
const char*& from_next,
char* to,
char* to_end,
char*& to_next) const
{ return this->do_out(state, from, from_end, from_next, to, to_end, to_next); }
codecvt_base::result unshift(cxxtools::MBState& state,
char* to,
char* to_end,
char*& to_next) const
{ return this->do_unshift(state, to, to_end, to_next); }
codecvt_base::result in(cxxtools::MBState& state,
const char* from,
const char* from_end,
const char*& from_next,
char* to, char* to_end,
char*& to_next) const
{ return this->do_in(state, from, from_end, from_next, to, to_end, to_next); }
int encoding() const
{ return this->do_encoding(); }
bool always_noconv() const
{ return this->do_always_noconv(); }
int length(cxxtools::MBState& state, const char* from,
const char* end, size_t max) const
{ return this->do_length(state, from, end, max); }
int max_length() const
{ return this->do_max_length(); }
protected:
virtual codecvt_base::result do_out(cxxtools::MBState& state,
const char* from,
const char* from_end,
const char*& from_next,
char* to,
char* to_end,
char*& to_next) const = 0;
virtual codecvt_base::result do_unshift(cxxtools::MBState& state,
char* to,
char* to_end,
char*& to_next) const = 0;
virtual codecvt_base::result do_in(cxxtools::MBState& state,
const char* from,
const char* from_end,
const char*& from_next,
char* to,
char* to_end,
char*& to_next) const = 0;
virtual int do_encoding() const throw() = 0;
virtual bool do_always_noconv() const throw() = 0;
virtual int do_length(cxxtools::MBState&,
const char* from,
const char* end,
size_t max) const = 0;
virtual int do_max_length() const throw() = 0;
};
}
#else // no CXXTOOLS_WITH_STD_LOCALE
namespace std {
class codecvt_base
{
public:
enum { ok, partial, error, noconv };
typedef int result;
virtual ~codecvt_base()
{ }
};
template <typename I, typename E, typename S>
class codecvt : public std::codecvt_base
{
public:
typedef I InternT;
typedef E ExternT;
typedef S StateT;
public:
explicit codecvt(size_t ref = 0)
{}
virtual ~codecvt()
{ }
codecvt_base::result out(StateT& state,
const InternT* from,
const InternT* from_end,
const InternT*& from_next,
ExternT* to,
ExternT* to_end,
ExternT*& to_next) const
{ return this->do_out(state, from, from_end, from_next, to, to_end, to_next); }
codecvt_base::result unshift(StateT& state,
ExternT* to,
ExternT* to_end,
ExternT*& to_next) const
{ return this->do_unshift(state, to, to_end, to_next); }
codecvt_base::result in(StateT& state,
const ExternT* from,
const ExternT* from_end,
const ExternT*& from_next,
InternT* to,
InternT* to_end,
InternT*& to_next) const
{ return this->do_in(state, from, from_end, from_next, to, to_end, to_next); }
int encoding() const
{ return this->do_encoding(); }
bool always_noconv() const
{ return this->do_always_noconv(); }
int length(StateT& state, const ExternT* from,
const ExternT* end, size_t max) const
{ return this->do_length(state, from, end, max); }
int max_length() const
{ return this->do_max_length(); }
protected:
virtual result do_in(StateT& s, const ExternT* fromBegin,
const ExternT* fromEnd, const ExternT*& fromNext,
InternT* toBegin, InternT* toEnd, InternT*& toNext) const = 0;
virtual result do_out(StateT& s, const InternT* fromBegin,
const InternT* fromEnd, const InternT*& fromNext,
ExternT* toBegin, ExternT* toEnd, ExternT*& toNext) const = 0;
virtual bool do_always_noconv() const = 0;
virtual int do_length(StateT& s, const ExternT* fromBegin,
const ExternT* fromEnd, size_t max) const = 0;
virtual int do_max_length() const = 0;
virtual std::codecvt_base::result do_unshift(StateT&,
ExternT*,
ExternT*,
ExternT*&) const = 0;
virtual int do_encoding() const = 0;
};
}
#endif // CXXTOOLS_WITH_STD_LOCALE
namespace cxxtools {
/**
* @brief Generic TextCodec class/facet which may be subclassed by specific Codec classes.
*
* This class contains default implementations for the methods do_unshift(), do_encoding()
* and do_always_noconv() so sub-classes do not have to implement this default behaviour.
*
* Codecs are used to convert one Text-encoding into another Text-encoding. The internal
* and external data type can be specified using the template parameter 'I' (internal) and
* 'E' (external).
*
* When used on a platform which supports locales and facets the conversion may use
* locale-specific conversion of the Text.
*
* This class derives from facet std::codecvt. Further documentation can be found there.
*
* @param I The character type associated with the internal code set.
* @param E The character type associated with the external code set.
*
* @see Utf8Codec
* @see Utf16Codec
* @see Utf32Codec
*/
template <typename I, typename E>
class TextCodec : public std::codecvt<I, E, cxxtools::MBState>
{
public:
typedef I InternT;
typedef E ExternT;
public:
/**
* @brief Constructs a new TextCodec object.
*
* The internal and external type are specified by the template parameters of the class.
*
* @param ref This parameter is passed to std::codecvt. When ref == 0 the locale takes care
* of deleting the facet. If ref == 1 the locale does not destroy the facet.
*/
explicit TextCodec(size_t ref = 0)
: std::codecvt<InternT, ExternT, MBState>(ref)
, _refs(ref)
{}
public:
//! Empty desctructor
virtual ~TextCodec()
{}
size_t refs() const
{ return _refs; }
private:
size_t _refs;
};
/** @brief helper template function for decoding data using a codec.
This template function makes it easy to use a codec to convert a string with
one encoding to another.
*/
template <typename CodecType>
std::basic_string<typename CodecType::InternT> decode(const typename CodecType::ExternT* data, unsigned size)
{
CodecType codec;
typename CodecType::InternT to[64];
MBState state;
std::basic_string<typename CodecType::InternT> ret;
const typename CodecType::ExternT* from = data;
typename CodecType::result r;
do
{
typename CodecType::InternT* to_next = to;
const typename CodecType::ExternT* from_next = from;
r = codec.in(state, from, from + size, from_next, to, to + sizeof(to)/sizeof(typename CodecType::InternT), to_next);
if (r == CodecType::error)
throw ConversionError("character conversion failed");
if (r == CodecType::partial && from_next == from)
throw ConversionError("character conversion failed - unexpected end of input sequence");
ret.append(to, to_next);
size -= (from_next - from);
from = from_next;
} while (r == CodecType::partial);
return ret;
}
/** @brief helper template function for decoding strings using a codec.
This template function makes it easy to use a codec to convert a string with
one encoding to another.
@code
std::string utf8data = ...;
cxxtools::String unicodeString = cxxtools::decode<cxxtools::Utf8Codec>(utf8data);
std::string base64data = ...;
std::string data = cxxtools::decode<cxxtools::Base64Codec>(base64data);
@endcode
*/
template <typename CodecType>
std::basic_string<typename CodecType::InternT> decode(const std::basic_string<typename CodecType::ExternT>& data)
{
return decode<CodecType>(data.data(), data.size());
}
template <typename CodecType>
std::basic_string<typename CodecType::ExternT> encode(const typename CodecType::InternT* data, unsigned size)
{
CodecType codec;
char to[64];
MBState state;
typename CodecType::result r;
const typename CodecType::InternT* from = data;
std::basic_string<typename CodecType::ExternT> ret;
do{
const typename CodecType::InternT* from_next;
typename CodecType::ExternT* to_next = to;
r = codec.out(state, from, from + size, from_next, to, to + sizeof(to), to_next);
if (r == CodecType::error)
throw ConversionError("character conversion failed");
ret.append(to, to_next);
size -= (from_next - from);
from = from_next;
} while (r == CodecType::partial);
typename CodecType::ExternT* to_next = to;
r = codec.unshift(state, to, to + sizeof(to), to_next);
if (r == CodecType::error)
throw ConversionError("character conversion failed");
ret.append(to, to_next);
return ret;
}
/** @brief helper template function for encoding strings using a codec.
This template function makes it easy to use a codec to convert a string with
one encoding to another.
@code
cxxtools::String unicodeString = ...;
std::string utf8data = cxxtools::encode<cxxtools::Utf8Codec>(unicodeString);
std::string base64data = cxxtools::encode<cxxtools::Base64Codec>("some data");
@endcode
*/
template <typename CodecType>
std::basic_string<typename CodecType::ExternT> encode(const std::basic_string<typename CodecType::InternT>& data)
{
return encode<CodecType>(data.data(), data.size());
}
}
#endif
|