latexgraphics.py

Go to the documentation of this file.

#  This file is part of repro, a Python package for automating 
#  reproducible research in scientific computing.
#
#  Copyright (C) 2008  Gilles Hennenfent, Sean Ross-Ross
#
#  This program is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program.  If not, see <http://www.gnu.org/licenses/>.

##
# 
# @package latexgraphics
# Provide an extended TeX scanner based on SCons TeX scanner
# 
import re, os.path

from SCons.Tool import LaTeXScanner
from SCons.Script import File, FindSourceFiles

##
# 
#     @bug Scanner include commented lines in search for dependencies. These lines 
#     should be ignored.
#     @todo Update scanner to find dependencies related to 'listing' package. 
#     
def scanner_function( node, env, path ):

    incgraph_re = re.compile('includegraphics')

    if node.is_derived():
        src_files = FindSourceFiles( node )
    else:
        src_files = [node]

    all_src_files = src_files

    for src_file in src_files:
        all_src_files += LaTeXScanner.scan( src_file )
    
    all_deps = all_src_files
    for src_file in all_src_files:
        deps = LaTeXScanner.find_include_names( src_file )
        for dep in deps:
            if incgraph_re.match( dep[0] ):
                filename = dep[1]
                ext = os.path.splitext( filename )[1]
                if ext == '':
                    # default extension is PNG
                    all_deps.append( File( filename+'.png' ) )
                else:
                    all_deps.append( File( filename ) )

    return all_deps

---