doxygen用にコメント修正。関数のstatic指定を外す
[YACASL2.git] / include / struct.h
1 #ifndef YACASL2_CASL2_INCLUDED
2 #define YACASL2_CASL2_INCLUDED
3
4 #include "word.h"
5
6 /**
7  * COMET IIの規格
8  */
9 enum {
10     CMDSIZE = 4,              /**<命令の最大文字数 */
11     GRSIZE = 8,               /**<汎用レジスタの数。COMET II規格により0から7までの8つ */
12     DEFAULT_MEMSIZE = 512,    /**<デフォルトのメモリ容量。COMET II規格では、65535語(word) */
13     DEFAULT_CLOCKS = 5000000, /**<デフォルトのクロック周波数。COMET II規格では、未定義 */
14 };
15
16 /**
17  * COMET II フラグのマスク値
18  */
19 enum {
20     OF = 0x4,    /**<Overflow Flag */
21     SF = 0x2,    /**<Sign Flag */
22     ZF = 0x1,    /**<Zero Flag */
23 };
24
25 /**
26  * COMET IIのCPU
27  */
28 typedef struct {
29     WORD gr[GRSIZE]; /**<汎用レジスタ */
30     WORD sp;         /**<スタックポインタ */
31     WORD pr;         /**<プログラムレジスタ */
32     WORD fr;         /**<フラグレジスタ */
33 } CPU;
34
35 /**
36  * COMET IIの仮想実行マシンシステム
37  */
38 typedef struct {
39     CPU *cpu;        /**<CPU */
40     WORD *memory;    /**<メモリ */
41     int memsize;     /**<メモリサイズ */
42     int clocks;      /**<クロック周波数 */
43 } SYSTEM;
44
45 extern SYSTEM *sys;
46
47 /**
48  * COMET II 命令
49  * 命令タイプは、オペランドにより6種類に分類
50  */
51 typedef enum {
52     /**
53      *  オペランド数2または3
54      *     第1オペランド: 汎用レジスタ
55      *     第2オペランド: アドレス
56      *     第3オペランド: 指標レジスタ
57      */
58     R_ADR_X = 010,
59     /**
60      *  オペランド数2または3
61      *     第1オペランド: 汎用レジスタ、
62      *     第2オペランド: アドレスに格納されている内容
63      *     第3オペランド: 指標レジスタ
64      */
65     R_ADR_X_ = 011,
66     /**
67      *  オペランド数2
68      *     第1オペランド: 汎用レジスタ
69      *     第2オペランド: 汎用レジスタ
70      */
71     R1_R2 = 020,
72     /**
73      * オペランド数1または2
74      *     第1オペランド: アドレス
75      *     第2オペランド: 指標レジスタ
76      */
77     ADR_X = 030,
78     /**
79      *   オペランド数1
80      *     第1オペランド: 汎用レジスタ
81      */
82     R_ = 040,
83     /**
84      *  オペランドなし
85      */
86     NONE = 0,
87 } CMDTYPE;
88
89 /**
90  * 命令コード配列
91  */
92 typedef struct {
93     char *name;
94     CMDTYPE type;
95     WORD code;
96 } CMD;
97
98 /**
99  * 命令コードのハッシュ表
100  */
101 typedef struct _CMDTAB {
102     struct _CMDTAB *next;
103     CMD *cmd;
104 } CMDTAB;
105
106 /**
107  * CASL2プログラムのプロパティ
108  */
109 typedef struct {
110     WORD start;   /**<プログラムの開始番地 */
111     WORD end;     /**<プログラムの終了番地 */
112 } PROGPROP;
113
114 extern PROGPROP *prog;
115
116 /**
117  * COMET II仮想マシンのリセット
118  */
119 void reset(int memsize, int clocks);
120
121 /**
122  * COMET II仮想マシンのシャットダウン
123  */
124 void shutdown();
125
126 /**
127  * 名前とタイプがキーの命令ハッシュ表を作成する
128  */
129 bool create_cmdtype_code();
130
131 /**
132  * 命令の名前とタイプから、命令コードを返す
133  * 無効な場合は0xFFFFを返す
134  */
135 WORD getcmdcode(const char *cmd, CMDTYPE type);
136
137 /**
138  * 名前とタイプがキーの命令ハッシュ表を解放する
139  */
140 void free_cmdtype_code();
141
142 /**
143  * コードがキーの命令ハッシュ表を作成する
144  */
145 bool create_code_type();
146
147 /**
148  * 命令コードから命令タイプを返す
149  * 無効な場合はNONEを返す
150  */
151 CMDTYPE getcmdtype(WORD code);
152
153 /**
154  * コードがキーの命令ハッシュ表を解放する
155  */
156 void free_code_type();
157
158 #endif            /* YACASL2_CASL2_INCLUDEDの終端 */