C言語を駆使したディレクトリ操作の全て！Dirent関数の10つの使い方と応用例

はじめに

C言語におけるディレクトリ操作のキーとなるのがdirent関数です。

これはディレクトリの開閉や、ファイル情報の取得などに使用されます。

本記事では、dirent関数を活用したディレクトリ操作の全てを解説します。

基本的な使い方から応用例まで、初心者でも理解できるように詳細に説明しますので、ぜひ実際のプログラミングに役立ててください。

●direntとは

direntはC言語で使用される標準ライブラリの一つです。

ここで「dirent」は「directory entry」を省略した形となり、文字通りディレクトリエントリー、つまりディレクトリやファイルに関する情報を扱うための機能を提供します。

○direntの基本的な役割

direntライブラリの主な役割は、ディレクトリの開閉と、ディレクトリ内のエントリー（ファイルやサブディレクトリ）の読み取りです。

これにより、プログラムからファイルシステムを直接操作することが可能となります。

●dirent関数の使い方

では、具体的なdirent関数の使用方法をサンプルコードを交えて解説します。

本記事では、基本的なディレクトリの開閉から、ファイルの読み込み、さらには応用的な操作までをカバーします。

○サンプルコード1：direntを使ってディレクトリを開く

下記のサンプルコードは、direntを使ってディレクトリを開く基本的なコードです。

この例では、direntの中にあるopendir関数を用いて、指定したディレクトリを開いています。

#include <dirent.h>
#include <stdio.h>

int main(void) {
    DIR *dir;
    dir = opendir("/path/to/directory");

    if (dir == NULL) {
        printf("ディレクトリを開くことができませんでした。\n");
        return 1;
    }

    printf("ディレクトリを開きました。\n");
    closedir(dir);

    return 0;
}

このコードでは、「/path/to/directory」の部分を開きたいディレクトリのパスに書き換えます。

opendir関数によってディレクトリを開き、成功すればDIR型のポインタが返されます。

ディレクトリの開き方に問題があった場合はNULLが返され、その場合にはエラーメッセージが表示されます。

最後に、必ずclosedir関数を使用して開いたディレクトリを閉じることが大切です。

○サンプルコード2：ディレクトリ内のファイルやサブディレクトリを読む

ディレクトリが正常に開けたら、次はその中のファイルやサブディレクトリを読むことができます。

下記のサンプルコードでは、direntの中にあるreaddir関数を使って、ディレクトリ内のエントリーを読み出しています。

#include <dirent.h>
#include <stdio.h>

int main(void) {
    DIR *dir;
    struct dirent *dp;

    dir = opendir("/path/to/directory");

    if (dir == NULL) {
        printf("ディレクトリを開くことができませんでした。\n");
        return 1;
    }

    while ((dp = readdir(dir)) != NULL) {
        printf("%s\n", dp->d_name);
    }

    closedir(dir);

    return 0;
}

このコードでは、まずディレクトリを開き、その後whileループとreaddir関数を組み合わせてディレクトリ内の全エントリーを読み出します。

各エントリーの情報はdirent構造体に格納され、その中のd_nameメンバにエントリーの名前が含まれます。

これを使って、エントリーの名前を表示しています。

○サンプルコード3：ディレクトリを閉じる

最後に、開いたディレクトリは必ず閉じる必要があります。

下記のコードはディレクトリを閉じるためのコードを表しています。

#include <dirent.h>
#include <stdio.h>

int main(void) {
    DIR *dir;

    dir = opendir("/path/to/directory");

    if (dir == NULL) {
        printf("ディレクトリを開くことができませんでした。\n");
        return 1;
    }

    closedir(dir);
    printf("ディレクトリを閉じました。\n");

    return 0;
}

このコードでは、opendir関数で開いたディレクトリを、closedir関数で閉じています。

これにより、開いたディレクトリに対する処理が完了します。

これらのサンプルコードを使って、基本的なディレクトリ操作を実行することができます。

しかし、dirent関数の真価は、これらの基本操作を組み合わせて応用的な処理を実現することにあります。

●direntの応用例

dirent関数は、基本的なディレクトリ操作だけでなく、さまざまな応用的な処理も可能です。

ここでは、dirent関数を使ったいくつかの応用例を紹介します。

これらのコードを参考にして、自身のプログラムで活用してみてください。

○サンプルコード4：特定の拡張子を持つファイルを検索する

特定の拡張子を持つファイルをディレクトリから検索することも可能です。

下記のコードは、”.txt”という拡張子を持つファイルをディレクトリから検索し、その名前を表示するコードです。

#include <dirent.h>
#include <stdio.h>
#include <string.h>

int main(void) {
    DIR *dir;
    struct dirent *dp;

    dir = opendir("/path/to/directory");

    if (dir == NULL) {
        printf("ディレクトリを開くことができませんでした。\n");
        return 1;
    }

    while ((dp = readdir(dir)) != NULL) {
        char *ext = strrchr(dp->d_name, '.');
        if (ext != NULL && strcmp(ext, ".txt") == 0) {
            printf("%s\n", dp->d_name);
        }
    }

    closedir(dir);

    return 0;
}

このコードでは、readdir関数を使ってディレクトリ内の各エントリーを読み込み、strrchr関数を使ってエントリー名の最後の’.’からの文字列（つまり拡張子）を取得します。

取得した拡張子が”.txt”と一致する場合のみ、エントリーの名前を表示します。

○サンプルコード5：ディレクトリ内のファイルを一覧表示する

ディレクトリ内の全てのファイルを一覧表示する場合も、dirent関数が役立ちます。

下記のサンプルコードは、ディレクトリ内の全てのファイル名を一覧表示するコードです。

#include <dirent.h>
#include <stdio.h>

int main(void) {
    DIR *dir;
    struct dirent *dp;

    dir = opendir("/path/to/directory");

    if (dir == NULL) {
        printf("ディレクトリを開くことができませんでした。\n");
        return 1;
    }

    while ((dp = readdir(dir)) != NULL) {
        printf("%s\n", dp->d_name);
    }

    closedir(dir);

    return 0;
}

このコードでは、opendir関数を使って指定したディレクトリを開きます。

ディレクトリが開けなかった場合はエラーメッセージを表示して終了します。

ディレクトリが開けたら、whileループを使ってディレクトリ内のエントリーを一つずつ読み込みます。

各エントリーの名前は、dirent構造体のd_nameメンバを使って取得できます。

エントリーの名前はprintf関数を使って表示されます。

全てのエントリーを表示し終えたら、closedir関数を使ってディレクトリを閉じます。

このコードを実行すると、指定したディレクトリ内の全てのファイル名が一覧で表示されます。

ディレクトリ内のファイル数が多い場合や、特定のパターンに一致するファイル名を探す場合などには、このコードを基にカスタマイズして使うことができます。

○サンプルコード6：ディレクトリのサイズを計算する

ディレクトリ内の全てのファイルの合計サイズを計算するには、dirent関数以外にもstat関数を使用します。

下記のサンプルコードは、ディレクトリ内の全てのファイルの合計サイズを計算し表示するコードです。

#include <dirent.h>
#include <stdio.h>
#include <sys/stat.h>

int main(void) {
    DIR *dir;
    struct dirent *dp;
    struct stat st;
    off_t total_size = 0;

    dir = opendir("/path/to/directory");

    if (dir == NULL) {
        printf("ディレクトリを開くことができませんでした。\n");
        return 1;
    }

    while ((dp = readdir(dir)) != NULL) {
        stat(dp->d_name, &st);
        total_size += st.st_size;
    }

    printf("Total size: %ld bytes\n", total_size);

    closedir(dir);

    return 0;
}

このコードでは、opendir関数を使ってディレクトリを開き、readdir関数を使ってエントリーを一つずつ読み込みます。

そして、stat関数を使ってエントリーの情報を取得し、そのサイズをtotal_sizeに加算します。

全てのエントリーのサイズを加算し終えたら、total_sizeを表示します。

最後に、closedir関数を使ってディレクトリを閉じます。

このコードを実行すると、指定したディレクトリ内の全てのファイルの合計サイズが表示されます。

ディレクトリが占めるディスクスペースを確認するために使うことができます。

○サンプルコード7：ファイルとディレクトリを分類して表示する

それでは、次にdirentを使ってファイルとディレクトリを分類し、それぞれを表示する方法について見てみましょう。

ディレクトリ内の全てのエントリーを取得し、そのエントリーがファイルなのかディレクトリなのかを判断することができます。

このような機能は、ディレクトリ構造の可視化やファイルシステムの操作において極めて有用です。

#include<stdio.h>
#include<dirent.h>

void main()
{
    DIR *dir;
    struct dirent *entry;
    dir = opendir(".");  // カレントディレクトリを開く

    if (dir == NULL)
    {
        printf("ディレクトリを開くことができませんでした。\n");
        return;
    }

    while ((entry = readdir(dir)) != NULL)
    {
        if (entry->d_type == DT_DIR)  // ディレクトリの場合
        {
            printf("[ディレクトリ]%s\n", entry->d_name);
        }
        else if (entry->d_type == DT_REG)  // ファイルの場合
        {
            printf("[ファイル]%s\n", entry->d_name);
        }
    }

    closedir(dir);  // ディレクトリを閉じる
}

このコードではdirent構造体のd_typeフィールドを使ってエントリーのタイプをチェックしています。

d_typeフィールドはエントリーがディレクトリなのかファイルなのかを示す情報を保持しています。

DT_DIRはディレクトリを、DT_REGは通常のファイルを表します。

エントリーがディレクトリの場合はその名前の前に”[ディレクトリ]”と表示し、ファイルの場合は”[ファイル]”と表示します。

このコードを実行すると、カレントディレクトリ内のすべてのエントリーが分類され、それぞれの名前とともにエントリーのタイプが表示されます。

例えば、もしカレントディレクトリに”test.txt”というファイルと”sample”というディレクトリが存在する場合、次のような出力が得られます。

[ファイル]test.txt
[ディレクトリ]sample

次に、このコードをより高度な形にカスタマイズする方法を見てみましょう。

たとえば、ディレクトリの場合はその中に含まれるエントリーも表示する再帰的な関数を作ることができます。

このような関数は、ディレクトリの構造を再帰的に調査する際に有用です。

#include<stdio.h>
#include<dirent.h>
#include<string.h>

void list_directory(const char *name)
{
    DIR *dir;
    struct dirent *entry;
    dir = opendir(name);

    if (dir == NULL)
    {
        printf("ディレクトリを開くことができませんでした：%s\n", name);
        return;
    }

    while ((entry = readdir(dir)) != NULL)
    {
        char path[1024];
        snprintf(path, sizeof(path), "%s/%s", name, entry->d_name);
        printf("%s\n", path);

        if (entry->d_type == DT_DIR)
        {
            // "."と".."ディレクトリは無視する
            if (strcmp(entry->d_name, ".") == 0 || strcmp(entry->d_name, "..") == 0)
                continue;
            // サブディレクトリも表示
            list_directory(path);
        }
    }

    closedir(dir);
}

void main()
{
    list_directory(".");  // カレントディレクトリから開始
}

このコードは先ほどのコードを拡張し、サブディレクトリに対しても再帰的にエントリーのリストを取得するようになっています。

関数list_directoryはディレクトリの名前を引数にとり、そのディレクトリ内の全てのエントリーをリストし、それがディレクトリであればその中も再帰的にリストします。

注意すべき点は、”.”（カレントディレクトリ）と”..”（親ディレクトリ）という特殊なディレクトリを無視していることです。

これらのディレクトリを再帰的にリストすると無限ループになる可能性があるため、これらを無視しています。

このコードを実行すると、カレントディレクトリから再帰的にすべてのエントリーをリストします。

それぞれのエントリーはその完全なパスとともに表示されます。

たとえば、カレントディレクトリが”project”で、その中に”src”というディレクトリとその中に”main.c”というファイルがある場合、次のような出力が得られます。

./project
./project/src
./project/src/main.c

○サンプルコード8：ディレクトリの深さを計算する

ディレクトリの深さとは、そのディレクトリが階層構造のどのレベルに位置しているかを表すものです。

例えば、ホームディレクトリはレベル1、その下のサブディレクトリはレベル2という具体的な数値でディレクトリの深さを表現します。

C言語のdirent関数を使うと、このディレクトリの深さを計算することができます。

では、具体的な実装を見ていきましょう。

#include <stdio.h>
#include <dirent.h>
#include <string.h>

// ディレクトリの深さを計算する関数
int depth_of_directory(const char *dir_name, int depth) {
    DIR *dir; 
    struct dirent *entry;
    int max_depth = depth;

    if ((dir = opendir(dir_name)) == NULL) { // ディレクトリを開く
        return -1;
    }
    while ((entry = readdir(dir)) != NULL) { // ディレクトリ内の要素を読む
        if (entry->d_type == DT_DIR) { // 要素がディレクトリであるか判定
            char path[1024];
            if (strcmp(entry->d_name, ".") == 0 || strcmp(entry->d_name, "..") == 0) // 現在のディレクトリと親ディレクトリは無視
                continue;
            snprintf(path, sizeof(path), "%s/%s", dir_name, entry->d_name); // 新しいパスを作成
            int new_depth = depth_of_directory(path, depth + 1); // 再帰的に深さを計算
            if (new_depth > max_depth)
                max_depth = new_depth; // 最大深さを更新
        }
    }
    closedir(dir); // ディレクトリを閉じる
    return max_depth;
}

int main(void) {
    const char *dir_name = "./"; // 現在のディレクトリを指定
    int depth = depth_of_directory(dir_name, 1); // ディレクトリの深さを計算
    printf("Directory depth: %d\n", depth); // 結果を出力
    return 0;
}

このサンプルコードは、指定したディレクトリの深さを計算します。

再帰的に各サブディレクトリの深さを調べ、最も深い部分の深さを求めることができます。

direntのd_typeフィールドを用いて、各エントリがディレクトリであるかを判定しています。

これを実行すると、選択したディレクトリの最も深いレベルが表示されます。

「Directory depth: 3」

この結果から、現在のディレクトリの最大の深さが3であることが分かります。

このようにして、ディレクトリの深さを計算し、その結果を使ってさまざまな処理を行うことが可能になります。

○サンプルコード9：隠しファイルを検索する

ここでは、dirent関数を使用して隠しファイルを検索する方法を説明します。

隠しファイルとは、その名の通り通常の方法では表示されない、特別なファイルです。

これらは主に設定情報を保存するために使用され、Unix系のシステムでは名前の先頭にピリオド(‘.’)がついています。

下記のコードは、指定したディレクトリ内の隠しファイルを全て検索し、その名前を出力する例です。

#include <stdio.h>
#include <dirent.h>

int main() {
    struct dirent *de;  // ディレクトリエントリへのポインタ

    DIR *dr = opendir("."); // カレントディレクトリを開く

    if (dr == NULL)  // opendirが失敗した場合のエラーハンドリング
    {
        printf("ディレクトリを開けませんでした");
        return 0;
    }

    while ((de = readdir(dr)) != NULL)  // ディレクトリ内のすべてのファイルとディレクトリを読む
    {
        if (de->d_name[0] == '.')  // ファイル名の最初の文字がピリオド（'.'）なら出力
            printf("%s\n", de->d_name);
    }

    closedir(dr); // ディレクトリストリームを閉じる
    return 0;
}

このコードでは、dirent構造体を用いてディレクトリエントリの情報を取得します。

そして、ディレクトリ内の各エントリについて、名前がピリオドで始まるかどうかを確認します。

もしピリオドで始まるならば、それは隠しファイルであるため、その名前を出力します。

このコードを実行すると、カレントディレクトリ内のすべての隠しファイルがリストされます。

たとえば、’.bashrc’や’.config’などのファイル名が表示されるはずです。

これにより、隠しファイルの存在とその名前を確認できます。

○サンプルコード10：特定のディレクトリを除外して検索する

次に、特定のディレクトリを除外して検索する方法を見てみましょう。

たとえば、ある特定のディレクトリだけは検索対象から外したい、という場合には次のようなコードを使うことができます。

ここでは、dirent関数を使ってディレクトリを読み、その中で特定のディレクトリを除外します。

#include <stdio.h>
#include <dirent.h>
#include <string.h>

int main() {
    struct dirent *de;  // ディレクトリエントリへのポインタ

    DIR *dr = opendir("."); // カレントディレクトリを開く

    if (dr == NULL)  // opendirが失敗した場合のエラーハンドリング
    {
        printf("ディレクトリを開けませんでした");
        return 0;
    }

    while ((de = readdir(dr)) != NULL)  // ディレクトリ内のすべてのファイルとディレクトリを読む
    {
        if (strcmp(de->d_name, "排除するディレクトリ名") != 0)  // 特定のディレクトリ名を持つエントリを排除
            printf("%s\n", de->d_name);
    }

    closedir(dr); // ディレクトリストリームを閉じる
    return 0;
}

このコードでは、’readdir’関数を使用してディレクトリ内のすべてのエントリを読み込みます。

そして、’strcmp’関数を用いてエントリの名前が特定のディレクトリ名と一致するかどうかを確認します。

一致しない場合（つまり、そのエントリが除外したいディレクトリでない場合）、そのエントリの名前を出力します。

このコードを実行すると、指定したディレクトリ名を除いたすべてのファイルとディレクトリがリストされます。

これにより、特定のディレクトリだけを検索対象から除外したい場合の対応方法を理解できます。

●direntを使う上での注意点と対処法

C言語のdirent関数を使用する際、注意するべきいくつかの重要な事項があります。

dirent関数を用いたディレクトリ操作は非常に便利ですが、誤った使用方法はエラーや不具合を引き起こす可能性があります。

ここでは、それらの注意点とその対処法について見ていきましょう。

まず、最も重要な注意点の一つは、ディレクトリを開いた後、必ず閉じることです。

これを怠ると、リソースのリークを引き起こす可能性があります。

これはプログラムが終了するまで開かれたディレクトリが解放されず、無駄にシステムリソースを消費する結果となります。

次のコードは、ディレクトリを開き、閉じずにプログラムを終了する例を示しています。

#include <dirent.h>

int main() {
    // ディレクトリを開く
    DIR* dir = opendir("/path/to/directory");

    // ディレクトリを閉じる処理がない

    return 0;
}

このコードでは、direntのopendir関数を使用してディレクトリを開いていますが、closedir関数を用いてディレクトリを閉じていません。

このため、プログラムが終了するまでディレクトリは開かれたままとなります。

これを防ぐためには、次のように閉じる処理を必ず記述することが必要です。

#include <dirent.h>

int main() {
    // ディレクトリを開く
    DIR* dir = opendir("/path/to/directory");

    // ディレクトリを閉じる
    closedir(dir);

    return 0;
}

こちらのコードでは、開いたディレクトリをclosedir関数で閉じています。

これにより、システムリソースのリークを防ぐことができます。

次に注意すべき点は、dirent関数がエラーを返す場合の処理です。

ディレクトリの読み込み中にエラーが発生した場合、dirent関数はNULLを返します。

この時点で適切なエラーハンドリングを行わないと、エラーの原因を特定するのが困難になるだけでなく、プログラムが予期しない動作をする可能性もあります。

エラーハンドリングは次のように行うことができます。

#include <dirent.h>
#include <stdio.h>
#include <errno.h>

int main() {
    // ディレクトリを開く
    DIR* dir = opendir("/path/to/directory");

    if (dir == NULL) {
        printf("エラー: %s\n", strerror(errno));
        return 1;
    }

    // ディレクトリを閉じる
    closedir(dir);

    return 0;
}

このコードでは、opendir関数がNULLを返した場合にエラーメッセージを表示する処理を追加しています。

strerror関数とerrno変数を使用してシステムが返すエラーメッセージを取得し、それを表示しています。

このようにエラーハンドリングを行うことで、エラーの原因を特定しやすくなります。

これらの注意点と対処法を理解し、dirent関数を使ったディレクトリ操作を行うと、より安全で効率的なコードを書くことが可能になります。

●direntのカスタマイズ方法

ディレクトリ操作を行うためにはdirentの基本的な機能だけでなく、独自のカスタマイズ方法も理解することが重要です。

ここでは、direntをカスタマイズするための方法をいくつか紹介します。

まず一つ目のカスタマイズ方法として、特定の条件を満たすファイルだけを取得する方法があります。

たとえば、ある特定の日付よりも新しいファイルだけをリストアップしたいといったケースです。

このような場合、dirent関数を使って一般的なディレクトリの走査を行い、その後でstat関数を用いてファイルの詳細情報を取得し、特定の条件を満たすかどうかを判断します。

それでは実際に、最終更新日が指定した日付よりも新しいファイルだけをリストアップするサンプルコードを見てみましょう。

#include <stdio.h>
#include <dirent.h>
#include <sys/stat.h>
#include <time.h>

int main() {
    DIR *dir;
    struct dirent *dp;
    struct stat file_info;
    time_t specified_time;

    //指定した時間を設定します。ここでは2023年1月1日を指定しています。
    struct tm t = {0};
    t.tm_year = 2023 - 1900;
    t.tm_mon = 1 - 1;
    t.tm_mday = 1;
    specified_time = mktime(&t);

    dir = opendir(".");
    if (dir == NULL) {
        perror("opendir");
        return 1;
    }

    while ((dp = readdir(dir)) != NULL) {
        stat(dp->d_name, &file_info);
        if (file_info.st_mtime > specified_time) {
            printf("%s\n", dp->d_name);
        }
    }

    closedir(dir);
    return 0;
}

このコードでは2023年1月1日以降に最後に更新されたファイルのみを表示しています。

direntを使ってディレクトリ内の全てのファイルを取得し、その後で各ファイルの最終更新日時をstat関数で取得しています。

その最終更新日時が指定した日付よりも新しいかどうかを確認し、新しい場合に限りファイル名を表示しています。

このコードを実行すると、ディレクトリ内に存在するファイルのうち、2023年1月1日以降に最終更新されたファイルの名前が表示されます。

もう一つのカスタマイズ方法としては、特定のパターンに一致するファイル名を検索する方法があります。

このような場合、dirent関数を用いてディレクトリを走査し、その後で文字列のマッチングを行います。

ここでは正規表現を使用してパターンマッチングを行う方法を紹介します。

それでは、”file”という文字列を含むファイル名のみを検索するサンプルコードを見てみましょう。

#include <stdio.h>
#include <dirent.h>
#include <string.h>

int main() {
    DIR *dir;
    struct dirent *dp;

    dir = opendir(".");
    if (dir == NULL) {
        perror("opendir");
        return 1;
    }

    while ((dp = readdir(dir)) != NULL) {
        if (strstr(dp->d_name, "file") != NULL) {
            printf("%s\n", dp->d_name);
        }
    }

    closedir(dir);
    return 0;
}

このコードではdirentを使ってディレクトリ内の全てのファイルを取得し、その後で各ファイル名が”file”という文字列を含むかどうかを確認しています。

“file”を含む場合に限り、ファイル名を表示しています。

このコードを実行すると、ディレクトリ内に存在するファイルのうち、ファイル名が”file”を含むファイルの名前が表示されます。

このようにdirentを使ってディレクトリ操作を行う際には、様々なカスタマイズ方法があります。

用途に応じて適切なカスタマイズを行うことで、より効率的なプログラムを作成することができます。

まとめ

我々は本日、C言語のdirent関数の重要な側面、使い方、およびカスタマイズ方法を紹介しました。

特にディレクトリ操作については、その基本的な機能から実用的な応用例までを網羅しました。

それぞれのサンプルコードでは、direntの特定の機能や可能性を体系的に理解するための状況を提供しました。

それぞれの機能がどのように動作し、いつ使用するのが最適かについての深い理解が得られることを願っています。

また、direntのカスタマイズ方法についても解説しました。

これにより、C言語のディレクトリ操作をさらに一歩進め、具体的なニーズに合わせてdirentを適応させる方法を紹介しました。

そして最後に、direntを使用する際の注意点と対処法を見てきました。

これらはあくまで基本的なガイドラインであり、それぞれのプロジェクトや目的に合わせて適応させる必要があります。

今日学んだdirentの知識と応用例を元に、C言語を使ってディレクトリ操作をより上手に、より効率的に行えることを期待しています。

プログラミングはあくまでツールであり、そのツールをどのように使用するかは、それを持っている人次第です。

したがって、direntを使うことで、どのような問題も自信を持って解決できるようになることを心から願っています。

その一方で、この記事があなたのC言語とdirentに関する理解を深める一助となれば幸いです。