sourcecode

package

v0.5.5-rc.5 Latest Latest Go to latest Published: Oct 6, 2022 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/adnsv/go-utils

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func LineContentAt[T StringLikeContent](anchor Anchor, buf T) T
func MakeErrorAt[T StringLikeContent](anchor Anchor, buf T, err error) error
type Anchor
- func CalcAnchor[T StringLikeContent](buf T) Anchor
type Error
- func MakeError(loc Location, err error) *Error
- func (e *Error) Error() string
type Location
- func LocationAt[T StringLikeContent](anchor Anchor, buf T) Location
- func (loc *Location) String() string
- func (loc *Location) Valid() bool
type LocationInFile
- func (loc *LocationInFile) String() string
type Scanner
- func NewScanner(b string) *Scanner
type StringLikeContent

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrDecDigitExpected = errors.New("a valid decimal digit expected")

View Source

var ErrHexDigitExpected = errors.New("a valid hex digit expected")

Functions ¶

func LineContentAt ¶

func LineContentAt[T StringLikeContent](anchor Anchor, buf T) T

func MakeErrorAt ¶

func MakeErrorAt[T StringLikeContent](anchor Anchor, buf T, err error) error

Types ¶

type Anchor ¶

type Anchor struct {
	LineNumber      int
	LineStartOffset int
	OffsetInBuffer  int
}

func CalcAnchor ¶

func CalcAnchor[T StringLikeContent](buf T) Anchor

type Error ¶

type Error struct {
	Location Location
	Err      error
}

func MakeError ¶

func MakeError(loc Location, err error) *Error

func (*Error) Error ¶

func (e *Error) Error() string

type Location ¶

type Location struct {
	LineNumber   int // 1-based
	ColumnNumber int // 1-based
}

Location specifies line:column position within a text file - both numers are 1-based - empty inputs are treated as 1:1

func LocationAt ¶

func LocationAt[T StringLikeContent](anchor Anchor, buf T) Location

func (*Location) String ¶

func (loc *Location) String() string

func (*Location) Valid ¶

func (loc *Location) Valid() bool

type LocationInFile ¶

type LocationInFile struct {
	Filepath string
	Location
}

func (*LocationInFile) String ¶

func (loc *LocationInFile) String() string

type Scanner ¶

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

Scanner is a generic helper for scraping source code for translation strings

func NewScanner ¶

func NewScanner(b string) *Scanner

func (*Scanner) Anchor ¶

func (scn *Scanner) Anchor() Anchor

func (*Scanner) IsAnyOf ¶

func (scn *Scanner) IsAnyOf(chars string) bool

func (*Scanner) IsByte ¶

func (scn *Scanner) IsByte(c byte) bool

func (*Scanner) IsByteFunc ¶

func (scn *Scanner) IsByteFunc(f func(byte) bool) bool

func (*Scanner) IsEOF ¶

func (scn *Scanner) IsEOF() bool

func (*Scanner) IsEOL ¶

func (scn *Scanner) IsEOL() bool

func (*Scanner) IsNextByte ¶

func (scn *Scanner) IsNextByte(offset int, c byte) bool

func (*Scanner) IsNextByteFunc ¶

func (scn *Scanner) IsNextByteFunc(offset int, f func(byte) bool) bool

func (*Scanner) IsSequence ¶

func (scn *Scanner) IsSequence(s string) bool

func (*Scanner) IsWS ¶

func (scn *Scanner) IsWS() bool

func (*Scanner) LineContentAt ¶

func (scn *Scanner) LineContentAt(anchor Anchor) string

func (*Scanner) LocationAt ¶

func (scn *Scanner) LocationAt(anchor Anchor) Location

func (*Scanner) MakeErrorAt ¶

func (scn *Scanner) MakeErrorAt(anchor Anchor, err error) error

func (*Scanner) ReadDecUint ¶

func (scn *Scanner) ReadDecUint() (uint64, error)

func (*Scanner) ReadHexUint ¶

func (scn *Scanner) ReadHexUint() (uint64, error)

func (*Scanner) ReadLineUntil ¶

func (scn *Scanner) ReadLineUntil(c byte) string

func (*Scanner) ReadSequenceFunc ¶

func (scn *Scanner) ReadSequenceFunc(isFirst, isOther func(byte) bool) string

func (*Scanner) Skip ¶

func (scn *Scanner) Skip() bool

func (*Scanner) SkipByte ¶

func (scn *Scanner) SkipByte(c byte) bool

func (*Scanner) SkipByteFunc ¶

func (scn *Scanner) SkipByteFunc(f func(byte) bool) bool

func (*Scanner) SkipEOL ¶

func (scn *Scanner) SkipEOL() bool

func (*Scanner) SkipSequence ¶

func (scn *Scanner) SkipSequence(s string) bool

func (*Scanner) SkipWS ¶

func (scn *Scanner) SkipWS() bool

func (*Scanner) SkipWSEOL ¶

func (scn *Scanner) SkipWSEOL() bool

type StringLikeContent ¶

type StringLikeContent interface {
	~string | []byte
}

Source Files ¶

View all Source files

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