The qt-libs Reference Manual

Table of Contents

The qt-libs Reference Manual

This is the qt-libs Reference Manual, version 2.0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:27:43 2018 GMT+0.

1 Introduction

About qt-libs

Working with Qtools requires working with CommonQt. This in turn currently requires working with SmokeQt. However, SmokeQt is not easily available on all platforms (especially OS X). This project should simply ensure that the libraries are either available by your system directly, or that they are built automatically for you. This ensures that Qtools can be used directly with hopefully no further user intervention being necessary.

The Details

There are two systems to be aware of: qt-lib-generator and qt-libs. The former is what's responsible for building and ensuring the external smoke libraries. The latter invokes the former if necessary, and stores the desired libraries in an easily accessible location, while also ensuring that CommonQt is tricked into using the proper paths when loading its libraries.

In effect this means that if you are running a project that depends on CommonQt (:qt), you should instead depend on :qt-libs, which will try to make sure that everything concerning foreign libraries will go smoothly. By default it uses prebuilt binaries that come from relatively recent, but not too recent systems. This should hopefully mean that all the dependant versions will be available on most systems out there. If that is not the case, you can try to build your own versions to ship.

In the future, CommonQt will use its own system to hook into Qt and drop Smoke support. When that time comes, this project will hopefully become obsolete. However, for the time being, Smoke is a necessary evil, and as such, this library hopes to make things a bit easier.

Precompiled Packages

Included in the precompiled packages for each platform are unless otherwise noted:

• Qt 4.8.7
• Qwt 5
• QImageBlitz
• QScintilla 2
• Phonon
• Smoke
• SmokeQt
• libcommonqt

Notes About the Platforms

Windows

• You will need an x86-64 Windows copy, version 7 or higher. Lower versions might work, but I will not test them.
• You can run both x86 and x86-64 versions of your implementation, but not both at the same time.
• You do not need to install or download Qt itself. Qt-libs will download a precompiled version.
• Drakma requires OpenSSL to download the archives. See https://slproweb.com/products/Win32OpenSSL.html. This is only required for the first-time setup. After that, drakma will not be loaded and you do not need to ship the SSL dlls for things to work.
• QtTest is not available as it fails to build and despite hours being spent on it I cannot figure out how to fix it.

Linux

• You will need an x86-64 Linux setup.
• You can run both x86 and x86-64 versions of your implementation, although precompiled versions only exist for x86-64.
• If you want to build the binaries yourself, you will need to install Qt. Preferably version 4.8.7 . The following packages should suffice for this:
  • Arch: base-devel qt4 qwt qwt5 qimageblitz qscintilla-qt4 phonon-qt4 patchelf
  • Debian & Ubuntu: gcc g++ cmake libqt4-dev libqwt5-qt4-dev libqimageblitz-dev libqscintilla2-dev libphonon-dev patchelf

Mac OS X

• You will need an x86-64 OS X setup, preferably Yosemite (10.10). Lower versions might work, but I will not test them.
• You can run both x86 and x86-64 versions of your implementation, although precompiled versions only exist for x86-64.
• If you want to build the binaries yourself, you will need to install Qt. Preferably version 4.8.7 . The following packages should suffice for this:
  • Xcode: Install its Command Line Tools
  • MacPorts: cmake qt4-mac qwt qimageblitz qscintilla phonon

Lisp

The following implementations have been tested to work. Others may as well, but are not officially supported.

• SBCL (1.2.12+)
• CCL (1.10+)
• ECL (16.1.2+)

Cook It Up!

On Linux and OS X you can automatically compile new versions of the libraries (except for Qt) if you need to. For Windows, see this article. In order to do this, follow these steps:

(ql:quickload :qt-libs)
(qt-libs:ensure-standalone-libs :method :install-sources :force T)

That should automatically download the necessary sources, copy the Qt binaries from your system, and compile the rest of the libraries.

2 Systems

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

2.1 qt-libs

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://github.com/Shinmera/qt-libs

License

Artistic

Description

System to ensure that the necessary Qt libs are available.

Version

2.0.1

Dependencies

• qt-lib-generator (system)
• cl-ppcre
• cffi

Source

qt-libs.asd (file)

Component

qt-libs.lisp (file)

2.2 qt-lib-generator

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://github.com/Shinmera/qt-libs

License

Artistic

Description

Bundling of necessary shared object files and build scripts.

Version

2.0.1

Dependencies

• trivial-features
• pathname-utils
• cl-ppcre
• sb-posix

Source

qt-lib-generator.asd (file)

Components

• package.lisp (file)
• toolkit.lisp (file)
• osx.lisp (file)
• linux.lisp (file)
• build.lisp (file)
• qt4.lisp (file)
• smokegen.lisp (file)
• smokeqt.lisp (file)
• libcommonqt.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 qt-libs.asd

Location

qt-libs.asd

Systems

qt-libs (system)

3.1.2 qt-lib-generator.asd

Location

qt-lib-generator.asd

Systems

qt-lib-generator (system)

3.1.3 qt-libs/qt-libs.lisp

Parent

qt-libs (system)

Location

qt-libs.lisp

Packages

qt-libs

Exported Definitions

• *standalone-libs-dir* (special variable)
• ensure-lib-loaded (function)
• ensure-standalone-libs (function)
• foreign-library-component (class)
• foreign-library-system (class)
• setup-paths (function)

Internal Definitions

• %ensure-lib-loaded (function)
• compile-foreign-library-system (function)
• copy-directory-tree (function)
• copy-libs (function)
• f (macro)
• generate-foreign-library-systems (function)
• installed-library-file (function)
• library-files (method)
• (setf library-files) (method)
• normalize-library-name (function)
• smoke-module (method)
• (setf smoke-module) (method)
• starts-with (function)
• write-foreign-library-system (function)

3.1.4 qt-lib-generator/package.lisp

Parent

qt-lib-generator (system)

Location

package.lisp

Packages

qt-lib-generator

3.1.5 qt-lib-generator/toolkit.lisp

Dependency

package.lisp (file)

Parent

qt-lib-generator (system)

Location

toolkit.lisp

Exported Definitions

• *max-cpus* (special variable)
• application-available-p (function)
• arch (function)
• check-checksum (function)
• check-file-exists (function)
• check-prerequisite (function)
• checksum-file (function)
• checksum-string (function)
• copy-directory-files (function)
• copy-file (function)
• cpu-count (function)
• determine-shared-library-name (function)
• determine-shared-library-type (function)
• download-file (function)
• ensure-system (function)
• externalize (function)
• extract-archive (function)
• get-path (function)
• make-shared-library-files (function)
• platform (function)
• pushnew-path (function)
• qt-libs-cache-directory (function)
• run-here (function)
• set-path (function)
• setenv (function)
• shared-library-file (function)
• status (function)
• with-chdir (macro)

Internal Definitions

flatten (function)

3.1.6 qt-lib-generator/osx.lisp

Dependency

toolkit.lisp (file)

Parent

qt-lib-generator (system)

Location

osx.lisp

Exported Definitions

• dylib-dependencies (function)
• dylib-set-dependency-name (function)
• dylib-set-install-name (function)
• dylib-set-options (function)
• find-similar (function)
• fix-dylib-collection (function)
• fix-dylib-paths (function)

Internal Definitions

levenshtein-distance (function)

3.1.7 qt-lib-generator/linux.lisp

Dependency

osx.lisp (file)

Parent

qt-lib-generator (system)

Location

linux.lisp

Exported Definitions

• fix-ldlib-collection (function)
• fix-ldlib-paths (function)
• ldlib-dependencies (function)
• ldlib-set-dependency-name (function)
• ldlib-set-options (function)
• ldlib-soname (function)
• patchelf (function)

Internal Definitions

soname-assoc-list (function)

3.1.8 qt-lib-generator/build.lisp

Dependency

linux.lisp (file)

Parent

qt-lib-generator (system)

Location

build.lisp

Exported Definitions

• base-directory (method)
• (setf base-directory) (method)
• binaries-archive (method)
• (setf binaries-archive) (method)
• build-directory (method)
• (setf build-directory) (method)
• build-library (class)
• checksummed-library (class)
• checksums (method)
• (setf checksums) (method)
• cmake-build-library (class)
• cmake-flags (method)
• (setf cmake-flags) (method)
• download-library (class)
• expected-checksum (generic function)
• expected-checksum (method)
• expected-checksum (method)
• find-local-files (generic function)
• find-local-files (method)
• foreign-library (class)
• github-library (class)
• install-directory (method)
• (setf install-directory) (method)
• local-file-cache (method)
• (setf local-file-cache) (method)
• locally-available-library (class)
• locally-available-p (generic function)
• locally-available-p (method)
• make-build-library (class)
• make-file (method)
• (setf make-file) (method)
• make-flags (method)
• (setf make-flags) (method)
• name (method)
• (setf name) (method)
• output-files (generic function)
• output-files (method)
• sources-archive (method)
• (setf sources-archive) (method)
• stage (generic function)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• tag (method)
• (setf tag) (method)
• url (method)
• (setf url) (method)

Internal Definitions

• binaries-url (generic function)
• binaries-url (method)
• sources-url (generic function)
• sources-url (method)

3.1.9 qt-lib-generator/qt4.lisp

Dependency

build.lisp (file)

Parent

qt-lib-generator (system)

Location

qt4.lisp

Exported Definitions

• find-local-files (method)
• qt4 (class)

Internal Definitions

• *generic-library-directories* (special variable)
• *qt-module-list* (special variable)
• find-qt-lib-directory (function)
• find-qt-plugins-directory (function)
• qt4-on-path-p (function)

3.1.10 qt-lib-generator/smokegen.lisp

Dependency

qt4.lisp (file)

Parent

qt-lib-generator (system)

Location

smokegen.lisp

Exported Definitions

• cmake-flags (method)
• output-files (method)
• smokegen (class)
• stage (method)

3.1.11 qt-lib-generator/smokeqt.lisp

Dependency

smokegen.lisp (file)

Parent

qt-lib-generator (system)

Location

smokeqt.lisp

Exported Definitions

• cmake-flags (method)
• output-files (method)
• smokegen (method)
• (setf smokegen) (method)
• smokeqt (class)
• stage (method)
• stage (method)

3.1.12 qt-lib-generator/libcommonqt.lisp

Dependency

smokeqt.lisp (file)

Parent

qt-lib-generator (system)

Location

libcommonqt.lisp

Exported Definitions

• fix-commonqt-pro-file (function)
• libcommonqt (class)
• smokeqt (method)
• (setf smokeqt) (method)
• stage (method)
• stage (method)

4 Packages

Packages are listed by definition order.

4.1 qt-libs

Source

qt-libs.lisp (file)

Nickname

org.shirakumo.qtools.libs

Use List

• pathname-utils
• qt-lib-generator
• common-lisp

Exported Definitions

• *standalone-libs-dir* (special variable)
• ensure-lib-loaded (function)
• ensure-standalone-libs (function)
• foreign-library-component (class)
• foreign-library-system (class)
• setup-paths (function)

Internal Definitions

• %ensure-lib-loaded (function)
• compile-foreign-library-system (function)
• copy-directory-tree (function)
• copy-libs (function)
• f (macro)
• generate-foreign-library-systems (function)
• installed-library-file (function)
• library-files (generic function)
• library-files (method)
• (setf library-files) (method)
• (setf library-files) (generic function)
• normalize-library-name (function)
• smoke-module (generic function)
• smoke-module (method)
• (setf smoke-module) (method)
• (setf smoke-module) (generic function)
• starts-with (function)
• write-foreign-library-system (function)

4.2 qt-lib-generator

Source

package.lisp (file)

Nickname

org.shirakumo.qtools.libs.generator

Use List

• pathname-utils
• common-lisp

Used By List

qt-libs

Exported Definitions

• *max-cpus* (special variable)
• application-available-p (function)
• arch (function)
• base-directory (generic function)
• base-directory (method)
• (setf base-directory) (method)
• (setf base-directory) (generic function)
• binaries-archive (generic function)
• binaries-archive (method)
• (setf binaries-archive) (method)
• (setf binaries-archive) (generic function)
• build-directory (generic function)
• build-directory (method)
• (setf build-directory) (method)
• (setf build-directory) (generic function)
• build-library (class)
• check-checksum (function)
• check-file-exists (function)
• check-prerequisite (function)
• checksum-file (function)
• checksum-string (function)
• checksummed-library (class)
• checksums (generic function)
• checksums (method)
• (setf checksums) (method)
• (setf checksums) (generic function)
• cmake-build-library (class)
• cmake-flags (generic function)
• cmake-flags (method)
• cmake-flags (method)
• cmake-flags (method)
• (setf cmake-flags) (method)
• (setf cmake-flags) (generic function)
• copy-directory-files (function)
• copy-file (function)
• cpu-count (function)
• determine-shared-library-name (function)
• determine-shared-library-type (function)
• download-file (function)
• download-library (class)
• dylib-dependencies (function)
• dylib-set-dependency-name (function)
• dylib-set-install-name (function)
• dylib-set-options (function)
• ensure-system (function)
• expected-checksum (generic function)
• expected-checksum (method)
• expected-checksum (method)
• externalize (function)
• extract-archive (function)
• find-local-files (generic function)
• find-local-files (method)
• find-local-files (method)
• find-similar (function)
• fix-commonqt-pro-file (function)
• fix-dylib-collection (function)
• fix-dylib-paths (function)
• fix-ldlib-collection (function)
• fix-ldlib-paths (function)
• foreign-library (class)
• get-path (function)
• github-library (class)
• install-directory (generic function)
• install-directory (method)
• (setf install-directory) (method)
• (setf install-directory) (generic function)
• ldlib-dependencies (function)
• ldlib-set-dependency-name (function)
• ldlib-set-options (function)
• ldlib-soname (function)
• libcommonqt (class)
• local-file-cache (generic function)
• local-file-cache (method)
• (setf local-file-cache) (method)
• (setf local-file-cache) (generic function)
• locally-available-library (class)
• locally-available-p (generic function)
• locally-available-p (method)
• make-build-library (class)
• make-file (generic function)
• make-file (method)
• (setf make-file) (method)
• (setf make-file) (generic function)
• make-flags (generic function)
• make-flags (method)
• (setf make-flags) (method)
• (setf make-flags) (generic function)
• make-shared-library-files (function)
• name (generic function)
• name (method)
• (setf name) (method)
• (setf name) (generic function)
• output-files (generic function)
• output-files (method)
• output-files (method)
• output-files (method)
• patchelf (function)
• platform (function)
• pushnew-path (function)
• qt-libs-cache-directory (function)
• qt4 (class)
• run-here (function)
• set-path (function)
• setenv (function)
• shared-library-file (function)
• smokegen (generic function)
• smokegen (method)
• (setf smokegen) (method)
• (setf smokegen) (generic function)
• smokegen (class)
• smokeqt (generic function)
• smokeqt (method)
• (setf smokeqt) (method)
• (setf smokeqt) (generic function)
• smokeqt (class)
• sources-archive (generic function)
• sources-archive (method)
• (setf sources-archive) (method)
• (setf sources-archive) (generic function)
• stage (generic function)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• status (function)
• tag (generic function)
• tag (method)
• (setf tag) (method)
• (setf tag) (generic function)
• url (generic function)
• url (method)
• (setf url) (method)
• (setf url) (generic function)
• with-chdir (macro)

Internal Definitions

• *generic-library-directories* (special variable)
• *qt-module-list* (special variable)
• binaries-url (generic function)
• binaries-url (method)
• find-qt-lib-directory (function)
• find-qt-plugins-directory (function)
• flatten (function)
• levenshtein-distance (function)
• qt4-on-path-p (function)
• soname-assoc-list (function)
• sources-url (generic function)
• sources-url (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *max-cpus*

Package

qt-lib-generator

Source

toolkit.lisp (file)

Special Variable: *standalone-libs-dir*

Package

qt-libs

Source

qt-libs.lisp (file)

5.1.2 Macros

Macro: with-chdir (TO) &body BODY

Package

qt-lib-generator

Source

toolkit.lisp (file)

5.1.3 Functions

Function: application-available-p &rest ALTERNATIVES

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: arch ()

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: check-checksum FILE CHECKSUM

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: check-file-exists FILE

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: check-prerequisite NAME &rest ALTERNATIVES

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: checksum-file TARGET

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: checksum-string VECTOR

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: copy-directory-files DIR TO &key REPLACE

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: copy-file FILE TO &key REPLACE

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: cpu-count ()

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: determine-shared-library-name PATHNAME

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: determine-shared-library-type PATHNAME

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: download-file URL TARGET

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: dylib-dependencies PATHNAME

Package

qt-lib-generator

Source

osx.lisp (file)

Function: dylib-set-dependency-name PATHNAME &rest PAIRS

Package

qt-lib-generator

Source

osx.lisp (file)

Function: dylib-set-install-name PATHNAME NAME

Package

qt-lib-generator

Source

osx.lisp (file)

Function: dylib-set-options PATHNAME &key NAME DEPENDENCIES RPATHS ADD-RPATHS REMOVE-RPATHS

Package

qt-lib-generator

Source

osx.lisp (file)

Function: ensure-lib-loaded FILE

Package

qt-libs

Source

qt-libs.lisp (file)

Function: ensure-standalone-libs &key METHOD FORCE STANDALONE-DIR

Package

qt-libs

Source

qt-libs.lisp (file)

Function: ensure-system SYSTEM &optional PACKAGE

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: externalize THING

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: extract-archive FROM TO &key STRIP-FOLDER

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: find-similar PATHNAME FILES

Package

qt-lib-generator

Source

osx.lisp (file)

Function: fix-commonqt-pro-file FILE &rest BASEPATHS

Package

qt-lib-generator

Source

libcommonqt.lisp (file)

Function: fix-dylib-collection FILES

Package

qt-lib-generator

Source

osx.lisp (file)

Function: fix-dylib-paths PATHNAME &optional REPLACEMENTS

Package

qt-lib-generator

Source

osx.lisp (file)

Function: fix-ldlib-collection FILES

Package

qt-lib-generator

Source

linux.lisp (file)

Function: fix-ldlib-paths PATHNAME &optional SONAMES

Package

qt-lib-generator

Source

linux.lisp (file)

Function: get-path &optional ENVVAR

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: ldlib-dependencies PATHNAME

Package

qt-lib-generator

Source

linux.lisp (file)

Function: ldlib-set-dependency-name PATHNAME &rest PAIRS

Package

qt-lib-generator

Source

linux.lisp (file)

Function: ldlib-set-options PATHNAME &key NAME DEPENDENCIES RPATH INTERPRETER

Package

qt-lib-generator

Source

linux.lisp (file)

Function: ldlib-soname PATHNAME

Package

qt-lib-generator

Source

linux.lisp (file)

Function: make-shared-library-files NAMES DEFAULTS &key KEY

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: patchelf PATHNAME &rest ARGS

Package

qt-lib-generator

Source

linux.lisp (file)

Function: platform ()

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: pushnew-path PATH &optional ENVVAR

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: qt-libs-cache-directory ()

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: run-here STRING &rest FORMAT-ARGS

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: set-path PATHS &optional ENVVAR

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: setenv ENVVAR NEW-VALUE

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: setup-paths ()

Package

qt-libs

Source

qt-libs.lisp (file)

Function: shared-library-file &rest ARGS &key HOST DEVICE DIRECTORY NAME VERSION DEFAULTS

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: status N STRING &rest FORMAT-ARGS

Package

qt-lib-generator

Source

toolkit.lisp (file)

5.1.4 Generic functions

Generic Function: base-directory OBJECT

Generic Function: (setf base-directory) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: base-directory (FOREIGN-LIBRARY foreign-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf base-directory) NEW-VALUE (FOREIGN-LIBRARY foreign-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: binaries-archive OBJECT

Generic Function: (setf binaries-archive) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: binaries-archive (DOWNLOAD-LIBRARY download-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf binaries-archive) NEW-VALUE (DOWNLOAD-LIBRARY download-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: build-directory OBJECT

Generic Function: (setf build-directory) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: build-directory (FOREIGN-LIBRARY foreign-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf build-directory) NEW-VALUE (FOREIGN-LIBRARY foreign-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: checksums OBJECT

Generic Function: (setf checksums) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: checksums (CHECKSUMMED-LIBRARY checksummed-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf checksums) NEW-VALUE (CHECKSUMMED-LIBRARY checksummed-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: cmake-flags OBJECT

Generic Function: (setf cmake-flags) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: cmake-flags (LIBRARY smokeqt)

Source

smokeqt.lisp (file)

Method: cmake-flags (LIBRARY smokegen)

Source

smokegen.lisp (file)

Method: cmake-flags (CMAKE-BUILD-LIBRARY cmake-build-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf cmake-flags) NEW-VALUE (CMAKE-BUILD-LIBRARY cmake-build-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: expected-checksum CHECKSUMMED-LIBRARY ARCHIVE &key PLATFORM ARCH &allow-other-keys

Package

qt-lib-generator

Source

build.lisp (file)

Methods

Method: expected-checksum (LIBRARY checksummed-library) (ARCHIVE (eql binaries)) &key PLATFORM ARCH &allow-other-keys

Method: expected-checksum (LIBRARY checksummed-library) (ARCHIVE (eql sources)) &key &allow-other-keys

Generic Function: find-local-files LOCALLY-AVAILABLE-LIBRARY

Package

qt-lib-generator

Source

build.lisp (file)

Methods

Method: find-local-files (SYSTEM qt4)

Source

qt4.lisp (file)

Method: find-local-files (LIBRARY locally-available-library) around

Generic Function: install-directory OBJECT

Generic Function: (setf install-directory) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: install-directory (FOREIGN-LIBRARY foreign-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf install-directory) NEW-VALUE (FOREIGN-LIBRARY foreign-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: local-file-cache OBJECT

Generic Function: (setf local-file-cache) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: local-file-cache (LOCALLY-AVAILABLE-LIBRARY locally-available-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf local-file-cache) NEW-VALUE (LOCALLY-AVAILABLE-LIBRARY locally-available-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: locally-available-p LOCALLY-AVAILABLE-LIBRARY

Package

qt-lib-generator

Source

build.lisp (file)

Methods

Method: locally-available-p (LIBRARY locally-available-library)

Generic Function: make-file OBJECT

Generic Function: (setf make-file) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: make-file (MAKE-BUILD-LIBRARY make-build-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf make-file) NEW-VALUE (MAKE-BUILD-LIBRARY make-build-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: make-flags OBJECT

Generic Function: (setf make-flags) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: make-flags (MAKE-BUILD-LIBRARY make-build-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf make-flags) NEW-VALUE (MAKE-BUILD-LIBRARY make-build-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: name OBJECT

Generic Function: (setf name) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: name (FOREIGN-LIBRARY foreign-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf name) NEW-VALUE (FOREIGN-LIBRARY foreign-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: output-files FOREIGN-LIBRARY

Package

qt-lib-generator

Source

build.lisp (file)

Methods

Method: output-files (LIBRARY smokeqt)

Source

smokeqt.lisp (file)

Method: output-files (LIBRARY smokegen)

Source

smokegen.lisp (file)

Method: output-files (LIBRARY foreign-library)

Generic Function: smokegen OBJECT

Generic Function: (setf smokegen) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: smokegen (SMOKEQT smokeqt)

automatically generated reader method

Source

smokeqt.lisp (file)

Method: (setf smokegen) NEW-VALUE (SMOKEQT smokeqt)

automatically generated writer method

Source

smokeqt.lisp (file)

Generic Function: smokeqt OBJECT

Generic Function: (setf smokeqt) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: smokeqt (LIBCOMMONQT libcommonqt)

automatically generated reader method

Source

libcommonqt.lisp (file)

Method: (setf smokeqt) NEW-VALUE (LIBCOMMONQT libcommonqt)

automatically generated writer method

Source

libcommonqt.lisp (file)

Generic Function: sources-archive OBJECT

Generic Function: (setf sources-archive) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: sources-archive (DOWNLOAD-LIBRARY download-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf sources-archive) NEW-VALUE (DOWNLOAD-LIBRARY download-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: stage STAGE FOREIGN-LIBRARY &key FORCE PLATFORM ARCH ARCHIVES &allow-other-keys

Package

qt-lib-generator

Source

build.lisp (file)

Methods

Method: stage (STAGE (eql install-sources)) (LIBRARY libcommonqt) &key &allow-other-keys

Source

libcommonqt.lisp (file)

Method: stage (STAGE (eql prepare-sources)) (LIBRARY libcommonqt) &key &allow-other-keys

Source

libcommonqt.lisp (file)

Method: stage (STAGE (eql compile-sources)) (LIBRARY smokeqt) &key &allow-other-keys around

Source

smokeqt.lisp (file)

Method: stage (STAGE (eql prepare-sources)) (LIBRARY smokeqt) &key &allow-other-keys before

Source

smokeqt.lisp (file)

Method: stage (STAGE (eql install-sources)) (LIBRARY smokegen) &key &allow-other-keys after

Source

smokegen.lisp (file)

Method: stage (STAGE (eql install-sources)) (LIBRARY locally-available-library) &key &allow-other-keys

Method: stage (STAGE (eql prepare-sources)) (LIBRARY locally-available-library) &key &allow-other-keys

Method: stage (STAGE (eql download-sources)) (LIBRARY locally-available-library) &key &allow-other-keys

Method: stage (STAGE (eql download-binaries)) (LIBRARY checksummed-library) &key PLATFORM ARCH &allow-other-keys after

Method: stage (STAGE (eql download-sources)) (LIBRARY checksummed-library) &key &allow-other-keys after

Method: stage (STAGE (eql prepare-sources)) (LIBRARY cmake-build-library) &key &allow-other-keys

Method: stage (STAGE (eql install-sources)) (LIBRARY make-build-library) &key &allow-other-keys

Method: stage (STAGE (eql compile-sources)) (LIBRARY make-build-library) &key &allow-other-keys

Method: stage (STAGE (eql prepare-sources)) (LIBRARY make-build-library) &key &allow-other-keys

Method: stage (STAGE (eql install-sources)) (LIBRARY build-library) &key FORCE &allow-other-keys around

Method: stage (STAGE (eql compile-sources)) (LIBRARY build-library) &key FORCE &allow-other-keys around

Method: stage (STAGE (eql prepare-sources)) (LIBRARY build-library) &key FORCE &allow-other-keys around

Method: stage (STAGE (eql clean)) (LIBRARY download-library) &key ARCHIVES &allow-other-keys after

Method: stage (STAGE (eql install-binaries)) (LIBRARY download-library) &key FORCE &allow-other-keys

Method: stage (STAGE (eql download-binaries)) (LIBRARY download-library) &key PLATFORM ARCH &allow-other-keys

Method: stage (STAGE (eql prepare-sources)) (LIBRARY download-library) &key FORCE &allow-other-keys

Method: stage (STAGE (eql download-sources)) (LIBRARY download-library) &key &allow-other-keys

Method: stage (STAGE (eql download-binaries)) (LIBRARY download-library) &key FORCE &allow-other-keys around

Method: stage (STAGE (eql download-sources)) (LIBRARY download-library) &key FORCE &allow-other-keys around

Method: stage (STAGE (eql clean)) (LIBRARY foreign-library) &key &allow-other-keys

Method: stage STAGE (LIBRARY foreign-library) &rest ARGS &key &allow-other-keys around

Generic Function: tag OBJECT

Generic Function: (setf tag) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: tag (GITHUB-LIBRARY github-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf tag) NEW-VALUE (GITHUB-LIBRARY github-library)

automatically generated writer method

Source

build.lisp (file)

Generic Function: url OBJECT

Generic Function: (setf url) NEW-VALUE OBJECT

Package

qt-lib-generator

Methods

Method: url (GITHUB-LIBRARY github-library)

automatically generated reader method

Source

build.lisp (file)

Method: (setf url) NEW-VALUE (GITHUB-LIBRARY github-library)

automatically generated writer method

Source

build.lisp (file)

5.1.5 Classes

Class: build-library ()

Package

qt-lib-generator

Source

build.lisp (file)

Direct superclasses

foreign-library (class)

Direct subclasses

make-build-library (class)

Direct methods

• stage (method)
• stage (method)
• stage (method)

Class: checksummed-library ()

Package

qt-lib-generator

Source

build.lisp (file)

Direct superclasses

foreign-library (class)

Direct subclasses

• qt4 (class)
• smokegen (class)
• smokeqt (class)
• libcommonqt (class)

Direct methods

• stage (method)
• stage (method)
• expected-checksum (method)
• expected-checksum (method)
• checksums (method)
• checksums (method)

Direct slots

Slot: checksums

Initargs

:checksums

Readers

checksums (generic function)

Writers

(setf checksums) (generic function)

Class: cmake-build-library ()

Package

qt-lib-generator

Source

build.lisp (file)

Direct superclasses

make-build-library (class)

Direct subclasses

• smokegen (class)
• smokeqt (class)

Direct methods

• stage (method)
• cmake-flags (method)
• cmake-flags (method)

Direct slots

Slot: cmake-flags

Initargs

:cmake-flags

Readers

cmake-flags (generic function)

Writers

(setf cmake-flags) (generic function)

Class: download-library ()

Package

qt-lib-generator

Source

build.lisp (file)

Direct superclasses

foreign-library (class)

Direct subclasses

github-library (class)

Direct methods

• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• stage (method)
• initialize-instance (method)
• binaries-archive (method)
• binaries-archive (method)
• sources-archive (method)
• sources-archive (method)

Direct slots

Slot: sources-archive

Initargs

:sources-archive

Readers

sources-archive (generic function)

Writers

(setf sources-archive) (generic function)

Slot: binaries-archive

Initargs

:binaries-archive

Readers

binaries-archive (generic function)

Writers

(setf binaries-archive) (generic function)

Class: foreign-library ()

Package

qt-lib-generator

Source

build.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• download-library (class)
• build-library (class)
• checksummed-library (class)
• locally-available-library (class)

Direct methods

• output-files (method)
• stage (method)
• stage (method)
• initialize-instance (method)
• install-directory (method)
• install-directory (method)
• build-directory (method)
• build-directory (method)
• base-directory (method)
• base-directory (method)
• name (method)
• name (method)

Direct slots

Slot: name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: base-directory

Initargs

:base-directory

Readers

base-directory (generic function)

Writers

(setf base-directory) (generic function)

Slot: build-directory

Initargs

:build-directory

Readers

build-directory (generic function)

Writers

(setf build-directory) (generic function)

Slot: install-directory

Initargs

:install-directory

Readers

install-directory (generic function)

Writers

(setf install-directory) (generic function)

Class: foreign-library-component ()

Package

qt-libs

Source

qt-libs.lisp (file)

Direct superclasses

file-component (class)

Direct methods

• perform (method)
• perform (method)

Direct Default Initargs

Initarg	Value
:type	"so"

Class: foreign-library-system ()

Package

qt-libs

Source

qt-libs.lisp (file)

Direct superclasses

system (class)

Direct methods

• perform (method)
• perform (method)
• smoke-module (method)
• smoke-module (method)
• library-files (method)
• library-files (method)

Direct slots

Slot: library-files

Initargs

:library-files

Readers

library-files (generic function)

Writers

(setf library-files) (generic function)

Slot: smoke-module

Initargs

:module

Readers

smoke-module (generic function)

Writers

(setf smoke-module) (generic function)

Class: github-library ()

Package

qt-lib-generator

Source

build.lisp (file)

Direct superclasses

download-library (class)

Direct subclasses

• qt4 (class)
• smokegen (class)
• smokeqt (class)
• libcommonqt (class)

Direct methods

• binaries-url (method)
• sources-url (method)
• initialize-instance (method)
• tag (method)
• tag (method)
• url (method)
• url (method)

Direct slots

Slot: url

Initargs

:url

Readers

url (generic function)

Writers

(setf url) (generic function)

Slot: tag

Initargs

:tag

Readers

tag (generic function)

Writers

(setf tag) (generic function)

Class: libcommonqt ()

Package

qt-lib-generator

Source

libcommonqt.lisp (file)

Direct superclasses

• checksummed-library (class)
• github-library (class)
• make-build-library (class)

Direct methods

• stage (method)
• stage (method)
• smokeqt (method)
• smokeqt (method)

Direct slots

Slot: smokeqt

Initargs

:smokeqt

Initform

(make-instance (quote qt-lib-generator:smokeqt))

Readers

smokeqt (generic function)

Writers

(setf smokeqt) (generic function)

Direct Default Initargs

Initarg	Value
:tag	"qt-libs2.0.1"

Class: locally-available-library ()

Package

qt-lib-generator

Source

build.lisp (file)

Direct superclasses

foreign-library (class)

Direct subclasses

qt4 (class)

Direct methods

• stage (method)
• stage (method)
• stage (method)
• locally-available-p (method)
• find-local-files (method)
• local-file-cache (method)
• local-file-cache (method)

Direct slots

Slot: local-file-cache

Initform

:unsaved

Readers

local-file-cache (generic function)

Writers

(setf local-file-cache) (generic function)

Class: make-build-library ()

Package

qt-lib-generator

Source

build.lisp (file)

Direct superclasses

build-library (class)

Direct subclasses

• cmake-build-library (class)
• libcommonqt (class)

Direct methods

• stage (method)
• stage (method)
• stage (method)
• make-flags (method)
• make-flags (method)
• make-file (method)
• make-file (method)

Direct slots

Slot: make-file

Initargs

:make-file

Initform

"makefile"

Readers

make-file (generic function)

Writers

(setf make-file) (generic function)

Slot: make-flags

Initargs

:make-flags

Initform

(list "-j" (max 1 (1- (qt-lib-generator:cpu-count))))

Readers

make-flags (generic function)

Writers

(setf make-flags) (generic function)

Class: qt4 ()

Package

qt-lib-generator

Source

qt4.lisp (file)

Direct superclasses

• checksummed-library (class)
• github-library (class)
• locally-available-library (class)

Direct methods

find-local-files (method)

Direct Default Initargs

Initarg	Value
:tag	"qt-libs2.0.1"

Class: smokegen ()

Package

qt-lib-generator

Source

smokegen.lisp (file)

Direct superclasses

• checksummed-library (class)
• github-library (class)
• cmake-build-library (class)

Direct methods

• output-files (method)
• stage (method)
• cmake-flags (method)

Direct Default Initargs

Initarg	Value
:tag	"qt-libs2.0.1"

Class: smokeqt ()

Package

qt-lib-generator

Source

smokeqt.lisp (file)

Direct superclasses

• checksummed-library (class)
• github-library (class)
• cmake-build-library (class)

Direct methods

• output-files (method)
• stage (method)
• stage (method)
• cmake-flags (method)
• smokegen (method)
• smokegen (method)

Direct slots

Slot: smokegen

Initargs

:smokegen

Initform

(make-instance (quote qt-lib-generator:smokegen))

Readers

smokegen (generic function)

Writers

(setf smokegen) (generic function)

Direct Default Initargs

Initarg	Value
:tag	"qt-libs2.0.1"

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *generic-library-directories*

Package

qt-lib-generator

Source

qt4.lisp (file)

Special Variable: *qt-module-list*

Package

qt-lib-generator

Source

qt4.lisp (file)

5.2.2 Macros

Macro: f PKG NAME &rest ARGS

Package

qt-libs

Source

qt-libs.lisp (file)

5.2.3 Functions

Function: %ensure-lib-loaded FILE

Package

qt-libs

Source

qt-libs.lisp (file)

Function: compile-foreign-library-system NAME &key MODULE DEPENDS-ON LIBRARY-FILES

Package

qt-libs

Source

qt-libs.lisp (file)

Function: copy-directory-tree FROM TO &key FORCE

Package

qt-libs

Source

qt-libs.lisp (file)

Function: copy-libs FROM TO &key TEST FORCE

Package

qt-libs

Source

qt-libs.lisp (file)

Function: find-qt-lib-directory ()

Package

qt-lib-generator

Source

qt4.lisp (file)

Function: find-qt-plugins-directory ()

Package

qt-lib-generator

Source

qt4.lisp (file)

Function: flatten LIST

Package

qt-lib-generator

Source

toolkit.lisp (file)

Function: generate-foreign-library-systems ()

Package

qt-libs

Source

qt-libs.lisp (file)

Function: installed-library-file NAME &optional DEFAULTS

Package

qt-libs

Source

qt-libs.lisp (file)

Function: levenshtein-distance A B

Package

qt-lib-generator

Source

osx.lisp (file)

Function: normalize-library-name NAME

Package

qt-libs

Source

qt-libs.lisp (file)

Function: qt4-on-path-p PATH

Package

qt-lib-generator

Source

qt4.lisp (file)

Function: soname-assoc-list FILES

Package

qt-lib-generator

Source

linux.lisp (file)

Function: starts-with A STRING

Package

qt-libs

Source

qt-libs.lisp (file)

Function: write-foreign-library-system NAME &key MODULE DEPENDS-ON LIBRARY-FILES PATH

Package

qt-libs

Source

qt-libs.lisp (file)

5.2.4 Generic functions

Generic Function: binaries-url DOWNLOAD-LIBRARY &key PLATFORM ARCH

Package

qt-lib-generator

Source

build.lisp (file)

Methods

Method: binaries-url (LIBRARY github-library) &key PLATFORM ARCH

Generic Function: library-files OBJECT

Generic Function: (setf library-files) NEW-VALUE OBJECT

Package

qt-libs

Methods

Method: library-files (FOREIGN-LIBRARY-SYSTEM foreign-library-system)

automatically generated reader method

Source

qt-libs.lisp (file)

Method: (setf library-files) NEW-VALUE (FOREIGN-LIBRARY-SYSTEM foreign-library-system)

automatically generated writer method

Source

qt-libs.lisp (file)

Generic Function: smoke-module OBJECT

Generic Function: (setf smoke-module) NEW-VALUE OBJECT

Package

qt-libs

Methods

Method: smoke-module (FOREIGN-LIBRARY-SYSTEM foreign-library-system)

automatically generated reader method

Source

qt-libs.lisp (file)

Method: (setf smoke-module) NEW-VALUE (FOREIGN-LIBRARY-SYSTEM foreign-library-system)

automatically generated writer method

Source

qt-libs.lisp (file)

Generic Function: sources-url DOWNLOAD-LIBRARY

Package

qt-lib-generator

Source

build.lisp (file)

Methods

Method: sources-url (LIBRARY github-library)

Appendix A Indexes

A.1 Concepts

A.2 Functions