NeoMutt  2020-06-26-89-g172cd3
Teaching an old dog new tricks
DOXYGEN
mutt_commands.h File Reference

Definitions of NeoMutt commands. More...

#include <stdint.h>
+ Include dependency graph for mutt_commands.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  Command
 A user-callable command. More...
 

Macros

#define MUTT_NAMED   (1 << 0)
 

Enumerations

enum  CommandResult { MUTT_CMD_ERROR = -1, MUTT_CMD_WARNING = -2, MUTT_CMD_SUCCESS = 0, MUTT_CMD_FINISH = 1 }
 Error codes for command_t parse functions. More...
 
enum  MuttSetCommand { MUTT_SET_SET, MUTT_SET_INV, MUTT_SET_UNSET, MUTT_SET_RESET }
 Flags for parse_set() More...
 

Variables

const struct Command Commands []
 

Detailed Description

Definitions of NeoMutt commands.

Authors
  • Bernard Pratz

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

Macro Definition Documentation

◆ MUTT_NAMED

#define MUTT_NAMED   (1 << 0)

Definition at line 73 of file mutt_commands.h.

Enumeration Type Documentation

◆ CommandResult

Error codes for command_t parse functions.

Enumerator
MUTT_CMD_ERROR 

Error: Can't help the user.

MUTT_CMD_WARNING 

Warning: Help given to the user.

MUTT_CMD_SUCCESS 

Success: Command worked.

MUTT_CMD_FINISH 

Finish: Stop processing this file.

Definition at line 33 of file mutt_commands.h.

34 {
35  MUTT_CMD_ERROR = -1,
36  MUTT_CMD_WARNING = -2,
37  MUTT_CMD_SUCCESS = 0,
38  MUTT_CMD_FINISH = 1
39 };
Error: Can&#39;t help the user.
Definition: mutt_commands.h:35
Success: Command worked.
Definition: mutt_commands.h:37
Warning: Help given to the user.
Definition: mutt_commands.h:36
Finish: Stop processing this file.
Definition: mutt_commands.h:38

◆ MuttSetCommand

Flags for parse_set()

Enumerator
MUTT_SET_SET 

default is to set all vars

MUTT_SET_INV 

default is to invert all vars

MUTT_SET_UNSET 

default is to unset all vars

MUTT_SET_RESET 

default is to reset all vars to default

Definition at line 64 of file mutt_commands.h.

65 {
66  MUTT_SET_SET,
67  MUTT_SET_INV,
70 };
default is to reset all vars to default
Definition: mutt_commands.h:69
default is to unset all vars
Definition: mutt_commands.h:68
default is to set all vars
Definition: mutt_commands.h:66
default is to invert all vars
Definition: mutt_commands.h:67

Variable Documentation

◆ Commands

const struct Command Commands[]

Definition at line 50 of file mutt_commands.c.