1 /*-------------------------------------------------------------------------
2 SDCCutil.c - Small utility functions.
4 Written By - Sandeep Dutta . sandeep.dutta@usa.net (1999)
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
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.
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.
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 -------------------------------------------------------------------------*/
28 #include "SDCChasht.h"
31 /** Given an array of name, value string pairs creates a new hash
32 containing all of the pairs.
34 hTab *populateStringHash(const char **pin);
36 /** Prints elements of the set to the file, each element on new line
38 void fputStrSet(FILE *fp, set *list);
40 /** Prepend / append given strings to each item of string set. The result is in a
43 set *appendStrSet(set *list, const char *pre, const char *post);
45 /** Given a set returns a string containing all of the strings seperated
46 by spaces. The returned string is on the heap.
48 const char *joinStrSet(set *list);
50 /** Given a file with path information in the binary files directory,
51 returns the directory component. Used for discovery of bin
52 directory of SDCC installation. Returns NULL if the path is
55 char *getBinPath (const char *prel);
57 /** Returns true if the given path exists.
59 bool pathExists (const char *ppath);
61 void setMainValue (const char *pname, const char *pvalue);
63 void populateMainValues (const char **ppin);
65 void buildCmdLine2 (char *pbuffer, size_t len, const char *pcmd, ...);
67 /** Returns true if sz starts with the string given in key.
69 bool startsWith (const char *sz, const char *key);
71 /** Removes any newline characters from the string. Not strictly the
74 void chomp (char *sz);
77 getRuntimeVariables(void);
79 /* strncpy() with guaranteed NULL termination. */
80 char *strncpyz(char *dest, const char *src, size_t n);
82 /* like strncat() with guaranteed NULL termination
83 * The passed size should be the size of the dest buffer, not the number of
86 char *strncatz(char *dest, const char *src, size_t n);
88 /* snprintf, by hook or by crook. */
89 size_t SDCCsnprintf(char *, size_t, const char *, ...);
91 # if defined(HAVE_VSNPRINTF)
93 // best option: we can define our own snprintf which logs errors.
94 # define SNPRINTF SDCCsnprintf
96 # elif defined(HAVE_SPRINTF)
98 // if we can't build a safe snprintf for lack of vsnprintf but there
99 // is a native snprintf, use it.
100 # define SNPRINTF snprintf
102 # elif defined(HAVE_VSPRINTF)
104 // we can at least define our own unsafe version.
105 # define SNPRINTF SDCCsnprintf
108 // We don't have a native snprintf nor the functions we need to write one.
109 # error "Need at least one of snprintf, vsnprintf, vsprintf!"