genutil

Documentation

Overview

Package genutil provides utilities to help "go generate" implementation.

Index

• func GenerateConstants(input, output string, params Params) error
• type GroupSpec
• type LineParser
• type Params
• type TypeSpec

Functions

func GenerateConstants

func GenerateConstants(input, output string, params Params) error

GenerateConstants reads consts from input and generate output Go source file using a text/template.

Types

type GroupSpec

type GroupSpec struct {
	Prefix   string // constant prefix used as group identifier, e.g, the prefix for "KEY_*" should be "KEY".
	TypeName string // constant type name, e.g. "EventCode"
	Desc     string // human-readable group description used in comment
}

GroupSpec describes how to make a group of constants.

type LineParser

type LineParser func(line string) (name, sval string, ok bool)

LineParser is a type to parse a line.

type Params

type Params struct {
	PackageName    string      // Go package name, e.g. "input"
	RepoName       string      // repo name, e.g "Linux kernel"
	PreludeCode    string      // Go code to include at the top of file (typically "//go:generate go run ...")
	CopyrightYear  int         // copyright year used in the license, e.g "2018"
	MainGoFilePath string      // name of the main .go file for generating the constants, e.g "gen/gen_constants.go"
	Types          []TypeSpec  // specification of types to be defined
	Groups         []GroupSpec // specification of groups of constants
	LineParser     LineParser  // parser for each line in the input file
}

Params controls the detailed behavior of GenerateConstants.

type TypeSpec

type TypeSpec struct {
	Name        string // type name, e.g "EventCode"
	BuiltInType string // Go built-in type, e.g "uint16"
	Desc        string // human-readable type description used in comment
}

TypeSpec describes a Go type to be defined in the generated code.