aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/{{base}}.h.mustache
blob: 0b7de817aababc7b8bd44c4ab296e8470908e078 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
{{#@filePartial}}preamble{{/@filePartial}}
#pragma once

{{#operations}}#include "jobs/basejob.h"
{{/operations}}{{#models}}#include "converters.h"
{{/models}}
{{#imports}}#include {{_}}
{{/imports}}
namespace QMatrixClient
{
{{#models}}    // Data structures
{{#    model}}{{#description}}
    /// {{_}}{{/description}}
    struct {{name}}{{#parents?}} : {{#parents}}{{name}}{{>cjoin}}{{/parents}}{{/parents?}}
    {
{{#vars}}{{#description}}        /// {{_}}
{{/description}}        {{>maybeOmittableType}} {{nameCamelCase}};
{{/vars}}{{#propertyMap}}{{#description}}        /// {{_}}
{{/description}}        {{>maybeOmittableType}} {{nameCamelCase}};
{{/propertyMap}}    };
{{#in?}}
    QJsonObject toJson(const {{name}}& pod);
{{/in?}}{{#out?}}
    template <> struct FromJson<{{name}}>
    {
        {{name}} operator()(const QJsonValue& jv);
    };
{{/    out?}}{{/model}}
{{/models}}{{#operations}}    // Operations
{{#    operation}}{{#summary}}
    /// {{summary}}{{#description?}}{{!add a linebreak between summary and description if both exist}}
    /// {{/description?}}{{/summary}}{{#description}}
    /// {{_}}{{/description}}
    class {{camelCaseOperationId}}Job : public BaseJob
    {
        public:{{#models}}
            // Inner data structures
{{#            model}}{{#description}}
            /// {{_}}{{/description}}
            struct {{name}}{{#parents?}} : {{#parents}}{{name}}{{>cjoin}}{{/parents}}{{/parents?}}
            {
{{#vars}}{{#description}}                /// {{_}}
{{/description}}                {{>maybeOmittableType}} {{nameCamelCase}};
{{/vars}}{{#propertyMap}}{{#description}}                /// {{_}}
{{/description}}                {{>maybeOmittableType}} {{nameCamelCase}};
{{/propertyMap}}            };
{{/            model}}
            // Construction/destruction
{{/        models}}{{#allParams?}}
            /*! {{summary}}{{#allParams}}
             * \param {{nameCamelCase}} {{#description}}
             *   {{_}}{{/description}}{{/allParams}}
             */{{/allParams?}}
            explicit {{camelCaseOperationId}}Job({{#allParams}}{{>joinedParamDecl}}{{/allParams}});{{^bodyParams}}

            /*! Construct a URL without creating a full-fledged job object
             *
             * This function can be used when a URL for
             * {{camelCaseOperationId}}Job is necessary but the job
             * itself isn't.
             */
            static QUrl makeRequestUrl(QUrl baseUrl{{#allParams?}}, {{#allParams}}{{>joinedParamDecl}}{{/allParams}}{{/allParams?}});
{{/bodyParams}}{{#        responses}}{{#normalResponse?}}{{#allProperties?}}
            ~{{camelCaseOperationId}}Job() override;

            // Result properties
{{#allProperties}}{{#description}}
            /// {{_}}{{/description}}
            {{>maybeCrefType}} {{paramName}}(){{^moveOnly}} const{{/moveOnly}};{{/allProperties}}

        protected:
            Status {{#producesNonJson?}}parseReply(QNetworkReply* reply){{/producesNonJson?}}{{^producesNonJson?}}parseJson(const QJsonDocument& data){{/producesNonJson?}} override;

        private:
            class Private;
            QScopedPointer<Private> d;{{/allProperties?}}{{/normalResponse?}}{{/responses}}
    };
{{/operation}}{{/operations}}{{!skip EOL
}}} // namespace QMatrixClient