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"
32 /** Given an array of name, value string pairs creates a new hash
33 containing all of the pairs.
35 hTab *populateStringHash(const char **pin);
37 /** Prints elements of the set to the file, each element on new line
39 void fputStrSet(FILE *fp, set *list);
41 /** Prepend / append given strings to each item of string set. The result is in a
44 set *appendStrSet(set *list, const char *pre, const char *post);
46 /** Given a set returns a string containing all of the strings seperated
47 by spaces. The returned string is on the heap.
49 const char *joinStrSet(set *list);
51 /** Split the path string to the directory and file name (including extension) components.
52 The directory component doesn't contain trailing directory separator.
53 Returns true if the path contains the directory separator. */
54 int dbuf_splitPath(const char *path, struct dbuf_s *dir, struct dbuf_s *file);
56 /** Split the path string to the file name (including directory) and file extension components.
57 The file name component doesn't contain trailing extension separator.
58 Returns true if the path contains the extension separator. */
59 int dbuf_splitFile(const char *path, struct dbuf_s *file, struct dbuf_s *ext);
61 /** Combile directory and the file name to a path string using the DIR_SEPARATOR_CHAR.
63 void dbuf_makePath(struct dbuf_s *path, const char *dir, const char *file);
65 /** Given a file with path information in the binary files directory,
66 returns the directory component. Used for discovery of bin
67 directory of SDCC installation. Returns NULL if the path is
70 const char *getBinPath (const char *prel);
72 /** Returns true if the given path exists.
74 bool pathExists (const char *ppath);
76 void setMainValue (const char *pname, const char *pvalue);
78 void populateMainValues (const char **ppin);
80 void buildCmdLine2 (char *pbuffer, size_t len, const char *pcmd, ...);
82 /** Returns true if sz starts with the string given in key.
84 bool startsWith (const char *sz, const char *key);
86 /** Removes any newline characters from the string. Not strictly the
89 void chomp (char *sz);
92 getRuntimeVariables(void);
94 /* strncpy() with guaranteed NULL termination. */
95 char *strncpyz(char *dest, const char *src, size_t n);
97 /* like strncat() with guaranteed NULL termination
98 * The passed size should be the size of the dest buffer, not the number of
101 char *strncatz(char *dest, const char *src, size_t n);
103 /* return SDCC build number */
104 const char *getBuildNumber(void);
106 /* snprintf, by hook or by crook. */
107 size_t SDCCsnprintf(char *, size_t, const char *, ...);
109 # if defined(HAVE_VSNPRINTF)
111 // best option: we can define our own snprintf which logs errors.
112 # define SNPRINTF SDCCsnprintf
114 # elif defined(HAVE_SPRINTF)
116 // if we can't build a safe snprintf for lack of vsnprintf but there
117 // is a native snprintf, use it.
118 # define SNPRINTF snprintf
120 # elif defined(HAVE_VSPRINTF)
122 // we can at least define our own unsafe version.
123 # define SNPRINTF SDCCsnprintf
126 // We don't have a native snprintf nor the functions we need to write one.
127 # error "Need at least one of snprintf, vsnprintf, vsprintf!"
132 enum pragma_token_e { TOKEN_UNKNOWN, TOKEN_STR, TOKEN_INT, TOKEN_EOL };
134 struct pragma_token_s {
135 enum pragma_token_e type;
142 void init_pragma_token(struct pragma_token_s *token);
143 char *get_pragma_token(const char *s, struct pragma_token_s *token);
144 const char *get_pragma_string(struct pragma_token_s *token);
145 void free_pragma_token(struct pragma_token_s *token);