Utilities.h

Go to the documentation of this file.

 
#pragma once
 
//
// MARK: General texts
//
 
#define ERR_ASSERT              "ASSERT FAILED: %s"
#define ERR_EXCEPTION           "EXCEPTION CAUGHT: %s"
 
//
// MARK: Misc
//
 
float GetMiscNetwTime ();
 
bool CheckEverySoOften (float& _lastCheck, float _interval, float _now);
 
inline bool CheckEverySoOften (float& _lastCheck, float _interval)
{ return CheckEverySoOften(_lastCheck, _interval, GetMiscNetwTime()); }
 
std::string GetPluginName (XPLMPluginID who);
 
std::istream& safeGetline(std::istream& is, std::string& t);
 
inline double WeatherAltCorr_ft (double pressureAlt_ft, double hPa)
{ return pressureAlt_ft + ((hPa - HPA_STANDARD) * FT_per_HPA); }
 
float HeadDiff (float from, float to);
 
float RpmToAngle (float angle, float rpm, float s);
 
template<typename T>
inline T NZ (T v)
{ return std::isnan(v) ? T(0) : v; }
 
//
// MARK: String functions
//
 
std::string str_n (const char* s, size_t max);
 
#define STR_N(s) str_n(s,sizeof(s))
 
std::vector<std::string> str_tokenize (const std::string& s,
                                       const std::string& tokens,
                                       bool bSkipEmpty = true);
 
class StrTokens {
protected:
    const std::string& s;               
    std::string sep;                    
    size_t p = std::string::npos;       
    int num = 0;                        
public:
    StrTokens (const std::string& _s, const std::string& _sep) : s(_s), sep(_sep) {}
    std::string next();
    std::string next(const std::string& _sep) { sep = _sep; return next(); }
    int count() const { return num; }
    bool finished () const { return p != std::string::npos && p >= s.length(); }
};
 
std::pair<std::string,std::string> str_split (const std::string& s,
                                              const std::string& tokens);
 
//
// MARK: Logging Support
//
 
#if defined(__clang__) || defined(__GNUC__)
#define XPPLANES_FMTARGS(FMT)  __attribute__((format(printf, FMT, FMT+1)))
#else
#define XPPLANES_FMTARGS(FMT)
#endif
 
enum logLevelTy : int {
    logDEBUG = 0,       
    logINFO,            
    logWARN,            
    logERR,             
    logFATAL,           
    logMSG              
};
 
const char* LogGetString ( const char* szFile, int ln, const char* szFunc, logLevelTy lvl, const char* szMsg, va_list args );
             
void LogMsg ( const char* szFile, int ln, const char* szFunc, logLevelTy lvl, const char* szMsg, ... ) XPPLANES_FMTARGS(5);
 
//
// MARK: Logging macros
//
 
#define LOG_MSG(lvl,...)  {                                         \
    if (lvl >= glob.logLvl)                                         \
    {LogMsg(__FILE__, __LINE__, __func__, lvl, __VA_ARGS__);}       \
}
 
#define THROW_ERROR(...)                                            \
throw XPMP2::XPMP2Error(__FILE__, __LINE__, __func__, __VA_ARGS__);
 
#define LOG_ASSERT(cond)                                            \
    if (!(cond)) {                                                  \
        THROW_ERROR(ERR_ASSERT,#cond);                              \
    }
 
//
// MARK: Compiler differences
//
 
// XCode/Linux don't provide the _s functions, not even with __STDC_WANT_LIB_EXT1__ 1
#if APL
inline int strerror_s( char *buf, size_t bufsz, int errnum )
{ return strerror_r(errnum, buf, bufsz); }
#elif LIN
inline int strerror_s( char *buf, size_t bufsz, int errnum )
{ strerror_r(errnum, buf, bufsz); return 0; }
#endif
 
// MARK: Thread names
#ifdef DEBUG
// This might not work on older Windows version, which is why we don't publish it in release builds
#if IBM
#define SET_THREAD_NAME(sName) SetThreadDescription(GetCurrentThread(), L##sName)
#elif APL
#define SET_THREAD_NAME(sName) pthread_setname_np(sName)
#elif LIN
#define SET_THREAD_NAME(sName) pthread_setname_np(pthread_self(),sName)
#endif
#else
#define SET_THREAD_NAME(sName)
#endif