MiKTeX utility class. More...

#include <miktex/Core/Utils.h>

Public Member Functions
	Utils (const Utils &other)=delete

Utils &	operator= (const Utils &other)=delete

	Utils (Utils &&other)=delete

Utils &	operator= (Utils &&other)=delete

Static Public Member Functions
static bool	GetEnvironmentString (const std::string &name, std::string &str)

static bool	GetEnvironmentString (const std::string &name, MiKTeX::Util::PathName &path)

static bool	FindProgram (const std::string &programName, MiKTeX::Util::PathName &path)

static bool	GetDefPrinter (std::string &printerName)

static MiKTeX::Util::PathName	GetExe ()

static std::string	GetExeName ()

static std::string	GetMiKTeXVersionString ()
	Gets the MiKTeX version information as a string. More...

static std::string	GetMiKTeXBannerString ()

static std::string	MakeProgramVersionString (const std::string &programName, const VersionNumber &versionNumber)

static std::string	GetOSVersionString ()

static GitInfo	GetGitInfo ()

static bool	HaveGetGitInfo ()

static void	UncompressFile (const MiKTeX::Util::PathName &pathIn, MiKTeX::Util::PathName &pathOut)

static const char *	GetRelativizedPath (const char lpszPath, const char lpszRoot)

static bool	GetUncRootFromPath (const MiKTeX::Util::PathName &path, MiKTeX::Util::PathName &uncRoot)

static bool	IsSafeFileName (const MiKTeX::Util::PathName &path)

static bool	IsParentDirectoryOf (const MiKTeX::Util::PathName &parentDir, const MiKTeX::Util::PathName &fileName)

static bool	SupportsHardLinks (const MiKTeX::Util::PathName &path)

static void	SetEnvironmentString (const std::string &valueName, const std::string &value)

static void	RemoveEnvironmentString (const std::string &valueName)

static void	PrintException (const std::exception &e)

static void	PrintException (const MiKTeXException &e)

static bool	ReadLine (std::string &str, FILE *stream, bool keepLineEnding)

static std::string	Hexify (const void *pv, std::size_t nBytes, bool lowerCase)

static std::string	Hexify (const void *pv, std::size_t nBytes)

static bool	ParseDvipsFontMapLine (const std::string &line, DvipsFontMapEntry &fontMapEntry)

static bool	IsMiKTeXDirectRoot (const MiKTeX::Util::PathName &root)

static void	RegisterMiKTeXUser ()

static bool	IsRegisteredMiKTeXUser ()

static void	ShowWebPage (const std::string &url)

static MiKTeX::Util::PathName	GetFolderPath (int nFolder, int nFallbackFolder, bool getCurrentPath)

static void	CheckHeap ()

static bool	GetPathNamePrefix (const MiKTeX::Util::PathName &path, const MiKTeX::Util::PathName &suffix, MiKTeX::Util::PathName &prefix)

static std::pair< bool, MiKTeX::Util::PathName >	ExpandTilde (const std::string &s)

static bool	IsPureAscii (const char *lpsz)

static bool	IsPureAscii (const std::string &str)

static bool	IsUTF8 (const char *lpsz, bool allowPureAscii)

static bool	IsUTF8 (const char *lpsz)

static bool	Equals (const char str1, const char str2)

static bool	EqualsIgnoreCase (const char str1, const char str2)

static bool	EqualsIgnoreCase (const std::string &str1, const std::string &str2)

static std::string	MakeLower (const std::string &str)

static unsigned long long	ToUnsignedLongLong (const std::string &s)

static std::size_t	ToSizeT (const std::string &s)

static std::time_t	ToTimeT (const std::string &s)

static std::pair< bool, bool >	CheckPath ()

static bool	CheckPath (bool repair)

static void	RegisterShellFileAssoc (const std::string &extension, const std::string &progId, bool takeOwnership)

static void	UnregisterShellFileAssoc (const std::string &extension, const std::string &progId)

static void	RegisterShellFileType (const std::string &progId, const std::string &userFriendlyName, const std::string &iconPath)

static void	UnregisterShellFileType (const std::string &progId)

static void	RegisterShellVerb (const std::string &progId, const std::string &verb, const std::string &command, const std::string &ddeExec)

static std::string	MakeProgId (const std::string &progId)

Detailed Description

MiKTeX utility class.

Member Function Documentation

◆ GetEnvironmentString()

static bool MiKTeX::Core::Utils::GetEnvironmentString	(	const std::string &	name,
		std::string &	str
	)

static

Gets the value of an environment variable.

Parameters

	lpszName	The name of the environment variable.
[out]	str	The string object to be filled with the value.

Returns: Returns true if the environment variable exists.

◆ GetMiKTeXBannerString()

static std::string MiKTeX::Core::Utils::GetMiKTeXBannerString ( )

static

Gets the MiKTeX banner string. The banner string includes the MiKTeX version number.

Returns: Returns a string object.

◆ GetMiKTeXVersionString()

static std::string MiKTeX::Core::Utils::GetMiKTeXVersionString ( )

static

Gets the MiKTeX version information as a string.

◆ PrintException()

static void MiKTeX::Core::Utils::PrintException ( const MiKTeXException & e )

static

Prints a MiKTeXException to the standard error stream.

Parameters

e	Execption to print.

The documentation for this class was generated from the following file:

Libraries/MiKTeX/Core/include/miktex/Core/Utils.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetEnvironmentString()

◆ GetMiKTeXBannerString()

◆ GetMiKTeXVersionString()

◆ PrintException()