Monthly Archive for March, 2007

オブジェクト指向入門 第2版 原則・コンセプト を読んでいます。 契約による設計という考えに触発され、自分でもやってみようと思いたちました。

単純なマクロ

さっそく、C++でやってみようということで、

#define REQUIRE
#define ENSURE

といった空マクロを用意しました。

int square10(int x) { // 10 以下の正数のみを対象とする二乗関数
  REQUIRE {
    assert(0 < x);
    assert(10 > x);
  }

  int ret(x * x);

  ENSURE {
    assert(x == sqrt(ret));
  }
  return ret;
}

と、一応は書けます。

しかし、本来ならヘッダファイル内の宣言に含めて インターフェイスとしてクライアントに提示したいものです。 さらに欲を言えば、Doxygenなどで自動的に抽出してほしい。

実現のために

1. それぞれの関数の入口/出口に、制約条件をチェックするhookを仕掛ける
2. 制約条件を関数/クラス宣言内に書ける
3. Doxygenのタグを拡張

といったことが必要になりそうです。

1を実現するには、auto変数をうまく利用すればいいんじゃない? と思いました。 2を実現するには、それぞれの制約条件を表現するクラスを、クラス内クラスとして定義すればよさそう。 3はどうしたらいいんだろう…

NDEBUG環境では、制約条件のオブジェクトを生成しないように、マクロを使えばよさそうです。

例

#include <cassert>

// constrain macro.
#ifdef NDEBUG
#define CONSTRAIN(method)
#else // NDEBUG
#define CONSTRAIN(method) 
   method##_constrain _constrain(*this)
#endif // NDEBUG

class Bird {
public:
   Bird() : // awake and not flying at first.
      flying_(false),
      sleeping_(false) {}

   void fly() {
      CONSTRAIN(fly);
      flying_ = true;
   }

   void sleep() {
      CONSTRAIN(sleep);
      sleeping_ = true;
   }

   friend class fly_constrain;
   friend class sleep_constrain;

private:
   bool flying_;
   bool sleeping_;

   // ----------------------------------------------------------------
   // constrains
   class fly_constrain {
   public:
      fly_constrain(Bird &b) : bird_(b) {  // requirement
         assert(false == bird_.flying_);
         assert(false == bird_.sleeping_);
      };

      ~fly_constrain() {                   // ensure
         assert(true == bird_.flying_);
         assert(false == bird_.sleeping_);
      }

   private:
      Bird &bird_;
   }; // fly_constrain

   class sleep_constrain {
   public:
      sleep_constrain(Bird &b) : bird_(b) { // requirement
         assert(false == bird_.sleeping_);
         assert(false == bird_.flying_);
      };

      ~sleep_constrain() {                  // ensure
         assert(true == bird_.sleeping_);
         assert(false == bird_.flying_);
      }

   private:
      Bird &bird_;
   }; // sleep_constrain

}; // Bird

// test
int main(int argc, char *argv[]) {
   Bird piyoko;

   piyoko.fly();
   piyoko.sleep(); // cannot sleep while flying !

   return 0;
}

実行結果

% c++ -Wall -g dbc.cxx
% ./a.out
dbc.cxx:57: failed assertion `false == bird_.flying_'
zsh: abort      ./a.out

鳥は飛びながら眠ることはできないという制約にひっかかっているの図です。

まとめ

C++でも契約による設計は実現できそうです。 しかしC++らしく手間がやたらとかかると。 CONSTRAINマクロは、メソッド名を自動抽出できればもう少しうまく書けそう。

他にも良いアイデアがあればぜひ教えてください。

参考リンク

• The Code Project::Design by Contract macros for C++ and link to Doxygen おおおっ!と思いましたが、VC限定なのですね。
• OnLamp::Using Design by Contract in C

オブジェクト指向入門 第2版 原則・コンセプト

posted with amazlet on 07.03.17

バートランド・メイヤー 酒匂 寛
翔泳社 (2007/01/10)
売り上げランキング: 13136

おすすめ度の平均:

オブジェクト指向の基礎からみっちり学べる

Amazon.co.jp で詳細を見る