Add a test for the case of a .DVI build using a .eps graphics.
authormanagan <managan@fdb21ef1-2011-0410-befe-b5e4ea1792b1>
Tue, 25 Nov 2008 18:32:19 +0000 (18:32 +0000)
committermanagan <managan@fdb21ef1-2011-0410-befe-b5e4ea1792b1>
Tue, 25 Nov 2008 18:32:19 +0000 (18:32 +0000)
Test that we don't make a .pdf file from the graphic.
The patch also covers the case of requiring the graphics files
I search for to have an extension so we don't try to build fig.eps from fig.eps...

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

src/engine/SCons/Tool/tex.py
test/TEX/eps_graphics.py [new file with mode: 0644]

index 603743114fb50180a65d5b62b9e2441a65f574b3..634adef3a0e335a2755cbd2974d9c7ea9ffb6a11 100644 (file)
@@ -126,7 +126,9 @@ _null = SCons.Scanner.LaTeX._null
 
 modify_env_var = SCons.Scanner.LaTeX.modify_env_var
 
-def FindFile(name,suffixes,paths,env):
+def FindFile(name,suffixes,paths,env,requireExt=False):
+    if requireExt:
+        name = SCons.Util.splitext(name)[0]
     if Verbose:
         print " searching for '%s' with extensions: " % name,suffixes
 
@@ -435,14 +437,22 @@ def ScanFiles(theFile, target, paths, file_tests, file_tests_search, env, graphi
     if Verbose:
         print "graphics files in '%s': "%str(theFile),graphic_files
     for graphFile in graphic_files:
-        graphicNode = FindFile(graphFile,graphics_extensions,paths,env)
-        # see if we can build this graphics file by epstopdf
-        graphicSrc = FindFile(graphFile,TexGraphics,paths,env)
-        if graphicSrc != None:
-            if Verbose and (graphicNode == None):
-                print "need to build '%s' by epstopdf %s -o %s" % (graphFile,graphicSrc,graphFile)
-            graphicNode = env.PDF(graphicSrc)
-            env.Depends(target[0],graphicNode)
+        graphicNode = FindFile(graphFile,graphics_extensions,paths,env,requireExt=True)
+        # if building with pdflatex see if we need to build the .pdf version of the graphic file
+        # I should probably come up with a better way to tell which builder we are using.
+        if graphics_extensions == LatexGraphics:
+            # see if we can build this graphics file by epstopdf
+            graphicSrc = FindFile(graphFile,TexGraphics,paths,env,requireExt=True)
+            # it seems that FindFile checks with no extension added
+            # so if the extension is included in the name then both searches find it
+            # we don't want to try to build a .pdf from a .pdf so make sure src!=file wanted
+            if (graphicSrc != None) and (graphicSrc != graphicNode):
+                if Verbose and (graphicNode == None):
+                    print "need to build '%s' by epstopdf %s -o %s" % (graphFile,graphicSrc,graphFile)
+                else:
+                    print "no need to build '%s', but source file %s exists" % (graphicNode,graphicSrc)
+                graphicNode = env.PDF(graphicSrc)
+                env.Depends(target[0],graphicNode)
 
     # recursively call this on each of the included files
     inc_files = [ ]
@@ -453,7 +463,7 @@ def ScanFiles(theFile, target, paths, file_tests, file_tests_search, env, graphi
     # using TEXINPUTS paths.
 
     for src in inc_files:
-        srcNode = srcNode = FindFile(src,['.tex','.ltx','.latex'],paths,env)
+        srcNode = srcNode = FindFile(src,['.tex','.ltx','.latex'],paths,env,requireExt=False)
         if srcNode != None:
             file_test = ScanFiles(srcNode, target, paths, file_tests, file_tests_search, env, graphics_extensions, targetdir)
     if Verbose:
diff --git a/test/TEX/eps_graphics.py b/test/TEX/eps_graphics.py
new file mode 100644 (file)
index 0000000..a0278f9
--- /dev/null
@@ -0,0 +1,187 @@
+#!/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__"
+
+"""
+Test creation of a Tex document with nested includes in a 
+subdir that needs to create a fig.pdf.
+
+Test courtesy Rob Managan.
+"""
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+latex = test.where_is('latex')
+epstopdf = test.where_is('epstopdf')
+if not latex:
+    test.skip_test("Could not find 'latex'; skipping test.\n")
+
+if not epstopdf:
+    test.skip_test("Could not find 'epstopdf'; skipping test.\n")
+
+test.subdir(['docs'])
+
+
+test.write(['SConstruct'], """\
+import os
+
+env = Environment(ENV = { 'PATH' : os.environ['PATH'] })
+
+test = env.DVI(source='docs/test.tex')
+""")
+
+
+test.write(['docs','Fig1.eps'], """\
+%!PS-Adobe-2.0 EPSF-2.0
+%%Title: Fig1.fig
+%%Creator: fig2dev Version 3.2 Patchlevel 4
+%%CreationDate: Tue Apr 25 09:56:11 2006
+%%For: managan@mangrove.llnl.gov (Rob Managan)
+%%BoundingBox: 0 0 98 98
+%%Magnification: 1.0000
+%%EndComments
+/$F2psDict 200 dict def
+$F2psDict begin
+$F2psDict /mtrx matrix put
+/col-1 {0 setgray} bind def
+/col0 {0.000 0.000 0.000 srgb} bind def
+
+end
+save
+newpath 0 98 moveto 0 0 lineto 98 0 lineto 98 98 lineto closepath clip newpath
+-24.9 108.2 translate
+1 -1 scale
+
+/cp {closepath} bind def
+/ef {eofill} bind def
+/gr {grestore} bind def
+/gs {gsave} bind defThe Oxygen Isotopic Composition of Captured Solar Wind: First Results\rfrom the GENESIS Mission
+/rs {restore} bind def
+/l {lineto} bind def
+/m {moveto} bind def
+/rm {rmoveto} bind def
+/n {newpath} bind def
+/s {stroke} bind def
+/slc {setlinecap} bind def
+/slj {setlinejoin} bind def
+/slw {setlinewidth} bind def
+/srgb {setrgbcolor} bind def
+/sc {scale} bind def
+/sf {setfont} bind def
+/scf {scalefont} bind def
+/tr {translate} bind def
+ /DrawEllipse {
+       /endangle exch def
+       /startangle exch def
+       /yrad exch def
+       /xrad exch def
+       /y exch def
+       /x exch def
+       /savematrix mtrx currentmatrix def
+       x y tr xrad yrad sc 0 0 1 startangle endangle arc
+       closepath
+       savematrix setmatrix
+       } def
+
+/$F2psBegin {$F2psDict begin /$F2psEnteredState save def} def
+/$F2psEnd {$F2psEnteredState restore end} def
+
+$F2psBegin
+10 setmiterlimit
+ 0.06299 0.06299 sc
+%
+% Fig objects follow
+% 
+7.500 slw
+% Ellipse
+n 1170 945 766 766 0 360 DrawEllipse gs col0 s gr
+
+$F2psEnd
+rs
+""")
+
+
+
+test.write(['docs','test.tex'],
+r"""\documentclass{report}
+
+\usepackage{graphicx}
+\usepackage{epsfig,color} % for .tex version of figures if we go that way
+
+\begin{document}
+\title{Report Title}
+
+\author{A. N. Author}
+\maketitle 
+\begin{abstract}
+there is no abstract
+\end{abstract}
+
+\chapter{Introduction}
+
+The introduction is short.
+
+\section{Acknowledgements}
+
+The Acknowledgements are shown as well.  
+
+To get a hard copy of this report call me.
+
+\begin{figure}[htbp]
+\begin{center}
+\includegraphics{Fig1}
+\caption{Zone and Node indexing}
+\label{fig1}
+\end{center}
+\end{figure}
+
+All done now.
+
+\end{document}
+""")
+
+# makeindex will write status messages to stderr (grrr...), so ignore it.
+test.run(arguments = '.', stderr=None)
+
+
+# All (?) the files we expect will get created in the subdir
+# (mybuild/docs) and not in the srcdir (docs).
+files = [
+    'docs/test.aux',
+    'docs/test.log',
+    'docs/test.dvi',
+]
+
+for f in files:
+    test.must_exist([ f])
+
+test.must_not_exist(['docs/Fig1.pdf',])
+
+test.pass_test()