mirror of
https://github.com/djcb/mu.git
synced 2024-06-30 08:01:07 +02:00
c9e958d65c
Helper function to format strings (a-la strftime).
334 lines
8.5 KiB
C++
334 lines
8.5 KiB
C++
/*
|
|
** Copyright (C) 2020-2021 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
|
|
**
|
|
** This library is free software; you can redistribute it and/or
|
|
** modify it under the terms of the GNU Lesser General Public License
|
|
** as published by the Free Software Foundation; either version 2.1
|
|
** of the License, or (at your option) any later version.
|
|
**
|
|
** This library is distributed in the hope that it will be useful,
|
|
** but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
** Lesser General Public License for more details.
|
|
**
|
|
** You should have received a copy of the GNU Lesser General Public
|
|
** License along with this library; if not, write to the Free
|
|
** Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
|
|
** 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef __MU_UTILS_HH__
|
|
#define __MU_UTILS_HH__
|
|
|
|
#include <string>
|
|
#include <sstream>
|
|
#include <vector>
|
|
#include <chrono>
|
|
#include <cstdarg>
|
|
#include <glib.h>
|
|
#include <ostream>
|
|
#include <iostream>
|
|
#include <type_traits>
|
|
|
|
namespace Mu {
|
|
|
|
using StringVec = std::vector<std::string>;
|
|
|
|
/**
|
|
* Flatten a string -- downcase and fold diacritics etc.
|
|
*
|
|
* @param str a string
|
|
*
|
|
* @return a flattened string
|
|
*/
|
|
std::string utf8_flatten(const char* str);
|
|
inline std::string
|
|
utf8_flatten(const std::string& s)
|
|
{
|
|
return utf8_flatten(s.c_str());
|
|
}
|
|
|
|
/**
|
|
* Replace all control characters with spaces, and remove leading and trailing space.
|
|
*
|
|
* @param dirty an unclean string
|
|
*
|
|
* @return a cleaned-up string.
|
|
*/
|
|
std::string utf8_clean(const std::string& dirty);
|
|
|
|
/**
|
|
* Remove ctrl characters, replacing them with ' '; subsequent
|
|
* ctrl characters are replaced by a single ' '
|
|
*
|
|
* @param str a string
|
|
*
|
|
* @return the string without control characters
|
|
*/
|
|
std::string remove_ctrl(const std::string& str);
|
|
|
|
/**
|
|
* Split a string in parts
|
|
*
|
|
* @param str a string
|
|
* @param sepa the separator
|
|
*
|
|
* @return the parts.
|
|
*/
|
|
std::vector<std::string> split(const std::string& str, const std::string& sepa);
|
|
|
|
/**
|
|
* Quote & escape a string for " and \
|
|
*
|
|
* @param str a string
|
|
*
|
|
* @return quoted string
|
|
*/
|
|
std::string quote(const std::string& str);
|
|
|
|
/**
|
|
* Format a string, printf style
|
|
*
|
|
* @param frm format string
|
|
* @param ... parameters
|
|
*
|
|
* @return a formatted string
|
|
*/
|
|
std::string format(const char* frm, ...) __attribute__((format(printf, 1, 2)));
|
|
|
|
/**
|
|
* Format a string, printf style
|
|
*
|
|
* @param frm format string
|
|
* @param ... parameters
|
|
*
|
|
* @return a formatted string
|
|
*/
|
|
std::string vformat(const char* frm, va_list args) __attribute__((format(printf, 1, 0)));
|
|
|
|
/**
|
|
* Convert an date to the corresponding time expressed as a string with a
|
|
* 10-digit time_t
|
|
*
|
|
* @param date the date expressed a YYYYMMDDHHMMSS or any n... of the first
|
|
* characters.
|
|
* @param first whether to fill out incomplete dates to the start or the end;
|
|
* ie. either 1972 -> 197201010000 or 1972 -> 197212312359
|
|
*
|
|
* @return the corresponding time_t expressed as a string
|
|
*/
|
|
std::string date_to_time_t_string(const std::string& date, bool first);
|
|
|
|
/**
|
|
* 64-bit incarnation of time_t expressed as a 10-digit string. Uses 64-bit for the time-value,
|
|
* regardless of the size of time_t.
|
|
*
|
|
* @param t some time value
|
|
*
|
|
* @return
|
|
*/
|
|
std::string date_to_time_t_string(int64_t t);
|
|
|
|
/**
|
|
* Get a string for a given time_t and format
|
|
* memory that must be freed after use.
|
|
*
|
|
* @param frm the format of the string (in strftime(3) format)
|
|
* @param t the time as time_t
|
|
* @param utc whether to display as UTC(if true) or local time
|
|
*
|
|
* @return a string representation of the time in UTF8-format, or empty in case
|
|
* of error.
|
|
*/
|
|
std::string time_to_string(const std::string& frm, time_t t, bool utc = false) G_GNUC_CONST;
|
|
|
|
/**
|
|
* Create a std::string by consuming a gchar* array; this takes ownership
|
|
* of str which should no longer be used.
|
|
*
|
|
* @param str a gchar* or NULL (latter taken as "")
|
|
*
|
|
* @return a std::string
|
|
*/
|
|
static inline std::string
|
|
from_gchars(gchar*&& str)
|
|
{
|
|
std::string s{str ? str : ""};
|
|
g_free(str);
|
|
|
|
return s;
|
|
}
|
|
|
|
using Clock = std::chrono::steady_clock;
|
|
using Duration = Clock::duration;
|
|
|
|
template <typename Unit>
|
|
constexpr int64_t
|
|
to_unit(Duration d)
|
|
{
|
|
using namespace std::chrono;
|
|
return duration_cast<Unit>(d).count();
|
|
}
|
|
|
|
constexpr int64_t
|
|
to_s(Duration d)
|
|
{
|
|
return to_unit<std::chrono::seconds>(d);
|
|
}
|
|
constexpr int64_t
|
|
to_ms(Duration d)
|
|
{
|
|
return to_unit<std::chrono::milliseconds>(d);
|
|
}
|
|
constexpr int64_t
|
|
to_us(Duration d)
|
|
{
|
|
return to_unit<std::chrono::microseconds>(d);
|
|
}
|
|
|
|
struct StopWatch {
|
|
using Clock = std::chrono::steady_clock;
|
|
StopWatch(const std::string name) : start_{Clock::now()}, name_{name} {}
|
|
~StopWatch()
|
|
{
|
|
const auto us{to_us(Clock::now() - start_)};
|
|
if (us > 2000000)
|
|
g_debug("%s: finished after %0.1f s", name_.c_str(), us / 1000000.0);
|
|
else if (us > 2000)
|
|
g_debug("%s: finished after %0.1f ms", name_.c_str(), us / 1000.0);
|
|
else
|
|
g_debug("%s: finished after %" G_GINT64_FORMAT " us", name_.c_str(), us);
|
|
}
|
|
|
|
private:
|
|
Clock::time_point start_;
|
|
std::string name_;
|
|
};
|
|
|
|
/**
|
|
* See g_canonicalize_filename
|
|
*
|
|
* @param filename
|
|
* @param relative_to
|
|
*
|
|
* @return
|
|
*/
|
|
std::string canonicalize_filename(const std::string& path, const std::string& relative_to);
|
|
|
|
/**
|
|
* Convert a size string to a size in bytes
|
|
*
|
|
* @param sizestr the size string
|
|
* @param first
|
|
*
|
|
* @return the size expressed as a string with the decimal number of bytes
|
|
*/
|
|
std::string size_to_string(const std::string& sizestr, bool first);
|
|
|
|
/**
|
|
* Convert a size into a size in bytes string
|
|
*
|
|
* @param size the size
|
|
* @param first
|
|
*
|
|
* @return the size expressed as a string with the decimal number of bytes
|
|
*/
|
|
std::string size_to_string(int64_t size);
|
|
|
|
/**
|
|
* Convert any ostreamable<< value to a string
|
|
*
|
|
* @param t the value
|
|
*
|
|
* @return a std::string
|
|
*/
|
|
template <typename T>
|
|
static inline std::string
|
|
to_string(const T& val)
|
|
{
|
|
std::stringstream sstr;
|
|
sstr << val;
|
|
|
|
return sstr.str();
|
|
}
|
|
|
|
struct MaybeAnsi {
|
|
explicit MaybeAnsi(bool use_color) : color_{use_color} {}
|
|
|
|
enum struct Color {
|
|
Black = 30,
|
|
Red = 31,
|
|
Green = 32,
|
|
Yellow = 33,
|
|
Blue = 34,
|
|
Magenta = 35,
|
|
Cyan = 36,
|
|
White = 37,
|
|
|
|
BrightBlack = 90,
|
|
BrightRed = 91,
|
|
BrightGreen = 92,
|
|
BrightYellow = 93,
|
|
BrightBlue = 94,
|
|
BrightMagenta = 95,
|
|
BrightCyan = 96,
|
|
BrightWhite = 97,
|
|
};
|
|
|
|
std::string fg(Color c) const { return ansi(c, true); }
|
|
std::string bg(Color c) const { return ansi(c, false); }
|
|
|
|
std::string reset() const { return color_ ? "\x1b[0m" : ""; }
|
|
|
|
private:
|
|
std::string ansi(Color c, bool fg = true) const
|
|
{
|
|
return color_ ? format("\x1b[%dm", static_cast<int>(c) + (fg ? 0 : 10)) : "";
|
|
}
|
|
|
|
const bool color_;
|
|
};
|
|
|
|
/// Allow using enum structs as bitflags
|
|
#define MU_TO_NUM(ET, ELM) std::underlying_type_t<ET>(ELM)
|
|
#define MU_TO_ENUM(ET, NUM) static_cast<ET>(NUM)
|
|
#define MU_ENABLE_BITOPS(ET) \
|
|
constexpr ET operator&(ET e1, ET e2) \
|
|
{ \
|
|
return MU_TO_ENUM(ET, MU_TO_NUM(ET, e1) & MU_TO_NUM(ET, e2)); \
|
|
} \
|
|
constexpr ET operator|(ET e1, ET e2) \
|
|
{ \
|
|
return MU_TO_ENUM(ET, MU_TO_NUM(ET, e1) | MU_TO_NUM(ET, e2)); \
|
|
} \
|
|
constexpr ET operator~(ET e) { return MU_TO_ENUM(ET, ~(MU_TO_NUM(ET, e))); } \
|
|
constexpr bool any_of(ET e) { return MU_TO_NUM(ET, e) != 0; } \
|
|
constexpr bool none_of(ET e) { return MU_TO_NUM(ET, e) == 0; } \
|
|
static inline ET& operator&=(ET& e1, ET e2) { return e1 = e1 & e2; } \
|
|
static inline ET& operator|=(ET& e1, ET e2) { return e1 = e1 | e2; }
|
|
|
|
/**
|
|
* For unit tests, assert two std::string's are equal.
|
|
*
|
|
* @param s1 string1
|
|
* @param s2 string2
|
|
*/
|
|
void assert_equal(const std::string& s1, const std::string& s2);
|
|
/**
|
|
* For unit tests, assert that to containers are the same.
|
|
*
|
|
* @param c1 container1
|
|
* @param c2 container2
|
|
*/
|
|
void assert_equal(const StringVec& v1, const StringVec& v2);
|
|
|
|
/**
|
|
* For unit-tests, allow warnings in the current function.
|
|
*
|
|
*/
|
|
void allow_warnings();
|
|
|
|
} // namespace Mu
|
|
|
|
#endif /* __MU_UTILS_HH__ */
|