bbcode

README

bbcode

bbcode is a fast BBCode compiler for Go. Documentation can be found on GoDoc

Documentation

Overview

Package bbcode implements a parser and HTML generator for BBCode.

Index

• Constants
• Variables
• func CompileText(in *BBCodeNode) string
• func InsertNewlines(out *HTMLTag)
• func Lex(str string) chan Token
• func ValidURL(raw string) string
• type BBClosingTag
• type BBCodeNode
  • func Parse(tokens chan Token) *BBCodeNode
  • func (n *BBCodeNode) GetOpeningTag() *BBOpeningTag
• type BBOpeningTag
  • func (t *BBOpeningTag) String() string
• type Compiler
  • func NewCompiler(autoCloseTags, ignoreUnmatchedClosingTags bool) Compiler
  • func (c Compiler) Compile(str string) string
  • func (c Compiler) CompileTree(node *BBCodeNode) *HTMLTag
  • func (c Compiler) SetDefault(compiler TagCompilerFunc)
  • func (c Compiler) SetTag(tag string, compiler TagCompilerFunc)
• type HTMLTag
  • func CompileRaw(in *BBCodeNode) *HTMLTag
  • func NewHTMLTag(value string) *HTMLTag
  • func NewlineTag() *HTMLTag
  • func (t *HTMLTag) AppendChild(child *HTMLTag) *HTMLTag
  • func (t *HTMLTag) String() string
• type TagCompilerFunc
• type Token

Constants

const (
	TEXT        = "text"
	OPENING_TAG = "opening"
	CLOSING_TAG = "closing"
)

Variables

var DefaultTagCompilers map[string]TagCompilerFunc

Functions

func CompileText

func CompileText(in *BBCodeNode) string

func InsertNewlines

func InsertNewlines(out *HTMLTag)

func Lex

func Lex(str string) chan Token

func ValidURL

func ValidURL(raw string) string

Types

type BBClosingTag

type BBClosingTag struct {
	Name string
	Raw  string
}

type BBCodeNode

type BBCodeNode struct {
	Token
	Parent     *BBCodeNode
	Children   []*BBCodeNode
	ClosingTag *BBClosingTag

	Compiler *Compiler
	Info     interface{}
}

func Parse

func Parse(tokens chan Token) *BBCodeNode

func (*BBCodeNode) GetOpeningTag

func (n *BBCodeNode) GetOpeningTag() *BBOpeningTag

type BBOpeningTag

type BBOpeningTag struct {
	Name  string
	Value string
	Args  map[string]string
	Raw   string
}

func (*BBOpeningTag) String

func (t *BBOpeningTag) String() string

type Compiler

type Compiler struct {
	AutoCloseTags              bool
	IgnoreUnmatchedClosingTags bool
	// contains filtered or unexported fields
}

func NewCompiler

func NewCompiler(autoCloseTags, ignoreUnmatchedClosingTags bool) Compiler

func (Compiler) Compile

func (c Compiler) Compile(str string) string

func (Compiler) CompileTree

func (c Compiler) CompileTree(node *BBCodeNode) *HTMLTag

CompileTree transforms BBCodeNode into an HTML tag.

func (Compiler) SetDefault

func (c Compiler) SetDefault(compiler TagCompilerFunc)

func (Compiler) SetTag

func (c Compiler) SetTag(tag string, compiler TagCompilerFunc)

type HTMLTag

type HTMLTag struct {
	Name     string
	Value    string
	Attrs    map[string]string
	Children []*HTMLTag
}

HTMLTag represents a DOM node.

func CompileRaw

func CompileRaw(in *BBCodeNode) *HTMLTag

func NewHTMLTag

func NewHTMLTag(value string) *HTMLTag

NewHTMLTag creates a new HTMLTag with string contents specified by value.

func NewlineTag

func NewlineTag() *HTMLTag

Returns a new HTMLTag representing a line break

func (*HTMLTag) AppendChild

func (t *HTMLTag) AppendChild(child *HTMLTag) *HTMLTag

func (*HTMLTag) String

func (t *HTMLTag) String() string

type TagCompilerFunc

type TagCompilerFunc func(*BBCodeNode) (*HTMLTag, bool)

var DefaultTagCompiler TagCompilerFunc

type Token

type Token struct {
	ID    string
	Value interface{}
}