screen_interface: add method mouse(), replacing CMD_MOUSE_EVENT

[ncmpc.git] / src / command.h

diff --git a/src/command.h b/src/command.h
index 4df7a30f0f07c4f808ba8cf415a5ed8503c1f75e..aa794c64cded5415e9c5cd521cb5c3eaddf6b00d 100644 (file)
--- a/src/command.h
+++ b/src/command.h
@@ -1,6 +1,6 @@
-/*
- * (c) 2004-2008 The Music Player Daemon Project
- * http://www.musicpd.org/
+/* ncmpc (Ncurses MPD Client)
+ * (c) 2004-2017 The Music Player Daemon Project
+ * Project homepage: http://musicpd.org
  *
  * 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
@@ -11,18 +11,20 @@
  * 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, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #ifndef COMMAND_H
 #define COMMAND_H
 
 #include "config.h"
+#include "Compiler.h"
 
 #include <stddef.h>
+#include <stdbool.h>
 
 #ifndef NCMPC_MINI
 #include <stdio.h>
@@ -48,6 +50,8 @@ typedef enum {
        CMD_CLEAR,
        CMD_DELETE,
        CMD_REPEAT,
+       CMD_SINGLE,
+       CMD_CONSUME,
        CMD_CROSSFADE,
        CMD_DB_UPDATE,
        CMD_VOLUME_UP,
@@ -56,9 +60,13 @@ typedef enum {
        CMD_SAVE_PLAYLIST,
        CMD_TOGGLE_FIND_WRAP,
        CMD_TOGGLE_AUTOCENTER,
+       CMD_SELECT_PLAYING,
        CMD_SEARCH_MODE,
        CMD_LIST_PREVIOUS,
        CMD_LIST_NEXT,
+       CMD_LIST_TOP,
+       CMD_LIST_MIDDLE,
+       CMD_LIST_BOTTOM,
        CMD_LIST_FIRST,
        CMD_LIST_LAST,
        CMD_LIST_NEXT_PAGE,
@@ -67,25 +75,33 @@ typedef enum {
        CMD_LIST_FIND_NEXT,
        CMD_LIST_RFIND,
        CMD_LIST_RFIND_NEXT,
+       CMD_LIST_JUMP,
        CMD_LIST_MOVE_UP,
        CMD_LIST_MOVE_DOWN,
-       CMD_MOUSE_EVENT,
+       CMD_LIST_RANGE_SELECT,
+       CMD_LIST_SCROLL_UP_LINE,
+       CMD_LIST_SCROLL_DOWN_LINE,
+       CMD_LIST_SCROLL_UP_HALF,
+       CMD_LIST_SCROLL_DOWN_HALF,
        CMD_SCREEN_UPDATE,
        CMD_SCREEN_PREVIOUS,
        CMD_SCREEN_NEXT,
+       CMD_SCREEN_SWAP,
        CMD_SCREEN_PLAY,
        CMD_SCREEN_FILE,
        CMD_SCREEN_ARTIST,
        CMD_SCREEN_SEARCH,
+       CMD_SCREEN_SONG,
        CMD_SCREEN_KEYDEF,
        CMD_SCREEN_HELP,
        CMD_SCREEN_LYRICS,
        CMD_SCREEN_OUTPUTS,
+       CMD_SCREEN_CHAT,
        CMD_LYRICS_UPDATE,
+       CMD_EDIT,
        CMD_INTERRUPT,
        CMD_GO_ROOT_DIRECTORY,
        CMD_GO_PARENT_DIRECTORY,
-       CMD_VIEW,
        CMD_LOCATE,
        CMD_QUIT
 } command_t;
@@ -112,27 +128,54 @@ typedef struct  {
 
 #ifdef ENABLE_KEYDEF_SCREEN
 command_definition_t *get_command_definitions(void);
+size_t get_cmds_max_name_width(command_definition_t *cmds);
 #endif
 
-command_t find_key_command(int key, command_definition_t *cmds);
+gcc_pure
+command_t
+find_key_command(int key, const command_definition_t *cmds);
 
 void command_dump_keys(void);
 
 #ifndef NCMPC_MINI
 
-int check_key_bindings(command_definition_t *cmds, char *buf, size_t size);
-int write_key_bindings(FILE *f, int all);
+/**
+ * @return true on success, false on error
+ */
+bool
+check_key_bindings(command_definition_t *cmds, char *buf, size_t size);
+
+/**
+ * @return true on success, false on error
+ */
+bool
+write_key_bindings(FILE *f, int all);
 
 #endif
 
+gcc_pure
 const char *key2str(int key);
+
+gcc_pure
 const char *get_key_description(command_t command);
+
+gcc_pure
 const char *get_key_command_name(command_t command);
-const char *get_key_names(command_t command, int all);
+
+gcc_pure
+const char *get_key_names(command_t command, bool all);
+
+gcc_pure
 command_t get_key_command(int key);
-command_t get_key_command_from_name(char *name);
-int assign_keys(command_t command, int keys[MAX_COMMAND_KEYS]);
 
-command_t get_keyboard_command(void);
+gcc_pure
+command_t
+get_key_command_from_name(const char *name);
+
+/**
+ * @return true on success, false on error
+ */
+bool
+assign_keys(command_t command, int keys[MAX_COMMAND_KEYS]);
 
 #endif