arg-packs.h

Go to the documentation of this file.

// Copyright 2005-2024 Google LLC
//
// 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.
//
// See www.openfst.org for extensive documentation on this weighted
// finite-state transducer library.
//
// std::pair and std::tuple are used for the arguments of FstClass operations.
//
// If a function with a return value is required, use the WithReturnValue
// template as follows:
//
// WithReturnValue<bool, std::tuple<...>>

#ifndef FST_SCRIPT_ARG_PACKS_H_
#define FST_SCRIPT_ARG_PACKS_H_

#include <type_traits>

namespace fst {
namespace script {

// Tack this on to an existing type to add a return value. The syntax for
// accessing the args is then slightly more stilted, as you must do an extra
// member access (since the args are stored as a member of this class).

template <class Retval, class ArgTuple>
struct WithReturnValue {
  // Avoid reference-to-reference if ArgTuple is a reference.
  using Args = std::remove_reference_t<ArgTuple>;

  Retval retval;
  const Args &args;

  explicit WithReturnValue(const Args &args) : args(args) {}
};

}  // namespace script
}  // namespace fst

#endif  // FST_SCRIPT_ARG_PACKS_H_