diff options
Diffstat (limited to 'lib/application-service/definitions')
| -rw-r--r-- | lib/application-service/definitions/location.cpp | 7 | ||||
| -rw-r--r-- | lib/application-service/definitions/location.h | 35 | ||||
| -rw-r--r-- | lib/application-service/definitions/protocol.cpp | 23 | ||||
| -rw-r--r-- | lib/application-service/definitions/protocol.h | 133 | ||||
| -rw-r--r-- | lib/application-service/definitions/user.cpp | 9 | ||||
| -rw-r--r-- | lib/application-service/definitions/user.h | 35 |
6 files changed, 125 insertions, 117 deletions
diff --git a/lib/application-service/definitions/location.cpp b/lib/application-service/definitions/location.cpp index a53db8d7..2ab83ae9 100644 --- a/lib/application-service/definitions/location.cpp +++ b/lib/application-service/definitions/location.cpp @@ -7,18 +7,17 @@ using namespace QMatrixClient; void JsonObjectConverter<ThirdPartyLocation>::dumpTo( - QJsonObject& jo, const ThirdPartyLocation& pod) + QJsonObject& jo, const ThirdPartyLocation& pod) { addParam<>(jo, QStringLiteral("alias"), pod.alias); addParam<>(jo, QStringLiteral("protocol"), pod.protocol); addParam<>(jo, QStringLiteral("fields"), pod.fields); } -void JsonObjectConverter<ThirdPartyLocation>::fillFrom( - const QJsonObject& jo, ThirdPartyLocation& result) +void JsonObjectConverter<ThirdPartyLocation>::fillFrom(const QJsonObject& jo, + ThirdPartyLocation& result) { fromJson(jo.value("alias"_ls), result.alias); fromJson(jo.value("protocol"_ls), result.protocol); fromJson(jo.value("fields"_ls), result.fields); } - diff --git a/lib/application-service/definitions/location.h b/lib/application-service/definitions/location.h index 5586cfc6..caf28615 100644 --- a/lib/application-service/definitions/location.h +++ b/lib/application-service/definitions/location.h @@ -10,21 +10,24 @@ namespace QMatrixClient { - // Data structures - - struct ThirdPartyLocation - { - /// An alias for a matrix room. - QString alias; - /// The protocol ID that the third party location is a part of. - QString protocol; - /// Information used to identify this third party location. - QJsonObject fields; - }; - template <> struct JsonObjectConverter<ThirdPartyLocation> - { - static void dumpTo(QJsonObject& jo, const ThirdPartyLocation& pod); - static void fillFrom(const QJsonObject& jo, ThirdPartyLocation& pod); - }; + +// Data structures + +struct ThirdPartyLocation +{ + /// An alias for a matrix room. + QString alias; + /// The protocol ID that the third party location is a part of. + QString protocol; + /// Information used to identify this third party location. + QJsonObject fields; +}; + +template <> +struct JsonObjectConverter<ThirdPartyLocation> +{ + static void dumpTo(QJsonObject& jo, const ThirdPartyLocation& pod); + static void fillFrom(const QJsonObject& jo, ThirdPartyLocation& pod); +}; } // namespace QMatrixClient diff --git a/lib/application-service/definitions/protocol.cpp b/lib/application-service/definitions/protocol.cpp index 2a62b15d..e87001fb 100644 --- a/lib/application-service/definitions/protocol.cpp +++ b/lib/application-service/definitions/protocol.cpp @@ -6,22 +6,22 @@ using namespace QMatrixClient; -void JsonObjectConverter<FieldType>::dumpTo( - QJsonObject& jo, const FieldType& pod) +void JsonObjectConverter<FieldType>::dumpTo(QJsonObject& jo, + const FieldType& pod) { addParam<>(jo, QStringLiteral("regexp"), pod.regexp); addParam<>(jo, QStringLiteral("placeholder"), pod.placeholder); } -void JsonObjectConverter<FieldType>::fillFrom( - const QJsonObject& jo, FieldType& result) +void JsonObjectConverter<FieldType>::fillFrom(const QJsonObject& jo, + FieldType& result) { fromJson(jo.value("regexp"_ls), result.regexp); fromJson(jo.value("placeholder"_ls), result.placeholder); } -void JsonObjectConverter<ProtocolInstance>::dumpTo( - QJsonObject& jo, const ProtocolInstance& pod) +void JsonObjectConverter<ProtocolInstance>::dumpTo(QJsonObject& jo, + const ProtocolInstance& pod) { addParam<>(jo, QStringLiteral("desc"), pod.desc); addParam<IfNotEmpty>(jo, QStringLiteral("icon"), pod.icon); @@ -29,8 +29,8 @@ void JsonObjectConverter<ProtocolInstance>::dumpTo( addParam<>(jo, QStringLiteral("network_id"), pod.networkId); } -void JsonObjectConverter<ProtocolInstance>::fillFrom( - const QJsonObject& jo, ProtocolInstance& result) +void JsonObjectConverter<ProtocolInstance>::fillFrom(const QJsonObject& jo, + ProtocolInstance& result) { fromJson(jo.value("desc"_ls), result.desc); fromJson(jo.value("icon"_ls), result.icon); @@ -39,7 +39,7 @@ void JsonObjectConverter<ProtocolInstance>::fillFrom( } void JsonObjectConverter<ThirdPartyProtocol>::dumpTo( - QJsonObject& jo, const ThirdPartyProtocol& pod) + QJsonObject& jo, const ThirdPartyProtocol& pod) { addParam<>(jo, QStringLiteral("user_fields"), pod.userFields); addParam<>(jo, QStringLiteral("location_fields"), pod.locationFields); @@ -48,8 +48,8 @@ void JsonObjectConverter<ThirdPartyProtocol>::dumpTo( addParam<>(jo, QStringLiteral("instances"), pod.instances); } -void JsonObjectConverter<ThirdPartyProtocol>::fillFrom( - const QJsonObject& jo, ThirdPartyProtocol& result) +void JsonObjectConverter<ThirdPartyProtocol>::fillFrom(const QJsonObject& jo, + ThirdPartyProtocol& result) { fromJson(jo.value("user_fields"_ls), result.userFields); fromJson(jo.value("location_fields"_ls), result.locationFields); @@ -57,4 +57,3 @@ void JsonObjectConverter<ThirdPartyProtocol>::fillFrom( fromJson(jo.value("field_types"_ls), result.fieldTypes); fromJson(jo.value("instances"_ls), result.instances); } - diff --git a/lib/application-service/definitions/protocol.h b/lib/application-service/definitions/protocol.h index 0a1f9a21..0d227851 100644 --- a/lib/application-service/definitions/protocol.h +++ b/lib/application-service/definitions/protocol.h @@ -8,76 +8,81 @@ #include <QtCore/QHash> #include <QtCore/QJsonObject> -#include "converters.h" #include <QtCore/QVector> namespace QMatrixClient { - // Data structures - /// Definition of valid values for a field. - struct FieldType - { - /// A regular expression for validation of a field's value. This may be relatively - /// coarse to verify the value as the application service providing this protocol - /// may apply additional validation or filtering. - QString regexp; - /// An placeholder serving as a valid example of the field value. - QString placeholder; - }; - template <> struct JsonObjectConverter<FieldType> - { - static void dumpTo(QJsonObject& jo, const FieldType& pod); - static void fillFrom(const QJsonObject& jo, FieldType& pod); - }; +// Data structures + +/// Definition of valid values for a field. +struct FieldType +{ + /// A regular expression for validation of a field's value. This may be + /// relativelycoarse to verify the value as the application service + /// providing this protocolmay apply additional validation or filtering. + QString regexp; + /// An placeholder serving as a valid example of the field value. + QString placeholder; +}; + +template <> +struct JsonObjectConverter<FieldType> +{ + static void dumpTo(QJsonObject& jo, const FieldType& pod); + static void fillFrom(const QJsonObject& jo, FieldType& pod); +}; - struct ProtocolInstance - { - /// A human-readable description for the protocol, such as the name. - QString desc; - /// An optional content URI representing the protocol. Overrides the one provided - /// at the higher level Protocol object. - QString icon; - /// Preset values for ``fields`` the client may use to search by. - QJsonObject fields; - /// A unique identifier across all instances. - QString networkId; - }; - template <> struct JsonObjectConverter<ProtocolInstance> - { - static void dumpTo(QJsonObject& jo, const ProtocolInstance& pod); - static void fillFrom(const QJsonObject& jo, ProtocolInstance& pod); - }; +struct ProtocolInstance +{ + /// A human-readable description for the protocol, such as the name. + QString desc; + /// An optional content URI representing the protocol. Overrides the one + /// providedat the higher level Protocol object. + QString icon; + /// Preset values for ``fields`` the client may use to search by. + QJsonObject fields; + /// A unique identifier across all instances. + QString networkId; +}; - struct ThirdPartyProtocol - { - /// Fields which may be used to identify a third party user. These should be - /// ordered to suggest the way that entities may be grouped, where higher - /// groupings are ordered first. For example, the name of a network should be - /// searched before the nickname of a user. - QStringList userFields; - /// Fields which may be used to identify a third party location. These should be - /// ordered to suggest the way that entities may be grouped, where higher - /// groupings are ordered first. For example, the name of a network should be - /// searched before the name of a channel. - QStringList locationFields; - /// A content URI representing an icon for the third party protocol. - QString icon; - /// The type definitions for the fields defined in the ``user_fields`` and - /// ``location_fields``. Each entry in those arrays MUST have an entry here. The - /// ``string`` key for this object is field name itself. - /// - /// May be an empty object if no fields are defined. - QHash<QString, FieldType> fieldTypes; - /// A list of objects representing independent instances of configuration. - /// For example, multiple networks on IRC if multiple are provided by the - /// same application service. - QVector<ProtocolInstance> instances; - }; - template <> struct JsonObjectConverter<ThirdPartyProtocol> - { - static void dumpTo(QJsonObject& jo, const ThirdPartyProtocol& pod); - static void fillFrom(const QJsonObject& jo, ThirdPartyProtocol& pod); - }; +template <> +struct JsonObjectConverter<ProtocolInstance> +{ + static void dumpTo(QJsonObject& jo, const ProtocolInstance& pod); + static void fillFrom(const QJsonObject& jo, ProtocolInstance& pod); +}; + +struct ThirdPartyProtocol +{ + /// Fields which may be used to identify a third party user. These should + /// beordered to suggest the way that entities may be grouped, where + /// highergroupings are ordered first. For example, the name of a network + /// should besearched before the nickname of a user. + QStringList userFields; + /// Fields which may be used to identify a third party location. These + /// should beordered to suggest the way that entities may be grouped, where + /// highergroupings are ordered first. For example, the name of a network + /// should besearched before the name of a channel. + QStringList locationFields; + /// A content URI representing an icon for the third party protocol. + QString icon; + /// The type definitions for the fields defined in the ``user_fields`` and + /// ``location_fields``. Each entry in those arrays MUST have an entry here. + /// The``string`` key for this object is field name itself.May be an empty + /// object if no fields are defined. + QHash<QString, FieldType> fieldTypes; + /// A list of objects representing independent instances of + /// configuration.For example, multiple networks on IRC if multiple are + /// provided by thesame application service. + QVector<ProtocolInstance> instances; +}; + +template <> +struct JsonObjectConverter<ThirdPartyProtocol> +{ + static void dumpTo(QJsonObject& jo, const ThirdPartyProtocol& pod); + static void fillFrom(const QJsonObject& jo, ThirdPartyProtocol& pod); +}; } // namespace QMatrixClient diff --git a/lib/application-service/definitions/user.cpp b/lib/application-service/definitions/user.cpp index 8ba92321..0f3c3130 100644 --- a/lib/application-service/definitions/user.cpp +++ b/lib/application-service/definitions/user.cpp @@ -6,19 +6,18 @@ using namespace QMatrixClient; -void JsonObjectConverter<ThirdPartyUser>::dumpTo( - QJsonObject& jo, const ThirdPartyUser& pod) +void JsonObjectConverter<ThirdPartyUser>::dumpTo(QJsonObject& jo, + const ThirdPartyUser& pod) { addParam<>(jo, QStringLiteral("userid"), pod.userid); addParam<>(jo, QStringLiteral("protocol"), pod.protocol); addParam<>(jo, QStringLiteral("fields"), pod.fields); } -void JsonObjectConverter<ThirdPartyUser>::fillFrom( - const QJsonObject& jo, ThirdPartyUser& result) +void JsonObjectConverter<ThirdPartyUser>::fillFrom(const QJsonObject& jo, + ThirdPartyUser& result) { fromJson(jo.value("userid"_ls), result.userid); fromJson(jo.value("protocol"_ls), result.protocol); fromJson(jo.value("fields"_ls), result.fields); } - diff --git a/lib/application-service/definitions/user.h b/lib/application-service/definitions/user.h index 062d2cac..3fd099d0 100644 --- a/lib/application-service/definitions/user.h +++ b/lib/application-service/definitions/user.h @@ -10,21 +10,24 @@ namespace QMatrixClient { - // Data structures - - struct ThirdPartyUser - { - /// A Matrix User ID represting a third party user. - QString userid; - /// The protocol ID that the third party location is a part of. - QString protocol; - /// Information used to identify this third party location. - QJsonObject fields; - }; - template <> struct JsonObjectConverter<ThirdPartyUser> - { - static void dumpTo(QJsonObject& jo, const ThirdPartyUser& pod); - static void fillFrom(const QJsonObject& jo, ThirdPartyUser& pod); - }; + +// Data structures + +struct ThirdPartyUser +{ + /// A Matrix User ID represting a third party user. + QString userid; + /// The protocol ID that the third party location is a part of. + QString protocol; + /// Information used to identify this third party location. + QJsonObject fields; +}; + +template <> +struct JsonObjectConverter<ThirdPartyUser> +{ + static void dumpTo(QJsonObject& jo, const ThirdPartyUser& pod); + static void fillFrom(const QJsonObject& jo, ThirdPartyUser& pod); +}; } // namespace QMatrixClient |