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 # - tex-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 # シェルスクリプトをデバッグするときは、DEBUGSH変数を設定してmakeを実行する
  34 # 例: DEBUGSH=1 make
  35 ifdef DEBUGSH
  36   SHELL := /bin/sh -x
  37 endif
  38
  39 .PHONY: tex-warn tex-xbb tex-clean tex-distclean
  40
  41 # シェルコマンド
  42 CAT := cat
  43 CMP := cmp -s
  44 CP := cp
  45 ECHO := /bin/echo
  46 GREP := grep
  47 MKDIR := mkdir
  48 SED := sed
  49 SEQ := seq
  50
  51 # LaTeXコマンド
  52 LATEX := platex
  53 DVIPDFMX := dvipdfmx
  54 EXTRACTBB := extractbb
  55 BIBTEX := pbibtex
  56 MENDEX := mendex
  57 KPSEWHICH := kpsewhich
  58
  59 #LaTeXオプション
  60 LATEXFLAG ?=
  61 DVIPDFMXFLAG ?=
  62 EXTRACTBBFLAGS ?=
  63 BIBTEXFLAG ?=
  64 MENDEXFLAG ?=
  65
  66 # .aux、.fls以外のTeX中間ファイルの拡張子
  67 #   .bbl: 文献リスト。作成方法はパターンルールで定義
  68 #   .glo: 用語集。\glossaryがあればTeX処理で生成
  69 #   .idx: 索引。\makeindexがあればTeX処理で生成
  70 #   .ind: 索引。作成方法はパターンルールで定義
  71 #   .lof: 図リスト。\listoffiguresがあればTeX処理で生成
  72 #   .lot: 表リスト。\listoftablesがあればTeX処理で生成
  73 #   .out: PDFブックマーク。hyperrefパッケージをbookmarksオプションtrue（初期値）で呼び出していれば、TeX処理で生成
  74 #   .toc: 目次。\tableofcontentsがあればTeX処理で生成
  75 LATEXINTEXT := .bbl .glo .idx .ind .lof .lot .out .toc
  76
  77 # ログファイル
  78 #   .log: TeXログ
  79 #   .ilg: 索引ログ
  80 #   .blg: BiBTeXログ
  81 LOGEXT := .log .ilg .blg
  82
  83 ALLINTEXT := .aux .dvi $(LATEXINTEXT) $(LOGEXT) .fls .d .*_prev
  84
  85 # make完了後、中間ファイルを残す
  86 .SECONDARY: $(foreach t,$(TEXTARGETS),$(addprefix $(basename $t),$(ALLINTEXT)))
  87
  88 # ファイル名から拡張子を除いた部分
  89 BASE = $(basename $<)
  90
  91 # .flsファイルから、INPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
  92 # 取得は、1回のmake実行につき1回だけ行われる
  93 INPUTFILES = $(INPUTFILESre)
  94
  95 INPUTFILESre = $(eval INPUTFILES := \
  96   $(sort $(filter-out $(BASE).tex $(BASE).aux, $(shell \
  97     $(SED) -n -e 's/^INPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
  98     $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
  99   ))))
 100
 101 # .flsファイルから、OUTPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
 102 # 取得は、1回のmake実行につき1回だけ行われる
 103 OUTPUTFILES =  $(OUTFILESre)
 104
 105 OUTFILESre = $(eval OUTPUTFILES := \
 106   $(sort $(filter-out $(BASE).aux $(BASE).dvi $(BASE).log,$(shell \
 107     $(SED) -n -e 's/^OUTPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
 108     $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
 109   ))))
 110
 111 # $(BASE).texで読み込まれる中間ファイルを$(BASE).flsから取得する
 112 # .idxは、.indへ置換
 113 LATEXINTFILES = \
 114   $(sort $(subst .idx,.ind, \
 115     $(filter $(addprefix $(BASE),$(LATEXINTEXT)),$(INPUTFILES) $(OUTPUTFILES)) \
 116   ))
 117
 118 LATEXINTFILES_PREV = $(addsuffix _prev,$(LATEXINTFILES))
 119
 120 # 分割され、\includeや\inputで読み込まれるTeXファイル - .tex
 121 TEXFILES = $(filter %.tex,$(INPUTFILES))
 122
 123 # 対応する画像ファイルの拡張子
 124 GRAPHICSEXT := .pdf .eps .jpg .jpeg .png .bmp
 125
 126 # $(BASE).texで読み込まれる画像ファイルを取得する
 127 GRAPHICFILES = $(GRAPHICFILESre)
 128
 129 GRAPHICFILESre = $(eval GRAPHICFILES := \
 130   $(sort \
 131     $(shell \
 132       $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
 133       $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
 134       $(SED) -e 's/\\verb|[^|]*|//g' | \
 135       $(SED) -e 's/}/}%/g' | $(SED) -e 'y/}%/}\n/' | \
 136       $(SED) -n -e 's/.*\\includegraphics\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}$$/\2/pg' \
 137     ) \
 138     $(filter $(addprefix %,$(GRAPHICSEXT)),$(INPUTFILES)) \
 139   ))
 140
 141 # そのほかの読み込みファイル
 142 OTHERFILES = $(sort $(filter-out %.aux $(LATEXINTFILES) $(TEXFILES) $(GRAPHICFILES),$(INPUTFILES)))
 143
 144 # \bibliography命令で読み込まれる文献データベースファイルをTeXファイルから検索する
 145 BIBDB = $(BIBDBre)
 146
 147 BIBDBre = $(eval BIBDB := \
 148   $(addsuffix .bib,$(basename $(sort $(shell \
 149       $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
 150       $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
 151       $(SED) -e 's/}/}%/g' | $(SED) -e 'y/}%/}\n/' | \
 152       $(SED) -n -e 's/.*\\bibliography\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}$$/\2/pg' | \
 153       $(SED) -e 's/,/ /g' \
 154    )))))
 155
 156 # LaTeX処理（コンパイル）
 157 LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(BASE).tex
 158 COMPILE.tex = $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || ($(SED) -n -e '/^!/,/^$$/p' $(BASE).log; exit 1)
 159
 160 # 相互参照未定義の警告
 161 WARN_UNDEFREF := 'There were undefined references\.'
 162
 163 # LaTeX処理
 164 # ログファイルに警告がある場合は警告がなくなるまで、最大CNTで指定された回数分、処理を実行する
 165 CNT := 3
 166 COMPILES.tex = \
 167   @(for i in `$(SEQ) 1 $(CNT)`; do \
 168       if test -s $@ -a -s $(BASE).log; then \
 169         $(GREP) -e $(WARN_UNDEFREF) $(BASE).log || exit 0; \
 170       else \
 171         $(ECHO) '$@ and/or $(BASE).log does not exist.'; \
 172       fi; \
 173       $(COMPILE.tex); \
 174     done)
 175
 176 # DVI -> PDF
 177 # 出力結果は.logファイルへ出力
 178 DVIPDFCMD = $(DVIPDFMX) $(DVIPDFMXFLAG) $(BASE).dvi
 179 COMPILE.dvi = \
 180   $(ECHO) $(DVIPDFCMD); $(DVIPDFCMD) >>$(BASE).log 2>&1 || \
 181   ($(SED) -n -e '/^Output written on toc_hyperref.dvi/,$$p' $(BASE).log; exit 1)
 182
 183 # ターゲットファイルと必須ファイルを比較し、内容が異なる場合はターゲットファイルの内容を必須ファイルに置き換える
 184 CMPPREV = $(CMP) $@ $< && $(ECHO) '$@ is up to date.' || $(CP) -p -v $< $@
 185
 186 ######################################################################
 187 # .dファイルの生成と読み込み
 188 # .dファイルには、LaTeX処理での依存関係が記述される
 189 ######################################################################
 190
 191 # .flsファイル作成用の一時ディレクトリー
 192 FLSDIR := .fls.temp
 193
 194 # $(BASE).flsファイルの作成
 195 FLSCMD = $(LATEX) -interaction=nonstopmode -recorder -output-directory=$(FLSDIR) $(BASE).tex
 196
 197 GENERETE.fls = \
 198   test ! -e $(FLSDIR) && $(MKDIR) $(FLSDIR); \
 199   $(FLSCMD) 1>/dev/null 2>&1; \
 200   $(SED) -e 's|$(FLSDIR)/||g' $(FLSDIR)/$(BASE).fls >$(BASE).fls; \
 201   test -e $(BASE).fls && \
 202     ($(ECHO) '$(BASE).fls is generated.'; $(RM) -r $(FLSDIR)) || \
 203     ($(ECHO) '$(BASE).fls is not generated.' 1>&2; exit 1)
 204
 205 # 依存関係を.dファイルに書き出す
 206 %.d: %.fls
 207     # 変数の展開
 208         @$(ECHO) "extract LATEXINTFILES:$(LATEXINTFILES) TEXFILES:$(TEXFILES) GRAPHICFILES:$(GRAPHICFILES) BIBDB:$(BIBDB)"
 209     # .dファイルの依存関係
 210         @$(ECHO) '$(BASE).d: $(BASE).tex $(BASE).fls' >$@
 211     # 中間ファイルの依存関係
 212         $(if $(sort $(LATEXINTFILES) $(BIBDB)),@( \
 213       $(ECHO); \
 214       $(ECHO) '# LaTeX Intermediate Files'; \
 215       $(ECHO) '$(BASE).dvi:: $(sort $(LATEXINTFILES_PREV) $(if $(BIBDB),$(BASE).bbl_prev))'; \
 216       $(ECHO) ' @$$(COMPILE.tex)'; \
 217       $(ECHO); \
 218       $(ECHO) '$(BASE).dvi:: $(BASE).aux'; \
 219       $(ECHO) ' @$$(COMPILES.tex)'; \
 220     ) >>$@)
 221     # \includeまたは\input命令で読み込まれるTeXファイルの依存関係
 222         $(if $(TEXFILES),@( \
 223       $(ECHO); \
 224       $(ECHO) '# Files called from \include or \input - .tex'; \
 225       $(ECHO) '$(BASE).aux: $(TEXFILES)'; \
 226     ) >>$@)
 227     # 画像ファイルの依存関係
 228         $(if $(GRAPHICFILES),@( \
 229       $(ECHO); \
 230       $(ECHO) '# IncludeGraphic Files - .pdf, .eps, .jpeg/.jpg, .png'; \
 231       $(ECHO) '#           .xbb Files - .pdf, .jpeg/.jpg, .png'; \
 232       $(ECHO) '$(BASE).aux: $(GRAPHICFILES)'; \
 233       $(if $(filter-out %.eps,$(GRAPHICFILES)), \
 234         $(ECHO); \
 235         $(ECHO) '$(BASE).aux: $(addsuffix .xbb,$(basename $(filter-out %.eps,$(GRAPHICFILES))))'; \
 236       ) \
 237     ) >>$@)
 238     # 文献処理用ファイルの依存関係
 239         $(if $(BIBDB),@( \
 240         $(ECHO); \
 241         $(ECHO) '# Bibliography files: .aux, BIBDB -> .bbl -> .div'; \
 242         $(ECHO) '$(BASE).bbl: $(BIBDB) $(BASE).tex'; \
 243       ) >>$@)
 244     # そのほかのファイル（TEXMFROOT以外にあるスタイルファイルなど）の依存関係
 245         $(if $(OTHERFILES),@( \
 246       $(ECHO); \
 247       $(ECHO) '# Other files'; \
 248       $(ECHO) '$(BASE).aux: $(OTHERFILES)'; \
 249     ) >>$@)
 250         @$(ECHO) '$@ is generated by scanning $(BASE).tex and $(BASE).fls.'
 251
 252 # 変数TEXTARGETSで指定されたターゲットファイルに対応する
 253 # .dファイルをインクルードし、依存関係を取得する
 254 # ターゲット末尾に clean、.xbb、.tex、.d が含まれている場合は除く
 255 ifeq (,$(filter %clean %.xbb %.tex %.d %.fls %.fls_prev,$(MAKECMDGOALS)))
 256   -include $(addsuffix .d,$(basename $(TEXTARGETS)))
 257 endif
 258
 259 ######################################################################
 260 # dviおよびPDFファイルを生成するパターンルール
 261 # TeX -> dvi -> PDF
 262 ######################################################################
 263
 264 # TeX -> aux
 265 %.aux: %.tex
 266         @$(COMPILE.tex)
 267
 268 # aux -> dvi
 269 %.dvi: %.aux
 270         @$(COMPILES.tex)
 271
 272 # tex -> dvi
 273 %.dvi: %.tex
 274         @$(COMPILE.tex)
 275         @$(COMPILES.tex)
 276
 277 # dvi -> PDF
 278 %.pdf: %.dvi
 279         @$(COMPILE.dvi)
 280
 281 ######################################################################
 282 # ファイルリストファイル（.fls）作成
 283 ######################################################################
 284
 285 %.fls: %.tex
 286         @-$(GENERETE.fls)
 287
 288 ######################################################################
 289 # LaTeX中間ファイルを生成するパターンルール
 290 ######################################################################
 291
 292 # 図リスト
 293 %.lof: %.tex
 294         @$(MAKE) -s $(BASE).aux
 295
 296 %.lof_prev: %.lof
 297         @$(CMPPREV)
 298
 299 # 表リスト
 300 %.lot: %.tex
 301         @$(MAKE) -s $(BASE).aux
 302
 303 %.lot_prev: %.lot
 304         @$(CMPPREV)
 305
 306 # PDFブックマーク
 307 %.out: %.tex
 308         @$(MAKE) -s $(BASE).aux
 309
 310 %.out_prev: %.out
 311         @$(CMPPREV)
 312
 313 # 目次
 314 %.toc: %.tex
 315         @$(MAKE) -s $(BASE).aux
 316
 317 %.toc_prev: %.toc
 318         @$(CMPPREV)
 319
 320 ######################################################################
 321 # 索引用中間ファイルを生成するパターンルール
 322 ######################################################################
 323
 324 # 索引用中間ファイル作成コマンド
 325 MENDEXCMD = $(MENDEX) $(MENDEXFLAG) $(BASE).idx
 326
 327 COMPILE.idx = $(ECHO) $(MENDEXCMD); $(MENDEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).ilg; exit 1)
 328
 329 # .tex -> .idx
 330 %.idx: %.tex
 331         @$(MAKE) -s $(BASE).aux
 332
 333 %.idx_prev: %.idx
 334         @$(CMPPREV)
 335
 336 # .idx -> .ind
 337 %.ind: %.idx_prev
 338         @$(COMPILE.idx)
 339
 340 %.ind_prev: %.ind
 341         @$(CMPPREV)
 342
 343 ######################################################################
 344 # 文献リスト用中間ファイルを生成するパターンルール
 345 ######################################################################
 346 # 文献リスト用中間ファイル作成コマンド
 347 BIBTEXCMD = $(BIBTEX) $(BIBTEXFLAG) $(BASE).aux
 348
 349 COMPILE.bib = $(ECHO) $(BIBTEXCMD); $(BIBTEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).blg; exit 1)
 350
 351 # TeX -> .aux -> .bib
 352 %.bbl: %.tex
 353         @$(MAKE) -s $(BASE).aux
 354         @$(COMPILE.bib)
 355
 356 %.bbl_prev: %.bbl
 357         @$(CMPPREV)
 358
 359 ######################################################################
 360 # バウンディング情報ファイルを生成するパターンルール
 361 ######################################################################
 362 %.xbb: %.pdf
 363         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 364
 365 %.xbb: %.jpeg
 366         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 367
 368 %.xbb: %.jpg
 369         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 370
 371 %.xbb: %.png
 372         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 373
 374 %.xbb: %.bmp
 375         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 376
 377 ######################################################################
 378 # ターゲット
 379 ######################################################################
 380
 381 # 警告
 382 tex-warn:
 383         @$(ECHO) "check current directory, or set TEXTARGET in Makefile."
 384
 385 # すべての画像ファイルに対してextractbbを実行
 386 tex-xbb:
 387         $(MAKE) -s $(addsuffix .xbb,$(basename $(wildcard $(addprefix *,$(GRAPHICSEXT)))))
 388
 389 # 中間ファイルの削除
 390 tex-clean:
 391         $(RM) $(addprefix *,$(ALLINTEXT))
 392         $(RM) -r $(FLSDIR)
 393 ifeq (,$(filter %.dvi,$(TEXTARGETS)))
 394         $(RM) *.dvi
 395 endif
 396
 397 # .xbbファイルの削除
 398 tex-xbb-clean:
 399         $(RM) *.xbb
 400
 401 # 生成されたすべてのファイルの削除
 402 tex-distclean: tex-clean tex-xbb-clean
 403 ifneq (,$(filter %.dvi,$(TEXTARGETS)))
 404         $(RM) *.dvi
 405 endif
 406         $(RM) $(TEXTARGETS)