Copyright 1999 Rogue Wave Software
Copyright 1999 Sun Microsystems, Inc.

総称コレクションクラス

11

ほとんどの総称コレクションクラスは、参照にもとづく意味解釈を使用します。つまり、110 ページの「コレクションクラスの格納方法」で説明したように、他のオブジェクトへのポインタを格納したり、検索したりします。これらのクラスでは、Rogue Wave コレクションクラスと同様、ユーザーがオブジェクトそのものの割り当てと開放を行う必要があります。

RWGVector(val)、RWGOrderedVector(val)、RWGSortedVector(val) の 3 つのベクトルにもとづく総称コレクションクラスは、値にもとづく意味解釈を使用します。これらのクラスは、型そのもの (オブジェクトへのポインタにもなる) を格納します。

記憶および検索の方法と基準はクラスごとに異なります。

#include <rw/gstack.h>                                     //1
#include <rw/rstream.h>                                    //2

declare(RWGStack, int)                                     //3

main(){
   RWGStack(int) gs;                                       //4
   gs.push(new int(1));                                    //5
   gs.push(new int(2));                                    //6
   gs.push(new int(3));                                    //7
   gs.push(new int(4));                                    //8

   cout << "Stack now has " << gs.entries()
        << " entries\n";                                   //9

   int* ip;                                                //10
   while( ip = gs.pop() )                                  //11
   {
     cout << *ip << "\n";                                  //12
     delete ip;
   }
   return 0;
}

プログラム出力

Stack now has 4 entries 4 3 2 1

次に、このプログラムを 1 行ずつ説明します。

//1	この #include はプリプロセッサマクロ RWGStackdeclare(type) を定義します。このマクロは行数が多くて整然としていませんが、型 type のオブジェクトの総称スタックがどのように動作すべきかを記述しています。一般にこのマクロは、基盤にある実装 (一重リンクリスト (クラス RWSlist)) に対する制限付きのインタフェースとして機能します。制限されている点は、RWSlist の一部のメンバー関数 (スタックに関係するもの) しか使用できないということと、スタックに挿入する項目が type 型でなければならないということです。
//2	<rw/rstream.h> は Rogue Wave が提供する特殊なヘッダファイルです。このヘッダファイルには、コンパイラに応じて適切な接尾辞の付いた <iostream.h> が入っています。
//3	この行は、コンパイラ付属のヘッダファイル <generic.h> 内で定義されているマクロ declare を呼び出します。declare(Class,type) と引数を指定して呼び出した場合、引数 type を持つマクロ Classdeclare が呼び出されます。したがってこの場合は、引数 int を持つマクロ RWGStackdeclare が呼び出されます (<rw/gstack.h> で定義されています)。 つまり、declare(RWGStack, int) マクロを呼び出した結果、特にユーザーのプログラムに対して新しいクラスが作成されたということです。実際的には、この名前は RWGStack(int) で、int へのポインタのスタックです。
//4	この行で新しいクラス RWGStack(int) のインスタンス gs が作成されます。
//5-//8	ヒープから 4 つの int が作成され、スタックに挿入されました。行 8 が実行されると、int 4 へのポインタがスタックの最上部にきて、int 1 へのポインタが最下部にきます。
//9	スタック上に項目がいくつあるかを確認するため、クラス RWGStack(int) のメンバー関数 entries() が呼び出されます。
//10	int へのポインタが宣言および定義されます。
//11	スタックが空になるまでポップされます。メンバー関数 pop() がスタックの最上部にある項目へのポインタを返して取り除きます。スタック上にそれ以上項目がなければゼロを返し、それによって while ループが終了します。
//12	各項目が逆参照および出力されます。

typedef int* intP;
declare(RWGStack, intP)                               //誤り
declare(RWGStack, int)                                //正しい

テスト関数

RWBoolean tester(const type* ty, const void* a)

ここで、tester は関数の名前、type は当該コレクションクラスのメンバーの型、RWBoolean は int に対する typedef です (とり得る値は TRUE か FALSE に限られます)。テスト関数の役目は、そのコレクションのあるメンバーが識別された場合にそれを知らせることです。これがどのように行われるか、あるいはオブジェクトを "識別" したとはどういう意味なのかを決定するのはユーザーです。ユーザーはアドレスを比較したり (2 つのオブジェクトが "同一" であるか調べる)、あるいはオブジェクトの中で一定の値を探したりする ("isEqual" か調べる) ことができます。最初の変数 ty はコレクションのメンバーを指定し、1 つの "候補" と考えることができます。"クライアントデータ" として考えることができる 2 番目の変数 a はユーザーが ty との一致をテストするために使用できます。

次の例は前述の例を拡張したものですが、isEqual のテストが問題になっています。スタックにいくつかの値をプッシュして、特定の値がスタックに存在するかどうかを確認しています。クラス RWGStack(type) のメンバー関数 contains() には、次のプロトタイプがあります。

RWBoolean contains(RWBoolean (*t)(const type*, const void*),
                   const void* a) const;

#include <rw/gstack.h>
#include <rw/rstream.h>

declare(RWGStack, int)

RWBoolean myTesterFunction(const int* jp, const void* a)     //1
{  return *jp == *(const int*)a;                             //2
}

main(){
   RWGStack(int) gs;                                         //3
   gs.push(new int(1));                                      //4
   gs.push(new int(2));                                      //5
   gs.push(new int(3));                                      //6
   gs.push(new int(4));                                      //7

   int aValue = 2;                                           //8

   if ( gs.contains(myTesterFunction, &aValue) )             //9
     cout << "Yup.\n";
   else
     cout << "Nope.\n";

while(!gs.isEmpty())
   delete gs.pop();

return 0;
}

プログラム出力

Yup.

テスト関数の 2 番目の引数は、必ずしもコレクションのメンバーと同じ型である必要はありません (上記の例ではそうなっていますが)。次は両者が同じ型でない場合の例です。

#include <rw/gstack.h> #include <rw/rstream.h> class Foo { public: int data; Foo(int i) {data = i;} }; declare(RWGStack, Foo) // Foo へのポインタのスタック RWBoolean anotherTesterFunction(const Foo* fp, const void* a) { return fp->data == *(const int*)a; } main(){ RWGStack(Foo) gs; gs.push(new Foo(1)); gs.push(new Foo(2)); gs.push(new Foo(3)); gs.push(new Foo(4)); int aValue = 2; if ( gs.contains(anotherTesterFunction, &aValue) ) cout << "Yup.\n"; else cout << "Nope.\n"; while(!gs.isEmpty()) delete gs.pop(); return 0; }

ここでは、Foo (へのポインタ) のスタックが宣言および使用されていますが、テスト関数へ 2 番目の引数として渡される変数の型はやはり const int* です。テスト関数はこれを考慮に入れなければなりません。

適用関数

void yourApplyFunction(type* ty, void* a)

ここで、yourApplyFunction は関数の名前、type は当該コレクションクラスのメンバーの型です。適用関数は、ユーザーに対してコレクションの各メンバーに何らかの演算を実行する (たとえば、出力したり画面上に描画したりする) 機会を与えます。2 番目の引数は、関数が使用する "ユーザー定義データ" (たとえば、オブジェクトを描画するウィンドウのハンドル) を保持するように設計されています。

次の例では、適用関数 printAFoo を使用して、総称二重リンクリストの RWGDlist(type) の各メンバーの値を出力しています。

#include <rw/gdlist.h> #include <rw/rstream.h> class Foo { public: int val; Foo(int i) {val = i;} }; declare(RWGDlist, Foo) void printAFoo(Foo* ty, void* sp){ ostream* s = (ostream*)sp; (*s) << ty->val << "\n"; } main(){ RWGDlist(Foo) gd; gd.append(new Foo(1)); gd.append(new Foo(2)); gd.append(new Foo(3)); gd.append(new Foo(4)); gd.apply(printAFoo, &cout); while(!gd.isEmpty()) delete gd.get(); return 0; }

プログラム出力

1 2 3 4

ある程度注意すれば、適用関数はコレクション内のオブジェクトを変更するのに使用することができます。たとえば上記の例のメンバーデータ val の値を変更したり、すべてのメンバーオブジェクトを削除するのに使用することもできます。しかし後者については、そのコレクションを再度使用しないように注意しなければなりません。