New module 'progname'.
[gnulib.git] / lib / progname.h
1 /* Program name management.
2    Copyright (C) 2001-2003 Free Software Foundation, Inc.
3    Written by Bruno Haible <haible@clisp.cons.org>, 2001.
4
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 2, or (at your option)
8    any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software Foundation,
17    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
18
19 #ifndef _PROGNAME_H
20 #define _PROGNAME_H
21
22 #include <stdbool.h>
23
24 /* This file supports selectively prefixing or nor prefixing error messages
25    with the program name.
26
27    Programs using this file should do the following in main():
28      set_program_name (argv[0]);
29      error_print_progname = maybe_print_progname;
30  */
31
32 /* String containing name the program is called with.  */
33 extern const char *program_name;
34
35 /* Set program_name, based on argv[0].  */
36 extern void set_program_name (const char *argv0);
37
38 #if ENABLE_RELOCATABLE
39
40 /* Set program_name, based on argv[0], and original installation prefix and
41    directory, for relocatability.  */
42 extern void set_program_name_and_installdir (const char *argv0,
43                                              const char *orig_installprefix,
44                                              const char *orig_installdir);
45 #define set_program_name(ARG0) \
46   set_program_name_and_installdir (ARG0, INSTALLPREFIX, INSTALLDIR)
47
48 /* Return the full pathname of the current executable, based on the earlier
49    call to set_program_name_and_installdir.  Return NULL if unknown.  */
50 extern char *get_full_program_name (void);
51
52 #endif
53
54 #endif /* _PROGNAME_H */