readconf  1.6
設定ファイル読み込みモジュール
 全て データ構造 ファイル 関数 変数 型定義 列挙型 列挙型の値 マクロ定義 グループ
データ構造 | マクロ定義 | 型定義 | 列挙型 | 関数 | 変数
readconf.h

設定ファイル読み込み関数用構造体等定義ファイル。 [詳細]

#include <stdbool.h>
readconf.hのインクルード依存関係図
このグラフは、どのファイルから直接、間接的にインクルードされているかを示しています。

ソースコードを見る。

データ構造

union  RCConfValue
 設定項目値の共用体。 [詳細]
 
struct  RCConfItem
 設定項目の構造体。 [詳細]
 
struct  RCError
 エラー情報格納構造体。 [詳細]
 

マクロ定義

#define ELEMENTSOF(ARRAY)   (sizeof(ARRAY)/sizeof(ARRAY[0]))
 

型定義

typedef enum RCValueType RCValueType
 設定項目の型ID。 [詳細]
 
typedef union RCConfValue RCConfValue
 設定項目値の共用体。 [詳細]
 
typedef bool(* RCValidator )(char *name, RCValueType type, RCConfValue value)
 設定項目値を検証する関数。 [詳細]
 
typedef bool(* RCConvertor )(const char *name, RCValueType type, const char *string, RCConfValue *value)
 設定項目値文字列を数値に変換する関数。 [詳細]
 
typedef struct RCConfItem RCConfItem
 設定項目の構造体。 [詳細]
 
typedef enum RCErrorNo RCErrorNo
 エラー番号。 [詳細]
 
typedef struct RCError RCError
 エラー情報格納構造体。 [詳細]
 

列挙型

enum  RCValueType { RCValueTypeString = 'S', RCValueTypeInteger = 'I', RCValueTypeReal = 'D', RCValueTypeBool = 'B' }
 設定項目の型ID。 [詳細]
 
enum  RCErrorNo {
  RCErrorNone = 0, RCErrorNoItem, RCErrorNullItem, RCErrorOpen,
  RCErrorNoMemory, RCErrorStringTooLong, RCErrorNameTooLong, RCErrorSyntax,
  RCErrorTypeMismatch, RCErrorUnexpectedName, RCErrorRedefinition, RCErrorNumberFormat,
  RCErrorValidationFailed, RCErrorBoolValue, RCErrorConstantConversion
}
 エラー番号。 [詳細]
 

関数

bool readconf (RCConfItem *items, size_t numItems, const char *confPath)
 指定の設定ファイルから設定を読み込み、指定された構造体配列に格納します。 [詳細]
 
void RCFreeStringValueInItems (RCConfItem *items, size_t numItems)
 指定された設定項目構造体配列の文字列を解放します。 [詳細]
 
void RCFreeRaisedErrors (void)
 readconf() による読み込み処理で発生したエラー情報構造体配列を解放します。 [詳細]
 
char * RCDuplicateString (const char *str)
 指定された文字列を複製します。 [詳細]
 

変数

RCErrorRCRaisedErrors
 エラー情報格納配列。 [詳細]
 
size_t RCNumRaisedErrors
 エラー情報数。 [詳細]
 
size_t RCMaxNameLength
 設定ファイルから項目名を読み込む際の最大の長さ。 [詳細]
 
size_t RCMaxStringLength
 設定ファイルから文字列を読み込む際の最大の長さ。 [詳細]
 

説明

設定ファイル読み込み関数用構造体等定義ファイル。

作者
tsntsumi
バージョン
1.6
から
v1.0 2013/12

readconf.h で定義されています。

マクロ定義

#define ELEMENTSOF (   ARRAY)    (sizeof(ARRAY)/sizeof(ARRAY[0]))

readconf.h250 行で定義されています。

参照元 convertStringToBool().

型定義

typedef bool(* RCConvertor)(const char *name, RCValueType type, const char *string, RCConfValue *value)

設定項目値文字列を数値に変換する関数。

引数
[in]name項目名。
[in]type型。
[in]string読み込んだ設定項目値文字列。
[out]value変換後の値を格納する変数へのポインタ。
戻り値
変換に成功したら true 、失敗したら false 。

readconf.h64 行で定義されています。

typedef bool(* RCValidator)(char *name, RCValueType type, RCConfValue value)

設定項目値を検証する関数。

readconf.h54 行で定義されています。

関数

char* RCDuplicateString ( const char *  str)

指定された文字列を複製します。

引数
str複製する文字列。
戻り値
複製した文字列。

readconf.c159 行で定義されています。

参照元 initialize(), setValue(), と shrinkString().

呼出しグラフ: