From 1685fce0eeb96610f688f3e4d56759fe04e91329 Mon Sep 17 00:00:00 2001 From: Robert Managan Date: Thu, 14 Jun 2012 10:37:48 -0700 Subject: Add support for using biber instead of bibtex. --- src/CHANGES.txt | 2 + src/engine/SCons/Tool/tex.py | 40 +++++++++++++- test/TEX/biber_biblatex.py | 124 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 164 insertions(+), 2 deletions(-) create mode 100755 test/TEX/biber_biblatex.py diff --git a/src/CHANGES.txt b/src/CHANGES.txt index 11e79a9..14b29d7 100644 --- a/src/CHANGES.txt +++ b/src/CHANGES.txt @@ -29,6 +29,8 @@ RELEASE 2.X.X - From Rob Managan: - Updated the TeX builder to support LaTeX's multibib package. - Updated the TeX builder to support LeTeX's biblatex package. + - Added support for using biber instead of bibtex by setting + env['BIBTEX'] = 'biber' From Arve Knudsen: - Test for FORTRANPPFILESUFFIXES (#2129). diff --git a/src/engine/SCons/Tool/tex.py b/src/engine/SCons/Tool/tex.py index 83de5bb..ce0a51f 100644 --- a/src/engine/SCons/Tool/tex.py +++ b/src/engine/SCons/Tool/tex.py @@ -55,7 +55,7 @@ must_rerun_latex = True check_suffixes = ['.toc', '.lof', '.lot', '.out', '.nav', '.snm'] # these are files that require bibtex or makeindex to be run when they change -all_suffixes = check_suffixes + ['.bbl', '.idx', '.nlo', '.glo', '.acn'] +all_suffixes = check_suffixes + ['.bbl', '.idx', '.nlo', '.glo', '.acn', '.bcf'] # # regular expressions used to search for Latex features @@ -64,6 +64,10 @@ all_suffixes = check_suffixes + ['.bbl', '.idx', '.nlo', '.glo', '.acn'] # search for all .aux files opened by latex (recorded in the .fls file) openout_aux_re = re.compile(r"OUTPUT *(.*\.aux)") +# search for all .bcf files opened by latex (recorded in the .fls file) +# for use by biber +openout_bcf_re = re.compile(r"OUTPUT *(.*\.bcf)") + #printindex_re = re.compile(r"^[^%]*\\printindex", re.MULTILINE) #printnomenclature_re = re.compile(r"^[^%]*\\printnomenclature", re.MULTILINE) #printglossary_re = re.compile(r"^[^%]*\\printglossary", re.MULTILINE) @@ -296,8 +300,19 @@ def InternalLaTeXAuxAction(XXXLaTeXAction, target = None, source= None, env=None dups[x] = 1 auxfiles = list(dups.keys()) + bcffiles = [] + if os.path.isfile(flsfilename): + flsContent = open(flsfilename, "rb").read() + bcffiles = openout_bcf_re.findall(flsContent) + # remove duplicates + dups = {} + for x in bcffiles: + dups[x] = 1 + bcffiles = list(dups.keys()) + if Verbose: print "auxfiles ",auxfiles + print "bcffiles ",bcffiles # Now decide if bibtex will need to be run. # The information that bibtex reads from the .aux file is @@ -320,6 +335,27 @@ def InternalLaTeXAuxAction(XXXLaTeXAction, target = None, source= None, env=None check_file_error_message(env['BIBTEX'], 'blg') must_rerun_latex = True + # Now decide if biber will need to be run. + # The information that bibtex reads from the .bcf file is + # pass-independent. If we find (below) that the .bbl file is unchanged, + # then the last latex saw a correct bibliography. + # Therefore only do this once + # Go through all .bcf files and remember the files already done. + for bcffilename in bcffiles: + if bcffilename not in already_bibtexed: + already_bibtexed.append(bcffilename) + target_bcf = os.path.join(targetdir, bcffilename) + if os.path.isfile(target_bcf): + content = open(target_bcf, "rb").read() + if content.find("bibdata") != -1: + if Verbose: + print "Need to run bibtex on ",bcffilename + bibfile = env.fs.File(SCons.Util.splitext(target_bcf)[0]) + result = BibTeXAction(bibfile, bibfile, env) + if result != 0: + check_file_error_message(env['BIBTEX'], 'blg') + must_rerun_latex = True + # Now decide if latex will need to be run again due to index. if check_MD5(suffix_nodes['.idx'],'.idx') or (count == 1 and run_makeindex): # We must run makeindex @@ -648,7 +684,7 @@ def tex_emitter_core(target, source, env, graphics_extensions): ['.bbl', '.blg','bibliography'], ['.bbl', '.blg','bibunit'], ['.bbl', '.blg','multibib'], - ['.bbl', '.blg','addbibresource'], + ['.bbl', '.blg','.bcf','addbibresource'], ['.toc','contents'], ['.lof','figures'], ['.lot','tables'], diff --git a/test/TEX/biber_biblatex.py b/test/TEX/biber_biblatex.py new file mode 100755 index 0000000..94b0a6a --- /dev/null +++ b/test/TEX/biber_biblatex.py @@ -0,0 +1,124 @@ +#!/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 that uses the multibib oackage + +Test courtesy Rob Managan. +""" + +import TestSCons +import os + +test = TestSCons.TestSCons() + +latex = test.where_is('pdflatex') +if not latex: + test.skip_test("Could not find 'pdflatex'; skipping test.\n") + +biber = test.where_is('biber') +if not latex: + test.skip_test("Could not find 'biber'; skipping test.\n") + +gloss = os.system('kpsewhich biblatex.sty') +if not gloss==0: + test.skip_test("biblatex.sty not installed; skipping test(s).\n") + + +test.write(['SConstruct'], """\ +#!/usr/bin/env python + +import os +env = Environment(ENV=os.environ) +env['BIBTEX'] = 'biber' +main_output = env.PDF('bibertest.tex') +""") + + +sources_bib_content = r""" +@book{mybook, + title={Title}, + author={Author, A}, + year={%s}, + publisher={Publisher}, +} +""" +test.write(['ref.bib'],sources_bib_content % '2013' ) + +test.write(['bibertest.tex'],r""" +\documentclass{article} + +\usepackage[backend=biber]{biblatex} +\addbibresource{ref.bib} + +\begin{document} + +Hello. This is boring. +\cite{mybook} +And even more boring. + +\printbibliography +\end{document} +""") + + +test.run() + + +# All (?) the files we expect will get created in the docs directory +files = [ + 'bibertest.aux', + 'bibertest.bbl', + 'bibertest.bcf', + 'bibertest.blg', + 'bibertest.fls', + 'bibertest.log', + 'bibertest.pdf', + 'bibertest.run.xml', +] + + +for f in files: + test.must_exist([ f]) + +pdf_output_1 = test.read('bibertest.pdf') + + + +test.write(['ref.bib'],sources_bib_content % '1982') + +test.run() + +pdf_output_2 = test.read('bibertest.pdf') + +pdf_output_1 = test.normalize_pdf(pdf_output_1) +pdf_output_2 = test.normalize_pdf(pdf_output_2) + +# 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) + +test.pass_test() -- cgit v0.12