package
0.0.0-20230413142902-7f6369a29beb
Repository: https://github.com/code-game-project/cge-parser.git
Documentation: pkg.go.dev

# README

Adapter Library

The adapter package provides helpers for interfacing with a cge-parser executable.

Usage

// Open example.cge.
file, _ := os.Open("example.cge")

// Parse metadata like cge_version from file.
// The returned reader is an io.MultiReader which wraps a buffer containing the
// read bytes for metadata parsing and the supplied reader, which enables choosing
// the cge-parser executable depending on the CGE version, because the data of the reader
// is not consumed.
metadata, reader, err := adapter.ParseMetadata(file)

// Execute the supplied cge-parser executable with the provided configuration
// and collect its output (objects, diagnostics, …) in the response struct.
response, errs := adapter.ParseCGE(reader, "/path/to/cge-parser", adapter.Config{
  IncludeComments: true,
  SendTokens:      true,
  NoObjects:       false,
  DisableWarnings: false,
})

# Functions

No description provided by the author
ParseMetadata reads the header of the CGE file and returns the metadata fields and a new io.Reader (even present if err != nil), which still contains the header enabling it to be used for complete parsing.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author