BACK HOME

フック機能

1 概要

本ドキュメントは、makefw/makefiles/makemain.mk および関連テンプレートファイルに追加する、フック機能の説明ドキュメントです。

1.1 目的

各ディレクトリの makelocal.mk で定義されたカスタムターゲットを、ビルドプロセスの適切なタイミングで自動的に呼び出す仕組みを提供します。

1.2 対象フック

フック名	説明	呼び出しタイミング
`pre-build`	ビルド前処理	`build` ターゲットの処理開始前
`post-build`	ビルド後処理	`build` ターゲットの処理完了後
`pre-clean`	クリーン前処理	`clean` ターゲットの処理開始前
`post-clean`	クリーン後処理	`clean` ターゲットの処理完了後
`pre-test`	テスト前処理	`test` ターゲットの処理開始前
`post-test`	テスト後処理	`test` ターゲットの処理完了後
`install`	インストール処理	`make install` 実行時

1.3 ターゲット未指定時の動作

make をターゲット指定なしで実行した場合、build ターゲットに読み替えます。
make (default) と make build の両方で同じフック処理が実行されます:

2 仕様

2.1 ターゲット定義の検出

GNU Make には、ターゲットが定義されているかを直接検出する標準的な組み込み機能がありません。
$(shell grep ...) を使用して、makelocal.mk ファイル内のターゲット定義を自動検出します。

HAS_PRE_BUILD := $(shell grep -qE '^pre-build[[:space:]]*:' $(MAKELOCAL_MK) 2>/dev/null && echo 1)
HAS_POST_BUILD := $(shell grep -qE '^post-build[[:space:]]*:' $(MAKELOCAL_MK) 2>/dev/null && echo 1)
HAS_INSTALL := $(shell grep -qE '^install[[:space:]]*:' $(MAKELOCAL_MK) 2>/dev/null && echo 1)

2.2 フック呼び出しの条件分岐

テンプレートファイル内で、検出結果に基づいて条件分岐します:

ifdef HAS_PRE_BUILD
_pre_build_hook: pre-build
else
_pre_build_hook:
    @:  # 無処理 (null command)
endif

2.3 install ターゲットのデフォルト定義

install ターゲットは、検出されない場合に無処理のデフォルトターゲットとして定義します:

ifdef HAS_INSTALL
else
.PHONY: install
install:
    @echo "No install target defined in makelocal.mk"
endif

3 使用例

フック機能は grep による自動検出を採用しているため、ユーザーは makelocal.mk にターゲットを定義するだけで有効になります。

3.1 例1: ビルド前にコード生成を行う


.PHONY: pre-build
pre-build:
    @echo "Generating code..."
    python $(WORKSPACE_FOLDER)/tools/codegen.py

3.2 例2: ビルド後にファイルをコピーする


.PHONY: post-build
post-build:
    @echo "Copying configuration files..."
    cp -r $(WORKSPACE_FOLDER)/config/* $(OUTPUT_DIR)/

3.3 例3: install ターゲットを定義する


INSTALL_DIR ?= /usr/local/bin

.PHONY: install
install: $(OUTPUT_DIR)/$(TARGET)
    @echo "Installing to $(INSTALL_DIR)..."
    mkdir -p $(INSTALL_DIR)
    cp $(OUTPUT_DIR)/$(TARGET) $(INSTALL_DIR)/

3.4 例4: 複数のフックを組み合わせる


.PHONY: pre-build post-build install

pre-build:
    @echo "Checking dependencies..."
    ./check_deps.sh

post-build:
    @echo "Running post-build verification..."
    ./verify_build.sh

install: $(OUTPUT_DIR)/$(TARGET)
    @echo "Installing..."
    cp $(OUTPUT_DIR)/$(TARGET) /usr/local/bin/

3.5 例5: エラーの無視

フックターゲット内でエラーが発生した場合、ビルド全体が停止します。エラーを無視したい場合は:

.PHONY: post-build
post-build:
    -some_command_that_may_fail
    another_command || true