文字列処理

[C言語] strspn関数の使い方 – 先頭から文字を検索

2025-01-17更新日: 2025-01-17

C言語のstrspn関数は、文字列の先頭から指定した文字集合に含まれる文字が連続している部分の長さを返します。

具体的には、strspn(s1, s2)は、文字列s1の先頭から、文字集合s2に含まれる文字がどれだけ連続しているかを調べ、その長さを返します。

s1の最初の文字がs2に含まれていない場合、返り値は0になります。

目次から探す

strspn関数とは
strspn関数の基本的な使い方
strspn関数の具体例
応用例
strspn関数を使う際の注意点
まとめ

strspn関数とは

strspn関数は、C言語の標準ライブラリに含まれる文字列操作関数の一つで、指定した文字集合に含まれる文字が、文字列の先頭からどれだけ連続しているかを調べるために使用されます。

この関数は、文字列の先頭部分が特定の文字集合にどれだけ一致しているかを数値で返します。

返り値は、先頭から一致する文字の数であり、最初に一致しない文字が見つかった時点でのカウントが返されます。

これにより、文字列の解析やフィルタリング、形式チェックなど、さまざまな場面で役立ちます。

strspn関数は、特に入力データの検証やトークン化の前処理において非常に便利です。

strspn関数の基本的な使い方

文字列の先頭からの一致部分を調べる

strspn関数は、指定した文字列の先頭から、与えられた文字集合に含まれる文字がどれだけ連続しているかを調べます。

例えば、文字列が abc123 で、文字集合が abc であれば、strspnは3を返します。

これは、先頭から3文字が文字集合に含まれているためです。

以下は、基本的な使用例です。

#include <stdio.h>
#include <string.h>
int main() {
    const char *str = "abc123";
    const char *charset = "abc";
    size_t result = strspn(str, charset);
    printf("一致する文字数: %zu\n", result); // 一致する文字数: 3
    return 0;
}

返り値の解釈

strspn関数の返り値は、先頭から一致する文字の数です。

もし、最初の文字が文字集合に含まれない場合、返り値は0になります。

例えば、文字列が 123abc で、文字集合が abc の場合、返り値は0となります。

文字集合に含まれない文字が見つかった場合

文字列の先頭部分に、文字集合に含まれない文字が見つかると、strspnはその時点での一致数を返します。

例えば、文字列が xyz123 で、文字集合が abc の場合、最初の文字 x が文字集合に含まれないため、返り値は0になります。

空文字列を扱う場合の挙動

空文字列をstrspn関数に渡した場合、返り値は0になります。

これは、空文字列には一致する文字が存在しないためです。

また、文字集合が空の場合も、返り値は0となります。

以下の例を参照してください。

#include <stdio.h>
#include <string.h>
int main() {
    const char *str = ""; // 空文字列
    const char *charset = "abc";
    size_t result = strspn(str, charset);
    printf("一致する文字数: %zu\n", result); // 一致する文字数: 0
    return 0;
}

strspn関数の具体例

例1: 文字列の先頭から特定の文字集合を検索

以下の例では、文字列 hello123 の先頭から、文字集合 hel の一致部分を調べます。

strspn関数は、先頭から一致する文字の数を返します。

#include <stdio.h>
#include <string.h>
int main() {
    const char *str = "hello123";
    const char *charset = "hel";
    size_t result = strspn(str, charset);
    printf("一致する文字数: %zu\n", result); // 一致する文字数: 4
    return 0;
}

この場合、返り値は4で、先頭の hel が文字集合に含まれており、そのあとの lも含まれているため、4が返されます。

例2: 数字やアルファベットの連続部分を調べる

次の例では、文字列 123abc456 の先頭から、文字集合 0123456789 の一致部分を調べます。

#include <stdio.h>
#include <string.h>
int main() {
    const char *str = "123abc456";
    const char *charset = "0123456789";
    size_t result = strspn(str, charset);
    printf("一致する文字数: %zu\n", result); // 一致する文字数: 3
    return 0;
}

この場合、返り値は3で、先頭の 123 が数字の集合に含まれています。

例3: 空白文字や特殊文字の連続部分を調べる

次の例では、文字列 Hello World! の先頭から、文字集合 (空白)の一致部分を調べます。

#include <stdio.h>
#include <string.h>
int main() {
    const char *str = "   Hello World!";
    const char *charset = " ";
    size_t result = strspn(str, charset);
    printf("一致する文字数: %zu\n", result); // 一致する文字数: 3
    return 0;
}

この場合、返り値は3で、先頭の空白が3つ連続しているためです。

例4: 文字集合に含まれない文字が最初にある場合

最後の例では、文字列 !@#abc の先頭から、文字集合 abc の一致部分を調べます。

#include <stdio.h>
#include <string.h>
int main() {
    const char *str = "!@#abc";
    const char *charset = "abc";
    size_t result = strspn(str, charset);
    printf("一致する文字数: %zu\n", result); // 一致する文字数: 0
    return 0;
}

この場合、返り値は0で、最初の文字 ! が文字集合に含まれていないため、一致する文字がないことを示しています。

応用例

入力文字列の形式チェックに使う

strspn関数は、ユーザーからの入力が特定の形式に従っているかを確認するために利用できます。

例えば、電話番号や郵便番号など、特定の文字種のみを許可する場合に、先頭部分がその形式に合致しているかをチェックすることができます。

以下は、数字のみの電話番号をチェックする例です。

#include <stdio.h>
#include <string.h>
int main() {
    const char *input = "0123456789"; // ユーザー入力
    const char *validChars = "0123456789"; // 有効な文字集合
    size_t result = strspn(input, validChars);
    
    if (result == strlen(input)) {
        printf("有効な電話番号です。\n");
    } else {
        printf("無効な電話番号です。\n");
    }
    return 0;
}

特定の文字種(数字、アルファベットなど)の連続部分を抽出する

特定の文字種の連続部分を抽出する際にもstrspn関数が役立ちます。

例えば、文字列の先頭から数字の部分を抽出する場合、次のように使用できます。

#include <stdio.h>
#include <string.h>
int main() {
    const char *str = "123abc456"; // 対象文字列
    const char *digits = "0123456789"; // 数字の集合
    size_t result = strspn(str, digits);
    
    printf("先頭の数字部分: %.*s\n", (int)result, str); // 先頭の数字部分: 123
    return 0;
}

文字列のトークン化の前処理として使う

文字列をトークン化する前に、先頭から不要な文字をスキップするためにstrspn関数を使用することができます。

例えば、カンマ区切りのデータから、先頭の空白を取り除く場合の例です。

#include <stdio.h>
#include <string.h>
int main() {
    const char *data = "   apple,banana,cherry"; // カンマ区切りのデータ
    const char *whitespace = " "; // 空白文字集合
    size_t skip = strspn(data, whitespace); // 空白の数を取得
    
    const char *trimmedData = data + skip; // 空白をスキップしたデータ
    printf("トークン化するデータ: %s\n", trimmedData); // トークン化するデータ: apple,banana,cherry
    return 0;
}

文字列の先頭から特定のパターンをスキップする

特定のパターンをスキップするためにもstrspn関数が利用できます。

例えば、特定のプレフィックス(接頭辞)を持つ文字列から、そのプレフィックスを取り除く場合の例です。

#include <stdio.h>
#include <string.h>
int main() {
    const char *str = "prefix_data"; // プレフィックスを持つ文字列
    const char *prefix = "prefix_"; // スキップするプレフィックス
    size_t skip = strspn(str, prefix); // プレフィックスの長さを取得
    
    const char *result = str + skip; // プレフィックスをスキップした結果
    printf("スキップ後のデータ: %s\n", result); // スキップ後のデータ: data
    return 0;
}

これにより、特定のパターンを持つ文字列から、そのパターンを簡単に取り除くことができます。

strspn関数を使う際の注意点

NULLポインタを渡した場合の挙動

strspn関数にNULLポインタを渡すと、未定義の動作が発生します。

これは、関数が文字列の内容を参照しようとするため、プログラムがクラッシュする可能性があります。

したがって、strspnを使用する前に、引数として渡す文字列がNULLでないことを確認することが重要です。

以下は、NULLチェックの例です。

#include <stdio.h>
#include <string.h>
int main() {
    const char *str = NULL; // NULLポインタ
    const char *charset = "abc";
    
    if (str != NULL) {
        size_t result = strspn(str, charset);
        printf("一致する文字数: %zu\n", result);
    } else {
        printf("文字列がNULLです。\n");
    }
    return 0;
}

文字集合が空の場合の挙動

strspn関数に空の文字集合を渡した場合、返り値は0になります。

これは、空の文字集合には一致する文字が存在しないためです。

したがって、空の文字集合を使用する際には、意図した動作であることを確認する必要があります。

以下は、空の文字集合を使用した例です。

#include <stdio.h>
#include <string.h>
int main() {
    const char *str = "abc123"; // 対象文字列
    const char *emptyCharset = ""; // 空の文字集合
    size_t result = strspn(str, emptyCharset);
    
    printf("一致する文字数: %zu\n", result); // 一致する文字数: 0
    return 0;
}