util.hpp

Go to the documentation of this file.

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * 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.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef PULSEVIEW_PV_UTIL_HPP
#define PULSEVIEW_PV_UTIL_HPP

#include <cmath>
#include <string>
#include <vector>

#ifndef Q_MOC_RUN
// Workaround for https://github.com/boostorg/serialization/issues/186
#include <boost/serialization/nvp.hpp>

#include <boost/multiprecision/cpp_dec_float.hpp>
#endif

#include <QMetaType>
#include <QString>
#include <QFontMetrics>

using std::string;
using std::vector;

namespace pv {
namespace util {

enum class TimeUnit {
    None = 0,
    Time = 1,
    Samples = 2
};

enum class SIPrefix {
    unspecified = -1,
    yocto, zepto,
    atto, femto, pico,
    nano, micro, milli,
    none,
    kilo, mega, giga,
    tera, peta, exa,
    zetta, yotta
};

int exponent(SIPrefix prefix);

typedef boost::multiprecision::number<
    boost::multiprecision::cpp_dec_float<24>,
    boost::multiprecision::et_off> Timestamp;

SIPrefix determine_value_prefix(double v);

QString format_time_si(const Timestamp& v,
    SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0,
    QString unit = "s", bool sign = true);

QString format_value_si(double v,
    SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0,
    QString unit = "", bool sign = true);

QString format_time_si_adjusted(const Timestamp& t, SIPrefix prefix,
    unsigned precision = 0, QString unit = "s", bool sign = true);

QString format_time_minutes(const Timestamp& t, signed precision = 0,
    bool sign = true);

vector<string> split_string(string text, string separator);

std::streamsize text_width(const QFontMetrics &metric, const QString &string);

} // namespace util
} // namespace pv

Q_DECLARE_METATYPE(pv::util::Timestamp)

#endif // PULSEVIEW_PV_UTIL_HPP