Gerneralize for_each_matching_blob().
[paraslash.git] / afs.h
diff --git a/afs.h b/afs.h
index 0ba203a..f4f0222 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -1,15 +1,26 @@
+/*
+ * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
 #include <regex.h>
 #include "osl.h"
 #include "hash.h"
 
-#define DATABASE_DIR "/home/maan/tmp/osl" /* FIXME */
-
+/** Audio file selector data stored in the audio file table. */
 struct afs_info {
+       /** Seconds since the epoch. */
        uint64_t last_played;
+       /** Bitfield of set attributes. */
        uint64_t attributes;
+       /** Counts how many times the file was selected. */
        uint32_t num_played;
+       /** Image blob associated with this file (foreign key). */
        uint32_t image_id;
+       /** Lyrics blob associated with this file (foreign key). */
        uint32_t lyrics_id;
+       /** Mp3, ogg or aac. */
        uint8_t audio_format_id;
 };
 
@@ -17,69 +28,9 @@ enum afs_table_flags {TBLFLAG_SKIP_CREATE};
 
 struct table_info {
        const struct osl_table_description *desc;
-       struct osl_table *table;
        enum afs_table_flags flags;
 };
 
-enum ls_sorting_method {
-       LS_SORT_BY_PATH, /* -sp (default) */
-       LS_SORT_BY_SCORE, /* -ss */
-       LS_SORT_BY_LAST_PLAYED, /* -sl */
-       LS_SORT_BY_NUM_PLAYED, /* -sn */
-       LS_SORT_BY_FREQUENCY, /* -sf */
-       LS_SORT_BY_CHANNELS, /* -sc */
-       LS_SORT_BY_IMAGE_ID, /* -si */
-       LS_SORT_BY_LYRICS_ID, /* -sy */
-       LS_SORT_BY_BITRATE, /* -sb */
-       LS_SORT_BY_DURATION, /* -sd */
-       LS_SORT_BY_AUDIO_FORMAT, /* -sa */
-       LS_SORT_BY_HASH, /* -sh */
-};
-
-enum ls_listing_mode {
-       LS_MODE_SHORT,
-       LS_MODE_LONG,
-       LS_MODE_VERBOSE,
-       LS_MODE_MBOX
-};
-
-enum ls_flags {
-       LS_FLAG_FULL_PATH = 1,
-       LS_FLAG_ADMISSIBLE_ONLY = 2,
-       LS_FLAG_REVERSE = 4,
-};
-
-struct ls_widths {
-       unsigned short score_width;
-       unsigned short image_id_width;
-       unsigned short lyrics_id_width;
-       unsigned short bitrate_width;
-       unsigned short frequency_width;
-       unsigned short duration_width;
-       unsigned short num_played_width;
-};
-
-struct ls_data {
-       struct audio_format_info afhi;
-       struct afs_info afsi;
-       char *path;
-       long score;
-       HASH_TYPE *hash;
-};
-
-struct ls_options {
-       unsigned flags;
-       enum ls_sorting_method sorting;
-       enum ls_listing_mode mode;
-       char **patterns;
-       int num_patterns;
-       struct ls_widths widths;
-       uint32_t array_size;
-       uint32_t num_matching_paths;
-       struct ls_data *data;
-       struct ls_data **data_ptr;
-};
-
 enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
 
 struct audio_file_data {
@@ -91,25 +42,43 @@ struct audio_file_data {
        struct osl_object map;
 };
 
+enum pattern_match_flags {
+       PM_REVERSE_LOOP = 1,
+       PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
+       PM_SKIP_EMPTY_NAME = 4,
+};
+
+struct pattern_match_data {
+       struct osl_table *table;
+       unsigned loop_col_num;
+       unsigned match_col_num;
+       unsigned pm_flags;
+       int fnmatch_flags;
+       struct osl_object patterns;
+       void *data;
+       int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
+};
+
 /* afs */
 typedef int callback_function(const struct osl_object *, struct osl_object *);
 __noreturn int afs_init(uint32_t cookie, int socket_fd);
 int send_callback_request(callback_function *f, struct osl_object *query,
        struct osl_object *result);
-int send_standard_callback_request(int argc, const char **argv,
+int send_standard_callback_request(int argc, char * const * const argv,
                callback_function *f, struct osl_object *result);
 int send_option_arg_callback_request(struct osl_object *options,
-       int argc, const char **argv, callback_function *f,
+       int argc, char * const * const argv, callback_function *f,
        struct osl_object *result);
-int stdin_command(struct osl_object *arg_obj, callback_function *f,
+int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
                unsigned max_len, struct osl_object *result);
 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
 int para_atol(const char *str, long *result);
 int open_next_audio_file(struct audio_file_data *afd);
 int close_audio_file(struct audio_file_data *afd);
+int for_each_matching_row(struct pattern_match_data *pmd);
 
 /* score */
-int score_init(struct table_info *ti);
+int score_init(struct table_info *ti, const char *db);
 void score_shutdown(enum osl_close_flags flags);
 int admissible_file_loop(void *data, osl_rbtree_loop_func *func);
 int admissible_file_loop_reverse(void *data, osl_rbtree_loop_func *func);
@@ -122,18 +91,14 @@ int score_delete(const struct osl_row *aft_row);
 int row_belongs_to_score_table(const struct osl_row *aft_row);
 
 /* attribute */
-int attribute_init(struct table_info *ti);
+int attribute_init(struct table_info *ti, const char *db);
 void attribute_shutdown(enum osl_close_flags flags);
-void get_attribute_bitmap(uint64_t *atts, char *buf);
+void get_attribute_bitmap(const uint64_t *atts, char *buf); /* needed by com_ls() */
 int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum);
-int com_lsatt(int fd, int argc, const char **argv);
-int com_setatt(int fd, int argc, const char **argv);
-int com_addatt(int fd, int argc, const char **argv);
-int com_rmatt(int fd, int argc, const char **argv);
 int get_attribute_text(uint64_t *atts, const char *delim, char **text);
 
 /* aft */
-int aft_init(struct table_info *ti);
+int aft_init(struct table_info *ti, const char *db);
 void aft_shutdown(enum osl_close_flags flags);
 int aft_get_row_of_path(char *path, struct osl_row **row);
 int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd);
@@ -141,39 +106,37 @@ int load_afsi(struct afs_info *afsi, struct osl_object *obj);
 void save_afsi(struct afs_info *afsi, struct osl_object *obj);
 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
 int get_audio_file_path_of_row(const struct osl_row *row, char **path);
-int get_afsi_object_of_row(const void *row, struct osl_object *obj);
+int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
-int com_touch(int fd, int argc, const char **argv);
-int com_add(int fd, int argc, const char **argv);
-int com_afs_ls(int fd, int argc, const char **argv);
-int com_afs_rm(int fd, int argc, const char **argv);
+int aft_check_callback(const struct osl_object *query, struct osl_object *result);
 
 /* mood */
-int mood_open(char *mood_name);
-void mood_close(void);
+int change_current_mood(char *mood_name);
+void close_current_mood(void);
 int mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_afsi);
-int mood_reload(void);
+int reload_current_mood(void);
 int mood_delete_audio_file(const struct osl_row *aft_row);
+int mood_check_callback(__a_unused const struct osl_object *query,
+       struct osl_object *result);
 
 
 /* playlist */
 int playlist_open(char *name);
 void playlist_close(void);
 int playlist_update_audio_file(struct osl_row *aft_row);
+int playlist_check_callback(__a_unused const struct osl_object *query,
+       struct osl_object *result);
 
 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
 
 
 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
-       int table_name ## _init(struct table_info *ti); \
+       int table_name ## _init(struct table_info *ti, const char *db); \
        void table_name ## _shutdown(enum osl_close_flags flags); \
-       int com_add ## cmd_prefix(int fd, int argc, const char **argv); \
-       int com_rm ## cmd_prefix(int fd, int argc, const char **argv); \
-       int com_cat ## cmd_prefix(int fd, int argc, const char **argv); \
-       int com_ls ## cmd_prefix(int fd, int argc, const char **argv); \
-       int com_mv ## cmd_prefix(int fd, int argc, const char **argv); \
        int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
+       int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
+               char **name, struct osl_object *def); \
        extern struct osl_table *table_name ## _table;
 
 DECLARE_BLOB_SYMBOLS(lyrics, lyr);
@@ -181,10 +144,20 @@ DECLARE_BLOB_SYMBOLS(images, img);
 DECLARE_BLOB_SYMBOLS(moods, mood);
 DECLARE_BLOB_SYMBOLS(playlists, pl);
 
-enum blob_table_columns {BLOBCOL_ID, BLOBCOL_NAME, BLOBCOL_DEF, NUM_BLOB_COLUMNS};
+/** The columns of an abstract blob table. */
+enum blob_table_columns {
+       /** The identifier, a positive integer that never repeats. */
+       BLOBCOL_ID,
+       /** The unique name of the blob. */
+       BLOBCOL_NAME,
+       /** The actual blob contents. */
+       BLOBCOL_DEF,
+       /** A blob table has that many columns. */
+       NUM_BLOB_COLUMNS
+};
+
 #define DEFINE_BLOB_TABLE_DESC(table_name) \
-       const struct osl_table_description table_name ## _table_desc = { \
-               .dir = DATABASE_DIR, \
+       struct osl_table_description table_name ## _table_desc = { \
                .name = #table_name, \
                .num_columns = NUM_BLOB_COLUMNS, \
                .flags = OSL_LARGE_TABLE, \