New refresh_min option to bound below the web interface refresh

[disorder] / lib / trackname.h

diff --git a/lib/trackname.h b/lib/trackname.h
index b40c626ddfbca9837bc61a513643f08cb56d8de0..56f933ee95682d21911e856f2d3255b7018585b7 100644 (file)
--- a/lib/trackname.h
+++ b/lib/trackname.h
@@ -1,26 +1,29 @@
 /*
  * This file is part of DisOrder
- * Copyright (C) 2005, 2006 Richard Kettlewell
+ * Copyright (C) 2005-2008 Richard Kettlewell
  *
- * This program is free software; you can redistribute it and/or modify
+ * 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
+ * the Free Software Foundation, either version 3 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.
- *
+ * 
+ * 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
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+/** @file lib/trackname.h
+ * @brief Track name calculation
  */
-
 #ifndef TRACKNAME_H
 #define TRACKNAME_H
 
+const struct collection *find_track_collection(const char *track);
+/* find the collection for @track@ */
+
 const char *find_track_root(const char *track);
 /* find the collection root for @track@ */
 
@@ -48,12 +51,33 @@ int compare_path_raw(const unsigned char *ap, size_t an,
 /* Comparison function for path names that groups all entries in a directory
  * together */
 
-/* Convenient wrapper for compare_path_raw */
+/** @brief Compare two paths
+ * @param ap First path
+ * @param bp Second path
+ * @return -ve, 0 or +ve for ap <, = or > bp
+ *
+ * Sorts files within a directory together.
+ * A wrapper around compare_path_raw().
+ */
 static inline int compare_path(const char *ap, const char *bp) {
   return compare_path_raw((const unsigned char *)ap, strlen(ap),
                          (const unsigned char *)bp, strlen(bp));
 }
 
+/** @brief Entry in a list of tracks or directories */
+struct tracksort_data {
+  /** @brief Track name */
+  const char *track;
+  /** @brief Sort key */
+  const char *sort;
+  /** @brief Display key */
+  const char *display;
+};
+
+struct tracksort_data *tracksort_init(int nvec,
+                                      char **vec,
+                                      const char *type);
+
 #endif /* TRACKNAME_H */
 
 /*