NeoMutt  2025-09-05-55-g97fc89
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
Global Function API

Prototype for a Global Function. More...

+ Collaboration diagram for Global Function API:

Functions

static int op_check_stats (int op)
 Calculate message statistics for all mailboxes - Implements global_function_t -.
 
static int op_enter_command (int op)
 Enter a neomuttrc command - Implements global_function_t -.
 
static int op_redraw (int op)
 Clear and redraw the screen - Implements global_function_t -.
 
static int op_shell_escape (int op)
 Invoke a command in a subshell - Implements global_function_t -.
 
static int op_show_log_messages (int op)
 Show log (and debug) messages - Implements global_function_t -.
 
static int op_version (int op)
 Show the NeoMutt version number - Implements global_function_t -.
 
static int op_what_key (int op)
 display the keycode for a key press - Implements global_function_t -
 

Detailed Description

Prototype for a Global Function.

Parameters
opOperation to perform, e.g. OP_VERSION
Return values
enumFunctionRetval

Function Documentation

◆ op_check_stats()

static int op_check_stats ( int op)
static

Calculate message statistics for all mailboxes - Implements global_function_t -.

Definition at line 50 of file global.c.

51{
54 return FR_SUCCESS;
55}
@ FR_SUCCESS
Valid function - successfully performed.
Definition dispatcher.h:39
struct Mailbox * get_current_mailbox(void)
Get the current Mailbox.
Definition index.c:721
int mutt_mailbox_check(struct Mailbox *m_cur, CheckStatsFlags flags)
Check all all Mailboxes for new mail.
#define MUTT_MAILBOX_CHECK_STATS
Ignore mail_check_stats and calculate statistics (used by <check-stats>)
Definition mxapi.h:52
#define MUTT_MAILBOX_CHECK_POSTPONED
Make sure the number of postponed messages is updated.
Definition mxapi.h:51
+ Here is the call graph for this function:

◆ op_enter_command()

static int op_enter_command ( int op)
static

Enter a neomuttrc command - Implements global_function_t -.

Definition at line 60 of file global.c.

61{
63 window_redraw(NULL);
64 return FR_SUCCESS;
65}
void mutt_enter_command(void)
Enter a neomutt command.
Definition external.c:621
void window_redraw(struct MuttWindow *win)
Reflow, recalc and repaint a tree of Windows.
+ Here is the call graph for this function:

◆ op_redraw()

static int op_redraw ( int op)
static

Clear and redraw the screen - Implements global_function_t -.

Definition at line 70 of file global.c.

71{
72 clearok(stdscr, true);
75 window_redraw(NULL);
76 return FR_SUCCESS;
77}
void mutt_resize_screen(void)
Update NeoMutt's opinion about the window size.
Definition resize.c:76
void window_invalidate_all(void)
Mark all windows as in need of repaint.
+ Here is the call graph for this function:

◆ op_shell_escape()

static int op_shell_escape ( int op)
static

Invoke a command in a subshell - Implements global_function_t -.

Definition at line 82 of file global.c.

83{
85 {
86 struct Mailbox *m_cur = get_current_mailbox();
87 if (m_cur)
88 {
89 m_cur->last_checked = 0; // force a check on the next mx_mbox_check() call
91 }
92 }
93 return FR_SUCCESS;
94}
bool mutt_shell_escape(void)
Invoke a command in a subshell.
Definition external.c:579
A mailbox.
Definition mailbox.h:79
time_t last_checked
Last time we checked this mailbox for new mail.
Definition mailbox.h:105
+ Here is the call graph for this function:

◆ op_show_log_messages()

static int op_show_log_messages ( int op)
static

Show log (and debug) messages - Implements global_function_t -.

Definition at line 99 of file global.c.

100{
101 struct Buffer *tempfile = buf_pool_get();
102 buf_mktemp(tempfile);
103
104 FILE *fp = mutt_file_fopen(buf_string(tempfile), "a+");
105 if (!fp)
106 {
107 mutt_perror("fopen");
108 buf_pool_release(&tempfile);
109 return FR_ERROR;
110 }
111
112 char buf[32] = { 0 };
113 struct LogLine *ll = NULL;
114 const struct LogLineList lll = log_queue_get();
115 STAILQ_FOREACH(ll, &lll, entries)
116 {
117 mutt_date_localtime_format(buf, sizeof(buf), "%H:%M:%S", ll->time);
118 fprintf(fp, "[%s]<%c> %s", buf, LogLevelAbbr[ll->level + 3], ll->message);
119 if (ll->level <= LL_MESSAGE)
120 fputs("\n", fp);
121 }
122
123 mutt_file_fclose(&fp);
124
125 struct PagerData pdata = { 0 };
126 struct PagerView pview = { &pdata };
127
128 pdata.fname = buf_string(tempfile);
129
130 pview.banner = "messages";
132 pview.mode = PAGER_MODE_OTHER;
133
134 mutt_do_pager(&pview, NULL);
135 buf_pool_release(&tempfile);
136
137 return FR_SUCCESS;
138}
static const char * buf_string(const struct Buffer *buf)
Convert a buffer to a const char * "string".
Definition buffer.h:96
@ FR_ERROR
Valid function - error occurred.
Definition dispatcher.h:38
int mutt_do_pager(struct PagerView *pview, struct Email *e)
Display some page-able text to the user (help or attachment)
Definition do_pager.c:122
#define mutt_file_fclose(FP)
Definition file.h:139
#define mutt_file_fopen(PATH, MODE)
Definition file.h:138
#define mutt_perror(...)
Definition logging2.h:94
@ LL_MESSAGE
Log informational message.
Definition logging2.h:43
size_t mutt_date_localtime_format(char *buf, size_t buflen, const char *format, time_t t)
Format localtime.
Definition date.c:950
struct LogLineList log_queue_get(void)
Get the Log Queue.
Definition logging.c:362
const char * LogLevelAbbr
Abbreviations of logging level names.
Definition logging.c:46
#define MUTT_PAGER_LOGS
Logview mode.
Definition lib.h:72
#define MUTT_PAGER_BOTTOM
Start at the bottom.
Definition lib.h:73
@ PAGER_MODE_OTHER
Pager is invoked via 3rd path. Non-email content is likely to be shown.
Definition lib.h:140
struct Buffer * buf_pool_get(void)
Get a Buffer from the pool.
Definition pool.c:82
void buf_pool_release(struct Buffer **ptr)
Return a Buffer to the pool.
Definition pool.c:96
#define STAILQ_FOREACH(var, head, field)
Definition queue.h:390
String manipulation buffer.
Definition buffer.h:36
A Log line.
Definition logging2.h:79
char * message
Message to be logged.
Definition logging2.h:85
enum LogLevel level
Log level, e.g. LL_DEBUG1.
Definition logging2.h:84
time_t time
Timestamp of the message.
Definition logging2.h:80
Data to be displayed by PagerView.
Definition lib.h:159
const char * fname
Name of the file to read.
Definition lib.h:163
Paged view into some data.
Definition lib.h:170
struct PagerData * pdata
Data that pager displays. NOTNULL.
Definition lib.h:171
enum PagerMode mode
Pager mode.
Definition lib.h:172
PagerFlags flags
Additional settings to tweak pager's function.
Definition lib.h:173
const char * banner
Title to display in status bar.
Definition lib.h:174
#define buf_mktemp(buf)
Definition tmp.h:33
+ Here is the call graph for this function:

◆ op_version()

static int op_version ( int op)
static

Show the NeoMutt version number - Implements global_function_t -.

Definition at line 143 of file global.c.

144{
146 return FR_SUCCESS;
147}
#define mutt_message(...)
Definition logging2.h:92
const char * mutt_make_version(void)
Generate the NeoMutt version string.
Definition version.c:295
+ Here is the call graph for this function:

◆ op_what_key()

static int op_what_key ( int op)
static

display the keycode for a key press - Implements global_function_t -

Definition at line 152 of file global.c.

153{
154 mw_what_key();
155 return FR_SUCCESS;
156}
void mw_what_key(void)
Display the value of a key -.
Definition curs_lib.c:501
+ Here is the call graph for this function: