package gen

Import Path
	go.pact.im/x/plumb/internal/gen (on go.dev)

Dependency Relation
	imports 13 packages, and imported by one package

Involved Source Files

	  d gen.go
		Package gen is the orchestrator of plumb's pure core: it runs the discover →
		solve → emit pipeline over loaded, type-checked packages to produce generated
		injector source, performing no I/O, holding no global state, and consulting no
		clock or randomness. Its output is a deterministic function of its inputs.
		The phases live in sibling packages (discover, solve, emit) over shared leaves
		(diag, gotypes); this package only wires them together.
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Options (struct)
		Options configures a single generation run. The cli builds it from flags; gen
		distributes the fields each phase needs.

		Fields (total 3, all are exported)
			ImportPath string
				ImportPath is the destination package's import path. It decides what is
				referenced unqualified (the destination) and what is imported and
				qualified (everything else). Required and never empty by the time the
				core runs.

			OutputBase string
				OutputBase is the base name of the file being written (e.g.
				"plumb_gen.go"), used to identify the file being overwritten for the
				same-package function-name collision check. Empty when writing to stdout,
				in which case that check is skipped.

			PackageName string
				PackageName is the identifier emitted in the generated `package <name>`
				clause. Required and never empty by the time the core runs.

		As Inputs Of (at least 2, in which 1 is exported)
			func Generate(opts Options, pkgs []*discover.Package) (*emit.Result, error)
			/* at least one unexported ... *//* at least one unexported: */
			func buildDestInfo(opts Options, pkgs []*discover.Package) (*solve.DestInfo, *diag.Error)


Package-Level Functions (total 3, in which 1 is exported)

	 func Generate(opts Options, pkgs []*discover.Package) (*emit.Result, error)
		Generate is the pure entry point: it analyzes the loaded packages, resolves
		every set, and returns the generated source and report. It performs no I/O.
		The returned error, when non-nil, is always a *diag.Error with a source
		position where one applies.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func buildDestInfo(opts Options, pkgs []*discover.Package) (*solve.DestInfo, *diag.Error)
		buildDestInfo gathers what the emitter needs to know about the destination
		package: whether it was scanned, its name, and the file each top-level
		identifier is declared in (for the collision safeguards). It also rejects a
		destination declaration that shadows a predeclared identifier, a
		whole-destination property, so it is checked here once rather than per set.

	 func collectImportQualifiers(pkg *discover.Package, outputBase string, out map[string]string)
		collectImportQualifiers records, for each import qualifier used by a hand-written
		file in the destination package, the base name of a file that uses it (a hint for
		the collision diagnostic). The file plumb will overwrite (outputBase) is skipped
		entirely: plumb rewrites its imports, so a qualifier used only there can never
		collide with a generated set name; only one a hand-written sibling still uses
		can. This makes gen the sole owner of output-file exclusion, for import
		qualifiers as for top-level names (see buildDestInfo). Among the eligible files
		the first base in sorted order wins, so the result never depends on the loader's
		file-iteration order.

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)