git.sur5r.net Git - cc65/blob - src/cc65/function.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                function.h                                 */
   4 /*                                                                           */
   5 /*                            Function management                            */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2012, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 52                                           */
  11 /*                D-70794 Filderstadt                                        */
  12 /* EMail:         uz@cc65.org                                                */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef FUNCTION_H
  37 #define FUNCTION_H
  38
  39
  40
  41 /*****************************************************************************/
  42 /*                                   data                                    */
  43 /*****************************************************************************/
  44
  45
  46
  47 /* Structure that holds all data needed for function activation */
  48 typedef struct Function Function;
  49
  50 /* Function activation data for current function (or NULL) */
  51 extern Function* CurrentFunc;
  52
  53
  54
  55 /*****************************************************************************/
  56 /*                                   Code                                    */
  57 /*****************************************************************************/
  58
  59
  60
  61 const char* F_GetFuncName (const Function* F);
  62 /* Return the name of the current function */
  63
  64 unsigned F_GetParamCount (const Function* F);
  65 /* Return the parameter count for the current function */
  66
  67 unsigned F_GetParamSize (const Function* F);
  68 /* Return the parameter size for the current function */
  69
  70 Type* F_GetReturnType (Function* F);
  71 /* Get the return type for the function */
  72
  73 int F_HasVoidReturn (const Function* F);
  74 /* Return true if the function does not have a return value */
  75
  76 void F_ReturnFound (Function* F);
  77 /* Mark the function as having a return statement */
  78
  79 int F_HasReturn (const Function* F);
  80 /* Return true if the function contains a return statement*/
  81
  82 int F_IsMainFunc (const Function* F);
  83 /* Return true if this is the main function */
  84
  85 int F_IsVariadic (const Function* F);
  86 /* Return true if this is a variadic function */
  87
  88 int F_IsOldStyle (const Function* F);
  89 /* Return true if this is an old style (K&R) function */
  90
  91 int F_HasOldStyleIntRet (const Function* F);
  92 /* Return true if this is an old style (K&R) function with an implicit int return */
  93
  94 unsigned F_GetRetLab (const Function* F);
  95 /* Return the return jump label */
  96
  97 int F_GetTopLevelSP (const Function* F);
  98 /* Get the value of the stack pointer on function top level */
  99
 100 int F_ReserveLocalSpace (Function* F, unsigned Size);
 101 /* Reserve (but don't allocate) the given local space and return the stack
 102  * offset.
 103  */
 104
 105 int F_GetStackPtr (const Function* F);
 106 /* Return the current stack pointer including reserved (but not allocated)
 107  * space on the stack.
 108  */
 109
 110 void F_AllocLocalSpace (Function* F);
 111 /* Allocate any local space previously reserved. The function will do
 112  * nothing if there is no reserved local space.
 113  */
 114
 115 int F_AllocRegVar (Function* F, const Type* Type);
 116 /* Allocate a register variable for the given variable type. If the allocation
 117  * was successful, return the offset of the register variable in the register
 118  * bank (zero page storage). If there is no register space left, return -1.
 119  */
 120
 121 void NewFunc (struct SymEntry* Func);
 122 /* Parse argument declarations and function body. */
 123
 124
 125
 126 /* End of function.h */
 127 #endif
 128
 129
 130