opcodes.h File Reference

All user-callable functions. More...

#include "config.h"
#include "mutt/lib.h"

Include dependency graph for opcodes.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	OP_REPAINT   -4
	Repaint is needed.
#define	OP_PARTIAL_KEY   -3
	Incomplete keybinding.
#define	OP_TIMEOUT   -2
	1 second with no events
#define	OP_ABORT   -1
	$abort_key pressed (Ctrl-G)
#define	OPS_ATTACHMENT(_fmt)
#define	OPS_AUTOCRYPT(_fmt)
#define	OPS_CORE(_fmt)
#define	OPS_CRYPT(_fmt)
#define	OPS_ENVELOPE(_fmt)
#define	OPS_NOTMUCH(_fmt)
#define	OPS_PGP(_fmt)
#define	OPS_SIDEBAR(_fmt)
#define	OPS_SMIME(_fmt)
#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.
const char *	opcodes_get_name (int op)
	Get the name of an opcode.

Detailed Description

All user-callable functions.

Authors

• Damien Riegel
• Richard Russon
• Pietro Cerutti

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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_REPAINT

#define OP_REPAINT   -4

Repaint is needed.

Definition at line 34 of file opcodes.h.

OP_PARTIAL_KEY

#define OP_PARTIAL_KEY   -3

Incomplete keybinding.

Definition at line 35 of file opcodes.h.

OP_TIMEOUT

#define OP_TIMEOUT   -2

1 second with no events

Definition at line 36 of file opcodes.h.

OP_ABORT

#define OP_ABORT   -1

$abort_key pressed (Ctrl-G)

Definition at line 37 of file opcodes.h.

OPS_ATTACHMENT

#define OPS_ATTACHMENT

(

_fmt

)

Definition at line 40 of file opcodes.h.

OPS_AUTOCRYPT

#define OPS_AUTOCRYPT

(

_fmt

)

Value:

  /* L10N: Help screen description for OP_AUTOCRYPT_ACCT_MENU */ \
  /*       Index: <op_autocrypt_acct_menu> */ \
  _fmt(OP_AUTOCRYPT_ACCT_MENU,                N_("manage autocrypt accounts")) \
  /* L10N: Help screen description for OP_AUTOCRYPT_CREATE_ACCT */ \
  /*       Autocrypt Dialog: <op_autocrypt_create_acct> */ \
  _fmt(OP_AUTOCRYPT_CREATE_ACCT,              N_("create a new autocrypt account")) \
  /* L10N: Help screen description for OP_AUTOCRYPT_DELETE_ACCT */ \
  /*       Autocrypt Dialog: <op_autocrypt_delete_acct> */ \
  _fmt(OP_AUTOCRYPT_DELETE_ACCT,              N_("delete the current account")) \
  /* L10N: Help screen description for OP_AUTOCRYPT_TOGGLE_ACTIVE */ \
  /*       Autocrypt Dialog: <op_autocrypt_toggle_active> */ \
  _fmt(OP_AUTOCRYPT_TOGGLE_ACTIVE,            N_("toggle the current account active/inactive")) \
  /* L10N: Help screen description for OP_AUTOCRYPT_TOGGLE_PREFER */ \
  /*       Autocrypt Dialog: <op_autocrypt_toggle_prefer> */ \
  _fmt(OP_AUTOCRYPT_TOGGLE_PREFER,            N_("toggle the current account prefer-encrypt flag")) \
  /* L10N: Help screen description for OP_COMPOSE_AUTOCRYPT_MENU */ \
  /*       Envelope Window: <op_compose_autocrypt_menu> */ \
  _fmt(OP_COMPOSE_AUTOCRYPT_MENU,             N_("show autocrypt compose menu options"))

Definition at line 158 of file opcodes.h.

OPS_CORE

#define OPS_CORE

(

_fmt

)

Definition at line 181 of file opcodes.h.

OPS_CRYPT

#define OPS_CRYPT

(

_fmt

)

Value:

  /* L10N: Help screen description for OP_DECRYPT_COPY */ \
  /*       Index: <op_save> */ \
  _fmt(OP_DECRYPT_COPY,                       N_("make decrypted copy")) \
  /* L10N: Help screen description for OP_DECRYPT_SAVE */ \
  /*       Index: <op_save> */ \
  _fmt(OP_DECRYPT_SAVE,                       N_("make decrypted copy and delete")) \
  /* L10N: Help screen description for OP_EXTRACT_KEYS */ \
  /*       Attach Dialog: <op_extract_keys> */ \
  /*       Index: <op_extract_keys> */ \
  _fmt(OP_EXTRACT_KEYS,                       N_("extract supported public keys")) \
  /* L10N: Help screen description for OP_FORGET_PASSPHRASE */ \
  /*       Attach Dialog: <op_forget_passphrase> */ \
  /*       Compose Dialog: <op_forget_passphrase> */ \
  /*       Index: <op_forget_passphrase> */ \
  _fmt(OP_FORGET_PASSPHRASE,                  N_("wipe passphrases from memory")) \

Definition at line 841 of file opcodes.h.

OPS_ENVELOPE

#define OPS_ENVELOPE

(

_fmt

)

Definition at line 858 of file opcodes.h.

OPS_NOTMUCH

#define OPS_NOTMUCH

(

_fmt

)

Value:

  /* L10N: Help screen description for OP_MAIN_CHANGE_VFOLDER */ \
  /*       Index: <op_main_change_folder> */ \
  _fmt(OP_MAIN_CHANGE_VFOLDER,                N_("open a different virtual folder")) \
  /* L10N: Help screen description for OP_MAIN_ENTIRE_THREAD */ \
  /*       Index: <op_main_entire_thread> */ \
  _fmt(OP_MAIN_ENTIRE_THREAD,                 N_("read entire thread of the current message")) \
  /* L10N: Help screen description for OP_MAIN_VFOLDER_FROM_QUERY */ \
  /*       Index: <op_main_vfolder_from_query> */ \
  _fmt(OP_MAIN_VFOLDER_FROM_QUERY,            N_("generate virtual folder from query")) \
  /* L10N: Help screen description for OP_MAIN_VFOLDER_FROM_QUERY_READONLY */ \
  /*       Index: <op_main_vfolder_from_query> */ \
  _fmt(OP_MAIN_VFOLDER_FROM_QUERY_READONLY,   N_("generate a read-only virtual folder from query")) \
  /* L10N: Help screen description for OP_MAIN_WINDOWED_VFOLDER_BACKWARD */ \
  /*       Index: <op_main_windowed_vfolder> */ \
  _fmt(OP_MAIN_WINDOWED_VFOLDER_BACKWARD,     N_("shifts virtual folder time window backwards")) \
  /* L10N: Help screen description for OP_MAIN_WINDOWED_VFOLDER_FORWARD */ \
  /*       Index: <op_main_windowed_vfolder> */ \
  _fmt(OP_MAIN_WINDOWED_VFOLDER_FORWARD,      N_("shifts virtual folder time window forwards")) \
  /* L10N: Help screen description for OP_MAIN_WINDOWED_VFOLDER_RESET */ \
  /*       Index: <op_main_windowed_vfolder> */ \
  _fmt(OP_MAIN_WINDOWED_VFOLDER_RESET,        N_("resets virtual folder time window to the present"))

Definition at line 894 of file opcodes.h.

OPS_PGP

#define OPS_PGP

(

_fmt

)

Value:

  /* L10N: Help screen description for OP_ATTACHMENT_ATTACH_KEY */ \
  /*       Compose Dialog: <op_attachment_attach_key> */ \
  _fmt(OP_ATTACHMENT_ATTACH_KEY,              N_("attach a PGP public key")) \
  /* L10N: Help screen description for OP_CHECK_TRADITIONAL */ \
  /*       Attach Dialog: <op_check_traditional> */ \
  /*       Index: <op_check_traditional> */ \
  _fmt(OP_CHECK_TRADITIONAL,                  N_("check for classic PGP")) \
  /* L10N: Help screen description for OP_COMPOSE_PGP_MENU */ \
  /*       Envelope Window: <op_compose_pgp_menu> */ \
  _fmt(OP_COMPOSE_PGP_MENU,                   N_("show PGP options")) \
  /* L10N: Help screen description for OP_MAIL_KEY */ \
  /*       Index: <op_mail_key> */ \
  _fmt(OP_MAIL_KEY,                           N_("mail a PGP public key")) \
  /* L10N: Help screen description for OP_VERIFY_KEY */ \
  /*       GPGME Key Selection Dialog: <op_verify_key> */ \
  /*       PGP Key Selection Dialog: <op_verify_key> */ \
  _fmt(OP_VERIFY_KEY,                         N_("verify a public key")) \
  /* L10N: Help screen description for OP_VIEW_ID */ \
  /*       GPGME Key Selection Dialog: <op_view_id> */ \
  /*       PGP Key Selection Dialog: <op_view_id> */ \
  _fmt(OP_VIEW_ID,                            N_("view the key's user id")) \

Definition at line 920 of file opcodes.h.

OPS_SIDEBAR

#define OPS_SIDEBAR

(

_fmt

)

Definition at line 943 of file opcodes.h.

OPS_SMIME

#define OPS_SMIME

(

_fmt

)

Value:

  /* L10N: Help screen description for OP_COMPOSE_SMIME_MENU */ \
  /*       Envelope Window: <op_compose_smime_menu> */ \
  _fmt(OP_COMPOSE_SMIME_MENU,                 N_("show S/MIME options")) \

Definition at line 978 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_NOTMUCH(_fmt) \
  OPS_PGP(_fmt) \
  OPS_SIDEBAR(_fmt) \
  OPS_SMIME(_fmt) \

Definition at line 983 of file opcodes.h.

DEFINE_OPS

#define DEFINE_OPS	(		opcode,
			help_string
	)		opcode,

Definition at line 1001 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 1000 of file opcodes.h.

             {
#define DEFINE_OPS(opcode, help_string) opcode,
  OPS(DEFINE_OPS)
#undef DEFINE_OPS
  OP_MAX,
};

Function Documentation

opcodes_get_description()

const char * opcodes_get_description

(

int

op

)

Get the description of an opcode.

Parameters

op	Opcode, e.g. OP_HELP

Return values

str	Description of the opcode

Definition at line 70 of file opcodes.c.

{
  if ((op < OP_REPAINT) || (op >= OP_MAX))
    return "[UNKNOWN]";
 
  if (op == OP_ABORT)
    return "abort the current action";
  if (op == OP_TIMEOUT)
    return "timeout occurred";
  if (op == OP_PARTIAL_KEY)
    return "partial keybinding";
  if (op == OP_REPAINT)
    return "repaint required";
 
  return OpStrings[op][1];
}

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

op	Opcode, e.g. OP_HELP

Return values

str	Name of the opcode

Definition at line 48 of file opcodes.c.

{
  if ((op < OP_REPAINT) || (op >= OP_MAX))
    return "[UNKNOWN]";
 
  if (op == OP_ABORT)
    return "OP_ABORT";
  if (op == OP_TIMEOUT)
    return "OP_TIMEOUT";
  if (op == OP_PARTIAL_KEY)
    return "OP_PARTIAL_KEY";
  if (op == OP_REPAINT)
    return "OP_REPAINT";
 
  return OpStrings[op][0];
}

Here is the caller graph for this function: