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 .PHONY: tex-warning tex-clean tex-distclean
  33
  34 # シェルコマンド
  35 CAT := cat
  36 CMP := cmp -s
  37 CP := cp
  38 ECHO := /bin/echo
  39 GREP := grep
  40 SED := sed
  41 SEQ := seq
  42
  43 # LaTeXコマンド
  44 LATEX := platex
  45 DVIPDFMX := dvipdfmx
  46 EXTRACTBB := extractbb
  47 BIBTEX := pbibtex
  48 MENDEX := mendex
  49
  50 #LaTeXオプション
  51 LATEXFLAG ?=
  52 DVIPDFMXFLAG ?=
  53 EXTRACTBBFLAGS ?=
  54 BIBTEXFLAG ?=
  55 MENDEXFLAG ?=
  56
  57 tex-warning:
  58         @$(ECHO) "check current directory, or set TEXTARGET in Makefile."
  59
  60 # TeX中間ファイルの拡張子
  61 #   .aux: 相互参照
  62 #   .fls: tex -recorderで生成されるファイルリスト
  63 #   .lof: 図リスト（\tableoffigures）
  64 #   .lot: 表リスト（\tableoftables）
  65 #   .out: hyperrefパッケージ
  66 #   .toc: 目次（\tableofcontents）
  67 #   .log: ログ
  68 TEX_INT := .aux .fls .lof .lot .out .toc .log
  69 # 索引中間ファイルの拡張子
  70 #   .idx: auxから作成
  71 #   .ind: idxから作成
  72 #   .ilg: 索引ログ
  73 IND_INT := .idx .ind .ilg
  74 # BiBTeX中間ファイルの拡張子
  75 #   .bbl: auxから作成
  76 #   .blg: BiBTeXログ
  77 BIB_INT := .bbl .blg
  78
  79 ALL_INTERFILES = $(addprefix *,$(TEX_INT) $(IND_INT) $(BIB_INT) .d .*_prev)
  80
  81 .SECONDARY: $(wildcard ALL_INTERFILES)
  82
  83 # \tableofcontents命令をTeXファイルから検索する
  84 toc = $(shell $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\tableofcontents/!s/.*\(\\tableofcontents\).*/\1/p' $< $(intex))
  85
  86 # \listoffigures命令をTeXファイルから検索する
  87 lof = $(shell $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\listoffigures/!s/.*\(\\listoffigures\).*/\1/p' $< $(intex))
  88
  89 # \listoftables命令をTeXファイルから検索する
  90 lot = $(shell $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\listoftables/!s/.*\(\\listoftables\).*/\1/p' $< $(intex))
  91
  92 # \makeindex命令をTeXファイルから検索する
  93 makeindex = $(shell $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\makeindex/!s/.*\(\\makeindex\).*/\1/p' $< $(intex))
  94
  95 # \bibliography命令で読み込まれる文献データベースファイルをTeXファイルから検索する
  96 bibdb = $(addsuffix .bib,$(basename $(strip $(shell \
  97   $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\bibliography/!s/\\bibliography\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}/&\n/p' $< $(intex) | \
  98   $(SED) -e 's/.*{\([^}]*\)}.*/\1/' | \
  99   $(SED) -e 's/,/ /g'))))
 100
 101 # hyperrefパッケージ読み込みをTeXファイルから検索する
 102 hyperref = $(shell $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\usepackage\(\[[^]]*\]\)\{0,1\}{hyperref}/!s/.*\(\\usepackage\)\(\[[^]]*\]\)\{0,1\}\({hyperref}\).*/\1\3/p' $< $(intex))
 103
 104 # ファイル名から拡張子を除いた部分
 105 BASE = $(basename $<)
 106
 107 # $(BASE).texで使われるLaTeX中間ファイル
 108 INTERFILES = $(strip \
 109                 $(if $(toc),$(BASE).toc) \
 110                 $(if $(lof),$(BASE).lof) \
 111                 $(if $(lot),$(BASE).lot) \
 112                 $(if $(makeindex),$(BASE).ind) \
 113                 $(if $(bibdb),$(BASE).bbl) \
 114                 $(if $(hyperref),$(BASE).out) \
 115               )
 116
 117 INTERFILES_PREV = $(addsuffix _prev,$(INTERFILES))
 118
 119 # LaTeX処理（コンパイル）
 120 LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(BASE).tex
 121 COMPILE.tex = $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).log; exit 1)
 122
 123 # 相互参照未定義の警告
 124 WARN_UNDEFREF := 'There were undefined references\.'
 125
 126 # LaTeX処理
 127 # ログファイルに警告がある場合は警告がなくなるまで、最大CNTで指定された回数分、処理を実行する
 128 CNT = 3
 129 COMPILES.tex = \
 130   @(for i in `$(SEQ) 1 $(CNT)`; do \
 131       if test -s $@ -a -s $(BASE).log; then \
 132         $(GREP) -e $(WARN_UNDEFREF) $(BASE).log || exit 0; \
 133       else \
 134         $(ECHO) '$@ and/or $(BASE).log does not exist.'; \
 135       fi; \
 136       $(COMPILE.tex); \
 137     done)
 138
 139 # DVI -> PDF
 140 # 出力結果は.logファイルへ出力
 141 DVIPDFCMD = $(DVIPDFMX) $(DVIPDFMXFLAG) $(BASE).dvi
 142 COMPILE.dvi = $(ECHO) $(DVIPDFCMD); $(DVIPDFCMD) >>$(BASE).log 2>&1 || ($(CAT) $(BASE).log; exit 1)
 143
 144 # 索引中間ファイル（.ind）作成
 145 MENDEXCMD = $(MENDEX) $(MENDEXFLAG) $(BASE).idx
 146 COMPILE.idx = $(ECHO) $(MENDEXCMD); $(MENDEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).ilg; exit 1)
 147
 148 # 文献リスト中間ファイル（.bbl）作成
 149 BIBTEXCMD = $(BIBTEX) $(BIBTEXFLAG) $(BASE).aux
 150 COMPILE.bib = $(ECHO) $(BIBTEXCMD); $(BIBTEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).blg; exit 1)
 151
 152 # ターゲットファイルと必須ファイルを比較し、内容が異なる場合はターゲットファイルの内容を必須ファイルに置き換える
 153 CMPPREV = $(CMP) $@ $< || $(CP) -p -v $< $@
 154
 155 # \include、\input命令で読み込まれるTeXファイル
 156 intex = $(addsuffix .tex,$(basename $(strip $(shell \
 157   $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\\(include\|input\)/!s/\\\(include\|input\)\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/p' $< | \
 158   $(SED) -e 's/.*{\([^}]*\)}.*/\1/'))))
 159
 160 # \includegraphics命令で読み込まれるグラフィックファイル
 161 ingraphics = $(strip $(shell \
 162   $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\includegraphics/!s/\\includegraphics\(\[[^]]*\]\)\{0,1\}\({[^}]*}\)/&\n/p' $< $(intex) | \
 163   $(SED) -e 's/.*{\([^}]*\)}.*/\1/'))
 164
 165 # 依存関係を.dファイルに書き出す
 166 %.d: %.tex
 167         @$(ECHO) '$@ is created by scanning $^.'
 168 # .dファイルの依存関係
 169         @$(ECHO) '$(BASE).d: $(BASE).tex' >$@
 170 # 中間ファイルの依存関係
 171         $(if $(INTERFILES),@( \
 172         $(ECHO); \
 173         $(ECHO) '# LaTeX Intermediate Files'; \
 174         $(ECHO) '$(BASE).dvi:: $(INTERFILES_PREV)'; \
 175         $(ECHO) '       @$$(COMPILE.tex)'; \
 176         $(ECHO); \
 177         $(ECHO) '$(BASE).dvi:: $(BASE).aux'; \
 178         $(ECHO) '       @$$(COMPILES.tex)'; \
 179       )  >>$@)
 180 # 画像ファイルの依存関係
 181         $(if $(ingraphics),@( \
 182         $(ECHO); \
 183         $(ECHO) '# IncludeGraphic Files - .pdf, .eps, .jpeg/.jpg, .png'; \
 184         $(ECHO) '#           .xbb Files - .pdf, .jpeg/.jpg, .png'; \
 185         $(ECHO) '$(BASE).aux: $(ingraphics)'; \
 186         $(if $(filter-out %.eps,$(ingraphics)), \
 187           $(ECHO); \
 188           $(ECHO) '$(BASE).aux: $(addsuffix .xbb,$(basename $(filter-out %.eps,$(ingraphics))))'; \
 189         ) \
 190       ) >>$@)
 191 # \includeまたは\input命令で読み込まれるTeXファイルの依存関係
 192         $(if $(intex),@( \
 193         $(ECHO); \
 194         $(ECHO) '# Files called from \include or \input - .tex'; \
 195         $(ECHO) '$(BASE).aux: $(intex)'; \
 196       ) >>$@)
 197 # 文献処理用ファイルの依存関係
 198         $(if $(bibdb),@( \
 199         $(ECHO); \
 200         $(ECHO) '# Bibliography files: .aux, BIBDB -> .bbl -> .div'; \
 201         $(ECHO) '$(BASE).bbl: $(bibdb) $(BASE).tex'; \
 202     ) >>$@)
 203
 204 # 変数TEXTARGETSで指定されたターゲットファイルに対応する
 205 # .dファイルをインクルードし、依存関係を取得する
 206 # ターゲット末尾に clean、.xbb、.tex、.d が含まれている場合は除く
 207 ifeq (,$(filter %clean %.xbb %.tex %.d,$(MAKECMDGOALS)))
 208   -include $(addsuffix .d,$(basename $(TEXTARGETS)))
 209 endif
 210
 211 # auxファイル作成
 212 %.aux: %.tex
 213         @$(COMPILE.tex)
 214
 215 %.dvi: %.aux
 216         @$(COMPILES.tex)
 217
 218 %.dvi: %.tex
 219         @$(COMPILE.tex)
 220         @$(COMPILES.tex)
 221
 222 # PDFファイル作成
 223 %.pdf: %.dvi
 224         @$(COMPILE.dvi)
 225
 226 # バウンディング情報ファイル作成
 227 # pdf、jpeg/jpg、pngファイルに対応
 228 %.xbb: %.pdf
 229         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 230
 231 %.xbb: %.jpeg
 232         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 233
 234 %.xbb: %.jpg
 235         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 236
 237 %.xbb: %.png
 238         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 239
 240 # 目次中間ファイル作成
 241 %.toc: %.tex
 242         @$(MAKE) -s $(BASE).aux
 243
 244 %.toc_prev: %.toc
 245         @$(CMPPREV)
 246
 247 # 図リスト中間ファイル作成
 248 %.lof: %.tex
 249         @$(MAKE) -s $(BASE).aux
 250
 251 %.lof_prev: %.lof
 252         @$(CMPPREV)
 253
 254 # 表リスト中間ファイル作成
 255 %.lot: %.tex
 256         @$(MAKE) -s $(BASE).aux
 257
 258 %.lot_prev: %.lot
 259         @$(CMPPREV)
 260
 261 # 索引中間ファイル作成
 262 %.idx: %.tex
 263         @$(MAKE) -s $(BASE).aux
 264
 265 %.idx_prev: %.idx
 266         @$(CMPPREV)
 267
 268 %.ind: %.idx_prev
 269         @$(COMPILE.idx)
 270
 271 %.ind_prev: %.ind
 272         @$(CMPPREV)
 273
 274 # BiBTeX中間ファイル作成
 275 %.bbl: %.tex
 276         @$(MAKE) -s $(BASE).aux
 277         @$(COMPILE.bib)
 278
 279 %.bbl_prev: %.bbl
 280         @$(CMPPREV)
 281
 282 # hyperref中間ファイル作成
 283 %.out: %.tex
 284         @$(MAKE) -s $(BASE).aux
 285
 286 %.out_prev: %.out
 287         @$(CMPPREV)
 288
 289 # tex-cleanターゲット
 290 tex-clean:
 291         $(RM) $(ALL_INTERFILES)
 292 ifeq (,$(filter %.dvi,$(TEXTARGETS)))
 293         $(RM) *.dvi
 294 endif
 295
 296 # xbb-cleanターゲット
 297 xbb-clean:
 298         $(RM) *.xbb
 299
 300 # tex-distcleanターゲット
 301 tex-distclean: tex-clean xbb-clean
 302 ifneq (,$(filter %.dvi,$(TEXTARGETS)))
 303         $(RM) *.dvi
 304 endif
 305         $(RM) $(TEXTARGETS)