str_funcs.h

Go to the documentation of this file.

// Name.......: str_funcs.h
// Purpose....: Commonly used string functions missing from standard C++ string library
// By/Date....: Gary James, 2008
//              Copyright 2008 Critical Link LLC, All Rights Reserved
// CORE FILE 
 
#ifndef STR_FUNCS_H_
#define STR_FUNCS_H_
 
#include <stdint.h>
#include <string>
#include <list>
#include <vector>
#include <stdarg.h>
#ifndef PVAR
#define PVAR(v) " "#v" = " << (v)
#endif
#ifndef PVARX
#define PVARX(v) " "#v" = 0x" << std::hex << (v) << std::dec
#endif
#ifndef PLOC 
#define PLOC __FILE__ << ":" << __LINE__ << " "
#endif
 
extern void        str_replace     (std::string &s1, const std::string &s2, const std::string &s3);
extern void        str_remove      (std::string &s1, const std::string &s2);
extern void        str_length_trim (std::string &s1, int maxlen);
extern void        str_pad         (std::string &s1, int len, char cc);
extern uint32_t    str_to_uint32   (const std::string &s1, int base = 10);
extern void        str_toupper     (std::string &s1);
extern void        str_tolower     (std::string &s1);
extern void        str_vsprintf    (std::string &s1, const char *fmt, va_list args);
extern void        str_sprintf     (std::string &s1, const char *fmt, ...);
extern std::string str_sprintf     (const char *fmt, ...);
extern void        str_split       (std::vector<std::string>& list, const std::string &s1, const std::string &s2, bool keep_empty = true);
extern void        str_strcpy      (char* destination, const std::string& source, size_t dest_buf_size);
 
 
//Templated wrapper of the above that lets us just pass in a fixed-length
//character buffer, and template magic will infer the buffer size. If a non-fixed
//length string is used as the destination, this function won't compile.
template <size_t dest_buf_size>
void str_strcpy (char (&destination)[dest_buf_size], const std::string& source)
{
    str_strcpy(destination, source, dest_buf_size);
}
 
//------------------------------------------------------------------------------
// In these IP address functions the MS byte of the uint32 values is first 
// octet of the address (i.e. 192.168.0.1 = 0xC0A80001).
//------------------------------------------------------------------------------
extern void        str_from_ip     (std::string &s1, uint32_t ip);
extern std::string format_ipaddr   (uint32_t ip);
extern uint32_t    ip_from_str     (const char *s1);
extern uint32_t    ip_from_str     (const std::string &s1);
 
extern void        parse_macaddr   (const std::string &s1, uint8_t* macaddr);
extern std::string format_macaddr  (const uint8_t *macaddr);
extern std::string xml_escape      (const char *str);
extern std::string xml_escape      (std::string str);
extern void        split_ip        (uint32_t ip, uint8_t *octets);
extern void        form_ip         (uint32_t &ip, uint8_t *octets);
 
extern std::string fileToString(const char *filename);
extern std::string getcwd_string();
 
void hexdump(void *ptr, int buflen);
 
#endif  //STR_FUNCS_H_