string Namespace Reference

Functions
bool	IsUpper (const std::string &string)
bool	IsLower (const std::string &string)
bool	IsNumber (const std::string &string)
bool	IsAlphabetic (const std::string &string)
bool	HasPrefix (const std::string &string, const std::string &prefix)
bool	HasSuffix (const std::string &string, const std::string &suffix)
bool	HasExtension (const std::string &string, const std::string &extension)
void	ToUpper (std::string *string)
void	ToLower (std::string *string)
bool	ReplaceAll (std::string *string, const std::string &replace_this, const std::string &with_this)
bool	ReplaceAllChar (std::string *string, char replace_this, char with_this)
bool	RemoveNumbers (std::string *string)
std::string	CreateTimestampedFilename (const std::string &base, const std::string &extension, const bool include_date=true)
std::string	GetDir (const std::string &string)
std::string	GetPath (const std::string &string)
std::string	GetRootDir (const std::string &string)
std::string	GetFileName (const std::string &string)
std::string	GetFileNameNoExtension (const std::string &string)
bool	RemoveExtension (std::string *string)
bool	RemovePrefix (std::string *string)
bool	RemoveSuffix (std::string *string)
std::string	GetExtension (const std::string &string)
void	ReplaceExtension (std::string *string, const std::string &new_extension)
std::string	JoinFilePath (const std::vector< std::string > &strings)
bool	IsAbsolutePath (const std::string &string)
bool	Tokenize (const std::string &string, const std::vector< char > &delimiters, std::vector< std::string > *tokens)
bool	TokenizeFileString (const std::string &file_string, std::vector< std::string > *tokens)
void	TrimWhiteSpace (std::string *string)
std::string	StringPrintf (const std::string &string)
std::string	StringScanf (const std::string &string)
size_t	FindFirstOf (const std::string &string)
size_t	FindLastOf (const std::string &string)
std::vector< size_t >	FindAllOf (const std::string &string)
void	RemoveFirstOf (std::string *string, const std::string &remove_this)
void	RemoveLastOf (std::string *string, const std::string &remove_this)
void	RemoveAll (std::string *string, const std::string &remove_this)
std::string	Substring (const std::string &string)
std::string	After (const std::string &string, const std::string &after_this)
std::string	Before (const std::string &string, const std::string &before_this)
void	Append (std::string *base, const std::string &append)
void	Append (std::string *first, const std::vector< std::string > &second)
bool	TrimFromBackToLength (std::string *string, size_t length)
bool	TrimFromFrontToLength (std::string *string, size_t length)
bool	TrimFromTo (std::string *string, size_t from, size_t to)
bool	FileNamesEquivalent (const std::string &one, const std::string &two)
bool	ExtensionsEquivalent (const std::string &one, const std::string &two)
bool	FilePathsEquivalent (const std::string &one, const std::string &two)
void	Reverse (std::string *string)

Function Documentation

std::string string::After	(	const std::string &	string,
		const std::string &	after_this
	)

void string::Append	(	std::string *	base,
		const std::string &	append
	)

void string::Append	(	std::string *	first,
		const std::vector< std::string > &	second
	)

std::string string::Before	(	const std::string &	string,
		const std::string &	before_this
	)

std::string string::CreateTimestampedFilename	(	const std::string &	base,
		const std::string &	extension,
		const bool	include_date = true
	)

bool string::ExtensionsEquivalent ( const std::string &  one, const std::string &  two  )

inline

Definition at line 34 of file extensions_equivalent.h.

                                                         {
  return GetExtension(path1) == GetExtension(path2);
}

bool string::FileNamesEquivalent	(	const std::string &	one,
		const std::string &	two
	)

bool string::FilePathsEquivalent	(	const std::string &	one,
		const std::string &	two
	)

std::vector<size_t> string::FindAllOf

(

const std::string &

string

)

size_t string::FindFirstOf

(

const std::string &

string

)

size_t string::FindLastOf

(

const std::string &

string

)

std::string string::GetDir

(

const std::string &

string

)

Definition at line 32 of file get_dir.h.

                                        {
  std::vector<std::string> path_tokens;
  TokenizeFileString(path, &path_tokens);

  // If the input path ends in a '/', it already does not have a filename. The
  // last element in the tokens vector is the local directory.
  // e.g. this/is/a/path/ --> return "path"
  if (path.back() == '/')
    return path_tokens.back();

  // Otherwise, there must be at least 2 tokens to have a local directory.
  // e.g. if the path is "/filename", there is no way to tell if it is a file or
  // directory. Assume it is a file.
  if (path_tokens.size() < 2)
    return std::string("");

  // If there are at least 2 tokens, return the second-to-last.
  // e.g. local_directory/filename.ext --> local_directory
  return path_tokens[path_tokens.size()-2];
}

std::string string::GetExtension ( const std::string &  string )

inline

Definition at line 27 of file get_extension.h.

                                                       {

  // Extension begins after the last '.', if one exists.
  const size_t last_period = string.find_last_of('.');
  if (last_period == string.npos)
    return std::string("");

  // Return an empty extension if the last charaacter in the string is a period.
  if (string.back() == '.')
    return std::string("");

  return string.substr(last_period + 1, string.size() - last_period - 1);
}

std::string string::GetFileName

(

const std::string &

string

)

std::string string::GetFileNameNoExtension

(

const std::string &

string

)

std::string string::GetPath

(

const std::string &

string

)

Definition at line 34 of file get_path.h.

                                         {
  // If the input path is empty, return an empty string.
  if (path.empty())
    return std::string("");

  // If the input path ends in a '/', it already does not have a filename.
  if (path.back() == '/')
    return path;

  std::vector<std::string> path_tokens;
  TokenizeFileString(path, &path_tokens);

  // If there are no tokens and the path begins with '/', return '/'. Otherwise
  // the input name is a file and therefore has no path.
  if (path_tokens.size() == 0)
    return path[0] == '/' ? std::string("/") : std::string("");

  // Remove the last token from the tokenized path.
  path_tokens.erase(path_tokens.end());

  // Join the remaining tokens, add a prepending slash if one existed in the
  // input path, and return the result.
  std::string output_path = JoinFilepath(path_tokens);
  if (path[0] == '/')
    return PrependSlash(output_path);

  return output_path;
}

std::string string::GetRootDir

(

const std::string &

string

)

Definition at line 33 of file get_root_dir.h.

                                            {
  std::vector<std::string> path_tokens;
  TokenizeFileString(path, &path_tokens);

  // If there are no tokens or only one token in the file path, return an empty string.
  if (path_tokens.size() <= 1)
    return std::string("");

  return path_tokens.front();
}

bool string::HasExtension ( const std::string &  string, const std::string &  extension  )

inline

Definition at line 27 of file has_extension.h.

                                                     {
  // - 1 because extension does not include the '.'
  if (extension.size() > string.size() - 1)
    return false;

  // Extension begins after the last '.', if one exists.
  const size_t last_period = string.find_last_of('.');
  if (last_period == string.npos)
    return false;

  // If the extension has non-zero size, '.' cannot be the last character in the
  // string.
  if (string.back() == '.' && extension.size() > 0)
    return false;

  // If the user prepends their extension query with '.', include the string's
  // last period in the comparison.
  if (extension[0] == '.')
    return string.compare(last_period, extension.size(), extension) == 0;

  return string.compare(last_period + 1, extension.size(), extension) == 0;
}

bool string::HasPrefix ( const std::string &  string, const std::string &  prefix  )

inline

Definition at line 27 of file has_prefix.h.

                                                                        {
  return string.size() >= prefix.size() &&
         string.compare(0, prefix.size(), prefix) == 0;
}

bool string::HasSuffix ( const std::string &  string, const std::string &  suffix  )

inline

Definition at line 27 of file has_suffix.h.

                                                                        {
  const size_t suffix_begin = string.size() - suffix.size();
  return string.size() >= suffix.size() &&
         string.compare(suffix_begin, suffix.size(), suffix) == 0;
}

bool string::IsAbsolutePath ( const std::string &  string )

inline

Definition at line 27 of file is_absolute_path.h.

                                                         {
  if (path_string.empty())
    return false;

  return path_string[0] == '/';
}

bool string::IsAlphabetic ( const std::string &  string )

inline

Definition at line 28 of file is_alphabetic.h.

                                                  {
  return std::all_of(string.begin(), string.end(), ::isalpha);
}

bool string::IsLower ( const std::string &  string )

inline

Definition at line 28 of file is_lower.h.

                                             {
  return std::all_of(string.begin(), string.end(), ::islower);
}

bool string::IsNumber ( const std::string &  string )

inline

Definition at line 28 of file is_number.h.

                                              {
  return std::all_of(string.begin(), string.end(), ::isdigit);
}

bool string::IsUpper ( const std::string &  string )

inline

Definition at line 28 of file is_upper.h.

                                             {
  return std::all_of(string.begin(), string.end(), ::isupper);
}

std::string string::JoinFilePath

(

const std::vector< std::string > &

strings

)

void string::RemoveAll	(	std::string *	string,
		const std::string &	remove_this
	)

bool string::RemoveExtension ( std::string *  string )

inline

Definition at line 30 of file remove_extension.h.

                                               {
  const std::string extension = GetExtension(*string);
  if (extension.empty() && string->back() != '.')
    return false;

  std::string period(".");
  return RemoveSuffix(period.append(extension), string);
}

void string::RemoveFirstOf	(	std::string *	string,
		const std::string &	remove_this
	)

void string::RemoveLastOf	(	std::string *	string,
		const std::string &	remove_this
	)

bool string::RemoveNumbers

(

std::string *

string

)

bool string::RemovePrefix

(

std::string *

string

)

bool string::RemoveSuffix

(

std::string *

string

)

bool string::ReplaceAll	(	std::string *	string,
		const std::string &	replace_this,
		const std::string &	with_this
	)

bool string::ReplaceAllChar	(	std::string *	string,
		char	replace_this,
		char	with_this
	)

void string::ReplaceExtension	(	std::string *	string,
		const std::string &	new_extension
	)

void string::Reverse ( std::string *  string )

inline

Definition at line 28 of file reverse.h.

                                       {
  std::reverse(string->begin(), string->end());
}

std::string string::StringPrintf

(

const std::string &

string

)

std::string string::StringScanf

(

const std::string &

string

)

std::string string::Substring

(

const std::string &

string

)

bool string::Tokenize ( const std::string &  string, const std::vector< char > &  delimiters, std::vector< std::string > *  tokens  )

inline

Definition at line 45 of file tokenize.h.

                                                   {
  std::string delimiters_string;
  for (const auto &element : delimiters)
    delimiters_string.push_back(element);

  Tokenize(string, delimiters_string, tokens);
}

bool string::TokenizeFileString ( const std::string &  file_string, std::vector< std::string > *  tokens  )

inline

Definition at line 33 of file tokenize_file_string.h.

                                                             {
  Tokenize(string, '/', tokens);
}

void string::ToLower ( std::string *  string )

inline

Definition at line 28 of file to_lower.h.

                                       {
  std::transform(string->begin(), string->end(), string->begin(), ::tolower);
}

void string::ToUpper ( std::string *  string )

inline

Definition at line 28 of file to_upper.h.

                                       {
  std::transform(string->begin(), string->end(), string->begin(), ::toupper);
}

bool string::TrimFromBackToLength	(	std::string *	string,
		size_t	length
	)

bool string::TrimFromFrontToLength	(	std::string *	string,
		size_t	length
	)

bool string::TrimFromTo	(	std::string *	string,
		size_t	from,
		size_t	to
	)

void string::TrimWhiteSpace ( std::string *  string )

inline

Definition at line 27 of file trim_white_space.h.

                                              {
  // Trim white space from the back.
  size_t back_whitespace = string->size() - 1;
  for (; back_whitespace > 0; --back_whitespace) {
    if (string->at(back_whitespace) != ' ')
      break;
  }
  string->erase(back_whitespace + 1, string->size());

  // Trim white space from the front.
  size_t front_whitespace = 0;
  for (; front_whitespace < string->size(); ++front_whitespace) {
    if (string->at(front_whitespace) != ' ')
      break;
  }
  string->erase(0, front_whitespace);
}