undef でデフォルト設定を実現しているやつをどうにかする

[sksat]

概要

こういうやつ:

c2a-core/Examples/minimum_user/src/src_user/Settings/System/obc_time_params.h

Lines 8 to 16 in 6a70ce9

	#undef OBCT_STEP_IN_MSEC
	#undef OBCT_STEPS_PER_CYCLE
	#undef OBCT_CYCLES_PER_SEC
	#undef OBCT_MAX_CYCLE
	#define OBCT_STEP_IN_MSEC (1)
	#define OBCT_STEPS_PER_CYCLE (100)
	#define OBCT_CYCLES_PER_SEC (1000 / OBCT_STEP_IN_MSEC / OBCT_STEPS_PER_CYCLE)
	#define OBCT_MAX_CYCLE (0xfffffff0u)

詳細

• 現状，core のヘッダでデフォルトの設定値を define しておいて，その直後で user の settings のヘッダを include しておき，user 側で undef して書き換える，というのが横行している
• これは以下の理由でとてもよくないため，どうにかしたい
  • 一般に #undef を多用するのはアンチパターン
  • define によって実現したいのは「定数値」の表現なのに，途中で書き換わっている
    • define してから undef して再 define するまでの間にその値を使ったら容易に壊れる
    • ↑これは「（undef するようなものは）このタイミングで値を使わないこと」といった規約やコメントでの 激しい 主張をしているならば事故を多少防げるが，現状はそうなっているわけでもない（おそらく暗黙知にはなっているだろうけれど）
  • なんのために core -> user の依存関係が発生しているのかが不明瞭
  • 「undef したらオーバーライドできる」というのは一種の分岐なので，同じことを実現するとしても分岐が発生していることが明確になるようにすべき（つまり，ifdef すべき）
  • ↑この分岐（core のデフォルト設定を使うのか，user 定義のものを使うのか）はビルド時の設定として表現すべき

close条件

undef が全部ないし問題ない程度に消えるなどしてどうにかなったら

[sksat]

それはそれとして，c2a-core のインターフェース定義をするヘッダと，c2a-core が設定値のデフォルト値を提供するヘッダは分割したい

[sksat]

c2a-core/Settings/default_hoge.h みたいなかんじになるのかな