galaxy-sixth-sensey - 【Vimにコントリビュート】garray_Tの使い方
2020/06/10
【Vimにコントリビュート】garray_Tの使い方

はじめに

Vimは古典的C言語（多分C99以下の企画）で書かれており、 またライブラリの依存関係を最小に抑えておきたいためでしょうか、 Vimのソースコード内に独自のAPI（structや諸関数）が含まれています。

今回、私はVimへの下記PullRequestを、一年に渡って作成しています。

（よければPRのトップコメントに 👍 する等で、応援してください！ マージされる可能性が高まります！）

そこでgarray_Tという便利なstructを発見したので、解説させていただきます。

※ 筆者はVimコントリビュート初心者です。誤ったことを言っていたら、ごめんなさい。

garray_Tの用途・使い方

要素がchar_uな場合

garray_TはC++のstd::vector<T>や、JavaのArrayList<T>、KotlinのMutableList<T>に相当します。 ただしCにジェネリクスはないので、型引数を持つ代わりに、キャストを前提としています。

定義は以下です。

/*
 * Structure used for growing arrays.
 * This is used to store information that only grows, is deleted all at
 * once, and needs to be accessed by index.  See ga_clear() and ga_grow().
 */
typedef struct growarray
{
    int	    ga_len;		    // current number of items used
    int	    ga_maxlen;		    // maximum number of items possible
    int	    ga_itemsize;	    // sizeof(item)
    int	    ga_growsize;	    // number of items to grow each time
    void    *ga_data;		    // pointer to the first item
} garray_T;

以下のように使用します。

（以下、コンパイルは未検証です。……Vimのソースコードを持ってくるのは、とっても大変なので 🙇）

// Vimのコーディングスタイルに多分従っているコード
    static void
foo(char_u **xs, size_t xs_size)  // char_uはVim特有の文字型
{
    int         i;
    garray_T    result;  // char_uの可変配列 = 可変文字列
    ga_init2(&result, sizeof(char_u), 80);

    ga_append(&result, '"');
    for (i = 0; i < xs_size - 1; ++i)
    {
        ga_concat(&result, xs[i]);
        ga_append(&result, ',');
    }
    ga_concat(&result, xs[xs_size - 1]);

    printf("%s\n", (char_u *)result.ga_data);

    ga_clear(&result);
}

char_u *xs[3] = {
    (char_u *)"foo",
    (char_u *)"bar",
    (char_u *)"baz"
};
foo(xs, 3);  // "foo,bar,baz"

ga_init2()はgarray_Tのコンスタントラクターです。 引数にそれぞれ「初期化先、要素のサイズ、メモリアロケートするときの増分」を指定します。

コンスタントラクターとしてga_init()を使うこともできます。

/*
 * Initialize a growing array.	Don't forget to set ga_itemsize and
 * ga_growsize!  Or use ga_init2().
 */
    void
ga_init(garray_T *gap)
{
    gap->ga_data = NULL;
    gap->ga_maxlen = 0;
    gap->ga_len = 0;
}

    void
ga_init2(garray_T *gap, int itemsize, int growsize)
{
    ga_init(gap);
    gap->ga_itemsize = itemsize;
    gap->ga_growsize = growsize;
}

ga_append() と ga_concat() は、要素がchar_uなgarray_Tに特化した関数で、 適宜メモリアロケートしつつresult.ga_dataにデータ（char_u及びchar_u*）を追加していきます。

これよって、むやみに手動メモリアロケ―としつつ sprintf()するという呪いのようなコードから解放されます。

それこそが、garray_Tの存在意義でしょう！

最後にga_clear()でアロケートされたメモリを解放（free）してあげます。

要素がchar_uでない場合

garray_Tは要素がchar_uでない場合も使用できます。

    static void
to_scalable(int *xs, size_t xs_size, garray_T *result)
{
    int i;

    ga_init2(result, sizeof(int), 80);

    for (i = 0; i < xs_size; ++i)
    {
        ga_grow(result, 1);
        ++result->ga_len;

        ((int *)result)[result->ga_len - 1] = xs[i];
    }
}

int         i;
garray_T    result;
int         xs[3] = { 1, 2, 3 };
to_scalable(xs, 3, &result);

for (i = 0; i < result.ga_len; ++i)
{
    printf("%d\n", ((int *)result.ga_len)[i]);
}
// 1
// 2
// 3

ga_clear(&result);

ga_grow(garray_T *ga, int n)はgarray_Tがもうn個分の要素を持たない場合に、 ga_dataを拡張する関数です。

ga_lenはgarray_T中の要素数を表し、手動で増分する必要があります。 （多分……。）

まとめ

Enjoy vimming!

この記事はこちらから修正リクエストを送ることができます。
【Vimにコントリビュート】garray_Tの使い方 - github
ゴミ箱ボタンの左にある、鉛筆ボタンを押してね！

(*^o^) { This blog powerd by Haskell Hakyll, and more (about licenses).