git.gag.com Git - fw/sdcc/blob - src/SDCCutil.h

   1 /*-------------------------------------------------------------------------
   2   SDCCutil.c - Small utility functions.
   3
   4              Written By -  Sandeep Dutta . sandeep.dutta@usa.net (1999)
   5
   6    This program is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by the
   8    Free Software Foundation; either version 2, or (at your option) any
   9    later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19
  20    In other words, you are welcome to use, share and improve this program.
  21    You are forbidden to forbid anyone else to use, share and improve
  22    what you give them.   Help stamp out software-hoarding!
  23 -------------------------------------------------------------------------*/
  24
  25 #ifndef SDCCUTIL_H
  26 #define SDCCUTIL_H
  27
  28 #include "SDCChasht.h"
  29 #include <stdarg.h>
  30
  31 /** Given an array of name, value string pairs creates a new hash
  32     containing all of the pairs.
  33 */
  34 hTab *populateStringHash(const char **pin);
  35
  36 /** Given an array of string pointers and another string, adds the
  37     string to the end of the list.  The end of the list is assumed to
  38     be the first NULL pointer.
  39 */
  40 void addToList (const char **list, const char *str);
  41
  42 /** Given an array of string pointers returns a string containing all
  43     of the strings seperated by spaces.  The returned string is on the
  44     heap.  The join stops when a NULL pointer is hit.
  45 */
  46 char *join(const char **pplist);
  47
  48 /** Given an array of string pointers, returns a string containing all
  49     of the strings seperated by spaces.  The returned string is on the
  50     heap.  n is the number of strings in the list.
  51 */
  52 char *joinn(char **pplist, int n);
  53
  54 /** Returns the characters in the path p2 past the last matching characters in
  55     p1.  Processes in a host dependent way.  For example, on win32 the
  56     test is case insensitive and treats '/' and '\' as the same.
  57 */
  58 char *getPathDifference (char *pinto, const char *p1, const char *p2);
  59
  60 /** Given a file with path information in the binary files directory,
  61     returns what PREFIX must be to get this path.  Used for discovery
  62     of where SDCC is installed.  Returns NULL if the path is
  63     impossible.
  64 */
  65 char *getPrefixFromBinPath (const char *prel);
  66
  67 /** Returns true if the given path exists.
  68  */
  69 bool pathExists (const char *ppath);
  70
  71 void setMainValue (const char *pname, const char *pvalue);
  72
  73 void populateMainValues (const char **ppin);
  74
  75 void buildCmdLine2 (char *pbuffer, const char *pcmd, size_t len);
  76
  77 /** Returns true if sz starts with the string given in key.
  78  */
  79 bool startsWith (const char *sz, const char *key);
  80
  81 /** Removes any newline characters from the string.  Not strictly the
  82     same as perl's chomp.
  83 */
  84 void chomp (char *sz);
  85
  86 hTab *
  87 getRuntimeVariables(void);
  88
  89 /* strncpy() with guaranteed NULL termination. */
  90 char *strncpyz(char *dest, const char *src, size_t n);
  91
  92 /* like strncat() with guaranteed NULL termination
  93  * The passed size should be the size of the dest buffer, not the number of
  94  * bytes to copy.
  95  */
  96 char *strncatz(char *dest, const char *src, size_t n);
  97
  98 /* snprintf, by hook or by crook. */
  99 size_t SDCCsnprintf(char *, size_t, const char *, ...);
 100
 101 # if defined(HAVE_VSNPRINTF)
 102
 103 // best option: we can define our own snprintf which logs errors.
 104 #  define SNPRINTF SDCCsnprintf
 105
 106 # elif defined(HAVE_SPRINTF)
 107
 108 // if we can't build a safe snprintf for lack of vsnprintf but there
 109 // is a native snprintf, use it.
 110 #  define SNPRINTF snprintf
 111
 112 # elif defined(HAVE_VSPRINTF)
 113
 114 // we can at least define our own unsafe version.
 115 #  define SNPRINTF SDCCsnprintf
 116
 117 # else
 118 // We don't have a native snprintf nor the functions we need to write one.
 119 #  error "Need at least one of snprintf, vsnprintf, vsprintf!"
 120 # endif
 121
 122
 123
 124 #endif
 125