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-2001 Ullrich von Bassewitz                                       */
  10 /*               Wacholderweg 14                                             */
  11 /*               D-70597 Stuttgart                                           */
  12 /* EMail:        uz@musoftware.de                                            */
  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* GetFuncName (const Function* F);
  62 /* Return the name of the current function */
  63
  64 unsigned GetParamCount (const Function* F);
  65 /* Return the parameter count for the current function */
  66
  67 unsigned GetParamSize (const Function* F);
  68 /* Return the parameter size for the current function */
  69
  70 type* GetReturnType (Function* F);
  71 /* Get the return type for the function */
  72
  73 int HasVoidReturn (const Function* F);
  74 /* Return true if the function does not have a return value */
  75
  76 int IsVariadic (const Function* F);
  77 /* Return true if this is a variadic function */
  78
  79 unsigned GetRetLab (const Function* F);
  80 /* Return the return jump label */
  81
  82 int GetTopLevelSP (const Function* F);
  83 /* Get the value of the stack pointer on function top level */
  84
  85 int ReserveLocalSpace (Function* F, unsigned Size);
  86 /* Reserve (but don't allocate) the given local space and return the stack
  87  * offset.
  88  */
  89
  90 void AllocLocalSpace (Function* F);
  91 /* Allocate any local space previously reserved. The function will do
  92  * nothing if there is no reserved local space.
  93  */
  94
  95 void NewFunc (struct SymEntry* Func);
  96 /* Parse argument declarations and function body. */
  97
  98
  99
 100 /* End of function.h */
 101 #endif
 102
 103
 104