2 * CDE - Common Desktop Environment
4 * Copyright (c) 1993-2012, The Open Group. All rights reserved.
6 * These libraries and programs are free software; you can
7 * redistribute them and/or modify them under the terms of the GNU
8 * Lesser General Public License as published by the Free Software
9 * Foundation; either version 2 of the License, or (at your option)
12 * These libraries and programs are distributed in the hope that
13 * they will be useful, but WITHOUT ANY WARRANTY; without even the
14 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU Lesser General Public License for more
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with these libraries and programs; if not, write
20 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
21 * Floor, Boston, MA 02110-1301 USA
25 * $XConsortium: util.h /main/4 1995/11/06 18:52:47 rswiston $
27 * @(#)util.h 1.39 14 Feb 1994 cde_app_builder/src/libAButil
29 * RESTRICTED CONFIDENTIAL INFORMATION:
31 * The information in this document is subject to special
32 * restrictions in a confidential disclosure agreement between
33 * HP, IBM, Sun, USL, SCO and Univel. Do not distribute this
34 * document outside HP, IBM, Sun, USL, SCO, or Univel without
35 * Sun's specific written approval. This document and all copies
36 * and derivative works thereof must be returned or destroyed at
39 * Copyright 1993 Sun Microsystems, Inc. All rights reserved.
44 * util.h - general utilities
50 #define _POSIX_SOURCE 1 /* we want to be POSIX-compliant */
53 #include <sys/types.h>
57 #include <ab_private/AB.h>
58 #include <ab/util_types.h>
59 #include <ab_private/util_err.h>
62 * <string.h> seems to have a problem cc -Xc is continually complaining
70 extern char *strdup(const char *);
89 AB_OS_TYPE_NUM_VALUES /* must be last */
93 typedef int UTIL_OUTPUT_HANDLER(STRING error_message);
94 typedef UTIL_OUTPUT_HANDLER *UtilOutputHandler;
96 extern const STRING Util_null_string; /* "(nil)" */
97 extern const STRING Util_empty_string; /* "" */
98 extern int utilP_verbosityPriv3602759317; /* private! */
103 int util_init(int *argc_in_out, STRING **argv_in_out);
108 #define util_free(ptr) {if ((ptr) != NULL) {free(ptr); (ptr)= NULL;}}
109 #define util_malloc(size) (malloc(size))
115 int util_putenv(STRING string);
116 #define util_min(a,b) (((a) < (b))? (a):(b))
117 #define util_max(a,b) (((a) > (b))? (a):(b))
118 #define util_xor(a,b) ( (((a)?1:0) + ((b)?1:0)) == 1 ) /* logical xor */
119 int util_set_program_name(STRING this_prog_name);
120 STRING util_get_program_name(void);
121 int util_set_program_name_from_argv0(STRING argv0);
122 AB_OS_TYPE util_get_os_type(void);
123 STRING util_os_type_to_string(AB_OS_TYPE);
124 STRING util_os_type_to_ident(AB_OS_TYPE);
130 * If verbosity is >= 3, debugging is turned on.
131 * verbosity < 3 => debugging level 0
132 * verbosity 3 => debugging level 1
133 * verbosity 4 => debugging level 2
136 int util_set_verbosity(int verbosity);
137 int util_get_verbosity(void);
138 BOOL util_be_silent(void);
139 BOOL util_be_verbose(void);
140 int util_get_debug_level(void);
141 int debug_level(void); /* these are special-case shortcuts that */
142 BOOL debugging(); /* don't conform to the naming convention */
148 * util_puts_err() and util_printf_err() should be used for messages
149 * that absolutely must be seen by the user (this should cause a popup
150 * to appear, when ab is running).
152 * util_puts() and util_printf() should be used for informative messages,
153 * and may or may not actually be presented to the user.
155 * util_dputs() and util_dprintf() should be used for debugging messages.
156 * Their first parameter is the debugging level at which the message should
157 * be printed. (verbosity 3 = debug level 1). If debugging is disabled
158 * (e.g., verbosity < 3), these functions never generate output.
160 * To redirect the error output, use util_set_err_output_handler. ALL error
161 * output will then be sent to that error handler. A value of NULL sends
162 * error messages to stderr (which is the startup default). This is normally
163 * used to add an error handler that will pop up an error dialog when
164 * running in a windowed application.
166 * util_set_output_handler() works similarly to the error handler.
168 int util_set_err_output_handler(UtilOutputHandler);
169 int util_set_output_handler(UtilOutputHandler);
170 int util_puts(STRING msg);
171 int util_puts_err(STRING msg);
172 int util_printf(STRING fmt, ...);
173 int util_printf_err(STRING fmt, ...);
174 void util_set_help_data(STRING help, STRING vol, STRING locID);
175 int util_get_help_data(STRING *help, STRING *vol, STRING *locID);
177 /* print output if debugging level >= specified */
178 int util_dputs(int debug_level, STRING msg);
179 int util_dprintf(int debug_level, STRING fmt, ...);
184 #define util_fopen fopen /* for consistency */
185 int util_unbuffer_file(FILE *fp); /* for debugging - removes all */
186 /* buffer from the stream */
187 BOOL util_file_is_regular_file(STRING filename);
188 BOOL util_file_is_directory(STRING filename);
189 BOOL util_directory_exists(STRING dirName);
190 BOOL util_file_exists(STRING fileName);
191 long util_file_size(STRING fileName); /* error if file don't exist */
192 BOOL util_paths_are_same_file(STRING path1, STRING path2);
193 int util_fdtruncate(int fildes, off_t length); /* truncate open file*/
194 int util_ftruncate(FILE *file, off_t length, const char *accessType);
207 FILE *util_fopen_locked(const char *filename, const char *type);
209 BOOL util_file_name_has_extension(STRING file_name, STRING ext);
210 BOOL util_file_name_has_ab_extension(STRING file_name);
211 BOOL util_file_name_is_bil_encapsulated(STRING file_name);
212 BOOL util_file_name_is_bil_module(STRING file_name);
213 BOOL util_file_name_is_bil_proj(STRING file_name);
214 FILE* util_create_tmp_file(char *data);
216 int util_cvt_path_to_relative( /* NULL from = cwd */
225 * THE UTIL STRING FUNCTIONS *ALWAYS* NULL-TERMINATE ANY RETURNED STRINGS!
227 * Note: len = length of string withOUT terminating 0
228 * size = size of string including terminating 0 ( = len+1 )
230 BOOL util_streq(STRING s1, STRING s2); /* True if strings = */
231 BOOL util_strcmp(STRING s1, STRING s2); /* allows NULL strings */
232 STRING util_strsafe(STRING s); /*returns "(nil)" for NULL strs*/
233 BOOL util_strempty(STRING s); /* looks for NULL AND "" */
234 int util_strncpy(STRING to, STRING from, int to_size);
235 int util_strcvt_to_lower(STRING to, STRING from, int to_size);
236 int util_strcasestr(STRING str, STRING substr);
237 int util_strncasecmp(STRING s1, STRING s2, int max_chars);
238 STRING util_strip_white_space(STRING string);
241 STRING util_get_file_name_from_path(
247 STRING util_get_dir_name_from_path(
257 BOOL util_path_is_absolute(
261 int util_derive_name_from_path(
274 pid_t util_vfork(void); /* lightweight fork() */
280 STRING util_cvt_bool_to_string(BOOL bool_value, STRING buf, int buf_size);
284 /*************************************************************************
286 ** Inline implementation **
288 *************************************************************************/
290 /* check 1st chars before calling strcmp - avoids a lot of calls */
291 #define util_streq(s1,s2) \
293 || (((s1) != NULL) && ((s2) != NULL) && (((s1)[0] == (s2)[0]) && (strcmp(s1,s2) == 0))) \
297 * allows compare of null strings (NULL < "")
299 #define util_strcmp(s1,s2) \
314 #define util_strlen(s) ((s) == NULL? 0:strlen(s))
316 #define util_strsafe(s) ((s) == NULL? Util_null_string:(s))
318 #define util_strempty(s) (s == NULL || (strcmp(s, "") == 0))
323 #define util_get_verbosity() (utilP_verbosityPriv3602759317)
324 #define util_be_silent() (util_get_verbosity() < 1)
325 #define util_be_verbose() (util_get_verbosity() > 1)
326 #define util_get_debug_level() (util_max(0, util_get_verbosity() - 2))
327 #define debug_level() ((int)(util_get_debug_level()))
328 #define debugging() ((BOOL)(debug_level() > 0))
331 * We key on DEBUG here, so that if DEBUG is turned off, these macros
332 * evaluate to constants. That should allow the compiler to remove
333 * sections of code that are executed conditionally based on these
337 #undef util_get_debug_level
338 #define util_get_debug_level() (0)
340 #define debug_level() (0)
342 #define debugging() (FALSE)
345 #define util_fclose(fp) ((fp) == NULL? 0:(util_funlock(fp, 0, 0), fclose(fp), (fp)= NULL, 0))
348 * These functions are obsolete. Here for backwards compatibility
350 #define util_error(s) util_puts_err(s)
352 #endif /* _AB_ABUTIL_H_ */