scoped_ptrクラステンプレートは動的に割り当てられたオブジェクトへのポインタを保持する。 (動的に割り当てられたオブジェクトとはC++のnewで割り当てられたものである。) 指されたオブジェクトはscoped_ptrのデストラクト時か、明示的なresetによって削除されることが保証されている。 exampleを参考のこと。
scoped_ptrテンプレートはシンプルな要求におけるシンプルな解決法である。 これは、所有権の共有や移動を伴わずに、デザインパターンの"Resource Acquisition Is Initialization"イディオム(訳注:RAIIパターン、「資源獲得を初期化時に行う」ことによりオブジェクトの所有権の所在を明確にする)を実現するための基礎的な仕組みを提供する。 scoped_ptrの名前と意味的な主張(noncopyableであるということ)の両方が、そのスコープでの所有権の所在が唯一であることを表す。 これはnoncopyableであり、コピーされるべきでないポインタに対して、shared_ptrやstd::auto_ptrよりも安全である。
scoped_ptrはとてもシンプルなので、通常の実装では全ての操作は組み込みポインタと同様に速く、組み込みポインタよりも大きな記憶スペースを取ることはない。
scoped_ptrは C++ 標準ライブラリコンテナの中で使うことはできない。 コンテナの中にスマートポインタを格納する必要があるときは、shared_ptrを使う。
scoped_ptrは動的に割り当てられた配列を正しく扱うことはできない。 動的に割り当てられた配列を扱うためには、scoped_arrayを参考にせよ。
このクラステンプレートには、指し示すオブジェクトの型を表すパラメータTを与える。 Tはスマートポインタの共通の要求事項を満たさなければならない。
Synopsis
namespace boost {
template<typename T> class scoped_ptr : noncopyable {
public:
typedef T element_type;
explicit scoped_ptr(T * p = 0); // never throws
~scoped_ptr(); // never throws
void reset(T * p = 0); // never throws
T & operator*() const; // never throws
T * operator->() const; // never throws
T * get() const; // never throws
void swap(scoped_ptr & b); // never throws
};
template<typename T>
void swap(scoped_ptr<T> & a, scoped_ptr<T> & b); // never throws
}
Members
element_type
typedef T element_type;
保持するポインタの型を規定する
constructors
explicit scoped_ptr(T * p = 0); // never throws
scoped_ptrを構築して、pのコピーを保持する。 pは C++ のnewによって割り当てられたものか、0でなければならない。 Tは完全型である必要はない。 スマートポインタの共通の要求事項を参考にせよ。
destructor
~scoped_ptr(); // never throws
保持するポインタが指すオブジェクトを、まるでdelete this->get()としたかのようにして破棄する。
例外を送出しないという保証は、削除されるオブジェクトのデストラクタが例外を送出しないという要求に依存する。 スマートポインタの共通の要求事項を参考にせよ。
reset
void reset(T * p = 0); // never throws
pが保持するポインタと等価でなければ、保持するポインタが指すオブジェクトを削除し、pのコピーを保持する。 pはC++のnewによって割り当てられたものか、0でなければならない。 例外を送出しないという保証は、削除されるオブジェクトのデストラクタが例外を送出しないという要求に依存する。 スマートポインタの共通の要求事項を参考にせよ。
indirection
T & operator*() const; // never throws
保持するポインタが指すオブジェクトの参照を返す。 保持するポインタが0なら動作は未定義である。
T * operator->() const; // never throws
保持するポインタを返す。 保持するポインタが0なら動作は未定義である。
get
T * get() const; // never throws
保持するポインタを返す。 Tは完全型である必要はない。 スマートポインタの共通の要求事項を参考にせよ。
swap
void swap(scoped_ptr & b); // never throws
ふたつのスマートポインタの中身を交換する。 Tは完全な型である必要はない。 スマートポインタの共通の要求事項 を参考にせよ。
Free Functions
swap
template<typename T> void swap(scoped_ptr<T> & a, scoped_ptr<T> & b); // never throws
a.swap(b)と等価である。 std::swapのインターフェースとの一貫性を図り、ジェネリックプログラミングを支援する。
Example
scoped_ptrの使い方の例を示す。
#include <boost/scoped_ptr.hpp>
#include <iostream>
struct Shoe { ~Shoe() { std::cout << "Buckle my shoe\n"; } };
class MyClass {
boost::scoped_ptr<int> ptr;
public:
MyClass() : ptr(new int) { *ptr = 0; }
int add_one() { return ++*ptr; }
};
void main()
{
boost::scoped_ptr<Shoe> x(new Shoe);
MyClass my_instance;
std::cout << my_instance.add_one() << '\n';
std::cout << my_instance.add_one() << '\n';
}
このプログラムは子守唄の始めの部分をつくる(※訳注:例が分かりにくい。)
1
2
Buckle my shoe
Rationale
auto_ptrに代わってscoped_ptrを使う第一の理由は、「資源獲得は初期化時に行う」RAIIパターンがカレントスコープでのみ適用されることと、所有権の移動はないことの二つのことをソースを読む人に伝えることである。
scoped_ptrを使う第二の理由は、後になってメンテナンスするプログラマが、auto_ptrを返すことで所有権を移動させる関数を加えることを防ぐ、ということだ。 なぜなら、メンテナンスプログラマはauto_ptrを見れば、所有権を安全に移動することが可能だと考えてしまうからである。
boolとintを考えよう。 我々は皆、蓋を開けてみればboolはただのintに過ぎないことを知っている。 実際、そのためboolをC++の標準に含めることに反対した者もいる。 しかし、単にintと書くのではなくboolと書くことで、プログラマの意図をはっきりと表現することができる。 scoped_ptrも同じことである。 これを使えば、何をしたいかをはっきりと伝えることができる。
scoped_ptr<T>はstd::auto_ptr<T> constと等価であると考えられるかもしれない。 しかしEd Breyはresetがstd::auto_ptr<T> constではうまく働かないことを指摘した。
Handle/Body Idiom
scoped_ptrの一般的な用法の一つに、handle/body表現 (pimplとも呼ばれる) の実装がある。 handle/body表現とは、オブジェクト本体の実装を隠蔽する(ヘッダファイル中にさらけ出すことを回避する)ためのものである。
サンプルプログラムscoped_ptr_example_test.cppは、ヘッダファイルscoped_ptr_example.hppをインクルードしている。 このヘッダファイルでは、不完全型のポインタを取るscoped_ptr<>を利用して実装を隠蔽している。 完全型が必要となるメンバ関数のインスタンス化は、実装ファイルscoped_ptr_example.cppの中に記述されている。
Frequently Asked Questions
Q. なぜscoped_ptrはメンバ関数release()を持たないのか?
A. ソースコードを読んでいるとき、使われている型に基づいてプログラムの動作を結論付けられることは価値がある。 もしscoped_ptrがメンバ関数release()を持っていれば、保持するポインタの所有権の移動が可能になり、資源の寿命を与えられた文脈に制限するという役割が弱くなる。 所有権の移動が必要なときはstd::auto_ptrを使えばよい。 (Dave Abrahamにより提供されている。)
Revised 17 September 2002
Copyright 1999 Greg Colvin and Beman Dawes. Copyright 2002 Darin Adler. Copyright 2002 Peter Dimov. Permission to copy, use, modify, sell and distribute this document is granted provided this copyright notice appears in all copies. This document is provided "as is" without express or implied warranty, and with no claim as to its suitability for any purpose.
Japanese Translation Copyright (C) 2003 Kohske Takahashi, Ryo Kobayashi.
オリジナルの、及びこの著作権表示が全ての複製の中に現れる限り、この文書の複製、利用、変更、販売そして配布を認める。 このドキュメントは「あるがまま」に提供されており、いかなる明示的、暗黙的保証も行わない。 また、いかなる目的に対しても、その利用が適していることを関知しない。