summaryrefslogtreecommitdiffstats
path: root/src/Runtime/Source/Qt3DSStateApplication/Include/Qt3DSStateXMLIO.h
blob: 3a6398459531cc9aa9c5b8c7e444f5aa4f78c21c (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
/****************************************************************************
**
** Copyright (C) 2013 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $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$
**
****************************************************************************/
#ifndef QT3DS_STATE_XML_IO_H
#define QT3DS_STATE_XML_IO_H
#pragma once
#include "Qt3DSState.h"
#include "foundation/Qt3DSDataRef.h"
#include "foundation/Qt3DSContainers.h"
#include "foundation/StringTable.h"
#include "foundation/XML.h"
#include "EASTL/map.h"
#include "EASTL/string.h"

namespace qt3ds {
namespace foundation {
    class IDOMReader;
    class IDOMWriter;
}
}

namespace qt3ds {
namespace state {

    struct SExecutableContent;
    class CXMLIO
    {
    public:
        typedef eastl::map<eastl::string, eastl::string> TIdRemapMap;

        static void GenerateUniqueId(SStateNode &inNode, const char8_t *inStem,
                                     IStateContext &ioContext, IStringTable &ioStringTable);
        static void GenerateUniqueId(SSend &inNode, const char8_t *inStem, IStateContext &ioContext,
                                     IStringTable &ioStringTable);
        // Load an SCXML file and return the root states
        // All states, transitions, and memory used in the graph is allocated using the graph
        // allocator.
        // This makes freeing the memory much easier because you can just free it by releasing the
        // graph
        // allocator and you don't have to go object by object.
        // Filename is just used as another tag or name on the scxml object.
        static bool LoadSCXMLFile(NVAllocatorCallback &inGraphAllocator, NVFoundationBase &inFnd,
                                  IDOMReader &inReader, IStringTable &inStringTable,
                                  const char8_t *inFilename, IStateContext &outContext,
                                  editor::IEditor *inEditor = NULL);

        // Loading fragments remaps their ids to avoid conflics.  Returns the top nodes from the
        // scxml graph.
        static eastl::pair<eastl::vector<SStateNode *>, TIdRemapMap>
        LoadSCXMLFragment(NVAllocatorCallback &inGraphAllocator, NVFoundationBase &inFnd,
                          IDOMReader &inReader, IStringTable &inStringTable,
                          IStateContext &ioContext, editor::IEditor &inEditor);

        // We write all the way to file instead of a DOM writer because we have to add xml
        // namespaces and those can only
        // be added during the actual serialization process.
        static void SaveSCXMLFile(IStateContext &inContext, NVFoundationBase &inFnd,
                                  IStringTable &inStringTable, IOutStream &outStream,
                                  editor::IEditor *inEditor = NULL);

        static void FindRoots(NVConstDataRef<SStateNode *> inObjects,
                              eastl::vector<SStateNode *> &outRoots);

        // Returns the roots of the copied list
        static eastl::vector<SStateNode *>
        SaveSCXMLFragment(IStateContext &inContext, NVFoundationBase &inFnd,
                          IStringTable &inStringTable, IDOMWriter &ioWriter,
                          NVDataRef<SStateNode *> inObjects, editor::IEditor &inEditor,
                          const QT3DSVec2 &inMousePos, eastl::vector<SNamespacePair> &outNamespaces);

        static void ToEditableXml(IStateContext &inContext, NVFoundationBase &inFnd,
                                  IStringTable &inStringTable, IDOMWriter &ioWriter,
                                  SExecutableContent &inContent, editor::IEditor &inEditor);

        static SExecutableContent *
        FromEditableXML(IDOMReader &inReader, NVFoundationBase &inFnd, IStateContext &inContext,
                        IStringTable &inStringTable, NVAllocatorCallback &inGraphAllocator,
                        editor::IEditor &inEditor, SStateNode *inStateNodeParent,
                        SExecutableContent *inExecContentParent);

        static eastl::vector<eastl::string> GetSupportedExecutableContentNames();
    };
}
}

#endif