KviKvsScript.h

Go to the documentation of this file.

#ifndef _KVI_KVS_SCRIPT_H_
#define _KVI_KVS_SCRIPT_H_
//=============================================================================
//
//   File : KviKvsScript.h
//   Creation date : Thu 25 Sep 2003 05.12 CEST by Szymon Stefanek
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2003-2010 Szymon Stefanek (pragma at kvirc dot net)
//
//   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.
//
//=============================================================================

#include "kvi_settings.h"
#include "KviQString.h"
#include "KviWindow.h"
#include "KviPointerList.h"
#include "KviKvsVariant.h"
#include "KviKvsVariantList.h"
#include "KviHeapObject.h"

class KviKvsTreeNodeInstruction;
class KviKvsExtendedRunTimeData;
class KviKvsScriptData;
class KviKvsReport;
class KviKvsRunTimeContext;

// X defines this stuff: ugly :/
#ifdef Error
#undef Error
#endif
#ifdef Success
#undef Success
#endif

class KVIRC_API KviKvsScript : public KviHeapObject
{
        friend class KviKvsObject;
        friend class KviKvsParser;
        friend class KviKvsRunTimeContext;

public:
        enum RunStatus
        {
                Error = 0,          
                Success = 1,        
                HaltEncountered = 2 
        };

        enum ScriptType
        {
                InstructionList, 
                Expression,      
                Parameter        
        };

        enum RunFlags
        {
                PreserveParams = 1, 
                // FIXME: This should be a global option, eventually
                AssumeLocals = 2, 
                // FIXME: This should be a global option, eventually
                Pedantic = 4, 
                Quiet = 8     
        };

public:
        KviKvsScript(const KviKvsScript & src);

        KviKvsScript(const QString & szName, const QString & szBuffer, ScriptType eType = InstructionList);

        ~KviKvsScript();

protected:
        KviKvsScript(const QString & szName, const QString & szBuffer, KviKvsTreeNodeInstruction * pPreparsedTree, ScriptType eType = InstructionList);

private:
        KviKvsScriptData * m_pData;

public:
        const QString & name() const;

        const QString & code() const;

        bool locked() const;

        void setName(const QString & szName);

        int run(KviWindow * pWnd, KviKvsVariantList * pParams = 0, KviKvsVariant * pRetVal = 0, int iRunFlags = 0, KviKvsExtendedRunTimeData * pExtData = 0);

        int run(KviWindow * pWnd, KviKvsVariantList * pParams, QString & szRetVal, int iRunFlags = 0, KviKvsExtendedRunTimeData * pExtData = 0);

        int run(KviKvsRunTimeContext * pContext, int iRunFlags = 0);

        static int run(const QString & szCode, KviWindow * pWindow, KviKvsVariantList * pParams = 0, KviKvsVariant * pRetVal = 0);

        static int evaluate(const QString & szCode, KviWindow * pWindow, KviKvsVariantList * pParams, KviKvsVariant * pRetVal);

        static int evaluateAsString(const QString & szCode, KviWindow * pWindow, KviKvsVariantList * pParams, QString & szRetVal);

        void dump(const char * prefix);

protected:
        bool parse(KviWindow * pOutput = 0, int iRunFlags = 0);

        int execute(KviWindow * pWnd, KviKvsVariantList * pParams = 0, KviKvsVariant * pRetVal = 0, int iRunFlags = 0, KviKvsExtendedRunTimeData * pExtData = 0);

        int executeInternal(KviKvsRunTimeContext * pContext);

        const QChar * buffer() const;

        void detach();
};

class KVIRC_API KviKvsScriptData
{
        friend class KviKvsScript;

protected:
        unsigned int m_uRefs; // Reference count for this structure

        QString m_szName;        // script context name
        QString m_szBuffer;      // NEVER TOUCH THIS
        const QChar * m_pBuffer; // this points to m_szBuffer: use it to extract string data

        KviKvsScript::ScriptType m_eType; // the type of the code in m_szBuffer

        KviKvsTreeNodeInstruction * m_pTree; // syntax tree
        unsigned int m_uLock;                // this is increased while the script is being executed
};

#endif //_KVI_KVS_SCRIPT_H_