LC::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
struct	CoreProxyHolder
class	CpuFeatures
class	CurryImpl
class	CurryTest
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	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
struct	DownloadParams
class	DummyObject
class	Dumper
class	Either
class	EitherCont
	A peir of two functions, typically a continuation and an error handler. More...
class	EitherTest
struct	ErrorInfo
class	ExtensionsData
class	FailedImpl
class	FDGuard
class	FindNotification
	A horizontal bar with typical widgets for text search. More...
class	FindNotificationWE
	A helper class to aid connecting FindNotification with QtWebEngine. More...
class	FindNotificationWk
	A helper class to aid connecting FindNotification with Qt WebKit. More...
class	FlatItemsModel
class	FlatItemsModelBase
class	FlatItemsModelTypedBase
class	FlattenFilterModel
	Proxy model flattening a hierarchical model. More...
class	FlatToFoldersProxyModel
struct	FlatTreeItem
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< Either< L, R > >
struct	InstanceApplicative< std::optional< T > >
struct	InstanceFunctor
	The Functor class is used for types that can be mapped over. More...
struct	InstanceFunctor< Either< L, R > >
struct	InstanceFunctor< QFuture< T > >
struct	InstanceFunctor< std::optional< T > >
	Implementation of the Functor class for std::optional. More...
struct	InstanceMonad
struct	InstanceMonad< Either< L, R > >
struct	InstanceMonad< std::optional< T > >
struct	InstanceMonadPlus
struct	InstanceMonadPlus< std::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...
struct	Literal
class	MassFontChangeDialog
class	MergeModel
struct	MimeDetector
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
class	OralTest_SimpleRecord
class	OralTest_SimpleRecord_Bench
class	PageNotification
	A horizontal widget embedding into the parent layout of the passed parent widget. More...
class	PlotItem
class	PreludeTest
struct	QStringToLower
struct	QStringTrimmed
class	QueueManager
	A simple scheduling manager for a queue of functors. More...
class	RegExp
struct	RegExpImpl
struct	ReplyError
struct	ReplyWithHeaders
struct	RequiresInit
class	ResourceLoader
	Utility class for loading a file from a set of locations. More...
struct	ResultInfo
class	RoledItemsModel
struct	RoledMemberField
class	RoleNamesMixin
	Wraps differences between role names handling in Qt4 and Qt5. More...
struct	S1
struct	S2
class	ScopeGuardTest
class	ScreensaverProhibitor
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	StringPathTrie
class	StringPathTrieTest
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...
struct	Tokenize
class	TokenizeTest
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	UtilTest
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...
struct	Worker
class	WorkerThread
class	WorkerThreadBase
class	WorkerThreadTest
struct	WrapType
struct	WrapType< QList< QString > >
class	XWrapper

Typedefs
typedef std::shared_ptr< XmlSettingsDialog >	XmlSettingsDialog_ptr
using	FlatTreeItem_ptr = std::shared_ptr< FlatTreeItem >
typedef std::shared_ptr< ModelItem >	ModelItem_ptr
typedef std::weak_ptr< ModelItem >	ModelItem_wtr
typedef QVector< ModelItem_ptr >	ModelItemsList_t
typedef std::shared_ptr< const ModelItem >	ModelItem_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
using	SerializeResult_t = Either< QString, Void >
template<typename T >
using	DoSmthDetector = decltype(std::declval< T >().DoSmth(QString {}))
using	SomeEither_t = Either< int, QString >
using	IntTrie = StringPathTrie< int >
using	FindResult = IntTrie::FindResult
using	QSVV = QList< QStringView >
template<typename T >
using	IsVoid_t = std::is_same< T, void >
using	Variant_t = std::variant< int, char, std::string, QString, double, float >
using	SVariant_t = std::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::tuple_element_t< 0, decltype(detail::TypeGetter(*static_cast< F * >(nullptr)))>
template<typename PtrType >
using	MemberTypeType_t = typename detail::DecomposeMemberPtr< PtrType >::Value_t
template<typename PtrType >
using	MemberTypeStruct_t = typename detail::DecomposeMemberPtr< PtrType >::StructType_t
template<auto Ptr>
using	MemberPtrType_t = MemberTypeType_t< decltype(Ptr)>
template<auto Ptr>
using	MemberPtrStruct_t = MemberTypeStruct_t< decltype(Ptr)>
template<typename List >
using	Head_t = typename Head< List >::Head_t
template<typename T >
using	AsTypelist_t = typename AsTypelist< T >::Result_t
template<template< typename > class Name, typename Def , typename... Args>
using	Find = typename detail::Find< Name, Def, Args... >::type
using	DefaultScopeGuard = detail::ScopeGuard< detail::DefaultScopeGuardDeleter >
using	QIODevice_ptr = std::shared_ptr< QIODevice >
using	QtException_t = QException
using	QtException_ptr = std::shared_ptr< QtException_t >
using	ConcurrentStdException = Util::ConcurrentException< Util::NewType< std::exception, struct StdException > >
using	DefaultHookProxy_ptr = std::shared_ptr< DefaultHookProxy >
using	TempResultType_t = Util::Either< IDownload::Error, QByteArray >
using	Introspect_f = std::function< QVariantMap(QVariant)>
using	LazyNotificationPixmap_t = std::function< std::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:")
template<typename T >
auto	PrepareRecords (QSqlDatabase db, int count=3)
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>
T	GetLastId (const QSqlQuery &query)
	Gets the last insert ID for the given query. More...
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...
QScreen *	GetScreenWithFallback (const QPoint &p)
QRect	AvailableGeometry (const QPoint &p)
QRect	ScreenGeometry (const QPoint &p)
	Q_DECLARE_FLAGS (FitFlags, FitFlag)
QDialog *	MakeCertificateViewerDialog (const QSslCertificate &cert, QWidget *parent)
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...
QPixmap	DrawOverlayText (QPixmap px, const QString &text, QFont font, const QPen &pen, const QBrush &brush)
template<typename T >
void	Save2MimeData (QMimeData *mimeData, const QString &name, const T &t)
FlatTreeItem *	ToFlat (const QModelIndex &idx)
bool	operator== (const ModelIterator &left, const ModelIterator &right)
bool	operator!= (const ModelIterator &left, const ModelIterator &right)
template<typename F >
void	EnumerateChildren (const QModelIndex &idx, bool includingRoot, F &&f)
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... Args>
auto	HandleReply (QNetworkReply *reply, QObject *context)
template<typename... Args>
auto	HandleReplySeq (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	WatchQmlErrors (QQuickWidget *view)
	Utility function for logging errors from a QML view. 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<typename Obj >
void	CreateShortcuts (const QList< QKeySequence > &seqs, Obj *obj, void(Obj::*member)(), QWidget *parent)
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))
QDomElement	BuildTagsTree (QStringList tags, QDomNode &node, QDomDocument &document, const QString &elementName, const std::function< QString(QDomElement)> &tagGetter, const std::function< void(QDomElement &, QString)> &tagSetter)
	Builds a nested sequence of DOM elements representing a list of tags. More...
template<typename T >
auto	AsSet (const T &cont)
template<typename F , typename... Args>
CurryImpl< std::decay_t< F >, Args... >	Curry (F &&f, Args &&... args)
auto	DomChildren (const QDomNode &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 ()>>
R	RightOr (const Either< L, R > &either, F &&f)
template<typename L , typename R >
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<template< typename U > class Container, typename T1 , typename T2 , 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) noexcept(noexcept(std::is_nothrow_invocable_v< F, decltype(*c.begin())>))
template<template< typename... > class Fallback, typename Container , typename F >
auto	MapAs (Container &&c, F &&f) noexcept(noexcept(std::is_nothrow_invocable_v< F, decltype(*c.begin())>))
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<typename Cont >
decltype(auto)	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 Assoc >
auto	Stlize (Assoc &&assoc) noexcept
	Converts an Qt's associative sequence assoc to an STL-like iteratable range. More...
QByteArray	AsByteArray (std::string_view view) noexcept
	Convert the view into a QByteArray without copying. More...
QByteArray	ToByteArray (std::string_view view) noexcept
	Create a QByteArray with the data referenced by the view. More...
std::string_view	AsStringView (const QByteArray &arr) noexcept
	Create a std::string_view referring the data within a QByteArray. More...
template<typename T , typename S >
std::pair< T, T >	BreakAt (const T &str, S c) noexcept
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...
SerializeResult_t	SerializeJsonToFile (const QString &filename, const QVariant &var, bool compact)
template<typename K >
constexpr uint64_t	DefaultHashImpl (K)
template<>
constexpr uint64_t	DefaultHashImpl (std::string_view name)
constexpr uint64_t	DefaultHash (auto val)
template<typename K , typename V , auto Hasher = DefaultHash<K>>
consteval auto	MakeHash (auto &&... commands)
template<typename V >
consteval auto	MakeStringHash (auto &&... commands)
QVector< QStringView >	AsRefs (const QVector< QString > &lst)
auto	TokenizeFwd (QStringView str)
auto	TokenizeRev (QStringView str)
auto	Reversed (auto container)
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 std::variant< Vars... > &v, Args &&... args)
template<typename... Vars, typename... Args>
decltype(auto)	Visit (std::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={})
	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={})
	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...
bool	IsOSXLoadFromBundle ()
QString	GetDefaultTagsSeparator ()
auto	MkWaiter ()
QString	GetAsBase64Src (const QImage &image)
	Returns the given image in a Base64-encoded form. More...
QString	MakePrettySize (qint64 sourceSize)
	Makes a formatted size from number. More...
QString	MakePrettySizeShort (qint64 size)
	Converts a bytes count to a string representation with appropriately chosen units. More...
QString	MakeTimeFromLong (ulong time)
	Makes a formatted time from number. More...
QTranslator *	LoadTranslator (const QString &baseName, const QString &localeName, const QString &prefix, const QString &appName)
QTranslator *	InstallTranslator (const QString &base, const QString &prefix=LCLowercase, const QString &appname=LCLowercase)
	Loads and installs a translator. More...
QString	GetLocaleName ()
	Returns the current locale name, like en_US. More...
QString	GetInternetLocaleName (const QLocale &locale)
QString	GetLanguage ()
	Returns the current language name. More...
QModelIndexList	GetSummarySelectedRows (QObject *sender)
QAction *	CreateSeparator (QObject *parent)
	Returns the action that is set to act as a separator. More...
QString	GetErrorString (IDownload::Error::Type type)
std::optional< QFuture< TempResultType_t > >	DownloadAsTemporary (IEntityManager *iem, const QUrl &url, DownloadParams params)
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< ANFieldData >	GetStdANFields (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, LC::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<Literal RoleArg, auto GetterArg>
RoledMemberField< RoleArg, GetterArg >	RoledMemberField_v
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
constexpr auto	Id = [] (auto&& t) -> decltype (auto) { return std::forward<decltype (t)> (t); }
constexpr auto	Apply = [] (const auto& t) { return t (); }
constexpr auto	Fst = [] (const auto& pair) { return pair.first; }
constexpr auto	Snd = [] (const auto& pair) { return pair.second; }
template<typename Cont >
concept	StringViewContainer = std::is_same_v<typename std::decay_t<Cont>::value_type, QStringView>
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	RoleTag = Qt::UserRole
const QString	LCLowercase = QStringLiteral ("leechcraft")
	The "leechcraft" literal, with no run-time overhead. More...
const int	SourcePager = 2
const int	StateRemove = 0
const int	StateAdd = 1

Typedef Documentation

AddrList_t

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

Definition at line 21 of file addresses.h.

ArgType_t

template<typename F , size_t Idx>

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

Definition at line 40 of file typegetter.h.

AsTypelist_t

template<typename T >

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

Definition at line 152 of file typelist.h.

BindResult_t

template<typename MV , typename F >

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

Definition at line 42 of file monad.h.

ConcurrentStdException

using LC::Util::ConcurrentStdException = typedef Util::ConcurrentException<Util::NewType<std::exception, struct StdException> >

Definition at line 90 of file concurrentexception.h.

DefaultHookProxy_ptr

using LC::Util::DefaultHookProxy_ptr = typedef std::shared_ptr<DefaultHookProxy>

Definition at line 109 of file defaulthookproxy.h.

DefaultScopeGuard

using LC::Util::DefaultScopeGuard = typedef detail::ScopeGuard<detail::DefaultScopeGuardDeleter>

Definition at line 125 of file util.h.

DoSmthDetector

template<typename T >

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

Definition at line 32 of file detectortest.cpp.

Find

template<template< typename > class Name, typename Def , typename... Args>

using LC::Util::Find = typedef typename detail::Find<Name, Def, Args...>::type

Definition at line 188 of file typelist.h.

FindResult

using LC::Util::FindResult = typedef IntTrie::FindResult

Definition at line 26 of file stringpathtrietest.cpp.

FlatTreeItem_ptr

using LC::Util::FlatTreeItem_ptr = typedef std::shared_ptr<FlatTreeItem>

Definition at line 22 of file flattofoldersproxymodel.h.

FmapResult_t

template<typename T , typename F >

using LC::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

T	The type of the functor.
F	The type of the function to apply to the elements inside the functor.

Definition at line 117 of file functor.h.

GSLResult_t

template<typename AF , typename AV >

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

Definition at line 34 of file applicative.h.

Head_t

template<typename List >

using LC::Util::Head_t = typedef typename Head<List>::Head_t

Definition at line 44 of file typelist.h.

Introspect_f

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

Definition at line 25 of file introspectable.h.

IntTrie

using LC::Util::IntTrie = typedef StringPathTrie<int>

Definition at line 24 of file stringpathtrietest.cpp.

IsDetected_t

template<typename Type , template< typename... > class Op, typename... Args>

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

Definition at line 50 of file detector.h.

IsVoid_t

template<typename T >

using LC::Util::IsVoid_t = typedef std::is_same<T, void>

Definition at line 43 of file typelisttest.cpp.

Lazy_t

template<typename T >

using LC::Util::Lazy_t = typedef std::function<T ()>

Definition at line 31 of file lazy.h.

LazyNotificationPixmap_t

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

Definition at line 252 of file util.h.

MemberPtrStruct_t

template<auto Ptr>

using LC::Util::MemberPtrStruct_t = typedef MemberTypeStruct_t<decltype (Ptr)>

Definition at line 70 of file typegetter.h.

MemberPtrType_t

template<auto Ptr>

using LC::Util::MemberPtrType_t = typedef MemberTypeType_t<decltype (Ptr)>

Definition at line 67 of file typegetter.h.

MemberTypeStruct_t

template<typename PtrType >

using LC::Util::MemberTypeStruct_t = typedef typename detail::DecomposeMemberPtr<PtrType>::StructType_t

Definition at line 64 of file typegetter.h.

MemberTypeType_t

template<typename PtrType >

using LC::Util::MemberTypeType_t = typedef typename detail::DecomposeMemberPtr<PtrType>::Value_t

Definition at line 61 of file typegetter.h.

ModelItem_cptr

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

Definition at line 28 of file modelitem.h.

ModelItem_ptr

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

Definition at line 23 of file modelitem.h.

ModelItem_wtr

typedef std::weak_ptr<ModelItem> LC::Util::ModelItem_wtr

Definition at line 26 of file modelitem.h.

ModelItemsList_t

typedef QVector<ModelItem_ptr> LC::Util::ModelItemsList_t

Definition at line 27 of file modelitem.h.

QIODevice_ptr

using LC::Util::QIODevice_ptr = typedef std::shared_ptr<QIODevice>

Definition at line 27 of file resourceloader.h.

QSVV

using LC::Util::QSVV = typedef QList<QStringView>

Definition at line 23 of file tokenizetest.cpp.

QtException_ptr

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

Definition at line 25 of file concurrentexception.h.

QtException_t

using LC::Util::QtException_t = typedef QException

Definition at line 23 of file concurrentexception.h.

RetType_t

template<typename F >

using LC::Util::RetType_t = typedef std::tuple_element_t<0, decltype (detail::TypeGetter (*static_cast<F*> (nullptr)))>

Definition at line 43 of file typegetter.h.

SerializeResult_t

using LC::Util::SerializeResult_t = typedef Either<QString, Void>

Definition at line 36 of file serializejson.cpp.

SomeEither_t

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

Definition at line 35 of file eithertest.cpp.

SVariant_t

using LC::Util::SVariant_t = typedef std::variant<S1, S2>

Definition at line 45 of file visitortest.cpp.

TempResultType_t

using LC::Util::TempResultType_t = typedef Util::Either<IDownload::Error, QByteArray>

Definition at line 24 of file downloadhelpers.h.

Variant_t

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

Definition at line 31 of file visitortest.cpp.

WrapType_t

template<typename T >

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

Definition at line 34 of file prelude.h.

XmlSettingsDialog_ptr

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

Definition at line 30 of file ihavesettings.h.

Enumeration Type Documentation

AllowedActionFlag

enum LC::Util::AllowedActionFlag

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

Definition at line 40 of file winflags.h.

QueuePriority

enum LC::Util::QueuePriority

strong

The priority of the action in the queue.

Enumerator
Normal	Standard priority.
High	Higher priority.

Definition at line 27 of file queuemanager.h.

SysPath

enum LC::Util::SysPath

strong

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 <code>/usr/[local/]share/leechcraft</code> on Linux, for example.

Definition at line 25 of file paths.h.

UserDir

enum LC::Util::UserDir

strong

Describes various user-specific paths.

Enumerator
Cache	Cache for volatile data.
LC	Root LeechCraft directory (something like ~/.leechcraft).

Definition at line 147 of file paths.h.

WinStateFlag

enum LC::Util::WinStateFlag

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

Definition at line 21 of file winflags.h.

Function Documentation

AsByteArray()

QByteArray LC::Util::AsByteArray ( std::string_view  view )

inlinenoexcept

Convert the view into a QByteArray without copying.

The lifetime of the view should be not less than the lifetime of the returned QByteArray and any of its copies.

For a version without this requirement, see ToByteArray()

Parameters

view	An std::string_view to be represented as a QByteArray.

Returns

A QByteArray referring to the same chunk of memory as the view.

See also

ToByteArray()

Definition at line 74 of file qtutil.h.

Referenced by LC::Util::XWrapper::GetAvailableGeometry().

Here is the caller graph for this function:

AsRefs()

QVector<QStringView> LC::Util::AsRefs

(

const QVector< QString > &

lst

)

Definition at line 28 of file stringpathtrietest.cpp.

References LC::Util::StringPathTrie< V >::Find().

Here is the call graph for this function:

AsSet()

template<typename T >

auto LC::Util::AsSet

(

const T &

cont

)

Definition at line 22 of file containerconversions.h.

AsStringView()

std::string_view LC::Util::AsStringView ( const QByteArray &  arr )

inlinenoexcept

Create a std::string_view referring the data within a QByteArray.

Parameters

arr	A QByteArray.

Returns

An std::string_view referencing the data within arr.

Definition at line 99 of file qtutil.h.

AvailableGeometry()

UTIL_GUI_API QRect LC::Util::AvailableGeometry

(

const QPoint &

p

)

Definition at line 72 of file geometry.cpp.

References GetScreenWithFallback().

Here is the call graph for this function:

BeginGroup()

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

inline

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

Parameters

[in]	settings	The QSettings object.
[in]	group	The 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 48 of file scopeguards.h.

Bind()

template<typename MV , typename F >

BindResult_t<MV, F> LC::Util::Bind	(	const MV &	value,
		const F &	f
	)

Definition at line 75 of file monad.h.

Referenced by LC::Util::detail::declptr(), and operator>>().

Here is the caller graph for this function:

BindMemFn() [1/2]

template<typename R , typename B , typename C , typename... Args>

auto LC::Util::BindMemFn	(	R(B::*)(Args...) const	fn,
		const C *	c
	)

Definition at line 49 of file functional.h.

BindMemFn() [2/2]

template<typename R , typename B , typename C , typename... Args>

auto LC::Util::BindMemFn	(	R(B::*)(Args...)	fn,
		C *	c
	)

Binds an instance of an object to its member function.

Parameters

[in]	fn	The member function of class T.
[in]	c	The 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

R	The return type of the function.
T	The type of the object.
Args	The arguments to the function, besides the object itself.

Definition at line 42 of file functional.h.

References LC::Util::Caster< To >::operator()().

Here is the call graph for this function:

BreakAt()

template<typename T , typename S >

std::pair<T, T> LC::Util::BreakAt ( const T &  str, S  c  )

noexcept

Definition at line 105 of file qtutil.h.

BuildTagsTree()

QDomElement LC::Util::BuildTagsTree	(	QStringList	tags,
		QDomNode &	node,
		QDomDocument &	document,
		const QString &	elementName,
		const std::function< QString(QDomElement)> &	tagGetter,
		const std::function< void(QDomElement &, QString)> &	tagSetter
	)

Builds a nested sequence of DOM elements representing a list of tags.

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.

Parameters

[in]	tags	List of tags.
[in]	node	The parent-most node to which all other nodes are appended.
[in]	document	The document containing all these nodes.
[in]	elementName	The name of the XML element that carries info about the tags.
[in]	tagSetter	Setter function for the tags for the given element.
[in]	tagGetter	Getter function for the tags for the given element.

Returns

Parent element of the item with tags.

Definition at line 20 of file buildtagstree.cpp.

ComparingBy()

template<typename R >

auto LC::Util::ComparingBy

(

R

r

)

Definition at line 227 of file prelude.h.

Concat() [1/3]

template<template< typename > class Container, typename T >

Container<T> LC::Util::Concat

(

const Container< Container< T >> &

containers

)

Definition at line 171 of file prelude.h.

Referenced by ConcatMap().

Here is the caller graph for this function:

Concat() [2/3]

template<template< typename... > class Container, typename... ContArgs>

auto LC::Util::Concat

(

const Container< ContArgs... > &

containers

)

-> std::decay_t<decltype (*containers.begin ())>

Definition at line 180 of file prelude.h.

References LC::Util::detail::Append().

Here is the call graph for this function:

Concat() [3/3]

template<template< typename... > class List, typename... Args1, typename... Args2>

constexpr List<Args1..., Args2...> LC::Util::Concat ( List< Args1... >  , List< Args2... >    )

constexpr

Definition at line 74 of file typelist.h.

ConcatMap()

template<typename Cont , typename F >

auto LC::Util::ConcatMap	(	Cont &&	c,
		F &&	f
	)

Definition at line 190 of file prelude.h.

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

Here is the call graph for this function:

CreateIfNotExists()

UTIL_SYS_API QDir LC::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]

path

The path to create.

Returns

The newly created dir.

Exceptions

std::runtime_error

Throws if the path could not be created.

Definition at line 132 of file paths.cpp.

CreateSeparator()

UTIL_API QAction * LC::Util::CreateSeparator

(

QObject *

parent

)

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

That is the action with setSeparator(true);

Parameters

[in]

parent

The parent of the action.

Returns

The separator action.

Definition at line 220 of file util.cpp.

CreateShortcuts()

template<typename Obj >

void LC::Util::CreateShortcuts	(	const QList< QKeySequence > &	seqs,
		Obj *	obj,
		void(Obj::*)()	member,
		QWidget *	parent
	)

Definition at line 40 of file util.h.

Curry()

template<typename F , typename... Args>

CurryImpl<std::decay_t<F>, Args...> LC::Util::Curry	(	F &&	f,
		Args &&...	args
	)

Definition at line 84 of file curry.h.

DefaultHash()

constexpr uint64_t LC::Util::DefaultHash ( auto  val )

constexpr

Definition at line 58 of file statichash.h.

DefaultHashImpl() [1/2]

template<typename K >

constexpr uint64_t LC::Util::DefaultHashImpl ( K  val )

constexpr

Definition at line 53 of file statichash.h.

DefaultHashImpl() [2/2]

template<>

constexpr uint64_t LC::Util::DefaultHashImpl ( std::string_view  name )

constexpr

Definition at line 44 of file statichash.h.

DetectFileMime()

UTIL_SYS_API QByteArray LC::Util::DetectFileMime

(

const QString &

path

)

Definition at line 31 of file mimedetector.cpp.

Do() [1/2]

template<typename MV >

auto LC::Util::Do

(

const MV &

value

)

Definition at line 89 of file monad.h.

Referenced by operator>>().

Here is the caller graph for this function:

Do() [2/2]

template<typename MV , typename FHead , typename... FArgs>

auto LC::Util::Do	(	const MV &	value,
		const FHead &	fHead,
		const FArgs &...	fArgs
	)

Definition at line 95 of file monad.h.

References LC::Util::oral::sph::f.

DomChildren()

auto LC::Util::DomChildren ( const QDomNode &  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

parent	The parent element whose children should be iterated over.
tag	The 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 96 of file domchildrenrange.h.

DownloadAsTemporary()

UTIL_XPC_API std::optional< QFuture< TempResultType_t > > LC::Util::DownloadAsTemporary	(	IEntityManager *	iem,
		const QUrl &	url,
		DownloadParams	params
	)

Definition at line 28 of file downloadhelpers.cpp.

DrawOverlayText()

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

Definition at line 116 of file util.cpp.

Drop()

template<int N, template< typename... > class List, typename... Args>

constexpr detail::DropImpl<N, List<Args...> >::Result_t LC::Util::Drop ( List< Args... >  )

constexpr

Definition at line 68 of file typelist.h.

DropArgs()

template<typename F >

detail::Dropper<F> LC::Util::DropArgs

(

const F &

f

)

Definition at line 115 of file dropargs.h.

ElideProgressBarText()

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

Definition at line 98 of file util.cpp.

References TintColors().

Here is the call graph for this function:

EnableTransparency()

UTIL_QML_API void LC::Util::EnableTransparency

(

QQuickWidget *

widget

)

Definition at line 20 of file util.cpp.

EnumerateChildren()

template<typename F >

void LC::Util::EnumerateChildren	(	const QModelIndex &	idx,
		bool	includingRoot,
		F &&	f
	)

Definition at line 22 of file util.h.

EqualityBy()

template<typename R >

auto LC::Util::EqualityBy

(

R

r

)

Definition at line 233 of file prelude.h.

Filter()

template<typename T , template< typename U > class Container, typename F >

Container<T> LC::Util::Filter	(	const Container< T > &	c,
		F	f
	)

Definition at line 161 of file prelude.h.

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

Here is the call graph for this function:

FindInSystemPath()

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

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]	name	The name of the file to search for.
[in]	paths	The paths to search in.
[in]	filter	The filter function for the candidates.

Returns

The full path to the first found file or an empty string.

Definition at line 85 of file paths.cpp.

First()

template<typename F >

auto LC::Util::First

(

F &&

f

)

Definition at line 245 of file prelude.h.

References LC::Util::oral::sph::f.

Referenced by LC::Util::oral::detail::Combine().

Here is the caller graph for this function:

FirstMatching()

template<typename F , typename G , typename Def , typename Head , typename... Args>

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

Definition at line 155 of file typelist.h.

Fmap()

template<typename T , typename F , typename = std::enable_if_t<IsFunctor<T> ()>>

FmapResult_t<T, F> LC::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]	functor	The functor whose values are subject to function.
[in]	function	The 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

T	The type of the functor.
F	The type of the function to apply to the elements inside the functor.

See also

InstanceFunctor

Definition at line 140 of file functor.h.

FormatName()

UTIL_GUI_API QString LC::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]

name

The source string.

Returns

HTML-formatted name.

Definition at line 111 of file util.cpp.

GetAsBase64Src()

UTIL_API QString LC::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]

image

The image to represent as Base64-encoded form.

Returns

The source string.

Definition at line 36 of file util.cpp.

GetDataFilters()

UTIL_XPC_API QList< QObject * > LC::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]	data	The data to query.
[in]	manager	The manager used to get the plugins.

Returns

The list of data filters that can handle data.

Definition at line 71 of file util.cpp.

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

Here is the call graph for this function:

GetDefaultTagsSeparator()

UTIL_TAGS_API QString LC::Util::GetDefaultTagsSeparator

(

)

Definition at line 20 of file util.cpp.

GetErrorString()

UTIL_XPC_API QString LC::Util::GetErrorString

(

IDownload::Error::Type

type

)

Definition at line 20 of file downloaderrorstrings.cpp.

GetInternetLocaleName()

UTIL_API QString LC::Util::GetInternetLocaleName

(

const QLocale &

locale

)

Definition at line 188 of file util.cpp.

GetLanguage()

UTIL_API QString LC::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 198 of file util.cpp.

GetLocaleName()

UTIL_API QString LC::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 157 of file util.cpp.

GetPassword() [1/2]

UTIL_XPC_API void LC::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 80 of file passutils.cpp.

GetPassword() [2/2]

UTIL_XPC_API QString LC::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]	keyName	The name of the key uniquely identifying the password.
[in]	dialogText	The text of the dialog to present to the user if the password isn't found or useStore is false.
[in]	proxy	The core proxy used to communicate with other plugins.
[in]	useStore	Whether 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 61 of file passutils.cpp.

GetPathCandidates()

UTIL_SYS_API QStringList LC::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]	path	The root path.
[in]	subfolder	The 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 30 of file paths.cpp.

References QML, and Share.

GetPersistentData()

UTIL_XPC_API QVariant LC::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]	key	The key to look for.
[in]	proxy	The 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 125 of file util.cpp.

GetScreenWithFallback()

UTIL_GUI_API QScreen * LC::Util::GetScreenWithFallback

(

const QPoint &

p

)

Definition at line 61 of file geometry.cpp.

Referenced by AvailableGeometry().

Here is the caller graph for this function:

GetServiceUrl()

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

Definition at line 46 of file lcserviceoverride.cpp.

GetSpaceInfo()

UTIL_SYS_API SpaceInfo LC::Util::GetSpaceInfo

(

const QString &

path

)

Returns the disk space info of the partition containing path.

Parameters

[in]

path

The 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 160 of file paths.cpp.

GetStdANFields()

UTIL_XPC_API QList< ANFieldData > LC::Util::GetStdANFields

(

const QString &

category

)

Returns the list of the standard AN fields for the given category.

Note

Plugins may define their own fields for different categories. The IANEmitter interface is used by those plugins to communicate their custom fields to the rest of LeechCraft.

Parameters

[in]

category

The category of events to return fields for.

Returns

The descriptions of the standard fields used by events in the given category.

See also

ANFieldData

Definition at line 23 of file stdanfields.cpp.

References LC::AN::Field::MediaAlbum, LC::AN::Field::MediaArtist, LC::AN::Field::MediaLength, LC::AN::Field::MediaTitle, and LC::AN::TypeIMEventTuneChange.

GetSummarySelectedRows()

UTIL_API QList< QModelIndex > LC::Util::GetSummarySelectedRows

(

QObject *

sender

)

Definition at line 203 of file util.cpp.

GetSysPath()

UTIL_SYS_API QString LC::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]	path	The identifier of the root path.
[in]	subfolder	The subfolder inside the path.
[in]	filename	The 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 62 of file paths.cpp.

GetSysPathUrl()

UTIL_SYS_API QUrl LC::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]	path	The identifier of the root path.
[in]	subfolder	The subfolder inside the path.
[in]	filename	The 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 75 of file paths.cpp.

GetSystemPaths()

UTIL_SYS_API QStringList LC::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 80 of file paths.cpp.

GetTemporaryName()

UTIL_SYS_API QString LC::Util::GetTemporaryName

(

const QString &

pattern = {}

)

Returns a temporary filename.

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

Parameters

[in]

pattern

Pattern of the filename.

Returns

The filename.

Definition at line 149 of file paths.cpp.

GetUserDir()

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

Definition at line 103 of file paths.cpp.

GSL()

template<typename AF , typename AV >

GSLResult_t<AF, AV> LC::Util::GSL	(	const AF &	af,
		const AV &	av
	)

Definition at line 49 of file applicative.h.

Referenced by Pure().

Here is the caller graph for this function:

HandleNetworkReply()

template<typename F >

void LC::Util::HandleNetworkReply	(	QObject *	context,
		QNetworkReply *	reply,
		F	f
	)

Definition at line 27 of file handlenetworkreply.h.

References LC::Util::oral::sph::f.

HandleReply()

template<typename... Args>

auto LC::Util::HandleReply	(	QNetworkReply *	reply,
		QObject *	context
	)

Definition at line 65 of file handlenetworkreply.h.

HandleReplySeq()

template<typename... Args>

auto LC::Util::HandleReplySeq	(	QNetworkReply *	reply,
		QObject *	context
	)

Definition at line 111 of file handlenetworkreply.h.

HasSupportedImageExtension()

UTIL_SYS_API bool LC::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]

filename

The name of the file, either relative or absolute.

Returns

Whether the filename has a known image suffix.

Definition at line 21 of file util.cpp.

InitJobHolderRow()

UTIL_XPC_API void LC::Util::InitJobHolderRow

(

const QList< QStandardItem * > &

row

)

Definition at line 162 of file util.cpp.

References LC::JobProgress, LC::ProcessProgress, LC::ProcessState, LC::RoleJobHolderRow, and LC::ProcessStateInfo::Running.

InstallTranslator()

UTIL_API QTranslator * LC::Util::InstallTranslator	(	const QString &	base,
		const QString &	prefix = LCLowercase,
		const QString &	appname = LCLowercase
	)

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]	base	Base name of the translation file.
[in]	prefix	The optional prefix of the translation (useful if it's not LC's one).
[in]	appname	Base name of the application.

Returns

The translator object if loading is successful, NULL otherwise.

Definition at line 137 of file util.cpp.

InvokeOn()

template<typename T , typename... Args>

auto LC::Util::InvokeOn	(	T &&	t,
		Args &&...	args
	)

Definition at line 109 of file visitor.h.

IsFunctor()

template<typename T >

constexpr bool LC::Util::IsFunctor ( )

constexpr

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

Returns

Whether type T implements the Functor class.

Template Parameters

T	The type to check.

Definition at line 104 of file functor.h.

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

Here is the call graph for this function:

IsMonadPlus()

template<typename T >

constexpr bool LC::Util::IsMonadPlus ( )

constexpr

Definition at line 52 of file monadplus.h.

References Mplus.

IsOSXLoadFromBundle()

UTIL_SYS_API bool LC::Util::IsOSXLoadFromBundle

(

)

Definition at line 33 of file util.cpp.

LoadTranslator()

UTIL_API QTranslator * LC::Util::LoadTranslator	(	const QString &	baseName,
		const QString &	localeName,
		const QString &	prefix,
		const QString &	appName
	)

Definition at line 97 of file util.cpp.

MakeAN()

UTIL_XPC_API Entity LC::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]	header	The header of the notification. This field will also be used if AN is not present.
[in]	text	The text of the notification. This field will also be used if AN is not present.
[in]	priority	The priority of this notification.
[in]	senderID	The ID of the plugin sending this notification.
[in]	cat	The category of this notification (one of Cat constants in interfaces/an/constants.h).
[in]	type	The type of this notification (one of Type constants in interfaces/an/constants.h).
[in]	id	The ID of this notification, used to group consecutive notifications about similar events like incoming message from the same IM contact.
[in]	visualPath	The list of names for a menu-like structure wishing to show this notification.
[in]	delta	The change of count of events with this id, or 0 to use count.
[in]	count	The total count of events with this id, used if delta is 0.
[in]	fullText	The full text of this notification. If null, the text parameter is used.
[in]	extendedText	The extended text of this notification. If null, the text parameter is used.

See also

MakeANCancel()

MakeANRule()

Definition at line 23 of file util.cpp.

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

Here is the call graph for this function:

MakeANCancel() [1/2]

UTIL_XPC_API Entity LC::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]

event

The event to cancel.

Returns

The Entity canceling the given event.

Definition at line 107 of file util.cpp.

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

Here is the call graph for this function:

MakeANCancel() [2/2]

UTIL_XPC_API Entity LC::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]	senderId	The ID of the sender of the event that is to be canceled.
[in]	eventId	The ID of the event that is to be canceled.

Returns

The Entity canceling the given event.

Definition at line 116 of file util.cpp.

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

Here is the call graph for this function:

MakeANRule()

UTIL_XPC_API Entity LC::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]	title	The human-readable title of the rule.
[in]	senderID	The plugin ID of the sender (must not be empty).
[in]	category	The category of the event (must not be empty).
[in]	types	The types of events in the given category. If this list is empty, every event type matches.
[in]	flags	The flags describing the notification behavior for for this rule
[in]	openConfiguration	Whether the configuration widget for the just created rule should be opened automatically.
[in]	fields	The 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 44 of file util.cpp.

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

Here is the call graph for this function:

MakeCertificateViewerDialog()

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

Definition at line 77 of file sslcertificateinfowidget.cpp.

References Close.

MakeDatabase()

QSqlDatabase LC::Util::MakeDatabase

(

const QString &

name = ":memory:"

)

Definition at line 73 of file common.h.

References LC::Util::DBLock::DumpError(), 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 LC::Util::MakeEndGroupScopeGuard ( QSettings &  settings )

inline

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

Parameters

[in]

settings

The 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 33 of file scopeguards.h.

MakeEntity() [1/2]

UTIL_XPC_API Entity LC::Util::MakeEntity	(	const QVariant &	entity,
		const QString &	location,
		LC::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]	entity	The Entity_ field of the Entity.
[in]	location	The Location_ field of the Entity.
[in]	tp	The Params_ field of the Entity.
[in]	mime	The Mime_ field of the Entity.

Returns

The resulting Entity.

See also

Entity, MakeNotification()

MakeEntity() [2/2]

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

Definition at line 82 of file util.cpp.

References LC::Entity::Entity_, LC::Entity::Location_, LC::Entity::Mime_, and LC::Entity::Parameters_.

Referenced by GetDataFilters(), MakeNotification(), and LC::Util::ShortcutManager::RegisterActionInfo().

Here is the caller graph for this function:

MakeHash()

template<typename K , typename V , auto Hasher = DefaultHash<K>>

consteval auto LC::Util::MakeHash

(

auto &&...

commands

)

Definition at line 64 of file statichash.h.

MakeLambdaEventFilter()

template<typename F >

auto LC::Util::MakeLambdaEventFilter	(	F &&	f,
		QObject *	parent = nullptr
	)

Definition at line 58 of file lambdaeventfilter.h.

MakeLazy()

template<typename T >

Lazy_t<T> LC::Util::MakeLazy

(

const T &

t

)

Definition at line 34 of file lazy.h.

References Mzero().

Here is the call graph for this function:

MakeLazyF()

template<typename R , typename F >

Lazy_t<R> LC::Util::MakeLazyF

(

const F &

l

)

Definition at line 40 of file lazy.h.

MakeNotification()

UTIL_XPC_API Entity LC::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]	header	The header of the notification.
[in]	text	The text of the notification.
[in]	priority	The priority level of the notification.

Returns

The Entity containing the corresponding notification.

See also

Entity, MakeEntity()

Definition at line 95 of file util.cpp.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

MakePrettySize()

UTIL_API QString LC::Util::MakePrettySize

(

qint64

sourceSize

)

Makes a formatted size from number.

Converts, for example, 1048576 to 1.0 MB.

Parameters

[in]

sourceSize

Size in bytes.

Returns

Formatted string.

See also

MakeTimeFromLong()

MakePrettySizeShort()

Definition at line 59 of file util.cpp.

MakePrettySizeShort()

UTIL_API QString LC::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]

size

Size in bytes.

Returns

Formatted string in relevant units.

See also

MakeTimeFromLong()

MakePrettySize()

Definition at line 72 of file util.cpp.

MakeScopeGuard()

template<typename F >

detail::ScopeGuard<F> LC::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]

f

The function to execute on scope exit. Should be a callable without any arguments.

Returns

An object executing f on destruction.

Definition at line 148 of file util.h.

Referenced by LC::Util::CustomCookieJar::setCookiesFromUrl(), and LC::Util::Visitor< FinallyFunc, Args >::Visitor().

Here is the caller graph for this function:

MakeStringHash()

template<typename V >

consteval auto LC::Util::MakeStringHash

(

auto &&...

commands

)

Definition at line 85 of file statichash.h.

MakeTimeFromLong()

UTIL_API QString LC::Util::MakeTimeFromLong

(

ulong

time

)

Makes a formatted time from number.

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

Parameters

[in]

time

Time interval in seconds.

Returns

DateTime object.

See also

MakePrettySize

Definition at line 85 of file util.cpp.

Map()

template<typename Container , typename F >

auto LC::Util::Map ( Container &&  c, F &&  f  )

noexcept

Definition at line 149 of file prelude.h.

References LC::Util::oral::sph::f.

Referenced by ConcatMap(), and LC::Util::PlotItem::SetMultipoints().

Here is the caller graph for this function:

MapAs()

template<template< typename... > class Fallback, typename Container , typename F >

auto LC::Util::MapAs ( Container &&  c, F &&  f  )

noexcept

Definition at line 155 of file prelude.h.

References LC::Util::oral::sph::f.

MkWaiter()

auto LC::Util::MkWaiter ( )

inline

Definition at line 31 of file common.h.

Mzero()

template<typename MP >

MP LC::Util::Mzero

(

)

Definition at line 58 of file monadplus.h.

Referenced by LC::Util::detail::IsMonadPlusImpl(), and MakeLazy().

Here is the caller graph for this function:

OpenXSD()

UTIL_XSD_API XmlSettingsDialog * LC::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]	title	The title of the dialog.
[in]	filename	The XML settings file to use to build the dialog.
[in]	bsm	The instance of BaseSettingsManager to use for storing the settings.

Returns

The XML settings dialog.

Definition at line 31 of file util.cpp.

operator!=()

bool LC::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]	left	First iterator to check for inequality.
[in]	right	Second iterator to check for inequality.

Returns

Whether left and right are equal.

Definition at line 82 of file modeliterator.cpp.

operator*() [1/3]

template<typename AF , typename AV >

auto LC::Util::operator*	(	const AF &	af,
		const AV &	av
	)		-> decltype (GSL (af, av))

Definition at line 55 of file applicative.h.

operator*() [2/3]

template<typename T , typename F >

auto LC::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]	functor	The functor whose values are subject to function.
[in]	function	The 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

T	The type of the functor.
F	The type of the function to apply to the elements inside the functor.

See also

InstanceFunctor

Fmap()

Definition at line 166 of file functor.h.

operator*() [3/3]

template<typename T , typename F >

auto LC::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]	functor	The functor whose values are subject to function.
[in]	function	The 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

T	The type of the functor.
F	The type of the function to apply to the elements inside the functor.

See also

InstanceFunctor

Fmap()

Definition at line 192 of file functor.h.

operator+()

template<typename MP >

auto LC::Util::operator+	(	const MP &	m1,
		const MP &	m2
	)		-> decltype (Mplus (m1) (m2))

Definition at line 73 of file monadplus.h.

operator==()

bool LC::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]	left	First iterator to check for equality.
[in]	right	Second iterator to check for equality.

Returns

Whether left and right are equal.

Definition at line 74 of file modeliterator.cpp.

operator>>()

template<typename MV , typename F >

auto LC::Util::operator>>	(	const MV &	value,
		const F &	f
	)		-> decltype (Bind (value, f))

Definition at line 83 of file monad.h.

References Bind(), and Do().

Here is the call graph for this function:

ParseJson() [1/2]

QVariant LC::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]	bytes	The byte array to parse JSON from.
[in]	context	The context string to be used in logging messages.

Returns

The recursive QVariant with JSON contents.

Definition at line 43 of file parsejson.h.

ParseJson() [2/2]

QVariant LC::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]	device	The device from which JSON-encoded data should be read.
[in]	context	The context string to be used in logging messages.

Returns

The recursive QVariant with JSON contents.

Definition at line 68 of file parsejson.h.

PartitionEithers()

template<template< typename > class Cont, typename L , typename R >

std::pair<Cont<L>, Cont<R> > LC::Util::PartitionEithers

(

const Cont< Either< L, R >> &

eithers

)

Definition at line 199 of file either.h.

References Visit().

Here is the call graph for this function:

PrepareRecords()

template<typename T >

auto LC::Util::PrepareRecords	(	QSqlDatabase	db,
		int	count = 3
	)

Definition at line 104 of file common.h.

References LC::Util::oral::sph::count.

Pure() [1/2]

template<template< typename... > class Applicative, typename... Args, typename T >

auto LC::Util::Pure

(

const T &

v

)

Definition at line 37 of file applicative.h.

References GSL().

Here is the call graph for this function:

Pure() [2/2]

template<typename Applicative , typename T >

auto LC::Util::Pure

(

const T &

v

)

-> decltype (InstanceApplicative<Applicative>::Pure (v))

Definition at line 43 of file applicative.h.

References GSL().

Here is the call graph for this function:

Q_DECLARE_FLAGS()

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

Return()

template<template< typename... > class Monad, typename... Args, typename V >

auto LC::Util::Return

(

const V &

v

)

Definition at line 36 of file monad.h.

Reverse() [1/2]

template<template< typename... > class List, typename Head , typename... Tail>

constexpr auto LC::Util::Reverse ( List< Head, Tail... >  ) -> decltype (Concat (Reverse (List<Tail...>

constexpr

Definition at line 86 of file typelist.h.

Reverse() [2/2]

template<template< typename... > class List>

constexpr List LC::Util::Reverse ( List<>  )

constexpr

Definition at line 80 of file typelist.h.

Reversed()

auto LC::Util::Reversed

(

auto

container

)

Definition at line 75 of file tokenizetest.cpp.

References TokenizeRev().

Here is the call graph for this function:

RightOr() [1/2]

template<typename L , typename R >

R LC::Util::RightOr	(	const Either< L, R > &	either,
		const R &	r
	)

Definition at line 191 of file either.h.

RightOr() [2/2]

template<typename L , typename R , typename F , typename = std::result_of_t<F ()>>

R LC::Util::RightOr	(	const Either< L, R > &	either,
		F &&	f
	)

Definition at line 183 of file either.h.

Save2MimeData()

template<typename T >

void LC::Util::Save2MimeData	(	QMimeData *	mimeData,
		const QString &	name,
		const T &	t
	)

Definition at line 104 of file util.h.

SavePassword()

UTIL_XPC_API void LC::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]	password	The password string to save.
[in]	keyName	The name of the key uniquely identifying the password.
[in]	proxy	The core proxy used to communicate with other plugins.

See also

GetPassword()

Definition at line 123 of file passutils.cpp.

ScreenGeometry()

UTIL_GUI_API QRect LC::Util::ScreenGeometry

(

const QPoint &

p

)

Definition at line 77 of file geometry.cpp.

Second()

template<typename F >

auto LC::Util::Second

(

F &&

f

)

Definition at line 251 of file prelude.h.

References LC::Util::oral::sph::f.

SerializeJson()

UTIL_SLL_API QByteArray LC::Util::SerializeJson	(	const QVariant &	var,
		bool	compact = true
	)

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]	var	The recursive variant to be serialized to JSON.
[in]	compact	Whether the output should be compacitified (this parameter may have no effect).

Returns

The serialized representation of var.

Definition at line 30 of file serializejson.cpp.

SerializeJsonToFile()

UTIL_SLL_API Either< QString, Void > LC::Util::SerializeJsonToFile	(	const QString &	filename,
		const QVariant &	var,
		bool	compact
	)

Definition at line 38 of file serializejson.cpp.

References LC::Util::Either< L, R >::Left().

Here is the call graph for this function:

SetJobHolderProgress() [1/2]

UTIL_XPC_API void LC::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]	row	The row to set data on.
[in]	done	The amount of work done.
[in]	total	The total amount of work.
[in]	text	The text that the progress-related item should have in the row.

See also

ProcessStateInfo

Definition at line 143 of file util.cpp.

References LC::JobProgress.

SetJobHolderProgress() [2/2]

UTIL_XPC_API void LC::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]	item	The item to set data on.
[in]	done	The amount of work done.
[in]	total	The total amount of work.

See also

ProcessStateInfo

Definition at line 154 of file util.cpp.

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

Sorted()

template<typename Cont >

decltype(auto) LC::Util::Sorted

(

Cont &&

cont

)

Definition at line 218 of file prelude.h.

SplitInto()

template<template< typename > class Container, typename T >

Container<Container<T> > LC::Util::SplitInto	(	size_t	numChunks,
		const Container< T > &	container
	)

Definition at line 196 of file prelude.h.

Stlize()

template<typename Assoc >

auto LC::Util::Stlize ( Assoc &&  assoc )

noexcept

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 std::pair<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:

QMap<QString, int> someMap;
for (const auto& [key, value] : Util::Stlize (someMap))
   qDebug () << key << value;

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

Parameters

[in]

assoc

The 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

Assoc

The type of the source Qt associative container.

Definition at line 49 of file qtutil.h.

swap()

void LC::Util::swap	(	FDGuard &	g1,
		FDGuard &	g2
	)

Definition at line 58 of file fdguard.cpp.

Tail()

template<template< typename... > class List, typename H , typename... T>

constexpr List<T...> LC::Util::Tail ( List< H, T... >  )

constexpr

Definition at line 47 of file typelist.h.

ToByteArray()

QByteArray LC::Util::ToByteArray ( std::string_view  view )

inlinenoexcept

Create a QByteArray with the data referenced by the view.

The data within view is copied into the returned QByteArray, so, unlike AsByteArray(), there are no requirements on the lifetime of view.

Parameters

view	An std::string_view to be represented as a QByteArray.

Returns

A QByteArray with the same data as the view.

See also

AsByteArray()

Definition at line 89 of file qtutil.h.

ToFlat()

FlatTreeItem* LC::Util::ToFlat

(

const QModelIndex &

idx

)

Definition at line 56 of file flattofoldersproxymodel.cpp.

Referenced by LC::Util::FlatToFoldersProxyModel::columnCount().

Here is the caller graph for this function:

TokenizeFwd()

auto LC::Util::TokenizeFwd

(

QStringView

str

)

Definition at line 25 of file tokenizetest.cpp.

TokenizeRev()

auto LC::Util::TokenizeRev

(

QStringView

str

)

Definition at line 65 of file tokenizetest.cpp.

Referenced by Reversed().

Here is the caller graph for this function:

Unreachable()

void LC::Util::Unreachable ( )

inline

Definition at line 27 of file unreachable.h.

Visit() [1/3]

template<typename Left , typename Right , typename... Args>

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

Definition at line 212 of file either.h.

Referenced by PartitionEithers(), and LC::Util::Visitor< FinallyFunc, Args >::Visitor().

Here is the caller graph for this function:

Visit() [2/3]

template<typename... Vars, typename... Args>

decltype(auto) LC::Util::Visit	(	const std::variant< Vars... > &	v,
		Args &&...	args
	)

Definition at line 52 of file visitor.h.

Visit() [3/3]

template<typename... Vars, typename... Args>

decltype(auto) LC::Util::Visit	(	std::variant< Vars... > &	v,
		Args &&...	args
	)

Definition at line 58 of file visitor.h.

References LC::Util::Visitor< FinallyFunc, Args >::Visitor().

Here is the call graph for this function:

Visitor()

template<typename... Args>

LC::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 LC::Util::Zip	(	const Container< T1 > &	c1,
		const Container< T2 > &	c2
	)		-> Container<Pair<T1, T2>>

Definition at line 60 of file prelude.h.

References ZipWith().

Here is the call graph for this function:

ZipWith()

template<template< typename U > class Container, typename T1 , typename T2 , typename F >

auto LC::Util::ZipWith	(	const Container< T1 > &	c1,
		const Container< T2 > &	c2,
		F	f
	)		-> WrapType_t<Container<std::decay_t<std::result_of_t<F (T1, T2)>>>>

Definition at line 43 of file prelude.h.

References LC::Util::oral::sph::f.

Referenced by Zip().

Here is the caller graph for this function:

Variable Documentation

AllOf

template<template< typename > class Pred, typename... Args>

constexpr auto LC::Util::AllOf = (Pred<Args> {} && ...)

constexpr

Definition at line 46 of file typelevel.h.

AnyOf

template<template< typename > class Pred, typename... Args>

constexpr auto LC::Util::AnyOf = (Pred<Args> {} || ...)

constexpr

Definition at line 49 of file typelevel.h.

Apply

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

constexpr

Definition at line 238 of file prelude.h.

Fst

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

constexpr

Definition at line 240 of file prelude.h.

Id

constexpr auto LC::Util::Id = [] (auto&& t) -> decltype (auto) { return std::forward<decltype (t)> (t); }

constexpr

Definition at line 224 of file prelude.h.

IsDetected_v

template<template< typename... > class Op, typename... Args>

constexpr bool LC::Util::IsDetected_v = detail::IsDetected<void, void, Op, Args...>::value_t::value

constexpr

Definition at line 47 of file detector.h.

LCLowercase

const Q_DECL_IMPORT QString LC::Util::LCLowercase = QStringLiteral ("leechcraft")

The "leechcraft" literal, with no run-time overhead.

Definition at line 34 of file util.cpp.

List< Head >

LC::Util::List< Head >

Definition at line 86 of file typelist.h.

Mplus

const { ... } LC::Util::Mplus

Referenced by IsMonadPlus().

Msum

const { ... } LC::Util::Msum

RoledMemberField_v

template<Literal RoleArg, auto GetterArg>

RoledMemberField<RoleArg, GetterArg> LC::Util::RoledMemberField_v

Definition at line 40 of file roleditemsmodel.h.

RoleTag

const int LC::Util::RoleTag = Qt::UserRole

Definition at line 31 of file categoryselector.cpp.

Referenced by LC::Util::CategorySelector::SetPossibleSelections().

Snd

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

constexpr

Definition at line 242 of file prelude.h.

SourcePager

const int LC::Util::SourcePager = 2

Definition at line 36 of file xwrapper.cpp.

Referenced by LC::Util::XWrapper::MinimizeWindow(), LC::Util::XWrapper::ResizeWindow(), and LC::Util::XWrapper::ShadeWindow().

StateAdd

const int LC::Util::StateAdd = 1

Definition at line 39 of file xwrapper.cpp.

Referenced by LC::Util::XWrapper::MinimizeWindow(), LC::Util::XWrapper::ResizeWindow(), and LC::Util::XWrapper::UnshadeWindow().

StateRemove

const int LC::Util::StateRemove = 0

Definition at line 38 of file xwrapper.cpp.

Referenced by LC::Util::XWrapper::ShadeWindow(), and LC::Util::XWrapper::UnshadeWindow().

StringViewContainer

template<typename Cont >

concept LC::Util::StringViewContainer = std::is_same_v<typename std::decay_t<Cont>::value_type, QStringView>

Definition at line 27 of file stringpathtrie.h.

Upcast

template<typename To >

constexpr auto LC::Util::Upcast = Upcaster<To> {}

constexpr

Definition at line 85 of file functional.h.