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 # == 機能 ==
  10 # - 読み込むべき中間ファイルがないことや相互参照未定義の警告がある場合、LaTeX処理を最大4回繰り返す
  11 # - \includegraphics命令がTeXファイルに含まれる場合、グラフィックファイルを挿入
  12 #   -- 挿入されたグラフィックファイルが更新されたときは、処理を開始
  13 #   -- 挿入されたグラフィックファイルがないときは、処理を中止
  14 #   -- 挿入されたグラフィックファイルに対するバウンディング情報ファイル（.xbb）を作成
  15 # - \include、\input命令がTeXファイルに含まれる場合、TeXファイルを挿入
  16 #   -- 挿入されたTeXファイルが更新されたときは、処理を開始
  17 #   -- 挿入されたTeXファイルがないときは、処理を中止
  18 # - \makeindex命令が含まれる場合、mendexで索引を作成
  19 # - \bibliography命令が含まれる場合、BiBTeXで文献一覧を作成
  20 #
  21 # == 擬似ターゲット ==
  22 # - tex-clean: TeX中間ファイル（auxなど）を削除。ターゲットに.dviが含まれていないときは.dviファイルを削除
  23 # - xbb-clean: バウンディング情報ファイル（.xbb）を削除
  24 # - tex-distclean: TeX中間ファイル、バウンディング情報ファイル、ターゲットファイル（PDF、.dvi）を削除
  25 #
  26 # === Makefile -- sample ===
  27 # TEXTARGETS := report.tex
  28 #
  29 # all: $(TEXTARGETS)
  30 #
  31 # include latex.mk
  32
  33 #debug
  34 #SHELL = /bin/sh -x
  35
  36 .PHONY: tex-warning tex-xbb tex-clean tex-distclean
  37
  38 # シェルコマンド
  39 CAT := cat
  40 CMP := cmp -s
  41 CP := cp
  42 ECHO := /bin/echo
  43 GREP := grep
  44 SED := sed
  45 SEQ := seq
  46
  47 # LaTeXコマンド
  48 LATEX := platex
  49 DVIPDFMX := dvipdfmx
  50 EXTRACTBB := extractbb
  51 BIBTEX := pbibtex
  52 MENDEX := mendex
  53 KPSEWHICH := kpsewhich
  54
  55 #LaTeXオプション
  56 LATEXFLAG ?=
  57 DVIPDFMXFLAG ?=
  58 EXTRACTBBFLAGS ?=
  59 BIBTEXFLAG ?=
  60 MENDEXFLAG ?=
  61
  62 tex-warning:
  63         @$(ECHO) "check current directory, or set TEXTARGET in Makefile."
  64
  65 # ファイル名から拡張子を除いた部分
  66 BASE = $(basename $<)
  67
  68 # .aux、.fls以外のTeX中間ファイルの拡張子
  69 #   .glo: 用語集。\glossaryがあれば生成
  70 #   .lof: 図リスト。\listoffiguresがあれば生成
  71 #   .lot: 表リスト。\listoftablesがあれば生成
  72 #   .out: PDFブックマーク。hyperrefパッケージをbookmarksオプションtrue（初期値）で呼び出せば生成
  73 #   .toc: 目次。\tableofcontentsがあれば生成
  74 #   .toc: 目次（\tableofcontents）
  75 TEX_INT := .glo .lof .lot .out .toc
  76 # 索引中間ファイルの拡張子
  77 #   .idx: \makeindexがあれば生成
  78 #   .ind: idxから作成
  79 IND_INT := .idx .ind
  80 # BiBTeX中間ファイルの拡張子
  81 #   .bbl: auxから作成
  82 BIB_INT := .bbl .blg
  83 #   .log: ログ
  84 #   .ilg: 索引ログ
  85 #   .blg: BiBTeXログ
  86 LOG := .log .ilg .blg
  87
  88 ALL_INTERFILES = $(addprefix *,.aux $(TEX_INT) $(IND_INT) $(BIB_INT) $(LOG) .fls .d .*_prev)
  89
  90 # make完了後、中間ファイルを残す
  91 .SECONDARY: $(wildcard ALL_INTERFILES)
  92
  93 # ファイル名から拡張子を除いた部分
  94 BASE = $(basename $<)
  95
  96 # .flsファイルから、INPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
  97 # 取得は、1回のmake実行につき1回だけ行われる
  98 INPUTFILES = $(INPUTFILESre)
  99
 100 INPUTFILESre = $(eval INPUTFILES := \
 101   $(sort $(filter-out $(BASE).tex $(BASE).aux, $(shell \
 102     $(SED) -n -e 's/^INPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
 103     $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
 104   ))))
 105
 106 # .flsファイルから、OUTPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
 107 # 取得は、1回のmake実行につき1回だけ行われる
 108 OUTPUTFILES =  $(OUTFILESre)
 109
 110 OUTFILESre = $(eval OUTPUTFILES := \
 111   $(sort $(filter-out $(BASE).aux $(BASE).dvi $(BASE).log,$(shell \
 112     $(SED) -n -e 's/^OUTPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
 113     $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
 114   ))))
 115
 116 # $(BASE).texで読み込まれる中間ファイルを$(BASE).flsから取得する
 117 # .idxは、.indへ置換
 118 INTERFILES = \
 119   $(sort $(subst .idx,.ind, \
 120     $(filter $(addprefix $(BASE),$(TEX_INT) $(IND_INT) $(BIB_INT)),$(INPUTFILES) $(OUTPUTFILES)) \
 121   ))
 122
 123 INTERFILES_PREV = $(addsuffix _prev,$(INTERFILES))
 124
 125 # TeXファイル - .tex
 126 TEXFILES = $(filter %.tex,$(INPUTFILES))
 127
 128 # 対応する画像ファイルの拡張子
 129 GRAPHICSEXT := .pdf .eps .jpg .jpeg .png .bmp
 130
 131 # $(BASE).texで読み込まれる画像ファイルを取得する
 132 GRAPHICFILES = $(GRAPHICFILESre)
 133
 134 GRAPHICFILESre = $(eval GRAPHICFILES := \
 135   $(sort \
 136     $(shell \
 137       $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
 138       $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
 139       $(SED) -n -e 's/\\includegraphics\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
 140       $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' \
 141     ) \
 142     $(filter $(addprefix %,$(GRAPHICSEXT)),$(INPUTFILES)) \
 143 ))
 144
 145 # そのほかの読み込みファイル
 146 OTHERFILES = \
 147   $(sort $(filter-out %.aux $(INTERFILES) $(TEXFILES) $(GRAPHICFILES),$(INPUTFILES)))
 148
 149 # \bibliography命令で読み込まれる文献データベースファイルをTeXファイルから検索する
 150 BIBDB = $(BIBDBre)
 151
 152 BIBDBre = $(eval BIBDB := \
 153   $(addsuffix .bib,$(basename $(sort $(shell \
 154      $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
 155      $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
 156      $(SED) -n -e 's/\\bibliography\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
 157      $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' | \
 158      $(SED) -e 's/,/ /g' \
 159    )))))
 160
 161 # LaTeX処理（コンパイル）
 162 LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(BASE).tex
 163 COMPILE.tex = $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || ($(SED) -n -e '/^!/,/^$$/p' $(BASE).log; exit 1)
 164
 165 # 相互参照未定義の警告
 166 WARN_UNDEFREF := 'There were undefined references\.'
 167
 168 # LaTeX処理
 169 # ログファイルに警告がある場合は警告がなくなるまで、最大CNTで指定された回数分、処理を実行する
 170 CNT := 3
 171 COMPILES.tex = \
 172   @(for i in `$(SEQ) 1 $(CNT)`; do \
 173       if test -s $@ -a -s $(BASE).log; then \
 174         $(GREP) -e $(WARN_UNDEFREF) $(BASE).log || exit 0; \
 175       else \
 176         $(ECHO) '$@ and/or $(BASE).log does not exist.'; \
 177       fi; \
 178       $(COMPILE.tex); \
 179     done)
 180
 181 # DVI -> PDF
 182 # 出力結果は.logファイルへ出力
 183 DVIPDFCMD = $(DVIPDFMX) $(DVIPDFMXFLAG) $(BASE).dvi
 184 COMPILE.dvi = $(ECHO) $(DVIPDFCMD); $(DVIPDFCMD) >>$(BASE).log 2>&1 || ($(SED) -n -e '/^Output written on toc_hyperref.dvi/,$$p' $(BASE).log; exit 1)
 185
 186 # 索引中間ファイル（.ind）作成
 187 MENDEXCMD = $(MENDEX) $(MENDEXFLAG) $(BASE).idx
 188 COMPILE.idx = $(ECHO) $(MENDEXCMD); $(MENDEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).ilg; exit 1)
 189
 190 # 文献リスト中間ファイル（.bbl）作成
 191 BIBTEXCMD = $(BIBTEX) $(BIBTEXFLAG) $(BASE).aux
 192 COMPILE.bib = $(ECHO) $(BIBTEXCMD); $(BIBTEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).blg; exit 1)
 193
 194 # ターゲットファイルと必須ファイルを比較し、内容が異なる場合はターゲットファイルの内容を必須ファイルに置き換える
 195 CMPPREV = $(CMP) $@ $< || $(CP) -p -v $< $@
 196
 197 # $(BASE).flsファイルの作成
 198 FLSCMD = $(LATEX) -interaction=nonstopmode -recorder $(BASE).tex
 199 CREATE.fls = \
 200   $(FLSCMD) 1>/dev/null 2>&1; \
 201   test -e $(BASE).fls && $(ECHO) '$(BASE).fls is created.'; \
 202   $(RM) $(addprefix $(BASE),.aux .dvi .log $(TEX_INT) $(IND_INT) $(BIB_INT))
 203
 204 # 依存関係を.dファイルに書き出す
 205 %.d: %.fls
 206         @$(ECHO) '$@ is created by scanning $(BASE).tex and $(BASE).fls.'
 207     # .dファイルの依存関係
 208         @$(ECHO) '$(BASE).d: $(BASE).tex $(BASE).fls' >$@
 209     # \includeまたは\input命令で読み込まれるTeXファイルの依存関係
 210         $(if $(TEXFILES),@( \
 211       $(ECHO); \
 212       $(ECHO) '# Files called from \include or \input - .tex'; \
 213       $(ECHO) '$(BASE).aux: $(TEXFILES)'; \
 214     ) >>$@)
 215     # そのほかのファイル（TEXMFROOT以外にあるスタイルファイルなど）の依存関係
 216         $(if $(OTHERFILES),@( \
 217       $(ECHO); \
 218       $(ECHO) '# Other files'; \
 219       $(ECHO) '$(BASE).aux: $(OTHERFILES)'; \
 220     ) >>$@)
 221     # 画像ファイルの依存関係
 222         $(if $(GRAPHICFILES),@( \
 223       $(ECHO); \
 224       $(ECHO) '# IncludeGraphic Files - .pdf, .eps, .jpeg/.jpg, .png'; \
 225       $(ECHO) '#           .xbb Files - .pdf, .jpeg/.jpg, .png'; \
 226       $(ECHO) '$(BASE).aux: $(GRAPHICFILES)'; \
 227       $(if $(filter-out %.eps,$(GRAPHICFILES)), \
 228         $(ECHO); \
 229         $(ECHO) '$(BASE).aux: $(addsuffix .xbb,$(basename $(filter-out %.eps,$(GRAPHICFILES))))'; \
 230       ) \
 231     ) >>$@)
 232     # 文献処理用ファイルの依存関係
 233         $(if $(BIBDB),@( \
 234         $(ECHO); \
 235         $(ECHO) '# Bibliography files: .aux, BIBDB -> .bbl -> .div'; \
 236         $(ECHO) '$(BASE).bbl: $(BIBDB) $(BASE).tex'; \
 237       ) >>$@)
 238     # 中間ファイルの依存関係
 239         $(if $(sort $(INTERFILES) $(BIBDB)),@( \
 240       $(ECHO); \
 241       $(ECHO) '# LaTeX Intermediate Files'; \
 242       $(ECHO) '$(BASE).dvi:: $(sort $(INTERFILES_PREV) $(if $(BIBDB),$(BASE).bbl_prev))'; \
 243       $(ECHO) ' @$$(COMPILE.tex)'; \
 244       $(ECHO); \
 245       $(ECHO) '$(BASE).dvi:: $(BASE).aux'; \
 246       $(ECHO) ' @$$(COMPILES.tex)'; \
 247     ) >>$@)
 248
 249 # 変数TEXTARGETSで指定されたターゲットファイルに対応する
 250 # .dファイルをインクルードし、依存関係を取得する
 251 # ターゲット末尾に clean、.xbb、.tex、.d が含まれている場合は除く
 252 ifeq (,$(filter %clean %.xbb %.tex %.d %.fls %.fls_prev,$(MAKECMDGOALS)))
 253   -include $(addsuffix .d,$(basename $(TEXTARGETS)))
 254 endif
 255
 256 # auxファイル作成
 257 %.aux: %.tex
 258         @$(COMPILE.tex)
 259
 260 %.dvi: %.aux
 261         @$(COMPILES.tex)
 262
 263 %.dvi: %.tex
 264         @$(COMPILE.tex)
 265         @$(COMPILES.tex)
 266
 267 # PDFファイル作成
 268 %.pdf: %.dvi
 269         @$(COMPILE.dvi)
 270
 271 # バウンディング情報ファイル作成
 272 # pdf、jpeg/jpg、pngファイルに対応
 273 extractbb:
 274         $(MAKE) -s $(addsuffix .xbb,$(basename $(wildcard $(addprefix *,.pdf .jpg .jpeg .png))))
 275
 276 %.xbb: %.pdf
 277         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 278
 279 %.xbb: %.jpeg
 280         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 281
 282 %.xbb: %.jpg
 283         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 284
 285 %.xbb: %.png
 286         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 287
 288 # ファイル一覧作成
 289 %.fls: %.tex
 290         @-$(CREATE.fls)
 291
 292 %.fls_prev: %.fls
 293         @$(CMPPREV)
 294
 295 # 目次中間ファイル作成
 296 %.toc: %.tex
 297         @$(MAKE) -s $(BASE).aux
 298
 299 %.toc_prev: %.toc
 300         @$(CMPPREV)
 301
 302 # 図リスト中間ファイル作成
 303 %.lof: %.tex
 304         @$(MAKE) -s $(BASE).aux
 305
 306 %.lof_prev: %.lof
 307         @$(CMPPREV)
 308
 309 # 表リスト中間ファイル作成
 310 %.lot: %.tex
 311         @$(MAKE) -s $(BASE).aux
 312
 313 %.lot_prev: %.lot
 314         @$(CMPPREV)
 315
 316 # 索引中間ファイル作成
 317 %.idx: %.tex
 318         @$(MAKE) -s $(BASE).aux
 319
 320 %.idx_prev: %.idx
 321         @$(CMPPREV)
 322
 323 %.ind: %.idx_prev
 324         @$(COMPILE.idx)
 325
 326 %.ind_prev: %.ind
 327         @$(CMPPREV)
 328
 329 # BiBTeX中間ファイル作成
 330 %.bbl: %.tex
 331         @$(MAKE) -s $(BASE).aux
 332         @$(COMPILE.bib)
 333
 334 %.bbl_prev: %.bbl
 335         @$(CMPPREV)
 336
 337 # hyperref中間ファイル作成
 338 %.out: %.tex
 339         @$(MAKE) -s $(BASE).aux
 340
 341 %.out_prev: %.out
 342         @$(CMPPREV)
 343
 344 # tex-cleanターゲット
 345 tex-clean:
 346         $(RM) $(ALL_INTERFILES)
 347 ifeq (,$(filter %.dvi,$(TEXTARGETS)))
 348         $(RM) *.dvi
 349 endif
 350
 351 # xbb-cleanターゲット
 352 xbb-clean:
 353         $(RM) *.xbb
 354
 355 # tex-distcleanターゲット
 356 tex-distclean: tex-clean xbb-clean
 357 ifneq (,$(filter %.dvi,$(TEXTARGETS)))
 358         $(RM) *.dvi
 359 endif
 360         $(RM) $(TEXTARGETS)