CIccTagZipUtf8Text Class Reference

Class: CIccTagZipUtf8Text() More...

#include <IccTagBasic.h>

Inheritance diagram for CIccTagZipUtf8Text:

Collaboration diagram for CIccTagZipUtf8Text:

Public Member Functions
icUChar *	AllocBuffer (icUInt32Number nSize)
	Name: CIccTagZipUtf8Text::AllocBuffer.
icUInt32Number	BufferSize () const
	CIccTagZipUtf8Text ()
	Name: CIccTagZipUtf8Text::CIccTagZipUtf8Text.
	CIccTagZipUtf8Text (const CIccTagZipUtf8Text &ITT)
	Name: CIccTagZipUtf8Text::CIccTagZipUtf8Text.
virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagZipUtf8Text::Describe.
icUChar *	GetBuffer () const
virtual const icChar *	GetClassName () const
virtual bool	GetText (std::string &str) const
	Name: CIccTagZipUtf8Text::GetText.
virtual icTagTypeSignature	GetType () const
	Function: GetType()
virtual CIccTag *	NewCopy () const
	Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.
CIccTagZipUtf8Text &	operator= (const CIccTagZipUtf8Text &TextTag)
	Name: CIccTagZipUtf8Text::operator=.
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagZipUtf8Text::Read.
bool	SetText (const icChar *szText)
virtual bool	SetText (const icUChar *szText)
	Name: CIccTagZipUtf8Text::SetText.
bool	SetText (const icUChar16 *szText)
	Name: CIccTagZipUtf8Text::SetText.
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagZipUtf8Text::Validate.
virtual bool	Write (CIccIO *pIO)
	Name: CIccTagZipUtf8Text::Write.
virtual	~CIccTagZipUtf8Text ()
	Name: CIccTagZipUtf8Text::~CIccTagZipUtf8Text.
Public Member Functions inherited from CIccTag
	CIccTag ()
	Name: CIccTag::CIccTag.
virtual void	DetachIO ()
	Function: ReadAll() - Read All sub data for tag from file.
virtual IIccExtensionTag *	GetExtension ()
virtual icArraySignature	GetTagArrayType () const
virtual icStructSignature	GetTagStructType () const
virtual bool	IsArrayType ()
virtual bool	IsMBBType ()
virtual bool	IsNumArrayType () const
virtual bool	IsSupported ()
	Function: IsSupported(size, pIO) - Check if tag fully supported for apply purposes.
virtual bool	Read (icUInt32Number size, CIccIO *pIO, CIccProfile *pProfile)
	Function: Read(size, pIO) - Read tag from file.
virtual bool	ReadAll ()
	Function: ReadAll() - Read All sub data for tag from file.
virtual	~CIccTag ()
	Name: CIccTag::CIccTag.

Protected Attributes
icUInt32Number	m_nBufSize
icUChar *	m_pZipBuf

Additional Inherited Members
Static Public Member Functions inherited from CIccTag
static CIccTag *	Create (icTagTypeSignature sig)
	Name: CIccTag::Create.
Public Attributes inherited from CIccTag
icUInt32Number	m_nReserved

Detailed Description

Class: CIccTagZipUtf8Text()

Purpose: The zipUtf8TextType ICC tag maintains compressed text data. Calls to GetText will uncompress, and SetText will compress. These functions may fail if macro ICC_USE_ZLIB is not defined.

Definition at line 366 of file IccTagBasic.h.

Constructor & Destructor Documentation

CIccTagZipUtf8Text() [1/2]

CIccTagZipUtf8Text::CIccTagZipUtf8Text

(

)

Name: CIccTagZipUtf8Text::CIccTagZipUtf8Text.

Purpose: Constructor

Definition at line 1050 of file IccTagBasic.cpp.

{
  m_pZipBuf = NULL;
  m_nBufSize = 0;
}

~CIccTagZipUtf8Text()

CIccTagZipUtf8Text::~CIccTagZipUtf8Text ( )

virtual

Name: CIccTagZipUtf8Text::~CIccTagZipUtf8Text.

Purpose: Destructor

Definition at line 1107 of file IccTagBasic.cpp.

{
  if (m_pZipBuf)
    free(m_pZipBuf);
}

CIccTagZipUtf8Text() [2/2]

CIccTagZipUtf8Text::CIccTagZipUtf8Text

(

const CIccTagZipUtf8Text &

ITT

)

Name: CIccTagZipUtf8Text::CIccTagZipUtf8Text.

Purpose: Copy Constructor

Args: ITT = The CIccTagText object to be copied

Definition at line 1066 of file IccTagBasic.cpp.

{
  m_pZipBuf = NULL;
  m_nBufSize = 0;
  AllocBuffer(ITT.BufferSize());
  if (m_pZipBuf) {
    memcpy(m_pZipBuf, ITT.GetBuffer(), m_nBufSize);
  }
}

References BufferSize(), and GetBuffer().

Here is the call graph for this function:

Member Function Documentation

AllocBuffer()

icUChar * CIccTagZipUtf8Text::AllocBuffer

(

icUInt32Number

nSize

)

Name: CIccTagZipUtf8Text::AllocBuffer.

Purpose: This function allocates room and returns pointer to data buffer to put string into

Args: nSize = Requested size of data buffer.

Return: The character buffer array

Definition at line 1410 of file IccTagBasic.cpp.

{
  if (m_nBufSize != nSize) {
    if (!nSize) {
      if (m_pZipBuf)
        free(m_pZipBuf);
 
      m_nBufSize = nSize;
      return NULL;
    }
 
    if (!m_nBufSize)
      m_pZipBuf = (icUChar*)malloc(nSize);
    else
      m_pZipBuf = (icUChar*)icRealloc(m_pZipBuf, nSize);
 
    m_nBufSize = nSize;
 
  }
 
  return m_pZipBuf;
}

References icRealloc().

Here is the call graph for this function:

BufferSize()

icUInt32Number CIccTagZipUtf8Text::BufferSize ( ) const

inline

Definition at line 396 of file IccTagBasic.h.

{ return m_nBufSize; }

Referenced by CIccTagZipUtf8Text(), and operator=().

Here is the caller graph for this function:

Describe()

void CIccTagZipUtf8Text::Describe ( std::string & sDescription, int nVerboseness )

virtual

Name: CIccTagZipUtf8Text::Describe.

Purpose: Dump data associated with the tag to a string

Args: sDescription - string to concatenate tag dump to

Reimplemented from CIccTag.

Definition at line 1198 of file IccTagBasic.cpp.

{
  std::string str;
#ifdef ICC_USE_ZLIB
  if (!GetText(str)) {
    sDescription += "Error! - Unable to decompress text data.\n";
  }
  else if (m_nBufSize > 4 && !memcmp(m_pZipBuf, icFaultyXmlZipData, 4)) {
    sDescription += "Warning! - Correcting for improperly encoded ";
    sDescription += CIccTagCreator::GetTagTypeSigName(GetType());
    sDescription += " tag.\n\n";
  }
 
  sDescription += "ZLib Compressed String=\"";
  sDescription += str;
  sDescription += "\"\n";
#else
  char size[30];
  sprintf(size, "%d", m_nBufSize);
  sDescription += "BEGIN_COMPESSED_DATA[\"";
  sDescription += size;
  sDescription += "]\n";
  if (m_nBufSize) {
    icMemDump(str, m_pZipBuf, m_nBufSize);
    sDescription += str;
    sDescription += "\n";
  }
  sDescription += "END_COMPRESSED_DATA\n";
#endif
}

References CIccTagCreator::GetTagTypeSigName(), icFaultyXmlZipData, and icMemDump().

Here is the call graph for this function:

GetBuffer()

icUChar * CIccTagZipUtf8Text::GetBuffer ( ) const

inline

Definition at line 395 of file IccTagBasic.h.

{ return m_pZipBuf; }

Referenced by CIccTagZipUtf8Text(), and operator=().

Here is the caller graph for this function:

GetClassName()

virtual const icChar * CIccTagZipUtf8Text::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlZipUtf8Text, CIccTagXmlZipXml, and CIccTagZipXml.

Definition at line 376 of file IccTagBasic.h.

{ return "CIccZipUtf8TagText"; }

GetText()

bool CIccTagZipUtf8Text::GetText ( std::string & str ) const

virtual

Name: CIccTagZipUtf8Text::GetText.

Purpose: Allows text data associated with the tag to be set.

Args: text - string to put uncompressed text into

Definition at line 1239 of file IccTagBasic.cpp.

{
#ifndef ICC_USE_ZLIB
  str="";
  return false;
#else
  int zstat;
  z_stream zstr;
  memset(&zstr, 0, sizeof(zstr));
  unsigned char buf[32767] = { 0 };
 
  zstat = inflateInit(&zstr);
 
  if (zstat != Z_OK) {
    return false;
  }
 
  zstat = inflateReset(&zstr);
 
  if (zstat != Z_OK) {
    return false;
  }
 
  if (m_nBufSize > 4 && !memcmp(m_pZipBuf, icFaultyXmlZipData, 4)) {
    //xrite creates invalid zipXMLType tags
    zstr.next_in = m_pZipBuf+4;
    zstr.avail_in = m_nBufSize-4;
  }
  else {
    zstr.next_in = m_pZipBuf;
    zstr.avail_in = m_nBufSize;
  }
 
  do {
    unsigned int i, n;
 
    zstr.next_out = buf;
    zstr.avail_out = sizeof(buf);
 
    zstat = inflate(&zstr, Z_SYNC_FLUSH);
 
    if (zstat != Z_OK && zstat != Z_STREAM_END) {
      inflateEnd(&zstr);
      return false;
    }
 
    n = sizeof(buf) - zstr.avail_out;
 
    for (i = 0; i < n; i++) {
      str += buf[i];
    }
  } while (zstat != Z_STREAM_END);
 
  inflateEnd(&zstr);
 
  return true;
#endif
}

References icFaultyXmlZipData.

Referenced by icGetTagText().

Here is the caller graph for this function:

GetType()

virtual icTagTypeSignature CIccTagZipUtf8Text::GetType ( ) const

inlinevirtual

Function: GetType()

Purpose: Get Tag Type. Each derived tag will implement it's own GetType() function.

Reimplemented from CIccTag.

Reimplemented in CIccTagZipXml.

Definition at line 375 of file IccTagBasic.h.

{ return icSigZipUtf8TextType; }

References icSigZipUtf8TextType.

NewCopy()

virtual CIccTag * CIccTagZipUtf8Text::NewCopy ( ) const

inlinevirtual

Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.

Parameter(s): none

Returns a new CIccTag object that is a copy of this object.

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlZipUtf8Text, CIccTagXmlZipXml, and CIccTagZipXml.

Definition at line 373 of file IccTagBasic.h.

{return new CIccTagZipUtf8Text(*this);}

operator=()

CIccTagZipUtf8Text & CIccTagZipUtf8Text::operator=

(

const CIccTagZipUtf8Text &

ITT

)

Name: CIccTagZipUtf8Text::operator=.

Purpose: Copy Operator

Args: TextTag = The CIccTagText object to be copied

Definition at line 1086 of file IccTagBasic.cpp.

{
  if (&ITT == this)
    return *this;
 
  AllocBuffer(ITT.BufferSize());
  if (m_pZipBuf) {
    memcpy(m_pZipBuf, ITT.GetBuffer(), m_nBufSize);
  }
 
  return *this;
}

References BufferSize(), and GetBuffer().

Referenced by CIccTagZipXml::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

Read()

bool CIccTagZipUtf8Text::Read ( icUInt32Number size, CIccIO * pIO )

virtual

Name: CIccTagZipUtf8Text::Read.

Purpose: Read in a text type tag into a data block

Args: size - # of bytes in tag, pIO - IO object to read tag from

Return: true = successful, false = failure

Reimplemented from CIccTag.

Definition at line 1127 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig;
 
  if (size<sizeof(icTagTypeSignature) || !pIO) {
    AllocBuffer(0);
    return false;
  }
 
  if (!pIO->Read32(&sig))
    return false;
 
  if (!pIO->Read32(&m_nReserved))
    return false;
 
  icUInt32Number nSize = size - sizeof(icTagTypeSignature) - sizeof(icUInt32Number);
 
  icUChar *pBuf = AllocBuffer(nSize);
 
  if (m_nBufSize && pBuf) {
    if (pIO->Read8(pBuf, m_nBufSize) != (icInt32Number)m_nBufSize) {
      return false;
    }
  }
 
  return true;
}

References CIccIO::Read32(), CIccIO::Read8(), and sig.

Here is the call graph for this function:

SetText() [1/3]

bool CIccTagZipUtf8Text::SetText ( const icChar * szText )

inline

Definition at line 384 of file IccTagBasic.h.

{ return SetText((icUChar*)szText); }

References SetText().

Referenced by SetText().

Here is the call graph for this function:

Here is the caller graph for this function:

SetText() [2/3]

bool CIccTagZipUtf8Text::SetText ( const icUChar * szText )

virtual

Name: CIccTagZipUtf8Text::SetText.

Purpose: Allows text data associated with the tag to be set.

Args: szText - zero terminated string to put in tag

Definition at line 1309 of file IccTagBasic.cpp.

{
#ifndef ICC_USE_ZLIB
  return false;
#else
  icUInt32Number nSize = (icUInt32Number)strlen((const char*)szText) + 1;
  icUtf8Vector compress;
  int i;
 
  int zstat;
  z_stream zstr;
  unsigned char buf[32767];
  memset(&zstr, 0, sizeof(zstr));
 
  zstat = deflateInit(&zstr, Z_DEFAULT_COMPRESSION);
 
  if (zstat != Z_OK) {
    return false;
  }
 
  zstat = deflateReset(&zstr);
  zstr.next_in = (Bytef*)szText;
  zstr.avail_in = nSize;
 
  if (zstat != Z_OK) {
    return false;
  }
 
 
  do {
    int n;
    zstr.next_out = buf;
    zstr.avail_out = sizeof(buf);
 
    zstat = deflate(&zstr, Z_FINISH);
 
    if (zstat != Z_OK && zstat != Z_STREAM_END) {
      deflateEnd(&zstr);
      return false;
    }
 
    n = sizeof(buf) - zstr.avail_out;
 
    for (i = 0; i < n; i++) {
      compress.push_back(buf[i]);
    }
  } while (zstat != Z_STREAM_END);
 
  deflateEnd(&zstr);
 
  icUChar *pBuf = AllocBuffer((icUInt32Number)compress.size());
 
  if (pBuf) {
    for (i = 0; i < (int)m_nBufSize; i++) {
      pBuf[i] = compress[i];
}
  }
 
  return true;
#endif
}

SetText() [3/3]

bool CIccTagZipUtf8Text::SetText

(

const icUChar16 *

szText

)

Name: CIccTagZipUtf8Text::SetText.

Purpose: Allows text data associated with the tag to be set.

Args: szText - zero terminated string to put in tag

Definition at line 1381 of file IccTagBasic.cpp.

{
  if (!szText) 
    return SetText("");
 
  icUtf8Vector text;
  icUInt32Number len;
  for (len=0; szText[len]; len++);
 
  icConvertUTF16toUTF8(szText, &szText[len], text, lenientConversion);
 
  return SetText((const icUChar*)&text[0]);
}

References icConvertUTF16toUTF8(), and lenientConversion.

Here is the call graph for this function:

Validate()

icValidateStatus CIccTagZipUtf8Text::Validate ( std::string sigPath, std::string & sReport, const CIccProfile * pProfile = NULL ) const

virtual

Name: CIccTagZipUtf8Text::Validate.

Purpose: Check tag data validity.

Args: sig = signature of tag being validated, sReport = String to add report information to

Return: icValidateStatusOK if valid, or other error status.

Reimplemented from CIccTag.

Definition at line 1448 of file IccTagBasic.cpp.

{
  icValidateStatus rv = CIccTag::Validate(sigPath, sReport, pProfile);
 
  CIccInfo Info;
  std::string sSigPathName = Info.GetSigPathName(sigPath);
 
  if (!m_nBufSize) {
    sReport += icMsgValidateWarning;
    sReport += sSigPathName;
    sReport += " - Empty Tag.\n";
    rv = icMaxStatus(rv, icValidateWarning);
  }
  else {
#ifdef ICC_USE_ZLIB
    std::string sText;
    if (!GetText(sText)) {
      sReport += icMsgValidateNonCompliant;
      sReport += sSigPathName;
      sReport += " - Unable to get text for tag (possibly corrupt compressed data).\n";
      rv = icMaxStatus(rv, icValidateNonCompliant);
    }
    else if (m_nBufSize > 4 && !memcmp(m_pZipBuf, icFaultyXmlZipData, 4)) {
      sReport += icMsgValidateNonCompliant;
      sReport += sSigPathName;
      sReport += " - Improperly encoded ";
      sReport += CIccTagCreator::GetTagTypeSigName(GetType());
      sReport += " tag.\n";
      rv = icMaxStatus(rv, icValidateNonCompliant);
    }
#else
    sReport += icMsgValidateWarning;
    sReport += sSigPathName;
    sReport += " - Zip compression not supported by CMM - unable to validate text compression.\n";
    rv = icMaxStatus(rv, icValidateWarning);
#endif
  }
  
  return rv;
}

References CIccInfo::GetSigPathName(), CIccTagCreator::GetTagTypeSigName(), icFaultyXmlZipData, icMaxStatus(), icMsgValidateNonCompliant, icMsgValidateWarning, icValidateNonCompliant, icValidateWarning, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagZipUtf8Text::Write ( CIccIO * pIO )

virtual

Name: CIccTagZipUtf8Text::Write.

Purpose: Write a text type tag to a file

Args: pIO - The IO object to write tag to.

Return: true = succesful, false = failure

Reimplemented from CIccTag.

Definition at line 1168 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig = GetType();
 
  if (!pIO)
   return false;
 
  if (!pIO->Write32(&sig))
   return false;
 
  if (!pIO->Write32(&m_nReserved))
    return false;
 
  if (m_pZipBuf) {
    if (pIO->Write8(m_pZipBuf, m_nBufSize) != (icInt32Number)m_nBufSize)
      return false;
  }
  return true;
}

References sig, CIccIO::Write32(), and CIccIO::Write8().

Here is the call graph for this function:

Member Data Documentation

m_nBufSize

icUInt32Number CIccTagZipUtf8Text::m_nBufSize

protected

Definition at line 401 of file IccTagBasic.h.

m_pZipBuf

icUChar* CIccTagZipUtf8Text::m_pZipBuf

protected

Definition at line 400 of file IccTagBasic.h.

---

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

• IccProfLib/IccTagBasic.h
• IccProfLib/IccTagBasic.cpp