(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit:

- using one engine list instead of 3
- removed engine filters (loco, wagons, helicopters, etc.)
- EngineList code isolated from GUI (moved to helpers.cpp - reusing CBlobT code which does exactly what is needed for EngineList)
- removed unnecessary  "optimization" (rebuild and sort engine list on each WE_PAINT)

1 files changed, 82 insertions, 187 deletions

diff --git a/build_vehicle_gui.c b/build_vehicle_gui.c
index cd8817920..32a4949f6 100644
--- a/build_vehicle_gui.c
+++ b/build_vehicle_gui.c
@@ -32,9 +32,6 @@ typedef enum BuildVehicleWidgets {
 	BUILD_VEHICLE_WIDGET_LIST,
 	BUILD_VEHICLE_WIDGET_SCROLLBAR,
 	BUILD_VEHICLE_WIDGET_PANEL,
-	BUILD_VEHICLE_WIDGET_PLANES,
-	BUILD_VEHICLE_WIDGET_JETS,
-	BUILD_VEHICLE_WIDGET_HELICOPTERS,
 	BUILD_VEHICLE_WIDGET_BUILD,
 	BUILD_VEHICLE_WIDGET_RENAME,
 	BUILD_VEHICLE_WIDGET_RESIZE,
@@ -50,13 +47,9 @@ static const Widget _build_vehicle_widgets[] = {
 	{  WWT_SCROLLBAR, RESIZE_BOTTOM,    14,   228,   239,    26,   121, 0x0,                     STR_0190_SCROLL_BAR_SCROLLS_LIST },
 	{      WWT_PANEL,     RESIZE_TB,    14,     0,   239,   122,   213, 0x0,                     STR_NULL },
 
-	{ WWT_PUSHTXTBTN,     RESIZE_TB,    14,     0,    79,   214,   225, STR_BLACK_PLANES,        STR_BUILD_PLANES_TIP },
-	{ WWT_PUSHTXTBTN,     RESIZE_TB,    14,    80,   159,   214,   225, STR_BLACK_JETS,          STR_BUILD_JETS_TIP },
-	{ WWT_PUSHTXTBTN,     RESIZE_TB,    14,   160,   239,   214,   225, STR_BLACK_HELICOPTERS,   STR_BUILD_HELICOPTERS_TIP },
-
-	{ WWT_PUSHTXTBTN,     RESIZE_TB,    14,     0,   114,   226,   237, STR_A006_BUILD_AIRCRAFT, STR_A026_BUILD_THE_HIGHLIGHTED_AIRCRAFT },
-	{ WWT_PUSHTXTBTN,     RESIZE_TB,    14,   115,   227,   226,   237, STR_A037_RENAME,         STR_A038_RENAME_AIRCRAFT_TYPE },
-	{  WWT_RESIZEBOX,     RESIZE_TB,    14,   228,   239,   226,   237, 0x0,                     STR_RESIZE_BUTTON },
+	{ WWT_PUSHTXTBTN,     RESIZE_TB,    14,     0,   114,   214,   225, STR_A006_BUILD_AIRCRAFT, STR_A026_BUILD_THE_HIGHLIGHTED_AIRCRAFT },
+	{ WWT_PUSHTXTBTN,     RESIZE_TB,    14,   115,   227,   214,   225, STR_A037_RENAME,         STR_A038_RENAME_AIRCRAFT_TYPE },
+	{  WWT_RESIZEBOX,     RESIZE_TB,    14,   228,   239,   214,   225, 0x0,                     STR_RESIZE_BUTTON },
 	{   WIDGETS_END},
 };
 
@@ -64,8 +57,6 @@ static bool _internal_sort_order; // descending/ascending
 static byte _last_sort_criteria = 0;
 static bool _last_sort_order = false;
 
-typedef int CDECL VehicleSortListingTypeFunction(const void*, const void*);
-
 static int CDECL EngineNumberSorter(const void *a, const void *b)
 {
 	const EngineID va = *(const EngineID*)a;
@@ -179,7 +170,7 @@ static int CDECL AircraftEngineCargoSorter(const void *a, const void *b)
 	return _internal_sort_order ? -r : r;
 }
 
-static VehicleSortListingTypeFunction* const _aircraft_sorter[] = {
+static EngList_SortTypeFunction * const _aircraft_sorter[] = {
 	&EngineNumberSorter,
 	&AircraftEngineCostSorter,
 	&AircraftEngineSpeedSorter,
@@ -286,135 +277,87 @@ void CcBuildAircraft(bool success, TileIndex tile, uint32 p1, uint32 p2)
 	}
 }
 
-static inline void ExtendEngineListSize(EngineID **engine_list, uint16 *engine_list_length, uint16 step_size, uint16 max)
-{
-	*engine_list_length = min(*engine_list_length + step_size, max);
-	*engine_list = realloc((void*)*engine_list, (*engine_list_length) * sizeof((*engine_list)[0]));
-}
-
-static void GenerateBuildAircraftList(EngineID **planes, uint16 *num_planes, EngineID **jets, uint16 *num_jets, EngineID **helicopters, uint16 *num_helicopters)
+static void GenerateBuildAircraftList(Window *w)
 {
-	uint16 plane_length      = *num_planes;
-	uint16 jet_length        = *num_jets;
-	uint16 helicopter_length = *num_helicopters;
 	EngineID eid;
+	buildvehicle_d *bv = &WP(w, buildvehicle_d);
 
-	(*num_planes)      = 0;
-	(*num_jets)        = 0;
-	(*num_helicopters) = 0;
+	EngList_RemoveAll(&bv->eng_list);
 
 	for (eid = AIRCRAFT_ENGINES_INDEX; eid < AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES; eid++) {
-
 		if (IsEngineBuildable(eid, VEH_Aircraft)) {
 			const AircraftVehicleInfo *avi = AircraftVehInfo(eid);
-
-			switch (avi->subtype) {
-				case AIR_CTOL: // Propeller planes
-					if (*num_planes == plane_length) ExtendEngineListSize(planes, &plane_length, 5, NUM_AIRCRAFT_ENGINES);
-					(*planes)[(*num_planes)++] = eid;
+			switch (bv->filter.acc_planes) {
+				case HELICOPTERS_ONLY:
+					if (avi->subtype != 0) continue; // if not helicopter
 					break;
 
-				case (AIR_CTOL | AIR_FAST): // Jet planes
-					if (*num_jets == jet_length) ExtendEngineListSize(jets, &jet_length, 5, NUM_AIRCRAFT_ENGINES);
-					(*jets)[(*num_jets)++] = eid;
+				case AIRCRAFT_ONLY:
+					if (avi->subtype == 0) continue; // if helicopter
 					break;
 
-				case 0: // Helicopters
-					if (*num_helicopters == helicopter_length) ExtendEngineListSize(helicopters, &helicopter_length, 5, NUM_AIRCRAFT_ENGINES);
-					(*helicopters)[(*num_helicopters)++] = eid;
+				case ALL:
 					break;
 			}
+			EngList_Add(&bv->eng_list, eid);
 		}
 	}
 }
 
 static void GenerateBuildList(Window *w)
 {
-	switch (WP(w, buildvehicle_d).vehicle_type) {
+	buildvehicle_d *bv = &WP(w, buildvehicle_d);
+
+	switch (bv->vehicle_type) {
 		case VEH_Aircraft:
-			GenerateBuildAircraftList(&WP(w, buildvehicle_d).list_a, &WP(w, buildvehicle_d).list_a_length,
-									  &WP(w, buildvehicle_d).list_b, &WP(w, buildvehicle_d).list_b_length,
-									  &WP(w, buildvehicle_d).list_c, &WP(w, buildvehicle_d).list_c_length);
+			GenerateBuildAircraftList(w);
+			_internal_sort_order = WP(w,buildvehicle_d).descending_sort_order;
+			EngList_Sort(&WP(w, buildvehicle_d).eng_list, _aircraft_sorter[WP(w,buildvehicle_d).sort_criteria]);
 			break;
 
 		default: NOT_REACHED();
 	}
-
-	/* Ensure that we do not have trailing unused blocks in the arrays. We will never be able to access them anyway since we are unaware that they are there */
-	WP(w, buildvehicle_d).list_a = realloc((void*)WP(w, buildvehicle_d).list_a, WP(w, buildvehicle_d).list_a_length * sizeof(WP(w, buildvehicle_d).list_a[0]));
-	WP(w, buildvehicle_d).list_b = realloc((void*)WP(w, buildvehicle_d).list_b, WP(w, buildvehicle_d).list_b_length * sizeof(WP(w, buildvehicle_d).list_b[0]));
-	WP(w, buildvehicle_d).list_c = realloc((void*)WP(w, buildvehicle_d).list_c, WP(w, buildvehicle_d).list_c_length * sizeof(WP(w, buildvehicle_d).list_c[0]));
-
-	WP(w, buildvehicle_d).data_invalidated = false; // No need to regenerate the list anymore. We just did it
 }
 
-static inline EngineID *GetEngineArray(Window *w)
+static inline const EngineID *GetEngineArray(Window *w)
 {
-	switch (WP(w,buildvehicle_d).show_engine_button) {
-		case 1: return WP(w, buildvehicle_d).list_a;
-		case 2: return WP(w, buildvehicle_d).list_b;
-		case 3: return WP(w, buildvehicle_d).list_c;
-		default: NOT_REACHED();
-	}
-	return NULL;
+	return WP(w, buildvehicle_d).eng_list;
 }
 
 static inline uint16 GetEngineArrayLength(Window *w)
 {
-	switch (WP(w,buildvehicle_d).show_engine_button) {
-		case 1: return WP(w, buildvehicle_d).list_a_length;
-		case 2: return WP(w, buildvehicle_d).list_b_length;
-		case 3: return WP(w, buildvehicle_d).list_c_length;
-		default: NOT_REACHED();
-	}
-	return 0;
-}
-
-static void SortAircraftBuildList(Window *w)
-{
-	_internal_sort_order = WP(w,buildvehicle_d).decenting_sort_order;
-	qsort((void*)GetEngineArray(w), GetEngineArrayLength(w), sizeof(GetEngineArray(w)[0]),
-		  _aircraft_sorter[WP(w,buildvehicle_d).sort_criteria]);
+	return EngList_Count(&WP(w, buildvehicle_d).eng_list);
 }
 
 static void DrawBuildAircraftWindow(Window *w)
 {
-	SetWindowWidgetLoweredState(w, BUILD_VEHICLE_WIDGET_PLANES,      WP(w,buildvehicle_d).show_engine_button == 1);
-	SetWindowWidgetLoweredState(w, BUILD_VEHICLE_WIDGET_JETS,        WP(w,buildvehicle_d).show_engine_button == 2);
-	SetWindowWidgetLoweredState(w, BUILD_VEHICLE_WIDGET_HELICOPTERS, WP(w,buildvehicle_d).show_engine_button == 3);
+	buildvehicle_d *bv = &WP(w, buildvehicle_d);
 
 	SetWindowWidgetDisabledState(w, BUILD_VEHICLE_WIDGET_BUILD, w->window_number == 0);
 
-	if (WP(w, buildvehicle_d).data_invalidated) {
-		GenerateBuildList(w);
+	GenerateBuildList(w);
 
-		if (WP(w,buildvehicle_d).sel_engine != INVALID_ENGINE) {
-			int i;
-			bool found = false;
-			if (HASBIT(WP(w,buildvehicle_d).show_engine_button, 0)) {
-				for (i = 0; i < GetEngineArrayLength(w); i++) {
-					if (WP(w,buildvehicle_d).sel_engine != GetEngineArray(w)[i]) continue;
-					found = true;
-					break;
-				}
-			}
-			if (!found) WP(w,buildvehicle_d).sel_engine = INVALID_ENGINE;
+	if (bv->sel_engine != INVALID_ENGINE) {
+		int i;
+		bool found = false;
+		int num_planes = GetEngineArrayLength(w);
+		for (i = 0; i < num_planes; i++) {
+			if (bv->sel_engine != GetEngineArray(w)[i]) continue;
+			found = true;
+			break;
 		}
+		if (!found) bv->sel_engine = INVALID_ENGINE;
 	}
 
 	SetVScrollCount(w, GetEngineArrayLength(w));
 	DrawWindowWidgets(w);
 
-	if (WP(w,buildvehicle_d).sel_engine == INVALID_ENGINE && GetEngineArrayLength(w) != 0) {
-		WP(w,buildvehicle_d).sel_engine = GetEngineArray(w)[0];
-	}
-
 	{
 		int x = 2;
 		int y = 27;
-		EngineID selected_id = WP(w,buildvehicle_d).sel_engine;
+		EngineID selected_id = bv->sel_engine;
 		EngineID eid = w->vscroll.pos;
-		EngineID *list = GetEngineArray(w);
+		const EngineID *list = GetEngineArray(w);
 		uint16 list_length = GetEngineArrayLength(w);
 		uint16 max = min(w->vscroll.pos + w->vscroll.cap, list_length);
 
@@ -431,19 +374,19 @@ static void DrawBuildAircraftWindow(Window *w)
 			DrawAircraftPurchaseInfo(x, wi->top + 1, wi->right - wi->left - 2, selected_id);
 		}
 	}
-	DrawString(85, 15, _aircraft_sort_listing[WP(w,buildvehicle_d).sort_criteria], 0x10);
-	DoDrawString(WP(w,buildvehicle_d).decenting_sort_order ? DOWNARROW : UPARROW, 69, 15, 0x10);
+	DrawString(85, 15, _aircraft_sort_listing[bv->sort_criteria], 0x10);
+	DoDrawString(bv->descending_sort_order ? DOWNARROW : UPARROW, 69, 15, 0x10);
 }
 
 static void BuildAircraftClickEvent(Window *w, WindowEvent *e)
 {
-	byte click_state = 0;
+	buildvehicle_d *bv = &WP(w, buildvehicle_d);
 
 	switch (e->we.click.widget) {
 		case BUILD_VEHICLE_WIDGET_SORT_ASSENDING_DESCENDING:
-			WP(w,buildvehicle_d).decenting_sort_order = !WP(w,buildvehicle_d).decenting_sort_order;
-			_last_sort_order = WP(w,buildvehicle_d).decenting_sort_order;
-			SortAircraftBuildList(w);
+			bv->descending_sort_order = !bv->descending_sort_order;
+			_last_sort_order = bv->descending_sort_order;
+			GenerateBuildList(w);
 			SetWindowDirty(w);
 			break;
 
@@ -451,60 +394,46 @@ static void BuildAircraftClickEvent(Window *w, WindowEvent *e)
 			uint i = (e->we.click.pt.y - 26) / 24;
 			if (i < w->vscroll.cap) {
 				i += w->vscroll.pos;
-
-				if (i < GetEngineArrayLength(w)) {
-					WP(w,buildvehicle_d).sel_engine = GetEngineArray(w)[i];
-					SetWindowDirty(w);
-				}
+				bv->sel_engine = (i < GetEngineArrayLength(w)) ? GetEngineArray(w)[i] : INVALID_ENGINE;
+				SetWindowDirty(w);
 			}
-		} break;
+			break;
+		}
 
 		case BUILD_VEHICLE_WIDGET_SORT_TEXT: case BUILD_VEHICLE_WIDGET_SORT_DROPDOWN:/* Select sorting criteria dropdown menu */
-			ShowDropDownMenu(w, _aircraft_sort_listing, WP(w,buildvehicle_d).sort_criteria, BUILD_VEHICLE_WIDGET_SORT_DROPDOWN, 0, 0);
+			ShowDropDownMenu(w, _aircraft_sort_listing, bv->sort_criteria, BUILD_VEHICLE_WIDGET_SORT_DROPDOWN, 0, 0);
 			return;
 
-		case BUILD_VEHICLE_WIDGET_HELICOPTERS: click_state++;
-		case BUILD_VEHICLE_WIDGET_JETS:        click_state++;
-		case BUILD_VEHICLE_WIDGET_PLANES:      click_state++;
-
-			if (WP(w,buildvehicle_d).show_engine_button == click_state) break; // We clicked the pressed button
-
-				WP(w,buildvehicle_d).sel_engine = INVALID_ENGINE;
-			WP(w,buildvehicle_d).show_engine_button = click_state;
-			w->vscroll.pos = 0;
-			SortAircraftBuildList(w);
-			SetWindowDirty(w);
-			break;
-
 		case BUILD_VEHICLE_WIDGET_BUILD: {
-			EngineID sel_eng = WP(w,buildvehicle_d).sel_engine;
+			EngineID sel_eng = bv->sel_engine;
 			if (sel_eng != INVALID_ENGINE)
 				DoCommandP(w->window_number, sel_eng, 0, CcBuildAircraft, CMD_BUILD_AIRCRAFT | CMD_MSG(STR_A008_CAN_T_BUILD_AIRCRAFT));
-		} break;
+			break;
+		}
 
 		case BUILD_VEHICLE_WIDGET_RENAME: {
-			EngineID sel_eng = WP(w,buildvehicle_d).sel_engine;
+			EngineID sel_eng = bv->sel_engine;
 			if (sel_eng != INVALID_ENGINE) {
-				WP(w,buildvehicle_d).rename_engine = sel_eng;
+				bv->rename_engine = sel_eng;
 				ShowQueryString(GetCustomEngineName(sel_eng),
 								STR_A039_RENAME_AIRCRAFT_TYPE, 31, 160, w->window_class, w->window_number, CS_ALPHANUMERAL);
 			}
-		} break;
+			break;
+		}
 	}
 }
 
 static void NewAircraftWndProc(Window *w, WindowEvent *e)
 {
+	buildvehicle_d *bv = &WP(w, buildvehicle_d);
+
 	switch (e->event) {
 		case WE_INVALIDATE_DATA:
-			WP(w,buildvehicle_d).data_invalidated = true;
 			SetWindowDirty(w);
 			break;
 
 		case WE_DESTROY:
-			free((void*)WP(w, buildvehicle_d).list_a);
-			free((void*)WP(w, buildvehicle_d).list_b);
-			free((void*)WP(w, buildvehicle_d).list_c);
+			EngList_Destroy(&bv->eng_list);
 			break;
 
 		case WE_PAINT:
@@ -518,16 +447,17 @@ static void NewAircraftWndProc(Window *w, WindowEvent *e)
 		case WE_ON_EDIT_TEXT: {
 			if (e->we.edittext.str[0] != '\0') {
 				_cmd_text = e->we.edittext.str;
-				DoCommandP(0, WP(w, buildvehicle_d).rename_engine, 0, NULL,
+				DoCommandP(0, bv->rename_engine, 0, NULL,
 						   CMD_RENAME_ENGINE | CMD_MSG(STR_A03A_CAN_T_RENAME_AIRCRAFT_TYPE));
 			}
-		} break;
+			break;
+		}
 
 		case WE_DROPDOWN_SELECT: /* we have selected a dropdown item in the list */
-			if (WP(w,buildvehicle_d).sort_criteria != e->we.dropdown.index) {
-				WP(w,buildvehicle_d).sort_criteria = e->we.dropdown.index;
+			if (bv->sort_criteria != e->we.dropdown.index) {
+				bv->sort_criteria = e->we.dropdown.index;
 				_last_sort_criteria = e->we.dropdown.index;
-				SortAircraftBuildList(w);
+				GenerateBuildList(w);
 			}
 			SetWindowDirty(w);
 				break;
@@ -540,83 +470,48 @@ static void NewAircraftWndProc(Window *w, WindowEvent *e)
 }
 
 static const WindowDesc _build_vehicle_desc = {
-	WDP_AUTO, WDP_AUTO, 240, 238,
+	WDP_AUTO, WDP_AUTO, 240, 226,
 	WC_BUILD_VEHICLE,0,
 	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,
 	_build_vehicle_widgets,
 	NewAircraftWndProc
 };
 
-/* Disable the aircraft subtype buttons for the types, that can't be build at the current airport */
-static void CreateAircraftWindow(Window *w)
-{
-	TileIndex tile = w->window_number;
-
-	if (tile == 0) {
-		WP(w, buildvehicle_d).show_engine_button = 1;
-	} else {
-		byte acc_planes = GetAirport(GetStationByTile(tile)->airport_type)->acc_planes;
-
-		WP(w, buildvehicle_d).show_engine_button = 0;
-		if (acc_planes == HELICOPTERS_ONLY || acc_planes == ALL) {
-			WP(w, buildvehicle_d).show_engine_button = 3;
-		} else {
-			DisableWindowWidget(w, BUILD_VEHICLE_WIDGET_HELICOPTERS);
-		}
-
-		if (acc_planes == AIRCRAFT_ONLY || acc_planes == ALL) {
-			/* Set the start clicked button to jets if the list isn't empty. If not, then show propeller planes */
-			WP(w, buildvehicle_d).show_engine_button = WP(w, buildvehicle_d).list_b_length == 0 ? 1 : 2;
-		} else {
-			DisableWindowWidget(w, BUILD_VEHICLE_WIDGET_JETS);
-			DisableWindowWidget(w, BUILD_VEHICLE_WIDGET_PLANES);
-		}
-
-		if (WP(w, buildvehicle_d).show_engine_button == 0) {
-			/* No plane type are buildable here */
-			NOT_REACHED();
-			WP(w, buildvehicle_d).show_engine_button = 1;
-		}
-	}
-}
-
 void ShowBuildVehicleWindow(TileIndex tile, byte type)
 {
+	buildvehicle_d *bv;
 	Window *w;
 
 	DeleteWindowById(WC_BUILD_VEHICLE, tile);
-
 	w = AllocateWindowDescFront(&_build_vehicle_desc, tile);
-
 	if (w == NULL) return;
 
-	WP(w, buildvehicle_d).vehicle_type = type;
-
-	w->resize.step_height = GetVehicleListHeight(type);
-	w->vscroll.cap = 4;
-	w->widget[BUILD_VEHICLE_WIDGET_LIST].data = (w->vscroll.cap << 8) + 1;
-
 	if (tile != 0) {
 		w->caption_color = GetTileOwner(tile);
 	} else {
 		w->caption_color = _local_player;
 	}
 
-	WP(w, buildvehicle_d).list_a_length = 0;
-	WP(w, buildvehicle_d).list_b_length = 0;
-	WP(w, buildvehicle_d).list_c_length = 0;
-	WP(w, buildvehicle_d).list_a        = NULL;
-	WP(w, buildvehicle_d).list_b        = NULL;
-	WP(w, buildvehicle_d).list_c        = NULL;
-	WP(w, buildvehicle_d).sel_engine           = INVALID_ENGINE;
-	WP(w, buildvehicle_d).sort_criteria        = _last_sort_criteria;
-	WP(w, buildvehicle_d).decenting_sort_order = _last_sort_order;
+	w->resize.step_height = GetVehicleListHeight(type);
+	w->vscroll.cap = 4;
+	w->widget[BUILD_VEHICLE_WIDGET_LIST].data = (w->vscroll.cap << 8) + 1;
+
+	bv = &WP(w, buildvehicle_d);
+	EngList_Create(&bv->eng_list);
+	bv->sel_engine           = INVALID_ENGINE;
+	bv->sort_criteria        = _last_sort_criteria;
+	bv->descending_sort_order = _last_sort_order;
+
+	bv->vehicle_type = type;
 
-	GenerateBuildList(w);
 	switch (type) {
-		case VEH_Aircraft: CreateAircraftWindow(w); break;
+		case VEH_Aircraft: {
+			byte acc_planes = GetAirport(GetStationByTile(tile)->airport_type)->acc_planes;
+			bv->filter.acc_planes = acc_planes;
+			break;
+		}
 		default: NOT_REACHED();
 	}
 
-	SortAircraftBuildList(w);
+	GenerateBuildList(w);
 }