merge: light refactoring

[neomutt] / mutt_commands.h

diff --git a/mutt_commands.h b/mutt_commands.h
index f5334b790210dc8a7f616b2499b7310fdc526e24..db5478dd26b8770082506648dec05a2d4c6b2007 100644 (file)
--- a/mutt_commands.h
+++ b/mutt_commands.h
@@ -1,6 +1,11 @@
 /**
+ * @file
+ * Mapping from user command name to function
+ *
+ * @authors
  * Copyright (C) 2016 Bernard Pratz <z+mutt+pub@m0g.net>
  *
+ * @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
@@ -15,19 +20,45 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef _MUTT_COMMANDS_H
-#define _MUTT_COMMANDS_H 1
+#ifndef MUTT_MUTT_COMMANDS_H
+#define MUTT_MUTT_COMMANDS_H
+
+#include <stdint.h>
 
 struct Buffer;
 
+/**
+ * enum CommandResult - Error codes for command_t parse functions
+ */
+enum CommandResult
+{
+  MUTT_CMD_ERROR   = -1, ///< Error: Can't help the user
+  MUTT_CMD_WARNING = -2, ///< Warning: Help given to the user
+  MUTT_CMD_SUCCESS =  0, ///< Success: Command worked
+  MUTT_CMD_FINISH  =  1  ///< Finish: Stop processing this file
+};
+
+/**
+ * typedef command_t - Prototype for a function to parse a command
+ * @param buf  Temporary Buffer space
+ * @param s    Buffer containing string to be parsed
+ * @param data Flags associated with the command
+ * @param err  Buffer for error messages
+ * @retval #CommandResult Result e.g. #MUTT_CMD_SUCCESS
+ */
+typedef enum CommandResult (*command_t)(struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err);
+
+/**
+ * struct Command - A user-callable command
+ */
 struct Command
 {
-  char *name;
-  int (*func)(struct Buffer *, struct Buffer *, unsigned long, struct Buffer *);
-  unsigned long data;
+  const char *name; ///< Name of the command
+  command_t func;   ///< Function to parse the command
+  intptr_t data;    ///< Data or flags to pass to the command
 };
 
 const struct Command *mutt_command_get(const char *s);
 void mutt_commands_apply(void *data, void (*application)(void *, const struct Command *));
 
-#endif /* _MUTT_COMMANDS_H */
+#endif /* MUTT_MUTT_COMMANDS_H */