split up queue.c to remove -ldl dependency from clients

[disorder] / server / server-queue.h

diff --git a/server/server-queue.h b/server/server-queue.h
new file mode 100644 (file)
index 0000000..624f203
--- /dev/null
+++ b/server/server-queue.h
@@ -0,0 +1,82 @@
+/*
+ * This file is part of DisOrder.
+ * Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+ * USA
+ */
+
+#ifndef SERVER_QUEUE_H
+#define SERVER_QUEUE_H
+
+extern struct queue_entry qhead;
+/* queue of things yet to be played.  the head will be played
+ * soonest. */
+
+extern struct queue_entry phead;
+/* things that have been played in the past.  the head is the oldest. */
+
+void queue_read(void);
+/* read the queue in.  Calls @fatal@ on error. */
+
+void queue_write(void);
+/* write the queue out.  Calls @fatal@ on error. */
+
+void recent_read(void);
+/* read the recently played list in.  Calls @fatal@ on error. */
+
+void recent_write(void);
+/* write the recently played list out.  Calls @fatal@ on error. */
+
+struct queue_entry *queue_add(const char *track, const char *submitter,
+                             int where);
+#define WHERE_START 0                  /* Add to head of queue */
+#define WHERE_END 1                    /* Add to end of queue */
+#define WHERE_BEFORE_RANDOM 2          /* End, or before random track */
+/* add an entry to the queue.  Return a pointer to the new entry. */
+
+void queue_remove(struct queue_entry *q, const char *who);
+/* remove an from the queue */
+
+struct queue_entry *queue_find(const char *key);
+/* find a track in the queue by name or ID */
+
+void queue_played(struct queue_entry *q);
+/* add @q@ to the played list */
+
+int queue_move(struct queue_entry *q, int delta, const char *who);
+/* move element @q@ in the queue towards the front (@delta@ > 0) or towards the
+ * back (@delta@ < 0).  The return value is the leftover delta once we've hit
+ * the end in whichever direction we were going. */
+
+void queue_moveafter(struct queue_entry *target,
+                    int nqs, struct queue_entry **qs, const char *who);
+/* Move all the elements QS to just after TARGET, or to the head if
+ * TARGET=0. */
+
+void queue_fix_sofar(struct queue_entry *q);
+/* Fix up the sofar field for standalone players */
+
+#endif /* SERVER_QUEUE_H */
+
+
+/*
+Local Variables:
+c-basic-offset:2
+comment-column:40
+fill-column:79
+indent-tabs-mode:nil
+End:
+*/