src/base/utils/misc.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2006  Christophe Dumez <chris@qbittorrent.org>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  * In addition, as a special exception, the copyright holders give permission to
  20  * link this program with the OpenSSL project's "OpenSSL" library (or with
  21  * modified versions of it that use the same license as the "OpenSSL" library),
  22  * and distribute the linked executables. You must obey the GNU General Public
  23  * License in all respects for all of the code used other than "OpenSSL".  If you
  24  * modify file(s), you may extend this exception to your version of the file(s),
  25  * but you are not obligated to do so. If you do not wish to do so, delete this
  26  * exception statement from your version.
  27  */
  28
  29 #pragma once
  30
  31 #include <QtTypes>
  32
  33 #include "base/pathfwd.h"
  34
  35 class QString;
  36 class QStringView;
  37
  38 /*  Miscellaneous functions that can be useful */
  39 namespace Utils::Misc
  40 {
  41     // use binary prefix standards from IEC 60027-2
  42     // see http://en.wikipedia.org/wiki/Kilobyte
  43     enum class SizeUnit
  44     {
  45         Byte,       // 1024^0,
  46         KibiByte,   // 1024^1,
  47         MebiByte,   // 1024^2,
  48         GibiByte,   // 1024^3,
  49         TebiByte,   // 1024^4,
  50         PebiByte,   // 1024^5,
  51         ExbiByte    // 1024^6,
  52         // int64 is used for sizes and thus the next units can not be handled
  53         // ZebiByte,   // 1024^7,
  54         // YobiByte,   // 1024^8
  55     };
  56
  57     enum class TimeResolution
  58     {
  59         Seconds,
  60         Minutes
  61     };
  62
  63     QString parseHtmlLinks(const QString &rawText);
  64
  65     QString osName();
  66     QString boostVersionString();
  67     QString libtorrentVersionString();
  68     QString opensslVersionString();
  69     QString zlibVersionString();
  70
  71     QString unitString(SizeUnit unit, bool isSpeed = false);
  72
  73     // return the best user friendly storage unit (B, KiB, MiB, GiB, TiB)
  74     // value must be given in bytes
  75     QString friendlyUnit(qint64 bytes, bool isSpeed = false, int precision = -1);
  76     QString friendlyUnitCompact(qint64 bytes);
  77     int friendlyUnitPrecision(SizeUnit unit);
  78     qint64 sizeInBytes(qreal size, SizeUnit unit);
  79
  80     bool isPreviewable(const Path &filePath);
  81
  82     // Take a number of seconds and return a user-friendly
  83     // time duration like "1d 2h 10m".
  84     QString userFriendlyDuration(qlonglong seconds, qlonglong maxCap = -1, TimeResolution resolution = TimeResolution::Minutes);
  85
  86     QString languageToLocalizedString(QStringView localeStr);
  87 }