NeoMutt  2024-04-25-89-g194907
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 490 of file history.c.

491{
492 struct History *h = get_history(hclass);
493 if (!h)
494 return; /* disabled */
495
496 if (*str)
497 {
498 int prev = h->last - 1;
499 const short c_history = cs_subset_number(NeoMutt->sub, "history");
500 if (prev < 0)
501 prev = c_history;
502
503 /* don't add to prompt history:
504 * - lines beginning by a space
505 * - repeated lines */
506 if ((*str != ' ') && (!h->hist[prev] || !mutt_str_equal(h->hist[prev], str)))
507 {
508 const bool c_history_remove_dups = cs_subset_bool(NeoMutt->sub, "history_remove_dups");
509 if (c_history_remove_dups)
510 remove_history_dups(hclass, str);
511 const short c_save_history = cs_subset_number(NeoMutt->sub, "save_history");
512 const char *const c_history_file = cs_subset_path(NeoMutt->sub, "history_file");
513 if (save && (c_save_history != 0) && c_history_file)
514 save_history(hclass, str);
515 mutt_str_replace(&h->hist[h->last++], str);
516 if (h->last > c_history)
517 h->last = 0;
518 }
519 }
520 h->cur = h->last; /* reset to the last entry */
521}
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:366
static struct History * get_history(enum HistoryClass hclass)
Get a particular history.
Definition: history.c:112
static void save_history(enum HistoryClass hclass, const char *str)
Save one history string to a file.
Definition: history.c:321
bool mutt_str_equal(const char *a, const char *b)
Compare two strings.
Definition: string.c:660
char * mutt_str_replace(char **p, const char *s)
Replace one string with another.
Definition: string.c:280
Saved list of user-entered commands/searches.
Definition: history.c:93
short cur
Current history item.
Definition: history.c:95
short last
Last history item.
Definition: history.c:96
char ** hist
Array of history items.
Definition: history.c:94
Container for Accounts, Notifications.
Definition: neomutt.h:42
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:46
+ 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 652 of file history.c.

653{
654 struct History *h = get_history(hclass);
655 if (!h)
656 return false; /* disabled */
657
658 return h->cur == h->last;
659}
+ 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 445 of file history.c.

446{
447 if (!NeoMutt)
448 return;
449
450 const short c_history = cs_subset_number(NeoMutt->sub, "history");
451 for (enum HistoryClass hclass = HC_FIRST; hclass < HC_MAX; hclass++)
452 {
453 struct History *h = &Histories[hclass];
454 if (!h->hist)
455 continue;
456
457 /* The array has (`$history`+1) elements */
458 for (int i = 0; i <= c_history; i++)
459 {
460 FREE(&h->hist[i]);
461 }
462 FREE(&h->hist);
463 }
464}
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:102
#define HC_FIRST
Definition: history.c:85
#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 472 of file history.c.

473{
474 const short c_history = cs_subset_number(NeoMutt->sub, "history");
475 if (c_history == OldSize)
476 return;
477
478 for (enum HistoryClass hclass = HC_FIRST; hclass < HC_MAX; hclass++)
479 init_history(&Histories[hclass]);
480
481 OldSize = c_history;
482}
static int OldSize
The previous number of history entries to save.
Definition: history.c:105
static void init_history(struct History *h)
Set up a new History ring buffer.
Definition: history.c:128
+ 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 530 of file history.c.

531{
532 struct History *h = get_history(hclass);
533 if (!h)
534 return ""; /* disabled */
535
536 int next = h->cur;
537 const short c_history = cs_subset_number(NeoMutt->sub, "history");
538 do
539 {
540 next++;
541 if (next > c_history)
542 next = 0;
543 if (next == h->last)
544 break;
545 } while (!h->hist[next]);
546
547 h->cur = next;
548 return NONULL(h->hist[h->cur]);
549}
#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 558 of file history.c.

559{
560 struct History *h = get_history(hclass);
561 if (!h)
562 return ""; /* disabled */
563
564 int prev = h->cur;
565 const short c_history = cs_subset_number(NeoMutt->sub, "history");
566 do
567 {
568 prev--;
569 if (prev < 0)
570 prev = c_history;
571 if (prev == h->last)
572 break;
573 } while (!h->hist[prev]);
574
575 h->cur = prev;
576 return NONULL(h->hist[h->cur]);
577}
+ 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 600 of file history.c.

601{
602 const char *const c_history_file = cs_subset_path(NeoMutt->sub, "history_file");
603 if (!c_history_file)
604 return;
605
606 FILE *fp = mutt_file_fopen(c_history_file, "r");
607 if (!fp)
608 return;
609
610 int line = 0, hclass = 0, read = 0;
611 char *linebuf = NULL, *p = NULL;
612 size_t buflen;
613
614 const char *const c_charset = cc_charset();
615 while ((linebuf = mutt_file_read_line(linebuf, &buflen, fp, &line, MUTT_RL_NO_FLAGS)))
616 {
617 read = 0;
618 if ((sscanf(linebuf, "%d:%n", &hclass, &read) < 1) || (read == 0) ||
619 (*(p = linebuf + strlen(linebuf) - 1) != '|') || (hclass < 0))
620 {
621 mutt_error(_("%s:%d: Bad history file format"), c_history_file, line);
622 continue;
623 }
624 /* silently ignore too high class (probably newer neomutt) */
625 if (hclass >= HC_MAX)
626 continue;
627 *p = '\0';
628 p = mutt_str_dup(linebuf + read);
629 if (p)
630 {
631 mutt_ch_convert_string(&p, "utf-8", c_charset, MUTT_ICONV_NO_FLAGS);
632 mutt_hist_add(hclass, p, false);
633 FREE(&p);
634 }
635 }
636
637 mutt_file_fclose(&fp);
638 FREE(&linebuf);
639}
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:808
#define mutt_file_fclose(FP)
Definition: file.h:149
#define mutt_file_fopen(PATH, MODE)
Definition: file.h:148
#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:490
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:73
#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 586 of file history.c.

587{
588 struct History *h = get_history(hclass);
589 if (!h)
590 return; /* disabled */
591
592 h->cur = h->last;
593}
+ 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 669 of file history.c.

670{
671 struct History *h = get_history(hclass);
672 if (!h)
673 return; /* disabled */
674
675 /* Don't check if str has a value because the scratch buffer may contain
676 * an old garbage value that should be overwritten */
677 mutt_str_replace(&h->hist[h->last], str);
678}
+ 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 416 of file history.c.

417{
418 if (!search_buf || !matches)
419 return 0;
420
421 struct History *h = get_history(hclass);
422 if (!h)
423 return 0;
424
425 int match_count = 0;
426 int cur = h->last;
427 const short c_history = cs_subset_number(NeoMutt->sub, "history");
428 do
429 {
430 cur--;
431 if (cur < 0)
432 cur = c_history;
433 if (cur == h->last)
434 break;
435 if (mutt_istr_find(h->hist[cur], search_buf))
436 matches[match_count++] = h->hist[cur];
437 } while (match_count < c_history);
438
439 return match_count;
440}
const char * mutt_istr_find(const char *haystack, const char *needle)
Find first occurrence of string (ignoring case)
Definition: string.c:521
+ 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 686 of file history.c.

687{
688 const short c_history = cs_subset_number(NeoMutt->sub, "history");
689 char **matches = mutt_mem_calloc(c_history, sizeof(char *));
690 int match_count = mutt_hist_search(buf, hclass, matches);
691 if (match_count)
692 {
693 if (match_count == 1)
694 mutt_str_copy(buf, matches[0], buflen);
695 else
696 dlg_history(buf, buflen, matches, match_count);
697 }
698 FREE(&matches);
699}
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:416
void * mutt_mem_calloc(size_t nmemb, size_t size)
Allocate zeroed memory on the heap.
Definition: memory.c:51
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:581
+ Here is the call graph for this function:
+ Here is the caller graph for this function: