common.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_COMMON_H
#define AJA_COMMON_H
 
#if defined(AJA_WINDOWS)
    #pragma warning(disable:4996)
    #pragma warning(disable:4800)
#endif
 
#include "ajabase/common/export.h"
#include <set>
#include <string>
#include <vector>
#include <cstdint>
 
namespace aja
{
 
static std::string WHITESPACE = " \t\n\r";
 
AJA_EXPORT bool starts_with(const std::string &str, const std::string &needle);
AJA_EXPORT bool starts_with(const std::string &str, const char needle);
AJA_EXPORT bool starts_with(const std::wstring& wstr, const std::wstring& needle);
AJA_EXPORT bool starts_with(const std::wstring& wstr, const wchar_t needle);
AJA_EXPORT bool ends_with(const std::string& str, const std::string& needle);
AJA_EXPORT bool ends_with(const std::string& str, const char needle);
AJA_EXPORT bool ends_with(const std::wstring& wstr, const std::wstring& needle);
AJA_EXPORT bool ends_with(const std::wstring& wstr, const wchar_t needle);
 
AJA_EXPORT std::string& replace(std::string& str, const std::string& from, const std::string& to);
 
// NOTE: these sto* functions are ment to be similar to the C++11 functions of the same name
//       one big difference is that these do not throw exceptions on errors and instead return
//       0 like the underlying strtol function does.
 
AJA_EXPORT int stoi(const std::string& str, std::size_t* idx=0, int base = 10);
 
AJA_EXPORT long stol(const std::string& str, std::size_t* idx=0, int base = 10);
 
//AJA_EXPORT long long stoll(const std::string& str, std::size_t* idx=0, int base = 10);
 
AJA_EXPORT unsigned long stoul(const std::string& str, std::size_t* idx=0, int base = 10);
 
AJA_EXPORT unsigned long long stoull(const std::string& str, std::size_t* idx=0, int base = 10);
 
AJA_EXPORT float stof(const std::string& str, std::size_t* idx=0);
 
AJA_EXPORT double stod(const std::string& str, std::size_t* idx=0);
 
AJA_EXPORT long double stold(const std::string& str, std::size_t* idx=0);
 
AJA_EXPORT std::string to_string(bool val);
AJA_EXPORT std::string to_string(int val);
AJA_EXPORT std::string to_string(long val);
AJA_EXPORT std::string to_string(long long val);
AJA_EXPORT std::string to_string(unsigned val);
AJA_EXPORT std::string to_string(unsigned long val);
AJA_EXPORT std::string to_string(unsigned long long val);
AJA_EXPORT std::string to_string(float val);
AJA_EXPORT std::string to_string(double val);
AJA_EXPORT std::string to_string(long double val);
 
AJA_EXPORT bool string_to_wstring(const std::string& str, std::wstring& wstr);
 
AJA_EXPORT bool wstring_to_string(const std::wstring& wstr, std::string& str);
 
AJA_EXPORT bool string_to_cstring (const std::string & str, char * c_str, size_t c_str_size);
 
AJA_EXPORT void split (const std::string & str, const char delim, std::vector<std::string> & elems);
 
AJA_EXPORT void split (const std::wstring & str, const wchar_t delim, std::vector<std::wstring> & elems);
 
AJA_EXPORT std::vector<std::string> split (const std::string & str, const char delim);
 
AJA_EXPORT std::vector<std::wstring> split (const std::wstring & str, const wchar_t delim);
 
AJA_EXPORT std::vector<std::string> split (const std::string & inStr, const std::string & inDelim);
 
AJA_EXPORT std::vector<std::wstring> split (const std::wstring & inStr, const std::wstring & inDelim);
 
AJA_EXPORT std::string & lower (std::string & str);
 
AJA_EXPORT std::string & upper (std::string & str);
 
AJA_EXPORT std::string & lstrip (std::string & str, const std::string & ws = aja::WHITESPACE);
 
AJA_EXPORT std::string & rstrip (std::string & str, const std::string & ws = aja::WHITESPACE);
 
AJA_EXPORT std::string & strip (std::string & str, const std::string & ws = aja::WHITESPACE);
 
AJA_EXPORT std::string join (const std::vector<std::string> & parts, const std::string & delim=" ");
 
AJA_EXPORT std::string join (const std::set<std::string> & parts, const std::string & delim=" ");
 
AJA_EXPORT char* safer_strncpy(char* target, const char* source, size_t num, size_t maxSize);
 
AJA_EXPORT bool is_hex_digit(const char inChr); //  New in SDK 17.1
 
AJA_EXPORT bool is_decimal_digit (const char inChr);    //  New in SDK 17.1
 
AJA_EXPORT bool is_alpha_numeric (const char inChr);    //  New in SDK 17.1
 
AJA_EXPORT bool is_legal_decimal_number (const std::string & inStr, const size_t inMaxLength = 2);  //  New in SDK 17.1
 
AJA_EXPORT uint64_t is_legal_hex_serial_number (const std::string & inStr); //  New in SDK 17.1
 
AJA_EXPORT bool is_alpha_numeric (const std::string & inStr);   //  New in SDK 17.1
} //end aja namespace
 
#endif  //  AJA_COMMON_H