refactor!: update option names for consistency

Rename CLI options to use consistent long-form names (e.g.,
--atlas=PATH, --border=SIZE, --padding=SIZE, --xml=PATH,
--algorithm=NAME, --trim-sprite, --allow-dupes, --drop-ext,
--atlas-size=SIZE, --trim-id=COUNT). Deprecate old short-form flags
and update help, config, and logging to match new option names.

Author: reybits

README.md

@@ -4,7 +4,7 @@ master      | development
 :---------: | :-----------:
 [![Build status: master](https://ci.appveyor.com/api/projects/status/lqfgod1e1pncowc2/branch/master?svg=true)](https://ci.appveyor.com/project/reybits/texture-packer/branch/master "Branch: master") ![GitHub last commit (master)](https://img.shields.io/github/last-commit/reybits/texture-packer/master) | [![Build status: development](https://ci.appveyor.com/api/projects/status/lqfgod1e1pncowc2/branch/development?svg=true)](https://ci.appveyor.com/project/reybits/texture-packer/branch/development "Branch: development") ![GitHub last commit (development)](https://img.shields.io/github/last-commit/reybits/texture-packer/development)
 
-The Texture Packer tool efficiently combines multiple images into a single optimized texture atlas, reducing memory usage and improving rendering performance. It streamlines asset management for game development and UI design by optimizing space usage with intelligent packing algorithms.
+The Texture Packer tool efficiently combines multiple images into a single optimized texture atlas, minimizing memory usage and boosting rendering performance. By leveraging advanced packing algorithms, it maximizes space utilization and streamlines asset management for game development and UI design, enabling faster load times and simplified workflow.
 
 ## Key features
 
@@ -17,17 +17,23 @@ The Texture Packer tool efficiently combines multiple images into a single optim
 ## Usage
 
 ```sh
-texpacker INPUT_IMAGE [INPUT_IMAGE] -o ATLAS
-  INPUT_IMAGE        input image name or directory separated by space
-  -o ATLAS           output atlas name (default PNG)
-  -res DESC_TEXTURE  output atlas description as XML
-  -pot               make power of two atlas
-  -trim              trim sprites
-  -overlay           draw overlay over sprite
-  -dupes             allow dupes
-  -slow              use slow method instead kd-tree
-  -b size            add border around sprites
-  -p size            add padding between sprites
+texpacker INPUT_IMAGE [INPUT_IMAGE] <OPTIONS> -o PATH
+  INPUT_IMAGE        Input image file or directory (space-separated)
+  --border=SIZE      Add border around sprites (default: 0 px)
+  --padding=SIZE     Add padding between sprites (default: 1 px)
+  --atlas=PATH       Output atlas file name (default: PNG)
+  --xml=PATH         The output file path for the atlas description in XML format
+  --prefix=PREFIX    Add prefix to texture path
+  --algorithm=NAME   Packing algorithm (kdtree or classic, default: kdtree)
+  --drop-ext         Remove file extension from sprite ID (default: false)
+  --allow-dupes      Allow duplicate sprites (default: false)
+  --keep-float       Preserve float hotspot coordinates (default: false)
+  --atlas-size=SIZE  Maximum atlas size (default: 2048 px)
+  --no-recurse       Do not search subdirectories
+  --overlay          Overlay sprites (default: false)
+  --pot              Make atlas dimensions power of two (default: false)
+  --trim-sprite      Trim transparent borders from sprites (default: false)
+  --trim-id=COUNT    Remove COUNT characters from the start of sprite IDs (default: 0)
 ```
 
 ## Download and build

src/Atlas/AtlasPacker.cpp

@@ -11,6 +11,7 @@
 #include "File.h"
 #include "Image.h"
 #include "KDTreePacker.h"
+#include "Log.h"
 #include "SimplePacker.h"
 #include "Trim.h"
 #include "Types/Types.h"
@@ -20,14 +21,18 @@
 
 std::unique_ptr<AtlasPacker> AtlasPacker::create(ImageList& imageList, const sConfig& config)
 {
-    if (config.slowMethod)
+    if (config.algorithm == sConfig::Algorithm::Classic)
     {
         std::stable_sort(imageList.begin(), imageList.end(), [](const cImage* a, const cImage* b) -> bool {
             return SimplePacker::Compare(a, b);
         });
 
         return std::make_unique<SimplePacker>(static_cast<uint32_t>(imageList.size()), config);
     }
+    else if (config.algorithm != sConfig::Algorithm::KDTree)
+    {
+        cLog::Error("Unknown algorithm, fallback to KD-Tree.");
+    }
 
     std::stable_sort(imageList.begin(), imageList.end(), [](const cImage* a, const cImage* b) -> bool {
         return KDTreePacker::Compare(a, b);

src/Atlas/AtlasSize.cpp

@@ -63,8 +63,8 @@ sSize cAtlasSize::nextSize(const sSize& size, uint32_t step) const
 
 bool cAtlasSize::isGood(const sSize& size) const
 {
-    return size.width <= m_config.maxTextureSize
-        && size.height <= m_config.maxTextureSize;
+    return size.width <= m_config.maxAtlasSize
+        && size.height <= m_config.maxAtlasSize;
 }
 
 uint32_t cAtlasSize::NextPot(uint32_t size)

src/Config.cpp

@@ -10,20 +10,58 @@
 #include "Log.h"
 #include "Utils.h"
 
+namespace
+{
+    constexpr static struct
+    {
+        const char* id;
+        const char* name;
+        sConfig::Algorithm algorithm;
+    } Algos[] = {
+        { "kdtree", "KD-Tree", sConfig::Algorithm::KDTree },
+        { "classic", "Classic", sConfig::Algorithm::Classic },
+    };
+
+} // namespace
+
 void sConfig::dump() const
 {
     // General
-    cLog::Info("Method:             {}", slowMethod ? "Classic" : "KD-Tree");
+    cLog::Info("Algorithm:          {}", ToName(algorithm));
     cLog::Info("Border:             {} px", border);
     cLog::Info("Padding:            {} px", padding);
-    cLog::Info("Max atlas size:     {} px", maxTextureSize);
+    cLog::Info("Max atlas size:     {} px", maxAtlasSize);
 
     // Features
-    cLog::Info("Keep hotspot float: {}", isEnabled(keepFloat) ? "Enabled" : "Disabled");
-    cLog::Info("Power of Two:       {}", isEnabled(pot) ? "Enabled" : "Disabled");
-    // cLog::Info("Multi-atlas:        {}", isEnabled(multi) ? "Enabled" : "Disabled");
-    cLog::Info("Trim sprites:       {}", isEnabled(trim) ? "Enabled" : "Disabled");
-    cLog::Info("Drop extension:     {}", isEnabled(dropExt) ? "Enabled" : "Disabled");
-    cLog::Info("Allow duplicates:   {}", isEnabled(alowDupes) ? "Enabled" : "Disabled");
-    cLog::Info("Overlay:            {}", isEnabled(overlay) ? "Enabled" : "Disabled");
+    cLog::Info("Keep hotspot float: {}", toString(keepFloat));
+    cLog::Info("Power of Two:       {}", toString(pot));
+    // cLog::Info("Multi-atlas:        {}", toString(multi));
+    cLog::Info("Trim sprites:       {}", toString(trimSprite));
+    cLog::Info("Drop extension:     {}", toString(dropExt));
+    cLog::Info("Allow duplicates:   {}", toString(alowDupes));
+    cLog::Info("Overlay:            {}", toString(overlay));
+}
+
+sConfig::Algorithm sConfig::ToAlgorithm(const char* str)
+{
+    for (const auto& m : Algos)
+    {
+        if (::strcmp(str, m.id) == 0)
+        {
+            return m.algorithm;
+        }
+    }
+    return sConfig::Algorithm::KDTree;
+}
+
+const char* sConfig::ToName(Algorithm algo)
+{
+    for (const auto& m : Algos)
+    {
+        if (m.algorithm == algo)
+        {
+            return m.name;
+        }
+    }
+    return "Unknown";
 }

src/Config.h

@@ -15,14 +15,22 @@ struct sConfig
     uint32_t border = 0;
     uint32_t padding = 1;
     bool pot = false;
-    bool trim = false;
+    bool trimSprite = false;
     bool multi = false;
     bool keepFloat = false;
     bool overlay = false;
     bool alowDupes = false;
-    bool slowMethod = false;
+    enum class Algorithm
+    {
+        KDTree,
+        Classic
+    };
+    Algorithm algorithm = Algorithm::KDTree;
     bool dropExt = false;
-    uint32_t maxTextureSize = 2048u;
+    uint32_t maxAtlasSize = 2048u;
 
     void dump() const;
+
+    static Algorithm ToAlgorithm(const char* str);
+    static const char* ToName(Algorithm algo);
 };

src/Image.cpp

@@ -86,7 +86,7 @@ bool cImage::load(const char* path, uint32_t trimPath, cTrim* trim)
     m_spriteId = TrimPath(path, trimPath);
     if (m_spriteId.length() == 0)
     {
-        cLog::Error("Trim value too big for path '{}'.", path);
+        cLog::Error("Trim value '{}' too big for path '{}'.", trimPath, path);
         return false;
     }
 

src/ImageList.cpp

@@ -16,12 +16,12 @@
 #include "Trim.h"
 #include "Utils.h"
 
-#include <sstream>
+#include <fmt/core.h>
 
 cImageList::cImageList(const sConfig& config, uint32_t reserve)
     : m_config(config)
     , m_size(config)
-    , m_trim(config.trim
+    , m_trim(config.trimSprite
                  ? new cTrim()
                  : nullptr)
 {
@@ -105,7 +105,7 @@ bool cImageList::doPacking(const char* desiredAtlasName, const char* outputResNa
             {
                 auto outputAtlasName = saver.getAtlasName();
 
-                // write resource file
+                // write XML
                 if (outputResName != nullptr)
                 {
                     std::string atlasName = resPathPrefix != nullptr
@@ -117,10 +117,14 @@ bool cImageList::doPacking(const char* desiredAtlasName, const char* outputResNa
                     if (file.open(outputResName, "w"))
                     {
                         writeHeader(file);
-
                         packer->generateResFile(file, atlasName);
-
                         writeFooter(file);
+
+                        cLog::Info("Atlas description '{}' was created.", outputResName);
+                    }
+                    else
+                    {
+                        cLog::Error("Error writing atlas description '{}'.", outputResName);
                     }
                 }
 
@@ -129,7 +133,7 @@ bool cImageList::doPacking(const char* desiredAtlasName, const char* outputResNa
                 auto percent = static_cast<uint32_t>(100.0f * spritesArea / atlasArea);
 
                 cLog::Info("Atlas '{}' ({} x {}, fill: {}%) was created in {:.2f} ms.",
-                           outputAtlasName.c_str(),
+                           outputAtlasName,
                            atlasSize.width, atlasSize.height,
                            percent,
                            (getCurrentTime() - startTime) * 0.001f);
@@ -187,15 +191,12 @@ bool cImageList::prepareAtlas(AtlasPacker* packer, sSize& atlasSize)
 
 void cImageList::writeHeader(cFile& file)
 {
-    std::stringstream out;
-    out << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
-    out << "<atlas>\n";
-    file.write((void*)out.str().c_str(), out.str().length());
+    std::string out = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<atlas>\n";
+    file.write(out.c_str(), out.length());
 }
 
 void cImageList::writeFooter(cFile& file)
 {
-    std::stringstream out;
-    out << "</atlas>\n";
-    file.write((void*)out.str().c_str(), out.str().length());
+    std::string out = "</atlas>\n";
+    file.write(out.c_str(), out.length());
 }

src/Utils.cpp

@@ -62,11 +62,20 @@ const char* formatNum(int num, char delimiter)
     return Out;
 }
 
-const char* isEnabled(bool enabled)
+const char* toString(bool enabled)
 {
     return enabled ? "enabled" : "disabled";
 }
 
+bool isOption(const char* arg, const char* name)
+{
+    if (::strncmp(arg, "--", 2) != 0)
+    {
+        return ::strcmp(arg, name) == 0;
+    }
+    return ::strncmp(arg, name, ::strlen(name)) == 0;
+}
+
 bool shiftArg(int argc, char* argv[], int& idx, const char*& value)
 {
     if (idx + 1 < argc)

src/Utils.h

@@ -14,7 +14,9 @@ void deprecatedOption(const char* oldArg, const char* newArg, const char* remove
 
 uint64_t getCurrentTime();
 const char* formatNum(int num, char delimiter = '\'');
-const char* isEnabled(bool enabled);
+const char* toString(bool enabled);
+
+bool isOption(const char* arg, const char* name);
 
 bool shiftArg(int argc, char* argv[], int& idx, const char*& value);
 bool shiftArg(int argc, char* argv[], int& idx, uint32_t& value);