Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

wvstrutils.h File Reference


Detailed Description

Various little string functions.

#include <sys/types.h>
#include <time.h>
#include <ctype.h>
#include "wvstring.h"
#include "wvstringlist.h"
#include "wvhex.h"

Include dependency graph for wvstrutils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

char * terminate_string (char *string, char c)
 Add character c to the end of a string after removing terminating carriage returns/linefeeds if any.
char * trim_string (char *string)
 Trims whitespace from the beginning and end of the character string, including carriage return / linefeed characters.
char * trim_string (char *string, char c)
 Similar to above, but trims the string starting at the first occurrence of c.
WvString spacecat (WvStringParm a, WvStringParm b, char sep= ' ', bool onesep=false)
 return the string formed by concatenating string 'a' and string 'b' with the 'sep' character between them.
char * non_breaking (char *string)
 Replaces all whitespace characters in the string with non-breaking spaces ( ) for use with web stuff.
void replace_char (void *string, char c1, char c2, int length)
 Replace all instances of c1 with c2 for the first 'length' characters in 'string'.
char * snip_string (char *haystack, char *needle)
 Snip off the first part of 'haystack' if it consists of 'needle'.
char * strlwr (char *string)
 In-place modify a character string so that all contained letters are in lower case.
char * strupr (char *string)
 In-place modify a character string so that all contained letters are in upper case.
bool is_word (const char *string)
 Returns true if all characters in 'string' are isalnum() (alphanumeric).
WvString hexdump_buffer (const void *buf, size_t len, bool charRep=true)
 Produce a hexadecimal dump of the data buffer in 'buf' of length 'len'.
bool isnewline (char c)
 Returns true if 'c' is a newline or carriage return character.
WvString web_unescape (const char *str, bool no_space=false)
 Converts escaped characters (things like 20 etc.) from web URLS into their normal ASCII representations.
WvString url_encode (WvStringParm stuff)
 Converts all those pesky spaces, colons, and other nasties into nice unreadable Quasi-Unicode codes.
WvString diff_dates (time_t t1, time_t t2)
 Returns the difference between to dates in a human readable format.
WvString rfc822_date (time_t _when=-1)
 Returns an RFC822-compatible date made out of _when, or, if _when < 0, out of the current time.
WvString rfc1123_date (time_t _when)
 Returns an RFC1123-compatible date made out of _when.
WvString passwd_crypt (const char *str)
 Similar to crypt(), but this randomly selects its own salt.
WvString passwd_md5 (const char *str)
 Similar to crypt(), but this randomly selects its own salt.
WvString backslash_escape (WvStringParm s1)
 Returns a string with a backslash in front of every non alphanumeric character in s1.
int strcount (WvStringParm s, const char c)
 How many times does 'c' occur in "s"?
WvString encode_hostname_as_DN (WvStringParm hostname)
 Example: encode_hostname_as_DN("www.fizzle.com") will result in dc=www,dc=fizzle,dc=com,cn=www.fizzle.com.
WvString nice_hostname (WvStringParm name)
 Given a hostname, turn it into a "nice" one.
WvString getfilename (WvStringParm fullname)
 Take a full path/file name and splits it up into respective pathname and filename.
WvString getdirname (WvStringParm fullname)
WvString sizetoa (unsigned long long blocks, unsigned int blocksize=1)
 Given a number of blocks and a blocksize (default==1 byte), return a WvString containing a human-readable representation of blocks*blocksize.
WvString sizektoa (unsigned int kbytes)
 Give a size in Kilobyes gives a human readable size.
WvString secondstoa (unsigned int total_seconds)
 Given a number of seconds, returns a formatted human-readable string saying how long the period is.
int lookup (const char *str, const char *const *table, bool case_sensitive=false)
 Finds a string in an array and returns its index.
template<class StringCollection>
void strcoll_split (StringCollection &coll, WvStringParm _s, const char *splitchars=" \t", int limit=0)
 Splits a string and adds each substring to a collection.
template<class StringCollection>
void strcoll_splitstrict (StringCollection &coll, WvStringParm _s, const char *splitchars=" \t", int limit=0)
 Splits a string and adds each substring to a collection.
template<class StringCollection>
WvString strcoll_join (const StringCollection &coll, const char *joinchars=" \t")
 Concatenates all strings in a collection and returns the result.
WvString strreplace (WvStringParm s, WvStringParm a, WvStringParm b)
 Replace any instances of "a" with "b" in "s".
WvString undupe (WvStringParm s, char c)
 Replace any consecutive instances of character c with a single one.
WvString hostname ()
WvString fqdomainname ()
WvString metriculate (const off_t i)
 Inserts SI-style spacing into a number (eg passing 9876543210 returns "9 876 543 210").
WvString afterstr (WvStringParm line, WvStringParm a)
 Returns everything in line (exclusively) after a.
WvString beforestr (WvStringParm line, WvStringParm a)
 Returns everything in line (exclusively) before 'a'.
WvString substr (WvString line, unsigned int pos, unsigned int len)
 Returns the string of length len starting at pos in line.
template<class T>
bool wvstring_to_num (WvStringParm str, T &n)


Function Documentation

char* terminate_string char *  string,
char  c
 

Add character c to the end of a string after removing terminating carriage returns/linefeeds if any.

You need a buffer that's at least one character bigger than the current length of the string, including the terminating NULL.

char* trim_string char *  string  ) 
 

Trims whitespace from the beginning and end of the character string, including carriage return / linefeed characters.

Modifies the string in place. Returns the new first character of the string, which points either at 'string' itself or some character contained therein.

string is allowed to be NULL; returns NULL in that case.

WvString spacecat WvStringParm  a,
WvStringParm  b,
char  sep = ' ',
bool  onesep = false
 

return the string formed by concatenating string 'a' and string 'b' with the 'sep' character between them.

For example, spacecat("xx", "yy", ";"); returns "xx;yy", and spacecat("xx;;", "yy", ";") returns "xx;;;yy", and spacecat("xx;;", "yy", ";", true) returns "xx;yy".

This function is much faster than the more obvious WvString("%s;%s", a, b), so it's useful when you're producing a *lot* of string data.

void replace_char void *  string,
char  c1,
char  c2,
int  length
 

Replace all instances of c1 with c2 for the first 'length' characters in 'string'.

Ignores terminating NULL, so make sure you set 'length' correctly.

char* strlwr char *  string  ) 
 

In-place modify a character string so that all contained letters are in lower case.

Returns 'string'.

char* strupr char *  string  ) 
 

In-place modify a character string so that all contained letters are in upper case.

Returns 'string'.

WvString hexdump_buffer const void *  buf,
size_t  len,
bool  charRep = true
 

Produce a hexadecimal dump of the data buffer in 'buf' of length 'len'.

It is formatted with 16 bytes per line; each line has an address offset, hex representation, and printable representation.

This is used mostly for debugging purposes. You can send the returned WvString object directly to a WvLog or any other WvStream for output.

bool isnewline char  c  ) 
 

Returns true if 'c' is a newline or carriage return character.

Increases code readability a bit.

WvString web_unescape const char *  str,
bool  no_space = false
 

Converts escaped characters (things like 20 etc.) from web URLS into their normal ASCII representations.

If you happen to be decoding PEM encoded stuff,or anything that has + signs in it that you don't want encoded as spaces, then set no_space to true, and it should "just work" for you.

WvString passwd_crypt const char *  str  ) 
 

Similar to crypt(), but this randomly selects its own salt.

Before calling this function, you should call srandom(). When 2 identical strings are encrypted, they will not return the same encryption. Also, str does not need to be less than 8 chars as UNIX crypt says, although it only works on the first 8 characters.

WvString passwd_md5 const char *  str  ) 
 

Similar to crypt(), but this randomly selects its own salt.

Before calling this function, you should call srandom(). When 2 identical strings are encrypted, they will not return the same encryption. Also, str does not need to be less than 8 chars as we're using the glibc md5 algorithm.

WvString nice_hostname WvStringParm  name  ) 
 

Given a hostname, turn it into a "nice" one.

It has to start with a letter/number, END with a letter/number, have underscores converted to hyphens, and have no more than one hyphen in a row. If we can't do this and have any sort of answer, return "UNKNOWN".

WvString getfilename WvStringParm  fullname  ) 
 

Take a full path/file name and splits it up into respective pathname and filename.

This can also be useful for splitting the toplevel directory off a path.

int lookup const char *  str,
const char *const *  table,
bool  case_sensitive = false
 

Finds a string in an array and returns its index.

Returns -1 if not found.

template<class StringCollection>
void strcoll_split StringCollection &  coll,
WvStringParm  _s,
const char *  splitchars = " \t",
int  limit = 0
 

Splits a string and adds each substring to a collection.

coll : the collection of strings to add to _s : the string to split splitchars : the set of delimiter characters limit : the maximum number of elements to split

template<class StringCollection>
void strcoll_splitstrict StringCollection &  coll,
WvStringParm  _s,
const char *  splitchars = " \t",
int  limit = 0
 

Splits a string and adds each substring to a collection.

this behaves differently in that it actually delimits the pieces as fields and returns them, it doesn't treat multiple delimeters as one and skip them.

ie., parm1::parm2 -> 'parm1','','parm2' when delimited with ':'

coll : the collection of strings to add to _s : the string to split splitchars : the set of delimiter characters limit : the maximum number of elements to split

template<class StringCollection>
WvString strcoll_join const StringCollection &  coll,
const char *  joinchars = " \t"
 

Concatenates all strings in a collection and returns the result.

coll : the collection of strings to read from joinchars : the delimiter string to insert between strings

WvString strreplace WvStringParm  s,
WvStringParm  a,
WvStringParm  b
 

Replace any instances of "a" with "b" in "s".

Kind of like sed, only much dumber.

WvString afterstr WvStringParm  line,
WvStringParm  a
 

Returns everything in line (exclusively) after a.

If a is not in line, "" is returned.

WvString beforestr WvStringParm  line,
WvStringParm  a
 

Returns everything in line (exclusively) before 'a'.

If a is not in line, line is returned.

WvString substr WvString  line,
unsigned int  pos,
unsigned int  len
 

Returns the string of length len starting at pos in line.

Error checking prevents seg fault. If pos > line.len()-1 return "" if pos+len > line.len() simply return from pos to end of line


Generated on Sun Jul 10 17:31:04 2005 for WvStreams by  doxygen 1.4.0