The core namespace. More...

Classes
class	Argv
	An argv wrapper class. More...
struct	AutoFunc
class	AutoResource
class	AutoResource2
struct	BufferSizes
	Hardcoded buffer sizes. More...
class	BZip2Stream
class	Cfg
	INI container. More...
struct	ci_char_traits
class	CommandLineBuilder
	An instance of this class builds a command-line. More...
class	CsvList
class	Directory
	Directory class. More...
struct	DirectoryEntry
	Directory entry information. More...
struct	DirectoryEntry2
	Extended directory entry information. More...
class	DirectoryLister
	An instances can be used to read entries of a file system directory. More...
struct	DvipsFontMapEntry
	Information about an entry in a Dvips font map file. More...
struct	equal_icase
struct	fclose_
class	File
struct	FileInfoRecord
	File information. More...
struct	FileSystemChangeEvent
class	FileSystemWatcher
class	FileSystemWatcherCallback
struct	FileTypeInfo
	File type information. More...
class	Fndb
struct	FormatInfo
	Information about a TeX format. More...
struct	free_
struct	GitInfo
class	GzipStream
struct	hash_icase
class	ICreateFndbCallback
class	IFindFileCallback
	Find file callback interface. More...
class	IPrivateKeyProvider
	Access a private key file. More...
class	IRunProcessCallback
	Run process callback interface. More...
struct	LanguageInfo
	Language information. More...
struct	less_icase_dos
struct	LibraryVersion
struct	LocateOptions
struct	LocateResult
class	LockFile
	An instance of this class provides an interface to a lock file. More...
class	LzmaStream
class	MD5
	Instances of this struct represent MD5 values. More...
class	MD5Builder
	Instances of this struct can be used to calculate MD5 values. More...
class	MemoryMappedFile
	Instances of this class provide access to memory-mapped files. More...
struct	MIKTEXMFMODE
	METAFONT mode. More...
struct	MiKTeXUserInfo
	User information. More...
struct	PaperSizeInfo
	Paper size information. More...
class	Process
	An instance of this class manages a child process. More...
struct	ProcessInfo
	Process information. More...
class	ProcessOutput
	A callback interface to save process output. More...
struct	ProcessStartInfo
	Process start options. More...
class	Quoter
struct	RootDirectoryInfo
class	Session
	The MiKTeX session interface. More...
struct	SetupConfig
struct	SourceLocation
struct	StartupConfig
	Startup configuration. More...
class	Stream
class	StreamReader
class	StreamWriter
struct	StructChecker
class	TemporaryDirectory
class	TemporaryFile
class	Uri
class	Utils
	MiKTeX utility class. More...
struct	VersionNumber
	An instance of this struct represents a version number. More...

Typedefs
typedef AutoResource< FILE *, fclose_ >	AutoFILE
typedef AutoResource< void *, free_ >	AutoMemoryPointer
typedef std::basic_string< char, ci_char_traits >	ci_string
typedef MiKTeX::Util::OptionSet< DirectoryCopyOption >	DirectoryCopyOptionSet
typedef MiKTeX::Util::OptionSet< FileAttribute >	FileAttributeSet
typedef MiKTeX::Util::OptionSet< FileOpenOption >	FileOpenOptionSet
typedef MiKTeX::Util::OptionSet< FileDeleteOption >	FileDeleteOptionSet
typedef MiKTeX::Util::OptionSet< FileMoveOption >	FileMoveOptionSet
typedef MiKTeX::Util::OptionSet< FileCopyOption >	FileCopyOptionSet
typedef MiKTeX::Util::OptionSet< CreateLinkOption >	CreateLinkOptionSet
typedef MiKTeX::Util::OptionSet< FileExistsOption >	FileExistsOptionSet
typedef MiKTeX::Util::OptionSet< ExpandOption >	ExpandOptionSet
typedef MiKTeX::Util::OptionSet< RegisterRootDirectoriesOption >	RegisterRootDirectoriesOptionSet

Enumerations
enum class	OptionConvention { None , GNU , Xt , DOS }
	Option parsing convention. More...
enum class	QuotingConvention { None , Whitespace , Bat }
	Quoting convention. More...
enum class	DirectoryCopyOption { UpdateFndb , ReplaceExisting , PreserveMode , CopySubDirectories }
	Directory copy options. More...
enum class	FileMode { Append , Create , CreateNew , Open , Command }
	How to open a file. More...
enum class	FileAccess { None , Read , Write , ReadWrite }
	File access options. More...
enum class	FileAttribute { Directory , ReadOnly , Hidden , Executable }
	File attributes. More...
enum class	FileOpenOption { None , DeleteOnClose }
	Options for opening a file. More...
enum class	FileDeleteOption { UpdateFndb , TryHard }
	Options for deleting a file. More...
enum class	FileMoveOption { UpdateFndb , ReplaceExisting }
	Options for renaming (moving) a file. More...
enum class	FileCopyOption { UpdateFndb , ReplaceExisting , PreserveMode }
	Options for copying a file. More...
enum class	CreateLinkOption { UpdateFndb , ReplaceExisting , Symbolic }
	Options for creating a link. More...
enum class	FileExistsOption { SymbolicLink }
	Options for checking file existance. More...
enum class	FileSystemChangeAction { Added , Modified , Removed }
enum class	FileType { None = 0 , AFM , BASE , BIB , BST , CID , CLUA , CMAP , CNF , CWEB , DB , DVI , DVIPSCONFIG , ENC , EXE , FEA , FMT , HBF , GLYPHFONT , GRAPHICS , GF , IST , LIG , LUA , MAP , MEM , MF , MFPOOL , MFT , MISCFONT , MLBIB , MLBST , MP , MPPOOL , MPSUPPORT , OCP , OFM , OPL , OTF , OTP , OVF , OVP , PDFTEXCONFIG , PK , PROGRAMBINFILE , PROGRAMTEXTFILE , PSHEADER , SCRIPT , SFD , TCX , TEX , TEXPOOL , TEXSOURCE , TEXSYSDOC , TFM , TROFF , TTF , TYPE1 , TYPE42 , VF , WEB , WEB2C , E_N_D }
	File type enum class. More...
enum class	ProcessStatus { None , Runnable , Sleeping , Stopped , Zombie , Other }
	Process status. More...
enum class	ProcessExitStatus { None , Exited , Signaled , Other }
	Process exit status. More...
enum class	MiKTeXConfiguration { None , Regular , Direct , Portable }
	MiKTeX configurations. More...
enum class	ConfigurationScope { None , User , Common }
	MiKTeX configuration scope. More...
enum class	ExpandOption { Values , Braces , PathPatterns }
	Expansion options. More...
enum class	RegisterRootDirectoriesOption { NoRegistry , Temporary , Review }
	Root registration options. More...
enum class	ShellCommandMode { Forbidden , Restricted , Query , Unrestricted }
	Shell command mode. More...
enum class	SeekOrigin { Begin , Current , End }

Functions
template<class HandleType>
HandleType	InvalidHandleValue ()
template<class Func>
AutoFunc< Func >	CreateAutoFunc (Func func)
std::ostream &	operator<< (std::ostream &os, const CommandLineBuilder &cmd)
class MIKTEXCORETYPEAPI(MiKTeXException) std::ostream &	operator<< (std::ostream &os, const SourceLocation &loc)
	The MiKTeX exception base class.
std::ostream &	operator<< (std::ostream &os, const MiKTeXException::KVMAP &kvmap)
std::ostream &	operator<< (std::ostream &os, const MiKTeXException &ex)
std::string	FileSystemChangeActionToString (FileSystemChangeAction action)
std::ostream &	operator<< (std::ostream &os, const FileSystemChangeAction &action)
bool	operator< (const LibraryVersion &lhs, const LibraryVersion &rhs)
std::ostream &	operator<< (std::ostream &os, const MD5 &md5)
std::ostream &	operator<< (std::ostream &os, const MiKTeXConfiguration &miktexConfiguration)
std::ostream &	operator<< (std::ostream &os, const ConfigurationScope &scope)
std::ostream &	operator<< (std::ostream &os, const StartupConfig &startupConfig)
bool	operator< (const DvipsFontMapEntry &lhs, const DvipsFontMapEntry &rhs)
std::ostream &	operator<< (std::ostream &os, const GitInfo &gitInfo)
bool	operator== (const VersionNumber &v1, const VersionNumber &v2)
bool	operator< (const VersionNumber &v1, const VersionNumber &v2)
std::ostream &	operator<< (std::ostream &os, const VersionNumber &v)

Variables
constexpr unsigned	INVALID_ROOT_INDEX = static_cast<unsigned>(-1)
	An invalid TEXMF root index.

Detailed Description

The core namespace.

Enumeration Type Documentation

◆ ConfigurationScope

enum class MiKTeX::Core::ConfigurationScope

strong

MiKTeX configuration scope.

Enumerator
User	User configuration scope.
Common	Common (system-wide) configuration scope.

◆ CreateLinkOption

enum class MiKTeX::Core::CreateLinkOption

strong

Options for creating a link.

Enumerator
UpdateFndb	Update the file name database.
ReplaceExisting	Replace an existing link.
Symbolic	Indicates wheter this is a symbolic link or a hard link.

◆ DirectoryCopyOption

enum class MiKTeX::Core::DirectoryCopyOption

strong

Directory copy options.

Enumerator
UpdateFndb	Update the file name database.
ReplaceExisting	Replace an existing directory.
PreserveMode	Preserve mode.
CopySubDirectories	Deep copy.

◆ ExpandOption

enum class MiKTeX::Core::ExpandOption

strong

Expansion options.

Enumerator
Values	Expand values.
Braces	Expand braces.
PathPatterns	Expand path patterns.

◆ FileAccess

enum class MiKTeX::Core::FileAccess

strong

File access options.

Enumerator
Read	Read access.
Write	Write access.
ReadWrite	Read/Write access.

◆ FileAttribute

enum class MiKTeX::Core::FileAttribute

strong

File attributes.

Enumerator
Directory	File is a directory.
ReadOnly	File is read-only.
Hidden	File is hidden.
Executable	File is executable.

◆ FileCopyOption

enum class MiKTeX::Core::FileCopyOption

strong

Options for copying a file.

Enumerator
UpdateFndb	Update the file name database.
ReplaceExisting	Replace an existing file.
PreserveMode	Preserve file mode.

◆ FileDeleteOption

enum class MiKTeX::Core::FileDeleteOption

strong

Options for deleting a file.

Enumerator
UpdateFndb	Update the file name database.
TryHard	Try hard to make the file go away.

◆ FileExistsOption

enum class MiKTeX::Core::FileExistsOption

strong

Options for checking file existance.

Enumerator
SymbolicLink	Follow symbolic links.

◆ FileMode

enum class MiKTeX::Core::FileMode

strong

How to open a file.

Enumerator
Append	Open a file for append access; that is, writing at the end of file only. If the file already exists, its initial contents are unchanged and output to the stream is appended to the end of the file. Otherwise, a new, empty file is created.
Create	The file will be created, if it doesn't already exist.
CreateNew	The file will be created. Raise an error, if the file already exists.
Open	Open an existing file.
Command	Execute a command and create a pipe.

◆ FileMoveOption

enum class MiKTeX::Core::FileMoveOption

strong

Options for renaming (moving) a file.

Enumerator
UpdateFndb	Update the file name database.
ReplaceExisting	Replace an existing file.

◆ FileOpenOption

enum class MiKTeX::Core::FileOpenOption

strong

Options for opening a file.

Enumerator
DeleteOnClose	Delete the file when it is closed.

◆ FileType

enum class MiKTeX::Core::FileType

strong

File type enum class.

Enumerator
AFM	AFM files (*.afm).
BASE	METAFONT base files (*.base).
BIB	BibTeX database files (*.bib).
BST	BibTeX style files (*.bst).
EXE	Executable files (*.exe).
FMT	TeX format files (*.fmt).
TEX	TeX input files (*.tex).
TEXSYSDOC	TeX documentation files (.dvi;.pdf).
TFM	TeX font metric files (*.tfm).

◆ MiKTeXConfiguration

enum class MiKTeX::Core::MiKTeXConfiguration

strong

MiKTeX configurations.

Enumerator
Regular	Regular MiKTeX configuration.
Direct	MiKTeXDirect (CD/DVD) configuration.
Portable	MiKTeX Portable configuration.

◆ OptionConvention

enum class MiKTeX::Core::OptionConvention

strong

Option parsing convention.

◆ ProcessExitStatus

enum class MiKTeX::Core::ProcessExitStatus

strong

Process exit status.

◆ ProcessStatus

enum class MiKTeX::Core::ProcessStatus

strong

Process status.

◆ QuotingConvention

enum class MiKTeX::Core::QuotingConvention

strong

Quoting convention.

◆ RegisterRootDirectoriesOption

enum class MiKTeX::Core::RegisterRootDirectoriesOption

strong

Root registration options.

Enumerator
NoRegistry	Don't store in registry.
Temporary	Only temporary registration.
Review	Check if the registration is valid.

◆ ShellCommandMode

enum class MiKTeX::Core::ShellCommandMode

strong

Shell command mode.

Enumerator
Forbidden	Shell commands are forbidden.
Restricted	Only some shell commands are allowed.
Query	Ask the user.
Unrestricted	All shell commands are allowed.

Function Documentation

◆ operator<()

bool MiKTeX::Core::operator<	(	const VersionNumber &	v1,
		const VersionNumber &	v2 )

inline

Compares two version numbers.

Parameters

v1	The first version number.
v2	The second version number.

Returns: Returns true, if the first version number is less than the other.

◆ operator<<()

class MIKTEXCORETYPEAPI(MiKTeXException) std::ostream & MiKTeX::Core::operator<<	(	std::ostream &	os,
		const SourceLocation &	loc )

inline

The MiKTeX exception base class.

◆ operator==()

bool MiKTeX::Core::operator==	(	const VersionNumber &	v1,
		const VersionNumber &	v2 )

inline

Compares two version numbers.

Parameters

v1	The first version number.
v2	The second version number.

Returns: Returns true, if both version numbers compare equal.

Variable Documentation

◆ INVALID_ROOT_INDEX

unsigned MiKTeX::Core::INVALID_ROOT_INDEX = static_cast<unsigned>(-1)

constexpr

An invalid TEXMF root index.

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ ConfigurationScope

◆ CreateLinkOption

◆ DirectoryCopyOption

◆ ExpandOption

◆ FileAccess

◆ FileAttribute

◆ FileCopyOption

◆ FileDeleteOption

◆ FileExistsOption

◆ FileMode

◆ FileMoveOption

◆ FileOpenOption

◆ FileType

◆ MiKTeXConfiguration

◆ OptionConvention

◆ ProcessExitStatus

◆ ProcessStatus

◆ QuotingConvention

◆ RegisterRootDirectoriesOption

◆ ShellCommandMode

Function Documentation

◆ operator<()

◆ operator<<()

◆ operator==()

Variable Documentation

◆ INVALID_ROOT_INDEX