CIccTagUtf8Text Class Reference

Class: CIccTagUtf8Text() More...

#include <IccTagBasic.h>

Inheritance diagram for CIccTagUtf8Text:

Collaboration diagram for CIccTagUtf8Text:

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

Purpose: The utf8TextType ICC tag

Definition at line 321 of file IccTagBasic.h.

Constructor & Destructor Documentation

CIccTagUtf8Text() [1/2]

CIccTagUtf8Text::CIccTagUtf8Text

(

)

Name: CIccTagUtf8Text::CIccTagUtf8Text.

Purpose: Constructor

Definition at line 706 of file IccTagBasic.cpp.

{
  m_szText = (icUChar*)malloc(1);
  m_szText[0] = '\0';
  m_nBufSize = 1;
}

CIccTagUtf8Text() [2/2]

CIccTagUtf8Text::CIccTagUtf8Text

(

const CIccTagUtf8Text &

ITT

)

Name: CIccTagUtf8Text::CIccTagUtf8Text.

Purpose: Copy Constructor

Args: ITT = The CIccTagText object to be copied

Definition at line 723 of file IccTagBasic.cpp.

{
  m_szText = (icUChar*)malloc(1);
  m_szText[0] = '\0';
  m_nBufSize = 1;
  SetText(ITT.m_szText);
}

References m_szText.

~CIccTagUtf8Text()

CIccTagUtf8Text::~CIccTagUtf8Text ( )

virtual

Name: CIccTagUtf8Text::~CIccTagUtf8Text.

Purpose: Destructor

Definition at line 762 of file IccTagBasic.cpp.

{
  free(m_szText);
}

Member Function Documentation

Capacity()

icUInt32Number CIccTagUtf8Text::Capacity ( ) const

inline

Definition at line 349 of file IccTagBasic.h.

{ return m_nBufSize; }

Describe()

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

virtual

Name: CIccTagUtf8Text::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 861 of file IccTagBasic.cpp.

{
  sDescription += "UTF8 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) {
      if ((nVerboseness > 50) || (m_nBufSize < BRIEF_STRING_SIZE)) {
        // output entire string if short or doing verbose output
        sDescription += (icChar*)m_szText;  
      }
      else {
         // copy just first part of string to keep nVerboseness under control
         char buf[BRIEF_STRING_SIZE + 1];
         strncpy(buf, (icChar*)m_szText, BRIEF_STRING_SIZE);
         buf[BRIEF_STRING_SIZE] = '\0'; // ensure NULL termination
         sDescription += buf;
         sDescription += "\n... <!truncated!>";
      }
    }
    sDescription += "\"\n";
  }
}

References BRIEF_STRING_SIZE.

GetBuffer()

icUChar * CIccTagUtf8Text::GetBuffer

(

icUInt32Number

nSize

)

Name: CIccTagUtf8Text::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 character buffer array

Definition at line 971 of file IccTagBasic.cpp.

{
  if (m_nBufSize < nSize) {
    m_szText = (icUChar*)icRealloc(m_szText, nSize+1);
 
    if (m_szText) {
      m_szText[nSize] = '\0';
      m_nBufSize = nSize;
    }
    else {
      m_nBufSize = 0;
    }
  }
 
  return m_szText;
}

References icRealloc().

Here is the call graph for this function:

GetClassName()

virtual const icChar * CIccTagUtf8Text::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlUtf8Text.

Definition at line 331 of file IccTagBasic.h.

{ return "CIccUtf8TagText"; }

GetText()

const icUChar * CIccTagUtf8Text::GetText ( ) const

inline

Definition at line 338 of file IccTagBasic.h.

{ return m_szText; }

Referenced by CIccStructNamedColor::getName(), icConvertEncodingProfile(), and icGetTagText().

Here is the caller graph for this function:

GetType()

virtual icTagTypeSignature CIccTagUtf8Text::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 330 of file IccTagBasic.h.

{ return icSigUtf8TextType; }

References icSigUtf8TextType.

NewCopy()

virtual CIccTag * CIccTagUtf8Text::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 CIccTagXmlUtf8Text.

Definition at line 327 of file IccTagBasic.h.

{return new CIccTagUtf8Text(*this);}

operator=() [1/3]

CIccTagUtf8Text & CIccTagUtf8Text::operator=

(

const CIccTagUtf8Text &

TextTag

)

Name: CIccTagUtf8Text::operator=.

Purpose: Copy Operator

Args: TextTag = The CIccTagText object to be copied

Definition at line 741 of file IccTagBasic.cpp.

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

References m_szText.

operator=() [2/3]

const icChar * CIccTagUtf8Text::operator= ( const icChar * szText )

inline

Definition at line 345 of file IccTagBasic.h.

{ return (const icChar*)operator=((icUChar*)szText); }

References operator=().

Referenced by operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [3/3]

const icUChar * CIccTagUtf8Text::operator=

(

const icUChar *

szText

)

Name: *CIccTagUtf8Textoperator=.

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 952 of file IccTagBasic.cpp.

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

Read()

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

virtual

Name: CIccTagUtf8Text::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 781 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;
 
  if (size < sizeof(icTagTypeSignature) + sizeof(icUInt32Number))
    return false;
 
  icUInt32Number nSize = size - sizeof(icTagTypeSignature) - sizeof(icUInt32Number);
 
  icUChar *pBuf = GetBuffer(nSize);
 
  if (nSize) {
    if (pIO->Read8(pBuf, nSize) != (icInt32Number)nSize) {
      return false;
    }
  }
 
  Release();
 
  return true;
}

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

Here is the call graph for this function:

Release()

void CIccTagUtf8Text::Release

(

)

Name: CIccTagUtf8Text::Release.

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

Definition at line 996 of file IccTagBasic.cpp.

{
  icUInt32Number nSize = (icUInt32Number)strlen((icChar*)m_szText)+1;
 
  if (nSize < m_nBufSize-1) {
    m_szText=(icUChar*)icRealloc(m_szText, nSize+1);
    m_nBufSize = nSize+1;
  }
}

References icRealloc().

Here is the call graph for this function:

SetText() [1/3]

void CIccTagUtf8Text::SetText ( const icChar * szText )

inline

Definition at line 342 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 CIccTagUtf8Text::SetText

(

const icUChar *

szText

)

Name: CIccTagUtf8Text::SetText.

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

Args: szText - zero terminated string to put in tag

Definition at line 903 of file IccTagBasic.cpp.

{
  if (!szText) 
    SetText("");
 
  icUInt32Number len=(icUInt32Number)strlen((icChar*)szText) + 1;
  icUChar *szBuf = GetBuffer(len);
 
  strcpy((icChar*)szBuf, (icChar*)szText);
  Release();
}

SetText() [3/3]

void CIccTagUtf8Text::SetText

(

const icUChar16 *

szText

)

Name: CIccTagUtf8Text::SetText.

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

Args: szText - zero terminated string to put in tag

Definition at line 926 of file IccTagBasic.cpp.

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

References icConvertUTF16toUTF8(), and lenientConversion.

Here is the call graph for this function:

Validate()

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

virtual

Name: CIccTagUtf8Text::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 1021 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 CIccTagUtf8Text::Write ( CIccIO * pIO )

virtual

Name: CIccTagUtf8Text::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 827 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 = (icUInt32Number)strlen((icChar*)m_szText)+1;
 
  if (pIO->Write8(m_szText, nSize) != (icInt32Number)nSize)
    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 CIccTagUtf8Text::m_nBufSize

protected

Definition at line 354 of file IccTagBasic.h.

m_szText

icUChar* CIccTagUtf8Text::m_szText

protected

Definition at line 353 of file IccTagBasic.h.

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

---

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

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