ドキュメントの修正
[YACASL2.git] / include / word.h
1 #ifndef YACASL2_WORD_H_INCLUDED
2 #define YACASL2_WORD_H_INCLUDED
3
4 #include <stdbool.h>
5
6 /**
7  * @brief 16ビットの数値を表すデータ型
8  */
9 typedef unsigned short WORD;
10
11 /**
12  * @brief wordデータ型についてのエラーをエラーリストに追加する
13  *
14  * @return なし
15  */
16 void addcerrlist_word();
17
18 /**
19  * @brief 10進数または16進数の文字列をWORD値に変換する
20  *
21  * @return WORD値
22  *
23  * @param *str 10進数または16進数の文字列
24  */
25 WORD nh2word(const char *str);
26
27 /**
28  * @brief WORD値を10進数値を表す文字列に変換する
29  *
30  * @return 10進数値を表す文字列
31  *
32  * @param *word WORD値
33  */
34 char *word2n(WORD word);
35
36 /**
37  * @brief WORD値を2進数の文字列に変換する
38  *
39  * @return 2進数値を表す文字列
40  *
41  * @param word WORD値
42  */
43 char *word2bit(const WORD word);
44
45 /**
46  * @brief WORD値を解析して表示する
47  *
48  * @return なし
49  *
50  * @param word WORD値
51  * @param logicalmode 論理演算の場合はtrue、算術演算の場合はfalse
52  */
53 void print_dumpword(WORD word, bool logicalmode);
54
55 #endif