bavard

README

bavard

Internal package with some code-generation helper (txt/template and asm).

Used by:

• gnark
• gurvy
• goff

Documentation

Overview

Package bavard contains helper functions to generate consistent code from text/template templates. it is used by github.com/consensys/gnark && github.com/consensys/gnark-crypto

Index

• Variables
• func Apache2(copyrightHolder string, year int) func(*Bavard) error
• func Apache2Header(copyrightHolder string, year int) string
• func AssertSlice(input interface{}) (reflect.Value, error)
• func BuildTag(buildTag string) func(*Bavard) error
• func Format(v bool) func(*Bavard) error
• func Funcs(funcs template.FuncMap) func(*Bavard) error
• func GenerateFromFiles(output string, templateF []string, data interface{}, ...) error
• func GenerateFromString(output string, templates []string, data interface{}, ...) error
• func GeneratedBy(label string) func(*Bavard) error
• func Import(v bool) func(*Bavard) error
• func Package(name string) func(*Bavard) error
• func Verbose(v bool) func(*Bavard) error
• func WriteBigIntAsUint64Slice(builder *strings.Builder, input *big.Int)
• type BatchGenerator
  • func NewBatchGenerator(copyrightHolder string, copyrightYear int, generatedBy string) *BatchGenerator
  • func (b *BatchGenerator) Generate(data interface{}, packageName string, baseTmplDir string, entries ...Entry) error
  • func (b *BatchGenerator) GenerateWithOptions(data interface{}, packageName string, baseTmplDir string, ...) error
• type Bavard
• type Entry

Variables

var StringBuilderPool = sync.Pool{New: func() interface{} { return &strings.Builder{} }}

Functions

func Apache2

func Apache2(copyrightHolder string, year int) func(*Bavard) error

Apache2 returns a bavard option to be used in Generate writing an apache2 licence header in the generated file

func Apache2Header

func Apache2Header(copyrightHolder string, year int) string

Apache2Header returns a Apache2 header string

func AssertSlice

func AssertSlice(input interface{}) (reflect.Value, error)

func BuildTag

func BuildTag(buildTag string) func(*Bavard) error

BuildTag returns a bavard option to be used in Generate adding build tags string on top of the generated file

func Format

func Format(v bool) func(*Bavard) error

Format returns a bavard option to be used in Generate. If set to true, will run gofmt on generated file. Or simple tab alignment on .s files

func Funcs

func Funcs(funcs template.FuncMap) func(*Bavard) error

Funcs returns a bavard option to be used in Generate. See text/template FuncMap for more info

func GenerateFromFiles

func GenerateFromFiles(output string, templateF []string, data interface{}, options ...func(*Bavard) error) error

GenerateFromFiles will concatenate templates and create output file from executing the resulting text/template see other package functions to add options (package name, licensing, build tags, ...)

func GenerateFromString

func GenerateFromString(output string, templates []string, data interface{}, options ...func(*Bavard) error) error

GenerateFromString will concatenate templates and create output file from executing the resulting text/template see other package functions to add options (package name, licensing, build tags, ...)

func GeneratedBy

func GeneratedBy(label string) func(*Bavard) error

GeneratedBy returns a bavard option to be used in Generate writing a standard "Code generated by 'label' DO NOT EDIT"

func Import

func Import(v bool) func(*Bavard) error

Import returns a bavard option to be used in Generate. If set to true, will run goimports

func Package

func Package(name string) func(*Bavard) error

Package returns a bavard option adding package name and optional package documentation in the generated file

func Verbose

func Verbose(v bool) func(*Bavard) error

Verbose returns a bavard option to be used in Generate. If set to true, will print to stdout during code generation

func WriteBigIntAsUint64Slice

func WriteBigIntAsUint64Slice(builder *strings.Builder, input *big.Int)

Types

type BatchGenerator

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

BatchGenerator enables more efficient and clean multiple file generation

func NewBatchGenerator

func NewBatchGenerator(copyrightHolder string, copyrightYear int, generatedBy string) *BatchGenerator

NewBatchGenerator returns a new BatchGenerator

func (*BatchGenerator) Generate

func (b *BatchGenerator) Generate(data interface{}, packageName string, baseTmplDir string, entries ...Entry) error

Generate an entry with generator default config

func (*BatchGenerator) GenerateWithOptions

func (b *BatchGenerator) GenerateWithOptions(data interface{}, packageName string, baseTmplDir string, extraOptions []func(*Bavard) error, entries ...Entry) error

GenerateWithOptions allows adding extra configuration (helper functions etc.) to a batch generation

type Bavard

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

Bavard root object to configure the code generation from text/template

type Entry

type Entry struct {
	File      string
	Templates []string
	BuildTag  string
}

Entry to be used in batch generation of files