pfc::string_base

#include <string_base.h>

Inheritance diagram for pfc::string_base:

Public Member Functions
string_base &	_formatter () const
void	add_filename (const char *fn)
virtual void	add_string (const char *p_string, t_size p_length=~0)=0
const char *	c_str () const
void	convert_to_lower_ascii (const char *src, char replace= '?')
void	delimit (const char *c)
void	end_with (char c)
void	end_with_slash ()
bool	ends_with (char c) const
t_size	find_first (char p_char, t_size p_start=0) const
t_size	find_first (const char *p_string, t_size p_start=0) const
t_size	find_last (char p_char, t_size p_start=~0) const
t_size	find_last (const char *p_string, t_size p_start=~0) const
void	fix_dir_separator (char c= '\\')
bool	fix_eol (const char *append=" (...)", t_size start=0)
virtual t_size	get_length () const
virtual const char *	get_ptr () const =0
bool	has_prefix (const char *prefix) const
bool	has_prefix_i (const char *prefix) const
bool	has_suffix (const char *suffix) const
bool	has_suffix_i (const char *suffix) const
bool	is_empty () const
bool	is_valid_utf8 () const
char	last_char () const
t_size	length () const
bool	limit_length (t_size length_in_chars, const char *append=" (...)")
virtual char *	lock_buffer (t_size p_requested_length)=0
	operator const char * () const
bool	operator!= (const string_base &p_other) const
const string_base &	operator+= (const char *src)
const string_base &	operator+= (const string_base &src)
bool	operator< (const string_base &p_other) const
bool	operator<= (const string_base &p_other) const
const string_base &	operator= (const char *src)
const string_base &	operator= (const string_base &src)
bool	operator== (const string_base &p_other) const
bool	operator> (const string_base &p_other) const
bool	operator>= (const string_base &p_other) const
t_size	replace_string (const char *replace, const char *replaceWith, t_size start=0)
void	reset ()
t_size	scan_filename () const
virtual void	set_string (const char *p_string, t_size p_length=~0)
void	set_string_ (const char *str)
void	skip_trailing_char (unsigned c= ' ')
const char *	toString () const
virtual void	truncate (t_size len)=0
bool	truncate_eol (t_size start=0)
void	truncate_filename ()
void	truncate_last_char ()
void	truncate_number_suffix ()
void	truncate_to_parent_path ()
virtual void	unlock_buffer ()=0
Public Member Functions inherited from pfc::string_receiver
void	add_byte (char c)
void	add_char (t_uint32 c)
void	add_chars (t_uint32 p_char, t_size p_count)
void	add_string_ (const char *str)

Protected Member Functions
	string_base ()
	~string_base ()
Protected Member Functions inherited from pfc::string_receiver
	string_receiver ()
	~string_receiver ()

Detailed Description

Definition at line 193 of file string_base.h.

Constructor & Destructor Documentation

pfc::string_base::string_base ( )

inlineprotected

Definition at line 268 of file string_base.h.

{}

pfc::string_base::~string_base ( )

inlineprotected

Definition at line 269 of file string_base.h.

{}

Member Function Documentation

string_base& pfc::string_base::_formatter ( ) const

inline

Definition at line 261 of file string_base.h.

{return const_cast<string_base&>(*this);}

void pfc::string_base::add_filename ( const char *  fn )

inline

Definition at line 257 of file string_base.h.

{end_with_slash(); *this += fn; }

virtual void pfc::string_base::add_string ( const char *  p_string, t_size  p_length = ~0  )

pure virtual

Implements pfc::string_receiver.

Implemented in pfc::string_base_ref, pfc::string8_t< t_alloc >, pfc::string8_t< pfc::alloc_standard >, pfc::string_fixed_t< max_length >, pfc::string_fixed_t< 32 >, pfc::string_fixed_t< 127 >, string_formatter_tf, and pfc::__stringEmpty.

const char* pfc::string_base::c_str ( ) const

inline

Definition at line 196 of file string_base.h.

{ return get_ptr(); }

void pfc::string_base::convert_to_lower_ascii	(	const char *	src,
		char	replace = '?'
	)

Definition at line 257 of file string_base.cpp.

{
    reset();
    PFC_ASSERT(replace>0);
    while(*src)
    {
        unsigned c;
        t_size delta = utf8_decode_char(src,c);
        if (delta==0) {c = replace; delta = 1;}
        else if (c>=0x80) c = replace;
        add_byte((char)c);
        src += delta;
    }
}

void pfc::string_base::delimit ( const char *  c )

inline

Definition at line 246 of file string_base.h.

{if (length()>0) add_string(c);}

void pfc::string_base::end_with

(

char

c

)

Definition at line 780 of file string_base.cpp.

                                      {
    if (!ends_with(p_char)) add_byte(p_char);
}

void pfc::string_base::end_with_slash

(

)

Definition at line 788 of file string_base.cpp.

                                 {
    end_with( io::path::getDefaultSeparator() );
}

bool pfc::string_base::ends_with

(

char

c

)

const

Definition at line 783 of file string_base.cpp.

                                        {
    t_size length = get_length();
    return length > 0 && get_ptr()[length-1] == c;
}

t_size pfc::string_base::find_first ( char  p_char, t_size  p_start = 0  ) const

inline

Definition at line 237 of file string_base.h.

{return pfc::string_find_first(get_ptr(),p_char,p_start);}

t_size pfc::string_base::find_first ( const char *  p_string, t_size  p_start = 0  ) const

inline

Definition at line 239 of file string_base.h.

{return pfc::string_find_first(get_ptr(),p_string,p_start);}

t_size pfc::string_base::find_last ( char  p_char, t_size  p_start = ~0  ) const

inline

Definition at line 238 of file string_base.h.

{return pfc::string_find_last(get_ptr(),p_char,p_start);}

t_size pfc::string_base::find_last ( const char *  p_string, t_size  p_start = ~0  ) const

inline

Definition at line 240 of file string_base.h.

{return pfc::string_find_last(get_ptr(),p_string,p_start);}

void pfc::string_base::fix_dir_separator

(

char

c = '\\'

)

Definition at line 1167 of file string_base.cpp.

                                          {
#ifdef _WIN32
    end_with(c);
#else
    end_with_slash();
#endif
}

bool pfc::string_base::fix_eol	(	const char *	append = " (...)",
		t_size	start = 0
	)

Definition at line 988 of file string_base.cpp.

{
    const bool rv = truncate_eol(start);
    if (rv) add_string(append);
    return rv;
}

virtual t_size pfc::string_base::get_length ( ) const

inlinevirtual

Reimplemented in pfc::string_base_ref, pfc::string8_t< t_alloc >, pfc::string8_t< pfc::alloc_standard >, pfc::string_fixed_t< max_length >, pfc::string_fixed_t< 32 >, pfc::string_fixed_t< 127 >, string_formatter_tf, and pfc::__stringEmpty.

Definition at line 200 of file string_base.h.

{return strlen(get_ptr());}

virtual const char* pfc::string_base::get_ptr ( ) const

pure virtual

Implemented in pfc::string_base_ref, pfc::string8_t< t_alloc >, pfc::string8_t< pfc::alloc_standard >, pfc::string_fixed_t< max_length >, pfc::string_fixed_t< 32 >, pfc::string_fixed_t< 127 >, string_formatter_tf, and pfc::__stringEmpty.

bool pfc::string_base::has_prefix ( const char *  prefix ) const

inline

Definition at line 263 of file string_base.h.

{ return string_has_prefix( get_ptr(), prefix ); }

bool pfc::string_base::has_prefix_i ( const char *  prefix ) const

inline

Definition at line 264 of file string_base.h.

{ return string_has_prefix_i( get_ptr(), prefix); }

bool pfc::string_base::has_suffix ( const char *  suffix ) const

inline

Definition at line 265 of file string_base.h.

{ return string_has_suffix( get_ptr(), suffix); }

bool pfc::string_base::has_suffix_i ( const char *  suffix ) const

inline

Definition at line 266 of file string_base.h.

{ return string_has_suffix_i( get_ptr(), suffix); }

bool pfc::string_base::is_empty ( ) const

inline

Definition at line 213 of file string_base.h.

{return *get_ptr()==0;}

bool pfc::string_base::is_valid_utf8 ( ) const

inline

Definition at line 217 of file string_base.h.

{return pfc::is_valid_utf8(get_ptr());}

char pfc::string_base::last_char

(

)

const

Definition at line 792 of file string_base.cpp.

                                  {
    size_t l = this->length();
    if (l == 0) return 0;
    return this->get_ptr()[l-1];
}

t_size pfc::string_base::length ( ) const

inline

For compatibility with old conventions.

Definition at line 209 of file string_base.h.

{return get_length();}

bool pfc::string_base::limit_length	(	t_size	length_in_chars,
		const char *	append = " (...)"
	)

Definition at line 995 of file string_base.cpp.

{
    bool rv = false;
    const char * base = get_ptr(), * ptr = base;
    while(length_in_chars && utf8_advance(ptr)) length_in_chars--;
    if (length_in_chars==0)
    {
        truncate(ptr-base);
        add_string(append);
        rv = true;
    }
    return rv;
}

virtual char* pfc::string_base::lock_buffer ( t_size  p_requested_length )

pure virtual

Implemented in pfc::string_base_ref, pfc::string8_t< t_alloc >, pfc::string8_t< pfc::alloc_standard >, pfc::string_fixed_t< max_length >, pfc::string_fixed_t< 32 >, pfc::string_fixed_t< 127 >, string_formatter_tf, and pfc::__stringEmpty.

pfc::string_base::operator const char * ( ) const

inline

Definition at line 233 of file string_base.h.

{return get_ptr();}

bool pfc::string_base::operator!= ( const string_base &  p_other ) const

inline

Definition at line 227 of file string_base.h.

{return strcmp(*this,p_other) != 0;}

const string_base& pfc::string_base::operator+= ( const char *  src )

inline

Definition at line 222 of file string_base.h.

{add_string_(src);return *this;}

const string_base& pfc::string_base::operator+= ( const string_base &  src )

inline

Definition at line 224 of file string_base.h.

{add_string(src);return *this;}

bool pfc::string_base::operator< ( const string_base &  p_other ) const

inline

Definition at line 229 of file string_base.h.

{return strcmp(*this,p_other) < 0;}

bool pfc::string_base::operator<= ( const string_base &  p_other ) const

inline

Definition at line 231 of file string_base.h.

{return strcmp(*this,p_other) <= 0;}

const string_base& pfc::string_base::operator= ( const char *  src )

inline

Definition at line 221 of file string_base.h.

{set_string_(src);return *this;}

const string_base& pfc::string_base::operator= ( const string_base &  src )

inline

Definition at line 223 of file string_base.h.

{set_string(src);return *this;}

bool pfc::string_base::operator== ( const string_base &  p_other ) const

inline

Definition at line 226 of file string_base.h.

{return strcmp(*this,p_other) == 0;}

bool pfc::string_base::operator> ( const string_base &  p_other ) const

inline

Definition at line 228 of file string_base.h.

{return strcmp(*this,p_other) > 0;}

bool pfc::string_base::operator>= ( const string_base &  p_other ) const

inline

Definition at line 230 of file string_base.h.

{return strcmp(*this,p_other) >= 0;}

t_size pfc::string_base::replace_string	(	const char *	replace,
		const char *	replaceWith,
		t_size	start = 0
	)

Definition at line 1029 of file string_base.cpp.

                                                                                                 {
    string_formatter temp;
    size_t srcDone = 0, walk = start;
    size_t occurances = 0;
    const char * const source = this->get_ptr();
    
    const size_t replaceLen = strlen( replace );
    for(;;) {
        const char * ptr = strstr( source + walk, replace );
        if (ptr == NULL) {
            // end
            if (srcDone == 0) {
                return 0; // string not altered
            }
            temp.add_string( source + srcDone );
            break;
        }
        ++occurances;
        walk = ptr - source;
        temp.add_string( source + srcDone, walk - srcDone );
        temp.add_string( replaceWith );
        walk += replaceLen;
        srcDone = walk;
    }
    this->set_string( temp );
    return occurances;
    
}

void pfc::string_base::reset ( )

inline

Definition at line 211 of file string_base.h.

{truncate(0);}

t_size pfc::string_base::scan_filename ( ) const

inline

Definition at line 235 of file string_base.h.

{return pfc::scan_filename(get_ptr());}

virtual void pfc::string_base::set_string ( const char *  p_string, t_size  p_length = ~0  )

inlinevirtual

Reimplemented in pfc::string_base_ref, pfc::string8_t< t_alloc >, pfc::string8_t< pfc::alloc_standard >, string_formatter_tf, and pfc::__stringEmpty.

Definition at line 198 of file string_base.h.

{reset();add_string(p_string,p_length);}

void pfc::string_base::set_string_ ( const char *  str )

inline

Definition at line 204 of file string_base.h.

{set_string(str, _strParamLen(str));}

void pfc::string_base::skip_trailing_char

(

unsigned

c = ' '

)

Definition at line 12 of file string_base.cpp.

{
    const char * str = get_ptr();
    t_size ptr,trunc = 0;
    bool need_trunc = false;
    for(ptr=0;str[ptr];)
    {
        unsigned c;
        t_size delta = utf8_decode_char(str+ptr,c);
        if (delta==0) break;
        if (c==skip)
        {
            need_trunc = true;
            trunc = ptr;
        }
        else
        {
            need_trunc = false;
        }
        ptr += delta;
    }
    if (need_trunc) truncate(trunc);
}

const char* pfc::string_base::toString ( ) const

inline

Definition at line 206 of file string_base.h.

{return get_ptr();}

virtual void pfc::string_base::truncate ( t_size  len )

pure virtual

Implemented in pfc::string_base_ref, pfc::string8_t< t_alloc >, pfc::string8_t< pfc::alloc_standard >, pfc::string_fixed_t< max_length >, pfc::string_fixed_t< 32 >, pfc::string_fixed_t< 127 >, string_formatter_tf, and pfc::__stringEmpty.

bool pfc::string_base::truncate_eol

(

t_size

start = 0

)

Definition at line 973 of file string_base.cpp.

{
    const char * ptr = get_ptr() + start;
    for(t_size n=start;*ptr;n++)
    {
        if (*ptr==10 || *ptr==13)
        {
            truncate(n);
            return true;
        }
        ptr++;
    }
    return false;
}

void pfc::string_base::truncate_filename ( )

inline

Definition at line 255 of file string_base.h.

{truncate(scan_filename());}

void pfc::string_base::truncate_last_char

(

)

Definition at line 797 of file string_base.cpp.

                                     {
    size_t l = this->length();
    if (l > 0) this->truncate( l - 1 );
}

void pfc::string_base::truncate_number_suffix

(

)

Definition at line 802 of file string_base.cpp.

                                         {
    size_t l = this->length();
    const char * const p = this->get_ptr();
    while( l > 0 && char_is_numeric( p[l-1] ) ) --l;
    truncate( l );
}

void pfc::string_base::truncate_to_parent_path

(

)

Definition at line 1009 of file string_base.cpp.

                                          {
    size_t at = scan_filename();
#ifdef _WIN32
    while(at > 0 && (*this)[at-1] == '\\') --at;
    if (at > 0 && (*this)[at-1] == ':' && (*this)[at] == '\\') ++at;
#else
    // Strip trailing /
    while(at > 0 && (*this)[at-1] == '/') --at;

    // Hit empty? Bring root / back to life
    if (at == 0 && (*this)[0] == '/') ++at;

    // Deal with proto://
    if (at > 0 && (*this)[at-1] == ':') {
        while((*this)[at] == '/') ++at;
    }
#endif
    this->truncate( at );
}

virtual void pfc::string_base::unlock_buffer ( )

pure virtual

Implemented in pfc::string_base_ref, pfc::string8_t< t_alloc >, pfc::string8_t< pfc::alloc_standard >, pfc::string_fixed_t< max_length >, pfc::string_fixed_t< 32 >, pfc::string_fixed_t< 127 >, string_formatter_tf, and pfc::__stringEmpty.

---

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

• pfc/string_base.h
• pfc/string_base.cpp