X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=afs.h;h=9a1d7d9ca0f130c4590f55c23abc181b632c6483;hb=a5a6446fd1af4a0ad03ef06a3c194d37d6a46acd;hp=2f9d7e5fc40bdc9c1661336ffce20d7a7df76148;hpb=c2396d21b32adec8a94bdae47d66bdc492779775;p=paraslash.git

diff --git a/afs.h b/afs.h
index 2f9d7e5f..9a1d7d9c 100644
--- a/afs.h
+++ b/afs.h
@@ -1,8 +1,4 @@
-/*
- * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
 /** \file afs.h Exported symbols of the audio file selector. */
 
@@ -77,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);
 };
@@ -141,12 +133,14 @@ struct pattern_match_data {
 	unsigned loop_col_num;
 	/** Data from this column is matched against the given patterns. */
 	unsigned match_col_num;
-	/** \see pattern_match_flags. */
+	/** \see \ref pattern_match_flags. */
 	unsigned pm_flags;
 	/** This value is passed verbatim to fnmatch(). */
 	int fnmatch_flags;
-	/** Null-terminated array of patterns. */
-	struct osl_object patterns;
+	/** Obtained by deserializing the query buffer in the callback. */
+	struct lls_parse_result *lpr;
+	/** Do not try to match the first inputs of lpr */
+	unsigned input_skip;
 	/** Data pointer passed to the action function. */
 	void *data;
 	/** Gets increased by one for each match. */
@@ -163,24 +157,37 @@ struct afs_callback_arg {
 	struct osl_object query;
 	/** Will be written on band SBD_OUTPUT, fully buffered. */
 	struct para_buffer pbout;
+	/**
+	 * Convenience pointer for the deserialized parse result.
+	 *
+	 * Most afs command handlers call \ref send_lls_callback_request() to
+	 * serialize the parse result of the subcommand and pass it to the
+	 * callback. In afs context a pointer to the deserialized parse result
+	 * is stored here.
+	 */
+	struct lls_parse_result *lpr;
 };
 
 /**
+ * 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
  * handler and the corresponding callback function that runs in afs context.
  *
- * \sa send_callback_request().
+ * \sa \ref send_callback_request().
  */
 typedef int afs_callback(struct afs_callback_arg *aca);
 
 /**
- * Callbacks send chunks to data back to the command handler. Pointers to
- * this type of function are used by \ref send_callback_request and friends
- * to deal with the data in the command handler process.
+ * Dispatch the output of an afs callback.
  *
- * \sa \ref send_callback_request().
+ * 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. 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);
@@ -215,56 +222,59 @@ _static_inline_ int afs_max_size_handler(char *buf, size_t size, void *private)
 	return pass_buffer_as_shm(amshd->fd, amshd->band, buf, size);
 }
 
-__noreturn void afs_init(uint32_t cookie, int socket_fd);
+__noreturn void afs_init(int socket_fd);
 __must_check int afs_event(enum afs_events event, struct para_buffer *pb,
 	void *data);
 int send_callback_request(afs_callback *f, struct osl_object *query,
 		callback_result_handler *result_handler,
 		void *private_result_data);
-int send_option_arg_callback_request(struct osl_object *options,
-		int argc,  char * const * const argv, afs_callback *f,
-		callback_result_handler *result_handler,
-		void *private_result_data);
-int send_standard_callback_request(int argc,  char * const * const argv,
-		afs_callback *f, callback_result_handler *result_handler,
-		void *private_result_data);
+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 admissible_file_loop(void *data, osl_rbtree_loop_func *func);
+extern const struct afs_table_operations score_ops;
+int score_loop(osl_rbtree_loop_func *func, 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_update(const struct osl_row *aft_row, long new_score);
-int get_num_admissible_files(unsigned *num);
 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(struct audio_file_data *afd);
+int open_and_update_audio_file(int *fd);
 int load_afd(int shmid, struct audio_file_data *afd);
 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi);
 int get_audio_file_path_of_row(const struct osl_row *row, char **path);
 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
 int aft_check_callback(struct afs_callback_arg *aca);
+void free_status_items(void);
+
+/* mood */
+int mood_load(const char *mood_name, char **msg);
+void mood_unload(void);
+int mood_check_callback(struct afs_callback_arg *aca);
 
 /* playlist */
-int playlist_open(const char *name);
-void playlist_close(void);
+int playlist_load(const char *name, char **msg);
+void playlist_unload(void);
 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 */
@@ -273,20 +283,22 @@ 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(char *name, struct osl_object *def); \
+	int cmd_prefix ## _get_def_by_name(const char *name, struct osl_object *def); \
 	int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
 		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);
 DECLARE_BLOB_SYMBOLS(images, img);
 DECLARE_BLOB_SYMBOLS(moods, mood);
 DECLARE_BLOB_SYMBOLS(playlists, pl);
+/** \endcond blob_symbols */
 
 /** The columns of an abstract blob table. */
 enum blob_table_columns {