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