-/***********************************************************
-* Rocks'n'Diamonds -- McDuffin Strikes Back! *
-*----------------------------------------------------------*
-* (c) 1995-2002 Artsoft Entertainment *
-* Holger Schemel *
-* Detmolder Strasse 189 *
-* 33604 Bielefeld *
-* Germany *
-* e-mail: info@artsoft.org *
-*----------------------------------------------------------*
-* tools.h *
-***********************************************************/
+// ============================================================================
+// Rocks'n'Diamonds - McDuffin Strikes Back!
+// ----------------------------------------------------------------------------
+// (c) 1995-2014 by Artsoft Entertainment
+// Holger Schemel
+// info@artsoft.org
+// https://www.artsoft.org/
+// ----------------------------------------------------------------------------
+// tools.h
+// ============================================================================
#ifndef TOOLS_H
#define TOOLS_H
#include "main.h"
#include "game.h"
-/* for SetDrawtoField */
-#define DRAW_DIRECT 0
-#define DRAW_BUFFERED 1
-#define DRAW_BACKBUFFER 2
-/* for DrawElementShifted */
+// for DrawElementShifted
#define NO_CUTTING 0
#define CUT_ABOVE (1 << 0)
#define CUT_BELOW (1 << 1)
#define CUT_LEFT (1 << 2)
#define CUT_RIGHT (1 << 3)
-/* for masking functions */
+// for masking functions
#define NO_MASKING 0
#define USE_MASKING 1
-/* for MoveDoor */
+// for MoveDoor
#define DOOR_OPEN_1 (1 << 0)
#define DOOR_OPEN_2 (1 << 1)
#define DOOR_CLOSE_1 (1 << 2)
#define DOOR_COPY_BACK (1 << 4)
#define DOOR_NO_COPY_BACK (1 << 5)
#define DOOR_NO_DELAY (1 << 6)
-#define DOOR_FORCE_REDRAW (1 << 7)
-#define DOOR_GET_STATE (1 << 8)
-#define DOOR_SET_STATE (1 << 9)
+#define DOOR_FORCE_ANIM (1 << 7)
+#define DOOR_FORCE_REDRAW (1 << 8)
+#define DOOR_GET_STATE (1 << 9)
+#define DOOR_SET_STATE (1 << 10)
-/* for Request */
+#define DOOR_1 (DOOR_ACTION_1)
+#define DOOR_2 (DOOR_ACTION_2)
+#define DOOR_OPEN (DOOR_OPEN_ALL)
+#define DOOR_CLOSE (DOOR_CLOSE_ALL)
+
+#define DOOR_INDEX_FROM_TOKEN(x) ((x) == DOOR_1 ? 0 : 1)
+#define DOOR_TOKEN_FROM_INDEX(x) ((x) == 0 ? DOOR_1 ? : DOOR_2)
+#define REDRAW_DOOR_FROM_TOKEN(x) ((x) == DOOR_1 ? REDRAW_DOOR_1 : \
+ REDRAW_DOOR_2)
+
+// for Request
#define REQ_ASK (1 << 0)
#define REQ_CONFIRM (1 << 1)
#define REQ_PLAYER (1 << 2)
#define REQUEST_WAIT_FOR_INPUT (REQ_ASK | REQ_CONFIRM | REQ_PLAYER)
+
+int getFieldbufferOffsetX_RND(int, int);
+int getFieldbufferOffsetY_RND(int, int);
+
+int getLevelFromScreenX(int);
+int getLevelFromScreenY(int);
+
+int getScreenFieldSizeX(void);
+int getScreenFieldSizeY(void);
+
void DumpTile(int, int);
+void DumpTileFromScreen(int, int);
+
+void DrawMaskedBorder_FIELD(void);
+void DrawMaskedBorder_DOOR_1(void);
+void DrawMaskedBorder_DOOR_2(void);
+void DrawMaskedBorder_DOOR_3(void);
+void DrawMaskedBorder_ALL(void);
+void DrawMaskedBorder(int);
+void DrawMaskedBorderToTarget(int);
+void DrawTileCursor(int);
void SetDrawtoField(int);
-void RedrawPlayfield(boolean, int, int, int, int);
-void BackToFront();
-void FadeToFront();
+int GetDrawtoField(void);
+void RedrawPlayfield(void);
+void BlitScreenToBitmapExt_RND(Bitmap *, int, int);
+void BlitScreenToBitmap_RND(Bitmap *);
+void BlitScreenToBitmap(Bitmap *);
+void BackToFront(void);
+void BackToFront_WithFrameDelay(unsigned int);
void FadeIn(int);
-void FadeOut(int, int);
-void FadeCross(int);
-void FadeInField(int);
-void FadeOutField(int, int);
-void FadeCrossField(int);
+void FadeOut(int);
+void FadeSetEnterMenu(void);
+void FadeSetLeaveMenu(void);
+void FadeSetEnterScreen(void);
+void FadeSetNextScreen(void);
+void FadeSetLeaveScreen(void);
+void FadeSetFromType(int);
+void FadeSetDisabled(void);
+void FadeSkipNextFadeIn(void);
+void FadeSkipNextFadeOut(void);
-void ClearWindow();
+int getImageFromGraphicOrDefault(int, int);
+Bitmap *getGlobalBorderBitmapFromStatus(int);
+
+void ClearField(void);
+
+void SetBackgroundImage(int, int);
+void SetWindowBackgroundImageIfDefined(int);
void SetMainBackgroundImageIfDefined(int);
+void SetDoorBackgroundImageIfDefined(int);
+void SetWindowBackgroundImage(int);
void SetMainBackgroundImage(int);
void SetDoorBackgroundImage(int);
-void SetPanelBackground();
+void SetPanelBackground(void);
void DrawBackground(int, int, int, int);
+void DrawBackgroundForFont(int, int, int, int, int);
+void DrawBackgroundForGraphic(int, int, int, int, int);
+boolean CheckIfGlobalBorderHasChanged(void);
+void RedrawGlobalBorder(void);
void MarkTileDirty(int, int);
-void SetBorderElement();
+void SetBorderElement(void);
+void FloodFillLevel(int, int, int, short[MAX_LEV_FIELDX][MAX_LEV_FIELDY], int, int);
+void FloodFillLevelExt(int, int, int, int x, int y, short field[x][y], int, int);
void SetRandomAnimationValue(int, int);
int getGraphicAnimationFrame(int, int);
-void DrawGraphicAnimationExt(DrawBuffer *, int, int, int, int, int);
-void DrawGraphicAnimation(int, int, int);
+int getGraphicAnimationFrameXY(int, int, int);
+
+void DrawFixedGraphicAnimation(int, int, int);
+void DrawFixedGraphicAnimationExt(DrawBuffer *, int, int, int, int, int);
+void DrawSizedGraphicAnimationExt(DrawBuffer *, int, int, int, int, int, int);
+
void DrawLevelGraphicAnimation(int, int, int);
void DrawLevelElementAnimation(int, int, int);
void DrawLevelGraphicAnimationIfNeeded(int, int, int);
void DrawPlayerField(int, int);
void DrawPlayer(struct PlayerInfo *);
-void getGraphicSourceExt(int, int, Bitmap **, int *, int *, boolean);
+void getGraphicSourceBitmap(int, int, Bitmap **);
+void getGraphicSourceXY(int, int, int *, int *, boolean);
+void getSizedGraphicSourceExt(int, int, int, Bitmap **, int *, int *, boolean);
+void getSizedGraphicSource(int, int, int, Bitmap **, int *, int *);
+void getFixedGraphicSource(int, int, Bitmap **, int *, int *);
+void getMiniGraphicSource(int, Bitmap **, int *, int *);
+void getGlobalAnimGraphicSource(int, int, Bitmap **, int *, int *);
void getGraphicSource(int, int, Bitmap **, int *, int *);
+
void DrawGraphic(int, int, int, int);
void DrawGraphicExt(DrawBuffer *, int, int, int, int);
void DrawGraphicThruMask(int, int, int, int);
void DrawGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
+void DrawFixedGraphic(int, int, int, int);
+void DrawFixedGraphicExt(DrawBuffer *, int, int, int, int);
+void DrawFixedGraphicThruMask(int, int, int, int);
+void DrawFixedGraphicThruMaskExt(DrawBuffer *, int, int, int, int);
+
+void DrawSizedGraphic(int, int, int, int, int);
+void DrawSizedGraphicExt(DrawBuffer *, int, int, int, int, int);
+void DrawSizedGraphicThruMask(int, int, int, int, int);
+void DrawSizedGraphicThruMaskExt(DrawBuffer *, int, int, int, int, int);
+
void DrawMiniGraphic(int, int, int);
-void getMiniGraphicSource(int, Bitmap **, int *, int *);
void DrawMiniGraphicExt(DrawBuffer *, int, int, int);
void DrawScreenElementExt(int, int, int, int, int, int, int);
void DrawScreenElementThruMask(int, int, int);
void DrawLevelElementThruMask(int, int, int);
void DrawLevelFieldThruMask(int, int);
-void DrawLevelFieldCrumbledSand(int, int);
-void DrawLevelFieldCrumbledSandDigging(int, int, int, int);
-void DrawLevelFieldCrumbledSandNeighbours(int, int);
+void DrawLevelFieldCrumbled(int, int);
+void DrawLevelFieldCrumbledDigging(int, int, int, int);
+void DrawLevelFieldCrumbledNeighbours(int, int);
+void DrawScreenGraphic(int, int, int, int);
+void DrawLevelGraphic(int, int, int, int);
void DrawScreenElement(int, int, int);
void DrawLevelElement(int, int, int);
void DrawScreenField(int, int);
void DrawLevelField(int, int);
+void DrawSizedWallParts_MM(int, int, int, int, boolean, int);
+void DrawSizedElement(int, int, int, int);
+void DrawSizedElementThruMask(int, int, int, int);
+void DrawSizedElementOrWall(int, int, int, int, int);
+
void DrawMiniElement(int, int, int);
void DrawMiniElementOrWall(int, int, int, int);
-void ShowEnvelope();
+void ShowEnvelope(int);
+void ShowEnvelopeDoor(char *, int);
+void DrawEnvelopeRequestToScreen(int, int);
-void DrawLevel(void);
+void DrawLevel(int);
+void DrawSizedLevel(int, int, int, int, int);
void DrawMiniLevel(int, int, int, int);
-void DrawPreviewLevel(boolean);
+void DrawPreviewPlayers(void);
+void DrawPreviewLevelInitial(void);
+void DrawPreviewLevelAnimation(void);
-void WaitForEventToContinue();
+void DrawNetworkPlayers(void);
+void ClearNetworkPlayers(void);
+
+void WaitForEventToContinue(void);
boolean Request(char *, unsigned int);
+void InitGraphicCompatibilityInfo_Doors(void);
+void InitDoors(void);
unsigned int OpenDoor(unsigned int);
unsigned int CloseDoor(unsigned int);
unsigned int GetDoorState(void);
unsigned int SetDoorState(unsigned int);
unsigned int MoveDoor(unsigned int);
-void DrawSpecialEditorDoor();
-void UndrawSpecialEditorDoor();
+void DrawSpecialEditorDoor(void);
+void UndrawSpecialEditorDoor(void);
-void CreateToolButtons();
-void FreeToolButtons();
+void CreateToolButtons(void);
+void FreeToolButtons(void);
-int map_element_RND_to_EM(int);
-int map_element_EM_to_RND(int);
+int map_element_RND_to_EM_cave(int);
+int map_element_EM_to_RND_cave(int);
+int map_element_EM_to_RND_game(int);
int map_direction_RND_to_EM(int);
int map_direction_EM_to_RND(int);
void map_android_clone_elements_RND_to_EM(struct LevelInfo *);
void map_android_clone_elements_EM_to_RND(struct LevelInfo *);
+int map_element_RND_to_SP(int);
+int map_element_SP_to_RND(int);
+int map_action_SP_to_RND(int);
+
+int map_element_RND_to_MM(int);
+int map_element_MM_to_RND(int);
+int map_action_MM_to_RND(int);
+int map_sound_MM_to_RND(int);
+int map_mm_wall_element(int);
+int map_mm_wall_element_editor(int);
+
int get_next_element(int);
int el_act_dir2img(int, int, int);
int el_act2img(int, int);
int el2img(int);
int el2edimg(int);
int el2preimg(int);
+int el2panelimg(int);
int font2baseimg(int);
-unsigned int InitRND(long);
+int getBeltNrFromBeltElement(int);
+int getBeltNrFromBeltActiveElement(int);
+int getBeltNrFromBeltSwitchElement(int);
+int getBeltDirNrFromBeltElement(int);
+int getBeltDirNrFromBeltSwitchElement(int);
+int getBeltDirFromBeltElement(int);
+int getBeltDirFromBeltSwitchElement(int);
+int getBeltElementFromBeltNrAndBeltDirNr(int, int);
+int getBeltElementFromBeltNrAndBeltDir(int, int);
+int getBeltSwitchElementFromBeltNrAndBeltDirNr(int, int);
+int getBeltSwitchElementFromBeltNrAndBeltDir(int, int);
+
+unsigned int InitRND(int);
void InitGraphicInfo_EM(void);
-void PlayMenuSound();
+void PlayMenuSoundExt(int);
+void PlayMenuSound(void);
void PlayMenuSoundStereo(int, int);
-void PlayMenuSoundIfLoop();
-void PlayMenuMusic();
+void PlayMenuSoundIfLoopExt(int);
+void PlayMenuSoundIfLoop(void);
+void PlayMenuMusicExt(int);
+void PlayMenuMusic(void);
+void PlayMenuSoundsAndMusic(void);
+void FadeMenuSoundsAndMusic(void);
+void PlaySoundActivating(void);
+void PlaySoundSelecting(void);
+
+void SetAnimStatus(int);
+void SetGameStatus(int);
+void SetFontStatus(int);
+void ResetFontStatus(void);
+
+void SetLevelSetInfo(char *, int);
+
+void ToggleFullscreenIfNeeded(void);
+void ChangeWindowScalingIfNeeded(void);
+void ChangeVsyncModeIfNeeded(void);
+void ChangeViewportPropertiesIfNeeded(void);
+
+boolean CheckIfAllViewportsHaveChanged(void);
+boolean CheckFadeAll(void);
+
+void OpenURL(char *);
+void OpenURLFromHash(SetupFileHash *, int);
-void ToggleFullscreenIfNeeded();
+void TestGeneratingUUIDs(void);
-#endif /* TOOLS_H */
+#endif // TOOLS_H