latex.mkの推敲
[makefiles.git] / latex_mk / latex.mk
index 05b8673..19b15ad 100644 (file)
@@ -3,7 +3,7 @@
 #
 # == 使い方 ==
 # 1. texソースファイルと同じディレクトリーに本ファイル(latex.mk)をコピーする
-# 2. Makefileに変数TARGETS と「include latex.mk」を記述する
+# 2. Makefileに変数TEXTARGETS と「include latex.mk」を記述する
 # 3. texソースファイルと同じディレクトリーで、make コマンドを実行する
 #
 # == 機能 ==
 #   -- 挿入されたTeXファイルがないときは、処理を中止
 # - \makeindex命令が含まれる場合、mendexで索引を作成
 # - \bibliography命令が含まれる場合、BiBTeXで文献一覧を作成
-
+#
 # == 擬似ターゲット ==
 # - tex-clean: TeX中間ファイル(auxなど)を削除。ターゲットに.dviが含まれていないときは.dviファイルを削除
 # - xbb-clean: バウンディング情報ファイル(.xbb)を削除
 # - tex-distclean: TeX中間ファイル、バウンディング情報ファイル、ターゲットファイル(PDF、.dvi)を削除
 #
 # === Makefile -- sample ===
-# TARGETS := report.tex
+# TEXTARGETS := report.tex
 #
-# all: $(TARGETS)
+# all: $(TEXTARGETS)
 #
 # include latex.mk
-
-.PHONY: tex-clean tex-distclean
+.PHONY: tex-warning tex-clean tex-distclean
 
 # シェルコマンド
 CAT := cat
 CMP := cmp -s
 CP := cp
-ECHO := echo
+ECHO := /bin/echo
 GREP := grep
 SED := sed
+SEQ := seq
 
 # LaTeXコマンド
 LATEX := platex
@@ -47,160 +47,233 @@ EXTRACTBB := extractbb
 BIBTEX := pbibtex
 MENDEX := mendex
 
+#LaTeXオプション
+LATEXFLAG ?=
+DVIPDFMXFLAG ?=
+EXTRACTBBFLAGS ?=
+BIBTEXFLAG ?=
+MENDEXFLAG ?=
+
+tex-warning:
+       @$(ECHO) "check current directory, or set TEXTARGET in Makefile."
+
+# ファイル名から拡張子を除いた部分
+BASE = $(basename $<)
+
 # TeX中間ファイルの拡張子
-#   .aux: 相互参照
+#   .aux: 相互参照
 #   .fls: tex -recorderで生成されるファイルリスト
-#   .lof: 図リスト(\tableoffigures)
-#   .lot: 表リスト(\tableoftables)
-#   .out: hyperrefパッケージ
-#   .toc: 目次(\tableofcontents)
+#   .lof: 図リスト(\tableoffigures)
+#   .lot: 表リスト(\tableoftables)
+#   .out: hyperrefパッケージ
+#   .toc: 目次(\tableofcontents)
 #   .log: ログ
 TEX_INT := .aux .fls .lof .lot .out .toc .log
-
 # 索引中間ファイルの拡張子
 #   .idx: auxから作成
 #   .ind: idxから作成
 #   .ilg: 索引ログ
 IND_INT := .idx .ind .ilg
-
 # BiBTeX中間ファイルの拡張子
 #   .bbl: auxから作成
 #   .blg: BiBTeXログ
 BIB_INT := .bbl .blg
 
-# ファイル名から拡張子を除いた部分
-FILEBASE = $(basename $<)
-# .texファイル
-TEXFILE = $(addsuffix .tex,$(FILEBASE))
-# .auxファイル
-AUXFILE = $(addsuffix .aux,$(FILEBASE))
-# .prev_auxファイル。.auxファイルのコピー
-PREV_AUXFILE = $(addsuffix .prev_aux,$(FILEBASE))
-# .dviファイル
-DVIFILE = $(addsuffix .dvi,$(FILEBASE))
-# .dファイル
-DFILE = $(addsuffix .d,$(FILEBASE))
-# .logファイル
-LOGFILE = $(addsuffix .log,$(FILEBASE))
-# .idxファイル
-IDXFILE = $(addsuffix .idx,$(FILEBASE))
-# .prev_idxファイル。.idxファイルのコピー
-PREV_IDXFILE = $(addsuffix .prev_idx,$(FILEBASE))
-# .indファイル
-INDFILE = $(addsuffix .ind,$(FILEBASE))
-# .bblファイル
-BBLFILE = $(addsuffix .bbl,$(FILEBASE))
+ALL_INTERFILES = $(addprefix *,$(TEX_INT) $(IND_INT) $(BIB_INT) .d .*_prev)
+
+.SECONDARY: $(wildcard ALL_INTERFILES)
+
+# \tableofcontents命令をTeXファイルから検索する
+toc = \
+  $(shell \
+    $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(intex) | \
+    $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+    $(SED) -n -e 's/.*\(\\tableofcontents\)/\1/p' \
+  )
+
+# \listoffigures命令をTeXファイルから検索する
+lof = \
+  $(shell \
+    $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(intex) | \
+    $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+    $(SED) -n -e 's/.*\(\\listoffigures\)/\1/p' \
+  )
+
+# \listoftables命令をTeXファイルから検索する
+lot = \
+  $(shell \
+     $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(intex) | \
+     $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+     $(SED) -n -e 's/.*\(\\listoftables\)/\1/p' \
+   )
+
+# \makeindex命令をTeXファイルから検索する
+makeindex = \
+  $(shell \
+    $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(intex) | \
+    $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+    $(SED) -n -e 's/.*\(\\makeindex\)/\1/p' \
+  )
+
+# \bibliography命令で読み込まれる文献データベースファイルをTeXファイルから検索する
+bibdb = \
+  $(addsuffix .bib,$(basename $(strip $(shell \
+     $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(intex) | \
+     $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+     $(SED) -n -e 's/\\bibliography\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
+     $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' | \
+     $(SED) -e 's/,/ /g' \
+   ))))
+
+# hyperrefパッケージ読み込みをTeXファイルから検索する
+hyperref = \
+  $(shell \
+    $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(intex) | \
+    $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+    $(SED) -n -e 's/.*\(\\usepackage\(\[[^]]*\]\)\{0,1\}{hyperref}\)/\1/p'\
+  )
+
+# $(BASE).texで使われるLaTeX中間ファイル
+INTERFILES = \
+  $(strip \
+    $(if $(toc),$(BASE).toc) \
+    $(if $(lof),$(BASE).lof) \
+    $(if $(lot),$(BASE).lot) \
+    $(if $(makeindex),$(BASE).ind) \
+    $(if $(bibdb),$(BASE).bbl) \
+    $(if $(hyperref),$(BASE).out) \
+  )
+
+INTERFILES_PREV = $(addsuffix _prev,$(INTERFILES))
+
+# \include命令で読み込まれるTeXファイル
+includetex = \
+  $(strip $(addsuffix .tex,$(shell \
+    $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex | \
+    $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+    $(SED) -n -e 's/\\include\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
+    $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' \
+  )))
+
+# \input命令で読み込まれるTeXファイル
+define get_inputtex
+  $(strip $(shell \
+    $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $1 | \
+    $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+    $(SED) -n -e 's/\\input\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
+    $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' \
+  ))
+endef
+
+inputtex = $(call get_inputtex,$(BASE).tex $(includetex))
+
+# \include命令または\input命令で読み込まれるTeXファイル
+intex = $(strip $(includetex) $(inputtex))
 
-#LaTeXオプション
-LATEXFLAG ?=
-DVIPDFMXFLAG ?=
-EXTRACTBBFLAGS ?=
-BIBTEXFLAG ?=
-MENDEXFLAG ?=
+# \includegraphics命令で読み込まれるグラフィックファイル
+ingraphics = \
+  $(strip $(shell \
+    $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(intex) | \
+    $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+    $(SED) -n -e 's/\\includegraphics\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
+    $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' \
+  ))
 
 # LaTeX処理(コンパイル)
-COMPILE.tex = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(TEXFILE) || $(CAT) $(LOGFILE)
+LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(BASE).tex
+COMPILE.tex = $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).log; exit 1)
 
 # 相互参照未定義の警告
 WARN_UNDEFREF := 'There were undefined references\.'
 
-# 読み込むべき中間ファイルがないことの警告
-WARN_NOFILE = 'No file $(FILEBASE)\.[a-zA-Z0-9]*\.'
-
-# ログファイルに警告がある場合、LaTeX処理を最大4回繰り返す
+# LaTeX処理
+# ログファイルに警告がある場合は警告がなくなるまで、最大CNTで指定された回数分、処理を実行する
+CNT := 3
 COMPILES.tex = \
-  if test -s $(INDFILE); then \
-    $(ECHO) "---------- for index ----------"; \
-    $(COMPILE.tex); \
-  fi; \
-  for f in 1st 2nd 3rd final; do \
-    if test -s $@ -a -s $(LOGFILE); then \
-      $(GREP) -e $(WARN_UNDEFREF) -e $(WARN_NOFILE) $(LOGFILE) || exit 0; \
-    fi; \
-    $(ECHO) "---------- $$f try ----------"; \
-    $(COMPILE.tex); \
-  done
-
-# \includegraphics命令で読み込まれるグラフィックファイル
-ingraphics = $(strip $(shell \
-  $(SED) -n -e '/^%/!s/\\includegraphics\(\[[^]]*\]\)\{0,1\}\({[^}]*}\)/&\n/gp' $< $(intex) | \
-  $(SED) -e 's/.*{\([^}]*\)}.*/\1/'))
-
-# \include、\input命令で読み込まれるtexファイル
-intex = $(addsuffix .tex,$(basename $(strip $(shell \
-  $(SED) -n -e '/^%/!s/\\\(include\|input\)\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/gp' $< | \
-  $(SED) -e 's/.*{\([^}]*\)}.*/\1/'))))
-
-# \makeindex命令
-makeindex = $(SED) -n -e '/^%/!s/\\makeindex/&/p' $<
-
-# \bibliography命令で読み込まれる文献データベースファイル
-bibdb = $(addsuffix .bib,$(basename $(strip $(shell \
-  $(SED) -n -e '/^%/!s/\\bibliography\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}/&\n/gp' $< $(intex) | \
-  $(SED) -e 's/.*{\([^}]*\)}.*/\1/' | \
-  $(SED) -e 's/,/ /g'))))
+  @(for i in `$(SEQ) 1 $(CNT)`; do \
+      if test -s $@ -a -s $(BASE).log; then \
+        $(GREP) -e $(WARN_UNDEFREF) $(BASE).log || exit 0; \
+      else \
+        $(ECHO) '$@ and/or $(BASE).log does not exist.'; \
+      fi; \
+      $(COMPILE.tex); \
+    done)
+
+# DVI -> PDF
+# 出力結果は.logファイルへ出力
+DVIPDFCMD = $(DVIPDFMX) $(DVIPDFMXFLAG) $(BASE).dvi
+COMPILE.dvi = $(ECHO) $(DVIPDFCMD); $(DVIPDFCMD) >>$(BASE).log 2>&1 || ($(CAT) $(BASE).log; exit 1)
+
+# 索引中間ファイル(.ind)作成
+MENDEXCMD = $(MENDEX) $(MENDEXFLAG) $(BASE).idx
+COMPILE.idx = $(ECHO) $(MENDEXCMD); $(MENDEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).ilg; exit 1)
+
+# 文献リスト中間ファイル(.bbl)作成
+BIBTEXCMD = $(BIBTEX) $(BIBTEXFLAG) $(BASE).aux
+COMPILE.bib = $(ECHO) $(BIBTEXCMD); $(BIBTEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).blg; exit 1)
+
+# ターゲットファイルと必須ファイルを比較し、内容が異なる場合はターゲットファイルの内容を必須ファイルに置き換える
+CMPPREV = $(CMP) $@ $< || $(CP) -p -v $< $@
 
 # 依存関係を.dファイルに書き出す
 %.d: %.tex
-       @$(ECHO) '$@ is created by scanning $^.'
-  # texファイルの依存関係
-       @($(ECHO) '$(AUXFILE) $(DFILE): $<'; \
+       @$(ECHO) '$@ is created by scanning $<.'
+# .dファイルの依存関係
+       @$(ECHO) '$(BASE).d: $(BASE).tex' >$@
+# 中間ファイルの依存関係
+       $(if $(INTERFILES),@( \
       $(ECHO); \
-      $(ECHO) '$(DVIFILE): $(AUXFILE)') >$@
-  # 画像ファイルの依存関係
-       $(if $(ingraphics),@( \
+      $(ECHO) '# LaTeX Intermediate Files'; \
+      $(ECHO) '$(BASE).dvi:: $(INTERFILES_PREV)'; \
+      $(ECHO) '        @$$(COMPILE.tex)'; \
       $(ECHO); \
-      $(ECHO) '# IncludeGraphic Files - .pdf, .jpeg/.jpg, .png with .xbb'; \
-      $(ECHO) '$(DVIFILE) $(AUXFILE): $(ingraphics)'; \
+      $(ECHO) '$(BASE).dvi:: $(BASE).aux'; \
+      $(ECHO) '        @$$(COMPILES.tex)'; \
+    ) >>$@)
+# 画像ファイルの依存関係
+       $(if $(ingraphics),@( \
       $(ECHO); \
-      $(ECHO) '$(DVIFILE) $(AUXFILE): $(addsuffix .xbb,$(basename $(ingraphics)))') >>$@)
-  # Include/Inputファイルの依存関係
+      $(ECHO) '# IncludeGraphic Files - .pdf, .eps, .jpeg/.jpg, .png'; \
+      $(ECHO) '#           .xbb Files - .pdf, .jpeg/.jpg, .png'; \
+      $(ECHO) '$(BASE).aux: $(ingraphics)'; \
+      $(if $(filter-out %.eps,$(ingraphics)), \
+        $(ECHO); \
+        $(ECHO) '$(BASE).aux: $(addsuffix .xbb,$(basename $(filter-out %.eps,$(ingraphics))))'; \
+      ) \
+    ) >>$@)
        $(if $(intex),@( \
       $(ECHO); \
-      $(ECHO) '# Include / Input Files - .tex'; \
-      $(ECHO) '$(DVIFILE) $(AUXFILE): $(intex)') >>$@)
-  # 索引作成用ファイルの依存関係
-       $(if $(makeindex),@( \
-      $(ECHO); \
-      $(ECHO) '# Index Files: .aux -> idx -> .ind -> .dvi'; \
-      $(ECHO) '$(IDXFILE): $<'; \
-      $(ECHO); \
-      $(ECHO) '$(PREV_IDXFILE): $(IDXFILE)'; \
-      $(ECHO); \
-      $(ECHO) '$(INDFILE): $(PREV_IDXFILE)'; \
-      $(ECHO); \
-      $(ECHO) '$(DVIFILE): $(INDFILE)') >>$@)
-  # 文献処理用ファイルの依存関係
+      $(ECHO) '# Files called from \include or \input - .tex'; \
+      $(ECHO) '$(BASE).aux: $(intex)'; \
+    ) >>$@)
+# 文献処理用ファイルの依存関係
        $(if $(bibdb),@( \
       $(ECHO); \
-      $(ECHO) '# Bibliography Files - .bbl, .bib'; \
-      $(ECHO) '$(PREV_AUXFILE): $(AUXFILE)'; \
-      $(ECHO); \
-      $(ECHO) '$(DVIFILE): $(BBLFILE)'; \
-      $(ECHO); \
-      $(ECHO) '$(BBLFILE): $(bibdb)') >>$@)
+      $(ECHO) '# Bibliography files: .aux, BIBDB -> .bbl -> .div'; \
+      $(ECHO) '$(BASE).bbl: $(bibdb) $(BASE).tex'; \
+    ) >>$@)
 
-# 変数TARGETSで指定されたターゲットファイルに対応する
+# 変数TEXTARGETSで指定されたターゲットファイルに対応する
 # .dファイルをインクルードし、依存関係を取得する
-# ターゲットに %clean、%.xbb、%.d が含まれている場合は除く
-ifeq (,$(filter %clean %.xbb %.d,$(MAKECMDGOALS)))
-  -include $(addsuffix .d,$(basename $(TARGETS)))
+# ターゲット末尾に clean、.xbb、.tex、.d が含まれている場合は除く
+ifeq (,$(filter %clean %.xbb %.tex %.d,$(MAKECMDGOALS)))
+  -include $(addsuffix .d,$(basename $(TEXTARGETS)))
 endif
 
-# dviファイル作成
-%.dvi: %.tex
-       $(COMPILES.tex)
-
 # auxファイル作成
 %.aux: %.tex
-       $(COMPILE.tex)
+       @$(COMPILE.tex)
 
-%.prev_aux: %.aux
-       -$(CMP) $@ $< || $(CP) $< $@
+%.dvi: %.aux
+       @$(COMPILES.tex)
+
+%.dvi: %.tex
+       @$(COMPILE.tex)
+       @$(COMPILES.tex)
 
 # PDFファイル作成
 %.pdf: %.dvi
-       $(DVIPDFMX) $(DVIPDFMXFLAG) $<
+       @$(COMPILE.dvi)
 
 # バウンディング情報ファイル作成
 # pdf、jpeg/jpg、pngファイルに対応
@@ -216,24 +289,59 @@ endif
 %.xbb: %.png
        $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
 
-# 索引ファイル作成
+# 目次中間ファイル作成
+%.toc: %.tex
+       @$(MAKE) -s $(BASE).aux
+
+%.toc_prev: %.toc
+       @$(CMPPREV)
+
+# 図リスト中間ファイル作成
+%.lof: %.tex
+       @$(MAKE) -s $(BASE).aux
+
+%.lof_prev: %.lof
+       @$(CMPPREV)
+
+# 表リスト中間ファイル作成
+%.lot: %.tex
+       @$(MAKE) -s $(BASE).aux
+
+%.lot_prev: %.lot
+       @$(CMPPREV)
+
+# 索引中間ファイル作成
 %.idx: %.tex
-       $(COMPILE.tex)
+       @$(MAKE) -s $(BASE).aux
+
+%.idx_prev: %.idx
+       @$(CMPPREV)
+
+%.ind: %.idx_prev
+       @$(COMPILE.idx)
+
+%.ind_prev: %.ind
+       @$(CMPPREV)
+
+# BiBTeX中間ファイル作成
+%.bbl: %.tex
+       @$(MAKE) -s $(BASE).aux
+       @$(COMPILE.bib)
 
-%.prev_idx: %.idx
-       -$(CMP) $@ $< || $(CP) $< $@
+%.bbl_prev: %.bbl
+       @$(CMPPREV)
 
-%.ind: %.prev_idx
-       $(MENDEX) $(MENDEXFLAG) $(IDXFILE)
+# hyperref中間ファイル作成
+%.out: %.tex
+       @$(MAKE) -s $(BASE).aux
 
-# 文献処理用ファイル作成
-%.bbl: %.prev_aux
-       $(BIBTEX) $(BIBTEXFLAG) $(AUXFILE)
+%.out_prev: %.out
+       @$(CMPPREV)
 
 # tex-cleanターゲット
 tex-clean:
-       $(RM) $(addprefix *,$(TEX_INT) $(IND_INT) $(BIB_INT) .d .prev_aux .prev_idx)
-ifeq (,$(filter %.dvi,$(TARGETS)))
+       $(RM) $(ALL_INTERFILES)
+ifeq (,$(filter %.dvi,$(TEXTARGETS)))
        $(RM) *.dvi
 endif
 
@@ -243,7 +351,7 @@ xbb-clean:
 
 # tex-distcleanターゲット
 tex-distclean: tex-clean xbb-clean
-ifneq (,$(filter %.dvi,$(TARGETS)))
+ifneq (,$(filter %.dvi,$(TEXTARGETS)))
        $(RM) *.dvi
 endif
-       $(RM) $(TARGETS)
+       $(RM) $(TEXTARGETS)