compile_report.h File Reference

Compile report controls. More...

Go to the source code of this file.

Data Structures
struct	loomc_compile_report_options_t
	Requests a result-owned target compile report. More...

Macros
#define	LOOMC_ARTIFACT_FORMAT_COMPILE_REPORT_JSON   "loom-compile-report-json"
	Loom compile report JSON artifact format.
#define	LOOMC_ARTIFACT_FORMAT_COMPILE_REPORT_TEXT   "loom-compile-report-text"
	Loom compile report text artifact format.

Enumerations
enum	loomc_compile_report_format_t { LOOMC_COMPILE_REPORT_FORMAT_JSON = 0 , LOOMC_COMPILE_REPORT_FORMAT_TEXT = 1 }
	Compile report serialization format. More...
enum	loomc_compile_report_mode_t { LOOMC_COMPILE_REPORT_MODE_NONE = 0 , LOOMC_COMPILE_REPORT_MODE_SUMMARY = 1 , LOOMC_COMPILE_REPORT_MODE_DETAILS = 2 }
	Compile report detail mode. More...

Functions
loomc_status_t	loomc_compile_report_mode_parse (loomc_string_view_t value, loomc_compile_report_mode_t *out_mode)
	Parses a stable compile report mode spelling.
loomc_string_view_t	loomc_compile_report_mode_name (loomc_compile_report_mode_t mode)
	Returns the stable JSON/CLI spelling for mode.

Detailed Description

Compile report controls.

Compile reports are optional structured or human-readable sidecars for pass execution and target emission. They describe the backend, target, terminal status, artifact size, and target-provided compiler analysis facts available at the selected verbosity. Summary and detail reports include configuration bindings applied by the module's last successful compilation. These bindings survive release of the configuration module and compile result, workspace trimming, and module cloning. IR serialization alone does not carry invocation bindings.

Report generation is opt-in. Omitting this descriptor, or setting mode to LOOMC_COMPILE_REPORT_MODE_NONE, avoids report collection and formatting.

Enumeration Type Documentation

loomc_compile_report_format_t

enum loomc_compile_report_format_t

Compile report serialization format.

Enumerator
LOOMC_COMPILE_REPORT_FORMAT_JSON	Emits the stable structured JSON representation.
LOOMC_COMPILE_REPORT_FORMAT_TEXT	Emits bounded human-readable text.

loomc_compile_report_mode_t

enum loomc_compile_report_mode_t

Compile report detail mode.

Enumerator
LOOMC_COMPILE_REPORT_MODE_NONE	Does not request a compile report.
LOOMC_COMPILE_REPORT_MODE_SUMMARY	Requests stable target, status, artifact, and summary compiler facts.
LOOMC_COMPILE_REPORT_MODE_DETAILS	Requests summary facts plus detail rows when producers support them.

Function Documentation

loomc_compile_report_mode_name()

loomc_string_view_t loomc_compile_report_mode_name

(

loomc_compile_report_mode_t

mode

)

Returns the stable JSON/CLI spelling for mode.

Parameters

mode	Mode to name. Unrecognized values use the "none" spelling.

Returns

Borrowed static string view containing the stable spelling.

loomc_compile_report_mode_parse()

loomc_status_t loomc_compile_report_mode_parse	(	loomc_string_view_t	value,
		loomc_compile_report_mode_t *	out_mode )

Parses a stable compile report mode spelling.

Accepts "", "none", "summary", "details", "json", "json-summary", or "json-details".

Parameters

value	Mode spelling to parse. The view need not be NUL-terminated.
out_mode	Receives the parsed mode on success.

Returns

OK when value is recognized. Invalid argument is returned when out_mode is NULL or the spelling is unsupported.