lua.h

Go to the documentation of this file.

/*
 * lua.h
 *
 * Interface library for Lua interpreter
 *
 * 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
 */

#ifndef PTLIB_LUA_H
#define PTLIB_LUA_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#include <ptlib.h>

#if P_LUA

#include <ptclib/script.h>
#include <ptclib/vartype.h>


struct lua_State;



class PLua : public PScriptLanguage
{
    PCLASSINFO(PLua, PScriptLanguage)
  public:
    PLua();

    ~PLua();

    static PString LanguageName();

    virtual PString GetLanguageName() const;

    virtual bool IsInitialised() const;

    virtual bool LoadFile(
      const PFilePath & filename  
    );

    virtual bool LoadText(
      const PString & text  
    );

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

    bool CreateTable(
      const PString & name,   
      const PString & metatable = PString::Empty() 
    );

    bool DeleteTable(
      const PString & name,   
      bool metaTable = false  
    );


    virtual bool CreateComposite(
      const PString & name   
    );

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

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

    bool GetBoolean(
      const PString & name  
    );

    bool SetBoolean(
      const PString & name, 
      bool value            
    );

    int GetInteger(
      const PString & name  
    );

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

    double GetNumber(
      const PString & name  
    );

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

    PString GetString(
      const PString & name  
    );

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

    virtual bool ReleaseVariable(
      const PString & name    
    );

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


    #define PDECLARE_LuaFunctionNotifier(cls, fn) PDECLARE_NOTIFIER2(PLua, cls, fn, PScriptLanguage::Signature &)

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

  protected:
    virtual bool OnLuaError(int code, const PString & str = PString::Empty(), int pop = 0);

    bool ParseVariableName(const PString & name, PStringArray & vars);
    bool InternalGetVariable(const PString & name);
    bool InternalSetVariable(const PString & name);
    static int InternalCallback(lua_State * state);
    int InternalCallback();

    lua_State * m_lua;
};


#endif // P_LUA

#endif  // PTLIB_LUA_H