QoreEncoding.h

Go to the documentation of this file.

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
  QoreEncoding.h

  Qore Programming Language

  Copyright (C) 2003 - 2015 David Nichols

  Permission is hereby granted, free of charge, to any person obtaining a
  copy of this software and associated documentation files (the "Software"),
  to deal in the Software without restriction, including without limitation
  the rights to use, copy, modify, merge, publish, distribute, sublicense,
  and/or sell copies of the Software, and to permit persons to whom the
  Software is furnished to do so, subject to the following conditions:

  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  DEALINGS IN THE SOFTWARE.

  Note that the Qore library is released under a choice of three open-source
  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
  information.
*/

#ifndef _QORE_ENCODING_H

#define _QORE_ENCODING_H

#include <qore/common.h>
#include <qore/QoreThreadLock.h>

#include <strings.h>
#include <string.h>

#include <map>

#include <string>

typedef qore_size_t (*mbcs_length_t)(const char* str, const char* end, bool &invalid);

typedef qore_size_t (*mbcs_end_t)(const char* str, const char* end, qore_size_t num_chars, bool &invalid);

typedef qore_size_t (*mbcs_pos_t)(const char* str, const char* ptr, bool &invalid);


typedef qore_size_t (*mbcs_charlen_t)(const char* str, qore_size_t valid_len);

typedef unsigned (*mbcs_get_unicode_t)(const char* p);

// private implementation of the QoreEncoding class
struct qore_encoding_private;


class QoreEncoding {
protected:
   // FIXME: move all this to the private implementation with the ABI change
   // NOTE: the following class members cannot be removed because until Qore 0.8.12 this class implemented inline member functions
   //       that refered directly to these member variables, therefore they make up a part of the library's ABI :(
   std::string code;
   std::string desc;
   mbcs_length_t flength;
   mbcs_end_t fend;
   mbcs_pos_t fpos;
   mbcs_charlen_t fcharlen;
   unsigned char maxwidth;

   qore_encoding_private* priv;

public:
   DLLLOCAL QoreEncoding(const char* n_code, const char* n_desc = 0, unsigned char n_minwidth = 1, unsigned char n_maxwidth = 1, mbcs_length_t l = 0, mbcs_end_t e = 0, mbcs_pos_t p = 0, mbcs_charlen_t c = 0,  mbcs_get_unicode_t gu = 0, bool n_ascii_compat = true);

   DLLLOCAL ~QoreEncoding();


   DLLEXPORT qore_size_t getLength(const char* p, const char* end, bool& invalid) const;


   DLLEXPORT qore_size_t getLength(const char* p, const char* end, ExceptionSink* xsink) const;


   DLLEXPORT qore_size_t getByteLen(const char* p, const char* end, qore_size_t c, bool& invalid) const;


   DLLEXPORT qore_size_t getByteLen(const char* p, const char* end, qore_size_t c, ExceptionSink* xsink) const;


   DLLEXPORT qore_size_t getCharPos(const char* p, const char* end, bool& invalid) const;


   DLLEXPORT qore_size_t getCharPos(const char* p, const char* end, ExceptionSink* xsink) const;


   DLLEXPORT qore_size_t getCharLen(const char* p, qore_size_t valid_len) const;
      
   DLLEXPORT bool isMultiByte() const;

   DLLEXPORT const char* getCode() const;

   DLLEXPORT const char* getDesc() const;

   DLLEXPORT int getMaxCharWidth() const;


   DLLEXPORT unsigned getMinCharWidth() const;
   

   DLLEXPORT bool isAsciiCompat() const;


   DLLLOCAL unsigned getUnicode(const char* p) const;
};

// case-insensitive maps for encodings
typedef std::map<const char*, QoreEncoding*, ltcstrcase> encoding_map_t;
typedef std::map<const char*, const QoreEncoding*, ltcstrcase> const_encoding_map_t;

class QoreString;


class QoreEncodingManager {
private:
   DLLLOCAL static encoding_map_t emap;
   DLLLOCAL static const_encoding_map_t amap;
   DLLLOCAL static QoreThreadLock mutex;
   
   DLLLOCAL static const QoreEncoding* addUnlocked(const char* n_code, const char* n_desc = 0, unsigned char n_minwidth = 1, unsigned char n_maxwidth = 1, mbcs_length_t l = 0, mbcs_end_t e = 0, mbcs_pos_t p = 0, mbcs_charlen_t c = 0,  mbcs_get_unicode_t gu = 0, bool n_ascii_compat = true);
   DLLLOCAL static const QoreEncoding* findUnlocked(const char* name);

public:
   DLLEXPORT static void addAlias(const QoreEncoding* qcs, const char* alias);

   DLLEXPORT static const QoreEncoding* findCreate(const char* name);

   DLLEXPORT static const QoreEncoding* findCreate(const QoreString* str);

   DLLEXPORT static void showEncodings();

   DLLEXPORT static void showAliases();

   DLLEXPORT static const QoreEncoding* add(const char* code, const char* desc = 0, unsigned char maxwidth = 1, mbcs_length_t l = 0, mbcs_end_t e = 0, mbcs_pos_t p = 0, mbcs_charlen_t = 0);

   DLLLOCAL static void init(const char* def);
   DLLLOCAL QoreEncodingManager();
   DLLLOCAL ~QoreEncodingManager();
};

DLLEXPORT qore_size_t q_get_byte_len(const QoreEncoding* enc, const char* p, const char* end, qore_size_t c, ExceptionSink* xsink);
DLLEXPORT qore_size_t q_get_char_len(const QoreEncoding* enc, const char* p, qore_size_t valid_len, ExceptionSink* xsink);

DLLEXPORT extern QoreEncodingManager QEM;

// builtin character encodings
DLLEXPORT extern const QoreEncoding* QCS_DEFAULT, 
   *QCS_USASCII,                                  
   *QCS_UTF8,                                     
   *QCS_UTF16,                                    
   *QCS_UTF16BE,                                  
   *QCS_UTF16LE,                                  
   *QCS_ISO_8859_1,                               
   *QCS_ISO_8859_2,                               
   *QCS_ISO_8859_3,                               
   *QCS_ISO_8859_4,                               
   *QCS_ISO_8859_5,                               
   *QCS_ISO_8859_6,                               
   *QCS_ISO_8859_7,                               
   *QCS_ISO_8859_8,                               
   *QCS_ISO_8859_9,                               
   *QCS_ISO_8859_10,                              
   *QCS_ISO_8859_11,                              
   *QCS_ISO_8859_13,                              
   *QCS_ISO_8859_14,                              
   *QCS_ISO_8859_15,                              
   *QCS_ISO_8859_16,                              
   *QCS_KOI8_R,                                   
   *QCS_KOI8_U,                                   
   *QCS_KOI7;                                     

#endif // _QORE_ENCODING_H