//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef SDF_DECLARE_SPEC_H
#define SDF_DECLARE_SPEC_H

#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/usd/sdf/specType.h"
#include "pxr/base/tf/registryManager.h"
#include "pxr/base/tf/type.h"

class SdfSpec;

/// Helper macros for implementing C++ spec classes corresponding to
/// the various scene description spec types defined by Sdf. There are
/// two macros that each C++ spec class must invoke, one in the class
/// definition and one in the implementation .cpp file. For example:
///
/// <in MySpecType.h>
/// class MySpecType : public MyBaseSpecType {
///     SDF_DECLARE_SPEC(MySpecType, MyBaseSpecType);
///     ...
/// };
///
/// <in MySpecType.cpp>
/// SDF_DEFINE_SPEC(MySpecType, MyBaseSpecType);
///
/// There are two sets of these macros, one for concrete spec types
/// and one for 'abstract' spec types that only serve as a base class
/// for concrete specs.
///
#define SDF_DECLARE_ABSTRACT_SPEC(SchemaType, SpecType, BaseSpecType)      \
public:                                                                    \
    SpecType() { }                                                         \
    SpecType(const SpecType& spec)                                         \
        : BaseSpecType(spec) { }                                           \
    explicit SpecType(const Sdf_IdentityRefPtr& identity)                  \
        : BaseSpecType(identity) { }                                       \
protected:                                                                 \
    friend class Sdf_CastAccess;                                           \
    explicit SpecType(const SdfSpec& spec)                                 \
        : BaseSpecType(spec) { }                                           \
public:                                                                    \
    static const std::type_info& GetSchemaType()                           \
    { return typeid(SchemaType); }                                         \

#define SDF_DEFINE_ABSTRACT_SPEC(SpecType, BaseSpecType)                   \
TF_REGISTRY_FUNCTION(TfType)                                               \
{                                                                          \
    TfType::Define<SpecType, TfType::Bases<BaseSpecType> >();              \
}                                                                          \
TF_REGISTRY_FUNCTION(SdfSpecTypeRegistration)                              \
{                                                                          \
    SdfSpecTypeRegistration::RegisterAbstractSpecType<SpecType>();         \
}

// ------------------------------------------------------------

#define SDF_DECLARE_SPEC(SchemaType, SpecTypeEnum, SpecType, BaseSpecType) \
    SDF_DECLARE_ABSTRACT_SPEC(SchemaType, SpecType, BaseSpecType)          \
public:                                                                    \
    static SdfSpecType GetStaticSpecType() { return SpecTypeEnum; }        \

#define SDF_DEFINE_SPEC(SpecType, BaseSpecType)                            \
TF_REGISTRY_FUNCTION(TfType)                                               \
{                                                                          \
    TfType::Define<SpecType, TfType::Bases<BaseSpecType> >();              \
}                                                                          \
TF_REGISTRY_FUNCTION(SdfSpecTypeRegistration)                              \
{                                                                          \
    SdfSpecTypeRegistration::RegisterSpecType<SpecType>();                 \
}

// ------------------------------------------------------------
// Special set of macros for SdfSpec only.

#define SDF_DECLARE_BASE_SPEC(SchemaType, SpecType)                        \
public:                                                                    \
    SpecType() { }                                                         \
    SpecType(const SpecType& spec) : _id(spec._id) { }                     \
    explicit SpecType(const Sdf_IdentityRefPtr& id) : _id(id) { }          \
public:                                                                    \
    static const std::type_info& GetSchemaType()                           \
    { return typeid(SchemaType); }                                         \

#define SDF_DEFINE_BASE_SPEC(SpecType)                                     \
TF_REGISTRY_FUNCTION(TfType)                                               \
{                                                                          \
    TfType::Define<SpecType>();                                            \
}                                                                          \
TF_REGISTRY_FUNCTION(SdfSpecTypeRegistration)                              \
{                                                                          \
    SdfSpecTypeRegistration::RegisterAbstractSpecType<SpecType>();         \
}

#endif // SDF_DECLARE_SPEC_H
