devilutionX/Source/debug.h

/**
 * @file debug.h
 *
 * Interface of debug functions.
 */
#pragma once

#include <cstdint>
#include <string_view>

#include <ankerl/unordered_dense.h>

#include "diablo.h"
#include "engine.h"
#include "engine/clx_sprite.hpp"

namespace devilution {

extern std::string TestMapPath;
extern OptionalOwnedClxSpriteList pSquareCel;
extern bool DebugToggle;
extern bool DebugGodMode;
extern bool DebugInvisible;
extern bool DebugVision;
extern bool DebugPath;
extern bool DebugGrid;
extern ankerl::unordered_dense::map<int, Point> DebugCoordsMap;
extern bool DebugScrollViewEnabled;
extern std::string debugTRN;
extern uint32_t glMid1Seed[NUMLEVELS];
extern uint32_t glMid2Seed[NUMLEVELS];
extern uint32_t glMid3Seed[NUMLEVELS];
extern uint32_t glEndSeed[NUMLEVELS];

enum class DebugGridTextItem : uint16_t {
	None,
	microTiles,
	dPiece,
	dTransVal,
	dLight,
	dPreLight,
	dFlags,
	dPlayer,
	dMonster,
	dCorpse,
	dObject,
	dItem,
	dSpecial,

	coords,
	cursorcoords,
	objectindex,

	// take dPiece as index
	Solid,
	Transparent,
	Trap,

	// megatiles
	AutomapView,
	dungeon,
	pdungeon,
	Protected,
};

void FreeDebugGFX();
void LoadDebugGFX();
void GetDebugMonster();
void NextDebugMonster();
void SetDebugLevelSeedInfos(uint32_t mid1Seed, uint32_t mid2Seed, uint32_t mid3Seed, uint32_t endSeed);
bool IsDebugGridTextNeeded();
bool IsDebugGridInMegatiles();
DebugGridTextItem GetDebugGridTextType();
void SetDebugGridTextType(DebugGridTextItem value);
bool GetDebugGridText(Point dungeonCoords, char *debugGridTextBuffer);
bool IsDebugAutomapHighlightNeeded();
bool ShouldHighlightDebugAutomapTile(Point position);
void AddDebugAutomapMonsterHighlight(std::string_view name);
void AddDebugAutomapItemHighlight(std::string_view name);
void AddDebugAutomapObjectHighlight(std::string_view name);
void ClearDebugAutomapHighlights();

} // namespace devilution
Add documentation - Add file documentation to about 1/4 of the files in Source - Copy over a lot of the documentation from the sanctuary/notes repo - Standardise all the existing documentation - Create a configuration for Doxygen - Add more documentation (engine.cpp is now fully documented) 6 years ago			`/**`
			`* @file debug.h`
			`*`
			`* Interface of debug functions.`
			`*/`
:recycle: Consistently use pragma once to guard the headers 5 years ago			`#pragma once`
Add files via upload 8 years ago
Add missing <cstdint> includes Done with the following script: ```ruby Dir["Source/*/.{h,c,cc,cpp,hpp}"].each do \|path\| v = File.read(path) next if !v.include?("uint32_t") \|\| v.include?("cstdint") lines = v.lines line_num = if lines[2].start_with?(" ") lines.index { \|l\| l.start_with?(" /") } + 3 else 3 end lines.insert(line_num, "#include <cstdint>\n") File.write(path, lines.join("")) end ``` then fixed-up manually 3 years ago			`#include <cstdint>`
Remove utils/stdcompat/string_view.hpp 3 years ago			`#include <string_view>`
Switch to ankerl::unordered_dense 2 years ago
			`#include <ankerl/unordered_dense.h>`
Add debug text commands 5 years ago
Move seedinfo to text commands 3 years ago			`#include "diablo.h"`
♻️ Store CEL width with the sprite itself Instead of passing the CEL sprite width when drawing, store the CEL width at load time in the new `CelSprite` struct. Implemented for most sprites except towners, missiles, or monsters. 5 years ago			`#include "engine.h"`
CLX: A new graphics format The format is almost identical to CL2, except it uses the frame header to store frame width and height instead of 5 32-line offsets. This means we always have access to frame dimensions, so we can use it as an on-disk format for our graphics as well. Additionally, we may be able to optimize the rendering even more in the future now that we have guaranteed knowledge of frame dimensions. 4 years ago			`#include "engine/clx_sprite.hpp"`
:truck: Split up all.h in to proper header relations 5 years ago
:art: Change namespace to devilution 5 years ago			`namespace devilution {`
Sanitize use of namespace Wrap individual headers in dvl namespace to prevent including standard header in another namespace. 6 years ago
Add debug command for testing custom levels 4 years ago			`extern std::string TestMapPath;`
CLX: A new graphics format The format is almost identical to CL2, except it uses the frame header to store frame width and height instead of 5 32-line offsets. This means we always have access to frame dimensions, so we can use it as an on-disk format for our graphics as well. Additionally, we may be able to optimize the rendering even more in the future now that we have guaranteed knowledge of frame dimensions. 4 years ago			`extern OptionalOwnedClxSpriteList pSquareCel;`
debug X toggle 5 years ago			`extern bool DebugToggle;`
Clean up god mode 5 years ago			`extern bool DebugGodMode;`
Debug: Insivible (#7543) 1 year ago			`extern bool DebugInvisible;`
Port debug vision to a command 5 years ago			`extern bool DebugVision;`
debug path command (#6101) 3 years ago			`extern bool DebugPath;`
Merge pull request #2711 from qndel/show_coords 5 years ago			`extern bool DebugGrid;`
Switch to ankerl::unordered_dense 2 years ago			`extern ankerl::unordered_dense::map<int, Point> DebugCoordsMap;`
Remove debug command line argument -^ (Enable debug tools) and added scrollview debug command 5 years ago			`extern bool DebugScrollViewEnabled;`
Add TRN debug command and support for optional class TRNs 4 years ago			`extern std::string debugTRN;`
Move seedinfo to text commands 3 years ago			`extern uint32_t glMid1Seed[NUMLEVELS];`
			`extern uint32_t glMid2Seed[NUMLEVELS];`
			`extern uint32_t glMid3Seed[NUMLEVELS];`
			`extern uint32_t glEndSeed[NUMLEVELS];`
Add files via upload 8 years ago
Lua: Migrate and organize the rest of debug cmds Fully migrates debug commands to Lua and organizes them into logical groups. The CLI `+` syntax now runs Lua, e.g.: ```bash build/devilutionx '+dev.player.trn.plr("infra")' ``` Chat hotkeys run Lua code if they start with `/lua`, e.g.: ```ini [NetMsg] QuickMessage1=/lua message(dev.player.info()) ``` 2 years ago			`enum class DebugGridTextItem : uint16_t {`
			`None,`
Add `dev.display.tileData('microTiles')` 1 year ago			`microTiles,`
Lua: Migrate and organize the rest of debug cmds Fully migrates debug commands to Lua and organizes them into logical groups. The CLI `+` syntax now runs Lua, e.g.: ```bash build/devilutionx '+dev.player.trn.plr("infra")' ``` Chat hotkeys run Lua code if they start with `/lua`, e.g.: ```ini [NetMsg] QuickMessage1=/lua message(dev.player.info()) ``` 2 years ago			`dPiece,`
			`dTransVal,`
			`dLight,`
			`dPreLight,`
			`dFlags,`
			`dPlayer,`
			`dMonster,`
			`dCorpse,`
			`dObject,`
			`dItem,`
			`dSpecial,`

			`coords,`
			`cursorcoords,`
			`objectindex,`

			`// take dPiece as index`
			`Solid,`
			`Transparent,`
			`Trap,`

			`// megatiles`
			`AutomapView,`
			`dungeon,`
			`pdungeon,`
			`Protected,`
			`};`

Cleanup default calling conventions 7 years ago			`void FreeDebugGFX();`
Strip out debug features from the release builds leveldebug and lightmax still remains 5 years ago			`void LoadDebugGFX();`
Cleanup default calling conventions 7 years ago			`void GetDebugMonster();`
			`void NextDebugMonster();`
Add "seedinfo" debug command 5 years ago			`void SetDebugLevelSeedInfos(uint32_t mid1Seed, uint32_t mid2Seed, uint32_t mid3Seed, uint32_t endSeed);`
Reduce exported functions in debug.h 5 years ago			`bool IsDebugGridTextNeeded();`
add megatiles to tiledata (#3211) 4 years ago			`bool IsDebugGridInMegatiles();`
Lua: Migrate and organize the rest of debug cmds Fully migrates debug commands to Lua and organizes them into logical groups. The CLI `+` syntax now runs Lua, e.g.: ```bash build/devilutionx '+dev.player.trn.plr("infra")' ``` Chat hotkeys run Lua code if they start with `/lua`, e.g.: ```ini [NetMsg] QuickMessage1=/lua message(dev.player.info()) ``` 2 years ago			`DebugGridTextItem GetDebugGridTextType();`
			`void SetDebugGridTextType(DebugGridTextItem value);`
Reduce exported functions in debug.h 5 years ago			`bool GetDebugGridText(Point dungeonCoords, char *debugGridTextBuffer);`
Add search monster/item/object debug commands 3 years ago			`bool IsDebugAutomapHighlightNeeded();`
			`bool ShouldHighlightDebugAutomapTile(Point position);`
Lua: Migrate and organize the rest of debug cmds Fully migrates debug commands to Lua and organizes them into logical groups. The CLI `+` syntax now runs Lua, e.g.: ```bash build/devilutionx '+dev.player.trn.plr("infra")' ``` Chat hotkeys run Lua code if they start with `/lua`, e.g.: ```ini [NetMsg] QuickMessage1=/lua message(dev.player.info()) ``` 2 years ago			`void AddDebugAutomapMonsterHighlight(std::string_view name);`
			`void AddDebugAutomapItemHighlight(std::string_view name);`
			`void AddDebugAutomapObjectHighlight(std::string_view name);`
			`void ClearDebugAutomapHighlights();`
Add include guards, prepare for XRef (#28) Add definitions, other junk. 8 years ago
:art: Format code 5 years ago			`} // namespace devilution`