C言語+MySQL入門|配布用にビルドする

C言語+MySQL入門|配布用にビルドする

前の記事では、GUIアプリを配布するときに必要なファイルと、利用先で準備する接続環境を整理しました。

今回は、第15章で完成したソースコードを引き継ぎ、配布に使用する実行ファイルを作成します。

開発中に作った実行ファイルをそのまま渡す前に、使用するソース、コンパイル設定、警告の有無を確認しておきましょう。また、古いオブジェクトファイルが混ざらないように、配布用の設定ですべてのソースをコンパイルし直します。

この記事では、次の内容を扱います。

  • 第15章の完成版をchap16へ引き継ぐ。
  • MSYS2 UCRT64のビルド環境を確認する。
  • 最適化と警告の設定を決める。
  • GUI版に必要なソースだけをコンパイルする。
  • GTK 4とConnector/Cをリンクする。
  • ビルドした実行ファイルの設定確認と起動確認を行う。

今回の到達点は、配布用の設定でinventory_register.exeを作成し、開発用PCで基本動作を確認できることです。

配布用のビルドで確認することを整理しよう

ビルドとは、ソースコードから実行ファイルを作る一連の処理です。

今回も、各Cソースをオブジェクトファイルへ変換し、それらをライブラリとリンクして、一つの実行ファイルを作成します。

配布用にビルドするときは、次の点を確認します。

確認項目今回の方針
使用するソース第15章の完成版を引き継ぐ
ビルド環境MSYS2 UCRT64へそろえる
C言語の規格C17を使用する
最適化-O2を指定する
警告-Wall、-Wextra、-Wpedanticを指定する
警告が出た場合-Werrorでコンパイルを停止する
オブジェクトファイル配布用の保存先へ毎回作り直す
実行ファイル名inventory_register.exeとする

配布用という特別な種類のCプログラムを作るわけではありません。

これまでのアプリを、対象ファイルと設定を明確にしたうえで、作り直して確認すると考えると分かりやすいですね。

なお、今回作成する実行ファイルにも、GTK 4やConnector/Cの実行時ファイルが必要です。ビルドの成功だけで、別のPCへの配布が完了するわけではありません。

図1:完成版ソースから配布用の実行ファイルを作る

この図から分かること

各ソースをコンパイルしてオブジェクトファイルを作り、その後でリンクを行います。

GTK 4とConnector/Cのリンク設定は、外部ライブラリの関数を利用するために使います。

ソースがそろっていることに加え、コンパイルとリンクの両方が成功して、実行ファイルが完成します。

第15章の完成版をchap16へ引き継ごう

第16章の作業場所は、C:\c-mysql\chap16です。

MSYS2 UCRT64では、次のように移動します。

cd /c/c-mysql/chap16

第15章の完成版から、次のものを引き継ぎます。

コピーするもの内容
include共通のデータ型と公開関数の宣言
src接続、商品操作、入出庫、履歴、入力検証の実装
gui完成したGUIの実装
inventory.conf開発用PCで確認するための接続設定
run_gui_register.sh開発用PCでの起動スクリプト

gui/inventory_register.cは、15.11で作成し、15.12で通し確認に使用した完成版です。

src/db/db.cも、15.10で追加した接続・通信待ち時間の設定を含むものを使用します。

初回の引き継ぎを行う

以下は、chap16に同名のフォルダや設定ファイルをまだ配置していない場合の手順です。

すでに配置している場合は、編集済みの内容を確認してから引き継いでください。

cp -a ../chap15/include ../chap15/src ../chap15/gui .
cp -p ../chap15/inventory.conf ../chap15/run_gui_register.sh .

コピー先を確認します。

ls

実行結果の例

distribution_plan.c
distribution_plan.exe
gui
include
inventory.conf
run_gui_register.sh
src

distribution_plan.cとdistribution_plan.exeは、16.1で作成した補助プログラムです。今回のGUIのビルド対象には含めません。

また、chap15のinventory_register.exeやオブジェクトファイルをコピーする必要はありません。実行ファイルは、この後の手順で作成します。

ビルド対象の13個のソースを確認しよう

今回のGUI版では、次の13個のCソースを使用します。

ソースファイル担当する処理
gui/inventory_register.cGUI、入力取得、確認画面、結果表示、画面状態の管理
src/db/db.cMySQLへの接続
src/db/db_config.c接続設定の読み込み
src/product/product.c商品登録
src/product/product_list.c商品一覧の取得
src/product/product_find.c商品IDによる検索
src/product/product_update.c商品情報の変更
src/product/product_delete.c履歴確認と商品削除
src/stock/stock_receive.c入庫
src/stock/stock_ship.c出庫
src/stock/stock_history.c入出庫時の履歴登録
src/stock/stock_history_list.c履歴一覧の取得
src/common/validation.c商品名、単価、整数の検証

mainを定義するのは、gui/inventory_register.cです。

第12章のコンソール版のmainや、15.12の照合用プログラムは、このGUIのビルド対象へ追加しません。

同じ実行ファイルへ複数のmainを含めないことと、必要な共通処理を漏らさないことを確認しましょう。

UCRT64のビルド環境を確認しよう

最初に、使用している環境を確認します。

echo "$MSYSTEM"

実行結果の例

UCRT64

続いて、使用されるコマンドの場所を確認します。

command -v gcc
command -v pkg-config

実行結果の例

/ucrt64/bin/gcc
/ucrt64/bin/pkg-config

GCCの対象環境も確認します。

gcc -dumpmachine

実行結果の例

x86_64-w64-mingw32

この表示は、64ビットWindows向けのGCCであることを確認する手掛かりです。ただし、この表示だけではUCRT64とほかのMinGW環境を区別できないため、MSYSTEMとコマンドの場所も合わせて確認します。

両ライブラリの設定が見つかるか確認する

pkg-config --exists gtk4 mysqlclient
echo $?

実行結果の例

0

0なら、両方のビルド設定を取得できています。

コンパイル用とリンク用の設定は、それぞれ次のコマンドで確認できます。

pkg-config --cflags gtk4 mysqlclient
pkg-config --libs gtk4 mysqlclient
オプション取得する主な設定
--cflagsヘッダーの検索先やコンパイル時の定義
--libsライブラリの検索先やリンク対象

表示される具体的な内容は、インストールされているライブラリやバージョンによって異なります。

配布用のコンパイル設定を決めよう

今回使用する主なオプションは、次のとおりです。

オプション役割
-std=c17C17を使用する
-O2最適化を有効にする
-Wall基本的な警告を有効にする
-Wextra追加の警告を有効にする
-Wpedantic指定したC規格に関する診断を有効にする
-Werrorコンパイラが出す警告をエラーとして扱う
-Iinclude共通ヘッダーの検索先を追加する
-cリンクせず、オブジェクトファイルを作る
-o出力先のファイル名を指定する

-O2で最適化する

-O2を指定すると、GCCが実行速度やコードの構成を改善するための最適化を行います。具体的に有効になる最適化は、対象環境やGCCの構成によって異なります。

ただし、最適化を指定したことと、アプリの動作が正しいことは別に確認します。

また、DBへの通信待ち時間などが、最適化だけで解消されるわけではありません。

-Werrorで警告が出たら停止する

これまでも警告を表示していましたが、今回は-Werrorを加えます。

-Werrorは、コンパイラが出す警告をエラーとして扱う設定です。警告を見落としたまま次の処理へ進むことを防ぐために使用します。

警告が出た場合は、表示されたファイル名、行番号、内容を確認して修正します。

なお、-Wallは、GCCが持つすべての警告を有効にするという意味ではありません。今回の設定で警告が出なくても、入力検証やトランザクションの動作確認は必要です。

今回はコンソールから確認できる起動方式を維持する

Windows向けGCCには、実行ファイルのサブシステムを指定する-mconsoleや-mwindowsがあります。

オプション主な役割
-mconsoleコンソールアプリケーション用のサブシステムを指定する
-mwindowsGUIアプリケーション用のサブシステムを指定する

これらは、Windowsの実行ファイルとしての起動方式に関する指定です。GTKのウィンドウを作る処理とは分けて考えます。

現在のアプリには、次の出力があります。

  • --check-configによる設定確認。
  • 設定ファイルを読み込めない場合の説明。
  • 接続やDB処理の診断情報。

この記事では、これまでの出力をコンソールから確認できる構成を維持し、-mwindowsは追加しません。

配布時のパスワード入力や起動方法は、16.7で整えていきます。

図2:警告を確認してからリンクへ進む

この図から分かること

コンパイル中に警告やエラーが出た場合は、そこで停止して内容を確認します。

すべての対象ソースをコンパイルできたら、オブジェクトファイルとライブラリをリンクします。

実行ファイルが完成した後には、設定確認や起動確認も行います。

配布用ビルドをスクリプトへまとめよう

毎回13個のソースを入力する代わりに、ビルド処理をスクリプトへまとめます。

今回のスクリプトでは、次の処理を行います。

  • UCRT64環境と必要なコマンドを確認する。
  • ソースとヘッダーの不足を確認する。
  • GTK 4とConnector/Cの設定を取得する。
  • すべてのソースを配布用の設定でコンパイルする。
  • 一時的な実行ファイルへリンクする。
  • リンク成功後にinventory_register.exeとして採用する。

オブジェクトファイルは、build/release内へ保存します。

元のソースオブジェクトファイル
gui/inventory_register.cbuild/release/gui/inventory_register.o
src/db/db.cbuild/release/src/db/db.o
src/product/product.cbuild/release/src/product/product.o
src/stock/stock_receive.cbuild/release/src/stock/stock_receive.o

このスクリプトは、C:\msys64のように、MSYS2の導入先に空白を含まない構成を前提にしています。pkg-configが返す設定を、空白区切りで配列へ分けて使用します。

完成版GUIを配布用の設定でコンパイルしてリンクするスクリプト

ファイル名: build_gui_release.sh

#!/usr/bin/env bash

set -euo pipefail

# スクリプトを保存したchap16を作業場所にする
cd -- "$(dirname -- "${BASH_SOURCE[0]}")"

# 教材と同じUCRT64環境でビルドする
if [[ "${MSYSTEM:-}" != "UCRT64" ]]; then
    printf "MSYS2 UCRT64のターミナルから実行してください。\n" >&2
    exit 1
fi

# ビルドに必要なコマンドを確認する
for tool_name in gcc pkg-config; do
    if ! command -v "$tool_name" >/dev/null 2>&1; then
        printf "必要なコマンドがありません:%s\n" "$tool_name" >&2
        exit 1
    fi
done

compiler_target=$(gcc -dumpmachine)
if [[ "$compiler_target" != "x86_64-w64-mingw32" ]]; then
    printf "GCCの対象環境を確認してください:%s\n" "$compiler_target" >&2
    exit 1
fi

if ! pkg-config --exists gtk4 mysqlclient; then
    printf "GTK 4またはConnector/Cのビルド設定が見つかりません。\n" >&2
    exit 1
fi

# GUI版に必要な13個のソースだけを指定する
sources=(
    gui/inventory_register.c
    src/db/db.c
    src/db/db_config.c
    src/product/product.c
    src/product/product_list.c
    src/product/product_find.c
    src/product/product_update.c
    src/product/product_delete.c
    src/stock/stock_receive.c
    src/stock/stock_ship.c
    src/stock/stock_history.c
    src/stock/stock_history_list.c
    src/common/validation.c
)

# 公開ヘッダーと、在庫モジュールの内部ヘッダーを確認する
headers=(
    include/app_types.h
    include/app_result.h
    include/db.h
    include/db_config.h
    include/product.h
    include/stock.h
    include/stock_history.h
    include/validation.h
    src/stock/stock_history_internal.h
)

missing=0
for file_path in "${sources[@]}" "${headers[@]}"; do
    if [[ ! -f "$file_path" ]]; then
        printf "必要なファイルがありません:%s\n" "$file_path" >&2
        missing=1
    fi
done

if (( missing != 0 )); then
    exit 1
fi

# コンパイル用とリンク用の設定を分けて取得する
library_cflags_text=$(pkg-config --cflags gtk4 mysqlclient)
library_libs_text=$(pkg-config --libs gtk4 mysqlclient)

# 空白を含まない標準のMSYS2導入先を前提に配列へ分ける
read -r -a library_cflags <<< "$library_cflags_text"
read -r -a library_libs <<< "$library_libs_text"

compile_options=(
    -std=c17
    -O2
    -Wall
    -Wextra
    -Wpedantic
    -Werror
    -Iinclude
)

build_dir="build/release"
final_executable="inventory_register.exe"
temporary_executable="$build_dir/inventory_register.new.exe"

mkdir -p -- "$build_dir"

# リンク途中のファイルは終了時に片付ける
cleanup()
{
    rm -f -- "$temporary_executable"
}
trap cleanup EXIT

objects=()
printf "ビルド対象:%dファイル\n" "${#sources[@]}"

# 設定の違う古いオブジェクトを使わず、毎回すべてコンパイルする
for source_file in "${sources[@]}"; do
    object_file="$build_dir/${source_file%.c}.o"
    mkdir -p -- "$(dirname -- "$object_file")"

    printf "コンパイル:%s\n" "$source_file"
    gcc "${compile_options[@]}" "${library_cflags[@]}" \
        -c "$source_file" -o "$object_file"

    objects+=("$object_file")
done

# オブジェクトの後ろへリンク用ライブラリを指定する
printf "リンク:%s\n" "$temporary_executable"
gcc -O2 "${objects[@]}" -o "$temporary_executable" \
    "${library_libs[@]}"

# リンクに成功した実行ファイルだけを採用する
mv -f -- "$temporary_executable" "$final_executable"

printf "ビルドが完了しました:%s\n" "$final_executable"

スクリプトの処理を確認しよう

スクリプトの保存先へ移動する

cd -- "$(dirname -- "${BASH_SOURCE[0]}")"

この処理によって、スクリプトを保存したchap16を基準にファイルを参照します。

別の場所からスクリプトを呼び出しても、ソースやヘッダーの検索先が変わりにくい構成です。

ソースとヘッダーの不足を先に調べる

for file_path in "${sources[@]}" "${headers[@]}"; do
    if [[ ! -f "$file_path" ]]; then
        printf "必要なファイルがありません:%s\n" "$file_path" >&2
        missing=1
    fi
done

不足したファイルがあれば、そのパスを表示します。

特に、履歴表示に必要なinclude/stock_history.hと、履歴登録で使用するsrc/stock/stock_history_internal.hを区別して確認しています。

この確認はファイルの存在を調べるものです。内容の整合性は、その後のコンパイルや動作確認で確かめます。

毎回すべてのソースをコンパイルする

gcc "${compile_options[@]}" "${library_cflags[@]}" \
    -c "$source_file" -o "$object_file"

今回は、更新日時による差分ビルドを行わず、13個すべてをコンパイルします。

これにより、以前の設定で作ったオブジェクトファイルを、そのまま使ってしまうことを防ぎます。

また、リンク対象はobjectsへ追加したものだけです。build内に別の確認用オブジェクトが残っていても、自動的にリンクへ追加されることはありません。

ライブラリはオブジェクトの後ろへ指定する

gcc -O2 "${objects[@]}" -o "$temporary_executable" \
    "${library_libs[@]}"

先にアプリ側のオブジェクトを並べ、その後ろへライブラリの設定を渡しています。

GCCのリンクでは、ライブラリやオブジェクトの指定順序が結果に関係するため、この並びを使用します。gcc.gnu.org

リンク成功後に実行ファイルを採用する

mv -f -- "$temporary_executable" "$final_executable"

リンク先は、いったんbuild/release/inventory_register.new.exeとしています。

リンクが成功した後で、chap16直下のinventory_register.exeへ移します。

途中で失敗した場合は、完成メッセージを表示せずに終了します。一時的な実行ファイルは、EXITの処理で片付けます。

以前のinventory_register.exeがある場合、ビルド失敗時にはそのファイルが残ることがあります。ファイルが存在することだけで今回のビルド成功と判断せず、終了ステータスと完了表示を確認してください。

配布用ビルドを実行しよう

起動中のinventory_register.exeがあれば、先に終了します。

Windowsでは、実行中のファイルを置き換えられず、最後の採用処理で失敗する場合があります。

chap16で実行します。

bash build_gui_release.sh

実行結果の例

警告やエラーがない場合は、次のように表示されます。

ビルド対象:13ファイル
コンパイル:gui/inventory_register.c
コンパイル:src/db/db.c
コンパイル:src/db/db_config.c
コンパイル:src/product/product.c
コンパイル:src/product/product_list.c
コンパイル:src/product/product_find.c
コンパイル:src/product/product_update.c
コンパイル:src/product/product_delete.c
コンパイル:src/stock/stock_receive.c
コンパイル:src/stock/stock_ship.c
コンパイル:src/stock/stock_history.c
コンパイル:src/stock/stock_history_list.c
コンパイル:src/common/validation.c
リンク:build/release/inventory_register.new.exe
ビルドが完了しました:inventory_register.exe

実行直後に終了ステータスを確認します。

echo $?

実行結果の例

0

0なら、スクリプトが正常終了しています。

コンパイラの警告は-Werrorで停止しますが、リンク時の診断なども含めて、表示されたメッセージ全体を確認してください。

ビルドに失敗した場合は発生した段階を確認しよう

エラーが出た場合は、最初に表示された原因から確認すると追いやすくなります。

表示や状態主に確認するところ
UCRT64から実行するよう案内された起動したターミナル
ビルド設定が見つからないGTK 4、Connector/C、pkg-configの環境
必要なファイルがないchap15からのコピー内容と保存先
ヘッダーが見つからないヘッダー名、配置、検索先
宣言と定義の型が一致しない対応するヘッダーとCソース
未使用変数などで停止した指摘されたソースの記述
undefined referenceが出る実装ソースやリンク対象の不足
multiple definitionが出る同じ定義やmainの重複
実行ファイルの置き換えに失敗するアプリの起動状態、保存先の権限

警告が出た場合は、内容を確認して修正します。

特に、ポインター型やprintfの書式に関する警告では、単に型変換を追加する前に、渡している値の型が正しいかを確認しましょう。

修正後は保存し、もう一度ビルドします。

bash build_gui_release.sh

ビルドした実行ファイルで設定を確認しよう

まず、接続設定だけを確認します。

./inventory_register.exe --check-config

実行結果の例

設定の検証が完了しました。MySQLへは接続していません。

この確認では、inventory.confの読み込みと、設定内容の検証を行います。

パスワードは不要です。また、MySQL Serverへ実際に接続できることまでは確認していません。

確認できることこの操作では確認しないこと
inventory.confを読み込めるサーバーが稼働しているか
必須項目がそろっているユーザー認証に成功するか
設定の形式が条件に合っている商品テーブルを操作できるか

なお、--check-configを実行する場合でも、実行ファイルの起動に必要なDLLは必要です。今回の確認は、それらが導入されている開発用PCで行います。

開発用PCでGUIの起動を確認しよう

MySQL Serverが起動していることと、inventory.confがこれまでと同じDBを指していることを確認します。

その後、引き継いだ起動スクリプトを実行します。

bash run_gui_register.sh

実行結果の例

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

設定の検証が完了しました。MySQLへは接続していません。
MySQLのパスワード:

パスワードを入力すると、GUIが起動します。入力したパスワードの文字は表示されません。

今回共有されている22件の商品がそのまま保存されていれば、一覧の件数表示は次のようになります。

取得済みの商品:22件

商品一覧では、たとえば次の内容を照合します。

商品ID商品名単価在庫数
23入庫確認ノートA4190.506
24通常操作確認ノートA5200.007
31GUI通し確認ノートA5200.000

今回は、ビルド後の基本確認として、次の操作を行いましょう。

  • 起動直後の商品一覧を確認する。
  • 商品を選択し、商品名と単価が入力欄へ表示されることを確認する。
  • 在庫履歴を表示し、取得結果を確認する。
  • 一覧を更新する。
  • アプリを終了し、再度起動する。

読み取り中心の確認なので、登録・変更・削除・入出庫を実行する必要はありません。

配布に使う最終版については、第15章の通し確認も参照して動作を確認します。ソースの修正を伴った場合は、その変更に関係する通常操作と異常系も確認してください。

図3:ビルド・設定確認・起動確認を順に行う

この図から分かること

ビルド成功、設定確認成功、DB接続成功は、それぞれ別の確認です。

実行ファイルを作成できた後、設定ファイルを読み込めるかを確認し、続いてMySQLへ接続してGUIの基本操作を確かめます。

ここまで確認できたら、別のPCで動かすために必要な実行時ファイルの調査へ進みます。

今回作成したファイルを確認しよう

今回の作業後は、主に次のファイルが追加・作成されます。

ファイルやフォルダ内容配布時の扱い
build_gui_release.sh配布用ビルドの手順開発・ビルド用として管理する
build/release内のオブジェクト配布用設定でコンパイルした中間ファイル実行用ZIPへ入れない
inventory_register.exe今回作成したGUI本体配布対象にする
inventory.conf開発用PCで使用した接続設定配布先向けの設定方法を後で整える
run_gui_register.sh開発用PCでの起動手段配布先向けの起動方法を後で整える

ソースやヘッダーを修正した場合は、再度ビルドしてください。

また、GTK 4やConnector/Cを更新してビルドし直した場合は、実行ファイルが必要とするDLLの構成も改めて確認します。

次の16.3では、今回作成したinventory_register.exeを対象に、GTK 4、Connector/C、その依存ライブラリを調べていきましょう。

Follow me!