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