src/aclvis/Interp.h

Go to the documentation of this file.

// -*- C++ -*-
/***************************************************************************
 *
 * The IPPL Framework
 * 
 *
 * Visit http://people.web.psi.ch/adelmann/ for more details
 *
 ***************************************************************************/

#ifndef ACLVIS_INTERP_H
#define ACLVIS_INTERP_H

// include files
#include "aclvis/InterpNamedObj.h"

// forward references
class InterpCmd;


class Interp : public InterpNamedObj {

public:
  // Constructor - nm is the name of the interpreter, and is used
  // as the string presented at the prompt (if you want a >, as in
  // cmd>, you must include it in the name)
  Interp(const char *);

  // Destructor
  virtual ~Interp();

  // Add a new command callback to the interpreter, by providing a InterpCmd.
  virtual void addCommand(InterpCmd&) = 0;

  // Take the given string and have the interpreter evaluate it as a command.
  // Return true if OK, false if an error occurred.
  virtual bool evalCommand(const char *) = 0;

  // Bind a given variable to the given string variable name ... modifying
  // the interpreter variable should then modify the bound variable.
  // This is available for integer and double variables.
  virtual void bindVar(const char *, int &) = 0;
  virtual void bindVar(const char *, double &) = 0;

  // Provide a prompt and input a command from the user.  Return only
  // when the command "go" is given.  If the timeout vlaue is < 0, this
  // routine will only return if the user types "go".  Otherwise, it will
  // return when a timeout occurs.
  virtual void interact(int timeoutseconds = (-1));
};

#endif // ACLVIS_INTERP_H

/***************************************************************************
 * $RCSfile: Interp.h,v $   $Author: adelmann $
 * $Revision: 1.1.1.1 $   $Date: 2003/01/23 07:40:34 $
 * IPPL_VERSION_ID: $Id: Interp.h,v 1.1.1.1 2003/01/23 07:40:34 adelmann Exp $ 
 ***************************************************************************/

---