ast

README

AST

The project provides the Avocet Tools implementation of a reStructuredText abstract syntax tree. It is used to specify the structs returned by both linear and inlinear RST parsers

Documentation

Index

• func PrettyB(t BType) string
• func PrettyE(t EType) string
• func PrettyP(t PType) string
• type BType
• type Block
  • func NewBlock(t BType, fname string, line int) *Block
  • func (blk *Block) Has(idref string) bool
  • func (blk *Block) HasClass(cls string) bool
• type Content
  • func NewContent() *Content
  • func (con *Content) Add(blk *Block)
  • func (con *Content) Append(blk *Block)
  • func (con *Content) Insert(e *Element)
  • func (con *Content) Int(key, val string)
  • func (con *Content) Merge(ncon *Content)
  • func (con *Content) Sect(sect *Section)
  • func (con *Content) Set(key, val string)
  • func (con *Content) Target(key string, data *Content)
• type Document
  • func NewDocument(p *Path) *Document
• type EType
• type Element
  • func NewElement(t EType, line, pos int) *Element
• type PType
• type Path
  • func NewPath(abs, rel string) *Path
  • func (p *Path) Set()
• type Section
  • func NewSection(char string) *Section
  • func (sec *Section) Has(idref string) bool

Functions

func PrettyB

func PrettyB(t BType) string

func PrettyE

func PrettyE(t EType) string

func PrettyP

func PrettyP(t PType) string

Types

type BType

type BType int

const (
	UnsetBType BType = iota
	Para
	Directive
	UList
	UListItem
	OList
	OListItem
	DList
	DListItem

	Footnote
	Endnote
	Citation
)

type Block

type Block struct {
	Type    BType    `json:"block_type"`
	Content *Content `json:"block_content"`

	Idrefs []string `json:"identity_references,omitempty"`
	Class  []string `json:"classifiers,omitempty"`

	File string `json:"filename"`
	Line int    `json:"line"`
}

func NewBlock

func NewBlock(t BType, fname string, line int) *Block

func (*Block) Has

func (blk *Block) Has(idref string) bool

func (*Block) HasClass

func (blk *Block) HasClass(cls string) bool

type Content

type Content struct {
	Inline   []*Element          `json:"inline_elements,omitempty" bson:"inline_elements,omitempty"`
	Meta     map[string]string   `json:"metadata_user,omitempty" bson:metadata_user,omitempty"`
	Internal map[string]string   `json:"metadata_internal,omitempty" bson:"metadata_internal,omitempty"`
	Data     []*Block            `json:"data,omitempty" bson:"data,omitempty"`
	Targets  map[string]*Content `json:"targets,omitempty" bson:"targets,omitempty"`
	Sections []*Section          `json:"sections" bson:"sections,omitempty"`
}

func NewContent

func NewContent() *Content

func (*Content) Add

func (con *Content) Add(blk *Block)

func (*Content) Append

func (con *Content) Append(blk *Block)

func (*Content) Insert

func (con *Content) Insert(e *Element)

func (*Content) Int

func (con *Content) Int(key, val string)

func (*Content) Merge

func (con *Content) Merge(ncon *Content)

func (*Content) Sect

func (con *Content) Sect(sect *Section)

func (*Content) Set

func (con *Content) Set(key, val string)

func (*Content) Target

func (con *Content) Target(key string, data *Content)

type Document

type Document struct {
	Valid bool `json:"-"`

	Path *Path `json:"path"`

	Content *Content `json:"content"`
}

func NewDocument

func NewDocument(p *Path) *Document

type EType

type EType int

const (
	Unset EType = iota
	Text
	Strong
	Emphasis
	Code
	Literal
	ULink
	VLink
	Foot
	End
	UCite
	VCite
	Replace
	Sub
	ULinkSub
	VLinkSub
	Role
)

type Element

type Element struct {
	Type EType  `json:"element_type" bson:"element_type"`
	Text string `json:"text" bson:"text"`

	File string `json:"file" bson:"file"`
	Line int    `json:"line" bson:"line"`
	Pos  int    `json:"position" bson:"position"`

	Dom  string `json:"domain,omitempty" bson:"domain,omitempty"`
	Role string `json:"role,omitempty" bson:"role,omitempty"`
	Key  string `json:"key,omitempty" bson:"key,omitempty"`
}

func NewElement

func NewElement(t EType, line, pos int) *Element

type PType

type PType int

const (
	UnsetPath PType = iota
	RST
	Tex
	Md
	PDF
	HTML
)

type Path

type Path struct {
	Type PType  `json:"type"`
	Ext  string `json:"extension"`

	Name     string    `json:"name_base"`
	Filename string    `json:"name_file"`
	Dir      string    `json:"path_dir"`
	Abs      string    `json:"path_absolute"`
	Rel      string    `json:"path_relative"`
	Size     int64     `json:"size"`
	Mtime    time.Time `json:"mtime"`
}

func NewPath

func NewPath(abs, rel string) *Path

func (*Path) Set

func (p *Path) Set()

type Section

type Section struct {
	Content *Content `json:"section_content"`

	Idrefs []string `json:"identity_references"`

	LiteralLevel string `json:"level_literal"`
	LocalLevel   int    `json:"level_local"`
	GlobalLevel  int    `json:"level_global"`
}

func NewSection

func NewSection(char string) *Section

func (*Section) Has

func (sec *Section) Has(idref string) bool