Data Structures | Enumerations | Functions | Variables

newgrf_debug_gui.cpp File Reference

GUIs for debugging NewGRFs. More...

#include "stdafx.h"
#include <stdarg.h>
#include "window_gui.h"
#include "window_func.h"
#include "fileio_func.h"
#include "spritecache.h"
#include "string_func.h"
#include "strings_func.h"
#include "textbuf_gui.h"
#include "engine_base.h"
#include "industry.h"
#include "object_base.h"
#include "station_base.h"
#include "town.h"
#include "vehicle_base.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 "table/newgrf_debug_data.h"

Go to the source code of this file.

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...

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 NIFeatureGetFeature (uint window_number)
 Get the NIFeature related to the window number.
static const NIHelperGetFeatureHelper (uint window_number)
 Get the NIHelper related to the window number.
void ShowNewGRFInspectWindow (GrfSpecFeature feature, uint index, const uint32 grfid)
 Show 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, NULL, 0, SmallVector<SpriteID, 256>() }
 The sprite picker.
static const int CBM_NO_BIT = UINT8_MAX
 Mask to show no bit needs to be enabled for the callback.
static const NWidgetPart _nested_newgrf_inspect_widgets []
static WindowDesc _newgrf_inspect_desc (WDP_AUTO,"newgrf_inspect", 400, 300, WC_NEWGRF_INSPECT, WC_NONE, 0, _nested_newgrf_inspect_widgets, lengthof(_nested_newgrf_inspect_widgets))
static const 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, lengthof(_nested_sprite_aligner_widgets))

Detailed Description

GUIs for debugging NewGRFs.

Definition in file newgrf_debug_gui.cpp.


Enumeration Type Documentation

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 73 of file newgrf_debug_gui.cpp.


Function Documentation

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 556 of file newgrf_debug_gui.cpp.

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

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

static const NIFeature* GetFeature ( uint  window_number  )  [inline, static]

Get the NIFeature related to the window number.

Parameters:
window_number The window to get the NIFeature for.
Returns:
the NIFeature, or NULL is there isn't one.

Definition at line 251 of file newgrf_debug_gui.cpp.

References _nifeatures, GetFeatureNum(), and GSF_FAKE_END.

Referenced by GetFeatureHelper(), and IsNewGRFInspectable().

static const NIHelper* GetFeatureHelper ( uint  window_number  )  [inline, static]

Get the NIHelper related to the window number.

Parameters:
window_number The window to get the NIHelper for.
Precondition:
GetFeature(window_number) != NULL
Returns:
the NIHelper

Definition at line 263 of file newgrf_debug_gui.cpp.

References GetFeature(), and NIFeature::helper.

Referenced by NewGRFInspectWindow::SetStringParameters().

static uint GetFeatureIndex ( uint  window_number  )  [inline, static]

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 51 of file newgrf_debug_gui.cpp.

References GB().

Referenced by NewGRFInspectWindow::SetStringParameters().

static GrfSpecFeature GetFeatureNum ( uint  window_number  )  [inline, static]

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 241 of file newgrf_debug_gui.cpp.

References GB().

Referenced by GetFeature().

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 590 of file newgrf_debug_gui.cpp.

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

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

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 614 of file newgrf_debug_gui.cpp.

References VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.

static uint GetInspectWindowNumber ( GrfSpecFeature  feature,
uint  index 
) [inline, static]

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 63 of file newgrf_debug_gui.cpp.

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

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 578 of file newgrf_debug_gui.cpp.

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

Referenced by VehicleViewWindow::IsNewGRFInspectable(), and ShowNewGRFInspectWindow().

void ShowNewGRFInspectWindow ( GrfSpecFeature  feature,
uint  index,
const uint32  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 538 of file newgrf_debug_gui.cpp.

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

Referenced by VehicleViewWindow::ShowNewGRFInspectWindow().


Variable Documentation

const NWidgetPart _nested_newgrf_inspect_widgets[] [static]
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 504 of file newgrf_debug_gui.cpp.

The sprite picker.

Definition at line 44 of file newgrf_debug_gui.cpp.

Referenced by HandleMouseEvents().

const int CBM_NO_BIT = UINT8_MAX [static]

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

Definition at line 100 of file newgrf_debug_gui.cpp.