OpenSTA/include/sta/ReportTcl.hh

// OpenSTA, Static Timing Analyzer
// Copyright (c) 2024, Parallax Software, Inc.
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

#pragma once

#include <tcl.h>

#include "Report.hh"

namespace sta {

// Encapsulate the Tcl stdout and stderr channels to print to the
// report object so that the output from Tcl puts and errors can be
// logged and redirected.
//
// Output streams that talk to TCL channels.
// This directs all output on the Report object to the Tcl stdout channel.
// Tcl output channels are encapsulated to print to the Report object
// that supports redirection and logging as well as printing to the
// underlying channel.
class ReportTcl : public Report
{
public:
  ReportTcl();
  virtual ~ReportTcl();
  virtual void logBegin(const char *filename);
  virtual void logEnd();
  virtual void redirectFileBegin(const char *filename);
  virtual void redirectFileAppendBegin(const char *filename);
  virtual void redirectFileEnd();
  virtual void redirectStringBegin();
  virtual const char *redirectStringEnd();
  // This must be called after the Tcl interpreter has been constructed.
  // It makes the encapsulated channels.
  virtual void setTclInterp(Tcl_Interp *interp);

protected:
  virtual size_t printConsole(const char *buffer,
                              size_t length);
  void flush();

private:
  Tcl_ChannelType *makeEncapChannelType(Tcl_Channel channel,
					char *channel_name,
					Tcl_DriverOutputProc output_proc);
  size_t printTcl(Tcl_Channel channel,
                  const char *buffer,
                  size_t length);

  Tcl_Interp *interp_;
  // The original tcl channels.
  Tcl_Channel tcl_stdout_;
  Tcl_Channel tcl_stderr_;
  // Encapsulated channels that print on this object.
  Tcl_Channel tcl_encap_stdout_;
  Tcl_Channel tcl_encap_stderr_;
};

} // namespace