summaryrefslogtreecommitdiffstats
path: root/src/knx/knxproj/qknxgroupaddresses.cpp
blob: 460723edcbc00524839be9597d617c07a76981a7 (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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/******************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtKnx module.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
******************************************************************************/

#include "qknxgroupaddresses_p.h"

QT_BEGIN_NAMESPACE

static bool fetchBool(const QXmlStreamAttributes &attrs, const QString &name)
{
    auto attr = attrs.value(name);
    if (attr.isNull())
        return false;
    return attrs.value(name).toString() == QStringLiteral("true");
};

// -- QKnxGroupAddress

bool QKnxGroupAddress::parseElement(QXmlStreamReader *reader, bool pedantic)
{
    if (!reader || !reader->isStartElement())
        return false;

    if (reader->name() == QStringLiteral("GroupAddress")) {
        auto attrs = reader->attributes();

        // required attributes
        QStringRef attr;
        if (!QKnxProjectUtils::fetchAttr(attrs, QStringLiteral("Id"), &attr, reader))
            return false;
        if (!QKnxProjectUtils::setNCName(QLatin1String("Id"), attr, &Id, reader, pedantic))
            return false;

        if (!QKnxProjectUtils::fetchAttr(attrs, QLatin1String("Address"), &attr, reader))
            return false;
        if (!QKnxProjectUtils::setNumber<quint32>(QLatin1String("Address"), attr.toUInt(), 65535,
            &Address, reader, pedantic)) return false;

        if (!QKnxProjectUtils::fetchAttr(attrs, QLatin1String("Name"), &attr, reader))
            return false;
        if (!QKnxProjectUtils::setString(QLatin1String("Name"), attr, 255, &Name, reader,
            pedantic)) return false;

        if (!QKnxProjectUtils::fetchAttr(attrs, QStringLiteral("Puid"), &attr, reader))
            return false;
        Puid = attr.toUInt();

        // optional attributes
        Unfiltered = fetchBool(attrs, QStringLiteral("Unfiltered"));
        Central = fetchBool(attrs, QStringLiteral("Central"));
        Global = fetchBool(attrs, QStringLiteral("Global"));

        attr = attrs.value(QStringLiteral("DatapointType"));
        if (pedantic && !attr.isNull() && !QKnxProjectUtils::isNCName(attr.toString())) {
            reader->raiseError(tr("Pedantic error: DatapointType is not a valid xs:ID, got '%1'.")
                .arg(attr));
            return false;
        }
        DatapointType = attr.toString();

        Description = attrs.value(QStringLiteral("Description")).toString();
        Comment = attrs.value(QStringLiteral("Comment")).toString();

        attr = attrs.value(QLatin1String("Key"));
        if (!attr.isNull() && !QKnxProjectUtils::setString(QLatin1String("Key"), attr, 40, &Key,
            reader, pedantic)) return false;

        attr = attrs.value(QStringLiteral("Security")); // TODO: pedantic
        if (!attr.isNull())
            Security = attr.toString();

        reader->skipCurrentElement(); // attribute element only
    } else {
        reader->raiseError(tr("Expected element <GroupAddress>, got: <%1>.").arg(reader->name()));
    }
    return !reader->hasError();
}

// -- QKnxGroupRange

bool QKnxGroupRange::parseElement(QXmlStreamReader *reader, bool pedantic)
{
    if (!reader || !reader->isStartElement())
        return false;

    if (reader->name() == QLatin1String("GroupRange")) {
        auto attrs = reader->attributes();

        // required attributes
        QStringRef attr;
        if (!QKnxProjectUtils::fetchAttr(attrs, QStringLiteral("Id"), &attr, reader))
            return false;
        if (!QKnxProjectUtils::setNCName(QLatin1String("Id"), attr, &Id, reader, pedantic))
            return false;

        if (!QKnxProjectUtils::fetchAttr(attrs, QLatin1String("Name"), &attr, reader))
            return false;
        if (!QKnxProjectUtils::setString(QLatin1String("Name"), attr, 255, &Name, reader,
            pedantic)) return false;

        if (!QKnxProjectUtils::fetchAttr(attrs, QLatin1String("RangeStart"), &attr, reader))
            return false;
        RangeStart = attr.toUShort();
        if (!QKnxProjectUtils::fetchAttr(attrs, QLatin1String("RangeEnd"), &attr, reader))
            return false;
        RangeEnd = attr.toUShort();

        if (!QKnxProjectUtils::fetchAttr(attrs, QStringLiteral("Puid"), &attr, reader))
            return false;
        Puid = attr.toUInt();

        // optional attributes;
        Unfiltered = fetchBool(attrs, QStringLiteral("Unfiltered"));
        Description = attrs.value(QStringLiteral("Description")).toString();
        Comment = attrs.value(QStringLiteral("Comment")).toString();

        attr = attrs.value(QStringLiteral("Security")); // TODO: pedantic
        if (!attr.isNull())
            Security = attr.toString();

        // children
        while (!reader->atEnd() && !reader->hasError()) {
            auto tokenType = reader->readNext();
            if (tokenType == QXmlStreamReader::TokenType::StartElement) {
                if (reader->name() == QLatin1String("GroupRange")) {
                    QKnxGroupRange range;
                    if (!range.parseElement(reader, pedantic))
                        return false;
                    GroupRange.append(range);
                } else if (reader->name() == QStringLiteral("GroupAddress")) {
                    QKnxGroupAddress address;
                    if (!address.parseElement(reader, pedantic))
                        return false;
                    GroupAddress.append(address);
                }
            } else if (tokenType == QXmlStreamReader::TokenType::EndElement) {
                if (reader->name() == QLatin1String("GroupRange"))
                    break;
            }
        }
    } else {
        reader->raiseError(tr("Expected element <GroupRange>, got: <%1>.").arg(reader->name()));
    }
    return !reader->hasError();
}


// -- QKnxGroupAddresses

bool QKnxGroupAddresses::parseElement(QXmlStreamReader *reader, bool pedantic)
{
    if (!reader || !reader->isStartElement())
        return false;

    if (reader->name() == QLatin1String("GroupAddresses")) {
        // child
        if (reader->readNextStartElement() && reader->name() != QLatin1String("GroupRanges")) {
            reader->raiseError(tr("Expected element <GroupRanges>, got: <%1>.")
                .arg(reader->name()));
            return false;
        }

        if (pedantic && GroupRanges.size() > 0) {
            reader->raiseError(tr("Pedantic error: Encountered element <GroupRanges> "
                "more than once."));
            return false;
        }

        // children
        while (!reader->atEnd() && !reader->hasError()) {
            auto tokenType = reader->readNext();
            if (tokenType == QXmlStreamReader::TokenType::StartElement) {
                if (reader->name() == QStringLiteral("GroupRange")) {
                    if (pedantic && GroupRanges.size() >= 65535) {
                        reader->raiseError(tr("Pedantic error: Encountered element <GroupRange> "
                            "more than 65535 times."));
                        return false;
                    }
                    QKnxGroupRange range;
                    if (!range.parseElement(reader, pedantic))
                        return false;
                    GroupRanges.append(range);
                }
            } else if (tokenType == QXmlStreamReader::TokenType::EndElement) {
                if (reader->name() == QLatin1String("GroupRanges"))
                    break;
            }
        }

        reader->skipCurrentElement(); // force reading until GroupAddresses end element
    } else {
        reader->raiseError(tr("Expected element <GroupAddresses>, got: <%1>.").arg(reader->name()));
    }
    return !reader->hasError();
}

QT_END_NAMESPACE