Engine Class

#include <engine.h>

Public Functions

	Engine()
void	build()
void	load(const std::string & file_name)
bool	load_project_version(const std::string & project_config, const std::string & version_label, const std::string & source_root_override = std::string())
void	set_config(const Configuration & new_config)
Configuration	config()
Logger &	logger()
void	process_file(const std::string & filename, const std::string & output_filename)
void	process_directory(const std::string & directory)
void	save()
std::string	project_file_name()
void	update_config(const Configuration & new_config)
const int &	get_classes()
const int &	get_headers()

Detailed Description

No description available.

Member Function Documentation

Engine()

No description available.

void build()

No description available.

void load(const std::string & file_name)

No description available.

bool load_project_version(const std::string & project_config, const std::string & version_label, const std::string & source_root_override = std::string())

Build the active configuration from a .docuriser-project file for a specific version, mirroring the GUI's per-version build path so docuriser build can regenerate a complete version headlessly. The config supplies identity + build.source_path; includes/external/defines/readme/license/topics come from the source root's own .docuriser manifest, the license display name from the config's "License" fact, and the output dir is derived as versions// beside the config. Hands the result to the parser via set_config(). Returns false if the config or manifest can't be read/parsed (or is a too-new format) or the label isn't major.minor.

source_root_override (plan 04 slice D): when non-empty, the manifest and every build path resolve under THIS root instead of the config's build.source_path — the CLI points it at a detached git-worktree snapshot of the version's tag, so the build reads the tagged tree while the output still lands in versions// beside the config. Pass an absolute path.

void set_config(const Configuration & new_config)

Set the active configuration directly (and hand it to the parser) WITHOUT writing it to disk. For callers that assemble a Configuration in memory (e.g. the GUI building a version from a .docuriser-project), where load() (reads legacy JSON) and update_config() (saves) are both unsuitable.

Configuration config()

No description available.

Logger & logger()

No description available.

void process_file(const std::string & filename, const std::string & output_filename)

std::string absolute_path(const std::string& relative_path) const;

void process_directory(const std::string & directory)

No description available.

void save()

No description available.

std::string project_file_name()

No description available.

void update_config(const Configuration & new_config)

No description available.

const int & get_classes()

Access the aggregated classes after processing

const int & get_headers()

Access the aggregated per-header namespace-scope declarations (one entry per parsed file that declared anything documentable)