The cl-soup Reference Manual

Table of Contents

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

The cl-soup Reference Manual

This is the cl-soup Reference Manual, version 0.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:27:46 2018 GMT+0.


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

1 Introduction

cl-webkit - a binding to WebKitGTK+ for Common Lisp

About

cl-webkit is a binding to WebKitGTK+ for Common Lisp, currently targeting WebKit version 2. The WebKitGTK+ library adds web browsing capabilities to an application, leveraging the full power of the WebKit browsing engine.

API overview

The cl-webkit API closely follows the WebKit2 API, with the exception that class based interfaces are preferred over functional interfaces in cases where both are provided. That is, *_{new,get,set} methods are excluded in favour of make-instance and slot accessors wherever possible.

For documentation on how to use the WebKit2 API, please refer to the C API documentation.

Backwards compatibility (with older WebKit2 API versions) is not a priority. The binding targets the latest version of Webkit2Gtk+ available on mainstream distributions.

Status

Build Status

The binding currently covers most of the WebKit 2.4 API.

Dependencies

To run the test-suite you also need a checkout of lisp-unit.

Installation

Assuming you have Quicklisp installed, do

$ git clone https://github.com/joachifm/cl-webkit.git ~/common-lisp/quicklisp/local-projects/cl-webkit
$ lisp
* (ql:quickload :cl-webkit2)

Contributing

Send patches via email or as pull requests on GitHub. Feel free to append your name to the list of CONTRIBUTORS.

A few things to keep in mind

Resources

See also

Copying

cl-webkit is distributed under the MIT license (see COPYING). Please note that this licence only covers the binding itself. Refer to the distribution terms of the third-party dependencies for 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-soup

Author

Joachim Fasting <joachifm@fastmail.fm>

License

MIT

Description

An FFI binding to libsoup

Version

0.0

Dependency

cffi

Source

cl-soup.asd (file)

Components

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

Location

cl-soup.asd

Systems

cl-soup (system)


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

3.1.2 cl-soup/package.lisp

Parent

cl-soup (system)

Location

package.lisp

Packages

cl-soup


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

3.1.3 cl-soup/init.lisp

Dependency

package.lisp (file)

Parent

cl-soup (system)

Location

init.lisp


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

3.1.4 cl-soup/message-headers.lisp

Dependency

init.lisp (file)

Parent

cl-soup (system)

Location

message-headers.lisp

Exported Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-soup

Source

package.lisp (file)

Nickname

soup

Use List
Exported Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Functions

Function: soup-message-headers-get-list HEADERS NAME
Package

cl-soup

Source

message-headers.lisp (file)

Function: soup-message-headers-get-one HEADERS NAME
Package

cl-soup

Source

message-headers.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-soup.asd: The cl-soup<dot>asd file
cl-soup/init.lisp: The cl-soup/init<dot>lisp file
cl-soup/message-headers.lisp: The cl-soup/message-headers<dot>lisp file
cl-soup/package.lisp: The cl-soup/package<dot>lisp file

F
File, Lisp, cl-soup.asd: The cl-soup<dot>asd file
File, Lisp, cl-soup/init.lisp: The cl-soup/init<dot>lisp file
File, Lisp, cl-soup/message-headers.lisp: The cl-soup/message-headers<dot>lisp file
File, Lisp, cl-soup/package.lisp: The cl-soup/package<dot>lisp file

L
Lisp File, cl-soup.asd: The cl-soup<dot>asd file
Lisp File, cl-soup/init.lisp: The cl-soup/init<dot>lisp file
Lisp File, cl-soup/message-headers.lisp: The cl-soup/message-headers<dot>lisp file
Lisp File, cl-soup/package.lisp: The cl-soup/package<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   F   S  
Index Entry  Section

F
Function, soup-message-headers-get-list: Exported functions
Function, soup-message-headers-get-one: Exported functions

S
soup-message-headers-get-list: Exported functions
soup-message-headers-get-one: Exported functions

Jump to:   F   S  

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

A.3 Variables


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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-soup: The cl-soup system
cl-soup: The cl-soup package

P
Package, cl-soup: The cl-soup package

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

Jump to:   C   P   S