HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Strutil Namespace Reference

String-related utilities. More...

Namespaces

 fmt
 
 old
 

Classes

class  StringHash
 
struct  StringEqual
 C++ functor for comparing two strings for equality of their characters. More...
 
struct  StringIEqual
 
struct  StringLess
 C++ functor for comparing the ordering of two strings. More...
 
struct  StringILess
 

Enumerations

enum  QuoteBehavior { DeleteQuotes, KeepQuotes }
 

Functions

void OIIO_API sync_output (FILE *file, string_view str)
 
void OIIO_API sync_output (std::ostream &file, string_view str)
 
template<typename... Args>
std::string sprintf (const char *fmt, const Args &...args)
 
template<typename... Args>
void printf (const char *fmt, const Args &...args)
 
template<typename... Args>
void fprintf (FILE *file, const char *fmt, const Args &...args)
 
template<typename... Args>
void fprintf (std::ostream &file, const char *fmt, const Args &...args)
 
template<typename... Args>
void print (const char *fmt, const Args &...args)
 
template<typename... Args>
void print (FILE *file, const char *fmt, const Args &...args)
 
template<typename... Args>
void print (std::ostream &file, const char *fmt, const Args &...args)
 
std::string OIIO_API vsprintf (const char *fmt, va_list ap)
 
std::string OIIO_API vformat (const char *fmt, va_list ap)
 
std::string OIIO_API memformat (long long bytes, int digits=1)
 
std::string OIIO_API timeintervalformat (double secs, int digits=1)
 
bool OIIO_API get_rest_arguments (const std::string &str, std::string &base, std::map< std::string, std::string > &result)
 
std::string OIIO_API escape_chars (string_view unescaped)
 
std::string OIIO_API unescape_chars (string_view escaped)
 
std::string OIIO_API wordwrap (string_view src, int columns=80, int prefix=0, string_view sep=" ", string_view presep="")
 
OIIO_CONSTEXPR14 size_t strhash (size_t len, const char *s)
 
OIIO_CONSTEXPR14 size_t strhash (string_view s)
 
bool OIIO_API iequals (string_view a, string_view b)
 
bool OIIO_API iless (string_view a, string_view b)
 
bool OIIO_API starts_with (string_view a, string_view b)
 Does 'a' start with the string 'b', with a case-sensitive comparison? More...
 
bool OIIO_API istarts_with (string_view a, string_view b)
 
bool OIIO_API ends_with (string_view a, string_view b)
 Does 'a' end with the string 'b', with a case-sensitive comparison? More...
 
bool OIIO_API iends_with (string_view a, string_view b)
 
bool OIIO_API contains (string_view a, string_view b)
 Does 'a' contain the string 'b' within it? More...
 
bool OIIO_API icontains (string_view a, string_view b)
 
void OIIO_API to_lower (std::string &a)
 
void OIIO_API to_upper (std::string &a)
 
std::string lower (string_view a)
 Return an all-upper case version of a (locale-independent). More...
 
std::string upper (string_view a)
 Return an all-upper case version of a (locale-independent). More...
 
string_view OIIO_API strip (string_view str, string_view chars=string_view())
 
string_view OIIO_API lstrip (string_view str, string_view chars=string_view())
 
string_view OIIO_API rstrip (string_view str, string_view chars=string_view())
 
void OIIO_API split (string_view str, std::vector< string_view > &result, string_view sep=string_view(), int maxsplit=-1)
 
void OIIO_API split (string_view str, std::vector< std::string > &result, string_view sep=string_view(), int maxsplit=-1)
 
OIIO_API std::vector< std::stringsplits (string_view str, string_view sep="", int maxsplit=-1)
 
OIIO_API std::vector< string_viewsplitsv (string_view str, string_view sep="", int maxsplit=-1)
 
template<class Sequence >
std::string join (const Sequence &seq, string_view sep="")
 
template<class Sequence >
std::string join (const Sequence &seq, string_view sep, size_t len)
 
std::string OIIO_API concat (string_view s, string_view t)
 
std::string OIIO_API repeat (string_view str, int n)
 Repeat a string formed by concatenating str n times. More...
 
std::string OIIO_API replace (string_view str, string_view pattern, string_view replacement, bool global=false)
 
float OIIO_API strtof (const char *nptr, char **endptr=nullptr) noexcept
 
double OIIO_API strtod (const char *nptr, char **endptr=nullptr) noexcept
 
OIIO_API int stoi (string_view s, size_t *pos=0, int base=10)
 
unsigned int stoui (string_view s, size_t *pos=0, int base=10)
 
OIIO_API float stof (string_view s, size_t *pos=0)
 
OIIO_API float stof (const std::string &s, size_t *pos=0)
 
OIIO_API float stof (const char *s, size_t *pos=0)
 
OIIO_API double stod (string_view s, size_t *pos=0)
 
OIIO_API double stod (const std::string &s, size_t *pos=0)
 
OIIO_API double stod (const char *s, size_t *pos=0)
 
OIIO_API bool string_is_int (string_view s)
 
OIIO_API bool string_is_float (string_view s)
 
template<typename T >
from_string (string_view s)
 
template<>
int from_string< int > (string_view s)
 
template<>
unsigned int from_string< unsigned int > (string_view s)
 
template<>
float from_string< float > (string_view s)
 
template<typename T >
std::string to_string (const T &value)
 
std::string to_string (const std::string &value)
 
std::string to_string (string_view value)
 
std::string to_string (const char *value)
 
template<typename T >
bool string_is (string_view)
 
template<>
bool string_is< int > (string_view s)
 
template<>
bool string_is< float > (string_view s)
 
template<class T , class Allocator >
int extract_from_list_string (std::vector< T, Allocator > &vals, string_view list, string_view sep=",")
 
template<class T >
std::vector< T > extract_from_list_string (string_view list, size_t nvals=0, T val=T(), string_view sep=",")
 
OIIO_API char * safe_strcpy (char *dst, string_view src, size_t size) noexcept
 
void OIIO_API skip_whitespace (string_view &str) noexcept
 
void OIIO_API remove_trailing_whitespace (string_view &str) noexcept
 
void trim_whitespace (string_view &str) noexcept
 
bool OIIO_API parse_char (string_view &str, char c, bool skip_whitespace=true, bool eat=true) noexcept
 
bool OIIO_API parse_until_char (string_view &str, char c, bool eat=true) noexcept
 
bool OIIO_API parse_prefix (string_view &str, string_view prefix, bool eat=true) noexcept
 
bool OIIO_API parse_int (string_view &str, int &val, bool eat=true) noexcept
 
bool OIIO_API parse_float (string_view &str, float &val, bool eat=true) noexcept
 
bool OIIO_API parse_string (string_view &str, string_view &val, bool eat=true, QuoteBehavior keep_quotes=DeleteQuotes) noexcept
 
string_view OIIO_API parse_word (string_view &str, bool eat=true) noexcept
 
string_view OIIO_API parse_identifier (string_view &str, bool eat=true) noexcept
 
string_view OIIO_API parse_identifier (string_view &str, string_view allowed, bool eat=true) noexcept
 
bool OIIO_API parse_identifier_if (string_view &str, string_view id, bool eat=true) noexcept
 
string_view OIIO_API parse_until (string_view &str, string_view sep=" \t\r\n", bool eat=true) noexcept
 
string_view OIIO_API parse_while (string_view &str, string_view set, bool eat=true) noexcept
 
string_view OIIO_API parse_nested (string_view &str, bool eat=true) noexcept
 
OIIO_API std::string excise_string_after_head (std::string &str, string_view head)
 
void OIIO_API utf8_to_unicode (string_view str, std::vector< uint32_t > &uvec)
 
std::string OIIO_API base64_encode (string_view str)
 
float stof (ustring s)
 
template<>
std::string to_string (const ustring &value)
 

Detailed Description

String-related utilities.

Enumeration Type Documentation

Enumerator
DeleteQuotes 
KeepQuotes 

Definition at line 788 of file strutil.h.

Function Documentation

std::string OIIO_API Strutil::base64_encode ( string_view  str)

Encode the string in base64. https://en.wikipedia.org/wiki/Base64

std::string OIIO_API Strutil::concat ( string_view  s,
string_view  t 
)

Concatenate two strings, returning a std::string, implemented carefully to not perform any redundant copies or allocations. This is semantically equivalent to Strutil::sprintf("%s%s", s, t), but is more efficient.

bool OIIO_API Strutil::contains ( string_view  a,
string_view  b 
)

Does 'a' contain the string 'b' within it?

bool OIIO_API Strutil::ends_with ( string_view  a,
string_view  b 
)

Does 'a' end with the string 'b', with a case-sensitive comparison?

std::string OIIO_API Strutil::escape_chars ( string_view  unescaped)

Take a string that may have embedded newlines, tabs, etc., and turn those characters into escape sequences like \n, \t, \v, \b, \r, \f, \a, \\, \".

OIIO_API std::string Strutil::excise_string_after_head ( std::string str,
string_view  head 
)

Look within str for the pattern: head nonwhitespace_chars whitespace Remove that full pattern from str and return the nonwhitespace part that followed the head (or return the empty string and leave str unmodified, if the head was never found).

template<class T , class Allocator >
int Strutil::extract_from_list_string ( std::vector< T, Allocator > &  vals,
string_view  list,
string_view  sep = "," 
)

Given a string containing values separated by a comma (or optionally another separator), extract the individual values, placing them into vals[] which is presumed to already contain defaults. If only a single value was in the list, replace all elements of vals[] with the value. Otherwise, replace them in the same order. A missing value will simply not be replaced. Return the number of values found in the list (including blank or malformed ones). If the vals vector was empty initially, grow it as necessary.

For example, if T=float, suppose initially, vals[] = {0, 1, 2}, then "3.14" results in vals[] = {3.14, 3.14, 3.14} "3.14,,-2.0" results in vals[] = {3.14, 1, -2.0}

This can work for type T = int, float, or any type for that has an explicit constructor from a std::string.

Definition at line 584 of file strutil.h.

template<class T >
std::vector<T> Strutil::extract_from_list_string ( string_view  list,
size_t  nvals = 0,
val = T(),
string_view  sep = "," 
)

Given a string containing values separated by a comma (or optionally another separator), extract the individual values, returning them as a std::vector<T>. The vector will be initialized with nvals elements with default value val. If only a single value was in the list, replace all elements of vals[] with the value. Otherwise, replace them in the same order. A missing value will simply not be replaced and will retain the initialized default value. If the string contains more then nvals values, they will append to grow the vector.

For example, if T=float, extract_from_list_string ("", 3, 42.0f) –> {42.0, 42.0, 42.0} extract_from_list_string ("3.14", 3, 42.0f) –> {3.14, 3.14, 3.14} extract_from_list_string ("3.14,,-2.0", 3, 42.0f) –> {3.14, 42.0, -2.0} extract_from_list_string ("1,2,3,4", 3, 42.0f) –> {1.0, 2.0, 3.0, 4.0}

This can work for type T = int, float, or any type for that has an explicit constructor from a std::string.

Definition at line 632 of file strutil.h.

template<typename... Args>
void Strutil::fprintf ( FILE *  file,
const char *  fmt,
const Args &...  args 
)
inline

Definition at line 169 of file strutil.h.

template<typename... Args>
void Strutil::fprintf ( std::ostream &  file,
const char *  fmt,
const Args &...  args 
)
inline

Definition at line 175 of file strutil.h.

template<typename T >
T Strutil::from_string ( string_view  s)
inline

Definition at line 515 of file strutil.h.

template<>
float Strutil::from_string< float > ( string_view  s)
inline

Definition at line 528 of file strutil.h.

template<>
int Strutil::from_string< int > ( string_view  s)
inline

Definition at line 519 of file strutil.h.

template<>
unsigned int Strutil::from_string< unsigned int > ( string_view  s)
inline

Definition at line 523 of file strutil.h.

bool OIIO_API Strutil::get_rest_arguments ( const std::string str,
std::string base,
std::map< std::string, std::string > &  result 
)

Get a map with RESTful arguments extracted from the given string 'str'. Add it into the 'result' argument (Warning: the 'result' argument may be changed even if 'get_rest_arguments ()' return an error!). Return true on success, false on error. Acceptable forms:

  • text?arg1=val1&arg2=val2...
  • ?arg1=val1&arg2=val2... Everything before question mark will be saved into the 'base' argument.
bool OIIO_API Strutil::icontains ( string_view  a,
string_view  b 
)

Does 'a' contain the string 'b' within it, using a case-insensitive comparison?

bool OIIO_API Strutil::iends_with ( string_view  a,
string_view  b 
)

Does 'a' end with the string 'b', with a case-insensitive comparison? For speed, this always uses a static locale that doesn't require a mutex.

bool OIIO_API Strutil::iequals ( string_view  a,
string_view  b 
)

Case-insensitive comparison of strings. For speed, this always uses a static locale that doesn't require a mutex.

bool OIIO_API Strutil::iless ( string_view  a,
string_view  b 
)

Case-insensitive ordered comparison of strings. For speed, this always uses a static locale that doesn't require a mutex.

bool OIIO_API Strutil::istarts_with ( string_view  a,
string_view  b 
)

Does 'a' start with the string 'b', with a case-insensitive comparison? For speed, this always uses a static locale that doesn't require a mutex.

template<class Sequence >
std::string Strutil::join ( const Sequence &  seq,
string_view  sep = "" 
)

Join all the strings in 'seq' into one big string, separated by the 'sep' string. The Sequence can be any iterable collection of items that are able to convert to string via stream output. Examples include: std::vector<string_view>, std::vector<std::string>, std::set<ustring>, std::vector<int>, etc.

Definition at line 400 of file strutil.h.

template<class Sequence >
std::string Strutil::join ( const Sequence &  seq,
string_view  sep,
size_t  len 
)

Join all the strings in 'seq' into one big string, separated by the 'sep' string. The Sequence can be any iterable collection of items that are able to convert to string via stream output. Examples include: std::vector<string_view>, std::vector<std::string>, std::set<ustring>, std::vector<int>, etc. Values will be rendered into the string in a locale-independent manner (i.e., '.' for decimal in floats). If the optional len is nonzero, exactly that number of elements will be output (truncating or default-value-padding the sequence).

Definition at line 423 of file strutil.h.

std::string Strutil::lower ( string_view  a)
inline

Return an all-upper case version of a (locale-independent).

Definition at line 342 of file strutil.h.

string_view OIIO_API Strutil::lstrip ( string_view  str,
string_view  chars = string_view() 
)

Return a reference to the section of str that has all consecutive characters in chars removed from the beginning (left side). If chars is empty, it will be interpreted as " \t\n\r\f\v" (whitespace).

std::string OIIO_API Strutil::memformat ( long long  bytes,
int  digits = 1 
)

Return a string expressing a number of bytes, in human readable form.

  • memformat(153) -> "153 B"
  • memformat(15300) -> "14.9 KB"
  • memformat(15300000) -> "14.6 MB"
  • memformat(15300000000LL) -> "14.2 GB"
bool OIIO_API Strutil::parse_char ( string_view str,
char  c,
bool  skip_whitespace = true,
bool  eat = true 
)
noexcept

If str's first character is c (or first non-whitespace char is c, if skip_whitespace is true), return true and additionally modify str to skip over that first character if eat is also true. Otherwise, if str does not begin with character c, return false and don't modify str.

bool OIIO_API Strutil::parse_float ( string_view str,
float &  val,
bool  eat = true 
)
noexcept

If str's first non-whitespace characters form a valid float, return true, place the float's value in val, and additionally modify str to skip over the parsed float if eat is also true. Otherwise, if no float is found at the beginning of str, return false and don't modify val or str.

string_view OIIO_API Strutil::parse_identifier ( string_view str,
bool  eat = true 
)
noexcept

If str's first non-whitespace characters form a valid C-like identifier, return the identifier, and additionally modify str to skip over the parsed identifier if eat is also true. Otherwise, if no identifier is found at the beginning of str, return an empty string_view and don't modify str.

string_view OIIO_API Strutil::parse_identifier ( string_view str,
string_view  allowed,
bool  eat = true 
)
noexcept

If str's first non-whitespace characters form a valid C-like identifier, return the identifier, and additionally modify str to skip over the parsed identifier if eat is also true. Otherwise, if no identifier is found at the beginning of str, return an empty string_view and don't modify str. The 'allowed' parameter may specify a additional characters accepted that would not ordinarily be allowed in C identifiers, for example, parse_identifier (blah, "$:") would allow "identifiers" containing dollar signs and colons as well as the usual alphanumeric and underscore characters.

bool OIIO_API Strutil::parse_identifier_if ( string_view str,
string_view  id,
bool  eat = true 
)
noexcept

If the C-like identifier at the head of str exactly matches id, return true, and also advance str if eat is true. If it is not a match for id, return false and do not alter str.

bool OIIO_API Strutil::parse_int ( string_view str,
int val,
bool  eat = true 
)
noexcept

If str's first non-whitespace characters form a valid integer, return true, place the integer's value in val, and additionally modify str to skip over the parsed integer if eat is also true. Otherwise, if no integer is found at the beginning of str, return false and don't modify val or str.

string_view OIIO_API Strutil::parse_nested ( string_view str,
bool  eat = true 
)
noexcept

Assuming the string str starts with either '(', '[', or '{', return the head, up to and including the corresponding closing character (')', ']', or '}', respectively), recognizing nesting structures. For example, parse_nested("(a(b)c)d") should return "(a(b)c)", NOT "(a(b)". Return an empty string if str doesn't start with one of those characters, or doesn't contain a correctly matching nested pair. If eat==true, str will be modified to trim off the part of the string that is returned as the match.

bool OIIO_API Strutil::parse_prefix ( string_view str,
string_view  prefix,
bool  eat = true 
)
noexcept

If str's first non-whitespace characters are the prefix, return true and additionally modify str to skip over that prefix if eat is also true. Otherwise, if str doesn't start with optional whitespace and the prefix, return false and don't modify str.

bool OIIO_API Strutil::parse_string ( string_view str,
string_view val,
bool  eat = true,
QuoteBehavior  keep_quotes = DeleteQuotes 
)
noexcept

If str's first non-whitespace characters form a valid string (either a single word separated by whitespace or anything inside a double-quoted ("") or single-quoted ('') string, return true, place the string's value (not including surrounding double quotes) in val, and additionally modify str to skip over the parsed string if eat is also true. Otherwise, if no string is found at the beginning of str, return false and don't modify val or str. If keep_quotes is true, the surrounding double quotes (if present) will be kept in val.

string_view OIIO_API Strutil::parse_until ( string_view str,
string_view  sep = " \t\r\n",
bool  eat = true 
)
noexcept

Return the characters until any character in sep is found, storing it in str, and additionally modify str to skip over the parsed section if eat is also true. Otherwise, if no word is found at the beginning of str, return an empty string_view and don't modify str.

bool OIIO_API Strutil::parse_until_char ( string_view str,
char  c,
bool  eat = true 
)
noexcept

Modify str to trim all characters up to (but not including) the first occurrence of c, and return true if c was found or false if the whole string was trimmed without ever finding c. But if eat is false, then don't modify str, just return true if any c is found, false if no c is found.

string_view OIIO_API Strutil::parse_while ( string_view str,
string_view  set,
bool  eat = true 
)
noexcept

Return the characters at the head of the string that match any in set, and additionally modify str to skip over the parsed section if eat is also true. Otherwise, if no set characters are found at the beginning of str, return an empty string_view and don't modify str.

string_view OIIO_API Strutil::parse_word ( string_view str,
bool  eat = true 
)
noexcept

Return the first "word" (set of contiguous alphabetical characters) in str, and additionally modify str to skip over the parsed word if eat is also true. Otherwise, if no word is found at the beginning of str, return an empty string_view and don't modify str.

template<typename... Args>
void Strutil::print ( const char *  fmt,
const Args &...  args 
)
inline

Strutil::print (fmt, ...) Strutil::print (FILE*, fmt, ...) Strutil::print (ostream& fmt, ...)

Output formatted strings to stdout, a FILE*, or a stream, respectively. All use "Python-like" formatting description (as {fmt} does, and some day, std::format), are type-safe, are thread-safe (the outputs are "atomic", at least versus other calls to Strutil::*printf), and automatically flush their outputs. They are all locale-independent by default (use {:n} for locale-aware formatting).

Definition at line 194 of file strutil.h.

template<typename... Args>
void Strutil::print ( FILE *  file,
const char *  fmt,
const Args &...  args 
)
inline

Definition at line 200 of file strutil.h.

template<typename... Args>
void Strutil::print ( std::ostream &  file,
const char *  fmt,
const Args &...  args 
)
inline

Definition at line 206 of file strutil.h.

template<typename... Args>
void Strutil::printf ( const char *  fmt,
const Args &...  args 
)
inline

Strutil::print (fmt, ...) Strutil::fprint (FILE*, fmt, ...) Strutil::fprint (ostream& fmt, ...)

Output formatted strings to stdout, a FILE*, or a stream, respectively. All use printf-like formatting rules, are type-safe, are thread-safe (the outputs are "atomic", at least versus other calls to Strutil::*printf), and automatically flush their outputs. They are all locale-independent (forcing classic "C" locale).

Definition at line 163 of file strutil.h.

void OIIO_API Strutil::remove_trailing_whitespace ( string_view str)
noexcept

Modify str to trim any trailing whitespace (space, tab, linefeed, cr) from the back.

std::string OIIO_API Strutil::repeat ( string_view  str,
int  n 
)

Repeat a string formed by concatenating str n times.

std::string OIIO_API Strutil::replace ( string_view  str,
string_view  pattern,
string_view  replacement,
bool  global = false 
)

Replace a pattern inside a string and return the result. If global is true, replace all instances of the pattern, otherwise just the first.

string_view OIIO_API Strutil::rstrip ( string_view  str,
string_view  chars = string_view() 
)

Return a reference to the section of str that has all consecutive characters in chars removed from the ending (right side). If chars is empty, it will be interpreted as " \t\n\r\f\v" (whitespace).

OIIO_API char* Strutil::safe_strcpy ( char *  dst,
string_view  src,
size_t  size 
)
noexcept

Copy at most size characters (including terminating 0 character) from src into dst[], filling any remaining characters with 0 values. Returns dst. Note that this behavior is identical to strncpy, except that it guarantees that there will be a termining 0 character.

void OIIO_API Strutil::skip_whitespace ( string_view str)
noexcept

Modify str to trim any leading whitespace (space, tab, linefeed, cr) from the front.

void OIIO_API Strutil::split ( string_view  str,
std::vector< string_view > &  result,
string_view  sep = string_view(),
int  maxsplit = -1 
)

Fills the "result" list with the words in the string, using sep as the delimiter string. If maxsplit is > -1, at most maxsplit splits are done. If sep is "", any whitespace string is a separator. If the source str is empty, there will be zero pieces.

void OIIO_API Strutil::split ( string_view  str,
std::vector< std::string > &  result,
string_view  sep = string_view(),
int  maxsplit = -1 
)
OIIO_API std::vector<std::string> Strutil::splits ( string_view  str,
string_view  sep = "",
int  maxsplit = -1 
)

Split the contents of str using sep as the delimiter string. If sep is "", any whitespace string is a separator. If maxsplit > -1, at most maxsplit split fragments will be produced (for example, maxsplit=2 will split at only the first separator, yielding at most two fragments). The result is returned as a vector of std::string (for splits()) or a vector of string_view (for splitsv()). If the source str is empty, there will be zero pieces.

Examples:
RAY/RAY_DemoMountain.C, and RAY/RAY_DemoMountain.h.
OIIO_API std::vector<string_view> Strutil::splitsv ( string_view  str,
string_view  sep = "",
int  maxsplit = -1 
)
template<typename... Args>
std::string Strutil::sprintf ( const char *  fmt,
const Args &...  args 
)
inline

Construct a std::string in a printf-like fashion. For example:

std::string s = Strutil::sprintf ("blah %d %g", (int)foo, (float)bar);

Uses the fmt library underneath, so it's fully type-safe, and works with any types that understand stream output via '<<'. The formatting of the string will always use the classic "C" locale conventions (in particular, '.' as decimal separator for float values).

Definition at line 90 of file strutil.h.

bool OIIO_API Strutil::starts_with ( string_view  a,
string_view  b 
)

Does 'a' start with the string 'b', with a case-sensitive comparison?

OIIO_API double Strutil::stod ( string_view  s,
size_t *  pos = 0 
)
OIIO_API double Strutil::stod ( const std::string s,
size_t *  pos = 0 
)
OIIO_API double Strutil::stod ( const char *  s,
size_t *  pos = 0 
)
OIIO_API float Strutil::stof ( string_view  s,
size_t *  pos = 0 
)

stof() returns the float conversion of text from several string types. No exceptions or errors – parsing errors just return 0.0. These always use '.' for the decimal mark (versus atof and std::strtof, which are locale-dependent).

OIIO_API float Strutil::stof ( const std::string s,
size_t *  pos = 0 
)
OIIO_API float Strutil::stof ( const char *  s,
size_t *  pos = 0 
)
float Strutil::stof ( ustring  s)
inline

Definition at line 808 of file ustring.h.

OIIO_API int Strutil::stoi ( string_view  s,
size_t *  pos = 0,
int  base = 10 
)
unsigned int Strutil::stoui ( string_view  s,
size_t *  pos = 0,
int  base = 10 
)
inline

Definition at line 477 of file strutil.h.

OIIO_CONSTEXPR14 size_t Strutil::strhash ( size_t  len,
const char *  s 
)
inline

Our favorite "string" hash of a length of bytes. Currently, it is just a wrapper for an inlined, constexpr (if C++ >= 14), Cuda-safe farmhash.

Definition at line 285 of file strutil.h.

OIIO_CONSTEXPR14 size_t Strutil::strhash ( string_view  s)
inline

Hash a string_view. This is OIIO's default favorite string hasher. Currently, it uses farmhash, is constexpr (for C++14), and works in Cuda. This is rigged, though, so that empty strings hash always hash to 0 (that isn't would a raw farmhash would give you, but it's a useful property, especially for trivial initialization).

Definition at line 297 of file strutil.h.

template<typename T >
bool Strutil::string_is ( string_view  )
inline

Definition at line 552 of file strutil.h.

template<>
bool Strutil::string_is< float > ( string_view  s)
inline

Definition at line 561 of file strutil.h.

template<>
bool Strutil::string_is< int > ( string_view  s)
inline

Definition at line 556 of file strutil.h.

OIIO_API bool Strutil::string_is_float ( string_view  s)

Return true if the string is exactly (other than leading or trailing whitespace) a valid float. This operations in a locale-independent manner, i.e., it assumes '.' as the decimal mark.

OIIO_API bool Strutil::string_is_int ( string_view  s)

Return true if the string is exactly (other than leading and trailing whitespace) a valid int.

string_view OIIO_API Strutil::strip ( string_view  str,
string_view  chars = string_view() 
)

Return a reference to the section of str that has all consecutive characters in chars removed from the beginning and ending. If chars is empty, it will be interpreted as " \t\n\r\f\v" (whitespace).

double OIIO_API Strutil::strtod ( const char *  nptr,
char **  endptr = nullptr 
)
noexcept
float OIIO_API Strutil::strtof ( const char *  nptr,
char **  endptr = nullptr 
)
noexcept

strtod/strtof equivalents that are "locale-independent", always using '.' as the decimal separator. This should be preferred for I/O and other situations where you want the same standard formatting regardless of locale.

void OIIO_API Strutil::sync_output ( FILE *  file,
string_view  str 
)

Output the string to the file/stream in a synchronized fashion, so that buffers are flushed and internal mutex is used to prevent threads from clobbering each other – output strings coming from concurrent threads may be interleaved, but each string is "atomic" and will never splice each other character-by-character.

void OIIO_API Strutil::sync_output ( std::ostream &  file,
string_view  str 
)
std::string OIIO_API Strutil::timeintervalformat ( double  secs,
int  digits = 1 
)

Return a string expressing an elapsed time, in human readable form. e.g. "0:35.2"

void OIIO_API Strutil::to_lower ( std::string a)

Convert to upper case in place, faster than std::toupper because we use a static locale that doesn't require a mutex lock.

template<typename T >
std::string Strutil::to_string ( const T &  value)
inline

Template function to convert any type to a string. The default implementation is just to use sprintf or fmt::to_string. The template can be overloaded if there is a better method for particular types.

Definition at line 538 of file strutil.h.

std::string Strutil::to_string ( const std::string value)
inline

Definition at line 543 of file strutil.h.

std::string Strutil::to_string ( string_view  value)
inline

Definition at line 544 of file strutil.h.

std::string Strutil::to_string ( const char *  value)
inline

Definition at line 545 of file strutil.h.

template<>
std::string Strutil::to_string ( const ustring value)
inline

Definition at line 815 of file ustring.h.

void OIIO_API Strutil::to_upper ( std::string a)

Convert to upper case in place, faster than std::toupper because we use a static locale that doesn't require a mutex lock.

void Strutil::trim_whitespace ( string_view str)
inlinenoexcept

Modify str to trim any whitespace (space, tab, linefeed, cr) from both the front and back.

Definition at line 749 of file strutil.h.

std::string OIIO_API Strutil::unescape_chars ( string_view  escaped)

Take a string that has embedded escape sequences (\\, \", \n, etc.) and collapse them into the 'real' characters.

std::string Strutil::upper ( string_view  a)
inline

Return an all-upper case version of a (locale-independent).

Definition at line 349 of file strutil.h.

void OIIO_API Strutil::utf8_to_unicode ( string_view  str,
std::vector< uint32_t > &  uvec 
)

Converts utf-8 string to vector of unicode codepoints. This function will not stop on invalid sequences. It will let through some invalid utf-8 sequences like: 0xfdd0-0xfdef, 0x??fffe/0x??ffff. It does not support 5-6 bytes long utf-8 sequences. Will skip trailing character if there are not enough bytes for decoding a codepoint.

N.B. Following should probably return u32string instead of taking vector, but C++11 support is not yet stabilized across compilers. We will eventually add that and deprecate this one, after everybody is caught up to C++11.

std::string OIIO_API Strutil::vformat ( const char *  fmt,
va_list  ap 
)

Return a std::string formatted like Strutil::format, but passed already as a va_list. This is not guaranteed type-safe and is not extensible like format(). Use with caution!

std::string OIIO_API Strutil::vsprintf ( const char *  fmt,
va_list  ap 
)

Return a std::string formatted from printf-like arguments – passed already as a va_list. This is not guaranteed type-safe and is not extensible like format(). Use with caution!

std::string OIIO_API Strutil::wordwrap ( string_view  src,
int  columns = 80,
int  prefix = 0,
string_view  sep = " ",
string_view  presep = "" 
)

Word-wrap string src to no more than columns width, starting with an assumed position of prefix on the first line and intending by prefix blanks before all lines other than the first.

Words may be split AT any characters in sep or immediately AFTER any characters in presep. After the break, any extra sep characters will be deleted.

By illustration, wordwrap("0 1 2 3 4 5 6 7 8", 10, 4) should return: "0 1 2\n 3 4 5\n 6 7 8"