diff options
author | Simon Howard | 2010-05-01 21:20:30 +0000 |
---|---|---|
committer | Simon Howard | 2010-05-01 21:20:30 +0000 |
commit | da43e27597e40f5a298ed5c4ae785cc1b36510d4 (patch) | |
tree | 7bd57a534f9f036695fa0e69136ed8e44dd74cca | |
parent | 928963656d68dbface669773eecfb6b22ba15da5 (diff) | |
download | chocolate-doom-da43e27597e40f5a298ed5c4ae785cc1b36510d4.tar.gz chocolate-doom-da43e27597e40f5a298ed5c4ae785cc1b36510d4.tar.bz2 chocolate-doom-da43e27597e40f5a298ed5c4ae785cc1b36510d4.zip |
Silence printf(DEH_String(...)) warnings, by providing a DEH_printf
function that checks the format string is a valid replacement. Also add
DEH_fprintf and DEH_snprintf functions to use throughout the code to do
similar checking.
Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 1927
-rw-r--r-- | src/am_map.c | 6 | ||||
-rw-r--r-- | src/d_main.c | 32 | ||||
-rw-r--r-- | src/d_net.c | 10 | ||||
-rw-r--r-- | src/deh_main.h | 8 | ||||
-rw-r--r-- | src/deh_text.c | 228 | ||||
-rw-r--r-- | src/f_finale.c | 2 | ||||
-rw-r--r-- | src/hu_stuff.c | 2 | ||||
-rw-r--r-- | src/m_menu.c | 4 | ||||
-rw-r--r-- | src/p_saveg.c | 2 | ||||
-rw-r--r-- | src/p_setup.c | 4 | ||||
-rw-r--r-- | src/st_stuff.c | 22 | ||||
-rw-r--r-- | src/wi_stuff.c | 39 |
12 files changed, 297 insertions, 62 deletions
diff --git a/src/am_map.c b/src/am_map.c index 9a81d62c..4c58abdd 100644 --- a/src/am_map.c +++ b/src/am_map.c @@ -515,7 +515,7 @@ void AM_loadPics(void) for (i=0;i<10;i++) { - sprintf(namebuf, DEH_String("AMMNUM%d"), i); + DEH_snprintf(namebuf, 9, "AMMNUM%d", i); marknums[i] = W_CacheLumpName(namebuf, PU_STATIC); } @@ -528,7 +528,7 @@ void AM_unloadPics(void) for (i=0;i<10;i++) { - sprintf(namebuf, DEH_String("AMMNUM%d"), i); + DEH_snprintf(namebuf, 9, "AMMNUM%d", i); W_ReleaseLumpName(namebuf); } } @@ -1035,7 +1035,7 @@ AM_drawFline || fl->b.x < 0 || fl->b.x >= f_w || fl->b.y < 0 || fl->b.y >= f_h) { - fprintf(stderr, DEH_String("fuck %d \r"), fuck++); + DEH_fprintf(stderr, "fuck %d \r", fuck++); return; } diff --git a/src/d_main.c b/src/d_main.c index 3580c346..671c4e9c 100644 --- a/src/d_main.c +++ b/src/d_main.c @@ -819,7 +819,7 @@ void D_DoomMain (void) PrintBanner(PACKAGE_STRING); - printf (DEH_String("Z_Init: Init zone memory allocation daemon. \n")); + DEH_printf("Z_Init: Init zone memory allocation daemon. \n"); Z_Init (); #ifdef FEATURE_MULTIPLAYER @@ -936,7 +936,7 @@ void D_DoomMain (void) deathmatch = 2; if (devparm) - printf(DEH_String(D_DEVSTR)); + DEH_printf(D_DEVSTR); // find which dir to use for config files @@ -962,7 +962,7 @@ void D_DoomMain (void) scale = 10; if (scale > 400) scale = 400; - printf (DEH_String("turbo scale: %i%%\n"),scale); + DEH_printf("turbo scale: %i%%\n", scale); forwardmove[0] = forwardmove[0]*scale/100; forwardmove[1] = forwardmove[1]*scale/100; sidemove[0] = sidemove[0]*scale/100; @@ -970,14 +970,14 @@ void D_DoomMain (void) } // init subsystems - printf (DEH_String("V_Init: allocate screens.\n")); + DEH_printf("V_Init: allocate screens.\n"); V_Init (); - printf (DEH_String("M_LoadDefaults: Load system defaults.\n")); + DEH_printf("M_LoadDefaults: Load system defaults.\n"); M_ApplyPlatformDefaults(); M_LoadDefaults (); // load before initing other systems - printf (DEH_String("W_Init: Init WADfiles.\n")); + DEH_printf("W_Init: Init WADfiles.\n"); D_AddFile(iwadfile); #ifdef FEATURE_WAD_MERGE @@ -1322,8 +1322,8 @@ void D_DoomMain (void) if (p && p < myargc-1 && deathmatch) { - printf(DEH_String("Austin Virtual Gaming: Levels will end " - "after 20 minutes\n")); + DEH_printf("Austin Virtual Gaming: Levels will end " + "after 20 minutes\n"); timelimit = 20; } @@ -1437,16 +1437,16 @@ void D_DoomMain (void) PrintDehackedBanners(); - printf (DEH_String("M_Init: Init miscellaneous info.\n")); + DEH_printf("M_Init: Init miscellaneous info.\n"); M_Init (); - printf (DEH_String("R_Init: Init DOOM refresh daemon - ")); + DEH_printf("R_Init: Init DOOM refresh daemon - "); R_Init (); - printf (DEH_String("\nP_Init: Init Playloop state.\n")); + DEH_printf("\nP_Init: Init Playloop state.\n"); P_Init (); - printf (DEH_String("I_Init: Setting up machine state.\n")); + DEH_printf("I_Init: Setting up machine state.\n"); I_Init (); #ifdef FEATURE_MULTIPLAYER @@ -1454,18 +1454,18 @@ void D_DoomMain (void) NET_Init (); #endif - printf (DEH_String("S_Init: Setting up sound.\n")); + DEH_printf("S_Init: Setting up sound.\n"); S_Init (sfxVolume * 8, musicVolume * 8); - printf (DEH_String("D_CheckNetGame: Checking network game status.\n")); + DEH_printf("D_CheckNetGame: Checking network game status.\n"); D_CheckNetGame (); PrintGameVersion(); - printf (DEH_String("HU_Init: Setting up heads up display.\n")); + DEH_printf("HU_Init: Setting up heads up display.\n"); HU_Init (); - printf (DEH_String("ST_Init: Init status bar.\n")); + DEH_printf("ST_Init: Init status bar.\n"); ST_Init (); // If Doom II without a MAP01 lump, this is a store demo. diff --git a/src/d_net.c b/src/d_net.c index f5890769..faf47821 100644 --- a/src/d_net.c +++ b/src/d_net.c @@ -370,17 +370,17 @@ void D_CheckNetGame (void) ++num_players; } - printf (DEH_String("startskill %i deathmatch: %i startmap: %i startepisode: %i\n"), - startskill, deathmatch, startmap, startepisode); + DEH_printf("startskill %i deathmatch: %i startmap: %i startepisode: %i\n", + startskill, deathmatch, startmap, startepisode); - printf(DEH_String("player %i of %i (%i nodes)\n"), - consoleplayer+1, num_players, num_players); + DEH_printf("player %i of %i (%i nodes)\n", + consoleplayer+1, num_players, num_players); // Show players here; the server might have specified a time limit if (timelimit > 0) { - printf(DEH_String("Levels will end after %d minute"),timelimit); + DEH_printf("Levels will end after %d minute", timelimit); if (timelimit > 1) printf("s"); printf(".\n"); diff --git a/src/deh_main.h b/src/deh_main.h index 6afe07f3..9248e982 100644 --- a/src/deh_main.h +++ b/src/deh_main.h @@ -27,6 +27,8 @@ #ifndef DEH_MAIN_H #define DEH_MAIN_H +#include <stdio.h> + #include "doomtype.h" #include "doomfeatures.h" #include "md5.h" @@ -52,10 +54,16 @@ void DEH_Checksum(md5_digest_t digest); #ifdef FEATURE_DEHACKED char *DEH_String(char *s); +void DEH_printf(char *fmt, ...); +void DEH_fprintf(FILE *fstream, char *fmt, ...); +void DEH_snprintf(char *buffer, size_t len, char *fmt, ...); #else #define DEH_String(x) (x) +#define DEH_printf printf +#define DEH_fprintf fprintf +#define DEH_snprintf snprintf #endif diff --git a/src/deh_text.c b/src/deh_text.c index 9e8cc79d..5c6446dc 100644 --- a/src/deh_text.c +++ b/src/deh_text.c @@ -24,6 +24,8 @@ // //----------------------------------------------------------------------------- +#include <stdarg.h> + #include "doomdef.h" #include "doomtype.h" @@ -251,3 +253,229 @@ deh_section_t deh_section_text = NULL, }; +typedef enum +{ + FORMAT_ARG_INVALID, + FORMAT_ARG_INT, + FORMAT_ARG_FLOAT, + FORMAT_ARG_CHAR, + FORMAT_ARG_STRING, + FORMAT_ARG_PTR, + FORMAT_ARG_SAVE_POS +} format_arg_t; + +// Get the type of a format argument. +// We can mix-and-match different format arguments as long as they +// are for the same data type. + +static format_arg_t FormatArgumentType(char c) +{ + switch (c) + { + case 'd': case 'i': case 'o': case 'u': case 'x': case 'X': + return FORMAT_ARG_INT; + + case 'e': case 'E': case 'f': case 'F': case 'g': case 'G': + case 'a': case 'A': + return FORMAT_ARG_FLOAT; + + case 'c': case 'C': + return FORMAT_ARG_CHAR; + + case 's': case 'S': + return FORMAT_ARG_STRING; + + case 'p': + return FORMAT_ARG_PTR; + + case 'n': + return FORMAT_ARG_SAVE_POS; + + default: + return FORMAT_ARG_INVALID; + } +} + +// Given the specified string, get the type of the first format +// string encountered. + +static format_arg_t NextFormatArgument(char **str) +{ + format_arg_t argtype; + + // Search for the '%' starting the next string. + + while (**str != '\0') + { + if (**str == '%') + { + ++*str; + + // Don't stop for double-%s. + + if (**str != '%') + { + break; + } + } + + ++*str; + } + + // Find the type of the format string. + + while (**str != '\0') + { + argtype = FormatArgumentType(**str); + + if (argtype != FORMAT_ARG_INVALID) + { + ++*str; + + return argtype; + } + + ++*str; + } + + // Stop searching, we have reached the end. + + *str = NULL; + + return FORMAT_ARG_INVALID; +} + +// Check if the specified argument type is a valid replacement for +// the original. + +static boolean ValidArgumentReplacement(format_arg_t original, + format_arg_t replacement) +{ + // In general, the original and replacement types should be + // identical. However, there are some cases where the replacement + // is valid and the types don't match. + + // Characters can be represented as ints. + + if (original == FORMAT_ARG_CHAR && replacement == FORMAT_ARG_INT) + { + return true; + } + + // Strings are pointers. + + if (original == FORMAT_ARG_STRING && replacement == FORMAT_ARG_PTR) + { + return true; + } + + return original == replacement; +} + +// Return true if the specified string contains no format arguments. + +static boolean ValidFormatReplacement(char *original, char *replacement) +{ + char *rover1; + char *rover2; + int argtype1, argtype2; + + // Check each argument in turn and compare types. + + rover1 = original; rover2 = replacement; + + for (;;) + { + argtype1 = NextFormatArgument(&rover1); + argtype2 = NextFormatArgument(&rover2); + + if (argtype2 == FORMAT_ARG_INVALID) + { + // No more arguments left to read from the replacement string. + + break; + } + else if (argtype1 == FORMAT_ARG_INVALID) + { + // Replacement string has more arguments than the original. + + return false; + } + else if (!ValidArgumentReplacement(argtype1, argtype2)) + { + // Not a valid replacement argument. + + return false; + } + } + + return true; +} + +// Get replacement format string, checking arguments. + +static char *FormatStringReplacement(char *s) +{ + char *repl; + + repl = DEH_String(s); + + if (!ValidFormatReplacement(s, repl)) + { + printf("WARNING: Unsafe dehacked replacement provided for " + "printf format string: %s\n", s); + + return s; + } + + return repl; +} + +// printf(), performing a replacement on the format string. + +void DEH_printf(char *fmt, ...) +{ + va_list args; + char *repl; + + repl = FormatStringReplacement(fmt); + + va_start(args, fmt); + + vprintf(repl, args); + + va_end(args); +} + +// fprintf(), performing a replacement on the format string. + +void DEH_fprintf(FILE *fstream, char *fmt, ...) +{ + va_list args; + char *repl; + + repl = FormatStringReplacement(fmt); + + va_start(args, fmt); + + vfprintf(fstream, repl, args); + + va_end(args); +} + +// snprintf(), performing a replacement on the format string. + +void DEH_snprintf(char *buffer, size_t len, char *fmt, ...) +{ + va_list args; + char *repl; + + repl = FormatStringReplacement(fmt); + + va_start(args, fmt); + + vsnprintf(buffer, len, repl, args); + + va_end(args); +} + diff --git a/src/f_finale.c b/src/f_finale.c index 1a3a85ca..3f0082cb 100644 --- a/src/f_finale.c +++ b/src/f_finale.c @@ -663,7 +663,7 @@ void F_BunnyScroll (void) laststage = stage; } - sprintf (name, DEH_String("END%i"), stage); + DEH_snprintf(name, 10, "END%i", stage); V_DrawPatch ((SCREENWIDTH-13*8)/2, (SCREENHEIGHT-8*8)/2,0, W_CacheLumpName (name,PU_CACHE)); } diff --git a/src/hu_stuff.c b/src/hu_stuff.c index 9f86c0b9..1381532d 100644 --- a/src/hu_stuff.c +++ b/src/hu_stuff.c @@ -345,7 +345,7 @@ void HU_Init(void) j = HU_FONTSTART; for (i=0;i<HU_FONTSIZE;i++) { - sprintf(buffer, DEH_String("STCFN%.3d"), j++); + DEH_snprintf(buffer, 9, "STCFN%.3d", j++); hu_font[i] = (patch_t *) W_CacheLumpName(buffer, PU_STATIC); } diff --git a/src/m_menu.c b/src/m_menu.c index 1ced1d16..5fb1ae7c 100644 --- a/src/m_menu.c +++ b/src/m_menu.c @@ -729,7 +729,7 @@ void M_QuickSave(void) quickSaveSlot = -2; // means to pick a slot now return; } - sprintf(tempstring,DEH_String(QSPROMPT),savegamestrings[quickSaveSlot]); + DEH_snprintf(tempstring, 80, QSPROMPT, savegamestrings[quickSaveSlot]); M_StartMessage(tempstring,M_QuickSaveResponse,true); } @@ -761,7 +761,7 @@ void M_QuickLoad(void) M_StartMessage(DEH_String(QSAVESPOT),NULL,false); return; } - sprintf(tempstring,DEH_String(QLPROMPT),savegamestrings[quickSaveSlot]); + DEH_snprintf(tempstring, 80, QLPROMPT, savegamestrings[quickSaveSlot]); M_StartMessage(tempstring,M_QuickLoadResponse,true); } diff --git a/src/p_saveg.c b/src/p_saveg.c index d2a4393d..968120c0 100644 --- a/src/p_saveg.c +++ b/src/p_saveg.c @@ -76,7 +76,7 @@ char *P_SaveGameFile(int slot) filename = malloc(strlen(savegamedir) + 32); } - sprintf(basename, DEH_String(SAVEGAMENAME "%d.dsg"), slot); + DEH_snprintf(basename, 32, SAVEGAMENAME "%d.dsg", slot); sprintf(filename, "%s%s", savegamedir, basename); diff --git a/src/p_setup.c b/src/p_setup.c index 58edc6fd..7d9d4318 100644 --- a/src/p_setup.c +++ b/src/p_setup.c @@ -774,9 +774,9 @@ P_SetupLevel if ( gamemode == commercial) { if (map<10) - sprintf (lumpname, DEH_String("map0%i"), map); + DEH_snprintf(lumpname, 9, "map0%i", map); else - sprintf (lumpname, DEH_String("map%i"), map); + DEH_snprintf(lumpname, 9, "map%i", map); } else { diff --git a/src/st_stuff.c b/src/st_stuff.c index d48609b4..d9c45098 100644 --- a/src/st_stuff.c +++ b/src/st_stuff.c @@ -1081,10 +1081,10 @@ static void ST_loadUnloadGraphics(load_callback_t callback) // Load the numbers, tall and short for (i=0;i<10;i++) { - sprintf(namebuf, DEH_String("STTNUM%d"), i); + DEH_snprintf(namebuf, 9, "STTNUM%d", i); callback(namebuf, &tallnum[i]); - sprintf(namebuf, DEH_String("STYSNUM%d"), i); + DEH_snprintf(namebuf, 9, "STYSNUM%d", i); callback(namebuf, &shortnum[i]); } @@ -1096,7 +1096,7 @@ static void ST_loadUnloadGraphics(load_callback_t callback) // key cards for (i=0;i<NUMCARDS;i++) { - sprintf(namebuf, DEH_String("STKEYS%d"), i); + DEH_snprintf(namebuf, 9, "STKEYS%d", i); callback(namebuf, &keys[i]); } @@ -1106,7 +1106,7 @@ static void ST_loadUnloadGraphics(load_callback_t callback) // arms ownership widgets for (i=0; i<6; i++) { - sprintf(namebuf, DEH_String("STGNUM%d"), i+2); + DEH_snprintf(namebuf, 9, "STGNUM%d", i+2); // gray # callback(namebuf, &arms[i][0]); @@ -1116,7 +1116,7 @@ static void ST_loadUnloadGraphics(load_callback_t callback) } // face backgrounds for different color players - sprintf(namebuf, DEH_String("STFB%d"), consoleplayer); + DEH_snprintf(namebuf, 9, "STFB%d", consoleplayer); callback(namebuf, &faceback); // status bar background bits @@ -1128,23 +1128,23 @@ static void ST_loadUnloadGraphics(load_callback_t callback) { for (j=0; j<ST_NUMSTRAIGHTFACES; j++) { - sprintf(namebuf, DEH_String("STFST%d%d"), i, j); + DEH_snprintf(namebuf, 9, "STFST%d%d", i, j); callback(namebuf, &faces[facenum]); ++facenum; } - sprintf(namebuf, DEH_String("STFTR%d0"), i); // turn right + DEH_snprintf(namebuf, 9, "STFTR%d0", i); // turn right callback(namebuf, &faces[facenum]); ++facenum; - sprintf(namebuf, DEH_String("STFTL%d0"), i); // turn left + DEH_snprintf(namebuf, 9, "STFTL%d0", i); // turn left callback(namebuf, &faces[facenum]); ++facenum; - sprintf(namebuf, DEH_String("STFOUCH%d"), i); // ouch! + DEH_snprintf(namebuf, 9, "STFOUCH%d", i); // ouch! callback(namebuf, &faces[facenum]); ++facenum; - sprintf(namebuf, DEH_String("STFEVL%d"), i); // evil grin ;) + DEH_snprintf(namebuf, 9, "STFEVL%d", i); // evil grin ;) callback(namebuf, &faces[facenum]); ++facenum; - sprintf(namebuf, DEH_String("STFKILL%d"), i); // pissed off + DEH_snprintf(namebuf, 9, "STFKILL%d", i); // pissed off callback(namebuf, &faces[facenum]); ++facenum; } diff --git a/src/wi_stuff.c b/src/wi_stuff.c index 5e87069e..e7eece07 100644 --- a/src/wi_stuff.c +++ b/src/wi_stuff.c @@ -1589,16 +1589,16 @@ static void WI_loadUnloadData(load_callback_t callback) if (gamemode == commercial) { for (i=0 ; i<NUMCMAPS ; i++) - { - sprintf(name, DEH_String("CWILV%2.2d"), i); + { + DEH_snprintf(name, 9, "CWILV%2.2d", i); callback(name, &lnames[i]); - } + } } else { for (i=0 ; i<NUMMAPS ; i++) { - sprintf(name, DEH_String("WILV%d%d"), wbs->epsd, i); + DEH_snprintf(name, 9, "WILV%d%d", wbs->epsd, i); callback(name, &lnames[i]); } @@ -1610,7 +1610,7 @@ static void WI_loadUnloadData(load_callback_t callback) // splat callback(DEH_String("WISPLAT"), &splat[0]); - + if (wbs->epsd < 3) { for (j=0;j<NUMANIMS[wbs->epsd];j++) @@ -1619,17 +1619,16 @@ static void WI_loadUnloadData(load_callback_t callback) for (i=0;i<a->nanims;i++) { // MONDO HACK! - if (wbs->epsd != 1 || j != 8) + if (wbs->epsd != 1 || j != 8) { // animations - sprintf(name, DEH_String("WIA%d%.2d%.2d"), - wbs->epsd, j, i); + DEH_snprintf(name, 9, "WIA%d%.2d%.2d", wbs->epsd, j, i); callback(name, &a->p[i]); } else { // HACK ALERT! - a->p[i] = anims[1][4].p[i]; + a->p[i] = anims[1][4].p[i]; } } } @@ -1642,7 +1641,7 @@ static void WI_loadUnloadData(load_callback_t callback) for (i=0;i<10;i++) { // numbers 0-9 - sprintf(name, DEH_String("WINUM%d"), i); + DEH_snprintf(name, 9, "WINUM%d", i); callback(name, &num[i]); } @@ -1683,13 +1682,13 @@ static void WI_loadUnloadData(load_callback_t callback) callback(DEH_String("WICOLON"), &colon); // "time" - callback(DEH_String("WITIME"), &timepatch); + callback(DEH_String("WITIME"), &timepatch); // "sucks" - callback(DEH_String("WISUCKS"), &sucks); + callback(DEH_String("WISUCKS"), &sucks); // "par" - callback(DEH_String("WIPAR"), &par); + callback(DEH_String("WIPAR"), &par); // "killers" (vertical) callback(DEH_String("WIKILRS"), &killers); @@ -1698,16 +1697,16 @@ static void WI_loadUnloadData(load_callback_t callback) callback(DEH_String("WIVCTMS"), &victims); // "total" - callback(DEH_String("WIMSTT"), &total); + callback(DEH_String("WIMSTT"), &total); for (i=0 ; i<MAXPLAYERS ; i++) { // "1,2,3,4" - sprintf(name, DEH_String("STPB%d"), i); + DEH_snprintf(name, 9, "STPB%d", i); callback(name, &p[i]); // "1,2,3,4" - sprintf(name, DEH_String("WIBP%d"), i+1); + DEH_snprintf(name, 9, "WIBP%d", i+1); callback(name, &bp[i]); } @@ -1725,7 +1724,7 @@ void WI_loadData(void) if (gamemode == commercial) { - NUMCMAPS = 32; + NUMCMAPS = 32; lnames = (patch_t **) Z_Malloc(sizeof(patch_t*) * NUMCMAPS, PU_STATIC, NULL); } @@ -1756,11 +1755,11 @@ void WI_loadData(void) { strcpy(bg_lumpname, DEH_String("INTERPIC")); } - else + else { - sprintf(bg_lumpname, DEH_String("WIMAP%d"), wbs->epsd); + DEH_snprintf(bg_lumpname, 9, "WIMAP%d", wbs->epsd); } - + bg = W_CacheLumpName(bg_lumpname, PU_CACHE); V_DrawPatch(0, 0, 1, bg); } |