X-Git-Url: http://j8takagi.net/cgi-bin/gitweb.cgi?p=YACASL2.git;a=blobdiff_plain;f=include%2Fstruct.h;h=ee5963425b8b29b25be94c759d843b213a097c7e;hp=e862786713a1b49f983d13695e45f4f929b5f810;hb=c2820a4ee2f34c794268b5a61d3223f1c270d39c;hpb=71c7607d809b725d66ef21471041e2677c71be4e

diff --git a/include/struct.h b/include/struct.h
index e862786..ee59634 100644
--- a/include/struct.h
+++ b/include/struct.h
@@ -5,7 +5,7 @@
 #include "word.h"
 
 /**
- * COMET IIの規格
+ * @brief COMET IIの規格値
  */
 enum {
     CMDSIZE = 4,              /**<命令の最大文字数 */
@@ -15,7 +15,7 @@ enum {
 };
 
 /**
- * COMET II フラグのマスク値
+ * @brief COMET II フラグのマスク値
  */
 enum {
     OF = 0x4,    /**<Overflow Flag */
@@ -24,7 +24,7 @@ enum {
 };
 
 /**
- * COMET IIのCPU
+ * @brief COMET IIのCPUを表すデータ型
  */
 typedef struct {
     WORD gr[GRSIZE]; /**<汎用レジスタ */
@@ -34,7 +34,7 @@ typedef struct {
 } CPU;
 
 /**
- * COMET IIの仮想実行マシンシステム
+ * @brief COMET IIの仮想実行マシンシステムを表すデータ型
  */
 typedef struct {
     CPU *cpu;        /**<CPU */
@@ -43,46 +43,44 @@ typedef struct {
     clock_t clocks;  /**<クロック周波数 */
 } SYSTEM;
 
+/**
+ * @brief COMET IIの仮想実行マシンシステム
+ */
 extern SYSTEM *sys;
 
 /**
  * COMET II 命令
- * 命令タイプは、オペランドにより6種類に分類
+ * 命令タイプは、オペランドにより5種類に分類
  */
 typedef enum {
     /**
-     *  オペランド数2または3。命令語長2
-     *     第1オペランド: 汎用レジスタ
-     *     第2オペランド: アドレス
-     *     第3オペランド: 指標レジスタ
+     *  オペランド数2または3
+     *  - 第1オペランド: 汎用レジスタ。必須
+     *  - 第2オペランド: アドレス。必須
+     *  - 第3オペランド: 指標レジスタとして用いる汎用レジスタ。任意
      */
-    R_ADR_X = 010,
+    R_ADR_X = 01,
     /**
-     *  オペランド数2または3。。命令語長2
-     *     第1オペランド: 汎用レジスタ
-     *     第2オペランド: アドレスに格納されている内容
-     *     第3オペランド: 指標レジスタ
+     *  オペランド数2
+     *  - 第1オペランド: 汎用レジスタ。必須
+     *  - 第2オペランド: 汎用レジスタ。必須
      */
-    R1_R2 = 020,
+    R1_R2 = 02,
     /**
-     * オペランド数1または2。命令語長1
-     *     第1オペランド: アドレス
-     *     第2オペランド: 指標レジスタ
+     * オペランド数1または2
+     * - 第1オペランド: アドレス。必須
+     * - 第2オペランド: 指標レジスタとして用いる汎用レジスタ。任意
      */
-    ADR_X = 030,
+    ADR_X = 03,
     /**
-     *   オペランド数1。命令語長1
-     *     第1オペランド: 汎用レジスタ
+     * オペランド数1
+     * - 第1オペランド: 汎用レジスタ。必須
      */
-    R_ = 040,
+    R_ = 04,
     /**
-     *  オペランドなし。命令語長1
+     * オペランドなし
      */
-    NONE = 0,
-    /**
-     *  COMET II命令以外
-     */
-    NOTCMD = 077,
+    NONE = 00,
 } CMDTYPE;
 
 /**
@@ -151,16 +149,26 @@ void free_cmdtype_code();
 /**
  * コードがキーの命令ハッシュ表を作成する
  */
-bool create_code_type();
+bool create_code_cmdtype();
 
 /**
  * 命令コードから命令の関数ポインタを返す
  */
 const void (*getcmdptr(WORD code));
 
+/**
+ * 命令コードから命令のタイプを返す
+ */
+CMDTYPE getcmdtype(WORD code);
+
+/**
+ * 命令コードから命令の名前を返す
+ */
+char *getcmdname(WORD code);
+
 /**
  * コードがキーの命令ハッシュ表を解放する
  */
-void free_code_type();
+void free_code_cmdtype();
 
 #endif            /* YACASL2_CASL2_INCLUDEDの終端 */