The trivial-debug-console Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The trivial-debug-console Reference Manual

This is the trivial-debug-console Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:41:15 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

* About
  =trivial-debug-console= is a tiny little library to make writing GUI
  applications in Common Lisp easier on Windows. The free lisp
  implementations like SBCL and CLISP produce "text-mode" executable
  images on windows, which means they pop up a console window when
  run. You could create a launcher to hide the window, but then you
  couldn't do any debugging in the image.

  =trivial-debug-console= lets you wrap a function such that the
  console window will be un-hidden whenever the debugger is entered,
  and re-hidden after the condition has been handled. You get the
  console window for just as long as you need it, then it gets out of
  your way.

* Usage
  There are two ways to use =trivial-debug-console=:
  1. =(debuggify func &rest args)= will apply =func= to =args= with
     the debug wrapper.
  2. =(with-debug-console &body body)= will wrap =body= in a lambda
     and pass it to =debuggify=, to make wrapping a series of actions
     easier.

* Notes
  - This only works on windows (I'm still thinking about how to make
    it work on X-windows systems).
  - =trivial-debug-console= goes to lengths to not disrupt normal
    error-handling mechanisms. =*DEBUGGER-HOOK*= and the regular
    error-handling mechanisms should all work normally.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 trivial-debug-console

Author

Matthew Stickney <mtstickney@gmail.com>

License

MIT

Description

A library to provide a well-behaved debug console.

Dependency

cffi

Source

trivial-debug-console.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 trivial-debug-console.asd

Location

trivial-debug-console.asd

Systems

trivial-debug-console (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 trivial-debug-console/package.lisp

Parent

trivial-debug-console (system)

Location

package.lisp

Packages

trivial-debug-console


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 trivial-debug-console/ffi.lisp

Dependency

package.lisp (file)

Parent

trivial-debug-console (system)

Location

ffi.lisp

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.4 trivial-debug-console/trivial-debug-console.lisp

Dependency

ffi.lisp (file)

Parent

trivial-debug-console (system)

Location

trivial-debug-console.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 trivial-debug-console

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: with-debug-console &body BODY
Package

trivial-debug-console

Source

trivial-debug-console.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: debuggify FUNC &rest ARGS
Package

trivial-debug-console

Source

trivial-debug-console.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Macros

Macro: with-console (WINDOW) &body BODY
Package

trivial-debug-console

Source

trivial-debug-console.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: console-window ()

Return a handle to the calling process’s console window.

Package

trivial-debug-console

Source

ffi.lisp (file)

Function: debug-handler &optional PARENT-HOOK

Return a function to be used as *DEBUGGER-HOOK* that shows the console window, runs any existing hooks, and hides the window when debugging is complete.

Package

trivial-debug-console

Source

trivial-debug-console.lisp (file)

Function: show-window HWND TYPE

Set the show state of the specified window.

Package

trivial-debug-console

Source

ffi.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   T  
Index Entry  Section

F
File, Lisp, trivial-debug-console.asd: The trivial-debug-console<dot>asd file
File, Lisp, trivial-debug-console/ffi.lisp: The trivial-debug-console/ffi<dot>lisp file
File, Lisp, trivial-debug-console/package.lisp: The trivial-debug-console/package<dot>lisp file
File, Lisp, trivial-debug-console/trivial-debug-console.lisp: The trivial-debug-console/trivial-debug-console<dot>lisp file

L
Lisp File, trivial-debug-console.asd: The trivial-debug-console<dot>asd file
Lisp File, trivial-debug-console/ffi.lisp: The trivial-debug-console/ffi<dot>lisp file
Lisp File, trivial-debug-console/package.lisp: The trivial-debug-console/package<dot>lisp file
Lisp File, trivial-debug-console/trivial-debug-console.lisp: The trivial-debug-console/trivial-debug-console<dot>lisp file

T
trivial-debug-console.asd: The trivial-debug-console<dot>asd file
trivial-debug-console/ffi.lisp: The trivial-debug-console/ffi<dot>lisp file
trivial-debug-console/package.lisp: The trivial-debug-console/package<dot>lisp file
trivial-debug-console/trivial-debug-console.lisp: The trivial-debug-console/trivial-debug-console<dot>lisp file

Jump to:   F   L   T  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   D   F   M   S   W  
Index Entry  Section

C
console-window: Internal functions

D
debug-handler: Internal functions
debuggify: Exported functions

F
Function, console-window: Internal functions
Function, debug-handler: Internal functions
Function, debuggify: Exported functions
Function, show-window: Internal functions

M
Macro, with-console: Internal macros
Macro, with-debug-console: Exported macros

S
show-window: Internal functions

W
with-console: Internal macros
with-debug-console: Exported macros

Jump to:   C   D   F   M   S   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S   T  
Index Entry  Section

P
Package, trivial-debug-console: The trivial-debug-console package

S
System, trivial-debug-console: The trivial-debug-console system

T
trivial-debug-console: The trivial-debug-console system
trivial-debug-console: The trivial-debug-console package

Jump to:   P   S   T