1/****************************************************************************
2**
3** Copyright (C) 2018 Intel Corporation.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the examples of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:BSD$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** BSD License Usage
18** Alternatively, you may use this file under the terms of the BSD license
19** as follows:
20**
21** "Redistribution and use in source and binary forms, with or without
22** modification, are permitted provided that the following conditions are
23** met:
24** * Redistributions of source code must retain the above copyright
25** notice, this list of conditions and the following disclaimer.
26** * Redistributions in binary form must reproduce the above copyright
27** notice, this list of conditions and the following disclaimer in
28** the documentation and/or other materials provided with the
29** distribution.
30** * Neither the name of The Qt Company Ltd nor the names of its
31** contributors may be used to endorse or promote products derived
32** from this software without specific prior written permission.
33**
34**
35** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
36** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
38** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
39** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
42** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
43** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
45** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
46**
47** $QT_END_LICENSE$
48**
49****************************************************************************/
50
51#ifndef CONVERTER_H
52#define CONVERTER_H
53
54#include <QIODevice>
55#include <QPair>
56#include <QVariant>
57#include <QVector>
58
59class VariantOrderedMap : public QVector<QPair<QVariant, QVariant>>
60{
61public:
62 VariantOrderedMap() = default;
63 VariantOrderedMap(const QVariantMap &map)
64 {
65 reserve(asize: map.size());
66 for (auto it = map.begin(); it != map.end(); ++it)
67 append(t: {it.key(), it.value()});
68 }
69};
70using Map = VariantOrderedMap;
71Q_DECLARE_METATYPE(Map)
72
73class Converter
74{
75protected:
76 Converter();
77
78public:
79 static Converter *null;
80
81 enum Direction {
82 In = 1, Out = 2, InOut = 3
83 };
84
85 enum Option {
86 SupportsArbitraryMapKeys = 0x01
87 };
88 Q_DECLARE_FLAGS(Options, Option)
89
90 virtual ~Converter() = 0;
91
92 virtual QString name() = 0;
93 virtual Direction directions() = 0;
94 virtual Options outputOptions() = 0;
95 virtual const char *optionsHelp() = 0;
96 virtual bool probeFile(QIODevice *f) = 0;
97 virtual QVariant loadFile(QIODevice *f, Converter *&outputConverter) = 0;
98 virtual void saveFile(QIODevice *f, const QVariant &contents, const QStringList &options) = 0;
99};
100
101Q_DECLARE_OPERATORS_FOR_FLAGS(Converter::Options)
102
103#endif // CONVERTER_H
104

source code of qtbase/examples/corelib/serialization/convert/converter.h