関数が失敗した場合に返される値が、-1だったりNULLだったりfalseだったりその他の特別な値だったり、ライブラリによって、または型によってバラバラである。Boost Optional Libraryでは、無効値を統一的に表現するためのboost::optional型を提供する。
Boost.Optionalの基本的な使い道は、関数の失敗値を表現することである。
検索の関数を考えてみよう。よくあるのは、該当要素が見つかったときに要素を指すポインタを返し、見つからなかった場合はNULLポインタを返すといったものだ。
#include <vector>
#include <boost/assign/list_of.hpp>
int* find_value(std::vector<int>& v, int value)
{
for (std::size_t i = 0; i < v.size(); ++i) {
if (v[i] == value)
return &v[i];
}
return NULL;
}
int main()
{
std::vector<int> v = boost::assign::list_of(1)(2)(3);
int* p = find_value(v, 3);
if (p) {
std::cout << *p << std::endl;
}
else {
std::cout << "該当なし" << std::endl;
}
}実行結果：
3
これは、Boost.Optionalを使用すると以下のように書くことができる。
#include <vector>
#include <boost/assign/list_of.hpp>
#include <boost/optional.hpp>
boost::optional<int&> find_value(std::vector<int>& v, int value)
{
for (std::size_t i = 0; i < v.size(); ++i) {
if (v[i] == value)
return v[i];
}
return boost::none;
}
int main()
{
std::vector<int> v = boost::assign::list_of(1)(2)(3);
boost::optional<int&> p = find_value(v, 3);
if (p) {
std::cout << p.get() << std::endl;
}
else {
std::cout << "該当なし" << std::endl;
}
}実行結果：
3
このケースは単なるポインタの置き換えだが、boost::optionalはその他あらゆるケースで無効値を表現するのに使用できる。
例として、本の見た目を模倣する電子書籍ビューアを考えよう。
画面には、2ページを見開き表示するが、そのデータが偶数ページ数あるとは限らず、最終ページは見開きではなく左1ページしか表示しないかもしれない。また、ページめくりの方向によっては、右ページのみ表示する場合もある。
そのような状況で、boost::optional<int>を使用して、有効なページを指しているかどうかを管理できる。
#include <vector>
#include <boost/optional.hpp>
class Viewer {
std::vector<Page> pages_;
boost::optional<int> left_page_; // 左に表示するページ番号
boost::optional<int> right_page_; // 右に表示するページ番号
void nextPage()
{
if (left_page_ && left_page_.get() + 1 < pages.size())
left_page_ = left_page_.get() + 1;
else
left_page_ = boost::none;
if (right_page_ && right_page_.get() + 1 < pages.size())
right_page_ = right_page_.get() + 1;
else
right_page_ = boost::none;
}
};boost::optionalにより、「-1ページを無効値とする」のようなプログラム仕様ではなく、型によって無効値がありえることを示すことができる。
C++の言語仕様では、if文の条件式で変数を定義できる。boost::optionalの変数をif文で定義すると便利だ。
if (boost::optional<int> p = get_value()) {
std::cout << p.get() << std::endl;
}こうすることで、boost::optional変数の寿命がif文のスコープになるので、連続してoptional値を使用する場合などに、変数名の衝突や、誤って異なる変数を使用してしまう心配がなくなる。
if (boost::optional<int> p = get_position()) {
...
} // ここでpの寿命が尽きる
// 同名の変数を定義する
if (boost::optional<int> p = get_vector()) {
}