kegml

Documentation

Index

• Constants
• Variables
• func ParseTitle(s pegn.Scanner) *ast.Node
• func ReadTitle(path string) (string, error)
• func ScanTitle(s pegn.Scanner, buf *[]rune) bool
• func ScanYAMLFrontMatter(s pegn.Scanner, buf *[]rune) bool

Examples

• ScanTitle (Short)

Constants

const (
	Untyped int = iota
	Title
)

Variables

var PEGN string

var Scanner pegn.Scanner

Functions

func ParseTitle

func ParseTitle(s pegn.Scanner) *ast.Node

func ReadTitle

func ReadTitle(path string) (string, error)

ReadTitle reads a KEG node title from KEGML file.

func ScanTitle

func ScanTitle(s pegn.Scanner, buf *[]rune) bool

Example (Short)

package main

import (
	"fmt"

	"github.com/BuddhiLW/keg/kegml"
	"github.com/rwxrob/pegn/scanner"
)

func main() {
	s := scanner.New(`# A short title`)

	fmt.Println(kegml.ScanTitle(s, nil))
	s.Print()

}

Output:

true
'e' 14-15 ""

func ScanYAMLFrontMatter

func ScanYAMLFrontMatter(s pegn.Scanner, buf *[]rune) bool