The firephp Reference Manual

Table of Contents

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

The firephp Reference Manual

This is the firephp Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:38:47 2018 GMT+0.


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

1 Introduction

This is firephp implementation in Common Lisp.

Currently it can send 2 types of firephp messages as FirePHPCore library can - dump messages and log messages (with type log, info, warn). Messages must be simple structures like lists, strings, numbers etc. Server supported is hunchentoot, but can be easily extended to work with other servers. Library does not support FirePHP 1.0 protocol.

On google chrome there are 2 cases.

Dump messages work with plugin webug and only if no log messages present in response.

Here is the code to send dump messages.

(firephp:send-message "Test")
(firephp:send-message "Test" :label "TestLabel")

And to send log messages just need to

(firephp:send-message "Test" :type :log)
(firephp:send-message "Test" :type :log :label "TestLabel")

Small debug wrappers included. Try

(firephp:fb "test1" "test2" (list 1 2 3))
(firephp:descr "test1" "test2" (list 1 2 3))

Currently works with FirePHP4Chrome for Google Chrome. Does not work on Firefox Firephp plugin


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 firephp

Maintainer

Olexiy Zamkoviy

Author

Olexiy Zamkoviy

License

LLGPL

Description

FirePHP debug utility

Dependencies
Source

firephp.asd (file)

Component

firephp.lisp (file)


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 firephp.asd

Location

firephp.asd

Systems

firephp (system)

Packages

firephp-asd


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

3.1.2 firephp/firephp.lisp

Parent

firephp (system)

Location

firephp.lisp

Packages

firephp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 firephp-asd

Source

firephp.asd

Use List

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

4.2 firephp

FirePHP protocol server implementation

Source

firephp.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 Special variables

Special Variable: *escape-html-p*
Package

firephp

Source

firephp.lisp (file)


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

5.1.2 Functions

Function: descr &rest ARGS
Package

firephp

Source

firephp.lisp (file)

Function: fb &rest ARGS

Simple debug function applies to any arguments and just displays them

Package

firephp

Source

firephp.lisp (file)

Function: send-message MESSAGE &rest ARGS &key TYPE LABEL
Package

firephp

Source

firephp.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: get-last-message-index ()
Package

firephp

Source

firephp.lisp (file)

Function: maybe-escape-html STR
Package

firephp

Source

firephp.lisp (file)

Function: send-header NAME VALUE
Package

firephp

Source

firephp.lisp (file)

Function: split-into-chunks SEQUENCE &optional SIZE
Package

firephp

Source

firephp.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L  
Index Entry  Section

F
File, Lisp, firephp.asd: The firephp<dot>asd file
File, Lisp, firephp/firephp.lisp: The firephp/firephp<dot>lisp file
firephp.asd: The firephp<dot>asd file
firephp/firephp.lisp: The firephp/firephp<dot>lisp file

L
Lisp File, firephp.asd: The firephp<dot>asd file
Lisp File, firephp/firephp.lisp: The firephp/firephp<dot>lisp file

Jump to:   F   L  

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

A.2 Functions

Jump to:   D   F   G   M   S  
Index Entry  Section

D
descr: Exported functions

F
fb: Exported functions
Function, descr: Exported functions
Function, fb: Exported functions
Function, get-last-message-index: Internal functions
Function, maybe-escape-html: Internal functions
Function, send-header: Internal functions
Function, send-message: Exported functions
Function, split-into-chunks: Internal functions

G
get-last-message-index: Internal functions

M
maybe-escape-html: Internal functions

S
send-header: Internal functions
send-message: Exported functions
split-into-chunks: Internal functions

Jump to:   D   F   G   M   S  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*escape-html-p*: Exported special variables

S
Special Variable, *escape-html-p*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   F   P   S  
Index Entry  Section

F
firephp: The firephp system
firephp: The firephp package
firephp-asd: The firephp-asd package

P
Package, firephp: The firephp package
Package, firephp-asd: The firephp-asd package

S
System, firephp: The firephp system

Jump to:   F   P   S