The cl-tidy Reference Manual

Table of Contents

The cl-tidy Reference Manual

This is the cl-tidy Reference Manual, version 0.0.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:25:39 2018 GMT+0.

1 Introduction

#CL-Tidy

Foreign Function Interface bindings (and a little glue) for HTML Tidy.

Please see the documentation for more details.

2 Systems

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

2.1 cl-tidy

Author

Red Daly <reddaly at gmail.com>

License

MIT License

Description

FFI bindings for HTML Tidy

Version

0.0.2

Dependency

cffi

Source

cl-tidy.asd (file)

Component

src (module)

3 Modules

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

3.1 cl-tidy/src

Parent

cl-tidy (system)

Location

src/

Components

• package.lisp (file)
• main.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 cl-tidy.asd

Location

cl-tidy.asd

Systems

cl-tidy (system)

Packages

cl-tidy.script

4.1.2 cl-tidy/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-tidy

4.1.3 cl-tidy/src/main.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/main.lisp

Exported Definitions

clean-up-html (function)

Internal Definitions

• check-html (function)
• init-tidy-buffer (function)
• slurp-file-3000 (function)
• tidy-buffer-tclass (class)
• tidy-clean-and-repair (function)
• tidy-create (function)
• tidy-error-count (function)
• tidy-error-summary (function)
• tidy-opt-set-bool (function)
• tidy-parse-string (function)
• tidy-release (function)
• tidy-run-diagnostics (function)
• tidy-save-buffer (function)
• tidy-warning-count (function)
• with-tidy-buffer (macro)
• with-tidy-doc (macro)
• without-interrupts (macro)

5 Packages

Packages are listed by definition order.

5.1 cl-tidy.script

Source

cl-tidy.asd

Use List

• asdf/interface
• common-lisp

5.2 cl-tidy

Source

package.lisp (file)

Use List

• common-lisp
• cffi

Exported Definitions

clean-up-html (function)

Internal Definitions

• check-html (function)
• init-tidy-buffer (function)
• slurp-file-3000 (function)
• tidy-buffer-tclass (class)
• tidy-clean-and-repair (function)
• tidy-create (function)
• tidy-error-count (function)
• tidy-error-summary (function)
• tidy-opt-set-bool (function)
• tidy-parse-string (function)
• tidy-release (function)
• tidy-run-diagnostics (function)
• tidy-save-buffer (function)
• tidy-warning-count (function)
• with-tidy-buffer (macro)
• with-tidy-doc (macro)
• without-interrupts (macro)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: clean-up-html STRING

Given an HTML string, ‘string‘, runs the input through Tidy. If
Tidy can handle the input, returns a version of the document that is valid XHTML.

Thus, most dirty web pages from the internet can be grabbed run through ‘CLEAN-UP-HTML‘ and subsequently passed into a strict XML parser.

Package

cl-tidy

Source

main.lisp (file)

6.2 Internal definitions

6.2.1 Macros

Macro: with-tidy-buffer (VAR) &body BODY

Package

cl-tidy

Source

main.lisp (file)

Macro: with-tidy-doc (VAR) &body BODY

Package

cl-tidy

Source

main.lisp (file)

Macro: without-interrupts &body BODY

Run BODY with interrupts disabled.

Package

cl-tidy

Source

main.lisp (file)

6.2.2 Functions

Function: check-html STRING

Package

cl-tidy

Source

main.lisp (file)

Function: init-tidy-buffer BUF

Package

cl-tidy

Source

main.lisp (file)

Function: slurp-file-3000 PATHNAME

A SLURP-FILE function inspired Mr. Insane 3000’s SLURP-STREAM4.

Package

cl-tidy

Source

main.lisp (file)

Function: tidy-clean-and-repair TDOC

Package

cl-tidy

Source

main.lisp (file)

Function: tidy-create ()

Package

cl-tidy

Source

main.lisp (file)

Function: tidy-error-count TDOC

Package

cl-tidy

Source

main.lisp (file)

Function: tidy-error-summary TDOC

Package

cl-tidy

Source

main.lisp (file)

Function: tidy-opt-set-bool TDOC OPT VAL

Package

cl-tidy

Source

main.lisp (file)

Function: tidy-parse-string TDOC HTML-CONTENT

Package

cl-tidy

Source

main.lisp (file)

Function: tidy-release TDOC

Package

cl-tidy

Source

main.lisp (file)

Function: tidy-run-diagnostics TDOC

Package

cl-tidy

Source

main.lisp (file)

Function: tidy-save-buffer TDOC OUTPUT

Package

cl-tidy

Source

main.lisp (file)

Function: tidy-warning-count TDOC

Package

cl-tidy

Source

main.lisp (file)

6.2.3 Classes

Class: tidy-buffer-tclass ()

Package

cl-tidy

Source

main.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types