Utils.h

Go to the documentation of this file.

/***************************************************************************
                Utils.h  -  some commonly used utility functions
                             -------------------
    begin                : Sun Mar 27 2011
    copyright            : (C) 2011 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef KWAVE_UTILS_H
#define KWAVE_UTILS_H

#include "config.h"

#include <limits>

#include <QString>
#include <QtGlobal>

#include "libkwave/Sample.h" // for sample_index_t

namespace Kwave
{

    void Q_DECL_EXPORT yield();

    QString Q_DECL_EXPORT zoom2string(double percent);

    QString Q_DECL_EXPORT ms2string(double ms, int precision = 6);

    QString Q_DECL_EXPORT samples2string(sample_index_t samples);

    QString Q_DECL_EXPORT ms2hms(double ms);

    QString Q_DECL_EXPORT string2date(const QString &s);

    template<class T> T round_up(T x, const T s)
    {
        T modulo = (x % s);
        if (modulo) x += (s - modulo);
        return x;
    }

    template <typename T> unsigned int toUint(T x)
    {
        const unsigned int max = std::numeric_limits<unsigned int>::max();
        Q_ASSERT(x >= 0);
        Q_ASSERT(static_cast<quint64>(x) <= static_cast<quint64>(max));

        if (x <= 0) return 0;
        if (static_cast<quint64>(x) > static_cast<quint64>(max)) return max;

        return static_cast<unsigned int>(x);
    }

    template <typename T> int toInt(T x)
    {
        const int min = std::numeric_limits<int>::min();
        const int max = std::numeric_limits<int>::max();
        Q_ASSERT(static_cast<qint64>(x) >= static_cast<qint64>(min));
        Q_ASSERT(static_cast<qint64>(x) <= static_cast<qint64>(max));

        if (static_cast<qint64>(x) < static_cast<qint64>(min)) return min;
        if (static_cast<qint64>(x) > static_cast<qint64>(max)) return max;

        return static_cast<int>(x);
    }

    QString Q_DECL_EXPORT urlScheme();

}

#endif /* KWAVE_UTILS_H */

//***************************************************************************
//***************************************************************************