The hu.dwim.debug Reference Manual

Table of Contents

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

The hu.dwim.debug Reference Manual

This is the hu.dwim.debug Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:57:35 2018 GMT+0.


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

1 Introduction

http://dwim.hu/project/hu.dwim.debug


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 hu.dwim.debug

Authors

Tamás Borbély <tomi.borbely@gmail.com>
Attila Lendvai <attila.lendvai@gmail.com>
Levente Mészáros <levente.meszaros@gmail.com>

License

BSD or Bugroff

Description

Various debug utilities such as lexical tracing, etc.

Defsystem Dependency

hu.dwim.asdf

Dependencies
Source

hu.dwim.debug.asd (file)

Component

source (module)


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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 hu.dwim.debug/source

Parent

hu.dwim.debug (system)

Location

source/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 hu.dwim.debug.asd

Location

hu.dwim.debug.asd

Systems

hu.dwim.debug (system)


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

4.1.2 hu.dwim.debug/source/package.lisp

Parent

source (module)

Location

source/package.lisp

Packages

hu.dwim.debug


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

4.1.3 hu.dwim.debug/source/path-to-root.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/path-to-root.lisp

Exported Definitions
Internal Definitions

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

4.1.4 hu.dwim.debug/source/trace.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/trace.lisp

Exported Definitions
Internal Definitions

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

4.1.5 hu.dwim.debug/source/util.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/util.lisp

Exported Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 hu.dwim.debug

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Macros

Macro: break* (&key IO-FORMAT DEBUGGER-FORMAT INSPECT) &body FORMS
Package

hu.dwim.debug

Source

util.lisp (file)

Macro: break/inspect &body FORMS
Package

hu.dwim.debug

Source

util.lisp (file)

Macro: break/inspect* (&rest ARGS &key &allow-other-keys) &body FORMS
Package

hu.dwim.debug

Source

util.lisp (file)

Macro: break/print &body FORMS
Package

hu.dwim.debug

Source

util.lisp (file)

Macro: break/print* (&rest ARGS &key &allow-other-keys) &body FORMS
Package

hu.dwim.debug

Source

util.lisp (file)

Macro: with-lexical-trace &body FORMS
Package

hu.dwim.debug

Source

trace.lisp (file)

Macro: with-lexical-trace* (&key &allow-other-keys) &body FORMS
Package

hu.dwim.debug

Source

trace.lisp (file)


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

6.1.2 Functions

Function: build-reference-map &key IGNORE-REFERENCE-PREDICATE INITIAL-SIZE

Stop the GC, build a hashtable of referenced-object -> referrers using SB-VM::MAP-ALLOCATED-OBJECTS (while hoping that there’s enough free memory left for this), and then store it in *REFERENCE-MAP* to be used later by PATH-TO-ROOT queries.

Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Function: build-reference-map-type-breakdown ()
Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Function: collect-referenced-objects PREDICATE
Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Function: collect-root-objects &optional ROOT-OBJECT-PREDICATE
Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Function: count-references OBJECT
Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Function: find-referenced-object PREDICATE &key KEY
Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Function: path-to-root OBJECT &key INITIAL-CAPACITY MAXIMUM-CAPACITY MAXIMUM-ITERATION MAXIMUM-LEVEL MAXIMUM-RESULT ROOT-OBJECT-PREDICATE
Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Function: referencing-objects-of OBJECT
Package

hu.dwim.debug

Source

path-to-root.lisp (file)


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

6.2 Internal definitions


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

6.2.1 Special variables

Special Variable: *reference-map*
Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Special Variable: *referenced-object-indices*
Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Special Variable: *referencing-levels*
Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Special Variable: *to-be-visited-objects*
Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Special Variable: *trace-function-call-level*
Package

hu.dwim.debug

Source

trace.lisp (file)

Special Variable: *trace-indentation-width*
Package

hu.dwim.debug

Source

trace.lisp (file)

Special Variable: *visited-objects*
Package

hu.dwim.debug

Source

path-to-root.lisp (file)


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

6.2.2 Functions

Function: ignore-reference? REFERENCING-OBJECT REFERENCED-OBJECT

A default implementation to test whether to ignore a reference or not when recording the references.

Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Function: root-object? OBJECT &optional COUNT

A default implementation to test whether an object qualifies as ’root’ object.

Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Function: trace-application-form OPERATOR OPERATOR-NAME ARGUMENTS VARIABLE-NAMES
Package

hu.dwim.debug

Source

trace.lisp (file)

Function: trace-setq-form NAME VALUE
Package

hu.dwim.debug

Source

trace.lisp (file)

Function: write-trace-indent ()
Package

hu.dwim.debug

Source

trace.lisp (file)


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

6.2.3 Generic functions

Generic Function: elements-of OBJECT
Generic Function: (setf elements-of) NEW-VALUE OBJECT
Package

hu.dwim.debug

Methods
Method: elements-of (REFERENCE-PATH reference-path)

automatically generated reader method

Source

path-to-root.lisp (file)

Method: (setf elements-of) NEW-VALUE (REFERENCE-PATH reference-path)

automatically generated writer method

Source

path-to-root.lisp (file)


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

6.2.4 Classes

Class: =layer-class-definer-for-lexical-trace= ()
Package

hu.dwim.debug

Source

trace.lisp (file)

Direct superclasses

=layer-class-definer-for-ignore-undefined-references= (class)

Direct methods
  • =layered-function-definer-for-unwalk-form= (method)
  • =layered-function-definer-for-unwalk-form= (method)
Class: reference-path ()
Package

hu.dwim.debug

Source

path-to-root.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • elements-of (method)
  • elements-of (method)
Direct slots
Slot: elements
Initargs

:elements

Readers

elements-of (generic function)

Writers

(setf elements-of) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   H   L   M  
Index Entry  Section

F
File, Lisp, hu.dwim.debug.asd: The hu<dot>dwim<dot>debug<dot>asd file
File, Lisp, hu.dwim.debug/source/package.lisp: The hu<dot>dwim<dot>debug/source/package<dot>lisp file
File, Lisp, hu.dwim.debug/source/path-to-root.lisp: The hu<dot>dwim<dot>debug/source/path-to-root<dot>lisp file
File, Lisp, hu.dwim.debug/source/trace.lisp: The hu<dot>dwim<dot>debug/source/trace<dot>lisp file
File, Lisp, hu.dwim.debug/source/util.lisp: The hu<dot>dwim<dot>debug/source/util<dot>lisp file

H
hu.dwim.debug.asd: The hu<dot>dwim<dot>debug<dot>asd file
hu.dwim.debug/source: The hu<dot>dwim<dot>debug/source module
hu.dwim.debug/source/package.lisp: The hu<dot>dwim<dot>debug/source/package<dot>lisp file
hu.dwim.debug/source/path-to-root.lisp: The hu<dot>dwim<dot>debug/source/path-to-root<dot>lisp file
hu.dwim.debug/source/trace.lisp: The hu<dot>dwim<dot>debug/source/trace<dot>lisp file
hu.dwim.debug/source/util.lisp: The hu<dot>dwim<dot>debug/source/util<dot>lisp file

L
Lisp File, hu.dwim.debug.asd: The hu<dot>dwim<dot>debug<dot>asd file
Lisp File, hu.dwim.debug/source/package.lisp: The hu<dot>dwim<dot>debug/source/package<dot>lisp file
Lisp File, hu.dwim.debug/source/path-to-root.lisp: The hu<dot>dwim<dot>debug/source/path-to-root<dot>lisp file
Lisp File, hu.dwim.debug/source/trace.lisp: The hu<dot>dwim<dot>debug/source/trace<dot>lisp file
Lisp File, hu.dwim.debug/source/util.lisp: The hu<dot>dwim<dot>debug/source/util<dot>lisp file

M
Module, hu.dwim.debug/source: The hu<dot>dwim<dot>debug/source module

Jump to:   F   H   L   M  

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

A.2 Functions

Jump to:   (  
B   C   E   F   G   I   M   P   R   T   W  
Index Entry  Section

(
(setf elements-of): Internal generic functions
(setf elements-of): Internal generic functions

B
break*: Exported macros
break/inspect: Exported macros
break/inspect*: Exported macros
break/print: Exported macros
break/print*: Exported macros
build-reference-map: Exported functions
build-reference-map-type-breakdown: Exported functions

C
collect-referenced-objects: Exported functions
collect-root-objects: Exported functions
count-references: Exported functions

E
elements-of: Internal generic functions
elements-of: Internal generic functions

F
find-referenced-object: Exported functions
Function, build-reference-map: Exported functions
Function, build-reference-map-type-breakdown: Exported functions
Function, collect-referenced-objects: Exported functions
Function, collect-root-objects: Exported functions
Function, count-references: Exported functions
Function, find-referenced-object: Exported functions
Function, ignore-reference?: Internal functions
Function, path-to-root: Exported functions
Function, referencing-objects-of: Exported functions
Function, root-object?: Internal functions
Function, trace-application-form: Internal functions
Function, trace-setq-form: Internal functions
Function, write-trace-indent: Internal functions

G
Generic Function, (setf elements-of): Internal generic functions
Generic Function, elements-of: Internal generic functions

I
ignore-reference?: Internal functions

M
Macro, break*: Exported macros
Macro, break/inspect: Exported macros
Macro, break/inspect*: Exported macros
Macro, break/print: Exported macros
Macro, break/print*: Exported macros
Macro, with-lexical-trace: Exported macros
Macro, with-lexical-trace*: Exported macros
Method, (setf elements-of): Internal generic functions
Method, elements-of: Internal generic functions

P
path-to-root: Exported functions

R
referencing-objects-of: Exported functions
root-object?: Internal functions

T
trace-application-form: Internal functions
trace-setq-form: Internal functions

W
with-lexical-trace: Exported macros
with-lexical-trace*: Exported macros
write-trace-indent: Internal functions

Jump to:   (  
B   C   E   F   G   I   M   P   R   T   W  

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

A.3 Variables

Jump to:   *  
E   S  
Index Entry  Section

*
*reference-map*: Internal special variables
*referenced-object-indices*: Internal special variables
*referencing-levels*: Internal special variables
*to-be-visited-objects*: Internal special variables
*trace-function-call-level*: Internal special variables
*trace-indentation-width*: Internal special variables
*visited-objects*: Internal special variables

E
elements: Internal classes

S
Slot, elements: Internal classes
Special Variable, *reference-map*: Internal special variables
Special Variable, *referenced-object-indices*: Internal special variables
Special Variable, *referencing-levels*: Internal special variables
Special Variable, *to-be-visited-objects*: Internal special variables
Special Variable, *trace-function-call-level*: Internal special variables
Special Variable, *trace-indentation-width*: Internal special variables
Special Variable, *visited-objects*: Internal special variables

Jump to:   *  
E   S  

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

A.4 Data types

Jump to:   =  
C   H   P   R   S  
Index Entry  Section

=
=layer-class-definer-for-lexical-trace=: Internal classes

C
Class, =layer-class-definer-for-lexical-trace=: Internal classes
Class, reference-path: Internal classes

H
hu.dwim.debug: The hu<dot>dwim<dot>debug system
hu.dwim.debug: The hu<dot>dwim<dot>debug package

P
Package, hu.dwim.debug: The hu<dot>dwim<dot>debug package

R
reference-path: Internal classes

S
System, hu.dwim.debug: The hu<dot>dwim<dot>debug system

Jump to:   =  
C   H   P   R   S