X-Git-Url: http://j8takagi.net/cgi-bin/gitweb.cgi?p=YACASL2.git;a=blobdiff_plain;f=include%2Fcerr.h;h=810bf3c442cd881fc261bae02829d8b39e3b6be7;hp=f651c7d0aeab20f0d0d352339aba139a06745a31;hb=03e322484530da78d796401413d9f5f493d95345;hpb=3ea92ba68cb320156d5bc7fe92f5e5fa0c150635 diff --git a/include/cerr.h b/include/cerr.h index f651c7d..810bf3c 100644 --- a/include/cerr.h +++ b/include/cerr.h @@ -1,50 +1,87 @@ #ifndef YACASL2_CERR_H_INCLUDED #define YACASL2_CERR_H_INCLUDED -#include -#include -#include -#include +#include +#include "cmem.h" -#ifndef ARRAYSIZE -#define ARRAYSIZE(array) (sizeof(array)/sizeof(array[0])) -#endif - -/* エラー番号 */ -extern int cerrno; - -/* エラーメッセージ */ -extern char *cerrmsg; +/** + * @brief エラーを表すデータ型 + */ +typedef struct _CERR { + int num; /**<エラー番号 */ + char *msg; /**<エラーメッセージ */ +} CERR; -/* エラーコード配列 */ -typedef struct { - int num; - char *msg; -} CERRARRAY; +/** + * @brief 現在のエラー + */ +extern CERR *cerr; -/* エラーコードリスト */ +/** + * @brief エラーリストのデータ型 + */ typedef struct _CERRLIST { - struct _CERRLIST *next; - CERRARRAY *err; + struct _CERRLIST *next; /**<リスト次項目へのポインタ */ + CERR *cerr; /**<エラーの構造体 */ } CERRLIST; -/* エラーメッセージ */ -extern CERRLIST *cerr; +/** + * @brief エラーリスト + */ +extern CERRLIST *cerrlist; enum { - CERRSTRSIZE = 10, /* エラーメッセージ中に挿入できる文字列のサイズ */ - CERRMSGSIZE = 70, /* エラーメッセージのサイズ */ + CERRSTRSIZE = 10, /**<エラーメッセージ中に挿入できる文字列のサイズ */ + CERRMSGSIZE = 70, /**<エラーメッセージのサイズ */ }; -/* エラーを追加する */ -void addcerrlist(int cerrc, CERRARRAY cerrv[]); +/** + * @brief エラーを初期化する + * + * @return なし + */ +void cerr_init(); + +/** + * @brief エラーリストを作成・追加する + * + * @return なし + * + * @param cerrc 作成または追加するエラーの数 + * @param cerrv 作成または追加するエラーの配列 + */ +void addcerrlist(int cerrc, CERR cerrv[]); + +/** + * @brief エラーリストを表示する + * + * @return なし + */ +void printcerrlist(); -/* エラー番号とエラーメッセージを設定 */ +/** + * @brief 現在のエラーを設定する + * + * @return なし + * + * @param num エラー番号 + * @param *str エラーメッセージに含まれる文字列 + */ void setcerr(int num, const char *str); -/* エラー番号からメッセージを返す */ +/** + * @brief エラー番号に対応するエラーメッセージを返す + * + * @return エラーメッセージ + * + * @param num エラー番号 + */ char *getcerrmsg(int num); -/* エラーを解放する */ +/** + * @brief エラーリストと現在のエラーを解放する + * + * @return なし + */ void freecerr(); #endif