61fc03bca670992074c888422b5363c268f6212d
[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規格では、8(0から7) */
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     unsigned clocks;      /**<クロック周波数 */
43 } SYSTEM;
44
45 extern SYSTEM *sys;
46
47 /**
48  * COMET II 命令
49  * 命令タイプは、オペランドにより6種類に分類
50  */
51 typedef enum {
52     /**
53      *  オペランド数2または3。命令語長2
54      *     第1オペランド: 汎用レジスタ
55      *     第2オペランド: アドレス
56      *     第3オペランド: 指標レジスタ
57      */
58     R_ADR_X = 010,
59     /**
60      *  オペランド数2または3。。命令語長2
61      *     第1オペランド: 汎用レジスタ
62      *     第2オペランド: アドレスに格納されている内容
63      *     第3オペランド: 指標レジスタ
64      */
65     R1_R2 = 020,
66     /**
67      * オペランド数1または2。命令語長1
68      *     第1オペランド: アドレス
69      *     第2オペランド: 指標レジスタ
70      */
71     ADR_X = 030,
72     /**
73      *   オペランド数1。命令語長1
74      *     第1オペランド: 汎用レジスタ
75      */
76     R_ = 040,
77     /**
78      *  オペランドなし。命令語長1
79      */
80     NONE = 0,
81     /**
82      *  COMET II命令以外
83      */
84     NOTCMD = 077,
85 } CMDTYPE;
86
87 /**
88  * 命令コード表の項目
89  */
90 typedef struct {
91     char *name;                 /**<命令名 */
92     CMDTYPE type;               /**<命令タイプ */
93     WORD code;                  /**<命令コード */
94     const void (*ptr);          /**<命令の関数ポインタ */
95 } CMD;
96
97 /**
98  * 命令コードのハッシュ表
99  */
100 typedef struct _CMDTAB {
101     struct _CMDTAB *next;       /**<リスト次項目へのポインタ */
102     CMD *cmd;                   /**<命令コード表の項目 */
103 } CMDTAB;
104
105 /**
106  * プログラム実行時の開始と終了のアドレス
107  */
108 typedef struct {
109     WORD start;   /**<開始アドレス */
110     WORD end;     /**<終了アドレス */
111     bool stop;    /**<終了フラグ */
112 } EXECPTR;
113
114 extern EXECPTR *execptr;
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  */
150 const void (*getcmdptr(WORD code));
151
152 /**
153  * コードがキーの命令ハッシュ表を解放する
154  */
155 void free_code_type();
156
157 #endif            /* YACASL2_CASL2_INCLUDEDの終端 */