scummvm/engines/sword25/script/script.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * $URL$
 * $Id$
 *
 */

/* 
 * This code is based on Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

#ifndef SWORD25_SCRIPT_H
#define SWORD25_SCRIPT_H

// -----------------------------------------------------------------------------
// Includes
// -----------------------------------------------------------------------------

#include "common/array.h"
#include "common/str.h"
#include "sword25/kernel/common.h"
#include "sword25/kernel/service.h"
#include "sword25/kernel/persistable.h"

namespace Sword25 {

// -----------------------------------------------------------------------------
// Forward declarations
// -----------------------------------------------------------------------------

class BS_Kernel;
class BS_OutputPersistenceBlock;
class BS_InputPersistenceBlock;

// -----------------------------------------------------------------------------
// Class declaration
// -----------------------------------------------------------------------------

class BS_ScriptEngine : public BS_Service, public BS_Persistable {
public:
	// -----------------------------------------------------------------------------
	// Constructor / destructor
	// -----------------------------------------------------------------------------
	
	BS_ScriptEngine(BS_Kernel * KernelPtr) : BS_Service(KernelPtr) {};
	virtual ~BS_ScriptEngine() {};

	// -----------------------------------------------------------------------------
	// This method must be implemented by the script engine
	// -----------------------------------------------------------------------------
	
	/**
	 * Initialises the scrip tengine. Returns true if successful, false otherwise.
	 */
	virtual bool Init() = 0;

	/**
	 * Loads a script file and executes it. 
	 * @param FileName		The script filename
	*/
	virtual bool ExecuteFile(const Common::String &FileName) = 0;

	/**
	 * Executes a specified script fragment
	 * @param Code		String of script code
	 */
	virtual bool ExecuteString(const Common::String &Code) = 0;

	/**
	 * Returns a pointer to the main object of the script engine
	 * Note: Using this method breaks the encapsulation of the language from the rest of the engine.
	 */
	virtual void * GetScriptObject() = 0;

	/**
	 * Makes the command line parameters for the script environment available
	 * Note: How the command line parameters will be used by scripts is dependant on the
	 * particular implementation.
	 * @param CommandLineParameters		List containing the command line parameters
	*/
	virtual void SetCommandLine(const Common::Array<Common::String> &CommandLineParameters) = 0;

	virtual bool Persist(BS_OutputPersistenceBlock &Writer) = 0;
	virtual bool Unpersist(BS_InputPersistenceBlock &Reader) = 0;
};

} // End of namespace Sword25

#endif