X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=8beca5aefcd0b9d06aed05e915877a2c5104a1a8;hp=3d13aea277d7459e9fd36d194cc4ff710473022c;hb=e8d5da94efd6cbb0aa75f57290c76d9992ff8f47;hpb=f57f71019a272c7e5a29a10da55a8ef2bed5de71

diff --git a/afs.h b/afs.h
index 3d13aea2..8beca5ae 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. */
 
@@ -141,14 +137,12 @@ 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;
 	/** Obtained by deserializing the query buffer in the callback. */
 	struct lls_parse_result *lpr;
-	/** Null-terminated array of patterns. */
-	struct osl_object patterns;
 	/** Do not try to match the first inputs of lpr */
 	unsigned input_skip;
 	/** Data pointer passed to the action function. */
@@ -167,6 +161,14 @@ 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;
 };
 
@@ -176,16 +178,14 @@ struct afs_callback_arg {
  * 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.
- *
- * \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.
  */
 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);
@@ -220,19 +220,12 @@ _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);