NeoMutt  2024-03-23-23-gec7045
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 <stdlib.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 *search_buf, enum HistoryClass hclass, char **matches)
 Find matches in a history list.
 
void mutt_hist_complete (char *buf, size_t buflen, 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 (char *buf, size_t buflen, char **matches, int match_count)
 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 49 of file lib.h.

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

◆ ExpandoDataHistory

Expando UIDs for History.

See also
ED_HISTORY, ExpandoDomain
Enumerator
ED_HIS_MATCH 

HistoryEntry.history.

ED_HIS_NUMBER 

HistoryEntry.num.

Definition at line 75 of file lib.h.

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

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 482 of file history.c.

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

645{
646 struct History *h = get_history(hclass);
647 if (!h)
648 return false; /* disabled */
649
650 return h->cur == h->last;
651}
+ 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 437 of file history.c.

438{
439 if (!NeoMutt)
440 return;
441
442 const short c_history = cs_subset_number(NeoMutt->sub, "history");
443 for (enum HistoryClass hclass = HC_FIRST; hclass < HC_MAX; hclass++)
444 {
445 struct History *h = &Histories[hclass];
446 if (!h->hist)
447 continue;
448
449 /* The array has (`$history`+1) elements */
450 for (int i = 0; i <= c_history; i++)
451 {
452 FREE(&h->hist[i]);
453 }
454 FREE(&h->hist);
455 }
456}
HistoryClass
Type to differentiate different histories.
Definition: lib.h:50
static struct History Histories[HC_MAX]
Command histories, one for each HistoryClass.
Definition: history.c:100
#define HC_FIRST
Definition: history.c:83
#define FREE(x)
Definition: memory.h:45
+ 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 464 of file history.c.

465{
466 const short c_history = cs_subset_number(NeoMutt->sub, "history");
467 if (c_history == OldSize)
468 return;
469
470 for (enum HistoryClass hclass = HC_FIRST; hclass < HC_MAX; hclass++)
471 init_history(&Histories[hclass]);
472
473 OldSize = c_history;
474}
static int OldSize
The previous number of history entries to save.
Definition: history.c:103
static void init_history(struct History *h)
Set up a new History ring buffer.
Definition: history.c:126
+ 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 522 of file history.c.

523{
524 struct History *h = get_history(hclass);
525 if (!h)
526 return ""; /* disabled */
527
528 int next = h->cur;
529 const short c_history = cs_subset_number(NeoMutt->sub, "history");
530 do
531 {
532 next++;
533 if (next > c_history)
534 next = 0;
535 if (next == h->last)
536 break;
537 } while (!h->hist[next]);
538
539 h->cur = next;
540 return NONULL(h->hist[h->cur]);
541}
#define NONULL(x)
Definition: string2.h:37
+ 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 550 of file history.c.

551{
552 struct History *h = get_history(hclass);
553 if (!h)
554 return ""; /* disabled */
555
556 int prev = h->cur;
557 const short c_history = cs_subset_number(NeoMutt->sub, "history");
558 do
559 {
560 prev--;
561 if (prev < 0)
562 prev = c_history;
563 if (prev == h->last)
564 break;
565 } while (!h->hist[prev]);
566
567 h->cur = prev;
568 return NONULL(h->hist[h->cur]);
569}
+ 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 592 of file history.c.

593{
594 const char *const c_history_file = cs_subset_path(NeoMutt->sub, "history_file");
595 if (!c_history_file)
596 return;
597
598 FILE *fp = mutt_file_fopen(c_history_file, "r");
599 if (!fp)
600 return;
601
602 int line = 0, hclass, read;
603 char *linebuf = NULL, *p = NULL;
604 size_t buflen;
605
606 const char *const c_charset = cc_charset();
607 while ((linebuf = mutt_file_read_line(linebuf, &buflen, fp, &line, MUTT_RL_NO_FLAGS)))
608 {
609 read = 0;
610 if ((sscanf(linebuf, "%d:%n", &hclass, &read) < 1) || (read == 0) ||
611 (*(p = linebuf + strlen(linebuf) - 1) != '|') || (hclass < 0))
612 {
613 mutt_error(_("%s:%d: Bad history file format"), c_history_file, line);
614 continue;
615 }
616 /* silently ignore too high class (probably newer neomutt) */
617 if (hclass >= HC_MAX)
618 continue;
619 *p = '\0';
620 p = mutt_str_dup(linebuf + read);
621 if (p)
622 {
623 mutt_ch_convert_string(&p, "utf-8", c_charset, MUTT_ICONV_NO_FLAGS);
624 mutt_hist_add(hclass, p, false);
625 FREE(&p);
626 }
627 }
628
629 mutt_file_fclose(&fp);
630 FREE(&linebuf);
631}
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:801
#define mutt_file_fclose(FP)
Definition: file.h:148
#define mutt_file_fopen(PATH, MODE)
Definition: file.h:147
#define MUTT_RL_NO_FLAGS
No flags are set.
Definition: file.h:40
#define mutt_error(...)
Definition: logging2.h:92
void mutt_hist_add(enum HistoryClass hclass, const char *str, bool save)
Add a string to a history.
Definition: history.c:482
int mutt_ch_convert_string(char **ps, const char *from, const char *to, uint8_t flags)
Convert a string between encodings.
Definition: charset.c:830
#define MUTT_ICONV_NO_FLAGS
No flags are set.
Definition: charset.h:72
#define _(a)
Definition: message.h:28
char * mutt_str_dup(const char *str)
Copy a string, safely.
Definition: string.c:253
+ 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 578 of file history.c.

579{
580 struct History *h = get_history(hclass);
581 if (!h)
582 return; /* disabled */
583
584 h->cur = h->last;
585}
+ 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 661 of file history.c.

662{
663 struct History *h = get_history(hclass);
664 if (!h)
665 return; /* disabled */
666
667 /* Don't check if str has a value because the scratch buffer may contain
668 * an old garbage value that should be overwritten */
669 mutt_str_replace(&h->hist[h->last], str);
670}
+ 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 *  search_buf,
enum HistoryClass  hclass,
char **  matches 
)

Find matches in a history list.

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

Definition at line 408 of file history.c.

409{
410 if (!search_buf || !matches)
411 return 0;
412
413 struct History *h = get_history(hclass);
414 if (!h)
415 return 0;
416
417 int match_count = 0;
418 int cur = h->last;
419 const short c_history = cs_subset_number(NeoMutt->sub, "history");
420 do
421 {
422 cur--;
423 if (cur < 0)
424 cur = c_history;
425 if (cur == h->last)
426 break;
427 if (mutt_istr_find(h->hist[cur], search_buf))
428 matches[match_count++] = h->hist[cur];
429 } while (match_count < c_history);
430
431 return match_count;
432}
const char * mutt_istr_find(const char *haystack, const char *needle)
Find first occurrence of string (ignoring case)
Definition: string.c:570
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_hist_complete()

void mutt_hist_complete ( char *  buf,
size_t  buflen,
enum HistoryClass  hclass 
)

Complete a string from a history list.

Parameters
bufBuffer in which to save string
buflenBuffer length
hclassHistory list to use

Definition at line 678 of file history.c.

679{
680 const short c_history = cs_subset_number(NeoMutt->sub, "history");
681 char **matches = mutt_mem_calloc(c_history, sizeof(char *));
682 int match_count = mutt_hist_search(buf, hclass, matches);
683 if (match_count)
684 {
685 if (match_count == 1)
686 mutt_str_copy(buf, matches[0], buflen);
687 else
688 dlg_history(buf, buflen, matches, match_count);
689 }
690 FREE(&matches);
691}
void dlg_history(char *buf, size_t buflen, char **matches, int match_count)
Select an item from a history list -.
Definition: dlg_history.c:139
int mutt_hist_search(const char *search_buf, enum HistoryClass hclass, char **matches)
Find matches in a history list.
Definition: history.c:408
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:50
size_t mutt_str_copy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:630
+ Here is the call graph for this function:
+ Here is the caller graph for this function: