function.h

// Copyright 2021 The Pigweed Authors
//
// 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
//
//     https://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.
#pragma once
 
#include <cstddef>
 
#include "lib/fit/function.h"
#include "pw_function/config.h"
 
namespace pw {
 
 
template <typename FunctionType>
using Function = fit::function_impl<
    function_internal::config::kInlineCallableSize,
    /*require_inline=*/!function_internal::config::kEnableDynamicAllocation,
    FunctionType,
    PW_FUNCTION_DEFAULT_ALLOCATOR_TYPE>;
 
// TODO: b/252852651 - Remove warning above when conversion from
// `fit::inline_function` to `fit::function` doesn't allocate anymore.
template <typename FunctionType,
          std::size_t inline_target_size =
              function_internal::config::kInlineCallableSize>
using InlineFunction = fit::inline_function<FunctionType, inline_target_size>;
 
template <typename FunctionType,
          std::size_t inline_target_size =
              function_internal::config::kInlineCallableSize,
          typename Allocator = PW_FUNCTION_DEFAULT_ALLOCATOR_TYPE>
using DynamicFunction = fit::function_impl<inline_target_size,
                                           /*require_inline=*/false,
                                           FunctionType,
                                           Allocator>;
 
using Closure = Function<void()>;
 
template <typename FunctionType>
using Callback = fit::callback_impl<
    function_internal::config::kInlineCallableSize,
    /*require_inline=*/!function_internal::config::kEnableDynamicAllocation,
    FunctionType,
    PW_FUNCTION_DEFAULT_ALLOCATOR_TYPE>;
 
template <typename FunctionType,
          std::size_t inline_target_size =
              function_internal::config::kInlineCallableSize>
using InlineCallback = fit::inline_callback<FunctionType, inline_target_size>;
 
template <typename FunctionType,
          std::size_t inline_target_size =
              function_internal::config::kInlineCallableSize,
          typename Allocator = PW_FUNCTION_DEFAULT_ALLOCATOR_TYPE>
using DynamicCallback = fit::callback_impl<inline_target_size,
                                           /*require_inline=*/false,
                                           FunctionType,
                                           Allocator>;
 
template <auto method, typename T>
auto bind_member(T* instance) {
  return fit::bind_member<method, T>(instance);
}
 
 
}  // namespace pw