bdlat_typetraits

Detailed Description

Provide compile-time traits for generated types.

Outline

• Purpose
• Classes
• Macros
• Description
  • Usage

Purpose

Provide compile-time traits for generated types.

Classes

• bdlat_IsBasicChoice<TYPE>: true for generated "choice" types
• bdlat_IsBasicSequence<TYPE>: true for generated "sequence" types
• bdlat_IsBasicEnumeration<TYPE>: true for generated "enumeration" types
• bdlat_HasFallbackEnumerator<TYPE>: true for generated "enumeration" types
• that have a "fallback" enumerator
• bdlat_BasicEnumerationWrapper<TYPE>: characteristics of enumeration type
• bdlat_IsBasicCustomizedType<TYPE>: true for generated "customized" types
• bdlat_UsesDefaultValueFlag<TYPE>: true for generated "sequence" types
• that use e_DEFAULT_VALUE fmt flag

Macros

• BDLAT_DECL_CHOICE_TRAITS(ClassName)
• BDLAT_DECL_CHOICE_WITH_ALLOCATOR_TRAITS(ClassName)
• BDLAT_DECL_CHOICE_WITH_BITWISEMOVEABLE_TRAITS(ClassName)
• BDLAT_DECL_CHOICE_WITH_ALLOCATOR_BITWISEMOVEABLE_TRAITS(ClassName)
• BDLAT_DECL_SEQUENCE_TRAITS(ClassName)
• BDLAT_DECL_SEQUENCE_WITH_ALLOCATOR_TRAITS(ClassName)
• BDLAT_DECL_SEQUENCE_WITH_BITWISEMOVEABLE_TRAITS(ClassName)
• BDLAT_DECL_SEQUENCE_WITH_ALLOCATOR_BITWISEMOVEABLE_TRAITS(ClassName)
• BDLAT_DECL_ENUMERATION_TRAITS(ClassName)
• BDLAT_DECL_ENUMERATION_WITH_FALLBACK_TRAITS(ClassName)
• BDLAT_DECL_CUSTOMIZEDTYPE_TRAITS(ClassName)
• BDLAT_DECL_CUSTOMIZEDTYPE_WITH_ALLOCATOR_TRAITS(ClassName)
• BDLAT_DECL_CUSTOMIZEDTYPE_WITH_BITWISEMOVEABLE_TRAITS(ClassName)
• BDLAT_DECL_CUSTOMIZEDTYPE_WITH_ALLOCATOR_BITWISEMOVEABLE_TRAITS(ClassName)

See also

Description

This component provides compile-time traits that pertain to generated types. The five traits provided, bdlat_IsBasicChoice, bdlat_IsBasicSequence, bdlat_IsBasicEnumeration, bdlat_HasFallbackEnumerator, bdlat_IsBasicCustomizedType are used for generated "choice" types, "sequence" types, "enumeration", "enumeration" with fallback enumerator, and "customized type" types respectively.

Usage

This component is intended to be used by components generated using the bas_codegen.pl tool.

Classes
struct	bdlat_IsBasicChoice< TYPE >
struct	bdlat_IsBasicSequence< TYPE >
struct	bdlat_IsBasicEnumeration< TYPE >
struct	bdlat_HasFallbackEnumerator< TYPE >
struct	bdlat_IsBasicCustomizedType< TYPE >
struct	bdlat_UsesDefaultValueFlag< TYPE >
struct	bdlat_BasicEnumerationWrapper< TYPE >
struct	bdlat_TypeTraitBasicChoice
struct	bdlat_TypeTraitBasicSequence
struct	bdlat_TypeTraitBasicEnumeration
struct	bdlat_TypeTraitHasFallbackEnumerator
struct	bdlat_TypeTraitBasicCustomizedType

Macro Definition Documentation

BDLAT_DECL_CHOICE_TRAITS

#define BDLAT_DECL_CHOICE_TRAITS

(

ClassName

)

Value:

    template <>                                                               \
    struct bdlat_IsBasicChoice<ClassName> : bsl::true_type { };               \
    namespace bdlb {                                                          \
        template <>                                                           \
        struct HasPrintMethod<ClassName> : bsl::true_type { };                \
    }

BDLAT_DECL_CHOICE_WITH_ALLOCATOR_BITWISEMOVEABLE_TRAITS

#define BDLAT_DECL_CHOICE_WITH_ALLOCATOR_BITWISEMOVEABLE_TRAITS

(

ClassName

)

Value:

    namespace bslma {                                                         \
        template <>                                                           \
        struct UsesBslmaAllocator<ClassName> : bsl::true_type { };            \
    }                                                                         \
    namespace bslmf {                                                         \
        template <>                                                           \
        struct IsBitwiseMoveable<ClassName> : bsl::true_type { };             \
    }                                                                         \
    BDLAT_DECL_CHOICE_TRAITS(ClassName)

BDLAT_DECL_CHOICE_WITH_ALLOCATOR_TRAITS

#define BDLAT_DECL_CHOICE_WITH_ALLOCATOR_TRAITS

(

ClassName

)

Value:

    namespace bslma {                                                         \
        template <>                                                           \
        struct UsesBslmaAllocator<ClassName> : bsl::true_type { };            \
    }                                                                         \
    BDLAT_DECL_CHOICE_TRAITS(ClassName)

BDLAT_DECL_CHOICE_WITH_BITWISEMOVEABLE_TRAITS

#define BDLAT_DECL_CHOICE_WITH_BITWISEMOVEABLE_TRAITS

(

ClassName

)

Value:

    namespace bslmf {                                                         \
        template <>                                                           \
        struct IsBitwiseMoveable<ClassName> : bsl::true_type { };             \
    }                                                                         \
    BDLAT_DECL_CHOICE_TRAITS(ClassName)

BDLAT_DECL_CUSTOMIZEDTYPE_TRAITS

#define BDLAT_DECL_CUSTOMIZEDTYPE_TRAITS

(

ClassName

)

Value:

    template <>                                                               \
    struct bdlat_IsBasicCustomizedType<ClassName> : bsl::true_type { };       \
    namespace bdlb {                                                          \
        template <>                                                           \
        struct HasPrintMethod<ClassName> : bsl::true_type { };                \
    }

BDLAT_DECL_CUSTOMIZEDTYPE_WITH_ALLOCATOR_BITWISEMOVEABLE_TRAITS

#define BDLAT_DECL_CUSTOMIZEDTYPE_WITH_ALLOCATOR_BITWISEMOVEABLE_TRAITS

(

ClassName

)

Value:

    namespace bslma {                                                         \
        template <>                                                           \
        struct UsesBslmaAllocator<ClassName> : bsl::true_type { };            \
    }                                                                         \
    namespace bslmf {                                                         \
        template <>                                                           \
        struct IsBitwiseMoveable<ClassName> : bsl::true_type { };             \
    }                                                                         \
    BDLAT_DECL_CUSTOMIZEDTYPE_TRAITS(ClassName)

BDLAT_DECL_CUSTOMIZEDTYPE_WITH_ALLOCATOR_TRAITS

#define BDLAT_DECL_CUSTOMIZEDTYPE_WITH_ALLOCATOR_TRAITS

(

ClassName

)

Value:

    namespace bslma {                                                         \
        template <>                                                           \
        struct UsesBslmaAllocator<ClassName> : bsl::true_type { };            \
    }                                                                         \
    BDLAT_DECL_CUSTOMIZEDTYPE_TRAITS(ClassName)

BDLAT_DECL_CUSTOMIZEDTYPE_WITH_BITWISEMOVEABLE_TRAITS

#define BDLAT_DECL_CUSTOMIZEDTYPE_WITH_BITWISEMOVEABLE_TRAITS

(

ClassName

)

Value:

    namespace bslmf {                                                         \
        template <>                                                           \
        struct IsBitwiseMoveable<ClassName> : bsl::true_type { };             \
    }                                                                         \
    BDLAT_DECL_CUSTOMIZEDTYPE_TRAITS(ClassName)

BDLAT_DECL_ENUMERATION_TRAITS

#define BDLAT_DECL_ENUMERATION_TRAITS

(

ClassName

)

Value:

    namespace bslmf {                                                         \
        template <>                                                           \
        struct IsBitwiseMoveable<ClassName::Value> : bsl::true_type { };      \
    }                                                                         \
    template <>                                                               \
    struct bdlat_IsBasicEnumeration<ClassName::Value> : bsl::true_type { };   \
    template <>                                                               \
    struct bdlat_BasicEnumerationWrapper<ClassName::Value> : ClassName {      \
        typedef ClassName Wrapper;                                            \
    };

BDLAT_DECL_ENUMERATION_WITH_FALLBACK_TRAITS

#define BDLAT_DECL_ENUMERATION_WITH_FALLBACK_TRAITS

(

ClassName

)

Value:

    BDLAT_DECL_ENUMERATION_TRAITS(ClassName)                                  \
    template <>                                                               \
    struct bdlat_HasFallbackEnumerator<ClassName::Value> : bsl::true_type { };

BDLAT_DECL_SEQUENCE_TRAITS

#define BDLAT_DECL_SEQUENCE_TRAITS

(

ClassName

)

Value:

    template <>                                                               \
    struct bdlat_IsBasicSequence<ClassName> : bsl::true_type { };             \
    namespace bdlb {                                                          \
        template <>                                                           \
        struct HasPrintMethod<ClassName> : bsl::true_type { };                \
    }

BDLAT_DECL_SEQUENCE_WITH_ALLOCATOR_BITWISEMOVEABLE_TRAITS

#define BDLAT_DECL_SEQUENCE_WITH_ALLOCATOR_BITWISEMOVEABLE_TRAITS

(

ClassName

)

Value:

    namespace bslma {                                                         \
        template <>                                                           \
        struct UsesBslmaAllocator<ClassName> : bsl::true_type { };            \
    }                                                                         \
    namespace bslmf {                                                         \
        template <>                                                           \
        struct IsBitwiseMoveable<ClassName> : bsl::true_type { };             \
    }                                                                         \
    BDLAT_DECL_SEQUENCE_TRAITS(ClassName)

BDLAT_DECL_SEQUENCE_WITH_ALLOCATOR_TRAITS

#define BDLAT_DECL_SEQUENCE_WITH_ALLOCATOR_TRAITS

(

ClassName

)

Value:

    namespace bslma {                                                         \
        template <>                                                           \
        struct UsesBslmaAllocator<ClassName> : bsl::true_type { };            \
    }                                                                         \
    BDLAT_DECL_SEQUENCE_TRAITS(ClassName)

BDLAT_DECL_SEQUENCE_WITH_BITWISEMOVEABLE_TRAITS

#define BDLAT_DECL_SEQUENCE_WITH_BITWISEMOVEABLE_TRAITS

(

ClassName

)

Value:

    namespace bslmf {                                                         \
        template <>                                                           \
        struct IsBitwiseMoveable<ClassName> : bsl::true_type { };             \
    }                                                                         \
    BDLAT_DECL_SEQUENCE_TRAITS(ClassName)