privatestrlib.h

/*
 * File: privatestrlib.h
 * ---------------------
 * This file exports several useful string functions that are not
 * included in the C++ string library.
 * This functionality is considered "private" and not to be used by students.
 *
 * @version 2021/04/09
 * - moved to private SGL namespace
 * - renamed some functions to remove 'string' prefix
 * @version 2021/04/03
 * - removed dependency on custom collections
 * @version 2018/11/14
 * - added std::to_string for bool, char, pointer, and generic template type T
 * @version 2018/09/25
 * - added doc comments for new documentation generation
 * @version 2018/09/02
 * - added padLeft, padRight
 * @version 2016/11/09
 * - added boolalpha to writeGenericValue (improves bool printing in
 *   collection toString output)
 * @version 2016/10/30
 * - added overloads that take type char instead of string:
 *   stringContains, stringIndexOf, stringJoin, stringLastIndexOf, stringReplace,
 *   stringSplit, toLowerCase, toUpperCase
 * @version 2016/10/26
 * - bug fix for stringLastIndexOf default index arg
 * @version 2016/10/13
 * - modified writeGenericValue, writeQuotedString to return ostream
 * @version 2016/08/03
 * - modified readGenericValue not to throw error() on parse failures
 *   (needed to support idiomatic silent-failing >> operators)
 * @version 2015/10/26
 * - added charToInteger/integerToChar functions
 * @version 2015/08/02
 * - added htmlEncode/Decode functions (not 100% perfect but works for common cases)
 * @version 2014/10/19
 * - alphabetized functions
 * - added several 'inPlace' variants of existing functions that return strings
 * @version 2014/10/08
 * - removed dependency on 'using namespace' statement
 */


#ifndef _private_strlib_h
#define _private_strlib_h

#include <iostream>
#include <sstream>
#include <string>
#include <vector>

namespace sgl {
namespace priv {
namespace strlib {

string boolToString(bool b);

string boolToString(int b);

int charToInteger(char c);

string charToString(char c);

bool contains(const string& s, char ch);

bool contains(const string& s, const string& substring);

string doubleToString(double d);

bool endsWith(const string& str, const string& suffix);

bool endsWith(const string& str, char suffix);

bool equalsIgnoreCase(const string& s1, const string& s2);

string htmlDecode(const string& s);

string htmlEncode(const string& s);

int indexOf(const string& s, char ch, int startIndex = 0);

int indexOf(const string& s, const string& substring, int startIndex = 0);

char integerToChar(int n);

string integerToString(int n, int radix = 10);

string join(const std::vector<string>& v, char delimiter = '\n');

string join(const std::vector<string>& v, const string& delimiter = "\n");

int lastIndexOf(const string& s, char ch, int startIndex = (int) string::npos);

int lastIndexOf(const string& s, const string& substring, int startIndex = (int) string::npos);

string longToString(long n, int radix = 10);

string padLeft(const string& s, int length, char fill = ' ');

string padRight(const string& s, int length);

string pointerToString(void* p);

string realToString(double d);

string replace(const string& str, char old, char replacement, int limit = -1);

string replace(const string& str, const string& old, const string& replacement, int limit = -1);

int replaceInPlace(string& str, char old, char replacement, int limit = -1);

int replaceInPlace(string& str, const string& old, const string& replacement, int limit = -1);

std::vector<string> split(const string& str, char delimiter, int limit = -1);

std::vector<string> split(const string& str, const string& delimiter, int limit = -1);

bool startsWith(const string& str, char prefix);

bool startsWith(const string& str, const string& prefix);

bool stringIsBool(const string& str);

bool stringIsDouble(const string& str);   // alias

bool stringIsInteger(const string& str, int radix = 10);

bool stringIsLong(const string& str, int radix = 10);

bool stringIsReal(const string& str);

bool stringToBool(const string& str);

char stringToChar(const string& str);

double stringToDouble(const string& str);   // alias

int stringToInteger(const string& str, int radix = 10);

long stringToLong(const string& str, int radix = 10);

double stringToReal(const string& str);

char toLowerCase(char ch);

string toLowerCase(const string& str);

void toLowerCaseInPlace(string& str);

char toUpperCase(char ch);

string toUpperCase(const string& str);

void toUpperCaseInPlace(string& str);

string trim(const string& str);

void trimInPlace(string& str);

string trimEnd(const string& str);

void trimEndInPlace(string& str);

string trimStart(const string& str);

void trimStartInPlace(string& str);

string urlDecode(const string& str);

void urlDecodeInPlace(string& str);

string urlEncode(const string& str);

void urlEncodeInPlace(string& str);

} // namespace strlib
} // namespace priv
} // namespace sgl

// add to_string overloads for some common types missing from C++ standard
namespace std {

bool stob(const string& str);

char stoc(const string& str);

string to_string(bool b);

string to_string(char c);

string to_string(void* p);

template <typename T>
string to_string(const T& value) {
    std::ostringstream out;
    out << value;   // if you get an error here, your type might not have a << operator
    return out.str();
}
} // namespace std

#endif // _private_strlib_h