debug_io.h

Go to the documentation of this file.

/*
**  Command & Conquer Generals Zero Hour(tm)
**  Copyright 2025 Electronic Arts 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 <http://www.gnu.org/licenses/>.
*/

// $File: //depot/GeneralsMD/Staging/code/Libraries/Source/debug/debug_io.h $
// $Author: mhoffe $
// $Revision: #1 $
// $DateTime: 2003/07/03 11:55:26 $
//
// ©2003 Electronic Arts
//
// Debug I/O interface
#ifdef _MSC_VER
#  pragma once
#endif
#ifndef DEBUG_IO_H // Include guard
#define DEBUG_IO_H

class DebugIOInterface
{
  // no copy/assign op
  DebugIOInterface(const &DebugIOInterface);
  DebugIOInterface& operator=(const DebugIOInterface&);
 
protected:
  virtual ~DebugIOInterface() {}
 
public:
  // interface only so no functionality here
  explicit DebugIOInterface(void) {}

  enum StringType
  {
    Assert = 0,

    Check,

    Log,

    Crash,

    Exception,

    CmdReply,

    StructuredCmdReply,

    Other,
 
    MAX
  };

  virtual int Read(char *buf, int maxchar)=0;

  virtual void Write(StringType type, const char *src, const char *str)=0;

  virtual void EmergencyFlush(void)=0;

  virtual void Execute(class Debug& dbg, const char *cmd, bool structuredCmd,
                       unsigned argn, const char * const * argv)=0;

  virtual void Delete(void)=0;
};

 
#ifdef DOXYGEN

  #define DEBUG_DECLARE_IO_INTERFACE(type) 

  #define DEBUG_IMPLEMENT_IO_INTERFACE(io_id,descr,type) 
 
#else
 
  #define DEBUG_DECLARE_IO_INTERFACE(type) \
    public: \
      static bool __RegisterClassFactory; \
      static DebugIOInterface *__ClassFactory(void) { return new type; }
 
  #define DEBUG_IMPLEMENT_IO_INTERFACE(io_id,descr,type) \
    static bool type::__RegisterClassFactory=Debug::AddIOFactory(#io_id,descr,type::__ClassFactory);
 
#endif

 
#endif // DEBUG_IO_H