1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
/*
* Copyright (C) 2012-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "DatabaseUtils.h"
#include "LabelFormatter.h"
#include "SortFileItem.h"
#include <map>
#include <memory>
#include <string>
#include <vector>
typedef enum {
SortOrderNone = 0,
SortOrderAscending,
SortOrderDescending
} SortOrder;
typedef enum {
SortAttributeNone = 0x0,
SortAttributeIgnoreArticle = 0x1,
SortAttributeIgnoreFolders = 0x2,
SortAttributeUseArtistSortName = 0x4,
SortAttributeIgnoreLabel = 0x8
} SortAttribute;
typedef enum {
SortSpecialNone = 0,
SortSpecialOnTop = 1,
SortSpecialOnBottom = 2
} SortSpecial;
///
/// \defgroup List_of_sort_methods List of sort methods
/// \addtogroup List_of_sort_methods
///
/// \brief These ID's can be used with the \ref built_in_functions_6 "Container.SetSortMethod(id)" function
/// \note The on field named part with <b>String</b> shows the string used on
/// GUI to set this sort type.
///
///@{
typedef enum {
/// __0__ :
SortByNone = 0,
/// __1__ : Sort by Name <em>(String: <b><c>Label</c></b>)</em>
SortByLabel,
/// __2__ : Sort by Date <em>(String: <b><c>Date</c></b>)</em>
SortByDate,
/// __3__ : Sort by Size <em>(String: <b><c>Size</c></b>)</em>
SortBySize,
/// __4__ : Sort by filename <em>(String: <b><c>File</c></b>)</em>
SortByFile,
/// __5__ : Sort by path <em>(String: <b><c>Path</c></b>)</em>
SortByPath,
/// __6__ : Sort by drive type <em>(String: <b><c>DriveType</c></b>)</em>
SortByDriveType,
/// __7__ : Sort by title <em>(String: <b><c>Title</c></b>)</em>
SortByTitle,
/// __8__ : Sort by track number <em>(String: <b><c>TrackNumber</c></b>)</em>
SortByTrackNumber,
/// __9__ : Sort by time <em>(String: <b><c>Time</c></b>)</em>
SortByTime,
/// __10__ : Sort by artist <em>(String: <b><c>Artist</c></b>)</em>
SortByArtist,
/// __11__ : Sort by first artist then year <em>(String: <b><c>ArtistYear</c></b>)</em>
SortByArtistThenYear,
/// __12__ : Sort by album <em>(String: <b><c>Album</c></b>)</em>
SortByAlbum,
/// __13__ : Sort by album type <em>(String: <b><c>AlbumType</c></b>)</em>
SortByAlbumType,
/// __14__ : Sort by genre <em>(String: <b><c>Genre</c></b>)</em>
SortByGenre,
/// __15__ : Sort by country <em>(String: <b><c>Country</c></b>)</em>
SortByCountry,
/// __16__ : Sort by year <em>(String: <b><c>Year</c></b>)</em>
SortByYear,
/// __17__ : Sort by rating <em>(String: <b><c>Rating</c></b>)</em>
SortByRating,
/// __18__ : Sort by user rating <em>(String: <b><c>UserRating</c></b>)</em>
SortByUserRating,
/// __19__ : Sort by votes <em>(String: <b><c>Votes</c></b>)</em>
SortByVotes,
/// __20__ : Sort by top 250 <em>(String: <b><c>Top250</c></b>)</em>
SortByTop250,
/// __21__ : Sort by program count <em>(String: <b><c>ProgramCount</c></b>)</em>
SortByProgramCount,
/// __22__ : Sort by playlist order <em>(String: <b><c>Playlist</c></b>)</em>
SortByPlaylistOrder,
/// __23__ : Sort by episode number <em>(String: <b><c>Episode</c></b>)</em>
SortByEpisodeNumber,
/// __24__ : Sort by season <em>(String: <b><c>Season</c></b>)</em>
SortBySeason,
/// __25__ : Sort by number of episodes <em>(String: <b><c>TotalEpisodes</c></b>)</em>
SortByNumberOfEpisodes,
/// __26__ : Sort by number of watched episodes <em>(String: <b><c>WatchedEpisodes</c></b>)</em>
SortByNumberOfWatchedEpisodes,
/// __27__ : Sort by TV show status <em>(String: <b><c>TvShowStatus</c></b>)</em>
SortByTvShowStatus,
/// __28__ : Sort by TV show title <em>(String: <b><c>TvShowTitle</c></b>)</em>
SortByTvShowTitle,
/// __29__ : Sort by sort title <em>(String: <b><c>SortTitle</c></b>)</em>
SortBySortTitle,
/// __30__ : Sort by production code <em>(String: <b><c>ProductionCode</c></b>)</em>
SortByProductionCode,
/// __31__ : Sort by MPAA <em>(String: <b><c>MPAA</c></b>)</em>
SortByMPAA,
/// __32__ : Sort by video resolution <em>(String: <b><c>VideoResolution</c></b>)</em>
SortByVideoResolution,
/// __33__ : Sort by video codec <em>(String: <b><c>VideoCodec</c></b>)</em>
SortByVideoCodec,
/// __34__ : Sort by video aspect ratio <em>(String: <b><c>VideoAspectRatio</c></b>)</em>
SortByVideoAspectRatio,
/// __35__ : Sort by audio channels <em>(String: <b><c>AudioChannels</c></b>)</em>
SortByAudioChannels,
/// __36__ : Sort by audio codec <em>(String: <b><c>AudioCodec</c></b>)</em>
SortByAudioCodec,
/// __37__ : Sort by audio language <em>(String: <b><c>AudioLanguage</c></b>)</em>
SortByAudioLanguage,
/// __38__ : Sort by subtitle language <em>(String: <b><c>SubtitleLanguage</c></b>)</em>
SortBySubtitleLanguage,
/// __39__ : Sort by studio <em>(String: <b><c>Studio</c></b>)</em>
SortByStudio,
/// __40__ : Sort by date added <em>(String: <b><c>DateAdded</c></b>)</em>
SortByDateAdded,
/// __41__ : Sort by last played <em>(String: <b><c>LastPlayed</c></b>)</em>
SortByLastPlayed,
/// __42__ : Sort by playcount <em>(String: <b><c>PlayCount</c></b>)</em>
SortByPlaycount,
/// __43__ : Sort by listener <em>(String: <b><c>Listeners</c></b>)</em>
SortByListeners,
/// __44__ : Sort by bitrate <em>(String: <b><c>Bitrate</c></b>)</em>
SortByBitrate,
/// __45__ : Sort by random <em>(String: <b><c>Random</c></b>)</em>
SortByRandom,
/// __46__ : Sort by channel <em>(String: <b><c>Channel</c></b>)</em>
SortByChannel,
/// __47__ : Sort by channel number <em>(String: <b><c>ChannelNumber</c></b>)</em>
SortByChannelNumber,
/// __48__ : Sort by date taken <em>(String: <b><c>DateTaken</c></b>)</em>
SortByDateTaken,
/// __49__ : Sort by relevance
SortByRelevance,
/// __50__ : Sort by installation date <en>(String: <b><c>installdate</c></b>)</em>
SortByInstallDate,
/// __51__ : Sort by last updated <en>(String: <b><c>lastupdated</c></b>)</em>
SortByLastUpdated,
/// __52__ : Sort by last used <em>(String: <b><c>lastused</c></b>)</em>
SortByLastUsed,
/// __53__ : Sort by client channel order <em>(String: <b><c>ClientChannelOrder</c></b>)</em>
SortByClientChannelOrder,
/// __54__ : Sort by total number of discs <em>(String: <b><c>totaldiscs</c></b>)</em>
SortByTotalDiscs,
/// __55__ : Sort by original release date <em>(String: <b><c>Originaldate</c></b>)</em>
SortByOrigDate,
/// __56__ : Sort by BPM <em>(String: <b><c>bpm</c></b>)</em>
SortByBPM,
} SortBy;
///@}
typedef struct SortDescription {
SortBy sortBy = SortByNone;
SortOrder sortOrder = SortOrderAscending;
SortAttribute sortAttributes = SortAttributeNone;
int limitStart = 0;
int limitEnd = -1;
} SortDescription;
typedef struct GUIViewSortDetails
{
SortDescription m_sortDescription;
int m_buttonLabel;
LABEL_MASKS m_labelMasks;
} GUIViewSortDetails;
typedef DatabaseResult SortItem;
typedef std::shared_ptr<SortItem> SortItemPtr;
typedef std::vector<SortItemPtr> SortItems;
class SortUtils
{
public:
static SORT_METHOD TranslateOldSortMethod(SortBy sortBy, bool ignoreArticle);
static SortDescription TranslateOldSortMethod(SORT_METHOD sortBy);
static SortBy SortMethodFromString(const std::string& sortMethod);
static const std::string& SortMethodToString(SortBy sortMethod);
static SortOrder SortOrderFromString(const std::string& sortOrder);
static const std::string& SortOrderToString(SortOrder sortOrder);
/*! \brief retrieve the label id associated with a sort method for displaying in the UI.
\param sortBy the sort method in question.
\return the label id of the sort method.
*/
static int GetSortLabel(SortBy sortBy);
static void Sort(SortBy sortBy, SortOrder sortOrder, SortAttribute attributes, DatabaseResults& items, int limitEnd = -1, int limitStart = 0);
static void Sort(SortBy sortBy, SortOrder sortOrder, SortAttribute attributes, SortItems& items, int limitEnd = -1, int limitStart = 0);
static void Sort(const SortDescription &sortDescription, DatabaseResults& items);
static void Sort(const SortDescription &sortDescription, SortItems& items);
static bool SortFromDataset(const SortDescription &sortDescription, const MediaType &mediaType, const std::unique_ptr<dbiplus::Dataset> &dataset, DatabaseResults &results);
static void GetFieldsForSQLSort(const MediaType& mediaType, SortBy sortMethod, FieldList& fields);
static const Fields& GetFieldsForSorting(SortBy sortBy);
static std::string RemoveArticles(const std::string &label);
typedef std::string (*SortPreparator) (SortAttribute, const SortItem&);
typedef bool (*Sorter) (const DatabaseResult &, const DatabaseResult &);
typedef bool (*SorterIndirect) (const SortItemPtr &, const SortItemPtr &);
private:
static const SortPreparator& getPreparator(SortBy sortBy);
static Sorter getSorter(SortOrder sortOrder, SortAttribute attributes);
static SorterIndirect getSorterIndirect(SortOrder sortOrder, SortAttribute attributes);
static std::map<SortBy, SortPreparator> m_preparators;
static std::map<SortBy, Fields> m_sortingFields;
};
|
