A program wrapper that wraps Lua scripts. More...

#include <lua_wrapper.hpp>

Inheritance diagram for bcache::lua_wrapper_t:

Classes
class	runner_t

Public Member Functions
	lua_wrapper_t (const file::exe_path_t &exe_path, const string_list_t &args, const std::string &lua_script_path)

bool	can_handle_command () override
	Check if this class implements a wrapper for the given command. More...

Public Member Functions inherited from bcache::program_wrapper_t
bool	handle_command (int &return_code)
	Try to wrap a program command. More...

Private Member Functions
void	resolve_args () override
	Resolve arguments on the command line. More...

string_list_t	get_capabilities () override
	Generate a list of supported capabilites. More...

std::map< std::string, expected_file_t >	get_build_files () override
	Get the paths to the files that are to be generated by the command. More...

std::string	get_program_id () override
	Get a string that uniquely identifies the program. More...

string_list_t	get_relevant_arguments () override
	Get relevant command line arguments for hashing. More...

std::map< std::string, std::string >	get_relevant_env_vars () override
	Get relevant environment variables for hashing. More...

string_list_t	get_input_files () override
	Get the paths to the input files for the command. More...

std::string	preprocess_source () override
	Generate the preprocessed source text. More...

string_list_t	get_implicit_input_files () override
	Get a list of paths to implicit input files. More...

sys::run_result_t	run_for_miss () override
	Run the actual command (when there is a cache miss). More...

Private Attributes
runner_t	m_runner

Additional Inherited Members
Protected Member Functions inherited from bcache::program_wrapper_t
	program_wrapper_t (const file::exe_path_t &exe_path, const string_list_t &args)

Protected Attributes inherited from bcache::program_wrapper_t
const file::exe_path_t &	m_exe_path

const string_list_t &	m_args

capabilities_t	m_active_capabilities
	Active capabilities. More...

Detailed Description

A program wrapper that wraps Lua scripts.

This special wrapper class implements the wrapper API methods by redirecting the calls to the corrsponding methods in a Lua script.

Member Function Documentation

◆ can_handle_command()

bool bcache::lua_wrapper_t::can_handle_command ( )

overridevirtual

Check if this class implements a wrapper for the given command.

Returns: true if this wrapper can handle the command.

Implements bcache::program_wrapper_t.

◆ get_build_files()

std::map< std::string, expected_file_t > bcache::lua_wrapper_t::get_build_files ( )

overrideprivatevirtual

Get the paths to the files that are to be generated by the command.

Returns: the files that are expected to be generated by this command.

Exceptions

runtime_error if the request could not be completed.

Reimplemented from bcache::program_wrapper_t.

◆ get_capabilities()

string_list_t bcache::lua_wrapper_t::get_capabilities ( )

overrideprivatevirtual

Generate a list of supported capabilites.

The list of capabilites can contain zero or more of the following (case sensitive) strings:

String	Meaning
create_target_dirs	Request creation of missing output dirs
direct_mode	Supports direct mode
hard_links	Can use hard links for cached files

In order to support direct mode, get_input_files() and get_implicit_input_files() need to be implemented.

Returns: a list of supported capabilites.

Exceptions

runtime_error if the request could not be completed.

Note: Capabilites are "opt-in". If this method is not implemented or returns an empty list, all capabilites will be treated as "not supported".

Reimplemented from bcache::program_wrapper_t.

◆ get_implicit_input_files()

string_list_t bcache::lua_wrapper_t::get_implicit_input_files ( )

overrideprivatevirtual

Get a list of paths to implicit input files.

This method is only used in direct mode, and the main use case is for collecting a list of all include files for C/C++ builds.

Returns: the list of implicit input files.

Exceptions

runtime_error if the request could not be completed.

Note: The preprocess_source method has been called before calling this method (so the list can be collected during the preprocessing step and later be returned by this method).; Only used in direct mode.

Reimplemented from bcache::program_wrapper_t.

◆ get_input_files()

string_list_t bcache::lua_wrapper_t::get_input_files ( )

overrideprivatevirtual

Get the paths to the input files for the command.

Returns: the files that are used as primary input.

Exceptions

runtime_error if the request could not be completed.

Note: Only used in direct mode.

Reimplemented from bcache::program_wrapper_t.

◆ get_program_id()

std::string bcache::lua_wrapper_t::get_program_id ( )

overrideprivatevirtual

Get a string that uniquely identifies the program.

Returns: a program ID string.

Exceptions

runtime_error if the request could not be completed.

Reimplemented from bcache::program_wrapper_t.

◆ get_relevant_arguments()

string_list_t bcache::lua_wrapper_t::get_relevant_arguments ( )

overrideprivatevirtual

Get relevant command line arguments for hashing.

Returns: filtered command line arguments.

Exceptions

runtime_error if the request could not be completed.

Note: The purpose of this function is to create a list of arguments that is suitable for hashing (i.e. uniquely identifying) the program options. As such, things like absolute file paths and compilation defines should be excluded (since they are resolved in the preprocess step).

Reimplemented from bcache::program_wrapper_t.

◆ get_relevant_env_vars()

std::map< std::string, std::string > bcache::lua_wrapper_t::get_relevant_env_vars ( )

overrideprivatevirtual

Get relevant environment variables for hashing.

Returns: relevant environment variables and their values.

Exceptions

runtime_error if the request could not be completed.

Note: The purpose of this function is to create a list of environment variables that may affect program output.

Reimplemented from bcache::program_wrapper_t.

◆ preprocess_source()

std::string bcache::lua_wrapper_t::preprocess_source ( )

overrideprivatevirtual

Generate the preprocessed source text.

Returns: the preprocessed source code file as a string, or an empty string if the operation failed.

Exceptions

runtime_error if the request could not be completed.

Reimplemented from bcache::program_wrapper_t.

◆ resolve_args()

void bcache::lua_wrapper_t::resolve_args ( )

overrideprivatevirtual

Resolve arguments on the command line.

This method is called after can_handle_command, but before calling other methods that rely on the command line arguments. This gives a wrapper the opportunity to resolve special arguments so that they can be properly interpretade by later steps.

The primary use case of this method is to implement support for so called response files, which contain further command line arguments (this is common on Windows to work around the relativlely small command line length limit).

Exceptions

runtime_error if the request could not be completed.

Reimplemented from bcache::program_wrapper_t.

◆ run_for_miss()

sys::run_result_t bcache::lua_wrapper_t::run_for_miss ( )

overrideprivatevirtual

Run the actual command (when there is a cache miss).

Returns: the run result for the child process.

Reimplemented from bcache::program_wrapper_t.

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

wrappers/lua_wrapper.hpp
wrappers/lua_wrapper.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ can_handle_command()

◆ get_build_files()

◆ get_capabilities()

◆ get_implicit_input_files()

◆ get_input_files()

◆ get_program_id()

◆ get_relevant_arguments()

◆ get_relevant_env_vars()

◆ preprocess_source()

◆ resolve_args()

◆ run_for_miss()