annotate lib/progname.c @ 12112:e375e45551a4

Fix a misleading comment.
author Bruno Haible <bruno@clisp.org>
date Sun, 04 Oct 2009 12:08:17 +0200
parents 341123ec9461
children 281617eccdf5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* Program name management.
11011
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
2 Copyright (C) 2001-2003, 2005-2009 Free Software Foundation, Inc.
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3 Written by Bruno Haible <haible@clisp.cons.org>, 2001.
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
4
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7470
diff changeset
5 This program is free software: you can redistribute it and/or modify
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7470
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7470
diff changeset
8 (at your option) any later version.
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
9
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13 GNU General Public License for more details.
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
14
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7470
diff changeset
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
17
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18
7304
1c4ed7637c24 Include <config.h> unconditionally.
Bruno Haible <bruno@clisp.org>
parents: 6259
diff changeset
19 #include <config.h>
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21 /* Specification. */
7470
7138ae14facc Make it possible to #define set_program_name to an alias.
Bruno Haible <bruno@clisp.org>
parents: 7304
diff changeset
22 #undef ENABLE_RELOCATABLE /* avoid defining set_program_name as a macro */
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23 #include "progname.h"
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24
11897
341123ec9461 progname: also set global program_invocation_name, when possible.
Jim Meyering <meyering@redhat.com>
parents: 11011
diff changeset
25 #include <errno.h> /* get program_invocation_name declaration */
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26 #include <string.h>
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29 /* String containing name the program is called with.
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 To be initialized by main(). */
5630
bff122f8ce16 Fix a link error on MacOS X.
Bruno Haible <bruno@clisp.org>
parents: 4606
diff changeset
31 const char *program_name = NULL;
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33 /* Set program_name, based on argv[0]. */
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 void
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35 set_program_name (const char *argv0)
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36 {
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
37 /* libtool creates a temporary executable whose name is sometimes prefixed
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
38 with "lt-" (depends on the platform). It also makes argv[0] absolute.
11011
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
39 But the name of the temporary executable is a detail that should not be
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
40 visible to the end user and to the test suite.
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
41 Remove this "<dirname>/.libs/" or "<dirname>/.libs/lt-" prefix here. */
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42 const char *slash;
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43 const char *base;
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
44
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45 slash = strrchr (argv0, '/');
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
46 base = (slash != NULL ? slash + 1 : argv0);
9539
97082c49805f Work around circular library issue when cross-compiling.
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
47 if (base - argv0 >= 7 && strncmp (base - 7, "/.libs/", 7) == 0)
9577
0b6c2edb43b3 Don't strip off a leading "lt-" prefix outside a .libs directory.
Bruno Haible <bruno@clisp.org>
parents: 9539
diff changeset
48 {
0b6c2edb43b3 Don't strip off a leading "lt-" prefix outside a .libs directory.
Bruno Haible <bruno@clisp.org>
parents: 9539
diff changeset
49 argv0 = base;
0b6c2edb43b3 Don't strip off a leading "lt-" prefix outside a .libs directory.
Bruno Haible <bruno@clisp.org>
parents: 9539
diff changeset
50 if (strncmp (base, "lt-", 3) == 0)
0b6c2edb43b3 Don't strip off a leading "lt-" prefix outside a .libs directory.
Bruno Haible <bruno@clisp.org>
parents: 9539
diff changeset
51 argv0 = base + 3;
0b6c2edb43b3 Don't strip off a leading "lt-" prefix outside a .libs directory.
Bruno Haible <bruno@clisp.org>
parents: 9539
diff changeset
52 }
11011
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
53
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
54 /* But don't strip off a leading <dirname>/ in general, because when the user
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
55 runs
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
56 /some/hidden/place/bin/cp foo foo
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
57 he should get the error message
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
58 /some/hidden/place/bin/cp: `foo' and `foo' are the same file
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
59 not
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
60 cp: `foo' and `foo' are the same file
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
61 */
0b99e0a3b918 Add more comments.
Bruno Haible <bruno@clisp.org>
parents: 9577
diff changeset
62
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
63 program_name = argv0;
11897
341123ec9461 progname: also set global program_invocation_name, when possible.
Jim Meyering <meyering@redhat.com>
parents: 11011
diff changeset
64
12112
e375e45551a4 Fix a misleading comment.
Bruno Haible <bruno@clisp.org>
parents: 11897
diff changeset
65 /* On glibc systems, the error() function comes from libc and uses the
e375e45551a4 Fix a misleading comment.
Bruno Haible <bruno@clisp.org>
parents: 11897
diff changeset
66 variable program_invocation_name, not program_name. So set this variable
e375e45551a4 Fix a misleading comment.
Bruno Haible <bruno@clisp.org>
parents: 11897
diff changeset
67 as well. */
11897
341123ec9461 progname: also set global program_invocation_name, when possible.
Jim Meyering <meyering@redhat.com>
parents: 11011
diff changeset
68 #if HAVE_DECL_PROGRAM_INVOCATION_NAME
341123ec9461 progname: also set global program_invocation_name, when possible.
Jim Meyering <meyering@redhat.com>
parents: 11011
diff changeset
69 program_invocation_name = (char *) argv0;
341123ec9461 progname: also set global program_invocation_name, when possible.
Jim Meyering <meyering@redhat.com>
parents: 11011
diff changeset
70 #endif
4603
fae2e3155b7a New module 'progname'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
71 }