MiKTeX 26.5-next
A scalable TeX distribution
Loading...
Searching...
No Matches
MiKTeX::Packages Namespace Reference

The package manager namespace. More...

Namespaces

namespace  internal
 Package manager internals.

Classes

struct  InstallationSummary
 Installation summary. More...
struct  PackageInfo
 Package record. More...
class  PackageInstaller
class  PackageInstallerCallback
 Callback interface. More...
class  PackageIterator
 Instances of this class can be used to browse the package database. More...
class  PackageManager
 The package manager interface. More...
struct  ProxySettings
struct  RepositoryInfo
 Package repository info struct. More...

Typedefs

typedef MiKTeX::Util::OptionSet< UpdateDbOption > UpdateDbOptionSet
typedef MiKTeX::Util::OptionSet< PackageFilter > PackageFilterSet

Enumerations

enum class  UpdateDbOption { FromCache }
 UpdateDb options. More...
enum class  Notification {
  None = 0 , DownloadPackageStart , DownloadPackageEnd , InstallFileStart ,
  InstallFileEnd , InstallPackageStart , InstallPackageEnd , RemoveFileStart ,
  RemoveFileEnd , RemovePackageStart , RemovePackageEnd
}
 Installer notifications. More...
enum class  PackageFilter { Top , Obsolete }
 Package filter. More...
enum class  PackageLevel {
  None = 0 , Essential = 10 , Basic = 1000 , Advanced = 100000 ,
  Complete = 1000000000
}
 Package level. More...
enum class  RepositoryType {
  Unknown , MiKTeXDirect , Local , Remote ,
  MiKTeXInstallation
}
 Repository type. More...
enum class  RepositoryStatus { Unknown , Online , Offline }
 Repository status. More...
enum class  RepositoryIntegrity { Unknown , Intact , Corrupted }
 Repository integrrity. More...
enum class  RepositoryReleaseState { Unknown , Stable , Next }
 Repository release state. More...

Functions

bool IsValidTimeT (std::time_t time)
bool operator== (const PackageInfo &lhs, const PackageInfo &rhs)
std::string PackageLevelToString (PackageLevel packageLevel)
std::ostream & operator<< (std::ostream &os, const PackageLevel packageLevel)
std::string RepositoryTypeToString (RepositoryType repositoryType)
std::ostream & operator<< (std::ostream &os, const RepositoryType repositoryType)
std::string RepositoryStatusToString (RepositoryStatus repositoryStatus)
std::ostream & operator<< (std::ostream &os, const RepositoryStatus repositoryStatus)
std::string RepositoryIntegrityToString (RepositoryIntegrity repositoryIntegrity)
std::ostream & operator<< (std::ostream &os, const RepositoryIntegrity repositoryIntegrity)
std::string RepositoryReleaseStateToString (RepositoryReleaseState repositoryReleaseState)
std::ostream & operator<< (std::ostream &os, const RepositoryReleaseState repositoryReleaseState)
bool operator== (const RepositoryInfo &lhs, const RepositoryInfo &rhs)
bool operator!= (const RepositoryInfo &lhs, const RepositoryInfo &rhs)

Variables

constexpr std::time_t InvalidTimeT = static_cast<std::time_t>(0)
 An invalid timestamp.

Detailed Description

The package manager namespace.

Enumeration Type Documentation

◆ Notification

enum class MiKTeX::Packages::Notification
strong

Installer notifications.

Enumerator
DownloadPackageStart 

Package download is about to start.

DownloadPackageEnd 

Package download has finished.

InstallFileStart 

File installation is about to start.

InstallFileEnd 

File installation has finished.

InstallPackageStart 

Package installation is about to start.

InstallPackageEnd 

Package installation has finished.

RemoveFileStart 

File removal is about to start.

RemoveFileEnd 

File removal has finished.

RemovePackageStart 

Package removal is about to start.

RemovePackageEnd 

Package removal has finished.

◆ PackageFilter

Package filter.

Enumerator
Top 

Top-level package filter.

Obsolete 

Obsolete packages.

◆ PackageLevel

enum class MiKTeX::Packages::PackageLevel
strong

Package level.

Enumerator
Essential 

Essential package set.

Basic 

Basic package set.

Advanced 

Advanced package set.

Complete 

Complete package set.

◆ RepositoryIntegrity

Repository integrrity.

Enumerator
Intact 

The repository is known to be intact.

Corrupted 

The repository is known to be corrupted.

◆ RepositoryReleaseState

Repository release state.

Enumerator
Stable 

Stable channel.

Next 

Experimental channel.

◆ RepositoryStatus

Repository status.

Enumerator
Online 

Repository is known to be online.

Offline 

Remote repository is known to be offline.

◆ RepositoryType

Repository type.

Enumerator
Local 

Local (file system) directory.

Remote 

Remote (Internet) directory.

◆ UpdateDbOption

UpdateDb options.

Function Documentation

◆ IsValidTimeT()

bool MiKTeX::Packages::IsValidTimeT ( std::time_t time)
inline

Check a timestamp.

Parameters
timeThe timestamp to check.
Returns
Returns true, if this is a valid timestamp.

Variable Documentation

◆ InvalidTimeT

std::time_t MiKTeX::Packages::InvalidTimeT = static_cast<std::time_t>(0)
constexpr

An invalid timestamp.