Add GALAlgorithm::AddShortNameAlias()

Author: rouault

Diff for: gcore/gdalalgorithm.cpp

@@ -886,6 +886,19 @@ GDALInConstructionAlgorithmArg::AddHiddenAlias(const std::string &alias)
     return *this;
 }
 
+/************************************************************************/
+/*           GDALInConstructionAlgorithmArg::AddShortNameAlias()        */
+/************************************************************************/
+
+GDALInConstructionAlgorithmArg &
+GDALInConstructionAlgorithmArg::AddShortNameAlias(char shortNameAlias)
+{
+    m_decl.AddShortNameAlias(shortNameAlias);
+    if (m_owner)
+        m_owner->AddShortNameAliasFor(this, shortNameAlias);
+    return *this;
+}
+
 /************************************************************************/
 /*             GDALInConstructionAlgorithmArg::SetPositional()          */
 /************************************************************************/
@@ -2100,6 +2113,27 @@ void GDALAlgorithm::AddAliasFor(GDALInConstructionAlgorithmArg *arg,
     }
 }
 
+/************************************************************************/
+/*                 GDALAlgorithm::AddShortNameAliasFor()                */
+/************************************************************************/
+
+//! @cond Doxygen_Suppress
+void GDALAlgorithm::AddShortNameAliasFor(GDALInConstructionAlgorithmArg *arg,
+                                         char shortNameAlias)
+{
+    std::string alias;
+    alias += shortNameAlias;
+    if (cpl::contains(m_mapShortNameToArg, alias))
+    {
+        ReportError(CE_Failure, CPLE_AppDefined,
+                    "Short name '%s' already declared.", alias.c_str());
+    }
+    else
+    {
+        m_mapShortNameToArg[alias] = arg;
+    }
+}
+
 //! @endcond
 
 /************************************************************************/
@@ -3652,6 +3686,14 @@ GDALAlgorithm::GetArgNamesForCLI() const
             opt += arg->GetShortName();
             addComma = true;
         }
+        for (char alias : arg->GetShortNameAliases())
+        {
+            if (addComma)
+                opt += ", ";
+            opt += "-";
+            opt += alias;
+            addComma = true;
+        }
         for (const std::string &alias : arg->GetAliases())
         {
             if (addComma)

Diff for: gcore/gdalalgorithm.h

@@ -559,6 +559,13 @@ class CPL_DLL GDALAlgorithmArgDecl final
         return *this;
     }
 
+    /** Declare a shortname alias.*/
+    GDALAlgorithmArgDecl &AddShortNameAlias(char shortNameAlias)
+    {
+        m_shortNameAliases.push_back(shortNameAlias);
+        return *this;
+    }
+
     /** Declare an hidden alias (i.e. not exposed in usage).
      * Must be 2 characters at least. */
     GDALAlgorithmArgDecl &AddHiddenAlias(const std::string &alias)
@@ -854,6 +861,12 @@ class CPL_DLL GDALAlgorithmArgDecl final
         return m_aliases;
     }
 
+    /** Return the shortname aliases (potentially none) */
+    inline const std::vector<char> &GetShortNameAliases() const
+    {
+        return m_shortNameAliases;
+    }
+
     /** Return the description */
     inline const std::string &GetDescription() const
     {
@@ -1112,6 +1125,7 @@ class CPL_DLL GDALAlgorithmArgDecl final
     std::map<std::string, std::vector<std::string>> m_metadata{};
     std::vector<std::string> m_aliases{};
     std::vector<std::string> m_hiddenAliases{};
+    std::vector<char> m_shortNameAliases{};
     std::vector<std::string> m_choices{};
     std::vector<std::string> m_hiddenChoices{};
     std::variant<bool, std::string, int, double, std::vector<std::string>,
@@ -1188,6 +1202,12 @@ class CPL_DLL GDALAlgorithmArg /* non-final */
         return m_decl.GetAliases();
     }
 
+    /** Alias for GDALAlgorithmArgDecl::GetShortNameAliases() */
+    inline const std::vector<char> &GetShortNameAliases() const
+    {
+        return m_decl.GetShortNameAliases();
+    }
+
     /** Alias for GDALAlgorithmArgDecl::GetDescription() */
     inline const std::string &GetDescription() const
     {
@@ -1617,6 +1637,9 @@ class CPL_DLL GDALInConstructionAlgorithmArg final : public GDALAlgorithmArg
     /** Add a non-documented alias for the argument */
     GDALInConstructionAlgorithmArg &AddHiddenAlias(const std::string &alias);
 
+    /** Add a shortname alias for the argument */
+    GDALInConstructionAlgorithmArg &AddShortNameAlias(char shortNameAlias);
+
     /** Alias for GDALAlgorithmArgDecl::SetPositional() */
     GDALInConstructionAlgorithmArg &SetPositional();
 
@@ -2475,6 +2498,10 @@ class CPL_DLL GDALAlgorithmRegistry
     //! @cond Doxygen_Suppress
     void AddAliasFor(GDALInConstructionAlgorithmArg *arg,
                      const std::string &alias);
+
+    void AddShortNameAliasFor(GDALInConstructionAlgorithmArg *arg,
+                              char shortNameAlias);
+
     void SetPositional(GDALInConstructionAlgorithmArg *arg);
 
     //! @endcond