package token

Import Path
	github.com/go-git/gcfg/token (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 2 packages

Involved Source Files

	      position.go
	      serialize.go
	   d➜ token.go
		Package token defines constants representing the lexical tokens of the gcfg
		configuration syntax and basic operations on tokens (printing, predicates).

		Note that the API for the token package may change to accommodate new
		features or implementation changes in gcfg.
Package-Level Type Names (total 8, in which 5 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type File (struct)
		A File is a handle for a file belonging to a FileSet.
		A File has a name, size, and line offset table.

		Fields (total 6, none are exported)
			/* 6 unexporteds ... *//* 6 unexporteds: */
			base int
				// Pos value range for this file is [base...base+size]

			infos []lineInfo
			lines []int
				lines and infos are protected by set.mutex

			name string
				// file name as provided to AddFile

			set *FileSet
			size int
				// file size as provided to AddFile

		Methods (total 14, in which 12 are exported)
			(*T) AddLine(offset int)
				AddLine adds the line offset for a new line.
				The line offset must be larger than the offset for the previous line
				and smaller than the file size; otherwise the line offset is ignored.

			(*T) AddLineInfo(offset int, filename string, line int)
				AddLineInfo adds alternative file and line number information for
				a given file offset. The offset must be larger than the offset for
				the previously added alternative line info and smaller than the
				file size; otherwise the information is ignored.

				AddLineInfo is typically used to register alternative position
				information for //line filename:line comments in source files.

			(*T) Base() int
				Base returns the base offset of file f as registered with AddFile.

			(*T) Line(p Pos) int
				Line returns the line number for the given file position p;
				p must be a Pos value in that file or NoPos.

			(*T) LineCount() int
				LineCount returns the number of lines in file f.

			(*T) Name() string
				Name returns the file name of file f as registered with AddFile.

			(*T) Offset(p Pos) int
				Offset returns the offset for the given file position p;
				p must be a valid Pos value in that file.
				f.Offset(f.Pos(offset)) == offset.

			(*T) Pos(offset int) Pos
				Pos returns the Pos value for the given file offset;
				the offset must be <= f.Size().
				f.Pos(f.Offset(p)) == p.

			(*T) Position(p Pos) (pos Position)
				Position returns the Position value for the given file position p;
				p must be a Pos value in that file or NoPos.

			(*T) SetLines(lines []int) bool
				SetLines sets the line offsets for a file and returns true if successful.
				The line offsets are the offsets of the first character of each line;
				for instance for the content "ab\nc\n" the line offsets are {0, 3}.
				An empty file has an empty line offset table.
				Each line offset must be larger than the offset for the previous line
				and smaller than the file size; otherwise SetLines fails and returns
				false.

			(*T) SetLinesForContent(content []byte)
				SetLinesForContent sets the line offsets for the given file content.

			(*T) Size() int
				Size returns the size of file f as registered with AddFile.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) info(offset int) (filename string, line, column int)
				info returns the file name, line, and column number for a file offset.

			(*T) position(p Pos) (pos Position)
		As Outputs Of (at least 3, in which 2 are exported)
			func (*FileSet).AddFile(filename string, base, size int) *File
			func (*FileSet).File(p Pos) (f *File)
			/* at least one unexported ... *//* at least one unexported: */
			func (*FileSet).file(p Pos) *File
		As Inputs Of (at least 4, in which 1 are exported)
			func github.com/go-git/gcfg/scanner.(*Scanner).Init(file *File, src []byte, err scanner.ErrorHandler, mode scanner.Mode)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func searchFiles(a []*File, x int) int
			func github.com/go-git/gcfg.read(c *warnings.Collector, callback func(string, string, string, string, bool) error, fset *FileSet, file *File, src []byte) error
			func github.com/go-git/gcfg.readInto(config interface{}, fset *FileSet, file *File, src []byte) error

	 type FileSet (struct)
		A FileSet represents a set of source files.
		Methods of file sets are synchronized; multiple goroutines
		may invoke them concurrently.

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			base int
				// base offset for the next file

			files []*File
				// list of files in the order added to the set

			last *File
				// cache of last file looked up

			mutex sync.RWMutex
				// protects the file set

		Methods (total 8, in which 7 are exported)
			(*T) AddFile(filename string, base, size int) *File
				AddFile adds a new file with a given filename, base offset, and file size
				to the file set s and returns the file. Multiple files may have the same
				name. The base offset must not be smaller than the FileSet's Base(), and
				size must not be negative.

				Adding the file will set the file set's Base() value to base + size + 1
				as the minimum base value for the next file. The following relationship
				exists between a Pos value p for a given file offset offs:

					int(p) = base + offs

				with offs in the range [0, size] and thus p in the range [base, base+size].
				For convenience, File.Pos may be used to create file-specific position
				values from a file offset.

			(*T) Base() int
				Base returns the minimum base offset that must be provided to
				AddFile when adding the next file.

			(*T) File(p Pos) (f *File)
				File returns the file that contains the position p.
				If no such file is found (for instance for p == NoPos),
				the result is nil.

			(*T) Iterate(f func(*File) bool)
				Iterate calls f for the files in the file set in the order they were added
				until f returns false.

			(*T) Position(p Pos) (pos Position)
				Position converts a Pos in the fileset into a general Position.

			(*T) Read(decode func(interface{}) error) error
				Read calls decode to deserialize a file set into s; s must not be nil.

			(*T) Write(encode func(interface{}) error) error
				Write calls encode to serialize the file set s.

			/* one unexported ... *//* one unexported: */
			(*T) file(p Pos) *File
		As Outputs Of (at least one exported)
			func NewFileSet() *FileSet
		As Inputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func github.com/go-git/gcfg.read(c *warnings.Collector, callback func(string, string, string, string, bool) error, fset *FileSet, file *File, src []byte) error
			func github.com/go-git/gcfg.readInto(config interface{}, fset *FileSet, file *File, src []byte) error

	 type Pos int (basic type)
		Pos is a compact encoding of a source position within a file set.
		It can be converted into a Position for a more convenient, but much
		larger, representation.

		The Pos value for a given file is a number in the range [base, base+size],
		where base and size are specified when adding the file to the file set via
		AddFile.

		To create the Pos value for a specific source offset, first add
		the respective file to the current file set (via FileSet.AddFile)
		and then call File.Pos(offset) for that file. Given a Pos value p
		for a specific file set fset, the corresponding Position value is
		obtained by calling fset.Position(p).

		Pos values can be compared directly with the usual comparison operators:
		If two Pos values p and q are in the same file, comparing p and q is
		equivalent to comparing the respective source file offsets. If p and q
		are in different files, p < q is true if the file implied by p was added
		to the respective file set before the file implied by q.

		Methods (only one, which is exported)
			( T) IsValid() bool
				IsValid returns true if the position is valid.

		Implements (at least one exported)
			 T : database/sql/driver.Validator
		As Outputs Of (at least 2, both are exported)
			func (*File).Pos(offset int) Pos
			func github.com/go-git/gcfg/scanner.(*Scanner).Scan() (pos Pos, tok Token, lit string)
		As Inputs Of (at least 7, in which 5 are exported)
			func (*File).Line(p Pos) int
			func (*File).Offset(p Pos) int
			func (*File).Position(p Pos) (pos Position)
			func (*FileSet).File(p Pos) (f *File)
			func (*FileSet).Position(p Pos) (pos Position)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func (*File).position(p Pos) (pos Position)
			func (*FileSet).file(p Pos) *File
		As Types Of (only one, which is exported)
			const NoPos

	 type Position (struct)
		Position describes an arbitrary source position
		including the file, line, and column location.
		A Position is valid if the line number is > 0.

		Fields (total 4, all are exported)
			Column int
				// column number, starting at 1 (byte count)

			Filename string
				// filename, if any

			Line int
				// line number, starting at 1

			Offset int
				// offset, starting at 0

		Methods (total 2, both are exported)
			(*T) IsValid() bool
				IsValid returns true if the position is valid.

			( T) String() string
				String returns a string in one of several forms:

					file:line:column    valid position with file name
					line:column         valid position without file name
					file                invalid position with file name
					-                   invalid position without file name

		Implements (at least 5, in which 3 are exported)
			*T : database/sql/driver.Validator
			 T : expvar.Var
			 T : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 T : context.stringer
			 T : runtime.stringer
		As Outputs Of (at least 3, in which 2 are exported)
			func (*File).Position(p Pos) (pos Position)
			func (*FileSet).Position(p Pos) (pos Position)
			/* at least one unexported ... *//* at least one unexported: */
			func (*File).position(p Pos) (pos Position)
		As Inputs Of (at least one exported)
			func github.com/go-git/gcfg/scanner.(*ErrorList).Add(pos Position, msg string)

	 type Token int (basic type)
		Token is the set of lexical tokens of the gcfg configuration syntax.

		Methods (total 3, all are exported)
			( T) IsLiteral() bool
				IsLiteral returns true for tokens corresponding to identifiers
				and basic type literals; it returns false otherwise.

			( T) IsOperator() bool
				IsOperator returns true for tokens corresponding to operators and
				delimiters; it returns false otherwise.

			( T) String() string
				String returns the string corresponding to the token tok.
				For operators and delimiters, the string is the actual token character
				sequence (e.g., for the token ASSIGN, the string is "="). For all other
				tokens the string corresponds to the token constant name (e.g. for the
				token IDENT, the string is "IDENT").

		Implements (at least 4, in which 2 are exported)
			 T : expvar.Var
			 T : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 T : context.stringer
			 T : runtime.stringer
		As Outputs Of (at least one exported)
			func github.com/go-git/gcfg/scanner.(*Scanner).Scan() (pos Pos, tok Token, lit string)
		As Types Of (total 13, in which 9 are exported)
			const ASSIGN
			const COMMENT
			const EOF
			const EOL
			const IDENT
			const ILLEGAL
			const LBRACK
			const RBRACK
			const STRING
			/* 4 unexporteds ... *//* 4 unexporteds: */
			const literal_beg
			const literal_end
			const operator_beg
			const operator_end

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type lineInfo (struct)
		A lineInfo object describes alternative file and line number
		information (such as provided via a //line comment in a .go
		file) for a given file offset.

		Fields (total 3, all are exported)
			Filename string
			Line int
			Offset int
				fields are exported to make them accessible to gob

		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func searchLineInfos(a []lineInfo, x int) int

	 type serializedFile (struct)

		Fields (total 5, all are exported)
			Base int
			Infos []lineInfo
			Lines []int
			Name string
				fields correspond 1:1 to fields with same (lower-case) name in File

			Size int

	 type serializedFileSet (struct)

		Fields (total 2, both are exported)
			Base int
			Files []serializedFile


Package-Level Functions (total 4, in which 1 are exported)

	 func NewFileSet() *FileSet
		NewFileSet creates a new file set.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func searchFiles(a []*File, x int) int
	 func searchInts(a []int, x int) int
	 func searchLineInfos(a []lineInfo, x int) int
Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var tokens [12]string
Package-Level Constants (total 14, in which 10 are exported)

	const ASSIGN Token = 8 // =
		Operators and delimiters

	const COMMENT Token = 2
		The list of tokens.

	const EOF Token = 1
		The list of tokens.

	const EOL Token = 11 // \n
		The list of tokens.

	const IDENT Token = 4 // section-name, variable-name
		Identifiers and basic type literals
		(these tokens stand for classes of literals)

	const ILLEGAL Token = 0
		Special tokens

	const LBRACK Token = 9 // [
		The list of tokens.

	const NoPos Pos = 0
		The zero value for Pos is NoPos; there is no file and line information
		associated with it, and NoPos().IsValid() is false. NoPos is always
		smaller than any other Pos value. The corresponding Position value
		for NoPos is the zero value for Position.

	const RBRACK Token = 10 // ]
		The list of tokens.

	const STRING Token = 5 // "subsection-name", variable value
		The list of tokens.

	/* 4 unexporteds ... *//* 4 unexporteds: */
	const literal_beg Token = 3
		The list of tokens.

	const literal_end Token = 6
		The list of tokens.

	const operator_beg Token = 7
		The list of tokens.

	const operator_end Token = 12
		The list of tokens.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.