summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Client/Code/Core/Doc/Exceptions.h
blob: 11d686474edd3399e949cf00d75184eaf08ecdbf (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
/****************************************************************************
**
** Copyright (C) 2016 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-EXCEPT$
** 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 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** 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 INCLUDED_EXCEPTIONS_H
#define INCLUDED_EXCEPTIONS_H 1

#pragma once

#include "StudioException.h"
#include "Qt3DSString.h"

class CGeneralException : public CStudioException
{
public:
    CGeneralException(const Q3DStudio::CString &inDescription)
        : m_Description(inDescription)
    {
    }
    virtual ~CGeneralException() {}

    const wchar_t *GetDescription() const override
    {
        return static_cast<const wchar_t *>(m_Description);
    }

protected:
    Q3DStudio::CString m_Description;
};

class CNoClientException : public CStudioException
{
public:
    CNoClientException() {}
    virtual ~CNoClientException() {}
    const wchar_t *GetDescription() const override
    {
        return Q3DStudio::CString(_LSTR("Client is not installed"));
    }
};

class CClientCreationException : public CStudioException
{
public:
    CClientCreationException() {}
    virtual ~CClientCreationException() {}
    const wchar_t *GetDescription() const override
    {
        return Q3DStudio::CString(_LSTR("Unable to create Client"));
    }
};

class CInvalidFileFormatException : public CStudioException
{
public:
    CInvalidFileFormatException() {}
    virtual ~CInvalidFileFormatException() {}
    const wchar_t *GetDescription() const override
    {
        return Q3DStudio::CString(_LSTR("Invalid file format"));
    }
};

class CUnsupportedFileFormatException : public CStudioException
{
public:
    CUnsupportedFileFormatException() {}
    virtual ~CUnsupportedFileFormatException() {}
    const wchar_t *GetDescription() const override
    {
        return Q3DStudio::CString(_LSTR("Unsupported file format"));
    }
};

class ProjectFileNotFoundException : public CStudioException
{
public:
    ProjectFileNotFoundException() {}
    virtual ~ProjectFileNotFoundException() {}
    const wchar_t *GetDescription() const override
    {
        return Q3DStudio::CString(_LSTR("Project file was not found"));
    }
};

class CENotImplException : public CStudioException
{
public:
    CENotImplException() {}
    virtual ~CENotImplException() {}
    const wchar_t *GetDescription() const override { return Q3DStudio::CString(_LSTR("ENOTIMPL")); }
};

class CInvalidArgumentsException : public CStudioException
{
public:
    CInvalidArgumentsException() {}
    virtual ~CInvalidArgumentsException() {}
    const wchar_t *GetDescription() const override
    {
        return Q3DStudio::CString(_LSTR("Invalid Argument"));
    }
};

class CNullPointerException : public CStudioException
{
public:
    CNullPointerException() {}
    virtual ~CNullPointerException() {}
    const wchar_t *GetDescription() const override
    {
        return Q3DStudio::CString(_LSTR("Null Pointer Error"));
    }
};

class CUnexpectedResultException : public CStudioException
{
public:
    CUnexpectedResultException() {}
    virtual ~CUnexpectedResultException() {}
    const wchar_t *GetDescription() const override
    {
        return Q3DStudio::CString(_LSTR("Unexpected Result"));
    }
};

class CClientFailException : public CStudioException
{
public:
    CClientFailException() {}
    virtual ~CClientFailException() {}
    const wchar_t *GetDescription() const override
    {
        return Q3DStudio::CString(_LSTR("Client Failure"));
    }
};

// Any referenced (e.g. Data File) load errors
class CLoadReferencedFileException : public CGeneralException
{
public:
    CLoadReferencedFileException(const wchar_t *inFilePath, const Q3DStudio::CString &inDescription)
        : CGeneralException(inDescription)
    {
        if (inFilePath)
            m_FilePath = inFilePath;
    }
    virtual ~CLoadReferencedFileException() {}
    const wchar_t *GetFilePath() const { return static_cast<const wchar_t *>(m_FilePath); }

protected:
    Q3DStudio::CString m_FilePath;
};

#endif // INCLUDED_EXCEPTIONS_H