MayaFlux
1.0.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
FunctionBuild.hpp
Go to the documentation of this file.
1
#pragma once
2
3
namespace
MayaFlux::Reflect::Tool
{
4
5
/**
6
* @struct FunctionBuildOptions
7
* @brief What `mayaflux_signatures --functions --build` needs to describe the functions of one header.
8
*
9
* The compile command comes from compile_args when given, else from the
10
* database in build_path through translation_unit.
11
*/
12
struct
FunctionBuildOptions
{
13
std::filesystem::path
header
;
14
std::filesystem::path
build_path
;
15
std::filesystem::path
translation_unit
;
16
std::string
resource_dir
;
17
std::vector<std::string>
extra_args
;
18
std::vector<std::string>
compile_args
;
19
std::filesystem::path
depfile
;
20
std::string
depfile_target
;
21
bool
insert_includes
{
true
};
22
};
23
24
/**
25
* @brief Writes the function sidecar of one header, for a build step.
26
*
27
* Inserts the sidecar include when the header lacks it, writes the sidecar,
28
* and writes a depfile of the files the scan read when options.depfile is set.
29
* A missing sidecar is stubbed in the scan's temporary directory, and no other
30
* file in the source tree is touched.
31
*
32
* @return 0 on success, 1 with the reason on stderr otherwise.
33
*/
34
[[nodiscard]]
int
run_function_build
(
const
FunctionBuildOptions& options);
35
36
}
MayaFlux::Reflect::Tool::run_function_build
int run_function_build(const FunctionBuildOptions &options)
Writes the function sidecar of one header, for a build step.
Definition
FunctionBuild.cpp:21
MayaFlux::Reflect::Tool
Definition
Build.cpp:19
MayaFlux::Reflect::Tool::FunctionBuildOptions::compile_args
std::vector< std::string > compile_args
Definition
FunctionBuild.hpp:18
MayaFlux::Reflect::Tool::FunctionBuildOptions::header
std::filesystem::path header
Definition
FunctionBuild.hpp:13
MayaFlux::Reflect::Tool::FunctionBuildOptions::depfile_target
std::string depfile_target
Definition
FunctionBuild.hpp:20
MayaFlux::Reflect::Tool::FunctionBuildOptions::resource_dir
std::string resource_dir
Definition
FunctionBuild.hpp:16
MayaFlux::Reflect::Tool::FunctionBuildOptions::depfile
std::filesystem::path depfile
Definition
FunctionBuild.hpp:19
MayaFlux::Reflect::Tool::FunctionBuildOptions::translation_unit
std::filesystem::path translation_unit
Definition
FunctionBuild.hpp:15
MayaFlux::Reflect::Tool::FunctionBuildOptions::extra_args
std::vector< std::string > extra_args
Definition
FunctionBuild.hpp:17
MayaFlux::Reflect::Tool::FunctionBuildOptions::insert_includes
bool insert_includes
Definition
FunctionBuild.hpp:21
MayaFlux::Reflect::Tool::FunctionBuildOptions::build_path
std::filesystem::path build_path
Definition
FunctionBuild.hpp:14
MayaFlux::Reflect::Tool::FunctionBuildOptions
What mayaflux_signatures --functions --build needs to describe the functions of one header.
Definition
FunctionBuild.hpp:12
src
Tools
Reflect
FunctionBuild.hpp
Generated by
1.15.0