Skip to content

WIP: Maliit 3 major refactoring #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
dobey wants to merge 13 commits into
base: master
Choose a base branch
from
Draft

WIP: Maliit 3 major refactoring #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8eae0f1
Remove MImPluginSettingsInfo and AbstractPluginSetting
dobey May 13, 2022
beb3bc9
Drop the setLanguage API as keyboard language is plugin side
dobey May 17, 2022
177ad9e
Remove MaliitSettingsEntry usage and settingdata.{cpp,h}
dobey May 17, 2022
b9069a2
Remove SettingEntryType
dobey May 18, 2022
6ce3506
Remove toolbar API and docs
dobey May 24, 2022
cfaaec2
Remove attribute extensions API
dobey Jun 7, 2022
1454967
Remove extended attribute API
dobey Jun 8, 2022
25cb39a
glib: Remove the plugin settings API from maliit-glib
dobey Jun 13, 2022
248c2de
glib: Remove AttributeExtension API from maliit-glib
dobey Jun 14, 2022
489a8e2
tests: Fix the mimpluginmanager plugin switcher test
dobey Jun 15, 2022
ac95819
Separate the library version from the project version
dobey Jun 16, 2022
e81c810
Add FormattedNumberContentType separate from NumberContentType
dobey Jun 16, 2022
57b17c2
Remove MImExtensionEvent and related API
dobey Jun 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 9 additions & 65 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
cmake_minimum_required(VERSION 3.5)

project(maliit-framework VERSION 2.3.0)
project(maliit-framework VERSION 2.99.0)
set(LIBRARY_VERSION 3.0.0)

# Build options

Expand Down Expand Up @@ -56,9 +57,7 @@ include_directories(src common)

add_library(maliit-common STATIC
common/maliit/namespace.h
common/maliit/namespaceinternal.h
common/maliit/settingdata.cpp
common/maliit/settingdata.h)
common/maliit/namespaceinternal.h)
target_link_libraries(maliit-common Qt5::Core)
target_include_directories(maliit-common PUBLIC common)

Expand Down Expand Up @@ -91,7 +90,7 @@ if(enable-wayland)
endif()

set_source_files_properties(dbus_interfaces/minputmethodcontext1interface.xml dbus_interfaces/minputmethodserver1interface.xml
PROPERTIES INCLUDE maliit/settingdata.h)
PROPERTIES INCLUDE maliit/namespace.h)

qt5_add_dbus_adaptor(CONNECTION_SOURCES dbus_interfaces/minputmethodcontext1interface.xml dbusserverconnection.h DBusServerConnection)
qt5_add_dbus_adaptor(CONNECTION_SOURCES dbus_interfaces/minputmethodserver1interface.xml dbusinputcontextconnection.h DBusInputContextConnection)
Expand All @@ -114,13 +113,6 @@ set(PLUGINS_SOURCES
src/maliit/plugins/abstractinputmethod.h
src/maliit/plugins/abstractinputmethodhost.cpp
src/maliit/plugins/abstractinputmethodhost.h
src/maliit/plugins/abstractpluginsetting.h
src/maliit/plugins/attributeextension.cpp
src/maliit/plugins/attributeextension.h
src/maliit/plugins/attributeextension_p.h
src/maliit/plugins/extensionevent.cpp
src/maliit/plugins/extensionevent.h
src/maliit/plugins/extensionevent_p.h
src/maliit/plugins/inputmethodplugin.h
src/maliit/plugins/keyoverride.cpp
src/maliit/plugins/keyoverride.h
Expand All @@ -131,11 +123,6 @@ set(PLUGINS_SOURCES
src/maliit/plugins/plugindescription.h
src/maliit/plugins/subviewdescription.cpp
src/maliit/plugins/subviewdescription.h
src/maliit/plugins/updateevent.cpp
src/maliit/plugins/updateevent.h
src/maliit/plugins/updateevent_p.h
src/maliit/plugins/updatereceiver.cpp
src/maliit/plugins/updatereceiver.h
src/maliit/standaloneinputmethod.cpp
src/maliit/standaloneinputmethod.h
src/maliit/standaloneinputmethodhost.cpp
Expand All @@ -152,10 +139,6 @@ set(PLUGINS_SOURCES
src/abstractplatform.h
src/logging.cpp
src/logging.h
src/mattributeextensionid.cpp
src/mattributeextensionid.h
src/mattributeextensionmanager.cpp
src/mattributeextensionmanager.h
src/mimhwkeyboardtracker.h
src/mimonscreenplugins.cpp
src/mimonscreenplugins.h
Expand All @@ -174,8 +157,6 @@ set(PLUGINS_SOURCES
src/mimsubviewoverride.h
src/minputmethodhost.cpp
src/minputmethodhost.h
src/msharedattributeextensionmanager.cpp
src/msharedattributeextensionmanager.h
src/unknownplatform.cpp
src/unknownplatform.h
src/windowdata.cpp
Expand Down Expand Up @@ -215,35 +196,20 @@ target_link_libraries(maliit-plugins PRIVATE maliit-common maliit-connection ${P
target_link_libraries(maliit-plugins PUBLIC Qt5::Core Qt5::Gui Qt5::Quick)
target_include_directories(maliit-plugins PRIVATE ${PLUGINS_INCLUDE_DIRS})

set_target_properties(maliit-plugins PROPERTIES SOVERSION ${PROJECT_VERSION_MAJOR}
VERSION ${PROJECT_VERSION}
set_target_properties(maliit-plugins PROPERTIES
VERSION ${LIBRARY_VERSION}
EXPORT_NAME Maliit::Plugins)

if(enable-glib)
find_package(GLib2)
find_package(GIO)

set(GLIB_SOURCES
maliit-glib/maliitattributeextension.c
maliit-glib/maliitattributeextension.h
maliit-glib/maliitattributeextensionprivate.h
maliit-glib/maliitattributeextensionregistry.c
maliit-glib/maliitattributeextensionregistry.h
maliit-glib/maliitbus.c
maliit-glib/maliitbus.h
maliit-glib/maliitbusprivate.h
maliit-glib/maliitinputmethod.c
maliit-glib/maliitinputmethod.h
maliit-glib/maliitpluginsettings.c
maliit-glib/maliitpluginsettings.h
maliit-glib/maliitpluginsettingsprivate.h
maliit-glib/maliitsettingdata.c
maliit-glib/maliitsettingdata.h
maliit-glib/maliitsettingsentry.c
maliit-glib/maliitsettingsentry.h
maliit-glib/maliitsettingsentryprivate.h
maliit-glib/maliitsettingsmanager.c
maliit-glib/maliitsettingsmanager.h)
maliit-glib/maliitinputmethod.h)

set_source_files_properties(maliit-glib/maliitmarshallers.list
PROPERTIES PREFIX maliit_marshal)
Expand All @@ -269,14 +235,13 @@ if(enable-glib)
add_library(maliit-glib SHARED ${GLIB_SOURCES} ${GLIB_HEADER})
target_include_directories(maliit-glib PUBLIC ${GIO_INCLUDE_DIRS})
target_link_libraries(maliit-glib ${GIO_LIBRARIES})
set_target_properties(maliit-glib PROPERTIES SOVERSION ${PROJECT_VERSION_MAJOR}
VERSION ${PROJECT_VERSION}
set_target_properties(maliit-glib PROPERTIES
VERSION ${LIBRARY_VERSION}
EXPORT_NAME Maliit::GLib)
endif()

add_definitions(-DMALIIT_FRAMEWORK_USE_INTERNAL_API
-DMALIIT_PLUGINS_DATA_DIR="${CMAKE_INSTALL_FULL_DATADIR}/maliit/plugins"
-DMALIIT_EXTENSIONS_DIR="${CMAKE_INSTALL_FULL_DATADIR}/maliit-framework/extensions"
-DMALIIT_CONFIG_ROOT="/maliit/"
-DMALIIT_PLUGINS_DIR="${CMAKE_INSTALL_FULL_LIBDIR}/maliit/plugins"
-DMALIIT_DEFAULT_HW_PLUGIN="libmaliit-keyboard-plugin.so"
Expand Down Expand Up @@ -494,7 +459,6 @@ if(enable-tests)
add_library(test-utils STATIC
tests/utils/core-utils.cpp
tests/utils/core-utils.h
tests/utils/gui-utils.cpp
tests/utils/gui-utils.h)
target_link_libraries(test-utils PUBLIC Qt5::Core Qt5::Gui Qt5::Test maliit-connection)
target_include_directories(test-utils INTERFACE tests/utils)
Expand Down Expand Up @@ -527,7 +491,6 @@ if(enable-tests)
endfunction()

create_test(sanitychecks)
create_test(ut_mattributeextensionmanager)
create_test(ut_mimonscreenplugins)
create_test(ut_mimpluginmanager ${DUMMY_PLUGINS})
create_test(ut_mimpluginmanagerconfig)
Expand All @@ -547,29 +510,10 @@ if(enable-tests)
TESTDATA_PATH=${CMAKE_SOURCE_DIR}/tests
QT_QPA_PLATFORM=minimal)

if(enable-glib)
add_executable(ut_maliit_glib_settings
tests/ut_maliit_glib_settings/ut_maliit_glib_settings.c
tests/ut_maliit_glib_settings/mockmaliitserver.c
tests/ut_maliit_glib_settings/mockmaliitserver.h)
target_link_libraries(ut_maliit_glib_settings GLib2::GLib GLib2::GIO maliit-glib)

add_test(ut_maliit_glib_settings ut_maliit_glib_settings)
if(install-tests)
install(TARGETS ut_maliit_glib_settings DESTINATION ${CMAKE_INSTALL_LIBDIR}/maliit-framework-tests/ut_maliit_glib_settings)
endif()
endif()

if(install-tests)
install(FILES tests/qmlplugin/helloworld.qml
DESTINATION ${CMAKE_INSTALL_LIBDIR}/maliit-framework-tests/plugins/qml/helloworld)

install(TARGETS ${DUMMY_PLUGINS} DESTINATION ${CMAKE_INSTALL_LIBDIR}/maliit-framework-tests/plugins)
install(DIRECTORY tests/ut_mattributeextensionmanager/
DESTINATION ${CMAKE_INSTALL_LIBDIR}/maliit-framework-tests/ut_mattributeextensionmanager
FILES_MATCHING PATTERN "*.xml")
install(DIRECTORY tests/ut_mimpluginmanager/
DESTINATION ${CMAKE_INSTALL_LIBDIR}/maliit-framework-tests/ut_mimpluginmanager
FILES_MATCHING PATTERN "*.xml")
endif()
endif()
37 changes: 3 additions & 34 deletions common/maliit/namespace.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ namespace Maliit {
//! only integer numbers allowed
NumberContentType,

//! only numbers and formatted characters
FormattedNumberContentType,
Copy link
Contributor

@pvuorela pvuorela Aug 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pondering if we should just use Qt::inputMethodHint which offers more types and hint combinations.

On the history side not entirely sure did we even add this before Qt got that hint of its own.

Copy link
Contributor Author

@dobey dobey Aug 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how much sense it makes, because the Wayland protocols are so unstable right now, and Phosh devs keep trying to push their own changes which break the existing protocols, and Qt::InputMethodHints doesn't have flags for everything, so I can only see it getting more complicated to keep updated, along with I don't want to have to block on getting things into Qt, maybe backported, etc… if we want to add anything else in the future.

Copy link
Contributor

@pvuorela pvuorela Aug 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could alternatively be a similar enum. But then again Qt::InputMethodHints should not block adding new extensions, those can be presented with other properties. We already do pass the content type here but also the input method hints.

Actually looks like I've halfway marked this as deprecated in 2013 with the Qt5 port. minputcontext.cpp / MInputContext::getStateInformation()

Also curious on what those wayland changes would be. The input hint side has seemed relatively stable for many years.


//! allows numbers and certain other characters used in phone numbers
PhoneNumberContentType,

Expand Down Expand Up @@ -126,12 +129,6 @@ namespace Maliit {
//! Name of property which tells whether correction is enabled.
//! \sa Maliit::ImCorrectionEnabledQuery.
const char* const correctionEnabledQuery = "maliit-correction-enabled";
//! Name of property which holds ID of attribute extension.
//! \sa Maliit::InputMethodAttributeExtensionIdQuery.
const char* const attributeExtensionId = "maliit-attribute-extension-id";
//! Name of property which holds attribute extension.
//! \sa Maliit::InputMethodAttributeExtensionQuery.
const char* const attributeExtension = "maliit-attribute-extension";
//! Name of the property which overrides localized numeric input with western numeric input.
//! \sa Maliit::WesternNumericInputEnforcedQuery.
const char* const westernNumericInputEnforced = "maliit-western-numeric-input-enforced";
Expand All @@ -141,34 +138,6 @@ namespace Maliit {
//! \sa Maliit::VisualizationPriorityQuery
const char* const suppressInputMethod = "maliit-suppress-input-method";
}

enum SettingEntryType
{
StringType = 1,
IntType = 2,
BoolType = 3,
StringListType = 4,
IntListType = 5
};

namespace SettingEntryAttributes
{
//! Name of setting entry attribute which holds the list of values that can be assigned to the entry.
//! \sa Maliit::SettingsEntry
const char* const valueDomain = "valueDomain";
//! Name of setting entry attribute which holds the descriptions for the values in valueDomain.
//! \sa Maliit::SettingsEntry
const char* const valueDomainDescriptions = "valueDomainDescriptions";
//! Name of setting entry attribute which holds the minimum valid value (inclusive) for an integer property.
//! \sa Maliit::SettingsEntry
const char* const valueRangeMin = "valueRangeMin";
//! Name of setting entry attribute which holds the maximum valid value (inclusive) for an integer property.
//! \sa Maliit::SettingsEntry
const char* const valueRangeMax = "valueRangeMax";
//! Name of setting entry attribute which holds the default value for a setting entry.
//! \sa Maliit::SettingsEntry
const char* const defaultValue = "defaultValue";
}
}

Q_DECLARE_METATYPE(Maliit::TextContentType)
Expand Down
141 changes: 0 additions & 141 deletions common/maliit/settingdata.cpp
View file
Open in desktop

This file was deleted.

Loading