Add scanning of files included in Latex by means of \lstinputlisting{}

Patch from Stefan Hepp.

git-svn-id: http://scons.tigris.org/svn/scons/trunk@4559 fdb21ef1-2011-0410-befe-b5e4ea1792b1

diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index 5c8c8b8134f4df0f55dec407adcc9295ba0f0689..9dff0f3d548d16aa1d7f239353129b0a33388aea 100644 (file)
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -120,6 +120,9 @@ RELEASE X.X.X - XXX
 
     - Fix problem with filenames of sideeffects when the user changes
       the name of the output file from the latex default
+      
+    - Add scanning of files included in Latex by means of \lstinputlisting{}
+      Patch from Stefan Hepp.
 
 RELEASE 1.2.0.d20090223 - Mon, 23 Feb 2009 08:41:06 -0800
 

diff --git a/src/engine/SCons/Scanner/LaTeX.py b/src/engine/SCons/Scanner/LaTeX.py
index 530c948c3d86115f1bebe32346849ad8d14b16ba..913812ae524fba7975cfc3b91d7f676792567df3 100644 (file)
--- a/src/engine/SCons/Scanner/LaTeX.py
+++ b/src/engine/SCons/Scanner/LaTeX.py
@@ -151,6 +151,7 @@ class LaTeX(SCons.Scanner.Base):
     of the file being searched:
     env['TEXINPUTS'] for "input" and "include" keywords
     env['TEXINPUTS'] for "includegraphics" keyword
+    env['TEXINPUTS'] for "lstinputlisting" keyword
     env['BIBINPUTS'] for "bibliography" keyword
     env['BSTINPUTS'] for "bibliographystyle" keyword
 
@@ -162,7 +163,8 @@ class LaTeX(SCons.Scanner.Base):
                      'includegraphics': 'TEXINPUTS',
                      'bibliography': 'BIBINPUTS',
                      'bibliographystyle': 'BSTINPUTS',
-                     'usepackage': 'TEXINPUTS'}
+                     'usepackage': 'TEXINPUTS',
+                     'lstinputlisting': 'TEXINPUTS'}
     env_variables = SCons.Util.unique(keyword_paths.values())
 
     def __init__(self, name, suffixes, graphics_extensions, *args, **kw):
@@ -172,7 +174,7 @@ class LaTeX(SCons.Scanner.Base):
         # Without the \n,  the ^ could match the beginning of a *previous*
         # line followed by one or more newline characters (i.e. blank
         # lines), interfering with a match on the next line.
-        regex = r'^[^%\n]*\\(include|includegraphics(?:\[[^\]]+\])?|input|bibliography|usepackage){([^}]*)}'
+        regex = r'^[^%\n]*\\(include|includegraphics(?:\[[^\]]+\])?|lstinputlisting(?:\[[^\]]+\])?|input|bibliography|usepackage){([^}]*)}'
         self.cre = re.compile(regex, re.M)
         self.graphics_extensions = graphics_extensions
 

diff --git a/test/TEX/lstinputlisting.py b/test/TEX/lstinputlisting.py
new file mode 100644 (file)
index 0000000..57b8eae
--- /dev/null
+++ b/test/TEX/lstinputlisting.py
@@ -0,0 +1,131 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Verify that we re-run LaTeX when a source file in \lstinputlisting
+changes.
+
+Thanks to Stefan Hepp for the patch that fixed this.
+"""
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+pdflatex = test.where_is('pdflatex')
+
+if not pdflatex:
+    test.skip_test("Could not find pdflatex; skipping test(s).\n")
+
+test.write(['SConstruct'], """\
+import os
+
+DefaultEnvironment(ENV={'PATH':os.environ['PATH']})
+
+PDF("test.tex")
+""")
+
+test.write(['test.tex'], r"""
+\documentclass{article}
+\usepackage{listings}
+
+\begin{document}
+
+\section{Listings}
+
+\lstinputlisting{test.c}
+
+\end{document}
+""")
+
+source_content = r"""
+int main(int argc, char** argv) {
+    return %s;
+}
+"""
+
+
+
+test.write('test.c', source_content % '0')
+
+test.run()
+
+pdf_output_1 = test.read('test.pdf')
+
+
+
+test.write('test.c', source_content % '1')
+
+test.run()
+
+pdf_output_2 = test.read('test.pdf')
+
+# If the PDF file is the same as it was previously, then it didn't
+# pick up the change from 1981 to 1982, so fail.
+test.fail_test(pdf_output_1 == pdf_output_2)
+
+
+
+# Double-check:  clean everything and rebuild from scratch, which
+# should force the PDF file to be the 1982 version.
+
+test.run(arguments = '-c')
+
+test.run()
+
+pdf_output_3 = test.read('test.pdf')
+
+
+
+# If the PDF file is now different than the second run, modulo the
+# creation timestamp and the ID and some other PDF garp, then something
+# else odd has happened, so fail.
+
+pdf_output_2 = test.normalize_pdf(pdf_output_2)
+pdf_output_3 = test.normalize_pdf(pdf_output_3)
+
+if pdf_output_2 != pdf_output_3:
+    import sys
+    test.write('test.normalized.2.pdf', pdf_output_2)
+    test.write('test.normalized.3.pdf', pdf_output_3)
+    sys.stdout.write("***** 2 and 3 are different!\n")
+    sys.stdout.write(test.diff_substr(pdf_output_2, pdf_output_3, 80, 80) + '\n')
+    sys.stdout.write("Output from run 2:\n")
+    sys.stdout.write(test.stdout(-2) + '\n')
+    sys.stdout.write("Output from run 3:\n")
+    sys.stdout.write(test.stdout() + '\n')
+    sys.stdout.flush()
+    test.fail_test()
+
+
+
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4: