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 ALLINTERFILES = $(addprefix *,.aux $(LATEXINTEXT) $(LOGEXT) .fls .d .*_prev)
  84
  85 # make完了後、中間ファイルを残す
  86 .SECONDARY: $(wildcard ALLINTERFILES)
  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 LATEXINTERFILES = \
 114   $(sort $(subst .idx,.ind, \
 115     $(filter $(addprefix $(BASE),$(LATEXINTEXT)),$(INPUTFILES) $(OUTPUTFILES)) \
 116   ))
 117
 118 LATEXINTERFILES_PREV = $(addsuffix _prev,$(LATEXINTERFILES))
 119
 120 # 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 = \
 143   $(sort $(filter-out %.aux $(LATEXINTERFILES) $(TEXFILES) $(GRAPHICFILES),$(INPUTFILES)))
 144
 145 # \bibliography命令で読み込まれる文献データベースファイルをTeXファイルから検索する
 146 BIBDB = $(BIBDBre)
 147
 148 BIBDBre = $(eval BIBDB := \
 149   $(addsuffix .bib,$(basename $(sort $(shell \
 150       $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
 151       $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
 152       $(SED) -e 's/}/}%/g' | $(SED) -e 'y/}%/}\n/' | \
 153       $(SED) -n -e 's/.*\\bibliography\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}$$/\2/pg' | \
 154       $(SED) -e 's/,/ /g' \
 155    )))))
 156
 157 # LaTeX処理（コンパイル）
 158 LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(BASE).tex
 159 COMPILE.tex = $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || ($(SED) -n -e '/^!/,/^$$/p' $(BASE).log; exit 1)
 160
 161 # 相互参照未定義の警告
 162 WARN_UNDEFREF := 'There were undefined references\.'
 163
 164 # LaTeX処理
 165 # ログファイルに警告がある場合は警告がなくなるまで、最大CNTで指定された回数分、処理を実行する
 166 CNT := 3
 167 COMPILES.tex = \
 168   @(for i in `$(SEQ) 1 $(CNT)`; do \
 169       if test -s $@ -a -s $(BASE).log; then \
 170         $(GREP) -e $(WARN_UNDEFREF) $(BASE).log || exit 0; \
 171       else \
 172         $(ECHO) '$@ and/or $(BASE).log does not exist.'; \
 173       fi; \
 174       $(COMPILE.tex); \
 175     done)
 176
 177 # DVI -> PDF
 178 # 出力結果は.logファイルへ出力
 179 DVIPDFCMD = $(DVIPDFMX) $(DVIPDFMXFLAG) $(BASE).dvi
 180 COMPILE.dvi = \
 181   $(ECHO) $(DVIPDFCMD); $(DVIPDFCMD) >>$(BASE).log 2>&1 || \
 182   ($(SED) -n -e '/^Output written on toc_hyperref.dvi/,$$p' $(BASE).log; exit 1)
 183
 184 # ターゲットファイルと必須ファイルを比較し、内容が異なる場合はターゲットファイルの内容を必須ファイルに置き換える
 185 CMPPREV = $(CMP) $@ $< || $(CP) -p -v $< $@
 186
 187 ######################################################################
 188 # .dファイルの生成と読み込み
 189 # .dファイルには、LaTeX処理での依存関係が記述される
 190 ######################################################################
 191
 192 # .flsファイル作成用の一時ディレクトリー
 193 FLSDIR := .fls.temp
 194
 195 # $(BASE).flsファイルの作成
 196 FLSCMD = $(LATEX) -interaction=nonstopmode -recorder -output-directory=$(FLSDIR) $(BASE).tex
 197
 198 GENERETE.fls = \
 199   test ! -e $(FLSDIR) && $(MKDIR) $(FLSDIR); \
 200   $(FLSCMD) 1>/dev/null 2>&1; \
 201   $(SED) -e 's|$(FLSDIR)/||g' $(FLSDIR)/$(BASE).fls >$(BASE).fls; \
 202   test -e $(BASE).fls && \
 203     ($(ECHO) '$(BASE).fls is generated.'; $(RM) -r $(FLSDIR)) || \
 204     ($(ECHO) '$(BASE).fls is not generated.' 1>&2; exit 1)
 205
 206 # 依存関係を.dファイルに書き出す
 207 %.d: %.fls
 208     # .dファイルの依存関係
 209         @$(ECHO) '$(BASE).d: $(BASE).tex $(BASE).fls' >$@
 210     # \includeまたは\input命令で読み込まれるTeXファイルの依存関係
 211         $(if $(TEXFILES),@( \
 212       $(ECHO); \
 213       $(ECHO) '# Files called from \include or \input - .tex'; \
 214       $(ECHO) '$(BASE).aux: $(TEXFILES)'; \
 215     ) >>$@)
 216     # そのほかのファイル（TEXMFROOT以外にあるスタイルファイルなど）の依存関係
 217         $(if $(OTHERFILES),@( \
 218       $(ECHO); \
 219       $(ECHO) '# Other files'; \
 220       $(ECHO) '$(BASE).aux: $(OTHERFILES)'; \
 221     ) >>$@)
 222     # 画像ファイルの依存関係
 223         $(if $(GRAPHICFILES),@( \
 224       $(ECHO); \
 225       $(ECHO) '# IncludeGraphic Files - .pdf, .eps, .jpeg/.jpg, .png'; \
 226       $(ECHO) '#           .xbb Files - .pdf, .jpeg/.jpg, .png'; \
 227       $(ECHO) '$(BASE).aux: $(GRAPHICFILES)'; \
 228       $(if $(filter-out %.eps,$(GRAPHICFILES)), \
 229         $(ECHO); \
 230         $(ECHO) '$(BASE).aux: $(addsuffix .xbb,$(basename $(filter-out %.eps,$(GRAPHICFILES))))'; \
 231       ) \
 232     ) >>$@)
 233     # 文献処理用ファイルの依存関係
 234         $(if $(BIBDB),@( \
 235         $(ECHO); \
 236         $(ECHO) '# Bibliography files: .aux, BIBDB -> .bbl -> .div'; \
 237         $(ECHO) '$(BASE).bbl: $(BIBDB) $(BASE).tex'; \
 238       ) >>$@)
 239     # 中間ファイルの依存関係
 240         $(if $(sort $(LATEXINTERFILES) $(BIBDB)),@( \
 241       $(ECHO); \
 242       $(ECHO) '# LaTeX Intermediate Files'; \
 243       $(ECHO) '$(BASE).dvi:: $(sort $(LATEXINTERFILES_PREV) $(if $(BIBDB),$(BASE).bbl_prev))'; \
 244       $(ECHO) ' @$$(COMPILE.tex)'; \
 245       $(ECHO); \
 246       $(ECHO) '$(BASE).dvi:: $(BASE).aux'; \
 247       $(ECHO) ' @$$(COMPILES.tex)'; \
 248     ) >>$@)
 249         @$(ECHO) '$@ is generated by scanning $(BASE).tex and $(BASE).fls.'
 250
 251 # 変数TEXTARGETSで指定されたターゲットファイルに対応する
 252 # .dファイルをインクルードし、依存関係を取得する
 253 # ターゲット末尾に clean、.xbb、.tex、.d が含まれている場合は除く
 254 ifeq (,$(filter %clean %.xbb %.tex %.d %.fls %.fls_prev,$(MAKECMDGOALS)))
 255   -include $(addsuffix .d,$(basename $(TEXTARGETS)))
 256 endif
 257
 258 ######################################################################
 259 # dviおよびPDFファイルを生成するパターンルール
 260 # TeX -> dvi -> PDF
 261 ######################################################################
 262
 263 # TeX -> aux
 264 %.aux: %.tex
 265         @$(COMPILE.tex)
 266
 267 # aux -> dvi
 268 %.dvi: %.aux
 269         @$(COMPILES.tex)
 270
 271 # tex -> dvi
 272 %.dvi: %.tex
 273         @$(COMPILE.tex)
 274         @$(COMPILES.tex)
 275
 276 # dvi -> PDF
 277 %.pdf: %.dvi
 278         @$(COMPILE.dvi)
 279
 280 ######################################################################
 281 # ファイルリストファイル（.fls）作成
 282 ######################################################################
 283
 284 %.fls: %.tex
 285         @-$(GENERETE.fls)
 286
 287 ######################################################################
 288 # LaTeX中間ファイルを生成するパターンルール
 289 ######################################################################
 290
 291 # 図リスト
 292 %.lof: %.tex
 293         @$(MAKE) -s $(BASE).aux
 294
 295 %.lof_prev: %.lof
 296         @$(CMPPREV)
 297
 298 # 表リスト
 299 %.lot: %.tex
 300         @$(MAKE) -s $(BASE).aux
 301
 302 %.lot_prev: %.lot
 303         @$(CMPPREV)
 304
 305 # PDFブックマーク
 306 %.out: %.tex
 307         @$(MAKE) -s $(BASE).aux
 308
 309 %.out_prev: %.out
 310         @$(CMPPREV)
 311
 312 # 目次
 313 %.toc: %.tex
 314         @$(MAKE) -s $(BASE).aux
 315
 316 %.toc_prev: %.toc
 317         @$(CMPPREV)
 318
 319 ######################################################################
 320 # 索引用中間ファイルを生成するパターンルール
 321 ######################################################################
 322
 323 # 索引用中間ファイル作成コマンド
 324 MENDEXCMD = $(MENDEX) $(MENDEXFLAG) $(BASE).idx
 325
 326 COMPILE.idx = $(ECHO) $(MENDEXCMD); $(MENDEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).ilg; exit 1)
 327
 328 # .tex -> .idx
 329 %.idx: %.tex
 330         @$(MAKE) -s $(BASE).aux
 331
 332 %.idx_prev: %.idx
 333         @$(CMPPREV)
 334
 335 # .idx -> .ind
 336 %.ind: %.idx_prev
 337         @$(COMPILE.idx)
 338
 339 %.ind_prev: %.ind
 340         @$(CMPPREV)
 341
 342 ######################################################################
 343 # 文献リスト用中間ファイルを生成するパターンルール
 344 ######################################################################
 345 # 文献リスト用中間ファイル作成コマンド
 346 BIBTEXCMD = $(BIBTEX) $(BIBTEXFLAG) $(BASE).aux
 347
 348 COMPILE.bib = $(ECHO) $(BIBTEXCMD); $(BIBTEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).blg; exit 1)
 349
 350 # TeX -> .aux -> .bib
 351 %.bbl: %.tex
 352         @$(MAKE) -s $(BASE).aux
 353         @$(COMPILE.bib)
 354
 355 %.bbl_prev: %.bbl
 356         @$(CMPPREV)
 357
 358 ######################################################################
 359 # バウンディング情報ファイルを生成するパターンルール
 360 ######################################################################
 361 %.xbb: %.pdf
 362         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 363
 364 %.xbb: %.jpeg
 365         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 366
 367 %.xbb: %.jpg
 368         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 369
 370 %.xbb: %.png
 371         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 372
 373 %.xbb: %.bmp
 374         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 375
 376 ######################################################################
 377 # ターゲット
 378 ######################################################################
 379
 380 # 警告
 381 tex-warn:
 382         @$(ECHO) "check current directory, or set TEXTARGET in Makefile."
 383
 384 # すべての画像ファイルに対してextractbbを実行
 385 tex-xbb:
 386         $(MAKE) -s $(addsuffix .xbb,$(basename $(wildcard $(addprefix *,$(GRAPHICSEXT)))))
 387
 388 # 中間ファイルの削除
 389 tex-clean:
 390         $(RM) $(ALLINTERFILES)
 391         $(RM) -r $(FLSDIR)
 392 ifeq (,$(filter %.dvi,$(TEXTARGETS)))
 393         $(RM) *.dvi
 394 endif
 395
 396 # .xbbファイルの削除
 397 tex-xbb-clean:
 398         $(RM) *.xbb
 399
 400 # 生成されたすべてのファイルの削除
 401 tex-distclean: tex-clean tex-xbb-clean
 402 ifneq (,$(filter %.dvi,$(TEXTARGETS)))
 403         $(RM) *.dvi
 404 endif
 405         $(RM) $(TEXTARGETS)