CharEncodingConv.cpp

Go to the documentation of this file.

/*  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.

    This file is part of the TerraLib - a Framework for building GIS enabled applications.

    TerraLib 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 3 of the License,
    or (at your option) any later version.

    TerraLib 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 TerraLib. See COPYING. If not, write to
    TerraLib Team at <terralib-team@terralib.org>.
 */

/*!
  \file terralib/common/CharEncodingConv.cpp

  \brief A class that deals with character encoding/decoding.
 */

// TerraLib
#include "../Defines.h"
#include "CharEncodingConv.h"

// TerraLib
#include "Exception.h"
#include "Translator.h"

// STL
#include <sstream>

#ifdef TERRALIB_GNU_ICONV_ENABLED
// iconv
#include <errno.h>
#include <iconv.h>

// internal iconv names
static const char* iconv_names[]  = {"UTF-8", "CP1250", "CP1251", "CP1252", "CP1253", "CP1254", "CP1257", "ISO-8859-1"};
#endif

#define TE_CONVERSION_BUFFERSIZE_SIZE 64

// CharEncoding Names
std::map<te::common::CharEncoding, std::string> te::common::CharEncodingConv::sm_encodingNames;

te::common::CharEncodingConv::CharEncodingConv(const CharEncoding& fromCode, const CharEncoding& toCode)
  : m_fromCode(fromCode),
    m_toCode(toCode)
{
  if(m_fromCode == UNKNOWN_CHAR_ENCODING || m_toCode == UNKNOWN_CHAR_ENCODING)
    throw Exception(TE_TR("Impossible conversion of unknown char encoding!"));

#ifdef TERRALIB_GNU_ICONV_ENABLED
  m_cd = iconv_open(iconv_names[toCode], iconv_names[fromCode]);

  if(m_cd == (iconv_t)(-1))
  {
    if(errno == EINVAL) 
      throw Exception(TE_TR("Failed to start iconv to start converting charsets: the conversion from fromCode to toCode is not supported!"));
    else
      throw Exception(TE_TR("Failed to start iconv to start converting charsets!"));
  }
#endif
}

te::common::CharEncodingConv::~CharEncodingConv()
{
#ifdef TERRALIB_GNU_ICONV_ENABLED
  if(iconv_close(m_cd))
    throw Exception(TE_TR("Failed to close iconv! This wasn't supposed to occur! Contact TerraLib Team!"));
#endif
}

std::string te::common::CharEncodingConv::conv(const std::string& src)
{
#ifdef TERRALIB_GNU_ICONV_ENABLED
  std::ostringstream outstring(std::ios_base::out);
  const char* inbuff = src.c_str();
  std::size_t inbytesleft = src.length();

  char outchar[TE_CONVERSION_BUFFERSIZE_SIZE];

  std::size_t nbytes = 0;

  for(;;)
  {
    char* outbuff = outchar;
    std::size_t outbytesleft = TE_CONVERSION_BUFFERSIZE_SIZE;

#if TE_PLATFORM == TE_PLATFORMCODE_MSWINDOWS
    nbytes = iconv(m_cd, &inbuff, &inbytesleft, &outbuff, &outbytesleft);

#elif TE_PLATFORM == TE_PLATFORMCODE_LINUX || TE_PLATFORM == TE_PLATFORMCODE_APPLE
    nbytes = iconv(m_cd, (char**)(&inbuff), &inbytesleft, &outbuff, &outbytesleft);

#else
    #error "Platform not supported! Please contact terralib-team@dpi.inpe.br"
#endif

    if((nbytes == (std::size_t)(-1)) && (errno != E2BIG))
    {
      nbytes = iconv(m_cd, 0, 0, 0, 0);

      if(nbytes == (std::size_t)(-1))
        throw Exception(TE_TR("Failed to convert character sets and also to bring iconv to its initial state!"));
      else
        throw Exception(TE_TR("Failed to convert character sets!"));
    }

    outstring.write(outchar, TE_CONVERSION_BUFFERSIZE_SIZE - outbytesleft);

    if(inbytesleft == 0)
      break;
  }

  nbytes = iconv(m_cd, 0, 0, 0, 0);

  if(nbytes == (std::size_t)(-1))
    throw Exception(TE_TR("Failed to bring iconv to its initial state!"));

  return outstring.str();
#else
  return src;
#endif
}

std::string te::common::CharEncodingConv::convert(const std::string& src, const CharEncoding& fromCode, const CharEncoding& toCode)
{
  if(fromCode == UNKNOWN_CHAR_ENCODING || toCode == UNKNOWN_CHAR_ENCODING)
    throw Exception(TE_TR("Impossible conversion of unknown char encoding!"));

#ifdef TERRALIB_GNU_ICONV_ENABLED
  iconv_t cd = iconv_open(iconv_names[toCode], iconv_names[fromCode]);

  if(cd == (iconv_t)(-1))
  {
    if(errno == EINVAL) 
      throw Exception(TE_TR("Failed to start iconv to start converting charsets: the conversion from fromCode to toCode is not supported!"));
    else
      throw Exception(TE_TR("Failed to start iconv to start converting charsets!"));
  }

  std::ostringstream outstring(std::ios_base::out);
  const char* inbuff = src.c_str();
  std::size_t inbytesleft = src.length();

  char outchar[TE_CONVERSION_BUFFERSIZE_SIZE];

  for(;;)
  {
    char* outbuff = outchar;
    std::size_t outbytesleft = TE_CONVERSION_BUFFERSIZE_SIZE;

#if TE_PLATFORM == TE_PLATFORMCODE_MSWINDOWS
    std::size_t nbytes = iconv(cd, &inbuff, &inbytesleft, &outbuff, &outbytesleft);

#elif TE_PLATFORM == TE_PLATFORMCODE_LINUX || TE_PLATFORM == TE_PLATFORMCODE_APPLE
    std::size_t nbytes = iconv(cd, (char**)(&inbuff), &inbytesleft, &outbuff, &outbytesleft);

#else
    #error "Platform not supported! Please contact terralib-team@dpi.inpe.br"
#endif

    if((nbytes == (std::size_t)(-1)) && (errno != E2BIG))
    {
      iconv_close(cd);
      throw Exception(TE_TR("Failed to convert character sets!"));
    }

    outstring.write(outchar, TE_CONVERSION_BUFFERSIZE_SIZE - outbytesleft);

    if(inbytesleft == 0)
      break;
  }

  if(iconv_close(cd))
    throw Exception(TE_TR("Failed to close iconv!"));

  return outstring.str();
#else
  return src;
#endif
}

std::string te::common::CharEncodingConv::getCharEncodingName(const CharEncoding& code)
{
  return sm_encodingNames[code];
}

te::common::CharEncoding te::common::CharEncodingConv::getCharEncodingType(const std::string& name)
{
  std::map<CharEncoding, std::string>::const_iterator it;
  for(it = sm_encodingNames.begin(); it != sm_encodingNames.end(); ++it)
    if(it->second == name)
      return it->first;

  return UNKNOWN_CHAR_ENCODING;
}

void te::common::CharEncodingConv::initialize()
{
  if(!sm_encodingNames.empty())
    return;

  sm_encodingNames[UTF8  ] = "UTF-8";
  sm_encodingNames[CP1250] = "CP1250";
  sm_encodingNames[CP1251] = "CP1251";
  sm_encodingNames[CP1252] = "CP1252";
  sm_encodingNames[CP1253] = "CP1253";
  sm_encodingNames[CP1254] = "CP1254";
  sm_encodingNames[CP1257] = "CP1257";
  sm_encodingNames[LATIN1] = "Latin1";
  // continue...
  sm_encodingNames[UNKNOWN_CHAR_ENCODING] = "Unknown";
}