1 /* Shared general utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
20 #ifndef COMMON_COMMON_UTILS_H
21 #define COMMON_COMMON_UTILS_H
28 /* If possible, define FUNCTION_NAME, a macro containing the name of
29 the function being defined. Since this macro may not always be
30 defined, all uses must be protected by appropriate macro definition
31 checks (Eg: "#ifdef FUNCTION_NAME").
33 Version 2.4 and later of GCC define a magical variable `__PRETTY_FUNCTION__'
34 which contains the name of the function currently being defined.
35 This is broken in G++ before version 2.6.
36 C9x has a similar variable called __func__, but prefer the GCC one since
37 it demangles C++ function names. */
38 #if (GCC_VERSION >= 2004)
39 #define FUNCTION_NAME __PRETTY_FUNCTION__
41 #if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L
42 #define FUNCTION_NAME __func__ /* ARI: func */
46 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
49 /* Like xmalloc, but zero the memory. */
50 void *xzalloc (size_t);
56 static_assert (IsFreeable
<T
>::value
, "Trying to use xfree with a non-POD \
57 data type. Use operator delete instead.");
60 free (ptr
); /* ARI: free */
64 /* Like asprintf and vasprintf, but return the string, throw an error
66 char *xstrprintf (const char *format
, ...) ATTRIBUTE_PRINTF (1, 2);
67 char *xstrvprintf (const char *format
, va_list ap
)
68 ATTRIBUTE_PRINTF (1, 0);
70 /* Like snprintf, but throw an error if the output buffer is too small. */
71 int xsnprintf (char *str
, size_t size
, const char *format
, ...)
72 ATTRIBUTE_PRINTF (3, 4);
74 /* Returns a std::string built from a printf-style format string. */
75 std::string
string_printf (const char* fmt
, ...)
76 ATTRIBUTE_PRINTF (1, 2);
78 /* Like string_printf, but takes a va_list. */
79 std::string
string_vprintf (const char* fmt
, va_list args
)
80 ATTRIBUTE_PRINTF (1, 0);
82 /* Like string_printf, but appends to DEST instead of returning a new
84 void string_appendf (std::string
&dest
, const char* fmt
, ...)
85 ATTRIBUTE_PRINTF (2, 3);
87 /* Like string_appendf, but takes a va_list. */
88 void string_vappendf (std::string
&dest
, const char* fmt
, va_list args
)
89 ATTRIBUTE_PRINTF (2, 0);
91 /* Make a copy of the string at PTR with LEN characters
92 (and add a null character at the end in the copy).
93 Uses malloc to get the space. Returns the address of the copy. */
95 char *savestring (const char *ptr
, size_t len
);
97 /* The strerror() function can return NULL for errno values that are
98 out of range. Provide a "safe" version that always returns a
101 extern char *safe_strerror (int);
103 /* Return non-zero if the start of STRING matches PATTERN, zero
107 startswith (const char *string
, const char *pattern
)
109 return strncmp (string
, pattern
, strlen (pattern
)) == 0;
112 ULONGEST
strtoulst (const char *num
, const char **trailer
, int base
);
114 /* Skip leading whitespace characters in INP, returning an updated
115 pointer. If INP is NULL, return NULL. */
117 extern char *skip_spaces (char *inp
);
119 /* A const-correct version of the above. */
121 extern const char *skip_spaces (const char *inp
);
123 /* Skip leading non-whitespace characters in INP, returning an updated
124 pointer. If INP is NULL, return NULL. */
126 extern char *skip_to_space (char *inp
);
128 /* A const-correct version of the above. */
130 extern const char *skip_to_space (const char *inp
);
132 /* Assumes that V is an argv for a program, and iterates through
133 freeing all the elements. */
134 extern void free_vector_argv (std::vector
<char *> &v
);
136 /* Given a vector of arguments ARGV, return a string equivalent to
137 joining all the arguments with a whitespace separating them. */
138 extern std::string
stringify_argv (const std::vector
<char *> &argv
);
140 /* Return true if VALUE is in [LOW, HIGH]. */
142 template <typename T
>
144 in_inclusive_range (T value
, T low
, T high
)
146 return value
>= low
&& value
<= high
;
149 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
150 power of 2). Round up/down when necessary. Examples of correct
153 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
154 write_memory (addr, value, len);
159 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
160 write_memory (sp, value, len);
162 Note that uses such as:
164 write_memory (addr, value, len);
165 addr += align_up (len, 8);
169 sp -= align_up (len, 8);
170 write_memory (sp, value, len);
172 are typically not correct as they don't ensure that the address (SP
173 or ADDR) is correctly aligned (relying on previous alignment to
174 keep things right). This is also why the methods are called
175 "align_..." instead of "round_..." as the latter reads better with
176 this incorrect coding style. */
178 extern ULONGEST
align_up (ULONGEST v
, int n
);
179 extern ULONGEST
align_down (ULONGEST v
, int n
);
181 #endif /* COMMON_COMMON_UTILS_H */
This page took 0.035818 seconds and 4 git commands to generate.