skeletons.hpp

Go to the documentation of this file.

// MIT License
//
// Copyright (c) 2020, The Regents of the University of California,
// through Lawrence Berkeley National Laboratory (subject to receipt of any
// required approvals from the U.S. Dept. of Energy).  All rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
/** \file components/skeletons.hpp
 * \headerfile components/skeletons.hpp "timemory/components/skeletons.hpp"
 *
 * These provide fake types for heavyweight types w.r.t. templates. In general,
 * if a component is templated or contains a lot of code, create a skeleton
 * and in \ref timemory/components/types.hpp use an #ifdef to provide the skeleton
 * instead. Also, make sure the component file is not directly included.
 * If the type uses callbacks, emulate the callbacks here.
 *
 */
 
#pragma once
 
//======================================================================================//
//
namespace tim
{
namespace component
{
namespace skeleton
{
struct base
{};
}  // namespace skeleton
 
//--------------------------------------------------------------------------------------//
 
template <typename Tp, typename Vp>
struct base;
 
//--------------------------------------------------------------------------------------//
 
template <typename Tp>
struct base<Tp, skeleton::base>
{
    using Type       = Tp;
    using value_type = void;
    using base_type  = base<Tp, skeleton::base>;
};
 
//--------------------------------------------------------------------------------------//
 
}  // namespace component
}  // namespace tim