Add World of Warcraft TOC file lexer

pygments/lexers/_mapping.py

@@ -522,6 +522,7 @@
     'WatLexer': ('pygments.lexers.webassembly', 'WebAssembly', ('wast', 'wat'), ('*.wat', '*.wast'), ()),
     'WebIDLLexer': ('pygments.lexers.webidl', 'Web IDL', ('webidl',), ('*.webidl',), ()),
     'WhileyLexer': ('pygments.lexers.whiley', 'Whiley', ('whiley',), ('*.whiley',), ('text/x-whiley',)),
+    'WoWTocLexer': ('pygments.lexers.wowtoc', 'World of Warcraft TOC', ('wowtoc',), ('*.toc',), ()),
     'X10Lexer': ('pygments.lexers.x10', 'X10', ('x10', 'xten'), ('*.x10',), ('text/x-x10',)),
     'XMLUL4Lexer': ('pygments.lexers.ul4', 'XML+UL4', ('xml+ul4',), ('*.xmlul4',), ()),
     'XQueryLexer': ('pygments.lexers.webmisc', 'XQuery', ('xquery', 'xqy', 'xq', 'xql', 'xqm'), ('*.xqy', '*.xquery', '*.xq', '*.xql', '*.xqm'), ('text/xquery', 'application/xquery')),

pygments/lexers/wowtoc.py

@@ -0,0 +1,82 @@
+"""
+    pygments.lexers.wowtoc
+    ~~~~~~~~~~~~~~~~~~~~~~
+
+    Lexer for World of Warcraft TOC files, which describe game addon metadata.
+
+    :copyright: Copyright 2006-2022 by the Pygments team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+"""
+
+from pygments.lexer import RegexLexer, bygroups
+from pygments.token import Comment, Name, Text, Punctuation, String, Keyword
+
+__all__ = ["WoWTocLexer"]
+
+def _create_tag_line_token(inner_pattern, inner_token, ignore_case=False):
+    # this function template-izes the tag line for a specific type of tag, which will
+    # have a different pattern and different token. otherwise, everything about a tag
+    # line is the same
+    return (
+        (r"(?i)" if ignore_case else r"")
+        + r"^(##)( *)"
+        + inner_pattern
+        + r"( *)(:)( *)([^\n]*?)( *)$",
+        bygroups(
+            Keyword.Declaration,
+            Text.Whitespace,
+            inner_token,
+            Text.Whitespace,
+            Punctuation,
+            Text.Whitespace,
+            String,
+            Text.Whitespace,
+        ),
+    )
+
+
+class WoWTocLexer(RegexLexer):
+    """
+    Lexer for World of Warcraft TOC files.
+
+    .. versionadded:: 2.13
+    """
+
+    name = "World of Warcraft TOC"
+    aliases = ["wowtoc"]
+    filenames = ["*.toc"]
+
+    tokens = {
+        "root": [
+            # official localized tags, Notes and Title
+            # (normal part is insensitive, locale part is sensitive)
+            _create_tag_line_token(
+                r"((?:[nN][oO][tT][eE][sS]|[tT][iI][tT][lL][eE])-(?:ptBR|zhCN|enCN|frFR|deDE|itIT|esMX|ptPT|koKR|ruRU|esES|zhTW|enTW|enGB|enUS))",
+                Name.Builtin,
+            ),
+            # other official tags
+            _create_tag_line_token(
+                r"(Interface|Title|Notes|RequiredDeps|Dep[^: ]*|OptionalDeps|LoadOnDemand|LoadWith|LoadManagers|SavedVariablesPerCharacter|SavedVariables|DefaultState|Secure|Author|Version)",
+                Name.Builtin,
+                ignore_case=True
+            ),
+            # user-defined tags
+            _create_tag_line_token(
+                r"(x-[^: ]*)",
+                Name.Variable,
+                ignore_case=True
+            ),
+            # non-conforming tags, but still valid
+            _create_tag_line_token(
+                r"([^: ]*)",
+                Name.Other,
+                ignore_case=True
+            ),
+
+            # Comments
+            (r"^#[^\n]*$", Comment),
+
+            # Addon Files
+            (r"^[^\n]+$", Name),
+        ]
+    }

tests/examplefiles/wowtoc/comments.toc

@@ -0,0 +1,6 @@
+#
+#a
+# a comment
+# a comment with a # in it
+## no comma, thus a comment
+## has space: and is thus, a comment

tests/examplefiles/wowtoc/files.toc

@@ -0,0 +1,3 @@
+a
+Foo.lua
+Spaces allowed.lua

tests/examplefiles/wowtoc/official_tags.toc

@@ -0,0 +1,63 @@
+## TiTlE-ptBR: value
+## TiTlE-zhCN: value
+## TiTlE-enCN: value
+## TiTlE-frFR: value
+## TiTlE-deDE: value
+## TiTlE-itIT: value
+## TiTlE-esMX: value
+## TiTlE-ptPT: value
+## TiTlE-koKR: value
+## TiTlE-ruRU: value
+## TiTlE-esES: value
+## TiTlE-zhTW: value
+## TiTlE-enTW: value
+## TiTlE-enGB: value
+## TiTlE-enUS: value
+## NoTeS-ptBR: value
+## NoTeS-zhCN: value
+## NoTeS-enCN: value
+## NoTeS-frFR: value
+## NoTeS-deDE: value
+## NoTeS-itIT: value
+## NoTeS-esMX: value
+## NoTeS-ptPT: value
+## NoTeS-koKR: value
+## NoTeS-ruRU: value
+## NoTeS-esES: value
+## NoTeS-zhTW: value
+## NoTeS-enTW: value
+## NoTeS-enGB: value
+## NoTeS-enUS: value
+## Interface: value
+## interface: value
+## Title: value
+## title: value
+## Notes: value
+## notes: value
+## RequiredDeps: value
+## requireddeps: value
+## Dependencies: value
+## dependencies: value
+## OptionalDeps: value
+## optionaldeps: value
+## LoadOnDemand: value
+## loadondemand: value
+## LoadWith: value
+## loadwith: value
+## LoadManagers: value
+## loadmanagers: value
+## SavedVariablesPerCharacter: value
+## savedvariablespercharacter: value
+## SavedVariables: value
+## savedvariables: value
+## DefaultState: value
+## defaultstate: value
+## Secure: value
+## secure: value
+## Author: value
+## author: value
+## Version: value
+## version: value
+## Dep: value
+## dep: value
+## DepSomething: value