Classes
struct	CleanReport
	Outcome of a Manager::clean() call. More...
class	ConfigError
	Raised when notex.json is missing, malformed, or fails to write. More...
class	Document
	Loads a .tex file as a sequence of lines and offers editing primitives anchored on recognisable landmarks. More...
class	DocumentError
class	Environment
	Represents the surrounding system as NoTeX perceives it: where TeX expects user files to live, and whether NoTeX is installed. More...
class	EnvironmentError
	Raised when the surrounding TeX environment cannot be resolved. More...
class	FilesystemError
	Raised when a filesystem operation (copy, write, remove) fails. More...
class	Installer
	Deploys the NoTeX LaTeX template and fonts onto the system. More...
class	Manager
	Represents a single NoTeX project: its location and metadata. More...
class	NotexError
	Base class for every exception raised by the NoTeX core library. More...
class	Orchestrator
	Owns the command-line parser and coordinates the domain objects that carry out each command. More...
struct	ProjectConfig
	Persisted metadata for a single NoTeX project, stored as JSON in .notex/notex.json. More...
class	ProjectNotFoundError
	Raised when a command that requires a project is run outside one. More...
class	UsageError
	Raised when the command line supplied by the user is invalid. More...

Enumerations
enum class	InstallationType { NONE , LOCAL , GLOBAL }
enum class	ExitCode : int { SUCCESS = 0 , FAILURE = 1 , USAGE_ERROR = 2 , ENVIRONMENT_ERROR = 3 , PROJECT_NOT_FOUND_ERROR = 4 , FILESYSTEM_ERROR = 5 , CONFIG_ERROR = 6 , DOCUMENT_ERROR = 7 }
	Process exit codes returned by the notex executable. More...

Functions
std::string_view	to_string (InstallationType type)

Detailed Description

Implements Document: line-oriented reading, anchor lookup, and atomic writing for a single .tex file.

Implements Environment: TEXMFHOME resolution and installation detection.

Implements Installer: writing the embedded template and fonts to a global or local target, and refreshing the TeX filename database.

Implements the read side of Manager: project discovery and notex.json loading/saving.

Implements Orchestrator: command-line parsing and dispatch to the notex_core domain classes.

Enumeration Type Documentation

enum class notex::ExitCode : int

strong

Process exit codes returned by the notex executable.

Enumerator
SUCCESS	The command completed successfully.
FAILURE	An unexpected, unclassified error.
USAGE_ERROR	The command line was invalid.
ENVIRONMENT_ERROR	The TeX environment could not be resolved.
PROJECT_NOT_FOUND_ERROR	No .notex/ directory could be found.
FILESYSTEM_ERROR	A filesystem operation failed.
CONFIG_ERROR	notex.json could not be read or written.
DOCUMENT_ERROR	A .tex file could not be edited safely: an expected anchor is missing or ambiguous.

Definition at line 21 of file errors.hpp.

strong

Whether, and how, the NoTeX template is installed relative to the directory an Environment was asked about.

Enumerator
NONE	Neither a local nor a global installation was found.
LOCAL	A local installation exists (takes precedence over global).
GLOBAL	Only a global installation exists.

Definition at line 16 of file environment.hpp.

std::string_view notex::to_string ( InstallationType type )

Definition at line 18 of file environment.cpp.

References GLOBAL, LOCAL, and NONE.