Introduce FCITX_ADDON_FACTORY_V2 and FCITX_IMPORT_ADDON_FACTORY (#1185)

FCITX_ADDON_FACTORY_V2 will generate an entry based on addon name, so it will be unique and can be referenced more easily with static addon loader.
fcitx · Nov 18, 2024 · a8ac930 · a8ac930
1 parent 5e48134
commit a8ac930
Show file tree

Hide file tree

Showing 53 changed files with 170 additions and 68 deletions.
diff --git a/src/frontend/dbusfrontend/dbusfrontend.conf.in.in b/src/frontend/dbusfrontend/dbusfrontend.conf.in.in
@@ -6,5 +6,5 @@ Category=Frontend
 Version=@PROJECT_VERSION@
 
 [Addon/Dependencies]
-0=dbus
-
+0=core:@PROJECT_VERSION@
+1=dbus
diff --git a/src/frontend/dbusfrontend/dbusfrontend.cpp b/src/frontend/dbusfrontend/dbusfrontend.cpp
@@ -610,4 +610,4 @@ class DBusFrontendModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::DBusFrontendModuleFactory);
+FCITX_ADDON_FACTORY_V2(dbusfrontend, fcitx::DBusFrontendModuleFactory);
diff --git a/src/frontend/fcitx4frontend/fcitx4frontend.conf.in.in b/src/frontend/fcitx4frontend/fcitx4frontend.conf.in.in
@@ -6,7 +6,8 @@ Category=Frontend
 Version=@PROJECT_VERSION@
 
 [Addon/Dependencies]
-0=dbus
+0=core:@PROJECT_VERSION@
+1=dbus
 
 [Addon/OptionalDependencies]
 0=xcb

diff --git a/src/frontend/fcitx4frontend/fcitx4frontend.cpp b/src/frontend/fcitx4frontend/fcitx4frontend.cpp
@@ -366,4 +366,4 @@ class Fcitx4FrontendModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::Fcitx4FrontendModuleFactory);
+FCITX_ADDON_FACTORY_V2(fcitx4frontend, fcitx::Fcitx4FrontendModuleFactory);
diff --git a/src/frontend/ibusfrontend/ibusfrontend.conf.in.in b/src/frontend/ibusfrontend/ibusfrontend.conf.in.in
@@ -6,5 +6,6 @@ Category=Frontend
 Version=@PROJECT_VERSION@
 
 [Addon/Dependencies]
-0=dbus
+0=core:@PROJECT_VERSION@
+1=dbus
 
diff --git a/src/frontend/ibusfrontend/ibusfrontend.cpp b/src/frontend/ibusfrontend/ibusfrontend.cpp
@@ -1010,4 +1010,4 @@ class IBusFrontendModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::IBusFrontendModuleFactory);
+FCITX_ADDON_FACTORY_V2(ibusfrontend, fcitx::IBusFrontendModuleFactory);
diff --git a/src/frontend/waylandim/waylandim.conf.in.in b/src/frontend/waylandim/waylandim.conf.in.in
@@ -7,5 +7,6 @@ Version=@PROJECT_VERSION@
 Configurable=True
 
 [Addon/Dependencies]
-0=wayland:@PROJECT_VERSION@
+0=core:@PROJECT_VERSION@
+1=wayland:@PROJECT_VERSION@
 
diff --git a/src/frontend/waylandim/waylandim.cpp b/src/frontend/waylandim/waylandim.cpp
@@ -111,4 +111,4 @@ class WaylandIMModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::WaylandIMModuleFactory);
+FCITX_ADDON_FACTORY_V2(waylandim, fcitx::WaylandIMModuleFactory);
diff --git a/src/frontend/xim/xim.conf.in.in b/src/frontend/xim/xim.conf.in.in
@@ -7,7 +7,8 @@ Version=@PROJECT_VERSION@
 Configurable=True
 
 [Addon/Dependencies]
-0=xcb
+0=core:@PROJECT_VERSION@
+1=xcb
 
 # This intends to load xim after dbus & ibusfrontend, so xim is released before dbus.
 # This helps new fcitx server to become xim server properly when replacing.

diff --git a/src/frontend/xim/xim.cpp b/src/frontend/xim/xim.cpp
@@ -705,4 +705,4 @@ class XIMModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::XIMModuleFactory);
+FCITX_ADDON_FACTORY_V2(xim, fcitx::XIMModuleFactory);
diff --git a/src/im/keyboard/CMakeLists.txt b/src/im/keyboard/CMakeLists.txt
@@ -6,7 +6,6 @@ endif()
 if (TARGET Fcitx5::Module::Emoji)
     target_link_libraries(keyboard Fcitx5::Module::Emoji)
 endif()
-target_include_directories(keyboard PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>")
 configure_file(keyboard.conf.in.in keyboard.conf.in @ONLY)
 fcitx5_translate_desktop_file(${CMAKE_CURRENT_BINARY_DIR}/keyboard.conf.in keyboard.conf)
 install(FILES "${CMAKE_CURRENT_BINARY_DIR}/keyboard.conf" DESTINATION "${FCITX_INSTALL_PKGDATADIR}/addon"

diff --git a/src/im/keyboard/keyboard.conf.in.in b/src/im/keyboard/keyboard.conf.in.in
@@ -6,6 +6,9 @@ Category=InputMethod
 Version=@PROJECT_VERSION@
 Configurable=True
 
+[Addon/Dependencies]
+0=core:@PROJECT_VERSION@
+
 [Addon/OptionalDependencies]
 0=xcb
 1=spell

diff --git a/src/im/keyboard/keyboard.cpp b/src/im/keyboard/keyboard.cpp
@@ -35,6 +35,7 @@
 #include "fcitx-utils/stringutils.h"
 #include "fcitx-utils/textformatflags.h"
 #include "fcitx-utils/utf8.h"
+#include "fcitx/addoninstance.h"
 #include "fcitx/candidatelist.h"
 #include "fcitx/event.h"
 #include "fcitx/inputcontext.h"
@@ -940,3 +941,5 @@ bool KeyboardEngineState::handleBackspace(const InputMethodEntry &entry) {
 }
 
 } // namespace fcitx
+
+FCITX_ADDON_FACTORY_V2(keyboard, fcitx::KeyboardEngineFactory);
diff --git a/src/lib/fcitx/addoninstance.h b/src/lib/fcitx/addoninstance.h
@@ -199,6 +199,33 @@ class FCITXCORE_EXPORT AddonInstance {
     }                                                                          \
     }
 
+#define FCITX_ADDON_FACTORY_V2(AddonName, ClassName)                           \
+    extern "C" {                                                               \
+    FCITXCORE_EXPORT                                                           \
+    ::fcitx::AddonFactory *fcitx_addon_factory_instance_##AddonName() {        \
+        static ClassName factory;                                              \
+        return &factory;                                                       \
+    }                                                                          \
+    }
+
+#define FCITX_ADDON_FACTORY_V2_BACKWARDS(AddonName, ClassName)                 \
+    FCITX_ADDON_FACTORY_V2(AddonName, ClassName)                               \
+    FCITX_ADDON_FACTORY(ClassName)
+
+#define FCITX_IMPORT_ADDON_FACTORY(StaticRegistry, AddonName)                  \
+    extern "C" {                                                               \
+    ::fcitx::AddonFactory *fcitx_addon_factory_instance_##AddonName();         \
+    }                                                                          \
+    class StaticAddonRegistrar_##AddonName {                                   \
+    public:                                                                    \
+        StaticAddonRegistrar_##AddonName() {                                   \
+            (StaticRegistry)                                                   \
+                .emplace(FCITX_STRINGIFY(AddonName),                           \
+                         fcitx_addon_factory_instance_##AddonName());          \
+        }                                                                      \
+    };                                                                         \
+    StaticAddonRegistrar_##AddonName staticAddonRegistrar_##AddonName
+
 /// A convenient macro to obtain the addon pointer of another addon.
 #define FCITX_ADDON_DEPENDENCY_LOADER(NAME, ADDONMANAGER)                      \
     auto NAME() {                                                              \

diff --git a/src/lib/fcitx/addonloader.cpp b/src/lib/fcitx/addonloader.cpp
@@ -5,8 +5,18 @@
  *
  */
 
+#include "fcitx/addonloader.h"
+#include <exception>
+#include <memory>
+#include <string>
+#include <utility>
+#include "fcitx-utils/flags.h"
 #include "fcitx-utils/library.h"
 #include "fcitx-utils/log.h"
+#include "fcitx-utils/standardpath.h"
+#include "fcitx-utils/stringutils.h"
+#include "fcitx/addoninfo.h"
+#include "fcitx/addoninstance.h"
 #include "addonloader_p.h"
 #include "config.h"
 
@@ -41,9 +51,9 @@ AddonInstance *SharedLibraryLoader::load(const AddonInfo &info,
                 continue;
             }
             try {
-                registry_.emplace(
-                    info.uniqueName(),
-                    std::make_unique<SharedLibraryFactory>(std::move(lib)));
+                registry_.emplace(info.uniqueName(),
+                                  std::make_unique<SharedLibraryFactory>(
+                                      info, std::move(lib)));
             } catch (const std::exception &e) {
                 FCITX_ERROR() << "Failed to initialize addon factory for addon "
                               << info.uniqueName() << ". Error: " << e.what();

diff --git a/src/lib/fcitx/addonloader.h b/src/lib/fcitx/addonloader.h
@@ -4,8 +4,8 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  *
  */
-#ifndef _FCITX_ADDONRESOLVER_H_
-#define _FCITX_ADDONRESOLVER_H_
+#ifndef _FCITX_ADDONLOADER_H_
+#define _FCITX_ADDONLOADER_H_
 
 #include <string>
 #include <unordered_map>
@@ -18,7 +18,7 @@ namespace fcitx {
 class AddonFactory;
 class AddonManager;
 
-typedef std::unordered_map<std::string, AddonFactory *> StaticAddonRegistry;
+using StaticAddonRegistry = std::unordered_map<std::string, AddonFactory *>;
 
 class FCITXCORE_EXPORT AddonLoader {
 public:
@@ -29,4 +29,4 @@ class FCITXCORE_EXPORT AddonLoader {
 };
 } // namespace fcitx
 
-#endif // _FCITX_ADDONRESOLVER_H_
+#endif // _FCITX_ADDONLOADER_H_
diff --git a/src/lib/fcitx/addonloader_p.h b/src/lib/fcitx/addonloader_p.h
@@ -7,20 +7,36 @@
 #ifndef _FCITX_ADDONLOADER_P_H_
 #define _FCITX_ADDONLOADER_P_H_
 
+#include <memory>
 #include <stdexcept>
+#include <string>
+#include <string_view>
+#include <unordered_map>
+#include <utility>
 #include "fcitx-utils/library.h"
 #include "fcitx-utils/standardpath.h"
+#include "fcitx-utils/stringutils.h"
 #include "addonfactory.h"
 #include "addoninfo.h"
 #include "addoninstance.h"
 #include "addonloader.h"
 
 namespace fcitx {
 
+namespace {
+constexpr char FCITX_ADDON_FACTORY_ENTRY[] = "fcitx_addon_factory_instance";
+}
+
 class SharedLibraryFactory {
 public:
-    SharedLibraryFactory(Library lib) : library_(std::move(lib)) {
-        auto *funcPtr = library_.resolve("fcitx_addon_factory_instance");
+    SharedLibraryFactory(const AddonInfo &info, Library lib)
+        : library_(std::move(lib)) {
+        std::string v2Name = stringutils::concat(FCITX_ADDON_FACTORY_ENTRY, "_",
+                                                 info.uniqueName());
+        auto *funcPtr = library_.resolve(v2Name.data());
+        if (!funcPtr) {
+            funcPtr = library_.resolve(FCITX_ADDON_FACTORY_ENTRY);
+        }
         if (!funcPtr) {
             throw std::runtime_error(library_.error());
         }

diff --git a/src/modules/clipboard/clipboard.conf.in.in b/src/modules/clipboard/clipboard.conf.in.in
@@ -8,5 +8,6 @@ OnDemand=False
 Configurable=True
 
 [Addon/OptionalDependencies]
-0=xcb:@PROJECT_VERSION@
-1=wayland:@PROJECT_VERSION@
+0=core:@PROJECT_VERSION@
+1=xcb:@PROJECT_VERSION@
+2=wayland:@PROJECT_VERSION@
diff --git a/src/modules/clipboard/clipboard.cpp b/src/modules/clipboard/clipboard.cpp
@@ -498,4 +498,4 @@ class ClipboardModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::ClipboardModuleFactory);
+FCITX_ADDON_FACTORY_V2(clipboard, fcitx::ClipboardModuleFactory);
diff --git a/src/modules/dbus/dbus.conf.in.in b/src/modules/dbus/dbus.conf.in.in
@@ -6,7 +6,8 @@ Category=Module
 Version=@PROJECT_VERSION@
 
 [Addon/Dependencies]
-0=keyboard
+0=core:@PROJECT_VERSION@
+1=keyboard
 
 [Addon/OptionalDependencies]
 0=xcb

diff --git a/src/modules/dbus/dbusmodule.cpp b/src/modules/dbus/dbusmodule.cpp
@@ -854,4 +854,4 @@ class DBusModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::DBusModuleFactory)
+FCITX_ADDON_FACTORY_V2(dbus, fcitx::DBusModuleFactory)
diff --git a/src/modules/emoji/emoji.conf.in.in b/src/modules/emoji/emoji.conf.in.in
@@ -5,3 +5,6 @@ Library=libemoji
 Category=Module
 Version=@PROJECT_VERSION@
 OnDemand=True
+
+[Addon/Dependencies]
+0=core:@PROJECT_VERSION@
diff --git a/src/modules/emoji/emoji.cpp b/src/modules/emoji/emoji.cpp
@@ -241,4 +241,4 @@ class EmojiModuleFactory : public AddonFactory {
 
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::EmojiModuleFactory);
+FCITX_ADDON_FACTORY_V2(emoji, fcitx::EmojiModuleFactory);
diff --git a/src/modules/imselector/imselector.conf.in.in b/src/modules/imselector/imselector.conf.in.in
@@ -7,3 +7,6 @@ Library=libimselector
 Type=SharedLibrary
 OnDemand=False
 Configurable=True
+
+[Addon/Dependencies]
+0=core:@PROJECT_VERSION@
diff --git a/src/modules/imselector/imselector.cpp b/src/modules/imselector/imselector.cpp
@@ -271,4 +271,4 @@ class IMSelectorFactory : public AddonFactory {
 
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::IMSelectorFactory);
+FCITX_ADDON_FACTORY_V2(imselector, fcitx::IMSelectorFactory);
diff --git a/src/modules/notificationitem/notificationitem.conf.in.in b/src/modules/notificationitem/notificationitem.conf.in.in
@@ -8,5 +8,5 @@ Version=@PROJECT_VERSION@
 OnDemand=True
 
 [Addon/Dependencies]
-0=dbus
-
+0=core:@PROJECT_VERSION@
+1=dbus
diff --git a/src/modules/notificationitem/notificationitem.cpp b/src/modules/notificationitem/notificationitem.cpp
@@ -13,6 +13,7 @@
 #include "fcitx-utils/endian_p.h"
 #include "fcitx-utils/i18n.h"
 #include "fcitx/addonfactory.h"
+#include "fcitx/addoninstance.h"
 #include "fcitx/addonmanager.h"
 #include "fcitx/misc_p.h"
 #include "classicui_public.h"
@@ -423,4 +424,4 @@ class NotificationItemFactory : public AddonFactory {
 
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::NotificationItemFactory)
+FCITX_ADDON_FACTORY_V2(notificationitem, fcitx::NotificationItemFactory)
diff --git a/src/modules/notifications/notifications.conf.in.in b/src/modules/notifications/notifications.conf.in.in
@@ -9,4 +9,5 @@ OnDemand=True
 Configurable=True
 
 [Addon/Dependencies]
-0=dbus
+0=core:@PROJECT_VERSION@
+1=dbus
diff --git a/src/modules/notifications/notifications.cpp b/src/modules/notifications/notifications.cpp
@@ -222,4 +222,4 @@ class NotificationsModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::NotificationsModuleFactory)
+FCITX_ADDON_FACTORY_V2(notifications, fcitx::NotificationsModuleFactory)
diff --git a/src/modules/quickphrase/quickphrase.cpp b/src/modules/quickphrase/quickphrase.cpp
@@ -546,4 +546,4 @@ class QuickPhraseModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::QuickPhraseModuleFactory)
+FCITX_ADDON_FACTORY_V2(quickphrase, fcitx::QuickPhraseModuleFactory)
diff --git a/src/modules/spell/spell.conf.in.in b/src/modules/spell/spell.conf.in.in
@@ -6,3 +6,6 @@ Category=Module
 Version=@PROJECT_VERSION@
 OnDemand=True
 Configurable=True
+
+[Addon/Dependencies]
+0=core:@PROJECT_VERSION@
diff --git a/src/modules/spell/spell.cpp b/src/modules/spell/spell.cpp
@@ -111,4 +111,4 @@ Spell::hintForDisplay(const std::string &language, SpellProvider provider,
 }
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::SpellModuleFactory)
+FCITX_ADDON_FACTORY_V2(spell, fcitx::SpellModuleFactory)
diff --git a/src/modules/unicode/unicode.conf.in.in b/src/modules/unicode/unicode.conf.in.in
@@ -8,5 +8,8 @@ Version=@PROJECT_VERSION@
 OnDemand=False
 Configurable=True
 
+[Addon/Dependencies]
+0=core:@PROJECT_VERSION@
+
 [Addon/OptionalDependencies]
 0=clipboard
diff --git a/src/modules/unicode/unicode.cpp b/src/modules/unicode/unicode.cpp
@@ -471,4 +471,4 @@ class UnicodeModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::UnicodeModuleFactory);
+FCITX_ADDON_FACTORY_V2(unicode, fcitx::UnicodeModuleFactory);
diff --git a/src/modules/wayland/wayland.conf.in.in b/src/modules/wayland/wayland.conf.in.in
@@ -5,3 +5,6 @@ Library=libwayland
 Category=Module
 Version=@PROJECT_VERSION@
 Configurable=True
+
+[Addon/Dependencies]
+0=core:@PROJECT_VERSION@
diff --git a/src/modules/wayland/waylandmodule.cpp b/src/modules/wayland/waylandmodule.cpp
@@ -702,4 +702,4 @@ class WaylandModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::WaylandModuleFactory);
+FCITX_ADDON_FACTORY_V2(wayland, fcitx::WaylandModuleFactory);
diff --git a/src/modules/xcb/xcb.conf.in.in b/src/modules/xcb/xcb.conf.in.in
@@ -5,3 +5,6 @@ Library=libxcb
 Category=Module
 Version=@PROJECT_VERSION@
 Configurable=True
+
+[Addon/Dependencies]
+0=core:@PROJECT_VERSION@
diff --git a/src/modules/xcb/xcbmodule.cpp b/src/modules/xcb/xcbmodule.cpp
@@ -208,4 +208,4 @@ class XCBModuleFactory : public AddonFactory {
 };
 } // namespace fcitx
 
-FCITX_ADDON_FACTORY(fcitx::XCBModuleFactory);
+FCITX_ADDON_FACTORY_V2(xcb, fcitx::XCBModuleFactory);