All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
QoreEncoding Class Reference

defines string encoding functions in Qore More...

`#include <QoreEncoding.h>`

## Public Member Functions

DLLEXPORT qore_size_t | getByteLen (const char *p, const char *end, qore_size_t c, bool &invalid) const
| gives the number of bytes for the number of chars in the string or up to the end of the string More...
DLLEXPORT qore_size_t | getByteLen (const char *p, const char *end, qore_size_t c, ExceptionSink *xsink) const
| gives the number of bytes for the number of chars in the string or up to the end of the string More...
DLLEXPORT qore_offset_t | getCharLen (const char *p, qore_size_t valid_len) const
| gives the number of total bytes for the character given one or more characters More...
DLLEXPORT qore_size_t | getCharPos (const char *p, const char *end, bool &invalid) const
| gives the character position (number of characters) starting from the first pointer to the second More...
DLLEXPORT qore_size_t | getCharPos (const char *p, const char *end, ExceptionSink *xsink) const
| gives the character position (number of characters) starting from the first pointer to the second More...
DLLEXPORT const char * | getCode () const
| returns the string code (ex: "UTF-8") for the encoding
DLLEXPORT const char * | getDesc () const
| returns the description for the encoding
DLLEXPORT qore_size_t | getLength (const char *p, const char *end, bool &invalid) const
| gives the length of the string in characters More...
DLLEXPORT qore_size_t | getLength (const char *p, const char *end, ExceptionSink *xsink) const
| gives the length of the string in characters More...
DLLEXPORT int | getMaxCharWidth () const
| returns the maximum character width in bytes for the encoding
DLLEXPORT unsigned | getMinCharWidth () const
| returns the minimum character width in bytes for the encoding More...
DLLEXPORT int | getUnicode (const char *p, const char *end, unsigned &clen, ExceptionSink *xsink) const
| returns the unicode code point for the given character; if there are any errors (invalid character, not enough space in the string, etc), a Qore-language exception is thrown More...
DLLEXPORT bool | isAsciiCompat () const
| returns true if the character encoding is backwards-compatible with ASCII More...
DLLEXPORT bool | isMultiByte () const
| returns true if the encoding is a multi-byte encoding

## Detailed Description

defines string encoding functions in Qore

for performance reasons this is not a class hierarchy with virtual methods; this ugly implementation with function pointers is much faster. Only encodings where a single character can be more than 1 byte needs to have functions implemented.

Note
  only encodings that are backwards compatible with ASCII are supported by Qore; currently the only multi-byte encoding completely supported by qore is UTF-8 (UTF-16* encodings are not properly supported yet)
  the default encoding is represented by QCS_DEFAULT; unless another encoding is explicitly given, all strings will be tagged with QCS_DEFAULT

See Also
  QCS_DEFAULT

## Member Function Documentation

DLLEXPORT qore_size_t QoreEncoding::getByteLen | ( | const char * | p,
|  | const char * | end,
|  | qore_size_t | c,
|  | bool & | invalid
| ) |  | const

gives the number of bytes for the number of chars in the string or up to the end of the string

Parameters

  p | a pointer to the character data
  end | a pointer to the next byte after the end of the character data
  c | the number of characters to check
  invalid | if true after executing the function, invalid input was given and the return value should be ignored

Returns
  the number of bytes for the given number of characters in the string or up to the end of the string

DLLEXPORT qore_size_t QoreEncoding::getByteLen | ( | const char * | p,
|  | const char * | end,
|  | qore_size_t | c,
|  | ExceptionSink * | xsink
| ) |  | const

gives the number of bytes for the number of chars in the string or up to the end of the string

Parameters

  p | a pointer to the character data
  end | a pointer to the next byte after the end of the character data
  c | the number of characters to check
  xsink | Qore-language exceptions will be raised using this argument

Returns
  the number of bytes for the given number of characters in the string or up to the end of the string

DLLEXPORT qore_offset_t QoreEncoding::getCharLen | ( | const char * | p,
|  | qore_size_t | valid_len
| ) |  | const

gives the number of total bytes for the character given one or more characters

always returns 1 for single-byte encodings

Parameters

  p | a pointer to the character data to check
  valid_len | the number of valid bytes at the start of the character pointer

Returns
  0=invalid, positive = number of bytes needed to represent the character (and all are present), negative numbers = number of additional bytes needed to perform the check

DLLEXPORT qore_size_t QoreEncoding::getCharPos | ( | const char * | p,
|  | const char * | end,
|  | bool & | invalid
| ) |  | const

gives the character position (number of characters) starting from the first pointer to the second

Parameters

  p | a pointer to the character data
  end | a pointer to the next byte after the end of the character data
  invalid | if true after executing the function, invalid input was given and the return value should be ignored

Returns
  the number of bytes for the given number of characters in the string

DLLEXPORT qore_size_t QoreEncoding::getCharPos | ( | const char * | p,
|  | const char * | end,
|  | ExceptionSink * | xsink
| ) |  | const

gives the character position (number of characters) starting from the first pointer to the second

Parameters

  p | a pointer to the character data
  end | a pointer to the next byte after the end of the character data
  xsink | Qore-language exceptions will be raised using this argument

Returns
  the number of bytes for the given number of characters in the string

DLLEXPORT qore_size_t QoreEncoding::getLength | ( | const char * | p,
|  | const char * | end,
|  | bool & | invalid
| ) |  | const

gives the length of the string in characters

Parameters

  p | a pointer to the character data
  end | a pointer to the next byte after the end of the character data
  invalid | if true after executing the function, invalid input was given and the return value should be ignored

Returns
  the number of characters in the string

DLLEXPORT qore_size_t QoreEncoding::getLength | ( | const char * | p,
|  | const char * | end,
|  | ExceptionSink * | xsink
| ) |  | const

gives the length of the string in characters

Parameters

  p | a pointer to the character data
  end | a pointer to the next byte after the end of the character data
  xsink | Qore-language exceptions will be raised using this argument

Returns
  the number of characters in the string

DLLEXPORT unsigned QoreEncoding::getMinCharWidth | ( |  | ) | const

returns the minimum character width in bytes for the encoding

Since
  Qore 0.8.12

DLLEXPORT int QoreEncoding::getUnicode | ( | const char * | p,
|  | const char * | end,
|  | unsigned & | clen,
|  | ExceptionSink * | xsink
| ) |  | const

returns the unicode code point for the given character; if there are any errors (invalid character, not enough space in the string, etc), a Qore-language exception is thrown

Parameters

  p | a pointer to a character
  end | a pointer to the next byte after the end of the character data
  clen | the length of the character
  xsink | Qore-language exceptions will be raised using this argument

Returns
  the unicode code point for the character or -1 in case of an error

Since
  Qore 0.8.13

DLLEXPORT bool QoreEncoding::isAsciiCompat | ( |  | ) | const

returns true if the character encoding is backwards-compatible with ASCII

Since
  Qore 0.8.12

The documentation for this class was generated from the following file:

- include/qore/QoreEncoding.h (79e5dd4f976dab9d74ec8272aec97c21df86c597)