list.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_LIST_H
#define MYMPD_LIST_H
 
#include "dist/sds/sds.h"
 
#include <stdbool.h>
 
struct t_list_node {
    sds key;                   
    sds value_p;               
    int64_t value_i;           
    void *user_data;           
    struct t_list_node *next;  
};
 
struct t_list {
    unsigned length;           
    struct t_list_node *head;  
    struct t_list_node *tail;  
};
 
enum list_sort_direction {
    LIST_SORT_ASC = 0,
    LIST_SORT_DESC = 1
};
 
typedef void (*user_data_callback) (struct t_list_node *current);
 
typedef sds (*list_node_to_line_callback) (sds buffer, struct t_list_node *current, bool newline);
 
typedef bool (*list_sort_callback) (struct t_list_node *current, struct t_list_node *next, enum list_sort_direction direction);
 
struct t_list *list_new(void);
struct t_list *list_dup(struct t_list *l);
bool list_append(struct t_list *dst, struct t_list *src);
void list_init(struct t_list *l);
void list_clear(struct t_list *l);
void list_free(struct t_list *l);
void list_free_void(void *l);
void list_clear_user_data(struct t_list *l, user_data_callback free_cb);
void list_free_user_data(struct t_list *l, user_data_callback free_cb);
void list_free_cb_ignore_user_data(struct t_list_node *current);
void list_free_cb_sds_user_data(struct t_list_node *current);
void list_free_cb_ptr_user_data(struct t_list_node *current);
void *list_node_free_user_data(struct t_list_node *n, user_data_callback free_cb);
void *list_node_free(struct t_list_node *n);
 
bool list_push(struct t_list *l, const char *key, int64_t value_i,
        const char *value_p, void *user_data);
bool list_push_len(struct t_list *l, const char *key, size_t key_len, int64_t value_i,
        const char *value_p, size_t value_len, void *user_data);
bool list_insert(struct t_list *l, const char *key, int64_t value_i,
        const char *value_p, void *user_data);
 
bool list_replace(struct t_list *l, unsigned idx, const char *key, int64_t value_i,
        const char *value_p, void *user_data);
bool list_replace_len(struct t_list *l, unsigned idx, const char *key, size_t key_len, int64_t value_i,
        const char *value_p, size_t value_len, void *user_data);
bool list_replace_user_data(struct t_list *l, unsigned idx, const char *key, int64_t value_i,
        const char *value_p, void *user_data, user_data_callback free_cb);
bool list_replace_len_user_data(struct t_list *l, unsigned idx, const char *key, size_t key_len, int64_t value_i,
        const char *value_p, size_t value_len, void *user_data, user_data_callback free_cb);
 
void list_crop(struct t_list *l, unsigned length, user_data_callback free_cb);
 
bool list_shuffle(struct t_list *l);
bool list_swap_item(struct t_list_node *n1, struct t_list_node *n2);
bool list_move_item_pos(struct t_list *l, unsigned from, unsigned to);
 
unsigned list_get_node_idx(const struct t_list *l, const char *key);
struct t_list_node *list_get_node(const struct t_list *l, const char *key);
struct t_list_node *list_node_at(const struct t_list *l, unsigned idx);
struct t_list_node *list_node_prev_at(const struct t_list *l, unsigned idx, struct t_list_node **previous);
struct t_list_node *list_shift_first(struct t_list *l);
struct t_list_node *list_node_extract(struct t_list *l, unsigned idx);
 
bool list_remove_node(struct t_list *l, unsigned idx);
bool list_remove_node_user_data(struct t_list *l, unsigned idx, user_data_callback free_cb);
bool list_remove_node_by_key(struct t_list *l, const char *key);
bool list_remove_node_by_key_user_data(struct t_list *l, const char *key, user_data_callback free_cb);
 
bool list_write_to_disk(sds filepath, struct t_list *l, list_node_to_line_callback node_to_line_cb);
 
bool list_sort_by_callback(struct t_list *l, enum list_sort_direction direction, list_sort_callback sort_cb);
bool list_sort_by_value_i(struct t_list *l, enum list_sort_direction direction);
bool list_sort_by_value_p(struct t_list *l, enum list_sort_direction direction);
bool list_sort_by_key(struct t_list *l, enum list_sort_direction direction);
 
#endif