flyhigh

Use your source, Luke!

Effective Go+αで書かれてるネーミング規約

Effective GoGo language community wikiを 必要になったので読んでみたが、いろいろ長ったらしい。なのでまとめた。

パッケージ名

bytesみたく、小さくまとめる。そしてすべて小文字で。名前衝突は考えなくていい。起こることがレアだし、最悪、Goでは違う名前でのimportができる。たとえばmp3.MP3Fileというのではなく、mp3.File でよい。どうせパッケージ名付きで呼び出すのだから。

アクセサ (Getter, Setter)名

Getter / Setterをつくるのは良い。しかし、Getterの先頭にGetはいらない。

1
2
obj.Field() // getter
obj.SetField(); // setter

インターフェース名

Reader, Writerのように、-erで終えろ。

変数名

アンダースコアはいれない。MixedCap, mixedCapというようなスタイルで。 短い名前推奨。lineCountより、c。メソッドのレシーバーなんかは1,2文字でよい。あと、省略した場合はすべて大文字で。URIと略したら、SetUriではなくSetURIと書くように。

参考

Effective go (Naming)

Go language community wiki

Go言語でのバインディング。FFIであるCGOを使う。

個人的に、Go言語からのバインディングに興味をもち、ちょうど必要だったmecabのバインドをつくっている。(shinpei/go-mecab)Go言語には、バインディングのためのCGO(シーゴー)というツールがついている。そこでgo-mecabの経験から、Goでのバインディングメモを書いてみた。先に、まとめておくと、CGOには以下のよい点、よろしくない点があった。

  1. Cの関数を直接呼べる。このためラッパー関数は(ほぼ)必要ないのは楽で良い
  2. CのソースをGoの中に書ける。必要なラッパーはここで追加できるのは楽で良い
  3. typedefされたシンボルを区別する。このため、型変換関数を定義する必要があり、よろしくない
  4. コンパイルに必要なLDFLAGSなどをテキストとして読む。pkg-configなどが使えずよろしくない

3,4について、特に4について、workaroundをお持ちの方は、教えて頂きたい。

Cの関数を呼ぶ

たとえば、libmに含まれる、sin関数は以下のように呼び出せる。

1
2
3
4
5
6
7
8
9
10
11
package main

/*
#cgo LDFLAGS:-lm
#include <math.h>
*/
import "C"

func main () {
        println(C.sin(3.14));
}

ここでの厄介な注意点は以下だ。なぜそうなるのかはよくわかってない。質問してみようかしら。

  • import “C”は、/ * */の後に空行を置かずに書くこと **。
  • 他パッケージとまとめて、import ("C" "fmt")のようにしてもNG

型変換 (Goの世界とCの世界)

上の例では、意識していないが、バインディングでは必ず互いの世界の型にあわせる必要がある。先ほどのC.sin()の型は、func (_Ctype_double) _Ctype_doubleとなる。_Ctype_doubleというのが、C言語の型である。一方でGo型対応する型はfloat64だ。_Ctype_doubleに関しては、プリミティブを代入可能である。このため、先の例は問題なくコンパイルできた。

1
var d _Ctype_double = 3.14; // doubleはプリミティブ代入可能

ちなみに、var d C.double = 3.14と書いても良い。

では、型変換が問題になる例をあげよう。import “math”を追加して、printlnを以下のように替える。

1
println(math.Abs(C.sin(3.14)));

こうすると、以下のエラーがでる。

1
2
  sin2  go build
./sin.go:14: cannot use _Cfunc_sin(3.14) (type C.double) as type float64 in function argument

goコンパイラはC.doubleとfloat64が交換可能であることをしらない。このため、エラーがでている。そのため、こう書き換えないといけない。

1
println(math.Abs(float64(C.sin(3.14))));

この型変換について最も厄介なのが、typeofされたCの構造体だった。Cでは以下の2つは同じ型だが、Goでは2つは異なる型として扱われる。

1
2
struct mecab_t;
typeof struct mecab_t mecab_t; //これ以降はmecab_tと書かれる

この2つの型については変換関数をCGOを用いて定義してやり、それを呼び出すことで解決した。他にいい方法があれば知りたい。

構造体要素へのアクセス

Go言語はポインタを持つ。このためreferenceとdefeferenceを区別する必要があるが、実際はなんとも透過的に扱える。これは、Goが参照か値かを区別してくれて、アクセス演算子の動作を変えてくれるから、とどっかで読んだ。(Cでは、値なら. (ドット)、参照なら –> (アロー)がアクセス演算子として用いられる)

シンプルな例をあげる。Goのコードでは参照か値かを区別せずに使えることがわかる。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package main

import "fmt";

type Hoge struct {
    Name string;
    Age int;
}

func main () {
    var valA Hoge = Hoge {"taro", 16};
    fmt.Printf("%s\n",valA.Name);
    var refA *Hoge = &valA;
    fmt.Printf("%s\n", (refA.Name));
}

このコンパイルは無事通り、以下が実行結果だ。

1
2
3
  reference  ./reference
taro
taro

この機能のおかげで、構造体のアクセスは、最上位の構造体の参照さえとってこれれば、アクセス可能となる。このあたりは実コードをサンプルにあげる。ptrというのが、C構造体へのポインタであり、Getterあたりを見れば、C構造体の要素にアクセスしてるのがわかる。

終わりに

もっと複雑なライブラリをバインドする場合は他にも必要な情報があるだろう。関数ポインタのマップとか、__attribute__((pack))付きの構造体とか。それらはバインドの機会があれば書きたい。

ちなみにサンプルにあげたgo-mecabはfree(defer)も未実装である。言うまでもないが、freeなしの現状では、富豪以外、使ってはいけない。

参考

cgo 公式ドキュメント

公式レポにあるgmpのバインディング

Good or recommended way to translate C struct to Go struct