X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=d0c162fb376278c021b0f1092ae763bf615e4392;hp=4d3feb4840ec21f4d315c0a2fce9926377e6d9e9;hb=d9f939fe8a68267a62b68546b17e1ec9a34aab0b;hpb=d894e0cc7ce94d09847a8a35f47127968d4268f1

diff --git a/afs.h b/afs.h
index 4d3feb48..d0c162fb 100644
--- a/afs.h
+++ b/afs.h
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file afs.h Exported symbos of the audio file selector. */
+/** \file afs.h Exported symbols of the audio file selector. */
 
 #include <regex.h>
 #include "osl.h"
@@ -26,19 +26,37 @@ struct afs_info {
 	uint8_t audio_format_id;
 };
 
+/**
+ * Events caused by changes to an afs table.
+ *
+ * Whenever an afs table changes, an event is generated which causes afs to
+ * call the event handlers of all other tables. For example, if an audio file
+ * is added, the event handler of the mood table checks the new file for
+ * admissibility.
+ */
 enum afs_events {
+	/** An attribute was added. */
 	ATTRIBUTE_ADD,
+	/** An attribute was renamed. */
 	ATTRIBUTE_RENAME,
+	/** An attribute was removed. */
 	ATTRIBUTE_REMOVE,
+	/** The afs info struct of an audio file changed. */
 	AFSI_CHANGE,
+	/** The afh info struct of an audio file changed. */
 	AFHI_CHANGE,
+	/** An audio file was renamed. */
 	AUDIO_FILE_RENAME,
+	/** An audio file was added. */
 	AUDIO_FILE_ADD,
+	/** An audio file is about to be removed. */
 	AUDIO_FILE_REMOVE,
+	/** A new blob was added. */
 	BLOB_ADD,
+	/** A blob was renamed. */
 	BLOB_RENAME,
+	/** A blob is about to be removed. */
 	BLOB_REMOVE,
-
 };
 
 struct rmatt_event_data {
@@ -47,22 +65,24 @@ struct rmatt_event_data {
 };
 
 
-struct addatt_event_data {
-	const char *name;
-	unsigned char bitnum;
-};
-
 struct afsi_change_event_data {
 	const struct osl_row *aft_row;
 	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. */
 	int (*open)(const char *base_dir);
+	/** Gets called on shutdown and on \p SIGHUP. */
 	void (*close)(void);
+	/** Called by the \a init afs command. */
 	int (*create)(const char *);
+	/** Handles afs events. */
 	int (*event_handler)(enum afs_events event, struct para_buffer *pb,
 		void *data);
 	/* int *(check)() */
@@ -72,11 +92,12 @@ enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
 
 struct audio_file_data {
 	enum play_mode current_play_mode;
+	char attributes_string[MAXLINE];
+	char path[_POSIX_PATH_MAX];
 	int fd;
 	long score;
 	struct afs_info afsi;
-	struct audio_format_info afhi;
-	char *path;
+	struct afh_info afhi;
 };
 
 enum afs_server_code {
@@ -159,7 +180,7 @@ int load_afd(int shmid, 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_afhi_of_row(const struct osl_row *row, struct afh_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);
@@ -177,7 +198,6 @@ int mood_check_callback(__a_unused const struct osl_object *query,
 /* 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);
 
@@ -185,6 +205,7 @@ int playlist_check_callback(__a_unused const struct osl_object *query,
 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
 
 
+/** 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); \
@@ -213,6 +234,7 @@ enum blob_table_columns {
 	NUM_BLOB_COLUMNS
 };
 
+/** Define an osl table decription for a blob table. */
 #define DEFINE_BLOB_TABLE_DESC(table_name) \
 	struct osl_table_description table_name ## _table_desc = { \
 		.name = #table_name, \
@@ -221,8 +243,10 @@ enum blob_table_columns {
 		.column_descriptions = blob_cols \
 	};
 
+/** Define a pointer to an osl blob table with a canonical name. */
 #define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
 
+/** Define a blob table. */
 #define INIT_BLOB_TABLE(table_name) \
 	DEFINE_BLOB_TABLE_DESC(table_name); \
 	DEFINE_BLOB_TABLE_PTR(table_name);