CIccTagUtf16Text Class Reference

Class: CIccTagUtf16Text() More...

#include <IccTagBasic.h>

Inheritance diagram for CIccTagUtf16Text:

Collaboration diagram for CIccTagUtf16Text:

Public Member Functions
icUInt32Number	Capacity () const
	CIccTagUtf16Text ()
	Name: CIccTagUtf16Text::CIccTagUtf16Text.
	CIccTagUtf16Text (const CIccTagUtf16Text &ITT)
	Name: CIccTagUtf16Text::CIccTagUtf16Text.
virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagUtf16Text::Describe.
icUChar16 *	GetBuffer (icUInt32Number nSize)
	Name: CIccTagUtf16Text::GetBuffer.
virtual const icChar *	GetClassName () const
icUInt32Number	GetLength () const
	Name: CIccTagUtf16Text::GetLength.
const icUChar16 *	GetText () const
const icChar *	GetText (std::string &bufStr) const
	Name: CIccTagUtf16Text::GetText.
virtual icTagTypeSignature	GetType () const
	Function: GetType()
virtual CIccTag *	NewCopy () const
	Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.
CIccTagUtf16Text &	operator= (const CIccTagUtf16Text &TextTag)
	Name: CIccTagUtf16Text::operator=.
const icUChar16 *	operator= (const icUChar16 *szText)
	Name: *CIccTagUtf16Textoperator=.
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagUtf16Text::Read.
void	Release ()
	Name: CIccTagUtf16Text::Release.
void	SetText (const icChar *szText)
void	SetText (const icUChar *szText)
	Name: CIccTagUtf16Text::SetText.
void	SetText (const icUChar16 *szText)
	Name: CIccTagUtf16Text::SetText.
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagUtf16Text::Validate.
virtual bool	Write (CIccIO *pIO)
	Name: CIccTagUtf16Text::Write.
virtual	~CIccTagUtf16Text ()
	Name: CIccTagUtf16Text::~CIccTagUtf16Text.
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
icUChar16 *	m_szText

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: CIccTagUtf16Text()

Purpose: The utf8TextType ICC tag

Definition at line 433 of file IccTagBasic.h.

Constructor & Destructor Documentation

CIccTagUtf16Text() [1/2]

CIccTagUtf16Text::CIccTagUtf16Text

(

)

Name: CIccTagUtf16Text::CIccTagUtf16Text.

Purpose: Constructor

Definition at line 1499 of file IccTagBasic.cpp.

{
  m_szText = (icUChar16*)malloc(1*sizeof(icUChar16));
  m_szText[0] = 0;
  m_nBufSize = 1;
}

CIccTagUtf16Text() [2/2]

CIccTagUtf16Text::CIccTagUtf16Text

(

const CIccTagUtf16Text &

ITT

)

Name: CIccTagUtf16Text::CIccTagUtf16Text.

Purpose: Copy Constructor

Args: ITT = The CIccTagText object to be copied

Definition at line 1516 of file IccTagBasic.cpp.

{
  m_szText = (icUChar16*)malloc(1*sizeof(icUChar16));
  m_szText[0] = 0;
  m_nBufSize = 1;
  SetText(ITT.m_szText);
}

References m_szText.

~CIccTagUtf16Text()

CIccTagUtf16Text::~CIccTagUtf16Text ( )

virtual

Name: CIccTagUtf16Text::~CIccTagUtf16Text.

Purpose: Destructor

Definition at line 1555 of file IccTagBasic.cpp.

{
  free(m_szText);
}

Member Function Documentation

Capacity()

icUInt32Number CIccTagUtf16Text::Capacity ( ) const

inline

Definition at line 463 of file IccTagBasic.h.

{ return m_nBufSize; }

Describe()

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

virtual

Name: CIccTagUtf16Text::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 1672 of file IccTagBasic.cpp.

{
    sDescription += "UTF16 Length = ";
    if (m_szText && *m_szText) {
        char buf[40];
        sprintf(buf, "%d bytes\n", m_nBufSize);
        sDescription += buf;
    }
    else
        sDescription += "0 (NULL)";
 
    if (nVerboseness > 25) {
        sDescription += "\"";
        if (m_szText && *m_szText) {
            std::string   s;
            if ((nVerboseness > 50) || (m_nBufSize < BRIEF_STRING_SIZE)) {
                // output entire string if short or doing verbose
                sDescription += GetText(s);
            }
            else {
                // copy just first part of string to keep nVerboseness under control
                char buf[BRIEF_STRING_SIZE + 1];
                strncpy(buf, GetText(s), BRIEF_STRING_SIZE);
                buf[BRIEF_STRING_SIZE] = '\0'; // ensure NULL termination
                sDescription += buf;
                sDescription += "\n... <!truncated!>";
            }
        }
        sDescription += "\"\n";
    }
 
}

References BRIEF_STRING_SIZE.

GetBuffer()

icUChar16 * CIccTagUtf16Text::GetBuffer

(

icUInt32Number

nSize

)

Name: CIccTagUtf16Text::GetBuffer.

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

Args: nSize = Requested size of data buffer.

Return: The utf16 character buffer array

Definition at line 1826 of file IccTagBasic.cpp.

{
  if (m_nBufSize < nSize) {
    m_szText = (icUChar16*)icRealloc(m_szText, (nSize+1)*sizeof(icUChar16));
 
    m_szText[nSize] = 0;
 
    m_nBufSize = nSize;
  }
 
  return m_szText;
}

References icRealloc().

Here is the call graph for this function:

GetClassName()

virtual const icChar * CIccTagUtf16Text::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlUtf16Text.

Definition at line 443 of file IccTagBasic.h.

{ return "CIccUtf16TagText"; }

GetLength()

icUInt32Number CIccTagUtf16Text::GetLength

(

)

const

Name: CIccTagUtf16Text::GetLength.

Purpose: Get length of utf16 string

Definition at line 1568 of file IccTagBasic.cpp.

{
  icUInt32Number n;
  if (!m_szText || !m_nBufSize)
    return 0;
 
  for (n=0; n<m_nBufSize && m_szText[n]; n++);
 
  return n;
}

GetText() [1/2]

const icUChar16 * CIccTagUtf16Text::GetText ( ) const

inline

Definition at line 451 of file IccTagBasic.h.

{ return m_szText; }

GetText() [2/2]

const icChar * CIccTagUtf16Text::GetText

(

std::string &

buf

)

const

Name: CIccTagUtf16Text::GetText.

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

Args: buf - buffer to put tag data into. Returns: buf.c_str()

Definition at line 1716 of file IccTagBasic.cpp.

{
  icUtf8Vector str;
 
  icConvertUTF16toUTF8(m_szText, &m_szText[GetLength()], str, lenientConversion);
 
  buf.clear();
  icUtf8Vector::iterator c;
  c=str.begin();
  if (str.size()>2 && (str[0]==0xff && str[1]==0xfe)) {
    c++; c++;
  }
  for (; c!=str.end(); c++)
    buf.push_back(*c);
 
  return buf.c_str();
}

References icConvertUTF16toUTF8(), and lenientConversion.

Referenced by icGetTagText().

Here is the call graph for this function:

Here is the caller graph for this function:

GetType()

virtual icTagTypeSignature CIccTagUtf16Text::GetType ( ) const

inlinevirtual

Function: GetType()

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

Reimplemented from CIccTag.

Definition at line 442 of file IccTagBasic.h.

{ return icSigUtf16TextType; }

References icSigUtf16TextType.

NewCopy()

virtual CIccTag * CIccTagUtf16Text::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 CIccTagXmlUtf16Text.

Definition at line 439 of file IccTagBasic.h.

{return new CIccTagUtf16Text(*this);}

operator=() [1/2]

CIccTagUtf16Text & CIccTagUtf16Text::operator=

(

const CIccTagUtf16Text &

TextTag

)

Name: CIccTagUtf16Text::operator=.

Purpose: Copy Operator

Args: TextTag = The CIccTagText object to be copied

Definition at line 1534 of file IccTagBasic.cpp.

{
  if (&TextTag == this)
    return *this;
 
  m_szText = (icUChar16*)malloc(1*sizeof(icUChar16));
  m_szText[0] = '\0';
  m_nBufSize = 1;
  SetText(TextTag.m_szText);
 
  return *this;
}

References m_szText.

operator=() [2/2]

const icUChar16 * CIccTagUtf16Text::operator=

(

const icUChar16 *

szText

)

Name: *CIccTagUtf16Textoperator=.

Purpose: Define assignment operator to associate text with tag.

Args: szText - zero terminated string to put in the tag

Return: A pointer to the string assigned to the tag.

Definition at line 1807 of file IccTagBasic.cpp.

{
  SetText(szText);
  return (icUChar16*)m_szText;
}

Read()

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

virtual

Name: CIccTagUtf16Text::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 1593 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig;
 
  if (size<sizeof(icTagTypeSignature) || !pIO) {
    m_szText[0] = '\0';
    return false;
  }
 
  if (!pIO->Read32(&sig))
    return false;
 
  if (!pIO->Read32(&m_nReserved))
    return false;
 
  icUInt32Number nSize = (size - sizeof(icTagTypeSignature) - sizeof(icUInt32Number))/sizeof(icUChar16);
 
  icUChar16 *pBuf = GetBuffer(nSize);
 
  if (nSize) {
    if (pIO->Read16(pBuf, nSize) != (icInt32Number)nSize) {
      return false;
    }
  }
 
  Release();
 
  return true;
}

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

Here is the call graph for this function:

Release()

void CIccTagUtf16Text::Release

(

)

Name: CIccTagUtf16Text::Release.

Purpose: This will resize the buffer to fit the zero terminated string in the buffer.

Definition at line 1847 of file IccTagBasic.cpp.

{
  icUInt32Number nSize = GetLength()+1;
 
  if (nSize < m_nBufSize-1) {
    m_szText=(icUChar16*)icRealloc(m_szText, (nSize+1)*sizeof(icUChar16));
    m_nBufSize = nSize+1;
  }
}

References icRealloc().

Here is the call graph for this function:

SetText() [1/3]

void CIccTagUtf16Text::SetText ( const icChar * szText )

inline

Definition at line 455 of file IccTagBasic.h.

{ 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]

void CIccTagUtf16Text::SetText

(

const icUChar *

szText

)

Name: CIccTagUtf16Text::SetText.

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

Args: szText - zero terminated string to put in tag

Definition at line 1772 of file IccTagBasic.cpp.

{
  if (!szText) {
    icUChar16 c=0;
    SetText(&c);
  }
 
  icUtf16Vector str;
  icConvertUTF8toUTF16(szText, szText+strlen((icChar*)szText)+1, str, lenientConversion);
 
  int pos = 0;
  if (str[0]==0xfeff) {
    pos = 1;
  }
 
  icUInt32Number nSize = (icUInt32Number)(str.size()-pos);
  icUChar16 *szBuf = GetBuffer(nSize);
 
  if (nSize)
    memcpy(m_szText, &str[pos], nSize*sizeof(icUChar));
  Release();
}

References icConvertUTF8toUTF16(), and lenientConversion.

Here is the call graph for this function:

SetText() [3/3]

void CIccTagUtf16Text::SetText

(

const icUChar16 *

szText

)

Name: CIccTagUtf16Text::SetText.

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

Args: szText - zero terminated string to put in tag

Definition at line 1745 of file IccTagBasic.cpp.

{
  if (!szText) {
    icUChar16 c=0;
    SetText(&c);
  }
 
  icUInt32Number n;
  for (n=0; szText[n]; n++);
 
  icUInt32Number len=n + 1;
  icUChar16 *szBuf = GetBuffer(len);
 
  memcpy(szBuf, szText, len*sizeof(icUChar16));
  Release();
}

Validate()

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

virtual

Name: CIccTagUtf16Text::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 1872 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);
  }
 
  return rv;
}

References CIccInfo::GetSigPathName(), icMaxStatus(), icMsgValidateWarning, icValidateWarning, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagUtf16Text::Write ( CIccIO * pIO )

virtual

Name: CIccTagUtf16Text::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 1636 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_szText)
    return false;
 
  icUInt32Number nSize = GetLength();
 
  if (nSize) {
    if (pIO->Write16(m_szText, nSize) != (icInt32Number)nSize)
      return false;
  }
 
  return true;
}

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

Here is the call graph for this function:

Member Data Documentation

m_nBufSize

icUInt32Number CIccTagUtf16Text::m_nBufSize

protected

Definition at line 469 of file IccTagBasic.h.

m_szText

icUChar16* CIccTagUtf16Text::m_szText

protected

Definition at line 468 of file IccTagBasic.h.

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

---

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

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