1
2 //
3 // This source file is part of appleseed.
4 // Visit https://appleseedhq.net/ for additional information and resources.
5 //
6 // This software is released under the MIT license.
7 //
8 // Copyright (c) 2010-2013 Francois Beaune, Jupiter Jazz Limited
9 // Copyright (c) 2014-2018 Francois Beaune, The appleseedhq Organization
10 //
11 // Permission is hereby granted, free of charge, to any person obtaining a copy
12 // of this software and associated documentation files (the "Software"), to deal
13 // in the Software without restriction, including without limitation the rights
14 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 // copies of the Software, and to permit persons to whom the Software is
16 // furnished to do so, subject to the following conditions:
17 //
18 // The above copyright notice and this permission notice shall be included in
19 // all copies or substantial portions of the Software.
20 //
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 // THE SOFTWARE.
28 //
29
30 #pragma once
31
32 // appleseed.foundation headers.
33 #include "foundation/platform/compiler.h"
34
35 // Standard headers.
36 #include <cassert>
37 #include <cstddef>
38 #include <cstring>
39 #include <exception>
40
41 namespace foundation
42 {
43
44 //
45 // Base class for all appleseed exceptions.
46 //
47
48 class Exception
49 : public std::exception
50 {
51 public:
52 // Constructors.
53 Exception();
54 explicit Exception(const char* what);
55
56 // Returns a generic, implementation-defined description of the exception.
57 const char* what() const throw() override;
58
59 protected:
60 // Copy a string to another, ensuring that no overflow occurs and that the
61 // resulting string is always properly null-terminated.
62 static void copy_string(
63 char* destination,
64 const char* source,
65 const size_t destination_size);
66
67 char m_what[2048];
68
69 void set_what(const char* what);
70 };
71
72
73 //
74 // Exception class implementation.
75 //
76
Exception()77 inline Exception::Exception()
78 {
79 set_what("foundation::Exception");
80 }
81
Exception(const char * what)82 inline Exception::Exception(const char* what)
83 {
84 set_what(what);
85 }
86
what()87 inline const char* Exception::what() const throw()
88 {
89 return m_what;
90 }
91
copy_string(char * destination,const char * source,const size_t destination_size)92 inline void Exception::copy_string(
93 char* destination,
94 const char* source,
95 const size_t destination_size)
96 {
97 assert(destination);
98 assert(source);
99 assert(destination_size > 0);
100
101 std::strncpy(destination, source, destination_size - 1);
102
103 destination[destination_size - 1] = '\0';
104 }
105
set_what(const char * what)106 inline void Exception::set_what(const char* what)
107 {
108 copy_string(m_what, what, sizeof(m_what));
109 }
110
111 } // namespace foundation
112