blob: 13d87cd001437d873e3771246bc88da09ee85add [file] [log] [blame]
/* Program name management.
Copyright (C) 2001-2003 Free Software Foundation, Inc.
Written by Bruno Haible <>, 2001.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
#ifndef _PROGNAME_H
#define _PROGNAME_H
#include <stdbool.h>
/* This file supports selectively prefixing or nor prefixing error messages
with the program name.
Programs using this file should do the following in main():
set_program_name (argv[0]);
error_print_progname = maybe_print_progname;
/* String containing name the program is called with. */
extern const char *program_name;
/* Set program_name, based on argv[0]. */
extern void set_program_name (const char *argv0);
/* Set program_name, based on argv[0], and original installation prefix and
directory, for relocatability. */
extern void set_program_name_and_installdir (const char *argv0,
const char *orig_installprefix,
const char *orig_installdir);
#define set_program_name(ARG0) \
set_program_name_and_installdir (ARG0, INSTALLPREFIX, INSTALLDIR)
/* Return the full pathname of the current executable, based on the earlier
call to set_program_name_and_installdir. Return NULL if unknown. */
extern char *get_full_program_name (void);
/* Indicates whether errors and warnings get prefixed with program_name.
Default is true.
A reason to omit the prefix is for better interoperability with Emacs'
compile.el. */
extern bool error_with_progname;
/* Print program_name prefix on stderr if and only if error_with_progname
is true. */
extern void maybe_print_progname (void);
#endif /* _PROGNAME_H */