refactor: update API signatures and docs for clarity

reybits · reybits · commit 5393d5341361 · 2025-12-02T19:40:24.000+01:00
- Make constructors explicit in several classes for safer conversions.
- Add default initialization for sRect in cKDNode.
- Mark destructors as override where appropriate.
- Change cFile::write to take const void* for correctness.
- Update stb README: fix typos, clarify authorship, and reflect latest
  versions and file names.
diff --git a/src/Atlas/AtlasPacker.cpp b/src/Atlas/AtlasPacker.cpp
@@ -245,7 +245,7 @@ bool AtlasPacker::generateResFile(cFile& file, const std::string& atlasName)
                            hotspot.x, hotspot.y);
     }
 
-    file.write((void*)out.c_str(), out.length());
+    file.write(out.c_str(), out.length());
 
     return true;
 }
diff --git a/src/Atlas/AtlasSize.h b/src/Atlas/AtlasSize.h
@@ -15,7 +15,7 @@ struct sConfig;
 class cAtlasSize final
 {
 public:
-    cAtlasSize(const sConfig& config);
+    explicit cAtlasSize(const sConfig& config);
 
     void addRect(const sSize& size);
     uint32_t getArea() const;
diff --git a/src/Atlas/KDNode.h b/src/Atlas/KDNode.h
@@ -38,5 +38,5 @@ class cKDNode final
     cKDNode* m_childA = nullptr; // left or top
     cKDNode* m_childB = nullptr; // right or bottom
 
-    sRect m_rect;
+    sRect m_rect{ 0u, 0u, 0u, 0u };
 };
diff --git a/src/Atlas/KDTreePacker.h b/src/Atlas/KDTreePacker.h
@@ -17,8 +17,8 @@ class cKDNode;
 class KDTreePacker final : public AtlasPacker
 {
 public:
-    KDTreePacker(const sConfig& config);
-    ~KDTreePacker();
+    explicit KDTreePacker(const sConfig& config);
+    ~KDTreePacker() override;
 
     static bool Compare(const cImage* a, const cImage* b);
 
diff --git a/src/Atlas/SimplePacker.h b/src/Atlas/SimplePacker.h
@@ -17,7 +17,7 @@ class SimplePacker final : public AtlasPacker
 {
 public:
     SimplePacker(uint32_t count, const sConfig& config);
-    ~SimplePacker();
+    ~SimplePacker() override;
 
     static bool Compare(const cImage* a, const cImage* b);
 
diff --git a/src/File.cpp b/src/File.cpp
@@ -59,7 +59,7 @@ uint32_t cFile::read(void* ptr, uint32_t size) const
     return 0u;
 }
 
-uint32_t cFile::write(void* ptr, uint32_t size) const
+uint32_t cFile::write(const void* ptr, uint32_t size) const
 {
     if (m_file != nullptr)
     {
diff --git a/src/File.h b/src/File.h
@@ -24,7 +24,7 @@ class cFile final
 
     uint32_t seek(uint32_t offset, int whence) const;
     uint32_t read(void* ptr, uint32_t size) const;
-    uint32_t write(void* ptr, uint32_t size) const;
+    uint32_t write(const void* ptr, uint32_t size) const;
 
     long getSize() const
     {
diff --git a/src/Trim.h b/src/Trim.h
@@ -44,7 +44,7 @@ class cTrim
 class cTrimRigthBottom final : public cTrim
 {
 public:
-    cTrimRigthBottom(const sConfig& config);
+    explicit cTrimRigthBottom(const sConfig& config);
 
     virtual bool trim(const char* path, const cBitmap& input) override;
 
diff --git a/src/stb/README.md b/src/stb/README.md
@@ -5,27 +5,29 @@ stb
 
 single-file public domain (or MIT licensed) libraries for C/C++
 
+# This project discusses security-relevant bugs in public in Github Issues and Pull Requests, and it may take significant time for security fixes to be implemented or merged. If this poses an unreasonable risk to your project, do not use stb libraries.
+
 Noteworthy:
 
 * image loader: [stb_image.h](stb_image.h)
 * image writer: [stb_image_write.h](stb_image_write.h)
-* image resizer: [stb_image_resize.h](stb_image_resize.h)
+* image resizer: [stb_image_resize2.h](stb_image_resize2.h)
 * font text rasterizer: [stb_truetype.h](stb_truetype.h)
 * typesafe containers: [stb_ds.h](stb_ds.h)
 
-Most libraries by stb, except: stb_dxt by Fabian "ryg" Giesen, stb_image_resize
-by Jorge L. "VinoBS" Rodriguez, and stb_sprintf by Jeff Roberts.
+Most libraries by stb, except: stb_dxt by Fabian "ryg" Giesen, original stb_image_resize
+by Jorge L. "VinoBS" Rodriguez, and stb_image_resize2 and stb_sprintf by Jeff Roberts.
 
 <a name="stb_libs"></a>
 
-library    | lastest version | category | LoC | description
+library    | latest version | category | LoC | description
 --------------------- | ---- | -------- | --- | --------------------------------
 **[stb_vorbis.c](stb_vorbis.c)** | 1.22 | audio | 5584 | decode ogg vorbis files from file/memory to float/16-bit signed output
 **[stb_hexwave.h](stb_hexwave.h)** | 0.5 | audio | 680 | audio waveform synthesizer
-**[stb_image.h](stb_image.h)** | 2.28 | graphics | 7987 | image loading/decoding from file/memory: JPG, PNG, TGA, BMP, PSD, GIF, HDR, PIC
-**[stb_truetype.h](stb_truetype.h)** | 1.26 | graphics | 5077 | parse, decode, and rasterize characters from truetype fonts
+**[stb_image.h](stb_image.h)** | 2.30 | graphics | 7988 | image loading/decoding from file/memory: JPG, PNG, TGA, BMP, PSD, GIF, HDR, PIC
+**[stb_truetype.h](stb_truetype.h)** | 1.26 | graphics | 5079 | parse, decode, and rasterize characters from truetype fonts
 **[stb_image_write.h](stb_image_write.h)** | 1.16 | graphics | 1724 | image writing to disk: PNG, TGA, BMP
-**[stb_image_resize.h](stb_image_resize.h)** | 0.97 | graphics | 2634 | resize images larger/smaller with good quality
+**[stb_image_resize2.h](stb_image_resize2.h)** | 2.16 | graphics | 10650 | resize images larger/smaller with good quality
 **[stb_rect_pack.h](stb_rect_pack.h)** | 1.01 | graphics | 623 | simple 2D rectangle packer with decent quality
 **[stb_perlin.h](stb_perlin.h)** | 0.5 | graphics | 428 | perlin's revised simplex noise w/ different seeds
 **[stb_ds.h](stb_ds.h)** | 0.67 | utility | 1895 | typesafe dynamic array and hash tables for C, will compile in C++
@@ -36,14 +38,14 @@ library    | lastest version | category | LoC | description
 **[stb_easy_font.h](stb_easy_font.h)** | 1.1 | 3D&nbsp;graphics | 305 | quick-and-dirty easy-to-deploy bitmap font for printing frame rate, etc
 **[stb_tilemap_editor.h](stb_tilemap_editor.h)** | 0.42 | game&nbsp;dev | 4187 | embeddable tilemap editor
 **[stb_herringbone_wa...](stb_herringbone_wang_tile.h)** | 0.7 | game&nbsp;dev | 1221 | herringbone Wang tile map generator
-**[stb_c_lexer.h](stb_c_lexer.h)** | 0.12 | parsing | 940 | simplify writing parsers for C-like languages
+**[stb_c_lexer.h](stb_c_lexer.h)** | 0.12 | parsing | 941 | simplify writing parsers for C-like languages
 **[stb_divide.h](stb_divide.h)** | 0.94 | math | 433 | more useful 32-bit modulus e.g. "euclidean divide"
 **[stb_connected_comp...](stb_connected_components.h)** | 0.96 | misc | 1049 | incrementally compute reachability on grids
 **[stb_leakcheck.h](stb_leakcheck.h)** | 0.6 | misc | 194 | quick-and-dirty malloc/free leak-checking
 **[stb_include.h](stb_include.h)** | 0.02 | misc | 295 | implement recursive #include support, particularly for GLSL
 
 Total libraries: 21
-Total lines of C code: 43117
+Total lines of C code: 51137
 
 
 FAQ

Original file line number	Diff line number	Diff line change
`@@ -245,7 +245,7 @@ bool AtlasPacker::generateResFile(cFile& file, const std::string& atlasName)`
`245`	`245`	`hotspot.x, hotspot.y);`
`246`	`246`	`}`
`247`	`247`
`248`		`- file.write((void*)out.c_str(), out.length());`
	`248`	`+ file.write(out.c_str(), out.length());`
`249`	`249`
`250`	`250`	`return true;`
`251`	`251`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ struct sConfig;`
`15`	`15`	`class cAtlasSize final`
`16`	`16`	`{`
`17`	`17`	`public:`
`18`		`- cAtlasSize(const sConfig& config);`
	`18`	`+ explicit cAtlasSize(const sConfig& config);`
`19`	`19`
`20`	`20`	`void addRect(const sSize& size);`
`21`	`21`	`uint32_t getArea() const;`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,8 @@ class cKDNode;`
`17`	`17`	`class KDTreePacker final : public AtlasPacker`
`18`	`18`	`{`
`19`	`19`	`public:`
`20`		`- KDTreePacker(const sConfig& config);`
`21`		`- ~KDTreePacker();`
	`20`	`+ explicit KDTreePacker(const sConfig& config);`
	`21`	`+ ~KDTreePacker() override;`
`22`	`22`
`23`	`23`	`static bool Compare(const cImage* a, const cImage* b);`
`24`	`24`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ class SimplePacker final : public AtlasPacker`
`17`	`17`	`{`
`18`	`18`	`public:`
`19`	`19`	`SimplePacker(uint32_t count, const sConfig& config);`
`20`		`- ~SimplePacker();`
	`20`	`+ ~SimplePacker() override;`
`21`	`21`
`22`	`22`	`static bool Compare(const cImage* a, const cImage* b);`
`23`	`23`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ uint32_t cFile::read(void* ptr, uint32_t size) const`
`59`	`59`	`return 0u;`
`60`	`60`	`}`
`61`	`61`
`62`		`-uint32_t cFile::write(void* ptr, uint32_t size) const`
	`62`	`+uint32_t cFile::write(const void* ptr, uint32_t size) const`
`63`	`63`	`{`
`64`	`64`	`if (m_file != nullptr)`
`65`	`65`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class cFile final`
`24`	`24`
`25`	`25`	`uint32_t seek(uint32_t offset, int whence) const;`
`26`	`26`	`uint32_t read(void* ptr, uint32_t size) const;`
`27`		`- uint32_t write(void* ptr, uint32_t size) const;`
	`27`	`+ uint32_t write(const void* ptr, uint32_t size) const;`
`28`	`28`
`29`	`29`	`long getSize() const`
`30`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ class cTrim`
`44`	`44`	`class cTrimRigthBottom final : public cTrim`
`45`	`45`	`{`
`46`	`46`	`public:`
`47`		`- cTrimRigthBottom(const sConfig& config);`
	`47`	`+ explicit cTrimRigthBottom(const sConfig& config);`
`48`	`48`
`49`	`49`	`virtual bool trim(const char* path, const cBitmap& input) override;`
`50`	`50`