C言語+MySQL入門|画面に必要なデータをまとめる

C言語+MySQL入門|画面に必要なデータをまとめる

前の記事では、ボタンを押すとコールバック関数が呼ばれ、入力した商品名と単価を画面へ表示する仕組みを確認しました。

今回は、画面で使用するデータを構造体へまとめます。

入力欄やボタン、メッセージ欄が増えてくると、それぞれをコールバックへ渡す方法や、選択中の商品を管理する場所を整理したくなります。

そこで、画面に必要な情報を一つの構造体にまとめ、複数のコールバックから参照できる形にしていきましょう。

この記事では、次の内容を学びます。

  • ウィジェットへのポインターを構造体へまとめる。
  • 選択中の商品IDを画面の状態として保持する。
  • 構造体へのポインターをコールバックへ渡す。
  • 複数のコールバックで同じ画面データを共有する。
  • 構造体と画面部品の有効期間を確認する。

この記事の到達点は、画面部品と選択状態を一つの構造体で管理し、コールバックから利用できることです。

今回は、入力内容の表示に加えて、入力欄をクリアするボタンを用意します。商品を一覧から選択する機能やDB処理は、後の記事で組み合わせます。

画面で管理する情報を整理しよう

GUIアプリでは、画面部品そのものに加えて、操作中の状態も管理します。

今回の在庫管理アプリなら、次のような情報です。

種類管理する情報用途
ウィンドウ基本ウィンドウへのポインターアプリの画面を扱う
入力欄商品名・単価の入力欄へのポインター入力内容の取得やクリア
ボタン表示・クリアのボタンへのポインター操作部品の管理
メッセージ欄結果表示用ラベルへのポインター操作結果を表示する
選択状態選択中の商品ID変更・削除・入出庫の対象を保持する

ウィジェットのポインターと商品IDは、役割が異なります。

入力欄へのポインターは、文字列を取得する場所を示します。一方、選択中の商品IDは、どの商品を操作対象にしているかを表す値です。

この二つを区別しながら、画面で必要になる情報としてまとめます。

画面データをAppUiという構造体へまとめよう

今回は、画面用の構造体をAppUiという名前にします。

typedef struct {
    GtkWindow *window;
    GtkEntry *name_entry;
    GtkEntry *price_entry;
    GtkButton *show_button;
    GtkButton *clear_button;
    GtkLabel *message;
    int selected_product_id;
} AppUi;

それぞれのメンバーの役割は、次のとおりです。

メンバー内容
window基本ウィンドウ
name_entry商品名の入力欄
price_entry単価の入力欄
show_button入力内容を表示するボタン
clear_button入力欄をクリアするボタン
message操作案内や結果を表示するラベル
selected_product_id選択中の商品ID

GtkEntry *やGtkLabel *など、用途に合ったポインター型で保持しています。

なお、構造体の中へウィジェット本体をコピーしているわけではありません。作成したウィジェットを参照するためのポインターを保存しています。

選択していない状態は商品IDの0で表す

今回のアプリでは、実際の商品IDは1以上です。

そのため、画面側ではselected_product_idが0のとき、商品を選択していない状態として扱います。

selected_product_id画面側での意味
0商品を選択していない
1以上そのIDの商品を選択している

これは、画面内部で使用する管理上のルールです。DBへ商品IDの0を渡して検索や更新をするためのものではありません。

今回は商品一覧から選択する機能をまだ作成していないため、未選択の状態で使用します。

図1:画面部品と選択状態をAppUiへまとめる

この図から分かること

画面で使用する部品への参照と、選択中の商品IDをAppUiへまとめています。

コールバックは、AppUiへのポインターを受け取ることで、必要な入力欄やメッセージ欄へアクセスできます。

画面部品と操作中の状態を、同じまとまりとして管理できます。

AppUiを用意する場所を決めよう

構造体を定義したら、実際のデータをどこへ用意するかも決めます。

今回は基本ウィンドウを一つ扱うため、mainの中にAppUiを一つ用意します。

AppUi ui = {0};

この初期化によって、ポインターメンバーはNULL、selected_product_idは0になります。

そのアドレスを、activateのコールバックへ渡します。

g_signal_connect(
    app,
    "activate",
    G_CALLBACK(on_activate),
    &ui
);

mainは、g_application_runの実行中も終了していません。

そのため、今回の構成では、アプリの操作中もmain内のuiを使用できます。g_application_runは、アプリの実行とイベント処理を進める関数です。

画面を作成するon_activateと、ボタンのコールバックへ、同じAppUiのアドレスを渡していきます。

構造体を共有するプログラムを作ろう

前の記事の入力画面を、AppUiを使う形へ整理します。

今回は、次の二つのボタンを用意します。

ボタン行うこと
入力内容を表示現在の商品名・単価・選択状態を表示する
入力欄をクリア商品名と単価を空にし、選択状態を初期化する

クリアは、画面の入力と選択状態を初期化する操作です。DBへ保存された商品を削除する処理は含めません。

同じ画面データを使って入力内容の表示とクリアを行うプログラム

ファイル名: inventory_ui_state.c

#include <gtk/gtk.h>

/* 画面で使用する部品と選択状態をまとめる */
typedef struct {
    GtkWindow *window;
    GtkEntry *name_entry;
    GtkEntry *price_entry;
    GtkButton *show_button;
    GtkButton *clear_button;
    GtkLabel *message;
    int selected_product_id;
} AppUi;

/* 現在の入力内容と選択状態を表示する */
static void on_show_input_clicked(
    GtkButton *button,
    gpointer user_data
)
{
    /* 今回は操作されたボタン自体を参照しない */
    (void)button;

    /* mainで用意した画面データを受け取る */
    AppUi *ui = user_data;

    /* 入力欄から現在の文字列を取得する */
    const char *name = gtk_editable_get_text(
        GTK_EDITABLE(ui->name_entry)
    );

    const char *price = gtk_editable_get_text(
        GTK_EDITABLE(ui->price_entry)
    );

    /* 選択していない場合は、画面に未選択と表示する */
    char selection_text[32] = "未選択";

    if (ui->selected_product_id > 0) {
        g_snprintf(
            selection_text,
            sizeof selection_text,
            "%d",
            ui->selected_product_id
        );
    }

    /* 画面へ表示する文字列を作成する */
    char *text = g_strdup_printf(
        "入力内容を表示しました。\n"
        "商品名:%s\n"
        "単価:%s\n"
        "選択中の商品ID:%s\n"
        "MySQLへは保存していません。",
        name,
        price,
        selection_text
    );

    gtk_label_set_text(ui->message, text);

    /* 自分で確保した表示用文字列を解放する */
    g_free(text);

    g_print("入力内容と選択状態を表示しました。\n");
}

/* 入力欄と選択状態を初期化する */
static void on_clear_clicked(
    GtkButton *button,
    gpointer user_data
)
{
    (void)button;

    /* 表示ボタンと同じ画面データを受け取る */
    AppUi *ui = user_data;

    /* 二つの入力欄を空にする */
    gtk_editable_set_text(GTK_EDITABLE(ui->name_entry), "");
    gtk_editable_set_text(GTK_EDITABLE(ui->price_entry), "");

    /* 商品を選択していない状態に戻す */
    ui->selected_product_id = 0;

    gtk_label_set_text(
        ui->message,
        "入力欄をクリアしました。\n"
        "商品は選択されていません。"
    );

    g_print("入力欄と選択状態を初期化しました。\n");
}

/* アプリが有効になったときに画面を作成する */
static void on_activate(GtkApplication *app, gpointer user_data)
{
    /* mainから渡された画面データを受け取る */
    AppUi *ui = user_data;

    /* 既存のウィンドウがあれば再利用する */
    GtkWindow *window = gtk_application_get_active_window(app);

    if (window != NULL) {
        gtk_window_present(window);
        return;
    }

    /* 基本ウィンドウを作成して構造体へ保存する */
    ui->window = GTK_WINDOW(gtk_application_window_new(app));

    gtk_window_set_title(ui->window, "在庫管理アプリ");
    gtk_window_set_default_size(ui->window, 900, 600);
    gtk_window_set_resizable(ui->window, TRUE);

    /* 新しく作成する画面は未選択の状態にする */
    ui->selected_product_id = 0;

    /* 画面全体を縦方向へ並べる */
    GtkWidget *root = gtk_box_new(GTK_ORIENTATION_VERTICAL, 16);

    gtk_widget_set_margin_top(root, 20);
    gtk_widget_set_margin_bottom(root, 20);
    gtk_widget_set_margin_start(root, 20);
    gtk_widget_set_margin_end(root, 20);

    gtk_window_set_child(ui->window, root);

    GtkWidget *heading = gtk_label_new("商品情報の入力");
    gtk_label_set_xalign(GTK_LABEL(heading), 0.0f);

    /* 商品名と単価を並べる入力部分 */
    GtkWidget *grid = gtk_grid_new();
    gtk_grid_set_row_spacing(GTK_GRID(grid), 12);
    gtk_grid_set_column_spacing(GTK_GRID(grid), 16);

    GtkWidget *name_label = gtk_label_new("商品名");
    gtk_label_set_xalign(GTK_LABEL(name_label), 0.0f);

    ui->name_entry = GTK_ENTRY(gtk_entry_new());
    gtk_entry_set_placeholder_text(ui->name_entry, "例:ノート");
    gtk_widget_set_hexpand(GTK_WIDGET(ui->name_entry), TRUE);

    GtkWidget *price_label = gtk_label_new("単価");
    gtk_label_set_xalign(GTK_LABEL(price_label), 0.0f);

    ui->price_entry = GTK_ENTRY(gtk_entry_new());
    gtk_entry_set_placeholder_text(ui->price_entry, "例:180.50");
    gtk_widget_set_hexpand(GTK_WIDGET(ui->price_entry), TRUE);

    gtk_grid_attach(GTK_GRID(grid), name_label, 0, 0, 1, 1);
    gtk_grid_attach(
        GTK_GRID(grid),
        GTK_WIDGET(ui->name_entry),
        1, 0, 1, 1
    );

    gtk_grid_attach(GTK_GRID(grid), price_label, 0, 1, 1, 1);
    gtk_grid_attach(
        GTK_GRID(grid),
        GTK_WIDGET(ui->price_entry),
        1, 1, 1, 1
    );

    /* 二つのボタンを横方向へ並べる */
    GtkWidget *actions = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 12);
    gtk_widget_set_halign(actions, GTK_ALIGN_START);

    ui->show_button = GTK_BUTTON(
        gtk_button_new_with_label("入力内容を表示")
    );

    ui->clear_button = GTK_BUTTON(
        gtk_button_new_with_label("入力欄をクリア")
    );

    gtk_box_append(GTK_BOX(actions), GTK_WIDGET(ui->show_button));
    gtk_box_append(GTK_BOX(actions), GTK_WIDGET(ui->clear_button));

    /* 操作案内と結果を表示する */
    ui->message = GTK_LABEL(
        gtk_label_new(
            "商品名と単価を入力して、ボタンを押してください。"
        )
    );
    gtk_label_set_xalign(ui->message, 0.0f);
    gtk_label_set_wrap(ui->message, TRUE);

    /* 二つのコールバックへ同じAppUiを渡す */
    g_signal_connect(
        ui->show_button,
        "clicked",
        G_CALLBACK(on_show_input_clicked),
        ui
    );

    g_signal_connect(
        ui->clear_button,
        "clicked",
        G_CALLBACK(on_clear_clicked),
        ui
    );

    /* 画面全体へ配置する */
    gtk_box_append(GTK_BOX(root), heading);
    gtk_box_append(GTK_BOX(root), grid);
    gtk_box_append(GTK_BOX(root), actions);
    gtk_box_append(GTK_BOX(root), GTK_WIDGET(ui->message));

    g_print("画面データをまとめた入力画面を表示します。\n");

    gtk_window_present(ui->window);
}

int main(int argc, char *argv[])
{
    /* アプリの実行中に使う画面データ */
    AppUi ui = {0};

    GtkApplication *app = gtk_application_new(
        "org.example.InventoryGui",
        G_APPLICATION_DEFAULT_FLAGS
    );

    /* 画面データのアドレスを起動時のコールバックへ渡す */
    g_signal_connect(
        app,
        "activate",
        G_CALLBACK(on_activate),
        &ui
    );

    /* この実行中もmain内のuiは有効 */
    int status = g_application_run(
        G_APPLICATION(app),
        argc,
        argv
    );

    /* GTKのアプリに対する参照を解放する */
    g_object_unref(app);

    /* 閉じられた画面のウィジェットは、ここでは参照しない */
    g_print(
        "アプリの実行が終了しました。終了状態:%d\n",
        status
    );

    return status;
}

今回は、前の記事で使用したname-entryやprice-entryという名前による関連付けを、AppUiのメンバーによる参照へ整理しています。

また、画面を組み立てるためだけに使うrootやgridは、on_activate内のローカル変数のままです。すべての部品を構造体へ保存する必要はありません。

UCRT64でビルドして実行しよう

以前の記事の確認用アプリが起動していれば、閉じてから作業してください。

MSYS2 UCRT64で、chap13へ移動します。

cd /c/c-mysql/chap13

inventory_ui_state.cをUTF-8で保存し、ビルドします。

簡潔なコマンドは、次のとおりです。

gcc inventory_ui_state.c -o inventory_ui_state.exe \
  $(pkg-config --cflags --libs gtk4)

警告も確認する場合は、次のように指定します。

gcc -std=c17 -Wall -Wextra -Wpedantic \
  inventory_ui_state.c -o inventory_ui_state.exe \
  $(pkg-config --cflags --libs gtk4)

ビルドに成功したら、実行します。

./inventory_ui_state.exe

今回はinventory_ui_state.cだけをビルド対象にします。MySQLへの接続処理は、まだ含めていません。

実行結果の例

起動すると、ターミナルへ次のように表示されます。

画面データをまとめた入力画面を表示します。

ウィンドウには、次の部品が表示されます。

部品内容
商品名の入力欄商品名を入力する
単価の入力欄単価を入力する
入力内容を表示ボタン現在の入力内容を表示する
入力欄をクリアボタン入力内容と選択状態を初期化する
メッセージ欄操作案内や結果を表示する

商品名へノート、単価へ180.50と入力し、入力内容を表示ボタンを押すと、次のように表示されます。

入力内容を表示しました。
商品名:ノート
単価:180.50
選択中の商品ID:未選択
MySQLへは保存していません。

ターミナルには、次のように表示されます。

入力内容と選択状態を表示しました。

続けて入力欄をクリアボタンを押すと、二つの入力欄が空になり、メッセージが変わります。

入力欄をクリアしました。
商品は選択されていません。

ターミナルには、次のように表示されます。

入力欄と選択状態を初期化しました。

もう一度入力内容を表示ボタンを押すと、商品名と単価が空の状態で表示されます。

同じAppUiを複数の関数へ渡している

今回のデータの受け渡しを、順番に確認しましょう。

mainでは、AppUiの実体を用意しています。

AppUi ui = {0};

そのアドレスを、on_activateへ渡します。

g_signal_connect(
    app,
    "activate",
    G_CALLBACK(on_activate),
    &ui
);

on_activateは、追加データをAppUiへのポインターとして受け取ります。

AppUi *ui = user_data;

さらに、ボタンのコールバックへ、そのポインターを渡しています。

g_signal_connect(
    ui->show_button,
    "clicked",
    G_CALLBACK(on_show_input_clicked),
    ui
);

g_signal_connectの追加データは、コールバックへ渡すためのポインターです。構造体の中身を自動的に複製するものではありません。

場所uiの意味渡す値
mainAppUiの実体&ui
on_activateAppUiを指すポインターui
ボタンのコールバック同じAppUiを指すポインターメンバーを参照・更新する

mainではuiが構造体そのものなので、アドレスを得るために&uiを使います。

一方、on_activateのuiは、すでにポインターです。ボタンへ渡すときはuiをそのまま指定します。

図2:一つのAppUiを複数のコールバックで共有する

この図から分かること

画面作成、入力内容の表示、入力欄のクリアは、同じAppUiを参照しています。

表示用のコールバックは必要な値を読み、クリア用のコールバックは入力欄や選択状態を更新します。

コールバックごとに別の画面データを作っているわけではありません。

ポインターを通してメンバーを参照しよう

AppUiへのポインターからメンバーを使うときは、アロー演算子を使用します。

const char *name = gtk_editable_get_text(
    GTK_EDITABLE(ui->name_entry)
);

ui->name_entryで、AppUiに保存した商品名の入力欄を取り出しています。

メッセージの更新も、同じように記述できます。

gtk_label_set_text(
    ui->message,
    "入力欄をクリアしました。\n"
    "商品は選択されていません。"
);

選択状態を変更する場合は、メンバーへ値を代入します。

ui->selected_product_id = 0;

この代入は、mainで用意したAppUiのメンバーを変更しています。

そのため、その後に別のコールバックが同じAppUiを参照すると、更新後の値を確認できます。

mainに置いた構造体が有効な理由を確認しよう

前の記事では、コールバックへ渡すデータの有効期間に注意することを説明しました。

今回のAppUiもローカル変数ですが、置いている場所はmainです。

AppUi ui = {0};

mainは、次の関数が実行されている間も終了していません。

int status = g_application_run(
    G_APPLICATION(app),
    argc,
    argv
);

この実行中に、on_activateやボタンのコールバックが呼ばれます。

タイミングmain内のui
アプリを作成する有効
on_activateが呼ばれる有効
on_activateから戻る引き続き有効
ボタンのコールバックが呼ばれる有効
g_application_runから戻る引き続き有効
mainを終了する有効期間が終わる

ローカル変数だから渡せないのではなく、参照する期間を通して、その変数が有効かどうかを確認します。

今回は、画面操作をg_application_runの実行中に行い、mainが終了する前にGtkApplicationの参照も解放しています。

on_activate内に実体を置く場合とは異なる

もしAppUiの実体をon_activate内の一時的なローカル変数として用意し、そのアドレスを後のボタン操作へ渡すと、on_activateから戻った時点で有効期間が終わってしまいます。

今回の構成では、実体をmainへ置くことで、画面操作中の有効期間を確保しています。

on_activateやボタンのコールバック内にあるuiは、main内の実体を参照するためのポインター変数です。

構造体とウィジェットの管理担当を分けよう

構造体へポインターをまとめても、ウィジェットの管理方法が変わるわけではありません。

対象今回の管理方法
AppUiの実体main内の自動変数として用意する
ウィンドウや配置した部品GTKのオブジェクト管理に従って扱う
AppUi内のウィジェットポインター画面部品を参照するために保持する
入力欄から取得した文字列GTKが管理する内容を借りて読む
g_strdup_printfで作った文字列使用後にg_freeで解放する

今回のAppUiは、mallocなどで動的に確保したものではありません。そのため、AppUiに対してfreeやg_freeを呼び出す必要はありません。

また、構造体へ保存した各ウィジェットへ、まとめてfreeを呼び出す処理も追加しません。

構造体が有効でも、閉じた画面は参照しない

main内のAppUiがまだ有効でも、その中に保存されたポインターが指す画面部品まで、常に有効とは限りません。

ウィンドウを閉じて部品が破棄された後は、それらのポインターを使って入力内容を取得したり、ラベルを更新したりしません。

今回のmainでは、g_application_runから戻った後に画面部品を参照していません。

構造体の有効期間と、参照先の部品の有効期間は、引き続き分けて考えましょう。

図3:画面データを使う期間と終了時の扱い

この図から分かること

main内のAppUiは、今回の画面操作が行われる期間を通して有効です。

一方、ウィンドウを閉じた後は、構造体が残っていても、その画面の部品を参照しません。

AppUiそのものと、保存したポインターの参照先を分けて管理することが大切です。

画面用の型とDB処理用の型を分けておこう

今回作成したAppUiは、GUI側で使用する型です。

第12章までに用意したProductInputやProductとは、役割が異なります。

型主な内容使用する場所
AppUi画面部品への参照、選択中の商品IDGUI側
ProductInput登録・変更する商品名と単価GUI側とDB関数の受け渡し
ProductDBから取得した商品情報DB関数の戻りデータや表示処理

入力欄へのポインターを、そのまま商品名としてDB関数へ渡すことはできません。

商品登録では、AppUiから入力欄を参照し、文字列を取得して検証した後、ProductInputへ保存してDB関数を呼び出す流れになります。

また、selected_product_idへ値が入っていても、その商品が現在もDBに存在することまでは保証されません。実際の検索や更新の結果は、DB関数から返される結果で判断します。

二つのボタンで状態の共有を確認しよう

今回の画面では、次の順序で確認できます。

  1. 商品名へノート、単価へ180.50と入力する。
  2. 入力内容を表示ボタンを押す。
  3. 入力した内容と未選択の表示を確認する。
  4. 入力欄をクリアボタンを押す。
  5. 二つの入力欄が空になったことを確認する。
  6. もう一度、入力内容を表示ボタンを押す。

表示用とクリア用のコールバックが、同じ入力欄とメッセージ欄を使用していることを確認してください。

今回は商品選択の機能をまだ実装していないため、選択中の商品IDは未選択のままです。今後、商品一覧から選択したIDをselected_product_idへ保存し、変更や入出庫の対象として利用します。

次の記事では、この画面データを使うGUI側の処理と、第12章で完成したDB処理の役割を整理し、共通のDB関数をGUIから呼び出す構成へ進みましょう。

Follow me!