ncmpc  0.30
Data Structures | Macros | Enumerations | Functions
command.hxx File Reference
#include "config.h"
#include "Compiler.h"
#include <stddef.h>
#include <stdio.h>

Go to the source code of this file.

Data Structures

struct  command_definition_t
 

Macros

#define MAX_COMMAND_KEYS   3
 
#define COMMAND_KEY_MODIFIED   0x01
 
#define COMMAND_KEY_CONFLICT   0x02
 
#define KEYDEF_WRITE_HEADER   0x01
 
#define KEYDEF_WRITE_ALL   0x02
 
#define KEYDEF_COMMENT_ALL   0x04
 

Enumerations

enum  command_t {
  CMD_NONE = 0, CMD_PLAY, CMD_SELECT, CMD_SELECT_ALL,
  CMD_PAUSE, CMD_STOP, CMD_CROP, CMD_TRACK_NEXT,
  CMD_TRACK_PREVIOUS, CMD_SEEK_FORWARD, CMD_SEEK_BACKWARD, CMD_SHUFFLE,
  CMD_RANDOM, CMD_CLEAR, CMD_DELETE, CMD_REPEAT,
  CMD_SINGLE, CMD_CONSUME, CMD_CROSSFADE, CMD_DB_UPDATE,
  CMD_VOLUME_UP, CMD_VOLUME_DOWN, CMD_ADD, 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,
  CMD_LIST_PREVIOUS_PAGE, CMD_LIST_FIND, CMD_LIST_FIND_NEXT, CMD_LIST_RFIND,
  CMD_LIST_RFIND_NEXT, CMD_LIST_JUMP, CMD_LIST_MOVE_UP, CMD_LIST_MOVE_DOWN,
  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_LOCATE, CMD_QUIT
}
 

Functions

gcc_pure command_t find_key_command (int key, const command_definition_t *cmds)
 
void command_dump_keys ()
 
bool check_key_bindings (command_definition_t *cmds, char *buf, size_t size)
 
bool write_key_bindings (FILE *f, int all)
 
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)
 
gcc_pure const char * get_key_names (command_t command, bool all)
 
gcc_pure command_t get_key_command (int key)
 
gcc_pure command_t get_key_command_from_name (const char *name)
 
bool assign_keys (command_t command, int keys[MAX_COMMAND_KEYS])
 

Macro Definition Documentation

◆ MAX_COMMAND_KEYS

#define MAX_COMMAND_KEYS   3

◆ COMMAND_KEY_MODIFIED

#define COMMAND_KEY_MODIFIED   0x01

◆ COMMAND_KEY_CONFLICT

#define COMMAND_KEY_CONFLICT   0x02

◆ KEYDEF_WRITE_HEADER

#define KEYDEF_WRITE_HEADER   0x01

◆ KEYDEF_WRITE_ALL

#define KEYDEF_WRITE_ALL   0x02

◆ KEYDEF_COMMENT_ALL

#define KEYDEF_COMMENT_ALL   0x04

Enumeration Type Documentation

◆ command_t

enum command_t
Enumerator
CMD_NONE 
CMD_PLAY 
CMD_SELECT 
CMD_SELECT_ALL 
CMD_PAUSE 
CMD_STOP 
CMD_CROP 
CMD_TRACK_NEXT 
CMD_TRACK_PREVIOUS 
CMD_SEEK_FORWARD 
CMD_SEEK_BACKWARD 
CMD_SHUFFLE 
CMD_RANDOM 
CMD_CLEAR 
CMD_DELETE 
CMD_REPEAT 
CMD_SINGLE 
CMD_CONSUME 
CMD_CROSSFADE 
CMD_DB_UPDATE 
CMD_VOLUME_UP 
CMD_VOLUME_DOWN 
CMD_ADD 
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 
CMD_LIST_PREVIOUS_PAGE 
CMD_LIST_FIND 
CMD_LIST_FIND_NEXT 
CMD_LIST_RFIND 
CMD_LIST_RFIND_NEXT 
CMD_LIST_JUMP 
CMD_LIST_MOVE_UP 
CMD_LIST_MOVE_DOWN 
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_LOCATE 
CMD_QUIT 

Function Documentation

◆ find_key_command()

gcc_pure command_t find_key_command ( int  key,
const command_definition_t cmds 
)

◆ command_dump_keys()

void command_dump_keys ( )

◆ check_key_bindings()

bool check_key_bindings ( command_definition_t cmds,
char *  buf,
size_t  size 
)
Returns
true on success, false on error

◆ write_key_bindings()

bool write_key_bindings ( FILE *  f,
int  all 
)
Returns
true on success, false on error

◆ key2str()

gcc_pure const char* key2str ( int  key)

◆ get_key_description()

gcc_pure const char* get_key_description ( command_t  command)

◆ get_key_command_name()

gcc_pure const char* get_key_command_name ( command_t  command)

◆ get_key_names()

gcc_pure const char* get_key_names ( command_t  command,
bool  all 
)

◆ get_key_command()

gcc_pure command_t get_key_command ( int  key)

◆ get_key_command_from_name()

gcc_pure command_t get_key_command_from_name ( const char *  name)

◆ assign_keys()

bool assign_keys ( command_t  command,
int  keys[MAX_COMMAND_KEYS] 
)
Returns
true on success, false on error