GUIs for debugging NewGRFs. More...

#include "stdafx.h"
#include "core/backup_type.hpp"
#include "core/geometry_func.hpp"
#include "window_gui.h"
#include "window_func.h"
#include "random_access_file_type.h"
#include "spritecache.h"
#include "string_func.h"
#include "strings_func.h"
#include "textbuf_gui.h"
#include "vehicle_gui.h"
#include "zoom_func.h"
#include "engine_base.h"
#include "industry.h"
#include "object_base.h"
#include "station_base.h"
#include "town.h"
#include "vehicle_base.h"
#include "train.h"
#include "roadveh.h"
#include "newgrf_act5.h"
#include "newgrf_airport.h"
#include "newgrf_airporttiles.h"
#include "newgrf_debug.h"
#include "newgrf_object.h"
#include "newgrf_spritegroup.h"
#include "newgrf_station.h"
#include "newgrf_town.h"
#include "newgrf_railtype.h"
#include "newgrf_industries.h"
#include "newgrf_industrytiles.h"
#include "widgets/newgrf_debug_widget.h"
#include "table/strings.h"
#include "safeguards.h"
#include "table/newgrf_debug_data.h"

Data Structures
struct	NIProperty
	Representation of the data from a NewGRF property. More...

struct	NICallback
	Representation of the available callbacks with information on when they actually apply. More...

struct	NIVariable
	Representation on the NewGRF variables. More...

class	NIHelper
	Helper class to wrap some functionality/queries in. More...

struct	NIFeature
	Container for all information for a given feature. More...

struct	NewGRFInspectWindow
	Window used for inspecting NewGRFs. More...

struct	SpriteAlignerWindow
	Window used for aligning sprites. More...

Typedefs
typedef const void *	NIOffsetProc(const void *b)

Enumerations
enum	NIType { NIT_INT , NIT_CARGO }
	The type of a property to show. More...

Functions
static uint	GetFeatureIndex (uint window_number)
	Get the feature index related to the window number.

static uint	GetInspectWindowNumber (GrfSpecFeature feature, uint index)
	Get the window number for the inspect window given a feature and index.

static GrfSpecFeature	GetFeatureNum (uint window_number)
	Get the feature number related to the window number.

static const NIFeature *	GetFeature (uint window_number)
	Get the NIFeature related to the window number.

static const NIHelper *	GetFeatureHelper (uint window_number)
	Get the NIHelper related to the window number.

void	ShowNewGRFInspectWindow (GrfSpecFeature feature, uint index, const uint32_t grfid)
	Show the inspect window for a given feature and index.

void	InvalidateNewGRFInspectWindow (GrfSpecFeature feature, uint index)
	Invalidate the inspect window for a given feature and index.

void	DeleteNewGRFInspectWindow (GrfSpecFeature feature, uint index)
	Delete inspect window for a given feature and index.

bool	IsNewGRFInspectable (GrfSpecFeature feature, uint index)
	Can we inspect the data given a certain feature and index.

GrfSpecFeature	GetGrfSpecFeature (TileIndex tile)
	Get the GrfSpecFeature associated with the tile.

GrfSpecFeature	GetGrfSpecFeature (VehicleType type)
	Get the GrfSpecFeature associated with the vehicle.

void	ShowSpriteAlignerWindow ()
	Show the window for aligning sprites.

Variables
NewGrfDebugSpritePicker	_newgrf_debug_sprite_picker = { SPM_NONE, nullptr, std::vector<SpriteID>() }
	The sprite picker.

static const int	CBM_NO_BIT = UINT8_MAX
	Mask to show no bit needs to be enabled for the callback.

static constexpr NWidgetPart	_nested_newgrf_inspect_chain_widgets []

static constexpr NWidgetPart	_nested_newgrf_inspect_widgets []

static WindowDesc	_newgrf_inspect_chain_desc (WDP_AUTO, "newgrf_inspect_chain", 400, 300, WC_NEWGRF_INSPECT, WC_NONE, 0, _nested_newgrf_inspect_chain_widgets)

static WindowDesc	_newgrf_inspect_desc (WDP_AUTO, "newgrf_inspect", 400, 300, WC_NEWGRF_INSPECT, WC_NONE, 0, _nested_newgrf_inspect_widgets)

static constexpr NWidgetPart	_nested_sprite_aligner_widgets []

static WindowDesc	_sprite_aligner_desc (WDP_AUTO, "sprite_aligner", 400, 300, WC_SPRITE_ALIGNER, WC_NONE, 0, _nested_sprite_aligner_widgets)

Detailed Description

GUIs for debugging NewGRFs.

Definition in file newgrf_debug_gui.cpp.

Typedef Documentation

◆ NIOffsetProc

typedef const void * NIOffsetProc(const void *b)

Definition at line 85 of file newgrf_debug_gui.cpp.

Enumeration Type Documentation

◆ NIType

enum NIType

The type of a property to show.

This is used to provide an appropriate representation in the GUI.

Enumerator
NIT_INT	The property is a simple integer.
NIT_CARGO	The property is a cargo.

Definition at line 80 of file newgrf_debug_gui.cpp.

Function Documentation

◆ DeleteNewGRFInspectWindow()

void DeleteNewGRFInspectWindow	(	GrfSpecFeature	feature,
		uint	index
	)

Delete inspect window for a given feature and index.

The index is normally an in-game location/identifier, such as a TileIndex or an IndustryID depending on the feature we want to inspect.

Parameters

feature	The feature we want to delete the window for.
index	The index/identifier of the feature to delete.

Definition at line 729 of file newgrf_debug_gui.cpp.

References CloseWindowById(), GetInspectWindowNumber(), GSF_INVALID, InvalidateWindowData(), WC_LAND_INFO, and WC_NEWGRF_INSPECT.

Referenced by CmdMoveRailVehicle(), CmdRemoveSingleRail(), DoClearTownHouseHelper(), ReallyClearObjectTile(), RemoveAirport(), RemoveFromRailBaseStation(), RemoveRoadStop(), RemoveRoadWaypointStop(), Town::~Town(), and Vehicle::~Vehicle().

◆ GetFeature()

static const NIFeature * GetFeature ( uint window_number )

inlinestatic

Get the NIFeature related to the window number.

Parameters

window_number The window to get the NIFeature for.

Returns: the NIFeature, or nullptr is there isn't one.

Definition at line 249 of file newgrf_debug_gui.cpp.

References _nifeatures, GetFeatureNum(), and GSF_FAKE_END.

Referenced by NewGRFInspectWindow::DrawMainPanelWidget(), GetFeatureHelper(), IsNewGRFInspectable(), and NewGRFInspectWindow::OnClick().

◆ GetFeatureHelper()

static const NIHelper * GetFeatureHelper ( uint window_number )

inlinestatic

Get the NIHelper related to the window number.

Parameters

window_number The window to get the NIHelper for.

Precondition: GetFeature(window_number) != nullptr

Returns: the NIHelper

Definition at line 261 of file newgrf_debug_gui.cpp.

References GetFeature(), and NIFeature::helper.

Referenced by NewGRFInspectWindow::OnClick(), and NewGRFInspectWindow::SetStringParameters().

◆ GetFeatureIndex()

static uint GetFeatureIndex ( uint window_number )

inlinestatic

Get the feature index related to the window number.

Parameters

window_number The window to get the feature index from.

Returns: the feature index

Definition at line 58 of file newgrf_debug_gui.cpp.

References GB().

◆ GetFeatureNum()

static GrfSpecFeature GetFeatureNum ( uint window_number )

inlinestatic

Get the feature number related to the window number.

Parameters

window_number The window to get the feature number for.

Returns: The feature number.

Definition at line 239 of file newgrf_debug_gui.cpp.

References GB().

Referenced by NewGRFInspectWindow::DrawMainPanelWidget(), NewGRFInspectWindow::DrawVehicleChainWidget(), GetFeature(), NewGRFInspectWindow::HasChainIndex(), NewGRFInspectWindow::OnClick(), NewGRFInspectWindow::OnQueryTextFinished(), and NewGRFInspectWindow::UpdateWidgetSize().

◆ GetGrfSpecFeature() [1/2]

GrfSpecFeature GetGrfSpecFeature ( TileIndex tile )

Get the GrfSpecFeature associated with the tile.

Parameters

tile	The tile to get the feature from.

Returns: the GrfSpecFeature.

Definition at line 763 of file newgrf_debug_gui.cpp.

References GetStationType(), GetTileType(), GSF_INVALID, IsLevelCrossing(), MP_HOUSE, MP_INDUSTRY, MP_OBJECT, MP_RAILWAY, MP_ROAD, and MP_STATION.

Referenced by NIHVehicle::GetParent(), LandInfoWindow::IsNewGRFInspectable(), VehicleViewWindow::IsNewGRFInspectable(), LandInfoWindow::ShowNewGRFInspectWindow(), VehicleViewWindow::ShowNewGRFInspectWindow(), and Vehicle::~Vehicle().

◆ GetGrfSpecFeature() [2/2]

GrfSpecFeature GetGrfSpecFeature ( VehicleType type )

Get the GrfSpecFeature associated with the vehicle.

Parameters

type	The vehicle type to get the feature from.

Returns: the GrfSpecFeature.

Definition at line 789 of file newgrf_debug_gui.cpp.

References GSF_INVALID, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.

◆ GetInspectWindowNumber()

static uint GetInspectWindowNumber	(	GrfSpecFeature	feature,
		uint	index
	)

inlinestatic

Get the window number for the inspect window given a feature and index.

Parameters

feature	The feature we want to inspect.
index	The index/identifier of the feature to inspect.

Returns: the InspectWindow (Window)Number

Definition at line 70 of file newgrf_debug_gui.cpp.

Referenced by DeleteNewGRFInspectWindow(), NIHVehicle::GetParent(), NIHStation::GetParent(), NIHHouse::GetParent(), NIHIndustryTile::GetParent(), NIHIndustry::GetParent(), NIHObject::GetParent(), NIHAirportTile::GetParent(), NIHAirport::GetParent(), NIHRoadStop::GetParent(), InvalidateNewGRFInspectWindow(), IsNewGRFInspectable(), and ShowNewGRFInspectWindow().

◆ InvalidateNewGRFInspectWindow()

void InvalidateNewGRFInspectWindow	(	GrfSpecFeature	feature,
		uint	index
	)

Invalidate the inspect window for a given feature and index.

The index is normally an in-game location/identifier, such as a TileIndex or an IndustryID depending on the feature we want to inspect.

Parameters

feature	The feature we want to invalidate the window for.
index	The index/identifier of the feature to invalidate.

Definition at line 713 of file newgrf_debug_gui.cpp.

References GetInspectWindowNumber(), GSF_INVALID, InvalidateWindowData(), and WC_NEWGRF_INSPECT.

Referenced by Train::ConsistChanged().

◆ IsNewGRFInspectable()

bool IsNewGRFInspectable	(	GrfSpecFeature	feature,
		uint	index
	)

Can we inspect the data given a certain feature and index.

The index is normally an in-game location/identifier, such as a TileIndex or an IndustryID depending on the feature we want to inspect.

Parameters

feature	The feature we want to inspect.
index	The index/identifier of the feature to inspect.

Returns: true if there is something to show.

Definition at line 751 of file newgrf_debug_gui.cpp.

References GetFeature(), GetInspectWindowNumber(), NIFeature::helper, and NIHelper::IsInspectable().

Referenced by ShowNewGRFInspectWindow().

◆ ShowNewGRFInspectWindow()

void ShowNewGRFInspectWindow	(	GrfSpecFeature	feature,
		uint	index,
		const uint32_t	grfid
	)

Show the inspect window for a given feature and index.

The index is normally an in-game location/identifier, such as a TileIndex or an IndustryID depending on the feature we want to inspect.

Parameters

feature	The feature we want to inspect.
index	The index/identifier of the feature to inspect.
grfid	GRFID of the item opening this window, or 0 if not opened by other window.

Definition at line 695 of file newgrf_debug_gui.cpp.

References GetInspectWindowNumber(), IsNewGRFInspectable(), and NewGRFInspectWindow::SetCallerGRFID().

◆ ShowSpriteAlignerWindow()

void ShowSpriteAlignerWindow ( )

Show the window for aligning sprites.

Definition at line 1213 of file newgrf_debug_gui.cpp.

Referenced by MenuClickHelp().

Variable Documentation

◆ _nested_newgrf_inspect_chain_widgets

constexpr NWidgetPart _nested_newgrf_inspect_chain_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    NWidget(WWT_CAPTION, COLOUR_GREY, WID_NGRFI_CAPTION), SetDataTip(STR_NEWGRF_INSPECT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_SHADEBOX, COLOUR_GREY),
    NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
    NWidget(WWT_STICKYBOX, COLOUR_GREY),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_GREY),
    NWidget(NWID_HORIZONTAL),
      NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_NGRFI_VEH_PREV), SetDataTip(AWV_DECREASE, STR_NULL),
      NWidget(WWT_PUSHARROWBTN, COLOUR_GREY, WID_NGRFI_VEH_NEXT), SetDataTip(AWV_INCREASE, STR_NULL),
      NWidget(WWT_EMPTY, COLOUR_GREY, WID_NGRFI_VEH_CHAIN), SetFill(1, 0), SetResize(1, 0),
    EndContainer(),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, COLOUR_GREY, WID_NGRFI_MAINPANEL), SetMinimalSize(300, 0), SetScrollbar(WID_NGRFI_SCROLLBAR), EndContainer(),
    NWidget(NWID_VERTICAL),
      NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_NGRFI_SCROLLBAR),
      NWidget(WWT_RESIZEBOX, COLOUR_GREY),
    EndContainer(),
  EndContainer(),
}

Definition at line 630 of file newgrf_debug_gui.cpp.

◆ _nested_newgrf_inspect_widgets

constexpr NWidgetPart _nested_newgrf_inspect_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_GREY),
    NWidget(WWT_CAPTION, COLOUR_GREY, WID_NGRFI_CAPTION), SetDataTip(STR_NEWGRF_INSPECT_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_NGRFI_PARENT), SetDataTip(STR_NEWGRF_INSPECT_PARENT_BUTTON, STR_NEWGRF_INSPECT_PARENT_TOOLTIP),
    NWidget(WWT_SHADEBOX, COLOUR_GREY),
    NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
    NWidget(WWT_STICKYBOX, COLOUR_GREY),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_PANEL, COLOUR_GREY, WID_NGRFI_MAINPANEL), SetMinimalSize(300, 0), SetScrollbar(WID_NGRFI_SCROLLBAR), EndContainer(),
    NWidget(NWID_VERTICAL),
      NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_NGRFI_SCROLLBAR),
      NWidget(WWT_RESIZEBOX, COLOUR_GREY),
    EndContainer(),
  EndContainer(),
}

Definition at line 654 of file newgrf_debug_gui.cpp.

◆ _nested_sprite_aligner_widgets

constexpr NWidgetPart _nested_sprite_aligner_widgets[]

staticconstexpr

Definition at line 1133 of file newgrf_debug_gui.cpp.

◆ _newgrf_debug_sprite_picker

NewGrfDebugSpritePicker _newgrf_debug_sprite_picker = { SPM_NONE, nullptr, std::vector<SpriteID>() }

The sprite picker.

Definition at line 51 of file newgrf_debug_gui.cpp.

Referenced by SpriteAlignerWindow::DrawWidget(), GfxBlitter(), HandleMouseEvents(), SpriteAlignerWindow::OnClick(), and SpriteAlignerWindow::OnInvalidateData().

◆ CBM_NO_BIT

const int CBM_NO_BIT = UINT8_MAX

static

Mask to show no bit needs to be enabled for the callback.

Definition at line 109 of file newgrf_debug_gui.cpp.

Referenced by NewGRFInspectWindow::DrawMainPanelWidget().

Data Structures

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ NIOffsetProc

Enumeration Type Documentation

◆ NIType

Function Documentation

◆ DeleteNewGRFInspectWindow()

◆ GetFeature()

◆ GetFeatureHelper()

◆ GetFeatureIndex()

◆ GetFeatureNum()

◆ GetGrfSpecFeature() [1/2]

◆ GetGrfSpecFeature() [2/2]

◆ GetInspectWindowNumber()

◆ InvalidateNewGRFInspectWindow()

◆ IsNewGRFInspectable()

◆ ShowNewGRFInspectWindow()

◆ ShowSpriteAlignerWindow()

Variable Documentation

◆ _nested_newgrf_inspect_chain_widgets

◆ _nested_newgrf_inspect_widgets

◆ _nested_sprite_aligner_widgets

◆ _newgrf_debug_sprite_picker

◆ CBM_NO_BIT