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