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