typescriptdomain.LinkingHtmlFormatter Class Reference

Inheritance diagram for typescriptdomain.LinkingHtmlFormatter:

Collaboration diagram for typescriptdomain.LinkingHtmlFormatter:

Public Member Functions
def	__init__ (self, **kwargs)
def	__init__ (self, **kwargs)

Private Member Functions
def	_get_value (self, value, tok)
def	_fmt (self, value, tok)
def	_format_lines (self, tokensource)
def	_get_value (self, value, tok)
def	_fmt (self, value, tok)
def	_format_lines (self, tokensource)

Private Attributes
	_builder
	_bridge

Detailed Description

Definition at line 370 of file typescriptdomain.py.

Constructor & Destructor Documentation

__init__() [1/2]

def typescriptdomain.LinkingHtmlFormatter.__init__	(		self,
		**	kwargs
	)

Definition at line 371 of file typescriptdomain.py.

    def __init__(self, **kwargs):
        super(LinkingHtmlFormatter, self).__init__(**kwargs)
        self._builder = kwargs["_builder"]
        self._bridge = kwargs["_bridge"]
 

References typescriptdomain.LinkingHtmlFormatter.__init__().

Referenced by typescriptdomain.LinkingHtmlFormatter.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

__init__() [2/2]

def typescriptdomain.LinkingHtmlFormatter.__init__	(		self,
		**	kwargs
	)

Definition at line 371 of file typescriptdomain.py.

    def __init__(self, **kwargs):
        super(LinkingHtmlFormatter, self).__init__(**kwargs)
        self._builder = kwargs["_builder"]
        self._bridge = kwargs["_bridge"]
 

References typescriptdomain.LinkingHtmlFormatter.__init__(), typescriptdomain.LinkingHtmlFormatter._bridge, and typescriptdomain.LinkingHtmlFormatter._builder.

Here is the call graph for this function:

Member Function Documentation

_get_value() [1/2]

def typescriptdomain.LinkingHtmlFormatter._get_value (   self,   value,   tok  )

private

Definition at line 376 of file typescriptdomain.py.

    def _get_value(self, value, tok):
        xref = tok_getprop(tok, "xref")
        caption = tok_getprop(tok, "caption")
 
        if tok_getprop(tok, "is_literal"):
            return '<span style="font-weight: bolder">%s</span>' % (value,)
 
        if tok_getprop(tok, "trailing_underscore"):
            logger.warn(
                "{}:{}: code block contains xref to '{}' with unsupported trailing underscore".format(
                    self._bridge.path, self._bridge.line, xref
                )
            )
 
        if tok_getprop(tok, "is_identifier"):
            if xref.startswith('"'):
                return value
            if re.match("^[0-9]+$", xref) is not None:
                return value
            if xref in (
                "number",
                "object",
                "string",
                "boolean",
                "any",
                "true",
                "false",
                "null",
                "undefined",
                "Array",
                "unknown",
            ):
                return value
 
        if self._bridge.docname is None:
            return value
        if xref is None:
            return value
        content = caption if caption is not None else value
        ts = self._builder.env.get_domain("ts")
        r1 = ts.objects.get(("type", xref), None)
        if r1 is not None:
            rel_uri = (
                self._builder.get_relative_uri(self._bridge.docname, r1[0])
                + "#"
                + r1[1]
            )
            return (
                '<a style="color:inherit;text-decoration:underline" href="%s">%s</a>'
                % (rel_uri, content)
            )
 
        std = self._builder.env.get_domain("std")
        r2 = std.labels.get(xref.lower(), None)
        if r2 is not None:
            rel_uri = (
                self._builder.get_relative_uri(self._bridge.docname, r2[0])
                + "#"
                + r2[1]
            )
            return (
                '<a style="color:inherit;text-decoration:underline" href="%s">%s</a>'
                % (rel_uri, content)
            )
        r3 = std.anonlabels.get(xref.lower(), None)
        if r3 is not None:
            rel_uri = (
                self._builder.get_relative_uri(self._bridge.docname, r3[0])
                + "#"
                + r3[1]
            )
            return (
                '<a style="color:inherit;text-decoration:underline" href="%s">%s</a>'
                % (rel_uri, content)
            )
 
        logger.warn(
            "{}:{}: code block contains unresolved xref '{}'".format(
                self._bridge.path, self._bridge.line, xref
            )
        )
 
        return value
 

References typescriptdomain.LinkingHtmlFormatter._bridge, typescriptdomain.LinkingHtmlFormatter._builder, and typescriptdomain.tok_getprop().

Referenced by typescriptdomain.LinkingHtmlFormatter._fmt().

Here is the call graph for this function:

Here is the caller graph for this function:

_fmt() [1/2]

def typescriptdomain.LinkingHtmlFormatter._fmt (   self,   value,   tok  )

private

Definition at line 460 of file typescriptdomain.py.

    def _fmt(self, value, tok):
        cls = self._get_css_class(tok)
        value = self._get_value(value, tok)
        if cls is None or cls == "":
            return value
        return '<span class="%s">%s</span>' % (cls, value)
 

References typescriptdomain.LinkingHtmlFormatter._get_value().

Referenced by typescriptdomain.LinkingHtmlFormatter._format_lines().

Here is the call graph for this function:

Here is the caller graph for this function:

_format_lines() [1/2]

def typescriptdomain.LinkingHtmlFormatter._format_lines (   self,   tokensource  )

private

Just format the tokens, without any wrapping tags.
Yield individual lines.

Definition at line 467 of file typescriptdomain.py.

    def _format_lines(self, tokensource):
        """
        Just format the tokens, without any wrapping tags.
        Yield individual lines.
        """
        lsep = self.lineseparator
        escape_table = _escape_html_table
 
        line = ""
        for ttype, value in tokensource:
            link = get_annotation(ttype, "link")
 
            parts = value.translate(escape_table).split("\n")
 
            if len(parts) == 0:
                # empty token, usually should not happen
                pass
            elif len(parts) == 1:
                # no newline before or after token
                line += self._fmt(parts[0], ttype)
            else:
                line += self._fmt(parts[0], ttype)
                yield 1, line + lsep
                for part in parts[1:-1]:
                    yield 1, self._fmt(part, ttype) + lsep
                line = self._fmt(parts[-1], ttype)
 
        if line:
            yield 1, line + lsep
 
 

References typescriptdomain.LinkingHtmlFormatter._fmt(), and typescriptdomain.get_annotation().

Here is the call graph for this function:

_get_value() [2/2]

def typescriptdomain.LinkingHtmlFormatter._get_value (   self,   value,   tok  )

private

Definition at line 376 of file typescriptdomain.py.

    def _get_value(self, value, tok):
        xref = tok_getprop(tok, "xref")
        caption = tok_getprop(tok, "caption")
 
        if tok_getprop(tok, "is_literal"):
            return '<span style="font-weight: bolder">%s</span>' % (value,)
 
        if tok_getprop(tok, "trailing_underscore"):
            logger.warn(
                "{}:{}: code block contains xref to '{}' with unsupported trailing underscore".format(
                    self._bridge.path, self._bridge.line, xref
                )
            )
 
        if tok_getprop(tok, "is_identifier"):
            if xref.startswith('"'):
                return value
            if re.match("^[0-9]+$", xref) is not None:
                return value
            if xref in (
                "number",
                "object",
                "string",
                "boolean",
                "any",
                "true",
                "false",
                "null",
                "undefined",
                "Array",
                "unknown",
            ):
                return value
 
        if self._bridge.docname is None:
            return value
        if xref is None:
            return value
        content = caption if caption is not None else value
        ts = self._builder.env.get_domain("ts")
        r1 = ts.objects.get(("type", xref), None)
        if r1 is not None:
            rel_uri = (
                self._builder.get_relative_uri(self._bridge.docname, r1[0])
                + "#"
                + r1[1]
            )
            return (
                '<a style="color:inherit;text-decoration:underline" href="%s">%s</a>'
                % (rel_uri, content)
            )
 
        std = self._builder.env.get_domain("std")
        r2 = std.labels.get(xref.lower(), None)
        if r2 is not None:
            rel_uri = (
                self._builder.get_relative_uri(self._bridge.docname, r2[0])
                + "#"
                + r2[1]
            )
            return (
                '<a style="color:inherit;text-decoration:underline" href="%s">%s</a>'
                % (rel_uri, content)
            )
        r3 = std.anonlabels.get(xref.lower(), None)
        if r3 is not None:
            rel_uri = (
                self._builder.get_relative_uri(self._bridge.docname, r3[0])
                + "#"
                + r3[1]
            )
            return (
                '<a style="color:inherit;text-decoration:underline" href="%s">%s</a>'
                % (rel_uri, content)
            )
 
        logger.warn(
            "{}:{}: code block contains unresolved xref '{}'".format(
                self._bridge.path, self._bridge.line, xref
            )
        )
 
        return value
 

References typescriptdomain.LinkingHtmlFormatter._bridge, typescriptdomain.LinkingHtmlFormatter._builder, and typescriptdomain.tok_getprop().

Referenced by typescriptdomain.LinkingHtmlFormatter._fmt().

Here is the call graph for this function:

Here is the caller graph for this function:

_fmt() [2/2]

def typescriptdomain.LinkingHtmlFormatter._fmt (   self,   value,   tok  )

private

Definition at line 460 of file typescriptdomain.py.

    def _fmt(self, value, tok):
        cls = self._get_css_class(tok)
        value = self._get_value(value, tok)
        if cls is None or cls == "":
            return value
        return '<span class="%s">%s</span>' % (cls, value)
 

References typescriptdomain.LinkingHtmlFormatter._get_value().

Referenced by typescriptdomain.LinkingHtmlFormatter._format_lines().

Here is the call graph for this function:

Here is the caller graph for this function:

_format_lines() [2/2]

def typescriptdomain.LinkingHtmlFormatter._format_lines (   self,   tokensource  )

private

Just format the tokens, without any wrapping tags.
Yield individual lines.

Definition at line 467 of file typescriptdomain.py.

    def _format_lines(self, tokensource):
        """
        Just format the tokens, without any wrapping tags.
        Yield individual lines.
        """
        lsep = self.lineseparator
        escape_table = _escape_html_table
 
        line = ""
        for ttype, value in tokensource:
            link = get_annotation(ttype, "link")
 
            parts = value.translate(escape_table).split("\n")
 
            if len(parts) == 0:
                # empty token, usually should not happen
                pass
            elif len(parts) == 1:
                # no newline before or after token
                line += self._fmt(parts[0], ttype)
            else:
                line += self._fmt(parts[0], ttype)
                yield 1, line + lsep
                for part in parts[1:-1]:
                    yield 1, self._fmt(part, ttype) + lsep
                line = self._fmt(parts[-1], ttype)
 
        if line:
            yield 1, line + lsep
 
 

References typescriptdomain.LinkingHtmlFormatter._fmt(), and typescriptdomain.get_annotation().

Here is the call graph for this function:

Field Documentation

_builder

typescriptdomain.LinkingHtmlFormatter._builder

private

Definition at line 373 of file typescriptdomain.py.

Referenced by typescriptdomain.LinkingHtmlFormatter.__init__(), and typescriptdomain.LinkingHtmlFormatter._get_value().

_bridge

typescriptdomain.LinkingHtmlFormatter._bridge

private

Definition at line 374 of file typescriptdomain.py.

Referenced by typescriptdomain.LinkingHtmlFormatter.__init__(), and typescriptdomain.LinkingHtmlFormatter._get_value().

---

The documentation for this class was generated from the following files:

• contrib/gana/_exts/typescriptdomain.py
• contrib/handbook/_exts/typescriptdomain.py