]> git.sur5r.net Git - cc65/blobdiff - src/cc65/codeent.h
Normalized code.
[cc65] / src / cc65 / codeent.h
index c698f7a563fe4433eceebc6e8f8c9186a52b0936..b2509863b996fd836d2542594d572d89a0216eb4 100644 (file)
@@ -1,15 +1,15 @@
 /*****************************************************************************/
 /*                                                                           */
-/*                                codeent.h                                 */
+/*                                 codeent.h                                 */
 /*                                                                           */
-/*                           Code segment entry                             */
+/*                            Code segment entry                             */
 /*                                                                           */
 /*                                                                           */
 /*                                                                           */
-/* (C) 2001     Ullrich von Bassewitz                                        */
-/*              Wacholderweg 14                                              */
-/*              D-70597 Stuttgart                                            */
-/* EMail:       uz@musoftware.de                                             */
+/* (C) 2001-2009, Ullrich von Bassewitz                                      */
+/*                Roemerstrasse 52                                           */
+/*                D-70794 Filderstadt                                        */
+/* EMail:         uz@cc65.org                                                */
 /*                                                                           */
 /*                                                                           */
 /* This software is provided 'as-is', without any expressed or implied       */
@@ -38,7 +38,7 @@
 
 
 
-#include <stdio.h>
+#include <string.h>
 
 /* common */
 #include "coll.h"
 
 
 /*****************************************************************************/
-/*                                  Data                                    */
+/*                                   Data                                    */
 /*****************************************************************************/
 
 
 
 /* Flags used */
-#define CEF_USERMARK   0x0001U         /* Generic mark by user functions */
-#define CEF_NUMARG     0x0002U         /* Insn has numerical argument */
+#define CEF_USERMARK    0x0001U         /* Generic mark by user functions */
+#define CEF_NUMARG      0x0002U         /* Insn has numerical argument */
 
 /* Code entry structure */
 typedef struct CodeEntry CodeEntry;
 struct CodeEntry {
-    opc_t              OPC;            /* Opcode */
-    am_t               AM;             /* Adressing mode */
-    char*                      Arg;            /* Argument as string */
-    unsigned long      Num;            /* Numeric argument */
-    unsigned short     Flags;          /* Flags */
-    unsigned short      Info;          /* Additional code info */
-    unsigned char      Size;           /* Estimated size */
-    unsigned char      Use;            /* Registers used */
-    unsigned char      Chg;            /* Registers changed/destroyed */
-    CodeLabel*         JumpTo;         /* Jump label */
-    Collection         Labels;         /* Labels for this instruction */
+    unsigned char       OPC;            /* Opcode */
+    unsigned char       AM;             /* Adressing mode */
+    unsigned char       Size;           /* Estimated size */
+    unsigned char       Flags;          /* Flags */
+    char*               Arg;            /* Argument as string */
+    unsigned long       Num;            /* Numeric argument */
+    unsigned short      Info;           /* Additional code info */
+    unsigned short      Use;            /* Registers used */
+    unsigned short      Chg;            /* Registers changed/destroyed */
+    CodeLabel*          JumpTo;         /* Jump label */
+    Collection          Labels;         /* Labels for this instruction */
     LineInfo*           LI;             /* Source line info for this insn */
     RegInfo*            RI;             /* Register info for this insn */
 };
@@ -83,13 +83,21 @@ struct CodeEntry {
 
 
 /*****************************************************************************/
-/*                                          Code                                    */
+/*                                   Code                                    */
 /*****************************************************************************/
 
 
 
+const char* MakeHexArg (unsigned Num);
+/* Convert Num into a string in the form $XY, suitable for passing it as an
+ * argument to NewCodeEntry, and return a pointer to the string.
+ * BEWARE: The function returns a pointer to a static buffer, so the value is
+ * gone if you call it twice (and apart from that it's not thread and signal
+ * safe).
+ */
+
 CodeEntry* NewCodeEntry (opc_t OPC, am_t AM, const char* Arg,
-                        CodeLabel* JumpTo, LineInfo* LI);
+                         CodeLabel* JumpTo, LineInfo* LI);
 /* Create a new code entry, initialize and return it */
 
 void FreeCodeEntry (CodeEntry* E);
@@ -106,6 +114,12 @@ int CodeEntriesAreEqual (const CodeEntry* E1, const CodeEntry* E2);
 void CE_AttachLabel (CodeEntry* E, CodeLabel* L);
 /* Attach the label to the entry */
 
+void CE_ClearJumpTo (CodeEntry* E);
+/* Clear the JumpTo entry and the argument (which contained the name of the
+ * label). Note: The function will not clear the backpointer from the label,
+ * so use it with care.
+ */
+
 #if defined(HAVE_INLINE)
 INLINE int CE_HasLabel (const CodeEntry* E)
 /* Check if the given code entry has labels attached */
@@ -113,7 +127,7 @@ INLINE int CE_HasLabel (const CodeEntry* E)
     return (CollCount (&E->Labels) > 0);
 }
 #else
-#  define CE_HasLabel(E)       (CollCount (&(E)->Labels) > 0)
+#  define CE_HasLabel(E)        (CollCount (&(E)->Labels) > 0)
 #endif
 
 #if defined(HAVE_INLINE)
@@ -123,7 +137,7 @@ INLINE unsigned CE_GetLabelCount (const CodeEntry* E)
     return CollCount (&E->Labels);
 }
 #else
-#  define CE_GetLabelCount(E)  CollCount (&(E)->Labels)
+#  define CE_GetLabelCount(E)   CollCount (&(E)->Labels)
 #endif
 
 #if defined(HAVE_INLINE)
@@ -133,7 +147,7 @@ INLINE CodeLabel* CE_GetLabel (CodeEntry* E, unsigned Index)
     return CollAt (&E->Labels, Index);
 }
 #else
-#  define CE_GetLabel(E, Index)        CollAt (&(E)->Labels, (Index))
+#  define CE_GetLabel(E, Index) CollAt (&(E)->Labels, (Index))
 #endif
 
 void CE_MoveLabel (CodeLabel* L, CodeEntry* E);
@@ -146,7 +160,7 @@ INLINE int CE_HasMark (const CodeEntry* E)
     return (E->Flags & CEF_USERMARK) != 0;
 }
 #else
-#  define CE_HasMark(E)        (((E)->Flags & CEF_USERMARK) != 0)
+#  define CE_HasMark(E) (((E)->Flags & CEF_USERMARK) != 0)
 #endif
 
 #if defined(HAVE_INLINE)
@@ -156,7 +170,7 @@ INLINE void CE_SetMark (CodeEntry* E)
     E->Flags |= CEF_USERMARK;
 }
 #else
-#  define CE_SetMark(E)        ((E)->Flags |= CEF_USERMARK)
+#  define CE_SetMark(E) ((E)->Flags |= CEF_USERMARK)
 #endif
 
 #if defined(HAVE_INLINE)
@@ -166,14 +180,49 @@ INLINE void CE_ResetMark (CodeEntry* E)
     E->Flags &= ~CEF_USERMARK;
 }
 #else
-#  define CE_ResetMark(E)      ((E)->Flags &= ~CEF_USERMARK)
+#  define CE_ResetMark(E)       ((E)->Flags &= ~CEF_USERMARK)
+#endif
+
+#if defined(HAVE_INLINE)
+INLINE int CE_HasNumArg (const CodeEntry* E)
+/* Return true if the instruction has a numeric argument */
+{
+    return (E->Flags & CEF_NUMARG) != 0;
+}
+#else
+#  define CE_HasNumArg(E)       (((E)->Flags & CEF_NUMARG) != 0)
 #endif
 
 void CE_SetArg (CodeEntry* E, const char* Arg);
-/* Set a new argument for the given code entry. An old string is deleted. */
+/* Replace the argument by the new one. */
 
-int CE_KnownImm (const CodeEntry* E);
-/* Return true if the argument of E is a known immediate value */
+void CE_SetNumArg (CodeEntry* E, long Num);
+/* Set a new numeric argument for the given code entry that must already
+ * have a numeric argument.
+ */
+
+int CE_IsConstImm (const CodeEntry* E);
+/* Return true if the argument of E is a constant immediate value */
+
+int CE_IsKnownImm (const CodeEntry* E, unsigned long Num);
+/* Return true if the argument of E is a constant immediate value that is
+ * equal to Num.
+ */
+
+#if defined(HAVE_INLINE)
+INLINE int CE_IsCallTo (const CodeEntry* E, const char* Name)
+/* Check if this is a call to the given function */
+{
+    return (E->OPC == OP65_JSR && strcmp (E->Arg, Name) == 0);
+}
+#else
+#  define CE_IsCallTo(E, Name) ((E)->OPC == OP65_JSR && strcmp ((E)->Arg, (Name)) == 0)
+#endif
+
+int CE_UseLoadFlags (CodeEntry* E);
+/* Return true if the instruction uses any flags that are set by a load of
+ * a register (N and Z).
+ */
 
 void CE_FreeRegInfo (CodeEntry* E);
 /* Free an existing register info struct */
@@ -183,14 +232,11 @@ void CE_GenRegInfo (CodeEntry* E, RegContents* InputRegs);
  * overwritten.
  */
 
-void CE_Output (const CodeEntry* E, FILE* F);
-/* Output the code entry to a file */
+void CE_Output (const CodeEntry* E);
+/* Output the code entry to the output file */
 
 
 
 /* End of codeent.h */
-#endif
-
-
-
 
+#endif