#include <IccTagBasic.h>

Inheritance diagram for CIccTagText:

Collaboration diagram for CIccTagText:

Public Member Functions
icUInt32Number	Capacity () const

	CIccTagText ()
	Name: CIccTagText::CIccTagText.

	CIccTagText (const CIccTagText &ITT)
	Name: CIccTagText::CIccTagText.

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

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

virtual const icChar *	GetClassName () const

const icChar *	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.

CIccTagText &	operator= (const CIccTagText &TextTag)
	Name: CIccTagText::operator=.

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

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

void	Release ()
	Name: CIccTagText::Release.

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

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

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

virtual	~CIccTagText ()
	Name: CIccTagText::~CIccTagText.

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

icChar *	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: CIccTagText()

Purpose: The textType ICC tag

Definition at line 283 of file IccTagBasic.h.

Constructor & Destructor Documentation

◆ CIccTagText() [1/2]

CIccTagText::CIccTagText ( )

Name: CIccTagText::CIccTagText.

Purpose: Constructor

Definition at line 363 of file IccTagBasic.cpp.

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

◆ CIccTagText() [2/2]

CIccTagText::CIccTagText ( const CIccTagText & ITT )

Name: CIccTagText::CIccTagText.

Purpose: Copy Constructor

Args: ITT = The CIccTagText object to be copied

Definition at line 380 of file IccTagBasic.cpp.

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

References m_szText.

◆ ~CIccTagText()

CIccTagText::~CIccTagText ( )

virtual

Name: CIccTagText::~CIccTagText.

Purpose: Destructor

Definition at line 419 of file IccTagBasic.cpp.

{
  free(m_szText);
}

Member Function Documentation

◆ Capacity()

icUInt32Number CIccTagText::Capacity ( ) const

inline

Definition at line 306 of file IccTagBasic.h.

306{ return m_nBufSize; }

◆ Describe()

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

virtual

Name: CIccTagText::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 516 of file IccTagBasic.cpp.

{
  sDescription += "Text 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 * CIccTagText::GetBuffer ( icUInt32Number nSize )

Name: CIccTagText::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 600 of file IccTagBasic.cpp.

{
  if (m_nBufSize < nSize) {
    m_szText = (icChar*)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 * CIccTagText::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlText.

Definition at line 293 of file IccTagBasic.h.

293{ return "CIccTagText"; }

◆ GetText()

const icChar * CIccTagText::GetText ( ) const

inline

Definition at line 300 of file IccTagBasic.h.

300{ return m_szText; }

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

Here is the caller graph for this function:

◆ GetType()

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

292{ return icSigTextType; }

icSigTextType

@ icSigTextType

Definition icProfileHeader.h:565

References icSigTextType.

◆ NewCopy()

virtual CIccTag * CIccTagText::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 CIccTagXmlText.

Definition at line 289 of file IccTagBasic.h.

289{return new CIccTagText(*this);}

CIccTagText::CIccTagText

CIccTagText()

Name: CIccTagText::CIccTagText.

Definition IccTagBasic.cpp:363

◆ operator=() [1/2]

CIccTagText & CIccTagText::operator= ( const CIccTagText & TextTag )

Name: CIccTagText::operator=.

Purpose: Copy Operator

Args: TextTag = The CIccTagText object to be copied

Definition at line 398 of file IccTagBasic.cpp.

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

References m_szText.

◆ operator=() [2/2]

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

Name: *CIccTagTextoperator=.

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

{
  SetText(szText);
  return m_szText;
}

◆ Read()

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

virtual

Name: CIccTagText::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 438 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig;
 
  // Defensive: initialize so error paths all have valid m_szText
  m_szText[0] = '\0';
 
  if (size < (sizeof(icTagTypeSignature) + sizeof(icUInt32Number)) || !pIO)
    return false;
 
  if (!pIO->Read32(&sig))
    return false;
 
  if (!pIO->Read32(&m_nReserved))
    return false;
 
  icUInt32Number nSize = size - sizeof(icTagTypeSignature) - sizeof(icUInt32Number);
 
  icChar *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 CIccTagText::Release ( )

Name: CIccTagText::Release.

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

Definition at line 624 of file IccTagBasic.cpp.

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

References icRealloc().

Here is the call graph for this function:

◆ SetText()

void CIccTagText::SetText ( const icChar * szText )

Name: CIccTagText::SetText.

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

Args: szText - zero terminated string to put in tag

Definition at line 557 of file IccTagBasic.cpp.

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

◆ Validate()

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

virtual

Name: CIccTagText::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 649 of file IccTagBasic.cpp.

{
  icValidateStatus rv = CIccTag::Validate(sigPath, sReport, pProfile);
 
  CIccInfo Info;
  std::string sSigPathName = Info.GetSigPathName(sigPath);
  icSignature sig = icGetFirstSigPathSig(sigPath);
 
  if (m_nBufSize) {
    switch(sig) {
    case icSigCopyrightTag:
      break;
    case icSigCharTargetTag:
      if (m_nBufSize<7) {
        sReport += icMsgValidateNonCompliant;
        sReport += sSigPathName;
        sReport += " - Tag must have at least seven text characters.\n";
        rv = icMaxStatus(rv, icValidateNonCompliant);
      }
      break;
    default:
      sReport += icMsgValidateWarning;
      sReport += sSigPathName;
      sReport += " - Unknown Tag.\n";
      rv = icMaxStatus(rv, icValidateWarning);
    }
    int i;
    for (i=0; m_szText[i] && i<(int)m_nBufSize; i++) {
      if (m_szText[i]&0x80) {
        sReport += icMsgValidateWarning;
        sReport += sSigPathName;
        sReport += " - Text does not contain just 7-bit data.\n";
        rv = icMaxStatus(rv, icValidateWarning);
      }
    }
  }
  else {
    sReport += icMsgValidateWarning;
    sReport += sSigPathName;
    sReport += " - Empty Tag.\n";
    rv = icMaxStatus(rv, icValidateWarning);
  }
 
 
  return rv;
}

References CIccInfo::GetSigPathName(), icGetFirstSigPathSig(), icMaxStatus(), icMsgValidateNonCompliant, icMsgValidateWarning, icSigCharTargetTag, icSigCopyrightTag, icValidateNonCompliant, icValidateWarning, sig, and CIccTag::Validate().

Here is the call graph for this function:

◆ Write()

bool CIccTagText::Write ( CIccIO * pIO )

virtual

Name: CIccTagText::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 482 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(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 CIccTagText::m_nBufSize

protected

Definition at line 311 of file IccTagBasic.h.

◆ m_szText

icChar* CIccTagText::m_szText

protected

Definition at line 310 of file IccTagBasic.h.

Referenced by CIccTagText(), 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

◆ CIccTagText() [1/2]

◆ CIccTagText() [2/2]

◆ ~CIccTagText()

Member Function Documentation

◆ Capacity()

◆ Describe()

◆ GetBuffer()

◆ GetClassName()

◆ GetText()

◆ GetType()

◆ NewCopy()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Read()

◆ Release()

◆ SetText()

◆ Validate()

◆ Write()

Member Data Documentation

◆ m_nBufSize

◆ m_szText