#include <IccTagBasic.h>

Inheritance diagram for CIccTagTextDescription:

Collaboration diagram for CIccTagTextDescription:

Public Member Functions
icUInt32Number	Capacity () const

	CIccTagTextDescription ()
	Name: CIccTagTextDescription::CIccTagTextDescription.

	CIccTagTextDescription (const CIccTagTextDescription &ITTD)
	Name: CIccTagTextDescription::CIccTagTextDescription.

virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagTextDescription::Describe.

icChar *	GetBuffer (icUInt32Number nSize)
	Name: CIccTagTextDescription::GetBuffer.

virtual const icChar *	GetClassName () const

const icChar *	GetText () const

virtual icTagTypeSignature	GetType () const
	Function: GetType()

icUInt16Number *	GetUnicodeBuffer (icUInt32Number nSize)
	Name: CIccTagTextDescription::GetUnicodeBuffer.

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

CIccTagTextDescription &	operator= (const CIccTagTextDescription &TextDescTag)
	Name: CIccTagTextDescription::operator=.

const icChar *	operator= (const icChar *szText)
	Name: CIccTagTextDescription::operator=.

virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagTextDescription::Read.

void	Release ()
	Name: CIccTagTextDescription::Release.

void	ReleaseUnicode ()
	Name: CIccTagTextDescription::ReleaseUnicode.

void	SetText (const icChar *szText)
	Name: CIccTagTextDescription::SetText.

virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagTextDescription::Validate.

virtual bool	Write (CIccIO *pIO)
	Name: CIccTagTextDescription::Write.

virtual	~CIccTagTextDescription ()
	Name: CIccTagTextDescription::~CIccTagTextDescription.

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
bool	m_bInvalidScript

icUInt32Number	m_nASCIISize

icUInt16Number	m_nScriptCode

icUInt8Number	m_nScriptSize

icUInt32Number	m_nUnicodeLanguageCode

icUInt32Number	m_nUnicodeSize

icUInt8Number	m_szScriptText [67]

icChar *	m_szText

icUInt16Number *	m_uzUnicodeText

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

Purpose: The textType ICC tag

Definition at line 480 of file IccTagBasic.h.

Constructor & Destructor Documentation

◆ CIccTagTextDescription() [1/2]

CIccTagTextDescription::CIccTagTextDescription ( )

Name: CIccTagTextDescription::CIccTagTextDescription.

Purpose: Constructor

Definition at line 1899 of file IccTagBasic.cpp.

{
  m_szText = (icChar*)malloc(1);
  m_szText[0] = '\0';
  m_nASCIISize = 1;
 
  m_uzUnicodeText = (icUInt16Number*)malloc(sizeof(icUInt16Number));
  m_uzUnicodeText[0] = 0;
  m_nUnicodeSize = 1;
  m_nUnicodeLanguageCode = 0;
 
  m_nScriptSize = 0;
  m_nScriptCode = 0;
  memset(m_szScriptText, 0, sizeof(m_szScriptText));
 
  m_bInvalidScript = false;
}

◆ CIccTagTextDescription() [2/2]

CIccTagTextDescription::CIccTagTextDescription ( const CIccTagTextDescription & ITTD )

Name: CIccTagTextDescription::CIccTagTextDescription.

Purpose: Copy Constructor

Args: ITTD = The CIccTagTextDescription object to be copied

Definition at line 1927 of file IccTagBasic.cpp.

{
  m_nASCIISize = ITTD.m_nASCIISize;
  m_nUnicodeSize = ITTD.m_nUnicodeSize;
  m_nUnicodeLanguageCode = ITTD.m_nUnicodeLanguageCode;
  m_nScriptSize = ITTD.m_nScriptSize;
  m_nScriptCode = ITTD.m_nScriptCode;
 
  if (m_nASCIISize) {
    m_szText = (icChar*)malloc(m_nASCIISize * sizeof(icChar));
    memcpy(m_szText, ITTD.m_szText, m_nASCIISize*sizeof(icChar));
  }
  else {
    m_nASCIISize = 1;
    m_szText = (icChar*)calloc(m_nASCIISize, sizeof(icChar));
    m_szText[0] = '\0';
  }
 
  if (m_nUnicodeSize) {
    m_uzUnicodeText = (icUInt16Number*)malloc((m_nUnicodeSize) * sizeof(icUInt16Number));
    memcpy(m_uzUnicodeText, ITTD.m_uzUnicodeText, m_nUnicodeSize*sizeof(icUInt16Number));
  }
  else {
    m_nUnicodeSize = 1;
    m_uzUnicodeText = (icUInt16Number*)calloc(m_nUnicodeSize, sizeof(icUInt16Number));
    m_uzUnicodeText[0] = 0;
  }
 
  memcpy(m_szScriptText, ITTD.m_szScriptText, sizeof(m_szScriptText));
 
  m_bInvalidScript = ITTD.m_bInvalidScript;
}

References m_bInvalidScript, m_nASCIISize, m_nScriptCode, m_nScriptSize, m_nUnicodeLanguageCode, m_nUnicodeSize, m_szScriptText, m_szText, and m_uzUnicodeText.

◆ ~CIccTagTextDescription()

CIccTagTextDescription::~CIccTagTextDescription ( )

virtual

Name: CIccTagTextDescription::~CIccTagTextDescription.

Purpose: Destructor

Definition at line 2021 of file IccTagBasic.cpp.

{
  free(m_szText);
  free(m_uzUnicodeText);
}

Member Function Documentation

◆ Capacity()

icUInt32Number CIccTagTextDescription::Capacity ( ) const

inline

Definition at line 503 of file IccTagBasic.h.

503{ return m_nASCIISize; }

◆ Describe()

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

virtual

Name: CIccTagTextDescription::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 2185 of file IccTagBasic.cpp.

{
  sDescription += "TextDescription Length = ";
  if (m_szText && *m_szText) {
    char buf[40];
    sprintf(buf, "%zu bytes\n", strlen(m_szText));
    sDescription += buf;
  }
  else
    sDescription += "0 (NULL)";
 
  if (nVerboseness > 25) {
    sDescription += "\"";
    if (m_szText && *m_szText) {
      if ((nVerboseness > 50) || (strlen(m_szText) < BRIEF_STRING_SIZE)) {
        // output entire string if short or doing verbose
         sDescription += m_szText;  
      }
      else {
        // copy just first part of string to keep nVerboseness under control
        char buf[BRIEF_STRING_SIZE+1];
        strncpy(buf, 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()

icChar * CIccTagTextDescription::GetBuffer ( icUInt32Number nSize )

Name: CIccTagTextDescription::GetBuffer.

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

Args: nSize = Requested size of data buffer.

Return:

Definition at line 2272 of file IccTagBasic.cpp.

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

References icRealloc().

Here is the call graph for this function:

◆ GetClassName()

virtual const icChar * CIccTagTextDescription::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlTextDescription.

Definition at line 490 of file IccTagBasic.h.

490{ return "CIccTagTextDescription"; }

◆ GetText()

const icChar * CIccTagTextDescription::GetText ( ) const

inline

Definition at line 497 of file IccTagBasic.h.

497{ return m_szText; }

Referenced by CIccProfileIdDesc::CIccProfileIdDesc(), icGetTagText(), and main().

Here is the caller graph for this function:

◆ GetType()

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

489{ return icSigTextDescriptionType; }

icSigTextDescriptionType

@ icSigTextDescriptionType

Definition icProfileHeader.h:566

References icSigTextDescriptionType.

◆ GetUnicodeBuffer()

icUInt16Number * CIccTagTextDescription::GetUnicodeBuffer ( icUInt32Number nSize )

Name: CIccTagTextDescription::GetUnicodeBuffer.

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

Args: nSize = Requested size of data buffer.

Return:

Definition at line 2316 of file IccTagBasic.cpp.

{
  if (m_nUnicodeSize < nSize) {
    m_uzUnicodeText = (icUInt16Number*)icRealloc(m_uzUnicodeText, (nSize+1)*sizeof(icUInt16Number));
 
    m_uzUnicodeText[nSize] = 0;
 
    m_nUnicodeSize = nSize;
  }
 
  return m_uzUnicodeText;
}

References icRealloc().

Here is the call graph for this function:

◆ NewCopy()

virtual CIccTag * CIccTagTextDescription::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 CIccTagXmlTextDescription.

Definition at line 486 of file IccTagBasic.h.

486{return new CIccTagTextDescription(*this);}

CIccTagTextDescription::CIccTagTextDescription

CIccTagTextDescription()

Name: CIccTagTextDescription::CIccTagTextDescription.

Definition IccTagBasic.cpp:1899

◆ operator=() [1/2]

CIccTagTextDescription & CIccTagTextDescription::operator= ( const CIccTagTextDescription & TextDescTag )

Name: CIccTagTextDescription::operator=.

Purpose: Copy Operator

Args: TextDescTag = The CIccTagTextDescription object to be copied

Definition at line 1971 of file IccTagBasic.cpp.

{
  if (&TextDescTag == this)
    return *this;
 
  m_nASCIISize = TextDescTag.m_nASCIISize;
  m_nUnicodeSize = TextDescTag.m_nUnicodeSize;
  m_nUnicodeLanguageCode = TextDescTag.m_nUnicodeLanguageCode;
  m_nScriptSize = TextDescTag.m_nScriptSize;
  m_nScriptCode = TextDescTag.m_nScriptCode;
 
  if (m_szText)
    free(m_szText);
  if (m_nASCIISize) {
    m_szText = (icChar*)calloc(m_nASCIISize, sizeof(icChar));
    memcpy(m_szText, TextDescTag.m_szText, m_nASCIISize*sizeof(icChar));
  } 
  else {
    m_nASCIISize = 1;
    m_szText = (icChar*)calloc(m_nASCIISize, sizeof(icChar));
    m_szText[0] = '\0';
  }
 
  if (m_uzUnicodeText)
    free(m_uzUnicodeText);
  if (m_nUnicodeSize) {
    m_uzUnicodeText = (icUInt16Number*)calloc(m_nUnicodeSize, sizeof(icUInt16Number));
    memcpy(m_uzUnicodeText, TextDescTag.m_uzUnicodeText, m_nUnicodeSize*sizeof(icUInt16Number));
  }
  else {
    m_nUnicodeSize = 1;
    m_uzUnicodeText = (icUInt16Number*)calloc(m_nUnicodeSize, sizeof(icUInt16Number));
    m_uzUnicodeText[0] = 0;
  }
 
  memcpy(m_szScriptText, TextDescTag.m_szScriptText, sizeof(m_szScriptText));
 
  m_bInvalidScript = TextDescTag.m_bInvalidScript;
 
  return *this;  
}

References m_bInvalidScript, m_nASCIISize, m_nScriptCode, m_nScriptSize, m_nUnicodeLanguageCode, m_nUnicodeSize, m_szScriptText, m_szText, and m_uzUnicodeText.

◆ operator=() [2/2]

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

Name: CIccTagTextDescription::operator=.

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

{
  SetText(szText);
  return m_szText;
}

◆ Read()

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

virtual

Name: CIccTagTextDescription::Read.

Purpose: Read in the tag contents 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 2041 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig;
  icUInt32Number nEnd;
 
  m_szText[0] = '\0';
  nEnd = pIO->Tell() + size;
 
  if (size<3*sizeof(icUInt32Number) || !pIO)
    return false;
 
  icUInt32Number nSize;
 
  if (!pIO->Read32(&sig) ||
      !pIO->Read32(&m_nReserved) ||
      !pIO->Read32(&nSize))
    return false;
 
  if (3*sizeof(icUInt32Number) + nSize > size)
    return false;
 
  icChar *pBuf = GetBuffer(nSize);
 
  if (nSize) {
    if (pIO->Read8(pBuf, nSize) != (icInt32Number)nSize) {
      return false;
    }
  }
  else 
    m_szText[0] = '\0';
  
  Release();
 
  if (pIO->Tell() + 2 * sizeof(icUInt32Number) > nEnd)
    return false;
 
  if (!pIO->Read32(&m_nUnicodeLanguageCode) ||
      !pIO->Read32(&nSize))
    return false;
 
  // Calculations in GetUnicodeBuffer() can cause wrap-around error
  if (nSize == 0xFFFFFFFF) 
    return false;
 
  icUInt16Number *pBuf16 = GetUnicodeBuffer(nSize);
 
  if (nSize) {
    if (pIO->Read16(pBuf16, nSize) != (icInt32Number)nSize) {
      return false;
    }
  }
  else 
    pBuf16[0] = 0;
 
  ReleaseUnicode();
 
  if (pIO->Tell()+3 > (icInt32Number)nEnd)
    return false;
 
  if (!pIO->Read16(&m_nScriptCode) ||
      !pIO->Read8(&m_nScriptSize))
     return false;
  
  if (pIO->Tell() + m_nScriptSize> (icInt32Number)nEnd ||
      m_nScriptSize > sizeof(m_szScriptText))
    return false;
 
  int nScriptLen = pIO->Read8(m_szScriptText, 67);
 
  if (!nScriptLen)
    return false;
 
  if (nScriptLen<67) {
    memset(&m_szScriptText[0], 0, 67-nScriptLen);
    m_bInvalidScript = true;
  }
 
  return true;
}

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

Here is the call graph for this function:

◆ Release()

void CIccTagTextDescription::Release ( )

Name: CIccTagTextDescription::Release.

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

Definition at line 2293 of file IccTagBasic.cpp.

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

References icRealloc().

Here is the call graph for this function:

◆ ReleaseUnicode()

void CIccTagTextDescription::ReleaseUnicode ( )

Name: CIccTagTextDescription::ReleaseUnicode.

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

Definition at line 2337 of file IccTagBasic.cpp.

{
  int i;
  for (i=0; m_uzUnicodeText[i]; i++);
 
  icUInt32Number nSize = i+1;
 
  if (nSize < m_nUnicodeSize-1) {
    m_uzUnicodeText=(icUInt16Number*)icRealloc(m_uzUnicodeText, (nSize+1)*sizeof(icUInt16Number));
    m_nUnicodeSize = nSize+1;
  }
}

References icRealloc().

Here is the call graph for this function:

◆ SetText()

void CIccTagTextDescription::SetText ( const icChar * szText )

Name: CIccTagTextDescription::SetText.

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

Args: szText - zero terminated string to put in tag

Definition at line 2227 of file IccTagBasic.cpp.

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

◆ Validate()

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

virtual

Name: CIccTagTextDescription::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 2365 of file IccTagBasic.cpp.

{
  icValidateStatus rv = CIccTag::Validate(sigPath, sReport, pProfile);
 
  CIccInfo Info;
  std::string sSigPathName = Info.GetSigPathName(sigPath);
 
  if (m_nScriptSize>67) {
    sReport += icMsgValidateNonCompliant;
    sReport += sSigPathName;
    sReport += " - ScriptCode count must not be greater than 67.\n";
 
    rv =icMaxStatus(rv, icValidateNonCompliant);
  }
 
  if (m_bInvalidScript) {
    sReport += icMsgValidateNonCompliant;
    sReport += sSigPathName;
    sReport += " - ScriptCode must contain 67 bytes.\n";
 
    rv =icMaxStatus(rv, icValidateNonCompliant);
  }
 
  return rv;
}

References CIccInfo::GetSigPathName(), icMaxStatus(), icMsgValidateNonCompliant, icValidateNonCompliant, and CIccTag::Validate().

Here is the call graph for this function:

◆ Write()

bool CIccTagTextDescription::Write ( CIccIO * pIO )

virtual

Name: CIccTagTextDescription::Write.

Purpose: Write the tag to a file

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

Return: true = succesful, false = failure

Reimplemented from CIccTag.

Definition at line 2134 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig = GetType();
  icUInt32Number zero = 0;
 
  if (!pIO)
   return false;
 
  if (!pIO->Write32(&sig) ||
      !pIO->Write32(&m_nReserved) ||
      !pIO->Write32(&m_nASCIISize))
    return false;
 
  if (m_nASCIISize) {
    if (pIO->Write8(m_szText, m_nASCIISize) != (icInt32Number)m_nASCIISize)
      return false;
  }
 
  if (!pIO->Write32(&m_nUnicodeLanguageCode))
    return false;
 
  if (m_nUnicodeSize > 1) {
    if (!pIO->Write32(&m_nUnicodeSize) ||
        pIO->Write16(m_uzUnicodeText, m_nUnicodeSize) != (icInt32Number)m_nUnicodeSize)
      return false;
  }
  else {
    if (!pIO->Write32(&zero))
      return false;
  }
 
  if (!pIO->Write16(&m_nScriptCode) ||
      !pIO->Write8(&m_nScriptSize) ||
      pIO->Write8(m_szScriptText, 67)!= 67)
    return false;
 
  m_bInvalidScript = false;
 
  return true;
}

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

Here is the call graph for this function:

Member Data Documentation

◆ m_bInvalidScript

bool CIccTagTextDescription::m_bInvalidScript

protected

Definition at line 522 of file IccTagBasic.h.

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

◆ m_nASCIISize

icUInt32Number CIccTagTextDescription::m_nASCIISize

protected

Definition at line 512 of file IccTagBasic.h.

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

◆ m_nScriptCode

icUInt16Number CIccTagTextDescription::m_nScriptCode

protected

Definition at line 520 of file IccTagBasic.h.

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

◆ m_nScriptSize

icUInt8Number CIccTagTextDescription::m_nScriptSize

protected

Definition at line 519 of file IccTagBasic.h.

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

◆ m_nUnicodeLanguageCode

icUInt32Number CIccTagTextDescription::m_nUnicodeLanguageCode

protected

Definition at line 516 of file IccTagBasic.h.

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

◆ m_nUnicodeSize

icUInt32Number CIccTagTextDescription::m_nUnicodeSize

protected

Definition at line 515 of file IccTagBasic.h.

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

◆ m_szScriptText

icUInt8Number CIccTagTextDescription::m_szScriptText[67]

protected

Definition at line 518 of file IccTagBasic.h.

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

◆ m_szText

icChar* CIccTagTextDescription::m_szText

protected

Definition at line 511 of file IccTagBasic.h.

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

◆ m_uzUnicodeText

icUInt16Number* CIccTagTextDescription::m_uzUnicodeText

protected

Definition at line 514 of file IccTagBasic.h.

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

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

IccProfLib/IccTagBasic.h
IccProfLib/IccTagBasic.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CIccTagTextDescription() [1/2]

◆ CIccTagTextDescription() [2/2]

◆ ~CIccTagTextDescription()

Member Function Documentation

◆ Capacity()

◆ Describe()

◆ GetBuffer()

◆ GetClassName()

◆ GetText()

◆ GetType()

◆ GetUnicodeBuffer()

◆ NewCopy()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Read()

◆ Release()

◆ ReleaseUnicode()

◆ SetText()

◆ Validate()

◆ Write()

Member Data Documentation

◆ m_bInvalidScript

◆ m_nASCIISize

◆ m_nScriptCode

◆ m_nScriptSize

◆ m_nUnicodeLanguageCode

◆ m_nUnicodeSize

◆ m_szScriptText

◆ m_szText

◆ m_uzUnicodeText