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
|
/*
* Copyright (C) 2003-2013 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_TAG_BUILDER_HXX
#define MPD_TAG_BUILDER_HXX
#include "TagType.h"
#include "gcc.h"
#include <vector>
#include <stddef.h>
struct TagItem;
struct Tag;
/**
* A class that constructs #Tag objects.
*/
class TagBuilder {
/**
* The duration of the song (in seconds). A value of zero
* means that the length is unknown. If the duration is
* really between zero and one second, you should round up to
* 1.
*/
int time;
/**
* Does this file have an embedded playlist (e.g. embedded CUE
* sheet)?
*/
bool has_playlist;
/** an array of tag items */
std::vector<TagItem *> items;
public:
/**
* Create an empty tag.
*/
TagBuilder()
:time(-1), has_playlist(false) {}
~TagBuilder() {
Clear();
}
TagBuilder(const TagBuilder &other) = delete;
TagBuilder &operator=(const TagBuilder &other) = delete;
/**
* Returns true if the object contains any information.
*/
gcc_pure
bool IsDefined() const {
return time >= 0 || has_playlist || !items.empty();
}
void Clear();
/**
* Create a new #Tag instance from data in this object. The
* returned object is owned by the caller. This object is
* empty afterwards.
*/
Tag *Commit();
void SetTime(int _time) {
time = _time;
}
void SetHasPlaylist(bool _has_playlist) {
has_playlist = _has_playlist;
}
void Reserve(unsigned n) {
items.reserve(n);
}
/**
* Appends a new tag item.
*
* @param type the type of the new tag item
* @param value the value of the tag item (not null-terminated)
* @param len the length of #value
*/
gcc_nonnull_all
void AddItem(tag_type type, const char *value, size_t length);
/**
* Appends a new tag item.
*
* @param type the type of the new tag item
* @param value the value of the tag item (null-terminated)
*/
gcc_nonnull_all
void AddItem(tag_type type, const char *value);
private:
gcc_nonnull_all
void AddItemInternal(tag_type type, const char *value, size_t length);
};
#endif
|
