Merge pull request #4878 from kprussing/feature/latex-scanner-requirepackage

Add RequirePackage to the scanned macros for recursive LaTeX scanning

Author: bdbaddog

CHANGES.txt

@@ -78,6 +78,9 @@ RELEASE  VERSION/DATE TO BE FILLED IN LATER
     - Fix typos in preface, Chapter 6, Chapter 9 and Chapter 10 of User Guide
     - Fix broken links in Chapter 1 of User Guide
 
+  From Keith F. Prussing:
+    - Add RequiredPackage to the LaTeX scanner for recursive scanning of
+      custom LaTeX packages.
 
   From Mats Wichmann:
     - Introduce some unit tests for the file locking utility routines

RELEASE.txt

@@ -102,7 +102,8 @@ long function signature lines, and some linting-inspired cleanups.
 - zip tool now uses zipfile module's "from_file" method to populate ZipInfo
   records, rather than doing manually.
 
-
+- Add RequiredPackage to the LaTeX scanner for recursive scanning of custom
+  LaTeX packages.
 
 PACKAGING
 ---------

SCons/Scanner/LaTeX.py

@@ -165,6 +165,7 @@ class LaTeX(ScannerBase):
                      'addsectionbib': 'BIBINPUTS',
                      'makeindex': 'INDEXSTYLE',
                      'usepackage': 'TEXINPUTS',
+                     'RequirePackage': 'TEXINPUTS',
                      'usetheme': 'TEXINPUTS',
                      'usecolortheme': 'TEXINPUTS',
                      'usefonttheme': 'TEXINPUTS',
@@ -193,7 +194,8 @@ def __init__(self, name, suffixes, graphics_extensions, *args, **kwargs) -> None
               | addbibresource
               | addglobalbib
               | addsectionbib
-              | usepackage
+              | usepackage(?:\s*\[[^\]]+\])?
+              | RequirePackage(?:\s*\[[^\]]+\])?
               | use(?:|color|font|inner|outer)theme(?:\s*\[[^\]]+\])?
               )
                   \s*{([^}]*)}       # first arg
@@ -276,7 +278,7 @@ def _latex_names(self, include_type, filename):
             base, ext = os.path.splitext( filename )
             if ext == "":
                 return [filename + '.bib']
-        if include_type == 'usepackage':
+        if include_type in ('usepackage', 'RequirePackage'):
             base, ext = os.path.splitext( filename )
             if ext == "":
                 return [filename + '.sty']
@@ -417,7 +419,7 @@ def scan_recurse(self, node, path=()):
             if n is None:
                 # Do not bother with 'usepackage' warnings, as they most
                 # likely refer to system-level files
-                if inc_type != 'usepackage' or re.match("use(|color|font|inner|outer)theme", inc_type):
+                if inc_type not in ('usepackage', 'RequirePackage') or re.match("use(|color|font|inner|outer)theme", inc_type):
                     SCons.Warnings.warn(
                         SCons.Warnings.DependencyWarning,
                         "No dependency generated for file: %s "

SCons/Scanner/LaTeXTests.py

@@ -101,6 +101,15 @@
 
 test.write(['subdir2', 'inc3.tex'], "\\input{inc2}\n")
 
+test.write('test7.latex',r"""
+\usepackage{scons}
+""")
+test.write('scons.sty',r"""
+\RequirePackage[option]{other}
+\RequirePackage{system}
+""")
+test.write('other.sty', "\n")
+
 # define some helpers:
 #   copied from CTest.py
 class DummyEnvironment(collections.UserDict):
@@ -200,7 +209,7 @@ def runTest(self) -> None:
                   ('color', 'font', 'inner', 'outer', '')]
          deps_match(self, deps, files)
 
-class LaTeXScannerTestCase5(unittest.TestCase):
+class LaTeXScannerTestCase6(unittest.TestCase):
      def runTest(self) -> None:
          env = DummyEnvironment(TEXINPUTS=[test.workpath("subdir")],LATEXSUFFIXES = [".tex", ".ltx", ".latex"])
          s = SCons.Scanner.LaTeX.LaTeXScanner()
@@ -217,5 +226,14 @@ def runTest(self) -> None:
          else:
              deps_match(self, deps, files)
 
+class LaTeXScannerTestCase7(unittest.TestCase):
+     def runTest(self) -> None:
+         env = DummyEnvironment(TEXINPUTS=[test.workpath("subdir")],LATEXSUFFIXES = [".tex", ".ltx", ".latex"])
+         s = SCons.Scanner.LaTeX.LaTeXScanner()
+         path = s.path(env)
+         deps = s(env.File('test7.latex'), env, path)
+         files = ["other.sty", "scons.sty"]
+         deps_match(self, deps, files)
+
 if __name__ == "__main__":
     unittest.main()