diff options
author | Max Horn | 2009-02-24 06:00:10 +0000 |
---|---|---|
committer | Max Horn | 2009-02-24 06:00:10 +0000 |
commit | d19ba951e825ce8ee4ae7c1c058ba517c678eb68 (patch) | |
tree | 0b1376ce4da6871a9cc16d8564f95236048a3231 /engines/sci/include | |
parent | 7105df20fa34e7819f5b416526405424cf9b36b5 (diff) | |
download | scummvm-rg350-d19ba951e825ce8ee4ae7c1c058ba517c678eb68.tar.gz scummvm-rg350-d19ba951e825ce8ee4ae7c1c058ba517c678eb68.tar.bz2 scummvm-rg350-d19ba951e825ce8ee4ae7c1c058ba517c678eb68.zip |
SCI: Moved sciconsole.h and sys_strings.h to the dirs their *.cpp counterparts are in
svn-id: r38835
Diffstat (limited to 'engines/sci/include')
-rw-r--r-- | engines/sci/include/engine.h | 2 | ||||
-rw-r--r-- | engines/sci/include/sciconsole.h | 230 | ||||
-rw-r--r-- | engines/sci/include/sys_strings.h | 80 |
3 files changed, 1 insertions, 311 deletions
diff --git a/engines/sci/include/engine.h b/engines/sci/include/engine.h index c031ec77dc..46a17142cf 100644 --- a/engines/sci/include/engine.h +++ b/engines/sci/include/engine.h @@ -37,7 +37,7 @@ namespace Common { #include "sci/include/vocabulary.h" #include "sci/include/sciresource.h" #include "sci/include/script.h" -#include "sci/include/sciconsole.h" +#include "sci/scicore/sciconsole.h" #include "sci/include/versions.h" #include "sci/engine/seg_manager.h" #include "sci/gfx/gfx_state_internal.h" diff --git a/engines/sci/include/sciconsole.h b/engines/sci/include/sciconsole.h deleted file mode 100644 index 92c80601be..0000000000 --- a/engines/sci/include/sciconsole.h +++ /dev/null @@ -1,230 +0,0 @@ -/* 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$ - * - */ - -/* Header file for the SCI console. -** Please note that the console does not use the priority field; the console -** should therefore be drawn after everything else has been drawn (with the -** possible exception of the mouse pointer). -*/ - -#ifndef _SCI_CONSOLE_H_ -#define _SCI_CONSOLE_H_ - -#include "common/scummsys.h" - -#include "sci/sci_memory.h" -#include "sci/tools.h" -#include "sci/include/vm_types.h" - -#define SCI_CONSOLE -#include "sci/gfx/gfx_operations.h" - -namespace Sci { - -extern int con_passthrough; -/* Echo all sciprintf() stuff to the text console */ -extern FILE *con_file; -/* Echo all sciprintf() output to a text file. Note: clients of freesci.dll -** should use open_console_file and close_console_file, rather than refer -** directly to the con_file variable. -*/ - -union cmd_param_t { - int32 val; - char *str; - reg_t reg; -}; - -extern unsigned int cmd_paramlength; -/* The number of parameters passed to a function called from the parser */ - -extern cmd_param_t *cmd_params; -/* The parameters passed to a function called by the parser */ - -extern struct EngineState *con_gamestate; -/* The game state as used by some of the console commands */ - - -/*** FUNCTION DEFINITIONS ***/ - -void con_set_string_callback(void(*callback)(char *)); -/* Sets the console string callback -** Parameters: (void -> char *) callback: The closure to invoke after -** a string for sciprintf() has been generated -** This sets a single callback function to be used after sciprintf() -** is used. -*/ - -void con_set_pixmap_callback(void(*callback)(gfx_pixmap_t *)); -/* Sets the console pixmap callback -** Parameters: (void -> gfx_pixmap_t *) callback: The closure to invoke after -** a pixmap has been provided to be -** published in the on-screen console -** This sets a single callback function to be used after sciprintf() -** is used. -*/ - -void con_init(); -/* Initializes the command parser -** Parameters: (void) -** Returns : (void) -** This function will initialize hook up a few commands to the parser. -** It must be called before cmdParse() is used. -*/ - - -void con_parse(EngineState *s, const char *command); -/* Parses a command and summons appropriate facilities to handle it -** Parameters: (EngineState *) s: The EngineState to use -** command: The command to execute -** Returns : (void) -*/ - - -int con_hook_command(int command(EngineState *s), const char *name, const char *param, const char *description); -/* Adds a command to the parser's command list -** Parameters: command: The command to add -** name: The command's name -** param: A description of the parameters it takes -** description: A short description of what it does -** Returns : 0 if successful, 1 if appending failed because -** of an incorrect *param string, 'command'==0, or -** 'name' already being in use. -** A valid param string is either empty (no parameters allowed) -** or contains one of the following tokens: -** ! Special token: EngineState* must be set for this function to be called -** i (an int) -** s (a 'string' (char *)) -** h (a byte, described in hexadecimal digits) -** a (a heap address, register or object name) -** r (any register value) -** x* (an arbitrary (possibly 0) number of 'x' tokens) -** The '*' token may only be used as the last token of the list. -** Another way to specify optional parameters is by means of the -** '-opt:t' notation, which allows an optional parameter of type 't' -** to be specified as 'opt:<value>' when calling. See also the -** con_hasopt() and con_getopt() calls. -** -** Please note that the 'h' type does accept hexadecimal numbers greater -** than 0xff and less than 0x00, but clips them to this range. -** -** Example: "isi*" would define the function to take an int, a -** string, and an arbitrary number of ints as parameters (in that sequence). -** -** When the function is called, it can retrieve its parameters from cmd_params; -** the actual number of parameters is stored in cmd_paramlength. -** It is allowed to modify the char*s from a cmd_params[] element, as long -** as no element beyond strlen(cmd_params[x].str)+1 is accessed. -*/ - -cmd_param_t con_getopt(char *opt); -/* Retreives the specified optional parameter -** -- for use within console functions only -- -** Parameters: (char *) opt: The optional parameter to retrieve -** Returns : (cmd_param_t) The corresponding parameter -** Should only be used if con_hasopt() reports its presence. -*/ - -int con_hasopt(char *opt); -/* Checks whether an optional parameter was specified -** -- for use within console functions only -- -** Parameters: (char *) opt: The optional parameter to check for -** Returns : (int) non-zero iff the parameter was specified -*/ - -int con_can_handle_pixmaps(); -/* Determines whether the console supports pixmap inserts -** Returns : (int) non-zero iff pixmap inserts are supported -*/ - -int con_insert_pixmap(gfx_pixmap_t *pixmap); -/* Inserts a pixmap into the console history buffer -** Parameters: (gfx_pixmap_t *) pixmap: The pixmap to insert -** Returns : (int) 0 on success, non-zero if no receiver for -** the pixmap could not be found -** The pixmap must be unique; it is freed by the console on demand. -** Use gfx_clone_pixmap() if neccessary. -** If the pixmap could not be inserted, the called must destroy it -*/ - -int con_hook_page(const char *topic, const char *body); -/* Hooks a general information page to the manual page system -** Parameters: (const char *) topic: The topic name -** (const char *) body: The text body to assign to the topic -** Returns : (int) 0 on success -*/ - -int con_hook_int(int *pointer, const char *name, const char *description); -/* Adds an int to the list of modifyable ints. -** Parameters: pointer: Pointer to the int to add to the list -** name: Name for this value -** description: A short description for the value -** Returns : 0 on success, 1 if either value has already been added -** or if name is already being used for a different value. -** The internal list of int references is used by some of the basic commands. -*/ - - -void con_gfx_init(); -/* Initializes the gfx console -*/ - -void con_gfx_show(gfx_state_t *state); -/* Enters on-screen console mode -** Parameters: (gfx_state_t *state): The graphics state to use for interaction -** Returns : (void) -*/ - -char *con_gfx_read(gfx_state_t *state); -/* Reads a single line from the on-screen console, if it is open -** Parameters: (gfx_state_t *state): The graphics state to use for interaction -** Returns : (char *) The input, in a static buffer -*/ - -void con_gfx_hide(gfx_state_t *stae); -/* Closes the on-screen console -** Parameters: (gfx_state_t *state): The graphics state to use for interaction -** Returns : (void) -*/ - - -int sci_hexdump(byte *data, int length, int offsetplus); - -void open_console_file(char *filename); -/* Opens the file to which the console output is echoed. If a file was opened -** before, closes it. -** Parameters: filename - name of the file -** Returns : (void) -*/ - -void close_console_file(); -/* Closes the console output file. -** Parameters: (void) -** Returns : (void) -*/ - -} // End of namespace Sci - -#endif /* _SCI_CONSOLE_H_ */ diff --git a/engines/sci/include/sys_strings.h b/engines/sci/include/sys_strings.h deleted file mode 100644 index 2d89a263d8..0000000000 --- a/engines/sci/include/sys_strings.h +++ /dev/null @@ -1,80 +0,0 @@ -/* 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$ - * - */ - -#ifndef SCI_SYS_STRINGS_H -#define SCI_SYS_STRINGS_H - -namespace Sci { - -enum { - SYS_STRINGS_MAX = 4, - - SYS_STRING_SAVEDIR = 0, - SYS_STRING_PARSER_BASE = 1, - - MAX_PARSER_BASE = 64 -}; - -struct sys_string_t { - char *name; - int max_size; - char *value; -}; - -struct sys_strings_t { - sys_string_t strings[SYS_STRINGS_MAX]; -}; - -void sys_string_acquire(sys_strings_t *strings, int index, const char *name, int max_len); -/* Reserves a new system string -** Parameters: (sys_strings_t *) strings: The string table to reserve in -** (int) index: Index number to reserve -** (const char *) name: Name the entry should be tagged with -** (int) max_len: Maximum string length in bytes -*/ - -int sys_string_set(sys_strings_t *strings, int index, const char *value); -/* Sets the value of a system string -** Parameters: (sys_strings_t *) strings: The string table to use -** (int) index: Index of the string to write to -** (const char *) value: The value to copy -** Returns : 0 on success, 1 on error -** Length clipping is performed. -*/ - -void sys_strings_restore(sys_strings_t *new_strings, sys_strings_t *old_strings); -/* Cleanup system strings after a gamestate restore -** Parameters: (sys_strings_t *) The freshly loaded system strings to clean up -** (sys_strings_t *) The old system strings to clean up -*/ - -void sys_string_free_all(sys_strings_t *strings); -/* Deallocates all allocated system strings -** Parameters: (sys_strings_t *) strings: The string table to deallocate -*/ - -} // End of namespace Sci - -#endif // SCI_SYS_STRINGS_H |