Linux (Ubuntu) から NTFS でフォーマットされた外付け USB HDD へファイルをコピーしたらシンボリックリンクがシンボリックリンクのままだったでござるの巻

表題の通りなんですが、シンボリックリンク先の実体は外付け HDD にはコピーされていなかったので意味のない状態になってしまい、困りました。

ちなみにコピー先が NTFS ではなく FAT32 でフォーマットされた外付け HDD だと「シンボリックリンクを作れない」というようなエラーになりました。

GUI のファイルブラウザでコピーしても cp コマンドで(オプションは特に指定せず)コピーしてもそうなったので、まあそういうものなんでしょう。


cp コマンドに -L オプションをつけることで解決。
シンボリックリンクがリンク先の実体としてコピーされる)

btrfs で複数のデバイスを使うときにやったことメモ

1TB の HDD のおさがりをもらったのでさっそく Linux PC に搭載して、前から気になっていた btrfs でフォーマットして使ってみました。

この記事に書く予定のシナリオとしては、

1. ディスク単体で btrfs フォーマットしてマウントして使用開始
2. ディスクを増設して一つのボリューム(?)として使用継続

という程度のもので、スナップショットがどうしたとか透過的圧縮がこうしたとかルートファイルシステムをどうのこうのとかいったような高度な話は一切出て来ません。

それでも例によっていろいろハマったので、後の自分のためにハマりポイントなどをメモ。

環境は Ubuntu 12.04.3 LTS。




最初に btrfs-tools パッケージをインストールした気がします。
(記憶があやふや)


それからディスクを btrfs でフォーマット。

$ sudo mkfs.btrfs <device file>

な感じですね。ここまではちょっとググればすぐにわかります。

<device file> には /dev/sdb とかそんな感じのデバイスファイル名を指定します。
ここからは /dev/sdb で話を進めます。(この記事を読んでくださっている皆さんはご自身の環境にあわせて読み替えてください。)

ちなみに、最初 /dev/sdb1 とかのパーティション?を指定してしまってエラーになってしまいました。よく考えたら当たり前なのかもしれませんが・・・。
(おさがりだったので事前になんらかのファイルシステムでフォーマットされていたのかもしれません)



次にこのディスクを単体でマウントします。
このあたりまでは旧来のファイルシステムと同じ感覚でやってたのですが問題なくできてました。

$ mkdir /mnt/btrfs_test
$ sudo mount /dev/sdb /mnt/btrfs_test

/mnt/btrfs_test はマウントポイントですね。
もしファイルシステムのタイプがどうのこうのというエラーになったら -t btrfs をつけると良いと思います。

これでもう /mnt/btrfs_test 以下には好き放題にファイルを作ったりできちゃうのですが、便利に使うためにもうあといくつか作業をします。



このままでは、PC を再起動するたびにマウントしなおさないといけなくなるので、/etc/fstab に以下の内容を書いておきましょう。

/dev/sdb    /mnt/btrfs_test    btrfs  noatime,nodiratime  0  0

/dev/sdb は最初に初期化したデバイスファイル名なのでみなさんの環境にあわせて変えてください。
/mnt/btrfs_test はマウントポイントです。
つぎの btrfs はファイルシステムのタイプで、
その次の noatime,nodiratime はパフォーマンスがよくなる(ファイルやディレクトリの最終アクセス日時をいちいち更新するのをやめる)ということです。これらのオプションはつけても付けなくても良いと思います。




さらに、サブボリュームと呼ばれるものを作っておくと、そのサブボリューム単位でスナップショットをとったりすることができて便利になるようです。

$ cd /mnt/btrfs_test
$ sudo btrfs subvolume create <subvolume name>


マウントするときは、このサブボリュームの単位でマウントすることもできるようです。




しばらくこの状態で使っていたら、もう一台 1TB HDD のおさがりをもらいました。
いったん PC をシャットダウンしてその HDD を接続したあと PC を起動し、/dev/sdc が認識されていることを確認しました。

この /dev/sdc も btrfs でフォーマットしました。

これを単体でマウントして別々のディスクとして扱うのではせっかく btrfs にした意味がないので、既存の /mnt/btrfs_test の容量を増やすようにしたいと思います。

それには、以下のコマンドでファイルシステムにデバイスを追加します。

$ sudo btrfs device add /dev/sdc /mnt/btrfs_test

これだけで完了です。簡単ですね。

ただ、この状態では、古い方(/dev/sdb)の 1TB のディスクにばかりデータが書きこまれていて、新しい方(/dev/sdc)にはまったくデータが書きこまれていないというアンバランスな状態となっていますので、これをバランスさせます。

$ sudo btrfs filesystem balance /mnt/btrfs_test

このコマンドは実行にかなり時間がかかります。

このコマンドが完了してから df コマンドを実行すると、無事 /mnt/btrfs_test の容量が約 2TB になっていることが確認できました。


なお、デバイスを追加しても、fstab は書き換えなくても大丈夫なようです。ファイルシステムに追加されたデバイスのうちどれか一つを指定してマウントすると、すべてのデバイスがまとめて使用可能になるようです。





以上、僕が知りたかった情報(なぜサブボリュームを作るのか、等の理由も含めて)があまりまとめられていなかったのでまとめてみました。

間違いの指摘やアドバイス等、よろしくおねがいします。

Ruby で特定のパターンが出現するまで簡単にファイルを読み飛ばす方法

テキストファイルの処理をしてると、たまに表題のようなことをやりたくなりますね。

ヘッダーの1行だけ読み飛ばすとか固定行数読み飛ばすだけならその行数の分だけ gets() を呼べばいいのですが、何行目に現れるかわからない特定のパターンまで読み飛ばすというのは、C 言語脳な僕には gets() して目的のパターンかどうか比較してそうでなければ次の行・・・みたいなループを書いてしまいがちです。

Ruby 脳的にはどうするのがいいかなと思っていたのですが、gets() の rs 引数としてその特定のパターンを渡せばよいようです。

すなわち、

aaaaa
bb
ccccc
ddd
eeeeeee
fff
<<<DATA
data 1
data 2
data 3
  :

という感じのファイルがあったとして、<<

open('data.txt') do |f|
  f.gets("\n<<<DATA\n")
     :
  # 本来の目的の処理
end

と1行で読み飛ばせてしまうことがわかりました。

"\n<<<DATA\n" を行の区切りとして、そこまでを一行として読み取ってしまうという荒業ですね。(そうでもない?)

前後の \n によって、その文字列だけからなる行があるということを意味しています。

逆に特定のパターンが行の途中に現れるとかだとすると \n を除かないといけません。
ただ、後ろの \n が無いと、本来の処理に入ってから一回だけゴミが渡されてきちゃうような気がしますので要注意かも。といっても gets() (引数なし)をもう一回呼べばいいだけですかね。

パターンとして正規表現が使えたら最強な気もしますが、rs のデフォルトが $/ ということはそれはできないのかな?


多分、年に2回くらい使うので忘れないようにメモ。

ssh サーバに公開鍵をワンライナーで登録する方法

2014.05.09 追記

$ ssh-copy-id user@hostname

でいいかも。
(公開鍵ファイルを指定したい場合は -i オプションを使用する)





$ ssh user@hostname "echo `cat ~/.ssh/id_rsa.pub` >> ~/.ssh/authorized_keys"

以上。
たまにやりたくなるんだけどいつも忘れるのでメモ。

`〜` はローカル側のシェルで置き換えられてから ssh コマンドが実行され、echo 〜 はリモートサーバ上で実行される。

ちなみに bash の man の EXPANSION の項によると、

  1. ワード分割
  2. ブレース展開(a{b, c, d}e を abe, ace, ade に分割)
  3. チルダ展開(~ をホームディレクトリなどに展開)
  4. 以下の展開が同時に行われる(左から右の順で評価される)
    1. パラメータ、変数および算術展開(${〜} や $((〜)) を展開)
    2. プロセス置換(<(〜) や >(〜) を置換。名前付きパイプ(FIFO)をサポートしている環境のみ)
    3. コマンド置換($(〜) や `〜` を置換)
  5. ワード分割(ここまでの展開で生成されたワードに基づいて再度分割)
  6. パス名展開(* や ? や [〜] を展開)

の順で処理されてから実行されるようです。

Java とか Android (DEX) の MUTF-8 (Modified UTF-8) って何者よ?っていう話

Android の APK の DEX をゴニョゴニョしてたら、DEX の string 領域に格納されている文字列は実は UTF-8 じゃなくてちょっと modify された MUTF-8 (Modified UTF-8) だということが判明して軽くショックを受けています。

Wikipedia の UTF-8 の項によりますと、標準の UTF-8 から以下の 2 つの変更点があるようです。

後者に関しては端的にいうと CESU-8 (Compatibility Encoding Scheme for UTF-16: 8-Bit) というエンコード方法に則っているということのようです。

Wikipedia のページにも例がありますが、U+10400 というコードポイントを普通に UTF-8 でエンコーディングしたら 0xF0, 0x90, 0x90, 0x80 という 4 バイトのバイト列になるのですが、CESU-8 だと 0xED, 0xA0, 0x81, 0xED, 0xB0, 0x80 という 6 バイトのバイト列になります。

これは U+10400 を UTF-16 でエンコーディングすると 0xD801, 0xDC00 というサロゲートペアになるのですが、それぞれ、0xD801 を UTF-8 のようにエンコーディングすると 0xED, 0xA0, 0x81 となり、0xDC00 を UTF-8 のようにエンコーディングすると 0xED, 0xB0, 0x80 となるためなんですね。

これら 2 つのルールを整理しますと、以下の表のようになります。

Unicode コードポイント U+0000 U+0001 〜 U+007F U+0080 〜 U+07FF U+0800 〜 U+FFFF U+10000 〜 U+10FFFF
通常の UTF-8 0x00 0x01 〜 0x7F 0xC4,0x80 〜 0xDF,0xBF 0xE0,0xA0,0x80 〜 0xEF,0xBF,0xBF 0xF0,0x90,0x80,0x80 〜 0xF0,0x90,0xBF,0xBF
UTF-16F 0x0000 0x0001 〜 0x007F 0x0080 〜 0x7FFF 0x0800 〜 0xFFFF 0xD800,0xDC00 〜 0xDBFF,0xDFFF
Modified UTF-8 0xC0,0x80 0x01 〜 0x7F 0xC4,0x80 〜 0xDF,0xBF 0xE0,0xA0,0x80 〜 0xEF,0xBF,0xBF 0xED,0xA0,0x80,0xED,0xB0,0x80 〜 0xED,0xAF,0xBF,0xED,0xBF,0xBF


ちなみに、MUTF-8 を UTF-16 に戻したり、逆に UTF-16 を MUTF-8 に変換したりするコードは Android のソースの
dalvik/dx/src/com/android/dx/rop/cst/CstString.java
あたりにあります。
(関数名 utf8BytesToString() や stringToUtf8Bytes() が該当します)


その他、参考 URL
http://docs.oracle.com/javase/1.5.0/docs/guide/jni/spec/types.html#wp16542

HTML5/JavaScript/CSS3 でクロスプラットフォームなデスクトップ GUI アプリを作れるフレームワークの決定版を見つけた(かもしれない)件

[追記 2015/05/19]
2015年時点では HTML5/JavaScript/CSS でデスクトップ GUI アプリを作るなら、Electron 一択でしょうね。electron.atom.io

[追記ここまで]


私はデスクトップアプリケーション開発歴はすでに20年近い老人ですが、数年前から「HTML5 でデスクトップ GUI アプリを開発するのが今後主流になるはず」と言い続けてきました。

最近になってやっと、その説をサポートしてくれてかつ人に紹介しても恥ずかしくなさそうなフレームワークに出会えたので(それも一気に 2 つも)、紹介したいと思います。


ちなみに、私のデスクトップアプリ開発に使ってきたフレームワークの遍歴は、以下のような感じです。(抜けてるのもあるかも)

他にも、大学の計算機の授業の課題で SunOS の上で生の Motif を書いたりしたし、趣味でいろんなフレームワークをつまみ食いしたりしてチュートリアル程度はやったというのを含めるとこのリストは倍くらいになるかもしれない。

で、一時期 Web アプリやモバイルアプリの開発なんかもやってみて思ったのが、結局どのフレームワークでも、コントロールやウィジェットと呼ばれる GUI 部品を座標とか大きさを指定したりレイアウトマネージャー的なものにそのへんを任せたりしつつ配置して、それぞれの部品のアクションに応じてイベントハンドラ書いたり、MVC モデルとか使ってデータが更新されたら見た目も更新する(もしくはその逆)みたいなことをしたり、結局はどれもこれも似たようなことやってるだけだなと。なのに、新しい環境が出てきたら毎回毎回新しい言葉を覚えて新しい習慣を身につけないといけないと。
WPF やってるくらいのころに、「もうこれ HTML でいいじゃん」とマイクロソフトを呪ったわけです。なんでまた新しいマークアップとかバインディングとか覚えないといけないのと。

たぶんそれが 2006〜2007 年くらい。

で、新しもの好きがたたって(?)一時期 Titanium Desktop とかに可能性を感じてみちゃったりしたわけです(結局 Appcelerator は Titanium Desktop を手放してオープンソース化されて Tide SDK ?とかになって細々とやってるのかな)。

AppJS っていうのを見つけたりしてこれもいいかもと思ったんだけど、実際使ってみるとどうも思ったとおり動いてくれない(Windows 64bit 環境だと起動もせずにクラッシュした。そのうち直るかもしれないけど)し、ドキュメントとかも圧倒的に足りてない感じ。→ 今は deskshell っていうプロジェクトに引き継がれているようですが、どうなることやら。

最近は Chrome App がいい感じかな〜とも思ったけど、お手軽さという意味ではいいんだけどやっぱりブラウザに縛られるというか普通にローカルのファイルを見に行けないとかそういう息苦しさみたいなものはある。作れるアプリが限定されちゃうというか。必要なデータは全部 Web からかき集めてきて、保存するときもクラウド、みたいな Web ネイティブなイマドキのアプリにはいいのかもしれない。(実際、2 つくらい自分用の実用的な小さなアプリを Chrome App で作ってみた)


前置きが長くなったけど、そんな中で見つけたのが node-webkitQt

node-webkit

node-webkit は、数ある「WebKit と LL を組み合わせて見ました」系のフレームワークとは一線を画す感じで、ちょっと使ってみた感じでも商用アプリを作るのに耐える品質を備えているんじゃないかと思ったフレームワーク。開発も活発に続いている。ドキュメント等、情報も他のものに比べると十分そろっていると思う。(少なくとも、今までアプリを作ってて困ったことがあってぐぐったら全部答えが見つかっている)

少しだけ特徴をあげてみると、

  • 作ったアプリをバイナリ単体で配布できる(Windows なら単一の .exe ファイルにできるし、Mac ならパッケージを作れる。Linux でも 1 つの実行ファイルにして配布できる)
  • node.js で DOM をいじれる

→ これ結構気持ちのいいパラダイムシフト。サーバサイドの人もクライアントサイドの人も到達したことのない境地のはず。「サーバサイドとクライアントサイドの言語が統一できますよ」っていうの(一瞬うれしそうだけど全然嬉しくないやつ)のレベルじゃない。たとえば、AngularJS のコントローラの中で SQLite で直にファイルからデータを読みだしたりできるんだぜ?
CoffeeScript とか LESS とかソレ系のやつを grunt で毎回コンパイルしたりしなくてよい。GUI アプリとして実行される時にコンパイルすれば良いから。で、シングルページアプリケーションとして動かして DOM をグリグリいじって画面の更新をするようにすれば再読み込みが発生しないのでパフォーマンスにもインパクト小(起動時に一回だけコンパイルされるだけ)。どうしてもそれも許せないなら普通に事前に JS や CSS へとコンパイルしてもいい。

→ パフォーマンスは逆に悪化するらしいが、秘密にしたいコードを(若干ではあるが)隠せる。

などなど。
node-webkit を使って、これも 2 つくらいアプリを書き始めてみたところ。

Qt

Qt なんて、見つけたというか温故知新というか僕が今まで気づいてなかっただけで、C++ のごっつい旧世代のフレームワークくらいにしか思ってなかったんだけど、実は Webkit ベースで HTML5 アプリを作れて C++ の世界(QObject)とのインタラクションが快適そうなので急浮上してきた。

実際ちょっと使ってみたら、Qt って名前の通り結構キュートなやつなのな。クラスライブラリの設計とかもちゃんとモダンな標準に従っててエレガントな感じがしてさわり心地がいい。C++er としてはホント今まで気づいてあげられなくてごめんよという感じ。
node-webkit ほどの気持ちよさは無いけど、パフォーマンスを極限まで追求したいとかどうしてもシステムコール呼びたいとか、ポインタが無いと生きていけないとかそんな下寄りに行きたい、でもイマドキっぽいかっこいい GUI も欲しいとかいうようなときは(どんなときだよ)、今後は僕は Qt を選ぶと思う。(node-webkit + native extension に行っちゃうかもしれないけど)

一つ実験的に規模大きめの GUI アプリを書き始めてみた。

まとめ

Web/モバイル全盛のこの時代、デスクトップアプリ自体がオワコンっていう話もあるのかもしれないけど、たぶん HTML5 ベースのデスクトップアプリによって一回揺り戻しが来るんじゃないかな〜なんて考えています。

久しぶりにワクワクしながら GUI アプリを書いている今日このごろです。

chef で remote_directory リソースで一気にファイルをコピーしようとしたら空ディレクトリがコピーされなくて困った件(解決策もあるよ)

仕事では vagrant + chef を使って Hermetic なテスト環境を誰でも簡単に作れるようにしようという取り組みをしています。

モバイルアプリからアクセスするバックエンドのサーバは、現時点では本番環境かテスト環境かというくらいしかないのですが、これを vagrant と chef で誰でもローカルの仮想マシン上にセットアップできるようにしちゃおうという目論見です。

バックエンドサーバのコードは自社製のレガシーなものがすでにありますので、まずはそれをデプロイしたいなと。
chef のリポジトリの site-cookbooks/<cookbook-name>/files/default/ あたりにそのバックエンドサーバの実行に必要なファイル一式を用意しておいて、まるっと仮想マシンにコピーしたいわけです。

で、chef のリソースについてのドキュメントなんかを読むと、どうやら remote_directory というリソースを使えば cookbook に入れておいたファイルたちをディレクトリごとまるっとコピーしてくれるようだということがわかります。

そこで早速使ってみたのですが、一つ問題に気づいてしまいました。

空っぽのディレクトリが仮想マシン側の環境にコピーされていないのです。

ログを出すためのディレクトリとか、ユーザからのアップロードを受け付けるためのディレクトリだとかそんな感じのディレクトリの一つや二つ、ありますよね?
そういう空のディレクトリが cookbook の files の下にあっても、仮想マシン側にはそれがコピー(作成)されないのです。

一つや二つなら、実行時にどうせ作られるし別に気にしないのですが、今回いじってるサーバはちょっとわけあって100個くらいそういう空のディレクトリがあります。
しかも、本番環境やテスト環境と差分がないことを diff とったりして確認したいので、100個も差分があると本当の差分が埋もれてしまって困ることになります。

で、解決策がここにありました。
https://github.com/higanworks-cookbooks/mongodb-10gen/issues/3

やはり同じ事で困っている人はいるみたいです。


解決策を大雑把に説明すると、コピー元の cookbook の files の下の空ディレクトリになんでもいいからダミーの空ファイルを入れておけということのようです。

私の場合は

find ${COOKBOOK_FILES_DEFAULT_DIR} -type d -empty -exec touch {}/delete.me \;

という感じで一括して delete.me という名前のファイルを空ディレクトリの中に作成しました。

で、レシピには、

execute 'delete delete.me files' do
  command "find #{dst_dir} -name 'delete.me' -exec rm {} \\;"             
end

こんな感じのコードを書いておくと knife solo cook したときに delete.me が消えてなくなります。

シェルスクリプトの中でコマンドが存在するかどうかを確かめる方法

stackoverflow に答えとともに良い説明があった。
http://stackoverflow.com/a/677212/2122085

#!/bin/sh なスクリプトの場合(bash ではなく sh を使っている場合)は

\command -v foo >/dev/null 2>&1 || { echo >&2 "'foo' is required.  Aborting."; exit 1; }

で OK。

こういう場合、よく which を使う(というか僕はいままで which を使っていた)のだけど、それだとどうもコマンドが見つからなかった時に 0(正常終了)を返してくる環境があるらしく、また which は外部コマンドなので多少オーバーヘッドがあったり、ディストリビューションによっては which をカスタマイズしてパッケージマネージャと連携させていたりするらしいのでヘビーデューティなスクリプトだとパフォーマンスに多少影響を与えることになるのかもしれない。

一応上記コマンドの解説。

\command -v は sh のビルトインで、引数で指定されたコマンド(外部コマンド、ビルトインコマンド、エイリアスを含む)を実行はせずに、外部コマンドならそのコマンドの絶対パス、ビルトインコマンドならコマンド名、エイリアスならエイリアスの展開、をそれぞれ表示してくれる。
(stackoverflow の回答では先頭に \ をつけていないけど、念のためつけておくことにした。http://bearmini.hatenablog.com/entry/2013/04/13/000055 参照。)

foo は探したいコマンド。

>/dev/null 2>&1 は command -v の出力を(エラー出力も含めて)捨てている。

|| { 〜 } の部分は、コマンドが見つからなかった時に command ビルトインの終了コードが 0 以外になるので実行される部分。上記の例ではエラーメッセージを表示して exit 1 している。



(sh ではなく)#!/bin/bash を使用している場合は command ビルトインの代わりに type もしくは hash ビルトインが使える。

hash ビルトインを使うと、コマンドをサーチしてその場所がハッシュされて残るので、実際にそのコマンドを実行するときのサーチが高速になるとのこと。ただし外部コマンドを探すときにしか使えず、ビルトインコマンドを探すことができないという欠点がある。

type ビルトインを使うと、2回目以降のサーチが速くなったりはしないがビルトインコマンドも探すことができる。command ビルトインとの違いはよくわからないけど、man を読んだ限りでは、type だと tracked alias というものにも対応しているのかな?ただ、tracked alias の説明をググったりして探してみても ksh というシェルの機能のようで bash では使えなさそう。command -v より type のほうがキータイプ数(ファイルに保存される文字数)が少なくなるというメリットがあるのかな?
上記 stackoverflow の回答では bash のときは hash か type を使えと書いてあるけど command -v ではいけない理由までは書いてないな。

なんかモヤモヤしたままこの記事は終了^^;

bash スクリプトの中でそのスクリプト自身が置かれているディレクトリを絶対パスで取得する方法

[2017.04.04 update]
shellcheck でエラーが出ないように修正
[/2017.04.04 update]

イディオム的な。

BASE_DIR="$( cd "$( dirname "$0" )" || exit; pwd )"

いつも忘れるのでメモ。

GotW #6a: 正しい const 第1部(勝手訳)

GotW #6a の翻訳です。

例によって原文著者(Herb Sutter 氏)の許可は得ていませんし、私の英訳がヒドいクオリティである(用語の統一がとれていないとか、誤訳が含まれているとか)かもしれませんのでそこのところはご理解いただければと思います


原文:http://herbsutter.com/2013/05/24/gotw-6a-const-correctness-part-1-3/

const and mutable have been in C++ for many years. How well do you know what they mean today?

const と mutable は長年にわたって C++ に存在しています。現在それらがどういう意味を持つか、あなたはどのくらい知っていますか?

Problem 問題

JG Question 見習いグルへの問題

1. What is a “shared variable”?

1. "共有変数" とは何か?

Guru Questions グルへの問題

2. What do const and mutable mean on shared variables?

2. 共有変数に対する const と mutable は何を意味するか?

3.How are const and mutable different in C++98 and C++11?

3. const と mutable は C++98 と C++11 においてどのように異なるか?

Solution 解答

1. What is a “shared variable”?

1. "共有変数" とは何か?


A “shared variable” is one that could be accessed from more than one thread at the same time.

"共有変数" は複数のスレッドから同時にアクセスできる変数のことです。


This concept is important in the C++ memory model. For example, the C++ memory model (the core of which is described in ISO C++ §1.10) prohibits the invention of a write to a “potentially shared memory location” that would not have been written to in a sequentially consistent execution of the program, and the C++ standard library refers to this section when it prohibits “modify[ing] objects accessible by [other] threads” through a const function, as we will see in #2.

このコンセプトは C++ メモリモデルにおいて重要です。たとえば、C++ メモリモデル(核となる部分は ISO C++ §1.10 に記述されています)は”潜在的に共有されるメモリ位置" への書き込みを禁じていて、プログラムが正しく実行されている限りにおいてはそのような場所に書き込まれることはありません。また、C++ 標準ライブラリが次の 2. でこれから見るように const 関数によって "[他の] スレッドからアクセス可能なオブジェクトの変更" を禁じているのは、このセクションを参照しているためです。

2. What do const and mutable mean on shared variables?

2. 共有変数に対する const と mutable は何を意味するか?

Starting with C++11, const on a variable that is possibly shared means “read-only or as good as read-only” for the purposes of concurrency. Concurrent const operations on the same object are required to be safe without the calling code doing external synchronization.

C++11 の場合から見て行きましょう。共有される可能性のある変数に対する const は、並列実行の目的のために "読み取り専用 もしくは 読み取り専用と同等" を意味します。同じオブジェクトに対する並列 const 操作は外部的に同期をするためのコードの呼び出しなしで安全であるために必要とされます。

If you are implementing a type, unless you know objects of the type can never be shared (which is generally impossible), this means that each of your const member functions must be either:

あなたが何かの型を実装しようとしているなら、その型のオブジェクトが絶対に共有されることがないとわかっている場合(そんなことは普通ありませんが)を除いて、すべての const メンバ関数は以下のいずれかである必要があることを意味します:

  • truly physically/bitwise const with respect to this object, meaning that they perform no writes to the object’s data; or else
  • internally synchronized so that if it does perform any actual writes to the object’s data, that data is correctly protected with a mutex or equivalent (or if appropriate are atomic<>) so that any possible concurrent const accesses by multiple callers can’t tell the difference.
  • このオブジェクトに関して、真に物理的にビット単位で const である。すなわち、そのオブジェクトのデータに対して書き込みが行われない;もしくは、
  • 内部的に同期しているので実際にはそのオブジェクトのデータに何か書き込んでいるが、そのデータは mutex もしくは同等のもの(もしくは atomic<> が適切ならそれ)を用いて正しく保護されているので、複数の呼び出し元からの何らかの並列な const アクセスにはそれがわからないようになっている。

Types that do not respect this cannot be used with the standard library, which requires that:

これを守らない型は、標準ライブラリと組み合わせて使うことができません。標準ライブラリは以下のことを要求しています:

“… to prevent data races (1.10). … [a] C++ standard library function shall not directly or indirectly modify objects (1.10) accessible by threads other than the current thread unless the objects are accessed directly or indirectly via the function’s non-const arguments, including this.”—ISO C++ §17.6.5.9

"... データの競合 (1.10) を防ぐため ... [a] C++ 標準ライブラリ関数は、関数の非 const な引数(this を含む)によって直接または間接的にアクセスされる以外は、直接または間接的に現在のスレッド以外のスレッドからアクセスされるオブジェクト(1.10) を変更してはならない。- ISO C++ §17.6.5.9

Similarly, writing mutable on a member variable means what it has always meant: The variable is “writable but logically const.” Note what this implies:

同様に、メンバ変数に mutable と書くことはすでに述べたような意味を持ちます:その変数は "書き込み可能だが論理的には const" です。これが意味するところは、

  • The “logically const” part now means “can be used safely by multiple concurrent const operations.”
  • The “mutable” and “writable” part further means that some const operations may actually be writers of the shared variable, which means it’s inherently got to be correct to read and write concurrently, so it should be protected with a mutex or similar, or made atomic<>.
  • "論理的に const" の部分は "複数の並列 const 操作によって安全に使うことができる" ということを意味します。
  • "mutable" と "書き込み可能" の部分は、const 操作 によって実際には共有変数に書き込むことがあるかもしれないということを意味し、read と write が同時に行われたとしても本質的に正しくなければならないということであり、mutex もしくは同等のもの、もしくは atomic<> にすることによって保護されるべきであるということです。


In general, remember:

一般的には、以下のルールを覚えてください:

Guideline: Remember the “M&M rule”: For a member variable, mutable and mutex (or atomic) go together.

ガイドライン:"M&M ルール" を覚えましょう:メンバ変数に対して、mutable と mutex (もしくは atomic)はいつも一緒に使います。


This applies in both directions, to wit:

これは両方の面から適用されます。すなわち:

(1) For a member variable, mutable implies mutex (or equivalent): A mutable member variable is presumed to be a mutable shared variable and so must be synchronized internally—protected with a mutex, made atomic, or similar.

(1) メンバ変数に対して、mutable は mutex(もしくは同等のもの)を示唆します:mutable なメンバ変数は mutable な共有変数であると推測されるので、内部的に同期されなければなりません。すなわち mutex を使うかもしくは atomic にするかもしくは同等の方法で保護されなければなりません。

(2) For a member variable, mutex (or similar synchronization type) implies mutable: A member variable that is itself of a synchronization type, such as a mutex or a condition variable, naturally wants to be mutable, because you will want to use it in a non-const way (e.g., take a std::lock_guard) inside concurrent const member functions.

(2) メンバ変数に対して、mutex(もしくは同等の同期型)は mutable を示唆します:mutex や条件変数のような同期型のメンバ変数は、必然的に mutable になるはずです。非 const な方法(たとえば std::lock_guard を取るとか)で並列 const メンバ関数の中から使われるからです。


We’ll see an example of (2) in Part 2, GotW #6b.

(2) の例は第2部、GotW #6b で見て行きましょう。

3. How are const and mutable different in C++98 and C++11?

3. const と mutable は C++98 と C++11 においてどのように異なるか?

First, let’s be clear: C++98 single-threaded code still works. C++11 has excellent C++98 compatibility, and even though the meaning of const has evolved, C++98 single-threaded code that uses the old “logically const” meaning of const is still valid.

まず一つ明確にしておきましょう:C++98 のシングルスレッドのコードは今でも動きます。C++11 は C++98 との素晴らしい互換性を持っていて、const の意味が改良されたにもかかわらず、const をその古い "論理的に const" の意味で使っている C++98 のシングルスレッドのコードは今でも有効です。

With C++98, we taught a generation of C++ developers that “const means logically const, not physically/bitwise const.” That is, in C++98 we taught that const meant only that the observable state of the object (say, via its non-private member functions) should not change as far as the caller could tell, but its internal bits might change in order to update counters and instrumentation and other data not accessible via the type’s public or protected interface.

C++98 では、私たちは C++ 開発者達に "const というのは論理的に const であって物理的/ビット単位で const ということではない" と教えました。すなわち、C++98 においては、cost はそのオブジェクトの観測可能な状態(つまり、private でないメンバ関数を介して、ということですが)が呼び出し元にわかる範囲では変わってはいけないが、内部のビットはカウンタや計測値を更新したり、public もしくは protected なインターフェースを介してアクセスされることのないようなデータは変化しても良いと教えました。

That definition is not sufficient for concurrency. With C++11 and onward, which now includes a concurrency memory model and thread safety specification for the standard library, this is now much simpler: const now really does mean “read-only, or safe to read concurrently”—either truly physically/bitwise const, or internally synchronized so that any actual writes are synchronized with any possible concurrent const accesses so the callers can’t tell the difference.

この定義は並列性のためには不十分です。C++ およびそれ以降では、標準ライブラリのための並列性メモリモデルとスレッド安全性仕様が含まれます。これはよりシンプルです:const は "読み取り専用、もしくは並列読み取りに対し安全" という意味を持つようになりました。これは、真に物理的にビット単位で const であるか、実際には書き込みが同期されていても並列 const アクセス時に呼び出し元に違いがわからないようにするために内部的に同期するかのどちらかです。

Although existing C++98-era types still work just fine in C++98-era single-threaded code for compatibility, those types and any new ones you write today should obey the new stricter requirement if they could be used on multiple threads. The good news is that most existing types already followed that rule, and code that relies on casting away const and/or using mutable data members in single-threaded code has already been generally questionable and relatively rare.

既存の C++98 時代の型は互換性のために今でもちゃんと C++98 時代のシングルスレッドコードで動きます。そのような型も、あなたが今日以降書く新しい型も、もしマルチスレッドで使われるのであれば、新しい厳格な方の要求に従うべきです。良いニュースはほとんどの既存の型は実はそのルールにすでに従っているということです。また、シングルスレッドのコードにおいて、キャストによって cosnt を外してしまうことや mutable なデータメンバを使うことに依存しているようなコードは一般的にはいかがわしいものとされてきましたし、相対的にレアなものです。

Summary まとめ

Don’t shoot yourself (or your fellow programmers) in the foot. Write const-correct code.

自分自身の足を撃ちぬかないでください(もしくは同僚プログラマの足を)。正しい const のコードを書いてください。

Using const consistently is simply necessary for correctly-synchronized code. That by itself is ample reason to be consistently const-correct, but there’s more: It lets you document interfaces and invariants far more effectively than any mere /* I promise not to change this */ comment can accomplish. It’s a powerful part of “design by contract.” It helps the compiler to stop you from accidentally writing bad code. It can even help the compiler generate tighter, faster, smaller code. That being the case, there’s no reason why you shouldn’t use it as much as possible, and every reason why you should.

一貫して const を使うことは正しく同期されるコードのために必要です。それだけでも、一貫して "正しい const" であるべき理由として十分ですが、理由はほかにもあります:正しい const は、インターフェースと不変性について /* これは変更しないよ。約束します! */ なんて書くよりもずっと効率的にドキュメンテーションすることにもなります。これは ”契約によるデザイン (design by contract)" のパワフルな部分です。

Remember that the correct use of mutable is a key part of const-correctness. If your class contains a member that could change even for const objects and operations, make that member mutable and protect it with a mutex or make it atomic. That way, you will be able to write your class’ const member functions easily and correctly, and users of your class will be able to correctly create and use const and non-const objects of your class’ type.

mutable を正しく使うことが "正しい const" のキーになることを覚えておいてください。もしあなたのクラスが const オブジェクトに対する const 操作であっても変更されるようなメンバを持っているなら、そのメンバを mutable にしてそれを mutex で守るか atomic にしてください。そうすると、あなたのクラスの const メンバ関数は簡単に正しく書くことができるようになりますし、あなたのクラスを使う人もあなたのクラス型の const もしくは 非 const オブジェクトを正しく生成して使うことができるようになります。

It’s true that not all commercial libraries’ interfaces are const-correct. That isn’t an excuse for you to write const-incorrect code, though. It is, however, one of the few good excuses to write const_cast, plus a detailed comment nearby grumbling about the library vendor’s laziness and how you’re looking for a replacement product.

すべての商用ライブラリのインターフェースが "正しい const" ではないことは確かです。しかしそれはあなたが "正しくない const" のコードを書くための言い訳にはなりません。ただし、それは const_cast を書くための、そしてそのライブラリのベンダの怠慢やあなたが代わりになる製品を探していることについて愚痴をこぼすための詳細なコメントをそのライブラリのコードの近くに書くための言い訳として許される、数少ないものの一つです。

Acknowledgments 謝辞

Thanks in particular to the following for their feedback to improve this article: mttpd, jlehrer, Chris Vine.

この記事をより良くするための以下の各位からのフィードバックに対し、特に感謝する:mttpd, jlehrer, Chris Vine.

Vagrant で作成した仮想マシンを、ホスト起動時に一緒に自動的に起動する方法(Ubuntu 12.04)

Ubuntu 12.04 の場合、/etc/rc.local あたりに以下のように書いておきます。
(他のバージョンの Ubuntu や、他のディストリビューションでもコマンド自体は同じで大丈夫でしょう。このコマンドを書く場所がちょっと違うかもしれませんが、そのシステムごとに起動時に自動実行されるスクリプトがあるはずですのでそこに書きましょう)

sudo -u $user VBoxManage startvm $vm --type headless

$user は VM を作成した(その VM を管理している)ユーザのユーザ名です。
$vm は VM の名前です。あなたの VM の名前に置き換えてください。
VM の名前がわからないという場合は VBoxManage list vms というコマンドを実行するとたぶんわかります。

GotW #5: 仮想関数のオーバーライド (勝手訳)

GotW #5 の翻訳です。

例によって原文著者(Herb Sutter 氏)の許可は得ていませんし、私の英訳がヒドいクオリティである(用語の統一がとれていないとか、誤訳が含まれているとか)かもしれませんのでそこのところはご理解いただければと思います。


原文:http://herbsutter.com/2013/05/22/gotw-5-solution-overriding-virtual-functions/

Virtual functions are a pretty basic feature, but they occasionally harbor subtleties that trap the unwary. If you can answer questions like this one, then you know virtual functions cold, and you’re less likely to waste a lot of time debugging problems like the ones illustrated below.

仮想関数はとても基本的な機能ですが、ちょっとした引っ掛けをはらんでいます。今回のような問題に答えられるようであれば、あなたは仮想関数について完璧に知っていて、以下で説明されているような問題をデバッグするのに何時間もかけてしまうようなことはないでしょう。

Problem 問題

JG Question 見習いグルへの質問

1. What do the override and final keywords do? Why are they useful?

1. override および final キーワードは何をするか?それらはなぜ有用か?

Guru Question グルへの質問

2. In your travels through the dusty corners of your company’s code archives, you come across the following program fragment written by an unknown programmer. The programmer seems to have been experimenting to see how some C++ features worked.
(a) What could be improved in the code’s correctness or style?
(b) What did the programmer probably expect the program to print, but what is the actual result?

2. あなたはあなたの会社のコードアーカイブの埃をかぶった一角を旅している。あなたは、以下のような誰が書いたかわからないプログラムの断片に行き当たった。そのプログラムを書いたプログラマはいくつかのC++の機能がどのように動くのか、実験していたかのようだ。
(a) コードの正しさやスタイルを改善するとしたら何ができるか?
(b) そのプログラマはこのプログラムが印字することを期待していたのだと思うが、実際には何が起こるか?

class base {
public:
    virtual void f( int );
    virtual void f( double );
    virtual void g( int i = 10 );
};

void base::f( int ) {
    cout << "base::f(int)" << endl;
}

void base::f( double ) {
    cout << "base::f(double)" << endl;
}

void base::g( int i ) {
    cout << i << endl;
}

class derived: public base {
public:
    void f( complex<double> );
    void g( int i = 20 );
};

void derived::f( complex<double> ) {
    cout << "derived::f(complex)" << endl;
}

void derived::g( int i ) {
    cout << "derived::g() " << i << endl;
}

int main() {
    base    b;
    derived d;
    base*   pb = new derived;

    b.f(1.0);
    d.f(1.0);
    pb->f(1.0);

    b.g();
    d.g();
    pb->g();

    delete pb;
}

Solution 解答

1. What do the override and final keywords do? Why are they useful?

1. override および final キーワードは何をするか?それらはなぜ有用か?

These keywords give explicit control over virtual function overriding. Writing override declares the intent to override a base class virtual function. Writing final makes a virtual function no longer overrideable in further-derived classes, or a class no longer permitted to have further-derived classes.

これらのキーワードは、仮想関数のオーバーライドに対して明示的な制御を与えます。override と書くことは、基底クラスの仮想関数をオーバーライドする意図を宣言します。final と書くことは、仮想関数が派生クラスでオーバーライドされないこと、もしくはクラスがそれ以上継承できないようにします。

They are useful because they let the programmer explicitly declare intent in a way the language can enforce at compile time. If you write override but there is no matching base class function, or you write final and a further-derived class tries to implicitly or explicitly override the function anyway, you get a compile-time error.

これらはプログラマに明示的に意図を宣言させ、言語がコンパイル時に強制できるので有用です。あなたが override と書いたのにマッチする基底クラスの関数が存在しなければ、もしくはあなたが final と書いたのに派生クラスで暗黙的もしくは明示的にかかわらず関数をオーバーライドしたら、コンパイル時エラーになります。

Of the two, by far the more commonly useful is override; uses for final are rarer.

これら2つのうち、override のほうが一般的にははるかに有用です。final を使うのはそれに比べると稀です。

2. (a) What could be improved in the code’s correctness or style?

2.(a) コードの正しさやスタイルを改善するとしたら何ができるか?

First, let’s consider some style issues, and one real error:

まず、いくつかあるスタイル上の問題を考えてみましょう。そのうちの一つは実際にエラーです:

1. The code uses explicit new, delete, and an owning *.

1. コードは明示的な new と delete、所有する * を使っている

Avoid using owning raw pointers and explicit new and delete except in rare cases like when you’re writing the internal implementation details of a low-level data structure.

生ポインタを所有したり、new や delete を使うことは避けなければなりません。ただし、低レベルなデータ構造の内部の詳細な実装を書いているというレアケースのような場合は除きます。

{
    base*   pb = new derived;

    ...

    delete pb;
}


Instead of new and base*, use make_unique and unique_ptr.

new と base* の代わりに、make_unique と unique_ptr を使います。

{
    auto pb = unique_ptr<base>{ make_unique<derived>() };

    ...

} // automatic delete here


Guideline: Don’t use explicit new, delete, and owning * pointers, except in rare cases encapsulated inside the implementation of a low-level data structure.

ガイドライン:明示的な new、delete および所有権のある * ポインタを使用しない。低レベルデータ構造の実装の隠蔽された中身のようなレアケースを除く。


However, that delete brings us to another issue unrelated to how we allocate and manage the lifetime of the object, namely:

しかしながら、delete はオブジェクトの確保や生存期間の管理の方法に関係なく、別の問題を持ち込みます。すなわち:

2. base’s destructor should be virtual or protected.

2. base のデストラクタは virtual もしくは protected であるべき。

class base {
public:
    virtual void f( int );
    virtual void f( double );
    virtual void g( int i = 10 );
};


This looks innocuous, but the writer of base forgot to make the destructor either virtual or protected. As it is, deleting via a pointer-to-base without a virtual destructor is evil, pure and simple, and corruption is the best thing you can hope for because the wrong destructor will get called, derived class members won’t be destroyed, and operator delete will be invoked with the wrong object size.

これは無害に見えますが、base を書いた人はデストラクタを virtual にするか protected にすることを忘れています。このまま virtual デストラクタなしで base へのポインタ経由で delete することははっきりいって悪です。こうなるとあなたが望むことのできる最良のものは破滅です。間違ったデストラクタが呼ばれ、derived クラスのメンバが破棄されず、operator delete が間違ったオブジェクトサイズで起動されます。

Guideline: Make base class destructors public and virtual, or protected and nonvirtual.

ガイドライン:基底クラスのデストラクタを public で virtual にするか、protected で 非 virtual にせよ。

Exactly one of the following can be true for a polymorphic type:

ポリモーフィック型において、以下のうちいずれかのみが真となり得ます。

  • Either destruction via a pointer to base is allowed, in which case the function has to be public and had better be virtual;
  • or else it isn’t, in which case the function has to be protected (private is not allowed because the derived destructor must be able to invoke the base destructor) and would naturally also be nonvirtual (when the derived destructor invokes the base destructor, it does so nonvirtually whether declared virtual or not).
  • 基底クラスへのポインタ経由での破棄が許されているならば、デストラクタは public かつ virtual である必要がある;
  • 基底クラスへのポインタ経由での破棄が許されていないのであれば、デストラクタは protected とし(private であってはなりません。派生クラスのデストラクタは基底クラスのデストラクタを起動しなければならないためです)、必然的に非 virtual とします(派生クラスのデストラクタが基底クラスのデストラクタを起動したとき、virtual と宣言されているかどうかにかかわらず、それは非 virtual 的に動作します)。

Interlude 間奏

For the next few points, it’s important to differentiate three terms:

次の点について、3つの用語を区別しておくことは重要です。

  • To overload a function f means to provide another function with the same name in the same scope but with different parameter types. When f is actually called, the compiler will try to pick the best match based on the actual parameters that are supplied.
  • To override a virtual function f means to provide another function with the same name and the same parameter types in a derived class.
  • To hide a function f that exists in an enclosing scope (base class, outer class, or namespace) means to provide another function with the same name in an inner scope (derived class, nested class, or namespace), which will hide the same function name in an enclosing scope.
  • 関数 f をオーバーロードするとは、同じ名前の別の関数を同じスコープ内で異なるパラメータ型で提供するということです。f が実際に呼ばれる時、コンパイラは最もマッチするものを実際に与えられたパラメータにもとづいて選ぼうとします。
  • 仮想関数 f をオーバーライドするとは、派生クラスにおいて同じ名前で同じパラメータ型の別の関数を提供することです。
  • ある包含スコープ(基底クラス、外部クラス、もしくは名前空間)に存在する関数 f を隠すとは、同じ名前で内部スコープ(派生クラス、ネストクラス、もしくは名前空間)に別の関数を提供することです。これは包含スコープの同じ関数名を隠します。

3. derived::f is neither an override nor an overload.

3. derived::f はオーバーライドでもオーバーロードでもない

    void derived::f( complex<double> )


derived does not overload the base::f functions, it hides them. This distinction is very important, because it means that base::f(int) and base::f(double) are not visible in the scope of derived.

derived はいずれの base::f 関数もオーバーロードしません。それらを隠してしまいます。この区別はとても重要です。base::f(int) と base::f(double) は derived のスコープでは不可視となってしまうことを意味するからです。

If the author of derived intended to hide the base functions named f, then this is all right. Usually, however, the hiding is inadvertent and surprising, and the correct way to bring the names into the scope of derived is to write the using-declaration using base::f; inside derived.

derived を書いた人が f という名前の基底クラスの関数を意図して隠したのであればこれは問題ありません。しかし普通は隠すことは意図的ではなく驚きです。derived クラスのスコープにそれらの名前を持ち込むための正しい方法は、derived の中に using 宣言 using base::f; を書くことです。

Guideline: When providing a non-overridden function with the same name as an inherited function, be sure to bring the inherited functions into scope with a using-declaration if you don’t want to hide them.

ガイドライン: 継承された関数と同じ名前で非オーバーライド関数を提供する場合、継承されるはずの関数を隠したくなければ using 宣言を使ってスコープの中にそれらを確実に取り込む。

4. derived::g overrides base::g but doesn’t say “override.”

4. derived::g は base::g をオーバーライドしているが、override と書いていない。

    void g( int i = 20 )  /* override */


This function overrides the base function, so it should say override explicitly. This documents the intent, and lets the compiler tell you if you’re trying to override something that’s not virtual or you got the signature wrong by mistake.

この関数は base の関数をオーバーライドしますので、明示的に override と宣言すべきです。これはその意図をドキュメント化し、あなたが非virtual な何かをオーバーライドしようとしていることや誤って違うシグネチャを書いてしまったことをコンパイラに検出させることができます。

Guideline: Always write override when you intend to override a virtual function.

ガイドライン:仮想関数をオーバーライドしようとしているなら、常に override と書く。

5. derived::g overrides base::g but changes the default argument.

5. derived::g は base::g をオーバーライドしているが、デフォルト引数を変更している。

    void g( int i = 20 )

Changing the default argument is decidedly user-unfriendly. Unless you’re really out to confuse people, don’t change the default arguments of the inherited functions you override. Yes, this is legal C++, and yes, the result is well-defined; and no, don’t do it. Further below, we’ll see just how confusing this can be.

デフォルト引数を変更することは決定的にユーザに不親切です。もしわざと人々を混乱させようとしているのでなければ、オーバーライドする関数のデフォルト引数を変更しないでください。これは C++ 的に合法であり、結果もきちんと定義されています。しかし、絶対にしないでください。この後で、これがいかに混乱を招くかを見ていきます。

Guideline: Never change the default arguments of overridden inherited functions.

ガイドライン:オーバーライドされた関数のデフォルト引数を変更してはならない。

We could go one step further:

さらに一歩推し進めて:

Guideline: Avoid default arguments on virtual functions in general.

ガイドライン:一般に、仮想関数ではデフォルト引数の使用を避ける

Finally, public virtual functions are great when a class is acting as a pure abstract base class (ABC) that only specifies the virtual interface without implementations, like a C# or Java interface does.

最後に、public な仮想関数は、そのクラスが純粋な抽象基底クラス(Abstract base class: ABC)となるときには素晴らしいものです。純粋な抽象基底クラスとは、実装のない仮想インターフェースのみが指定されるもので、C#Java の interface のようなものです。

Guideline: Prefer to have a class contain only public virtual functions, or no public virtual functions (other than the destructor which is special).

ガイドライン: クラスには public な仮想関数だけを持たせる、もしくは public な仮想関数を全く持たせない(デストラクタだけは特別なので除外)のいずれかとせよ。

A pure abstract base class should have only public virtual functions. …

純粋な抽象基底クラスは public な仮想関数だけを持つべきです...

But when a class is both providing virtual functions and their implementations, consider the Non-Virtual Interface pattern (NVI) that makes the public interface and the virtual interface separate and distinct.

しかし、あるクラスが仮想関数とその実装をともに提供するとき、非仮想インターフェース(NVI: Non-Virtual Interface)パターンを考慮してください。public なインターフェースと仮想関数を分離して区別できるようにします。

… For any other base class, prefer making public member functions non-virtual, and virtual member functions non-public; the former should have any default arguments and can be implemented in terms of the latter.

... それ以外の基底クラスは、public なメンバー関数は非 virtual とし、仮想メンバ関数は非 public とします;デフォルト引数は前者にもたせ、また前者は後者を使って実装します。

This cleanly separates the public interface from the derivation interface, lets each follow its natural form best suited for its distinct audience, and avoids having one function exist in tension from doing double duty with two responsibilities. Among other benefits, using NVI will often clarify your class’s design in important ways, including for example that the default arguments which matter to the caller therefore naturally belong on the public interface, not on the virtual interface. Following this pattern means that several classes of potential problems, including this one of virtuals with default arguments, just naturally don’t arise.

これにより public インターフェースを派生インターフェースから明確に分離し、利用者にとってベストで自然な形にすることができますし、一つの関数に2つの責任を負わせて2つの仕事をさせるのを回避することができます。数ある利点の中でも特に、NVI を使うことはあなたのクラスのデザインを重要な点で明確にすることがあります。たとえば呼び出し元にとって問題となるデフォルト引数が仮想インターフェースではなく public インターフェースに自然に属しているといったようなことです。このパターンに従うことで、潜在的な問題となるようなクラス(このデフォルト引数付きの仮想関数をもったものなど)が単純に発生しなくなります。

The C++ standard library follows NVI nearly universally, and other modern OO languages and environments have rediscovered this principle for their own library design guidelines, such as in the .NET Framework Design Guidelines.

C++ 標準ライブラリはほぼすべての箇所で NVI に従っています。また他のモダンな OO 言語や処理系もそのライブラリのデザインガイドラインにおいてこの原則を再発見しています。たとえば .NETのクラスライブラリ設計 開発チーム直伝の設計原則、コーディング標準、パターン (Microsoft.net Development Series)

2. (b) What did the programmer probably expect the program to print, but what is the actual result?

2. (b) そのプログラマはこのプログラムが印字することを期待していたのだと思うが、実際には何が起こるか?

Now that we have those issues out of the way, let’s look at the mainline and see whether it does that the programmer intended:

これまでの問題では本筋から外れてしまっていましたが、いよいよ本流に戻ってそのプログラマが何を意図していたのかを見ていきましょう。

int main() {
    base    b;
    derived d;
    base*   pb = new derived;

    b.f(1.0);

No problem. This first call invokes base::f( double ), as expected.

これは問題ないですね。最初の呼び出しは base::f(double) を期待通り呼び出します。

    d.f(1.0);

This calls derived::f( complex ). Why? Well, remember that derived doesn’t declare using base::f; to bring the base functions named f into scope, and so clearly base::f( int ) and base::f( double ) can’t be called. They are not present in the same scope as derived::f( complex ) so as to participate in overloading.

これは derived::f(complex) を呼び出します。なぜでしょうか?derived が f という名前の base の関数をスコープに持ち込むための using base::f; を宣言していなかったことを思い出してください。ということで、明らかに base::f(int) と base::f(double) は呼び出されません。それらは derived::f(complex) と同じスコープには存在しないので、オーバーロードの対象になりません。

The programmer may have expected this to call base::f( double ), but in this case there won’t even be a compile error because fortunately(?) complex provides an implicit conversion from double, and so the compiler interprets this call to mean derived::f( complex(1.0) ).

そのプログラマは base::f(double) が呼び出されることを期待していたかもしれませんが、このケースでは幸運なことに(?)コンパイルエラーにすらなりません。complex が double からの暗黙の変換を提供していてコンパイラが derived::f(complex(1.0)) を呼び出すように解釈するからです。

    pb->f(1.0);


Interestingly, even though the base* pb is pointing to a derived object, this calls base::f( double ) because overload resolution is done on the static type (here base), not the dynamic type (here derived). You have a base pointer, you get the base interface.

面白いことに、base* pb は derived オブジェクトを指しているにもかかわらず、これは base::f(double) を呼び出します。オーバーロード解決が静的型(ここでは base)に対して行われるからで、動的型(ここでは derived)に対して行われるのではないためです。base ポインタを使うと、base のインターフェースが得られるというわけです。

For the same reason, the call pb->f(complex(1.0)); would not compile, because there is no satisfactory function in the base interface.

同じ理由で、pb->f(complex(1.0)); はコンパイルされません。base インターフェースにおいて、これを満たす関数は存在しないからです。

    b.g();


This prints 10, because it simply invokes base::g( int ) whose parameter defaults to the value 10. No sweat.

これは 10 を出力します。単純に base::g(int) を起動してそのデフォルト引数が 10 だからです。特に面白くありませんね。

    d.g();

This prints derived::g() 20, because it simply invokes derived::g( int ) whose parameter defaults to the value 20. Also no sweat.

これは derived::g() 20 を出力します。単純に derived::g(int) を起動してそのデフォルト引数が 20 だからです。これも特に面白くありません。

    pb->g();


This prints derived::g() 10.

これは derived::g() 10 を出力します。

“Wait a minute!” you might protest. “What’s going on here?” This result may temporarily lock your mental brakes and bring you to a screeching halt until you realize that what the compiler has done is quite proper. (Although, of course, the programmer of derived ought to be taken out into the back parking lot and yelled at.) The thing to remember is that, like overloads, default parameters are taken from the static type (here base) of the object, hence the default value of 10 is taken. However, the function happens to be virtual, and so the function actually called is based on the dynamic type (here derived) of the object. Again, this can be avoided by avoiding default arguments on virtual functions, such as by following NVI and avoiding public virtual functions entirely.

"ちょっと待って!" とあなたは抗議するかもしれません。"いったい何が起こっているの?" この結果は、コンパイラが何をしたのかを正しく理解できるまで一時的にあなたの精神のブレーキをロックしてキキーーッと止まらせてしまうかもしれません。(とはいえ、もちろんその derived を書いたプログラマは裏の駐車場に引きずり出されて怒鳴りつけられるべきでしょうね)覚えておくべきことは、オーバーロードのように、デフォルトパラメータはオブジェクトの静的型(ここでは base)から取られるということで、したがってデフォルト値の 10 が取られます。しかしながら、この関数は virtual として呼び出され、実際に呼び出される関数は動的型(ここでは derived)のオブジェクトにもとづいています。もう一度言いますが、これは NVI に従ったり public な仮想関数を全面的に回避するといったことによってデフォルト引数を仮想関数に与えるのを回避することで回避できます。

    delete pb;
}


Finally, as noted, this shouldn’t be needed because you should be using unique_ptrs which do the cleanup for you, and base should have a virtual destructor so that destruction via any pointer to base is correct.

最後に、すでに述べたように、これは必要とされるべきではありません。unique_ptr を使うべきだからです。unique_ptr があなたのために後片付けをしてくれます。また、base は仮想デストラクタを持つべきです。base への任意のポインタを介してデストラクションが正しく行われるようにするためです。

Acknowledgments 謝辞

Thanks in particular to the following for their feedback to improve this article: litb1, KrzaQ, mttpd.

この記事をより良くするための以下の各位からのフィードバックに対し、特に感謝する:litb1, KrzaQ, mttpd

GotW #4: クラスのメカニクス(勝手訳)

第 4 回めの GotW の翻訳です。

例によって原文著者(Herb Sutter 氏)の許可は得ていませんし、私の英訳がヒドいクオリティである(用語の統一がとれていないとか、誤訳が含まれているとか)かもしれませんのでそこのところはご理解いただければと思います。


原文:http://herbsutter.com/2013/05/20/gotw-4-class-mechanics/


How good are you at the details of writing classes? This item focuses not only on blatant errors, but even more so on professional style. Understanding these principles will help you to design classes that are easier to use and easier to maintain.

あなたはクラスを書くことにどれくらい詳しいですか?この項目では明らかなエラーにフォーカスするだけでなくプロフェッショナルなスタイルについてもフォーカスします。これらの原理を理解することが使いやすく保守しやすいクラスのデザインを助けるでしょう。

Problem 問題

JG Question 見習いグルへの質問

1. What makes interfaces “easy to use correctly, hard to use incorrectly”? Explain.

1. インターフェースを "正しく使うのは容易で、間違って使うのが難しい" ものにするにはどうすればよいですか?説明してください。

Guru Question グルへの質問

2. You are doing a code review. A programmer has written the following class, which shows some poor style and has some real errors. How many can you find, and how would you fix them?

2. あなたはコードレビューをしています。あるプログラマが以下の様なクラスを書きました。いくつか問題のあるスタイルといくつか実際のエラーがあるようです。いくつ見つけられますか?また、どうやって直しますか?

class complex {
public:
    complex( double r, double i = 0 )
        : real(r), imag(i)
    { }

    void operator+ ( complex other ) {
        real = real + other.real;
        imag = imag + other.imag;
    }

    void operator<<( ostream os ) {
        os << "(" << real << "," << imag << ")";
    }

    complex operator++() {
        ++real;
        return *this;
    }

    complex operator++( int ) {
        auto temp = *this;
        ++real;
        return temp;
    }

    // ... 上記を補足するより多くの関数 ...

private:
    double real, imag;
};

Note: This is not intended to be a complete class. For example, if you provide operator++ you would normally also provide operator–. Rather, this is an instructive example to focus on the mechanics of writing correctly the kinds of functions this class is trying to support.

注意:これは完全なクラスであることを意図して書かれていません。たとえば、operator++を提供するなら、普通はoperator-も提供するはずです。それよりも、これはこのクラスがサポートしようとしている機能のようなものを、正しく書くための方式にフォーカスするための手本となるような例です。

Solution 解答

1. What makes interfaces “easy to use correctly, hard to use incorrectly”? Explain.

1. インターフェースを "正しく使うのは容易で、間違って使うのが難しい" ものにするにはどうすればよいですか?説明してください。

We want to enable a “pit of success” where users of our type just naturally fall into good practices—they just naturally write code that is valid, correct, and efficient.

私たちのようなタイプのユーザが書くコードが、有効で、正しくて、効率的なものに自然になるような、"成功のための落とし穴" http://blogs.msdn.com/b/brada/archive/2003/10/02/50420.aspx を可能にしたいと思います。

On the other hand, we want to make it hard for our users to get into trouble—we want code that would be incorrect or inefficient to be invalid (a compile time error if possible) or at least inconvenient and hard to write silently so that we can protect the user from unwelcome surprises.

一方で、私たちのユーザがトラブルに巻き込まれにくくもしたいです。正しくない、または効率的でないようなコードが有効でない(可能であればコンパイル時エラーになる)ように、もしくは、少なくとも黙って書くには不便だったり難しいようにしたいです。そうすることで、ユーザをうれしくないサプライズから守ることができます。


Scott Meyers popularized this guidance. See his concise writeup for further examples.

スコットメイヤーズはこのガイダンスをポピュラーにしました http://programmer.97things.oreilly.com/wiki/index.php/Make_Interfaces_Easy_to_Use_Correctly_and_Hard_to_Use_Incorrectly。彼の簡潔な記事を更なる例として参照してください。

2. You are doing a code review. A programmer has written the following class, which shows some poor style and has some real errors. How many can you find, and how would you fix them?

2. あなたはコードレビューをしています。あるプログラマが以下の様なクラスを書きました。いくつか問題のあるスタイルといくつか実際のエラーがあるようです。いくつ見つけられますか?また、どうやって直しますか?

This class has a lot of problems—even more than I will show explicitly here. The point of this puzzle was primarily to highlight class mechanics (issues like “what is the canonical form of operator<

このクラスはたくさんの問題を抱えています--私がここで明示的に示すよりも多くの問題があります。この問題のポイントは、第一義的にはクラスのメカニクス(operator<<の正しい書き方は?とかoperator+はメンバにするべき?とかいったような問題)を浮き彫りにすることであって、インターフェイスが単にまずくデザインされていることを指摘することではありませんが、まずは二つのおそらくもっとも有用な観察から始めることにしましょう。


First, this is a code review but the developer doesn’t seem to have tried to even unit-test his code, else he would have found some glaring problems.

1つめは、これはコードレビューですが、その開発者はどうやら彼のコードに対してユニットテストさえしていなかったようです。もししていたら、いくつかの明確な問題が見つかっていたはずです。


Second, why write a complex class when one already exists in the standard library? And, what’s more, when the standard one isn’t plagued with any of the following problems and has been crafted based on years of practice by the best people in our industry? Humble thyself and reuse.

2つめに、なぜすでに標準ライブラリに存在している complex クラスを新たに書いたのでしょう?しかも、標準のものは以下の問題には全く悩まされることがなく、業界の最高レベルの人々によって何年分ものプラクティスに基づいて作られているものなのに?謙虚たれ。再利用せよ。


Guideline: Reuse code—especially standard library code—instead of handcrafting your own. It’s faster, easier, and safer.

ガイドライン:コードを再利用せよ -- 特に標準ライブラリのコードを -- 自分で手作りするのではなく。標準ライブラリのコードはより速く、より簡単で、より安全である。


Perhaps the best way to fix the problems in the complex code is to avoid using the class at all, and use the std::complex template instead.

おそらくこの complex コードにおける問題を修正するのにもっとも良い方法は、このクラスを全く使わずに、代わりに std::complex テンプレートを使うことです。


Having said that, it’s an instructive example, so let’s go through the class as written and fix the problems as we go. First, the constructor:

とは言うものの、これは教育的な例なので、このクラスで書かれていることを読んで問題を修正していきましょう。まずはコンストラクタです:


1. The default constructor is missing.

1. デフォルトコンストラクタがない

    complex( double r, double i = 0 )
        : real(r), imag(i)
    { }

Once we supply a user-written constructor, we suppress the implicit generation of the default constructor. Beyond “easy to use correctly,” not having a default constructor makes the class annoying to use at all. In this case, we could either default both parameters, or provide a complex() = default; and declare the data members with initializers such as double real = 0, imag = 0; , or just delegate with complex() : complex(0) { } . Just defaulting the parameter is the simplest here.

ユーザ定義のコンストラクタを提供すると、デフォルトコンストラクタの暗黙的な生成が抑制されます。"正しく使うのが容易" である以前に、デフォルトコンストラクタを持たないことは、そのクラスをまったく使い物にならなくします。このケースでは、両方のパラメータにデフォルトを指定するか、complex() = default; と書いてデータメンバを初期値付きで double real = 0; imag = 0; のように宣言します。もしくは、単に complex(): complex(0) {} とデリゲートしてもよいでしょう。ここでは単にそのパラメータにデフォルトを指定するのが最もシンプルです。

Also, as explained in GotW #1, prefer to use { } consistently for initialization rather than ( ) just as a good modern habit. The two mean exactly the same thing in this case, but { } lets us be more consistent, and could catch a few errors during maintenance, such as typos that would invoke double-to-float narrowing conversions.

また、GotW #1 で説明したように、初期化には () ではなく一貫して {} を使うようにしましょう。これは近代的な良い習慣です。このケースではその2つはまったく同じ意味になりますが、{} のほうがより一貫していますし、保守の時に、double から float へのナローイング変換が起動されてしまうようなタイポなどいくつかの間違いを防ぐことができます。

2. operator+ passes by value.

2. operator+ は値渡し

    void operator+ ( complex other ) {
        real = real + other.real;
        imag = imag + other.imag;
    }

Although we’re about make other changes to this function in a moment, as written this parameter should be passed by const& because all we do is read from it.

この関数にはすぐに別の変更も必要になりますが、この引数からは読み出ししか行わないので const& で渡すべきです。

Guideline: Prefer passing a read-only parameter by const& if you are only going to read from it (not make a copy of it).

ガイドライン:読み取り専用の引数は const& で渡すこと。(コピーが作られない)

3. operator+ modifies this object’s value.

3. operator+ は this オブジェクトの値を変更する

Instead of returning void, operator+ should return a complex containing the sum and not modify this object’s value. Users who write val1 + val2 and see val1 changed are unlikely to be impressed by these gratuitously weird semantics. As Scott Meyers is wont to say, when writing a value type, “do as the ints do” and follow the conventions of the built-in types.

void を返す代わりに、operator+ は合計値を持った complex を返すべきで、this オブジェクトの値を変更するべきではありません。ユーザが val1 + val2 と書いた時に val1 が変更されてしまったとしたら、その不当で奇妙なセマンティクスに感激するということはなさそうです。スコット・メイヤーズがよく言うように、値型を書くときは、"int がするようにする"、そして組込み型の変換に従うことです。

4. operator+ is not written in terms of operator+= (which is missing).

4. operator+ は operator+= を使って書かれていない(そして operator+= は存在するべきなのに欠けている)

Really, this operator+ is trying to be operator+=. It should be split into an actual operator+ and operator+=, with the former calling the latter.

実際のところ、この operator+ は operator+= になろうとしています。これは operator+ と operator+= に分けられるべきで、前者が後者を呼び出すようにすべきです。

Guideline: If you supply a standalone version of an operator (e.g., operator+), always supply an assignment version of the same operator (e.g., operator+=) and prefer implementing the former in terms of the latter. Also, always preserve the natural relationship between op and op= (where op stands for any operator).

ガイドライン:ある演算子の単独のバージョン(たとえば operator+)を提供するなら、常にその演算子の代入バージョン(たとえば operator+=)も提供し、前者を実装するのに後者を使用するようにする。また、op と op= の間の自然な関係を常に維持する(op は任意の演算子)。


Having += is good, because users should prefer using it. Even in the above code, real = real + other.real; should be real += other.real; and similarly for the second line.

+= を持つことはいいことです。ユーザがそれを優先的に使用することができるからです。上記のコードでも、real = real + other.real; は real += other.real; となるべきです。2行目も同様です。


Guideline: Prefer writing a op= b instead of a = a op b (where op stands for any operator). It’s clearer, and it’s often more efficient.

ガイドライン:a = a op b ではなく、a op= b を優先すること(ここで op は任意の演算子を表す)。より明快で、しばしばより効率的である。


The reason why operator+= is more efficient is that it operates on the left-hand object directly and returns only a reference, not a temporary object. On the other hand, operator+ must return a temporary object. To see why, consider the following canonical forms for how operator+= and operator+ should normally be implemented for some type T.

operato+= がより効率的である理由は、それが左辺のオブジェクトに直接作用し、一時オブジェクトではなく参照を返すからです。かたや operator+ は一時オブジェクトを返さなければなりません。理由を見るために、以下の正規化された形式の operator+= と operator+ がある型 T に対して通常どのように実装されるべきかを考えてみましょう。

T& T::operator+=( const T& other ) {
    //...
    return *this;
}

T operator+( T a, const T& b ) {
    a += b;
    return a;
}


Did you notice that one parameter is passed by value, and one by reference? That’s because if you’re going to copy from a parameter anyway, it’s often better to pass it by value, which will naturally enable a move operation if the caller passes a temporary object such as in expressions like (val1 * val2) + val3. This is a good habit to follow even in cases like complex where a move is the same cost as a copy, since it doesn’t cost any efficiency when move and copy are the same, and arguably makes for cleaner code than passing by reference and adding an extra named local object. We’ll see more on parameter passing in a future GotW.

ひとつの引数が値で渡され、もう一つが参照で渡されていることに気づきましたか?どのみち引数からコピーするのであれば最初から値で渡してしまったほうがよいですし、値で渡されると呼び出し元が一時オブジェクトを渡した時にムーブ操作が可能となります。たとえば式 (val1 * val2) + val3 のときのように。これは complex のようにムーブがコピーと同じコストであるようなケースでも従うべき良い習慣です。なぜならムーブとコピーが同じだったとしても効率性を犠牲にすることはありませんし、参照で渡して余計なローカルな名前付きオブジェクトを追加するよりもほぼ間違いなくクリーンなコードになるからです。将来の GotW でパラメータ渡しについてより詳しく見ていきます。


Guideline: Prefer passing a read-only parameter by value if you’re going to make a copy of the parameter anyway, because it enables move from rvalue arguments.

ガイドライン:どのみちパラメータのコピーを作るのであれば、読み取り専用パラメータを値で渡すようにする。rvalue 引数からムーブが可能となるので。


Implementing + in terms of += both makes the code simpler and guarantees consistent semantics as the two functions are less likely to diverge during maintenance.

+ を += を使って実装することは、コードをよりシンプルにしますし、保守の間に2つの関数が枝分かれしにくく一貫したセマンティクスを保証します。

5. operator+ should not be a member function.

5. operator+ はメンバ関数であるべきではない

If operator+ is made a member function, as it is here, then it won’t work as naturally as your users may expect when you do decide to allow implicit conversions from other types. Here, an implicit conversion from double to complex makes sense, but with the original class users have an asymmetry: Specifically, when adding complex objects to numeric values, you can write a = b + 1.0 but not a = 1.0 + b because a member operator+ requires a complex (and not a double) as its left-hand argument.

ここに書かれたように operator+ がメンバ関数であるならば、他の型からの暗黙の変換を可能にしようと決めた時にユーザが期待するとおりに自然には動かなくなります。ここでは、double から complex への暗黙の変換は意味がありますが、オリジナルのクラスのユーザは非対称性を持つことになります:特に、complex オブジェクトを数値に足すとき、 a = b + 1.0 とは書けるのに、a = 1.0 + b とは書けません。メンバ operator+ は左側の引数に complex (double ではない)を必要とするからです。


Finally, the other reason to prefer non-members is because they provide better encapsulation, as pointed out by Scott Meyers.

最後に、非メンバを使うべきもう一つの理由は、スコット・メイヤーズが指摘(http://www.drdobbs.com/cpp/how-non-member-functions-improve-encapsu/184401197)するように、それがよりよいカプセル化を提供するからです。


Guideline: Prefer these guidelines for making an operator a member vs. nonmember function: unary operators are members; = () [] and -> must be members; the assignment operators (+= –= /= *= etc.) must be members; all other binary operators are nonmembers.

ガイドライン:演算子をメンバ関数にするか非メンバ関数にするかという問題に対し、以下のガイドラインを用いる:単項演算子はメンバにする。= () [] -> はメンバでなければならない。代入演算子(+= -= /= *= など)はメンバでなければならない。他のすべての二項演算子は非メンバ。

6. operator<< should not be a member function.

6. operator<< はメンバ関数であるべきではない

The author of this code didn’t really mean to enable the syntax my_complex << cout, did they?

このコードを書いた人は、シンタックス my_complex << cout を可能にしたかったわけではないですよね?

    void operator<<( ostream os ) {
        os << "(" << real << "," << imag << ")";
    }


The same reasons already given to show why operator+ should be a nonmember apply also to operator<<, only more so because a member the first parameter has to be a stream, not a complex. Further, the parameters should be references: (ostream&, const complex &).

operator+ が非メンバであるべきであることを示すのにすでに与えられたのと同じ理由が operator<< にも適用されます。それだけではなく、メンバなのであれば最初のパラメータは complex ではなく stream であるべきです。さらに、パラメータは参照であるべきです:(ostream&, const complex&)


Note also that the nonmember operator<< should normally be implemented in terms of a(n often virtual) const member function that does the work, usually named something like print.

非メンバ operator<< は通常、実際の仕事をするconst メンバ関数(virtual にすることが多く、たいてい print のような名前)を使って実装されるべきです。

7. operator<< should return ostream&.

7. operator<< は ostream& を返すべき

Further, operator<< should have a return type of ostream& and should return a reference to the stream in order to permit chaining. That way, users can use your operator<< naturally in code like cout << a << b;.

さらに、operator<< は返り値の型として ostream& を持つべきで、チェイン化を可能とするために引数として渡された stream への参照を返すべきです。こうすることで、ユーザは cout << a << b; のようなコードの中であなたの operator<< を自然に使うことができます。


Guideline: Always return stream references from operator<< and operator>>.

ガイドライン:operator<< と operator>> からは常に stream の参照を返す。

8. The preincrement operator’s return type is incorrect.

8. 前置インクリメント演算子の返り値の型が正しくない

    complex operator++() {
        ++real;
        return *this;
    }


Ignoring for the sake of argument whether preincrement is meaningful for complex numbers, if the function exists it should return a reference. This lets client code operate more intuitively and avoids needless inefficiency.

前置インクリメントが complex (複素数)に対して意味のあるものかどうかという議論はさておき、前置インクリメントの関数が存在するのであればそれは参照を返すべきです。これはクライアントコードをより直感的に作用させ、無意味な非効率性を回避させます。


Guideline: When you return *this, the return type should usually be a reference.

ガイドライン:return *this と書くときは返り値の型は通常は参照です。

9. Postincrement should be implemented in terms of preincrement.

9. 後置インクリメントは前置インクリメントを使って実装されるべき

    complex operator++( int ) {
        auto temp = *this;
        ++real;
        return temp;
    }


Instead of repeating the work, prefer to call ++*this. See GotW #2 for the full canonical form for postincrement.

作業を繰り返すのではなくて、++*this を呼び出すようにしましょう。後置インクリメントの完全な正規形は GotW #2 を見てください。


Guideline: For consistency, always implement postincrement in terms of preincrement, otherwise your users will get surprising (and often unpleasant) results.

ガイドライン:一貫性のために、後置インクリメントは常に前置インクリメントを使って実装します。さもなければユーザは驚くような(そしてそれはたいてい嬉しくない)結果を得ることになります。

Summary まとめ

That’s it. There are other modern C++ features we could apply here, but they would be arguably gratuitous and not appropriate for general recommendations. For example, this is a value type not designed to be inherited from, so we could prevent inheritance by making the class final, but that would be protecting against Machiavelli, not Murphy, and there’s no need for a general guideline that tells everyone they should now write final on every value type; that would just be tedious and unnecessary.

以上です。他にも適用可能なモダンな C++ の機能がありますが、それはほぼ間違いなく余計なもので、一般的な推奨としては適切ではないでしょう。たとえば、これが値型であって継承されるようにデザインされていないので、クラスを final にすることで継承を防ぐことができます。しかしそれはマキアヴェッリから守るかもしれませんがマーフィーからは守りません(訳注:マキアヴェッリは目的のために手段を選ばない様から、重箱の隅をつつくような、ごく希な間違い・失敗のことを表していると考えられ、マーフィーはマーフィーの法則から、人々が起こしがちなよくある間違いのことを表していると考えられます)。そして全員に今すぐすべての値型に対して final と書けと命じるような一般的なガイドラインの必要性もありません;単につまらない不必要なものになりかねません。


Here’s a corrected version of the class, ignoring design and style issues not explicitly noted above:

最後に修正されたバージョンのクラスを示します。ここでは上記で明示的に示された設計やスタイル上の問題は無視しています:

class complex {
public:
    complex( double r = 0, double i = 0 )
        : real{r}, imag{i}
    { }

    complex& operator+=( const complex& other ) {
        real += other.real;
        imag += other.imag;
        return *this;
    }

    complex& operator++() {
        ++real;
        return *this;
    }

    complex operator++( int ) {
        auto temp = *this;
        ++*this;
        return temp;
    }

    ostream& print( ostream& os ) const {
        return os << "(" << real << "," << imag << ")";
    }

private:
    double real, imag;
};

complex operator+( complex lhs, const complex& rhs ) {
    lhs += rhs;
    return lhs;
}

ostream& operator<<( ostream& os, const complex& c ) {
    return c.print(os);
}

Acknowledgments 謝辞

Thanks in particular to the following for their feedback to improve this article: Mikhail Belyaev, jlehrer, Olaf van der Spek, Marshall, litb1, hm, Dave Harris, nosenseetal.

この記事をより良くするための以下の各位からのフィードバックに対し、特に感謝する: Mikhail Belyaev, jlehrer, Olaf van der Spek, Marshall, litb1, hm, Dave Harris, nosenseetal.

Xmodmap でお好みのキーバインド

前フリ

プログラマのみなさんならキーボードにこだわりを持ってなおかつタイピング速度を0.01秒でも稼ぐために日夜キーバインドを研究されていることと思います。

そんな私は Windows では AutoHotKeyLinux では Xmodmap、Mac では KeyRemap4Mac を愛用しております。

新しい環境や新しいキーボードが手に入ったりするとまずはキーボードの設定から、という方も多いのではないでしょうか。

私は HHK を長年愛用しており、新しいコンピュータを購入したら何はともあれコイツをつないで、キーバインドの設定からはじめます。

とはいえ、もう長いこと使い込んだ設定ファイルの類はそんなに直す機会はないのですが、近頃 RealForce のお下がりをもらったのでこれをもう少し使いこんでみようとしておりまして、久しぶりに設定ファイルを書くハメになったわけです。

このキーボードを Linux で使うことにしたので、Xmodmap の設定ファイルを新たに作る必要があります。

しかし Xmodmap の書き方をすっかり忘れてしまっていたのでメモしておきます。
(どうも Web 上に転がってる情報は古いのが多いのか、設定ファイルのフォーマットとかも最近のものとは異なるようですし、統一的な情報がまとめられたページが日本語/英語ともに見当たりませんでしたので。もしかしてキーバインドを変更するような人ってもはやオールドタイプというか生きた化石というか obsoleted で deprecated な存在!?)


キーバインドの設定の大まかな流れは以下のようになります。

  1. xev コマンドで、どのキーを押したらどのようなキーコードがキーボードから送られてくるかをチェック
  2. キーコードがわかったら .Xmodmap ファイルにキーバインドを記述


私は HHK では左◇キーと h, j, k, l をそれぞれ同時に押したらそれがカーソルキーになるといったキーバインドを設定していますので、RealForce でも同様なキーバインドができるようになることを想定しています。

それ以上複雑なことはしようとは今のところ考えていません。


それでは、さっそく始めましょう。


1. xev コマンドで、どのキーを押したらどのようなキーコードがキーボードから送られてくるかをチェック

まず、おもむろにターミナルから xev コマンドを実行します。
すると、Event Tester という白いウインドウが出てくると思います。
同時に、ターミナルにはいろいろなイベントの情報がずらずらと表示されると思います。

Event Tester にフォーカスを合わせ、何かキーを押してみましょう。

たくさんの情報が表示されると思いますが、そのなかから KeyPress イベントや KeyRelease イベントを探しましょう。

KeyPress event, serial 36, synthetic NO, window 0x4200001,
    root 0xb6, subw 0x0, time 30146314, (1536,-767), root:(1602,494),
    state 0x0, keycode 64 (keysym 0xffe9, Alt_L), same_screen YES,
    XLookupString gives 0 bytes: 
    XmbLookupString gives 0 bytes: 
    XFilterEvent returns: False

KeyRelease event, serial 36, synthetic NO, window 0x4200001,
    root 0xb6, subw 0x0, time 30146434, (1536,-767), root:(1602,494),
    state 0x8, keycode 64 (keysym 0xffe9, Alt_L), same_screen YES,
    XLookupString gives 0 bytes: 
    XFilterEvent returns: False

それぞれ 3 行目くらいに
keycode 64 (keysym 0xffe9, Alt_L)
っていうのが見えると思います。

これは私の持っているキーボードで左 Alt キーを押した時の例です。

目的の数字は 64 です。
他のキーを押すとここが別の値になっていると思います。
また、同じ左 Alt キーでも、環境が異なれば別の値になっているかもしれません。


以下のコマンドを実行すると、現在割り当てられているキーバインドの一覧を確認することができます。

$ xmodmap -pke 


キーバインドを設定したいキーをいろいろ押してみたり、上記の一覧を参照しながら、そのキーコードをメモしておきましょう。

私の場合は、HHK で ◇ キーに相当する位置に RealForce では左 Alt キーがありますので、左 Alt + H, J, K, L でカーソルキーが押されたかのようにしたいと思います。
そこで、左 Alt キー と H, J, K, L の各キーのキーコードを調べます。

また、Alt + H などを入力したときにカーソルキーとして動くようになってしまうと、本当に Alt + H を入力したいときにできなくなってしまいますので、Windows キーを潰して代わりにそれを Alt キーのように使いたいと思います。

つまり、左 Alt キー を ◇ キーのようなキーに変更し、Windows キーを新しい左 Alt キーに変更します。
ついでに Caps Lock は不要なので Control キーに変更してみたいと思います。

キーボード上の物理的なキー キーコード 新しい役割
左 Alt 64 HHK の ◇ キーのようなキー
Windows 133 左 Alt
Caps Lock 66 左 Control
H 43 ◇+H でカーソルの左キー
J 44 ◇+J でカーソルの下キー
K 45 ◇+K でカーソルの上キー
L 46 ◇+L でカーソルの右キー

なお、上記のキーコードは私の環境でそうだったというだけで、環境が異なれば値も異なります。


調べ終わったら、xev のウインドウを閉じます。


2. キーコードがわかったら .Xmodmap ファイルにキーバインドを記述

さて、キーコードがわかったら、~/.Xmodmap ファイルを開いて編集しましょう。

ポインタ(マウス)の設定

Ubuntu 12.04 もしくは類似の環境の場合、デフォルトでは、次のような内容のファイルが存在しているかもしれません。存在していなければこのセクションは無視してください。

pointer = 1 2 3 4 5 6 7 8 9 10 11 12

これの意味するところは、マウスのボタンの入れ替え設定です。

とはいえ、上記の設定ではボタンの入れ替えはしていません。つまり、
物理的に 1 番のボタンが押されたらボタンコード 1 番が生成されて、
物理的に 2 番のボタンが押されたらボタンコード 2 番が生成されて、
 :
物理的に 12番のボタンが押されたらボタンコード 12番が生成されるように設定されています。

pointer = のあとに、物理ボタンの番号順に、生成したいボタンコードをスペースで区切って書いていきます。

ちなみに、普通のマウスでは 1 番のボタンとは左ボタン、2番のボタンが中ボタン、3番のボタンが右ボタンと割り当てられているようです。また、ホイールを上向きに回すと4番のボタンが押されたかのようにコードが生成され、下向きに回すと5番のボタンが押されたとみなされるようです。私の環境でもそうなっていました。

普通の人が持っているマウスはせいぜいその 5 つくらいのボタンを持っていると思いますが、Xmodmap の設定ファイルではもっとたくさんのボタンを持っているマウスのために、デフォルトで12個のボタンの定義が書かれているのだと思います。

もし、左ボタンと右ボタンの役割を入れ替えたいのであれば、

pointer = 3 2 1 4 5 6 7 8 9 10 11 12

と記述すれば良いようです。

こうすると、物理的に1番のボタン(左)が押されるとボタンコード3番(右)が生成され、物理的に3番(右)のボタンからはボタンコード1番(左)が生成されます。

また、4 と 5 を入れ替えると Natural Scrolling のような事ができるかもしれません。

マウスのボタンの入れ替えを考えていないのであれば、この行は元のまま残しておきましょう。

キーコードと keysym

さて、話がそれました。キーバインドの設定をしましょう。


以下のコマンドを実行すると、現在割り当てられているキーバインドの一覧を確認することができるのでした。

$ xmodmap -pke 


たとえば A キーの割り当ては、

keycode  38 = a A a A

となっていました。

これの意味するところは、右辺の左から順番に

  • A キーだけを押したら小文字の a
  • Shift + A を押したら大文字の A
  • Mode_switch + A を押したら小文字の a
  • Mode_switch + Shift + A を押したら大文字の A

が入力されるということです。

さて、ここで Mode_swtich とはなんでしょう?
聞いたことのないキーです。

$ xmodmap -pke | grep -i mode_switch

と実行すると、私の環境では

keycode 203 = Mode_switch NoSymbol Mode_switch

となっていました。

しかし、私のキーボード上のどのキーを押しても、このキーコードを発生させることができませんでした。

キーボードによっては、このキーコードを発生させる AltGr というキーを持っているものもあるそうですが、私のキーボードにはそのような物理的なキーはありません。

それでは、左 Alt キーを Mode_switch のように働かせて、Mode_switch + H, J, K, L の役割をカーソルキーの上下左右に割り当てれば良さそうです。

まず物理的な左 Alt キー(私の環境ではキーコードは 64 でした)を Mode_switch キーに変更するには、.Xmodmap ファイルに以下の行を書きます。

keycode 64 = Mode_switch

これで、キーコード 64 のキー(物理的な左 Alt キー)に Mode_switch という役割を割り当てたことになります。ちなみに、この、右辺に書かれているキーの役割のことを keysym と言います。

キーコードの数字は、私は10進数で書きましたが、16進数などで書いても良いようです。
keysym は大文字小文字を区別します。Mode_switch の s は小文字ですので気をつけてください。

他にどのような keysym があるかは /usr/include/X11/keysymdef.h というファイルの中に記述されています。(XK_ というプリフィクスを取り除いたものが keysym になります。)
なお、このファイルは x11proto-core-dev というパッケージをインストールしておかないと存在しません。


さて、これだけで済めば良いのですが、実はそうもいきません。

キーコード 64 のキーは元々 Alt_L という keysym を持っていて、そのキーコード 64 のキーはモディファイアキーという特殊なキーに割り当てられていますので、上記の行だけではまだ足りないのです。
(モディファイアキーに割り当てられていないキーは上記の行だけで設定変更が可能)


モディファイアキー

モディファイアキーとは、Control や Shift、Alt などのように、他のキーと組み合わせて使うためのキーです。

あなたの環境でどのようなモディファイアキーが定義されているかは以下のように単に xmodmap コマンドを実行することで知ることができます。

$ xmodmap
xmodmap:  up to 4 keys per modifier, (keycodes in parentheses):

shift       Shift_L (0x32),  Shift_R (0x3e)
lock        Caps_Lock (0x42)
control     Control_L (0x25),  Control_R (0x69)
mod1        Alt_L (0x40),  Alt_R (0x6c),  Meta_L (0xcd)
mod2        Num_Lock (0x4d)
mod3      
mod4        Super_L (0x85),  Super_R (0x86),  Super_L (0xce),  Hyper_L (0xcf)
mod5        ISO_Level3_Shift (0x5c),  Mode_switch (0xcb)

上記は私の環境でのデフォルトの例です。

例えば shift というモディファイアキーの役割を実行するには、キーコード 0x32 のキー(Shift_L という役割を与えられているが物理的に左シフトキーとは限らない)かキーコード 0x3e のキー(Shift_R という役割を与えられているが物理的に右シフトキーとは限らない)を押せば良いということを表しています。

キーコード 0x40 のキー(0x40 は 10 進数で 64 なので、上記調査結果からこれは物理的な左 Alt キーです)を押すと、mod1 というモディファイアキーになるようです。

shift、lock、control についてはなんとなくどんな役割か想像がつきますが、mod1〜mod5 のモディファイアキーについてはなんだかよくわかりませんね。
普通に生活している分には mod1〜mod5 のモディファイアにはお世話にならない気がしますので、気にしないでおきましょう。

さて、モディファイアキーに割り当てられている keycode に、別の keysym を割り当てるときは、一旦モディファイアキーのグループから抜けさせないといけない、というルールがあるようです。

私の例では左 Alt キー(キーコード 64)は mod1 のグループに入れられていますので、別の keysym(役割)を割り当てるまえに、このグループから抜けさせないといけません。

そこで、先ほどの .Xmodmap の設定ファイルの先頭に以下の行を追加します。

! この行を追加
remove mod1 = Alt_L

! これはさきほど書いておいた行
keycode 64 = Mode_switch

(行の先頭に ! がある行はコメントとみなされます。)

remove mod1 = Alt_L という書き方はなんとなく気持ち悪いですが、mod1 というグループから Alt_L を削除するという意味です。

これで、物理的に左 Alt キーを押すと Mode_switch キーとして働くようになります。

.Xmodmap ファイルを保存したら、以下のコマンドで読み込んでみましょう。

$ xmodmap ~/.Xmodmap

エラーは起こらなかったでしょうか?
大丈夫なようなら xev コマンドを起動し、物理的な左 Alt キーを押した時の keysym がどうなったか見てみましょう。

KeyPress event, serial 36, synthetic NO, window 0x1c00001,
    root 0xb6, subw 0x0, time 148526330, (1151,-215), root:(1201,557),
    state 0x0, keycode 64 (keysym 0xff7e, Mode_switch), same_screen YES,
    XLookupString gives 0 bytes: 
    XmbLookupString gives 0 bytes: 
    XFilterEvent returns: False

KeyRelease event, serial 36, synthetic NO, window 0x1c00001,
    root 0xb6, subw 0x0, time 148526458, (1151,-215), root:(1201,557),
    state 0x0, keycode 64 (keysym 0xff7e, Mode_switch), same_screen YES,
    XLookupString gives 0 bytes: 
    XFilterEvent returns: False

keysym が Mode_switch になっていますね。やりました!

$ xmodmap
xmodmap:  up to 4 keys per modifier, (keycodes in parentheses):

shift       Shift_L (0x32),  Shift_R (0x3e)
lock        Caps_Lock (0x42)
control     Control_L (0x25),  Control_R (0x69)
mod1        Alt_R (0x6c),  Meta_L (0xcd)
mod2        Num_Lock (0x4d)
mod3      
mod4        Super_L (0x85),  Super_R (0x86),  Super_L (0xce),  Hyper_L (0xcf)
mod5        ISO_Level3_Shift (0x5c),  Mode_switch (0xcb)

mod1 から Alt_L (0x40) が抜かれていますね。


それでは、ようやく目的の H, J, K, L との組み合わせを .Xmodmap に記述していきましょう。

remove mod1 = Alt_L
keycode 64 = Mode_switch

! ここから下を追加
keycode 43 = h H Left Left
keycode 44 = j J Down Down
keycode 45 = k K Up Up
keycode 46 = l L Right Right


保存したら、また同じコマンドで .Xmodmap を読み込ませてみます。

$ xmodmap ~/.Xmodmap


左 Alt + H, J, K, L で上下左右にカーソルが動いたら成功です!


あとは残りの Windows キーと Caps Lock キーの変更を行いましょう。
私の環境では、Windows キーはキーコード 133 で、Super_L という keysym を持っていました。また、mod4 というモディファイアキーのグループに入っていました。

Caps Lock キーはキーコード 66 で、Caps_Lock という keysym を持っており、lock というモディファイアキーのグループに入っています。

したがって、キーコード 133(Windows キー)やキーコード 66(Caps Lock キー)に別の役割(keysym)を割り当てるために、それぞれモディファイアキーのグループから一旦抜けさせないといけません。

また、Caps Lock キーは Control キーとして生まれ変わるために、keysym を割り当てたあとに control モディファイアキーのグループに仲間入りさせてあげないといけません。

これらを総合すると、.Xmodmap ファイルは以下のようになるでしょう。

remove mod1 = Alt_L
remove mod4 = Super_L
remove lock = Caps_Lock

keycode 64 = Mode_switch
keycode 133 = Alt_L
keycode 66 = Control_L

keycode 43 = h H Left Left
keycode 44 = j J Down Down
keycode 45 = k K Up Up
keycode 46 = l L Right Right

add control = Control_L

一般的に、.Xmodmap ファイルの中身は以下の順番で記述すると良いようです。


  1. モディファイアキーのグループから remove
    (役割を変更したい keycode にその時点で割り当てられている keysym を remove)

  2. keycode に keysym を割り当てる
    (物理キーに役割を割り当てる)

  3. モディファイアキーのグループに add
    (新しく割り当てられた役割に応じてモディファイアキーとして動作するように再割当て)



この .Xmodmap を読み込ませたあとのモディファイアキーの割り当ては以下のようになっています。

$ xmodmap
xmodmap:  up to 3 keys per modifier, (keycodes in parentheses):

shift       Shift_L (0x32),  Shift_R (0x3e)
lock      
control     Control_L (0x25),  Control_L (0x42),  Control_R (0x69)
mod1        Alt_R (0x6c),  Meta_L (0xcd)
mod2        Num_Lock (0x4d)
mod3      
mod4        Super_R (0x86),  Hyper_L (0xcf)
mod5        ISO_Level3_Shift (0x5c),  Mode_switch (0xcb)

lock グループに割り当てられているキーはなくなりました。
これでどんなキーを押しても Caps Lock として働くことはなくなったということです。

代わりに、キーコード 0x42(66)の Control_L が control グループに仲間入りしています。
元々あった左 Control キーに加え、Caps Lock キーもコントロールキーとして働くようになったということです。

また、Super_L もなくなりました。新しく割り当てた Mode_switch もどこにも入っていません。
これらのキーをモディファイアキーとして使いたければ、add を使って mod4 とか mod5 に追加してあげるとよいかもしれません。(私はいずれにしろ mod1〜mod5 は使いませんのであえて add しませんでした)

これで .Xmodmap で設定できることはだいたい説明し終わったはずです。
ここまでのことが理解できていれば、あとは man xmodmap でも見れば十分なはずです。


またいつか新しいキーボードを手にした時の自分のための長いメモを以上で終えたいと思います。

東プレ REALFORCE 86U /静電容量無接点/変荷重/86キー/USB SE0500

東プレ REALFORCE 86U /静電容量無接点/変荷重/86キー/USB SE0500


GotW #3: 標準ライブラリを使う(もしくは一時オブジェクト再訪)(勝手訳)

第 3 回めの GotW の翻訳です。

例によって原文著者(Herb Sutter 氏)の許可は得ていませんし、私の英訳がヒドいクオリティである(用語の統一がとれていないとか、誤訳が含まれているとか)かもしれませんのでそこのところはご理解いただければと思います。


原文:http://herbsutter.com/2013/05/16/gotw-3-solution-using-the-standard-library-or-temporaries-revisited/



Effective reuse is an important part of good software engineering. To demonstrate how much better off you can be by using standard library algorithms instead of handcrafting your own, let’s reconsider the previous question to demonstrate how many of the problems could have been avoided by simply reusing what’s already available in the standard library.

効率的な再利用は、よいソフトウェア工学の重要な一部です。自作のものを使う代わりに標準ライブラリのアルゴリズムを使うことによってどれだけのメリットがもたらされるかを示すために、前回の質問をもう一度考えてみましょう。標準ライブラリにすでに存在しているものを単に再利用するだけで、そこで起こった問題がどれだけ回避できるかがわかるはずです。

Problem 問題

JG Question 見習いグルへの質問


1. What is the most widely used C++ library?

1. 最も広く使われている C++ のライブラリは何か?

Guru Question グルへの質問


2. How many of the pitfalls in GotW #2 could have been avoided in the first place, if only the programmer had replaced the explicit iterator-based for loop with:

2. GotW #2 の落とし穴のうち、明示的なイテレータベースの for ループを以下の方法で書き換えただけで、いくつの問題が回避されるか?


(a) a range-based for loop?
(b) a standard library algorithm call?

(a) 範囲ベースの for ループ
(b) 標準ライブラリアルゴリズムの呼び出し


Demonstrate. (Note: As with GotW #2, don’t change the semantics of the function, even though they could be improved.)

解答してください。(注意:GotW #2 と同様、関数のセマンティクスは変更しないでください。たとえ改善につながるとしても)


To recap, here is the mostly-fixed function:

以下は、前回の解答においてほぼ修正済みの関数です:

string find_addr( const list<employee>& emps, const string& name ) {
    for( auto i = begin(emps);  i != end(emps); ++i ) {
        if( i->name() == name ) {
            return i->addr;
        }
    }
    return "";
}

Solution 解答

1. What is the most widely used C++ library?

1. 最も広く使われている C++ のライブラリは何か?

The C++ standard library, with its implementations on every platform.

C++ 標準ライブラリ。すべてのプラットフォームにおいてその実装についてくるもの。


2. (a) How many of the pitfalls in GotW #2 could have been avoided with a range-based for loop?

2. GotW #2 の落とし穴のうち、明示的なイテレータベースの for ループを以下の方法で書き換えただけで、いくつの問題が回避されるか?

Astute readers of GotW #2 will have been champing at the bit to say: “Why aren’t you using a range-based for loop?” Indeed, why not? That would solve several of the temporaries, never mind be easier to write.

鋭い読者なら、GotW #2 の時から "範囲ベースの for loop を使ったらどうだい?" と言いたくてうずうずしていたことでしょう。確かにそうですね。そうすることでいくつかの一時オブジェクトの問題は解決しますし、むしろ書くのも簡単になるくらいです。

Compare the original unimproved explicit iterator loop:

比較してみましょう。
オリジナルの改善前の明示的イテレータループ:

    for( auto i = begin(emps); i != end(emps); i++ ) {
        if( *i == name ) {
            return i->addr;
        }
    }


with the range-based for loop (bonus points if you remembered to write the const auto&):

範囲ベースの for ループ(const auto& と書くことを覚えていたならボーナスポイントを差し上げます):

    for( const auto& e : emps ) {
        if( e == name ) {
            return e.addr;
        }
    }


The expressions e == name and return e.addr; are unchanged in terms of their possible or actual temporaries. But the questions in the naked loop code about whether or not the = causes a temporary (recall: it doesn’t), whether or not end() recalculation matters and should be hoisted (recall: probably not, but maybe), and whether or not i++ should be rewritten ++i (recall: it should) all simply don’t arise in the range-for code. Such is the power of clear code, and using a higher level of abstraction.

式 e == name と return e.addr; は一時オブジェクトができる可能性があることや実際にできてしまうという意味では変わっていません。しかし質問のループバージョンにあった、= が一時オブジェクトを生成するかどうか(実際にはしません)、end() の再計算が問題になるか、またループの外にくくり出されるべきか(おそらく問題にはなりませんが、なるかもしれません)、i++ は ++i と書きなおされるべきか(書きなおされるべきです)といったすべてのことが、範囲 for では単に問題になりません。これこそ、高度な抽象化を用いたクリアなコードのパワーです。


A key advantage is that using the range-based for loop has increased our level of abstraction, the information density in our code. Consider: What can you say about the following two pieces of code without reading what comes next?

範囲ベースの for ループを使うことの主なアドバンテージは、抽象化のレベルを上げ、コードの情報の精度を上げることです。次の2つのコード片について、次に何がくるかを読まずに何を言うことができるか考えてみてください。

    for( auto i = begin(emps); i != end(emps); i++ ) {   // A

    for( const auto& e : emps ) {                        // B

At first it might seem that lines A and B convey the same information, but they don’t. When you see A, all you know is that there’s a loop of some sort that uses an iterator over emps. Granted, we’re so used to A that our eye’s peripheral vision tends to “autocomplete” it in our heads into “a loop that visits the elements of emps in order” and our autocomplete is often correct—except when it isn’t: was that a ++, or a s+= 2 in a strided loop? is the index modified inside the body? Our peripheral vision might be wrong.

まず、行 A も B も同じ情報を含んでいるようだと思われますが、実際には違います。A を見てわかるのは、emps に対してイテレータを使って何らかのループをしているということです。確かに、私たちは A の形式に慣れていますし、私たちの目の周辺視野は頭のなかで "これは emps の要素を順に処理するループだ” と "オートコンプリート" しようとします。そしてそのオートコンプリートはたいてい正しいものです -- 間違っているとき以外は。もし ++ が +=2 だったら?そのインデックスはループ本体の中で変更されていない?私たちの周辺視野は間違えるかもしれません。


On the other hand, B conveys more information to the reader. When you see B, you know for certain without inspecting the body of the loop that it is a loop that visits the element of emps in order. What’s more, you’ve simplified the loop control because there’s no need for an iterator indirection. Both of these are raising the level of abstraction of our code, and that’s a good thing.

一方、B は読者に対してより多くの情報を与えます。B を見て、ループの本体を見なくても確実にわかるのは、これは emps の要素を順に処理するループであるということです。さらに、ループ制御がシンプルになります。イテレータによる間接参照が不要になるからです。これらのことはコードの抽象化のレベルを上げます。これは良いことです。


Note that, as discussed in GotW #2, the naked for loop didn’t naturally allow consolidating to a single return statement without resorting to making the code more complex by adding an additional variable and performing extra computation (a default construction followed by an assignment, instead of just a construction). That’s still true of the range-based for loop form, because it still has the two return statements in different scopes.

GotW #2 で議論したように、生の for ループを書くと必然的に return 文を一つだけにまとめることができません。一つにするには、コードを複雑にするような、変数の追加や余計な計算が必要になります(デフォルトコンストラクタによる構築と、代入が必要になります。ただ構築すれば良いだけではなくなります)。範囲ベースの for ループ形式でもそれは同じで、return 文をそれぞれ異なるスコープで2つ書かないといけないことには変わりありません。

2. (b) … with a standard library algorithm call?

2. (b) … 標準ライブラリアルゴリズムの呼び出しでは?


With no other changes, simply using the standard find algorithm could do everything the range-based for loop did to avoid needless temporaries (and questions about them):

他の変更なしで、単に標準の find アルゴリズムを使うことで、範囲ベースの for でできることは全てできて、かつ不要な一時オブジェクト(とそれにまつわる質問)を回避することができます。

// ベター (内部にフォーカス)
//
string find_addr( /*...*/ ) {
    const auto i = find( begin(emps), end(emps), name );   // はい、直してあげましたよ
    return i != end(emps) ? i->addr : "";
}


This naturally eliminates the same temporaries as the range-for version, and it further increases our level of abstraction. As with the range-based for loop, we can see at a glance and for certain that the loop will visit the elements of emps in order, but on top of that we also know we’re trying to find something and will get back an iterator to the first matching element if one exists. We do still have an iterator indirection, but only a single-use iterator object and no iterator arithmetic as in the original naked iterator for loop.

これは範囲ベースの for のバージョンと同じ一時オブジェクトを取り除きます。そして抽象化のレベルを更に引き上げます。範囲ベースの for ループのように、emps の要素に順に処理をするループであることがぱっと見で確定できます。その上、何かを見つけ(find)ようとしていて、もし見つかったら最初にマッチした要素へのイテレータが返されるということがわかります。イテレータによる間接参照はまだ残っていますが、イテレータオブジェクトは一度きりしか現れず、生のイテレータ for ループにあったようなイテレータの算術演算はありません。

Further, we have eliminated a loop nested scope entirely and flattened out the function to a single scope which can simplify this calling function in ways even the range-for couldn’t. To demonstrate still more just how fundamental this point is, note that what else the flattening out of the body buys us: Now, because the return statements are in the same scope (possible only because we eliminated the loop scope), we have the option of naturally combining them. You could still write if( i != end(emps) ) return i->addr; else return “”; here, on one or two or four lines, but there’s no need to. To be clear, the point here is not that reducing return statements should be a goal in itself—it shouldn’t be, and “single exit” thinking has always been flawed as we already saw in GotW #2. Rather, the point is that using an algorithm often simplifies our code more than an explicit loop, even a range-for loop, can do—not only directly by removing extra indirections and extra variables and a loop nested scope, but often also by permitting additional simplifications in nearby code.

さらに、ループのネストしたスコープをなくして関数を一つのスコープにフラットにして関数を単純に呼ぶだけにしました。これは範囲ベースの for でもできなかったことです。単にこの点が大変基本的なことというだけでないことを示すために、関数本体をフラットにすることが私たちにもたらしてくれるもう一つのことを強調しておきます:今、return 文が同じスコープにあるので(これはループのスコープを取り除いたことによってのみ可能なことです)、私たちはそれらを組み合わせることができます。if( i != end(emps) ) return i->addr; else return ""; と、1行もしくは2行、もしくは4行で書くこともできますが、そうする必要はありません。明確にしておきたいのですが、ここでのポイントは return 文の数を減らすことが自己目的化したゴールではないということです。またそうなるべきではありません。そして "一つの出口" という考えは、GotW #2 で見たように、常に間違っていました。ここでのポイントは、アルゴリズムを使うことは明示的なループを書くよりも私達のコードをよりシンプルにするものだ、ということです。余計な間接参照や余計な変数を取り除くことは範囲 for ループを使ってもできることではありますが、そのように直接的にシンプルにするだけではなく、周辺のコードのさらなるシンプル化を可能とします。

The above code might still cause a temporary when comparing an employee with a string, and we can eliminate even that temporary if we go one small step further and use find_if with a custom comparison that compares e.name() == name to avoid a possible conversion, assuming something like a suitable employee::name() is available as we did in GotW #2. Combining this with the other fixes to pass parameters by reference, we get:

上記のコードは employee を string と比較するときにまだ一時オブジェクトを生成します。その一時オブジェクトさえも取り除く事が可能です。もう一歩推し進めて、find_if をカスタム比較関数と合わせて使って e.name() == name で比較を行えば、発生しうる変換を回避できます。もちろんそれには GotW #2 でのように適切な employee::name() のようなものが使えるという前提です。これと引数を参照で渡すという修正を組み合わせると、こうなります:

// さらにベター (完成)
//
string find_addr( const list<employee>& emps, const string& name ) {
    const auto i = find_if( begin(emps), end(emps),
                      [&](const auto& e) { return e.name() == name; } );
    return i != end(emps) ? i->addr : "";
}

Summary まとめ


Prefer algorithm calls over explicit loops, when you have or can write a suitable algorithm that does what you want. They raise the level of abstraction and the clarity of our code. Scott Meyers’ advice in Effective STL is still true, and more applicable than even now that lambdas make algorithms much more usable than before:

あなたのしたい事をするようなアルゴリズムがすでにあるかあなたが書くことができるならば、明示的なループよりもアルゴリズム呼び出しを優先しましょう。それにより抽象化のレベルとコードの明快さが引き上げられます。Effective STL でのスコット・メイヤーズのアドバイスは今でも有効であり、以前よりもラムダがアルゴリズムをより使いでのあるものにした今となっては、そのアドバイスは一層当てはまります:

Guideline: Prefer algorithm calls to explicit loops. Algorithm calls are often clearer and reduce complexity. If no suitable algorithm exists, why not write it? You’ll use it again.

ガイドライン:明示的なループよりもアルゴリズム呼び出しを優先せよ。アルゴリズム呼び出しはより明快で、複雑さを低減させるものだ。適切なアルゴリズムが存在しなければ、それを書いてみよう。それを再利用することになるだろう。

Prefer reusing existing library code to handcrafting your own. The more widely used the library, the more likely it is to come well-designed, pre-debugged, and pre-optimized for many common requirements. And what library is more widely used than the standard library? In your C++ program, your standard library implementation is the most widely used library code you’re likely to use. This helps you both in the library’s design and its implementation: It’s full of code that’s intended to be used and reused, and to that end a lot of thought and care has gone into the design of its features, including its standard algorithms like find and sort. Implementers have also spent hours sweating over efficiency details, and usability details, and all sorts of other considerations so that you don’t have to—including performing optimizations you should almost never resort to in application-level code, such as using nonportable OS- and CPU-target specific optimizations.

自分で手作りするよりも既存のライブラリコードを再利用することを優先しましょう。ライブラリがより広く使われるようになると、そのライブラリは多くの一般的な要件に対してより良くデザインされ、事前にデバッグや最適化が済んでいるものになるでしょう。そして標準ライブラリよりも広く使われているライブラリはあるでしょうか?あなたの C++ プログラムの中で、あなたの標準ライブラリ実装が最も広く使われているライブラリコードで、あなたが使うべきものです。これはあなたをライブラリのデザインとその実装の両面で手助けします。標準ライブラリはすべて、利用され、再利用されることを意図して作られたコードです。find や sort のような標準的なアルゴリズムも含め、その機能のデザインにとてもたくさんの考えや配慮の集大成になっています。実装者は効率性の詳細や使いやすさの詳細、その他ありとあらゆる考慮しなければならないことに対して多大な時間をつぎ込み汗を流して来ました。あなたがそうしなくても良いように。あなたが決して使うことのなさそうな、移植性のない OS や CPU を対象にした固有の最適化といったような、最適化の実施もその中に含まれています。

So, always prefer to reuse code, especially algorithms and especially the standard library, and escape the trap of “I’ll-write-my-own-just-’cause-I-can.”

ですので、つねにコードの再利用を優先しましょう。アルゴリズムと特に標準ライブラリを。そして "自分で書けるから自分で書く" という罠を避けるようにしましょう。

Guideline: Reuse code—especially standard library code—instead of handcrafting your own. It’s faster, easier, and safer.

ガイドライン:自作するのではなく、コードを再利用せよ。特に標準ライブラリのコードを。それはより速いし、より簡単だし、より安全だ。

Acknowledgments 謝辞

Thanks in particular to the following for their feedback to improve this article: Olaf ven der Spek, Sam Kramer.

この記事をより良くするための以下の各位からのフィードバックに対し、特に感謝する:Olaf ven der Spek, Sam Kramer.