Skip to content

Latest commit

 

History

History
295 lines (230 loc) · 6.48 KB

omake.md

File metadata and controls

295 lines (230 loc) · 6.48 KB
Raw

OMake に関するメモ

もっとも大事なこと

Dynamic scoping

X=1
GETX() =
  return $(X)
X=2
eprintln($(GETX)) # 2

代入がない

X=1
F() =
  eprintln($(X)) # 1
  X=2  # Xに1を代入するわけではない
  eprintln($(X)) # 2
F()
eprintln($(X)) # 1

これは次のOCamlプログラムとだいたい同じ:

let x = 1 in (* let x = ref 1 ではない *)
let f () = 
  print_int x;
  let x = 2 in (* x := 2 ではない *)
  print_int x
in
f ();
print_int x

でも関数から外の環境をいじりたい

変数代入もなくI/Oとdynamic scoping以外は純粋関数型っぽいが、 ビルドルールを書いているとスコープの外の変数の値を変化させたい事が多い。 exportを使うとこれができる

X=1
SETX()=
  export X # X の値を上のスコープに伝える
  X=2
SETX()
eprintln($(X)) # 2

OCamlでは「だいたい」こうなる:

let x = 1
let setx () =
  let x = 2 in
  x
in
let x = setx () in 
print_int x

「だいたい」というのはSETX自体が関数なので関数の返り値とexportで出す値の 両方があるともうちょっと違った翻訳になるから。

exportも外側のスコープにある変数への代入ではなく、外側のスコープでの変数定義なので、 存在していない変数束縛でも作ることができる:

MAKEY()=
  export Y
  Y = 3
MAKEY()
eprintln($(Y)) # 3

ルールと関数は違う!そしてsectionについて

いや、当たり前ですけど。たまにルール内で関数みたいなコードを書いておかしいなあとなるので。

hello.c:
    FP=1
    eprintln($(FP))         # unbound variable: global.FP
    echo "hello" > hello.c

FP=2
hello.c:
    FP=1
    eprintln($(FP))         # 2 !!!
    echo "hello" > hello.c

ルールのボディはコマンド列であって式列ではないのですね。 ルール中で変数を変更したい場合は、section を使って式列を書きましょう:

FP=2
hello.c:
    section
        FP=1
        eprintln($(FP))         # 1 !!!
        echo "hello" > hello.c

関数の呼び出し

関数の定義:

f(x) =
  eprintln(arg=$(x))
  value $(x)

呼出し方法が二つある。まず GNU-make っぽい文法 $(f args,...):

$(f 1)   # x=1
x=$(f 2) # x=2

普通の関数呼出し f(args,..) も書けるけど、戻り値が使えないことに注意！

f(3)              # x = 3
x=f(4)            # x="f(4)" と評価される!!
eprintln(x=$(x))  # x="f(4)"

関数呼び出しについてもう一つ。ルール内部で f(args,...) は使わないほうが良い:

.PHONY:poi
poi:
  $(eprintln Just a message)
  eprintln(Very noisy)

eprintln(..) はいろいろ出力して目障り:

$ omake poi
*** omake: finished reading OMakefiles (0.01 sec)
Just a message
- build . <poi>                              <------ うるさい
+ global.eprintln(("Very", ' ', "noisy"))    <------ うるさい
Very noisy
*** omake: done (0.01 sec, 0/0 scans, 1/1 rules, 0/19 digests)

次に大事なこと

export いろいろ

Reference manual の "Exporting the environment" はよく読む必要がある。まず読んだ上で。

引数なし export は気をつける

引数なし export は割といろんなものを勝手に外に出してくれるので便利そうだが、 実は予期しないものも出してしまうので使わないほうが良いと思う:

f(a,b) = 
  x = $(add $(a), $(b))
  export

例えば、上の関数はxにaとbの和をセットするつもりだが、aとbも外側に出してしまう。 ifの中とかの無引数exportは問題ないが、関数bodyのトップでのexportは、 一時変数まで外に出してしまうので、してはいけないと思われる。 一時変数にすべてprivate変数を使えば大丈夫だが、いちいちprivate書くの面倒くさい。

引数なし export を封印するにはどうしたらよいですか

Reference manual の "Exporting the environment" をよく読んで。

  • export .RULE で implicit rule と implicit dependencies を外に出せます
  • export .PHONY で phony target を外に出せます
  • Implicit ではないパターンを使わないルールは export しなくても外に出ます

Rule, dependency や phony target のexportも変数のexportと同じで、上のスコープにある 同名のものをshadowするはず。

前置 export のほうがよさげ

ifでスコープを作るのでいちいちexportしなければならない、面倒なと思う人は:

updateX(b)=
  if $(b)
    X=2
    export
  else
    X=3
    export
  export X
updateX(true)
eprintln($(X)) # 2

export を前置すると捗ります:

updateX(b)=
  export X
  if $(b)
    X=2
  else
    X=3
updateX(true)
eprintln($(X)) # 2

return を使うと export が無効になる

returnは関数内から外に一気に脱出して値を返しますが、その際、内部でのexport宣言は無視されます。

X=1
F(y)=
  export X
  X=2
  return $(y)
Z=$(F 1)
eprintln(Z=$(Z) X=$(X)) # Z=1 X=1 !!!

returnがどうしても必要なければ valueがおすすめ

X=1
F(y)=
  export X
  X=2
  value $(y)
Z=$(F 1)
eprintln(Z=$(Z) X=$(X)) # Z=1 X=2 !!!

Implicit rule

Implicit rule は %.ext みたいなワイルドカードを使ったルール。よくあるのは:

%.ext1: %.ext2
    ...

こんなのも書ける:

%a: %b
    cp $< $@

でもディレクトリ名を左辺には書けない

x/%a: %b  # rejected
    cp $< $@

右辺には書けます

%a: x/%b
    cp $< $@

Dependency が足りないように見える

OCaml で make inconsistent assumptions over implementation Xxx が出た時。 ターゲットを omake --show-dependency ターゲット でビルドしてみて確認するとよい。 足りていないのを確認できる。

if の条件節に括弧をつけない！

if ($(equal $(A), $(B))) ... とすると then 節がけっして呼ばれない:

if true
  eprintln("true")
if (true)
  eprintln("(true)") # "(true)" は真ではない

豆知識

CREATE_SUBDIRS

Reference manual の "Temporary directories" に CREATE_SUBDIRS という秘密の変数について さくっと書いてある。 .SUBDIRS: <dirs> で dirs が無い場合、 CREATE_SUBDIRS=true だと 勝手に掘ってくれるとある。ひどい。