typescriptdomain Namespace Reference

Data Structures
class	TypeScriptDefinition
class	TypeScriptDomain
class	BetterTypeScriptLexer
class	LinkFilter
class	LinkingHtmlFormatter
class	MyPygmentsBridge
class	MyHtmlBuilder

Functions
def	get_annotation (tok, key)
def	copy_token (tok)
def	tok_setprop (tok, key, value)
def	tok_getprop (tok, key)
def	setup (app)

Variables
	logger = logging.getLogger(__name__)
dictionary	token_props = {}
dictionary	_escape_html_table
	link_reg = re.compile(r"(?<!`)`([^`<]+)\s*(?:<([^>]+)>)?\s*`_?")
	literal_reg = re.compile(r"``([^`]+)``")

Detailed Description

TypeScript domain.

:copyright: Copyright 2019 by Taler Systems SA
:license: LGPLv3+
:author: Florian Dold

Function Documentation

get_annotation()

def typescriptdomain.get_annotation	(		tok,
			key
	)

Definition at line 542 of file typescriptdomain.py.

def get_annotation(tok, key):
    if not hasattr(tok, "kv"):
        return None
    return tok.kv.get(key)
 
 

Referenced by typescriptdomain.LinkingHtmlFormatter._format_lines().

Here is the caller graph for this function:

copy_token()

def typescriptdomain.copy_token

(

tok

)

Definition at line 548 of file typescriptdomain.py.

def copy_token(tok):
    new_tok = _TokenType(tok)
    # This part is very fragile against API changes ...
    new_tok.subtypes = set(tok.subtypes)
    new_tok.parent = tok.parent
    return new_tok
 
 

Referenced by typescriptdomain.LinkFilter._filter_one_literal(), and typescriptdomain.LinkFilter.filter().

Here is the caller graph for this function:

tok_setprop()

def typescriptdomain.tok_setprop	(		tok,
			key,
			value
	)

Definition at line 556 of file typescriptdomain.py.

def tok_setprop(tok, key, value):
    tokid = id(tok)
    e = token_props.get(tokid)
    if e is None:
        e = token_props[tokid] = (tok, {})
    _, kv = e
    kv[key] = value
 
 

References id.

Referenced by typescriptdomain.LinkFilter._filter_one_literal(), and typescriptdomain.LinkFilter.filter().

Here is the caller graph for this function:

tok_getprop()

def typescriptdomain.tok_getprop	(		tok,
			key
	)

Definition at line 565 of file typescriptdomain.py.

def tok_getprop(tok, key):
    tokid = id(tok)
    e = token_props.get(tokid)
    if e is None:
        return None
    _, kv = e
    return kv.get(key)
 
 

References id.

Referenced by typescriptdomain.LinkingHtmlFormatter._get_value().

Here is the caller graph for this function:

setup()

def typescriptdomain.setup

(

app

)

Definition at line 578 of file typescriptdomain.py.

def setup(app):
 
    class TsrefLexer(BetterTypeScriptLexer):
        def __init__(self, **options):
            super().__init__(**options)
            self.add_filter(LinkFilter(app))
 
    app.add_lexer("tsref", TsrefLexer)
    app.add_domain(TypeScriptDomain)
    app.add_builder(MyHtmlBuilder)

Variable Documentation

logger

typescriptdomain.logger = logging.getLogger(__name__)

Definition at line 38 of file typescriptdomain.py.

token_props

dictionary typescriptdomain.token_props = {}

Definition at line 304 of file typescriptdomain.py.

_escape_html_table

dictionary typescriptdomain._escape_html_table

private

Initial value:

=  {
    ord("&"): u"&",
    ord("<"): u"&lt;",
    ord(">"): u"&gt;",
    ord('"'): u"&quot;",
    ord("'"): u"&#39;",
}

Definition at line 361 of file typescriptdomain.py.

link_reg

typescriptdomain.link_reg = re.compile(r"(?<!`)`([^`<]+)\s*(?:<([^>]+)>)?\s*`_?")

Definition at line 574 of file typescriptdomain.py.

literal_reg

typescriptdomain.literal_reg = re.compile(r"``([^`]+)``")

Definition at line 575 of file typescriptdomain.py.