LeechCraft  0.6.70-10870-g558588d6ec
Modular cross-platform feature rich live environment.
LeechCraft::Util Namespace Reference

Namespaces

 AN
 
 CacheStrat
 
 detail
 
 IntSeq
 
 oral
 
 SvcAuth
 
 SysInfo
 
 Views
 
 XDG
 

Classes

class  AddressesModelManager
 Manages an XML settings model with a list of network interfaces selected by the user from the list of available ones. More...
 
class  ApplicativeTest
 
class  AssocCache
 
struct  AsTypelist
 
struct  AsTypelist< OtherList< Args... > >
 
class  AutoResizeMixin
 Automatically moves a widget to fit a rectangle on resize. More...
 
class  BackendSelector
 A common dialog to select storage backend. More...
 
class  BaseHookInterconnector
 Base class for signal-slot relays in plugin APIs. More...
 
class  BasicDeletePolicy
 
class  BitFlags
 
struct  Caster
 
class  CategorySelector
 The CategorySelector widget provides a way to select amongst a group of items. More...
 
class  ChoiceDeletePolicy
 Delegates the SlotClosure deletion decision to the signal handler. More...
 
class  ClearLineEditAddon
 Provides a "clear text" action for line edits. More...
 
class  ClosingDB
 
class  ColorButton
 A button for choosing a color. More...
 
class  ColorThemeProxy
 Proxy for QML files to use colors from current color theme. More...
 
class  ConcurrentException
 A concurrent exception that plays nicely with Qt. More...
 
class  ConsistencyChecker
 
class  CpuFeatures
 
class  CurryImpl
 
class  CustomCookieJar
 A customized cookie jar with additional features. More...
 
class  CustomNetworkReply
 A network reply with customizable content and reply headers. More...
 
class  DBLock
 Provides database transaction lock. More...
 
class  DefaultHookProxy
 Standard implementation of IHookProxy. More...
 
class  DelayedExecutor
 Executes a given action after a given timeout. More...
 
class  DeleteLaterPolicy
 Deletes a SlotClosure object after its signal has fired. More...
 
class  DetectorTest
 
class  DndActionsMixin
 Abstracts away differences between Qt4 and Qt5 in model DnD support. More...
 
class  DomChildrenRangeTest
 
class  DownloadHandler
 
class  DummyObject
 
class  Dumper
 
class  Either
 
class  EitherCont
 A peir of two functions, typically a continuation and an error handler. More...
 
class  EitherTest
 
class  ExtensionsData
 
class  ExtensionsDataImpl
 
class  FailedImpl
 
class  FDGuard
 
class  FileRemoveGuard
 QFile removing itself from file system on destruction. More...
 
class  FindNotification
 A horizontal bar with typical widgets for text search. More...
 
class  FindNotificationWk
 A helper class to aid connecting FindNotification with Qt WebKit. More...
 
class  FlattenFilterModel
 Proxy model flattening a hierarchical model. More...
 
class  FlatToFoldersProxyModel
 
class  FlowLayout
 A simple flow layout implementation. More...
 
class  FontChooserWidget
 Provides a widget for choosing a font. More...
 
class  FunctorTest
 
class  FuturesTest
 
struct  Head
 
struct  Head< List< H, T... > >
 
class  IDPool
 A simple pool of identificators of the given type. More...
 
struct  InstanceApplicative
 
struct  InstanceApplicative< boost::optional< T > >
 
struct  InstanceApplicative< Either< L, R > >
 
struct  InstanceFunctor
 The Functor class is used for types that can be mapped over. More...
 
struct  InstanceFunctor< boost::optional< T > >
 Implementation of the Functor class for boost.optional. More...
 
struct  InstanceFunctor< Either< L, R > >
 
struct  InstanceFunctor< QFuture< T > >
 
struct  InstanceMonad
 
struct  InstanceMonad< boost::optional< T > >
 
struct  InstanceMonad< Either< L, R > >
 
struct  InstanceMonadPlus
 
struct  InstanceMonadPlus< boost::optional< T > >
 
class  Introspectable
 
class  LazyInitializer
 Provides lazy initialization on first access to an object. More...
 
class  LineEditButtonManager
 Manages additional overlay buttons in a QLineEdit. More...
 
class  MassFontChangeDialog
 
class  MergeModel
 
class  MimeDetector
 
class  MimeDetectorImpl
 
class  ModelItem
 Provides a proxying API on top of an QAbstractItemModel. More...
 
class  ModelItemBase
 Base class for model items for tree-like models. More...
 
class  ModelIterator
 Provides an iterator-based API to a Qt model. More...
 
class  MonadicFuturesTest
 
class  MonadPlusTest
 
class  MonadTest
 
class  NetworkDiskCache
 A thread-safe garbage-collected network disk cache. More...
 
class  NetworkDiskCacheGC
 Garbage collection for a set of network disk caches. More...
 
class  NewType
 A somewhat "strong" typedef. More...
 
struct  NoDefaultCtor
 
class  NoDeletePolicy
 Does not delete a SlotClosure object. More...
 
struct  Not
 
class  NotificationActionHandler
 Aids in adding actions to notifications. More...
 
class  OralFKeyTest
 
class  OralTest
 
struct  OverloadBase
 
class  PageNotification
 A horizontal widget embedding into the parent layout of the passed parent widget. More...
 
class  PlotItem
 
class  PreludeTest
 
class  QmlErrorWatcher
 Utility class for logging errors from a QML view. More...
 
struct  QStringToLower
 
struct  QStringTrimmed
 
class  QueueManager
 A simple scheduling manager for a queue of functors. More...
 
class  RegExp
 
struct  RegExpImpl
 
class  ResourceLoader
 Utility class for loading a file from a set of locations. More...
 
class  RoleNamesMixin
 Wraps differences between role names handling in Qt4 and Qt5. More...
 
struct  S1
 
struct  S2
 
class  ScopeGuardTest
 
class  SelectableBrowser
 A "browser" that shows HTML either via QTextBrowser or a browser plugin. More...
 
struct  ServiceInfo
 
class  SettableIconProvider
 QML image provider with settable icons for each path. More...
 
class  ShortcutManager
 Aids in providing configurable shortcuts. More...
 
class  SlotClosure
 Executes a given functor upon a signal (or a list of signals). More...
 
class  SlotClosureBase
 Base class for SlotClosure. More...
 
class  SlotClosureTest
 
struct  SpaceInfo
 Contains information about a partition's disk space. More...
 
class  SslCertificateInfoWidget
 
class  StandardNAMFactory
 A standard QML QNetworkAccessManager factory. More...
 
class  StdDataFilterMenuCreator
 Adds actions to handle some data with relevant IDataFilter plugins to a menu. More...
 
class  StlizeTest
 
class  TagsCompleter
 Completer suitable for tag completion. More...
 
class  TagsCompletionModel
 A QStringListModel providing additional methods for tags. More...
 
class  TagsFilterModel
 Provides filter model with additional tags filter mode. More...
 
class  TagsLineEdit
 A line edit class suitable for use with TagsCompleter. More...
 
class  ThemeImageProvider
 Provides icons from the current theme by their FDO name. More...
 
class  ToolTipItem
 ToolTip for Qml objects. More...
 
class  TypeGetterTest
 
struct  Typelist
 
class  TypelistTest
 
class  UnhideListModel
 A model to be used with UnhideListViewBase. More...
 
class  UnhideListViewBase
 Base class for a view of a list of items to be unclosed. More...
 
class  UnhoverDeleteMixin
 Allows to hide a widget or popup after mouse leave. More...
 
struct  Upcaster
 
struct  Upcaster< To * >
 
class  UrlAccessor
 
class  UrlOperator
 Manipulates query part of an QUrl object. More...
 
class  ViewsTest
 
class  Visitor
 
class  VisitorTest
 
struct  Void
 A proper void type, akin to unit (or ()) type in functional languages. More...
 
class  WidthIconProvider
 Provides scalable icons to QML. More...
 
class  WkFontsWidget
 A settings widget for configuring WebKit fonts. More...
 
class  WorkerThread
 
class  WorkerThreadBase
 
struct  WrapType
 
struct  WrapType< QList< QString > >
 
class  XWrapper
 

Typedefs

typedef std::shared_ptr< XmlSettingsDialog > XmlSettingsDialog_ptr
 
typedef std::shared_ptr< ModelItemModelItem_ptr
 
typedef std::weak_ptr< ModelItemModelItem_wtr
 
typedef QVector< ModelItem_ptrModelItemsList_t
 
typedef std::shared_ptr< const ModelItemModelItem_cptr
 
typedef QList< QPair< QString, QString > > AddrList_t
 
template<typename AF , typename AV >
using GSLResult_t = typename InstanceApplicative< AF >::template GSLResult< AV >::Type_t
 
template<typename Type , template< typename... > class Op, typename... Args>
using IsDetected_t = typename detail::IsDetected< Type, void, Op, Args... >::type
 
template<typename T , typename F >
using FmapResult_t = typename InstanceFunctor< T >::template FmapResult_t< F >
 The result type of the contents of the functor T mapped by function F. More...
 
template<typename T >
using Lazy_t = std::function< T()>
 
template<typename MV , typename F >
using BindResult_t = typename InstanceMonad< MV >::template BindResult_t< F >
 
template<typename T >
using WrapType_t = typename WrapType< T >::type
 
template<typename T >
using DoSmthDetector = decltype(std::declval< T >().DoSmth(QString {}))
 
using SomeEither_t = Either< int, QString >
 
template<typename T >
using IsVoid_t = std::is_same< T, void >
 
using Variant_t = boost::variant< int, char, std::string, QString, double, float >
 
using SVariant_t = boost::variant< S1, S2 >
 
template<typename F , size_t Idx>
using ArgType_t = std::tuple_element_t< Idx+1, decltype(detail::TypeGetter(*static_cast< F * >(nullptr)))>
 
template<typename F >
using RetType_t = std::conditional_t< std::is_same_v< detail::RetTypeRaw_t< F >, detail::ReturnsVoid >, void, detail::RetTypeRaw_t< F > >
 
template<auto Ptr>
using MemberPtrType_t = typename detail::DecomposeMemberPtr< decltype(Ptr)>::Value_t
 
template<auto Ptr>
using MemberPtrStruct_t = typename detail::DecomposeMemberPtr< decltype(Ptr)>::StructType_t
 
template<typename List >
using Head_t = typename Head< List >::Head_t
 
template<typename T >
using AsTypelist_t = typename AsTypelist< T >::Result_t
 
using DefaultScopeGuard = detail::ScopeGuard< detail::DefaultScopeGuardDeleter >
 
typedef std::shared_ptr< QIODevice > QIODevice_ptr
 
using QtException_t = QException
 
using QtException_ptr = std::shared_ptr< QtException_t >
 
using ConcurrentStdException = Util::ConcurrentException< Util::NewType< std::exception, 0, __LINE__ > >
 
typedef std::shared_ptr< DefaultHookProxyDefaultHookProxy_ptr
 
using Introspect_f = std::function< QVariantMap(QVariant)>
 
using LazyNotificationPixmap_t = std::function< boost::optional< QFuture< QImage > >()>
 

Enumerations

enum  FitFlag {
  NoFlags,
  NoOverlap = 0x01
}
 
enum  QueuePriority {
  QueuePriority::Normal,
  QueuePriority::High
}
 The priority of the action in the queue. More...
 
enum  SysPath {
  SysPath::QML,
  SysPath::Share
}
 Describes various root paths recognized by GetSysPath(). More...
 
enum  UserDir {
  UserDir::Cache,
  UserDir::LC
}
 Describes various user-specific paths. More...
 
enum  WinStateFlag {
  NoState = 0,
  Modal = 1 << 0,
  Sticky = 1 << 1,
  MaximizedVert = 1 << 2,
  MaximizedHorz = 1 << 3,
  Shaded = 1 << 4,
  SkipTaskbar = 1 << 5,
  SkipPager = 1 << 6,
  Hidden = 1 << 7,
  Fullscreen = 1 << 8,
  OnTop = 1 << 9,
  OnBottom = 1 << 10,
  Attention = 1 << 11
}
 
enum  AllowedActionFlag {
  NoAction = 0,
  Move = 1 << 0,
  Resize = 1 << 1,
  Minimize = 1 << 2,
  Shade = 1 << 3,
  Stick = 1 << 4,
  MaximizeHorz = 1 << 5,
  MaximizeVert = 1 << 6,
  ShowFullscreen = 1 << 7,
  ChangeDesktop = 1 << 8,
  Close = 1 << 9,
  MoveToTop = 1 << 10,
  MoveToBottom = 1 << 11
}
 

Functions

QSqlDatabase MakeDatabase (const QString &name=":memory:")
 
QSqlQuery RunTextQuery (const QSqlDatabase &db, const QString &text)
 Runs the given query text on the given db. More...
 
QString LoadQuery (const QString &plugin, const QString &filename)
 Loads the query text from the given resource file. More...
 
void RunQuery (const QSqlDatabase &db, const QString &plugin, const QString &filename)
 Loads the query from the given resource file and runs it. More...
 
QString GenConnectionName (const QString &base)
 Generates an unique thread-safe connection name. More...
 
template<typename T = int>
GetLastId (const QSqlQuery &query)
 Gets the last insert ID for the given query. More...
 
QDialog * MakeCertificateViewerDialog (const QSslCertificate &cert, QWidget *parent)
 
QPoint FitRectScreen (QPoint pos, const QSize &size, FitFlags flags=NoFlags, const QPoint &shiftAdd=QPoint(0, 0))
 Tries to fit a rectangle (like a dialog or popup) into screen. More...
 
QPoint FitRect (QPoint pos, const QSize &size, const QRect &geometry, FitFlags flags=NoFlags, const QPoint &shiftAdd=QPoint(0, 0))
 Tries to fit a rectangle (like a dialog or popup) into geometry. More...
 
QLabel * ShowPixmapLabel (const QPixmap &pixmap, const QPoint &pos=QPoint())
 Shows a pixmap at the given pos. More...
 
QColor TintColors (const QColor &c1, const QColor &c2, double alpha=0.5)
 Mixes two colors with the given weights. More...
 
QString ElideProgressBarText (const QString &text, const QStyleOptionViewItem &option)
 
void TintPalette (QWidget *widget, const QColor &color, double alpha=0.5, const QList< QPalette::ColorRole > &roles={ QPalette::ColorRole::Text, QPalette::ColorRole::WindowText })
 Mixes some of the widget's palette roles with the given color. More...
 
QString FormatName (const QString &name)
 HTML-formats the name to let the user know it is not a part of the fixed dialog text. More...
 
 Q_DECLARE_FLAGS (FitFlags, FitFlag)
 
template<typename T >
void Save2MimeData (QMimeData *mimeData, const QString &name, const T &t)
 
bool operator== (const ModelIterator &left, const ModelIterator &right)
 
bool operator!= (const ModelIterator &left, const ModelIterator &right)
 
AddrList_t GetLocalAddresses (int port=0)
 Returns all local addresses. More...
 
QList< QHostAddress > GetAllAddresses ()
 Returns all addresses likely accessible "from the outside". More...
 
template<typename F >
void HandleNetworkReply (QObject *context, QNetworkReply *reply, F f)
 
template<typename Err = Util::Void>
auto HandleReply (QNetworkReply *reply, QObject *context)
 
QString GetServiceUrl (const ServiceInfo &info, const QString &path)
 
QString GetSocketErrorString (QAbstractSocket::SocketError error)
 Returns an error string for the given socket error. More...
 
QTreeWidgetItem * SslError2TreeItem (const QSslError &error)
 Builds a tree widget representation of the given SSL error. More...
 
void EnableTransparency (QQuickWidget *widget)
 
void CreateShortcuts (const QList< QKeySequence > &seqs, const std::function< void()> &func, QWidget *parent)
 Makes func invokable with shortcuts in seq. More...
 
void CreateShortcuts (const QList< QKeySequence > &seqs, QObject *object, const char *metamethod, QWidget *parent)
 Makes metamethod invokable with shortcuts in seq. More...
 
template<template< typename... > class Applicative, typename... Args, typename T >
auto Pure (const T &v)
 
template<typename Applicative , typename T >
auto Pure (const T &v) -> decltype(InstanceApplicative< Applicative >::Pure(v))
 
template<typename AF , typename AV >
GSLResult_t< AF, AV > GSL (const AF &af, const AV &av)
 
template<typename AF , typename AV >
auto operator* (const AF &af, const AV &av) -> decltype(GSL(af, av))
 
template<typename F >
CurryImpl< F > Curry (F f)
 
void ExecuteLater (const DelayedExecutor::Actor_f &actor, int delay=0)
 
template<typename F >
void DelayDestruction (const std::shared_ptr< F > &obj)
 
auto DomChildren (const QDomElement &parent, const QString &tag)
 Creates a range iterating over direct children named tag. More...
 
template<typename F >
detail::Dropper< F > DropArgs (const F &f)
 
template<typename L , typename R , typename F , typename = std::result_of_t<F ()>>
RightOr (const Either< L, R > &either, F &&f)
 
template<typename L , typename R >
RightOr (const Either< L, R > &either, const R &r)
 
template<template< typename > class Cont, typename L , typename R >
std::pair< Cont< L >, Cont< R > > PartitionEithers (const Cont< Either< L, R >> &eithers)
 
template<typename Left , typename Right , typename... Args>
auto Visit (const Either< Left, Right > &either, Args &&... args)
 
template<typename R , typename B , typename C , typename... Args>
auto BindMemFn (R(B::*fn)(Args...), C *c)
 Binds an instance of an object to its member function. More...
 
template<typename R , typename B , typename C , typename... Args>
auto BindMemFn (R(B::*fn)(Args...) const, const C *c)
 
template<typename T >
constexpr bool IsFunctor ()
 Checks whether the given type has a Functor instance for it. More...
 
template<typename T , typename F , typename = std::enable_if_t<IsFunctor<T> ()>>
FmapResult_t< T, F > Fmap (const T &functor, const F &function)
 Apply the function f to the elements in functor. More...
 
template<typename T , typename F >
auto operator* (const F &function, const T &functor) -> decltype(Fmap(functor, function))
 An operator-style alias for Fmap(). More...
 
template<typename T , typename F >
auto operator* (const T &functor, const F &function) -> decltype(Fmap(functor, function))
 An operator-style alias for Fmap(). More...
 
template<typename F >
auto MakeLambdaEventFilter (F &&f, QObject *parent=nullptr)
 
template<typename T >
Lazy_t< T > MakeLazy (const T &t)
 
template<typename R , typename F >
Lazy_t< R > MakeLazyF (const F &l)
 
template<template< typename... > class Monad, typename... Args, typename V >
auto Return (const V &v)
 
template<typename MV , typename F >
BindResult_t< MV, F > Bind (const MV &value, const F &f)
 
template<typename MV , typename F >
auto operator>> (const MV &value, const F &f) -> decltype(Bind(value, f))
 
template<typename MV >
auto Do (const MV &value)
 
template<typename MV , typename FHead , typename... FArgs>
auto Do (const MV &value, const FHead &fHead, const FArgs &... fArgs)
 
template<typename T >
constexpr bool IsMonadPlus ()
 
template<typename MP >
MP Mzero ()
 
template<typename MP >
auto operator+ (const MP &m1, const MP &m2) -> decltype(Mplus(m1)(m2))
 
QVariant ParseJson (const QByteArray &bytes, const char *context)
 Parses JSON content in the given bytearray. More...
 
QVariant ParseJson (QIODevice *device, const char *context)
 Utility function parsing JSON from the device. More...
 
template<typename T1 , typename T2 , template< typename U > class Container, typename F >
auto ZipWith (const Container< T1 > &c1, const Container< T2 > &c2, F f) -> WrapType_t< Container< std::decay_t< std::result_of_t< F(T1, T2)>>>>
 
template<typename T1 , typename T2 , template< typename U > class Container, template< typename U1, typename U2 > class Pair = QPair>
auto Zip (const Container< T1 > &c1, const Container< T2 > &c2) -> Container< Pair< T1, T2 >>
 
template<typename Container , typename F >
auto Map (Container &&c, F f)
 
template<template< typename... > class Fallback, typename Container , typename F >
auto MapAs (Container &&c, F &&f)
 
template<typename T , template< typename U > class Container, typename F >
Container< T > Filter (const Container< T > &c, F f)
 
template<template< typename > class Container, typename T >
Container< T > Concat (const Container< Container< T >> &containers)
 
template<template< typename... > class Container, typename... ContArgs>
auto Concat (const Container< ContArgs... > &containers) -> std::decay_t< decltype(*containers.begin())>
 
template<typename Cont , typename F >
auto ConcatMap (Cont &&c, F &&f)
 
template<template< typename > class Container, typename T >
Container< Container< T > > SplitInto (size_t numChunks, const Container< T > &container)
 
template<template< typename Pair, typename... Rest > class Cont, template< typename K, typename V > class Pair, typename K , typename V , typename KV , typename... Rest>
boost::optional< V > Lookup (const KV &key, const Cont< Pair< K, V >, Rest... > &cont)
 
template<typename Cont >
Cont Sorted (Cont &&cont)
 
template<typename R >
auto ComparingBy (R r)
 
template<typename R >
auto EqualityBy (R r)
 
template<typename F >
auto First (F &&f)
 
template<typename F >
auto Second (F &&f)
 
template<typename F >
auto Flip (F &&f)
 
template<template< typename K, typename V > class PairType = std::pair, typename Assoc >
auto Stlize (Assoc &&assoc) -> detail::StlAssocRange< detail::Identity, detail::Identity, decltype(assoc.begin()), Assoc, PairType >
 Converts an Qt's associative sequence assoc to an STL-like iteratable range. More...
 
template<template< typename K, typename V > class PairType = std::pair, typename Assoc >
auto StlizeCopy (Assoc &&assoc) -> detail::StlAssocRange< std::decay, std::decay, decltype(assoc.begin()), Assoc, PairType >
 
auto MakeEndGroupScopeGuard (QSettings &settings)
 Creates a scope guard that ends the current group on settings. More...
 
auto BeginGroup (QSettings &settings, const QString &group)
 Begins the group on settings and returns a scope guard ending that group. More...
 
QByteArray SerializeJson (const QVariant &var, bool compact=true)
 Serializes the given var to JSON representation. More...
 
template<template< typename... > class List, typename H , typename... T>
constexpr List< T... > Tail (List< H, T... >)
 
template<int N, template< typename... > class List, typename... Args>
constexpr detail::DropImpl< N, List< Args... > >::Result_t Drop (List< Args... >)
 
template<template< typename... > class List, typename... Args1, typename... Args2>
constexpr List< Args1..., Args2... > Concat (List< Args1... >, List< Args2... >)
 
template<template< typename... > class List>
constexpr List Reverse (List<>)
 
template<template< typename... > class List, typename Head , typename... Tail>
constexpr auto Reverse (List< Head, Tail... >) -> decltype(Concat(Reverse(List< Tail... >
 
template<typename F , typename G , typename Def , typename Head , typename... Args>
auto FirstMatching (F f, G g, Def def, Util::Typelist< Head, Args... >)
 
void Unreachable ()
 
template<typename F >
detail::ScopeGuard< F > MakeScopeGuard (const F &f)
 Returns an object performing passed function on scope exit. More...
 
template<typename... Vars, typename... Args>
decltype(auto) Visit (const boost::variant< Vars... > &v, Args &&... args)
 
template<typename... Vars, typename... Args>
decltype(auto) Visit (boost::variant< Vars... > &v, Args &&... args)
 
template<typename... Args>
 Visitor (Args &&...) -> Visitor< Void, Args... >
 
template<typename T , typename... Args>
auto InvokeOn (T &&t, Args &&... args)
 
void swap (FDGuard &g1, FDGuard &g2)
 
QByteArray DetectFileMime (const QString &path)
 
QStringList GetPathCandidates (SysPath path, QString subfolder)
 Returns possible full paths for the path and subfolder. More...
 
QString GetSysPath (SysPath path, const QString &subfolder, const QString &filename)
 Returns path to the file in the given root path and subfolder. More...
 
QUrl GetSysPathUrl (SysPath path, const QString &subfolder, const QString &filename)
 Returns path to the file in the given root path and subfolder. More...
 
QStringList GetSystemPaths ()
 Returns the components of the system PATH variable. More...
 
QString FindInSystemPath (const QString &name, const QStringList &paths, const std::function< bool(QFileInfo)> &filter=std::function< bool(QFileInfo)>())
 Searches for a file in system paths according to a filter. More...
 
QDir GetUserDir (UserDir dir, const QString &subpath)
 
QDir CreateIfNotExists (QString path)
 Creates a path if it doesn't exist. More...
 
QString GetTemporaryName (const QString &pattern=QString("lc_temp.XXXXXX"))
 Returns a temporary filename. More...
 
SpaceInfo GetSpaceInfo (const QString &path)
 Returns the disk space info of the partition containing path. More...
 
bool HasSupportedImageExtension (const QString &filename)
 Checks if the given filename has a known image extension. More...
 
auto MkWaiter ()
 
QString FromStdString (const std::string &str)
 An utility function that creates a QString from UTF8-encoded std::string. More...
 
UTIL_API QString GetAsBase64Src (const QImage &image)
 Returns the given image in a Base64-encoded form. More...
 
UTIL_API QString GetUserText (const Entity &entity)
 Return the user-readable representation of the entity. More...
 
UTIL_API QString MakePrettySize (qint64 sourceSize)
 Makes a formatted size from number. More...
 
UTIL_API QString MakePrettySizeShort (qint64 size)
 Converts a bytes count to a string representation with appropriately chosen units. More...
 
UTIL_API QString MakeTimeFromLong (ulong time)
 Makes a formatted time from number. More...
 
UTIL_API QTranslator * LoadTranslator (const QString &base, const QString &locale, const QString &prefix="leechcraft", const QString &appname="leechcraft")
 
UTIL_API QTranslator * InstallTranslator (const QString &base, const QString &prefix="leechcraft", const QString &appname="leechcraft")
 Loads and installs a translator. More...
 
UTIL_API QString GetLocaleName ()
 Returns the current locale name, like en_US. More...
 
UTIL_API QString GetInternetLocaleName (const QLocale &)
 
UTIL_API QString GetLanguage ()
 Returns the current language name. More...
 
UTIL_API QModelIndexList GetSummarySelectedRows (QObject *sender)
 
UTIL_API QAction * CreateSeparator (QObject *parent)
 Returns the action that is set to act as a separator. More...
 
UTIL_API QPixmap DrawOverlayText (QPixmap px, const QString &text, QFont font, const QPen &pen, const QBrush &brush)
 
template<typename TagGetter , typename TagSetter >
QDomElement GetElementForTags (const QStringList &tags, QDomNode &node, QDomDocument &document, const QString &elementName, TagGetter tagGetter, TagSetter tagSetter)
 Returns an element for a given tags list. More...
 
QString GetPassword (const QString &keyName, const QString &dialogText, const ICoreProxy_ptr &proxy, bool useStore=true)
 Returns password for the key, possibly asking the user. More...
 
void GetPassword (const QString &key, const QString &diaText, const ICoreProxy_ptr &proxy, const EitherCont< void(), void(QString)> &cont, QObject *depender, bool useStored)
 
void SavePassword (const QString &password, const QString &keyName, const ICoreProxy_ptr &proxy)
 Saves the password to be retrieved later via GetPassword(). More...
 
QList< ANFieldDataGetStdANFields (const QString &category)
 Returns the list of the standard AN fields for the given category. More...
 
Entity MakeAN (const QString &header, const QString &text, Priority priority, const QString &senderID, const QString &cat, const QString &type, const QString &id, const QStringList &visualPath, int delta=1, int count=0, const QString &fullText=QString(), const QString &extendedText=QString())
 Creates an Advanced Notifications-enabled notify entity. More...
 
Entity MakeANRule (const QString &title, const QString &senderID, const QString &category, const QStringList &types, AN::NotifyFlags flags=AN::NotifyNone, bool openConfiguration=false, const QList< QPair< QString, ANFieldValue >> &fields={})
 Creates an Entity defining an Advanced Notifications rule. More...
 
QList< QObject * > GetDataFilters (const QVariant &data, IEntityManager *manager)
 Returns the data filter plugins that can handle data. More...
 
Entity MakeEntity (const QVariant &entity, const QString &location, TaskParameters tp, const QString &mime)
 
Entity MakeNotification (const QString &header, const QString &text, Priority priority)
 An utility function to make a Entity with notification. More...
 
Entity MakeANCancel (const Entity &event)
 Makes an event for canceling another Advanced Notifications event. More...
 
Entity MakeANCancel (const QString &senderId, const QString &eventId)
 Makes an event for canceling another Advanced Notifications event. More...
 
QVariant GetPersistentData (const QByteArray &key, const ICoreProxy_ptr &proxy)
 Returns persistent data stored under given key. More...
 
void SetJobHolderProgress (const QList< QStandardItem * > &row, qint64 done, qint64 total, const QString &text)
 Sets the progress values on the given row. More...
 
void SetJobHolderProgress (QStandardItem *item, qint64 done, qint64 total)
 Sets the done and total progress values on the given item. More...
 
void InitJobHolderRow (const QList< QStandardItem *> &row)
 
UTIL_XPC_API Entity MakeEntity (const QVariant &entity, const QString &location, LeechCraft::TaskParameters tp, const QString &mime=QString())
 An utility function to make a Entity. More...
 
XmlSettingsDialog * OpenXSD (const QString &title, const QString &filename, Util::BaseSettingsManager *bsm)
 Opens XML settings dialog for the given XML filename. More...
 

Variables

template<template< typename... > class Op, typename... Args>
constexpr bool IsDetected_v = detail::IsDetected<void, void, Op, Args...>::value_t::value
 
template<typename To >
constexpr auto Upcast = Upcaster<To> {}
 
struct {
Mplus
 
struct {
Msum
 
template<typename... Args>
constexpr OverloadBase< Args... > Overload {}
 
const auto Id = [] (const auto& t) { return t; }
 
const auto Apply = [] (const auto& t) { return t (); }
 
const auto Fst = [] (const auto& pair) { return pair.first; }
 
const auto Snd = [] (const auto& pair) { return pair.second; }
 
template<template< typename > class Pred, typename... Args>
constexpr auto AllOf = (Pred<Args> {} && ...)
 
template<template< typename > class Pred, typename... Args>
constexpr auto AnyOf = (Pred<Args> {} || ...)
 
 List< Head >
 
const int SourcePager = 2
 
const int StateRemove = 0
 
const int StateAdd = 1
 

Typedef Documentation

◆ AddrList_t

typedef QList<QPair<QString, QString> > LeechCraft::Util::AddrList_t

Definition at line 44 of file addresses.h.

◆ ArgType_t

template<typename F , size_t Idx>
using LeechCraft::Util::ArgType_t = typedef std::tuple_element_t<Idx + 1, decltype (detail::TypeGetter (*static_cast<F*> (nullptr)))>

Definition at line 70 of file typegetter.h.

◆ AsTypelist_t

template<typename T >
using LeechCraft::Util::AsTypelist_t = typedef typename AsTypelist<T>::Result_t

Definition at line 182 of file typelist.h.

◆ BindResult_t

template<typename MV , typename F >
using LeechCraft::Util::BindResult_t = typedef typename InstanceMonad<MV>::template BindResult_t<F>

Definition at line 50 of file monad.h.

◆ ConcurrentStdException

Definition at line 106 of file concurrentexception.h.

◆ DefaultHookProxy_ptr

Definition at line 126 of file defaulthookproxy.h.

◆ DefaultScopeGuard

◆ DoSmthDetector

template<typename T >
using LeechCraft::Util::DoSmthDetector = typedef decltype (std::declval<T> ().DoSmth (QString {}))

Definition at line 41 of file detectortest.cpp.

◆ FmapResult_t

template<typename T , typename F >
using LeechCraft::Util::FmapResult_t = typedef typename InstanceFunctor<T>::template FmapResult_t<F>

The result type of the contents of the functor T mapped by function F.

Template Parameters
TThe type of the functor.
FThe type of the function to apply to the elements inside the functor.

Definition at line 124 of file functor.h.

◆ GSLResult_t

template<typename AF , typename AV >
using LeechCraft::Util::GSLResult_t = typedef typename InstanceApplicative<AF>::template GSLResult<AV>::Type_t

Definition at line 42 of file applicative.h.

◆ Head_t

template<typename List >
using LeechCraft::Util::Head_t = typedef typename Head<List>::Head_t

Definition at line 53 of file typelist.h.

◆ Introspect_f

using LeechCraft::Util::Introspect_f = typedef std::function<QVariantMap (QVariant)>

Definition at line 42 of file introspectable.h.

◆ IsDetected_t

template<typename Type , template< typename... > class Op, typename... Args>
using LeechCraft::Util::IsDetected_t = typedef typename detail::IsDetected<Type, void, Op, Args...>::type

Definition at line 59 of file detector.h.

◆ IsVoid_t

template<typename T >
using LeechCraft::Util::IsVoid_t = typedef std::is_same<T, void>

Definition at line 52 of file typelisttest.cpp.

◆ Lazy_t

template<typename T >
using LeechCraft::Util::Lazy_t = typedef std::function<T ()>

Definition at line 40 of file lazy.h.

◆ LazyNotificationPixmap_t

using LeechCraft::Util::LazyNotificationPixmap_t = typedef std::function<boost::optional<QFuture<QImage> > ()>

Definition at line 275 of file util.h.

◆ MemberPtrStruct_t

template<auto Ptr>
using LeechCraft::Util::MemberPtrStruct_t = typedef typename detail::DecomposeMemberPtr<decltype (Ptr)>::StructType_t

Definition at line 96 of file typegetter.h.

◆ MemberPtrType_t

template<auto Ptr>
using LeechCraft::Util::MemberPtrType_t = typedef typename detail::DecomposeMemberPtr<decltype (Ptr)>::Value_t

Definition at line 93 of file typegetter.h.

◆ ModelItem_cptr

typedef std::shared_ptr<const ModelItem> LeechCraft::Util::ModelItem_cptr

Definition at line 45 of file modelitem.h.

◆ ModelItem_ptr

typedef std::shared_ptr<ModelItem> LeechCraft::Util::ModelItem_ptr

Definition at line 40 of file modelitem.h.

◆ ModelItem_wtr

Definition at line 43 of file modelitem.h.

◆ ModelItemsList_t

Definition at line 44 of file modelitem.h.

◆ QIODevice_ptr

typedef std::shared_ptr<QIODevice> LeechCraft::Util::QIODevice_ptr

Definition at line 50 of file resourceloader.h.

◆ QtException_ptr

using LeechCraft::Util::QtException_ptr = typedef std::shared_ptr<QtException_t>

Definition at line 42 of file concurrentexception.h.

◆ QtException_t

using LeechCraft::Util::QtException_t = typedef QException

Definition at line 40 of file concurrentexception.h.

◆ RetType_t

template<typename F >
using LeechCraft::Util::RetType_t = typedef std::conditional_t< std::is_same_v<detail::RetTypeRaw_t<F>, detail::ReturnsVoid>, void, detail::RetTypeRaw_t<F> >

Definition at line 77 of file typegetter.h.

◆ SomeEither_t

using LeechCraft::Util::SomeEither_t = typedef Either<int, QString>

Definition at line 42 of file eithertest.cpp.

◆ SVariant_t

using LeechCraft::Util::SVariant_t = typedef boost::variant<S1, S2>

Definition at line 54 of file visitortest.cpp.

◆ Variant_t

using LeechCraft::Util::Variant_t = typedef boost::variant<int, char, std::string, QString, double, float>

Definition at line 40 of file visitortest.cpp.

◆ WrapType_t

template<typename T >
using LeechCraft::Util::WrapType_t = typedef typename WrapType<T>::type

Definition at line 56 of file prelude.h.

◆ XmlSettingsDialog_ptr

typedef std::shared_ptr<XmlSettingsDialog> LeechCraft::Util::XmlSettingsDialog_ptr

Definition at line 39 of file ihavesettings.h.

Enumeration Type Documentation

◆ AllowedActionFlag

Enumerator
NoAction 
Move 
Resize 
Minimize 
Shade 
Stick 
MaximizeHorz 
MaximizeVert 
ShowFullscreen 
ChangeDesktop 
Close 
MoveToTop 
MoveToBottom 

Definition at line 57 of file winflags.h.

◆ QueuePriority

The priority of the action in the queue.

Enumerator
Normal 

Standard priority.

High 

Higher priority.

Definition at line 48 of file queuemanager.h.

◆ SysPath

Describes various root paths recognized by GetSysPath().

See also
GetPathCandidates(), GetSysPath()
Enumerator
QML 

Root path for QML files.

Plugins are expected to install their files into a subdirectory of this directory.

Share 

Directory with shared data files.

Corresponds to /usr/[local/]share/leechcraft on Linux, for example.

Definition at line 48 of file paths.h.

◆ UserDir

Describes various user-specific paths.

Enumerator
Cache 

Cache for volatile data.

LC 

Root LeechCraft directory (something like ~/.leechcraft).

Definition at line 170 of file paths.h.

◆ WinStateFlag

Enumerator
NoState 
Modal 
Sticky 
MaximizedVert 
MaximizedHorz 
Shaded 
SkipTaskbar 
SkipPager 
Hidden 
Fullscreen 
OnTop 
OnBottom 
Attention 

Definition at line 38 of file winflags.h.

Function Documentation

◆ BeginGroup()

auto LeechCraft::Util::BeginGroup ( QSettings &  settings,
const QString &  group 
)
inline

Begins the group on settings and returns a scope guard ending that group.

Parameters
[in]settingsThe QSettings object.
[in]groupThe name of the group to begin.
Returns
The scope guard calling QSettings::endGroup() on the settings object on scope exit.
See also
MakeEndGroupScopeGuard()

Definition at line 65 of file scopeguards.h.

References MakeScopeGuard().

+ Here is the call graph for this function:

◆ Bind()

template<typename MV , typename F >
BindResult_t<MV, F> LeechCraft::Util::Bind ( const MV &  value,
const F &  f 
)

Definition at line 83 of file monad.h.

References LeechCraft::Util::oral::sph::f, and LeechCraft::Util::detail::IsCompatibleMonad().

Referenced by Do(), and operator>>().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ BindMemFn() [1/2]

template<typename R , typename B , typename C , typename... Args>
auto LeechCraft::Util::BindMemFn ( R(B::*)(Args...)  fn,
C *  c 
)

Binds an instance of an object to its member function.

Parameters
[in]fnThe member function of class T.
[in]cThe instance of class T to bind to the member function fn.
Returns
A functor callable with all arguments of fn but the object itself.
Template Parameters
RThe return type of the function.
TThe type of the object.
ArgsThe arguments to the function, besides the object itself.

Definition at line 51 of file functional.h.

◆ BindMemFn() [2/2]

template<typename R , typename B , typename C , typename... Args>
auto LeechCraft::Util::BindMemFn ( R(B::*)(Args...) const  fn,
const C *  c 
)

Definition at line 58 of file functional.h.

◆ ComparingBy()

template<typename R >
auto LeechCraft::Util::ComparingBy ( r)

Definition at line 252 of file prelude.h.

◆ Concat() [1/3]

template<template< typename... > class List, typename... Args1, typename... Args2>
constexpr List<Args1..., Args2...> LeechCraft::Util::Concat ( List< Args1... >  ,
List< Args2... >   
)

Definition at line 83 of file typelist.h.

◆ Concat() [2/3]

template<template< typename > class Container, typename T >
Container<T> LeechCraft::Util::Concat ( const Container< Container< T >> &  containers)

Definition at line 187 of file prelude.h.

Referenced by ConcatMap().

+ Here is the caller graph for this function:

◆ Concat() [3/3]

template<template< typename... > class Container, typename... ContArgs>
auto LeechCraft::Util::Concat ( const Container< ContArgs... > &  containers) -> std::decay_t<decltype (*containers.begin ())>

Definition at line 196 of file prelude.h.

◆ ConcatMap()

template<typename Cont , typename F >
auto LeechCraft::Util::ConcatMap ( Cont &&  c,
F &&  f 
)

Definition at line 205 of file prelude.h.

References Concat(), LeechCraft::Util::oral::sph::f, and Map().

Referenced by LeechCraft::Util::XDG::ToPaths().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ CreateIfNotExists()

UTIL_SYS_API QDir LeechCraft::Util::CreateIfNotExists ( QString  path)

Creates a path if it doesn't exist.

Creates a relative path ~/.leechcraft/path and throws an exception if this could not be done or if such path already exists and it is not readable.

Parameters
[in]pathThe path to create.
Returns
The newly created dir.
Exceptions
std::runtime_errorThrows if the path could not be created.

Definition at line 149 of file paths.cpp.

◆ CreateSeparator()

QAction * LeechCraft::Util::CreateSeparator ( QObject *  parent)

Returns the action that is set to act as a separator.

That is the action with setSeparator(true);

Parameters
[in]parentThe parent of the action.
Returns
The separator action.

Definition at line 268 of file util.cpp.

◆ Curry()

template<typename F >
CurryImpl<F> LeechCraft::Util::Curry ( f)

Definition at line 104 of file curry.h.

References LeechCraft::Util::oral::sph::f.

◆ DelayDestruction()

template<typename F >
void LeechCraft::Util::DelayDestruction ( const std::shared_ptr< F > &  obj)

Definition at line 106 of file delayedexecutor.h.

References ExecuteLater().

+ Here is the call graph for this function:

◆ DetectFileMime()

UTIL_SYS_API QByteArray LeechCraft::Util::DetectFileMime ( const QString &  path)

Definition at line 88 of file mimedetector.cpp.

◆ Do() [1/2]

template<typename MV >
auto LeechCraft::Util::Do ( const MV &  value)

Definition at line 97 of file monad.h.

Referenced by Do().

+ Here is the caller graph for this function:

◆ Do() [2/2]

template<typename MV , typename FHead , typename... FArgs>
auto LeechCraft::Util::Do ( const MV &  value,
const FHead &  fHead,
const FArgs &...  fArgs 
)

Definition at line 103 of file monad.h.

References Bind(), and Do().

+ Here is the call graph for this function:

◆ DomChildren()

auto LeechCraft::Util::DomChildren ( const QDomElement &  parent,
const QString &  tag 
)
inline

Creates a range iterating over direct children named tag.

The returned range is suitable for range-based for loops, in particular. For instance, the following is correct:

QDomDocument doc;
doc.setContent (R"(
<root>
<child num="1">first text</child>
<child num="2">second text</child>
<child num="3">third text</child>
</root>
)");
for (const auto& elem : MakeDomSiblingsRange (doc.firstChildElement ("root"), "child"))
qDebug () << elem.text () << elem.attribute ("num");

Modifying the underlying DOM tree will result in the same effects as modifying it during the canonical Qt-way of repeatedly calling QDomElement::nextSiblingElement() until the element becomes null.

Parameters
parentThe parent element whose children should be iterated over.
tagThe tag name of the child nodes (or an empty string for .
Returns
The range object representing the collection of the child nodes.

Definition at line 105 of file domchildrenrange.h.

◆ DrawOverlayText()

QPixmap LeechCraft::Util::DrawOverlayText ( QPixmap  px,
const QString &  text,
QFont  font,
const QPen &  pen,
const QBrush &  brush 
)

Definition at line 275 of file util.cpp.

◆ Drop()

template<int N, template< typename... > class List, typename... Args>
constexpr detail::DropImpl<N, List<Args...> >::Result_t LeechCraft::Util::Drop ( List< Args... >  )

Definition at line 77 of file typelist.h.

Referenced by LeechCraft::Util::detail::Dropper< F >::operator()().

+ Here is the caller graph for this function:

◆ DropArgs()

template<typename F >
detail::Dropper<F> LeechCraft::Util::DropArgs ( const F &  f)

Definition at line 124 of file dropargs.h.

References LeechCraft::Util::oral::sph::f.

◆ ElideProgressBarText()

UTIL_GUI_API QString LeechCraft::Util::ElideProgressBarText ( const QString &  text,
const QStyleOptionViewItem &  option 
)

Definition at line 150 of file util.cpp.

◆ EnableTransparency()

UTIL_QML_API void LeechCraft::Util::EnableTransparency ( QQuickWidget *  widget)

Definition at line 37 of file util.cpp.

Referenced by LeechCraft::Util::UnhideListViewBase::UnhideListViewBase().

+ Here is the caller graph for this function:

◆ EqualityBy()

template<typename R >
auto LeechCraft::Util::EqualityBy ( r)

Definition at line 258 of file prelude.h.

◆ ExecuteLater()

void LeechCraft::Util::ExecuteLater ( const DelayedExecutor::Actor_f actor,
int  delay = 0 
)
inline

Definition at line 100 of file delayedexecutor.h.

Referenced by DelayDestruction().

+ Here is the caller graph for this function:

◆ Filter()

template<typename T , template< typename U > class Container, typename F >
Container<T> LeechCraft::Util::Filter ( const Container< T > &  c,
f 
)

Definition at line 177 of file prelude.h.

References LeechCraft::Util::detail::Append(), and LeechCraft::Util::oral::sph::f.

+ Here is the call graph for this function:

◆ FindInSystemPath()

UTIL_SYS_API QString LeechCraft::Util::FindInSystemPath ( const QString &  name,
const QStringList &  paths,
const std::function< bool(QFileInfo)> &  filter = std::function< bool(QFileInfo)>() 
)

Searches for a file in system paths according to a filter.

This function searches for a file named name in system paths passed in paths and returns the full path for the first file that matches filter, or an empty string if nothing is found.

paths are most possibly obtained via GetSystemPaths(), but an arbitrary set of paths is fine too.

Parameters
[in]nameThe name of the file to search for.
[in]pathsThe paths to search in.
[in]filterThe filter function for the candidates.
Returns
The full path to the first found file or an empty string.

Definition at line 102 of file paths.cpp.

◆ First()

template<typename F >
auto LeechCraft::Util::First ( F &&  f)

Definition at line 270 of file prelude.h.

References LeechCraft::Util::oral::sph::f.

◆ FirstMatching()

template<typename F , typename G , typename Def , typename Head , typename... Args>
auto LeechCraft::Util::FirstMatching ( f,
g,
Def  def,
Util::Typelist< Head, Args... >   
)

Definition at line 185 of file typelist.h.

References LeechCraft::Util::oral::sph::f.

◆ Flip()

template<typename F >
auto LeechCraft::Util::Flip ( F &&  f)

Definition at line 282 of file prelude.h.

References LeechCraft::Util::oral::sph::f.

◆ Fmap()

template<typename T , typename F , typename = std::enable_if_t<IsFunctor<T> ()>>
FmapResult_t<T, F> LeechCraft::Util::Fmap ( const T &  functor,
const F &  function 
)

Apply the function f to the elements in functor.

This function forwards the function f to the instance of the Functor class (namely, InstanceFunctor<T>) for the type T to do the actual function application.

Parameters
[in]functorThe functor whose values are subject to function.
[in]functionThe function that should be applied to the values in the functor.
Returns
A functor of type FmapResult_t<T, F> where each element is the result of applying the function to the corresponding element in the source functor.
Template Parameters
TThe type of the functor.
FThe type of the function to apply to the elements inside the functor.
See also
InstanceFunctor

Definition at line 147 of file functor.h.

References LeechCraft::Util::InstanceFunctor< T >::Apply().

Referenced by operator*().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ FormatName()

UTIL_GUI_API QString LeechCraft::Util::FormatName ( const QString &  name)

HTML-formats the name to let the user know it is not a part of the fixed dialog text.

This function is useful to format an account name, a link title and similar entities in contexts like a dialog, a label or a tooltip. Using this function ensures this formatting is done in an uniform style across the whole GUI.

Parameters
[in]nameThe source string.
Returns
HTML-formatted name.

Definition at line 163 of file util.cpp.

◆ FromStdString()

QString LeechCraft::Util::FromStdString ( const std::string &  str)
inline

An utility function that creates a QString from UTF8-encoded std::string.

Parameters
[in]strThe UTF-8 encoded std::string.
Returns
The QString containing the same string.

Definition at line 54 of file util.h.

◆ GetAsBase64Src()

QString LeechCraft::Util::GetAsBase64Src ( const QImage &  image)

Returns the given image in a Base64-encoded form.

The return result is suitable for inserting into <img>'s src attribute as is.

Parameters
[in]imageThe image to represent as Base64-encoded form.
Returns
The source string.

Definition at line 50 of file util.cpp.

◆ GetDataFilters()

UTIL_XPC_API QList< QObject * > LeechCraft::Util::GetDataFilters ( const QVariant &  data,
IEntityManager manager 
)

Returns the data filter plugins that can handle data.

This function queries all available data filters plugins if they can handle data and returns the list of object instances that can handle it. The object instances are guaranteed to implement the IDataFilter interface as well as IEntityHandler interface.

The manager is used to obtain the list of plugins. It can be obtained from the ICoreProxy_ptr object that is passed to your plugin's Init() function.

Parameters
[in]dataThe data to query.
[in]managerThe manager used to get the plugins.
Returns
The list of data filters that can handle data.

Definition at line 94 of file util.cpp.

References IEntityManager::GetPossibleHandlers(), and MakeEntity().

+ Here is the call graph for this function:

◆ GetElementForTags()

template<typename TagGetter , typename TagSetter >
QDomElement LeechCraft::Util::GetElementForTags ( const QStringList &  tags,
QDomNode &  node,
QDomDocument &  document,
const QString &  elementName,
TagGetter  tagGetter,
TagSetter  tagSetter 
)

Returns an element for a given tags list.

This function tries to implement projection from tags to a hierarchical structure in form of XML. It traverses the tags list and creates child nodes from the document, appending the hierarchical structure's tree root to the node. It returns the parent element to which the item should be appended.

For empty tags list it just returns node converted to the QDomElement.

tagSetter is a function or functor that should be able to take two parameters, a QDomElement and a QString, and set tags for it.

tagGetter is a function or functor that should be able to take one parameter, a QDomElement, and return a QString for it with tags previously set with tagSetter.

Parameters
[in]tagsList of tags.
[in]nodeThe parent-most node to which all other nodes are appended.
[in]documentThe document containing all these nodes.
[in]elementNameThe name of the XML element that carries info about the tags.
[in]tagSetterSetter function for the tags for the given element.
[in]tagGetterGetter function for the tags for the given element.
Returns
Parent element of the item with tags.

Definition at line 224 of file util.h.

◆ GetInternetLocaleName()

QString LeechCraft::Util::GetInternetLocaleName ( const QLocale &  locale)

Definition at line 235 of file util.cpp.

◆ GetLanguage()

QString LeechCraft::Util::GetLanguage ( )

Returns the current language name.

This function works as GetLocaleName() except it doesn't return (and doesn't query for) country name.

Returns
Current language name.
See also
GetLocaleName()

Definition at line 245 of file util.cpp.

References GetLocaleName().

+ Here is the call graph for this function:

◆ GetLocaleName()

QString LeechCraft::Util::GetLocaleName ( )

Returns the current locale name, like en_US.

First, this function checks the locale value stored in "Language" key of settings object with organizationName() and applicationName(). If it's equal to "system", this function queries the LANG environment variable, and if it is empty or in invalid format (not like en_US), it takes the value of QLocale::system().name().

Then, if the resulting name the name of the language only, GetLocaleName() tries to find any countries for that language. If any countries are found, the code of the first found country is appended, else "_00" is appended.

Returns
Current locale name.
See also
GetLanguage()

Definition at line 204 of file util.cpp.

Referenced by GetLanguage(), and InstallTranslator().

+ Here is the caller graph for this function:

◆ GetPassword() [1/2]

UTIL_XPC_API QString LeechCraft::Util::GetPassword ( const QString &  keyName,
const QString &  dialogText,
const ICoreProxy_ptr proxy,
bool  useStore = true 
)

Returns password for the key, possibly asking the user.

This function returns password for the given keyName. The password is typically stored in a storage plugin like SecMan.

If the password isn't found in any password stores (or there are no password stores) or useStore is set to false, this function asks the user for the password instead using the dialogText for the dialog and returns the user input instead. If user has canceled the dialog it returns an null string. Otherwise, if the user has entered some text this function automatically stores the password under the keyName.

Note
Despite the name this function can be used to retrieve arbitrary string data saved via SavePassword().
Parameters
[in]keyNameThe name of the key uniquely identifying the password.
[in]dialogTextThe text of the dialog to present to the user if the password isn't found or useStore is false.
[in]proxyThe core proxy used to communicate with other plugins.
[in]useStoreWhether stored password should be used at all. Calling code may explicitly set this to false if the saved password is known to be invalid, for instance.
Returns
The password or a null string.
See also
SavePassword()

Definition at line 79 of file passutils.cpp.

References SavePassword().

+ Here is the call graph for this function:

◆ GetPassword() [2/2]

UTIL_XPC_API void LeechCraft::Util::GetPassword ( const QString &  key,
const QString &  diaText,
const ICoreProxy_ptr proxy,
const EitherCont< void(), void(QString)> &  cont,
QObject *  depender,
bool  useStored 
)

Definition at line 98 of file passutils.cpp.

◆ GetPathCandidates()

UTIL_SYS_API QStringList LeechCraft::Util::GetPathCandidates ( SysPath  path,
QString  subfolder 
)

Returns possible full paths for the path and subfolder.

This function returns a list of paths formed as the given root path identified by path plus the subfolder in it. The paths in the returned list aren't checked for existence.

For example, on Linux

const auto& paths = GetPathCandidates (SysPath::Share, "flags");

will return { "/usr/share/leechcraft/flags", "/usr/local/share/leechcraft/flags" }.

The subfolder can actually be a relative path, like flags/countries, not just a single subfolder name.

This function hardly needs to be called from user code, consider using GetSysPath() instead.

Parameters
[in]pathThe root path.
[in]subfolderThe subfolder inside the root path.
Returns
The list of possible paths to the subfolder in the root path identified by path.
See also
GetSysPath()

Definition at line 48 of file paths.cpp.

References QML, and Share.

Referenced by GetSysPath(), and LeechCraft::Util::UnhideListViewBase::UnhideListViewBase().

+ Here is the caller graph for this function:

◆ GetPersistentData()

UTIL_XPC_API QVariant LeechCraft::Util::GetPersistentData ( const QByteArray &  key,
const ICoreProxy_ptr proxy 
)

Returns persistent data stored under given key.

The persistent data itself is stored in plugins implementing the IPersistentStoragePlugin interface. This function uses the passed proxy to get the list of those.

If no data is found under the given key, a null QVariant is returned.

Parameters
[in]keyThe key to look for.
[in]proxyThe ICoreProxy object for getting the list of persistent storage plugins.
Returns
The data stored under the given key as a QVariant, or a null QVariant of no data is found (and, particularly, if no storage plugins are available).
See also
IPersistentStoragePlugin

Definition at line 148 of file util.cpp.

◆ GetServiceUrl()

UTIL_NETWORK_API QString LeechCraft::Util::GetServiceUrl ( const ServiceInfo info,
const QString &  path 
)

Definition at line 63 of file lcserviceoverride.cpp.

◆ GetSpaceInfo()

UTIL_SYS_API SpaceInfo LeechCraft::Util::GetSpaceInfo ( const QString &  path)

Returns the disk space info of the partition containing path.

Parameters
[in]pathThe path on the partition for which the space information should be returned.
Returns
The information about the disk space on the partition containing path.

Definition at line 176 of file paths.cpp.

◆ GetStdANFields()

UTIL_XPC_API QList< ANFieldData > LeechCraft::Util::GetStdANFields ( const QString &  category)

◆ GetSummarySelectedRows()

QModelIndexList LeechCraft::Util::GetSummarySelectedRows ( QObject *  sender)

Definition at line 250 of file util.cpp.

◆ GetSysPath()

UTIL_SYS_API QString LeechCraft::Util::GetSysPath ( SysPath  path,
const QString &  subfolder,
const QString &  filename 
)

Returns path to the file in the given root path and subfolder.

This function returns path to a file named filename and located in the path specified by path + subfolder. It actually checks whether the file exists and if it doesn't, returns a null string instead.

If LeechCraft is running on a system where multiple paths correspond to a single path, they are checked from more user-accessible to less user-accessible. For example, SysPath::Share corresponds to /usr/local/share/leechcraft and then /usr/share/leechcraft.

The subfolder can actually be a relative path, like flags/countries, not just a single subfolder name.

Refer to GetPathCandidates() for more information.

Parameters
[in]pathThe identifier of the root path.
[in]subfolderThe subfolder inside the path.
[in]filenameThe filename inside the path + subfolder.
Returns
Path to the filename located in path + subfolder, or an empty string if there is no such file.
See also
GetPathCandidates()
GetSysPathUrl()

Definition at line 79 of file paths.cpp.

References GetPathCandidates().

Referenced by GetSysPathUrl(), and LeechCraft::Util::UnhideListViewBase::UnhideListViewBase().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetSysPathUrl()

UTIL_SYS_API QUrl LeechCraft::Util::GetSysPathUrl ( SysPath  path,
const QString &  subfolder,
const QString &  filename 
)

Returns path to the file in the given root path and subfolder.

This function behaves exactly like GetSysPath(), but it returns the path as QUrl via the QUrl::fromLocalFile, so it is suitable, for example, for QML views.

Parameters
[in]pathThe identifier of the root path.
[in]subfolderThe subfolder inside the path.
[in]filenameThe filename inside the path + subfolder.
Returns
Path to the filename located in path + subfolder, or an empty URL if there is no such file.
See also
GetSysPath()

Definition at line 92 of file paths.cpp.

References GetSysPath().

+ Here is the call graph for this function:

◆ GetSystemPaths()

UTIL_SYS_API QStringList LeechCraft::Util::GetSystemPaths ( )

Returns the components of the system PATH variable.

This function gets the PATH variable from the environment, parses it and returns the list of the components to the caller.

Returns
System PATH components.
See also
FindInSystemPath()

Definition at line 97 of file paths.cpp.

◆ GetTemporaryName()

UTIL_SYS_API QString LeechCraft::Util::GetTemporaryName ( const QString &  pattern = QString("lc_temp.XXXXXX"))

Returns a temporary filename.

This function returns a name of a temporary file that could be created, not creating the file itself.

Parameters
[in]patternPattern of the filename.
Returns
The filename.

Definition at line 166 of file paths.cpp.

Referenced by LeechCraft::Util::DownloadHandler::DownloadHandler().

+ Here is the caller graph for this function:

◆ GetUserDir()

UTIL_SYS_API QDir LeechCraft::Util::GetUserDir ( UserDir  dir,
const QString &  subpath 
)

Definition at line 120 of file paths.cpp.

References Cache, and LC.

◆ GetUserText()

QString LeechCraft::Util::GetUserText ( const Entity entity)

Return the user-readable representation of the entity.

Parameters
[in]entityThe Entity from which to make the user-readable representation.
Returns
The user-readable string describing the entity.

Definition at line 59 of file util.cpp.

References LeechCraft::Entity::Additional_, LeechCraft::Entity::Entity_, and LeechCraft::Entity::Mime_.

◆ GSL()

template<typename AF , typename AV >
GSLResult_t<AF, AV> LeechCraft::Util::GSL ( const AF &  af,
const AV &  av 
)

Definition at line 57 of file applicative.h.

Referenced by operator*().

+ Here is the caller graph for this function:

◆ HandleNetworkReply()

template<typename F >
void LeechCraft::Util::HandleNetworkReply ( QObject *  context,
QNetworkReply *  reply,
f 
)

Definition at line 44 of file handlenetworkreply.h.

References LeechCraft::Util::oral::sph::f.

◆ HandleReply()

template<typename Err = Util::Void>
auto LeechCraft::Util::HandleReply ( QNetworkReply *  reply,
QObject *  context 
)

Definition at line 60 of file handlenetworkreply.h.

◆ HasSupportedImageExtension()

UTIL_SYS_API bool LeechCraft::Util::HasSupportedImageExtension ( const QString &  filename)

Checks if the given filename has a known image extension.

This function checks if the filename has an extension matching any image format known to QImageWriter.

Parameters
[in]filenameThe name of the file, either relative or absolute.
Returns
Whether the filename has a known image suffix.

Definition at line 38 of file util.cpp.

◆ InitJobHolderRow()

UTIL_XPC_API void LeechCraft::Util::InitJobHolderRow ( const QList< QStandardItem *> &  row)

◆ InstallTranslator()

QTranslator * LeechCraft::Util::InstallTranslator ( const QString &  base,
const QString &  prefix = "leechcraft",
const QString &  appname = "leechcraft" 
)

Loads and installs a translator.

Attempts to load and install a translator for the current locale. The name is formed like this: 'prefix_' + base + '_' + locale If base is an empty string, the second _ isn't appended.

First resources are searched (:/), then APPDIR/translations on Windows and /usr/[local/]share/appname/translations on Unix.

Parameters
[in]baseBase name of the translation file.
[in]prefixThe optional prefix of the translation (useful if it's not LC's one).
[in]appnameBase name of the application.
Returns
The translator object if loading is successful, NULL otherwise.

Definition at line 184 of file util.cpp.

References GetLocaleName(), and LoadTranslator().

+ Here is the call graph for this function:

◆ InvokeOn()

template<typename T , typename... Args>
auto LeechCraft::Util::InvokeOn ( T &&  t,
Args &&...  args 
)

Definition at line 173 of file visitor.h.

◆ IsFunctor()

template<typename T >
constexpr bool LeechCraft::Util::IsFunctor ( )

Checks whether the given type has a Functor instance for it.

Returns
Whether type T implements the Functor class.
Template Parameters
TThe type to check.

Definition at line 111 of file functor.h.

◆ IsMonadPlus()

template<typename T >
constexpr bool LeechCraft::Util::IsMonadPlus ( )

Definition at line 61 of file monadplus.h.

◆ LoadTranslator()

QTranslator * LeechCraft::Util::LoadTranslator ( const QString &  base,
const QString &  locale,
const QString &  prefix = "leechcraft",
const QString &  appname = "leechcraft" 
)

Definition at line 146 of file util.cpp.

Referenced by InstallTranslator().

+ Here is the caller graph for this function:

◆ Lookup()

template<template< typename Pair, typename... Rest > class Cont, template< typename K, typename V > class Pair, typename K , typename V , typename KV , typename... Rest>
boost::optional<V> LeechCraft::Util::Lookup ( const KV &  key,
const Cont< Pair< K, V >, Rest... > &  cont 
)

Definition at line 233 of file prelude.h.

◆ MakeAN()

UTIL_XPC_API Entity LeechCraft::Util::MakeAN ( const QString &  header,
const QString &  text,
Priority  priority,
const QString &  senderID,
const QString &  cat,
const QString &  type,
const QString &  id,
const QStringList &  visualPath,
int  delta = 1,
int  count = 0,
const QString &  fullText = QString(),
const QString &  extendedText = QString() 
)

Creates an Advanced Notifications-enabled notify entity.

Returns an entity with the given header, text and a bunch of other parameters that can be handled by Advanced Notifications.

The returned entity will also be handled by a visual notifications plugin if AN is not present. To avoid this set the MIME type of the result to x-leechcraft/notification+advanced.

Refer to the hand-written documentation for more information about using Advanced Notifications.

Parameters
[in]headerThe header of the notification. This field will also be used if AN is not present.
[in]textThe text of the notification. This field will also be used if AN is not present.
[in]priorityThe priority of this notification.
[in]senderIDThe ID of the plugin sending this notification.
[in]catThe category of this notification (one of Cat constants in interfaces/an/constants.h).
[in]typeThe type of this notification (one of Type constants in interfaces/an/constants.h).
[in]idThe ID of this notification, used to group consecutive notifications about similar events like incoming message from the same IM contact.
[in]visualPathThe list of names for a menu-like structure wishing to show this notification.
[in]deltaThe change of count of events with this id, or 0 to use count.
[in]countThe total count of events with this id, used if delta is 0.
[in]fullTextThe full text of this notification. If null, the text parameter is used.
[in]extendedTextThe extended text of this notification. If null, the text parameter is used.
See also
MakeANCancel()
MakeANRule()

Definition at line 46 of file util.cpp.

References LeechCraft::AN::EF::Count, LeechCraft::Util::oral::sph::count, LeechCraft::AN::EF::DeltaCount, LeechCraft::AN::EF::EventCategory, LeechCraft::AN::EF::EventID, LeechCraft::AN::EF::EventType, LeechCraft::AN::EF::ExtendedText, LeechCraft::AN::EF::FullText, MakeNotification(), LeechCraft::AN::EF::SenderID, and LeechCraft::AN::EF::VisualPath.

+ Here is the call graph for this function:

◆ MakeANCancel() [1/2]

UTIL_XPC_API Entity LeechCraft::Util::MakeANCancel ( const Entity event)

Makes an event for canceling another Advanced Notifications event.

Creates an Entity that cancels a previously generated Advanced Notifications event. The returned entity can be then emitted to notify plugins that the given event has been canceled.

Parameters
[in]eventThe event to cancel.
Returns
The Entity canceling the given event.

Definition at line 130 of file util.cpp.

References LeechCraft::Entity::Additional_, LeechCraft::AN::CatEventCancel, LeechCraft::Entity::Entity_, LeechCraft::AN::EF::EventCategory, LeechCraft::AN::EF::EventID, MakeNotification(), LeechCraft::PInfo_, and LeechCraft::AN::EF::SenderID.

+ Here is the call graph for this function:

◆ MakeANCancel() [2/2]

UTIL_XPC_API Entity LeechCraft::Util::MakeANCancel ( const QString &  senderId,
const QString &  eventId 
)

Makes an event for canceling another Advanced Notifications event.

Creates an Entity that cancels a previously generated Advanced Notifications event. The returned entity can be then emitted to notify plugins that the given event has been canceled.

This function doesn't take a previously created entity as the other overload does. Instead, it plainly creates the required entity from the given senderId and eventId. They should match those of the event in question.

Parameters
[in]senderIdThe ID of the sender of the event that is to be canceled.
[in]eventIdThe ID of the event that is to be canceled.
Returns
The Entity canceling the given event.

Definition at line 139 of file util.cpp.

References LeechCraft::Entity::Additional_, LeechCraft::AN::CatEventCancel, LeechCraft::AN::EF::EventCategory, LeechCraft::AN::EF::EventID, MakeNotification(), LeechCraft::PInfo_, and LeechCraft::AN::EF::SenderID.

+ Here is the call graph for this function:

◆ MakeANRule()

UTIL_XPC_API Entity LeechCraft::Util::MakeANRule ( const QString &  title,
const QString &  senderID,
const QString &  category,
const QStringList &  types,
AN::NotifyFlags  flags = AN::NotifyNone,
bool  openConfiguration = false,
const QList< QPair< QString, ANFieldValue >> &  fields = {} 
)

Creates an Entity defining an Advanced Notifications rule.

Returns an entity describing a notifications rule triggering under various conditions, defined by the parameters of this function.

Parameters
[in]titleThe human-readable title of the rule.
[in]senderIDThe plugin ID of the sender (must not be empty).
[in]categoryThe category of the event (must not be empty).
[in]typesThe types of events in the given category. If this list is empty, every event type matches.
[in]flagsThe flags describing the notification behavior for for this rule
[in]openConfigurationWhether the configuration widget for the just created rule should be opened automatically.
[in]fieldsThe list of pairs of a field ID (as in ANFieldData::ID_) and corresponding field value as ANFieldValue.
Returns
The Entity object describing a notifications rule for the passed parameters.
See also
MakeAN()

Definition at line 67 of file util.cpp.

References LeechCraft::Entity::Additional_, LeechCraft::AN::EF::EventCategory, LeechCraft::AN::EF::EventID, LeechCraft::AN::EF::EventType, LeechCraft::Util::oral::sph::fields, LeechCraft::AN::EF::IsSingleShot, MakeNotification(), LeechCraft::AN::EF::NotifyAudio, LeechCraft::AN::NotifyAudio, LeechCraft::AN::EF::NotifyPersistent, LeechCraft::AN::NotifyPersistent, LeechCraft::AN::NotifySingleShot, LeechCraft::AN::EF::NotifyTransient, LeechCraft::AN::NotifyTransient, LeechCraft::AN::EF::OpenConfiguration, LeechCraft::PLog_, and LeechCraft::AN::EF::SenderID.

+ Here is the call graph for this function:

◆ MakeCertificateViewerDialog()

UTIL_GUI_API QDialog * LeechCraft::Util::MakeCertificateViewerDialog ( const QSslCertificate &  cert,
QWidget *  parent 
)

Definition at line 94 of file sslcertificateinfowidget.cpp.

References Close.

◆ MakeDatabase()

QSqlDatabase LeechCraft::Util::MakeDatabase ( const QString &  name = ":memory:")

Definition at line 74 of file common.h.

References GenConnectionName(), and RunTextQuery().

Referenced by BOOST_FUSION_ADAPT_STRUCT().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ MakeEndGroupScopeGuard()

auto LeechCraft::Util::MakeEndGroupScopeGuard ( QSettings &  settings)
inline

Creates a scope guard that ends the current group on settings.

Parameters
[in]settingsThe QSettings object whose current group should be ended on scope exit.
Returns
The scope guard calling QSettings::endGroup() on the settings object on scope exit.
Note
BeginGroup() is preferable for most use cases.
See also
BeginGroup()

Definition at line 50 of file scopeguards.h.

References MakeScopeGuard().

+ Here is the call graph for this function:

◆ MakeEntity() [1/2]

Entity LeechCraft::Util::MakeEntity ( const QVariant &  entity,
const QString &  location,
TaskParameters  tp,
const QString &  mime 
)

◆ MakeEntity() [2/2]

UTIL_XPC_API Entity LeechCraft::Util::MakeEntity ( const QVariant &  entity,
const QString &  location,
LeechCraft::TaskParameters  tp,
const QString &  mime = QString() 
)

An utility function to make a Entity.

Creates a Entity that wraps the given entity from given location with parameterrs identified by tp and given mime type (which is null by default).

This function is provided for convenience and is equivalent to manually filling the Entity.

Parameters
[in]entityThe Entity_ field of the Entity.
[in]locationThe Location_ field of the Entity.
[in]tpThe Params_ field of the Entity.
[in]mimeThe Mime_ field of the Entity.
Returns
The resulting Entity.
See also
Entity, MakeNotification()

◆ MakeLambdaEventFilter()

template<typename F >
auto LeechCraft::Util::MakeLambdaEventFilter ( F &&  f,
QObject *  parent = nullptr 
)

Definition at line 67 of file lambdaeventfilter.h.

References LeechCraft::Util::oral::sph::f.

◆ MakeLazy()

template<typename T >
Lazy_t<T> LeechCraft::Util::MakeLazy ( const T &  t)

Definition at line 43 of file lazy.h.

◆ MakeLazyF()

template<typename R , typename F >
Lazy_t<R> LeechCraft::Util::MakeLazyF ( const F &  l)

Definition at line 49 of file lazy.h.

◆ MakeNotification()

UTIL_XPC_API Entity LeechCraft::Util::MakeNotification ( const QString &  header,
const QString &  text,
Priority  priority 
)

An utility function to make a Entity with notification.

Creates a Entity that holds information about user-visible notification. These notifications have "x-leechcraft/notification" MIME.

You can further customize the returned Entity to suit your exact needs. See the documentation for Entity about such entities.

Parameters
[in]headerThe header of the notification.
[in]textThe text of the notification.
[in]priorityThe priority level of the notification.
Returns
The Entity containing the corresponding notification.
See also
Entity, MakeEntity()

Definition at line 118 of file util.cpp.

References LeechCraft::Entity::Additional_, LeechCraft::AutoAccept, MakeEntity(), and LeechCraft::OnlyHandle.

Referenced by MakeAN(), MakeANCancel(), and MakeANRule().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ MakePrettySize()

QString LeechCraft::Util::MakePrettySize ( qint64  sourceSize)

Makes a formatted size from number.

Converts, for example, 1048576 to 1.0 MB.

Parameters
[in]sourceSizeSize in bytes.
Returns
Formatted string.
See also
MakeTimeFromLong()
MakePrettySizeShort()

Definition at line 109 of file util.cpp.

◆ MakePrettySizeShort()

QString LeechCraft::Util::MakePrettySizeShort ( qint64  size)

Converts a bytes count to a string representation with appropriately chosen units.

Converts, for example, 1048576 to 1.0 M.

As opposed to MakePrettySize(), this function tries to keep the returned string short.

Parameters
[in]sizeSize in bytes.
Returns
Formatted string in relevant units.
See also
MakeTimeFromLong()
MakePrettySize()

Definition at line 122 of file util.cpp.

◆ MakeScopeGuard()

template<typename F >
detail::ScopeGuard<F> LeechCraft::Util::MakeScopeGuard ( const F &  f)

Returns an object performing passed function on scope exit.

The returned object performs the passed function f upon destruction (and, thus, on scope exit).

The object is not copyable and not movable, and otherwise is implementation-defined.

Typical usage:

QSettings settings { "OrgNameName", "AppName" };
settings.beginGroup ();
const auto guard = Util::MakeScopeGuard ([&settings] { settings.endGroup (); });
// ...
Parameters
[in]fThe function to execute on scope exit. Should be a callable without any arguments.
Returns
An object executing f on destruction.

Definition at line 157 of file util.h.

References LeechCraft::Util::oral::sph::f.

Referenced by BeginGroup(), LeechCraft::Util::DownloadHandler::DownloadHandler(), MakeEndGroupScopeGuard(), LeechCraft::Util::SvcAuth::VkAuthManager::ManageQueue(), LeechCraft::Util::Visitor< FinallyFunc, Args >::operator()(), LeechCraft::Util::NetworkDiskCacheGC::RegisterDirectory(), and LeechCraft::Util::CustomCookieJar::setCookiesFromUrl().

+ Here is the caller graph for this function:

◆ MakeTimeFromLong()

QString LeechCraft::Util::MakeTimeFromLong ( ulong  time)

Makes a formatted time from number.

Converts, for example 256 to 00:04:16.

Parameters
[in]timeTime interval in seconds.
Returns
DateTime object.
See also
MakePrettySize

Definition at line 135 of file util.cpp.

◆ Map()

template<typename Container , typename F >
auto LeechCraft::Util::Map ( Container &&  c,
f 
)

◆ MapAs()

template<template< typename... > class Fallback, typename Container , typename F >
auto LeechCraft::Util::MapAs ( Container &&  c,
F &&  f 
)

Definition at line 171 of file prelude.h.

References LeechCraft::Util::oral::sph::f.

◆ MkWaiter()

auto LeechCraft::Util::MkWaiter ( )
inline

Definition at line 40 of file common.h.

◆ Mzero()

template<typename MP >
MP LeechCraft::Util::Mzero ( )

Definition at line 67 of file monadplus.h.

◆ OpenXSD()

UTIL_XSD_API XmlSettingsDialog * LeechCraft::Util::OpenXSD ( const QString &  title,
const QString &  filename,
Util::BaseSettingsManager *  bsm 
)

Opens XML settings dialog for the given XML filename.

The dialog is opened as non-modal and non-blocking and is automatically shown. The dialog is also set to be automatically deleted as soon as it is closed.

Parameters
[in]titleThe title of the dialog.
[in]filenameThe XML settings file to use to build the dialog.
[in]bsmThe instance of BaseSettingsManager to use for storing the settings.
Returns
The XML settings dialog.

Definition at line 40 of file util.cpp.

◆ operator!=()

bool LeechCraft::Util::operator!= ( const ModelIterator left,
const ModelIterator right 
)

For iterators to not be equal at least either the model, parent index, row or column should be unequal. Traversal index is not taken into account.

Parameters
[in]leftFirst iterator to check for inequality.
[in]rightSecond iterator to check for inequality.
Returns
Whether left and right are equal.

Definition at line 99 of file modeliterator.cpp.

◆ operator*() [1/3]

template<typename AF , typename AV >
auto LeechCraft::Util::operator* ( const AF &  af,
const AV &  av 
) -> decltype (GSL (af, av))

Definition at line 63 of file applicative.h.

References GSL().

+ Here is the call graph for this function:

◆ operator*() [2/3]

template<typename T , typename F >
auto LeechCraft::Util::operator* ( const F &  function,
const T &  functor 
) -> decltype (Fmap (functor, function))

An operator-style alias for Fmap().

This operator allows writing Fmap()'s in infix form. Internally, it just forwards the call to Fmap().

Parameters
[in]functorThe functor whose values are subject to function.
[in]functionThe function that should be applied to the values in the functor.
Returns
A functor of type FmapResult_t<T, F> where each element is the result of applying the function to the corresponding element in the source functor.
Template Parameters
TThe type of the functor.
FThe type of the function to apply to the elements inside the functor.
See also
InstanceFunctor
Fmap()

Definition at line 173 of file functor.h.

References Fmap().

+ Here is the call graph for this function:

◆ operator*() [3/3]

template<typename T , typename F >
auto LeechCraft::Util::operator* ( const T &  functor,
const F &  function 
) -> decltype (Fmap (functor, function))

An operator-style alias for Fmap().

This operator allows writing Fmap()'s in infix form. Internally, it just forwards the call to Fmap().

Parameters
[in]functorThe functor whose values are subject to function.
[in]functionThe function that should be applied to the values in the functor.
Returns
A functor of type FmapResult_t<T, F> where each element is the result of applying the function to the corresponding element in the source functor.
Template Parameters
TThe type of the functor.
FThe type of the function to apply to the elements inside the functor.
See also
InstanceFunctor
Fmap()

Definition at line 199 of file functor.h.

References Fmap().

+ Here is the call graph for this function:

◆ operator+()

template<typename MP >
auto LeechCraft::Util::operator+ ( const MP &  m1,
const MP &  m2 
) -> decltype (Mplus (m1) (m2))

Definition at line 82 of file monadplus.h.

References Mplus.

◆ operator==()

bool LeechCraft::Util::operator== ( const ModelIterator left,
const ModelIterator right 
)

For iterators to be equal the model, parent index, row and column should all be equal. Traversal index is not taken into account.

Parameters
[in]leftFirst iterator to check for equality.
[in]rightSecond iterator to check for equality.
Returns
Whether left and right are equal.

Definition at line 91 of file modeliterator.cpp.

◆ operator>>()

template<typename MV , typename F >
auto LeechCraft::Util::operator>> ( const MV &  value,
const F &  f 
) -> decltype (Bind (value, f))

Definition at line 91 of file monad.h.

References Bind(), and LeechCraft::Util::oral::sph::f.

+ Here is the call graph for this function:

◆ ParseJson() [1/2]

QVariant LeechCraft::Util::ParseJson ( const QByteArray &  bytes,
const char *  context 
)
inline

Parses JSON content in the given bytearray.

This functions uses QJson on Qt4 (don't forget to link to it!) and Qt's native JSON parsers on Qt5.

Parameters
[in]bytesThe byte array to parse JSON from.
[in]contextThe context string to be used in logging messages.
Returns
The recursive QVariant with JSON contents.

Definition at line 52 of file parsejson.h.

Referenced by ParseJson().

+ Here is the caller graph for this function:

◆ ParseJson() [2/2]

QVariant LeechCraft::Util::ParseJson ( QIODevice *  device,
const char *  context 
)
inline

Utility function parsing JSON from the device.

This function reads all available data from the device and passes it to the other ParseJson() overload.

Parameters
[in]deviceThe device from which JSON-encoded data should be read.
[in]contextThe context string to be used in logging messages.
Returns
The recursive QVariant with JSON contents.

Definition at line 77 of file parsejson.h.

References ParseJson().

+ Here is the call graph for this function:

◆ PartitionEithers()

template<template< typename > class Cont, typename L , typename R >
std::pair<Cont<L>, Cont<R> > LeechCraft::Util::PartitionEithers ( const Cont< Either< L, R >> &  eithers)

Definition at line 196 of file either.h.

◆ Pure() [1/2]

template<template< typename... > class Applicative, typename... Args, typename T >
auto LeechCraft::Util::Pure ( const T &  v)

Definition at line 45 of file applicative.h.

Referenced by Return().

+ Here is the caller graph for this function:

◆ Pure() [2/2]

template<typename Applicative , typename T >
auto LeechCraft::Util::Pure ( const T &  v) -> decltype (InstanceApplicative<Applicative>::Pure (v))

Definition at line 51 of file applicative.h.

◆ Q_DECLARE_FLAGS()

LeechCraft::Util::Q_DECLARE_FLAGS ( FitFlags  ,
FitFlag   
)

◆ Return()

template<template< typename... > class Monad, typename... Args, typename V >
auto LeechCraft::Util::Return ( const V &  v)

Definition at line 44 of file monad.h.

References Pure().

+ Here is the call graph for this function:

◆ Reverse() [1/2]

template<template< typename... > class List>
constexpr List LeechCraft::Util::Reverse ( List<>  )

Definition at line 89 of file typelist.h.

◆ Reverse() [2/2]

template<template< typename... > class List, typename Head , typename... Tail>
constexpr auto LeechCraft::Util::Reverse ( List< Head, Tail... >  ) -> decltype (Concat (Reverse (List<Tail...>

Definition at line 95 of file typelist.h.

◆ RightOr() [1/2]

template<typename L , typename R , typename F , typename = std::result_of_t<F ()>>
R LeechCraft::Util::RightOr ( const Either< L, R > &  either,
F &&  f 
)

Definition at line 180 of file either.h.

References LeechCraft::Util::oral::sph::f, LeechCraft::Util::Either< L, R >::GetRight(), and LeechCraft::Util::Either< L, R >::IsRight().

+ Here is the call graph for this function:

◆ RightOr() [2/2]

template<typename L , typename R >
R LeechCraft::Util::RightOr ( const Either< L, R > &  either,
const R &  r 
)

Definition at line 188 of file either.h.

References LeechCraft::Util::Either< L, R >::GetRight(), and LeechCraft::Util::Either< L, R >::IsRight().

+ Here is the call graph for this function:

◆ Save2MimeData()

template<typename T >
void LeechCraft::Util::Save2MimeData ( QMimeData *  mimeData,
const QString &  name,
const T &  t 
)

Definition at line 203 of file util.h.

◆ SavePassword()

UTIL_XPC_API void LeechCraft::Util::SavePassword ( const QString &  password,
const QString &  keyName,
const ICoreProxy_ptr proxy 
)

Saves the password to be retrieved later via GetPassword().

This function stores the password under the given keyName. The password is typically stored in a storage plugin like SecMan.

If there are no storage plugins, this function does nothing.

Note
Despite the name this function can be used to save arbitrary string data in secure storages like SecMan.
Parameters
[in]passwordThe password string to save.
[in]keyNameThe name of the key uniquely identifying the password.
[in]proxyThe core proxy used to communicate with other plugins.
See also
GetPassword()

Definition at line 153 of file passutils.cpp.

Referenced by GetPassword().

+ Here is the caller graph for this function:

◆ Second()

template<typename F >
auto LeechCraft::Util::Second ( F &&  f)

Definition at line 276 of file prelude.h.

References LeechCraft::Util::oral::sph::f.

◆ SerializeJson()

QByteArray LeechCraft::Util::SerializeJson ( const QVariant &  var,
bool  compact = true 
)
inline

Serializes the given var to JSON representation.

This function abstracts away differences between Qt4 and Qt5. It uses QJson on Qt4 (don't forget to link to it!) and native JSON functions on Qt5.

Parameters
[in]varThe recursive variant to be serialized to JSON.
[in]compactWhether the output should be compacitified (this parameter may have no effect).
Returns
The serialized representation of var.

Definition at line 50 of file serializejson.h.

◆ SetJobHolderProgress() [1/2]

UTIL_XPC_API void LeechCraft::Util::SetJobHolderProgress ( const QList< QStandardItem * > &  row,
qint64  done,
qint64  total,
const QString &  text 
)

Sets the progress values on the given row.

This function first retrieves the QStandardItem object at the position defined by JobHolderColumn::JobProgress in the passed row and then sets its text to text and updates the ProcessStateInfo structure under the JobHolderRole::ProcessState role to have the given amount of done and total.

Parameters
[in]rowThe row to set data on.
[in]doneThe amount of work done.
[in]totalThe total amount of work.
[in]textThe text that the progress-related item should have in the row.
See also
ProcessStateInfo

Definition at line 166 of file util.cpp.

References LeechCraft::JobProgress.

◆ SetJobHolderProgress() [2/2]

UTIL_XPC_API void LeechCraft::Util::SetJobHolderProgress ( QStandardItem *  item,
qint64  done,
qint64  total 
)

Sets the done and total progress values on the given item.

This function updates the ProcessStateInfo structure stored under the JobHolderRole::ProcessState role in the given item.

Parameters
[in]itemThe item to set data on.
[in]doneThe amount of work done.
[in]totalThe total amount of work.
See also
ProcessStateInfo

Definition at line 177 of file util.cpp.

References LeechCraft::ProcessStateInfo::Done_, and LeechCraft::ProcessState.

◆ Sorted()

template<typename Cont >
Cont LeechCraft::Util::Sorted ( Cont &&  cont)

Definition at line 243 of file prelude.h.

◆ SplitInto()

template<template< typename > class Container, typename T >
Container<Container<T> > LeechCraft::Util::SplitInto ( size_t  numChunks,
const Container< T > &  container 
)

Definition at line 211 of file prelude.h.

◆ Stlize()

template<template< typename K, typename V > class PairType = std::pair, typename Assoc >
auto LeechCraft::Util::Stlize ( Assoc &&  assoc) -> detail::StlAssocRange<detail::Identity, detail::Identity, decltype (assoc.begin ()), Assoc, PairType>

Converts an Qt's associative sequence assoc to an STL-like iteratable range.

This function takes an associative container assoc (one of Qt's containers like QHash and QMap) and returns a range with value_type equal to PairType<K, V>.

This way, both the key and the value of each pair in the assoc can be accessed in a range-for loop, for example.

Example usage:

for (const auto& pair : Util::Stlize (someMap))
qDebug () << pair.first // outputs a QString key
<< pair.second; // outputs an integer value corresponding to the key

All kinds of accesses are supported: elements of a non-const container may be modified via the iterators in the returned range.

Parameters
[in]assocThe Qt's associative container to iterate over.
Returns
A range with iterators providing access to both the key and the value via its value_type.
Template Parameters
PairTypeThe type of the pairs that should be used in the resulting range's iterators' value_type.
AssocThe type of the source Qt associative container.

Definition at line 166 of file qtutil.h.

Referenced by LeechCraft::Util::WkFontsWidget::accept(), LeechCraft::Util::MassFontChangeDialog::GetFamilies(), LeechCraft::Util::oral::detail::HandleExprTree(), and LeechCraft::Util::WkFontsWidget::RegisterSettable().

+ Here is the caller graph for this function:

◆ StlizeCopy()

template<template< typename K, typename V > class PairType = std::pair, typename Assoc >
auto LeechCraft::Util::StlizeCopy ( Assoc &&  assoc) -> detail::StlAssocRange<std::decay, std::decay, decltype (assoc.begin ()), Assoc, PairType>

Definition at line 172 of file qtutil.h.

◆ swap()

void LeechCraft::Util::swap ( FDGuard g1,
FDGuard g2 
)

Definition at line 74 of file fdguard.cpp.

◆ Tail()

template<template< typename... > class List, typename H , typename... T>
constexpr List<T...> LeechCraft::Util::Tail ( List< H, T... >  )

Definition at line 56 of file typelist.h.

◆ Unreachable()

void LeechCraft::Util::Unreachable ( )
inline

◆ Visit() [1/3]

template<typename... Vars, typename... Args>
decltype(auto) LeechCraft::Util::Visit ( const boost::variant< Vars... > &  v,
Args &&...  args 
)

Definition at line 110 of file visitor.h.

References LeechCraft::Util::detail::DetectCommonType().

+ Here is the call graph for this function:

◆ Visit() [2/3]

template<typename... Vars, typename... Args>
decltype(auto) LeechCraft::Util::Visit ( boost::variant< Vars... > &  v,
Args &&...  args 
)

Definition at line 119 of file visitor.h.

References LeechCraft::Util::detail::DetectCommonType().

+ Here is the call graph for this function:

◆ Visit() [3/3]

template<typename Left , typename Right , typename... Args>
auto LeechCraft::Util::Visit ( const Either< Left, Right > &  either,
Args &&...  args 
)

Definition at line 209 of file either.h.

References LeechCraft::Util::Either< L, R >::AsVariant().

Referenced by LeechCraft::Util::Visitor< FinallyFunc, Args >::operator()().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Visitor()

template<typename... Args>
LeechCraft::Util::Visitor ( Args &&  ...) -> Visitor< Void, Args... >

◆ Zip()

template<typename T1 , typename T2 , template< typename U > class Container, template< typename U1, typename U2 > class Pair = QPair>
auto LeechCraft::Util::Zip ( const Container< T1 > &  c1,
const Container< T2 > &  c2 
) -> Container<Pair<T1, T2>>

Definition at line 82 of file prelude.h.

References ZipWith().

+ Here is the call graph for this function:

◆ ZipWith()

template<typename T1 , typename T2 , template< typename U > class Container, typename F >
auto LeechCraft::Util::ZipWith ( const Container< T1 > &  c1,
const Container< T2 > &  c2,
f 
) -> WrapType_t<Container<std::decay_t<std::result_of_t<F (T1, T2)>>>>

Definition at line 65 of file prelude.h.

References LeechCraft::Util::oral::sph::f.

Referenced by LeechCraft::Util::oral::detail::AdaptCreateTable(), and Zip().

+ Here is the caller graph for this function:

Variable Documentation

◆ AllOf

template<template< typename > class Pred, typename... Args>
constexpr auto LeechCraft::Util::AllOf = (Pred<Args> {} && ...)

Definition at line 55 of file typelevel.h.

◆ AnyOf

template<template< typename > class Pred, typename... Args>
constexpr auto LeechCraft::Util::AnyOf = (Pred<Args> {} || ...)

Definition at line 58 of file typelevel.h.

◆ Apply

const auto LeechCraft::Util::Apply = [] (const auto& t) { return t (); }

Definition at line 263 of file prelude.h.

◆ Fst

const auto LeechCraft::Util::Fst = [] (const auto& pair) { return pair.first; }

Definition at line 265 of file prelude.h.

◆ Id

const auto LeechCraft::Util::Id = [] (const auto& t) { return t; }

Definition at line 249 of file prelude.h.

◆ IsDetected_v

template<template< typename... > class Op, typename... Args>
constexpr bool LeechCraft::Util::IsDetected_v = detail::IsDetected<void, void, Op, Args...>::value_t::value

Definition at line 56 of file detector.h.

Referenced by LeechCraft::Util::oral::detail::InitializeFromQuery().

◆ List< Head >

LeechCraft::Util::List< Head >

Definition at line 95 of file typelist.h.

◆ Mplus

const { ... } LeechCraft::Util::Mplus

Referenced by operator+().

◆ Msum

const { ... } LeechCraft::Util::Msum

◆ Overload

template<typename... Args>
constexpr OverloadBase<Args...> LeechCraft::Util::Overload {}

Definition at line 53 of file overload.h.

◆ Snd

const auto LeechCraft::Util::Snd = [] (const auto& pair) { return pair.second; }

Definition at line 267 of file prelude.h.

◆ SourcePager

◆ StateAdd

const int LeechCraft::Util::StateAdd = 1

◆ StateRemove

const int LeechCraft::Util::StateRemove = 0

◆ Upcast

template<typename To >
constexpr auto LeechCraft::Util::Upcast = Upcaster<To> {}

Definition at line 94 of file functional.h.