golightan

README

golightan - syntax highlighter -
================================================

Golightan is an syntx highlighter using `ANTLR <http://www.antlr.org/>`_

Formatter is same as `pygments <http://pygments.org/>`_.

.. image:: https://raw.githubusercontent.com/shirou/highlighter/master/terminal_highlight.png
   :alt: teminal highlighter for sqlite3
   :width: 100%
   :align: center


Available Lexers
-----------------

- sqlite3
- json
- golang (broken)
- python3 (broken)
- c
- XML
- GraphQL

lexer is placed at other package. See https://github.com/shirou/antlr-grammars-v4-go


Available Formatters
--------------------


- terminal
  - same as `terminal256`
- raw
- html
  - style is not implemented yet


command line
--------------

::

  go build cmd/golightan -o golightan


::

  Usage of golightan:
    -F string
          filters
    -f string
          formatter (default "html")
    -l string
          lexer
    -o string
          output (default "-")
    -s string
          html style (default "default")

LICENSE
============

BSD 3-clause license (same as ANTLR)

Documentation

Index

• Variables
• type NullErrorStrategy
  • func NewNullErrorStrategy() *NullErrorStrategy
  • func (e NullErrorStrategy) RecoverInline(parser antlr.Parser) antlr.Token
• type Token
  • func (t Token) String() string
• type TokenType
• type Tokens

Variables

var CSSMap = map[TokenType]string{
	TokenTypeText:                 "",
	TokenTypeWhitespace:           "w",
	TokenTypeError:                "err",
	TokenTypeOther:                "x",
	TokenTypeKeyword:              "k",
	TokenTypeKeywordConstant:      "kc",
	TokenTypeKeywordDeclaration:   "kd",
	TokenTypeKeywordNamespace:     "kn",
	TokenTypeKeywordPseudo:        "kp",
	TokenTypeKeywordReserved:      "kr",
	TokenTypeKeywordType:          "kt",
	TokenTypeName:                 "n",
	TokenTypeNameAttribute:        "na",
	TokenTypeNameBuiltin:          "nb",
	TokenTypeNameBuiltinPseudo:    "bp",
	TokenTypeNameClass:            "nc",
	TokenTypeNameConstant:         "no",
	TokenTypeNameDecorator:        "nd",
	TokenTypeNameEntity:           "ni",
	TokenTypeNameException:        "ne",
	TokenTypeNameFunction:         "nf",
	TokenTypeNameProperty:         "py",
	TokenTypeNameLabel:            "nl",
	TokenTypeNameNamespace:        "nn",
	TokenTypeNameOther:            "nx",
	TokenTypeNameTag:              "nt",
	TokenTypeNameVariable:         "nv",
	TokenTypeNameVariableClass:    "vc",
	TokenTypeNameVariableGlobal:   "vg",
	TokenTypeNameVariableInstance: "vi",
	TokenTypeLiteral:              "l",
	TokenTypeLiteralDate:          "ld",
	TokenTypeString:               "s",
	TokenTypeStringBacktick:       "sb",
	TokenTypeStringChar:           "sc",
	TokenTypeStringDoc:            "sd",
	TokenTypeStringDouble:         "s2",
	TokenTypeStringEscape:         "se",
	TokenTypeStringHeredoc:        "sh",
	TokenTypeStringInterpol:       "si",
	TokenTypeStringOther:          "sx",
	TokenTypeStringRegex:          "sr",
	TokenTypeStringSingle:         "s1",
	TokenTypeStringSymbol:         "ss",
	TokenTypeNumber:               "m",
	TokenTypeNumberFloat:          "mf",
	TokenTypeNumberHex:            "mh",
	TokenTypeNumberInteger:        "mi",
	TokenTypeNumberIntegerLong:    "il",
	TokenTypeNumberOct:            "mo",
	TokenTypeOperator:             "o",
	TokenTypeOperatorWord:         "ow",
	TokenTypePunctuation:          "p",
	TokenTypeComment:              "c",
	TokenTypeCommentMultiline:     "cm",
	TokenTypeCommentPreproc:       "cp",
	TokenTypeCommentSingle:        "c1",
	TokenTypeCommentSpecial:       "cs",
	TokenTypeGeneric:              "g",
	TokenTypeGenericDeleted:       "gd",
	TokenTypeGenericEmph:          "ge",
	TokenTypeGenericError:         "gr",
	TokenTypeGenericHeading:       "gh",
	TokenTypeGenericInserted:      "gi",
	TokenTypeGenericOutput:        "go",
	TokenTypeGenericPrompt:        "gp",
	TokenTypeGenericStrong:        "gs",
	TokenTypeGenericSubheading:    "gu",
	TokenTypeGenericTraceback:     "gt",
}

Types

type NullErrorStrategy

type NullErrorStrategy struct {
	*antlr.DefaultErrorStrategy
	// contains filtered or unexported fields
}

func NewNullErrorStrategy

func NewNullErrorStrategy() *NullErrorStrategy

func (NullErrorStrategy) RecoverInline

func (e NullErrorStrategy) RecoverInline(parser antlr.Parser) antlr.Token

type Token

type Token struct {
	OriginalToken antlr.Token
	TokenType     TokenType
	Text          string
}

func (Token) String

func (t Token) String() string

type TokenType

type TokenType int

const (
	TokenTypeText TokenType = iota
	TokenTypeWhitespace
	TokenTypeError
	TokenTypeOther
	TokenTypeKeyword
	TokenTypeKeywordConstant
	TokenTypeKeywordDeclaration
	TokenTypeKeywordNamespace
	TokenTypeKeywordPseudo
	TokenTypeKeywordReserved
	TokenTypeKeywordType
	TokenTypeName
	TokenTypeNameAttribute
	TokenTypeNameBuiltin
	TokenTypeNameBuiltinPseudo
	TokenTypeNameClass
	TokenTypeNameConstant
	TokenTypeNameDecorator
	TokenTypeNameEntity
	TokenTypeNameException
	TokenTypeNameFunction
	TokenTypeNameProperty
	TokenTypeNameLabel
	TokenTypeNameNamespace
	TokenTypeNameOther
	TokenTypeNameTag
	TokenTypeNameVariable
	TokenTypeNameVariableClass
	TokenTypeNameVariableGlobal
	TokenTypeNameVariableInstance
	TokenTypeLiteral
	TokenTypeLiteralDate
	TokenTypeString
	TokenTypeStringBacktick
	TokenTypeStringChar
	TokenTypeStringDoc
	TokenTypeStringDouble
	TokenTypeStringEscape
	TokenTypeStringHeredoc
	TokenTypeStringInterpol
	TokenTypeStringOther
	TokenTypeStringRegex
	TokenTypeStringSingle
	TokenTypeStringSymbol
	TokenTypeNumber
	TokenTypeNumberFloat
	TokenTypeNumberHex
	TokenTypeNumberInteger
	TokenTypeNumberIntegerLong
	TokenTypeNumberOct
	TokenTypeOperator
	TokenTypeOperatorWord
	TokenTypePunctuation
	TokenTypeComment
	TokenTypeCommentMultiline
	TokenTypeCommentPreproc
	TokenTypeCommentSingle
	TokenTypeCommentSpecial
	TokenTypeGeneric
	TokenTypeGenericDeleted
	TokenTypeGenericEmph
	TokenTypeGenericError
	TokenTypeGenericHeading
	TokenTypeGenericInserted
	TokenTypeGenericOutput
	TokenTypeGenericPrompt
	TokenTypeGenericStrong
	TokenTypeGenericSubheading
	TokenTypeGenericTraceback
)

type Tokens

type Tokens []Token