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