X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=afs.h;h=e8b8c865bda36b9f905b2c1cb435d03bc12d3cbd;hb=refs%2Fheads%2Fmaster;hp=1c54a1bdc9a820fd2801a740432b4098deccd2f2;hpb=2bc9900a9712dc70b694425857d6b7293b23a887;p=paraslash.git

diff --git a/afs.h b/afs.h
index 1c54a1bd..e8b8c865 100644
--- a/afs.h
+++ b/afs.h
@@ -73,19 +73,15 @@ struct afsi_change_event_data {
 	struct afs_info *old_afsi;
 };
 
-/** Function pointers for table handling.  */
-struct afs_table {
-	/** Initializes the other pointers in this struct. */
-	void (*init)(struct afs_table *t);
-	/** The name of this table. */
-	const char *name;
-	/** Gets called on startup and on \p SIGHUP. */
+/** Methods for table startup/shutdown and event handling. */
+struct afs_table_operations {
+	/** Gets called on startup and on SIGHUP. */
 	int (*open)(const char *base_dir);
-	/** Gets called on shutdown and on \p SIGHUP. */
+	/** Gets called on shutdown and on SIGHUP. */
 	void (*close)(void);
-	/** Called by the \a init afs command. */
+	/** Called from the init command. */
 	int (*create)(const char *);
-	/** Handles afs events. */
+	/** Handle events generated by other tables. See enum \ref afs_events. */
 	int (*event_handler)(enum afs_events event, struct para_buffer *pb,
 		void *data);
 };
@@ -173,6 +169,8 @@ struct afs_callback_arg {
 };
 
 /**
+ * The "top half" of an afs command.
+ *
  * Afs command handlers run as a process which is not related to the afs
  * process, i.e. they can not change the address space of afs directly.
  * Therefore afs commands typically consist of two functions: The command
@@ -183,9 +181,13 @@ struct afs_callback_arg {
 typedef int afs_callback(struct afs_callback_arg *aca);
 
 /**
+ * Dispatch the output of an afs callback.
+ *
  * Some AFS callbacks need to send data back to the command handler. Pointers
  * to this type of function are passed to \ref send_callback_request() and
- * related functions to dispatch the data in the command handler process.
+ * related functions to dispatch the data in the command handler process. Most
+ * (but not all) afs commands pass \ref afs_cb_result_handler(), which sends
+ * the output of the callback to the connected client.
  */
 typedef int callback_result_handler(struct osl_object *result, uint8_t band, void *private);
 int afs_cb_result_handler(struct osl_object *result, uint8_t band, void *private);
@@ -229,29 +231,33 @@ int send_callback_request(afs_callback *f, struct osl_object *query,
 int send_lls_callback_request(afs_callback *f,
 		const struct lls_command * const cmd,
 		struct lls_parse_result *lpr, void *private_result_data);
+__printf_2_3 void afs_error(const struct afs_callback_arg *aca,
+		const char *fmt,...);
 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
 int for_each_matching_row(struct pattern_match_data *pmd);
 
 /* score */
-void score_init(struct afs_table *t);
-int score_loop(osl_rbtree_loop_func *func, void *data);
+extern const struct afs_table_operations score_ops;
+void score_open(struct osl_table **result);
+void score_close(struct osl_table *t);
+int score_loop(osl_rbtree_loop_func *func, struct osl_table *t, void *data);
 int score_get_best(struct osl_row **aft_row, long *score);
 int get_score_and_aft_row(struct osl_row *score_row, long *score, struct osl_row **aft_row);
-int score_add(const struct osl_row *row, long score);
+int score_add(const struct osl_row *aft_row, long score, struct osl_table *t);
 int score_update(const struct osl_row *aft_row, long new_score);
 int score_delete(const struct osl_row *aft_row);
-int clear_score_table(void);
-int row_belongs_to_score_table(const struct osl_row *aft_row, unsigned *rank);
+void score_clear(void);
+bool row_belongs_to_score_table(const struct osl_row *aft_row);
 
 /* attribute */
-void attribute_init(struct afs_table *t);
+extern const struct afs_table_operations attr_ops;
 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 get_attribute_text(uint64_t *atts, const char *delim, char **text);
 int attribute_check_callback(struct afs_callback_arg *aca);
 
 /* aft */
-void aft_init(struct afs_table *t);
+extern const struct afs_table_operations aft_ops;
 int aft_get_row_of_path(const char *path, struct osl_row **row);
 int aft_check_attributes(uint64_t att_mask, struct para_buffer *pb);
 int open_and_update_audio_file(int *fd);
@@ -264,13 +270,17 @@ int aft_check_callback(struct afs_callback_arg *aca);
 void free_status_items(void);
 
 /* mood */
-int mood_switch(const char *mood_name, char **errmsg);
-void close_current_mood(void);
+struct mood_instance;
+int mood_load(const char *mood_name, struct mood_instance **result, char **msg);
+int mood_loop(struct mood_instance *m, osl_rbtree_loop_func *func, void *data);
+void mood_unload(struct mood_instance *m);
 int mood_check_callback(struct afs_callback_arg *aca);
 
 /* playlist */
-int playlist_open(const char *name, char **errmsg);
-void playlist_close(void);
+struct playlist_instance;
+int playlist_load(const char *name, struct playlist_instance **result, char **msg);
+int playlist_loop(struct playlist_instance *pi, osl_rbtree_loop_func *func, void *data);
+void playlist_unload(struct playlist_instance *pi);
 int playlist_check_callback(struct afs_callback_arg *aca);
 
 /** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
@@ -279,7 +289,6 @@ int playlist_check_callback(struct afs_callback_arg *aca);
 
 /** Define exported functions and a table pointer for an osl blob table. */
 #define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
-	void table_name ## _init(struct afs_table *t); \
 	int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
 	int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
 	int cmd_prefix ## _get_def_by_name(const char *name, struct osl_object *def); \
@@ -287,7 +296,8 @@ int playlist_check_callback(struct afs_callback_arg *aca);
 		char **name, struct osl_object *def); \
 	int table_name ##_event_handler(enum afs_events event, \
 		struct para_buffer *pb, void *data); \
-	extern struct osl_table *table_name ## _table;
+	extern struct osl_table *table_name ## _table; \
+	extern const struct afs_table_operations table_name ## _ops;
 
 /** \cond blob_symbols */
 DECLARE_BLOB_SYMBOLS(lyrics, lyr);