mpd/src/db/Selection.hxx
2021-10-13 12:07:05 +02:00

76 lines
1.9 KiB
C++

/*
* Copyright 2003-2021 The Music Player Daemon Project
* http://www.musicpd.org
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef MPD_DATABASE_SELECTION_HXX
#define MPD_DATABASE_SELECTION_HXX
#include "protocol/RangeArg.hxx"
#include "tag/Type.h"
#include <string>
class SongFilter;
struct LightSong;
struct DatabaseSelection {
/**
* The base URI of the search (UTF-8). Must not begin or end
* with a slash. An empty string searches the whole database.
*/
std::string uri;
const SongFilter *filter;
RangeArg window = RangeArg::All();
/**
* Sort the result by the given tag. #TAG_NUM_OF_ITEM_TYPES
* means don't sort. #SORT_TAG_LAST_MODIFIED sorts by
* "Last-Modified" (not technically a tag).
*/
TagType sort = TAG_NUM_OF_ITEM_TYPES;
/**
* If #sort is set, this flag can reverse the sort order.
*/
bool descending = false;
/**
* Recursively search all sub directories?
*/
bool recursive;
DatabaseSelection(const char *_uri, bool _recursive,
const SongFilter *_filter=nullptr) noexcept;
[[gnu::pure]]
bool IsEmpty() const noexcept;
/**
* Does this selection contain constraints other than "base"?
*/
[[gnu::pure]]
bool HasOtherThanBase() const noexcept;
[[gnu::pure]]
bool Match(const LightSong &song) const noexcept;
};
#endif