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: warning tex-clean tex-distclean
  33
  34 # シェルコマンド
  35 CAT := cat
  36 CMP := cmp -s
  37 CP := cp
  38 ECHO := echo
  39 GREP := grep
  40 SED := sed
  41
  42 warning:
  43         @$(ECHO) "check current directory, or set TARGET in Makefile."
  44
  45 # LaTeXコマンド
  46 LATEX := platex
  47 DVIPDFMX := dvipdfmx
  48 EXTRACTBB := extractbb
  49 BIBTEX := pbibtex
  50 MENDEX := mendex
  51
  52 # TeX中間ファイルの拡張子
  53 #   .aux: 相互参照
  54 #   .fls: tex -recorderで生成されるファイルリスト
  55 #   .lof: 図リスト（\tableoffigures）
  56 #   .lot: 表リスト（\tableoftables）
  57 #   .out: hyperrefパッケージ
  58 #   .toc: 目次（\tableofcontents）
  59 #   .log: ログ
  60 TEX_INT := .aux .fls .lof .lot .out .toc .log
  61 # 索引中間ファイルの拡張子
  62 #   .idx: auxから作成
  63 #   .ind: idxから作成
  64 #   .ilg: 索引ログ
  65 IND_INT := .idx .ind .ilg
  66 # BiBTeX中間ファイルの拡張子
  67 #   .bbl: auxから作成
  68 #   .blg: BiBTeXログ
  69 BIB_INT := .bbl .blg
  70
  71 .SECONDARY: $(wildcard $(addsuffix $(TEX_INT) $(IND_INT) $(BIB_INT) .d,*))
  72
  73 # \tableofcontents命令
  74 toc = $(shell $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\tableofcontents/!s/.*\(\\tableofcontents\).*/\1/p' $<)
  75
  76 # \listoffigures命令
  77 lof = $(shell $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\listoffigures/!s/.*\(\\listoffigures\).*/\1/p' $<)
  78
  79 # \listoftables命令
  80 lot = $(shell $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\listoftables/!s/.*\(\\listoftables\).*/\1/p' $<)
  81
  82 # \makeindex命令
  83 makeindex = $(shell $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\makeindex/!s/.*\(\\makeindex\).*/\1/p' $<)
  84
  85 # \bibliography命令で読み込まれる文献データベースファイル
  86 bibdb = $(addsuffix .bib,$(basename $(strip $(shell \
  87   $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\bibliography/!s/\\bibliography\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}/&\n/gp' $< $(intex) | \
  88   $(SED) -e 's/.*{\([^}]*\)}.*/\1/' | \
  89   $(SED) -e 's/,/ /g'))))
  90
  91 # hyperrefパッケージ読み込み
  92 hyperref = $(shell $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\usepackage\(\[[^]]*\]\)\{0,1\}{hyperref}/!s/.*\(\\usepackage\)\(\[[^]]*\]\)\{0,1\}\({hyperref}\).*/\1\3/p' $<)
  93
  94 # ファイル名から拡張子を除いた部分
  95 BASE = $(basename $<)
  96
  97 # .texファイル
  98 TEXFILE = $(addsuffix .tex,$(BASE))
  99
 100 # .auxファイル
 101 AUXFILE = $(addsuffix .aux,$(BASE))
 102 # .prev_auxファイル
 103 PREV_AUXFILE = $(addsuffix .prev_aux,$(BASE))
 104
 105 # .dviファイル
 106 DVIFILE = $(addsuffix .dvi,$(BASE))
 107
 108 # .dファイル
 109 DFILE = $(addsuffix .d,$(BASE))
 110
 111 # .logファイル
 112 LOGFILE = $(addsuffix .log,$(BASE))
 113
 114 # .tocファイル
 115 TOCFILE = $(addsuffix .toc,$(BASE))
 116 # .prev_tocファイル。.tocファイルのコピー
 117 PREV_TOCFILE = $(addsuffix .prev_toc,$(BASE))
 118
 119 # .lofファイル
 120 LOFFILE = $(addsuffix .lof,$(BASE))
 121 # .prev_lofファイル。.lofファイルのコピー
 122 PREV_LOFFILE = $(addsuffix .prev_lof,$(BASE))
 123
 124 # .lotファイル
 125 LOTFILE = $(addsuffix .lot,$(BASE))
 126 # .prev_lotファイル。.lotファイルのコピー
 127 PREV_LOTFILE = $(addsuffix .prev_lot,$(BASE))
 128
 129 # .idxファイル
 130 IDXFILE = $(addsuffix .idx,$(BASE))
 131 # .prev_idxファイル。.idxファイルのコピー
 132 PREV_IDXFILE = $(addsuffix .prev_idx,$(BASE))
 133
 134 # .indファイル
 135 INDFILE = $(addsuffix .ind,$(BASE))
 136 # .prev_indファイル。.indファイルのコピー
 137 PREV_INDFILE = $(addsuffix .prev_ind,$(BASE))
 138
 139 # .ilgファイル
 140 ILGFILE = $(addsuffix .ilg,$(BASE))
 141
 142 # .bblファイル
 143 BBLFILE = $(addsuffix .bbl,$(BASE))
 144 # .prev_bblファイル。.bblファイルのコピー
 145 PREV_BBLFILE = $(addsuffix .prev_bbl,$(BASE))
 146
 147 # .bblファイル
 148 BLGFILE = $(addsuffix .blg,$(BASE))
 149
 150 # .outファイル
 151 OUTFILE = $(addsuffix .out,$(BASE))
 152 # .prev_outファイル。.outファイルのコピー
 153 PREV_OUTFILE = $(addsuffix .prev_out,$(BASE))
 154
 155 #LaTeXオプション
 156 LATEXFLAG ?=
 157 DVIPDFMXFLAG ?=
 158 EXTRACTBBFLAGS ?=
 159 BIBTEXFLAG ?=
 160 MENDEXFLAG ?=
 161
 162 # LaTeX処理（コンパイル）
 163 LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(TEXFILE)
 164 COMPILE.tex = $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || ($(CAT) $(LOGFILE); exit 1)
 165
 166 # 索引中間ファイル（.ind）作成
 167 MENDEXCMD = $(MENDEX) $(MENDEXFLAG) $(IDXFILE)
 168 COMPILE.idx = $(ECHO) $(MENDEXCMD); $(MENDEXCMD) >/dev/null 2>&1 || ($(CAT) $(ILGFILE); exit 1)
 169
 170 # 文献リスト中間ファイル（.bbl）作成
 171 BIBTEXCMD = $(BIBTEX) $(BIBTEXFLAG) $(AUXFILE)
 172 COMPILE.bib = $(ECHO) $(BIBTEXCMD); $(BIBTEXCMD) >/dev/null 2>&1 || ($(CAT) $(BLGFILE); exit 1)
 173
 174 # 相互参照未定義の警告
 175 WARN_UNDEFREF := 'There were undefined references\.'
 176 # 読み込むべき中間ファイルがないことの警告
 177 WARN_NOFILE = 'No file $(BASE)\.[a-zA-Z0-9]*\.'
 178
 179 # LaTeX処理
 180 # 索引ファイルがある場合、1回処理する
 181 # ログファイルに警告がある場合、警告がなくなるまで最大4回処理する
 182 COMPILES.tex = \
 183   @(for f in 1st 2nd 3rd final; do \
 184       if test -s $@ -a -s $(LOGFILE); then \
 185         $(GREP) -e $(WARN_UNDEFREF) $(LOGFILE) || exit 0; \
 186       fi; \
 187       $(COMPILE.tex); \
 188     done)
 189
 190 # *.*ファイルと *.prev_*ファイルを比較し、*.*ファイルが更新されている場合はその内容を*.prev_* にコピーする
 191 CMPPREV = $(CMP) $@ $< || $(CP) -v $< $@
 192
 193 # \include、\input命令で読み込まれるtexファイル
 194 intex = $(addsuffix .tex,$(basename $(strip $(shell \
 195   $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\\(include\|input\)/!s/\\\(include\|input\)\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/gp' $< | \
 196   $(SED) -e 's/.*{\([^}]*\)}.*/\1/'))))
 197
 198 # \includegraphics命令で読み込まれるグラフィックファイル
 199 ingraphics = $(strip $(shell \
 200   $(SED) -n -e '/^.*[^\]\{0,1\}%.*\\includegraphics/!s/\\includegraphics\(\[[^]]*\]\)\{0,1\}\({[^}]*}\)/&\n/gp' $< $(intex) | \
 201   $(SED) -e 's/.*{\([^}]*\)}.*/\1/'))
 202
 203 # 依存関係を.dファイルに書き出す
 204 %.d: %.tex
 205         @$(ECHO) '$@ is created by scanning $^.'
 206 # TeX、.aux、.dvi、.dファイルの依存関係
 207         @($(ECHO) '$(AUXFILE) $(DFILE): $(TEXFILE)'; \
 208       $(ECHO); \
 209       $(ECHO) '$(DVIFILE): $(AUXFILE)' \
 210               $(if $(toc),'$(PREV_TOCFILE)') \
 211               $(if $(lof),'$(PREV_LOFFILE)') \
 212               $(if $(lot),'$(PREV_LOTFILE)') \
 213               $(if $(makeindex),'$(PREV_INDFILE)') \
 214               $(if $(bibdb),'$(PREV_BBLFILE)') \
 215               $(if $(hyperref),'$(PREV_OUTFILE)') \
 216     ) >$@
 217         $(if $(strip $(toc) $(lof) $(lot) $(makeindex) $(bibdb) $(hyperref)),@( \
 218       $(ECHO) ' @$$(COMPILE.tex)'; \
 219       $(ECHO) ' @$$(COMPILES.tex)'; \
 220     ) >>$@)
 221 # 画像ファイルの依存関係
 222         $(if $(ingraphics),@( \
 223         $(ECHO); \
 224         $(ECHO) '# IncludeGraphic Files - .pdf, .jpeg/.jpg, .png with .xbb'; \
 225         $(ECHO) '$(AUXFILE): $(ingraphics)'; \
 226         $(ECHO); \
 227         $(ECHO) '$(AUXFILE): $(addsuffix .xbb,$(basename $(filter-out %.eps,$(ingraphics))))'; \
 228     ) >>$@)
 229 # \includeまたは\input命令で読み込まれるTeXファイルの依存関係
 230         $(if $(intex),@( \
 231         $(ECHO); \
 232         $(ECHO) '# Files called from \include or \input - .tex'; \
 233         $(ECHO) '$(AUXFILE): $(intex)'; \
 234     ) >>$@)
 235 # 索引作成用ファイルの依存関係: .aux -> idx -> .ind -> .dvi
 236         $(if $(makeindex),@( \
 237         $(ECHO); \
 238         $(ECHO) '# Index files: .tex -> .idx -> .ind -> .dvi'; \
 239         $(ECHO) '$(IDXFILE): $(TEXFILE)'; \
 240         $(ECHO); \
 241         $(ECHO) '$(PREV_IDXFILE): $(IDXFILE)'; \
 242         $(ECHO); \
 243         $(ECHO) '$(INDFILE): $(PREV_IDXFILE)'; \
 244         $(ECHO); \
 245         $(ECHO) '$(PREV_INDFILE): $(INDFILE)'; \
 246     ) >>$@)
 247   # 文献処理用ファイルの依存関係
 248         $(if $(bibdb),@( \
 249         $(ECHO); \
 250         $(ECHO) '# Bibliography files: .aux, BIBDB -> .bbl -> .div'; \
 251         $(ECHO) '$(BBLFILE): $(bibdb) $(AUXFILE)'; \
 252         $(ECHO); \
 253         $(ECHO) '$(PREV_BBLFILE): $(BBLFILE)'; \
 254     ) >>$@)
 255
 256 # 変数TEXTARGETSで指定されたターゲットファイルに対応する
 257 # .dファイルをインクルードし、依存関係を取得する
 258 # ターゲットに %clean、%.xbb、%.d が含まれている場合は除く
 259 ifeq (,$(filter %clean %.xbb %.d,$(MAKECMDGOALS)))
 260   -include $(addsuffix .d,$(basename $(TEXTARGETS)))
 261 endif
 262
 263 # auxファイル作成
 264 %.aux: %.tex
 265         @$(COMPILE.tex)
 266
 267 # prev_auxファイル作成
 268 %.prev_aux: %.aux
 269         @$(CMPPREV)
 270
 271 # dviファイル作成
 272 %.dvi: %.aux
 273         $(COMPILES.tex)
 274
 275 # PDFファイル作成
 276 %.pdf: %.dvi
 277         $(DVIPDFMX) $(DVIPDFMXFLAG) $<
 278
 279 # バウンディング情報ファイル作成
 280 # pdf、jpeg/jpg、pngファイルに対応
 281 %.xbb: %.pdf
 282         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 283
 284 %.xbb: %.jpeg
 285         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 286
 287 %.xbb: %.jpg
 288         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 289
 290 %.xbb: %.png
 291         $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 292
 293 # 目次中間ファイル作成
 294 %.toc: %.prev_aux
 295         @$(COMPILE.tex)
 296
 297 %.prev_toc: %.toc
 298         @$(CMPPREV)
 299
 300 # 図リスト中間ファイル作成
 301 %.lof: %.prev_aux
 302         @$(COMPILE.tex)
 303
 304 %.prev_lof: %.lof
 305         @$(CMPPREV)
 306
 307 # 表リスト中間ファイル作成
 308 %.lot: %.prev_aux
 309         @$(COMPILE.tex)
 310
 311 %.prev_lot: %.lot
 312         @$(CMPPREV)
 313
 314 # hyperrefパッケージ中間ファイル作成
 315 %.lot: %.prev_aux
 316         @$(COMPILE.tex)
 317
 318 %.prev_lot: %.lot
 319         @$(CMPPREV)
 320
 321 # 索引中間ファイル作成
 322 %.idx: %.prev_aux
 323         @$(COMPILE.tex)
 324
 325 %.prev_idx: %.idx
 326         @$(CMPPREV)
 327
 328 %.ind: %.prev_idx
 329         @$(COMPILE.idx)
 330
 331 %.prev_ind: %.ind
 332         @$(CMPPREV)
 333
 334 # BiBTeX中間ファイル作成
 335 %.bbl: %.prev_aux
 336         @$(COMPILE.bib)
 337
 338 %.prev_bbl: %.bbl
 339         @$(CMPPREV)
 340
 341 # hyperref中間ファイル作成
 342 %.out: %.prev_aux
 343         @$(COMPILE.out)
 344
 345 %.prev_out: %.out
 346         @$(CMPPREV)
 347
 348 %.dvi: %.prev_out
 349         @$(COMPILE.tex)
 350
 351 # tex-cleanターゲット
 352 tex-clean:
 353         $(RM) $(addprefix *, \
 354       $(TEX_INT) $(IND_INT) $(BIB_INT) .d \
 355       .prev_aux .prev_toc .prev_lof .prev_lot \
 356       .prev_idx .prev_ind .prev_bbl .prev_out \
 357     )
 358 ifeq (,$(filter %.dvi,$(TEXTARGETS)))
 359         $(RM) *.dvi
 360 endif
 361
 362 # xbb-cleanターゲット
 363 xbb-clean:
 364         $(RM) *.xbb
 365
 366 # tex-distcleanターゲット
 367 tex-distclean: tex-clean xbb-clean
 368 ifneq (,$(filter %.dvi,$(TEXTARGETS)))
 369         $(RM) *.dvi
 370 endif
 371         $(RM) $(TEXTARGETS)