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

The cl-tidy Reference Manual

This is the cl-tidy Reference Manual, version 0.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:47:13 2024 GMT+0.

Next: Systems, Previous: The cl-tidy Reference Manual, Up: The cl-tidy Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The cl-tidy Reference Manual [Contents][Index]

2 Systems

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

cl-tidy

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

2.1 `cl-tidy`

FFI bindings for HTML Tidy

Author: Red Daly
License: MIT License
Version: 0.0.2
Dependency: cffi (system).
Source: cl-tidy.asd.
Child Component: src (module).

Next: Files, Previous: Systems, Up: The cl-tidy Reference Manual [Contents][Index]

3 Modules

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

cl-tidy/src

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

3.1 `cl-tidy/src`

Source

cl-tidy.asd.

Parent Component

cl-tidy (system).

Child Components

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

Next: Packages, Previous: Modules, Up: The cl-tidy Reference Manual [Contents][Index]

4 Files

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

Lisp

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

Next: cl-tidy/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-tidy/cl-tidy.asd`

Source: cl-tidy.asd.
Parent Component: cl-tidy (system).
ASDF Systems: cl-tidy.
Packages: cl-tidy.script.

Next: cl-tidy/src/main.lisp, Previous: cl-tidy/cl-tidy.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-tidy/src/package.lisp`

Source: cl-tidy.asd.
Parent Component: src (module).
Packages: cl-tidy.

Previous: cl-tidy/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-tidy/src/main.lisp`

Dependency

package.lisp (file).

Source

cl-tidy.asd.

Parent Component

src (module).

Public Interface

clean-up-html (function).

Internals

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).

Next: Definitions, Previous: Files, Up: The cl-tidy Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-tidy.script
cl-tidy

Next: cl-tidy, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-tidy.script`

Source

cl-tidy.asd.

Use List

asdf/interface.
common-lisp.

Previous: cl-tidy.script, Up: Packages [Contents][Index]

5.2 `cl-tidy`

Source

package.lisp.

Use List

cffi.
common-lisp.

Public Interface

clean-up-html (function).

Internals

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).

Next: Indexes, Previous: Packages, Up: The cl-tidy Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

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

6.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Ordinary 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.

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

6.2 Internals

Macros
Ordinary functions
Classes

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Macros

Macro: with-tidy-buffer ((var) &body body) ¶

Package: cl-tidy.
Source: main.lisp.

Macro: with-tidy-doc ((var) &body body) ¶

Package: cl-tidy.
Source: main.lisp.

Macro: without-interrupts (&body body) ¶

Run BODY with interrupts disabled.

Package: cl-tidy.
Source: main.lisp.

Next: Classes, Previous: Macros, Up: Internals [Contents][Index]

6.2.2 Ordinary functions

Function: check-html (string) ¶

Package: cl-tidy.
Source: main.lisp.

Function: init-tidy-buffer (buf) ¶

Package: cl-tidy.
Source: main.lisp.

Function: slurp-file-3000 (pathname) ¶

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

Package: cl-tidy.
Source: main.lisp.

Function: tidy-clean-and-repair (tdoc) ¶

Package: cl-tidy.
Source: main.lisp.

Function: tidy-create () ¶

Package: cl-tidy.
Source: main.lisp.

Function: tidy-error-count (tdoc) ¶

Package: cl-tidy.
Source: main.lisp.

Function: tidy-error-summary (tdoc) ¶

Package: cl-tidy.
Source: main.lisp.

Function: tidy-opt-set-bool (tdoc opt val) ¶

Package: cl-tidy.
Source: main.lisp.

Function: tidy-parse-string (tdoc html-content) ¶

Package: cl-tidy.
Source: main.lisp.

Function: tidy-release (tdoc) ¶

Package: cl-tidy.
Source: main.lisp.

Function: tidy-run-diagnostics (tdoc) ¶

Package: cl-tidy.
Source: main.lisp.

Function: tidy-save-buffer (tdoc output) ¶

Package: cl-tidy.
Source: main.lisp.

Function: tidy-warning-count (tdoc) ¶

Package: cl-tidy.
Source: main.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

6.2.3 Classes

Class: tidy-buffer-tclass ¶

Package

cl-tidy.

Source

main.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Previous: Definitions, Up: The cl-tidy Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	C F I M S T W

	Index Entry	Section

C
	`check-html`:	Private ordinary functions
	`clean-up-html`:	Public ordinary functions

F
	`Function, check-html`:	Private ordinary functions
	`Function, clean-up-html`:	Public ordinary functions
	`Function, init-tidy-buffer`:	Private ordinary functions
	`Function, slurp-file-3000`:	Private ordinary functions
	`Function, tidy-clean-and-repair`:	Private ordinary functions
	`Function, tidy-create`:	Private ordinary functions
	`Function, tidy-error-count`:	Private ordinary functions
	`Function, tidy-error-summary`:	Private ordinary functions
	`Function, tidy-opt-set-bool`:	Private ordinary functions
	`Function, tidy-parse-string`:	Private ordinary functions
	`Function, tidy-release`:	Private ordinary functions
	`Function, tidy-run-diagnostics`:	Private ordinary functions
	`Function, tidy-save-buffer`:	Private ordinary functions
	`Function, tidy-warning-count`:	Private ordinary functions

I
	`init-tidy-buffer`:	Private ordinary functions

M
	`Macro, with-tidy-buffer`:	Private macros
	`Macro, with-tidy-doc`:	Private macros
	`Macro, without-interrupts`:	Private macros

S
	`slurp-file-3000`:	Private ordinary functions

T
	`tidy-clean-and-repair`:	Private ordinary functions
	`tidy-create`:	Private ordinary functions
	`tidy-error-count`:	Private ordinary functions
	`tidy-error-summary`:	Private ordinary functions
	`tidy-opt-set-bool`:	Private ordinary functions
	`tidy-parse-string`:	Private ordinary functions
	`tidy-release`:	Private ordinary functions
	`tidy-run-diagnostics`:	Private ordinary functions
	`tidy-save-buffer`:	Private ordinary functions
	`tidy-warning-count`:	Private ordinary functions

W
	`with-tidy-buffer`:	Private macros
	`with-tidy-doc`:	Private macros
	`without-interrupts`:	Private macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

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

A.4 Data types

Jump to:	C F M P S T

	Index Entry	Section

C
	`cl-tidy`:	The cl-tidy system
	`cl-tidy`:	The cl-tidy package
	`cl-tidy.asd`:	The cl-tidy/cl-tidy․asd file
	`cl-tidy.script`:	The cl-tidy․script package
	`Class, tidy-buffer-tclass`:	Private classes

F
	`File, cl-tidy.asd`:	The cl-tidy/cl-tidy․asd file
	`File, main.lisp`:	The cl-tidy/src/main․lisp file
	`File, package.lisp`:	The cl-tidy/src/package․lisp file

M
	`main.lisp`:	The cl-tidy/src/main․lisp file
	`Module, src`:	The cl-tidy/src module

P
	`Package, cl-tidy`:	The cl-tidy package
	`Package, cl-tidy.script`:	The cl-tidy․script package
	`package.lisp`:	The cl-tidy/src/package․lisp file

S
	`src`:	The cl-tidy/src module
	`System, cl-tidy`:	The cl-tidy system

T
	`tidy-buffer-tclass`:	Private classes

The cl-tidy Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-tidy

3 Modules

3.1 cl-tidy/src

4 Files

4.1 Lisp

4.1.1 cl-tidy/cl-tidy.asd

4.1.2 cl-tidy/src/package.lisp

4.1.3 cl-tidy/src/main.lisp

5 Packages

5.1 cl-tidy.script

5.2 cl-tidy

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.2 Internals

6.2.1 Macros

6.2.2 Ordinary functions

6.2.3 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-tidy`

3.1 `cl-tidy/src`

4.1.1 `cl-tidy/cl-tidy.asd`

4.1.2 `cl-tidy/src/package.lisp`

4.1.3 `cl-tidy/src/main.lisp`

5.1 `cl-tidy.script`

5.2 `cl-tidy`