errors.hpp File Reference

Exception hierarchy and process exit codes used throughout NoTeX. More...

#include <stdexcept>
#include <string>
#include <utility>

Go to the source code of this file.

Classes
class	notex::NotexError
	Base class for every exception raised by the NoTeX core library. More...
class	notex::UsageError
	Raised when the command line supplied by the user is invalid. More...
class	notex::EnvironmentError
	Raised when the surrounding TeX environment cannot be resolved. More...
class	notex::ProjectNotFoundError
	Raised when a command that requires a project is run outside one. More...
class	notex::FilesystemError
	Raised when a filesystem operation (copy, write, remove) fails. More...
class	notex::ConfigError
	Raised when notex.json is missing, malformed, or fails to write. More...
class	notex::DocumentError

Namespaces
namespace	notex

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

Detailed Description

Exception hierarchy and process exit codes used throughout NoTeX.

Every error that the core library raises derives from NotexError and carries the ExitCode that the executable should return once the error reaches its single top-level handler. The core library never calls std::exit or terminates the process itself; translating an exception into a process exit code is strictly the executable's responsibility.

Definition in file errors.hpp.