include

Documentation

Overview

Package include resolves Pawn include directives.

Index

• type Candidate
• type Resolver
  • func New(fsys fsx.FS, roots []string) *Resolver
  • func NewWithQuotedRoots(fsys fsx.FS, roots, quotedRoots []string) *Resolver
  • func (r *Resolver) Complete(fromFile, prefix string, quoted bool, limit int) []Candidate
  • func (r *Resolver) Resolve(fromFile, spec string, quoted bool) (string, bool)
  • func (r *Resolver) ResolveAll(fromFile, spec string, quoted bool) []string
  • func (r *Resolver) Roots() []string

Types

type Candidate

type Candidate struct {
	Path      string
	Directory bool
}

Candidate is an include path offered by an editor.

type Resolver

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

Resolver searches a fixed, ordered list of include roots.

func New

func New(fsys fsx.FS, roots []string) *Resolver

New builds a Resolver from ordered, absolute roots.

func NewWithQuotedRoots

func NewWithQuotedRoots(fsys fsx.FS, roots, quotedRoots []string) *Resolver

NewWithQuotedRoots adds roots used only by quoted includes.

func (*Resolver) Complete

func (r *Resolver) Complete(fromFile, prefix string, quoted bool, limit int) []Candidate

Complete lists include paths below the typed prefix.

func (*Resolver) Resolve

func (r *Resolver) Resolve(fromFile, spec string, quoted bool) (string, bool)

Resolve finds spec from fromFile. Quoted includes search the source directory first. Missing extensions are retried with ".inc".

func (*Resolver) ResolveAll

func (r *Resolver) ResolveAll(fromFile, spec string, quoted bool) []string

ResolveAll returns matching include paths in search order.

func (*Resolver) Roots

func (r *Resolver) Roots() []string

Roots returns the configured search path.