StrView Class Reference

A simple wrapper to provide string functions on existing allocated char*. If the underlying char* is a const we do not allow any updates; The ownership of the char* must be managed externally! More...

#include <StrView.h>

Inheritance diagram for StrView:

Public Member Functions
	StrView ()=default
	StrView (char chars[], int maxlen, int len=0)
	Creates a Str with the indicated buffer.
	StrView (const char *chars)
	Creates a Str for string constant.
virtual void	add (const char *append)
	adds a string
virtual void	add (const char c)
	adds a character
virtual void	add (double value, int precision=2, int withd=0)
	adds a double value
virtual void	add (int value)
	adds a int value
virtual const char *	c_str ()
	provides the string value as const char*
virtual void	clear ()
	clears the string by setting the terminating 0 at the beginning
virtual bool	contains (const char *str)
	checks if the string contains a substring
bool	containsNumber ()
virtual int	count (char c, int startPos)
	count number of indicated characters as position
virtual bool	endsWith (const char *str)
	checks if the string ends with the indicated substring
virtual bool	endsWithIgnoreCase (const char *str)
	checks if the string ends with the indicated substring
virtual bool	equals (const char *str)
	checks if the string equals indicated parameter string
virtual bool	equalsIgnoreCase (const char *alt)
	Compares the string ignoring the case.
virtual int	indexOf (const char *cont, int start=0)
virtual int	indexOf (const char c, int start=0)
virtual void	insert (int pos, const char *str)
	inserts a substring into the string
virtual bool	isConst ()
	checks if the string is a constant that must not be changed
virtual bool	isEmpty ()
	checks if the string is empty
bool	isInteger ()
	Returns true if the string is an integer.
bool	isNumber ()
virtual bool	isOnHeap ()
	checks if the string is on the heap
virtual int	lastIndexOf (const char *cont)
	provides the position of the last occurrence of the indicated substring
virtual int	length ()
virtual void	ltrim ()
	remove leading spaces
virtual bool	matches (const char *pattern)
virtual int	maxLength ()
	provides the maximum length of the string
virtual int	nIndexOf (const char *cont, int n)
	searches for the nth occurence of the indicated character
virtual int	nIndexOf (const char c, int n)
	searches for the nth occurence of the indicated character
int	numberOfDecimals ()
	Determines the number of decimals in the number string.
virtual bool	operator!= (const char *alt) const
	checks if the indicated string is different from the current string
virtual bool	operator!= (const StrView &alt) const
	checks if the indicated string is different from the current string
virtual void	operator+= (const char *str)
	adds a substring at the end of the string
virtual void	operator+= (const char value)
	adds a character
virtual void	operator+= (double value)
	adds a double at the end of the string
virtual void	operator+= (int value)
	adds a int at the end of the string
virtual void	operator<< (int n)
	shift characters to the right -> we just move the pointer
virtual void	operator= (char *str)
	we can assign a char*
virtual void	operator= (char c)
	we can assign a char
virtual void	operator= (const char *str)
	we can assign a const char*
virtual void	operator= (double val)
	we can assign a double
virtual void	operator= (int value)
	we can assign an int
virtual bool	operator== (const char *alt) const
	checks if the indicated string is equal to the current string
virtual bool	operator== (const StrView &alt) const
	checks if the indicated string is equal to the current string
virtual char	operator[] (int index)
virtual void	remove (const char *toRemove)
	removes the indicated substring from the string
virtual void	removeAll (const char *toRemove)
	removes the indicated substring from the string
virtual bool	replace (const char *toReplace, const char *replaced)
	Replaces the first instance of toReplace with replaced.
virtual bool	replaceAll (const char *toReplace, const char *replaced)
	Replaces all instances of toReplace with replaced.
virtual void	rtrim ()
	remove trailing spaces
virtual void	set (char chars[], int maxlen, int len=0, bool isConst=false)
	assigns a memory buffer
virtual void	set (const char *alt)
	assigs a value
virtual void	set (const char c)
virtual void	set (const StrView &alt)
	assigs from another Str value
virtual void	set (double value, int precision=2, int withd=0)
virtual void	set (int value)
virtual void	setLength (int len, bool addZero=true)
	limits the length of the string (by adding a delimiting 0)
virtual void	setLengthUndo ()
	undo the last setLength call
virtual bool	startsWith (const char *str)
	checks if the string starts with the indicated substring
virtual void	substring (const char *from, int start, int end)
	copies a substring into the current string
virtual void	substring (StrView &from, int start, int end)
	copies a substring into the current string
virtual void	swap (StrView &str)
double	toDouble ()
	Converts the string to a double.
float	toFloat ()
	Converts the string to a float.
int	toInt ()
	Converts the string to an int.
long	toLong ()
	Converts the string to an long.
void	toLowerCase ()
	Converts the string to lowercase letters.
void	toUpperCase ()
	Converts the string to uppercase letters.
virtual void	trim ()
	remove leading and traling spaces

Static Public Member Functions
static const char *	toBinary (void const *const ptr, size_t const size)
	provides a binary string represntation

Protected Member Functions
virtual bool	grow (int newMaxLen)
	only supported in subclasses

Static Protected Member Functions
static char *	floatToString (char *outstr, double val, int precision, int widthp)
static char *	itoa (int n, char s[])
static void	reverse (char s[])
static int	strncmp_i (const char *s1, const char *s2, int n)

Protected Attributes
char *	chars = nullptr
bool	is_const = false
int	len = 0
int	maxlen = 0
char	savedChar
int	savedLen = -1

Detailed Description

A simple wrapper to provide string functions on existing allocated char*. If the underlying char* is a const we do not allow any updates; The ownership of the char* must be managed externally!

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

StrView() [1/3]

StrView ( )

default

StrView() [2/3]

StrView ( const char *  chars )

inline

Creates a Str for string constant.

StrView() [3/3]

StrView ( char  chars[], int  maxlen, int  len = 0  )

inline

Creates a Str with the indicated buffer.

Member Function Documentation

add() [1/4]

virtual void add ( const char *  append )

inlinevirtual

adds a string

add() [2/4]

virtual void add ( const char  c )

inlinevirtual

adds a character

add() [3/4]

virtual void add ( double  value, int  precision = 2, int  withd = 0  )

inlinevirtual

adds a double value

add() [4/4]

virtual void add ( int  value )

inlinevirtual

adds a int value

c_str()

virtual const char * c_str ( )

inlinevirtual

provides the string value as const char*

clear()

virtual void clear ( )

inlinevirtual

clears the string by setting the terminating 0 at the beginning

Reimplemented in Str.

contains()

virtual bool contains ( const char *  str )

inlinevirtual

checks if the string contains a substring

containsNumber()

bool containsNumber ( )

inline

count()

virtual int count ( char  c, int  startPos  )

inlinevirtual

count number of indicated characters as position

endsWith()

virtual bool endsWith ( const char *  str )

inlinevirtual

checks if the string ends with the indicated substring

endsWithIgnoreCase()

virtual bool endsWithIgnoreCase ( const char *  str )

inlinevirtual

checks if the string ends with the indicated substring

equals()

virtual bool equals ( const char *  str )

inlinevirtual

checks if the string equals indicated parameter string

equalsIgnoreCase()

virtual bool equalsIgnoreCase ( const char *  alt )

inlinevirtual

Compares the string ignoring the case.

floatToString()

static char * floatToString ( char *  outstr, double  val, int  precision, int  widthp  )

inlinestaticprotected

compute the rounding factor and fractional multiplier

print the decimal point

generate space padding

grow()

virtual bool grow ( int  newMaxLen )

inlineprotectedvirtual

only supported in subclasses

Reimplemented in Str.

indexOf() [1/2]

virtual int indexOf ( const char *  cont, int  start = 0  )

inlinevirtual

provides the position of the the indicated substring after the indicated start position

indexOf() [2/2]

virtual int indexOf ( const char  c, int  start = 0  )

inlinevirtual

provides the position of the the indicated character after the indicated start position

insert()

virtual void insert ( int  pos, const char *  str  )

inlinevirtual

inserts a substring into the string

isConst()

virtual bool isConst ( )

inlinevirtual

checks if the string is a constant that must not be changed

Reimplemented in Str.

isEmpty()

virtual bool isEmpty ( )

inlinevirtual

checks if the string is empty

isInteger()

bool isInteger ( )

inline

Returns true if the string is an integer.

isNumber()

bool isNumber ( )

inline

isOnHeap()

virtual bool isOnHeap ( )

inlinevirtual

checks if the string is on the heap

Reimplemented in Str.

itoa()

static char * itoa ( int  n, char  s[]  )

inlinestaticprotected

lastIndexOf()

virtual int lastIndexOf ( const char *  cont )

inlinevirtual

provides the position of the last occurrence of the indicated substring

length()

virtual int length ( )

inlinevirtual

provides the current length (filled with characters) of the string - excluding the terminating 0

ltrim()

virtual void ltrim ( )

inlinevirtual

remove leading spaces

matches()

virtual bool matches ( const char *  pattern )

inlinevirtual

file matching supporting * and ? - replacing regex which is not supported in all environments

returns 1 (true) if there is a match returns 0 if the pattern is not whitin the line

the line is ended but char was expected

end of mask

if the line also ends here then the pattern match

try to restart the mask on the rest

maxLength()

virtual int maxLength ( )

inlinevirtual

provides the maximum length of the string

nIndexOf() [1/2]

virtual int nIndexOf ( const char *  cont, int  n  )

inlinevirtual

searches for the nth occurence of the indicated character

nIndexOf() [2/2]

virtual int nIndexOf ( const char  c, int  n  )

inlinevirtual

searches for the nth occurence of the indicated character

numberOfDecimals()

int numberOfDecimals ( )

inline

Determines the number of decimals in the number string.

operator!=() [1/2]

virtual bool operator!= ( const char *  alt ) const

inlinevirtual

checks if the indicated string is different from the current string

operator!=() [2/2]

virtual bool operator!= ( const StrView &  alt ) const

inlinevirtual

checks if the indicated string is different from the current string

operator+=() [1/4]

virtual void operator+= ( const char *  str )

inlinevirtual

adds a substring at the end of the string

operator+=() [2/4]

virtual void operator+= ( const char  value )

inlinevirtual

adds a character

operator+=() [3/4]

virtual void operator+= ( double  value )

inlinevirtual

adds a double at the end of the string

operator+=() [4/4]

virtual void operator+= ( int  value )

inlinevirtual

adds a int at the end of the string

operator<<()

virtual void operator<< ( int  n )

inlinevirtual

shift characters to the right -> we just move the pointer

operator=() [1/5]

virtual void operator= ( char *  str )

inlinevirtual

we can assign a char*

Reimplemented in Str.

operator=() [2/5]

virtual void operator= ( char  c )

inlinevirtual

we can assign a char

operator=() [3/5]

virtual void operator= ( const char *  str )

inlinevirtual

we can assign a const char*

Reimplemented in Str.

operator=() [4/5]

virtual void operator= ( double  val )

inlinevirtual

we can assign a double

Reimplemented in Str.

operator=() [5/5]

virtual void operator= ( int  value )

inlinevirtual

we can assign an int

Reimplemented in Str.

operator==() [1/2]

virtual bool operator== ( const char *  alt ) const

inlinevirtual

checks if the indicated string is equal to the current string

operator==() [2/2]

virtual bool operator== ( const StrView &  alt ) const

inlinevirtual

checks if the indicated string is equal to the current string

operator[]()

virtual char operator[] ( int  index )

inlinevirtual

remove()

virtual void remove ( const char *  toRemove )

inlinevirtual

removes the indicated substring from the string

removeAll()

virtual void removeAll ( const char *  toRemove )

inlinevirtual

removes the indicated substring from the string

replace()

virtual bool replace ( const char *  toReplace, const char *  replaced  )

inlinevirtual

Replaces the first instance of toReplace with replaced.

replaceAll()

virtual bool replaceAll ( const char *  toReplace, const char *  replaced  )

inlinevirtual

Replaces all instances of toReplace with replaced.

reverse()

static void reverse ( char  s[] )

inlinestaticprotected

rtrim()

virtual void rtrim ( )

inlinevirtual

remove trailing spaces

set() [1/6]

virtual void set ( char  chars[], int  maxlen, int  len = 0, bool  isConst = false  )

inlinevirtual

assigns a memory buffer

set() [2/6]

virtual void set ( const char *  alt )

inlinevirtual

assigs a value

if the Str is a const we replace the pointer

if the Str is an external buffer we need to copy

set() [3/6]

virtual void set ( const char  c )

inlinevirtual

set() [4/6]

virtual void set ( const StrView &  alt )

inlinevirtual

assigs from another Str value

if the Str is a const we replace the pointer

if the Str is an external buffer we need to copy

set() [5/6]

virtual void set ( double  value, int  precision = 2, int  withd = 0  )

inlinevirtual

set() [6/6]

virtual void set ( int  value )

inlinevirtual

setLength()

virtual void setLength ( int  len, bool  addZero = true  )

inlinevirtual

limits the length of the string (by adding a delimiting 0)

setLengthUndo()

virtual void setLengthUndo ( )

inlinevirtual

undo the last setLength call

startsWith()

virtual bool startsWith ( const char *  str )

inlinevirtual

checks if the string starts with the indicated substring

strncmp_i()

static int strncmp_i ( const char *  s1, const char *  s2, int  n  )

inlinestaticprotected

substring() [1/2]

virtual void substring ( const char *  from, int  start, int  end  )

inlinevirtual

copies a substring into the current string

substring() [2/2]

virtual void substring ( StrView &  from, int  start, int  end  )

inlinevirtual

copies a substring into the current string

swap()

virtual void swap ( StrView &  str )

inlinevirtual

toBinary()

static const char * toBinary ( void const *const  ptr, size_t const  size  )

inlinestatic

provides a binary string represntation

toDouble()

double toDouble ( )

inline

Converts the string to a double.

toFloat()

float toFloat ( )

inline

Converts the string to a float.

toInt()

int toInt ( )

inline

Converts the string to an int.

toLong()

long toLong ( )

inline

Converts the string to an long.

toLowerCase()

void toLowerCase ( )

inline

Converts the string to lowercase letters.

toUpperCase()

void toUpperCase ( )

inline

Converts the string to uppercase letters.

trim()

virtual void trim ( )

inlinevirtual

remove leading and traling spaces

Member Data Documentation

chars

char* chars = nullptr

protected

is_const

bool is_const = false

protected

len

int len = 0

protected

maxlen

int maxlen = 0

protected

savedChar

char savedChar

protected

savedLen

int savedLen = -1

protected

---

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

• src/AudioTools/CoreAudio/AudioBasic/StrView.h