1 This file is history.def, from which is created history.c.
2 It implements the builtin "history" in Bash.
4 Copyright (C) 1987, 1989, 1991 Free Software Foundation, Inc.
6 This file is part of GNU Bash, the Bourne Again SHell.
8 Bash is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
13 Bash is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License along
19 with Bash; see the file COPYING. If not, write to the Free Software
20 Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA.
25 $FUNCTION history_builtin
27 $SHORT_DOC history [-c] [-d offset] [n] or history -awrn [filename] or history -ps arg [arg...]
28 Display the history list with line numbers. Lines listed with
29 with a `*' have been modified. Argument of N says to list only
30 the last N lines. The `-c' option causes the history list to be
31 cleared by deleting all of the entries. The `-d' option deletes
32 the history entry at offset OFFSET. The `-w' option writes out the
33 current history to the history file; `-r' means to read the file and
34 append the contents to the history list instead. `-a' means
35 to append history lines from this session to the history file.
36 Argument `-n' means to read all history lines not already read
37 from the history file and append them to the history list. If
38 FILENAME is given, then that is used as the history file else
39 if $HISTFILE has a value, that is used, else ~/.bash_history.
40 If the -s option is supplied, the non-option ARGs are appended to
41 the history list as a single entry. The -p option means to perform
42 history expansion on each ARG and display the result, without storing
43 anything in the history list.
49 #include "../bashtypes.h"
51 # include <sys/file.h>
53 #include "posixstat.h"
57 #if defined (HAVE_UNISTD_H)
61 #include "../bashansi.h"
64 #include "../bashhist.h"
65 #include <readline/history.h>
66 #include "bashgetopt.h"
73 static void display_history ();
74 static void push_history ();
75 static int expand_and_print_history ();
76 static int delete_histent ();
88 history_builtin (list)
91 int flags, opt, result;
92 char *filename, *delete_arg;
96 reset_internal_getopt ();
97 while ((opt = internal_getopt (list, "acd:npsrw")) != -1)
121 delete_arg = list_optarg;
124 #if defined (BANG_HISTORY)
135 opt = flags & (AFLAG|RFLAG|WFLAG|NFLAG);
136 if (opt && opt != AFLAG && opt != RFLAG && opt != WFLAG && opt != NFLAG)
138 builtin_error ("cannot use more than one of -anrw");
139 return (EXECUTION_FAILURE);
142 /* clear the history, but allow other arguments to add to it again. */
147 return (EXECUTION_SUCCESS);
154 return (EXECUTION_SUCCESS);
156 #if defined (BANG_HISTORY)
157 else if (flags & PFLAG)
160 return (expand_and_print_history (list));
161 return (EXECUTION_SUCCESS);
164 else if (flags & DFLAG)
166 if (legal_number (delete_arg, &delete_offset) == 0)
168 builtin_error ("%s: not a valid history position", delete_arg);
169 return (EXECUTION_FAILURE);
172 if (opt < history_base || opt < 0 || opt > (history_base + history_length))
174 builtin_error ("%d: not a valid history position", opt);
175 return (EXECUTION_FAILURE);
177 result = delete_histent (opt - history_base);
178 /* Since remove_history changes history_length, this can happen if
179 we delete the last history entry. */
180 if (where_history () > history_length)
181 history_set_pos (history_length);
182 return (result ? EXECUTION_SUCCESS : EXECUTION_FAILURE);
184 else if ((flags & (AFLAG|RFLAG|NFLAG|WFLAG|CFLAG)) == 0)
186 display_history (list);
187 return (EXECUTION_SUCCESS);
190 filename = list ? list->word->word : get_string_value ("HISTFILE");
191 result = EXECUTION_SUCCESS;
193 if (flags & AFLAG) /* Append session's history to file. */
194 result = maybe_append_history (filename);
195 else if (flags & WFLAG) /* Write entire history. */
196 result = write_history (filename);
197 else if (flags & RFLAG) /* Read entire file. */
198 result = read_history (filename);
199 else if (flags & NFLAG) /* Read `new' history from file. */
201 /* Read all of the lines in the file that we haven't already read. */
203 result = read_history_range (filename, history_lines_in_file, -1);
205 history_lines_in_file = where_history ();
208 return (result ? EXECUTION_FAILURE : EXECUTION_SUCCESS);
211 /* Accessors for HIST_ENTRY lists that are called HLIST. */
212 #define histline(i) (hlist[(i)]->line)
213 #define histdata(i) (hlist[(i)]->data)
216 display_history (list)
226 limit = get_numeric_arg (list, 0);
231 hlist = history_list ();
235 for (i = 0; hlist[i]; i++)
241 if ((limited == 0) || ((i -= limit) < 0))
247 printf ("%5d%c %s\n", i + history_base,
248 histdata(i) ? '*' : ' ',
255 /* Delete and free the history list entry at offset I. */
262 discard = remove_history (i);
266 free (discard->line);
267 free ((char *) discard);
273 delete_last_history ()
276 HIST_ENTRY **hlist, *histent;
278 hlist = history_list ();
282 for (i = 0; hlist[i]; i++)
286 /* History_get () takes a parameter that must be offset by history_base. */
287 histent = history_get (history_base + i); /* Don't free this */
291 return (delete_histent (i));
294 /* Remove the last entry in the history list and add each argument in
295 LIST to the history. */
302 if (hist_last_line_added && delete_last_history () == 0)
304 s = string_list (list);
305 maybe_add_history (s); /* Obeys HISTCONTROL setting. */
309 #if defined (BANG_HISTORY)
311 expand_and_print_history (list)
317 if (hist_last_line_added && delete_last_history () == 0)
318 return EXECUTION_FAILURE;
319 result = EXECUTION_SUCCESS;
322 r = history_expand (list->word->word, &s);
325 builtin_error ("%s: history expansion failed", list->word->word);
326 result = EXECUTION_FAILURE;
339 #endif /* BANG_HISTORY */