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