]> git.sur5r.net Git - cc65/blobdiff - src/cc65/codeinfo.h
Removed (pretty inconsistently used) tab chars from source code base.
[cc65] / src / cc65 / codeinfo.h
index 786652a01da48a681e59f399fd18cb43c37c54ff..68a08b5c8293b3af3b573edde4c56e68454bf824 100644 (file)
@@ -1,15 +1,15 @@
 /*****************************************************************************/
 /*                                                                           */
-/*                               codeinfo.h                                 */
+/*                                codeinfo.h                                 */
 /*                                                                           */
-/*             Additional information about code instructions               */
+/*                  Additional information about 6502 code                   */
 /*                                                                           */
 /*                                                                           */
 /*                                                                           */
-/* (C) 2001     Ullrich von Bassewitz                                        */
-/*              Wacholderweg 14                                              */
-/*              D-70597 Stuttgart                                            */
-/* EMail:       uz@musoftware.de                                             */
+/* (C) 2001-2002 Ullrich von Bassewitz                                       */
+/*               Wacholderweg 14                                             */
+/*               D-70597 Stuttgart                                           */
+/* EMail:        uz@cc65.org                                                 */
 /*                                                                           */
 /*                                                                           */
 /* This software is provided 'as-is', without any expressed or implied       */
 
 
 /*****************************************************************************/
-/*                                  Data                                    */
+/*                                 Forwards                                  */
 /*****************************************************************************/
 
 
 
-/* Flags that tell what a specific instruction does with a register.
- * Please note that *changing* a register must not necessarily mean that the
- * value currently in the register is used. A prominent example is a load
- * instruction: It changes the register contents and does not use the old
- * value. On the flip side, a shift or something similar would use the
- * current value and change it.
- */
-#define CI_USE_NONE    0x0000U         /* Use nothing */
-#define CI_USE_A       0x0001U         /* Use the A register */
-#define CI_USE_X       0x0002U         /* Use the X register */
-#define CI_USE_Y       0x0004U         /* Use the Y register */
-#define CI_MASK_USE            0x000FU         /* Extract usage info */
+struct CodeSeg;
+
+
+
+/*****************************************************************************/
+/*                                   Data                                    */
+/*****************************************************************************/
+
 
-#define CI_CHG_NONE    0x0000U         /* Change nothing */
-#define CI_CHG_A       0x0010U         /* Change the A register */
-#define CI_CHG_X       0x0020U         /* Change the X register */
-#define CI_CHG_Y       0x0040U         /* Change the Y register */
-#define CI_MASK_CHG    0x00F0U         /* Extract change info */
-                            
-#define CI_BRA         0x0100U         /* Instruction is a branch */
-#define CI_MASK_BRA    0x0100U         /* Extract branch info */       
 
-#define CI_NONE                0x0000U         /* Nothing used/changed */
+/* Forward to struct RegContents */
+struct RegContents;
+
+/* Defines for registers. */
+#define REG_NONE        0x0000U
+#define REG_A           0x0001U
+#define REG_X           0x0002U
+#define REG_Y           0x0004U
+#define REG_TMP1        0x0008U
+#define REG_PTR1_LO     0x0010U
+#define REG_PTR1_HI     0x0020U
+#define REG_PTR2_LO     0x0040U
+#define REG_PTR2_HI     0x0080U
+#define REG_SREG_LO     0x0100U
+#define REG_SREG_HI     0x0200U
+#define REG_SAVE_LO     0x0400U
+#define REG_SAVE_HI     0x0800U
+#define REG_SP_LO       0x1000U
+#define REG_SP_HI       0x2000U
+
+
+/* Combined register defines */
+#define REG_PTR1        (REG_PTR1_LO | REG_PTR1_HI)
+#define REG_PTR2        (REG_PTR2_LO | REG_PTR2_HI)
+#define REG_SREG        (REG_SREG_LO | REG_SREG_HI)
+#define REG_SAVE        (REG_SAVE_LO | REG_SAVE_HI)
+#define REG_SP          (REG_SP_LO | REG_SP_HI)
+#define REG_AX          (REG_A | REG_X)
+#define REG_AY          (REG_A | REG_Y)
+#define REG_XY          (REG_X | REG_Y)
+#define REG_AXY         (REG_AX | REG_Y)
+#define REG_EAX         (REG_AX | REG_SREG)
+#define REG_EAXY        (REG_EAX | REG_Y)
+#define REG_ZP          0xFFF8U
+#define REG_ALL         0xFFFFU
+
+
+
+/* Zero page register info */
+typedef struct ZPInfo ZPInfo;
+struct ZPInfo {
+    unsigned char  Len;         /* Length of the following string */
+    char           Name[11];    /* Name of zero page symbol */
+    unsigned short ByteUse;     /* Register info for this symbol */
+    unsigned short WordUse;     /* Register info for 16 bit access */
+};
+
+
+
+/* Defines for the conditions in a compare */
+typedef enum {
+    CMP_INV = -1,
+    CMP_EQ,
+    CMP_NE,
+    CMP_GT,
+    CMP_GE,
+    CMP_LT,
+    CMP_LE,
+    CMP_UGT,
+    CMP_UGE,
+    CMP_ULT,
+    CMP_ULE
+} cmp_t;
 
 
 
 /*****************************************************************************/
-/*                                          Code                                    */
+/*                                   Code                                    */
 /*****************************************************************************/
 
 
 
+void GetFuncInfo (const char* Name, unsigned short* Use, unsigned short* Chg);
+/* For the given function, lookup register information and store it into
+ * the given variables. If the function is unknown, assume it will use and
+ * load all registers.
+ */
+
+const ZPInfo* GetZPInfo (const char* Name);
+/* If the given name is a zero page symbol, return a pointer to the info
+ * struct for this symbol, otherwise return NULL.
+ */
+
+unsigned GetRegInfo (struct CodeSeg* S, unsigned Index, unsigned Wanted);
+/* Determine register usage information for the instructions starting at the
+ * given index.
+ */
+
+int RegAUsed (struct CodeSeg* S, unsigned Index);
+/* Check if the value in A is used. */
+
+int RegXUsed (struct CodeSeg* S, unsigned Index);
+/* Check if the value in X is used. */
+
+int RegYUsed (struct CodeSeg* S, unsigned Index);
+/* Check if the value in Y is used. */
+
+int RegAXUsed (struct CodeSeg* S, unsigned Index);
+/* Check if the value in A or(!) the value in X are used. */
+
+int RegEAXUsed (struct CodeSeg* S, unsigned Index);
+/* Check if any of the four bytes in EAX are used. */
+
+unsigned GetKnownReg (unsigned Use, const struct RegContents* RC);
+/* Return the register or zero page location from the set in Use, thats
+ * contents are known. If Use does not contain any register, or if the
+ * register in question does not have a known value, return REG_NONE.
+ */
+
+cmp_t FindBoolCmpCond (const char* Name);
+/* Check if the given string is the name of one of the boolean transformer
+ * subroutine, and if so, return the condition that is evaluated by this
+ * routine. Return CMP_INV if the condition is not recognised.
+ */
+
+cmp_t FindTosCmpCond (const char* Name);
+/* Check if this is a call to one of the TOS compare functions (tosgtax).
+ * Return the condition code or CMP_INV on failure.
+ */
+
+
+
 /* End of codeinfo.h */
 #endif
 
 
 
+