TclInterpreter.h

// -*- mode:C++; tab-width:2; c-basic-offset:2; indent-tabs-mode:nil -*- 
//
// Copyright (C) 2000-2005 by Roger Rene Kommer / artefaktur, Kassel, Germany.
// 
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public License (LGPL).
// 
// 
// This library 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 
// License ACDK-FreeLicense document enclosed in the distribution
// for more for more details.
// This file is part of the Artefaktur Component Development Kit:
//                         ACDK
// 
// Please refer to
// - http://www.acdk.de
// - http://www.artefaktur.com
// - http://acdk.sourceforge.net
// for more information.
// 
// $Header: /cvsroot/acdk/acdk/acdk_tcl/src/acdk/tcl/TclInterpreter.h,v 1.16 2005/04/08 10:53:21 kommer Exp $
#ifndef acdk_tcl_TclInterpreter_h
#define acdk_tcl_TclInterpreter_h



#include <acdk.h>
#include <acdk/lang/dmi/ScriptInterpreter.h>
#include "Config.h"



namespace acdk {
/** 
  Implements the Tcl interpreter and wrapper Classes
*/
namespace tcl {

using namespace acdk::lang;

ACDK_DECL_INTERFACE(TclInterpreter);

/** 
  Interface to a script interpreter Tcl, Java, etc.
  @author Roger Rene Kommer (kommer@artefaktur.com)
  @version $Revision: 1.16 $
  @date $Date: 2005/04/08 10:53:21 $
*/



class ACDK_ACDK_TCL_PUBLIC TclInterpreter
: extends acdk::lang::Object,
  implements acdk::lang::dmi::ScriptInterpreter
{
  ACDK_WITH_METAINFO(TclInterpreter)
private:
  /**
    The underlying Tcl_Interp* 
  */
  foreign void* _interpreter;
public:
  TclInterpreter(void* interp = 0);
  virtual ~TclInterpreter();
  /**
    Parse a file. On some interpreter also execute the script.
    @param file the file to parse
  */
  virtual void parse(IN(acdk::io::RFile) file);
  /**
    Parse a file. On some interpreter also execute the script.
    @param script the script to parse
  */
  virtual void parse(IN(RString) script);
  /**
    Evaluate the code . On some interpreter it is equal to parse.
    @param script the script to eval
    @return the output or result of the script fragment
    @bugs Not implemented yet
  */
  virtual acdk::lang::Object eval(IN(RString) code);
  /**
    Calls a script function.
    Note: may not all script interpreter support this function
    @param func the name of the function
    @param args the arguments for the function
    @return result of the call
    @bugs Not implemented yet
  */
  foreign virtual acdk::lang::dmi::ScriptVar call(IN(RString) func, acdk::lang::dmi::ScriptVarArray& args);
  /**
    Calls a script method of given object.
    @param obj the 'this' object of the script, which is a wrapper to the scripting
    @param func the name of the function
    @param args the arguments for the function
    @return result of the call
    @bugs Not implemented yet
  */
  foreign virtual acdk::lang::dmi::ScriptVar invoke(IN(acdk::lang::Object) obj, IN(RString) func, acdk::lang::dmi::ScriptVarArray& args);
  /**
    Do debug the given Script. May not work on all scripting languages
    @param in Inputstream for users input and script
    @param out Scripts output and users Echo output
    @param err Error stream
    @bugs Not implemented yet
  */
  virtual void interactive(IN(acdk::io::RCharReader) in, IN(acdk::io::RCharWriter) out, IN(acdk::io::RCharWriter) err);
  foreign void* interpreter() { return _interpreter; }
  static RTclInterpreter getInstance();
};

} // namespace acdk 
} // namespace tcl

#endif //acdk_tcl_TclInterpreter_h