trigger.h

Go to the documentation of this file.

/*
 SPDX-License-Identifier: GPL-3.0-or-later
 myMPD (c) 2018-2025 Juergen Mang <mail@jcgames.de>
 https://github.com/jcorporation/mympd
*/
 
#ifndef MYMPD_API_TRIGGER_H
#define MYMPD_API_TRIGGER_H
 
#include "dist/sds/sds.h"
#include "src/lib/list.h"
#include "src/lib/sticker.h"
 
enum trigger_events {
    TRIGGER_MYMPD_SCROBBLE = -1,       
    TRIGGER_MYMPD_START = -2,          
    TRIGGER_MYMPD_STOP = -3,           
    TRIGGER_MYMPD_CONNECTED = -4,      
    TRIGGER_MYMPD_DISCONNECTED = -5,   
    TRIGGER_MYMPD_FEEDBACK = -6,       
    TRIGGER_MYMPD_SKIPPED = -7,        
    TRIGGER_MYMPD_LYRICS = -8,         
    TRIGGER_MYMPD_ALBUMART = -9,       
    TRIGGER_MYMPD_TAGART = -10,        
    TRIGGER_MYMPD_JUKEBOX = -11,       
    TRIGGER_MYMPD_SMARTPLS = - 12,     
    TRIGGER_MYMPD_BGIMAGE = -13,       
    TRIGGER_MPD_DATABASE = 0x1,        
    TRIGGER_MPD_STORED_PLAYLIST = 0x2, 
    TRIGGER_MPD_QUEUE = 0x4,           
    TRIGGER_MPD_PLAYER = 0x8,          
    TRIGGER_MPD_MIXER = 0x10,          
    TRIGGER_MPD_OUTPUT = 0x20,         
    TRIGGER_MPD_OPTIONS = 0x40,        
    TRIGGER_MPD_UPDATE = 0x80,         
    TRIGGER_MPD_STICKER = 0x100,       
    TRIGGER_MPD_SUBSCRIPTION = 0x200,  
    TRIGGER_MPD_MESSAGE = 0x400,       
    TRIGGER_MPD_PARTITION = 0x800,     
    TRIGGER_MPD_NEIGHBOR = 0x1000,     
    TRIGGER_MPD_MOUNT = 0x2000         
};
 
struct t_event_data {
    int event;                
    struct t_list *arguments;  
};
 
struct t_trigger_data {
    sds script;               
    struct t_list arguments;  
};
 
bool mympd_api_trigger_save(struct t_list *trigger_list, sds name, int trigger_id, int event, sds partition,
        struct t_trigger_data *trigger_data, sds *error);
sds mympd_api_trigger_list(struct t_list *trigger_list, sds buffer, unsigned request_id, const char *partition);
sds mympd_api_trigger_get(struct t_list *trigger_list, sds buffer, unsigned request_id, unsigned trigger_id);
bool mympd_api_trigger_file_read(struct t_list *trigger_list, sds workdir);
bool mympd_api_trigger_file_save(struct t_list *trigger_list, sds workdir);
void mympd_api_trigger_list_clear(struct t_list *trigger_list);
int mympd_api_trigger_execute(struct t_list *trigger_list, enum trigger_events event,
        const char *partition, struct t_list *arguments);
int mympd_api_trigger_execute_http(struct t_list *trigger_list, enum trigger_events event,
        const char *partition, unsigned long conn_id, unsigned request_id,
        struct t_list *arguments);
int mympd_api_trigger_execute_feedback(struct t_list *trigger_list, sds uri,
        enum mympd_feedback_type type, int value, const char *partition);
bool mympd_api_trigger_delete(struct t_list *trigger_list, unsigned idx, sds *error);
const char *mympd_api_event_name(int event);
sds mympd_api_trigger_print_event_list(sds buffer);
 
struct t_trigger_data *mympd_api_trigger_data_new(void);
void mympd_api_trigger_data_free(struct t_trigger_data *trigger_data);
 
struct t_event_data *mympd_api_event_data_new(int event, struct t_list *arguments);
void mympd_api_event_data_free(struct t_event_data *event_data);
void mympd_api_event_data_free_void(void *event_data);
 
#endif