context.hh

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
*                                                                            *
\*===========================================================================*/
 
 
 
#ifndef VSI_CONTEXT_HH
#define VSI_CONTEXT_HH
 
//== INCLUDES =================================================================
#include <QVector>
#include <QStringList>
#include <QDomDocument>
#include <QFile>
#include <OpenFlipper/BasePlugin/LoggingInterface.hh>
#include <OpenFlipper/BasePlugin/PythonInterface.hh>
#include <parser/type.hh>
 
#include "element.hh"
 
//== NAMESPACES ===============================================================
namespace VSI {
 
//== FORWARDDECLARATIONS ======================================================
class Input;
class Output;
class InOut;
class Type;
 
//== CLASS DEFINITION =========================================================
 
class Context {
 
  public:
    explicit Context (LoggingInterface *_loggingInterface, PythonInterface *_pythonInterface);
 
    ~Context ();
 
    void parse (QFile& _xml);
 
    const QVector<Element *>& elements () const { return elements_; };
 
    QVector<Element *> elements (const QString& _category);
 
    Element *element (const QString& _name);
 
    QStringList categories ();
 
    void registerType (Type *_type);
 
    bool typeSupported (const QString& _type);
 
    Type *getType (const QString& _type);
 
    bool canConvert (const QString& _type1, const QString& _type2);
 
    static bool strToBool (const QString& _str);
 
    static QString getXmlString (QDomElement &_element, const QString& _tag, QString _default = "");
 
    static QString removeCommonTrailingSpaces(const QString& in);
 
    // execute script
    void executeScript(const QString& _script);
 
    // open script
    void openScriptInEditor(const QString& _script);
 
private:
 
    // parse element from xml
    void parseElement (QDomElement &_element);
 
    // parse element input from xml
    Input *parseInput (QDomElement &_domElement, Element *_e);
 
    // parse element output from xml
    Output *parseOutput (QDomElement& _domElement, Element *_e);
 
    // parse element function from xml
    Function *parseFunction (QDomElement& _domElement, Element *_e);
 
    // parse common input and output parts from xml
    bool parseInOutBase (QDomElement &_domElement, InOut *_io);
 
  private:
    QVector <Element *> elements_;
 
    QMap <QString, Type*> supportedTypes_;
 
    QList <Type *> types_;
 
    LoggingInterface *loggingInterface_;
    PythonInterface *pythonInterface_;
};
 
//=============================================================================
}
//=============================================================================
 
#endif