Add Selection info to completion

Author: levinli303

src/celengine/CMakeLists.txt

@@ -11,6 +11,8 @@ set(CELENGINE_SOURCES
   boundaries.h
   category.cpp
   category.h
+  completion.cpp
+  completion.h
   console.cpp
   console.h
   constellation.cpp

src/celengine/body.cpp

@@ -1127,7 +1127,7 @@ PlanetarySystem::find(std::string_view _name, bool deepSearch, bool i18n) const
 }
 
 void
-PlanetarySystem::getCompletion(std::vector<std::string>& completion,
+PlanetarySystem::getCompletion(std::vector<celestia::engine::Completion>& completion,
                                std::string_view _name,
                                bool deepSearch) const
 {
@@ -1138,13 +1138,13 @@ PlanetarySystem::getCompletion(std::vector<std::string>& completion,
 
         if (UTF8StartsWith(alias, _name))
         {
-            completion.push_back(alias);
+            completion.emplace_back(alias, Selection(index.second));
         }
         else
         {
             std::string lname = D_(alias.c_str());
             if (lname != alias && UTF8StartsWith(lname, _name))
-                completion.push_back(lname);
+                completion.emplace_back(lname, Selection(index.second));
         }
     }
 

src/celengine/body.h

@@ -10,6 +10,7 @@
 #pragma once
 
 #include <celengine/astroobj.h>
+#include <celengine/completion.h>
 #include <celengine/surface.h>
 #include <celengine/star.h>
 #include <celengine/location.h>
@@ -64,7 +65,7 @@ class PlanetarySystem
     };
 
     Body* find(std::string_view, bool deepSearch = false, bool i18n = false) const;
-    void getCompletion(std::vector<std::string>& completion, std::string_view _name, bool rec = true) const;
+    void getCompletion(std::vector<celestia::engine::Completion>& completion, std::string_view _name, bool rec = true) const;
 
 private:
     void addBodyToNameIndex(Body* body);

src/celengine/completion.cpp

@@ -0,0 +1,37 @@
+// completion.cpp
+//
+// Copyright (C) 2024-present, the Celestia Development Team
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License
+// as published by the Free Software Foundation; either version 2
+// of the License, or (at your option) any later version.
+
+#include "completion.h"
+
+namespace celestia::engine
+{
+
+std::string Completion::getName() const
+{
+    return name;
+}
+
+Selection Completion::getSelection() const
+{
+    return std::visit([this](auto& arg)
+    {
+        using T = std::decay_t<decltype(arg)>;
+        if constexpr (std::is_same_v<T, Selection>)
+        {
+            return arg;
+        }
+        else
+        {
+            static_assert(std::is_same_v<T, std::function<Selection()>>);
+            return arg();
+        }
+    }, selection);
+}
+
+}

src/celengine/completion.h

@@ -0,0 +1,36 @@
+// completion.h
+//
+// Copyright (C) 2024-present, the Celestia Development Team
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License
+// as published by the Free Software Foundation; either version 2
+// of the License, or (at your option) any later version.
+
+#pragma once
+
+#include <functional>
+#include <string>
+#include <variant>
+#include <celengine/selection.h>
+
+namespace celestia::engine
+{
+
+class Completion
+{
+public:
+    Completion(const std::string& name, const std::variant<Selection, std::function<Selection()>>& selection) :
+        name(name),
+        selection(selection)
+    {}
+
+    std::string getName() const;
+    Selection getSelection() const;
+
+private:
+    std::string name;
+    std::variant<Selection, std::function<Selection()>> selection;
+};
+
+}

src/celengine/dsodb.cpp

@@ -68,11 +68,23 @@ DSODatabase::find(std::string_view name, bool i18n) const
 }
 
 void
-DSODatabase::getCompletion(std::vector<std::string>& completion, std::string_view name) const
+DSODatabase::getCompletion(std::vector<celestia::engine::Completion>& completion, std::string_view name) const
 {
     // only named DSOs are supported by completion.
     if (!name.empty())
-        m_namesDB->getCompletion(completion, name);
+    {
+        std::vector<std::pair<std::string, AstroCatalog::IndexNumber>> namesWithIndices;
+        m_namesDB->getCompletion(namesWithIndices, name);
+
+        for (const auto& [dsoName, index] : namesWithIndices)
+        {
+            auto capturedIndex = index;
+            completion.emplace_back(dsoName, [this, capturedIndex]
+            {
+                return Selection(find(capturedIndex));
+            });
+        }
+    }
 }
 
 std::string

src/celengine/dsodb.h

@@ -21,7 +21,8 @@
 #include <Eigen/Core>
 #include <Eigen/Geometry>
 
-#include "dsooctree.h"
+#include <celengine/completion.h>
+#include <celengine/dsooctree.h>
 
 class DeepSkyObject;
 class DSODatabaseBuilder;
@@ -49,7 +50,7 @@ class DSODatabase
     DeepSkyObject* find(const AstroCatalog::IndexNumber catalogNumber) const;
     DeepSkyObject* find(std::string_view, bool i18n) const;
 
-    void getCompletion(std::vector<std::string>&, std::string_view) const;
+    void getCompletion(std::vector<celestia::engine::Completion>&, std::string_view) const;
 
     void findVisibleDSOs(celestia::engine::DSOHandler& dsoHandler,
                          const Eigen::Vector3d& obsPosition,

src/celengine/name.cpp

@@ -82,20 +82,20 @@ NameDatabase::getFinalNameIter() const
 }
 
 void
-NameDatabase::getCompletion(std::vector<std::string>& completion, std::string_view name) const
+NameDatabase::getCompletion(std::vector<std::pair<std::string, AstroCatalog::IndexNumber>>& completion, std::string_view name) const
 {
     std::string name2 = ReplaceGreekLetter(name);
-    for (const auto &[n, _] : nameIndex)
+    for (const auto &[n, index] : nameIndex)
     {
         if (UTF8StartsWith(n, name2, true))
-            completion.push_back(n);
+            completion.emplace_back(n, index);
     }
 
 #ifdef ENABLE_NLS
-    for (const auto &[n, _] : localizedNameIndex)
+    for (const auto &[n, index] : localizedNameIndex)
     {
         if (UTF8StartsWith(n, name2, true))
-            completion.push_back(n);
+            completion.emplace_back(n, index);
     }
 #endif
 }

src/celengine/name.h

@@ -39,7 +39,7 @@ class NameDatabase
     NumberIndex::const_iterator getFirstNameIter(AstroCatalog::IndexNumber catalogNumber) const;
     NumberIndex::const_iterator getFinalNameIter() const;
 
-    void getCompletion(std::vector<std::string>& completion, std::string_view name) const;
+    void getCompletion(std::vector<std::pair<std::string, AstroCatalog::IndexNumber>>& completion, std::string_view name) const;
 
 private:
     NameIndex   nameIndex;

src/celengine/simulation.cpp

@@ -457,7 +457,7 @@ Selection Simulation::findObjectFromPath(std::string_view s, bool i18n) const
 }
 
 
-void Simulation::getObjectCompletion(std::vector<std::string>& completion,
+void Simulation::getObjectCompletion(std::vector<celestia::engine::Completion>& completion,
                                      std::string_view s,
                                      bool withLocations) const
 {
@@ -485,7 +485,7 @@ void Simulation::getObjectCompletion(std::vector<std::string>& completion,
     universe->getCompletionPath(completion, s, {path, nPathEntries}, withLocations);
 
     std::sort(completion.begin(), completion.end(),
-              [](const std::string &s1, const std::string &s2) { return strnatcmp(s1, s2) < 0; });
+              [](const celestia::engine::Completion &s1, const celestia::engine::Completion &s2) { return strnatcmp(s1.getName(), s2.getName()) < 0; });
 }