diff options
Diffstat (limited to 'lib/application-service/definitions/protocol.h')
| -rw-r--r-- | lib/application-service/definitions/protocol.h | 133 |
1 files changed, 71 insertions, 62 deletions
diff --git a/lib/application-service/definitions/protocol.h b/lib/application-service/definitions/protocol.h index 66012a13..0d227851 100644 --- a/lib/application-service/definitions/protocol.h +++ b/lib/application-service/definitions/protocol.h @@ -6,74 +6,83 @@ #include "converters.h" -#include "converters.h" #include <QtCore/QHash> #include <QtCore/QJsonObject> #include <QtCore/QVector> -namespace QMatrixClient { - // Data structures +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 + /// 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 + /// 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; +}; - /// 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); - }; +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 - /// 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 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; +}; - 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<ThirdPartyProtocol> +{ + static void dumpTo(QJsonObject& jo, const ThirdPartyProtocol& pod); + static void fillFrom(const QJsonObject& jo, ThirdPartyProtocol& pod); +}; } // namespace QMatrixClient |