/************************************************************************
**
**  Copyright (C) 2009, 2010, 2011  Strahinja Markovic  <strahinja.markovic@gmail.com>
**
**  This file is part of Sigil.
**
**  Sigil 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 3 of the License, or
**  (at your option) any later version.
**
**  Sigil 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 Sigil.  If not, see <http://www.gnu.org/licenses/>.
**
*************************************************************************/

#pragma once
#ifndef VIEWEDITOR_H
#define VIEWEDITOR_H

#include <QtCore/QList>
#include <QtCore/QString>

#include "ViewEditors/Searchable.h"
#include "ViewEditors/Zoomable.h"

class QUrl;


/**
 * Interface for ViewEditors.
 * It would be lovely if we could make this a QObject
 * subclass, but multiple inheritance with multiple
 * QObject subclasses is apparently a bad idea.
 */
class ViewEditor : public Searchable, public Zoomable
{

public:

    /**
     *   Represents an element in the XHTML document tree
     * and the index of its child that selects the
     * next element in the chain.
     *
     *   By constructing a list of these items, one can
     * navigate the tree by selecting the element,
     * its child with the specified index, its child
     * with its index and so on until reaching
     * the element ultimately identified by this chain.
     *
     *   Because of WebKit limitations, this hierarchy
     * does not really look at all child nodes, but only
     * at element child nodes. The text nodes are considered
     * children only for the last element... and even then,
     * it depends on the specific ViewEditor... BookViewEditor
     * does this, CodeViewEditor doesn't.
     */
    struct ElementIndex {
        /**
         * The name of the element.
         */
        QString name;

        /**
         * The index of this element in its parent's list of children.
         */
        int index;
    };

    /**
     * Destructor.
     */
    virtual ~ViewEditor() {}

    /**
     * Returns the state of the loading procedure.
     *
     * @return \c true if loading is finished.
     */
    virtual bool IsLoadingFinished() = 0;

    virtual int GetCursorLine() const {
        return -1;
    }
    virtual int GetCursorColumn() const {
        return -1;
    }

    /**
     * Returns an "encoded" location of the caret element.
     * The returned list of elements represents a "chain"
     * or "walk" through the XHTML document with which one
     * can identify a single element in the document.
     * This list identifies the element in which the
     * keyboard caret is currently located.
     *
     * @return The element selecting list.
     */
    virtual QList< ElementIndex > GetCaretLocation() {
        return QList< ViewEditor::ElementIndex >();
    }

    /**
     * Accepts a list returned by a view's GetCaretLocation()
     * and creates and stores an update that sends the caret
     * in this view to the specified element.
     *
     * @param hierarchy The element selecting list.
     */
    virtual void StoreCaretLocationUpdate(const QList< ElementIndex > &hierarchy) {}

    virtual QString GetCaretLocationUpdate() {
        return QString();
    }

    /**
     * Perform the relocating of the caret on screen to
     * the location state that has been persisted.
     *
     * @return \c true if the update was performed.
     */
    virtual bool ExecuteCaretUpdate() {
        return false;
    }
};

#endif // VIEWEDITOR_H


