tts::scoped_sink Class Reference

RAII guard installing an output_sink for its scope, restoring the previous one on exit. More...

Detailed Description

RAII guard installing an output_sink for its scope, restoring the previous one on exit.

Saves whichever output_sink is currently installed on tts::output(), installs s, then restores the saved one once the guard goes out of scope - even through an early return or an exception.

Example

#define TTS_MAIN
#define TTS_CUSTOM_DRIVER_FUNCTION custom_sink_main
#include <tts/tts.hpp>
 
// A power-user output_sink prefixing every message TTS writes before forwarding it to stdout.
struct prefixed_sink : tts::output_sink
{
  int  messages = 0;
 
  void write(tts::text const& t) override
  {
    messages++;
    if(t != "\n") fputs("[MY-TTS] ", stdout);
    fputs(t.data(), stdout);
  }
};
 
TTS_CASE("Some test running through our custom output_sink")
{
  TTS_EXPECT(1 == 1);
};
 
int main(int argc, char const** argv)
{
  ::tts::initialize(argc, argv);
 
  prefixed_sink sink;
  {
    tts::scoped_sink scope(sink); // Install our custom sink for this scope...
    custom_sink_main(argc, argv); // ...run the test suite through it...
  } // ...then automatically restore the previous one.
 
  printf("Our custom output_sink received %d message(s)\n", sink.messages);
 
  return tts::report(0, 0);
}

See also

tts::output_sink

tts::output_handler

Public Member Functions
	scoped_sink (output_sink &s)
	Installs s as the current output_sink, saving whichever one was previously installed.