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