| 1 | /* |
| 2 | * This file is part of DisOrder |
| 3 | * Copyright (C) 2005-2008 Richard Kettlewell |
| 4 | * |
| 5 | * This program is free software: you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License as published by |
| 7 | * the Free Software Foundation, either version 3 of the License, or |
| 8 | * (at your option) any later version. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License |
| 16 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 17 | */ |
| 18 | /** @file lib/trackname.h |
| 19 | * @brief Track name calculation |
| 20 | */ |
| 21 | #ifndef TRACKNAME_H |
| 22 | #define TRACKNAME_H |
| 23 | |
| 24 | const struct collection *find_track_collection(const char *track); |
| 25 | /* find the collection for @track@ */ |
| 26 | |
| 27 | const char *find_track_root(const char *track); |
| 28 | /* find the collection root for @track@ */ |
| 29 | |
| 30 | const char *track_rootless(const char *track); |
| 31 | /* return the rootless part of @track@ (typically starting /) */ |
| 32 | |
| 33 | const char *trackname_part(const char *track, |
| 34 | const char *context, |
| 35 | const char *part); |
| 36 | /* compute PART (artist/album/title) for TRACK in CONTEXT (display/sort) */ |
| 37 | |
| 38 | const char *trackname_transform(const char *type, |
| 39 | const char *subject, |
| 40 | const char *context); |
| 41 | /* convert SUBJECT (usually 'track' or 'dir' according to TYPE) for CONTEXT |
| 42 | * (display/sort) */ |
| 43 | |
| 44 | int compare_tracks(const char *sa, const char *sb, |
| 45 | const char *da, const char *db, |
| 46 | const char *ta, const char *tb); |
| 47 | /* Compare tracks A and B, with sort/display/track names S?, D? and T? */ |
| 48 | |
| 49 | int compare_path_raw(const unsigned char *ap, size_t an, |
| 50 | const unsigned char *bp, size_t bn); |
| 51 | /* Comparison function for path names that groups all entries in a directory |
| 52 | * together */ |
| 53 | |
| 54 | /** @brief Compare two paths |
| 55 | * @param ap First path |
| 56 | * @param bp Second path |
| 57 | * @return -ve, 0 or +ve for ap <, = or > bp |
| 58 | * |
| 59 | * Sorts files within a directory together. |
| 60 | * A wrapper around compare_path_raw(). |
| 61 | */ |
| 62 | static inline int compare_path(const char *ap, const char *bp) { |
| 63 | return compare_path_raw((const unsigned char *)ap, strlen(ap), |
| 64 | (const unsigned char *)bp, strlen(bp)); |
| 65 | } |
| 66 | |
| 67 | /** @brief Entry in a list of tracks or directories */ |
| 68 | struct tracksort_data { |
| 69 | /** @brief Track name */ |
| 70 | const char *track; |
| 71 | /** @brief Sort key */ |
| 72 | const char *sort; |
| 73 | /** @brief Display key */ |
| 74 | const char *display; |
| 75 | }; |
| 76 | |
| 77 | struct tracksort_data *tracksort_init(int nvec, |
| 78 | char **vec, |
| 79 | const char *type); |
| 80 | |
| 81 | #endif /* TRACKNAME_H */ |
| 82 | |
| 83 | /* |
| 84 | Local Variables: |
| 85 | c-basic-offset:2 |
| 86 | comment-column:40 |
| 87 | fill-column:79 |
| 88 | End: |
| 89 | */ |