Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
Warnings.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, are permitted provided that the following conditions are met:
14 * Redistributions of source code must retain the above copyright notice,
15 this list of conditions and the following disclaimer.
16 * Redistributions in binary form must reproduce the above copyright notice,
17 this list of conditions and the following disclaimer in the documentation
18 and/or other materials provided with the distribution.
19 * Neither the name of the University of Oxford nor the names of its
20 contributors may be used to endorse or promote products derived from this
21 software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#ifndef _WARNINGS_HPP_
37#define _WARNINGS_HPP_
38
39#include <string>
40#include <deque>
41#include <sstream>
42
55{
56private:
57
61 typedef std::deque<std::pair<std::string, std::string> > WarningsContainerType;
62
65protected:
66
71 Warnings();
72
73public:
74
79 static void NoisyDestroy();
80
85 static void QuietDestroy();
86
90 static void PrintWarnings();
91
100 void AddWarning(const std::string& rMessage, const std::string& rFilename, unsigned lineNumber, bool onlyOnce=false);
101
107 std::string PopWarning() const;
108
113 static Warnings* Instance();
114
118 unsigned GetNumWarnings();
119
123 std::string GetNextWarningMessage();
124};
125
126#define WARNING(message) \
127{ \
128 std::stringstream msg_stream; \
129 msg_stream << message; \
130 Warnings::Instance()->AddWarning(msg_stream.str(), __FILE__, __LINE__); \
131}
132
150#define WARN_ONCE_ONLY(message) \
151{ \
152 std::stringstream msg_stream; \
153 msg_stream << message; \
154 Warnings::Instance()->AddWarning(msg_stream.str(), __FILE__, __LINE__, true); \
155}
156#endif // _WARNINGS_HPP_
static void QuietDestroy()
Definition Warnings.cpp:60
void AddWarning(const std::string &rMessage, const std::string &rFilename, unsigned lineNumber, bool onlyOnce=false)
Definition Warnings.cpp:97
WarningsContainerType mWarningMessages
Definition Warnings.hpp:63
std::string PopWarning() const
unsigned GetNumWarnings()
Definition Warnings.cpp:118
std::deque< std::pair< std::string, std::string > > WarningsContainerType
Definition Warnings.hpp:61
static void NoisyDestroy()
Definition Warnings.cpp:54
static Warnings * mpInstance
Definition Warnings.hpp:58
std::string GetNextWarningMessage()
Definition Warnings.cpp:123
static Warnings * Instance()
Definition Warnings.cpp:87
static void PrintWarnings()
Definition Warnings.cpp:69