sticker.h

Go to the documentation of this file.

// SPDX-License-Identifier: BSD-2-Clause
// Copyright The Music Player Daemon Project

#ifndef MPD_STICKER_H
#define MPD_STICKER_H

#include "compiler.h"

#include <stdbool.h>
#include <stddef.h>

struct mpd_connection;

enum mpd_sticker_operator {
    MPD_STICKER_OP_UNKOWN = -1,   // Keep typo, else we break the abi
    MPD_STICKER_OP_UNKNOWN = -1,
    MPD_STICKER_OP_EQ,
    MPD_STICKER_OP_GT,
    MPD_STICKER_OP_LT,
    MPD_STICKER_OP_EQ_INT,
    MPD_STICKER_OP_GT_INT,
    MPD_STICKER_OP_LT_INT,
    MPD_STICKER_OP_CONTAINS,
    MPD_STICKER_OP_STARTS_WITH,
};

enum mpd_sticker_sort {
    MPD_STICKER_SORT_UNKOWN = -1,   // Keep typo, else we break the abi
    MPD_STICKER_SORT_UNKNOWN = -1,
    MPD_STICKER_SORT_URI,
    MPD_STICKER_SORT_VALUE,
    MPD_STICKER_SORT_VALUE_INT,
};

#ifdef __cplusplus
extern "C" {
#endif

bool
mpd_send_sticker_set(struct mpd_connection *connection, const char *type,
             const char *uri, const char *name, const char *value);

bool
mpd_run_sticker_set(struct mpd_connection *connection, const char *type,
            const char *uri, const char *name, const char *value);

bool
mpd_send_sticker_inc(struct mpd_connection *connection, const char *type,
             const char *uri, const char *name, unsigned value);

bool
mpd_run_sticker_inc(struct mpd_connection *connection, const char *type,
            const char *uri, const char *name, unsigned value);

bool
mpd_send_sticker_dec(struct mpd_connection *connection, const char *type,
             const char *uri, const char *name, unsigned value);

bool
mpd_run_sticker_dec(struct mpd_connection *connection, const char *type,
            const char *uri, const char *name, unsigned value);

bool
mpd_send_sticker_delete(struct mpd_connection *connection, const char *type,
            const char *uri, const char *name);

bool
mpd_run_sticker_delete(struct mpd_connection *connection, const char *type,
               const char *uri, const char *name);

bool
mpd_send_sticker_get(struct mpd_connection *connection, const char *type,
             const char *uri, const char *name);

bool
mpd_send_sticker_list(struct mpd_connection *connection, const char *type,
              const char *uri);

bool
mpd_send_sticker_find(struct mpd_connection *connection, const char *type,
              const char *base_uri, const char *name);

const char *
mpd_parse_sticker(const char *input, size_t *name_length_r);

mpd_malloc
struct mpd_pair *
mpd_recv_sticker(struct mpd_connection *connection);

void
mpd_return_sticker(struct mpd_connection *connection, struct mpd_pair *pair);

bool
mpd_send_stickernames(struct mpd_connection *connection);

bool
mpd_send_stickertypes(struct mpd_connection *connection);

bool
mpd_send_stickernamestypes(struct mpd_connection *connection, const char *type);

bool
mpd_sticker_search_begin(struct mpd_connection *connection, const char *type,
             const char *base_uri, const char *name);

bool
mpd_sticker_search_add_value_constraint(struct mpd_connection *connection,
                    enum mpd_sticker_operator oper,
                    const char *value);

bool
mpd_sticker_search_add_sort(struct mpd_connection *connection,
                enum mpd_sticker_sort sort, bool descending);

bool
mpd_sticker_search_add_window(struct mpd_connection *connection,
                      unsigned start, unsigned end);

bool
mpd_sticker_search_commit(struct mpd_connection *connection);

void
mpd_sticker_search_cancel(struct mpd_connection *connection);

#ifdef __cplusplus
}
#endif

#endif /* MPD_STICKER_H */