目次 - SDL 3.0 API(機能別) - アサーション

アサーション

概要

有用なアサーション(検証)マクロ.

SDLアサーションは通常のアサーションマクロと似ているが, 次の様な特徴がある:

sizeofを巧妙に使うことで, 検証を無効化してコンパイルするコードから除外したとき, アサーションが参照する変数が使用されなくなってもコンパイラが警告を発しないようになっている.
if (x) SDL_assert(y); else do_something(); のような「ぶらさがりelse(dangling-else)」でも安全に使用できる.
様々な環境のCコンパイラやランタイムでも同じように動作する.
有か無しかのどちらかではなく, 複数のレベルのアサーション(SDL_assert, SDL_assert_release, SDL_assert_paranoid)が用意されている.
検証に失敗したとき様々な対応(リトライ, デバッガの呼び出し, プログラムの中断, 1回目を無視する, 無視して残りのプログラムを実行する)を提供している.
デフォルトでは可能ならばユーザにダイアログを表示するが, 検証失敗時にコールバックさせることもできる.
失敗した検証の再検証を行える. ネットワークを失敗させ, ケーブルを接続した後にもう一度テストするなどが可能.
ユーザに検証の失敗を無視させることができる. 無害な問題が発生して残りの処理を実行したい場合など.
ユーザに残りのプログラムの実行のために無視する検証をマークさせることができる. 無害な問題が発生し続ける場合など.
アプリケーションの全ての失敗した検証の統計とデータを提供する.
自動化スクリプトで制御する場合などのために, 環境変数でデフォルトのアサーションハンドラを制御できる.
Clangの静的解析の補助として使える. アナライザはSDLアサーションを常に成功として扱う(あなたが問題を解決する, そしてデバッグビルドで問題を検出するとみなすため). これはアナライザが失敗とする可能性を避けることを助ける.

使い方: あなたのコードをチェックするテストを配置して, デバッグビルドでコンパイルするだけである.

関数

SDL_GetAssertionHandler - 現在のアサーションハンドラを得る
SDL_GetAssertionReport - 失敗した全てのアサーションのリストを戻す
SDL_GetDefaultAssertionHandler - デフォルトのアサーションハンドラを得る
SDL_ReportAssertion - この関数を直接呼んではならない
SDL_ResetAssertionReport - 失敗したアサーションのリストを全て消去する
SDL_SetAssertionHandler - アプリケーション定義のアサーションハンドラを設定する

型

SDL_AssertionHandler - SDLアサーションに失敗したとき呼ばれるコールバック

構造体

SDL_AssertData - アサーションの情報の構造体

列挙体

SDL_AssertState - アサーションが失敗した後の動作の列挙体

マクロ

SDL_assert - デバッグビルド時のみアサーションを生成するマクロ
SDL_assert_always - 常にアサーションを生成するマクロ
SDL_ASSERT_FILE - アサーションで使用されるコンパイル中のファイル名のマクロ
SDL_ASSERT_LEVEL - アサーションレベルのマクロ
SDL_assert_paranoid - 厳格な設定のビルド時のみアサーションを生成するマクロ
SDL_assert_release - リリースビルド時でもアサーションを生成するマクロ
SDL_AssertBreakpoint - アサーションがブレイクポイントを発生させたとき使用するマクロ
SDL_disabled_assert - アサーションが無効のとき使用されるマクロ
SDL_enabled_assert - アサーションが無効のとき使用されるマクロ
SDL_FILE - 現在コンパイル中のファイルのマクロ
SDL_FUNCTION - 現在コンパイル中の関数名のマクロ
SDL_LINE - 現在コンパイル中のファイルの行番号のマクロ
SDL_NULL_WHILE_LOOP_CONDITION - do {} while (0);でコードを囲むときコンパイラが警告を発しないようにするためのマクロ
SDL_TriggerBreakpoint - デバッガに停止を指示するマクロ

SDL Wikiへのリンク

SDL3/CategoryAssert - SDL Wiki