cl-webkit

2021-08-07

No Description

Upstream URL

github.com/joachifm/cl-webkit

Author

Joachim Fasting <joachifm@fastmail.fm>

License

MIT

README.org

1cl-webkit - WebKitGTK+ binding for Common Lisp

1.1About

cl-webkit is a binding to [WebKitGTK+] for Common Lisp, currentlytargeting WebKit version 2. The WebKitGTK+ library adds web browsingcapabilities to an application, leveraging the full power of theWebKit browsing engine.

1.2API overview

The cl-webkit API closely follows the WebKit2 API, with the exceptionthat class based interfaces are preferred over functional interfacesin 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.

1.3Dependencies

  • A working installation of WebKit2GTK+ (whichever package provideslibwebkit2gtk-4.0.so, e.g., libwebkit2gtk on Debian).
  • A [CFFI] compatible Common Lisp implementation. The package isdeveloped using [SBCL] but should work on any implementation thatsupports CFFI.
  • A recent checkout of [cl-cffi-gtk]

1.4Installation

Assuming you have [Quicklisp] installed, do
  1. Clone to ~/common-lisp/quicklisp/local-projects/cl-webkit
  2. > lisp
  3. > (ql:quickload :cl-webkit2)

1.4.1Testing

To run tests, you need to additionally install Calispel,float-features and FiveAM (all of these are available viaQuicklisp). After that, simply running (asdf:test-system :cl-webkit2)should be enough.

1.5Contributing

Contributing implies an agreement to redistribute the work under theproject's license (see below); please make sure that you own therights to the work you contribute.

1.6Resources

1.7Change Log

1.7.13.0.0

  • Make webkit-web-view-evaluate-javascript process the returned valuesand turn them into the matching Lisp values (see jsc-value-to-lispdocstring for transformation rules).
  • The callback to the webkit-web-view-evaluate-javascript now acceptstwo required arguments -- the Lispy data, transformed from theresults of code evaluation, and an original JSCValue it wastransformed from.
  • Add tests (webkit2/tests/ subdirectory and cl-webkit2/tests system),mostly for JS evaluation results.

1.8Copying

cl-webkit is distributed under the MIT license.

Please note that this licence only covers the binding itself. Refer to the distribution terms of the third-party dependencies for details.

Dependencies (5)

  • calispel
  • cffi
  • cl-cffi-gtk
  • fiveam
  • float-features

Dependents (1)

  • GitHub
  • Quicklisp
  • Sponsor