tlist.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 2002 - 2008 by Scott Wheeler
    email                : wheeler@kde.org
 ***************************************************************************/

/***************************************************************************
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License version   *
 *   2.1 as published by the Free Software Foundation.                     *
 *                                                                         *
 *   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.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA         *
 *   02110-1301  USA                                                       *
 *                                                                         *
 *   Alternatively, this file is available under the Mozilla Public        *
 *   License Version 1.1.  You may obtain a copy of the License at         *
 *   http://www.mozilla.org/MPL/                                           *
 ***************************************************************************/

#ifndef TAGLIB_LIST_H
#define TAGLIB_LIST_H

#include "taglib.h"

#include <list>

namespace TagLib {


  template <class T> class List
  {
  public:
#ifndef DO_NOT_DOCUMENT
    typedef typename std::list<T>::iterator Iterator;
    typedef typename std::list<T>::const_iterator ConstIterator;
#endif

    List();

    List(const List<T> &l);

    virtual ~List();

    Iterator begin();

    ConstIterator begin() const;

    Iterator end();

    ConstIterator end() const;

    Iterator insert(Iterator it, const T &value);

    List<T> &sortedInsert(const T &value, bool unique = false);

    List<T> &append(const T &item);

    List<T> &append(const List<T> &l);

    List<T> &prepend(const T &item);

    List<T> &prepend(const List<T> &l);

    List<T> &clear();

    uint size() const;
    bool isEmpty() const;

    Iterator find(const T &value);

    ConstIterator find(const T &value) const;

    bool contains(const T &value) const;

    Iterator erase(Iterator it);

    const T &front() const;

    T &front();

    const T &back() const;

    T &back();

    void setAutoDelete(bool autoDelete);

    T &operator[](uint i);

    const T &operator[](uint i) const;

    List<T> &operator=(const List<T> &l);

    bool operator==(const List<T> &l) const;

  protected:
    /*
     * If this List is being shared via implicit sharing, do a deep copy of the
     * data and separate from the shared members.  This should be called by all
     * non-const subclass members.
     */
    void detach();

  private:
#ifndef DO_NOT_DOCUMENT
    template <class TP> class ListPrivate;
    ListPrivate<T> *d;
#endif
  };

}

// Since GCC doesn't support the "export" keyword, we have to include the
// implementation.

#include "tlist.tcc"

#endif