// bdlat_selectioninfo.h                                              -*-C++-*-
#ifndef INCLUDED_BDLAT_SELECTIONINFO
#define INCLUDED_BDLAT_SELECTIONINFO

#include <bsls_ident.h>
BSLS_IDENT("$Id: $")

//@PURPOSE: Provide a container for selection information.
//
//@CLASSES:
//  bdlat_SelectionInfo: container for selection information
//
//@SEE_ALSO: bdlat_choicefunctions
//
//@DESCRIPTION: This component provides the `bdlat_SelectionInfo` `struct`,
// which is a container for holding information (properties) about a choice
// selection.  The properties of a selection include its name and the length of
// its name, its distinct id within its containing type, its formatting mode,
// and a brief annotation.  Although each selection property is publicly
// accessible, a manipulator and accessor is also supplied for each.
//
// When accessing or manipulating a selection of a "choice" type (using one of
// the functions from the `bdlat_ChoiceFunctions` namespace), an instance of
// this `struct` will be passed as the second argument to the accessor or
// manipulator.
//
// Note that this `struct` needs to be a POD type.
//
///Usage
///-----
// This section illustrates intended use of this component.
//
///Example 1: Basic Usage
/// - - - - - - - - - - -
// Suppose you create an accessor for choice selections that prints the
// selection to an output stream:
// ```
// #include <bdlat_selectioninfo.h>
// #include <ostream>
//
// using namespace BloombergLP;
//
// class PrintSelectionWithInfo {
//     // Print the selection along with its name and annotation.
//
//     // PRIVATE DATA MEMBERS
//     bsl::ostream *d_stream_p;
//
//   public:
//     // CREATORS
//     PrintSelectionWithInfo(bsl::ostream *stream)
//     : d_stream_p(stream)
//     {
//     }
//
//     // OPERATIONS
//     template <typename TYPE>
//     int operator()(const TYPE&                selection,
//                    const bdlat_SelectionInfo& info)
//     {
//         (*d_stream_p) << selection << " ("
//                       << bsl::string(info.name(),
//                                      info.nameLength())
//                       << ", "
//                       << info.annotation() << ")\n";
//     }
// };
// ```

#include <bdlscm_version.h>

#include <bdlat_bdeatoverrides.h>

#include <bslmf_istriviallycopyable.h>
#include <bslmf_istriviallydefaultconstructible.h>
#include <bslmf_nestedtraitdeclaration.h>

#include <bsls_keyword.h>

#include <bsl_climits.h>
#include <bsl_cstring.h>
#include <bsl_iosfwd.h>

#ifndef BDE_DONT_ALLOW_TRANSITIVE_INCLUDES
#include <bslalg_typetraits.h>
#endif // BDE_DONT_ALLOW_TRANSITIVE_INCLUDES

namespace BloombergLP {

                         // ==========================
                         // struct bdlat_SelectionInfo
                         // ==========================

/// This `struct` holds information about an selection.  Its data members
/// are `public` by design so that instances may be statically initialized.
struct bdlat_SelectionInfo {

    // PUBLIC DATA -- DO *NOT* REORDER
    int         d_id;              // distinct id of selection
    const char *d_name_p;          // name of selection
    int         d_nameLength;      // length of selection name (0-terminator
                                   // not included)
    const char *d_annotation_p;    // selection annotation
    int         d_formattingMode;  // formatting mode

    // TRAITS
    BSLMF_NESTED_TRAIT_DECLARATION(bdlat_SelectionInfo,
                                   bsl::is_trivially_copyable);
    BSLMF_NESTED_TRAIT_DECLARATION(bdlat_SelectionInfo,
                                   bsl::is_trivially_default_constructible);

    // CREATORS

    // The following methods are not defined by design:
    //..
    //   bdlat_SelectionInfo();
    //   bdlat_SelectionInfo(const bdlat_SelectionInfo& original);
    //   ~bdlat_SelectionInfo();
    //..
    // The corresponding methods supplied by the compiler are sufficient.

    // MANIPULATORS

    // The following method is not defined by design:
    //..
    //   bdlat_SelectionInfo& operator=(const bdlat_SelectionInfo& rhs);
    //..
    // The assignment operator supplied by the compiler is sufficient.

    /// Return a reference to the modifiable annotation of this selection
    /// info object.
    const char *& annotation();

    /// Return a reference to the modifiable formatting mode of this
    /// selection info object.
    int& formattingMode();

    /// Return a reference to the modifiable id of this selection info
    /// object.
    int& id();

    /// Return a reference to the modifiable name of this selection info
    /// object.
    const char *& name();

    /// Return a reference to the modifiable length of the name of this
    /// selection info object.  Note that the 0-terminator is not included
    /// in the length.
    int& nameLength();

    // ACCESSORS

    /// Return the non-modifiable annotation of this selection info object.
    BSLS_KEYWORD_CONSTEXPR
    const char *annotation() const;

    /// Return the formatting mode of this selection info object.
    BSLS_KEYWORD_CONSTEXPR
    int formattingMode() const;

    /// Return the id of this selection info object.
    BSLS_KEYWORD_CONSTEXPR
    int id() const;

    /// Return the non-modifiable name of this selection info object.
    BSLS_KEYWORD_CONSTEXPR
    const char *name() const;

    /// Return the length of the name of this selection info object.  Note
    /// that the 0-terminator is not included in the length.
    BSLS_KEYWORD_CONSTEXPR
    int nameLength() const;
};

// ============================================================================
//                            INLINE DEFINITIONS
// ============================================================================

// FREE OPERATORS

/// Return `true` if the specified `lhs` and `rhs` selection info objects
/// have the same value, and `false` otherwise.  Two selection info objects
/// have the same value if each of their respective properties are
/// identical.
inline
bool operator==(const bdlat_SelectionInfo& lhs,
                const bdlat_SelectionInfo& rhs);

/// Return `true` if the specified `lhs` and `rhs` selection info objects do
/// not have the same value, and `false` otherwise.  Two selection info
/// objects do not have the same value if at least one of their respective
/// properties is not identical.
inline
bool operator!=(const bdlat_SelectionInfo& lhs,
                const bdlat_SelectionInfo& rhs);

/// Write the value of the specified `selectionInfo` to the specified
/// `stream`.
bsl::ostream& operator<<(bsl::ostream&              stream,
                         const bdlat_SelectionInfo& selectionInfo);

// MANIPULATORS
inline
const char *& bdlat_SelectionInfo::annotation()
{
    return d_annotation_p;
}

inline
int& bdlat_SelectionInfo::formattingMode()
{
    return d_formattingMode;
}

inline
int& bdlat_SelectionInfo::id()
{
    return d_id;
}

inline
const char *& bdlat_SelectionInfo::name()
{
    return d_name_p;
}

inline
int& bdlat_SelectionInfo::nameLength()
{
    return d_nameLength;
}

// ACCESSORS
inline
BSLS_KEYWORD_CONSTEXPR
const char *bdlat_SelectionInfo::annotation() const
{
    return d_annotation_p;
}

inline
BSLS_KEYWORD_CONSTEXPR
int bdlat_SelectionInfo::formattingMode() const
{
    return d_formattingMode;
}

inline
BSLS_KEYWORD_CONSTEXPR
int bdlat_SelectionInfo::id() const
{
    return d_id;
}

inline
BSLS_KEYWORD_CONSTEXPR
const char *bdlat_SelectionInfo::name() const
{
    return d_name_p;
}

inline
BSLS_KEYWORD_CONSTEXPR
int bdlat_SelectionInfo::nameLength() const
{
    return d_nameLength;
}

// FREE OPERATORS

inline
bool operator==(const bdlat_SelectionInfo& lhs, const bdlat_SelectionInfo& rhs)
{
    return lhs.formattingMode() == rhs.formattingMode()
        && lhs.id()             == rhs.id()
        && lhs.nameLength()     == rhs.nameLength()
        && 0 == bsl::strncmp(lhs.name(), rhs.name(), lhs.nameLength())
        && 0 == bsl::strcmp(lhs.annotation(), rhs.annotation());
}

inline
bool operator!=(const bdlat_SelectionInfo& lhs, const bdlat_SelectionInfo& rhs)
{
    return !(lhs == rhs);
}

}  // close enterprise namespace

#endif

// ----------------------------------------------------------------------------
// Copyright 2015 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
