/usr/include/xmms2/xmmsclient/xmmsclient++/coll.h is in libxmmsclient++-dev 0.8+dfsg-12.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 | /* XMMS2 - X Music Multiplexer System
* Copyright (C) 2003-2011 XMMS2 Team
*
* PLUGINS ARE NOT CONSIDERED TO BE DERIVED WORK !!!
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*/
#ifndef XMMSCLIENTPP_COLL_H
#define XMMSCLIENTPP_COLL_H
#include <xmmsclient/xmmsclient.h>
#include <xmmsclient/xmmsclient++/typedefs.h>
#include <string>
#include <iostream>
#include <stdexcept>
namespace Xmms
{
class Collection;
class CollResult;
Coll::Coll* extract_collection( xmmsv_t* );
/** @class Coll coll.h "xmmsclient/xmmsclient++/coll.h"
* @brief This class is used to build collection structures.
*/
namespace Coll
{
typedef xmmsv_coll_type_t Type;
const Type REFERENCE = XMMS_COLLECTION_TYPE_REFERENCE;
const Type UNION = XMMS_COLLECTION_TYPE_UNION;
const Type INTERSECTION = XMMS_COLLECTION_TYPE_INTERSECTION;
const Type COMPLEMENT = XMMS_COLLECTION_TYPE_COMPLEMENT;
const Type HAS = XMMS_COLLECTION_TYPE_HAS;
const Type EQUALS = XMMS_COLLECTION_TYPE_EQUALS;
const Type MATCH = XMMS_COLLECTION_TYPE_MATCH;
const Type SMALLER = XMMS_COLLECTION_TYPE_SMALLER;
const Type GREATER = XMMS_COLLECTION_TYPE_GREATER;
const Type IDLIST = XMMS_COLLECTION_TYPE_IDLIST;
const Type QUEUE = XMMS_COLLECTION_TYPE_QUEUE;
const Type PARTYSHUFFLE = XMMS_COLLECTION_TYPE_PARTYSHUFFLE;
class OperandIterator;
class IdlistElement;
class Coll;
// FIXME: Hide classes?
template< typename keyT, typename valT >
class AbstractElement
{
public:
virtual ~AbstractElement();
// get value
virtual operator valT() const = 0;
// set value
virtual valT operator=( valT value ) = 0;
protected:
AbstractElement( Coll& coll, keyT index );
AbstractElement( const Coll& coll, keyT index );
// to avoid problems with ostream and implicit casting operator
friend std::ostream& operator<<( std::ostream& os,
const AbstractElement< keyT, valT >& elem )
{
os << keyT( elem );
return os;
}
Coll& coll_;
keyT index_;
};
class AttributeElement : public AbstractElement< std::string, std::string >
{
public:
~AttributeElement();
operator std::string() const;
std::string operator=( std::string value );
protected:
friend class Coll;
AttributeElement( Coll& coll, std::string index );
AttributeElement( const Coll& coll, std::string index );
};
class Coll
{
public:
/** Destructor.
*/
virtual ~Coll();
Type getType() const;
// get/set attributes
AttributeElement operator []( const std::string& attrname );
const AttributeElement operator []( const std::string& attrname ) const;
void setAttribute( const std::string &attrname, const std::string &value );
std::string getAttribute( const std::string &attrname ) const;
void removeAttribute( const std::string &attrname );
virtual void addOperand( Coll& operand );
virtual void removeOperand( Coll& operand );
virtual void removeOperand();
virtual void setOperand( Coll& operand );
virtual CollPtr getOperand() const;
virtual void append( int id );
virtual void insert( unsigned int index, int id);
virtual void move( unsigned int index,
unsigned int newindex );
virtual void remove( unsigned int index );
virtual void clear();
virtual unsigned int size() const;
virtual IdlistElement operator []( unsigned int index );
virtual const IdlistElement operator []( unsigned int index ) const;
virtual OperandIterator getOperandIterator();
virtual const OperandIterator getOperandIterator() const;
// FIXME: Hide this, we shouldn't need it..
xmmsv_coll_t* getColl() const { return coll_; }
/** @cond */
protected:
friend class OperandIterator;
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend class IdlistElement;
friend class Unary;
Coll( xmmsv_coll_t *coll );
Coll( Type type );
Coll( const Coll& src );
Coll operator=( const Coll& src );
void setIndex( unsigned int index, int value );
int getIndex( unsigned int index ) const;
xmmsv_coll_t* coll_;
void ref();
void unref();
/** @endcond */
};
class Nary : public Coll
{
public:
// FIXME: support operator<< too ?
void addOperand( Coll& operand );
void removeOperand( Coll& operand );
OperandIterator getOperandIterator();
const OperandIterator getOperandIterator() const;
protected:
Nary( Type type );
Nary( xmmsv_coll_t* coll );
~Nary();
};
class Unary : public Coll
{
public:
void setOperand( Coll& operand );
void removeOperand();
CollPtr getOperand() const;
protected:
Unary( Type type );
Unary( Type type, Coll& operand );
Unary( xmmsv_coll_t* coll );
~Unary();
};
// FIXME: support integer value too? depend on class?
class Filter : public Unary
{
protected:
Filter( xmmsv_coll_t* coll );
Filter( Type type );
Filter( Type type, Coll& operand );
Filter( Type type, Coll& operand, const std::string& field);
Filter( Type type,
Coll& operand,
const std::string& field,
const std::string& value );
Filter( Type type,
Coll& operand,
const std::string& field,
const std::string& value,
bool case_sensitive );
~Filter();
};
class Reference : public Coll
{
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
//template<typename T> friend T* Xmms::extract_value( xmmsc_result_t* );
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
protected:
Reference( xmmsv_coll_t* coll );
public:
// nsname is actually of type Collection::Namespace,
// but we try to avoid a dependency hell here..
Reference();
Reference( const std::string& name,
const char* const& nsname );
~Reference();
};
/** A collection operator corresponding to all the media in
* the medialib.
*
* Used attributes: none.
*
* Operand: none.
*
* A Universe operator is used to refer to the "All Media"
* meta-collection that represents all the media in the
* medialib. Useful as input for other operators.
*/
class Universe : public Reference
{
public:
Universe();
~Universe();
};
/** A Union collection operator forms the union of multiple
* operators.
*
* Used attributes: none.
*
* Operand: unbounded.
*
* The collection produced by a Union operator is the union
* of all its operands, i.e. all the media matching
* <em>any</em> of the collection operands.
*/
class Union : public Nary
{
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
protected:
Union( xmmsv_coll_t* coll );
public:
Union();
~Union();
};
/** An Intersection collection operator forms the intersection
* of multiple operators.
*
* Used attributes: none.
*
* Operand: unbounded.
*
* The collection produced by an Intersection operator is the
* intersection of all its operands, i.e. all the media
* matching <em>all</em> the collection operands.
*/
class Intersection : public Nary
{
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
protected:
Intersection( xmmsv_coll_t* coll );
public:
Intersection();
~Intersection();
};
/** A Complement collection operator forms the complement of
* an operators.
*
* Used attributes: none.
*
* Operand: 1.
*
* The collection produced by an Intersection operator is the
* complement of its unique operand, i.e. all the media
* <em>not</em> matching the collection operand.
*/
class Complement : public Unary
{
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
protected:
Complement( xmmsv_coll_t* coll );
public:
Complement();
Complement( Coll& operand );
~Complement();
};
class Has : public Filter
{
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
//template<typename T> friend T* Xmms::extract_value( xmmsc_result_t* );
protected:
Has( xmmsv_coll_t* coll );
public:
Has();
Has(Coll& operand);
Has(Coll& operand, const std::string& field);
~Has();
};
class Smaller : public Filter
{
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
//template<typename T> friend T* Xmms::extract_value( xmmsc_result_t* );
protected:
Smaller( xmmsv_coll_t* coll );
public:
Smaller();
Smaller(Coll& operand);
Smaller(Coll& operand, const std::string& field);
Smaller(Coll& operand,
const std::string& field,
const std::string& value);
~Smaller();
};
class Greater : public Filter
{
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
//template<typename T> friend T* Xmms::extract_value( xmmsc_result_t* );
protected:
Greater( xmmsv_coll_t* coll );
public:
Greater();
Greater(Coll& operand);
Greater(Coll& operand, const std::string& field);
Greater(Coll& operand,
const std::string& field,
const std::string& value);
~Greater();
};
class Equals : public Filter
{
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
//template<typename T> friend T* Xmms::extract_value( xmmsc_result_t* );
protected:
Equals( xmmsv_coll_t* coll );
public:
Equals();
Equals(Coll& operand);
Equals(Coll& operand, const std::string& field);
Equals(Coll& operand,
const std::string& field,
const std::string& value,
bool case_sensitive = false);
~Equals();
};
class Match : public Filter
{
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
//template<typename T> friend T* Xmms::extract_value( xmmsc_result_t* );
protected:
Match( xmmsv_coll_t* coll );
public:
Match();
Match(Coll& operand);
Match(Coll& operand, const std::string& field);
Match(Coll& operand,
const std::string& field,
const std::string& value,
bool case_sensitive = false);
~Match();
};
/** An Idlist collection operator.
*
* Used attributes: none.
*
* Operand: none.
*
* The Idlist operator stores a fixed list of media id. The
* list is ordered, and that ordering is used if the operator
* is used as a playlist.
*
* The Idlist operator also unmasks the methods related to
* managing the internal id-list, as well as the [] bracket
* operator with integer argument for direct access.
*/
class Idlist : public Coll
{
friend class Element;
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
protected:
Idlist( xmmsv_coll_t* coll );
Idlist( Type type );
public:
Idlist();
~Idlist();
void append( int id );
void insert( unsigned int index, int id);
void move( unsigned int index, unsigned int newindex );
void remove( unsigned int index );
void clear();
unsigned int size() const;
// get/set value at index
IdlistElement operator []( unsigned int index );
const IdlistElement operator []( unsigned int index ) const;
};
/** A Queue collection operator.
*
* Used attributes:
* - history: if used as a playlist, determines how many
* played items remain before they are popped
* off the queue.
*
* Operand: none.
*
* The Queue operator is similar to the Idlist operator,
* except if loaded as a playlist, only <em>history</em>
* played items will remain and the previous ones are
* removed.
*/
class Queue : public Idlist
{
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
//template<typename T> friend T* Xmms::extract_value( xmmsc_result_t* );
protected:
Queue( xmmsv_coll_t* coll );
Queue( Type type );
Queue( Type type, unsigned int history );
public:
Queue();
Queue( unsigned int history );
~Queue();
};
/** A PartyShuffle collection operator.
*
* Used attributes:
* - history: if used as a playlist, determines how many
* played items remain before they are popped
* off the queue.
* - upcoming: if used as a playlist, determines the minimum
* number of incoming entries (if fewer, new entries
* are randomly fetched from the operand collection).
* - jumplist: optionally, the name of a playlist to jump to
* once the PartyShuffle is done playing.
*
* Operand: 1, the input collection to randomly fetch media from.
*
* The PartyShuffle operator is similar to the Queue operator
* (entries are popped if they exceed <em>history</em>), but
* when loaded, the playlist is automatically fed by random
* media taken from the input collection until its size reaches
*/
class PartyShuffle : public Queue
{
friend class ::Xmms::Collection;
friend class ::Xmms::CollResult;
friend Coll* ::Xmms::extract_collection( xmmsv_t* );
protected:
PartyShuffle( xmmsv_coll_t* coll );
public:
PartyShuffle();
PartyShuffle( unsigned int history );
PartyShuffle( unsigned int history, unsigned int upcoming );
~PartyShuffle();
void setOperand( Coll& operand );
void removeOperand();
CollPtr getOperand() const;
};
class OperandIterator
{
public:
OperandIterator( const OperandIterator& src );
OperandIterator operator=( const OperandIterator& src );
~OperandIterator();
void first();
bool valid() const;
void next();
CollPtr operator *() const;
// FIXME: Operator -> ?
private:
friend class Nary;
OperandIterator( Coll& coll );
OperandIterator( const Coll& coll );
void initIterator();
Coll& coll_;
xmmsv_list_iter_t *oper_it_;
};
/** Helper class accessing one element of an Idlist operator
* for reading or writing.
*
* This class should not be instanciated by users of the library.
*/
class IdlistElement : public AbstractElement< unsigned int, int >
{
public:
~IdlistElement();
operator int() const;
int operator=( int value );
private:
friend class Idlist;
IdlistElement( Coll& coll, unsigned int index );
IdlistElement( const Coll& coll, unsigned int index );
};
template< typename keyT, typename valT >
AbstractElement< keyT, valT >::AbstractElement( Coll& coll, keyT index )
: coll_ (coll), index_( index )
{
xmmsv_coll_ref( coll_.getColl() );
}
template< typename keyT, typename valT >
AbstractElement< keyT, valT >::AbstractElement( const Coll& coll, keyT index )
: coll_ (coll), index_( index )
{
xmmsv_coll_ref( coll_.getColl() );
}
template< typename keyT, typename valT >
AbstractElement< keyT, valT >::~AbstractElement()
{
xmmsv_coll_unref( coll_.getColl() );
}
}
}
#endif // XMMSCLIENTPP_COLL_H
|