// state.h - Save and restore state predicates.
//          - Manage global state variables
//
// ##Copyright##
// 
// Copyright 2000-2016 Peter Robinson  (pjr@itee.uq.edu.au)
//
// Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.00 
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ##Copyright##
//
// $Id: state.h,v 1.1.1.1 2000/12/07 21:48:04 qp Exp $

#ifndef STATE_H
#define STATE_H

public:
//
// psi_save(filename)
// Save the state of the execution into the "filename".
// mode(in)
//
ReturnValue psi_save(Object *&);

//
// psi_restore(filename)
// Restore the state of the execution from the "filename".
// mode(in)
//
ReturnValue psi_restore(Object *&);

// psi_global_state_set(key, value)
// Assign a value for a global state entry.
// mode(in,in)
//
ReturnValue psi_global_state_set(Object *&, Object *&);

// psi_global_state_lookup(key, value)
// Lookup a value for a global state entry.
// mode(in,out)
//
ReturnValue psi_global_state_lookup(Object *&, Object *&);

// psi_global_state_increment(key, value)
// Increment the value for a global state entry and return the new value.
// mode(in,out)
//
ReturnValue psi_global_state_increment(Object *&, Object *&);

// psi_global_state_decrement(key, value)
// Decrement the value for a global state entry and return the new value.
// mode(in,out)
//
ReturnValue psi_global_state_decrement(Object *&, Object *&);

#endif // STATE_H
