analysis

README

pawn-analysis

Shared Pawn preprocessing and semantic analysis for PawnKit tools.

The library provides original and expanded syntax, source-mapped symbols, tag and call checks, control flow, constant evaluation, and cached snapshots. Automaton checks cover invalid state transitions and conflicting state implementations.

result, err := analysis.AnalyzeContext(ctx, text, analysis.Options{
    URI: source.FileURI(path),
})

Use query.Snapshot for versioned editor documents. Set Options.Revision when API metadata or resolver state changes so cached results are invalidated. Use AnalyzeDocuments when the project host has already built a dependency closure.

Run go test ./... for the offline suite. Tests use a sibling pawn-corpus checkout when present. Set PAWN_CORPUS_DIR when it lives elsewhere.

Contributing

Small parser, resolver, and analysis fixes are welcome. A reduced Pawn example is often the best place to start. See CONTRIBUTING.md.

Licence

MIT

Documentation

Overview

Package analysis wires PawnKit preprocessing, parsing, and semantics.

Index

• type Options
• type Result
  • func Analyze(text []byte, opts Options) *Result
  • func AnalyzeContext(ctx context.Context, text []byte, opts Options) (*Result, error)

Types

type Options

type Options struct {
	URI            source.URI
	Includes       preprocess.IncludeResolver
	Names          sema.Resolver
	Predefined     map[string]string
	Revision       string
	RetainExpanded bool
}

Options configures one file analysis.

type Result

type Result struct {
	File            source.FileID
	Registry        *source.Registry
	Preprocess      *preprocess.Result
	Parse           *parser.CompactFile
	ExpandedParse   *parser.CompactFile
	Symbols         *symbol.Table
	ExpandedSymbols *symbol.Table
	Semantics       sema.Result
	ControlFlow     []sema.FunctionFlow
	Diagnostics     []diagnostic.Diagnostic
}

Result is one immutable file analysis.

func Analyze

func Analyze(text []byte, opts Options) *Result

Analyze runs the shared per-file pipeline.

func AnalyzeContext

func AnalyzeContext(ctx context.Context, text []byte, opts Options) (*Result, error)

AnalyzeContext runs the shared per-file pipeline with cancellation.