output.h

/*
 *  Copyright (c) 2004-2008    National Research Council
 *
 *  All rights reserved.
 *
 *  This material is confidential and proprietary information of
 *  National Research Council Canada ("Confidential Information").
 *  This Confidential Information may only be used and reproduced
 *  in accordance with the terms of the license agreement.
 *
 */

#ifndef __INCLUDED_SCOPIRA_TOOL_OUTPUT_H__
#define __INCLUDED_SCOPIRA_TOOL_OUTPUT_H__

// we'll include this as a convinience to users that include output.h
#include <scopira/tool/flow.h>
#include <scopira/tool/export.h>

namespace scopira
{
  namespace tool
  {
    typedef scopira::tool::oflow_i& (*output_func)(void);

    SCOPIRA_EXPORT extern scopira::tool::output_func gm_tool_output;

    scopira::tool::oflow_i& tool_output(void);

    SCOPIRA_EXPORT extern scopira::tool::oflow_i *gm_tool_output_stream;

    class output_stack;
  }
}

#ifndef OUTPUT
#define OUTPUT (scopira::tool::gm_tool_output())
#endif

class scopira::tool::output_stack
{
  private:
    output_func dm_oldfunc;
    oflow_i *dm_oldflow;
  public:
    output_stack(oflow_i *newflow)
      : dm_oldfunc(gm_tool_output), dm_oldflow(gm_tool_output_stream) {
      gm_tool_output = tool_output;
      gm_tool_output_stream = newflow;
    }

    output_stack(output_func newfunc)
      : dm_oldfunc(gm_tool_output), dm_oldflow(gm_tool_output_stream) {
      gm_tool_output = newfunc;
      gm_tool_output_stream = 0;
    }

    // dtor does a stack pop, that is, restores the old values
    ~output_stack() {
      gm_tool_output = dm_oldfunc;
      gm_tool_output_stream = dm_oldflow;
    }
};

#endif