tokens

package
Version: v2.25.2 Latest Latest
Warning

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

Go to latest
Published: Apr 17, 2021 License: Apache-2.0 Imports: 4 Imported by: 51

Documentation

Overview

Package tokens contains the core symbol and token types for referencing resources and related entities.

Index

Constants

View Source
const QNameDelimiter = "/"

QNameDelimiter is what delimits Namespace and Name parts.

View Source
const TokenDelimiter string = ":" // the character delimiting portions of a qualified token.

Variables

View Source
var NameRegexpPattern = "[A-Za-z_.][A-Za-z0-9_.]*"
View Source
var PackageNameRegexpPattern = "(" + PackagePartRegexpPattern + "\\" + QNameDelimiter + ")*" + PackagePartRegexpPattern
View Source
var PackagePartRegexpPattern = "[A-Za-z_.][A-Za-z0-9_.-]*"
View Source
var QNameRegexpPattern = "(" + NameRegexpPattern + "\\" + QNameDelimiter + ")*" + NameRegexpPattern

Functions

func IsName

func IsName(s string) bool

IsName checks whether a string is a legal Name.

func IsPackageName

func IsPackageName(s string) bool

IsPackageName checks whether a string is a legal Name.

func IsQName

func IsQName(s string) bool

IsQName checks whether a string is a legal Name.

Types

type ClassMemberName

type ClassMemberName Name

ClassMemberName is a simple name representing the class member's identifier.

func (ClassMemberName) Name

func (nm ClassMemberName) Name() Name

func (ClassMemberName) String

func (nm ClassMemberName) String() string

type Module

type Module Token

Module is a token representing a module. It uses the following subset of the token grammar:

Module = <Package> ":" <ModuleName>

Note that a module name of "." means "current module", to simplify emission and lookups.

func NewModuleToken

func NewModuleToken(pkg Package, nm ModuleName) Module

func (Module) Name

func (tok Module) Name() ModuleName

func (Module) Package

func (tok Module) Package() Package

func (Module) String

func (tok Module) String() string

type ModuleMember

type ModuleMember Token

ModuleMember is a token representing a module's member. It uses the following grammar. Note that this is not ambiguous because member names cannot contain slashes, and so the "last" slash in a name delimits the member:

ModuleMember = <Module> "/" <ModuleMemberName>

func NewModuleMemberToken

func NewModuleMemberToken(mod Module, nm ModuleMemberName) ModuleMember

func ParseModuleMember

func ParseModuleMember(s string) (ModuleMember, error)

ParseModuleMember attempts to turn the string s into a module member, returning an error if it isn't a valid one.

func (ModuleMember) Module

func (tok ModuleMember) Module() Module

func (ModuleMember) Name

func (tok ModuleMember) Name() ModuleMemberName

func (ModuleMember) Package

func (tok ModuleMember) Package() Package

func (ModuleMember) String

func (tok ModuleMember) String() string

type ModuleMemberName

type ModuleMemberName Name

ModuleMemberName is a simple name representing the module member's identifier.

func (ModuleMemberName) String

func (nm ModuleMemberName) String() string

type ModuleName

type ModuleName QName

ModuleName is a qualified name referring to an imported module from a package.

func (ModuleName) String

func (nm ModuleName) String() string

type Name

type Name string

Name is an identifier. It conforms to the regex [A-Za-z_.][A-Za-z0-9_]*.

func AsName

func AsName(s string) Name

AsName converts a given string to a Name, asserting its validity.

func (Name) Q

func (nm Name) Q() QName

Q turns a Name into a qualified name; this is legal, since Name's is a proper subset of QName's grammar.

func (Name) String

func (nm Name) String() string

type Package

type Package Token

Package is a token representing just a package. It uses a much simpler grammar:

Package = <PackageName>

Note that a package name of "." means "current package", to simplify emission and lookups.

func NewPackageToken

func NewPackageToken(nm PackageName) Package

func (Package) Name

func (tok Package) Name() PackageName

func (Package) String

func (tok Package) String() string

type PackageName

type PackageName string

PackageName is a qualified name referring to an imported package. It is similar to a QName, except that it permits dashes "-" as is commonplace with packages of various kinds.

func (PackageName) String

func (nm PackageName) String() string

type QName

type QName string

QName is a qualified identifier. The "/" character optionally delimits different pieces of the name. Each element conforms to the Name regex [A-Za-z_.][A-Za-z0-9_.]*. For example, "pulumi/pulumi/stack".

func AsQName

func AsQName(s string) QName

AsQName converts a given string to a QName, asserting its validity.

func (QName) Name

func (nm QName) Name() Name

Name extracts the Name portion of a QName (dropping any namespace).

func (QName) Namespace

func (nm QName) Namespace() QName

Namespace extracts the namespace portion of a QName (dropping the name); this may be empty.

func (QName) String

func (nm QName) String() string

type Token

type Token string

Token is a qualified name that is capable of resolving to a symbol entirely on its own. Most uses of tokens are typed based on the context, so that a subset of the token syntax is permissible (see the various typedefs below). However, in its full generality, a token can have a package part, a module part, a module-member part, and a class-member part. Obviously tokens that are meant to address just a module won't have the module-member part, and tokens addressing module members won't have the class-member part, etc.

Token's grammar is as follows:

Token				= <Identifier> |
					  <QualifiedToken> |
					  <DecoratedType>
Identifier			= <Name>
QualifiedToken		= <PackageName> [ ":" <ModuleName> [ ":" <ModuleMemberName> [ ":" <ClassMemberName> ] ] ]
PackageName			= ... similar to <QName>, except dashes permitted ...
ModuleName			= <QName>
ModuleMemberName	= <Name>
ClassMemberName		= <Name>

A token may be a simple identifier in the case that it refers to a built-in symbol, like a primitive type, or a variable in scope, rather than a qualified token that is to be bound to a symbol through package/module resolution.

Notice that both package and module names may be qualified names (meaning they can have "/"s in them; see QName's comments), and that module and class members must use unqualified, simple names (meaning they have no delimiters). The specialized token kinds differ only in what elements they require as part of the token string.

Finally, a token may also be a decorated type. This is for built-in array, map, pointer, and function types:

DecoratedType		= "*" <Token> |
					  "[]" <Token> |
					  "map[" <Token> "]" <Token> |
					  "(" [ <Token> [ "," <Token> ]* ] ")" <Token>?

Notice that a recursive parsing process is required to extract elements from a <DecoratedType> token.

func (Token) Delimiters

func (tok Token) Delimiters() int

func (Token) HasModule

func (tok Token) HasModule() bool

func (Token) HasModuleMember

func (tok Token) HasModuleMember() bool

func (Token) Module

func (tok Token) Module() Module

Module extracts the module portion from the token, assuming one exists.

func (Token) ModuleMember

func (tok Token) ModuleMember() ModuleMember

ModuleMember extracts the module member portion from the token, assuming one exists.

func (Token) Name

func (tok Token) Name() Name

Name returns the Token as a Name (and assumes it is a legal one).

func (Token) Package

func (tok Token) Package() Package

Package extracts the package from the token, assuming one exists.

func (Token) Simple

func (tok Token) Simple() bool

func (Token) String

func (tok Token) String() string

type Type

type Type Token

Type is a token representing a type. It is either a primitive type name, reference to a module class, or decorated:

Type = <Name> | <ModuleMember> | <DecoratedType>

func NewTypeToken

func NewTypeToken(mod Module, nm TypeName) Type

func ParseTypeToken

func ParseTypeToken(s string) (Type, error)

ParseTypeToken interprets an arbitrary string as a Type, returning an error if the string is not a valid Type.

func (Type) Module

func (tok Type) Module() Module

func (Type) Name

func (tok Type) Name() TypeName

func (Type) Package

func (tok Type) Package() Package

func (Type) Primitive

func (tok Type) Primitive() bool

Primitive indicates whether this type is a primitive type name (i.e., not qualified with a module, etc).

func (Type) String

func (tok Type) String() string

type TypeName

type TypeName Name

TypeName is a simple name representing the type's name, without any package/module qualifiers.

func (TypeName) String

func (nm TypeName) String() string

Source Files

Jump to

Keyboard shortcuts

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