mkdocstrings-matlab 0.1.3__py2.py3-none-any.whl → 0.1.5__py2.py3-none-any.whl

mkdocstrings_handlers/matlab/collections.py

@@ -0,0 +1,17 @@
+from _griffe.collections import LinesCollection as _LinesCollection, ModulesCollection
+from _griffe.models import Object
+
+
+class LinesCollection(_LinesCollection):
+    pass
+
+
+class ModelsCollection(ModulesCollection):
+    def __init__(self):
+        self.members: dict[str, Object] = {}
+
+    def __setitem__(self, key: str, value: Object):
+        self.members[key] = value
+
+    def __getitem__(self, key: str):
+        return self.members[key]

mkdocstrings_handlers/matlab/handler.py

@@ -8,9 +8,11 @@ from griffe import Docstring, Parameters, Parameter, ParameterKind
 from pprint import pprint
 
 
+import charset_normalizer
 import json
 
 
+from mkdocstrings_handlers.matlab.collections import LinesCollection, ModelsCollection
 from mkdocstrings_handlers.matlab_engine import MatlabEngine, MatlabExecutionError
 from mkdocstrings_handlers.matlab.models import (
     Function,
@@ -18,23 +20,9 @@ from mkdocstrings_handlers.matlab.models import (
     Classfolder,
     Namespace,
     Property,
-    ROOT
+    ROOT,
 )
-
-
-class _ModelsStorage:
-    def __init__(self):
-        self._namespace = ""
-        self._models = {}
-
-    def __getitem__(self, key):
-        return self._models[key]
-
-    def __setitem__(self, key, value):
-        self._models[key] = value
-
-    def __contains__(self, key):
-        return key in self._models
+from mkdocstrings_handlers.matlab.parser import MatlabParser
 
 
 class MatlabHandler(BaseHandler):
@@ -72,8 +60,8 @@ class MatlabHandler(BaseHandler):
         # "find_stubs_package": False,
         # "allow_inspection": True,
         "show_bases": True,
-        "show_inheritance_diagram": False,  # not implemented
-        "show_source": False,  # not implemented
+        "show_inheritance_diagram": False,  # Insider feature
+        "show_source": True,
         # "preload_modules": None,
         # Heading options
         "heading_level": 2,
@@ -138,11 +126,16 @@ class MatlabHandler(BaseHandler):
 
         if paths is None:
             paths = ""
+        else:
+            config_path = Path(config_file_path).parent
+            full_paths = [str((config_path / path).resolve()) for path in paths]
 
         self.engine = MatlabEngine()
         self.engine.addpath(str(Path(__file__).parent / "matlab"))
-        self.engine.matlab_startup(paths, startup_expression)
-        self.models = _ModelsStorage()
+        self.engine.matlab_startup(full_paths, startup_expression)
+        self.models = ModelsCollection()
+        self.lines = LinesCollection()
+        self.parser = MatlabParser()
         self._locale = locale
 
     def get_templates_dir(self, handler: str | None = None) -> Path:
@@ -173,6 +166,11 @@ class MatlabHandler(BaseHandler):
             raise CollectionError(error.args[0].strip()) from error
         ast_dict = json.loads(ast_json)
 
+        filepath = Path(ast_dict["path"])
+        if filepath not in self.lines:
+            lines = str(charset_normalizer.from_path(filepath).best()).splitlines()
+            self.lines[filepath] = lines
+
         match ast_dict["type"]:
             case "function" | "method":
                 return self.collect_function(ast_dict, final_config)
@@ -255,16 +253,38 @@ class MatlabHandler(BaseHandler):
             if ast_dict["docstring"]
             else None
         )
+
+        filepath = Path(ast_dict["path"])
+
+        if config["show_source"]:
+            tmObject = self.parser.parse_file(filepath)
+            tmClass = next(
+                child
+                for child in tmObject.children
+                if child.token == "meta.class.matlab"
+            )
+        else:
+            tmClass = None
+
+        bases = ast_dict["superclasses"] if isinstance(ast_dict["superclasses"], list) else [ast_dict["superclasses"]]
+        bases = [base for base in bases if base != "handle"]
+
         model = Class(
             ast_dict["name"],
             docstring=docstring,
-            parent=self.get_parent(Path(ast_dict["path"]).parent),
+            parent=self.get_parent(filepath.parent),
             hidden=ast_dict["hidden"],
             sealed=ast_dict["sealed"],
             abstract=ast_dict["abstract"],
             enumeration=ast_dict["enumeration"],
             handle=ast_dict["handle"],
-            filepath=Path(ast_dict["path"]),
+            bases=bases,
+            filepath=filepath,
+            modules_collection=self.models,
+            lines_collection=self.lines,
+            lineno=1,
+            endlineno=len(self.lines[filepath]),
+            textmate=tmClass,
         )
 
         for property_dict in ast_dict["properties"]:
@@ -296,12 +316,14 @@ class MatlabHandler(BaseHandler):
                 continue
 
             method = self.collect(f"{defining_class}.{name}", config)
+            (method.lineno, method.endlineno) = model.get_lineno_method(name)
             method.parent = model
             method._access = method_dict["access"]
             method._static = method_dict["static"]
             method._abstract = method_dict["abstract"]
             method._sealed = method_dict["sealed"]
             method._hidden = method_dict["hidden"]
+
             model.members[name] = method
             self.models[method.canonical_path] = method
 
@@ -340,6 +362,7 @@ class MatlabHandler(BaseHandler):
                 )
             )
 
+        filepath = Path(ast_dict["path"])
         model = Function(
             ast_dict["name"],
             parameters=Parameters(*parameters),
@@ -350,8 +373,12 @@ class MatlabHandler(BaseHandler):
             )
             if ast_dict["docstring"]
             else None,
-            parent=self.get_parent(Path(ast_dict["path"]).parent),
-            filepath=Path(ast_dict["path"]),
+            parent=self.get_parent(filepath.parent),
+            filepath=filepath,
+            modules_collection=self.models,
+            lines_collection=self.lines,
+            lineno=1,
+            endlineno=len(self.lines[filepath]),
         )
 
         self.models[model.canonical_path] = model

mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/argument.m

@@ -11,7 +11,7 @@ function data = argument(object)
            data(iArg) = docstring.metadata.argument(object(iArg));
        end
        return
-    end
+    end 
 
     data.name = object.Name;
     data.kind = string(object.Kind);

mkdocstrings_handlers/matlab/matlab/+docstring/+utils/dedent.m

@@ -7,7 +7,6 @@ end
 
 lines = cellstr(splitlines(doc));
 
-
 for iLine = numel(lines):-1:1
     line = lines{iLine};
     if ~isempty(line) && ~all(line == ' ')

mkdocstrings_handlers/matlab/matlab/+docstring/resolve.m

@@ -18,6 +18,10 @@ arguments
     cwd (1,1) string {mustBeFolder} = pwd()
 end
 
+if isempty(identifier)
+    docstring.exception("<empty>");
+end
+
 cd(cwd);
 
 % Check if namespace

mkdocstrings_handlers/matlab/models.py

@@ -1,8 +1,8 @@
 from enum import Enum
 from typing import Any
 from griffe import Function as GriffeFunction, Class as GriffeClass, Module, Attribute
-from _griffe.exceptions import BuiltinModuleError
 from pathlib import Path
+from textmate_grammar.elements import ContentElement
 
 
 class Access(Enum):
@@ -43,6 +43,7 @@ class Class(CanonicalPathMixin, PathMixin, GriffeClass):
         abstract: bool = False,
         enumeration: bool = False,
         handle: bool = False,
+        textmate: ContentElement | None = None,
         **kwargs: Any,
     ) -> None:
         super().__init__(*args, **kwargs)
@@ -51,6 +52,31 @@ class Class(CanonicalPathMixin, PathMixin, GriffeClass):
         self._abstract: bool = abstract
         self._enumeration: bool = enumeration
         self._handle: bool = handle
+        self._textmate: ContentElement | None = textmate
+
+        self._method_lineno: dict[str, tuple[int, int]] = {}
+        if textmate is None:
+            return
+        for block in [
+            block
+            for block in self._textmate.children
+            if block.token == "meta.methods.matlab"
+        ]:
+            for method in block.children:
+                declaration = next(
+                    item
+                    for item in method.children
+                    if item.token == "meta.function.declaration.matlab"
+                )
+                name = next(
+                    item
+                    for item in declaration.children
+                    if item.token == "entity.name.function.matlab"
+                ).content
+                charaters_ids = method.characters.keys()
+                lineno = min(charaters_ids, key=lambda p: p[0])[0]
+                endlino = max(charaters_ids, key=lambda p: p[0])[0] + 1
+                self._method_lineno[name] = (lineno, endlino)
 
     @property
     def is_private(self) -> bool:
@@ -63,6 +89,9 @@ class Class(CanonicalPathMixin, PathMixin, GriffeClass):
         else:
             return super().canonical_path
 
+    def get_lineno_method(self, method_name: str) -> tuple[int, int]:
+        return self._method_lineno.get(method_name, (self.lineno, self.endlineno))
+
 
 class Property(CanonicalPathMixin, Attribute):
     def __init__(
@@ -137,7 +166,7 @@ class _Root(Namespace):
 
     def __repr__(self) -> str:
         return "MATLABROOT"
-    
+
 
 ROOT = _Root()
 
@@ -145,7 +174,3 @@ ROOT = _Root()
 class Classfolder(Class):
     def __repr__(self) -> str:
         return f"Classfolder({self.path!r})"
-
-
-
-

mkdocstrings_handlers/matlab/parser.py

@@ -0,0 +1,31 @@
+from textmate_grammar.parsers.base import LanguageParser
+from pathlib import Path
+
+
+import logging
+import yaml
+
+
+logging.getLogger("textmate_grammar").setLevel(logging.ERROR)
+
+
+class MatlabParser(LanguageParser):
+    """
+    Represents a grammar for the MATLAB language.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new instance of the MatlabGrammar class.
+
+        Args:
+            remove_line_continuations (bool, optional): Whether to remove line continuations. Defaults to False.
+        """
+
+        with open(Path(__file__).parent / "resources" / "grammar.yml") as file:
+            try:
+                grammar = yaml.load(file.read(), Loader=yaml.CLoader)
+            except ImportError:
+                grammar = yaml.load(file.read(), Loader=yaml.Loader)
+
+        super().__init__(grammar, **kwargs)

mkdocstrings_handlers/matlab/resources/grammar.yml

@@ -0,0 +1,566 @@
+fileTypes:
+- m
+keyEquivalent: ^~M
+name: MATLAB minimal
+patterns:
+- comment: 'Rules are split into groups so #command_dual can be excluded in things
+    like (), {}, []'
+  include: '#rules_before_command_dual'
+- include: '#command_dual'
+- include: '#rules_after_command_dual'
+repository:
+  blocks:
+    patterns:
+    - begin: \s*(?<=^|[\s,;])(for)\b
+      beginCaptures:
+        '1':
+          name: keyword.control.for.matlab
+      end: \s*(?<=^|[\s,;])(end)\b
+      endCaptures:
+        '1':
+          name: keyword.control.end.for.matlab
+      name: meta.for.matlab
+      patterns:
+      - begin: \G(?!$)
+        end: (?<!\.{3})(?:(?=([,;])(?![^(]*\)))|$)
+        name: meta.for.declaration.matlab
+        patterns:
+        - include: $self
+      - include: $self
+    - begin: \s*(?<=^|[\s,;])(if)\b
+      beginCaptures:
+        '1':
+          name: keyword.control.if.matlab
+      end: \s*(?<=^|[\s,;])(end)\b
+      endCaptures:
+        '1':
+          name: keyword.control.end.if.matlab
+        '2':
+          patterns:
+          - include: $self
+      name: meta.if.matlab
+      patterns:
+      - begin: \G(?!$)
+        end: (?<!\.{3})(?:(?=([,;])(?![^(]*\)))|$)
+        name: meta.if.declaration.matlab
+        patterns:
+        - include: $self
+      - captures:
+          '1':
+            name: keyword.control.elseif.matlab
+        match: (?:\s*)(?<=^|[\s,;])(elseif)\b
+        name: meta.elseif.matlab
+        patterns:
+        - begin: \G(?!$)
+          end: (?<!\.{3})(?:(?=([,;])(?![^(]*\)))|$)
+          name: meta.elseif.declaration.matlab
+          patterns:
+          - include: $self
+      - captures:
+          '1':
+            name: keyword.control.else.matlab
+        end: ^
+        match: (?:\s*)(?<=^|[\s,;])(else)\b
+        name: meta.else.matlab
+      - include: $self
+    - begin: \s*(?<=^|[\s,;])(parfor)\b
+      beginCaptures:
+        '1':
+          name: keyword.control.for.matlab
+      end: \s*(?<=^|[\s,;])(end)\b
+      endCaptures:
+        '1':
+          name: keyword.control.end.for.matlab
+      name: meta.for.parallel.matlab
+      patterns:
+      - begin: \G(?!$)
+        end: (?<!\.{3})(?:(?=([,;])(?![^(]*\)))|$)
+        name: meta.for.parallel.declaration.matlab
+        patterns:
+        - include: $self
+      - include: $self
+    - begin: \s*(?<=^|[\s,;])(spmd)\b
+      beginCaptures:
+        '1':
+          name: keyword.control.repeat.parallel.matlab
+      end: \s*(?<=^|[\s,;])(end)\b
+      endCaptures:
+        '1':
+          name: keyword.control.end.repeat.parallel.matlab
+      name: meta.repeat.parallel.matlab
+      patterns:
+      - begin: \G(?!$)
+        end: (?<!\.{3})(?:(?=([,;])(?![^(]*\)))|$)
+        name: meta.repeat.parallel.declaration.matlab
+        patterns:
+        - include: $self
+      - include: $self
+    - begin: \s*(?<=^|[\s,;])(switch)\s+([a-zA-Z0-9][a-zA-Z0-9_]*)
+      beginCaptures:
+        '1':
+          name: keyword.control.switch.matlab
+        '2':
+          name: variable.other.constant.matlab
+      end: \s*(?<=^|[\s,;])(end)\b
+      endCaptures:
+        '1':
+          name: keyword.control.end.switch.matlab
+      name: meta.switch.matlab
+      patterns:
+      - captures:
+          '2':
+            name: keyword.control.switch.case.matlab
+          '3':
+            begin: \G(?!$)
+            end: (?<!\.{3})(?:(?=([,;])(?![^(]*\)))|$)
+            name: meta.case.declaration.matlab
+            patterns:
+            - include: $self
+        match: (\s*)(?<=^|[\s,;])(case)\b(.*?)(?<!\.{3})(?:(?=([,;])(?![^(]*\)))|$)
+        name: meta.case.matlab
+      - captures:
+          '2':
+            name: keyword.control.switch.otherwise.matlab
+          '3':
+            patterns:
+            - include: $self
+        match: (\s*)(?<=^|[\s,;])(otherwise)\b
+        name: meta.otherwise.matlab
+      - include: $self
+    - begin: \s*(?<=^|[\s,;])(try)\b
+      beginCaptures:
+        '1':
+          name: keyword.control.try.matlab
+      end: \s*(?<=^|[\s,;])(end)\b
+      endCaptures:
+        '1':
+          name: keyword.control.end.try.matlab
+      name: meta.try.matlab
+      patterns:
+      - captures:
+          '2':
+            name: keyword.control.catch.matlab
+          '3':
+            name: variable.other.constant.matlab
+        match: (\s*)(?<=^|[\s,;])(catch)\b\s*(\w+)?
+        name: meta.catch.matlab
+      - include: $self
+    - begin: \s*(?<=^|[\s,;])(while)\b
+      beginCaptures:
+        '1':
+          name: keyword.control.while.matlab
+      end: \s*(?<=^|[\s,;])(end)\b
+      endCaptures:
+        '1':
+          name: keyword.control.end.while.matlab
+      name: meta.while.matlab
+      patterns:
+      - begin: \G
+        end: (?<!\.{3})(?:(?=([,;])(?![^(]*\)))|$)
+        endCaptures:
+          '1':
+            include: $self
+        name: meta.while.declaration.matlab
+      - include: $self
+  classdef:
+    comment: Class definition
+    patterns:
+    - begin: "(?x)\n\t\t\t\t\t\t\t^\\s*    \t\t\t\t\t\t\t# Leading whitespace\n\t\t\
+        \t\t\t\t\t(classdef)\n\t\t\t\t\t\t\t\\s*\n\t\t\t\t\t"
+      beginCaptures:
+        '1':
+          name: storage.type.class.matlab
+      end: \s*(?<=^|[\s,;])(end)\b
+      endCaptures:
+        '1':
+          name: storage.type.class.end.matlab
+      name: meta.class.matlab
+      patterns:
+      - begin: \G
+        end: (?<!\.{3})(?=\n)
+        name: meta.class.declaration.matlab
+        patterns:
+        - begin: \G(\([^)]*\))?\s*
+          beginCaptures:
+            '1':
+              comment: Optional attributes
+              patterns:
+              - match: (?<=\s)\(
+                name: punctuation.section.parens.begin.matlab
+              - match: \)\z
+                name: punctuation.section.parens.end.matlab
+              - match: ','
+                name: punctuation.separator.modifier.comma.matlab
+              - match: '[a-zA-Z][a-zA-Z0-9_]*'
+                name: storage.modifier.class.matlab
+              - begin: (=)\s*
+                beginCaptures:
+                  '1':
+                    name: keyword.operator.assignment.matlab
+                end: (?=\)|,)
+                patterns:
+                - match: true|false
+                  name: constant.language.boolean.matlab
+                - include: '#string'
+              - include: '#comments'
+              - include: '#line_continuation'
+          end: (?<!\.{3})(?=\s*%|\n)
+          patterns:
+          - begin: \G\s*([a-zA-Z][a-zA-Z0-9_]*)
+            beginCaptures:
+              '1':
+                comment: Class name
+                name: entity.name.type.class.matlab
+            end: (?<!\.{3})(?=\n)
+            patterns:
+            - comment: Optional inheritance operator
+              match: <
+              name: punctuation.separator.lt.inheritance.matlab
+            - begin: (?<!\.)\b(?=[a-zA-Z])
+              comment: Inherited class
+              end: (?<=[a-zA-Z0-9_])(?!\.)
+              name: meta.inherited-class.matlab
+              patterns:
+              - match: (?<=[\s.<])[a-zA-Z][a-zA-Z0-9_]*(?=\s|$)
+                name: entity.other.inherited-class.matlab
+              - match: '[a-zA-Z][a-zA-Z0-9_]*'
+                name: entity.name.namespace.matlab
+              - match: \.
+                name: punctuation.accessor.dot.matlab
+            - comment: Multiple superclass operator
+              match: '&'
+              name: keyword.operator.type.matlab
+            - include: '#comments'
+            - include: '#line_continuation'
+          - include: '#comments'
+          - include: '#line_continuation'
+      - begin: "(?x)\n\t\t\t\t\t\t\t\t\t(^\\s*)\t\t\t\t\t\t\t\t# Leading whitespace\n\
+          \t\t\t\t\t\t\t\t\t(properties)\\b([^%]*)\n\t\t\t\t\t\t\t\t\t\\s*\n\t\t\t\
+          \t\t\t\t\t\t(\t\t\t\t\t\t\t\t\t# Optional attributes\n\t\t\t\t\t\t\t\t\t\
+          \t\\( [^)]* \\)\n\t\t\t\t\t\t\t\t\t)?\n\t\t\t\t\t\t\t\t\t\\s*($|(?=%))\n\
+          \t\t\t\t\t\t\t"
+        beginCaptures:
+          '2':
+            name: keyword.control.properties.matlab
+          '3':
+            patterns:
+            - match: '[a-zA-Z][a-zA-Z0-9_]*'
+              name: storage.modifier.properties.matlab
+            - begin: (=)\s*
+              beginCaptures:
+                '1':
+                  name: keyword.operator.assignment.matlab
+              end: ',|(?=\))'
+              patterns:
+              - match: true|false
+                name: constant.language.boolean.matlab
+              - match: public|protected|private
+                name: storage.modifier.access.matlab
+        end: \s*(?<=^|[\s,;])(end)\b
+        endCaptures:
+          '1':
+            name: keyword.control.end.properties.matlab
+        name: meta.properties.matlab
+        patterns:
+        - include: $self
+      - begin: "(?x)\n\t\t\t\t\t\t\t\t\t(^\\s*)\t\t\t\t\t\t\t\t# Leading whitespace\n\
+          \t\t\t\t\t\t\t\t\t(methods)\\b([^%]*)\n\t\t\t\t\t\t\t\t\t\\s*\n\t\t\t\t\t\
+          \t\t\t\t(\t\t\t\t\t\t\t\t\t# Optional attributes\n\t\t\t\t\t\t\t\t\t\t\\\
+          ( [^)]* \\)\n\t\t\t\t\t\t\t\t\t)?\n\t\t\t\t\t\t\t\t\t\\s*($|(?=%))\n\t\t\
+          \t\t\t\t\t"
+        beginCaptures:
+          '2':
+            name: keyword.control.methods.matlab
+          '3':
+            patterns:
+            - match: '[a-zA-Z][a-zA-Z0-9_]*'
+              name: storage.modifier.methods.matlab
+            - begin: =\s*
+              end: ',|(?=\))'
+              patterns:
+              - match: true|false
+                name: constant.language.boolean.matlab
+              - match: public|protected|private
+                name: storage.modifier.access.matlab
+        end: \s*(?<=^|[\s,;])(end)\b
+        endCaptures:
+          '1':
+            name: keyword.control.end.methods.matlab
+        name: meta.methods.matlab
+        patterns:
+        - include: $self
+      - begin: "(?x)\n\t\t\t\t\t\t\t\t\t(^\\s*)\t\t\t\t\t\t\t\t# Leading whitespace\n\
+          \t\t\t\t\t\t\t\t\t(events)\\b([^%]*)\n\t\t\t\t\t\t\t\t\t\\s*\n\t\t\t\t\t\
+          \t\t\t\t(\t\t\t\t\t\t\t\t\t# Optional attributes\n\t\t\t\t\t\t\t\t\t\t\\\
+          ( [^)]* \\)\n\t\t\t\t\t\t\t\t\t)?\n\t\t\t\t\t\t\t\t\t\\s*($|(?=%))\n\t\t\
+          \t\t\t\t\t"
+        beginCaptures:
+          '2':
+            name: keyword.control.events.matlab
+          '3':
+            patterns:
+            - match: '[a-zA-Z][a-zA-Z0-9_]*'
+              name: variable.parameter.events.matlab
+            - begin: =\s*
+              end: ',|(?=\))'
+              patterns:
+              - match: true|false
+                name: constant.language.boolean.matlab
+              - match: public|protected|private
+                name: storage.modifier.access.matlab
+        end: \s*(?<=^|[\s,;])(end)\b
+        endCaptures:
+          '1':
+            name: keyword.control.end.events.matlab
+        name: meta.events.matlab
+        patterns:
+        - captures:
+            '1':
+              name: entity.name.type.event.matlab
+          match: (?:^\s*|,\s*)([a-zA-Z0-9_]+)
+          name: meta.assignment.definition.event.matlab
+        - include: $self
+      - begin: "(?x)\n\t\t\t\t\t\t\t\t\t(^\\s*)\t\t\t\t\t\t\t\t# Leading whitespace\n\
+          \t\t\t\t\t\t\t\t\t(enumeration)\\b([^%]*)\n\t\t\t\t\t\t\t\t\t\\s*($|(?=%))\n\
+          \t\t\t\t\t\t\t"
+        beginCaptures:
+          '2':
+            name: keyword.control.enum.matlab
+        end: \s*(?<=^|[\s,;])(end)\b
+        endCaptures:
+          '1':
+            name: keyword.control.end.enum.matlab
+        name: meta.enum.matlab
+        patterns:
+        - captures:
+            '1':
+              name: variable.other.enummember.matlab
+          match: (?:^\s*|,\s*)([a-zA-Z0-9_]+)
+          name: meta.assignment.definition.enummember.matlab
+        - match: ','
+          name: punctuation.separator.comma.matlab
+        - include: '#comments'
+      - include: '#comments'
+  command_dual:
+    captures:
+      '2':
+        name: entity.name.function.command.matlab
+        patterns:
+        - comment: Embed MATLAB into command syntax to allow keyword grammar injection.
+          include: $self
+      '4':
+        name: string.unquoted.matlab
+        patterns:
+        - include: '#string_quoted_single'
+    comment: "\t\t\t\t\t  1 \t\t\t\t   2\t\t3 \t\t\t\t   4\t\t\t\t\t\t\t\t\t\t\t\t\
+      \t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t   "
+    match: (?<=^|[^.]\n|;|,|=)([^\S\n]*)(?# A> )(\b\w+\b)([^\S\n]+)(?# B> )((?!(\+|-|\*|\.\*|\/|\.\/|\\|\.\\|\^|\.\^|==|~=|&|&&|\||\|\||=|:|>|>=|<|<=|\.{3})[^\S\n]?)[^\s({=;%][^\n;%]*)
+    name: meta.function-call.command.matlab
+  comment_block:
+    begin: (^[\s]*)(%\{)[^\S\n]*+\n
+    beginCaptures:
+      '1':
+        name: punctuation.whitespace.comment.leading.matlab
+      '2':
+        name: punctuation.definition.comment.begin.matlab
+    end: (^[\s]*)(%\})[^\S\n]*+(?:\n|$)
+    endCaptures:
+      '1':
+        name: punctuation.whitespace.comment.leading.matlab
+      '2':
+        name: punctuation.definition.comment.end.matlab
+    name: comment.block.percentage.matlab
+    patterns:
+    - include: '#comment_block'
+    - match: ^[^\n]*\n
+  comments:
+    patterns:
+    - begin: (^[ \t]+)?(?=%%\s)
+      beginCaptures:
+        '1':
+          name: punctuation.whitespace.comment.leading.matlab
+      comment: Section comment
+      end: \Z
+      patterns:
+      - begin: '%%'
+        beginCaptures:
+          '0':
+            name: punctuation.definition.comment.matlab
+        end: \n
+        name: comment.line.double-percentage.matlab
+        patterns:
+        - begin: \G[^\S\n]*(?![\n\s])
+          beginCaptures:
+            '0':
+              name: punctuation.whitespace.comment.leading.matlab
+          contentName: entity.name.section.matlab
+          end: (?=\n)
+    - include: '#comment_block'
+    - begin: (^[ \t]+)?(?=%)
+      beginCaptures:
+        '1':
+          name: punctuation.whitespace.comment.leading.matlab
+      comment: Inline comment
+      end: \Z
+      patterns:
+      - begin: '%'
+        beginCaptures:
+          '0':
+            name: punctuation.definition.comment.matlab
+        end: \Z
+        name: comment.line.percentage.matlab
+  function:
+    patterns:
+    - begin: "(?x)\n\t\t\t\t\t\t\t(^\\s*)\t\t\t\t\t\t\t\t\t\t\t# Leading whitespace\n\
+        \t\t\t\t\t\t\t(function)\n\t\t\t\t\t\t\t\\s+\n\t\t\t\t\t"
+      beginCaptures:
+        '2':
+          name: storage.type.function.matlab
+      comment: Function definition
+      end: \s*(?<=^|[\s,;])(end)\b(\s*\n)?
+      endCaptures:
+        '1':
+          name: storage.type.function.end.matlab
+      name: meta.function.matlab
+      patterns:
+      - begin: \G
+        end: (?<=\))|(?>(?<!\.{3}.*)\n)
+        name: meta.function.declaration.matlab
+        patterns:
+        - begin: \G(?=[^\(]*?(?:=|\[|\.{3}))
+          comment: Function output
+          contentName: meta.assignment.variable.output.matlab
+          end: \s*(=)\s*
+          endCaptures:
+            '1':
+              name: keyword.operator.assignment.matlab
+          patterns:
+          - match: \G\[
+            name: punctuation.section.assignment.group.begin.matlab
+          - captures:
+              '1':
+                name: punctuation.section.assignment.group.end.matlab
+            match: (\])\s*
+          - match: '[a-zA-Z][a-zA-Z0-9_]*'
+            name: variable.parameter.output.matlab
+          - match: ','
+            name: punctuation.separator.parameter.comma.matlab
+          - include: '#line_continuation'
+          - include: '#comments'
+        - comment: Function name
+          match: '[a-zA-Z][a-zA-Z0-9_]*(?>\.[a-zA-Z0-9_]+)*'
+          name: entity.name.function.matlab
+          patterns:
+          - match: \.
+            name: punctuation.accessor.dot.matlab
+          - include: '#line_continuation'
+        - begin: \s*\(
+          beginCaptures:
+            '0':
+              name: punctuation.definition.parameters.begin.matlab
+          comment: Function arguments
+          end: \)
+          endCaptures:
+            '0':
+              name: punctuation.definition.parameters.end.matlab
+          name: meta.parameters.matlab
+          patterns:
+          - match: '[a-zA-Z][a-zA-Z0-9_]*'
+            name: variable.parameter.input.matlab
+          - match: '~'
+            name: variable.language.anonymous.matlab
+          - match: ','
+            name: punctuation.separator.parameter.comma.matlab
+          - include: '#comments'
+          - include: '#line_continuation'
+        - include: '#line_continuation'
+        - include: '#comments'
+      - begin: "(?x)\n\t\t\t\t\t\t\t\t\t(^\\s*)\t\t\t\t\t\t\t\t# Leading whitespace\n\
+          \t\t\t\t\t\t\t\t\t(arguments)\\b([^%]*)\n\t\t\t\t\t\t\t\t\t\\s*\n\t\t\t\t\
+          \t\t\t\t\t(\t\t\t\t\t\t\t\t\t# Optional attributes\n\t\t\t\t\t\t\t\t\t\t\
+          \\( [^)]* \\)\n\t\t\t\t\t\t\t\t\t)?\n\t\t\t\t\t\t\t\t\t\\s*($|(?=%))\n\t\
+          \t\t\t\t\t\t\t"
+        end: \s*(?<=^|[\s,;])(end)\b
+        endCaptures:
+          '1':
+            name: keyword.control.end.arguments.matlab
+        name: meta.arguments.matlab
+        patterns:
+        - comment: Class property name-value arguments
+          match: (?<=\w)\.\?(?=\w)
+          name: keyword.operator.other.matlab
+        - include: $self
+      - include: $self
+  line_continuation:
+    captures:
+      '1':
+        name: punctuation.separator.continuation.line.matlab
+      '2':
+        name: comment.continuation.line.matlab
+    comment: Line continuations
+    match: (\.{3})(.*)$
+    name: meta.continuation.line.matlab
+  rules_after_command_dual:
+    patterns:
+    - include: '#string'
+    - include: '#line_continuation'
+    - include: '#comments'
+  rules_before_command_dual:
+    patterns:
+    - include: '#classdef'
+    - include: '#function'
+    - include: '#blocks'
+  shell_string:
+    captures:
+      '1':
+        name: meta.interpolation.shell.matlab
+      '2':
+        name: punctuation.section.interpolation.begin.matlab
+      '3':
+        name: source.shell.embedded.matlab
+        patterns:
+        - include: source.shell
+    comment: Shell command
+    match: ^\s*((!)(.*)$\n?)
+  string:
+    patterns:
+    - include: '#shell_string'
+    - include: '#string_quoted_single'
+    - include: '#string_quoted_double'
+  string_quoted_double:
+    begin: ((?<=(\[|\(|\{|=|\s|;|:|,|~|<|>|&|\||-|\+|\*|\/|\\|\.|\^))|^)"
+    beginCaptures:
+      '0':
+        name: punctuation.definition.string.begin.matlab
+    comment: String literal (double-quoted)
+    end: '"(?=(\[|\(|\{|\]|\)|\}|=|~|<|>|&|\||-|\+|\*|\/|\\|\.|\^|\||\s|;|:|,)|$)'
+    endCaptures:
+      '0':
+        name: punctuation.definition.string.end.matlab
+    name: string.quoted.double.matlab
+    patterns:
+    - match: '""'
+      name: constant.character.escape.matlab
+    - match: '"(?=.)'
+      name: invalid.illegal.unescaped-quote.matlab
+  string_quoted_single:
+    begin: ((?<=(\[|\(|\{|=|\s|;|:|,|~|<|>|&|\||-|\+|\*|/|\\|\.|\^))|^)'
+    beginCaptures:
+      '0':
+        name: punctuation.definition.string.begin.matlab
+    comment: Character vector literal (single-quoted)
+    end: '''(?=(\[|\(|\{|\]|\)|\}|=|~|<|>|&|\||-|\+|\*|/|\\|\.|\^|\s|;|:|,)|$)'
+    endCaptures:
+      '0':
+        name: punctuation.definition.string.end.matlab
+    name: string.quoted.single.matlab
+    patterns:
+    - match: ''''''
+      name: constant.character.escape.matlab
+    - match: '''(?=.)'
+      name: invalid.illegal.unescaped-quote.matlab
+    - comment: Operator symbols
+      match: ((\%([\+\-0]?\d{0,3}(\.\d{1,3})?)(c|d|e|E|f|g|i|G|s|((b|t)?(o|u|x|X))))|\%\%|\\(b|f|n|r|t|\\))
+      name: constant.character.escape.matlab
+scopeName: source.matlab.minimal
+uuid: e1aee587-e622-4ace-9c88-d4b94de0b168

{mkdocstrings_matlab-0.1.3.dist-info → mkdocstrings_matlab-0.1.5.dist-info}/METADATA

@@ -1,15 +1,17 @@
 Metadata-Version: 2.3
 Name: mkdocstrings-matlab
-Version: 0.1.3
+Version: 0.1.5
 Summary: Add your description here
-Author-email: Mark Hu <mark.hu@asml.com>
+Author-email: Mark Hu <watermarkhu@gmail.com>
 License-File: LICENSE
+Requires-Dist: charset-normalizer>=3.3.2
 Requires-Dist: griffe>=1.2.0
 Requires-Dist: markdown>=3.7
 Requires-Dist: mkdocs-material>=9.5.33
 Requires-Dist: mkdocs>=1.6.0
 Requires-Dist: mkdocstrings>=0.25.2
 Requires-Dist: mkdocstrings[python]>=0.18
+Requires-Dist: textmate-grammar-python>=0.6.1
 Description-Content-Type: text/markdown
 
 # mkdocstrings-matlab

{mkdocstrings_matlab-0.1.3.dist-info → mkdocstrings_matlab-0.1.5.dist-info}/RECORD

@@ -1,25 +1,28 @@
 mkdocstrings_handlers/matlab/__init__.py,sha256=laA2bEP5rxdIWBLmfLiKKu7ChZ_HzCe-VeRvxmUTqww,128
-mkdocstrings_handlers/matlab/handler.py,sha256=078JkZgLNGIbTmGGhzQfKWjPLdw79Jf1d9Vj_hG6rgY,15721
-mkdocstrings_handlers/matlab/models.py,sha256=9oK-ZmpQuU2cU2wX8wlaK540BB9LazzaCtTmnnnIDyo,4428
+mkdocstrings_handlers/matlab/collections.py,sha256=oiDK4nwIUXroIPxw6Cu13WcBxmCyAHjPn7naaW_Yhjs,445
+mkdocstrings_handlers/matlab/handler.py,sha256=WPfsvlGTZcAYgep6rpRjESPJdXU2QbVm31cf5v9ob0c,16959
+mkdocstrings_handlers/matlab/models.py,sha256=n1l1Gr5Wq7nsrsP4PSePGfnGcln0NI-zSrkijGJBf80,5644
+mkdocstrings_handlers/matlab/parser.py,sha256=bA3KRNnYjSewqyJI8OmLKATk3AZOq9-28UQg0L6f9os,843
 mkdocstrings_handlers/matlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/matlab/matlab/matlab_startup.m,sha256=rGXiR8fI2GW7yWmHxgzE5Un66n5ws3ogYnMvS2oWO8U,464
 mkdocstrings_handlers/matlab/matlab/+docstring/exception.m,sha256=sj2ycqMpknn_OG5A5X_b5e4WcAoR2oPoqNnDEHJsi7c,222
-mkdocstrings_handlers/matlab/matlab/+docstring/resolve.m,sha256=ZHHz6ujW1godzDcGtC3p0SsVARv-roseUh85e2eTBrE,2736
+mkdocstrings_handlers/matlab/matlab/+docstring/resolve.m,sha256=GZ7-NC79CVBVHjNJNublosAsGNhLy8dX4uyT4cznl4U,2800
 mkdocstrings_handlers/matlab/matlab/+docstring/+case/builtin.m,sha256=IioiokiaLnsi_6VXraaGdU2AgjCNApYhgVEmp2Lg1eA,245
 mkdocstrings_handlers/matlab/matlab/+docstring/+case/class.m,sha256=kVQxUEk8iOfHK2_NnN0HjHVhFnPgUqsf9PzyKC93y0g,276
 mkdocstrings_handlers/matlab/matlab/+docstring/+case/func.m,sha256=QneDYSICtXqdPNq8sYNieirXUisuDKRM9rxPx-0osDU,137
 mkdocstrings_handlers/matlab/matlab/+docstring/+case/method.m,sha256=Bw8Mb96OP7-AnbGnvRMySOIbYSTtEC1BGBnqHMEIhsM,165
 mkdocstrings_handlers/matlab/matlab/+docstring/+case/namespace.m,sha256=ZpYrgZHLIdGvgg3F6210gDTska9YyASn63ZVYkBq41A,667
-mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/argument.m,sha256=i4lDOdGj35PahqX4HsSghibbcOlNRJ17R1N05IMi0Yg,1904
+mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/argument.m,sha256=yE1sywrr6Q0YjEkPkdBTjjkLeUrPv0jV-degM_EE_iE,1905
 mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/class.m,sha256=n7qDJACSybOGjrQJPR8EzoMxkw2WOPMvPflvshkLz3Q,1673
 mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/func.m,sha256=k1gz4kjEQX5DCIfzCs1lee5jjAL4fg6A7LnwcUF8kRE,424
 mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/namespace.m,sha256=kMzfAoWIpMXH76rrkyUqauJSRIaylsfnu0Cds4pYnJc,481
 mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/property.m,sha256=rH3cHz66ZG9sUvDU2fhlyASSB_yp0SiHlbpB44fcFiY,1560
 mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/script.m,sha256=pmuazWBqlugNEEojfQFkAg1ioErizoiEZ9RcFXecCP4,329
-mkdocstrings_handlers/matlab/matlab/+docstring/+utils/dedent.m,sha256=r02mWQkRP9uuoEl-f-02h1-ja17a_29LTeyJvK-kazI,669
+mkdocstrings_handlers/matlab/matlab/+docstring/+utils/dedent.m,sha256=IsqIZKyaBUeDihtxJOgIcCcV0Ju8Lv4oG-w4f7Iiu2s,668
 mkdocstrings_handlers/matlab/matlab/+docstring/+utils/get_namespace_path.m,sha256=4NlQ7-RjqIFZAn6P-9JzCrm2FvfGRKiM2M_leINj9i4,835
 mkdocstrings_handlers/matlab/matlab/+docstring/+utils/parse_doc.m,sha256=iFNpbnOr9FAv-3Zn8ksJHIthXAB7XKYVfH2NGFinzHs,499
-mkdocstrings_matlab-0.1.3.dist-info/METADATA,sha256=kU1-tCUxvcT9qjHjlxLj1Y1EKlEbGi2H8ctPRUbaUjQ,457
-mkdocstrings_matlab-0.1.3.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
-mkdocstrings_matlab-0.1.3.dist-info/licenses/LICENSE,sha256=14xA0OIYNpfmdeuq8-Yyqg7-3IJ4qhu3BJhknent-cY,1069
-mkdocstrings_matlab-0.1.3.dist-info/RECORD,,
+mkdocstrings_handlers/matlab/resources/grammar.yml,sha256=GLI4xdATiB70bzRscXOVwMlw0YFlA-3GJzuzqWeBKJU,19511
+mkdocstrings_matlab-0.1.5.dist-info/METADATA,sha256=KBhx1cJar_HMRP4xPomOvIBl_7Y-pITgSuLU0_Ra_rE,549
+mkdocstrings_matlab-0.1.5.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
+mkdocstrings_matlab-0.1.5.dist-info/licenses/LICENSE,sha256=14xA0OIYNpfmdeuq8-Yyqg7-3IJ4qhu3BJhknent-cY,1069
+mkdocstrings_matlab-0.1.5.dist-info/RECORD,,