makeで現在のTeXファイル、make allで全バージョンのTeXファイルをそれぞれ処理するよう仕様変更
[makefiles.git] / latex_mk / latex.mk
1 # latex.mk
2 # LaTeX処理(コンパイル)を行う
3 #
4 # == 使い方 ==
5 # 1. texソースファイルと同じディレクトリーに本ファイル(latex.mk)をコピーする
6 # 2. Makefileに変数TEXTARGETS と「include latex.mk」を記述する
7 # 3. texソースファイルと同じディレクトリーで、make コマンドを実行する
8 #
9 # == 機能 ==
10 # - 読み込むべき中間ファイルがないことや相互参照未定義の警告がある場合、LaTeX処理を最大4回繰り返す
11 # - \includegraphics命令がTeXファイルに含まれる場合、グラフィックファイルを挿入
12 #   -- 挿入されたグラフィックファイルが更新されたときは、処理を開始
13 #   -- 挿入されたグラフィックファイルがないときは、処理を中止
14 #   -- 挿入されたグラフィックファイルに対するバウンディング情報ファイル(.xbb)を作成
15 # - \include、\input命令がTeXファイルに含まれる場合、TeXファイルを挿入
16 #   -- 挿入されたTeXファイルが更新されたときは、処理を開始
17 #   -- 挿入されたTeXファイルがないときは、処理を中止
18 # - \makeindex命令が含まれる場合、mendexで索引を作成
19 # - \bibliography命令が含まれる場合、BiBTeXで文献一覧を作成
20 #
21 # == 擬似ターゲット ==
22 # - tex-clean: TeX中間ファイル(auxなど)を削除。ターゲットに.dviが含まれていないときは.dviファイルを削除
23 # - xbb-clean: バウンディング情報ファイル(.xbb)を削除
24 # - tex-distclean: TeX中間ファイル、バウンディング情報ファイル、ターゲットファイル(PDF、.dvi)を削除
25 #
26 # === Makefile -- sample ===
27 # TEXTARGETS := report.tex
28 #
29 # all: $(TEXTARGETS)
30 #
31 # include latex.mk
32
33 #debug
34 #SHELL = /bin/sh -x
35
36 .PHONY: tex-warning tex-clean tex-distclean
37
38 # シェルコマンド
39 CAT := cat
40 CMP := cmp -s
41 CP := cp
42 ECHO := /bin/echo
43 GREP := grep
44 SED := sed
45 SEQ := seq
46
47 # LaTeXコマンド
48 LATEX := platex
49 DVIPDFMX := dvipdfmx
50 EXTRACTBB := extractbb
51 BIBTEX := pbibtex
52 MENDEX := mendex
53 KPSEWHICH := kpsewhich
54
55 #LaTeXオプション
56 LATEXFLAG ?=
57 DVIPDFMXFLAG ?=
58 EXTRACTBBFLAGS ?=
59 BIBTEXFLAG ?=
60 MENDEXFLAG ?=
61
62 tex-warning:
63         @$(ECHO) "check current directory, or set TEXTARGET in Makefile."
64
65 # ファイル名から拡張子を除いた部分
66 BASE = $(basename $<)
67
68 # TeX中間ファイルの拡張子
69 #   .aux: 相互参照
70 #   .fls: tex -recorderで生成されるファイルリスト
71 #   .lof: 図リスト(\tableoffigures)
72 #   .lot: 表リスト(\tableoftables)
73 #   .out: hyperrefパッケージ
74 #   .toc: 目次(\tableofcontents)
75 #   .log: ログ
76 TEX_INT := .aux .lof .lot .out .toc .log
77 # 索引中間ファイルの拡張子
78 #   .idx: auxから作成
79 #   .ind: idxから作成
80 #   .ilg: 索引ログ
81 IND_INT := .idx .ind .ilg
82 # BiBTeX中間ファイルの拡張子
83 #   .bbl: auxから作成
84 #   .blg: BiBTeXログ
85 BIB_INT := .bbl .blg
86
87 ALL_INTERFILES = $(addprefix *,$(TEX_INT) $(IND_INT) $(BIB_INT) .fls .d .*_prev)
88
89 .SECONDARY: $(wildcard ALL_INTERFILES)
90
91 # ファイル名から拡張子を除いた部分
92 BASE = $(basename $<)
93
94 # .flsファイルから、INPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
95 INPUTFILES = $(INPUTFILESre)
96
97 INPUTFILESre = $(eval INPUTFILES := \
98   $(sort $(filter-out $(BASE).tex $(BASE).aux, $(shell \
99     $(SED) -n -e 's/^INPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
100     $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
101   ))))
102
103 # .flsファイルから、OUTPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
104 OUTPUTFILES =  $(OUTFILESre)
105
106 OUTFILESre = $(eval OUTPUTFILES := \
107   $(sort $(filter-out $(BASE).aux $(BASE).dvi $(BASE).log,$(shell \
108     $(SED) -n -e 's/^OUTPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
109     $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
110   ))))
111
112 # $(BASE).texで使われるLaTeX中間ファイル
113 INTERFILES = \
114   $(sort $(subst .idx,.ind, \
115     $(filter $(addprefix $(BASE),.lof .lot .out .toc .idx .ind .bbl),$(INPUTFILES) $(OUTPUTFILES)) \
116   ))
117
118 INTERFILES_PREV = $(addsuffix _prev,$(INTERFILES))
119
120 # TeXファイル - .tex
121 TEXFILES = $(filter %.tex,$(INPUTFILES))
122
123 # 画像ファイル - .pdf、.eps、.jpg/jpeg、.png、および.xbb
124 GRAPHICFILES = $(GRAPHICFILESre)
125
126 GRAPHICFILESre =  $(eval GRAPHICFILES := \
127   $(sort $(shell \
128       $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
129       $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
130       $(SED) -n -e 's/\\includegraphics\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
131       $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' \
132     ) \
133     $(filter %.pdf %.eps %.jpeg %.jpg %.png %.bmp,$(INPUTFILES)) \
134   ))
135
136 # そのほかの読み込みファイル
137 OTHERFILES = $(OTHERFILESre)
138
139 OTHERFILESre = $(eval OTHERFILES := \
140   $(sort $(filter-out %.aux $(INTERFILES) $(TEXFILES) $(GRAPHICFILES),$(INPUTFILES))))
141
142 # \bibliography命令で読み込まれる文献データベースファイルをTeXファイルから検索する
143 BIBDB = $(BIBDBre)
144
145 BIBDBre = $(eval BIBDB := \
146   $(addsuffix .bib,$(basename $(sort $(shell \
147      $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
148      $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
149      $(SED) -n -e 's/\\bibliography\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
150      $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' | \
151      $(SED) -e 's/,/ /g' \
152    )))))
153
154 # LaTeX処理(コンパイル)
155 LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(BASE).tex
156 COMPILE.tex = $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).log; exit 1)
157
158 FLSCMD = $(LATEX) -interaction=nonstopmode -recorder $(BASE).tex
159 CREATE.fls = \
160   $(ECHO) $(FLSCMD); $(FLSCMD) 1>/dev/null 2>&1; \
161   $(RM) $(addprefix $(BASE),$(TEX_INT) $(IND_INT) $(BIB_INT) .dvi)
162
163 # 相互参照未定義の警告
164 WARN_UNDEFREF := 'There were undefined references\.'
165
166 # LaTeX処理
167 # ログファイルに警告がある場合は警告がなくなるまで、最大CNTで指定された回数分、処理を実行する
168 CNT := 3
169 COMPILES.tex = \
170   @(for i in `$(SEQ) 1 $(CNT)`; do \
171       if test -s $@ -a -s $(BASE).log; then \
172         $(GREP) -e $(WARN_UNDEFREF) $(BASE).log || exit 0; \
173       else \
174         $(ECHO) '$@ and/or $(BASE).log does not exist.'; \
175       fi; \
176       $(COMPILE.tex); \
177     done)
178
179 # DVI -> PDF
180 # 出力結果は.logファイルへ出力
181 DVIPDFCMD = $(DVIPDFMX) $(DVIPDFMXFLAG) $(BASE).dvi
182 COMPILE.dvi = $(ECHO) $(DVIPDFCMD); $(DVIPDFCMD) >>$(BASE).log 2>&1 || ($(CAT) $(BASE).log; exit 1)
183
184 # 索引中間ファイル(.ind)作成
185 MENDEXCMD = $(MENDEX) $(MENDEXFLAG) $(BASE).idx
186 COMPILE.idx = $(ECHO) $(MENDEXCMD); $(MENDEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).ilg; exit 1)
187
188 # 文献リスト中間ファイル(.bbl)作成
189 BIBTEXCMD = $(BIBTEX) $(BIBTEXFLAG) $(BASE).aux
190 COMPILE.bib = $(ECHO) $(BIBTEXCMD); $(BIBTEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).blg; exit 1)
191
192 # ターゲットファイルと必須ファイルを比較し、内容が異なる場合はターゲットファイルの内容を必須ファイルに置き換える
193 CMPPREV = $(CMP) $@ $< || $(CP) -p -v $< $@
194
195 # 依存関係を.dファイルに書き出す
196 %.d: %.fls
197         @$(ECHO) '$@ is created by scanning $(BASE).tex and $(BASE).fls.'
198     # .dファイルの依存関係
199         @$(ECHO) '$(BASE).d: $(BASE).tex $(BASE).fls' >$@
200     # \includeまたは\input命令で読み込まれるTeXファイルの依存関係
201         $(if $(TEXFILES),@( \
202       $(ECHO); \
203       $(ECHO) '# Files called from \include or \input - .tex'; \
204       $(ECHO) '$(BASE).aux: $(TEXFILES)'; \
205     ) >>$@)
206     # そのほかのファイル(TEXMFROOT以外にあるスタイルファイルなど)の依存関係
207         $(if $(OTHERFILES),@( \
208       $(ECHO); \
209       $(ECHO) '# Other files'; \
210       $(ECHO) '$(BASE).aux: $(OTHERFILES)'; \
211     ) >>$@)
212     # 画像ファイルの依存関係
213         $(if $(GRAPHICFILES),@( \
214       $(ECHO); \
215       $(ECHO) '# IncludeGraphic Files - .pdf, .eps, .jpeg/.jpg, .png'; \
216       $(ECHO) '#           .xbb Files - .pdf, .jpeg/.jpg, .png'; \
217       $(ECHO) '$(BASE).aux: $(GRAPHICFILES)'; \
218       $(if $(filter-out %.eps,$(GRAPHICFILES)), \
219         $(ECHO); \
220         $(ECHO) '$(BASE).aux: $(addsuffix .xbb,$(basename $(filter-out %.eps,$(GRAPHICFILES))))'; \
221       ) \
222     ) >>$@)
223     # 文献処理用ファイルの依存関係
224         $(if $(BIBDB),@( \
225         $(ECHO); \
226         $(ECHO) '# Bibliography files: .aux, BIBDB -> .bbl -> .div'; \
227         $(ECHO) '$(BASE).bbl: $(BIBDB) $(BASE).tex'; \
228       ) >>$@)
229     # 中間ファイルの依存関係
230         $(if $(sort $(INTERFILES) $(BIBDB)),@( \
231       $(ECHO); \
232       $(ECHO) '# LaTeX Intermediate Files'; \
233       $(ECHO) '$(BASE).dvi:: $(sort $(INTERFILES_PREV) $(if $(BIBDB),$(BASE).bbl_prev))'; \
234       $(ECHO) ' @$$(COMPILE.tex)'; \
235       $(ECHO); \
236       $(ECHO) '$(BASE).dvi:: $(BASE).aux'; \
237       $(ECHO) ' @$$(COMPILES.tex)'; \
238     ) >>$@)
239
240 # 変数TEXTARGETSで指定されたターゲットファイルに対応する
241 # .dファイルをインクルードし、依存関係を取得する
242 # ターゲット末尾に clean、.xbb、.tex、.d が含まれている場合は除く
243 ifeq (,$(filter %clean %.xbb %.tex %.d %.fls %.fls_prev,$(MAKECMDGOALS)))
244   -include $(addsuffix .d,$(basename $(TEXTARGETS)))
245 endif
246
247 # auxファイル作成
248 %.aux: %.tex
249         @$(COMPILE.tex)
250
251 %.dvi: %.aux
252         @$(COMPILES.tex)
253
254 %.dvi: %.tex
255         @$(COMPILE.tex)
256         @$(COMPILES.tex)
257
258 # PDFファイル作成
259 %.pdf: %.dvi
260         @$(COMPILE.dvi)
261
262 # バウンディング情報ファイル作成
263 # pdf、jpeg/jpg、pngファイルに対応
264 extractbb:
265         $(MAKE) -s $(addsuffix .xbb,$(basename $(wildcard $(addprefix *,.pdf .jpg .jpeg .png))))
266
267 %.xbb: %.pdf
268         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
269
270 %.xbb: %.jpeg
271         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
272
273 %.xbb: %.jpg
274         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
275
276 %.xbb: %.png
277         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
278
279 # ファイル一覧作成
280 %.fls: %.tex
281         @-$(CREATE.fls)
282
283 %.fls_prev: %.fls
284         @$(CMPPREV)
285
286 # 目次中間ファイル作成
287 %.toc: %.tex
288         @$(MAKE) -s $(BASE).aux
289
290 %.toc_prev: %.toc
291         @$(CMPPREV)
292
293 # 図リスト中間ファイル作成
294 %.lof: %.tex
295         @$(MAKE) -s $(BASE).aux
296
297 %.lof_prev: %.lof
298         @$(CMPPREV)
299
300 # 表リスト中間ファイル作成
301 %.lot: %.tex
302         @$(MAKE) -s $(BASE).aux
303
304 %.lot_prev: %.lot
305         @$(CMPPREV)
306
307 # 索引中間ファイル作成
308 %.idx: %.tex
309         @$(MAKE) -s $(BASE).aux
310
311 %.idx_prev: %.idx
312         @$(CMPPREV)
313
314 %.ind: %.idx_prev
315         @$(COMPILE.idx)
316
317 %.ind_prev: %.ind
318         @$(CMPPREV)
319
320 # BiBTeX中間ファイル作成
321 %.bbl: %.tex
322         @$(MAKE) -s $(BASE).aux
323         @$(COMPILE.bib)
324
325 %.bbl_prev: %.bbl
326         @$(CMPPREV)
327
328 # hyperref中間ファイル作成
329 %.out: %.tex
330         @$(MAKE) -s $(BASE).aux
331
332 %.out_prev: %.out
333         @$(CMPPREV)
334
335 # tex-cleanターゲット
336 tex-clean:
337         $(RM) $(ALL_INTERFILES)
338 ifeq (,$(filter %.dvi,$(TEXTARGETS)))
339         $(RM) *.dvi
340 endif
341
342 # xbb-cleanターゲット
343 xbb-clean:
344         $(RM) *.xbb
345
346 # tex-distcleanターゲット
347 tex-distclean: tex-clean xbb-clean
348 ifneq (,$(filter %.dvi,$(TEXTARGETS)))
349         $(RM) *.dvi
350 endif
351         $(RM) $(TEXTARGETS)