cpp/openttd-patchpack/source Changeset - r18296:89d34cbdf3a3

Changeset - r18296:89d34cbdf3a3

Parent rev.

Child rev.

[Not reviewed]

master

0 9 0

frosch - 13 years ago 2011-11-08 17:24:43
frosch@openttd.org

(svn r23142) -Change: [NewGRF v8] Unify the return values of callbacks returning D0xx texts.

9 files changed with 140 insertions and 59 deletions:

src/build_vehicle_gui.cpp

src/industry_gui.cpp

src/newgrf_airport.cpp

src/newgrf_commons.cpp

src/object_gui.cpp

src/town_cmd.cpp

src/train_cmd.cpp

src/vehicle_cmd.cpp

src/vehicle_gui.cpp

0 comments (0 inline, 0 general)

src/build_vehicle_gui.cpp

➞

Show inline comments

@@ @@ -753,7 +753,11 @@ static int DrawAircraftPurchaseInfo(int @@
 static uint ShowAdditionalText(int left, int right, int y, EngineID engine)
+{
 	uint16 callback = GetVehicleCallback(CBID_VEHICLE_ADDITIONAL_TEXT, 0, 0, engine, NULL);
 	if (callback == CALLBACK_FAILED) return y;
 	if (callback == CALLBACK_FAILED || callback == 0x400) return y;
 	if (callback > 0x400) {
 		ErrorUnknownCallbackResult(Engine::Get(engine)->GetGRFID(), CBID_VEHICLE_ADDITIONAL_TEXT, callback);
 		return y;
+	}
 	StartTextRefStackUsage(6);
 	uint result = DrawStringMultiLine(left, right, y, INT32_MAX, GetGRFStringID(Engine::Get(engine)->GetGRFID(), 0xD000 + callback), TC_BLACK);

src/industry_gui.cpp

➞

Show inline comments

@@ @@ -73,7 +73,10 @@ static void GetCargoSuffix(uint cargo, C @@
 	suffix[0] = '\0';
 	if (HasBit(indspec->callback_mask, CBM_IND_CARGO_SUFFIX)) {
 		uint16 callback = GetIndustryCallback(CBID_INDUSTRY_CARGO_SUFFIX, 0, (cst << 8) | cargo, const_cast<Industry *>(ind), ind_type, (cst != CST_FUND) ? ind->location.tile : INVALID_TILE);
 		if (GB(callback, 0, 8) != 0xFF) {
 		if (callback == CALLBACK_FAILED || callback == 0x400) return;
 		if (callback > 0x400) {
 			ErrorUnknownCallbackResult(indspec->grf_prop.grffile->grfid, CBID_INDUSTRY_CARGO_SUFFIX, callback);
 		} else if (indspec->grf_prop.grffile->grf_version >= 8 || GB(callback, 0, 8) != 0xFF) {
 			StartTextRefStackUsage(6);
 			GetString(suffix, GetGRFStringID(indspec->grf_prop.grffile->grfid, 0xD000 + callback), suffix_last);
 			StopTextRefStackUsage();
@@ @@ -455,12 +458,16 @@ public: @@
 				str = STR_NULL;
 				if (HasBit(indsp->callback_mask, CBM_IND_FUND_MORE_TEXT)) {
 					uint16 callback_res = GetIndustryCallback(CBID_INDUSTRY_FUND_MORE_TEXT, 0, 0, NULL, this->selected_type, INVALID_TILE);
 					if (callback_res != CALLBACK_FAILED) {  // Did it fail?
 						str = GetGRFStringID(indsp->grf_prop.grffile->grfid, 0xD000 + callback_res);  // No. here's the new string
 						if (str != STR_UNDEFINED) {
 							StartTextRefStackUsage(6);
 							DrawStringMultiLine(left, right, y, bottom, str, TC_YELLOW);
 							StopTextRefStackUsage();
 					if (callback_res != CALLBACK_FAILED && callback_res != 0x400) {
 						if (callback_res > 0x400) {
 							ErrorUnknownCallbackResult(indsp->grf_prop.grffile->grfid, CBID_INDUSTRY_FUND_MORE_TEXT, callback_res);
 						} else {
 							str = GetGRFStringID(indsp->grf_prop.grffile->grfid, 0xD000 + callback_res);  // No. here's the new string
 							if (str != STR_UNDEFINED) {
 								StartTextRefStackUsage(6);
 								DrawStringMultiLine(left, right, y, bottom, str, TC_YELLOW);
 								StopTextRefStackUsage();
+							}
+						}
+					}
+				}
@@ @@ -783,17 +790,21 @@ public: @@
 		/* Get the extra message for the GUI */
 		if (HasBit(ind->callback_mask, CBM_IND_WINDOW_MORE_TEXT)) {
 			uint16 callback_res = GetIndustryCallback(CBID_INDUSTRY_WINDOW_MORE_TEXT, 0, 0, i, i->type, i->location.tile);
 			if (callback_res != CALLBACK_FAILED) {
 				StringID message = GetGRFStringID(ind->grf_prop.grffile->grfid, 0xD000 + callback_res);
 				if (message != STR_NULL && message != STR_UNDEFINED) {
 					y += WD_PAR_VSEP_WIDE;
 			if (callback_res != CALLBACK_FAILED && callback_res != 0x400) {
 				if (callback_res > 0x400) {
 					ErrorUnknownCallbackResult(ind->grf_prop.grffile->grfid, CBID_INDUSTRY_WINDOW_MORE_TEXT, callback_res);
 				} else {
 					StringID message = GetGRFStringID(ind->grf_prop.grffile->grfid, 0xD000 + callback_res);
 					if (message != STR_NULL && message != STR_UNDEFINED) {
 						y += WD_PAR_VSEP_WIDE;
 					StartTextRefStackUsage(6);
 					/* Use all the available space left from where we stand up to the
 					 * end of the window. We ALSO enlarge the window if needed, so we
 					 * can 'go' wild with the bottom of the window. */
 					y = DrawStringMultiLine(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, y, UINT16_MAX, message, TC_BLACK);
 					StopTextRefStackUsage();
 						StartTextRefStackUsage(6);
 						/* Use all the available space left from where we stand up to the
 						 * end of the window. We ALSO enlarge the window if needed, so we
 						 * can 'go' wild with the bottom of the window. */
 						y = DrawStringMultiLine(left + WD_FRAMERECT_LEFT, right - WD_FRAMERECT_RIGHT, y, UINT16_MAX, message, TC_BLACK);
 						StopTextRefStackUsage();
+					}
+				}
+			}
+		}

src/newgrf_airport.cpp

➞

Show inline comments

@@ @@ -273,7 +273,12 @@ StringID GetAirportTextCallback(const Ai @@
 	object.callback = (CallbackID)callback;
 	group = SpriteGroup::Resolve(as->grf_prop.spritegroup[0], &object);
 	if (group == NULL) return STR_UNDEFINED;
 	uint16 cb_res = (group != NULL) ? group->GetCallbackResult() : CALLBACK_FAILED;
 	if (cb_res == CALLBACK_FAILED || cb_res == 0x400) return STR_UNDEFINED;
 	if (cb_res > 0x400) {
 		ErrorUnknownCallbackResult(as->grf_prop.grffile->grfid, callback, cb_res);
 		return STR_UNDEFINED;
+	}
-	return GetGRFStringID(as->grf_prop.grffile->grfid, 0xD000 + group->GetCallbackResult());
+	return GetGRFStringID(as->grf_prop.grffile->grfid, 0xD000 + cb_res);
+}

src/newgrf_commons.cpp

➞

Show inline comments

@@ @@ -480,17 +480,24 @@ uint32 GetCompanyInfo(CompanyID owner, c @@
 CommandCost GetErrorMessageFromLocationCallbackResult(uint16 cb_res, uint32 grfid, StringID default_error)
+{
 	CommandCost res;
 	switch (cb_res) {
 		case 0x400: return res; // No error.
 		case 0x401: res = CommandCost(default_error); break;
 		case 0x402: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_IN_RAINFOREST); break;
 		case 0x403: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_IN_DESERT); break;
 		case 0x404: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_ABOVE_SNOW_LINE); break;
 		case 0x405: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_BELOW_SNOW_LINE); break;
 		case 0x406: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_SEA); break;
 		case 0x407: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_CANAL); break;
 		case 0x408: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_RIVER); break;
 		default:    res = CommandCost(GetGRFStringID(grfid, 0xD000 + cb_res)); break;
 	if (cb_res < 0x400) {
 		res = CommandCost(GetGRFStringID(grfid, 0xD000 + cb_res));
 	} else {
 		switch (cb_res) {
 			case 0x400: return res; // No error.
 			default:    // unknown reason -> default error
 			case 0x401: res = CommandCost(default_error); break;
 			case 0x402: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_IN_RAINFOREST); break;
 			case 0x403: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_IN_DESERT); break;
 			case 0x404: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_ABOVE_SNOW_LINE); break;
 			case 0x405: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_BELOW_SNOW_LINE); break;
 			case 0x406: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_SEA); break;
 			case 0x407: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_CANAL); break;
 			case 0x408: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_RIVER); break;
+		}
+	}
 	/* Copy some parameters from the registers to the error message text ref. stack */

src/object_gui.cpp

➞

Show inline comments

@@ @@ -233,19 +233,23 @@ public: @@
 				/* Get the extra message for the GUI */
 				if (HasBit(spec->callback_mask, CBM_OBJ_FUND_MORE_TEXT)) {
 					uint16 callback_res = GetObjectCallback(CBID_OBJECT_FUND_MORE_TEXT, 0, 0, spec, NULL, INVALID_TILE, _selected_object_view);
 					if (callback_res != CALLBACK_FAILED) {
 						StringID message = GetGRFStringID(spec->grf_prop.grffile->grfid, 0xD000 + callback_res);
 						if (message != STR_NULL && message != STR_UNDEFINED) {
 							StartTextRefStackUsage(6);
 							/* Use all the available space left from where we stand up to the
 							 * end of the window. We ALSO enlarge the window if needed, so we
 							 * can 'go' wild with the bottom of the window. */
 							int y = DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, message, TC_ORANGE) - r.top;
 							StopTextRefStackUsage();
 							if (y > this->info_height) {
 								BuildObjectWindow *bow = const_cast<BuildObjectWindow *>(this);
 								bow->info_height = y + 2;
 								bow->ReInit();
 					if (callback_res != CALLBACK_FAILED && callback_res != 0x400) {
 						if (callback_res > 0x400) {
 							ErrorUnknownCallbackResult(spec->grf_prop.grffile->grfid, CBID_OBJECT_FUND_MORE_TEXT, callback_res);
 						} else {
 							StringID message = GetGRFStringID(spec->grf_prop.grffile->grfid, 0xD000 + callback_res);
 							if (message != STR_NULL && message != STR_UNDEFINED) {
 								StartTextRefStackUsage(6);
 								/* Use all the available space left from where we stand up to the
 								 * end of the window. We ALSO enlarge the window if needed, so we
 								 * can 'go' wild with the bottom of the window. */
 								int y = DrawStringMultiLine(r.left, r.right, r.top, UINT16_MAX, message, TC_ORANGE) - r.top;
 								StopTextRefStackUsage();
 								if (y > this->info_height) {
 									BuildObjectWindow *bow = const_cast<BuildObjectWindow *>(this);
 									bow->info_height = y + 2;
 									bow->ReInit();
+								}
+							}
+						}
+					}

src/town_cmd.cpp

➞

Show inline comments

@@ @@ -650,10 +650,14 @@ static void GetTileDesc_Town(TileIndex t @@
 	td->str = hs->building_name;
 	uint16 callback_res = GetHouseCallback(CBID_HOUSE_CUSTOM_NAME, house_completed ? 1 : 0, 0, house, Town::GetByTile(tile), tile);
 	if (callback_res != CALLBACK_FAILED) {
 		StringID new_name = GetGRFStringID(hs->grf_prop.grffile->grfid, 0xD000 + callback_res);
 		if (new_name != STR_NULL && new_name != STR_UNDEFINED) {
 			td->str = new_name;
 	if (callback_res != CALLBACK_FAILED && callback_res != 0x400) {
 		if (callback_res > 0x400) {
 			ErrorUnknownCallbackResult(hs->grf_prop.grffile->grfid, CBID_HOUSE_CUSTOM_NAME, callback_res);
 		} else {
 			StringID new_name = GetGRFStringID(hs->grf_prop.grffile->grfid, 0xD000 + callback_res);
 			if (new_name != STR_NULL && new_name != STR_UNDEFINED) {
 				td->str = new_name;
+			}
+		}
+	}

src/train_cmd.cpp

➞

Show inline comments

@@ @@ -976,8 +976,26 @@ static CommandCost CheckTrainAttachment( @@
 				/* A failing callback means everything is okay */
 				StringID error = STR_NULL;
 				if (callback == 0xFD) error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
 				if (callback  < 0xFD) error = GetGRFStringID(head->GetGRFID(), 0xD000 + callback);
 				if (t->GetGRF()->grf_version < 8) {
 					if (callback == 0xFD) error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
 					if (callback  < 0xFD) error = GetGRFStringID(head->GetGRFID(), 0xD000 + callback);
 					if (callback >= 0x100) ErrorUnknownCallbackResult(head->GetGRFID(), CBID_TRAIN_ALLOW_WAGON_ATTACH, callback);
 				} else {
 					if (callback < 0x400) {
 						error = GetGRFStringID(head->GetGRFID(), 0xD000 + callback);
 					} else {
 						switch (callback) {
 							case 0x400: // allow
 							case 0x401: // allow if railtypes match (always the case for OpenTTD)
 								break;
 							default:    // unknown reason -> disallow
 							case 0x402: // disallow attaching
 								error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
 								break;
+						}
+					}
+				}
 				if (error != STR_NULL) return_cmd_error(error);
+			}

src/vehicle_cmd.cpp

➞

Show inline comments

@@ @@ -491,12 +491,30 @@ CommandCost CmdStartStopVehicle(TileInde @@
 		default: return CMD_ERROR;
+	}
 	/* Check if this vehicle can be started/stopped. The callback will fail or
 	 * return 0xFF if it can. */
 	uint16 callback = GetVehicleCallback(CBID_VEHICLE_START_STOP_CHECK, 0, 0, v->engine_type, v);
 	if (callback != CALLBACK_FAILED && GB(callback, 0, 8) != 0xFF && HasBit(p2, 0)) {
 		StringID error = GetGRFStringID(v->GetGRFID(), 0xD000 + callback);
 		return_cmd_error(error);
 	if (HasBit(p2, 0)) {
 		/* Check if this vehicle can be started/stopped. Failure means 'allow'. */
 		uint16 callback = GetVehicleCallback(CBID_VEHICLE_START_STOP_CHECK, 0, 0, v->engine_type, v);
 		StringID error = STR_NULL;
 		if (callback != CALLBACK_FAILED) {
 			if (v->GetGRF()->grf_version < 8) {
 				/* 8 bit result 0xFF means 'allow' */
 				if (callback < 0x400 && GB(callback, 0, 8) != 0xFF) error = GetGRFStringID(v->GetGRFID(), 0xD000 + callback);
 			} else {
 				if (callback < 0x400) {
 					error = GetGRFStringID(v->GetGRFID(), 0xD000 + callback);
 				} else {
 					switch (callback) {
 						case 0x400: // allow
 							break;
 						default: // unknown reason -> disallow
 							error = STR_ERROR_INCOMPATIBLE_RAIL_TYPES;
 							break;
+					}
+				}
+			}
+		}
 		if (error != STR_NULL) return_cmd_error(error);
+	}
 	if (flags & DC_EXEC) {

src/vehicle_gui.cpp

➞

Show inline comments

@@ @@ -253,7 +253,10 @@ byte GetBestFittingSubType(Vehicle *v_fr @@
 		v_for->InvalidateNewGRFCache();
 		uint16 callback = GetVehicleCallback(CBID_VEHICLE_CARGO_SUFFIX, 0, 0, v_for->engine_type, v_for);
 		if (callback == 0xFF) callback = CALLBACK_FAILED;
 		if (callback != CALLBACK_FAILED) {
 			if (callback > 0x400) ErrorUnknownCallbackResult(v_for->GetGRFID(), CBID_VEHICLE_CARGO_SUFFIX, callback);
 			if (callback >= 0x400 || (v_for->GetGRF()->grf_version < 8 && callback == 0xFF)) callback = CALLBACK_FAILED;
+		}
 		if (callback == CALLBACK_FAILED) break;
 		if (GetCargoSubtypeText(v_for) != expected_string) continue;
@@ @@ -332,7 +335,7 @@ static void DrawVehicleRefitWindow(const @@
 			/* Get the cargo name. */
 			SetDParam(0, CargoSpec::Get(refit.cargo)->name);
 			/* If the callback succeeded, draw the cargo suffix. */
 			if (refit.value != CALLBACK_FAILED) {
+			if (refit.value != CALLBACK_FAILED && refit.value < 0x400) {
 				SetDParam(1, GetGRFStringID(refit.engine->GetGRFID(), 0xD000 + refit.value));
 				DrawString(r.left + WD_MATRIX_LEFT, r.right - WD_MATRIX_RIGHT, y, STR_JUST_STRING_SPACE_STRING, colour);
 			} else {
@@ @@ -427,7 +430,10 @@ struct RefitWindow : public Window { @@
 						v->InvalidateNewGRFCache();
 						uint16 callback = GetVehicleCallback(CBID_VEHICLE_CARGO_SUFFIX, 0, 0, v->engine_type, v);
 						if (callback == 0xFF) callback = CALLBACK_FAILED;
 						if (callback != CALLBACK_FAILED) {
 							if (callback > 0x400) ErrorUnknownCallbackResult(v->GetGRFID(), CBID_VEHICLE_CARGO_SUFFIX, callback);
 							if (callback >= 0x400 || (v->GetGRF()->grf_version < 8 && callback == 0xFF)) callback = CALLBACK_FAILED;
+						}
 						if (refit_cyc != 0 && callback == CALLBACK_FAILED) break;
 						RefitOption option;
@@ @@ -984,6 +990,10 @@ StringID GetCargoSubtypeText(const Vehic @@
 	if (HasBit(EngInfo(v->engine_type)->callback_mask, CBM_VEHICLE_CARGO_SUFFIX)) {
 		uint16 cb = GetVehicleCallback(CBID_VEHICLE_CARGO_SUFFIX, 0, 0, v->engine_type, v);
 		if (cb != CALLBACK_FAILED) {
 			if (cb > 0x400) ErrorUnknownCallbackResult(v->GetGRFID(), CBID_VEHICLE_CARGO_SUFFIX, cb);
 			if (cb >= 0x400 || (v->GetGRF()->grf_version < 8 && cb == 0xFF)) cb = CALLBACK_FAILED;
+		}
 		if (cb != CALLBACK_FAILED) {
 			return GetGRFStringID(v->GetGRFID(), 0xD000 + cb);
+		}
+	}

0 comments (0 inline, 0 general)