girgen

Documentation

Index

• Variables
• type FileGenerator
  • func NewFileGenerator(n *NamespaceGenerator, name string, isRoot bool) *FileGenerator
  • func (f *FileGenerator) CIncludes() []string
  • func (f *FileGenerator) Generate() ([]byte, error)
  • func (f *FileGenerator) Header() *file.Header
  • func (f *FileGenerator) IsEmpty() bool
  • func (f *FileGenerator) Logln(lvl logger.Level, v ...interface{})
  • func (f *FileGenerator) Name() string
  • func (f *FileGenerator) Pen() *pen.Pen
  • func (f *FileGenerator) Pkgconfig() []string
• type Generator
  • func NewGenerator(repos gir.Repositories, modPath types.ModulePathFunc) *Generator
  • func NewGeneratorOpts(repos gir.Repositories, modPath types.ModulePathFunc, opts Opts) *Generator
  • func (g *Generator) AddFilters(filters []types.FilterMatcher)
  • func (g *Generator) AddPostprocessors(ppMap map[string][]Postprocessor)
  • func (g *Generator) AddProcessConverters(processors []typeconv.ConversionProcessor)
  • func (g *Generator) ApplyPreprocessors(preprocs []types.Preprocessor)
  • func (g *Generator) Filters() []types.FilterMatcher
  • func (g *Generator) Logln(lvl logger.Level, v ...interface{})
  • func (g *Generator) ModPath(n *gir.Namespace) string
  • func (g *Generator) ProcessConverter(converter *typeconv.Converter)
  • func (g *Generator) Repositories() gir.Repositories
  • func (g *Generator) UseNamespace(namespace, version string) *NamespaceGenerator
• type NamespaceGenerator
  • func NewNamespaceGenerator(g *Generator, n *gir.NamespaceFindResult) *NamespaceGenerator
  • func (n *NamespaceGenerator) AddPostprocessors(pps []Postprocessor)
  • func (n *NamespaceGenerator) CanGenerate(r *types.Resolved) bool
  • func (n *NamespaceGenerator) File(filename string) (*FileGenerator, bool)
  • func (n *NamespaceGenerator) FileWriter(info cmt.InfoFields) generators.FileWriter
  • func (n *NamespaceGenerator) Generate() (map[string][]byte, error)
  • func (n *NamespaceGenerator) Logln(lvl logger.Level, v ...interface{})
  • func (n *NamespaceGenerator) MakeFile(filename string) *FileGenerator
  • func (n *NamespaceGenerator) Namespace() *gir.NamespaceFindResult
  • func (n *NamespaceGenerator) Pkgconfig() []string
• type Opts
• type Postprocessor

Variables

var DefaultOpts = Opts{
	LogLevel: logger.Skip,
}

DefaultOpts contains default options.

Types

type FileGenerator

type FileGenerator struct {
	*NamespaceGenerator
	BuildTags []string // go:build lines, joined by AND (&&)
	Packages  []string // extra
	// contains filtered or unexported fields
}

FileGenerator is a file generator.

func NewFileGenerator

func NewFileGenerator(n *NamespaceGenerator, name string, isRoot bool) *FileGenerator

NewFileGenerator creates a new empty FileGenerator instance.

func (*FileGenerator) CIncludes

func (f *FileGenerator) CIncludes() []string

CIncludes returns this file's sorted C includes, including the repository's C includes.

func (*FileGenerator) Generate

func (f *FileGenerator) Generate() ([]byte, error)

Generate generates the final file content, completed with gofmt.

func (*FileGenerator) Header

func (f *FileGenerator) Header() *file.Header

Header returns the current file's header.

func (*FileGenerator) IsEmpty

func (f *FileGenerator) IsEmpty() bool

IsEmpty returns true if the file is empty.

func (*FileGenerator) Logln

func (f *FileGenerator) Logln(lvl logger.Level, v ...interface{})

func (*FileGenerator) Name

func (f *FileGenerator) Name() string

Name returns the current file's name.

func (*FileGenerator) Pen

func (f *FileGenerator) Pen() *pen.Pen

Pen returns the current file's writing pen.

func (*FileGenerator) Pkgconfig

func (f *FileGenerator) Pkgconfig() []string

Pkgconfig returns the current repository's pkg-config names.

type Generator

type Generator struct {
	Logger *log.Logger
	Opts   Opts
	// contains filtered or unexported fields
}

Generator is a big generator that manages multiple repositories.

func NewGenerator

func NewGenerator(repos gir.Repositories, modPath types.ModulePathFunc) *Generator

NewGenerator creates a new generator with sane defaults.

func NewGeneratorOpts

func NewGeneratorOpts(repos gir.Repositories, modPath types.ModulePathFunc, opts Opts) *Generator

NewGeneratorOpts creates a new generator with options.

func (*Generator) AddFilters

func (g *Generator) AddFilters(filters []types.FilterMatcher)

AddFilters adds the given list of filters.

func (*Generator) AddPostprocessors

func (g *Generator) AddPostprocessors(ppMap map[string][]Postprocessor)

AddPostprocessor registers the given postprocessors inside a map that has keys matching the namespace.

func (*Generator) AddProcessConverters

func (g *Generator) AddProcessConverters(processors []typeconv.ConversionProcessor)

AddProcessConverters adds the given list of conversion processors.

func (*Generator) ApplyPreprocessors

func (g *Generator) ApplyPreprocessors(preprocs []types.Preprocessor)

AddPreprocessors applies the given list of preprocessors.

func (*Generator) Filters

func (g *Generator) Filters() []types.FilterMatcher

Filters returns the generator's list of type filters.

func (*Generator) Logln

func (g *Generator) Logln(lvl logger.Level, v ...interface{})

Logln writes a log line into the internal logger.

func (*Generator) ModPath

func (g *Generator) ModPath(n *gir.Namespace) string

ModPath creates an import path from the user's ModulePathFunc given into the constructor.

func (*Generator) ProcessConverter

func (g *Generator) ProcessConverter(converter *typeconv.Converter)

ProcessConverter satisfies the typeconv.ConversionProcessor interface.

func (*Generator) Repositories

func (g *Generator) Repositories() gir.Repositories

Repositories returns the generator's repositories.

func (*Generator) UseNamespace

func (g *Generator) UseNamespace(namespace, version string) *NamespaceGenerator

UseNamespace creates a new namespace generator using the given namespace.

type NamespaceGenerator

type NamespaceGenerator struct {
	*Generator
	PkgPath    string
	PkgName    string
	PkgVersion string

	Files map[string]*FileGenerator
	// contains filtered or unexported fields
}

NamespaceGenerator manages generation of a namespace. A namespace contains various files, which are created using the FileWriter method.

func NewNamespaceGenerator

func NewNamespaceGenerator(g *Generator, n *gir.NamespaceFindResult) *NamespaceGenerator

NewNamespaceGenerator creates a new NamespaceGenerator from the given generator and namespace.

func (*NamespaceGenerator) AddPostprocessors

func (n *NamespaceGenerator) AddPostprocessors(pps []Postprocessor)

AddPostprocessors adds the given list of postprocessors.

func (*NamespaceGenerator) CanGenerate

func (n *NamespaceGenerator) CanGenerate(r *types.Resolved) bool

CanGenerate checks if a type can be generated or not.

func (*NamespaceGenerator) File

func (n *NamespaceGenerator) File(filename string) (*FileGenerator, bool)

File gets an existing file but returns false if no such file exists. It's useful for postprocessors to check if generation is working as intended. If SingleFile is true, then File will always return the same file.

func (*NamespaceGenerator) FileWriter

func (n *NamespaceGenerator) FileWriter(info cmt.InfoFields) generators.FileWriter

FileWriter returns the respective file writer from the given InfoFields.

func (*NamespaceGenerator) Generate

func (n *NamespaceGenerator) Generate() (map[string][]byte, error)

Generate generates everything in the current namespace into files. The returned map maps the filename to the raw file content.

func (*NamespaceGenerator) Logln

func (n *NamespaceGenerator) Logln(lvl logger.Level, v ...interface{})

func (*NamespaceGenerator) MakeFile

func (n *NamespaceGenerator) MakeFile(filename string) *FileGenerator

MakeFile makes a new FileGenerator for the given filename or returns an existing one.

func (*NamespaceGenerator) Namespace

func (n *NamespaceGenerator) Namespace() *gir.NamespaceFindResult

Namespace returns the generator's namespace that includes the repository it's in.

func (*NamespaceGenerator) Pkgconfig

func (n *NamespaceGenerator) Pkgconfig() []string

Pkgconfig returns the current repository's pkg-config names.

type Opts

type Opts struct {
	// LogLevel is defaulted to Skip, unless GIR_VERBOSE=1, then it's Debug.
	LogLevel logger.Level
	// SingleFile, if true, will make all NamespaceGenerators generate a single
	// output file per package instead of correlating it to the source file.
	SingleFile bool
}

Opts contains generator options.

type Postprocessor

type Postprocessor func(n *NamespaceGenerator) error

Postprocessor describes a processor function that modifies a namespace. It is called right before files are finalized within the namespace generator.