Warning.h

Go to the documentation of this file.

// Copyright Onix Solutions Limited [OnixS]. All rights reserved.
//
// This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
// and international copyright treaties.
//
// Access to and use of the software is governed by the terms of the applicable OnixS Software
// Services Agreement (the Agreement) and Customer end user license agreements granting
// a non-assignable, non-transferable and non-exclusive license to use the software
// for it's own data processing purposes under the terms defined in the Agreement.
//
// Except as otherwise granted within the terms of the Agreement, copying or reproduction of any
// part of this source code or associated reference material to any other location for further
// reproduction or redistribution, and any amendments to this copyright notice, are expressly
// prohibited.
//
// Any reproduction or redistribution for sale or hiring of the Software not in accordance with
// the terms of the Agreement is a violation of copyright law.
//

#pragma once

#include "OnixS/CME/DropCopy/Export.h"
#include "OnixS/CME/DropCopy/Types.h"

namespace OnixS { namespace CME { namespace DropCopy {

/// List of known warnings.
struct ONIXS_CME_DROP_COPY_EXPORT KnownWarnings
{
    /// List of known warnings.
    enum Enum
    {
        /// General-purpose warning.
        Generic,

        /// Indicates failure in the user-space code.
        /// When the Handler catches exception from the
        /// user-space code, warning of given code reported.
        ListenerFailure
    };

    /// Returns constant from its text presentation.
    static Enum deserialize(const char* value);

    /// Returns description of a particular warning.
    static const char* toString(Enum value);
};

/// Code of warning.
typedef KnownWarnings::Enum WarningCode;

/// Warning.
class ONIXS_CME_DROP_COPY_EXPORT Warning
{
public:
    /// Initializes instance with just a code.
    Warning(const std::string& source, WarningCode code);

    /// Initializes instance with code and description.
    Warning(const std::string& source, WarningCode code, const std::string& description);

    /// Initializes as clone of another warning.
    Warning(const Warning& other);

    /// Cleans internal resources.
    ~Warning();

    /// Code of warning.
    WarningCode code() const;

    /// Human readable description.
    const char* description() const;

    /// Origin of the warning.
    const char* source() const;

    /// String presentation of an warning.
    std::string toString() const;

    /// Appends presentation of an warning to the string.
    void toString(std::string&) const;

    /// Copies warning attributes from another instance.
    Warning& operator=(const Warning& other);

private:
    enum Traits
    {
        SourceMaxLength = 128,
        DescriptionMaxLength = 1024
    };

    WarningCode code_;
    char source_[SourceMaxLength];
    char description_[DescriptionMaxLength];
};

inline WarningCode Warning::code() const
{
    return code_;
}

inline const char* Warning::description() const
{
    return description_;
}

inline const char* Warning::source() const
{
    return source_;
}

inline std::string Warning::toString() const
{
    std::string str;
    toString(str);
    return str;
}

}}}

namespace std {
// Outputs message into standard stream.
ONIXS_CME_DROP_COPY_EXPORT std::ostream&
operator<<(std::ostream&, const OnixS::CME::DropCopy::Warning&);
}