script.h

Go to the documentation of this file.

/*
 * script.h
 *
 * Abstract class for interface to external script languages
 *
 * Portable Tools Library
 *
 * Copyright (C) 2010 by Post Increment
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Tools Library.
 *
 * The Initial Developer of the Original Code is Post Increment
 *
 * Contributor(s): Craig Southeren
 *                 Robert Jongbloed
 *
 * $Revision: 28224 $
 * $Author: rjongbloed $
 * $Date: 2012-08-21 18:09:25 +1000 (Tue, 21 Aug 2012) $
 */

#ifndef PTLIB_SCRIPT_H
#define PTLIB_SCRIPT_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib/pfactory.h>
#include <ptclib/vartype.h>



class PScriptLanguage : public PObject
{
  PCLASSINFO(PScriptLanguage, PObject)
  public:
    static PScriptLanguage * Create(const PString & language);

    PScriptLanguage();

    ~PScriptLanguage();

    virtual bool LoadFile(
      const PFilePath & filename  
    ) = 0;

    virtual bool LoadText(
      const PString & text  
    ) = 0;

    virtual bool Load(
      const PString & script  
    );

    virtual bool Run(
      const char * script = NULL
    ) = 0;

    virtual bool CreateComposite(
      const PString & name   
    ) = 0;

    virtual bool GetVar(
      const PString & name,  
      PVarType & var
    ) = 0;

    virtual bool SetVar(
      const PString & name, 
      const PVarType & var
    ) = 0;

    virtual bool GetBoolean(
      const PString & name  
    ) = 0;

    virtual bool SetBoolean(
      const PString & name, 
      bool value            
    ) = 0;

    virtual int GetInteger(
      const PString & name  
    ) = 0;

    virtual bool SetInteger(
      const PString & name, 
      int value             
    ) = 0;

    virtual double GetNumber(
      const PString & name  
    ) = 0;

    virtual bool SetNumber(
      const PString & name, 
      double value          
    ) = 0;

    virtual PString GetString(
      const PString & name  
    ) = 0;

    virtual bool SetString(
      const PString & name, 
      const char * value    
    ) = 0;

    virtual bool ReleaseVariable(
      const PString & name    
    ) = 0;

    struct ParamVector : public vector<PVarType>
    {
      ParamVector(size_t sz = 0) : vector<PVarType>(sz) { }
      void Push(void * state);
      void Pop(void * state);
    };

    struct Signature {
      ParamVector m_arguments;
      ParamVector m_results;
    };

    virtual bool Call(
      const PString & name,           
      const char * sigString = NULL,  
      ...
    ) = 0;
    virtual bool Call(
      const PString & name,       
      Signature & signature 
    ) = 0;

    typedef PNotifierTemplate<Signature &>  FunctionNotifier;
    #define PDECLARE_ScriptFunctionNotifier(cls, fn) PDECLARE_NOTIFIER2(PScriptLanguage, cls, fn, PScriptLanguage::Signature &)

    virtual bool SetFunction(
      const PString & name,         
      const FunctionNotifier & func 
    ) = 0;


    __inline bool IsLoaded() const { return m_loaded; }

    virtual int GetLastErrorCode() const { return m_lastErrorCode; }

    virtual const PString & GetLastErrorText() const { return m_lastErrorText; }

  protected:
    virtual void OnError(int code, const PString & str);

    virtual bool InternalSetFunction(const PString & name, const FunctionNotifier & func);
    virtual void InternalRemoveFunction(const PString & prefix);

    bool m_loaded;
    int m_lastErrorCode;
    PString m_lastErrorText;
    typedef map<PString, FunctionNotifier> FunctionMap;
    FunctionMap m_functions;

    PMutex m_mutex;
};


#if P_LUA
  PFACTORY_LOAD(PLua);
#endif
#if P_V8
  PFACTORY_LOAD(PJavaScript);
#endif


#endif  // PTLIB_SCRIPT_H