Common/MVKStrings.h

/*
 * MVKStrings.h
 *
 * Copyright (c) 2015-2024 The Brenwill Workshop Ltd. (http://www.brenwill.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __MVKStrings_h_
#define __MVKStrings_h_ 1

#include <string>
#include <streambuf>
#include <vector>
#include <cxxabi.h>

namespace mvk {

#pragma mark -
#pragma mark Strings

    static std::string _mvkDefaultWhitespaceChars = " \f\n\r\t\v";

    /** Returns a string with whitespace trimmed from the right end of the specified string. */
    inline std::string trim_right(const std::string& s, const std::string& delimiters = _mvkDefaultWhitespaceChars) {
        size_t endPos = s.find_last_not_of(delimiters);
        return (endPos != std::string::npos) ? s.substr(0, endPos + 1) : "";
    }

    /** Returns a string with whitespace trimmed from the left end of the specified string. */
    inline std::string trim_left(const std::string& s, const std::string& delimiters = _mvkDefaultWhitespaceChars) {
        size_t startPos = s.find_first_not_of(delimiters);
        return (startPos != std::string::npos) ? s.substr(startPos) : "";
    }

    /** Returns a string with whitespace trimmed from both ends of the specified string. */
    inline std::string trim(const std::string& s, const std::string& delimiters = _mvkDefaultWhitespaceChars) {
        size_t startPos = s.find_first_not_of(delimiters);
        size_t endPos = s.find_last_not_of(delimiters);
        return ( (startPos != std::string::npos) && (endPos != std::string::npos) ) ? s.substr(startPos, endPos + 1) : "";
    }

	/** Cleanse variable name by replacing any illegal chars and leading digit with underscores. */
	inline std::string cleanseVarName(const std::string& name) {
		std::string varName(name);
		size_t cCnt = varName.length();
		for (size_t cIdx = 0; cIdx < cCnt; cIdx++) {
			char& c = varName[cIdx];
			if ( !(c == '_' || isalpha(c) || (isdigit(c) && cIdx > 0)) ) { c = '_'; }
		}
		return varName;
	}

	/** Returns a string containing the ordinal suffix for a numeric value.*/
	inline const char* getOrdinalSuffix(int64_t val) {
		static const char* suffixes[] = {"th", "st", "nd", "rd"};
		auto ord = val % 100;
		if (ord > 10 && ord < 20) { return suffixes[0]; }	// All teens end in th.
		ord = ord % 10;
		if (ord > 3) { return suffixes[0]; }	// 4-9 end in th.
		return suffixes[ord];
	}

	/** Returns the name of a C++ type. */
	template<typename T>
	inline std::string getTypeName(const T* pObj) {
		int status;
		char* demangledName = abi::__cxa_demangle(typeid(*pObj).name(), 0, 0, &status);
		std::string tName = demangledName;
		free(demangledName);
		return tName;
	}


#pragma mark -
#pragma mark Streams

	/** A memory-based stream buffer. */
	class membuf : public std::streambuf {
	public:
		membuf(char* p, size_t n) {
			setg(p, p, p + n);
			setp(p, p + n);
		}
	};

	/** A character counting stream buffer. */
	class countbuf : public std::streambuf {
	public:
		size_t buffSize = 0;
	private:
		std::streamsize xsputn (const char* /* s */, std::streamsize n) override {
			buffSize += n;
			return n;
		}
	};

	/** A stream buffer underpinned by a vector<char>. */
	class charvectorbuf : public std::streambuf {
	public:
		charvectorbuf(std::vector<char>* pVec) : _pVec(pVec) {}
	private:
		std::streamsize xsputn (const char* s, std::streamsize n) override {
			_pVec->insert(_pVec->end(), s, s + n);
			return n;
		}

		std::vector<char>* _pVec;
	};

}

#endif