Merge branch 'master' into update-sdlthread

Author: Free-Pascal-meets-SDL-Website

Diff for: CHEATSHEET.md

@@ -56,6 +56,8 @@ Pascal:
 
 ```pascal
 type
+  PPSDL_JoystickPowerLevel = ^PSDL_JoystickPowerLevel;
+  PSDL_JoystickPowerLevel = ^TSDL_JoystickPowerLevel;
   TSDL_JoystickPowerLevel = type Integer;
 
 const
@@ -70,15 +72,23 @@ const
 
 Hint 1: C enums start at 0 if no explicit value is set.
 
-Hint 2: The type should be Word if only unsigned values are possible. Otherwise
-it should be Integer.
+Hint 2: The type should always be cint. Most C compilers have the enum elements
+> In C, each enumeration constant has type int and each enumeration type
+> is compatible with some integer type. (The integer types include all three
+> character types–plain, signed, and unsigned.) The choice of compatible
+> type is implementation-defined. The C standard grants the freedom to
+> use different integer types to represent different enumeration types,
+> but most compilers just use int to represent all enumeration types.
+Ref.: [https://www.embedded.com/enumerations-are-integers-except-when-theyre-not/](https://www.embedded.com/enumerations-are-integers-except-when-theyre-not/)
 
 Hint 3: Do not translate C enums to Pascal enums. C enums are handled like plain
 integers which will make bitwise operations (e. g. in macros) possible
 without typecasting.
 
 ## Structs
 
+### Defined Structs
+
 C:
 
 ```c
@@ -94,6 +104,7 @@ Pascal:
 
 ```pascal
 type
+  PPSDL_Version = ^PSDL_Version;
   PSDL_Version = ^TSDL_Version;
   TSDL_Version = record
     major: cuint8    { major version }
@@ -102,10 +113,12 @@ type
   end;
 ```
 
-Hint 1: If you have something like ```typedef struct name name```. the concrete
-structure is probably opaque. You should translate it as follows, although
-the best way to handle this is still not finally decided on. (see issue
+### Opaque Structs
+
+If you have something like ```typedef struct name name```. the concrete
+structure is opaque. See issue
 [#63](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/issues/63))
+for details.
 
 C:
 
@@ -115,8 +128,18 @@ typedef struct SDL_Window SDL_Window;
 
 Pascal:
 
+Prefered:
+```pascal
+type
+  PPSDL_Window = ^PSDL_Window;
+  PSDL_Window = ^TSDL_Window;
+  TSDL_Window = type Pointer;
+```
+
+Alternativly:
 ```pascal
 type
+  PPSDL_Window = ^PSDL_Window;
   PSDL_Window = ^TSDL_Window;
   TSDL_Window = record end;
 ```
@@ -137,6 +160,7 @@ Pascal:
 
 ```pascal
 type
+  PPSDL_WindowShapeParams = ^PSDL_WindowShapeParams;
   PSDL_WindowShapeParams = ^TSDL_WindowShapeParams;
   TSDL_WindowShapeParams = record
   case cint of

Diff for: LEGACYCHANGELOG.md

@@ -83,3 +83,11 @@ v.1.70-stable; 16.09.2013: Initial Commit
 v.1.72-stable; 29.09.2013: fixed bug with procedures without parameters (they must have brackets)
 
 v.1.70-stable; 11.09.2013: Initial Commit
+
+## Extracted from jedi.inc
+
+v. 1.63-stable; 16.09.13: since GPC isn't supported anymore, i've deleted it from here, too.
+
+v. 1.22-alpha; 24.07.13: fixed some bugs. special thanks to kotai from pascalgamedevelopment.com
+
+v. 1.00-alpha; 05.07.13: Initial Alpha-Release

Diff for: README.md

@@ -4,7 +4,7 @@ Unit files for building
 [Free Pascal](https://freepascal.org/) / [Delphi](https://www.embarcadero.com/products/delphi) applications
 using the [SDL2 library](https://libsdl.org).
 
-This repository is a community-maintained fork of the [Pascal-SDL-2-Headers](https://github.com/ev1313/Pascal-SDL-2-Headers) repo.
+The [SDL2-for-Pascal](https://github.com/PascalGameDevelopment/SDL2-for-Pascal) repository is a community-maintained fork of the [Pascal-SDL-2-Headers](https://github.com/ev1313/Pascal-SDL-2-Headers) repository.
 
 ## Installation
 
@@ -15,16 +15,26 @@ Simply add the units to your include path. You can achieve this by:
 
 Use the `sdl2` unit for the main SDL2 library (should be always needed). Units for the other SDL2 libraries are also provided:
  - [`sdl2_gfx`](https://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/)
- - [`sdl2_image`](https://www.libsdl.org/projects/SDL_image/)
- - [`sdl2_mixer`](https://www.libsdl.org/projects/SDL_mixer/)
- - [`sdl2_net`](https://www.libsdl.org/projects/SDL_net/)
- - [`sdl2_ttf`](https://www.libsdl.org/projects/SDL_ttf/)
+ - [`sdl2_image`](https://github.com/libsdl-org/SDL_image)
+ - [`sdl2_mixer`](https://github.com/libsdl-org/SDL_mixer)
+ - [`sdl2_net`](https://github.com/libsdl-org/SDL_net)
+ - [`sdl2_ttf`](https://github.com/libsdl-org/SDL_ttf)
+
+## Documentation
+
+[Official SDL2-for-Pascal Documentation](https://pascalgamedevelopment.github.io/SDL2-for-Pascal)
+
+### Further Resources
+
+[Free Pascal meets SDL](https://www.freepascal-meets-sdl.net)
+
+[PGD SDL2 Forum](https://www.pascalgamedevelopment.com/forumdisplay.php?26-SDL-SDL-2)
 
 ## Bugs / Contributions / ToDos
 
 If you have any contributions or bugfixes, feel free to drop a pull request or send in a patch.
+Please use the GitHub [issue tracker](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/issues).
 
-Please use the GitHub issue tracker for bug reports.
 
 ### ToDos
 
@@ -34,7 +44,7 @@ See part Enums on the [Cheat sheet](CHEATSHEET.md) for reference.
 - (Continously) improve Delphi-compatibility (and even more important, DO NOT break it)
 - (Continously) Adapt comments to [PasDoc format](https://pasdoc.github.io). (See issue [#22](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/issues/22))
 
-## Code style guidelines
+### Code style guidelines
 
 The main principle is to stay as tight as possible at the names in the C headers.
 These guidelines aim to have better consistency in this community project and make
@@ -61,22 +71,30 @@ Exception: Replace `*char` by `PAnsiChar`! (see issue [#26](https://github.com/P
 
 4. If an identifier or a function declaration is gone, mark them as `deprecated`. (see issue [#34](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/issues/34))
 
-5. Have a look at our [Translation Cheat Sheet](CHEATSHEET.md) for reference.
+5. For convenience we encourage to add single and double pointers for any SDL type. (see issue [#105](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/issues/105))
+
+6. 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`.
 
 ### v2.x (work in progress)
 
-- be up-to-date with _at least_ version 2.0.14 of the `SDL2 library`
-- replaced all aliases by typed enums
-- (done) update SDL_ttf.pas to latest version 2.21.0
-- (done) replace data types by c data types (see PR [#29](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/pull/29)) 
-- (done) add folders to project
-- (done) shift all units into unit folder (see PR [#27](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/pull/27))
+- update sdlthreads.inc
+- add testing framework ([fptest](https://github.com/graemeg/fptest))
+
+### v2.2 Stable (02/01/2024)
+
+- SDL2 unit is up-to-date with _at least_ version 2.0.14 of the `SDL2 library`
+- many aliases got replaced by typed enums
+- add single and double pointers for all types (thanks furious-programming)
+- update SDL_ttf.pas to latest version 2.21.0
+- replace data types by c data types (see PR [#29](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/pull/29))
+- add folder structure (see PR [#27](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/pull/27))
+- many bugfixes
 
-### v2.1 (Compatibility Release)
+### v2.1 Compatibility Release (25/09/2021)
 
 - This release has all commits until the change of the project folder structure (see PR [#27](https://github.com/PascalGameDevelopment/SDL2-for-Pascal/pull/27)). Compare the disucssion in issue #22.
 - Moving the units to a new location may (1) raise difficulties in committing new changes if the branch was started before and (2) make updates of project research pathes necessary.

Diff for: units/ctypes.inc

@@ -24,10 +24,12 @@
 type
   DWord = LongWord;
 
+  ppcbool = ^pcbool;
   pcbool = ^cbool;
   cbool = LongBool;
   {$EXTERNALSYM cbool}
 
+  ppcint8 = ^pcint8;
   pcint8 = ^cint8;
   cint8 = ShortInt;
   {$EXTERNALSYM cint8}
@@ -36,50 +38,60 @@ type
   cuint8 = Byte;
   {$EXTERNALSYM cuint8}
 
+  ppcint16 = ^pcint16;
   pcint16 = ^cint16;
   cint16 = SmallInt;
   {$EXTERNALSYM cint16}
 
+  ppcuint16 = ^pcuint16;
   pcuint16 = ^cuint16;
   cuint16 = Word;
   {$EXTERNALSYM cuint16}
 
+  ppcushort = ^pcushort;
   pcushort = ^cushort;
   cushort = Word;
   {$EXTERNALSYM cushort}
 
+  ppcint32 = ^pcint32;
   pcint32 = ^cint32;
   cint32 = LongInt;
   {$EXTERNALSYM cint32}
 
+  ppcuint32 = ^pcuint32;
   pcuint32 = ^cuint32;
   cuint32 = LongWord;
   {$EXTERNALSYM cuint32}
 
   {$IFNDEF Has_Int64}
+     ppcint64 = ^pcint64;
      pcint64 = ^cint64;
      cint64 = record
        hi: cuint32;
        lo: cuint32;
      end;
     {$EXTERNALSYM cint64}
 
+    ppcuint64 = ^pcuint64;
     pcuint64 = ^cuint64;
     cuint64 = record
       hi: cuint32;
       lo: cuint32;
     end;
     {$EXTERNALSYM cuint64}
   {$ELSE}
+    ppcint64 = ^pcint64;
     pcint64 = ^cint64;
     cint64 = Int64;
     {$EXTERNALSYM cint64}
 
+    ppcuint64 = ^pcuint64;
     pcuint64 = ^cuint64;
     cuint64 = UInt64;
     {$EXTERNALSYM cuint64}
   {$ENDIF}
 
+  ppcsize_t = ^pcsize_t;
   pcsize_t = ^csize_t;
   {$IFNDEF WIN64}
     csize_t = cuint32;
@@ -88,13 +100,26 @@ type
   {$ENDIF}
   {$EXTERNALSYM csize_t}
 
+  ppcfloat = ^pcfloat;
   pcfloat = ^cfloat;
   cfloat = Single;
   {$EXTERNALSYM cfloat}
 
+  ppcdouble = ^pcdouble;
+  pcdouble = ^cdouble;
+  cdouble = Double;
+  {$EXTERNALSYM cfloat}
+
+  ppcint = ^pcint;
   pcint = ^cint;
+
+  ppcuint = ^pcuint;
   pcuint = ^cuint;
+
+  ppclong = ^pclong;
   pclong = ^clong;
+
+  ppculong = ^pculong;
   pculong = ^culong;
   {
     Integer type sizes based on:
@@ -123,6 +148,7 @@ type
 
 { Data types for all compilers }
 type
+  PPUInt8Array = ^PUInt8Array;
   PUInt8Array = ^TUInt8Array;
   TUInt8Array = array [0..MAXINT shr 1] of cuint8;
 

Diff for: units/jedi.inc

@@ -1,22 +1,15 @@
 {
-  Simple DirectMedia Layer
-  Copyright (C) 1997-2013 Sam Lantinga <[email protected]>
+  This file (jedi.inc) is part of SDL2-for-Pascal.
+  It defines some variables for several Pascal-Compilers and OS-versions.
 
-  Pascal-Header-Conversion
-  Copyright (c) 2012/13 Tim Blume aka End
+  It is based upon:
 
-  sdl.inc is based on the files:
-    "begin_code.h",
-    "close_code.h",
-	  "sdl_config.h",
-	  "sdl_config_windows.h",
-   	...
-  it defines some variables for several Pascal-Compilers and OS-versions.
+    Pascal-Header-Conversion
+    Copyright (c) 2012/13 Tim Blume aka End
 
-  It is based on mine updated version of jedi-sdl.inc from the SDL 1.2 Headers,
-  they can be found at delphigl.com or on my github-repository:
-
-  https://github.com/ev1313/
+    jedi-sdl.inc: Global Conditional Definitions for JEDI-SDL cross-compilation
+    Copyright (C) 2000 - 2013 Prof. Abimbola Olowofoyeku and Tim Blume
+    See: https://github.com/ev1313/
 
   This software is provided 'as-is', without any express or implied
   warranty.  In no event will the authors be held liable for any damages
@@ -35,14 +28,6 @@
   3. This notice may not be removed or altered from any source distribution.
 }
 
-{
-  Changelog:
-  ----------
-  v. 1.63-stable; 16.09.13: since GPC isn't supported anymore, i've deleted it from here, too.
-  v. 1.22-alpha; 24.07.13: fixed some bugs. special thanks to kotai from pascalgamedevelopment.com
-  v. 1.00-alpha; 05.07.13: Initial Alpha-Release
-}
-
 {.$define Debug}           { uncomment for debugging }
 
 {$IFNDEF FPC}

Diff for: units/sdl.inc

@@ -1,6 +1,8 @@
 // based on "sdl.h"
 
 type
+  PPSDL_Init = ^PSDL_Init;
+  PSDL_Init = ^TSDL_Init;
   TSDL_Init = type cuint32;
 
 const