Add translation cheat sheet

Author: Free-Pascal-meets-SDL-Website

CHEATSHEET.md

@@ -0,0 +1,91 @@
+# SDL2 Translation Cheat Sheet (C to Pascal)
+
+This cheat sheet helps to quickly translate often found C constructs in the
+SDL2 package into Pascal according to the Code style guidelines of the
+conversion project.
+
+## Defines
+
+C:
+
+```
+#define SDL_HAT_CENTERED    0x00
+#define SDL_HAT_UP          0x01
+#define SDL_HAT_RIGHT       0x02
+#define SDL_HAT_DOWN        0x04
+#define SDL_HAT_LEFT        0x08
+#define SDL_HAT_RIGHTUP     (SDL_HAT_RIGHT|SDL_HAT_UP)
+#define SDL_HAT_RIGHTDOWN   (SDL_HAT_RIGHT|SDL_HAT_DOWN)
+#define SDL_HAT_LEFTUP      (SDL_HAT_LEFT|SDL_HAT_UP)
+#define SDL_HAT_LEFTDOWN    (SDL_HAT_LEFT|SDL_HAT_DOWN)
+```
+
+Pascal:
+
+```
+const
+  SDL_HAT_CENTERED  = $00;
+  SDL_HAT_UP        = $01;
+  SDL_HAT_RIGHT     = $02;
+  SDL_HAT_DOWN      = $04;
+  SDL_HAT_LEFT      = $08;
+  SDL_HAT_RIGHTUP   = SDL_HAT_RIGHT or SDL_HAT_UP;
+  SDL_HAT_RIGHTDOWN = SDL_HAT_RIGHT or SDL_HAT_DOWN;
+  SDL_HAT_LEFTUP    = SDL_HAT_LEFT or SDL_HAT_UP;
+  SDL_HAT_LEFTDOWN  = SDL_HAT_LEFT or SDL_HAT_DOWN;
+```
+
+## Enums
+
+C:
+
+```
+typedef enum
+{
+   SDL_JOYSTICK_POWER_UNKNOWN = -1,
+   SDL_JOYSTICK_POWER_EMPTY,   /* <= 5% */
+   SDL_JOYSTICK_POWER_LOW,     /* <= 20% */
+   SDL_JOYSTICK_POWER_MEDIUM,  /* <= 70% */
+   SDL_JOYSTICK_POWER_FULL,    /* <= 100% */
+   SDL_JOYSTICK_POWER_WIRED,
+   SDL_JOYSTICK_POWER_MAX
+} SDL_JoystickPowerLevel;
+```
+
+Pascal:
+
+```
+type
+  TSDL_JoystickPowerLevel = type SInt32;
+
+const
+  SDL_JOYSTICK_POWER_UNKNOWN = TSDL_JoystickPowerLevel(-1);
+  SDL_JOYSTICK_POWER_EMPTY   = TSDL_JoystickPowerLevel(0);  {* <= 5% *}
+  SDL_JOYSTICK_POWER_LOW     = TSDL_JoystickPowerLevel(1);  {* <= 20% *}
+  SDL_JOYSTICK_POWER_MEDIUM  = TSDL_JoystickPowerLevel(2);  {* <= 70% *}
+  SDL_JOYSTICK_POWER_FULL    = TSDL_JoystickPowerLevel(3);  {* <= 100% *}
+  SDL_JOYSTICK_POWER_WIRED   = TSDL_JoystickPowerLevel(4);
+  SDL_JOYSTICK_POWER_MAX     = TSDL_JoystickPowerLevel(5);
+```
+
+## Functions
+
+C:
+
+```
+extern DECLSPEC void SDLCALL SDL_LockJoysticks(void);
+
+extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
+```
+
+Pascal:
+
+```
+procedure SDL_LockJoysticks(); cdecl;
+  external SDL_LibName {$IFDEF DELPHI} {$IFDEF MACOS} name '_SDL_LockJoysticks' {$ENDIF} {$ENDIF};
+
+function SDL_JoystickNameForIndex(device_index: SInt32): PAnsiChar; cdecl;
+  external SDL_LibName {$IFDEF DELPHI} {$IFDEF MACOS} name '_SDL_JoystickNameForIndex' {$ENDIF} {$ENDIF};
+```
+
+

README.md

@@ -30,7 +30,7 @@ Please use the GitHub issue tracker for bug reports.
 
 - (Continously) Update files by new SDL2 functions and types which are present in more recent SDL2 versions.
 - (Continously atm.) Translate integer aliases into typed enums.
-See PR [#4](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/pull/4) for reference.
+See part Enums on the [Cheat sheet](CHEATSHEET.md) for reference.
 - (Continously) Check FPC/Delphi compatibility.
 
 ## Code style guidelines
@@ -53,6 +53,8 @@ original code. Do not replace them by Pascal equivalents.
 Ex.: Use `UInt32` (if used in
 the original code) instead of `Cardinal`, `LongWord` or `DWord` .
 
+4. Have a look at our [Translation Cheat Sheet](CHEATSHEET.md) for reference.
+
 ## Versions
 
 The version tag (see [tags](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/tags)) refers to the version of this translation package [SDL2 for Pascal](https://github.com/PascalGameDevelopment/SDL2-for-Pascal), not the `SDL2 library`.