Typo

[cc65] / src / cc65 / function.h

diff --git a/src/cc65/function.h b/src/cc65/function.h
index d56d30757645ee45b84e27ab1fcb4eb49f4f91a9..0954322ace2f0df06822034e614c9dbe11deb208 100644 (file)
--- a/src/cc65/function.h
+++ b/src/cc65/function.h
@@ -1,15 +1,15 @@
 /*****************************************************************************/
 /*                                                                           */
-/*                               function.h                                 */
+/*                                function.h                                 */
 /*                                                                           */
-/*                           Function management                            */
+/*                            Function management                            */
 /*                                                                           */
 /*                                                                           */
 /*                                                                           */
-/* (C) 1998-2006 Ullrich von Bassewitz                                       */
-/*               Römerstrasse 52                                             */
-/*               D-70794 Filderstadt                                         */
-/* EMail:        uz@cc65.org                                                 */
+/* (C) 1998-2012, Ullrich von Bassewitz                                      */
+/*                Roemerstrasse 52                                           */
+/*                D-70794 Filderstadt                                        */
+/* EMail:         uz@cc65.org                                                */
 /*                                                                           */
 /*                                                                           */
 /* This software is provided 'as-is', without any expressed or implied       */
@@ -36,13 +36,33 @@
 #ifndef FUNCTION_H
 #define FUNCTION_H
 
-
+#include "coll.h"
 
 /*****************************************************************************/
-/*                                  data                                    */
+/*                                   Data                                    */
 /*****************************************************************************/
 
 
+/* Enumeration for function flags */
+typedef enum {
+    FF_NONE             = 0x0000,
+    FF_HAS_RETURN       = 0x0001,       /* Function has a return statement */
+    FF_IS_MAIN          = 0x0002,       /* This is the main function */
+    FF_VOID_RETURN      = 0x0004,       /* Function returning void */
+} funcflags_t;
+
+/* Structure that holds all data needed for function activation */
+struct Function {
+    struct SymEntry*    FuncEntry;        /* Symbol table entry */
+    Type*               ReturnType;       /* Function return type */
+    FuncDesc*           Desc;             /* Function descriptor */
+    int                 Reserved;         /* Reserved local space */
+    unsigned            RetLab;           /* Return code label */
+    int                 TopLevelSP;       /* SP at function top level */
+    unsigned            RegOffs;          /* Register variable space offset */
+    funcflags_t         Flags;            /* Function flags */
+    Collection          LocalsBlockStack; /* Stack of blocks with local vars */
+};
 
 /* Structure that holds all data needed for function activation */
 typedef struct Function Function;
@@ -53,7 +73,7 @@ extern Function* CurrentFunc;
 
 
 /*****************************************************************************/
-/*                                  Code                                    */
+/*                                   Code                                    */
 /*****************************************************************************/
 
 
@@ -73,6 +93,15 @@ Type* F_GetReturnType (Function* F);
 int F_HasVoidReturn (const Function* F);
 /* Return true if the function does not have a return value */
 
+void F_ReturnFound (Function* F);
+/* Mark the function as having a return statement */
+
+int F_HasReturn (const Function* F);
+/* Return true if the function contains a return statement*/
+
+int F_IsMainFunc (const Function* F);
+/* Return true if this is the main function */
+
 int F_IsVariadic (const Function* F);
 /* Return true if this is a variadic function */
 
@@ -90,19 +119,24 @@ int F_GetTopLevelSP (const Function* F);
 
 int F_ReserveLocalSpace (Function* F, unsigned Size);
 /* Reserve (but don't allocate) the given local space and return the stack
- * offset.
- */
+** offset.
+*/
+
+int F_GetStackPtr (const Function* F);
+/* Return the current stack pointer including reserved (but not allocated)
+** space on the stack.
+*/
 
 void F_AllocLocalSpace (Function* F);
 /* Allocate any local space previously reserved. The function will do
- * nothing if there is no reserved local space.
- */
+** nothing if there is no reserved local space.
+*/
 
 int F_AllocRegVar (Function* F, const Type* Type);
 /* Allocate a register variable for the given variable type. If the allocation
- * was successful, return the offset of the register variable in the register
- * bank (zero page storage). If there is no register space left, return -1.
- */
+** was successful, return the offset of the register variable in the register
+** bank (zero page storage). If there is no register space left, return -1.
+*/
 
 void NewFunc (struct SymEntry* Func);
 /* Parse argument declarations and function body. */
@@ -110,7 +144,5 @@ void NewFunc (struct SymEntry* Func);
 
 
 /* End of function.h */
-#endif
-
-
 
+#endif