libretro/scummvm
1
0
Fork 0
mirror of https://github.com/libretro/scummvm.git synced 2024-12-15 06:08:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
a700883e6f
scummvm/common/forbidden.h
Paul Gilbert eb80a2119b COMMON: Fix string method comments in forbidden.h
2023-06-12 19:14:09 -07:00

599 lines
19 KiB
C
Raw Blame History

/* 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 3 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, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef COMMON_FORBIDDEN_H
#define COMMON_FORBIDDEN_H
/**
* @file
* This header file is meant to help ensure that engines and
* infrastructure code do not make use of certain "forbidden" APIs, such
* as fopen(), setjmp(), etc.
* This is achieved by re-#defining various symbols to a "garbage"
* string which then triggers a compiler error.
*
* Backend files may #define FORBIDDEN_SYMBOL_ALLOW_ALL if they
* have to access functions like fopen, fread etc.
* Regular code, esp. code in engines/, should never do that.
* To ease transition, though, we allow re-enabling selected symbols
* in frontend code. However, this should only be used as a temporary
* measure. Especially new code should avoid this at all costs.
*/
#ifndef FORBIDDEN_SYMBOL_ALLOW_ALL
// Make sure scummsys.h is always included first
#include "common/scummsys.h"
/**
* The garbage string to use as replacement for forbidden symbols.
*
* The reason for this particular string is the following:
* By including a space and some non-alphanumeric symbols we trigger
* a compiler error. By including the words "forbidden symbol" (which
* the compiler will hopefully print along with its own error message),
* we try to make clear what is causing the error.
*/
// Use debug and warning in common/textconsole.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_printf
#undef printf
#define printf FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use g_system->getSaveFileManager()->openForSaving
// to create output streams and use the stream's methods
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_fprintf
#undef fprintf
#define fprintf FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::String::format to format strings,
// and then debug or warning to output to console
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_vprintf
#undef vprintf
#define vprintf FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::String::format to format strings,
// and then use the save file manager's methods to write
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_vfprintf
#undef vfprintf
#define vfprintf FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::File in common/file.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_FILE
#undef FILE
#define FILE FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use g_system->getEventManager()->pollEvent to
// get events, one type of which is keyboard events
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_stdin
#undef stdin
#define stdin FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use debug and warning in common/textconsole.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_stdout
#undef stdout
#define stdout FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use debug and warning in common/textconsole.h
// ScummVM also has an error method, but this also
// exits the program immediately
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_stderr
#undef stderr
#define stderr FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::File in common/file.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_fopen
#undef fopen
#define fopen(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::File in common/file.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_fclose
#undef fclose
#define fclose(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::File in common/file.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_fread
#undef fread
#define fread(a,b,c,d) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::File in common/file.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_fwrite
#undef fwrite
#define fwrite(a,b,c,d) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::File in common/file.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_fseek
#undef fseek
#define fseek(a,b,c) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::File in common/file.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_ftell
#undef ftell
#define ftell(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::File in common/file.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_feof
#undef feof
#define feof(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::File in common/file.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_fgetc
#undef fgetc
#define fgetc(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// For writing to files use the save file manager
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_fputc
#undef fputc
#define fputc(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::File in common/file.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_fgets
#undef fgets
#define fgets(a,b,c) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// For writing to files use the save file manager
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_fputs
#undef fputs
#define fputs(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use g_system->getEventManager()->pollEvent to
// get events, one type of which is keyboard events
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_getc
#undef getc
#define getc(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use debug and warning in common/textconsole.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_putc
#undef putc
#define putc(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use g_system->getEventManager()->pollEvent to
// get events, one type of which is keyboard events
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_gets
#undef gets
#define gets(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use debug and warning in common/textconsole.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_puts
#undef puts
#define puts(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use g_system->getEventManager()->pollEvent to
// get events, one type of which is keyboard events
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_getchar
#undef getchar
#define getchar() FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use debug and warning in common/textconsole.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_putchar
#undef putchar
#define putchar(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// No equivalent in ScummVM
// mingw-w64 uses [set|long]jmp in system headers
#if !defined __MINGW64__ && ! defined __MINGW32__
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_setjmp
#undef setjmp
#define setjmp(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// No equivalent in ScummVM
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_longjmp
#undef longjmp
#define longjmp(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#endif // __MINGW64__ __MINGW32__
// No equivalent in ScummVM. The functionality of
// any system calls need to reimplemented as code
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_system
#undef system
#define system(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// You can either use error in common/textconsole.h
// to force stopping your engine, or do a call
// g_engine->quitGame(). For the latter, make sure to
// do g_engine->shouldQuit() checks in the loops of any
// calling methods so execution can break out of them
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_exit
#undef exit
#define exit(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use error or quitGame
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_abort
#undef abort
#define abort() FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use ConfMan in common/config-manager.h to save
// settings rather than environment variables
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_getenv
#undef getenv
#define getenv(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use ConfMan in common/config-manager.h to save
// settings rather than environment variables
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_putenv
#undef putenv
#define putenv(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use ConfMan in common/config-manager.h to save
// settings rather than environment variables
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_setenv
#undef setenv
#define setenv(a,b,c) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use ConfMan in common/config-manager.h to save
// settings rather than environment variables
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_unsetenv
#undef unsetenv
#define unsetenv(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
//
// Disable various symbols from time.h
// Use instead g_system->getTimeAndDate
//
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_time_h
/*
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_time_t
#undef time_t
#define time_t FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
*/
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_asctime
#undef asctime
#define asctime(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_clock
#undef clock
#define clock() FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_ctime
#undef ctime
#define ctime(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_difftime
#undef difftime
#define difftime(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_getdate
#undef getdate
#define getdate(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_gmtime
#undef gmtime
#define gmtime(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_localtime
#undef localtime
#define localtime(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_mktime
#undef mktime
#define mktime(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_time
#undef time
#define time(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#endif // FORBIDDEN_SYMBOL_EXCEPTION_time_h
//
// Disable various symbols from unistd.h
//
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_unistd_h
// ScummVM does not allow changing the current directory
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_chdir
#undef chdir
#define chdir(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// ScummVM has no equivalent for getting the current directory.
// However, you can use ConfMan.get("path") to get the
// running game's directory
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_getcwd
#undef getcwd
#define getcwd(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// ScummVM has no equivalent for getting the current directory.
// However, you can use ConfMan.get("path") to get the
// running game's directory
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_getwd
#undef getwd
#define getwd(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// ScummVM only allows deleting save files, via the
// save file manager's removeSavefile method
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_unlink
#undef unlink
#define unlink(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#endif // FORBIDDEN_SYMBOL_EXCEPTION_unistd_h
//
// Disable various symbols from ctype.h
//
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_ctype_h
// Use Common::isAlnum in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_isalnum
#undef isalnum
#define isalnum(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isAlpha in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_isalpha
#undef isalpha
#define isalpha(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isCntrl in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_iscntrl
#undef iscntrl
#define iscntrl(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isDigit in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_isdigit
#undef isdigit
#define isdigit(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isGraph in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_isgraph
#undef isgraph
#define isgraph(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isDigit in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_isnumber
#undef isnumber
#define isnumber(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isLower in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_islower
#undef islower
#define islower(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isPrint in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_isprint
#undef isprint
#define isprint(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isPunct in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_ispunct
#undef ispunct
#define ispunct(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isSpace in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_isspace
#undef isspace
#define isspace(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isUpper in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_isupper
#undef isupper
#define isupper(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isXDigit in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_isxdigit
#undef isxdigit
#define isxdigit(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::isBlank in common/util.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_isblank
#undef isblank
#define isblank(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
#endif // FORBIDDEN_SYMBOL_EXCEPTION_ctype_h
// No equivalent in ScummVM
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_mkdir
#undef mkdir
#define mkdir(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
/*
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_setlocale
#undef setlocale
#define setlocale(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
*/
// No equivalent in ScummVM
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_setvbuf
#undef setvbuf
#define setvbuf(a,b,c,d) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Temporary files must be manually implemented using save files
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_tmpfile
#undef tmpfile
#define tmpfile() FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Temporary files must be manually implemented using save files
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_tmpnam
#undef tmpnam
#define tmpnam(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Temporary files must be manually implemented using save files
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_tempnam
#undef tempnam
#define tempnam(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Define a Common::RandomSource as part of the engine,
// which has a getRandomNumber method
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_rand
#undef rand
#define rand() FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Define a Common::RandomSource as part of the engine,
// which has a setSeed method
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_srand
#undef srand
#define srand(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Define a Common::RandomSource as part of the engine,
// which has a getRandomNumber method
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_random
#undef random
#define random() FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Define a Common::RandomSource as part of the engine,
// which has a setSeed method
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_srandom
#undef srandom
#define srandom(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::strcat_s or Common::strlcat in common/str.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_strcat
#undef strcat
#define strcat(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::strcpy_s or Common::strlcpy in common/str.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_strcpy
#undef strcpy
#define strcpy(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::vsprintf_s in common/str.h or vsnprintf
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_vsprintf
#undef vsprintf
#define vsprintf(a,b,c) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use Common::sprintf_s in common/str.h or snprintf
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_sprintf
#undef sprintf
#define sprintf(a,b,...) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use scumm_stricmp in common/str.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_stricmp
#undef stricmp
#define stricmp(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use scumm_strnicmp in common/str.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_strnicmp
#undef strnicmp
#define strnicmp(a,b,c) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use scumm_stricmp in common/str.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_strcasecmp
#undef strcasecmp
#define strcasecmp(a,b) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use scumm_strnicmp in common/str.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_strncasecmp
#undef strncasecmp
#define strncasecmp(a,b,c) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
// Use scumm_strdup in common/str.h
#ifndef FORBIDDEN_SYMBOL_EXCEPTION_strdup
#undef strdup
#define strdup(a) FORBIDDEN_look_at_common_forbidden_h_for_more_info SYMBOL !%*
#endif
/*
* We also would like to disable the following symbols;
* however, these are also frequently used in regular code,
* e.g. for method names, so we don't override them.
* - read
* - remove
* - write
* - ...
*/
#endif
#endif
Reference in New Issue View Git Blame Copy Permalink