NCLTextualViewPlugin.h

/*
 * Copyright 2011 TeleMidia/PUC-Rio.
 * 
 * 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.
 * 
 * You should have received a copy of the GNU Lesser General Public 
 * License along with this library.  If not, see
 * <http://www.gnu.org/licenses/>. 
 */
#ifndef NCLTEXTUALVIEWPLUGIN_H
#define NCLTEXTUALVIEWPLUGIN_H

#include <QObject>

#include "NCLTextEditor.h"
#include "NCLTextEditorMainWindow.h"

#include "NCLTextualViewPlugin_global.h"

#include <QShortcut>
#include <QKeySequence>
#include <QDomElement>
#include <QMutex>

#include <core/extensions/IPlugin.h>
using namespace composer::extension;

class NCLTextualViewPlugin :
    public IPlugin
{
    Q_OBJECT

private:
    NCLTextEditorMainWindow *window; 
    NCLTextEditor *nclTextEditor; 
    NCLTextEditor *tmpNclTextEditor; 
    QMap <QString, int> startEntityOffset; 
    QMap <QString, int> endEntityOffset; 
    QShortcut *updateModelShortcut;

    bool isSyncing;
    Entity *currentEntity;

    QDomDocument xmlDoc;
    QMutex syncMutex;

public:
    explicit NCLTextualViewPlugin();
    ~NCLTextualViewPlugin();
    void init();
    bool saveSubsession();
    QWidget* getWidget();

public slots:
    void onEntityAdded(QString pluginID, Entity *);
    void onEntityChanged(QString pluginID, Entity *);
    void onEntityRemoved(QString pluginID, QString entityID);
    void errorMessage(QString error);
    void changeSelectedEntity(QString pluginID, void* param);
    void updateFromModel();

    void incrementalUpdateFromModel();

    void nonIncrementalUpdateFromModel();

    void updateErrorMessages();

// COMUNICATION WITH VALIDATION PLUGIN //
    void clearValidationMessages(QString, void *param);
    void validationError(QString pluginID, void *param);
// END COMMUNICATION WITH VALIDATION PLUGIN

private slots:
    void updateCoreModel();

    void incrementalUpdateCoreModel();

    void nonIncrementalUpdateCoreModel();

    void syncFinished();

    virtual void manageFocusLost(QFocusEvent *event);

signals:
    void TextualPluginHasAddedEntity(QString pluginID, Entity *entity);

protected:
    void updateEntitiesOffset(int startFrom = 0, int insertedChars = 0);
    void printEntitiesOffset();

    bool isStartEndTag(Entity *entity);

    void openStartEndTag(Entity *entity);

    void fixIdentation(int offset, bool mustAddTab = false);
};

#endif // DEBUGCONSOLEPLUGIN_H