File: element.h

package info (click to toggle)
libkode 0.0~git20241211.68f9908-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 636 kB
  • sloc: cpp: 6,612; makefile: 5
file content (131 lines) | stat: -rw-r--r-- 3,697 bytes parent folder | download | duplicates (3)
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
/*
    This file is part of KDE Schema Parser

    Copyright (c) 2005 Tobias Koenig <tokoe@kde.org>
                       based on wsdlpull parser by Vivek Krishna

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
 */

#ifndef SCHEMA_ELEMENT_H
#define SCHEMA_ELEMENT_H

#include <QList>
#include <QString>

#include "xmlelement.h"
#include "compositor.h"
#include <kode_export.h>

namespace XSD {

class ElementList;

class SCHEMA_EXPORT Element : public XmlElement
{
public:
    typedef ElementList List;

    Element();
    explicit Element(const QString &nameSpace);
    Element(const Element &other);
    Element(Element &&other);
    ~Element();

    Element &operator=(const Element &other);
    Element &operator=(Element &&other) noexcept;

    void setType(const QName &type);
    QName type() const;

    void setDocumentation(const QString &documentation);
    QString documentation() const;

    void setGroupId(int group);
    int groupId() const;

    void setMinOccurs(int minOccurs);
    int minOccurs() const;

    void setMaxOccurs(int maxOccurs);
    int maxOccurs() const;

    void setDefaultValue(const QString &defaultValue);
    QString defaultValue() const;

    void setFixedValue(const QString &fixedValue);
    QString fixedValue() const;

    void setIsQualified(bool isQualified);
    bool isQualified() const;

    void setNillable(bool nillable);
    bool nillable() const;

    void setOccurrence(int occurrence);
    int occurrence() const;

    void setReference(const QName &reference);
    QName reference() const;

    bool isResolved() const;

    void setCompositor(const Compositor &);
    Compositor compositor() const;

    /**
     * Makes a note that this element has substitutions available.
     *
     * Example:
     *  <xs:element name="Path" abstract="true" type="t:BasePathToElementType"/>
     *  <xs:element name="FieldURI" type="t:PathToUnindexedFieldType" substitutionGroup="t:Path"/>
     * will note in the element "Path" that substitutions exist.
     */
    void setHasSubstitutions(bool hasSub);
    /**
     * @return true if this element is the base element of a substitution group.
     */
    bool hasSubstitutions() const;

    bool operator==(const Element &other) const;
    inline bool operator!=(const Element &other) const { return !(*this == other); }

private:
    class Private;
    std::unique_ptr<Private> d;
};

class SCHEMA_EXPORT ElementList : public QList<Element>
{
public:
    // Readonly lookup, returns null element if not found
    Element element(const QName &qualifiedName) const;

    // Mutable lookup (for making changes), returns end() if not found
    iterator findElement(const QName &qualifiedName);

    // For debugging
    void dump();

    bool operator==(const ElementList &other) const;
    inline bool operator!=(const ElementList &other) const { return !(*this == other); }
};

}

SCHEMA_EXPORT QDebug operator<<(QDebug dbg, const XSD::Element &element);

#endif