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 # === Makefile -- sample ===
  10 # TEXTARGETS := report.tex
  11 #
  12 # all: $(TEXTARGETS)
  13 #
  14 # include latex.mk
  15
  16 ######################################################################
  17 # 使用するシェルコマンドの定義
  18 ######################################################################
  19
  20 # シェルコマンド
  21 CAT := cat
  22 CMP := cmp -s
  23 CP := cp
  24 ECHO := /bin/echo
  25 GREP := grep
  26 MKDIR := mkdir
  27 SED := sed
  28 SEQ := seq
  29
  30 # LaTeXコマンド
  31 LATEX := platex
  32 DVIPDFMX := dvipdfmx
  33 EXTRACTBB := extractbb
  34 BIBTEX := pbibtex
  35 MENDEX := mendex
  36 KPSEWHICH := kpsewhich
  37
  38 # LaTeXオプション
  39 LATEXFLAG ?=
  40 DVIPDFMXFLAG ?=
  41 EXTRACTBBFLAGS ?=
  42 BIBTEXFLAG ?=
  43 MENDEXFLAG ?=
  44
  45 # シェルコマンドをデバッグするときは、DEBUGSH変数を設定してmakeを実行する
  46 # 例: DEBUGSH=1 make
  47 ifdef DEBUGSH
  48   SHELL := /bin/sh -x
  49 endif
  50
  51 ######################################################################
  52 # 拡張子
  53 ######################################################################
  54
  55 # .aux、.fls以外のLaTeX中間ファイルの拡張子
  56 #   .bbl: 文献リスト。作成方法はパターンルールで定義
  57 #   .glo: 用語集。\glossaryがあればTeX処理で生成
  58 #   .idx: 索引。\makeindexがあればTeX処理で生成
  59 #   .ind: 索引。作成方法はパターンルールで定義
  60 #   .lof: 図リスト。\listoffiguresがあればTeX処理で生成
  61 #   .lot: 表リスト。\listoftablesがあればTeX処理で生成
  62 #   .out: PDFブックマーク。hyperrefパッケージをbookmarksオプションtrue（初期値）で呼び出していれば、TeX処理で生成
  63 #   .toc: 目次。\tableofcontentsがあればTeX処理で生成
  64 LATEXINTEXT := .bbl .glo .idx .ind .lof .lot .out .toc
  65
  66 # ログファイルの拡張子
  67 #   .log: TeXログ
  68 #   .ilg: 索引ログ
  69 #   .blg: BiBTeXログ
  70 LOGEXT := .log .ilg .blg
  71
  72 # すべてのTeX中間ファイルの拡張子
  73 ALLINTEXT := .aux .dvi $(LATEXINTEXT) $(LOGEXT) .fls .d .*_prev
  74
  75 # 画像ファイルの拡張子
  76 GRAPHICSEXT := .pdf .eps .jpg .jpeg .png .bmp
  77
  78 # make完了後、中間ファイルを残す
  79 .SECONDARY: $(foreach t,$(TEXTARGETS),$(addprefix $(basename $t),$(ALLINTEXT)))
  80
  81 ######################################################################
  82 # TeX処理の定義
  83 ######################################################################
  84
  85 # ファイル名から拡張子を除いた部分
  86 BASE = $(basename $<)
  87
  88 # LaTeX処理（コンパイル）
  89 LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(BASE).tex
  90
  91 # エラー発生時、ログのエラー部分を行頭に「<TeXファイル名>:<行番号>:」を付けて表示する
  92 COMPILE.tex = \
  93   $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || \
  94   ( \
  95     $(SED) -n -e '/^!/,/^$$/p' $(BASE).log | \
  96     $(SED) -e 's/.*\s*l\(ine \|\.\)\([0-9]*\) .*/$(BASE).tex:\2: &/'; \
  97     exit 1)
  98
  99 # 相互参照未定義の警告
 100 WARN_UNDEFREF := There were undefined references.
 101
 102 # LaTeX処理
 103 # ログファイルに警告がある場合は警告がなくなるまで、最大CNTで指定された回数分、処理を実行する
 104 CNT := 3
 105
 106 COMPILES.tex = \
 107   for i in `$(SEQ) 1 $(CNT)`; do $(GREP) -F "$(WARN_UNDEFREF)" $(BASE).log && $(COMPILE.tex) || (test $$? -eq 1 && exit 0 || exit $$?); done
 108
 109 # DVI -> PDF
 110 # 出力結果は.logファイルへ出力
 111 DVIPDFCMD = $(DVIPDFMX) $(DVIPDFMXFLAG) $(BASE).dvi
 112 COMPILE.dvi = \
 113   $(ECHO) $(DVIPDFCMD); $(DVIPDFCMD) >>$(BASE).log 2>&1 || \
 114   ($(SED) -n -e '/^Output written on toc_hyperref.dvi/,$$p' $(BASE).log; exit 1)
 115
 116 ######################################################################
 117 # .dファイルの生成と読み込み
 118 # .dファイルには、LaTeX処理での依存関係が記述される
 119 ######################################################################
 120
 121 # .flsファイルから、INPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
 122 # 取得は、1回のmake実行につき1回だけ行われる
 123 INPUTFILES = $(INPUTFILESre)
 124
 125 INPUTFILESre = $(eval INPUTFILES := \
 126   $(sort $(filter-out $(BASE).tex $(BASE).aux, $(shell \
 127     $(SED) -n -e 's/^INPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
 128     $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
 129   ))))
 130
 131 # .flsファイルから、OUTPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
 132 # 取得は、1回のmake実行につき1回だけ行われる
 133 OUTPUTFILES =  $(OUTFILESre)
 134
 135 OUTFILESre = $(eval OUTPUTFILES := \
 136   $(sort $(filter-out $(BASE).aux $(BASE).dvi $(BASE).log,$(shell \
 137     $(SED) -n -e 's/^OUTPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
 138     $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
 139   ))))
 140
 141 # $(BASE).texで読み込まれる中間ファイルを.flsから取得する
 142 # .idxは、.indへ置換
 143 LATEXINTFILES = \
 144   $(sort $(subst .idx,.ind, \
 145     $(filter $(addprefix $(BASE),$(LATEXINTEXT)),$(INPUTFILES) $(OUTPUTFILES)) \
 146   ))
 147
 148 LATEXINTFILES_PREV = $(addsuffix _prev,$(LATEXINTFILES))
 149
 150 # \includeや\inputで読み込まれるTeXファイルを.flsから取得する
 151 TEXFILES = $(filter %.tex,$(INPUTFILES))
 152
 153 # \includegraphicsで読み込まれる画像ファイルを$(BASE).texと$(TEXFILES)、および.flsファイルから取得する
 154 GRAPHICFILES = $(GRAPHICFILESre)
 155
 156 GRAPHICFILESre = $(eval GRAPHICFILES := \
 157   $(sort \
 158     $(shell \
 159       $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
 160       $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' -e 's/\\verb|[^|]*|//g' | \
 161       $(SED) -e 's/}/}%/g' | $(SED) -e 'y/}%/}\n/' | \
 162       $(SED) -n -e 's/.*\\includegraphics\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}$$/\2/pg' \
 163     ) \
 164     $(filter $(addprefix %,$(GRAPHICSEXT)),$(INPUTFILES)) \
 165   ))
 166
 167 # .flsから取得した、そのほかの読み込みファイル（.styなど）
 168 OTHERFILES = $(sort $(filter-out %.aux $(LATEXINTFILES) $(TEXFILES) $(GRAPHICFILES),$(INPUTFILES)))
 169
 170 # \bibliography命令で読み込まれる文献データベースファイルをTeXファイルから検索する
 171 BIBDB = $(BIBDBre)
 172
 173 BIBDBre = $(eval BIBDB := \
 174   $(addsuffix .bib,$(basename $(sort $(shell \
 175       $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
 176       $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' -e 's/\\verb|[^|]*|//g' | \
 177       $(SED) -e 's/}/}%/g' | $(SED) -e 'y/}%/}\n/' | \
 178       $(SED) -n -e 's/.*\\bibliography\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}$$/\2/pg' | \
 179       $(SED) -e 's/,/ /g' \
 180    )))))
 181
 182 # .flsファイル作成用の一時ディレクトリー
 183 FLSDIR := .fls.temp
 184
 185 # $(BASE).flsファイルの作成
 186 FLSCMD = $(LATEX) -interaction=nonstopmode -recorder -output-directory=$(FLSDIR) $(BASE).tex
 187
 188 GENERETE.fls = \
 189   test ! -e $(FLSDIR) && $(MKDIR) $(FLSDIR); \
 190   $(FLSCMD) 1>/dev/null 2>&1; \
 191   $(SED) -e 's|$(FLSDIR)/||g' $(FLSDIR)/$(BASE).fls >$(BASE).fls; \
 192   test -e $(BASE).fls && \
 193     ($(ECHO) '$(BASE).fls is generated.'; $(RM) -r $(FLSDIR)) || \
 194     ($(ECHO) '$(BASE).fls is not generated.' 1>&2; exit 1)
 195
 196 # 依存関係を.dファイルに書き出す
 197 %.d: %.fls
 198     # Makefile変数の展開
 199         @$(foreach i,0 1,$(ECHO) "Makefiles variable -- LATEXINTFILES=$(LATEXINTFILES) TEXFILES=$(TEXFILES) GRAPHICFILES=$(GRAPHICFILES) BIBDB=$(BIBDB)" $(if $(filter 0,$i),>/dev/null);)
 200     # .dファイルの依存関係
 201         @$(ECHO) '$(BASE).d: $(BASE).tex $(BASE).fls' >$@
 202     # 中間ファイルの依存関係
 203         $(if $(sort $(LATEXINTFILES) $(BIBDB)),@( \
 204       $(ECHO); \
 205       $(ECHO) '# LaTeX Intermediate Files'; \
 206       $(ECHO) '#'; \
 207       $(ECHO) '# $$(COMPILE.tex) := $(LATEXCMD)'; \
 208       $(ECHO) '# $$(COMPILES.tex) := $(subst $(COMPILE.tex),$(LATEXCMD),$(COMPILES.tex))'; \
 209       $(ECHO) '#'; \
 210       $(ECHO) '$(BASE).dvi:: $(sort $(LATEXINTFILES_PREV) $(if $(BIBDB),$(BASE).bbl_prev))'; \
 211       $(ECHO) ' @$$(COMPILE.tex)'; \
 212       $(ECHO); \
 213       $(ECHO) '$(BASE).dvi:: $(BASE).aux'; \
 214       $(ECHO) ' @$$(COMPILES.tex)'; \
 215     ) >>$@)
 216     # \includeや\inputで読み込まれるTeXファイルの依存関係
 217         $(if $(TEXFILES),@( \
 218       $(ECHO); \
 219       $(ECHO) '# Files called from \include or \input - .tex'; \
 220       $(ECHO) '$(BASE).aux: $(TEXFILES)'; \
 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     # そのほかのファイル（TEXMFROOT以外にあるスタイルファイルなど）の依存関係
 240         $(if $(OTHERFILES),@( \
 241       $(ECHO); \
 242       $(ECHO) '# Other files'; \
 243       $(ECHO) '$(BASE).aux: $(OTHERFILES)'; \
 244     ) >>$@)
 245         @$(ECHO) '$@ is generated by scanning $(BASE).tex and $(BASE).fls.'
 246
 247 # 変数TEXTARGETSで指定されたターゲットファイルに対応する
 248 # .dファイルをインクルードし、依存関係を取得する
 249 # ターゲット末尾に clean、.xbb、.tex、.d が含まれている場合は除く
 250 ifeq (,$(filter %clean %.xbb %.tex %.d %.fls %.fls_prev,$(MAKECMDGOALS)))
 251   -include $(addsuffix .d,$(basename $(TEXTARGETS)))
 252 endif
 253
 254 ######################################################################
 255 # dviおよびPDFファイルを生成するパターンルール
 256 # TeX -> dvi -> PDF
 257 ######################################################################
 258
 259 # TeX -> aux
 260 %.aux: %.tex
 261         @$(COMPILE.tex)
 262
 263 # aux -> dvi
 264 %.dvi: %.aux
 265         @$(COMPILES.tex)
 266
 267 # tex -> dvi
 268 %.dvi: %.tex
 269         @$(COMPILE.tex)
 270         @$(COMPILES.tex)
 271
 272 # dvi -> PDF
 273 %.pdf: %.dvi
 274         @$(COMPILE.dvi)
 275
 276 ######################################################################
 277 # ファイルリストファイル（.fls）作成
 278 ######################################################################
 279
 280 %.fls: %.tex
 281         @-$(GENERETE.fls)
 282
 283 ######################################################################
 284 # LaTeX中間ファイルを生成するパターンルール
 285 ######################################################################
 286
 287 # ターゲットファイルと必須ファイルを比較し、
 288 # 内容が異なる場合はターゲットファイルの内容を必須ファイルに置き換える
 289 CMPPREV = $(CMP) $< $@ && $(ECHO) '$@ is up to date.' || $(CP) -p -v $< $@
 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) $(addprefix *,$(ALLINTEXT))
 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)