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