highlight

package

v0.0.0-...-0e7933b Latest Latest Go to latest Published: Jan 22, 2022 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/SaionjiAsuka/magpie

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type ConsoleHighlighter
- func NewConsoleHighlighter() *ConsoleHighlighter
type HighlightIntf
type Highlighter
- func New(input string) *Highlighter
- func (h *Highlighter) Highlight()
- func (h *Highlighter) RegisterGenerator(intf HighlightIntf)
type HtmlHighlighter
- func NewHtmlHighlighter(writer io.Writer) *HtmlHighlighter

Constants ¶

View Source

const (
	COLOR_RESET  = "\x1b[0m"
	COLOR_BRIGHT = "\x1b[1m"

	COLOR_BLACK   = "\x1b[30m"
	COLOR_RED     = "\x1b[31m"
	COLOR_GREEN   = "\x1b[32m"
	COLOR_YELLOW  = "\x1b[33m"
	COLOR_BLUE    = "\x1b[34m"
	COLOR_MAGENTA = "\x1b[35m"
	COLOR_CYAN    = "\x1b[36m"
	COLOR_WHITE   = "\x1b[37m"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ConsoleHighlighter ¶

type ConsoleHighlighter struct {
}

func NewConsoleHighlighter ¶

func NewConsoleHighlighter() *ConsoleHighlighter

func (*ConsoleHighlighter) Name ¶

func (hl *ConsoleHighlighter) Name() string

func (*ConsoleHighlighter) WriteComment ¶

func (hl *ConsoleHighlighter) WriteComment(comment string) string

func (*ConsoleHighlighter) WriteFooter ¶

func (hl *ConsoleHighlighter) WriteFooter() string

func (*ConsoleHighlighter) WriteHeader ¶

func (hl *ConsoleHighlighter) WriteHeader() string

func (*ConsoleHighlighter) WriteKeyword ¶

func (hl *ConsoleHighlighter) WriteKeyword(keyword string) string

func (*ConsoleHighlighter) WriteLineHead ¶

func (hl *ConsoleHighlighter) WriteLineHead(lineNo int) string

func (*ConsoleHighlighter) WriteLineTail ¶

func (hl *ConsoleHighlighter) WriteLineTail() string

func (*ConsoleHighlighter) WriteNewLine ¶

func (hl *ConsoleHighlighter) WriteNewLine() string

func (*ConsoleHighlighter) WriteNormal ¶

func (hl *ConsoleHighlighter) WriteNormal(text string) string

func (*ConsoleHighlighter) WriteNumber ¶

func (hl *ConsoleHighlighter) WriteNumber(number string) string

func (*ConsoleHighlighter) WriteOperator ¶

func (hl *ConsoleHighlighter) WriteOperator(operator string) string

func (*ConsoleHighlighter) WriteQuotes ¶

func (hl *ConsoleHighlighter) WriteQuotes(quotes string) string

func (*ConsoleHighlighter) Writer ¶

func (hl *ConsoleHighlighter) Writer() io.Writer

type HighlightIntf ¶

type HighlightIntf interface {
	Name() string      //The Name of the generator
	Writer() io.Writer //The io.Writer you want the output to write to

	WriteHeader() string
	WriteFooter() string

	WriteLineHead(linNo int) string
	WriteLineTail() string
	WriteNewLine() string

	WriteQuotes(quotes string) string     //quote(single, double, raw)
	WriteComment(comment string) string   //comment
	WriteKeyword(keyword string) string   //keyword
	WriteOperator(operator string) string //operator
	WriteNumber(number string) string     //number
	WriteNormal(text string) string       //normal text
}

HighlightIntf is the interface of different Highlighter generators

type Highlighter ¶

type Highlighter struct {
	// contains filtered or unexported fields
}

func New ¶

func New(input string) *Highlighter

func (*Highlighter) Highlight ¶

func (h *Highlighter) Highlight()

Highlight the source code

func (*Highlighter) RegisterGenerator ¶

func (h *Highlighter) RegisterGenerator(intf HighlightIntf)

RegisterGenerator register a highlighter

type HtmlHighlighter ¶

type HtmlHighlighter struct {
	Out io.Writer
}

func NewHtmlHighlighter ¶

func NewHtmlHighlighter(writer io.Writer) *HtmlHighlighter

func (*HtmlHighlighter) Name ¶

func (hl *HtmlHighlighter) Name() string

func (*HtmlHighlighter) WriteComment ¶

func (hl *HtmlHighlighter) WriteComment(comment string) string

func (*HtmlHighlighter) WriteFooter ¶

func (hl *HtmlHighlighter) WriteFooter() string

func (*HtmlHighlighter) WriteHeader ¶

func (hl *HtmlHighlighter) WriteHeader() string

func (*HtmlHighlighter) WriteKeyword ¶

func (hl *HtmlHighlighter) WriteKeyword(keyword string) string

func (*HtmlHighlighter) WriteLineHead ¶

func (hl *HtmlHighlighter) WriteLineHead(lineNo int) string

func (*HtmlHighlighter) WriteLineTail ¶

func (hl *HtmlHighlighter) WriteLineTail() string

func (*HtmlHighlighter) WriteNewLine ¶

func (hl *HtmlHighlighter) WriteNewLine() string

func (*HtmlHighlighter) WriteNormal ¶

func (hl *HtmlHighlighter) WriteNormal(text string) string

func (*HtmlHighlighter) WriteNumber ¶

func (hl *HtmlHighlighter) WriteNumber(number string) string

func (*HtmlHighlighter) WriteOperator ¶

func (hl *HtmlHighlighter) WriteOperator(operator string) string

func (*HtmlHighlighter) WriteQuotes ¶

func (hl *HtmlHighlighter) WriteQuotes(quotes string) string

func (*HtmlHighlighter) Writer ¶

func (hl *HtmlHighlighter) Writer() io.Writer

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL