gsm.h

Gambit 是一个游戏库理论软件

//
// $Source: /home/gambit/CVS/gambit/sources/gcl/gsm.h,v $
// $Date: 2002/08/27 18:57:17 $
// $Revision: 1.4 $
//
// DESCRIPTION:
// Interface to GCL environment (GSM)
//
// This file is part of Gambit
// Copyright (c) 2002, The Gambit Project
//
// 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//

#ifndef GSM_H
#define GSM_H

#include "base/base.h"
#include "gsmincl.h"
#include "gsminstr.h"
#include "gsmhash.h"
#include "gclstatus.h"

class gclFunction;
class CallFuncObj;
class Portion;
class RefHashTable;
class FunctionHashTable;
class gclSignature;

class gText;
class gRational;

class Node;
class Infoset;

template <class T> class gList;
template <class T> class gStack;

template <class T> class RefCountHashTable;


class GSM  {
friend class gclFunctionCall;
friend class gclVarName;
friend class gclStatus;
private:
  static int _NumObj;

  static RefCountHashTable< void* > _GameRefCount;

  gInput&  _StdIn;
  gOutput& _StdOut;
  gOutput& _StdErr;

  Portion* _OUTPUT;
  Portion* _INPUT;
  Portion* _NULL;

  gStack< RefHashTable* >*       _RefTableStack;
  gStack< gText >*             _FuncNameStack;
  RefHashTable                   _GlobalRefTable;
  FunctionHashTable*             _FuncTable;

  void _BindCheck ( void ) const;
  bool _Bind ( const gText& param_name ) const;

  Portion* _VarRemove    ( const gText& var_name );

  // This function is located in gsmfunc.cc
  void InitFunctions( void );


public:
  GSM(gInput &p_input, gOutput &p_output, gOutput &p_error);
  virtual ~GSM();

  static int& GameRefCount(void*);

  bool PushRef  ( const gText& ref );
  void _ResolveRef ( Portion*& p );


  // Assign() will delete lhs and rhs
  Portion* Assign       ( Portion* lhs, Portion* rhs );
  void     VarDefine    ( const gText& var_name, Portion* p );
  bool     VarIsDefined ( const gText& var_name ) const;
  Portion* VarValue     ( const gText& var_name ) const;
  bool     UnAssign     ( Portion * );
  Portion* UnAssignExt  ( Portion * );
  bool VarRemove    ( const gText& var_name );

  bool AddFunction( gclFunction* func );
  bool DeleteFunction( gclFunction* func );

  Portion* Execute(gclExpression *, bool user_func = false );
  Portion* ExecuteUserFunc( gclExpression& program, 
			   const gclSignature& func_info,
			   Portion** param, 
			   const gText& funcname );
  gText UserFuncName( void ) const;
  
  void Clear  ( void );

  Portion* Help(gText text, bool udf, bool bif, bool getdesc = false );
  Portion* HelpVars(gText text);

  void InvalidateGameProfile( void* game, bool IsEfg );
  void UnAssignGameElement( void* game, bool IsEfg, PortionSpec spec );  

  void UnAssignEfgOutcome(efgGame *game, const efgOutcome *outcome);
  // Unassigns a SINGLE given element of an Efg
  void UnAssignEfgElement(efgGame *game, PortionSpec spec, void* data );

  // This function will unassign an infoset and all associated actions
  void UnAssignEfgInfoset(efgGame *game, Infoset* infoset );

  // This function will unassign the subtree rooted by the given node
  void UnAssignEfgSubTree(efgGame *game, Node* node ); 


  void GlobalVarDefine     ( const gText& var_name, Portion* p );
  bool GlobalVarIsDefined  ( const gText& var_name ) const;
  Portion* GlobalVarValue  ( const gText& var_name ) const;
  void GlobalVarRemove     ( const gText& var_name );

  gOutput &OutputStream(void) const { return _StdOut; }
  gOutput &ErrorStream(void) const { return _StdErr; }

  virtual gStatus &GetStatusMonitor(void) = 0;
  virtual void StartAlgorithmMonitor(const gText &);
  virtual void EndAlgorithmMonitor(void);
};


class gclRuntimeError : public gException  {
private:
  gText message;

public:
  gclRuntimeError(const gText &);
  virtual ~gclRuntimeError();

  gText Description(void) const;
};

#endif  // GSM_H