tclWrapper.h

Go to the documentation of this file.

/*     -*-C++-*- -*-coding: utf-8-unix;-*-
  Classified Ads is Copyright (c) Antti Järvinen 2013-2017.

  This file is part of Classified Ads.

  Classified Ads 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.

  Classified Ads 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 Classified Ads; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/


#ifndef TCLWRAPPER_H
#define TCLWRAPPER_H
#include <QThread>
#include <QQueue>
#include "../mcontroller.h"
#include <tcl.h>

class Model ;
class MController ;
class TclConsoleDialog ;
class TclCallbacks ;

class TclWrapper : public QThread {
    Q_OBJECT
public:
    TclWrapper(Model& aModel,
               MController& aController);

    ~TclWrapper() ;
    void stopScript(bool aDeleteLater = false ) ;
    void setScript(const QString& aScript) ; 
    const QString& currentProgram() const { return iTCLScript ; } ;
    void showConsole() ; 
    void notifyOfContentReceived(const Hash& aHashOfContent,
                                 const ProtocolItemType aTypeOfReceivedContent ) ;
public slots:
    void run() ;

signals:
    void error(MController::CAErrorSituation aError,
               const QString& aExplanation) ;
    void consoleOutput(QString aOutput) ;
public slots:
    void consoleClosed() ;
    void evalScript(QString aScript,
                    QString* aMainWindowTitle = NULL ) ;
private: // methods
    Tcl_Interp* initInterpreter() ;
    bool  initTk(Tcl_Interp* aInterp) ;
    bool  initExtensions(Tcl_Interp* aInterp) ;

    bool  initProgram(Tcl_Interp* aInterp) ;

    static int listItemsCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;

    static int getProfileCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;


    static int getClassifiedAdCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;


    static int getProfileCommentCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;


    static int getBinaryFileCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;

    static int getDbRecordCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;


    static int publishItemCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;
    static int sha1Cmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;
    static int storeTCLProgLocalDataCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;
    static int retrieveTCLProgLocalDataCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;
    static int saveFileCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;
    static int openFileCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;
    static int isProfileTrustedCmd(ClientData aCData, Tcl_Interp *aInterp, int aObjc, Tcl_Obj *const aObjv[]) ;
    static int closeProc(
        ClientData aInstanceData,
        Tcl_Interp *aInterp);
    static int inputProc(
        ClientData aInstanceData,
        char *aBuf,
        int aBufSize,
        int *aErrorCodePtr);
    static int outputProc(
        ClientData aInstanceData,
        const char *aBuf,
        int aToWrite,
        int *aErrorCodePtr);

    static void watchProc(
        ClientData instanceData,
        int mask);
    static int getHandleProc(
        ClientData aInstanceData,
        int aDirection,
        ClientData *aHandlePtr);

    int outputProcImpl(
        ClientData aInstanceData,
        const char *aBuf,
        int aToWrite,
        int *aErrorCodePtr);

    void notifyInterpreterOfContentReceived( Tcl_Interp* aInterp ) ;
private: // these are not public
    Model& iModel ; 
    MController& iController ;
    Tcl_Interp *iInterp  ; 
    QString iTCLScript ; 
    bool iNeedsToRun ; 
    QByteArray iStdOutBuffer ;
    bool iDeleteLater ; 
    TclConsoleDialog* iConsole ;
    QQueue<QString> iScriptQueue ;
    QString iMainWindowTitle ;
    QQueue<QPair<Hash, ProtocolItemType> > iAddedDataModelItems ;
    TclCallbacks* iTclCallbacks ;
} ;
#endif