render

package
v1.6.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 4, 2026 License: Apache-2.0 Imports: 40 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Compose

func Compose(dc *matter.DeviceTypeComposition) (composedClusters map[*matter.Cluster]*matter.ClusterComposition, err error)

func SplitZAPDocs

func SplitZAPDocs(cxt context.Context, spec *spec.Specification, inputs spec.DocSet) (clusters spec.DocSet, deviceTypes spec.DocSet, namespaces spec.DocSet, err error)

func ZAPTemplateDestinations

func ZAPTemplateDestinations(sdkRoot string, docPath string, entities []types.Entity, errata *errata.SDK) (destinations map[string][]types.Entity)

Types

type ClusterComposition

type ClusterComposition struct {
	Cluster *matter.Cluster
	Server  conformance.State
	Client  conformance.State

	Elements []*ElementComposition
}

type ClusterListPatcher

type ClusterListPatcher struct {
	// contains filtered or unexported fields
}

func NewClusterListPatcher

func NewClusterListPatcher(spec *spec.Specification, sdkRoot string) *ClusterListPatcher

func (ClusterListPatcher) Name

func (p ClusterListPatcher) Name() string

func (ClusterListPatcher) Process

func (p ClusterListPatcher) Process(cxt context.Context, inputs []*pipeline.Data[*asciidoc.Document]) (outputs []*pipeline.Data[[]byte], err error)

type DependencyTracer

type DependencyTracer struct {
	GlobalObjectDependencies spec.DocSet
	// contains filtered or unexported fields
}

func NewDependencyTracer

func NewDependencyTracer(specification *spec.Specification) *DependencyTracer

func (DependencyTracer) Name

func (p DependencyTracer) Name() string

func (DependencyTracer) Process

func (p DependencyTracer) Process(cxt context.Context, inputs []*pipeline.Data[*asciidoc.Document]) (outputs []*pipeline.Data[*asciidoc.Document], err error)

type DeviceTypesPatcher

type DeviceTypesPatcher struct {
	// contains filtered or unexported fields
}

func NewDeviceTypesPatcher

func NewDeviceTypesPatcher(sdkRoot string, spec *spec.Specification, clusterAliases pipeline.Map[string, []string], options TemplateOptions) *DeviceTypesPatcher

func (DeviceTypesPatcher) Name

func (p DeviceTypesPatcher) Name() string

func (DeviceTypesPatcher) Process

func (p DeviceTypesPatcher) Process(cxt context.Context, inputs []*pipeline.Data[*asciidoc.Document]) (outputs []*pipeline.Data[[]byte], err error)

type ElementComposition

type ElementComposition struct {
	ElementRequirement *matter.ElementRequirement
	State              conformance.State
}

type GlobalObjectsRenderer

type GlobalObjectsRenderer struct {
	// contains filtered or unexported fields
}

func NewGlobalObjectsRenderer

func NewGlobalObjectsRenderer(spec *spec.Specification, sdkRoot string, generator *TemplateGenerator) *GlobalObjectsRenderer

func (GlobalObjectsRenderer) Name

func (p GlobalObjectsRenderer) Name() string

func (GlobalObjectsRenderer) Process

func (p GlobalObjectsRenderer) Process(cxt context.Context, inputs []*pipeline.Data[*asciidoc.Document]) (outputs []*pipeline.Data[string], err error)

type IndexFilesPatcher

type IndexFilesPatcher struct {
	// contains filtered or unexported fields
}

func NewIndexFilesPatcher

func NewIndexFilesPatcher(sdkRoot string, spec *spec.Specification) *IndexFilesPatcher

func (IndexFilesPatcher) Name

func (ifp IndexFilesPatcher) Name() string

func (IndexFilesPatcher) Process

func (ifp IndexFilesPatcher) Process(cxt context.Context, inputs []*pipeline.Data[string]) (outputs []*pipeline.Data[[]byte], err error)

type NamespacePatcher

type NamespacePatcher struct {
	// contains filtered or unexported fields
}

func NewNamespacePatcher

func NewNamespacePatcher(sdkRoot string, specification *spec.Specification) *NamespacePatcher

func (NamespacePatcher) Name

func (p NamespacePatcher) Name() string

func (NamespacePatcher) Process

func (p NamespacePatcher) Process(cxt context.Context, inputs []*pipeline.Data[*asciidoc.Document]) (outputs []*pipeline.Data[[]byte], err error)

type TemplateGenerator

type TemplateGenerator struct {
	ClusterAliases pipeline.Map[string, []string]
	// contains filtered or unexported fields
}

func NewTemplateGenerator

func NewTemplateGenerator(spec *spec.Specification, pipelineOptions pipeline.ProcessingOptions, sdkRoot string, options TemplateOptions) (*TemplateGenerator, error)

func (TemplateGenerator) Name

func (tg TemplateGenerator) Name() string

func (TemplateGenerator) Process

func (tg TemplateGenerator) Process(cxt context.Context, input *pipeline.Data[*asciidoc.Document], index int32, total int32) (outputs []*pipeline.Data[string], extra []*pipeline.Data[*asciidoc.Document], err error)

type TemplateOptions

type TemplateOptions struct {
	FeatureXML             bool   `default:"true" aliases:"featureXML" help:"write new style feature XML" group:"ZAP:"`
	ConformanceXML         bool   `default:"true" aliases:"conformanceXML" help:"write new style conformance XML" group:"ZAP:"`
	EndpointCompositionXML bool   `default:"false" aliases:"endpointCompositionXML" help:"write new style endpoint composition XML" group:"ZAP:"`
	SpecOrder              bool   `default:"false" aliases:"specOrder" help:"write ZAP template XML in spec order" group:"ZAP:"`
	ExtendedQuality        bool   `` /* 136-byte string literal not displayed */
	ProvisionalPolicy      string `enum:"none,loose,strict" default:"none" help:"enforce a provisional policy for generating ZAP XML" group:"ZAP:"`
}

type ZclPatcher

type ZclPatcher struct {
	// contains filtered or unexported fields
}

func NewZclPatcher

func NewZclPatcher(sdkRoot string, spec *spec.Specification, provisionalZclFiles pipeline.StringSet) *ZclPatcher

func (ZclPatcher) Name

func (p ZclPatcher) Name() string

func (ZclPatcher) Process

func (p ZclPatcher) Process(cxt context.Context, inputs []*pipeline.Data[*asciidoc.Document]) (outputs []*pipeline.Data[[]byte], err error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL