mirror of https://github.com/djcb/mu.git
290 lines
7.6 KiB
C++
290 lines
7.6 KiB
C++
/*
|
|
** Copyright (C) 2017 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 <cstdarg>
|
|
#include <glib.h>
|
|
|
|
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);
|
|
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @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 format (const char *frm, va_list args) __attribute__((format(printf, 1, 0)));
|
|
|
|
|
|
/**
|
|
* Quote a string -- put in "" and escape any special characters by putting '\'
|
|
* in front of them.
|
|
*
|
|
* @param str
|
|
*
|
|
* @return
|
|
*/
|
|
std::string quoted (const std::string& str);
|
|
|
|
|
|
/**
|
|
* Convert an ISO date to the corresponding time expressed as a string
|
|
* with a 10-digit time_t
|
|
*
|
|
* @param date
|
|
* @param first
|
|
*
|
|
* @return
|
|
*/
|
|
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);
|
|
|
|
|
|
|
|
/**
|
|
* 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();
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
*
|
|
* don't repeat these catch blocks everywhere...
|
|
*
|
|
*/
|
|
|
|
#define MU_STORE_CATCH_BLOCK_RETURN(GE,R) \
|
|
catch (const MuStoreError& merr) { \
|
|
mu_util_g_set_error ((GE), \
|
|
merr.mu_error(), "%s", \
|
|
merr.what().c_str()); \
|
|
return (R); \
|
|
} \
|
|
|
|
|
|
#define MU_XAPIAN_CATCH_BLOCK \
|
|
catch (const Xapian::Error &xerr) { \
|
|
g_critical ("%s: xapian error '%s'", \
|
|
__func__, xerr.get_msg().c_str()); \
|
|
} catch (const std::runtime_error& re) { \
|
|
g_critical ("%s: error: %s", __func__, re.what()); \
|
|
} catch (...) { \
|
|
g_critical ("%s: caught exception", __func__); \
|
|
}
|
|
|
|
#define MU_XAPIAN_CATCH_BLOCK_G_ERROR(GE,E) \
|
|
catch (const Xapian::DatabaseLockError &xerr) { \
|
|
mu_util_g_set_error ((GE), \
|
|
MU_ERROR_XAPIAN_CANNOT_GET_WRITELOCK, \
|
|
"%s: xapian error '%s'", \
|
|
__func__, xerr.get_msg().c_str()); \
|
|
} catch (const Xapian::DatabaseError &xerr) { \
|
|
mu_util_g_set_error ((GE),MU_ERROR_XAPIAN, \
|
|
"%s: xapian error '%s'", \
|
|
__func__, xerr.get_msg().c_str()); \
|
|
} catch (const Xapian::Error &xerr) { \
|
|
mu_util_g_set_error ((GE),(E), \
|
|
"%s: xapian error '%s'", \
|
|
__func__, xerr.get_msg().c_str()); \
|
|
} catch (const std::runtime_error& ex) { \
|
|
mu_util_g_set_error ((GE),(MU_ERROR_INTERNAL), \
|
|
"%s: error: %s", __func__, ex.what()); \
|
|
\
|
|
} catch (...) { \
|
|
mu_util_g_set_error ((GE),(MU_ERROR_INTERNAL), \
|
|
"%s: caught exception", __func__); \
|
|
}
|
|
|
|
|
|
#define MU_XAPIAN_CATCH_BLOCK_RETURN(R) \
|
|
catch (const Xapian::Error &xerr) { \
|
|
g_critical ("%s: xapian error '%s'", \
|
|
__func__, xerr.get_msg().c_str()); \
|
|
return (R); \
|
|
} catch (const std::runtime_error& ex) { \
|
|
g_critical("%s: error: %s", __func__, ex.what()); \
|
|
return (R); \
|
|
} catch (...) { \
|
|
g_critical ("%s: caught exception", __func__); \
|
|
return (R); \
|
|
}
|
|
|
|
#define MU_XAPIAN_CATCH_BLOCK_G_ERROR_RETURN(GE,E,R) \
|
|
catch (const Xapian::Error &xerr) { \
|
|
mu_util_g_set_error ((GE),(E), \
|
|
"%s: xapian error '%s'", \
|
|
__func__, xerr.get_msg().c_str()); \
|
|
return (R); \
|
|
} catch (const std::runtime_error& ex) { \
|
|
mu_util_g_set_error ((GE),(MU_ERROR_INTERNAL), \
|
|
"%s: error: %s", __func__, ex.what()); \
|
|
return (R); \
|
|
} catch (...) { \
|
|
if ((GE)&&!(*(GE))) \
|
|
mu_util_g_set_error ((GE), \
|
|
(MU_ERROR_INTERNAL), \
|
|
"%s: caught exception", __func__); \
|
|
return (R); \
|
|
}
|
|
|
|
|
|
|
|
|
|
/// 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__ */
|