fastformat/exceptions.hpp

Go to the documentation of this file.

/* /////////////////////////////////////////////////////////////////////////
 * File:        fastformat/exceptions.hpp
 *
 * Purpose:     FastFormat API exception classes.
 *
 * Created:     23rd October 2008
 * Updated:     30th April 2010
 *
 * Home:        http://www.fastformat.org/
 *
 * Copyright (c) 2008-2010, Matthew Wilson and Synesis Software
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - Neither the names of Matthew Wilson and Synesis Software nor the names
 *   of any contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * ////////////////////////////////////////////////////////////////////// */


#ifndef FASTFORMAT_INCL_FASTFORMAT_HPP_EXCEPTIONS
#define FASTFORMAT_INCL_FASTFORMAT_HPP_EXCEPTIONS

/* /////////////////////////////////////////////////////////////////////////
 * Version information
 */

#ifndef FASTFORMAT_DOCUMENTATION_SKIP_SECTION
# define FASTFORMAT_VER_FASTFORMAT_HPP_EXCEPTIONS_MAJOR     1
# define FASTFORMAT_VER_FASTFORMAT_HPP_EXCEPTIONS_MINOR     1
# define FASTFORMAT_VER_FASTFORMAT_HPP_EXCEPTIONS_REVISION  2
# define FASTFORMAT_VER_FASTFORMAT_HPP_EXCEPTIONS_EDIT      8
#endif /* !FASTFORMAT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Language
 */

#ifndef __cplusplus
# error This file can only be included in C++ compilation units
#endif /* !__cplusplus */

/* /////////////////////////////////////////////////////////////////////////
 * Includes
 */

#include <fastformat/fastformat.h>
#include <fastformat/quality/contract.h>
#include <fastformat/quality/cover.h>

#include <stlsoft/stlsoft.h>

#include <exception>
#include <stdexcept>
#include <string>

/* /////////////////////////////////////////////////////////////////////////
 * Namespace
 */

#if !defined(FASTFORMAT_NO_NAMESPACE)
namespace fastformat
{
#endif /* !FASTFORMAT_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * Classes
 */

class fastformat_exception
    : public std::runtime_error
{
public: // Member Types
    typedef std::runtime_error              parent_class_type;
    typedef fastformat_exception            class_type;
    typedef std::string                     multibyte_string_type;
    typedef std::basic_string<ff_char_t>    string_type;

public: // Construction
    explicit fastformat_exception(char const* message)
        : parent_class_type(validate_message_(message))
    {
        FASTFORMAT_COVER_MARK_ENTRY();
    }
    virtual ~fastformat_exception() stlsoft_throw_0() = 0;

private:
    class_type& operator =(class_type const&);

protected: // Implementation
#ifndef FASTFORMAT_DOCUMENTATION_SKIP_SECTION
    static ff_char_t const* validate_format_(ff_char_t const* format)
    {
        FASTFORMAT_CONTRACT_ENFORCE_PRECONDITION_PARAMS_APPL_LAYER(NULL != format, "format parameter may not be null");

        FASTFORMAT_COVER_MARK_ENTRY();

        return format;
    }
    static ff_char_t const* validate_format_(ff_char_t const* format, size_t cchFormat)
    {
        FASTFORMAT_CONTRACT_ENFORCE_PRECONDITION_PARAMS_APPL_LAYER((NULL != format || 0 == cchFormat), "format string pointer may not be null unless length is zero");
        STLSOFT_SUPPRESS_UNUSED(cchFormat);

        FASTFORMAT_COVER_MARK_ENTRY();

        return format;
    }
    static char const* validate_message_(char const* message)
    {
        FASTFORMAT_CONTRACT_ENFORCE_PRECONDITION_PARAMS_APPL_LAYER(NULL != message, "message parameter may not be null");

        FASTFORMAT_COVER_MARK_ENTRY();

        return message;
    }
#endif /* !FASTFORMAT_DOCUMENTATION_SKIP_SECTION */
};

    class format_parsing_exception
        : public fastformat_exception
    {
    public: // Member Types
        typedef fastformat_exception                        parent_class_type;
        typedef format_parsing_exception                    class_type;
        typedef parent_class_type::multibyte_string_type    message_string_type;
        typedef parent_class_type::string_type              string_type;

    public: // Construction
        format_parsing_exception(char const* message, ff_parse_code_t code, ff_char_t const* format)
            : parent_class_type(validate_message_(message))
            , code(code)
            , format(validate_format_(format))
        {
            FASTFORMAT_COVER_MARK_ENTRY();
        }
        format_parsing_exception(char const* message, ff_parse_code_t code, ff_char_t const* format, size_t cchFormat)
            : parent_class_type(validate_message_(message))
            , code(code)
            , format(validate_format_(format, cchFormat), cchFormat)
        {
            FASTFORMAT_COVER_MARK_ENTRY();
        }
        virtual ~format_parsing_exception() stlsoft_throw_0() = 0;
    private:
        class_type& operator =(class_type const&);

    public: // Attributes
        const ff_parse_code_t   code;
        const string_type       format;
    };

        class illformed_format_exception
            : public format_parsing_exception
        {
        public: // Member Types
            typedef format_parsing_exception        parent_class_type;
            typedef illformed_format_exception      class_type;
            typedef parent_class_type::string_type  string_type;

        public: // Construction
            illformed_format_exception(char const* message, ff_parse_code_t code, ff_char_t const* format)
                : parent_class_type(message, code, format)
            {
                FASTFORMAT_COVER_MARK_ENTRY();
            }
            illformed_format_exception(char const* message, ff_parse_code_t code, ff_char_t const* format, size_t cchFormat)
                : parent_class_type(message, code, format, cchFormat)
            {
                FASTFORMAT_COVER_MARK_ENTRY();
            }
        private:
            class_type& operator =(class_type const&);
        };

    class mismatched_replacements_exception
        : public fastformat_exception
    {
    public: // Member Types
        typedef fastformat_exception                parent_class_type;
        typedef mismatched_replacements_exception   class_type;
        typedef parent_class_type::string_type      string_type;

    public: // Construction
        explicit mismatched_replacements_exception(char const* message, ff_replacement_code_t code, int numberOfReplacements, int firstMismatchedReplacementIndex)
            : parent_class_type(validate_message_(message))
            , code(code)
            , numberOfReplacements(numberOfReplacements)
            , firstMismatchedReplacementIndex(firstMismatchedReplacementIndex)
        {
            FASTFORMAT_COVER_MARK_ENTRY();
        }
        virtual ~mismatched_replacements_exception() stlsoft_throw_0() = 0;
    private:
        class_type& operator =(class_type const&);

    public: // Attributes
        const ff_replacement_code_t     code;
        const int                       numberOfReplacements;
        const int                       firstMismatchedReplacementIndex;
    };

        class missing_argument_exception
            : public mismatched_replacements_exception
        {
        public: // Member Types
            typedef mismatched_replacements_exception   parent_class_type;
            typedef missing_argument_exception          class_type;
            typedef parent_class_type::string_type      string_type;

        public: // Construction
            missing_argument_exception(char const* message, ff_replacement_code_t code, int numberOfReplacements, int firstMismatchedReplacementIndex)
                : parent_class_type(validate_message_(message), code, numberOfReplacements, firstMismatchedReplacementIndex)
            {
                FASTFORMAT_COVER_MARK_ENTRY();
            }
        private:
            class_type& operator =(class_type const&);
        };

        class unreferenced_argument_exception
            : public mismatched_replacements_exception
        {
        public: // Member Types
            typedef mismatched_replacements_exception   parent_class_type;
            typedef unreferenced_argument_exception     class_type;
            typedef parent_class_type::string_type      string_type;

        public: // Construction
            unreferenced_argument_exception(char const* message, ff_replacement_code_t code, int numberOfReplacements, int firstMismatchedReplacementIndex)
                : parent_class_type(validate_message_(message), code, numberOfReplacements, firstMismatchedReplacementIndex)
            {
                FASTFORMAT_COVER_MARK_ENTRY();
            }
        private:
            class_type& operator =(class_type const&);
        };

    class bundle_exception
        : public fastformat_exception
    {
    public: // Member Types
        typedef fastformat_exception                parent_class_type;
        typedef bundle_exception                    class_type;
        typedef parent_class_type::string_type      string_type;

    public: // Construction
        explicit bundle_exception(char const* message)
            : parent_class_type(validate_message_(message))
        {
            FASTFORMAT_COVER_MARK_ENTRY();
        }
        virtual ~bundle_exception() stlsoft_throw_0() = 0;
    private:
        class_type& operator =(class_type const&);
    };

/* /////////////////////////////////////////////////////////////////////////
 * Implementation
 */

#ifndef FASTFORMAT_DOCUMENTATION_SKIP_SECTION

inline /* virtual */ fastformat_exception::~fastformat_exception() stlsoft_throw_0() /* = 0 */
{}

inline /* virtual */ format_parsing_exception::~format_parsing_exception() stlsoft_throw_0() /* = 0 */
{}

inline /* virtual */ mismatched_replacements_exception::~mismatched_replacements_exception() stlsoft_throw_0() /* = 0 */
{}

inline /* virtual */ bundle_exception::~bundle_exception() stlsoft_throw_0() /* = 0 */
{}

#endif /* !FASTFORMAT_DOCUMENTATION_SKIP_SECTION */

/* /////////////////////////////////////////////////////////////////////////
 * Namespace
 */

#if !defined(FASTFORMAT_NO_NAMESPACE)
} /* namespace fastformat */
#endif /* !FASTFORMAT_NO_NAMESPACE */

/* /////////////////////////////////////////////////////////////////////////
 * Inclusion
 */

#ifdef STLSOFT_PPF_pragma_once_SUPPORT
# pragma once
#endif /* STLSOFT_PPF_pragma_once_SUPPORT */

/* ////////////////////////////////////////////////////////////////////// */

#endif /* FASTFORMAT_INCL_FASTFORMAT_HPP_EXCEPTIONS */

/* ///////////////////////////// end of file //////////////////////////// */

FastFormat Library documentation © Matthew Wilson, 2006-2009