NeoMutt  2025-09-05-14-gb97658
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
lib.h File Reference

Read/write command history from/to a file. More...

#include <stdbool.h>
#include "functions.h"
+ Include dependency graph for lib.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  HistoryEntry
 A line in the History menu. More...
 

Enumerations

enum  HistoryClass {
  HC_EXT_COMMAND , HC_ALIAS , HC_NEO_COMMAND , HC_FILE ,
  HC_PATTERN , HC_OTHER , HC_MAILBOX , HC_MAX
}
 Type to differentiate different histories. More...
 
enum  ExpandoDataHistory { ED_HIS_MATCH = 1 , ED_HIS_NUMBER }
 Expando UIDs for History. More...
 

Functions

void mutt_hist_add (enum HistoryClass hclass, const char *str, bool save)
 Add a string to a history.
 
bool mutt_hist_at_scratch (enum HistoryClass hclass)
 Is the current History position at the 'scratch' place?
 
void mutt_hist_cleanup (void)
 Free all the history lists.
 
void mutt_hist_init (void)
 Create a set of empty History ring buffers.
 
char * mutt_hist_next (enum HistoryClass hclass)
 Get the next string in a History.
 
char * mutt_hist_prev (enum HistoryClass hclass)
 Get the previous string in a History.
 
void mutt_hist_read_file (void)
 Read the History from a file.
 
void mutt_hist_reset_state (enum HistoryClass hclass)
 Move the 'current' position to the end of the History.
 
void mutt_hist_save_scratch (enum HistoryClass hclass, const char *str)
 Save a temporary string to the History.
 
int mutt_hist_search (const char *find, enum HistoryClass hclass, struct HistoryArray *matches)
 Find matches in a history list.
 
void mutt_hist_complete (struct Buffer *buf, enum HistoryClass hclass)
 Complete a string from a history list.
 
int main_hist_observer (struct NotifyCallback *nc)
 Notification that a Config Variable has change - Implements observer_t -.
 
void dlg_history (struct Buffer *buf, struct HistoryArray *matches)
 Select an item from a history list -.
 

Detailed Description

Read/write command history from/to a file.

Authors
  • Richard Russon

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 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, see http://www.gnu.org/licenses/.

Definition in file lib.h.

Enumeration Type Documentation

◆ HistoryClass

Type to differentiate different histories.

Saved lists of recently-used:

Enumerator
HC_EXT_COMMAND 

External commands.

HC_ALIAS 

Aliases.

HC_NEO_COMMAND 

NeoMutt commands.

HC_FILE 

Files.

HC_PATTERN 

Patterns.

HC_OTHER 

Miscellaneous strings.

HC_MAILBOX 

Mailboxes.

HC_MAX 

Definition at line 51 of file lib.h.

52{
54 HC_ALIAS,
56 HC_FILE,
58 HC_OTHER,
60 HC_MAX,
61};
@ HC_FILE
Files.
Definition: lib.h:56
@ HC_EXT_COMMAND
External commands.
Definition: lib.h:53
@ HC_MAILBOX
Mailboxes.
Definition: lib.h:59
@ HC_ALIAS
Aliases.
Definition: lib.h:54
@ HC_NEO_COMMAND
NeoMutt commands.
Definition: lib.h:55
@ HC_MAX
Definition: lib.h:60
@ HC_PATTERN
Patterns.
Definition: lib.h:57
@ HC_OTHER
Miscellaneous strings.
Definition: lib.h:58

◆ ExpandoDataHistory

Expando UIDs for History.

See also
ED_HISTORY, ExpandoDomain
Enumerator
ED_HIS_MATCH 

HistoryEntry.history.

ED_HIS_NUMBER 

HistoryEntry.num.

Definition at line 77 of file lib.h.

78{
79 ED_HIS_MATCH = 1,
81};
@ ED_HIS_MATCH
HistoryEntry.history.
Definition: lib.h:79
@ ED_HIS_NUMBER
HistoryEntry.num.
Definition: lib.h:80

Function Documentation

◆ mutt_hist_add()

void mutt_hist_add ( enum HistoryClass  hclass,
const char *  str,
bool  save 
)

Add a string to a history.

Parameters
hclassHistory to add to
strString to add
saveShould the changes be saved to file immediately?

Definition at line 483 of file history.c.

484{
485 struct History *h = get_history(hclass);
486 if (!h)
487 return; /* disabled */
488
489 if (*str)
490 {
491 int prev = h->last - 1;
492 const short c_history = cs_subset_number(NeoMutt->sub, "history");
493 if (prev < 0)
494 prev = c_history;
495
496 /* don't add to prompt history:
497 * - lines beginning by a space
498 * - repeated lines */
499 if ((*str != ' ') && (!h->hist[prev] || !mutt_str_equal(h->hist[prev], str)))
500 {
501 const bool c_history_remove_dups = cs_subset_bool(NeoMutt->sub, "history_remove_dups");
502 if (c_history_remove_dups)
503 remove_history_dups(hclass, str);
504 const short c_save_history = cs_subset_number(NeoMutt->sub, "save_history");
505 const char *const c_history_file = cs_subset_path(NeoMutt->sub, "history_file");
506 if (save && (c_save_history != 0) && c_history_file)
507 save_history(hclass, str);
508 mutt_str_replace(&h->hist[h->last++], str);
509 if (h->last > c_history)
510 h->last = 0;
511 }
512 }
513 h->cur = h->last; /* reset to the last entry */
514}
short cs_subset_number(const struct ConfigSubset *sub, const char *name)
Get a number config item by name.
Definition: helpers.c:143
const char * cs_subset_path(const struct ConfigSubset *sub, const char *name)
Get a path config item by name.
Definition: helpers.c:168
bool cs_subset_bool(const struct ConfigSubset *sub, const char *name)
Get a boolean config item by name.
Definition: helpers.c:47
static void remove_history_dups(enum HistoryClass hclass, const char *str)
De-dupe the history.
Definition: history.c:356
static struct History * get_history(enum HistoryClass hclass)
Get a particular history.
Definition: history.c:111
static void save_history(enum HistoryClass hclass, const char *str)
Save one history string to a file.
Definition: history.c:318
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:659
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:281
Saved list of user-entered commands/searches.
Definition: history.c:92
short cur
Current history item.
Definition: history.c:94
short last
Last history item.
Definition: history.c:95
char ** hist
Array of history items.
Definition: history.c:93
Container for Accounts, Notifications.
Definition: neomutt.h:43
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:47
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_hist_at_scratch()

bool mutt_hist_at_scratch ( enum HistoryClass  hclass)

Is the current History position at the 'scratch' place?

Parameters
hclassHistory to use
Return values
trueHistory is at 'scratch' place

The last entry in the history is used as a 'scratch' area. It can be overwritten as the user types and edits.

To get (back) to the scratch area, call mutt_hist_next(), mutt_hist_prev() or mutt_hist_reset_state().

Definition at line 645 of file history.c.

646{
647 struct History *h = get_history(hclass);
648 if (!h)
649 return false; /* disabled */
650
651 return h->cur == h->last;
652}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_hist_cleanup()

void mutt_hist_cleanup ( void  )

Free all the history lists.

Definition at line 438 of file history.c.

439{
440 if (!NeoMutt)
441 return;
442
443 const short c_history = cs_subset_number(NeoMutt->sub, "history");
444 for (enum HistoryClass hclass = HC_FIRST; hclass < HC_MAX; hclass++)
445 {
446 struct History *h = &Histories[hclass];
447 if (!h->hist)
448 continue;
449
450 /* The array has (`$history`+1) elements */
451 for (int i = 0; i <= c_history; i++)
452 {
453 FREE(&h->hist[i]);
454 }
455 FREE(&h->hist);
456 }
457}
HistoryClass
Type to differentiate different histories.
Definition: lib.h:52
static struct History Histories[HC_MAX]
Command histories, one for each HistoryClass.
Definition: history.c:101
#define HC_FIRST
Definition: history.c:84
#define FREE(x)
Definition: memory.h:62
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_hist_init()

void mutt_hist_init ( void  )

Create a set of empty History ring buffers.

This just creates empty histories. To fill them, call mutt_hist_read_file().

Definition at line 465 of file history.c.

466{
467 const short c_history = cs_subset_number(NeoMutt->sub, "history");
468 if (c_history == OldSize)
469 return;
470
471 for (enum HistoryClass hclass = HC_FIRST; hclass < HC_MAX; hclass++)
472 init_history(&Histories[hclass]);
473
474 OldSize = c_history;
475}
static int OldSize
The previous number of history entries to save.
Definition: history.c:104
static void init_history(struct History *h)
Set up a new History ring buffer.
Definition: history.c:127
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_hist_next()

char * mutt_hist_next ( enum HistoryClass  hclass)

Get the next string in a History.

Parameters
hclassHistory to choose
Return values
ptrNext string

If there is no next string, and empty string will be returned.

Definition at line 523 of file history.c.

524{
525 struct History *h = get_history(hclass);
526 if (!h)
527 return ""; /* disabled */
528
529 int next = h->cur;
530 const short c_history = cs_subset_number(NeoMutt->sub, "history");
531 do
532 {
533 next++;
534 if (next > c_history)
535 next = 0;
536 if (next == h->last)
537 break;
538 } while (!h->hist[next]);
539
540 h->cur = next;
541 return NONULL(h->hist[h->cur]);
542}
#define NONULL(x)
Definition: string2.h:36
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_hist_prev()

char * mutt_hist_prev ( enum HistoryClass  hclass)

Get the previous string in a History.

Parameters
hclassHistory to choose
Return values
ptrPrevious string

If there is no previous string, and empty string will be returned.

Definition at line 551 of file history.c.

552{
553 struct History *h = get_history(hclass);
554 if (!h)
555 return ""; /* disabled */
556
557 int prev = h->cur;
558 const short c_history = cs_subset_number(NeoMutt->sub, "history");
559 do
560 {
561 prev--;
562 if (prev < 0)
563 prev = c_history;
564 if (prev == h->last)
565 break;
566 } while (!h->hist[prev]);
567
568 h->cur = prev;
569 return NONULL(h->hist[h->cur]);
570}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_hist_read_file()

void mutt_hist_read_file ( void  )

Read the History from a file.

The file $history_file is read and parsed into separate History ring buffers.

Definition at line 593 of file history.c.

594{
595 const char *const c_history_file = cs_subset_path(NeoMutt->sub, "history_file");
596 if (!c_history_file)
597 return;
598
599 FILE *fp = mutt_file_fopen(c_history_file, "r");
600 if (!fp)
601 return;
602
603 int line = 0, hclass = 0, read = 0;
604 char *linebuf = NULL, *p = NULL;
605 size_t buflen;
606
607 const char *const c_charset = cc_charset();
608 while ((linebuf = mutt_file_read_line(linebuf, &buflen, fp, &line, MUTT_RL_NO_FLAGS)))
609 {
610 read = 0;
611 if ((sscanf(linebuf, "%d:%n", &hclass, &read) < 1) || (read == 0) ||
612 (*(p = linebuf + strlen(linebuf) - 1) != '|') || (hclass < 0))
613 {
614 mutt_error(_("%s:%d: Bad history file format"), c_history_file, line);
615 continue;
616 }
617 /* silently ignore too high class (probably newer neomutt) */
618 if (hclass >= HC_MAX)
619 continue;
620 *p = '\0';
621 p = mutt_str_dup(linebuf + read);
622 if (p)
623 {
624 mutt_ch_convert_string(&p, "utf-8", c_charset, MUTT_ICONV_NO_FLAGS);
625 mutt_hist_add(hclass, p, false);
626 FREE(&p);
627 }
628 }
629
630 mutt_file_fclose(&fp);
631 FREE(&linebuf);
632}
const char * cc_charset(void)
Get the cached value of $charset.
Definition: config_cache.c:116
char * mutt_file_read_line(char *line, size_t *size, FILE *fp, int *line_num, ReadLineFlags flags)
Read a line from a file.
Definition: file.c:685
#define mutt_file_fclose(FP)
Definition: file.h:139
#define mutt_file_fopen(PATH, MODE)
Definition: file.h:138
#define MUTT_RL_NO_FLAGS
No flags are set.
Definition: file.h:40
#define mutt_error(...)
Definition: logging2.h:93
void mutt_hist_add(enum HistoryClass hclass, const char *str, bool save)
Add a string to a history.
Definition: history.c:483
int mutt_ch_convert_string(char **ps, const char *from, const char *to, uint8_t flags)
Convert a string between encodings.
Definition: charset.c:831
#define MUTT_ICONV_NO_FLAGS
No flags are set.
Definition: charset.h:64
#define _(a)
Definition: message.h:28
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:254
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_hist_reset_state()

void mutt_hist_reset_state ( enum HistoryClass  hclass)

Move the 'current' position to the end of the History.

Parameters
hclassHistory to reset

After calling mutt_hist_next() and mutt_hist_prev(), this function resets the current position ('cur' pointer).

Definition at line 579 of file history.c.

580{
581 struct History *h = get_history(hclass);
582 if (!h)
583 return; /* disabled */
584
585 h->cur = h->last;
586}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_hist_save_scratch()

void mutt_hist_save_scratch ( enum HistoryClass  hclass,
const char *  str 
)

Save a temporary string to the History.

Parameters
hclassHistory to alter
strString to set

Write a 'scratch' string into the History's current position. This is useful to preserver a user's edits.

Definition at line 662 of file history.c.

663{
664 struct History *h = get_history(hclass);
665 if (!h)
666 return; /* disabled */
667
668 /* Don't check if str has a value because the scratch buffer may contain
669 * an old garbage value that should be overwritten */
670 mutt_str_replace(&h->hist[h->last], str);
671}
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_hist_search()

int mutt_hist_search ( const char *  find,
enum HistoryClass  hclass,
struct HistoryArray *  matches 
)

Find matches in a history list.

Parameters
[in]findString to find
[in]hclassHistory list
[out]matchesAll the matching lines
Return values
numMatches found

Definition at line 406 of file history.c.

407{
408 if (!find || !matches)
409 return 0;
410
411 struct History *h = get_history(hclass);
412 if (!h)
413 return 0;
414
415 int cur = h->last;
416 const short c_history = cs_subset_number(NeoMutt->sub, "history");
417
418 do
419 {
420 cur--;
421 if (cur < 0)
422 cur = c_history;
423
424 if (cur == h->last)
425 break;
426
427 if (mutt_istr_find(h->hist[cur], find))
428 ARRAY_ADD(matches, h->hist[cur]);
429
430 } while (ARRAY_SIZE(matches) < c_history);
431
432 return ARRAY_SIZE(matches);
433}
#define ARRAY_ADD(head, elem)
Add an element at the end of the array.
Definition: array.h:156
#define ARRAY_SIZE(head)
The number of elements stored.
Definition: array.h:87
const char * mutt_istr_find(const char *haystack, const char *needle)
Find first occurrence of string (ignoring case)
Definition: string.c:522
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_hist_complete()

void mutt_hist_complete ( struct Buffer buf,
enum HistoryClass  hclass 
)

Complete a string from a history list.

Parameters
bufBuffer in which to save string
hclassHistory list to use

Definition at line 678 of file history.c.

679{
680 struct HistoryArray matches = ARRAY_HEAD_INITIALIZER;
681
682 int match_count = mutt_hist_search(buf_string(buf), hclass, &matches);
683 if (match_count != 0)
684 {
685 if (match_count == 1)
686 {
687 const char **pstr = ARRAY_GET(&matches, 0);
688 buf_strcpy(buf, *pstr);
689 }
690 else
691 {
692 dlg_history(buf, &matches);
693 }
694 }
695
696 ARRAY_FREE(&matches);
697}
#define ARRAY_FREE(head)
Release all memory.
Definition: array.h:204
#define ARRAY_GET(head, idx)
Return the element at index.
Definition: array.h:109
#define ARRAY_HEAD_INITIALIZER
Static initializer for arrays.
Definition: array.h:58
size_t buf_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:395
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition: buffer.h:96
void dlg_history(struct Buffer *buf, struct HistoryArray *matches)
Select an item from a history list -.
Definition: dlg_history.c:119
int mutt_hist_search(const char *find, enum HistoryClass hclass, struct HistoryArray *matches)
Find matches in a history list.
Definition: history.c:406
+ Here is the call graph for this function:
+ Here is the caller graph for this function: