DEBUG_WIN Class Reference

#include <debugwin.h>

List of all members.

---

Detailed Description

API for the debug window is simple, see below. Most of its behaviour is its UI.

• It has a scrollable text area (most of the window)
• It has a stop control.
• It has a clear button.

A dprintf to the window causes the text to be sent to the text area. If the stop control is set, then the dprintf blocks (does not display anything or return) until the stop is released.

In multi-threaded apps, other threads and the UI continue to function during the stop. Only the calling thread is blocked. Pressing the clear button erases all text from the window. As text is sent to the window, it scrolls up so that the most recent output is visible. If the user has scrolled back, this does not happen. If the user scrolls back to the bottom, then the scrolling turns back on.

If the user destroys the window, it never comes back.

Definition at line 70 of file debugwin.h.

Public Member Functions

• void await_destruction ()

  Wait for the user to close the debug window. Then return.
  

• DEBUG_WIN (const char *title, INT32 xpos=DEBUG_WIN_XPOS, INT32 ypos=DEBUG_WIN_YPOS, INT32 xsize=DEBUG_WIN_XSIZE, INT32 ysize=DEBUG_WIN_YSIZE, INT32 buflines=debug_lines)

  Create a debug window with size according to the arguments.
  

• void dprintf (const char *format,...)

  Print a message to the debug window.
  

• ~DEBUG_WIN ()

  Close the file and destroy the window.
  

Private Attributes

• FILE * fp

---

Constructor & Destructor Documentation

DEBUG_WIN::DEBUG_WIN	(	const char *	title,
		INT32	xpos = DEBUG_WIN_XPOS,
		INT32	ypos = DEBUG_WIN_YPOS,
		INT32	xsize = DEBUG_WIN_XSIZE,
		INT32	ysize = DEBUG_WIN_YSIZE,
		INT32	buflines = debug_lines
	)

Create a debug window with size according to the arguments.

Create an hpterm window with a pipe connected to it.

Definition at line 213 of file debugwin.cpp.

References FALSE, fp, INT32FORMAT, and MAX_PATH.

                      {
  #ifdef __UNIX__
  INT32 length;                  /*length of name */
  char command[MAX_PATH];        /*pipe command */
  pid_t pid;                     /*process id */
  char host[MAX_PATH];           //remote host
  BOOL8 remote;                  //remote host

  //      remote=remote_display(host);                                                                    //check remote host
  remote = FALSE;
  if (remote)
                                 //do it remotely
    length = sprintf (command, "remsh %s 'DISPLAY=%s;export DISPLAY;",
      host, getenv ("DISPLAY"));
  else
    length = 0;
  length += sprintf (command + length, "trap \"\" 1 2 3 13 15\n");
  length +=
    sprintf (command + length,
    "/usr/bin/X11/xterm -sb -sl " INT32FORMAT " -geometry "
    INT32FORMAT "x" INT32FORMAT "", buflines, xsize / 8, ysize / 16);
  if (xpos >= 0)
    command[length++] = '+';
  length += sprintf (command + length, INT32FORMAT, xpos);
  if (ypos >= 0)
    command[length++] = '+';
  length +=
    sprintf (command + length,
    INT32FORMAT " -title \"%s\" -n \"%s\" -e /bin/sh -c ", ypos,
    title, title);
  pid = getpid ();               /*random number */
  length +=
    sprintf (command + length,
    "\"stty opost; tty >/tmp/debug%d; while [ -s /tmp/debug%d ]\ndo\nsleep 1\ndone\" &\n",
    pid, pid);
  length +=
    sprintf (command + length, "trap \"rm -f /tmp/debug%d; kill -9 $!\" 0\n",
    pid);
  length += sprintf (command + length, "trap \"exit\" 1 2 3 13 15\n");
  length +=
    sprintf (command + length,
    "while [ ! -s /tmp/debug%d ]\ndo\nsleep 1\ndone\n", pid);
  length += sprintf (command + length, "trap \"\" 1 2 3 13 15\n");
  length += sprintf (command + length, "ofile=`cat /tmp/debug%d`\n", pid);
  length +=
    sprintf (command + length, "cat -u - >$ofile; rm /tmp/debug%d\n", pid);
  if (remote) {
    command[length++] = '\'';    //terminate remsh
    command[length] = '\0';
  }
  fp = popen (command, "w");     /*create window */
  if (fp != NULL) {
                                 /*set no buffering */
    if (setvbuf (fp, NULL, _IONBF, BUFSIZ)) {
      pclose(fp); 
      fp = NULL;
    }
  }
  #endif
}

DEBUG_WIN::~DEBUG_WIN

(

)

Close the file and destroy the window.

Definition at line 286 of file debugwin.cpp.

References fp.

  {
  #ifdef __UNIX__
  pclose(fp); 
  #endif
}

---

Member Function Documentation

void DEBUG_WIN::await_destruction

(

)

Wait for the user to close the debug window. Then return.

Definition at line 322 of file debugwin.cpp.

References fp.

                                  {  //wait for user to close
  #ifdef __UNIX__
  signal(SIGPIPE, SIG_IGN); 
  while (!ferror (fp)) {
    sleep (1);
    fputc (0, fp);               //send nulls until error
  }
  #endif
}

void DEBUG_WIN::dprintf	(	const char *	format,
			...
	)

Print a message to the debug window.

Like printf, this function can cope with messages which do not end in newline, but nothing is printed until the newline is received.

Definition at line 302 of file debugwin.cpp.

References fp.

Referenced by tprintf().

  {
  va_list args;                  //variable args

  va_start(args, format);  //variable list
  #ifdef __UNIX__
  vfprintf(fp, format, args);  //Format into msg
  #else
                                 //Format into msg
  vfprintf(stderr, format, args); 
  #endif
  va_end(args); 
}

---

Member Data Documentation

FILE* DEBUG_WIN::fp [private]

Definition at line 107 of file debugwin.h.

Referenced by await_destruction(), DEBUG_WIN(), dprintf(), and ~DEBUG_WIN().

---

The documentation for this class was generated from the following files:

• ccutil/debugwin.h
• ccutil/debugwin.cpp

---