Class Cmd2Lexer

cmd2/pt_utils.py:193–307

Lexer that highlights cmd2 command names, aliases, and macros.

class Cmd2Lexer(Lexer):
    """Lexer that highlights cmd2 command names, aliases, and macros."""

    def __init__(
        self,
        cmd_app: "Cmd",
        command_color: str = "ansigreen",
        alias_color: str = "ansicyan",
        macro_color: str = "ansimagenta",
        flag_color: str = "ansired",
        argument_color: str = "ansiyellow",
    ) -> None:
        """Initialize the Lexer.

        :param cmd_app: cmd2.Cmd instance
        :param command_color: color to use for commands, defaults to 'ansigreen'
        :param alias_color: color to use for aliases, defaults to 'ansicyan'
        :param macro_color: color to use for macros, defaults to 'ansimagenta'
        :param flag_color: color to use for flags, defaults to 'ansired'
        :param argument_color: color to use for arguments, defaults to 'ansiyellow'
        """
        super().__init__()
        self.cmd_app = cmd_app
        self.command_color = command_color
        self.alias_color = alias_color
        self.macro_color = macro_color
        self.flag_color = flag_color
        self.argument_color = argument_color

    def lex_document(self, document: Document) -> Callable[[int], Any]:
        """Lex the document."""
        # Get redirection tokens and terminators to avoid highlighting them as values
        exclude_tokens = set(constants.REDIRECTION_TOKENS)
        exclude_tokens.update(self.cmd_app.statement_parser.terminators)
        arg_pattern = re.compile(r'(\s+)|(--?[^\s\'"]+)|("[^"]*"?|\'[^\']*\'?)|([^\s\'"]+)')

        def highlight_args(text: str, tokens: list[tuple[str, str]]) -> None:
            """Highlight arguments in a string."""
            for m in arg_pattern.finditer(text):
                space, flag, quoted, word = m.groups()
                match_text = m.group(0)

                if space:
                    tokens.append(("", match_text))
                elif flag:
                    tokens.append((self.flag_color, match_text))
                elif (quoted or word) and match_text not in exclude_tokens:
                    tokens.append((self.argument_color, match_text))
                else:
                    tokens.append(("", match_text))

        def get_line(lineno: int) -> list[tuple[str, str]]:
            """Return the tokens for the given line number."""
            line = document.lines[lineno]
            tokens: list[tuple[str, str]] = []

            # No syntax highlighting if styles are disallowed
            if ru.ALLOW_STYLE == ru.AllowStyle.NEVER: