Commit | Line | Data |
---|---|---|
d26e3629 KY |
1 | /* Shared general utility routines for GDB, the GNU debugger. |
2 | ||
61baf725 | 3 | Copyright (C) 1986-2017 Free Software Foundation, Inc. |
d26e3629 KY |
4 | |
5 | This file is part of GDB. | |
6 | ||
7 | This program is free software; you can redistribute it and/or modify | |
8 | it under the terms of the GNU General Public License as published by | |
9 | the Free Software Foundation; either version 3 of the License, or | |
10 | (at your option) any later version. | |
11 | ||
12 | This program is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
18 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ | |
19 | ||
20 | #ifndef COMMON_UTILS_H | |
21 | #define COMMON_UTILS_H | |
22 | ||
d4081a38 | 23 | #include <string> |
7c5ded6a | 24 | #include <vector> |
d4081a38 | 25 | |
3a80edfc JB |
26 | /* If possible, define FUNCTION_NAME, a macro containing the name of |
27 | the function being defined. Since this macro may not always be | |
28 | defined, all uses must be protected by appropriate macro definition | |
29 | checks (Eg: "#ifdef FUNCTION_NAME"). | |
30 | ||
31 | Version 2.4 and later of GCC define a magical variable `__PRETTY_FUNCTION__' | |
df049a58 DE |
32 | which contains the name of the function currently being defined. |
33 | This is broken in G++ before version 2.6. | |
34 | C9x has a similar variable called __func__, but prefer the GCC one since | |
35 | it demangles C++ function names. */ | |
36 | #if (GCC_VERSION >= 2004) | |
37 | #define FUNCTION_NAME __PRETTY_FUNCTION__ | |
38 | #else | |
39 | #if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L | |
46bbb3ed | 40 | #define FUNCTION_NAME __func__ /* ARI: func */ |
df049a58 DE |
41 | #endif |
42 | #endif | |
43 | ||
d26e3629 KY |
44 | /* xmalloc(), xrealloc() and xcalloc() have already been declared in |
45 | "libiberty.h". */ | |
46 | ||
47 | /* Like xmalloc, but zero the memory. */ | |
48 | void *xzalloc (size_t); | |
49 | ||
50 | void xfree (void *); | |
51 | ||
52 | /* Like asprintf and vasprintf, but return the string, throw an error | |
53 | if no memory. */ | |
54 | char *xstrprintf (const char *format, ...) ATTRIBUTE_PRINTF (1, 2); | |
55 | char *xstrvprintf (const char *format, va_list ap) | |
56 | ATTRIBUTE_PRINTF (1, 0); | |
57 | ||
d26e3629 KY |
58 | /* Like snprintf, but throw an error if the output buffer is too small. */ |
59 | int xsnprintf (char *str, size_t size, const char *format, ...) | |
60 | ATTRIBUTE_PRINTF (3, 4); | |
61 | ||
d4081a38 PA |
62 | /* Returns a std::string built from a printf-style format string. */ |
63 | std::string string_printf (const char* fmt, ...) | |
64 | ATTRIBUTE_PRINTF (1, 2); | |
65 | ||
baea0dae PA |
66 | /* Make a copy of the string at PTR with LEN characters |
67 | (and add a null character at the end in the copy). | |
68 | Uses malloc to get the space. Returns the address of the copy. */ | |
69 | ||
70 | char *savestring (const char *ptr, size_t len); | |
71 | ||
fb23d554 SDJ |
72 | /* The strerror() function can return NULL for errno values that are |
73 | out of range. Provide a "safe" version that always returns a | |
74 | printable string. */ | |
75 | ||
76 | extern char *safe_strerror (int); | |
77 | ||
61012eef GB |
78 | /* Return non-zero if the start of STRING matches PATTERN, zero |
79 | otherwise. */ | |
80 | ||
81 | static inline int | |
82 | startswith (const char *string, const char *pattern) | |
83 | { | |
84 | return strncmp (string, pattern, strlen (pattern)) == 0; | |
85 | } | |
86 | ||
03aef70f JK |
87 | ULONGEST strtoulst (const char *num, const char **trailer, int base); |
88 | ||
89 | /* Skip leading whitespace characters in INP, returning an updated | |
90 | pointer. If INP is NULL, return NULL. */ | |
91 | ||
92 | extern char *skip_spaces (char *inp); | |
93 | ||
94 | /* A const-correct version of the above. */ | |
95 | ||
96 | extern const char *skip_spaces_const (const char *inp); | |
97 | ||
98 | /* Skip leading non-whitespace characters in INP, returning an updated | |
99 | pointer. If INP is NULL, return NULL. */ | |
100 | ||
101 | #define skip_to_space(INP) ((char *) skip_to_space_const (INP)) | |
102 | ||
103 | /* A const-correct version of the above. */ | |
104 | ||
105 | extern const char *skip_to_space_const (const char *inp); | |
106 | ||
7c5ded6a SDJ |
107 | /* Assumes that V is an argv for a program, and iterates through |
108 | freeing all the elements. */ | |
109 | extern void free_vector_argv (std::vector<char *> &v); | |
110 | ||
2090129c SDJ |
111 | /* Given a vector of arguments ARGV, return a string equivalent to |
112 | joining all the arguments with a whitespace separating them. */ | |
113 | extern std::string stringify_argv (const std::vector<char *> &argv); | |
114 | ||
d26e3629 | 115 | #endif |