Files
create/src/Base/Tools.h

312 lines
8.2 KiB
C++

/***************************************************************************
* Copyright (c) 2009 Werner Mayer <wmayer[at]users.sourceforge.net> *
* *
* This file is part of the FreeCAD CAx development system. *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Library General Public *
* License as published by the Free Software Foundation; either *
* version 2 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 Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this library; see the file COPYING.LIB. If not, *
* write to the Free Software Foundation, Inc., 59 Temple Place, *
* Suite 330, Boston, MA 02111-1307, USA *
* *
***************************************************************************/
#ifndef BASE_TOOLS_H
#define BASE_TOOLS_H
#include <functional>
#include <algorithm>
#include <cmath>
#include <iostream>
#include <vector>
#include <string>
#include <boost_signals2.hpp>
#include <QString>
#include <QObject>
#if (QT_VERSION < 0x050300)
class QSignalBlocker
{
public:
QSignalBlocker(QObject *object)
: object(object)
, blocked(object && object->blockSignals(true))
, inhibited(false)
{
}
~QSignalBlocker()
{
if (object && !inhibited)
object->blockSignals(blocked);
}
void reblock()
{
if (object)
object->blockSignals(true);
inhibited = false;
}
void unblock()
{
if (object)
object->blockSignals(blocked);
inhibited = true;
}
private:
QObject *object;
bool blocked;
bool inhibited;
};
#endif
// ----------------------------------------------------------------------------
namespace Base
{
template <class T>
struct iotaGen
{
public:
T operator()() { return n++; }
iotaGen(T v) : n(v) {}
private:
T n;
};
// ----------------------------------------------------------------------------
template <class T>
class manipulator
{
T i_;
std::ostream& (*f_)(std::ostream&, T);
public:
manipulator(std::ostream& (*f)(std::ostream&, T), T i) : i_(i), f_(f)
{
}
friend std::ostream& operator<<( std::ostream& os, manipulator m)
{
return m.f_(os, m.i_);
}
};
inline std::ostream& tabsN(std::ostream& os, int n)
{
for (int i=0;i<n;i++)
os << "\t";
return os;
}
inline std::ostream& blanksN(std::ostream& os, int n)
{
for (int i=0;i<n;i++)
os << " ";
return os;
}
inline manipulator<int> tabs(int n)
{
return manipulator<int>(&tabsN, n);
}
inline manipulator<int> blanks(int n)
{
return manipulator<int>(&blanksN, n);
}
// ----------------------------------------------------------------------------
template<class T>
inline T clamp (T num, T lower, T upper)
{
return std::max<T>(std::min<T>(upper,num),lower);
}
template<class T>
inline T sgn (T t)
{
if (t == 0)
return T(0);
else
return (t > 0) ? T(1) : T(-1);
}
#ifndef M_PI
#define M_PI 3.14159265358979323846
#endif
template<class T>
inline T toRadians(T d)
{
return static_cast<T>((d*M_PI)/180.0);
}
template<class T>
inline T toDegrees(T r)
{
return static_cast<T>((r/M_PI)*180.0);
}
template<class T>
inline T fmod(T numerator, T denominator)
{
T modulo = std::fmod(numerator, denominator);
return (modulo >= T(0)) ? modulo : modulo + denominator;
}
// ----------------------------------------------------------------------------
class BaseExport StopWatch
{
public:
StopWatch();
~StopWatch();
void start();
int restart();
int elapsed();
std::string toString(int ms) const;
private:
struct Private;
Private* d;
};
// ----------------------------------------------------------------------------
template<typename Flag=bool>
struct FlagToggler {
Flag &flag;
bool toggled;
FlagToggler(Flag &_flag)
:flag(_flag),toggled(true)
{
flag = !flag;
}
FlagToggler(Flag &_flag, Flag check)
:flag(_flag),toggled(check==_flag)
{
if (toggled)
flag = !flag;
}
~FlagToggler() {
if (toggled)
flag = !flag;
}
};
// ----------------------------------------------------------------------------
template<typename Status, class Object>
class ObjectStatusLocker
{
public:
ObjectStatusLocker(Status s, Object* o, bool value = true) : status(s), obj(o)
{ old_value = obj->testStatus(status); obj->setStatus(status, value); }
~ObjectStatusLocker()
{ obj->setStatus(status, old_value); }
private:
Status status;
Object* obj;
bool old_value;
};
// ----------------------------------------------------------------------------
class StateLocker
{
public:
StateLocker(bool& flag, bool value = true) : lock(flag)
{ old_value = lock; lock = value; }
~StateLocker()
{ lock = old_value; }
private:
bool& lock;
bool old_value;
};
// ----------------------------------------------------------------------------
template<typename T>
class BitsetLocker
{
public:
BitsetLocker(T& flags, std::size_t flag, bool value = true)
: flags(flags), flag(flag)
{ oldValue = flags.test(flag); flags.set(flag,value); }
~BitsetLocker()
{ flags.set(flag,oldValue); }
private:
T &flags;
std::size_t flag;
bool oldValue;
};
// ----------------------------------------------------------------------------
class ConnectionBlocker {
typedef boost::signals2::connection Connection;
typedef boost::signals2::shared_connection_block ConnectionBlock;
ConnectionBlock blocker;
public:
ConnectionBlocker(Connection& c) : blocker(c) {
}
~ConnectionBlocker() {
}
};
// ----------------------------------------------------------------------------
struct BaseExport Tools
{
static std::string getUniqueName(const std::string&, const std::vector<std::string>&,int d=0);
static std::string addNumber(const std::string&, unsigned int, int d=0);
static std::string getIdentifier(const std::string&);
static std::wstring widen(const std::string& str);
static std::string narrow(const std::wstring& str);
static std::string escapedUnicodeFromUtf8(const char *s);
static std::string escapedUnicodeToUtf8(const std::string& s);
static QString escapeEncodeString(const QString& s);
static std::string escapeEncodeString(const std::string& s);
static QString escapeEncodeFilename(const QString& s);
static std::string escapeEncodeFilename(const std::string& s);
/**
* @brief toStdString Convert a QString into a UTF-8 encoded std::string.
* @param s String to convert.
* @return A std::string encoded as UTF-8.
*/
static inline std::string toStdString(const QString& s) { QByteArray tmp = s.toUtf8(); return std::string(tmp.constData(), tmp.size()); }
/**
* @brief fromStdString Convert a std::string encoded as UTF-8 into a QString.
* @param s std::string, expected to be UTF-8 encoded.
* @return String represented as a QString.
*/
static inline QString fromStdString(const std::string & s) { return QString::fromUtf8(s.c_str(), s.size()); }
};
} // namespace Base
#endif // BASE_TOOLS_H