ぷろみん

プログラミング的な内容を扱ってます

MSVCでも頑張ってC++20で導入されるspanを使う

C++

wandboxではspanを利用できるので動作確認だけならそちらが簡単です。

何故人はstringを使わないのか

stringは内部バッファに文字列を蓄えるので例えば

std::vector<std::string> Split(const std::string& text);

みたいな関数があった時に入力のテキストと出力の分割文字列で重複があるので無駄が多いと感じます。
そこで、区間を表す構造体が欲しくなります。

span

struct Span{
  char* pointer;
  size_t size;
};
std::vector<Span> Split(const std::string& text);

これで最小限の情報だけで関数を表現できたが、区間を入手したらその区間をイテレートしたいと思うのは自然なことでしょう。
分割したいアイテムが文字列じゃない場合を想定してテンプレートでSpanを書きたくなるかもしれません。
自分で書くのが億劫になってきました。

ちなみに文字列用のspanとして専用の<string_view>が存在するので、本来ならこっちを使うべきです。
MSVCの最新版では現在でも利用することができます。
string_viewをstring_spanにする案もあったそうですが、通らなかったんですかね。
string_viewはstringとほぼ同じ動作をし、無駄なnull終端を管理しません。
文字列を扱う場合はstring_viewを使いましょう。

#include <iostream>
#include <span>
#include <string_view>

template<class T>
void Print(T&& t){
    std::cout << t.size();
    for(auto i : t){
        std::cout << ",[" << i << "]";
    }
    std::cout << std::endl;
}

int main(){
    const char text[] = "ab";
    Print(std::span(text));
    Print(std::string_view(text));
}

//出力
//3,[a],[b],[]
//2,[a],[b]

utf8

更に横にそれますが、C++20になってchar8_tというutf8用の型が提供されるようになったので実際に使われる文字列はstd::u8string_viewが多くなるでしょう。

spanの使い道

コンテナの一部区間を出力したり、バイナリのチャンク分けの際に活躍します。
これらは上記と同じ問題が発生します。そこでspanの出番です。

ただ、概念を考えれば分かる通りspanやviewのスコープは参照元よりも短い必要があります。

現在のMSVCの最新版でもまだspanは導入されていません。C++20で入ることを考えると待っていたらリリースされそうではありますが、今欲しいとなると中々面倒です。

spanの導入

spanはCppCoreGuidelinesで提案されている概念の実装であるGSL (Guidelines Support Library)に含まれています。
今回はその中でもMicrosoftによる実装であるms-gslを利用します。

$ git init
$ git submodule add https://github.com/microsoft/vcpkg
$ cd vcpkg
$ ./bootstrap-vcpkg.bat
$ ./vcpkg.exe install ms-gsl
$ cd ..
$ touch main.cpp
$ touch CMakeLists.txt
$ cmake . -DCMAKE_TOOLCHAIN_FILE=vcpkg/scripts/buildsystems/vcpkg.cmake
$ cmake --build .

cmakeがinstall済みではない場合vcpkgが使っているものが以下にあります。
vcpkg\downloads\tools\cmake-3.14.0-windows\cmake-3.14.0-win32-x86\bin\cmake.exe

// main.cpp
#include <gsl/span>
// 上記と重複部分省略

int main() {
  Print(gsl::make_span("ab"));
}

# CMakeLists.txt
cmake_minimum_required(VERSION 3.1)

find_path(include_root_dir NAMES gsl/span)
include_directories(${include_root_dir})

add_executable(main main.cpp)