tokens

package
v0.15.1-dev Latest Latest
Warning

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

 Go to latest Published: Aug 9, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source 
const (
	EntryPointFunction       ModuleMemberName = ".main" // the special package entrypoint function.
	ModuleInitFunction       ModuleMemberName = ".init" // the special module initialization function.
	ClassConstructorFunction ClassMemberName  = ".ctor" // the special class instance constructor function.
	ClassInitFunction        ClassMemberName  = ".init" // the special class initialization function.
)

Special function names.

View Source 
const (
	PointerTypeDecors = PointerTypePrefix + "%v"
	PointerTypePrefix = "*"
)
View Source 
const (
	ArrayTypeDecors = ArrayTypePrefix + "%v"
	ArrayTypePrefix = "[]"
)
View Source 
const (
	MapTypeDecors    = MapTypePrefix + "%v" + MapTypeSeparator + "%v"
	MapTypePrefix    = "map["
	MapTypeSeparator = "]"
)
View Source 
const (
	FunctionTypeDecors         = FunctionTypePrefix + "%v" + FunctionTypeSeparator + "%v"
	FunctionTypePrefix         = "("
	FunctionTypeParamSeparator = ","
	FunctionTypeSeparator      = ")"
)
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 NameRegexp = regexp.MustCompile(NameRegexpPattern)
View Source 
var NameRegexpPattern = "[A-Za-z_.][A-Za-z0-9_.]*"
View Source 
var PackageNameRegexp = regexp.MustCompile(PackageNameRegexpPattern)
View Source 
var PackageNameRegexpPattern = "(" + PackagePartRegexpPattern + "\\" + QNameDelimiter + ")*" + PackagePartRegexpPattern
View Source 
var PackagePartRegexpPattern = "[A-Za-z_.][A-Za-z0-9_.-]*"
View Source 
var QNameRegexp = regexp.MustCompile(QNameRegexpPattern)
View Source 
var QNameRegexpPattern = "(" + NameRegexpPattern + "\\" + QNameDelimiter + ")*" + NameRegexpPattern

Functions

func IsArrayType 

func IsArrayType(tok Type) bool

IsArrayType returns true if the given type token represents an encoded pointer type.

func IsFunctionType 

func IsFunctionType(tok Type) bool

IsFunctionType returns true if the given type token represents an encoded pointer type.

func IsMapType 

func IsMapType(tok Type) bool

IsMapType returns true if the given type token represents an encoded pointer type.

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 IsPointerType 

func IsPointerType(tok Type) bool

IsPointerType returns true if the given type token represents an encoded pointer type.

func IsQName 

func IsQName(s string) bool

IsQName checks whether a string is a legal Name.

Types

type Accessibility 

type Accessibility string

Accessibility determines the visibility of a class member. 

const (
	PublicAccessibility    Accessibility = "public"
	PrivateAccessibility   Accessibility = "private"
	ProtectedAccessibility Accessibility = "protected"
)

Accessibility modifiers.

type ArrayType 

type ArrayType struct {
	Tok  Type // the full array type token.
	Elem Type // the element portion of the array type token.
}

ArrayType is a type token that decorates an element type token to turn it into an array: `"[]" <Elem>`.

func ParseArrayType 

func ParseArrayType(tok Type) ArrayType

ParseArrayType removes the array decorations from a token and returns its underlying type.

type ByName 

type ByName []Token

ByName implements sort.Interface to allow an array of tokens to be sorted based on string order.

func (ByName) Len 

func (ts ByName) Len() int

func (ByName) Less 

func (ts ByName) Less(i int, j int) bool

func (ByName) Swap 

func (ts ByName) Swap(i int, j int)

type ClassMember 

type ClassMember Token

ClassMember is a token representing a class's member. It uses the following grammar. Unlike ModuleMember, this cannot use a slash for delimiting names, because we use often ClassMember and ModuleMember interchangeably: 

ClassMember = <ModuleMember> "." <ClassMemberName>

func NewClassMemberToken 

func NewClassMemberToken(class Type, nm ClassMemberName) ClassMember

func (ClassMember) Class 

func (tok ClassMember) Class() Type

func (ClassMember) Module 

func (tok ClassMember) Module() Module

func (ClassMember) Name 

func (tok ClassMember) Name() ClassMemberName

func (ClassMember) Package 

func (tok ClassMember) Package() Package

func (ClassMember) String 

func (tok ClassMember) String() string

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 Function 

type Function Token

Function is a token representing a variable (module method or class method). Its grammar is as follows: 

Variable = <ModuleMember> | <ClassMember>

func (Function) String 

func (tok Function) String() string

type FunctionType 

type FunctionType struct {
	Tok        Type   // the full map type token.
	Parameters []Type // the parameter parts of the type token.
	Return     *Type  // the (optional) return part of the type token.
}

FunctionType is a type token that decorates a set of optional parameter and return tokens to turn them into a function type: `(" [ <Param1> [ "," <ParamN> ]* ] ")" [ <Return> ]`).

func ParseFunctionType 

func ParseFunctionType(tok Type) FunctionType

ParseFunctionType removes the function decorations from a token and returns its underlying type.

type MapType 

type MapType struct {
	Tok  Type // the full map type token.
	Key  Type // the key portion of the map type token.
	Elem Type // the element portion of the map type token.
}

MapType is a type token that decorates a key and element type token to turn them into a map: 

`"map[" <Key> "]" <Elem>`.

func ParseMapType 

func ParseMapType(tok Type) MapType

ParseMapType removes the map decorations from a token and returns its underlying type.

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. 

const (
	DefaultModule ModuleName = ".default" // used to reference the default module.
)

Special module names.

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_]*. 

const (
	ThisVariable  Name = ".this"  // the current object (for class methods).
	SuperVariable Name = ".super" // the parent class object (for class methods).
)

Special variable names.

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 PointerType 

type PointerType struct {
	Tok  Type // the full pointer type token.
	Elem Type // the element portion of the pointer type token.
}

PointerType is a type token that decorates an element type token turn it into a pointer: `"*" <Elem>`.

func ParsePointerType 

func ParsePointerType(tok Type) PointerType

ParsePointerType removes the pointer decorations from a token and returns its underlying type.

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) ClassMember 

func (tok Token) ClassMember() ClassMember

ClassMember extracts the class member portion from the token, assuming one exists.

func (Token) Delimiters 

func (tok Token) Delimiters() int

func (Token) HasClassMember 

func (tok Token) HasClassMember() bool

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 NewArrayTypeToken 

func NewArrayTypeToken(elem Type) Type

NewArrayTypeToken creates a new array type token from an element type.

func NewFunctionTypeToken 

func NewFunctionTypeToken(params []Type, ret *Type) Type

NewFunctionTypeToken creates a new function type token from parameter and return types.

func NewMapTypeToken 

func NewMapTypeToken(key Type, elem Type) Type

NewMapTypeToken creates a new map type token from an element type.

func NewPointerTypeToken 

func NewPointerTypeToken(elem Type) Type

NewPointerTypeToken creates a new array type token from an element type.

func NewTypeToken 

func NewTypeToken(mod Module, nm TypeName) Type

func (Type) Array 

func (tok Type) Array() bool

func (Type) Decorated 

func (tok Type) Decorated() bool

Decorated indicates whether this token represents a decorated type.

func (Type) Function 

func (tok Type) Function() bool

func (Type) Map 

func (tok Type) Map() bool

func (Type) Member 

func (tok Type) Member() ModuleMember

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) Pointer 

func (tok Type) Pointer() bool

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 NewArrayTypeName 

func NewArrayTypeName(elem TypeName) TypeName

NewArrayTypeName creates a new array type name from an element type.

func NewFunctionTypeName 

func NewFunctionTypeName(params []TypeName, ret *TypeName) TypeName

NewFunctionTypeName creates a new function type token from parameter and return types.

func NewMapTypeName 

func NewMapTypeName(key TypeName, elem TypeName) TypeName

NewMapTypeName creates a new map type name from an element type.

func NewPointerTypeName 

func NewPointerTypeName(elem TypeName) TypeName

NewPointerTypeName creates a new array type name from an element type.

func (TypeName) String 

func (nm TypeName) String() string

type Variable 

type Variable Token

Variable is a token representing a variable (module property, class property, or local variable (including parameters)). It can be a simple name for the local cases, or a true token for others: 

Variable = <Name> | <ModuleMember> | <ClassMember>

func (Variable) String 

func (tok Variable) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.