/* Aseprite
 * Copyright (C) 2001-2013  David Capello
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef APP_DOCUMENTS_H_INCLUDED
#define APP_DOCUMENTS_H_INCLUDED

#include "base/disable_copying.h"
#include "app/document_id.h"

#include <vector>

namespace app {
  class Document;

  class Documents {
  public:
    typedef std::vector<Document*>::iterator iterator;
    typedef std::vector<Document*>::const_iterator const_iterator;

    Documents();
    ~Documents();

    iterator begin() { return m_documents.begin(); }
    iterator end() { return m_documents.end(); }
    const_iterator begin() const { return m_documents.begin(); }
    const_iterator end() const { return m_documents.end(); }

    Document* front() const { return m_documents.front(); }
    Document* back() const { return m_documents.back(); }

    int size() const { return m_documents.size(); }
    bool empty() const { return m_documents.empty(); }

    // Adds a new document to the list. If the destructor is called the
    // document is deleted automatically.
    void addDocument(Document* document);

    // Removes a document from the list without deleting it. You must to
    // delete the document after removing it.
    void removeDocument(Document* document);

    // Moves the document to the given location in the same
    // list. E.g. It is used to reorder documents when they are selected
    // as active.
    void moveDocument(Document* document, int index);

    Document* getByIndex(int index) const { return m_documents[index]; }
    Document* getById(DocumentId id) const;

  private:
    // Deletes all documents in the list (calling "delete" operation).
    void deleteAll();

    std::vector<Document*> m_documents;
    DocumentId m_idCounter;

    DISABLE_COPYING(Documents);
  };

} // namespace app

#endif