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