Question

我想在Sphinx代码片段文档中使用Pygments强调类似Lisp的语言。我的方法是扩展现有的CommonLispLexer以使用NameHighlightFilter添加内置名称。但是，它不起作用，所以我必须遗漏一些明显的东西。我在conf.py中添加了以下内容：

def setup(app): 
    from sphinx.highlighting import lexers
    from pygments.lexers import CommonLispLexer
    from pygments.token import Name
    from pygments.filters import NameHighlightFilter
    tl_lexer = CommonLispLexer()
    tl_lexer.add_filter(NameHighlightFilter(
            names=['define-function', 'define-macro', 
                   'define-variable', 'define-constant'],
            tokentype=Name.Builtin,
            ))
    app.add_lexer('tl', tl_lexer)

highlight_language = 'tl'

但NameHighlightFilter无效。代码块突出显示就好像它们是Lisp一样，但是我的新内置名称没有特别突出显示。

Answer 1

原因是NameHighlighFilter仅转换词法分类为Token.Name的标记，但CommonLispLexer几乎将所有内容归类为Name.Variable。这是来自Pygments源代码的NameHighlightFilter的过滤函数：

def filter(self, lexer, stream):
    for ttype, value in stream:
        if ttype is Name and value in self.names:
            yield self.tokentype, value
        else:
            yield ttype, value

我唯一的解决方法是编写自己的过滤器。这个功能给了我想要的样子。

def filter(self, lexer, stream):
    define = False
    for ttype, value in stream:
        if value in self.tl_toplevel_forms:
            ttype = Name.Builtin
            define = True
        elif define and ttype == Name.Variable:
            define = False
            ttype = Name.Function
        elif value in self.tl_special_forms:
            ttype = Name.Variable
        # the Common Lisp lexer highlights everything else as
        # variables, which isn't the look I want.  Instead
        # highlight all non-special things as text.
        elif ttype == Name.Variable:
            ttype = Name.Text
        yield ttype, value

作为对Pygments开发人员的一个注释，也许NameHighlightFilter可以使用一个可选参数来表示要转换的令牌类型（目前它只接受输出令牌类型）。

Sphinx Pygments lexer过滤扩展？

1 个答案: