The cl-tidy Reference Manual

Table of Contents

Next: , Previous: , 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 2.4 "Will Decker" on Wed Jun 20 11:25:39 2018 GMT+0.


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

1 Introduction

#CL-Tidy

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

Please see the documentation for more details.


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


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 cl-tidy/src

Parent

cl-tidy (system)

Location

src/

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 cl-tidy.asd

Location

cl-tidy.asd

Systems

cl-tidy (system)

Packages

cl-tidy.script


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

4.1.2 cl-tidy/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-tidy


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

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

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

5 Packages

Packages are listed by definition order.


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

5.1 cl-tidy.script

Source

cl-tidy.asd

Use List

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

5.2 cl-tidy

Source

package.lisp (file)

Use List
Exported Definitions

clean-up-html (function)

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


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

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)


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

6.2 Internal definitions


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

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)


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

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)


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

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)

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-tidy.asd: The cl-tidy<dot>asd file
cl-tidy/src: The cl-tidy/src module
cl-tidy/src/main.lisp: The cl-tidy/src/main<dot>lisp file
cl-tidy/src/package.lisp: The cl-tidy/src/package<dot>lisp file

F
File, Lisp, cl-tidy.asd: The cl-tidy<dot>asd file
File, Lisp, cl-tidy/src/main.lisp: The cl-tidy/src/main<dot>lisp file
File, Lisp, cl-tidy/src/package.lisp: The cl-tidy/src/package<dot>lisp file

L
Lisp File, cl-tidy.asd: The cl-tidy<dot>asd file
Lisp File, cl-tidy/src/main.lisp: The cl-tidy/src/main<dot>lisp file
Lisp File, cl-tidy/src/package.lisp: The cl-tidy/src/package<dot>lisp file

M
Module, cl-tidy/src: The cl-tidy/src module

Jump to:   C   F   L   M  

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

A.2 Functions

Jump to:   C   F   I   M   S   T   W  
Index Entry  Section

C
check-html: Internal functions
clean-up-html: Exported functions

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

I
init-tidy-buffer: Internal functions

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

S
slurp-file-3000: Internal functions

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

W
with-tidy-buffer: Internal macros
with-tidy-doc: Internal macros
without-interrupts: Internal macros

Jump to:   C   F   I   M   S   T   W  

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

A.3 Variables


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

A.4 Data types

Jump to:   C   P   S   T  
Index Entry  Section

C
cl-tidy: The cl-tidy system
cl-tidy: The cl-tidy package
cl-tidy.script: The cl-tidy<dot>script package
Class, tidy-buffer-tclass: Internal classes

P
Package, cl-tidy: The cl-tidy package
Package, cl-tidy.script: The cl-tidy<dot>script package

S
System, cl-tidy: The cl-tidy system

T
tidy-buffer-tclass: Internal classes

Jump to:   C   P   S   T