Generated embedding reference

#

This section transcribes include/guchho/api.hpp and include/guchho/cli.hpp - the public C++ surface, exact as declared there. It is a frozen snapshot: keep it in step with the headers when either changes.

The embedding guide is where the reasoning lives; these are for looking things up.

Enumerations

#

The vocabulary a build is described in. Every decision a caller can make about a build is a scoped enumeration, so option structs stay a flat list of assignments. Full page.

Option structs

#

Configuration is input only. These structs have defaults for every member, so a caller names just the fields it cares about. Full page.

Result and shared types

#

Failure is data, not an exception: anything that can go wrong while building arrives as Message entries in a result struct. Full page.

Sessions and the server

#

A BuildContext is a build that is still alive. Work is either synchronous or owned by an object the caller creates and destroys; nothing is started implicitly. Full page.

The C++ plugin API

#

A plugin is a struct with a name and a setup function. Setup runs once, when the context is created; the hooks it registers then run for every build of that context. Full page.

Engine functions

#

One-shot calls, resolution helpers, the diagnostic renderers and the constants the engine publishes. Full page.

The command line surface

#

The boundary between Guchho as a program and Guchho as a library: running a command line, reading arguments without running anything, and the exit codes. Full page.

Edit this page on GitHub