Fix issue with parsing of MATLAB files. (#234)

Author: joeced

CHANGES.rst

@@ -1,3 +1,11 @@
+sphinxcontrib-matlabdomain-0.21.3 (2024-01-02)
+==============================================
+
+* Fix issue with parsing of MATLAB files, where keywords were used in ``struct``
+  fieldnames. E.g. ``a = pkg.arguments``. These were mistaken as ``keyword``
+  tokens and could result in warnings with ``Check if valid MATLAB code.``.
+* Bump copyright to 2024.
+
 sphinxcontrib-matlabdomain-0.21.2 (2023-12-17)
 ==============================================
 

CITATION.bib

@@ -16,11 +16,11 @@ @software{jorgen_cederberg_2023_7747374
                Marc-Henri Bleu-Laine and
                Nikolaas N. Oosterhof and
                ptitrex},
-  title     = {sphinx-contrib/matlabdomain: 0.21.1},
-  month     = dec,
-  year      = 2023,
+  title     = {sphinx-contrib/matlabdomain: 0.21.2},
+  month     = jan,
+  year      = 2024,
   publisher = {Zenodo},
-  version   = {0.21.1},
+  version   = {0.21.2},
   doi       = {10.5281/zenodo.7746009},
   url       = {https://github.com/sphinx-contrib/matlabdomain}
 }

LICENSE

@@ -1,8 +1,11 @@
-If not otherwise noted, the extensions in this package are licensed
-under the following license.
+License for sphinxcontrib-matlabdomain
+======================================
 
-Copyright (c) 2009 by the contributors (see AUTHORS file).
-All rights reserved.
+Unless otherwise indicated, all code in the sphinxcontrib-matlabdomain project
+is licenced under the two clause BSD licence below.
+
+Copyright (c) 2009-2024 by the sphinxcontrib-matlabdomain team (see AUTHORS
+file). All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
@@ -19,7 +22,7 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

sphinxcontrib/mat_directives.py

@@ -1,3 +1,13 @@
+"""
+    sphinxcontrib.mat_directives
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    Extend autodoc directives to matlabdomain.
+
+    :copyright: Copyright 2014-2024 by the sphinxcontrib-matlabdomain team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+"""
+
 from sphinx.ext.autodoc.directive import (
     AutodocDirective,
     DummyOptionSpec,

sphinxcontrib/mat_documenters.py

@@ -1,13 +1,13 @@
-# -*- coding: utf-8 -*-
 """
     sphinxcontrib.mat_documenters
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
     Extend autodoc directives to matlabdomain.
 
-    :copyright: Copyright 2014 Mark Mikofski
+    :copyright: Copyright 2014-2024 by the sphinxcontrib-matlabdomain team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 """
+
 from .mat_types import (  # noqa: E401
     MatModule,
     MatObject,

sphinxcontrib/mat_lexer.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """
     pygments.lexers.matlab
     ~~~~~~~~~~~~~~~~~~~~~~
@@ -288,7 +287,8 @@ class MatlabLexer(RegexLexer):
                         "try",
                         "while",
                     ),
-                    suffix=r"\b",
+                    prefix=r"(?<!\.)(",
+                    suffix=r")\b",
                 ),
                 Keyword,
             ),

sphinxcontrib/mat_parser.py

@@ -1,9 +1,11 @@
-# -*- coding: utf-8 -*-
 """
-Functions for parsing MatlabLexer output.
+    sphinxcontrib.mat_parser
+    ~~~~~~~~~~~~~~~~~~~~~~~~
 
-:copyright: Copyright 2023 Jørgen Cederberg
-:license: BSD, see LICENSE for details.
+    Functions for parsing MatlabLexer output.
+
+    :copyright: Copyright 2023-2024 by the sphinxcontrib-matlabdomain team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
 """
 
 import re

sphinxcontrib/mat_types.py

@@ -1,13 +1,13 @@
-# -*- coding: utf-8 -*-
 """
     sphinxcontrib.mat_types
     ~~~~~~~~~~~~~~~~~~~~~~~
 
     Types for MATLAB.
 
-    :copyright: Copyright 2014 Mark Mikofski
+    :copyright: Copyright 2014-2024 by the sphinxcontrib-matlabdomain team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 """
+
 from io import open  # for opening files with encoding in Python 2
 import os
 from copy import copy

sphinxcontrib/matlab.py

@@ -1,13 +1,14 @@
-# -*- coding: utf-8 -*-
 """
     sphinxcontrib.matlab
     ~~~~~~~~~~~~~~~~~~~~
 
     The MATLAB domain.
 
-    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+    :copyright: Copyright 2014-2024 by the sphinxcontrib-matlabdomain team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 """
+
+
 from . import mat_documenters as doc
 from . import mat_directives
 from . import mat_types

tests/test_data/ClassWithKeywordsAsFieldnames.m

@@ -0,0 +1,23 @@
+classdef ClassWithKeywordsAsFieldnames
+   % Class that uses keywords as fieldnames, i.e preceeded by a dot and not
+   % followed by a word break.
+   properties
+      a
+      b
+      c
+   end
+
+   methods
+      function obj = ClassWithKeywordsAsFieldnames()
+         % In MATLAB you can use `keywords` as fieldnames.
+         obj.a = pkg.arguments.end;
+         obj.b = pkg.otherwise.if;
+         obj.c = pkg.persisent.try.while;
+      end
+
+      function d = calculate(obj)
+         % Returns the value of `d`
+         d = obj.a + obj.b + obj.c;
+      end
+   end
+end