docc::util::DefaultDoccPaths Class Reference

#include <docc/util/docc_paths.h>

Inheritance diagram for docc::util::DefaultDoccPaths:

Public Types
enum class	DoccRootMode {   None , CMake , Pip , GlobalDist ,   Dist }

Public Member Functions
	DefaultDoccPaths (std::filesystem::path bin_root, std::filesystem::path src_root, DoccRootMode root_mode)
const std::filesystem::path &	bin_root () const
const std::filesystem::path &	src_root () const
DoccRootMode	root_mode () const
std::vector< std::filesystem::path >	get_default_include_paths () const override
std::vector< std::filesystem::path >	get_default_library_paths () const override
std::optional< std::filesystem::path >	get_builtin_target_plugin_src_path (const std::string &plugin) const
std::optional< std::filesystem::path >	get_builtin_target_plugin_rt_lib_path (const std::string &plugin) const
std::optional< std::filesystem::path >	get_builtin_target_plugin_rt_include_path (const std::string &plugin) const
std::optional< std::filesystem::path >	get_builtin_target_plugin_rt_libexec_src_path (const std::string &plugin, const std::string &rt_name) const
Public Member Functions inherited from docc::util::DoccPaths
virtual	~DoccPaths ()=default

Static Public Member Functions
static std::unique_ptr< DefaultDoccPaths >	from_lib_location (std::optional< std::filesystem::path > lib_location)
static std::unique_ptr< DefaultDoccPaths >	from_root (const std::string_view &root)

Member Enumeration Documentation

DoccRootMode

enum class docc::util::DefaultDoccPaths::DoccRootMode

strong

Enumerator
None
CMake
Pip
GlobalDist
Dist

Constructor & Destructor Documentation

DefaultDoccPaths()

docc::util::DefaultDoccPaths::DefaultDoccPaths	(	std::filesystem::path	bin_root,
		std::filesystem::path	src_root,
		DoccRootMode	root_mode )

Member Function Documentation

bin_root()

const std::filesystem::path & docc::util::DefaultDoccPaths::bin_root ( ) const

inline

from_lib_location()

std::unique_ptr< DefaultDoccPaths > docc::util::DefaultDoccPaths::from_lib_location ( std::optional< std::filesystem::path > lib_location )

static

from_root()

std::unique_ptr< DefaultDoccPaths > docc::util::DefaultDoccPaths::from_root ( const std::string_view & root )

static

get_builtin_target_plugin_rt_include_path()

std::optional< std::filesystem::path > docc::util::DefaultDoccPaths::get_builtin_target_plugin_rt_include_path

(

const std::string &

plugin

)

const

get_builtin_target_plugin_rt_lib_path()

std::optional< std::filesystem::path > docc::util::DefaultDoccPaths::get_builtin_target_plugin_rt_lib_path

(

const std::string &

plugin

)

const

get_builtin_target_plugin_rt_libexec_src_path()

std::optional< std::filesystem::path > docc::util::DefaultDoccPaths::get_builtin_target_plugin_rt_libexec_src_path	(	const std::string &	plugin,
		const std::string &	rt_name ) const

get_builtin_target_plugin_src_path()

std::optional< std::filesystem::path > docc::util::DefaultDoccPaths::get_builtin_target_plugin_src_path

(

const std::string &

plugin

)

const

get_default_include_paths()

std::vector< std::filesystem::path > docc::util::DefaultDoccPaths::get_default_include_paths ( ) const

overridevirtual

Implements docc::util::DoccPaths.

get_default_library_paths()

std::vector< std::filesystem::path > docc::util::DefaultDoccPaths::get_default_library_paths ( ) const

overridevirtual

Implements docc::util::DoccPaths.

root_mode()

DoccRootMode docc::util::DefaultDoccPaths::root_mode ( ) const

inline

src_root()

const std::filesystem::path & docc::util::DefaultDoccPaths::src_root ( ) const

inline

---

The documentation for this class was generated from the following file:

• c-compile/include/docc/util/docc_paths.h