fmt::formatter< Gaudi::Property< T, V, H > > Struct Template Reference

Definitions to allow use of Gaudi::Property<T> with fmtlib. More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/Gaudi/PropertyFmt.h>

Inheritance diagram for fmt::formatter< Gaudi::Property< T, V, H > >:

Collaboration diagram for fmt::formatter< Gaudi::Property< T, V, H > >:

Public Member Functions
constexpr auto	parse (format_parse_context &ctx) -> format_parse_context::iterator
auto	format (const Gaudi::Property< T, V, H > &p, format_context &ctx)

Public Attributes
bool	debug = false

Detailed Description

template<typename T, typename V, typename H>
struct fmt::formatter< Gaudi::Property< T, V, H > >

Definitions to allow use of Gaudi::Property<T> with fmtlib.

When this header is included, one can pass a Gaudi::Property<T> instance as argument to fmt::format.

For example

#include <Gaudi/Property.h>
#include <Gaudi/PropertyFmt.h>
#include <fmt/format.h>
 
int main() {
  Gaudi::Property<int> p{ "MyProp", 20 };
  fmt::print( "property {} has value {}\n", p.name(), p );
}

will print

property MyProp has value 20

A special formatting option can be used to print the property name as well as the value, so

#include <Gaudi/Property.h>
#include <Gaudi/PropertyFmt.h>
#include <fmt/format.h>
#include <iostream>
 
int main() {
  Gaudi::Property<int> p{ "MyProp", 20 };
 
  std::cout << "cout" << p << '\n';
  fmt::print( "fmt {:?}\n", p );
}

will print

cout 'MyProp':20
fmt  'MyProp':20

Definition at line 60 of file PropertyFmt.h.

Member Function Documentation

format()

template<typename T , typename V , typename H >

auto fmt::formatter< Gaudi::Property< T, V, H > >::format ( const Gaudi::Property< T, V, H > &  p, format_context &  ctx  )

inline

Definition at line 72 of file PropertyFmt.h.

  {
    if ( debug ) {
      if constexpr ( std::is_same_v<T, std::string> ) {
        std::stringstream s;
        s << std::quoted( p.value(), '\'' );
        return fmt::format_to( ctx.out(), " '{}':{}", p.name(), s.str() );
      } else {
        return fmt::format_to( ctx.out(), " '{}':{}", p.name(), p.value() );
      }
    } else {
      return formatter<T>::format( static_cast<const T&>( p ), ctx );
    }
  }

parse()

template<typename T , typename V , typename H >

constexpr auto fmt::formatter< Gaudi::Property< T, V, H > >::parse ( format_parse_context &  ctx ) -> format_parse_context::iterator

inlineconstexpr

Definition at line 62 of file PropertyFmt.h.

                                                                                    {
    auto it = ctx.begin(), end = ctx.end();
    if ( it != end && *it == '?' ) {
      debug = true;
      ++it;
      if ( it != end && *it != '}' ) detail::error_handler().on_error( "invalid format" );
      return it;
    }
    return formatter<T>::parse( ctx );
  }

Member Data Documentation

debug

template<typename T , typename V , typename H >

bool fmt::formatter< Gaudi::Property< T, V, H > >::debug = false

Definition at line 61 of file PropertyFmt.h.

---

The documentation for this struct was generated from the following file:

• GaudiKernel/include/Gaudi/PropertyFmt.h