Merge pull request #1196 from asarium/fix/sprintfAttribute

Add format string annotations to all printf style functions

Author: niffiwan

cmake/toolchain-clang.cmake

@@ -64,6 +64,8 @@ endif()
 
 set(COMPILER_FLAGS "${COMPILER_FLAGS} ${SANITIZE_FLAGS}")
 
+set(COMPILER_FLAGS "${COMPILER_FLAGS} -Wformat-security")
+
 set(COMPILER_FLAGS "${COMPILER_FLAGS} -Wno-unused-function")
 
 # Dear Clang, please tell us if a function does not return a value since that part of the standard is stupid!

cmake/toolchain-gcc.cmake

@@ -76,6 +76,8 @@ endif()
 
 set(COMPILER_FLAGS "${COMPILER_FLAGS} ${SANITIZE_FLAGS}")
 
+set(COMPILER_FLAGS "${COMPILER_FLAGS} -Wformat-security")
+
 set(COMPILER_FLAGS "${COMPILER_FLAGS} -Wno-unused-function")
 
 # Dear GCC, please tell us if a function does not return a value since that part of the standard is stupid!

code/bmpman/bmpman.cpp

@@ -418,7 +418,7 @@ DCF(bmpman, "Shows/changes bitmap caching parameters and usage") {
 	}
 
 	if (dc_optional_string_either("status", "--status") || dc_optional_string_either("?", "--?")) {
-		dc_printf("Total RAM usage: %d bytes\n", bm_texture_ram);
+		dc_printf("Total RAM usage: " SIZE_T_ARG " bytes\n", bm_texture_ram);
 
 		if (Bm_max_ram > 1024 * 1024) {
 			dc_printf("\tMax RAM allowed: %.1f MB\n", i2fl(Bm_max_ram) / (1024.0f*1024.0f));
@@ -434,14 +434,14 @@ DCF(bmpman, "Shows/changes bitmap caching parameters and usage") {
 
 
 	if (dc_optional_string("flush")) {
-		dc_printf("Total RAM usage before flush: %d bytes\n", bm_texture_ram);
+		dc_printf("Total RAM usage before flush: " SIZE_T_ARG " bytes\n", bm_texture_ram);
 		int i;
 		for (i = 0; i < MAX_BITMAPS; i++) {
 			if (bm_bitmaps[i].type != BM_TYPE_NONE) {
 				bm_free_data(i);
 			}
 		}
-		dc_printf("Total RAM after flush: %d bytes\n", bm_texture_ram);
+		dc_printf("Total RAM after flush: " SIZE_T_ARG " bytes\n", bm_texture_ram);
 	} else if (dc_optional_string("ram")) {
 		dc_stuff_int(&Bm_max_ram);
 

code/controlconfig/controlsconfig.cpp

@@ -1974,7 +1974,7 @@ void control_config_do_frame(float frametime)
 		if (t % 2) {
 			gr_set_color_fast(&Color_text_normal);
 			gr_get_string_size(&w, NULL, XSTR( "?", 208));
-			gr_printf_menu(x - w / 2, y - font_height / 2, XSTR( "?", 208));
+			gr_printf_menu(x - w / 2, y - font_height / 2, "%s", XSTR( "?", 208));
 		}
 
 	} else if (!(z & JOY_AXIS) && ((Conflicts[z].key >= 0) || (Conflicts[z].joy >= 0))) {
@@ -1986,7 +1986,7 @@ void control_config_do_frame(float frametime)
 		gr_set_color_fast(&Color_text_normal);
 		str = XSTR( "Control conflicts with:", 209);
 		gr_get_string_size(&w, NULL, str);
-		gr_printf_menu(x - w / 2, y - font_height, str);
+		gr_printf_menu(x - w / 2, y - font_height, "%s", str);
 
 		if (Control_config[i].hasXSTR) {
 			strcpy_s(buf, XSTR(Control_config[i].text, CONTROL_CONFIG_XSTR + i));
@@ -1996,20 +1996,20 @@ void control_config_do_frame(float frametime)
 
 		font::force_fit_string(buf, 255, Conflict_wnd_coords[gr_screen.res][CONTROL_W_COORD]);
 		gr_get_string_size(&w, NULL, buf);
-		gr_printf_menu(x - w / 2, y, buf);
+		gr_printf_menu(x - w / 2, y, "%s", buf);
 
 	} else if (*bound_string) {
 		gr_set_color_fast(&Color_text_normal);
 		gr_get_string_size(&w, NULL, bound_string);
-		gr_printf_menu(x - w / 2, y - font_height / 2, bound_string);
+		gr_printf_menu(x - w / 2, y - font_height / 2, "%s", bound_string);
 		if (timestamp_elapsed(bound_timestamp)) {
 			*bound_string = 0;
 		}
 	}
 
 	if (Cc_lines[Num_cc_lines - 1].y + font_height > Cc_lines[Scroll_offset].y + Control_list_coords[gr_screen.res][CONTROL_H_COORD]) {
 		gr_set_color_fast(&Color_white);
-		gr_printf_menu(Control_more_coords[gr_screen.res][CONTROL_X_COORD], Control_more_coords[gr_screen.res][CONTROL_Y_COORD], XSTR( "More...", 210));
+		gr_printf_menu(Control_more_coords[gr_screen.res][CONTROL_X_COORD], Control_more_coords[gr_screen.res][CONTROL_Y_COORD], "%s", XSTR( "More...", 210));
 	}
 
 	conflict = 0;
@@ -2035,7 +2035,7 @@ void control_config_do_frame(float frametime)
 		if (Cc_lines[line].label) {
 			strcpy_s(buf, Cc_lines[line].label);
 			font::force_fit_string(buf, 255, Control_list_ctrl_w[gr_screen.res]);
-			gr_printf_menu(Control_list_coords[gr_screen.res][CONTROL_X_COORD], y, buf);
+			gr_printf_menu(Control_list_coords[gr_screen.res][CONTROL_X_COORD], y, "%s", buf);
 		}
 
 		if (!(z & JOY_AXIS)) {
@@ -2046,7 +2046,7 @@ void control_config_do_frame(float frametime)
 
 			if ((k < 0) && (j < 0)) {
 				gr_set_color_fast(&Color_grey);
-				gr_printf_menu(x, y, XSTR( "None", 211));
+				gr_printf_menu(x, y, "%s", XSTR( "None", 211));
 
 			} else {
 				if (k >= 0) {
@@ -2066,7 +2066,7 @@ void control_config_do_frame(float frametime)
 						gr_set_color_fast(c);
 					}
 
-					gr_printf_menu(x, y, buf);
+					gr_printf_menu(x, y, "%s", buf);
 
 					Cc_lines[line].kx = x - Control_list_coords[gr_screen.res][CONTROL_X_COORD];
 					gr_get_string_size(&w, NULL, buf);
@@ -2075,7 +2075,7 @@ void control_config_do_frame(float frametime)
 
 					if (j >= 0) {
 						gr_set_color_fast(&Color_text_normal);
-						gr_printf_menu(x, y, XSTR( ", ", 212));
+						gr_printf_menu(x, y, "%s", XSTR( ", ", 212));
 						gr_get_string_size(&w, NULL, XSTR( ", ", 212));
 						x += w;
 					}
@@ -2099,7 +2099,7 @@ void control_config_do_frame(float frametime)
 					}
 
 					font::force_fit_string(buf, 255, Control_list_key_w[gr_screen.res] + Control_list_key_x[gr_screen.res] - x);
-					gr_printf_menu(x, y, buf);
+					gr_printf_menu(x, y, "%s", buf);
 
 					Cc_lines[line].jx = x - Control_list_coords[gr_screen.res][CONTROL_X_COORD];
 					gr_get_string_size(&Cc_lines[line].jw, NULL, buf);
@@ -2115,7 +2115,7 @@ void control_config_do_frame(float frametime)
 
 			if (j < 0) {
 				gr_set_color_fast(&Color_grey);
-				gr_printf_menu(x, y, XSTR( "None", 211));
+				gr_printf_menu(x, y, "%s", XSTR( "None", 211));
 
 			} else {
 				if (Conflicts_axes[z & ~JOY_AXIS] >= 0) {

code/cutscene/cutscenes.cpp

@@ -585,7 +585,7 @@ void cutscenes_screen_do_frame()
 		}
 
 		gr_printf_menu(Cutscene_list_coords[gr_screen.res][0], Cutscene_list_coords[gr_screen.res][1] + y,
-					   Cutscenes[Cutscene_list[z]].name);
+					   "%s", Cutscenes[Cutscene_list[z]].name);
 
 		y += font_height;
 		z++;

code/debugconsole/console.h

@@ -268,7 +268,7 @@ bool dc_pause_output(void);
  * @brief Prints the given char string to the debug console
  * @details See the doc for std::printf() for formating and more details
  */
-void dc_printf(const char *format, ...);
+void dc_printf(SCP_FORMAT_STRING const char *format, ...) SCP_FORMAT_STRING_ARGS(1, 2);
 
 /**
  * @brief Opens and processes the debug console. (Blocking call)

code/debugconsole/consoleparse.cpp

@@ -957,7 +957,7 @@ long dc_parse_long(const char *ch, dc_token type) {
 		dc_printf("Error: Could not convert all of the buffer '%s'.\n", buffer_str.c_str());
 		if (Dc_debug_on) {
 			dc_printf("<debug> Buffer value: %s\n", buffer_str.c_str());
-			dc_printf("<debug> Return value: %i", ret);
+			dc_printf("<debug> Return value: %ld", ret);
 		}
 		throw errParse(ch, type);
 	}
@@ -1046,7 +1046,7 @@ ulong dc_parse_ulong(const char *ch, dc_token type) {
 		dc_printf("Error: Could not convert all of the buffer '%s'.\n", buffer_str.c_str());
 		if (Dc_debug_on) {
 			dc_printf("<debug> Buffer value: %s\n", buffer_str.c_str());
-			dc_printf("<debug> Return value: %i", ret);
+			dc_printf("<debug> Return value: %ld", ret);
 		}
 		throw errParse(ch, type);
 	}

code/fs2netd/fs2netd_client.cpp

@@ -34,6 +34,7 @@
 #include "playerman/player.h"
 #include "popup/popup.h"
 #include "osapi/osapi.h"
+#include "hud/hudmessage.h"
 
 #ifndef WIN32
 #include <cstdio>
@@ -53,7 +54,6 @@
 
 
 extern int Multi_debrief_stats_accept_code;
-extern void HUD_printf(const char *format, ...);
 extern int game_hacked_data();
 
 
@@ -141,7 +141,7 @@ void fs2netd_options_config_init()
 		long port_tmp = strtol(Multi_options_g.tracker_port, (char**)NULL, 10);
 
 		if ( (port_tmp < 1024) || (port_tmp > USHRT_MAX) ) {
-			ml_printf("NOTICE: The port specified for game/user trackers, '%i', is outside of the required range, %i through %i!", port_tmp, 1024, USHRT_MAX);
+			ml_printf("NOTICE: The port specified for game/user trackers, '%ld', is outside of the required range, %i through %i!", port_tmp, 1024, USHRT_MAX);
 			ml_printf("NOTICE: Port for game/user trackers is invalid, using default instead (%s).", FS2NETD_DEFAULT_PORT);
 			strncpy( Multi_options_g.tracker_port, FS2NETD_DEFAULT_PORT, STD_NAME_LEN );
 		}
@@ -689,7 +689,7 @@ static void fs2netd_handle_messages()
 					case NETGAME_STATE_IN_MISSION: // gotta make it paused
 						//multi_pause_request(1); 
 						//send_game_chat_packet(Net_player, str, MULTI_MSG_ALL, NULL);
-						HUD_printf(tbuf);
+						HUD_printf("%s", tbuf);
 						break;
 
 					default:

code/fs2netd/tcp_client.cpp

@@ -768,7 +768,7 @@ int FS2NetD_ValidateTableList(bool do_send)
 		}
 
 		if ( num_tables > (int)Table_valid_status.size() ) {
-			ml_printf("FS2NetD WARNING: Table list contains %i tables, but we only requested %i!  Invalid data!", num_tables, Table_valid_status.size());
+			ml_printf("FS2NetD WARNING: Table list contains %i tables, but we only requested " SIZE_T_ARG "!  Invalid data!", num_tables, Table_valid_status.size());
 			return -1;
 		}
 

code/gamehelp/contexthelp.cpp

@@ -517,7 +517,8 @@ void help_overlay_blit(int overlay_id, int resolution_index)
 		gr_get_string_size(&width, &height, help_overlaylist[overlay_id].textlist.at(0).at(idx).string, (int)strlen(help_overlaylist[overlay_id].textlist.at(0).at(idx).string));
 		gr_rect(help_overlaylist[overlay_id].textlist.at(resolution_index).at(idx).x_coord-2*HELP_PADDING, help_overlaylist[overlay_id].textlist.at(resolution_index).at(idx).y_coord-3*HELP_PADDING, width+4*HELP_PADDING, height+4*HELP_PADDING, GR_RESIZE_MENU);
 		gr_set_color_fast(&Color_bright_white);
-		gr_printf_menu(help_overlaylist[overlay_id].textlist.at(resolution_index).at(idx).x_coord, help_overlaylist[overlay_id].textlist.at(resolution_index).at(idx).y_coord, help_overlaylist[overlay_id].textlist.at(0).at(idx).string);
+		gr_printf_menu(help_overlaylist[overlay_id].textlist.at(resolution_index).at(idx).x_coord, help_overlaylist[overlay_id].textlist.at(resolution_index).at(idx).y_coord,
+					   "%s", help_overlaylist[overlay_id].textlist.at(0).at(idx).string);
 	}
 	font::set_font(font::FONT1);
 
@@ -606,7 +607,7 @@ void showlbracketpos(int num)
 void showplinepos(int plinenum)
 {
 	int i;
-	dc_printf("pline %d on overlay %d vertices are now ", plinenum, current_helpid, help_overlaylist[current_helpid].textlist.at(current_resolution).at(plinenum).y_coord );
+	dc_printf("pline %d on overlay %d vertices are now ", plinenum, current_helpid );
 	for (i=0; i<help_overlaylist[current_helpid].plinelist.at(gr_screen.res).at(plinenum).vtxcount; i++)
 	{
 		dc_printf("(%3.0f %3.0f) ", help_overlaylist[current_helpid].plinelist.at(current_resolution).at(plinenum).vtx.at(i).xyz.x, help_overlaylist[current_helpid].plinelist.at(current_resolution).at(plinenum).vtx.at(i).xyz.y);