1 /*
2 Open Asset Import Library (assimp)
3 ----------------------------------------------------------------------
4 
5 Copyright (c) 2006-2021, assimp team
6 
7 All rights reserved.
8 
9 Redistribution and use of this software in source and binary forms,
10 with or without modification, are permitted provided that the
11 following conditions are met:
12 
13 * Redistributions of source code must retain the above
14   copyright notice, this list of conditions and the
15   following disclaimer.
16 
17 * Redistributions in binary form must reproduce the above
18   copyright notice, this list of conditions and the
19   following disclaimer in the documentation and/or other
20   materials provided with the distribution.
21 
22 * Neither the name of the assimp team, nor the names of its
23   contributors may be used to endorse or promote products
24   derived from this software without specific prior
25   written permission of the assimp team.
26 
27 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 
39 ----------------------------------------------------------------------
40 */
41 
42 /** @file  LogAux.h
43  *  @brief Common logging usage patterns for importer implementations
44  */
45 #pragma once
46 #ifndef INCLUDED_AI_LOGAUX_H
47 #define INCLUDED_AI_LOGAUX_H
48 
49 #ifdef __GNUC__
50 #   pragma GCC system_header
51 #endif
52 
53 #include <assimp/TinyFormatter.h>
54 #include <assimp/Exceptional.h>
55 #include <assimp/DefaultLogger.hpp>
56 
57 namespace Assimp {
58 
59 /// @brief Logger class, which will extend the class by log-functions.
60 /// @tparam TDeriving
61 template<class TDeriving>
62 class LogFunctions {
63 public:
64     // ------------------------------------------------------------------------------------------------
65     template<typename... T>
ThrowException(T &&...args)66     static void ThrowException(T&&... args)
67     {
68         throw DeadlyImportError(Prefix(), std::forward<T>(args)...);
69     }
70 
71     // ------------------------------------------------------------------------------------------------
72     template<typename... T>
LogWarn(T &&...args)73     static void LogWarn(T&&... args) {
74         if (!DefaultLogger::isNullLogger()) {
75             ASSIMP_LOG_WARN(Prefix(), std::forward<T>(args)...);
76         }
77     }
78 
79     // ------------------------------------------------------------------------------------------------
80     template<typename... T>
LogError(T &&...args)81     static void LogError(T&&... args)  {
82         if (!DefaultLogger::isNullLogger()) {
83             ASSIMP_LOG_ERROR(Prefix(), std::forward<T>(args)...);
84         }
85     }
86 
87     // ------------------------------------------------------------------------------------------------
88     template<typename... T>
LogInfo(T &&...args)89     static void LogInfo(T&&... args)  {
90         if (!DefaultLogger::isNullLogger()) {
91             ASSIMP_LOG_INFO(Prefix(), std::forward<T>(args)...);
92         }
93     }
94 
95     // ------------------------------------------------------------------------------------------------
96     template<typename... T>
LogDebug(T &&...args)97     static void LogDebug(T&&... args)  {
98         if (!DefaultLogger::isNullLogger()) {
99             ASSIMP_LOG_DEBUG(Prefix(), std::forward<T>(args)...);
100         }
101     }
102 
103     // ------------------------------------------------------------------------------------------------
104     template<typename... T>
LogVerboseDebug(T &&...args)105     static void LogVerboseDebug(T&&... args)  {
106         if (!DefaultLogger::isNullLogger()) {
107             ASSIMP_LOG_VERBOSE_DEBUG(Prefix(), std::forward<T>(args)...);
108         }
109     }
110 
111 private:
112     static const char* Prefix();
113 };
114 
115 } // ! Assimp
116 
117 #endif // INCLUDED_AI_LOGAUX_H
118