# makepart.mk / makechild.mk / makelocal.mk について

# 1 概要

makefw フレームワークでは、ビルド設定のカスタマイズに 3 種類の設定ファイルを提供しています。
これらのファイルにより、最終階層の makefile を一切編集することなく、プロジェクト固有の設定を柔軟に管理できます。

ファイル | スコープ | 適用対象
--- | --- | ---
`makepart.mk` | 階層継承 (親→子に伝播) | 自ディレクトリ + 子階層すべて
`makechild.mk` | 子階層限定 (自身は除く) | 子階層以降のみ (自ディレクトリは除く)
`makelocal.mk` | 自ディレクトリ限定 | 自ディレクトリのみ

# 2 makepart.mk

## 2.1 役割

`makepart.mk` は、makefw フレームワークにおける主要なカスタマイズ手段です。
最終階層の makefile はすべて統一テンプレート (`__template.mk`) で統一されており、プロジェクト固有の設定はすべて `makepart.mk` に記述します。

## 2.2 階層継承の仕組み

`makepart.mk` は `prepare.mk` により、ワークスペースルートからカレントディレクトリまでの各階層のものが順次インクルードされます。
親階層で定義した設定が子階層に継承されるため、共通設定を上位に、固有設定を下位に配置できます。

    prod/
    +-- makepart.mk          # LIBS += baselib (子階層すべてに継承)
    +-- myapp/
        +-- makepart.mk      # OUTPUT_DIR = ... (子階層すべてに継承)
        +-- libsrc/
            +-- mylib/
                +-- makefile # 上記すべての設定が有効

上記の例で `prod/myapp/libsrc/mylib/` でビルドを実行すると、インクルード順は以下のようになります。

1. `prod/makepart.mk`
2. `prod/myapp/makepart.mk`

いずれの設定もカレントディレクトリのビルドに適用されます。

## 2.3 検索と読み込みの仕組み

`prepare.mk` 内で、カレントディレクトリからワークスペースルート (`.workspaceRoot` ファイルが存在するディレクトリ) まで遡って `makepart.mk` を検索し、逆順 (親階層から) にインクルードします。

    MAKEPART_MK := $(shell \
        dir=`pwd`; \
        while [ "$$dir" != "/" ]; do \
            if [ -f "$$dir/makepart.mk" ]; then \
                echo "$$dir/makepart.mk"; \
            fi; \
            if [ -f "$$dir/.workspaceRoot" ]; then \
                break; \
            fi; \
            dir=$${dir%/*}; \
            if [ -z "$$dir" ]; then dir=/; fi; \
        done \
    )

    _reverse = $(if $(1),$(call _reverse,$(wordlist 2,$(words $(1)),$(1))) $(firstword $(1)))
    MAKEPART_MK := $(strip $(call _reverse,$(MAKEPART_MK)))

## 2.4 主な設定項目

変数 | 説明 | 例
--- | --- | ---
`LIBS` | リンクするライブラリ | `LIBS += calcbase`
`LIBSDIR` | ライブラリ検索パス | `LIBSDIR += $(WORKSPACE_FOLDER)/lib`
`CFLAGS` | C コンパイラフラグ | `CFLAGS += -DMYAPP_VERSION=\"1.0.0\"`
`CXXFLAGS` | C++ コンパイラフラグ | `CXXFLAGS += -std=c++17`
`OUTPUT_DIR` | 出力先ディレクトリ | `OUTPUT_DIR := $(WORKSPACE_FOLDER)/prod/calc/bin`
`LIB_TYPE` | ライブラリ種別 | `LIB_TYPE = shared` (デフォルトは static)
`LINK_TEST` | テストフレームワークリンク | `LINK_TEST = 1`
`TEST_SRCS` | テスト対象ソースファイル | `TEST_SRCS := $(WORKSPACE_FOLDER)/prod/.../add.c`

## 2.5 記述例

例1: 動的ライブラリの指定

    LIBS += calcbase

    ifeq ($(OS),Windows_NT)
        # Windows: DLL エクスポート定義
        CFLAGS   += /DCALC_EXPORTS
        CXXFLAGS += /DCALC_EXPORTS
    endif

    LIB_TYPE = shared

例2: 実行体の出力先統一

    OUTPUT_DIR := $(WORKSPACE_FOLDER)/prod/calc/bin

例3: テスト共通設定

    LINK_TEST = 1

    ifeq ($(OS),Windows_NT)
        CFLAGS   += /DCALC_STATIC
        CXXFLAGS += /DCALC_STATIC
    endif

    LIBSDIR += \
        $(WORKSPACE_FOLDER)/testfw/lib \
        $(WORKSPACE_FOLDER)/test/lib

例4: テスト対象ソースの指定

    TEST_SRCS := \
        $(WORKSPACE_FOLDER)/prod/calc/libsrc/calcbase/add.c

# 3 makechild.mk

## 3.1 役割

`makechild.mk` は、自身より1つ下の階層以降 にのみ適用される設定ファイルです。
定義した内容は自ディレクトリには適用されず、子階層以降にのみ有効です。

`makepart.mk` は自ディレクトリを含む子階層すべてに継承されますが、「自ディレクトリには適用したくないが、すべての子ディレクトリには共通して適用したい」設定を記述するのが `makechild.mk` の役割です。

## 3.2 スコープの詳細

以下のディレクトリ構成を例に説明します。

    prod/
    +-- makechild.mk          # ← (A)
    +-- myapp/
        +-- makechild.mk      # ← (B)
        +-- libsrc/
            +-- mylib/
                +-- makefile  # ← ここでビルド実行

`prod/myapp/libsrc/mylib/` でビルドを実行した場合:

ファイル | 適用されるか
--- | ---
`prod/makechild.mk` (A) | 適用される (`mylib/` は `prod/` の子孫)
`prod/myapp/makechild.mk` (B) | 適用される (`mylib/` は `myapp/` の子孫)

`prod/myapp/` でビルドを実行した場合:

ファイル | 適用されるか
--- | ---
`prod/makechild.mk` (A) | 適用される (`myapp/` は `prod/` の子)
`prod/myapp/makechild.mk` (B) | 適用されない (自ディレクトリは除く)

## 3.3 実装

各 `makepart.mk` のインクルード直後に、同ディレクトリの `makechild.mk` が存在すれば続けてインクルードされます。
ただしカレントディレクトリの `makechild.mk` は除外されます。

    define _include_makepart_and_child
    $(eval include $(1))$(if $(filter-out $(CURDIR)/makepart.mk,$(1)),$(eval -include $(patsubst %/makepart.mk,%/makechild.mk,$(1))))
    endef

    $(foreach makepart, $(MAKEPART_MK), $(call _include_makepart_and_child,$(makepart)))

- `$(filter-out $(CURDIR)/makepart.mk,$(1))` でカレントディレクトリを除外
- `$(patsubst %/makepart.mk,%/makechild.mk,$(1))` でパスを `makechild.mk` に変換
- `-include` を使用することで、ファイルが存在しない場合もエラーにならない

## 3.4 記述例

例1: 子ディレクトリ全体に共通フラグを追加

    CFLAGS += -DMYAPP_CHILD_BUILD

例2: 子ディレクトリ全体への出力先設定

    OUTPUT_DIR := $(WORKSPACE_FOLDER)/bin/myapp

# 4 makelocal.mk

## 4.1 役割

`makelocal.mk` は、自ディレクトリに限定される設定ファイルです。
`makepart.mk` の階層継承とは異なり、定義した内容は子階層に継承されません。

特定のディレクトリのみに適用したい設定 (フック、ローカルフラグなど) を `makepart.mk` に定義すると、そのディレクトリ以下のすべてのサブフォルダでも有効になってしまいます。
このような場合に `makelocal.mk` を使用します。

## 4.2 実装

`prepare.mk` の最後で、カレントディレクトリの `makelocal.mk` を読み込みます。

    -include $(CURDIR)/makelocal.mk

- `-include` を使用することで、ファイルが存在しない場合もエラーにならない
- `$(CURDIR)` はカレントディレクトリを指すため、継承は発生しない

## 4.3 記述例

例1: ディレクトリ固有の変数設定

    EXTRA_LDFLAGS := -lspeciallib

例2: フックターゲットの定義

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

# 5 インクルード順序

3 種類の設定ファイルは、`prepare.mk` 内で以下の順序でインクルードされます。

    1. prepare.mk
       +-- /a/makepart.mk          (親: 自ディレクトリ含む継承)
       +-- /a/makechild.mk         (親: 子階層以降に適用 ← makepart.mk の直後)
       +-- /a/b/makepart.mk        (中間: 継承)
       +-- /a/b/makechild.mk       (中間: 子階層以降に適用 ← makepart.mk の直後)
       +-- /a/b/c/makepart.mk      (カレント: 継承)
       ※ /a/b/c/makechild.mk は除く (カレントディレクトリのため)
       +-- makelocal.mk            (自ディレクトリのみ、継承なし)

    2. makemain.mk
       +-- テンプレート (makelibsrc_c_cpp.mk など)

各ディレクトリレベルごとに `makepart.mk` → `makechild.mk` の順でインクルードされ、最後にカレントディレクトリの `makelocal.mk` が読み込まれます。

# 6 配置の指針

設定項目 | 配置先 | 理由
--- | --- | ---
`LIBS`, `LIBSDIR` | makepart.mk | 自ディレクトリ含む子階層に継承させたい
`CFLAGS`, `CXXFLAGS` | makepart.mk | 共通のコンパイルオプション (自身も含む)
`OUTPUT_DIR` | makepart.mk | 出力先の統一
`LIB_TYPE` | makepart.mk | ライブラリ種別の指定
`TEST_SRCS` | makepart.mk | テスト対象ソースの指定
子のみに適用するフラグ | makechild.mk | 自ディレクトリには適用させたくない
子のみへの出力先設定 | makechild.mk | 自ディレクトリのビルドは別設定にしたい
フックターゲット | makelocal.mk | 自ディレクトリのみに限定
ローカル変数 | makelocal.mk | 継承させたくない設定

# 7 併用例

    LIBS += mybaselib

    CFLAGS += -DCHILD_ONLY_FLAG

    MY_LOCAL_VAR := 1

この構成により、`prod/myapp/` でビルドした場合:
- `LIBS += mybaselib` が適用される (makepart.mk)
- `CFLAGS += -DCHILD_ONLY_FLAG` は適用されない (makechild.mk は自身を除く)
- `MY_LOCAL_VAR := 1` が適用される (makelocal.mk)

`prod/myapp/libsrc/mylib/` でビルドした場合:
- `LIBS += mybaselib` が適用される (makepart.mk が継承)
- `CFLAGS += -DCHILD_ONLY_FLAG` が適用される (makechild.mk が子階層に適用)
- `MY_LOCAL_VAR := 1` は適用されない (makelocal.mk は自ディレクトリ限定)