HOWTO · Arduino

Arduino で文字列を分割

Arduino の substring()関数を使用して文字列を分割できます。

このページの内容

Arduinoには、すべてのフィールドを配列として返す String メソッドはありません。既知の範囲は substring() で抽出し、位置が分からない区切り文字は indexOf() で探せます。また、書き込み可能な文字配列は、C関数の strtok() でトークンに分割できます。手動の解析ループを使えば、空フィールドや複数の区切り文字を細かく制御できます。位置が分かっているか、入力を書き換えてよいか、区切り文字をどう扱うかに応じて方法を選んでください。

次の完全なスケッチでは、Arduinoの String と Serial APIを使います。ホスト側の小さな互換シムにより、ARDUINO が定義されていない場合は同じスケッチを標準C++として実行できます。ボード上ではArduinoコアがこれらのAPIを提供します。表示されるシリアル行はスケッチが生成しますが、コード内のラベルと出力文字列は変更せず、英語のままです。

Arduinoで substring() を使ってインデックス範囲を抽出する

抽出する範囲が分かっている場合は、substring(begin, end) を使います。開始インデックスの文字は含まれますが、終了インデックスの文字は含まれません。たとえば "Hello,World" では、インデックス0から4までで Hello となるため、終了引数には5を指定します。substring(begin) のように引数を1つだけ指定すると、そのインデックスから文字列の末尾までを抽出します。

次のスケッチを実行します。

このセクションのコードと表示されるラベルや出力は英語のままです。

#ifdef ARDUINO
#include <Arduino.h>
#else
#include <iostream>
#include <string>

class String {
 public:
  String(const char *value) : value_(value) {}
  int indexOf(char target) const {
    const auto position = value_.find(target);
    return position == std::string::npos ? -1 : static_cast<int>(position);
  }
  int indexOf(char target, unsigned int fromIndex) const {
    const auto position = value_.find(target, fromIndex);
    return position == std::string::npos ? -1 : static_cast<int>(position);
  }
  int lastIndexOf(char target) const {
    const auto position = value_.rfind(target);
    return position == std::string::npos ? -1 : static_cast<int>(position);
  }
  String substring(unsigned int begin, unsigned int end) const {
    return String(value_.substr(begin, end - begin).c_str());
  }
  String substring(unsigned int begin) const {
    return String(value_.substr(begin).c_str());
  }
  const char *c_str() const { return value_.c_str(); }

 private:
  std::string value_;
};

struct HostSerial {
  void begin(unsigned long) {}
  void println(const String &value) { std::cout << value.c_str() << '\n'; }
  void println(const char *value) { std::cout << value << '\n'; }
};

HostSerial Serial;
#endif

#include <cstring>

void setup() {
  Serial.begin(9600);

  String greeting = "Hello,World";
  Serial.println(greeting.substring(0, 5));

  String record = "sensor1:value1";
  int separator = record.indexOf(':');
  if (separator != -1) {
    Serial.println(record.substring(0, separator));
  }

  String recordWithoutColon = "sensor1";
  int absentSeparator = recordWithoutColon.indexOf(':');
  if (absentSeparator == -1) {
    Serial.println("delimiter not found");
  } else {
    Serial.println(recordWithoutColon.substring(0, absentSeparator));
  }

  String lines = "hello world\nGreetings\nPeople";
  int finalNewline = lines.lastIndexOf('\n');
  String finalLine = finalNewline == -1
                         ? lines
                         : lines.substring(finalNewline + 1);
  Serial.println(finalLine);

  String oneLine = "single line";
  int noNewline = oneLine.lastIndexOf('\n');
  String onlyLine = noNewline == -1 ? oneLine : oneLine.substring(noNewline + 1);
  Serial.println(onlyLine);

  char names[] = "Alice,Bob,Charlie,David";
  for (char *token = std::strtok(names, ","); token != nullptr;
       token = std::strtok(nullptr, ",")) {
    Serial.println(token);
  }

  String fields = "red,green,blue";
  unsigned int start = 0;
  while (true) {
    int nextSeparator = fields.indexOf(',', start);
    if (nextSeparator == -1) {
      Serial.println(fields.substring(start));
      break;
    }
    Serial.println(fields.substring(start, nextSeparator));
    start = nextSeparator + 1;
  }
}

void loop() {}

#ifndef ARDUINO
int main() {
  setup();
  return 0;
}
#endif
Hello
sensor1
delimiter not found
People
single line
Alice
Bob
Charlie
David
red
green
blue

ホスト側の互換シムは、一般的なC++コンパイラでスケッチのロジックを確認するためのもので、実機やArduinoハードウェアをエミュレートするものではありません。Arduino向けにビルドすると、条件付きコードはコアの実際の String と Serial 実装を使います。このスケッチは抽出前に indexOf() の結果を確認し、lastIndexOf('\n') == -1 の場合は改行のない文字列全体を使います。

indexOf() で区切り文字を探し、フィールドを抽出する

区切り文字の位置が一定でない場合は、indexOf() を呼び出し、返された位置を substring() の終了インデックスとして使います。指定した文字や文字列が見つからないと、Arduinoは -1 を返します。その値を substring() に渡す前に確認してください。確認しないと、有効なフィールド境界として扱えません。

たとえば String record = "sensor1:value1" で ':' を探します。結果が0以上なら、record.substring(0, separator) で sensor1 を抽出できます。コロンがない場合は、レコード全体を1つのフィールドとして扱うのか、入力を拒否するのかを明示的に決めます。複数のフィールドを取り出すには、前の区切り文字の次の文字から検索を繰り返します。

複数行文字列から最後の行を抽出する

lastIndexOf('\n') で最後の改行を探し、その1文字後から抽出を始めます。改行そのものから始めると改行文字も含まれ、シリアル出力に空行があるように見えることがあります。改行がなければ lastIndexOf() は -1 を返すため、その場合は別途処理します。たとえば、文字列全体を唯一の行として扱えます。

hello world、Greetings、People がそれぞれ別の行にある文字列では、最後の行の抽出を lastIndexOf('\n') + 1 から始めると、結果は People になります。

strtok() で変更可能な文字配列をトークンに分割する

strtok() の最初の呼び出しには、書き込み可能でヌル終端された文字配列を渡します。トークンを見つけると配列内の区切り文字をヌル文字に置き換えるため、文字列リテラルを渡したり、元の配列がそのまま残ると期待したりしないでください。同じ配列の走査を続けるには strtok(nullptr, delimiters) を呼び出し、nullptr が返されたら終了します。

区切り文字の引数は、複数文字からなる1つの区切りではなく、個々の文字の集合です。たとえば ":|" を指定すると、コロンまたはパイプの位置で分割します。連続する区切り文字は読み飛ばされるため、strtok() では空フィールドを保持できません。空フィールドや元の入力を保持する必要がある場合は、手動で解析してください。

手動の解析ループで区切り文字付きテキストを分割する

トークナイザーでは実現できないルールが必要な場合は、手動のループが便利です。区切り文字を探し、その前の範囲を処理してから、次の開始位置を区切り文字の後ろへ移します。ループの後には、入力が区切り文字で終わっていなくても残りの部分を処理します。これにより、例の最後のフィールドも含められます。

複数の区切り文字を使う場合は、各文字が選んだ集合に含まれるかを調べ、隣り合う区切り文字を空フィールドとして扱うか決めてください。空フィールドを保持するには、隣り合う区切り文字の間を読み飛ばさず、長さ0の範囲として処理します。元の入力を保持するには、Arduinoの元の String を変更せずに読み取るか、変更を伴うトークナイザーを使う前に文字配列をコピーします。

方法を選び、境界ケースを処理する

位置が固定されている場合は substring()、先に区切り文字を探す必要がある場合は indexOf()、最後に現れる位置が必要な場合は lastIndexOf() を使います。文字配列を書き換えてもよく、空フィールドを破棄してよい単純なトークン列には strtok() が適しています。複数の区切り文字、空フィールド、入力の保持について明確なルールがある場合は、手動のループがより適しています。

フィールドを抽出する前に、区切り文字が見つからない場合の扱いを決め、結果が -1 か確認してください。また、Arduinoの substring() では終了インデックスの文字は含まれず、改行の後のテキストを抽出するときは通常、改行自体を除外します。こうした選択によって、結果に意図した文字だけが含まれるかどうかが決まります。