NeoMutt  2022-04-29-247-gc6aae8
Teaching an old dog new tricks
DOXYGEN
opcodes.h File Reference

All user-callable functions. More...

#include "config.h"
#include "mutt/lib.h"
+ Include dependency graph for opcodes.h:

Go to the source code of this file.

Macros

#define OP_TIMEOUT   -2
 
#define OP_ABORT   -1
 
#define OPS_ATTACHMENT(_fmt)
 
#define OPS_AUTOCRYPT(_fmt)
 
#define OPS_CORE(_fmt)
 
#define OPS_CRYPT(_fmt)
 
#define OPS_ENVELOPE(_fmt)
 
#define OPS_MIX(_fmt)
 
#define OPS_NOTMUCH(_fmt)
 
#define OPS_PGP(_fmt)
 
#define OPS_SIDEBAR(_fmt)
 
#define OPS_SMIME(_fmt)    _fmt(OP_COMPOSE_SMIME_MENU, N_("show S/MIME options")) \
 
#define OPS(_fmt)
 
#define DEFINE_OPS(opcode, help_string)   opcode,
 

Enumerations

enum  MuttOps { OP_MAX }
 All NeoMutt Opcodes. More...
 

Functions

const char * opcodes_get_description (int op)
 Get the description of an opcode. More...
 
const char * opcodes_get_name (int op)
 Get the name of an opcode. More...
 

Detailed Description

All user-callable functions.

Authors
  • Damien Riegel

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 opcodes.h.

Macro Definition Documentation

◆ OP_TIMEOUT

#define OP_TIMEOUT   -2

Definition at line 32 of file opcodes.h.

◆ OP_ABORT

#define OP_ABORT   -1

Definition at line 33 of file opcodes.h.

◆ OPS_ATTACHMENT

#define OPS_ATTACHMENT (   _fmt)

Definition at line 36 of file opcodes.h.

◆ OPS_AUTOCRYPT

#define OPS_AUTOCRYPT (   _fmt)
Value:
_fmt(OP_AUTOCRYPT_ACCT_MENU, N_("manage autocrypt accounts")) \
_fmt(OP_AUTOCRYPT_CREATE_ACCT, N_("create a new autocrypt account")) \
_fmt(OP_AUTOCRYPT_DELETE_ACCT, N_("delete the current account")) \
_fmt(OP_AUTOCRYPT_TOGGLE_ACTIVE, N_("toggle the current account active/inactive")) \
_fmt(OP_AUTOCRYPT_TOGGLE_PREFER, N_("toggle the current account prefer-encrypt flag")) \
_fmt(OP_COMPOSE_AUTOCRYPT_MENU, N_("show autocrypt compose menu options"))
#define N_(a)
Definition: message.h:32

Definition at line 73 of file opcodes.h.

◆ OPS_CORE

#define OPS_CORE (   _fmt)

Definition at line 84 of file opcodes.h.

◆ OPS_CRYPT

#define OPS_CRYPT (   _fmt)
Value:
_fmt(OP_DECRYPT_COPY, N_("make decrypted copy")) \
_fmt(OP_DECRYPT_SAVE, N_("make decrypted copy and delete")) \
_fmt(OP_EXTRACT_KEYS, N_("extract supported public keys")) \
_fmt(OP_FORGET_PASSPHRASE, N_("wipe passphrases from memory")) \

Definition at line 287 of file opcodes.h.

◆ OPS_ENVELOPE

#define OPS_ENVELOPE (   _fmt)
Value:
_fmt(OP_ENVELOPE_EDIT_BCC, N_("edit the BCC list")) \
_fmt(OP_ENVELOPE_EDIT_CC, N_("edit the CC list")) \
_fmt(OP_ENVELOPE_EDIT_FCC, N_("enter a file to save a copy of this message in")) \
_fmt(OP_ENVELOPE_EDIT_FOLLOWUP_TO, N_("edit the Followup-To field")) \
_fmt(OP_ENVELOPE_EDIT_FROM, N_("edit the from field")) \
_fmt(OP_ENVELOPE_EDIT_HEADERS, N_("edit the message with headers")) \
_fmt(OP_ENVELOPE_EDIT_NEWSGROUPS, N_("edit the newsgroups list")) \
_fmt(OP_ENVELOPE_EDIT_REPLY_TO, N_("edit the Reply-To field")) \
_fmt(OP_ENVELOPE_EDIT_SUBJECT, N_("edit the subject of this message")) \
_fmt(OP_ENVELOPE_EDIT_TO, N_("edit the TO list")) \
_fmt(OP_ENVELOPE_EDIT_X_COMMENT_TO, N_("edit the X-Comment-To field")) \

Definition at line 293 of file opcodes.h.

◆ OPS_MIX

#define OPS_MIX (   _fmt)
Value:
_fmt(OP_COMPOSE_MIX, N_("send the message through a mixmaster remailer chain")) \
_fmt(OP_MIX_APPEND, N_("append a remailer to the chain")) \
_fmt(OP_MIX_CHAIN_NEXT, N_("select the next element of the chain")) \
_fmt(OP_MIX_CHAIN_PREV, N_("select the previous element of the chain")) \
_fmt(OP_MIX_DELETE, N_("delete a remailer from the chain")) \
_fmt(OP_MIX_INSERT, N_("insert a remailer into the chain")) \
_fmt(OP_MIX_USE, N_("accept the chain constructed"))

Definition at line 307 of file opcodes.h.

◆ OPS_NOTMUCH

#define OPS_NOTMUCH (   _fmt)
Value:
_fmt(OP_MAIN_CHANGE_VFOLDER, N_("open a different virtual folder")) \
_fmt(OP_MAIN_ENTIRE_THREAD, N_("read entire thread of the current message")) \
_fmt(OP_MAIN_VFOLDER_FROM_QUERY, N_("generate virtual folder from query")) \
_fmt(OP_MAIN_VFOLDER_FROM_QUERY_READONLY, N_("generate a read-only virtual folder from query")) \
_fmt(OP_MAIN_WINDOWED_VFOLDER_BACKWARD, N_("shifts virtual folder time window backwards")) \
_fmt(OP_MAIN_WINDOWED_VFOLDER_FORWARD, N_("shifts virtual folder time window forwards")) \
_fmt(OP_MAIN_WINDOWED_VFOLDER_RESET, N_("resets virtual folder time window to the present"))

Definition at line 320 of file opcodes.h.

◆ OPS_PGP

#define OPS_PGP (   _fmt)
Value:
_fmt(OP_ATTACHMENT_ATTACH_KEY, N_("attach a PGP public key")) \
_fmt(OP_CHECK_TRADITIONAL, N_("check for classic PGP")) \
_fmt(OP_COMPOSE_PGP_MENU, N_("show PGP options")) \
_fmt(OP_MAIL_KEY, N_("mail a PGP public key")) \
_fmt(OP_VERIFY_KEY, N_("verify a PGP public key")) \
_fmt(OP_VIEW_ID, N_("view the key's user id")) \

Definition at line 332 of file opcodes.h.

◆ OPS_SIDEBAR

#define OPS_SIDEBAR (   _fmt)
Value:
_fmt(OP_SIDEBAR_FIRST, N_("move the highlight to the first mailbox")) \
_fmt(OP_SIDEBAR_LAST, N_("move the highlight to the last mailbox")) \
_fmt(OP_SIDEBAR_NEXT, N_("move the highlight to next mailbox")) \
_fmt(OP_SIDEBAR_NEXT_NEW, N_("move the highlight to next mailbox with new mail")) \
_fmt(OP_SIDEBAR_OPEN, N_("open highlighted mailbox")) \
_fmt(OP_SIDEBAR_PAGE_DOWN, N_("scroll the sidebar down 1 page")) \
_fmt(OP_SIDEBAR_PAGE_UP, N_("scroll the sidebar up 1 page")) \
_fmt(OP_SIDEBAR_PREV, N_("move the highlight to previous mailbox")) \
_fmt(OP_SIDEBAR_PREV_NEW, N_("move the highlight to previous mailbox with new mail")) \
_fmt(OP_SIDEBAR_TOGGLE_VIRTUAL, N_("toggle between mailboxes and virtual mailboxes")) \
_fmt(OP_SIDEBAR_TOGGLE_VISIBLE, N_("make the sidebar (in)visible")) \

Definition at line 340 of file opcodes.h.

◆ OPS_SMIME

#define OPS_SMIME (   _fmt)     _fmt(OP_COMPOSE_SMIME_MENU, N_("show S/MIME options")) \

Definition at line 353 of file opcodes.h.

◆ OPS

#define OPS (   _fmt)
Value:
_fmt(OP_NULL, N_("null operation")) \
OPS_ATTACHMENT(_fmt) \
OPS_AUTOCRYPT(_fmt) \
OPS_CORE(_fmt) \
OPS_CRYPT(_fmt) \
OPS_ENVELOPE(_fmt) \
OPS_MIX(_fmt) \
OPS_NOTMUCH(_fmt) \
OPS_PGP(_fmt) \
OPS_SIDEBAR(_fmt) \
OPS_SMIME(_fmt) \

Definition at line 356 of file opcodes.h.

◆ DEFINE_OPS

#define DEFINE_OPS (   opcode,
  help_string 
)    opcode,

Definition at line 375 of file opcodes.h.

Enumeration Type Documentation

◆ MuttOps

enum MuttOps

All NeoMutt Opcodes.

Opcodes, e.g. OP_TOGGLE_NEW

Enumerator
OP_MAX 

Definition at line 374 of file opcodes.h.

374 {
375#define DEFINE_OPS(opcode, help_string) opcode,
377#undef DEFINE_OPS
378 OP_MAX,
379};
#define DEFINE_OPS(opcode, help_string)
Definition: opcodes.h:375
#define OPS(_fmt)
Definition: opcodes.h:356
@ OP_MAX
Definition: opcodes.h:378

Function Documentation

◆ opcodes_get_description()

const char * opcodes_get_description ( int  op)

Get the description of an opcode.

Parameters
opOpcode, e.g. OP_HELP
Return values
strDescription of the opcode

Definition at line 64 of file opcodes.c.

65{
66 if ((op < OP_TIMEOUT) || (op >= OP_MAX))
67 return "[UNKNOWN]";
68
69 if (op == OP_ABORT)
70 return "abort the current action";
71 if (op == OP_TIMEOUT)
72 return "timeout occurred";
73
74 return OpStrings[op][1];
75}
const char * OpStrings[][2]
Definition: opcodes.c:35
#define OP_TIMEOUT
Definition: opcodes.h:32
#define OP_ABORT
Definition: opcodes.h:33
+ Here is the caller graph for this function:

◆ opcodes_get_name()

const char * opcodes_get_name ( int  op)

Get the name of an opcode.

Parameters
opOpcode, e.g. OP_HELP
Return values
strName of the opcode

Definition at line 46 of file opcodes.c.

47{
48 if ((op < OP_TIMEOUT) || (op >= OP_MAX))
49 return "[UNKNOWN]";
50
51 if (op == OP_ABORT)
52 return "OP_ABORT";
53 if (op == OP_TIMEOUT)
54 return "OP_TIMEOUT";
55
56 return OpStrings[op][0];
57}
+ Here is the caller graph for this function: