1
This file is caller.def, from which is created caller.c. It implements the
2
builtin "caller" in Bash.
4
Copyright (C) 2002-2008 Rocky Bernstein for Free Software Foundation, Inc.
5
Copyright (C) 2008-2013 Free Software Foundation, Inc.
7
This file is part of GNU Bash, the Bourne Again SHell.
9
Bash is free software: you can redistribute it and/or modify
10
it under the terms of the GNU General Public License as published by
11
the Free Software Foundation, either version 3 of the License, or
12
(at your option) any later version.
14
Bash is distributed in the hope that it will be useful,
15
but WITHOUT ANY WARRANTY; without even the implied warranty of
16
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
GNU General Public License for more details.
19
You should have received a copy of the GNU General Public License
20
along with Bash. If not, see <http://www.gnu.org/licenses/>.
25
$FUNCTION caller_builtin
27
$SHORT_DOC caller [expr]
28
Return the context of the current subroutine call.
30
Without EXPR, returns "$line $filename". With EXPR, returns
31
"$line $subroutine $filename"; this extra information can be used to
32
provide a stack trace.
34
The value of EXPR indicates how many call frames to go back before the
35
current one; the top frame is frame 0.
38
Returns 0 unless the shell is not executing a shell function or EXPR
44
#include "chartypes.h"
45
#include "bashtypes.h"
47
#if defined (HAVE_UNISTD_H)
49
# include <sys/types.h>
56
#include "../bashintl.h"
61
#include "bashgetopt.h"
63
#ifdef LOADABLE_BUILTIN
64
# include "builtins.h"
75
#if !defined (ARRAY_VARS)
77
return (EXECUTION_FAILURE);
79
SHELL_VAR *funcname_v, *bash_source_v, *bash_lineno_v;
80
ARRAY *funcname_a, *bash_source_a, *bash_lineno_a;
81
char *funcname_s, *source_s, *lineno_s;
84
GET_ARRAY_FROM_VAR ("FUNCNAME", funcname_v, funcname_a);
85
GET_ARRAY_FROM_VAR ("BASH_SOURCE", bash_source_v, bash_source_a);
86
GET_ARRAY_FROM_VAR ("BASH_LINENO", bash_lineno_v, bash_lineno_a);
88
if (bash_lineno_a == 0 || array_empty (bash_lineno_a))
89
return (EXECUTION_FAILURE);
91
if (bash_source_a == 0 || array_empty (bash_source_a))
92
return (EXECUTION_FAILURE);
94
if (no_options (list))
96
list = loptend; /* skip over possible `--' */
98
/* If there is no argument list, then give short form: line filename. */
101
lineno_s = array_reference (bash_lineno_a, 0);
102
source_s = array_reference (bash_source_a, 1);
103
printf("%s %s\n", lineno_s ? lineno_s : "NULL", source_s ? source_s : "NULL");
104
return (EXECUTION_SUCCESS);
107
if (funcname_a == 0 || array_empty (funcname_a))
108
return (EXECUTION_FAILURE);
110
if (legal_number (list->word->word, &num))
112
lineno_s = array_reference (bash_lineno_a, num);
113
source_s = array_reference (bash_source_a, num+1);
114
funcname_s = array_reference (funcname_a, num+1);
116
if (lineno_s == NULL|| source_s == NULL || funcname_s == NULL)
117
return (EXECUTION_FAILURE);
119
printf("%s %s %s\n", lineno_s, funcname_s, source_s);
123
sh_invalidnum (list->word->word);
128
return (EXECUTION_SUCCESS);
132
#ifdef LOADABLE_BUILTIN
133
static char *caller_doc[] = {
134
N_("Returns the context of the current subroutine call.\n\
136
Without EXPR, returns "$line $filename". With EXPR, returns\n\
137
"$line $subroutine $filename"; this extra information can be used to\n\
138
provide a stack trace.\n\
140
The value of EXPR indicates how many call frames to go back before the\n\
141
current one; the top frame is frame 0."),
145
struct builtin caller_struct = {
154
#endif /* LOADABLE_BUILTIN */