scanner

Documentation

Index

• type Scanner
  • func (s *Scanner) GetIndentLevel() int
  • func (s *Scanner) Init(input string)
  • func (s *Scanner) Next() (token Token, err error)
  • func (s *Scanner) NextLine() (err error)
  • func (s *Scanner) Peak() Token
  • func (s *Scanner) PeakLine() string
  • func (s *Scanner) SetToken(input string)
• type Token
  • func (t *Token) IsBoolean() bool
  • func (t *Token) IsBracket() bool
  • func (t *Token) IsBranch() bool
  • func (t *Token) IsChecksum() bool
  • func (t *Token) IsClass() bool
  • func (t *Token) IsComment() bool
  • func (t *Token) IsCommit() bool
  • func (t *Token) IsDependency() bool
  • func (t *Token) IsExpand() bool
  • func (t *Token) IsExtension() bool
  • func (t *Token) IsFunction() bool
  • func (t *Token) IsGitURL() bool
  • func (t *Token) IsHomepage() bool
  • func (t *Token) IsList() bool
  • func (t *Token) IsMaintainers() bool
  • func (t *Token) IsString() bool
  • func (t *Token) IsSubmodule() bool
  • func (t *Token) IsTag() bool
  • func (t *Token) IsURL() bool
  • func (t *Token) IsVersion() bool

Types

type Scanner

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

Scanner is a structure containing the information of where the scanner cursor is located and the input text for the scanner.

func (*Scanner) GetIndentLevel

func (s *Scanner) GetIndentLevel() int

GetIndentLevel returns the level of indentation for a line.

func (*Scanner) Init

func (s *Scanner) Init(input string)

Init instantiates a new scanner with the input text.

func (*Scanner) Next

func (s *Scanner) Next() (token Token, err error)

Next moves the cursor to the next token.

func (*Scanner) NextLine

func (s *Scanner) NextLine() (err error)

NextLine moves the cursor to the next line if possible.

func (*Scanner) Peak

func (s *Scanner) Peak() Token

Peak grabs the current token.

func (*Scanner) PeakLine

func (s *Scanner) PeakLine() string

PeakLine grabs the current active line in the scanner.

func (*Scanner) SetToken

func (s *Scanner) SetToken(input string)

SetToken sets the token equal to the input string.

type Token

type Token struct {
	Data string
}

Token is the structure containing a scanned token.

func (*Token) IsBoolean

func (t *Token) IsBoolean() bool

IsBoolean returns if the current token is a boolean.

func (*Token) IsBracket

func (t *Token) IsBracket() bool

IsBracket returns if the current token begins a bracketed set

func (*Token) IsBranch

func (t *Token) IsBranch() bool

IsBranch returns if the current token defines a branch keyword.

func (*Token) IsChecksum

func (t *Token) IsChecksum() bool

IsChecksum returns uf the current token begins with a valid checksum header.

func (*Token) IsClass

func (t *Token) IsClass() bool

IsClass returns if the current token is begins a class definition.

func (*Token) IsComment

func (t *Token) IsComment() bool

IsComment returns if the token is a comment.

func (*Token) IsCommit

func (t *Token) IsCommit() bool

IsCommit returns if the current token is an commit keyword.

func (*Token) IsDependency

func (t *Token) IsDependency() bool

IsDependency returns if the current token begins with a valid version header.

func (*Token) IsExpand

func (t *Token) IsExpand() bool

IsExpand returns if the current token is an expand keyword.

func (*Token) IsExtension

func (t *Token) IsExtension() bool

IsExtension returns if the current token is an extension keyword.

func (*Token) IsFunction

func (t *Token) IsFunction() bool

IsFunction returns if the current token begins a function.

func (*Token) IsGitURL

func (t *Token) IsGitURL() bool

IsGitURL returns if the current token begins with a valid GitURL header.

func (*Token) IsHomepage

func (t *Token) IsHomepage() bool

IsHomepage returns if the current token begins with a homepage variable declaration.

func (*Token) IsList

func (t *Token) IsList() bool

IsList returns if the current token is an list declaration.

func (*Token) IsMaintainers

func (t *Token) IsMaintainers() bool

IsMaintainers returns if the current token is an maintainers keyword.

func (*Token) IsString

func (t *Token) IsString() bool

IsString returns if the current token begins a string.

func (*Token) IsSubmodule

func (t *Token) IsSubmodule() bool

IsSubmodule returns if the current token is a submodule keyword.

func (*Token) IsTag

func (t *Token) IsTag() bool

IsTag returns if the current token is an tag keyword.

func (*Token) IsURL

func (t *Token) IsURL() bool

IsURL returns if the current token begins with a valid URL header.

func (*Token) IsVersion

func (t *Token) IsVersion() bool

IsVersion returns if the current token begins with a valid version header.