QCString Class Reference

#include <qcstring.h>

Classes
struct	LongStringRep
struct	LSData
struct	LSHeader
struct	ShortStringRep
class	StringRep

Public Member Functions
	QCString ()
	~QCString ()
	QCString (const QCString &s)
	QCString (int size)
	QCString (const char *str)
	QCString (const char *str, uint maxlen)
QCString &	operator= (const QCString &s)
QCString &	operator= (const char *str)
bool	isNull () const
bool	isEmpty () const
uint	length () const
uint	size () const
const char *	data () const
char *	rawData () const
bool	resize (uint newlen)
bool	truncate (uint pos)
bool	fill (char c, int len=-1)
QCString	copy () const
QCString &	sprintf (const char *format,...)
int	find (char c, int index=0, bool cs=TRUE) const
int	find (const char *str, int index=0, bool cs=TRUE) const
int	find (const QCString &str, int index=0, bool cs=TRUE) const
int	find (const QRegExp &rx, int index=0) const
int	findRev (char c, int index=-1, bool cs=TRUE) const
int	findRev (const char *str, int index=-1, bool cs=TRUE) const
int	findRev (const QRegExp &rx, int index=-1) const
int	contains (char c, bool cs=TRUE) const
int	contains (const char *str, bool cs=TRUE) const
int	contains (const QRegExp &rx) const
bool	stripPrefix (const char *prefix)
QCString	left (uint len) const
QCString	right (uint len) const
QCString	mid (uint index, uint len=0xffffffff) const
QCString	lower () const
QCString	upper () const
QCString	stripWhiteSpace () const
QCString	simplifyWhiteSpace () const
QCString &	assign (const char *str)
QCString &	insert (uint index, const char *s)
QCString &	insert (uint index, char c)
QCString &	append (const char *s)
QCString &	prepend (const char *s)
QCString &	remove (uint index, uint len)
QCString &	replace (uint index, uint len, const char *s)
QCString &	replace (const QRegExp &rx, const char *str)
short	toShort (bool *ok=0) const
ushort	toUShort (bool *ok=0) const
int	toInt (bool *ok=0) const
uint	toUInt (bool *ok=0) const
long	toLong (bool *ok=0) const
ulong	toULong (bool *ok=0) const
uint64	toUInt64 (bool *ok=0) const
QCString &	setNum (short n)
QCString &	setNum (ushort n)
QCString &	setNum (int n)
QCString &	setNum (uint n)
QCString &	setNum (long n)
QCString &	setNum (ulong n)
	operator const char * () const
QCString &	operator+= (const char *str)
QCString &	operator+= (char c)
char &	at (uint i) const
char &	operator[] (int i) const

Private Attributes
StringRep	m_rep

Detailed Description

This is an alternative implementation of QCString. It provides basically the same functions but uses reference counting and copy on write.

Definition at line 131 of file qcstring.h.

Constructor & Destructor Documentation

QCString::QCString ( )

inline

creates an empty string

Definition at line 135 of file qcstring.h.

               : m_rep()
    {
    }

QCString::~QCString ( )

inline

destroys the string

Definition at line 140 of file qcstring.h.

    {
    }

QCString::QCString ( const QCString &  s )

inline

makes a copy of a string.

Definition at line 145 of file qcstring.h.

                                  : m_rep(s.m_rep)
    {
    }

QCString::QCString ( int  size )

inlineexplicit

creates a string with room for size characters

Parameters

[in]

size

the number of character to allocate (including the 0-terminator)

Definition at line 152 of file qcstring.h.

                                  : m_rep(size)
    {
    }

QCString::QCString ( const char *  str )

inline

creates a string from a plain C string.

Parameters

[in]

str

A zero terminated C string. When 0 an empty string is created.

Definition at line 159 of file qcstring.h.

                                : m_rep(str)
    {
    }

QCString::QCString ( const char *  str, uint  maxlen  )

inline

creates a string from str and copies over the first maxlen characters.

Definition at line 164 of file qcstring.h.

                                             : m_rep(str,maxlen)
    {
    }

Member Function Documentation

QCString & QCString::append

(

const char *

s

)

Definition at line 383 of file qcstring.cpp.

{
  return operator+=(s);
}

QCString & QCString::assign

(

const char *

str

)

Definition at line 350 of file qcstring.cpp.

{
  return operator=(str);
}

char& QCString::at ( uint  i ) const

inline

Returns a reference to the character at index i.

Definition at line 326 of file qcstring.h.

    {
      return m_rep.at(i);
    }

int QCString::contains	(	char	c,
		bool	cs = TRUE
	)		const

Definition at line 153 of file qcstring.cpp.

{
  if (length()==0) return 0;
  int count=0;
  const char *pos = data();
  if (cs)
  {
    while (*pos) if (*pos++ == c) count++;
  }
  else
  {
    c = tolower((unsigned char)c);
    while (*pos)
    {
      if (tolower((unsigned char)*pos)==c) count++;
      pos++;
    }
  }
  return count;
}

int QCString::contains	(	const char *	str,
		bool	cs = TRUE
	)		const

Definition at line 174 of file qcstring.cpp.

{
  if (str==0 || length()==0) return 0;
  int count=0;
  const char *pos = data();
  int len = qstrlen(str);
  while (*pos)
  {
    if (cs)
    {
      if (qstrncmp(pos,str,len)==0) count++;
    }
    else
    {
      if (qstrnicmp(pos,str,len)==0) count++;
    }
    pos++;
  }
  return count;
}

int QCString::contains

(

const QRegExp &

rx

)

const

Definition at line 195 of file qcstring.cpp.

{
  QString d = QString::fromLatin1( data() );
  return d.contains( rx );
}

QCString QCString::copy ( ) const

inline

Returns a deep copy of the string.

Definition at line 250 of file qcstring.h.

    {
      if (length()==0) return QCString();
      QCString cs(length()+1);
      memcpy(cs.rawData(),data(),length());
      return cs;
    }

const char* QCString::data ( ) const

inline

Returns a pointer to the contents of the string in the form of a 0-terminated C string

Definition at line 207 of file qcstring.h.

    {
      return m_rep.data();
    }

bool QCString::fill ( char  c, int  len = -1  )

inline

Fills a string with a predefined character

Parameters

[in]	c	the character used to fill the string with.
[in]	len	the number of character to fill. Use -1 to fill the whole string.

Note

the string will be resized to contain len characters. The contents of the string will be lost.

Definition at line 243 of file qcstring.h.

    {
      m_rep.fill(c,len);
      return TRUE;
    }

int QCString::find	(	char	c,
		int	index = 0,
		bool	cs = TRUE
	)		const

Definition at line 41 of file qcstring.cpp.

{
  if (index<0 || index>=(int)length()) return -1; // index outside string
  register const char *pos;
  if (cs)
  {
    pos = strchr(data()+index,c);
  }
  else
  {
    pos = data()+index;
    c = tolower((unsigned char)c);
    while (*pos && tolower((unsigned char)*pos)!=c) pos++;
    if (!*pos && c) pos=0; // not found
  }
  return pos ? (int)(pos - data()) : -1;
}

int QCString::find	(	const char *	str,
		int	index = 0,
		bool	cs = TRUE
	)		const

Definition at line 59 of file qcstring.cpp.

{
  int l = length();
  if (index<0 || index>=l) return -1; // index outside string
  if (!str)  return -1;               // no string to search for
  if (!*str) return index;           // empty string matching at index
  register const char *pos;
  if (cs) // case sensitive
  {
    pos = strstr(data()+index,str);
  }
  else // case insensitive
  {
    pos = data();
    int len = qstrlen(str);
    while (*pos)
    {
      if (qstrnicmp(pos,str,len)==0) break;
      pos++;
    }
    if (!*pos) pos = 0; // not found
  }
  return pos ? (int)(pos - data()) : -1;
}

int QCString::find	(	const QCString &	str,
		int	index = 0,
		bool	cs = TRUE
	)		const

Definition at line 84 of file qcstring.cpp.

{
  return find(str.data(),index,cs);
}

int QCString::find	(	const QRegExp &	rx,
		int	index = 0
	)		const

Definition at line 89 of file qcstring.cpp.

{
  QString d = QString::fromLatin1( data() );
  return d.find( rx, index );
}

int QCString::findRev	(	char	c,
		int	index = -1,
		bool	cs = TRUE
	)		const

Definition at line 95 of file qcstring.cpp.

{
  const char *b = data();
  const char *pos;
  int len = length();
  if (len==0) return -1; // empty string
  if (index<0) // start from end
  {
    if (cs)
    {
      pos = strrchr(b,c);
      return pos ? (int)(pos - b) : -1;
    }
    index=len;
  }
  else if (index>len) // bad index
  {
    return -1;
  }
  pos = b+index;
  if (cs)
  {
    while ( pos>=b && *pos!=c) pos--;
  }
  else
  {
    c = tolower((unsigned char)c);
    while ( pos>=b && tolower((unsigned char)*pos)!=c) pos--;
  }
  return pos>=b ? (int)(pos - b) : -1;
}

int QCString::findRev	(	const char *	str,
		int	index = -1,
		bool	cs = TRUE
	)		const

Definition at line 127 of file qcstring.cpp.

{
  int slen = qstrlen(str);
  int len = length();
  if (index<0) index = len-slen; // start from end
  else if (index>len) return -1; // bad index
  else if (index+slen>len) index=len-slen; // str would be too long
  if (index<0) return -1; // no match possible
  register const char *pos = data()+index;
  if (cs) // case sensitive
  {
    for (int i=index; i>=0; i--) if (qstrncmp(pos--,str,slen)==0) return i;
  }
  else // case insensitive
  {
    for (int i=index; i>=0; i--) if (qstrnicmp(pos,str,slen)==0) return i;
  }
  return -1;
}

int QCString::findRev	(	const QRegExp &	rx,
		int	index = -1
	)		const

Definition at line 147 of file qcstring.cpp.

{
  QString d = QString::fromLatin1( data() );
  return d.findRev( rx, index );
}

QCString & QCString::insert	(	uint	index,
		const char *	s
	)

Definition at line 355 of file qcstring.cpp.

{
  int len = s ? qstrlen(s) : 0;
  if ( len == 0 ) return *this;
  int olen = length();
  int nlen = olen + len;
  if ((int)index>=olen)
  {
    resize(nlen+index-olen+1);
    memset(rawData()+olen, ' ', index-olen);
    memcpy(rawData()+index,s, len+1);
  }
  else
  {
    resize(nlen+1);
    qmemmove(rawData()+index+len,data()+index,olen-index+1);
    memcpy(rawData()+index,s,len);
  }
  return *this;
}

QCString & QCString::insert	(	uint	index,
		char	c
	)

Definition at line 376 of file qcstring.cpp.

{
  char buf[2];
  buf[0] = c;
  buf[1] = '\0';
  return insert( index, buf );
}

bool QCString::isEmpty ( ) const

inline

Returns TRUE iff the string is empty

Definition at line 189 of file qcstring.h.

    {
      return m_rep.isEmpty();
    }

bool QCString::isNull ( ) const

inline

Returns TRUE iff the string is empty. Equivalent to isEmpty().

Definition at line 183 of file qcstring.h.

    {
      return m_rep.isEmpty();
    }

QCString QCString::left

(

uint

len

)

const

Definition at line 213 of file qcstring.cpp.

{
  if (isEmpty())
  {
    return QCString();
  }
  else if (len>=length())
  {
    return QCString(data());
  }
  else
  {
    QCString s( len+1 );
    memcpy( s.rawData(), data(), len);
    return s;
  }
}

uint QCString::length ( ) const

inline

Returns the length of the string, excluding the 0-terminator. Equivalent to size().

Definition at line 195 of file qcstring.h.

    {
      return m_rep.length();
    }

QCString QCString::lower

(

)

const

Definition at line 263 of file qcstring.cpp.

{
  if (length()==0) return QCString();
  QCString s(data());
  register char *pos = s.rawData();
  if (pos)
  {
    while (*pos)
    {
      *pos = tolower((unsigned char)*pos);
      pos++;
    }
  }
  return s;
}

QCString QCString::mid	(	uint	index,
		uint	len = 0xffffffff
	)		const

Definition at line 246 of file qcstring.cpp.

{
  uint slen = (uint)length();
  if (len==0xffffffff) len = slen-index;
  if (isEmpty() || index>=slen || len==0)
  {
    return QCString();
  }
  else
  {
    register const char *p = data()+index;
    QCString s(len+1);
    qstrncpy( s.rawData(), p, len+1 );
    return s;
  }
}

QCString::operator const char * ( ) const

inline

Converts the string to a plain C string

Definition at line 300 of file qcstring.h.

    {
      return (const char *)data();
    }

QCString& QCString::operator+= ( const char *  str )

inline

Appends string str to this string and returns a reference to the result.

Definition at line 306 of file qcstring.h.

    {
      if (!str) return *this;
      int len1 = length();
      int len2 = (int)strlen(str);
      resize(len1+len2+1);
      memcpy(rawData()+len1,str,len2);
      return *this;
    }

QCString& QCString::operator+= ( char  c )

inline

Appends character c to this string and returns a reference to the result.

Definition at line 317 of file qcstring.h.

    {
      int len = length();
      resize(len+2);
      rawData()[len]=c;
      return *this;
    }

QCString& QCString::operator= ( const QCString &  s )

inline

replaces the contents by that of string s.

Definition at line 169 of file qcstring.h.

    {
      m_rep = s.m_rep;
      return *this;
    }

QCString& QCString::operator= ( const char *  str )

inline

replaces the contents by that of C string str.

Definition at line 176 of file qcstring.h.

    {
      m_rep = str;
      return *this;
    }

char& QCString::operator[] ( int  i ) const

inline

Indexing operator. Equavalent to at().

Definition at line 332 of file qcstring.h.

    {
      return m_rep.at((uint)i);
    }

QCString & QCString::prepend

(

const char *

s

)

Definition at line 387 of file qcstring.cpp.

{
  return insert(0,s);
}

char* QCString::rawData ( ) const

inline

Returns a writable pointer to the data.

Warning

if the string is shared it will modifying the string directly and this will overwrite all copies as well!

Definition at line 216 of file qcstring.h.

    {
      return m_rep.rawData();
    }

QCString & QCString::remove	(	uint	index,
		uint	len
	)

Definition at line 391 of file qcstring.cpp.

{
  uint olen = length();
  if ( index + len >= olen ) // range problems
  {
    if ( index < olen )  // index ok
    {
      resize( index+1 );
    }
  }
  else if ( len != 0 )
  {
    QCString tmp(olen-index-len+1);
    qmemmove( tmp.rawData(), data()+index+len, olen-index-len+1 );
    resize( olen-len+1 );
    memcpy( rawData()+index,tmp.data(),tmp.length() );
  }
  return *this;
}

QCString & QCString::replace	(	uint	index,
		uint	len,
		const char *	s
	)

Definition at line 411 of file qcstring.cpp.

{
  remove( index, len );
  insert( index, s );
  return *this;
}

QCString & QCString::replace	(	const QRegExp &	rx,
		const char *	str
	)

Definition at line 418 of file qcstring.cpp.

{
  QString d = QString::fromLatin1( data() );
  QString r = QString::fromLatin1( str );
  d.replace( rx, r );
  operator=( d.ascii() );
  return *this;
}

bool QCString::resize ( uint  newlen )

inline

Resizes the string to hold newlen characters (this value should include the 0-terminator). If the string is enlarged the contents will be left unmodified.

Definition at line 225 of file qcstring.h.

    {
      m_rep.resize(newlen);
      return TRUE;
    }

QCString QCString::right

(

uint

len

)

const

Definition at line 231 of file qcstring.cpp.

{
  if (isEmpty())
  {
    return QCString();
  }
  else
  {
    int l = length();
    if ((int)len>l) len=l;
    const char *pos = data() + (l-len);
    return QCString(pos);
  }
}

QCString & QCString::setNum

(

short

n

)

Definition at line 469 of file qcstring.cpp.

{
  return setNum((long)n);
}

QCString & QCString::setNum

(

ushort

n

)

Definition at line 474 of file qcstring.cpp.

{
  return setNum((ulong)n);
}

QCString & QCString::setNum

(

int

n

)

Definition at line 479 of file qcstring.cpp.

{
  return setNum((long)n);
}

QCString & QCString::setNum

(

uint

n

)

Definition at line 484 of file qcstring.cpp.

{
  return setNum((ulong)n);
}

QCString & QCString::setNum

(

long

n

)

Definition at line 489 of file qcstring.cpp.

{
  char buf[20];
  register char *p = &buf[19];
  bool neg;
  if ( n < 0 )
  {
    neg = TRUE;
    n = -n;
  }
  else
  {
    neg = FALSE;
  }
  *p = '\0';
  do
  {
    *--p = ((int)(n%10)) + '0';
    n /= 10;
  } while ( n );
  if ( neg ) *--p = '-';
  operator=( p );
  return *this;
}

QCString & QCString::setNum

(

ulong

n

)

Definition at line 514 of file qcstring.cpp.

{
  char buf[20];
  register char *p = &buf[19];
  *p = '\0';
  do
  {
    *--p = ((int)(n%10)) + '0';
    n /= 10;
  } while ( n );
  operator=( p );
  return *this;
}

QCString QCString::simplifyWhiteSpace

(

)

const

Definition at line 323 of file qcstring.cpp.

{
  if ( isEmpty() )                            // nothing to do
    return *this;

  QCString result( length()+1 );
  const char *from  = data();
  char *to    = result.rawData();
  char *first = to;
  while ( TRUE )
  {
    while ( *from && isspace((uchar) *from) )
      from++;
    while ( *from && !isspace((uchar)*from) )
      *to++ = *from++;
    if ( *from )
      *to++ = 0x20;                       // ' '
    else
      break;
  }
  if ( to > first && *(to-1) == 0x20 )
    to--;
  *to = '\0';
  result.resize( (int)((long)to - (long)result.data()) + 1 );
  return result;
}

uint QCString::size ( ) const

inline

Returns the length of the string, excluding the 0-terminator.

Definition at line 201 of file qcstring.h.

    {
      return m_rep.length();
    }

QCString & QCString::sprintf	(	const char *	format,
			...
	)

Definition at line 27 of file qcstring.cpp.

{
  va_list ap;
  va_start( ap, format );
  const int minlen=256;
  int l = length();
  if (l<minlen) { resize(minlen); l=minlen; }
  int n=vsnprintf( rawData(), l, format, ap);
  if (n<0) n=l;
  resize(n+1);
  va_end( ap );
  return *this;
}

bool QCString::stripPrefix

(

const char *

prefix

)

Definition at line 201 of file qcstring.cpp.

{
  if (prefix==0 || length()==0) return FALSE;
  int len = qstrlen(prefix);
  if (qstrncmp(prefix,data(),len)==0)
  {
    m_rep=mid(len,length()-len).m_rep; // need to make a deep copy
    return TRUE;
  }
  return FALSE;
}

QCString QCString::stripWhiteSpace

(

)

const

Definition at line 295 of file qcstring.cpp.

{
  if ( isEmpty() )                            // nothing to do
    return *this;

  register const char *cs = data();
  int reslen = length();
  if ( !isspace((uchar)cs[0]) && !isspace((uchar)cs[reslen-1]) )
    return *this;                             // returns a copy

  QCString result(cs);
  register char *s = result.rawData();
  int start = 0;
  int end = reslen - 1;
  while ( isspace((uchar) s[start]) )                 // skip white space from start
    start++;
  if ( s[start] == '\0' )
  {                                                   // only white space
    return QCString();
  }
  while ( end && isspace((uchar) s[end]) )            // skip white space from end
    end--;
  end -= start - 1;
  qmemmove( s, &s[start], end );
  result.resize( end + 1 );
  return result;
}

int QCString::toInt

(

bool *

ok = 0

)

const

Definition at line 439 of file qcstring.cpp.

{
  QString s(data());
  return s.toInt(ok);
}

long QCString::toLong

(

bool *

ok = 0

)

const

Definition at line 451 of file qcstring.cpp.

{
  QString s(data());
  return s.toLong(ok);
}

short QCString::toShort

(

bool *

ok = 0

)

const

Definition at line 427 of file qcstring.cpp.

{
  QString s(data());
  return s.toShort(ok);
}

uint QCString::toUInt

(

bool *

ok = 0

)

const

Definition at line 445 of file qcstring.cpp.

{
  QString s(data());
  return s.toUInt(ok);
}

uint64 QCString::toUInt64

(

bool *

ok = 0

)

const

Definition at line 463 of file qcstring.cpp.

{
  QString s(data());
  return s.toUInt64(ok);
}

ulong QCString::toULong

(

bool *

ok = 0

)

const

Definition at line 457 of file qcstring.cpp.

{
  QString s(data());
  return s.toULong(ok);
}

ushort QCString::toUShort

(

bool *

ok = 0

)

const

Definition at line 433 of file qcstring.cpp.

{
  QString s(data());
  return s.toUShort(ok);
}

bool QCString::truncate ( uint  pos )

inline

Truncates the string at position pos.

Definition at line 232 of file qcstring.h.

    {
      return resize(pos+1);
    }

QCString QCString::upper

(

)

const

Definition at line 279 of file qcstring.cpp.

{
  if (length()==0) return QCString();
  QCString s(data());
  register char *pos = s.rawData();
  if (pos)
  {
    while (*pos)
    {
      *pos = toupper((unsigned char)*pos);
      pos++;
    }
  }
  return s;
}

Member Data Documentation

StringRep QCString::m_rep

private

Definition at line 695 of file qcstring.h.

---

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

• doxygen-1.8.11/qtools/qcstring.h
• doxygen-1.8.11/qtools/qcstring.cpp