The firephp Reference Manual

Table of Contents

The firephp Reference Manual

This is the firephp Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 13:28:30 2020 GMT+0.

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

2 Systems

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

2.1 firephp

Maintainer

Olexiy Zamkoviy

Author

Olexiy Zamkoviy

License

LLGPL

Description

FirePHP debug utility

Dependencies

• cl-json
• hunchentoot

Source

firephp.asd (file)

Component

firephp.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 firephp.asd

Location

firephp.asd

Systems

firephp (system)

Packages

firephp-asd

3.1.2 firephp/firephp.lisp

Parent

firephp (system)

Location

firephp.lisp

Packages

firephp

Exported Definitions

• *escape-html-p* (special variable)
• descr (function)
• fb (function)
• send-message (function)

Internal Definitions

• get-last-message-index (function)
• maybe-escape-html (function)
• send-header (function)
• split-into-chunks (function)

4 Packages

Packages are listed by definition order.

4.1 firephp-asd

Source

firephp.asd

Use List

• asdf/interface
• common-lisp

4.2 firephp

FirePHP protocol server implementation

Source

firephp.lisp (file)

Use List

common-lisp

Exported Definitions

• *escape-html-p* (special variable)
• descr (function)
• fb (function)
• send-message (function)

Internal Definitions

• get-last-message-index (function)
• maybe-escape-html (function)
• send-header (function)
• split-into-chunks (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *escape-html-p*

Package

firephp

Source

firephp.lisp (file)

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)

5.2 Internal definitions

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)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types