Simple framework for single stepping code. More...

Inheritance diagram for aud.util.SingleStepper:

Public Member Functions
	SingleStepper (JFrame parent)
	create new instance More...

	SingleStepper (String caption)
	create new instance More...

JFrame	parent ()
	get parent widget More...

void	halt (String text, int timeout)
	display `text` and wait for user or `timeout` More...

void	setTimeout (int timeout)
	Set global timeout. More...

SingleStepper	whereAmI ()
	print location of calling code More...

SingleStepper	showSource ()
	jmp to caller's location in editor (emacs only) More...

void	halt (String text)
	display `text` and wait for user (or global timeout) More...

void	halt ()
	wait for user More...

Static Public Member Functions
static void	main (String[] args)

Protected Member Functions
JComponent	createComponents ()

void	onNext ()
	call on button pressed More...

void	println (String text)
	print to both, text area and stdout More...

void	onHalt ()

Protected Attributes
JFrame	frame

JTextArea	history

JButton	next

Object	monitor = new Object()

int	timeout = 0

Detailed Description

Simple framework for single stepping code.

The SingleStepper widget consists of a text area that displays messages and a push button that triggers the next step.

The idea is to include calls to halt in your code: this prints a message and waits for the user to push the button to continue execution.

The following environment variables are recognized envionment variables.

environment variables
environment variable	purpose
AUD_TIMEOUT	set global timeout for `halt` in milliseconds `setTimeout`

DotViewer can be used to visualize the state of an algorithm that is run with SingleStepper. GraphDemo shows an example.

See also: DotViewer TODO: link GraphDemo

Definition at line 44 of file SingleStepper.java.

Constructor & Destructor Documentation

◆ SingleStepper() [1/2]

aud.util.SingleStepper.SingleStepper ( JFrame parent )

create new instance

Definition at line 53 of file SingleStepper.java.

                                      {
    frame=parent;
    parent.getContentPane().add(createComponents());
    if (Sys.env("AUD_TIMEOUT")!=null) {
      try {
        timeout=Integer.parseInt(Sys.env("AUD_TIMEOUT"));
      } catch (NumberFormatException e) {}
    }
  }

References aud.util.SingleStepper.createComponents(), aud.util.Sys.env(), aud.util.SingleStepper.frame, aud.util.SingleStepper.parent(), and aud.util.SingleStepper.timeout.

Here is the call graph for this function:

◆ SingleStepper() [2/2]

aud.util.SingleStepper.SingleStepper ( String caption )

create new instance

Definition at line 63 of file SingleStepper.java.

                                       {
    this(new JFrame(caption!=null ? caption : "aud.util.SingleStepper"));
    JFrame f=parent();
 
    // TODO: read geometry and font size from environment variable(s);
    //       and hide spinner (below) in case
    f.setSize(400,400);
    f.setVisible(true);
 
    // exit on close
    f.addWindowListener(new WindowAdapter() {
        public void windowClosing(WindowEvent e) {
          System.exit(0);
        }
      });
  }

References aud.util.SingleStepper.parent().

Here is the call graph for this function:

Member Function Documentation

◆ createComponents()

JComponent aud.util.SingleStepper.createComponents ( )

protected

Definition at line 84 of file SingleStepper.java.

                                          {
    final JSpinner spinner=new JSpinner();
    spinner.setValue(20);
 
    final JPanel panel=new JPanel(new BorderLayout());
 
    history=new JTextArea();
    history.setFont(new Font("",Font.BOLD,(int) spinner.getValue()));
    history.setEditable(false);
    history.setLineWrap(false);
 
    final JScrollPane historyPane = new JScrollPane(history);
    historyPane.setPreferredSize(new Dimension(400, 300));
 
    next=new JButton("continue");
 
    next.addActionListener(new ActionListener() {
        public void actionPerformed(ActionEvent ae) {
          onNext();
        }
      });
 
    spinner.addChangeListener(new ChangeListener(){
        @Override
        public void stateChanged(ChangeEvent arg0) {
          // TODO Auto-generated method stub
          if ((int) spinner.getValue()<10)
            spinner.setValue(10);
          if ((int) spinner.getValue()>40)
            spinner.setValue(40);
 
          history.setFont(new Font("",Font.BOLD,(int)spinner.getValue()));
        }
      });
 
    panel.add("North",spinner);
    panel.add("Center", historyPane);
    panel.add("South", next);
    return panel;
  }

References aud.util.SingleStepper.history, aud.util.SingleStepper.next, and aud.util.SingleStepper.onNext().

Referenced by aud.util.SingleStepper.SingleStepper().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ halt() [1/3]

void aud.util.SingleStepper.halt ( )

wait for user

Definition at line 188 of file SingleStepper.java.

188{ halt(Sys.whereAmI(1)); }

aud.util.SingleStepper.halt

void halt()

wait for user

Definition: SingleStepper.java:188

References aud.util.SingleStepper.halt(), and aud.util.Sys.whereAmI().

Referenced by aud.util.SingleStepper.halt(), aud.example.expr.ExpressionTreeTraversal.levelorder(), aud.example.BinaryTreeTraversal.levelorder(), aud.example.expr.ExpressionTreeTraversal.output(), aud.example.BinaryTreeTraversal.output(), aud.example.BinaryTreeTraversal.traverse(), and aud.example.expr.ExpressionTreeTraversal.traverse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ halt() [2/3]

void aud.util.SingleStepper.halt ( String text )

display text and wait for user (or global timeout)

Definition at line 183 of file SingleStepper.java.

                                {
    halt(text,timeout);
  }

References aud.util.SingleStepper.halt(), and aud.util.SingleStepper.timeout.

Here is the call graph for this function:

◆ halt() [3/3]

void aud.util.SingleStepper.halt	(	String	text,
		int	timeout
	)

display text and wait for user or timeout

Definition at line 138 of file SingleStepper.java.

                                            {
    println(text);
    try {
      onHalt();
      synchronized(monitor) {
        monitor.wait(timeout>=0 ? timeout : 0);
      }
 
    } catch (InterruptedException e) {
      System.err.println(e);
      history.append("--- interrupted ---\n");
    } catch (IllegalMonitorStateException e) {
      System.err.println("ERROR: "+e);
      System.exit(-1);
    }
  }

References aud.util.SingleStepper.history, aud.util.SingleStepper.monitor, aud.util.SingleStepper.onHalt(), aud.util.SingleStepper.println(), and aud.util.SingleStepper.timeout.

Referenced by aud.util.SingleStepperDemo.main(), aud.example.BinaryTreeTraversal.main(), aud.example.expr.ExpressionTreeTraversal.main(), and aud.util.SingleStepper.main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ main()

static void aud.util.SingleStepper.main ( String[] args )

static

Reimplemented in aud.util.SingleStepperDemo, aud.example.BinaryTreeTraversal, and aud.example.expr.ExpressionTreeTraversal.

Definition at line 190 of file SingleStepper.java.

                                         {
    SingleStepper s=new SingleStepper("aud.util.SingleStepper");
 
    for (int i=0;i<4;++i) {
      System.out.println(i);
      s.halt("some message "+i);
    }
    s.halt("QUIT");
    System.exit(0);
  }

References aud.util.SingleStepper.halt().

Here is the call graph for this function:

◆ onHalt()

void aud.util.SingleStepper.onHalt ( )

protected

Reimplemented in aud.example.BinaryTreeTraversal, aud.example.expr.ExpressionTreeTraversal, and aud.util.SingleStepperDemo.

Definition at line 161 of file SingleStepper.java.

161{}

Referenced by aud.util.SingleStepper.halt().

Here is the caller graph for this function:

◆ onNext()

void aud.util.SingleStepper.onNext ( )

protected

call on button pressed

Definition at line 126 of file SingleStepper.java.

                          {
    try {
      synchronized (monitor) {
        monitor.notify();
      }
    } catch (IllegalMonitorStateException e) {
      System.err.println("ERROR: "+e);
      System.exit(-1);
    }
  }

References aud.util.SingleStepper.monitor.

Referenced by aud.util.SingleStepper.createComponents().

Here is the caller graph for this function:

◆ parent()

JFrame aud.util.SingleStepper.parent ( )

get parent widget

Definition at line 81 of file SingleStepper.java.

81{ return frame; }

References aud.util.SingleStepper.frame.

Referenced by aud.util.SingleStepper.SingleStepper().

Here is the caller graph for this function:

◆ println()

void aud.util.SingleStepper.println ( String text )

protected

print to both, text area and stdout

Definition at line 156 of file SingleStepper.java.

                                      {
     history.append(text+"\n");
     System.out.println(text);
  }

References aud.util.SingleStepper.history.

Referenced by aud.util.SingleStepper.halt(), and aud.util.SingleStepper.whereAmI().

Here is the caller graph for this function:

◆ setTimeout()

void aud.util.SingleStepper.setTimeout ( int timeout )

Set global timeout.

Continue halt after timeout milliseconds.

Parameters

timeout in milliseconds

Definition at line 167 of file SingleStepper.java.

                                      {
    this.timeout=timeout;
  }

References aud.util.SingleStepper.timeout.

◆ showSource()

SingleStepper aud.util.SingleStepper.showSource ( )

jmp to caller's location in editor (emacs only)

Definition at line 177 of file SingleStepper.java.

                                    {
    Sys.openCallersSourceInEmacs(1);
    return this;
  }

References aud.util.Sys.openCallersSourceInEmacs().

Here is the call graph for this function:

◆ whereAmI()

SingleStepper aud.util.SingleStepper.whereAmI ( )

print location of calling code

Definition at line 172 of file SingleStepper.java.

                                  {
    println(Sys.whereAmI(1));
    return this;
  }

References aud.util.SingleStepper.println(), and aud.util.Sys.whereAmI().

Here is the call graph for this function:

Member Data Documentation

◆ frame

JFrame aud.util.SingleStepper.frame

protected

Definition at line 46 of file SingleStepper.java.

Referenced by aud.util.SingleStepper.parent(), and aud.util.SingleStepper.SingleStepper().

◆ history

JTextArea aud.util.SingleStepper.history

protected

Definition at line 47 of file SingleStepper.java.

Referenced by aud.util.SingleStepper.createComponents(), aud.util.SingleStepper.halt(), and aud.util.SingleStepper.println().

◆ monitor

Object aud.util.SingleStepper.monitor = new Object()

protected

Definition at line 49 of file SingleStepper.java.

Referenced by aud.util.SingleStepper.halt(), and aud.util.SingleStepper.onNext().

◆ next

JButton aud.util.SingleStepper.next

protected

Definition at line 48 of file SingleStepper.java.

Referenced by aud.util.SingleStepper.createComponents().

◆ timeout

int aud.util.SingleStepper.timeout = 0

protected

Definition at line 50 of file SingleStepper.java.

Referenced by aud.util.SingleStepper.halt(), aud.util.SingleStepper.setTimeout(), and aud.util.SingleStepper.SingleStepper().

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

SingleStepper.java

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SingleStepper() [1/2]

◆ SingleStepper() [2/2]

Member Function Documentation

◆ createComponents()

◆ halt() [1/3]

◆ halt() [2/3]

◆ halt() [3/3]

◆ main()

◆ onHalt()

◆ onNext()

◆ parent()

◆ println()

◆ setTimeout()

◆ showSource()

◆ whereAmI()

Member Data Documentation

◆ frame

◆ history

◆ monitor

◆ next

◆ timeout