CIccTagXmlText Class Reference

#include <IccTagXml.h>

Inheritance diagram for CIccTagXmlText:

Collaboration diagram for CIccTagXmlText:

Public Member Functions
	CIccTagXmlText ()
	CIccTagXmlText (const CIccTagXmlText &ITT)
virtual	~CIccTagXmlText ()
icUInt32Number	Capacity () const
virtual void	Describe (std::string &sDescription, int nVerboseness)
virtual void	DetachIO ()
icChar *	GetBuffer (icUInt32Number nSize)
virtual const char *	GetClassName () const
virtual const char *	GetExtClassName () const
virtual const char *	GetExtDerivedClassName () const
virtual IIccExtensionTag *	GetExtension ()
virtual icArraySignature	GetTagArrayType () const
virtual icStructSignature	GetTagStructType () const
const icChar *	GetText () const
virtual icTagTypeSignature	GetType () const
virtual bool	IsArrayType ()
virtual bool	IsMBBType ()
virtual bool	IsNumArrayType () const
virtual bool	IsSupported ()
virtual CIccTag *	NewCopy () const
virtual bool	ParseXml (xmlNode *pNode, std::string &parseStr)
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
virtual bool	Read (icUInt32Number size, CIccIO *pIO, CIccProfile *pProfile)
virtual bool	ReadAll ()
void	Release ()
void	SetText (const icChar *szText)
virtual bool	ToXml (std::string &xml, std::string blanks="")
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
virtual bool	Write (CIccIO *pIO)

Static Public Member Functions
static CIccTag *	Create (icTagTypeSignature sig)

Data Fields
icUInt32Number	m_nReserved

Protected Attributes
icUInt32Number	m_nBufSize
icChar *	m_szText

Detailed Description

Constructor & Destructor Documentation

CIccTagXmlText() [1/2]

CIccTagXmlText::CIccTagXmlText ( )

inline

: CIccTagText() {}

References CIccTagText::CIccTagText().

Here is the call graph for this function:

CIccTagXmlText() [2/2]

CIccTagXmlText::CIccTagXmlText ( const CIccTagXmlText &  ITT )

inline

: CIccTagText(ITT) {}

References CIccTagText::CIccTagText().

Referenced by NewCopy().

Here is the call graph for this function:

Here is the caller graph for this function:

~CIccTagXmlText()

virtual CIccTagXmlText::~CIccTagXmlText ( )

inlinevirtual

{}

Member Function Documentation

Capacity()

icUInt32Number CIccTagText::Capacity ( ) const

inlineinherited

{ return m_nBufSize; }

References CIccTagText::m_nBufSize.

Create()

CIccTag * CIccTag::Create ( icTagTypeSignature  sig )

staticinherited

Name: CIccTag::Create

Purpose: This is a static tag creator based upon tag signature type

Args: sig = tag type signature

Return: Pointer to Allocated tag

{
  return CIccTagCreator::CreateTag(sig);
}

References CIccTagCreator::CreateTag().

Referenced by CIccDefaultEncProfileConverter::ConvertFromParams(), CIccTagStruct::LoadElem(), CIccProfileXml::ParseTag(), CIccTagXmlStruct::ParseTag(), CIccMpeXmlTintArray::ParseXml(), CIccTagXmlArray::ParseXml(), CIccMpeTintArray::Read(), CIccTagLutAtoB::Read(), CIccTagLut8::Read(), CIccTagLut16::Read(), CIccTagLut8::SetColorSpaces(), CIccTagLut16::SetColorSpaces(), and CIccProfileDescText::SetType().

Here is the call graph for this function:

Here is the caller graph for this function:

Describe()

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

virtualinherited

Name: CIccTagText::Describe

Purpose: Dump data associated with the tag to a string

Args: sDescription - string to concatenate tag dump to

Reimplemented from CIccTag.

{
  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 CIccTagText::m_szText.

DetachIO()

virtual void CIccTag::DetachIO ( )

inlinevirtualinherited

Function: ReadAll() - Read All sub data for tag from file. Called by CIccProfile::ReadAll() to read all sub data for tag

Returns true if ReadAll is successful.

{}

GetBuffer()

icChar * CIccTagText::GetBuffer ( icUInt32Number  nSize )

inherited

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

{
  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(), CIccTagText::m_nBufSize, and CIccTagText::m_szText.

Referenced by CIccTagText::Read(), and CIccTagText::SetText().

Here is the call graph for this function:

Here is the caller graph for this function:

GetClassName()

virtual const char * CIccTagXmlText::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTagText.

{return "CIccTagXmlText"; }

GetExtClassName()

virtual const char * CIccTagXml::GetExtClassName ( ) const

inlinevirtualinherited

Implements IIccExtensionTag.

{ return "CIccTagXml"; }

Referenced by icProfDescToXml(), and icXmlParseProfDesc().

Here is the caller graph for this function:

GetExtDerivedClassName()

virtual const char * CIccTagXml::GetExtDerivedClassName ( ) const

inlinevirtualinherited

Implements IIccExtensionTag.

Reimplemented in CIccCurveXml.

{ return ""; }

GetExtension()

virtual IIccExtensionTag * CIccTagXmlText::GetExtension ( )

inlinevirtual

Reimplemented from CIccTag.

{return this; }

GetTagArrayType()

virtual icArraySignature CIccTag::GetTagArrayType ( ) const

inlinevirtualinherited

Reimplemented in CIccTagArray.

{ return icSigUndefinedArray; }

References icSigUndefinedArray.

Referenced by icGetTagArrayHandlerOfType(), and CIccProfileXml::ParseTag().

Here is the caller graph for this function:

GetTagStructType()

virtual icStructSignature CIccTag::GetTagStructType ( ) const

inlinevirtualinherited

Reimplemented in CIccTagStruct.

{ return icSigUndefinedStruct; }

References icSigUndefinedStruct.

Referenced by icGetTagStructHandlerOfType(), CIccArrayColorantInfo::Validate(), and CIccArrayNamedColor::Validate().

Here is the caller graph for this function:

GetText()

const icChar * CIccTagText::GetText ( ) const

inlineinherited

{ return m_szText; }

References CIccTagText::m_szText.

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

Here is the caller graph for this function:

GetType()

virtual icTagTypeSignature CIccTagText::GetType ( ) const

inlinevirtualinherited

Function: GetType()

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

Reimplemented from CIccTag.

{ return icSigTextType; }

References icSigTextType.

Referenced by CIccTagText::Write().

Here is the caller graph for this function:

IsArrayType()

virtual bool CIccTag::IsArrayType ( )

inlinevirtualinherited

Reimplemented in CIccTagXYZ, CIccTagChromaticity, CIccTagSparseMatrixArray, CIccTagFixedNum< T, Tsig >, CIccTagNum< T, Tsig >, CIccTagFloatNum< T, Tsig >, and CIccTagData.

{ return false; }

Referenced by MyTagDialog::MyTagDialog(), and DumpTag().

Here is the caller graph for this function:

IsMBBType()

virtual bool CIccTag::IsMBBType ( )

inlinevirtualinherited

Reimplemented in CIccMBB.

{ return false; } //If true then CIccTag can be cast as an CIccMBB 

Referenced by CIccProfileXml::ParseTag().

Here is the caller graph for this function:

IsNumArrayType()

virtual bool CIccTag::IsNumArrayType ( ) const

inlinevirtualinherited

Reimplemented in CIccTagSparseMatrixArray, CIccTagFixedNum< T, Tsig >, CIccTagNum< T, Tsig >, and CIccTagFloatNum< T, Tsig >.

{ return false;} //If true then CIccTag can be cast as a CIccTagNumArray

Referenced by CIccArrayNamedColor::FindDeviceColor(), CIccArrayNamedColor::FindPcsColor(), CIccArrayNamedColor::FindSpectralColor(), CIccTagStruct::GetElemNumberValue(), CIccStructNamedColor::GetNumArray(), CIccMpeXmlTintArray::ParseXml(), and CIccMpeTintArray::Read().

Here is the caller graph for this function:

IsSupported()

virtual bool CIccTag::IsSupported ( )

inlinevirtualinherited

Function: IsSupported(size, pIO) - Check if tag fully supported for apply purposes. By Default inherited classes are supported. Unknown tag types are not supported.

Returns true if tag type is supported.

Reimplemented in CIccTagUnknown, CIccTagEmbeddedProfile, and CIccTagMultiProcessElement.

{ return true; }

NewCopy()

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

{return new CIccTagXmlText(*this);}

References CIccTagXmlText().

Here is the call graph for this function:

ParseXml()

bool CIccTagXmlText::ParseXml ( xmlNode *  pNode, std::string &  parseStr  )

virtual

Implements CIccTagXml.

{
  std::string str = icXmlParseTextString(pNode, parseStr);
 
  if (!str.empty()){    
    SetText(str.c_str());
    return true;
  }
  return false;
}

References icXmlParseTextString(), and CIccTagText::SetText().

Here is the call graph for this function:

Read() [1/2]

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

virtualinherited

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.

{
  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 CIccTagText::GetBuffer(), CIccTag::m_nReserved, CIccTagText::m_szText, CIccIO::Read32(), CIccIO::Read8(), and CIccTagText::Release().

Here is the call graph for this function:

Read() [2/2]

virtual bool CIccTag::Read ( icUInt32Number  size, CIccIO *  pIO, CIccProfile *  pProfile  )

inlinevirtualinherited

Function: Read(size, pIO) - Read tag from file. Each derived tag will implement it's own Read() function.

Parameter(s): size - number of bytes in tag including the type signature. pIO - IO object used to read in tag. The IO object should already be initialized to point to the begining of the tag.

Returns true if Read is successful.

Reimplemented in CIccTagEmbeddedProfile.

{ return Read(size, pIO); }

References CIccTag::Read().

Here is the call graph for this function:

ReadAll()

virtual bool CIccTag::ReadAll ( )

inlinevirtualinherited

Function: ReadAll() - Read All sub data for tag from file. Called by CIccProfile::ReadAll() to read all sub data for tag

Returns true if ReadAll is successful.

Reimplemented in CIccTagEmbeddedProfile.

{ return true; }

Release()

void CIccTagText::Release ( )

inherited

Name: CIccTagText::Release

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

{
  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(), CIccTagText::m_nBufSize, and CIccTagText::m_szText.

Referenced by CIccTagText::Read(), and CIccTagText::SetText().

Here is the call graph for this function:

Here is the caller graph for this function:

SetText()

void CIccTagText::SetText ( const icChar *  szText )

inherited

Name: CIccTagText::SetText

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

Args: szText - zero terminated string to put in tag

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

References CIccTagText::GetBuffer(), CIccTagText::Release(), and CIccTagText::SetText().

Referenced by CIccTagText::CIccTagText(), CIccTagText::operator=(), CIccTagText::operator=(), ParseXml(), and CIccTagText::SetText().

Here is the call graph for this function:

Here is the caller graph for this function:

ToXml()

bool CIccTagXmlText::ToXml ( std::string &  xml, std::string  blanks = ""  )

virtual

Implements CIccTagXml.

{
  return icXmlDumpTextData(xml, blanks, m_szText);
}

References icXmlDumpTextData(), and CIccTagText::m_szText.

Here is the call graph for this function:

Validate()

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

virtualinherited

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.

{
  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, CIccTagText::m_nBufSize, CIccTagText::m_szText, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagText::Write ( CIccIO *  pIO )

virtualinherited

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.

{
  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 CIccTagText::GetType(), CIccTag::m_nReserved, CIccTagText::m_szText, CIccIO::Write32(), and CIccIO::Write8().

Here is the call graph for this function:

Field Documentation

m_nBufSize

icUInt32Number CIccTagText::m_nBufSize

protectedinherited

Referenced by CIccTagText::CIccTagText(), CIccTagText::CIccTagText(), CIccTagText::Capacity(), CIccTagText::GetBuffer(), CIccTagText::operator=(), CIccTagText::Release(), and CIccTagText::Validate().

m_nReserved

icUInt32Number CIccTag::m_nReserved

inherited

Referenced by CIccTag::CIccTag(), CIccTagMultiProcessElement::CIccTagMultiProcessElement(), CIccTagMultiProcessElement::CIccTagMultiProcessElement(), CIccTagMultiProcessElement::operator=(), CIccProfileXml::ParseTag(), CIccTagXmlStruct::ParseTag(), CIccMpeXmlTintArray::ParseXml(), CIccTagXmlArray::ParseXml(), CIccTagText::Read(), CIccTagUtf8Text::Read(), CIccTagZipUtf8Text::Read(), CIccTagUtf16Text::Read(), CIccTagTextDescription::Read(), CIccTagSignature::Read(), CIccTagNamedColor2::Read(), CIccTagXYZ::Read(), CIccTagChromaticity::Read(), CIccTagCicp::Read(), CIccTagSparseMatrixArray::Read(), CIccTagFixedNum< T, Tsig >::Read(), CIccTagNum< T, Tsig >::Read(), CIccTagFloatNum< T, Tsig >::Read(), CIccTagMeasurement::Read(), CIccTagMultiLocalizedUnicode::Read(), CIccTagData::Read(), CIccTagDateTime::Read(), CIccTagColorantOrder::Read(), CIccTagColorantTable::Read(), CIccTagViewingConditions::Read(), CIccTagProfileSeqDesc::Read(), CIccTagResponseCurveSet16::Read(), CIccTagSpectralDataInfo::Read(), CIccTagSpectralViewingConditions::Read(), CIccTagEmbeddedHeightImage::Read(), CIccTagEmbeddedNormalImage::Read(), CIccTagStruct::Read(), CIccTagArray::Read(), CIccTagDict::Read(), CIccTagCurve::Read(), CIccTagParametricCurve::Read(), CIccTagLutAtoB::Read(), CIccTagLut8::Read(), CIccTagLut16::Read(), CIccTagGamutBoundaryDesc::Read(), CIccTagMultiProcessElement::Read(), CIccTagProfileSequenceId::Read(), CIccTagEmbeddedProfile::Read(), CIccTag::Validate(), CIccTagText::Write(), CIccTagUtf8Text::Write(), CIccTagZipUtf8Text::Write(), CIccTagUtf16Text::Write(), CIccTagTextDescription::Write(), CIccTagSignature::Write(), CIccTagNamedColor2::Write(), CIccTagXYZ::Write(), CIccTagChromaticity::Write(), CIccTagCicp::Write(), CIccTagSparseMatrixArray::Write(), CIccTagFixedNum< T, Tsig >::Write(), CIccTagNum< T, Tsig >::Write(), CIccTagFloatNum< T, Tsig >::Write(), CIccTagMeasurement::Write(), CIccTagMultiLocalizedUnicode::Write(), CIccTagData::Write(), CIccTagDateTime::Write(), CIccTagColorantOrder::Write(), CIccTagColorantTable::Write(), CIccTagViewingConditions::Write(), CIccTagProfileSeqDesc::Write(), CIccTagResponseCurveSet16::Write(), CIccTagSpectralDataInfo::Write(), CIccTagSpectralViewingConditions::Write(), CIccTagEmbeddedHeightImage::Write(), CIccTagEmbeddedNormalImage::Write(), CIccTagStruct::Write(), CIccTagArray::Write(), CIccTagDict::Write(), CIccTagEmbeddedProfile::Write(), CIccTagCurve::Write(), CIccTagParametricCurve::Write(), CIccTagLutAtoB::Write(), CIccTagLut8::Write(), CIccTagLut16::Write(), CIccTagGamutBoundaryDesc::Write(), CIccTagMultiProcessElement::Write(), and CIccTagProfileSequenceId::Write().

m_szText

icChar* CIccTagText::m_szText

protectedinherited

Referenced by CIccTagText::CIccTagText(), CIccTagText::CIccTagText(), CIccTagText::~CIccTagText(), CIccTagText::Describe(), CIccTagText::GetBuffer(), CIccTagText::GetText(), CIccTagText::operator=(), CIccTagText::operator=(), CIccTagText::Read(), CIccTagText::Release(), ToXml(), CIccTagText::Validate(), and CIccTagText::Write().

---

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

• IccXML/IccLibXML/IccTagXml.h
• IccXML/IccLibXML/IccTagXml.cpp