paper.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 paper
# Provide one builder, Preamble, and extend a second one, PDF, to 
# generate PDF from LaTeX document.
# 
# @page pg_docblds Document reproducible research
# 
# @section sec_preamblebld Preamble
# 
# Defined in the paper tool. Builder to generate a LaTeX document 
# from different pieces.
# 
# @section sec_tex2pdfbld PDF
# 
# Extended in the paper tool. Builder to generate PDF from LaTeX document.
# 
# Combined example:
# 
# \verbinclude examples/LaTeX/NestedFiles/SConstruct
# 

from SCons.Errors import UserError
from SCons.Script import Builder, Action, File
from string import join
from SCons.Scanner import Scanner
from repro.scanners.latexgraphics import scanner_function

##
# 
#     @brief Add header and footer to make a valid LaTeX document
#     
def preamble_action( target, source, env ):

    documentclass = env.get('documentclass','article')
    if not isinstance( documentclass, str ):
        if isinstance ( documentclass, (list,tuple) ) and len(documentclass) == 1:
            documentclass = documentclass[0]
        else:
            raise UserError( "Preamble: documentclass must be a string or a list of length 1." )
        
    classoptions  = env.get('classoptions')
    packages      = env.get('packages')
    include       = env.get('include')

    target = env.Split(target)
    if len(target) >1:
        raise UserError( "Preamble: target must be a single file name" )      

    source = env.Split(source)

    ofile = open(str(target[0]), 'w' )
    ofile.write('%% This file is automatically generated. Do not edit!\n')
    
    if classoptions is not None:
        if isinstance( classoptions, (list,tuple) ):
            classoptions = join(classoptions,',')
        ofile.write('\\documentclass[%s]{%s}\n\n' % (classoptions,documentclass))
    else:
        ofile.write('\\documentclass{%s}\n\n' % (documentclass))

    if packages is not None:
        for package in packages:
            ofile.write('\\usepackage{%s}\n'%package)
        ofile.write('\n')        

    if include is not None:
        if isinstance( include, str):
            ofile.write(include)
        else:
            raise UserError( "Preamble: include=string")
    
    ofile.write('\n\n\\begin{document}\n\n')

    for src in source:
        ofile.write('\\input{%s}\n\n'%src)
   
    ofile.write('\\end{document}\n')
    ofile.close()  
    
    return None

##
# 
#     @brief Add Preamble builder to the environment and redefine source scanne of 
#     PDF builder.
#     
def generate(env):
    
    env.PDF.method.builder.source_scanner= Scanner( scanner_function )
    
    preamble_act = Action(preamble_action,
                         varlist=['documentclass','classoptions','packages','include'] )
    
    bld2 = Builder(action     = preamble_act,
                   suffix     = '.ltx',
                   src_suffix = '.tex',
                   )
    env['BUILDERS']['Preamble'] = bld2
    
##
# 
#     @brief Return True (this tool always exists).
#     
def exists( env ):
    return 1 

---