native

Documentation

Overview

Package native provides types to implement native variables, constants, functions, types and packages that can be imported or used as builtins in programs and templates.

Index

• Variables
• type CSS
• type CSSEnvStringer
• type CSSStringer
• type CombinedImporter
  • func (importers CombinedImporter) Import(path string) (ImportablePackage, error)
• type CombinedPackage
  • func (packages CombinedPackage) Lookup(name string) Declaration
  • func (packages CombinedPackage) LookupFunc(f LookupFunc) error
  • func (packages CombinedPackage) PackageName() string
• type Converter
• type Declaration
• type Declarations
• type Env
• type EnvStringer
• type HTML
• type HTMLEnvStringer
• type HTMLStringer
• type ImportablePackage
• type Importer
• type JS
• type JSEnvStringer
• type JSON
• type JSONEnvStringer
• type JSONStringer
• type JSStringer
• type LookupFunc
• type Markdown
• type MarkdownEnvStringer
• type MarkdownStringer
• type Package
  • func (p Package) Lookup(name string) Declaration
  • func (p Package) LookupFunc(f LookupFunc) error
  • func (p Package) PackageName() string
• type Packages
  • func (pp Packages) Import(path string) (ImportablePackage, error)
• type UntypedBooleanConst
• type UntypedNumericConst
• type UntypedStringConst

Variables

var StopLookup = errors.New("stop lookup")

StopLookup is used as return value from a LookupFunc function to indicate that the lookup should be stopped.

Types

type CSS

type CSS string

CSS is the css type in templates.

type CSSEnvStringer

type CSSEnvStringer interface {
	CSS(Env) CSS
}

CSSEnvStringer is like CSSStringer where the CSS method takes an Env parameter.

type CSSStringer

type CSSStringer interface {
	CSS() CSS
}

CSSStringer is implemented by values that are not escaped in CSS context.

type CombinedImporter

type CombinedImporter []Importer

CombinedImporter combines multiple importers into one importer.

func (CombinedImporter) Import

func (importers CombinedImporter) Import(path string) (ImportablePackage, error)

Import calls the Import method of each importer and returns as soon as an importer returns a package.

type CombinedPackage

type CombinedPackage []ImportablePackage

CombinedPackage implements an ImportablePackage by combining multiple packages into one package with name the name of the first package and as declarations the declarations of all packages.

The ImportablePackage.Lookup method calls the Lookup methods of each package in order and returns as soon as a package returns a not nil value.

func (CombinedPackage) Lookup

func (packages CombinedPackage) Lookup(name string) Declaration

Lookup calls the Lookup method of each package in order and returns as soon as a combined package returns a declaration.

func (CombinedPackage) LookupFunc

func (packages CombinedPackage) LookupFunc(f LookupFunc) error

LookupFunc calls the LookupFunc method of each package in order. As soon as f returns StopLookup, LookupFunc returns. If the same declaration name is in multiple packages, f is only called with its first occurrence.

func (CombinedPackage) PackageName

func (packages CombinedPackage) PackageName() string

PackageName returns the package name of the first combined package.

type Converter

type Converter = func(src []byte, out io.Writer) error

Converter is implemented by format converters.

type Declaration

type Declaration interface{}

Declaration represents a declaration.

• for a variable: a pointer to the value of the variable
• for a function: the function
• for a type: its reflect.Type value
• for a typed constant: its value as a string, boolean or numeric value
• for an untyped constant: an UntypedStringConst, UntypedBooleanConst or UntypedNumericConst value
• for a package: an ImportablePackage value (used only for template globals)

type Declarations

type Declarations map[string]Declaration

Declarations represents a set of variables, constants, functions, types and packages declarations and can be used for template globals and package declarations.

The key is the declaration's name and the element is its value.

type Env

type Env interface {

	// CallPath returns the path, relative to the root, of the call site of
	// the caller function. If it is not called by the main goroutine, the
	// returned value is not significant.
	CallPath() string

	// Context returns the context of the execution.
	// It is the context passed as an option for execution.
	Context() context.Context

	// Fatal exits the execution and then panics with value v. Deferred
	// functions are not called and started goroutines are not terminated.
	Fatal(v interface{})

	// MarkdownConverter returns the Markdown converter provided to the
	// BuildTemplate function, if one was set.
	MarkdownConverter() Converter

	// Print calls the print built-in function with args as argument.
	Print(args ...interface{})

	// Println calls the println built-in function with args as argument.
	Println(args ...interface{})

	// Stop stops the execution with the given error. Deferred functions are
	// not called and started goroutines are not terminated.
	Stop(err error)

	// TypeOf is like reflect.TypeOf but if v has a Scriggo type it returns
	// its Scriggo reflect type instead of the reflect type of the proxy.
	TypeOf(v reflect.Value) reflect.Type
}

Env represents an execution environment.

Each execution creates an Env value. This value is passed as the first argument to calls to native functions and methods that have Env as the type of the first parameter.

type EnvStringer

type EnvStringer interface {
	String(Env) string
}

EnvStringer is like fmt.Stringer where the String method takes an Env parameter.

type HTML

type HTML string

HTML is the html type in templates.

type HTMLEnvStringer

type HTMLEnvStringer interface {
	HTML(Env) HTML
}

HTMLEnvStringer is like HTMLStringer where the HTML method takes a Env parameter.

type HTMLStringer

type HTMLStringer interface {
	HTML() HTML
}

HTMLStringer is implemented by values that are not escaped in HTML context.

type ImportablePackage

type ImportablePackage interface {

	// PackageName returns the name of the package.
	// It is a Go identifier but not the empty identifier.
	PackageName() string

	// Lookup searches for an exported declaration, named name, in the
	// package. If the declaration does not exist, it returns nil.
	Lookup(name string) Declaration

	// LookupFunc calls f for each package declaration stopping if f returns
	// an error. Lookup order is undefined.
	LookupFunc(f LookupFunc) error
}

ImportablePackage represents an importable package.

type Importer

type Importer interface {
	Import(path string) (ImportablePackage, error)
}

Importer represents a package importer; Import returns the native package with the given package path.

If an error occurs it returns the error, if the package does not exist it returns nil and nil.

type JS

type JS string

JS is the js type in templates.

type JSEnvStringer

type JSEnvStringer interface {
	JS(Env) JS
}

JSEnvStringer is like JSStringer where the JS method takes an Env parameter.

type JSON

type JSON string

JSON is the json type in templates.

type JSONEnvStringer

type JSONEnvStringer interface {
	JSON(Env) JSON
}

JSONEnvStringer is like JSONStringer where the JSON method takes an Env parameter.

type JSONStringer

type JSONStringer interface {
	JSON() JSON
}

JSONStringer is implemented by values that are not escaped in JSON context.

type JSStringer

type JSStringer interface {
	JS() JS
}

JSStringer is implemented by values that are not escaped in JavaScript context.

type LookupFunc

type LookupFunc func(name string, decl Declaration) error

LookupFunc is the type of the function called by ImportablePackage.LookupFunc to read each package declaration. If the function returns an error, ImportablePackage.LookupFunc stops and returns the error or nil if the error is StopLookup.

type Markdown

type Markdown string

Markdown is the markdown type in templates.

type MarkdownEnvStringer

type MarkdownEnvStringer interface {
	Markdown(Env) Markdown
}

MarkdownEnvStringer is like MarkdownStringer where the Markdown method takes a Env parameter.

type MarkdownStringer

type MarkdownStringer interface {
	Markdown() Markdown
}

MarkdownStringer is implemented by values that are not escaped in Markdown context.

type Package

type Package struct {
	// Name of the package.
	Name string
	// Declarations of the package.
	Declarations Declarations
}

Package implements ImportablePackage given its name and declarations.

func (Package) Lookup

func (p Package) Lookup(name string) Declaration

Lookup returns the declaration named name in the package or nil if no such declaration exists.

func (Package) LookupFunc

func (p Package) LookupFunc(f LookupFunc) error

LookupFunc calls f for each package declaration stopping if f returns an error. Lookup order is undefined.

func (Package) PackageName

func (p Package) PackageName() string

PackageName returns the name of the package.

type Packages

type Packages map[string]ImportablePackage

Packages implements Importer using a map of ImportablePackage.

func (Packages) Import

func (pp Packages) Import(path string) (ImportablePackage, error)

Import returns an ImportablePackage.

type UntypedBooleanConst

type UntypedBooleanConst bool

UntypedBooleanConst represents an untyped boolean constant.

type UntypedNumericConst

type UntypedNumericConst string

UntypedNumericConst represents an untyped numeric constant.

type UntypedStringConst

type UntypedStringConst string

UntypedStringConst represents an untyped string constant.