-.PHONY: clean-tex distclean-tex
+# latex.mk
+# LaTeX処理(コンパイル)を行う
+#
+# == 使い方 ==
+# 1. texソースファイルと同じディレクトリーに本ファイル(latex.mk)をコピーする
+# 2. Makefileに変数TEXTARGETS と「include latex.mk」を記述する
+# 3. texソースファイルと同じディレクトリーで、make コマンドを実行する
+#
+# === Makefile -- sample ===
+# TEXTARGETS := report.tex
+#
+# all: $(TEXTARGETS)
+#
+# include latex.mk
+
+######################################################################
+# 使用するシェルコマンドの定義
+######################################################################
# シェルコマンド
+CAT := cat
CMP := cmp -s
CP := cp
-ECHO := echo
+ECHO := /bin/echo
GREP := grep
+MKDIR := mkdir
SED := sed
+SEQ := seq
# LaTeXコマンド
LATEX := platex
EXTRACTBB := extractbb
BIBTEX := pbibtex
MENDEX := mendex
+KPSEWHICH := kpsewhich
-#LaTeXオプション
-interaction ?= batchmode
+# LaTeXオプション
LATEXFLAG ?=
DVIPDFMXFLAG ?=
EXTRACTBBFLAGS ?=
BIBTEXFLAG ?=
MENDEXFLAG ?=
-# LaTeX処理(コンパイル)
-COMPILE.tex = $(LATEX) -interaction=$(interaction) $(LATEXFLAG) $(addsuffix .tex,$(basename $<))
+# シェルコマンドをデバッグするときは、DEBUGSH変数を設定してmakeを実行する
+# 例: DEBUGSH=1 make
+ifdef DEBUGSH
+ SHELL := /bin/sh -x
+endif
+
+######################################################################
+# 拡張子
+######################################################################
+
+# .aux、.fls以外のLaTeX中間ファイルの拡張子
+# .bbl: 文献リスト。作成方法はパターンルールで定義
+# .glo: 用語集。\glossaryがあればTeX処理で生成
+# .idx: 索引。\makeindexがあればTeX処理で生成
+# .ind: 索引。作成方法はパターンルールで定義
+# .lof: 図リスト。\listoffiguresがあればTeX処理で生成
+# .lot: 表リスト。\listoftablesがあればTeX処理で生成
+# .out: PDFブックマーク。hyperrefパッケージをbookmarksオプションtrue(初期値)で呼び出していれば、TeX処理で生成
+# .toc: 目次。\tableofcontentsがあればTeX処理で生成
+LATEXINTEXT := .bbl .glo .idx .ind .lof .lot .out .toc
-# 相互参照の警告
-WARN_REF := 'Label(s) may have changed. Rerun to get cross-references right.'
+# ログファイルの拡張子
+# .log: TeXログ
+# .ilg: 索引ログ
+# .blg: BiBTeXログ
+LOGEXT := .log .ilg .blg
-# 相互参照未定義の警告。2回目以降の処理で出る場合は、参照エラー
-WARN_UNDEFREF := 'There were undefined references.'
+# すべてのTeX中間ファイルの拡張子
+ALLINTEXT := .aux .dvi $(LATEXINTEXT) $(LOGEXT) .fls .d .*_prev
-# auxやtocなどのファイルがない警告
-WARN_NOFILE := 'No file'
+# 画像ファイルの拡張子
+GRAPHICSEXT := .pdf .eps .jpg .jpeg .png .bmp
-# LaTeX処理の最大回数
-MAX_CNT := 10
+# make完了後、中間ファイルを残す
+.SECONDARY: $(foreach t,$(TEXTARGETS),$(addprefix $(basename $t),$(ALLINTEXT)))
+
+######################################################################
+# TeX処理の定義
+######################################################################
+
+# ファイル名から拡張子を除いた部分
+BASE = $(basename $<)
+
+# LaTeX処理(コンパイル)
+LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(BASE).tex
+
+COMPILE.tex = $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || ($(SED) -n -e '/^!/,/^$$/p' $(BASE).log; exit 1)
+
+# 相互参照未定義の警告
+WARN_UNDEFREF := There were undefined references.
+
+# LaTeX処理
+# ログファイルに警告がある場合は警告がなくなるまで、最大CNTで指定された回数分、処理を実行する
+CNT := 3
-# logファイルに相互参照または目次ファイルなしの警告がある場合、LaTeX処理を繰り返す
-# 2回目以降の処理で相互参照未定義の警告がある場合と、
-# 繰り返しの回数がMAX_CNTになった場合は、警告を表示してエラー終了
COMPILES.tex = \
- cnt=0; \
- while $(GREP) -F -e $(WARN_REF) -e $(WARN_NOFILE) $(addsuffix .log,$(basename $<)); do \
- if test $$cnt -ge $(MAX_CNT); then \
- $(ECHO) "LaTeX compile is over $$cnt times, but warnings exist."; \
- exit 1; \
- fi; \
- $(COMPILE.tex); \
- if test $$cnt -eq 1 && $(GREP) -F $(WARN_UNDEFREF) $(addsuffix .log,$(basename $<)); then \
- exit 1; \
- fi; \
- cnt=`expr $$cnt + 1`; \
- done
-
-# \includeコマンドで読み込まれるtexファイル
-intex = $(addsuffix .tex,$(basename $(strip $(shell \
- $(SED) -n -e 's/\\\(include\|input\)\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/gp' $< | \
- $(SED) -e 's/.*{\([^}]*\)}.*/\1/'))))
-
-# \includegraphicsコマンドで読み込まれるグラフィックファイル
-ingraphics = $(strip $(shell \
- $(SED) -n -e 's/\\includegraphics\(\[[^]]*\]\)\{0,1\}\({[^}]*}\)/&\n/gp' $< $(intex) | \
- $(SED) -e 's/.*{\([^}]*\)}.*/\1/'))
-
-# \bibliographyコマンドで読み込まれる文献データベースファイル
-bibdb = $(addsuffix .bib,$(basename $(strip $(shell \
- $(SED) -n -e 's/\\bibliography\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}/&\n/gp' $< $(intex) | \
- $(SED) -e 's/.*{\([^}]*\)}.*/\1/' | \
- $(SED) -e 's/,/ /g'))))
-
-# texファイルに索引作成の指定があるか確認
-MAKEINDEX := '\makeindex'
-GREP-makeindex = $(GREP) -F $(MAKEINDEX) $<
-
-# 依存関係を自動生成し、dファイルに格納
-%.d: %.tex
- @$(ECHO) '$@ is created by scanning $^.'
- # texファイルの依存関係
- @(($(ECHO) '$(subst .tex,.dvi,$<) $(subst .tex,.aux,$<) $(subst .tex,.d,$<): $<'; \
- $(ECHO); \
- $(ECHO) '$(subst .tex,.prev_aux,$<):') >$@)
- # Include/Inputファイルの依存関係
- $(if $(intex),@( \
+ for i in `$(SEQ) 1 $(CNT)`; do $(GREP) -F "$(WARN_UNDEFREF)" $(BASE).log && $(COMPILE.tex) || (test $$? -eq 1 && exit 0 || exit $$?); done
+
+# DVI -> PDF
+# 出力結果は.logファイルへ出力
+DVIPDFCMD = $(DVIPDFMX) $(DVIPDFMXFLAG) $(BASE).dvi
+COMPILE.dvi = \
+ $(ECHO) $(DVIPDFCMD); $(DVIPDFCMD) >>$(BASE).log 2>&1 || \
+ ($(SED) -n -e '/^Output written on toc_hyperref.dvi/,$$p' $(BASE).log; exit 1)
+
+######################################################################
+# .dファイルの生成と読み込み
+# .dファイルには、LaTeX処理での依存関係が記述される
+######################################################################
+
+# .flsファイルから、INPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
+# 取得は、1回のmake実行につき1回だけ行われる
+INPUTFILES = $(INPUTFILESre)
+
+INPUTFILESre = $(eval INPUTFILES := \
+ $(sort $(filter-out $(BASE).tex $(BASE).aux, $(shell \
+ $(SED) -n -e 's/^INPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
+ $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
+ ))))
+
+# .flsファイルから、OUTPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
+# 取得は、1回のmake実行につき1回だけ行われる
+OUTPUTFILES = $(OUTFILESre)
+
+OUTFILESre = $(eval OUTPUTFILES := \
+ $(sort $(filter-out $(BASE).aux $(BASE).dvi $(BASE).log,$(shell \
+ $(SED) -n -e 's/^OUTPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
+ $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
+ ))))
+
+# $(BASE).texで読み込まれる中間ファイルを.flsから取得する
+# .idxは、.indへ置換
+LATEXINTFILES = \
+ $(sort $(subst .idx,.ind, \
+ $(filter $(addprefix $(BASE),$(LATEXINTEXT)),$(INPUTFILES) $(OUTPUTFILES)) \
+ ))
+
+LATEXINTFILES_PREV = $(addsuffix _prev,$(LATEXINTFILES))
+
+# \includeや\inputで読み込まれるTeXファイルを.flsから取得する
+TEXFILES = $(filter %.tex,$(INPUTFILES))
+
+# \includegraphicsで読み込まれる画像ファイルを$(BASE).texと$(TEXFILES)、および.flsファイルから取得する
+GRAPHICFILES = $(GRAPHICFILESre)
+
+GRAPHICFILESre = $(eval GRAPHICFILES := \
+ $(sort \
+ $(shell \
+ $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
+ $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+ $(SED) -e 's/\\verb|[^|]*|//g' | \
+ $(SED) -e 's/}/}%/g' | $(SED) -e 'y/}%/}\n/' | \
+ $(SED) -n -e 's/.*\\includegraphics\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}$$/\2/pg' \
+ ) \
+ $(filter $(addprefix %,$(GRAPHICSEXT)),$(INPUTFILES)) \
+ ))
+
+# .flsから取得した、そのほかの読み込みファイル(.styなど)
+OTHERFILES = $(sort $(filter-out %.aux $(LATEXINTFILES) $(TEXFILES) $(GRAPHICFILES),$(INPUTFILES)))
+
+# \bibliography命令で読み込まれる文献データベースファイルをTeXファイルから検索する
+BIBDB = $(BIBDBre)
+
+BIBDBre = $(eval BIBDB := \
+ $(addsuffix .bib,$(basename $(sort $(shell \
+ $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
+ $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+ $(SED) -e 's/}/}%/g' | $(SED) -e 'y/}%/}\n/' | \
+ $(SED) -n -e 's/.*\\bibliography\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}$$/\2/pg' | \
+ $(SED) -e 's/,/ /g' \
+ )))))
+
+# .flsファイル作成用の一時ディレクトリー
+FLSDIR := .fls.temp
+
+# $(BASE).flsファイルの作成
+FLSCMD = $(LATEX) -interaction=nonstopmode -recorder -output-directory=$(FLSDIR) $(BASE).tex
+
+GENERETE.fls = \
+ test ! -e $(FLSDIR) && $(MKDIR) $(FLSDIR); \
+ $(FLSCMD) 1>/dev/null 2>&1; \
+ $(SED) -e 's|$(FLSDIR)/||g' $(FLSDIR)/$(BASE).fls >$(BASE).fls; \
+ test -e $(BASE).fls && \
+ ($(ECHO) '$(BASE).fls is generated.'; $(RM) -r $(FLSDIR)) || \
+ ($(ECHO) '$(BASE).fls is not generated.' 1>&2; exit 1)
+
+# 依存関係を.dファイルに書き出す
+%.d: %.fls
+ # Makefile変数の展開
+ @$(foreach i,0 1,$(ECHO) "Makefiles variable -- LATEXINTFILES=$(LATEXINTFILES) TEXFILES=$(TEXFILES) GRAPHICFILES=$(GRAPHICFILES) BIBDB=$(BIBDB)" $(if $(filter 0,$i),>/dev/null);)
+ # .dファイルの依存関係
+ @$(ECHO) '$(BASE).d: $(BASE).tex $(BASE).fls' >$@
+ # 中間ファイルの依存関係
+ $(if $(sort $(LATEXINTFILES) $(BIBDB)),@( \
+ $(ECHO); \
+ $(ECHO) '# LaTeX Intermediate Files'; \
+ $(ECHO) '#'; \
+ $(ECHO) '# $$(COMPILE.tex) := $(LATEXCMD)'; \
+ $(ECHO) '# $$(COMPILES.tex) := $(subst $(COMPILE.tex),$(LATEXCMD),$(COMPILES.tex))'; \
+ $(ECHO) '#'; \
+ $(ECHO) '$(BASE).dvi:: $(sort $(LATEXINTFILES_PREV) $(if $(BIBDB),$(BASE).bbl_prev))'; \
+ $(ECHO) ' @$$(COMPILE.tex)'; \
$(ECHO); \
- $(ECHO) '# Include/Input Files - tex'; \
- $(ECHO) '$(subst .tex,.dvi,$<) $(subst .tex,.aux,$<): $(intex)') >>$@)
- # 画像ファイルの依存関係
- $(if $(ingraphics),@( \
+ $(ECHO) '$(BASE).dvi:: $(BASE).aux'; \
+ $(ECHO) ' @$$(COMPILES.tex)'; \
+ ) >>$@)
+ # \includeや\inputで読み込まれるTeXファイルの依存関係
+ $(if $(TEXFILES),@( \
$(ECHO); \
- $(ECHO) '# IncludeGraphic Files - pdf, jpeg/jpg, png & xbb'; \
- $(ECHO) '$(subst .tex,.dvi,$<) $(subst .tex,.aux,$<): $(ingraphics)'; \
+ $(ECHO) '# Files called from \include or \input - .tex'; \
+ $(ECHO) '$(BASE).aux: $(TEXFILES)'; \
+ ) >>$@)
+ # 画像ファイルの依存関係
+ $(if $(GRAPHICFILES),@( \
$(ECHO); \
- $(ECHO) '$(subst .tex,.dvi,$<) $(subst .tex,.aux,$<): $(addsuffix .xbb,$(basename $(ingraphics)))') >>$@)
- # 文献処理用ファイルの依存関係
- $(if $(bibdb),@( \
- $(ECHO); \
- $(ECHO) '# Bibliography Files - bbl & bib'; \
- $(ECHO) '$(subst .tex,.dvi,$<): $(subst .tex,.bbl,$<)'; \
- $(ECHO); \
- $(ECHO) '$(subst .tex,.bbl,$<): $(bibdb)') >>$@)
- # 索引作成用ファイルの依存関係
- $(if $(strip $(shell $(GREP-makeindex))),@( \
- $(ECHO); \
- $(ECHO) '# MakeIndex Files - ind'; \
- $(ECHO) '$(subst .tex,.idx,$<):'; \
- $(ECHO); \
- $(ECHO) '$(subst .tex,.ind,$<):'; \
- $(ECHO); \
- $(ECHO) '$(subst .tex,.dvi,$<): $(subst .tex,.ind,$<)') >>$@)
-
-# 変数TARGETSで指定されたターゲットファイルに対応するdファイルをインクルード
-# .dファイルからヘッダファイルの依存関係を取得する
-# ターゲットに clean が含まれている場合は除く
-ifeq (,$(filter %clean,$(MAKECMDGOALS)))
- -include $(addsuffix .d,$(basename $(TARGETS)))
+ $(ECHO) '# IncludeGraphic Files - .pdf, .eps, .jpeg/.jpg, .png'; \
+ $(ECHO) '# .xbb Files - .pdf, .jpeg/.jpg, .png'; \
+ $(ECHO) '$(BASE).aux: $(GRAPHICFILES)'; \
+ $(if $(filter-out %.eps,$(GRAPHICFILES)), \
+ $(ECHO); \
+ $(ECHO) '$(BASE).aux: $(addsuffix .xbb,$(basename $(filter-out %.eps,$(GRAPHICFILES))))'; \
+ ) \
+ ) >>$@)
+ # 文献リストファイルの依存関係
+ $(if $(BIBDB),@( \
+ $(ECHO); \
+ $(ECHO) '# Bibliography files: .aux, BIBDB -> .bbl -> .div'; \
+ $(ECHO) '$(BASE).bbl: $(BIBDB) $(BASE).tex'; \
+ ) >>$@)
+ # そのほかのファイル(TEXMFROOT以外にあるスタイルファイルなど)の依存関係
+ $(if $(OTHERFILES),@( \
+ $(ECHO); \
+ $(ECHO) '# Other files'; \
+ $(ECHO) '$(BASE).aux: $(OTHERFILES)'; \
+ ) >>$@)
+ @$(ECHO) '$@ is generated by scanning $(BASE).tex and $(BASE).fls.'
+
+# 変数TEXTARGETSで指定されたターゲットファイルに対応する
+# .dファイルをインクルードし、依存関係を取得する
+# ターゲット末尾に clean、.xbb、.tex、.d が含まれている場合は除く
+ifeq (,$(filter %clean %.xbb %.tex %.d %.fls %.fls_prev,$(MAKECMDGOALS)))
+ -include $(addsuffix .d,$(basename $(TEXTARGETS)))
endif
-# 相互参照ファイル作成。dviファイルも同時に作成される
-%.aux: %.tex
- $(COMPILE.tex)
+######################################################################
+# dviおよびPDFファイルを生成するパターンルール
+# TeX -> dvi -> PDF
+######################################################################
-%.prev_aux: %.aux
- -$(CMP) $@ $< || $(CP) $< $@
+# TeX -> aux
+%.aux: %.tex
+ @$(COMPILE.tex)
-# dviファイル作成
+# aux -> dvi
%.dvi: %.aux
- $(COMPILES.tex)
+ @$(COMPILES.tex)
+
+# tex -> dvi
+%.dvi: %.tex
+ @$(COMPILE.tex)
+ @$(COMPILES.tex)
+
+# dvi -> PDF
+%.pdf: %.dvi
+ @$(COMPILE.dvi)
+
+######################################################################
+# ファイルリストファイル(.fls)作成
+######################################################################
+
+%.fls: %.tex
+ @-$(GENERETE.fls)
+
+######################################################################
+# LaTeX中間ファイルを生成するパターンルール
+######################################################################
+
+# ターゲットファイルと必須ファイルを比較し、内容が異なる場合はターゲットファイルの内容を必須ファイルに置き換える
+CMPPREV = $(CMP) $@ $< && $(ECHO) '$@ is up to date.' || $(CP) -p -v $< $@
+
+# 図リスト
+%.lof: %.tex
+ @$(MAKE) -s $(BASE).aux
+
+%.lof_prev: %.lof
+ @$(CMPPREV)
+
+# 表リスト
+%.lot: %.tex
+ @$(MAKE) -s $(BASE).aux
+
+%.lot_prev: %.lot
+ @$(CMPPREV)
+
+# PDFブックマーク
+%.out: %.tex
+ @$(MAKE) -s $(BASE).aux
+
+%.out_prev: %.out
+ @$(CMPPREV)
+
+# 目次
+%.toc: %.tex
+ @$(MAKE) -s $(BASE).aux
-# 文献処理用ファイル作成
-# BiBTeXで文献処理するときに使用される
-%.bbl: %.prev_aux
- $(BIBTEX) $(BIBTEXFLAG) $(subst .prev_aux,aux,$<)
+%.toc_prev: %.toc
+ @$(CMPPREV)
-# バウンディング情報ファイル作成
-# dvipdfmxで図を挿入するときに使用される
-# pdf、jpeg/jpg、pngファイルに対応
+######################################################################
+# 索引用中間ファイルを生成するパターンルール
+######################################################################
+
+# 索引用中間ファイル作成コマンド
+MENDEXCMD = $(MENDEX) $(MENDEXFLAG) $(BASE).idx
+
+COMPILE.idx = $(ECHO) $(MENDEXCMD); $(MENDEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).ilg; exit 1)
+
+# .tex -> .idx
+%.idx: %.tex
+ @$(MAKE) -s $(BASE).aux
+
+%.idx_prev: %.idx
+ @$(CMPPREV)
+
+# .idx -> .ind
+%.ind: %.idx_prev
+ @$(COMPILE.idx)
+
+%.ind_prev: %.ind
+ @$(CMPPREV)
+
+######################################################################
+# 文献リスト用中間ファイルを生成するパターンルール
+######################################################################
+# 文献リスト用中間ファイル作成コマンド
+BIBTEXCMD = $(BIBTEX) $(BIBTEXFLAG) $(BASE).aux
+
+COMPILE.bib = $(ECHO) $(BIBTEXCMD); $(BIBTEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).blg; exit 1)
+
+# TeX -> .aux -> .bib
+%.bbl: %.tex
+ @$(MAKE) -s $(BASE).aux
+ @$(COMPILE.bib)
+
+%.bbl_prev: %.bbl
+ @$(CMPPREV)
+
+######################################################################
+# バウンディング情報ファイルを生成するパターンルール
+######################################################################
%.xbb: %.pdf
$(EXTRACTBB) $(EXTRACTBBFLAGS) $<
%.xbb: %.png
$(EXTRACTBB) $(EXTRACTBBFLAGS) $<
-# 索引ファイル作成
-# 索引を作成するときに使用される
-%.idx: %.aux
- $(COMPILE.tex)
+%.xbb: %.bmp
+ $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
-%.prev_idx: %.idx
- -$(CMP) $@ $< || $(CP) $< $@
+######################################################################
+# ターゲット
+######################################################################
-%.ind: %.prev_idx
- $(MENDEX) $(MENDEXFLAG) $(subst .prev_idx,.idx,$<)
+# 警告
+tex-warn:
+ @$(ECHO) "check current directory, or set TEXTARGET in Makefile."
-# PDFファイル作成
-%.pdf: %.dvi
- $(DVIPDFMX) $(DVIPDFMXFLAG) $<
+# すべての画像ファイルに対してextractbbを実行
+tex-xbb:
+ $(MAKE) -s $(addsuffix .xbb,$(basename $(wildcard $(addprefix *,$(GRAPHICSEXT)))))
-# tex-cleanターゲット
+# 中間ファイルの削除
tex-clean:
- $(RM) *.aux *.bbl *.blg *.idx *.ilg *.ind *.lof *.lot *.out *.toc *.xbb *.log *.d
+ $(RM) $(addprefix *,$(ALLINTEXT))
+ $(RM) -r $(FLSDIR)
+ifeq (,$(filter %.dvi,$(TEXTARGETS)))
+ $(RM) *.dvi
+endif
-# tex-distcleanターゲット
-tex-distclean: tex-clean
- $(RM) $(addsuffix .dvi,$(basename $(TARGETS))) $(addsuffix .pdf,$(basename $(TARGETS)))
+# .xbbファイルの削除
+tex-xbb-clean:
+ $(RM) *.xbb
+
+# 生成されたすべてのファイルの削除
+tex-distclean: tex-clean tex-xbb-clean
+ifneq (,$(filter %.dvi,$(TEXTARGETS)))
+ $(RM) *.dvi
+endif
+ $(RM) $(TEXTARGETS)