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-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 # TeX中間ファイルの拡張子
  69 #   .aux: 相互参照
  70 #   .fls: tex -recorderで生成されるファイルリスト
  71 #   .lof: 図リスト（\tableoffigures）
  72 #   .lot: 表リスト（\tableoftables）
  73 #   .out: hyperrefパッケージ
  74 #   .toc: 目次（\tableofcontents）
  75 #   .log: ログ
  76 TEX_INT := .aux .lof .lot .out .toc .log
  77 # 索引中間ファイルの拡張子
  78 #   .idx: auxから作成
  79 #   .ind: idxから作成
  80 #   .ilg: 索引ログ
  81 IND_INT := .idx .ind .ilg
  82 # BiBTeX中間ファイルの拡張子
  83 #   .bbl: auxから作成
  84 #   .blg: BiBTeXログ
  85 BIB_INT := .bbl .blg
  86
  87 ALL_INTERFILES = $(addprefix *,$(TEX_INT) $(IND_INT) $(BIB_INT) .fls .d .*_prev)
  88
  89 .SECONDARY: $(wildcard ALL_INTERFILES)
  90
  91 # ファイル名から拡張子を除いた部分
  92 BASE = $(basename $<)
  93
  94 # .flsファイルから、INPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
  95 INPUTFILES = $(INPUTFILESre)
  96
  97 INPUTFILESre = $(eval INPUTFILES := \
  98   $(sort $(filter-out $(BASE).tex $(BASE).aux, $(shell \
  99     $(SED) -n -e 's/^INPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
 100     $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
 101   ))))
 102
 103 # .flsファイルから、OUTPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
 104 OUTPUTFILES =  $(OUTFILESre)
 105
 106 OUTFILESre = $(eval OUTPUTFILES := \
 107   $(sort $(filter-out $(BASE).aux $(BASE).dvi $(BASE).log,$(shell \
 108     $(SED) -n -e 's/^OUTPUT \(.\{1,\}\)/\1/p' $(BASE).fls | \
 109     $(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
 110   ))))
 111
 112 # $(BASE).texで使われるLaTeX中間ファイル
 113 INTERFILES = \
 114   $(sort $(subst .idx,.ind, \
 115     $(filter $(addprefix $(BASE),.lof .lot .out .toc .idx .ind .bbl),$(INPUTFILES) $(OUTPUTFILES)) \
 116   ))
 117
 118 INTERFILES_PREV = $(addsuffix _prev,$(INTERFILES))
 119
 120 # TeXファイル - .tex
 121 TEXFILES = $(filter %.tex,$(INPUTFILES))
 122
 123 # 画像ファイル - .pdf、.eps、.jpg／jpeg、.png、および.xbb
 124 GRAPHICFILES = $(GRAPHICFILESre)
 125
 126 GRAPHICFILESre =  $(eval GRAPHICFILES := \
 127   $(sort $(shell \
 128       $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
 129       $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
 130       $(SED) -n -e 's/\\includegraphics\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
 131       $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' \
 132     ) \
 133     $(filter %.pdf %.eps %.jpeg %.jpg %.png %.bmp,$(INPUTFILES)) \
 134   ))
 135
 136 # そのほかの読み込みファイル
 137 OTHERFILES = \
 138   $(sort $(filter-out %.aux $(INTERFILES) $(TEXFILES) $(GRAPHICFILES),$(INPUTFILES)))
 139
 140 # \bibliography命令で読み込まれる文献データベースファイルをTeXファイルから検索する
 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' | \
 147      $(SED) -n -e 's/\\bibliography\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
 148      $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' | \
 149      $(SED) -e 's/,/ /g' \
 150    )))))
 151
 152 # LaTeX処理（コンパイル）
 153 LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(BASE).tex
 154 COMPILE.tex = $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || ($(SED) -n -e '/^!/,/^$$/p' $(BASE).log; exit 1)
 155
 156 FLSCMD = $(LATEX) -interaction=nonstopmode -recorder $(BASE).tex
 157 CREATE.fls = \
 158   $(ECHO) $(FLSCMD); $(FLSCMD) 1>/dev/null 2>&1; \
 159   $(RM) $(addprefix $(BASE),$(TEX_INT) $(IND_INT) $(BIB_INT) .dvi)
 160
 161 # 相互参照未定義の警告
 162 WARN_UNDEFREF := 'There were undefined references\.'
 163
 164 # LaTeX処理
 165 # ログファイルに警告がある場合は警告がなくなるまで、最大CNTで指定された回数分、処理を実行する
 166 CNT := 3
 167 COMPILES.tex = \
 168   @(for i in `$(SEQ) 1 $(CNT)`; do \
 169       if test -s $@ -a -s $(BASE).log; then \
 170         $(GREP) -e $(WARN_UNDEFREF) $(BASE).log || exit 0; \
 171       else \
 172         $(ECHO) '$@ and/or $(BASE).log does not exist.'; \
 173       fi; \
 174       $(COMPILE.tex); \
 175     done)
 176
 177 # DVI -> PDF
 178 # 出力結果は.logファイルへ出力
 179 DVIPDFCMD = $(DVIPDFMX) $(DVIPDFMXFLAG) $(BASE).dvi
 180 COMPILE.dvi = $(ECHO) $(DVIPDFCMD); $(DVIPDFCMD) >>$(BASE).log 2>&1 || ($(SED) -n -e '/^Output written on toc_hyperref.dvi/,$$p' $(BASE).log; exit 1)
 181
 182 # 索引中間ファイル（.ind）作成
 183 MENDEXCMD = $(MENDEX) $(MENDEXFLAG) $(BASE).idx
 184 COMPILE.idx = $(ECHO) $(MENDEXCMD); $(MENDEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).ilg; exit 1)
 185
 186 # 文献リスト中間ファイル（.bbl）作成
 187 BIBTEXCMD = $(BIBTEX) $(BIBTEXFLAG) $(BASE).aux
 188 COMPILE.bib = $(ECHO) $(BIBTEXCMD); $(BIBTEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).blg; exit 1)
 189
 190 # ターゲットファイルと必須ファイルを比較し、内容が異なる場合はターゲットファイルの内容を必須ファイルに置き換える
 191 CMPPREV = $(CMP) $@ $< || $(CP) -p -v $< $@
 192
 193 # 依存関係を.dファイルに書き出す
 194 %.d: %.fls
 195         @$(ECHO) '$@ is created by scanning $(BASE).tex and $(BASE).fls.'
 196     # .dファイルの依存関係
 197         @$(ECHO) '$(BASE).d: $(BASE).tex $(BASE).fls' >$@
 198     # \includeまたは\input命令で読み込まれるTeXファイルの依存関係
 199         $(if $(TEXFILES),@( \
 200       $(ECHO); \
 201       $(ECHO) '# Files called from \include or \input - .tex'; \
 202       $(ECHO) '$(BASE).aux: $(TEXFILES)'; \
 203     ) >>$@)
 204     # そのほかのファイル（TEXMFROOT以外にあるスタイルファイルなど）の依存関係
 205         $(if $(OTHERFILES),@( \
 206       $(ECHO); \
 207       $(ECHO) '# Other files'; \
 208       $(ECHO) '$(BASE).aux: $(OTHERFILES)'; \
 209     ) >>$@)
 210     # 画像ファイルの依存関係
 211         $(if $(GRAPHICFILES),@( \
 212       $(ECHO); \
 213       $(ECHO) '# IncludeGraphic Files - .pdf, .eps, .jpeg/.jpg, .png'; \
 214       $(ECHO) '#           .xbb Files - .pdf, .jpeg/.jpg, .png'; \
 215       $(ECHO) '$(BASE).aux: $(GRAPHICFILES)'; \
 216       $(if $(filter-out %.eps,$(GRAPHICFILES)), \
 217         $(ECHO); \
 218         $(ECHO) '$(BASE).aux: $(addsuffix .xbb,$(basename $(filter-out %.eps,$(GRAPHICFILES))))'; \
 219       ) \
 220     ) >>$@)
 221     # 文献処理用ファイルの依存関係
 222         $(if $(BIBDB),@( \
 223         $(ECHO); \
 224         $(ECHO) '# Bibliography files: .aux, BIBDB -> .bbl -> .div'; \
 225         $(ECHO) '$(BASE).bbl: $(BIBDB) $(BASE).tex'; \
 226       ) >>$@)
 227     # 中間ファイルの依存関係
 228         $(if $(sort $(INTERFILES) $(BIBDB)),@( \
 229       $(ECHO); \
 230       $(ECHO) '# LaTeX Intermediate Files'; \
 231       $(ECHO) '$(BASE).dvi:: $(sort $(INTERFILES_PREV) $(if $(BIBDB),$(BASE).bbl_prev))'; \
 232       $(ECHO) ' @$$(COMPILE.tex)'; \
 233       $(ECHO); \
 234       $(ECHO) '$(BASE).dvi:: $(BASE).aux'; \
 235       $(ECHO) ' @$$(COMPILES.tex)'; \
 236     ) >>$@)
 237
 238 # 変数TEXTARGETSで指定されたターゲットファイルに対応する
 239 # .dファイルをインクルードし、依存関係を取得する
 240 # ターゲット末尾に clean、.xbb、.tex、.d が含まれている場合は除く
 241 ifeq (,$(filter %clean %.xbb %.tex %.d %.fls %.fls_prev,$(MAKECMDGOALS)))
 242   -include $(addsuffix .d,$(basename $(TEXTARGETS)))
 243 endif
 244
 245 # auxファイル作成
 246 %.aux: %.tex
 247         @$(COMPILE.tex)
 248
 249 %.dvi: %.aux
 250         @$(COMPILES.tex)
 251
 252 %.dvi: %.tex
 253         @$(COMPILE.tex)
 254         @$(COMPILES.tex)
 255
 256 # PDFファイル作成
 257 %.pdf: %.dvi
 258         @$(COMPILE.dvi)
 259
 260 # バウンディング情報ファイル作成
 261 # pdf、jpeg/jpg、pngファイルに対応
 262 extractbb:
 263         $(MAKE) -s $(addsuffix .xbb,$(basename $(wildcard $(addprefix *,.pdf .jpg .jpeg .png))))
 264
 265 %.xbb: %.pdf
 266         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 267
 268 %.xbb: %.jpeg
 269         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 270
 271 %.xbb: %.jpg
 272         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 273
 274 %.xbb: %.png
 275         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 276
 277 # ファイル一覧作成
 278 %.fls: %.tex
 279         @-$(CREATE.fls)
 280
 281 %.fls_prev: %.fls
 282         @$(CMPPREV)
 283
 284 # 目次中間ファイル作成
 285 %.toc: %.tex
 286         @$(MAKE) -s $(BASE).aux
 287
 288 %.toc_prev: %.toc
 289         @$(CMPPREV)
 290
 291 # 図リスト中間ファイル作成
 292 %.lof: %.tex
 293         @$(MAKE) -s $(BASE).aux
 294
 295 %.lof_prev: %.lof
 296         @$(CMPPREV)
 297
 298 # 表リスト中間ファイル作成
 299 %.lot: %.tex
 300         @$(MAKE) -s $(BASE).aux
 301
 302 %.lot_prev: %.lot
 303         @$(CMPPREV)
 304
 305 # 索引中間ファイル作成
 306 %.idx: %.tex
 307         @$(MAKE) -s $(BASE).aux
 308
 309 %.idx_prev: %.idx
 310         @$(CMPPREV)
 311
 312 %.ind: %.idx_prev
 313         @$(COMPILE.idx)
 314
 315 %.ind_prev: %.ind
 316         @$(CMPPREV)
 317
 318 # BiBTeX中間ファイル作成
 319 %.bbl: %.tex
 320         @$(MAKE) -s $(BASE).aux
 321         @$(COMPILE.bib)
 322
 323 %.bbl_prev: %.bbl
 324         @$(CMPPREV)
 325
 326 # hyperref中間ファイル作成
 327 %.out: %.tex
 328         @$(MAKE) -s $(BASE).aux
 329
 330 %.out_prev: %.out
 331         @$(CMPPREV)
 332
 333 # tex-cleanターゲット
 334 tex-clean:
 335         $(RM) $(ALL_INTERFILES)
 336 ifeq (,$(filter %.dvi,$(TEXTARGETS)))
 337         $(RM) *.dvi
 338 endif
 339
 340 # xbb-cleanターゲット
 341 xbb-clean:
 342         $(RM) *.xbb
 343
 344 # tex-distcleanターゲット
 345 tex-distclean: tex-clean xbb-clean
 346 ifneq (,$(filter %.dvi,$(TEXTARGETS)))
 347         $(RM) *.dvi
 348 endif
 349         $(RM) $(TEXTARGETS)