Warnings.hpp

/*

Copyright (C) University of Oxford, 2005-2011

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of Chaste.

Chaste is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 2.1 of the License, or
(at your option) any later version.

Chaste is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
License for more details. The offer of Chaste under the terms of the
License is subject to the License being interpreted in accordance with
English Law and subject to any action against the University of Oxford
being under the jurisdiction of the English Courts.

You should have received a copy of the GNU Lesser General Public License
along with Chaste. If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef _WARNINGS_HPP_
#define _WARNINGS_HPP_

#include <string>
#include <deque>
#include <sstream>

class Warnings
{
private:

    static Warnings* mpInstance; 
    typedef std::deque<std::pair<std::string, std::string> > WarningsContainerType;

    WarningsContainerType mWarningMessages; 
protected:

    Warnings();

public:

    static void NoisyDestroy();

    static void QuietDestroy();

    void AddWarning(const std::string& rMessage, const std::string& rFilename, unsigned lineNumber, bool onlyOnce=false);

    std::string PopWarning() const;

    static Warnings* Instance();

    unsigned GetNumWarnings();

    std::string GetNextWarningMessage();
};

#define WARNING(message)                                                    \
{                                                                           \
    std::stringstream msg_stream;                                           \
    msg_stream << message;                                                  \
    Warnings::Instance()->AddWarning(msg_stream.str(), __FILE__, __LINE__); \
}

#define WARN_ONCE_ONLY(message)                                                     \
{                                                                                   \
    std::stringstream msg_stream;                                                   \
    msg_stream << message;                                                          \
    Warnings::Instance()->AddWarning(msg_stream.str(), __FILE__, __LINE__, true);   \
}
#endif // _WARNINGS_HPP_