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
|
/*
* libSpiff - XSPF playlist handling library
*
* Copyright (C) 2006-2008, Sebastian Pipping / Xiph.Org Foundation
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer.
*
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* * Neither the name of the Xiph.Org Foundation nor the names of
* its contributors may be used to endorse or promote products
* derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Sebastian Pipping, sping@xiph.org
*/
/**
* @file SpiffExtensionReaderFactory.h
* Interface of SpiffExtensionReaderFactory.
*/
#ifndef SPIFF_EXTENSION_READER_FACTROY_H
#define SPIFF_EXTENSION_READER_FACTROY_H
#include "SpiffDefines.h"
#include "SpiffToolbox.h"
#include <map>
namespace Spiff {
class SpiffExtensionReader;
class SpiffReader;
class SpiffExtensionReaderFactoryPrivate;
/**
* Manages creation of SpiffExtensionReader instances.
* SpiffExtensionReaders can be registered/unregistered dynamically.
*/
class SpiffExtensionReaderFactory {
private:
/// @cond DOXYGEN_NON_API
SpiffExtensionReaderFactoryPrivate * const d; ///< D pointer
/// @endcond
public:
/**
* Creates a new SpiffExtensionReaderFactory object.
*/
SpiffExtensionReaderFactory();
/**
* Copy constructor.
*
* @param source Source to copy from
*/
SpiffExtensionReaderFactory(const SpiffExtensionReaderFactory
& source);
/**
* Assignment operator.
*
* @param source Source to copy from
*/
SpiffExtensionReaderFactory & operator=(
SpiffExtensionReaderFactory const & source);
/**
* Destroys this SpiffExtensionReaderFactory object and deletes all
* memory associated with it.
*/
~SpiffExtensionReaderFactory();
/**
* Overwrites the registered reader for the given application URI.
* Pass NULL for the URI to make this the catch-all reader.
* The reader will be cloned internally so can safely delete
* the instance passed for registration.
*
* @param example Representative for the extension reader cleass
* @param triggerUri Application URI associate, must not be NULL
*/
void registerPlaylistExtensionReader(SpiffExtensionReader const * example,
XML_Char const * triggerUri);
/**
* Overwrites the registered reader for the given application URI.
* Pass NULL for the URI to make this the catch-all reader.
* The reader will be cloned internally so can safely delete
* the instance passed for registration.
*
* @param example Representative for the extension reader cleass
* @param triggerUri Application URI associate, must not be NULL
*/
void registerTrackExtensionReader(SpiffExtensionReader const * example,
XML_Char const * triggerUri);
/**
* Unregisteres the given application URI.
* NOTE: This URI will still be handled if a catch-all
* handler has been set.
*
* @param triggerUri Application URI to unregister
*/
void unregisterPlaylistExtensionReader(
XML_Char const * triggerUri);
/**
* Unregisteres the given application URI.
* NOTE: This URI will still be handled if a catch-all
* handler has been set.
*
* @param triggerUri Application URI to unregister
*/
void unregisterTrackExtensionReader(
XML_Char const * triggerUri);
/**
* Creates a new SpiffExtensionReader whose type was
* registered for this application URI.
*
* @param applicationUri Application URI
* @param reader SpiffReader for the extension reader
* @return New playlist extension reader
*/
SpiffExtensionReader * newPlaylistExtensionReader(
XML_Char const * applicationUri, SpiffReader * reader);
/**
* Creates a new SpiffExtensionReader whose type was
* registered for this application URI.
*
* @param applicationUri Application URI
* @param reader SpiffReader for the extension reader
* @return New track extension reader
*/
SpiffExtensionReader * newTrackExtensionReader(
XML_Char const * applicationUri, SpiffReader * reader);
private:
/**
* Overwrites the registered reader for the given application URI.
* Pass NULL for the URI to make this the catch-all reader.
* The reader will be cloned internally so can safely delete
* the instance passed for registration.
*
* @param container Container to unregister from
* @param catchAll Catch-all slot to modifiy
* @param example Reader class representative
* @param triggerUri Application URI to unregister
*/
void registerReader(std::map<XML_Char const *,
SpiffExtensionReader const *,
Toolbox::SpiffStringCompare> & container,
SpiffExtensionReader const * & catchAll,
SpiffExtensionReader const * example,
XML_Char const * triggerUri);
/**
* Unregisteres the given application URI.
*
* @param container Container to unregister from
* @param catchAll Catch-all slot to modifiy
* @param triggerUri Application URI to unregister
*/
void unregisterReader(std::map<XML_Char const *,
SpiffExtensionReader const *,
Toolbox::SpiffStringCompare> & container,
SpiffExtensionReader const * & catchAll,
XML_Char const * triggerUri);
/**
* Creates a new SpiffExtensionReader whose type was
* registered for this application URI.
*
* @param container Container to use
* @param catchAll Catch-all slot to use
* @param applicationUri Application URI
* @param reader SpiffReader for the extension reader
* @return New extension reader
*/
SpiffExtensionReader * newReader(std::map<XML_Char const *,
SpiffExtensionReader const *,
Toolbox::SpiffStringCompare> & container,
SpiffExtensionReader const * catchAll,
XML_Char const * applicationUri,
SpiffReader * reader);
};
}
#endif // SPIFF_EXTENSION_READER_FACTROY_H
|
