X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=afs.h;h=ab2db3aa1f90c561732abc34b528f0a7b20f1ebb;hb=c458b9d45e7c6ddda6285fca3797fddff815bd0a;hp=546a19ec3767cb6500dff2e0e53bca8561eaa147;hpb=bf04447eb634a2e9ac3e644e48386597fecca9ee;p=paraslash.git

diff --git a/afs.h b/afs.h
index 546a19ec..ab2db3aa 100644
--- a/afs.h
+++ b/afs.h
@@ -4,6 +4,8 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
+/** \file afs.h Exported symbos of the audio file selector. */
+
 #include <regex.h>
 #include "osl.h"
 #include "hash.h"
@@ -42,26 +44,39 @@ struct audio_file_data {
 	struct osl_object map;
 };
 
+/** Flags passed to for_each_matching_row(). */
 enum pattern_match_flags {
+	/** Loop in reverse order. */
 	PM_REVERSE_LOOP = 1,
+	/** If no pattern is given, loop over all rows. */
 	PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
+	/** If the data in match_column is the empty string, skip this row. */
 	PM_SKIP_EMPTY_NAME = 4,
 };
 
+/** Structure passed to for_each_matching_row(). */
 struct pattern_match_data {
+	/** Loop over all rows in this table. */
 	struct osl_table *table;
+	/** Determines the loop order. Must be an rbtree column. */
 	unsigned loop_col_num;
+	/** Data from this column is matched against the given patterns. */
 	unsigned match_col_num;
+	/** \see 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;
+	/** Data pointer passed to the action function. */
 	void *data;
+	/** For each matching row, this function will be called. */
 	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);
+__noreturn void 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, char * const * const argv,
@@ -99,12 +114,13 @@ int get_attribute_text(uint64_t *atts, const char *delim, char **text);
 /* aft */
 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 aft_get_row_of_path(const char *path, struct osl_row **row);
 int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd);
 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_afhi_of_row(const struct osl_row *row, struct audio_format_info *afhi);
+int get_afsi_of_path(const char *path, 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 struct osl_row *row, struct osl_object *obj);
 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);