expression.h

Go to the documentation of this file.

/*
    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., 51 Franklin Street, Fifth Floor,
    Boston, MA  02110-1301, USA.

    ---
    Copyright (C) 2009 Alexander Rieder <alexanderrieder@gmail.com>
 */

#ifndef _EXPRESSION_H
#define _EXPRESSION_H

#include <QObject>
#include <QDomElement>

#include "cantor_export.h"

class KZip;

namespace Cantor
{
class Session;
class Result;
class ExpressionPrivate;

class CANTOR_EXPORT Expression : public QObject
{
  Q_OBJECT
  public:
    enum Status{ Computing,   
         Done,        
         Error,       
         Interrupted  
    };

    enum FinishingBehavior { 
    DoNotDelete,     
    DeleteOnFinish   
    };
    Expression( Session* session );
    virtual ~Expression();

    virtual void evaluate() = 0;
    virtual void interrupt() = 0;
    
    int id();

    void setId(int id);

    void setFinishingBehavior(FinishingBehavior behavior);

    FinishingBehavior finishingBehavior();

    void setCommand( const QString& cmd );

    QString command();

    virtual void addInformation(const QString& information);

    void setErrorMessage( const QString& cmd);

    QString errorMessage();

    Result* result();

    void clearResult();
    
    Status status();

    Session* session();

    QDomElement toXml(QDomDocument& doc);
    void saveAdditionalData(KZip* archive);

    bool isInternal();
    void setInternal(bool internal);

  Q_SIGNALS:
    void idChanged();
    void gotResult();
    void statusChanged(Cantor::Expression::Status status);
    void needsAdditionalInformation(const QString& question);

  //These are protected, because only subclasses will handle results/status changes
  protected:
    void setResult(Result* result);
    void setStatus(Status status);

  protected:
    //returns a string of latex commands, that is inserted into the header. 
    //used for example if special packages are needed
    virtual QString additionalLatexHeaders();
  private:
    void renderResultAsLatex();
  private Q_SLOTS:
    void latexRendered();

  private:
    ExpressionPrivate* d;
};

}
#endif /* _EXPRESSION_H */