This is the bike-internals Reference Manual, version 0.14.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:23:57 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
bike-internalsCommon Lisp .Net Core Interop Internals
Dmitry Ignatiev
Dmitry Ignatiev
MIT
0.14.0
uiop (system).
alexandria (system).
global-vars (system).
cffi (system).
cl-ppcre (system).
split-sequence (system).
flexi-streams (system).
trivial-features (system).
trivial-garbage (system).
bordeaux-threads (system).
closer-mop (system).
src (module).
Modules are listed depth-first from the system components tree.
bike-internals/srcbike-internals (system).
internals-package.lisp (file).
features.lisp (file).
string-buffer.lisp (file).
internals-ffi.lisp (file).
rwlock.lisp (file).
internals.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
bike-internals/bike-internals.asdbike-internals/src/internals-package.lispbike-internals/src/features.lispbike-internals/src/string-buffer.lispbike-internals/src/internals-ffi.lispbike-internals/src/rwlock.lispbike-internals/src/internals.lispbike-internals/bike-internals.asdbike-internals (system).
bike-internals/src/features.lispinternals-package.lisp (file).
src (module).
bike-internals/src/string-buffer.lispfeatures.lisp (file).
src (module).
*default-string-buffer-capacity* (special variable).
camel-case-string (function).
copy-line-buffer (function).
copy-string-buffer (function).
lb-line-start (function).
lb-position (function).
lb-process-lines (function).
lb-seen-cr-p (function).
lb-shift (function).
line-buffer (structure).
line-buffer-p (function).
line-callback (type).
lisp-case-string (function).
make-line-buffer (function).
make-line-output-callback (function).
make-simple-character-string (function).
make-string-buffer (function).
process-string-lines (function).
sb-append-format (function).
sb-append-line (function).
sb-append-string (function).
sb-capacity (function).
sb-data (function).
sb-delete (function).
sb-ensure-capacity (function).
sb-extend (function).
sb-insert-string (function).
sb-length (function).
(setf sb-length) (function).
sb-string (function).
simple-character-string (function).
simple-character-string (type).
simple-character-string-upcase (function).
string-buffer (structure).
string-buffer-p (function).
whitespace-char-p (function).
%base-string-to-string (function).
%lb-cap (function).
(setf %lb-cap) (function).
%lb-data (function).
(setf %lb-data) (function).
%lb-len (function).
(setf %lb-len) (function).
%lb-line-start (reader).
(setf %lb-line-start) (writer).
%lb-pos (reader).
(setf %lb-pos) (writer).
%lb-seen-cr (reader).
(setf %lb-seen-cr) (writer).
%make-line-buffer (function).
%make-string-buffer (function).
%maybe-string-upcase (function).
%sb-cap (reader).
(setf %sb-cap) (writer).
%sb-data (reader).
(setf %sb-data) (writer).
%sb-len (reader).
(setf %sb-len) (writer).
+ascii-char-code-limit+ (constant).
+max-string-buffer-capacity+ (constant).
bike-internals/src/internals-ffi.lispstring-buffer.lisp (file).
src (module).
+pointer-bits+ (constant).
+pointer-size+ (constant).
add-default-library-directory (function).
define-foreign-library-once (macro).
expand-from-foreign (method).
expand-to-foreign (method).
get-exe-path (function).
load-foreign-library-once (function).
native-path (function).
remove-default-library-directory (function).
translate-from-foreign (method).
translate-to-foreign (method).
use-foreign-library-once (macro).
clear-default-library-directories (function).
dotnet-char-type (class).
bike-internals/src/rwlock.lispinternals-ffi.lisp (file).
src (module).
make-rwlock (function).
rwlock (structure).
rwlock-name (function).
rwlockp (function).
with-read-lock (macro).
with-write-lock (macro).
%make-rwlock (function).
%rwlock-cv-lock (reader).
%rwlock-name (reader).
(setf %rwlock-name) (writer).
%rwlock-reader-count (reader).
(setf %rwlock-reader-count) (writer).
%rwlock-reader-cv (reader).
%rwlock-threads (reader).
(setf %rwlock-threads) (writer).
%rwlock-upgrade-cv (reader).
%rwlock-upgrading-count (reader).
(setf %rwlock-upgrading-count) (writer).
%rwlock-waiting-reader-count (reader).
(setf %rwlock-waiting-reader-count) (writer).
%rwlock-waiting-upgrade-count (reader).
(setf %rwlock-waiting-upgrade-count) (writer).
%rwlock-waiting-writer-count (reader).
(setf %rwlock-waiting-writer-count) (writer).
%rwlock-writer (reader).
(setf %rwlock-writer) (writer).
%rwlock-writer-count (reader).
(setf %rwlock-writer-count) (writer).
%rwlock-writer-cv (reader).
make-rwlti (function).
rwlock-begin-read (function).
rwlock-begin-write (function).
rwlock-end-read (function).
rwlock-end-write (function).
rwlock-modify-count (function).
rwlock-thread-info (function).
rwlock-thread-info (structure).
rwlock-thread-info-p (function).
rwlock-wait (function).
rwlti-next (reader).
(setf rwlti-next) (writer).
rwlti-read-count (reader).
(setf rwlti-read-count) (writer).
rwlti-thread (reader).
(setf rwlti-thread) (writer).
rwlti-upgrade-count (reader).
(setf rwlti-upgrade-count) (writer).
rwlti-write-count (reader).
(setf rwlti-write-count) (writer).
bike-internals/src/internals.lisprwlock.lisp (file).
src (module).
+coreclr-library-file+ (constant).
+interop-library-file+ (constant).
+system-native-library-file+ (constant).
build-interop (function).
find-coreclr (function).
find-interop (function).
function-designator (type).
required-slot (macro).
slot-initializer-missing (condition).
slot-initializer-missing-message (reader method).
%find-by-command (function).
%find-interop (function).
%get-flexi-stream (function).
%version-compare (function).
%version> (function).
Packages are listed by definition order.
bike-internalscffi.
cl-ppcre.
common-lisp.
flexi-streams.
global-vars.
split-sequence.
uiop/driver.
*default-string-buffer-capacity* (special variable).
+coreclr-library-file+ (constant).
+interop-library-file+ (constant).
+pointer-bits+ (constant).
+pointer-size+ (constant).
+system-native-library-file+ (constant).
add-default-library-directory (function).
build-interop (function).
camel-case-string (function).
copy-line-buffer (function).
copy-string-buffer (function).
define-foreign-library-once (macro).
find-coreclr (function).
find-interop (function).
function-designator (type).
get-exe-path (function).
lb-line-start (function).
lb-position (function).
lb-process-lines (function).
lb-seen-cr-p (function).
lb-shift (function).
line-buffer (structure).
line-buffer-p (function).
line-callback (type).
lisp-case-string (function).
load-foreign-library-once (function).
make-line-buffer (function).
make-line-output-callback (function).
make-rwlock (function).
make-simple-character-string (function).
make-string-buffer (function).
native-path (function).
process-string-lines (function).
remove-default-library-directory (function).
required-slot (macro).
rwlock (structure).
rwlock-name (function).
rwlockp (function).
sb-append-format (function).
sb-append-line (function).
sb-append-string (function).
sb-capacity (function).
sb-data (function).
sb-delete (function).
sb-ensure-capacity (function).
sb-extend (function).
sb-insert-string (function).
sb-length (function).
(setf sb-length) (function).
sb-string (function).
simple-character-string (function).
simple-character-string (type).
simple-character-string-upcase (function).
slot-initializer-missing (condition).
slot-initializer-missing-message (generic reader).
string-buffer (structure).
string-buffer-p (function).
use-foreign-library-once (macro).
whitespace-char-p (function).
with-read-lock (macro).
with-write-lock (macro).
%base-string-to-string (function).
%find-by-command (function).
%find-interop (function).
%get-flexi-stream (function).
%lb-cap (function).
(setf %lb-cap) (function).
%lb-data (function).
(setf %lb-data) (function).
%lb-len (function).
(setf %lb-len) (function).
%lb-line-start (reader).
(setf %lb-line-start) (writer).
%lb-pos (reader).
(setf %lb-pos) (writer).
%lb-seen-cr (reader).
(setf %lb-seen-cr) (writer).
%make-line-buffer (function).
%make-rwlock (function).
%make-string-buffer (function).
%maybe-string-upcase (function).
%rwlock-cv-lock (reader).
%rwlock-name (reader).
(setf %rwlock-name) (writer).
%rwlock-reader-count (reader).
(setf %rwlock-reader-count) (writer).
%rwlock-reader-cv (reader).
%rwlock-threads (reader).
(setf %rwlock-threads) (writer).
%rwlock-upgrade-cv (reader).
%rwlock-upgrading-count (reader).
(setf %rwlock-upgrading-count) (writer).
%rwlock-waiting-reader-count (reader).
(setf %rwlock-waiting-reader-count) (writer).
%rwlock-waiting-upgrade-count (reader).
(setf %rwlock-waiting-upgrade-count) (writer).
%rwlock-waiting-writer-count (reader).
(setf %rwlock-waiting-writer-count) (writer).
%rwlock-writer (reader).
(setf %rwlock-writer) (writer).
%rwlock-writer-count (reader).
(setf %rwlock-writer-count) (writer).
%rwlock-writer-cv (reader).
%sb-cap (reader).
(setf %sb-cap) (writer).
%sb-data (reader).
(setf %sb-data) (writer).
%sb-len (reader).
(setf %sb-len) (writer).
%version-compare (function).
%version> (function).
+ascii-char-code-limit+ (constant).
+max-string-buffer-capacity+ (constant).
clear-default-library-directories (function).
dotnet-char-type (class).
make-rwlti (function).
rwlock-begin-read (function).
rwlock-begin-write (function).
rwlock-end-read (function).
rwlock-end-write (function).
rwlock-modify-count (function).
rwlock-thread-info (function).
rwlock-thread-info (structure).
rwlock-thread-info-p (function).
rwlock-wait (function).
rwlti-next (reader).
(setf rwlti-next) (writer).
rwlti-read-count (reader).
(setf rwlti-read-count) (writer).
rwlti-thread (reader).
(setf rwlti-thread) (writer).
rwlti-upgrade-count (reader).
(setf rwlti-upgrade-count) (writer).
rwlti-write-count (reader).
(setf rwlti-write-count) (writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Default capacity for STRING-BUFFER
Defines a foreign library NAME which maps to the specified FILE.
Unlike the original CFFI macro, it does not redefine the library
in case it is already defined and also does not use a sophisticated feature spec evaluation.
Converts a DESIGNATOR which must be a STRING-DESIGNATOR to a string
replacing Lisp-style ‘naming-convention’ with ‘camelCase’.
:CAPITALIZE - non-NIL value designates that the result should be capitalized
as in ‘PascalCase’.
In case of the value being equal to ‘:FORCE’, this setting
overrides ‘:HANDLE-PERCENT’ behavior described below.
:HANDLE-UNDERSCORES - non-NIL value designates that ‘_’ characters should be
stripped and treated as word separators.
:HANDLE-DOT - non-NIL value designates that ‘.’ characters should be treated as
word separators.
:HANDLE-WHITESPACE - non-NIL value designates that whitespace characters should be
treated as word separators.
Additionally, such characters will be stripped in case the value
equals to ‘:STRIP’ keyword.
:PREPEND-UNDERSCORE - non-NIL value designates whether the result should include
a prepended underscore character, as in ‘_camelCase’.
:HANDLE-PERCENT - Value of ‘:STRIP’ designates that starting ‘%’ characters should
be stripped.
Other non-NIL value designates that starting ‘%’ characters should
be replaced with underscores. In this case, string capitalization
is turned off unless the value of ‘:CAPITALIZE’ equals to ‘:FORCE’.
Copies a LINE-BUFFER.
Copies a STRING-BUFFER.
Returns full path to coreclr library or NIL if not found
Retrieves the path to current executable file
Retrieves current line start inside LINE-BUFFER.
Retrieves current position inside LINE-BUFFER.
Processes lines inside LINE-BUFFER using a LINE-CALLBACK.
LINE-BUFFER is destructively modified, and all the processed lines are removed from it.
SKIP-TRAILING-LINE - When non-NIL, skips the last line unless it ends with #Newline.
Returns non-NIL in case of previous character inside LINE-BUFFER was a #Return.
Removes characters from LINE-BUFFER up to the beginning of the current line.
Converts a DESIGNATOR which must be a STRING-DESIGNATOR to a string
in a Lisp-style ‘naming-convention’ instead of a ‘camelCase’ one.
:HANDLE-UNDERSCORES - non-NIL value designates that ‘_’ characters should
be treated as word separators.
:HANDLE-DOT - non-NIL value designates that ‘.’ characters should
be treated as word separators.
:HANDLE-WHITESPACE - non-NIL value designates that whitespace characters should
be treated as word separators.
:PREFIX - either NIL or a string designator which would be prepended to the result.
:SUFFIX - either NIL or a string designator which would be appended to the result.
Like CFFI:LOAD-FOREIGN-LIBRARY but ensures that the library is only loaded once.
:DEFAULT-DIRECTORIES-ONLY - unless non-NIL, specifies that the library search
should only be performed in default directories for the platform.
Currently only used on Windows.
Allocates a line buffer which can hold CAPACITY characters initially.
Creates a LINE-CALLBACK which outputs lines to a STREAM.
Creates an instance of Read-Write lock with read preferrence
Allocates a SIMPLE-CHARACTER-STRING that can hold LENGTH characters.
Allocates a string buffer which can hold CAPACITY characters initially.
Retrieves native namestring for the file or directory
Processes lines of a STRING and applies a LINE-CALLBACK to each line.
:START - Designates starting position inside STRING.
:END - Process characters until this position inside STRING.
:LINE-START - Designates previous line start position inside STRING.
:SEEN-CR - Designates whether previous call to this function stumbled upon #Return character.
:SKIP-TRAILING-LINE - When non-NIL, skips the last line.
Retrieves name of a read-write lock
Appends a formatted string to STRING-BUFFER using FORMAT function.
Appends a STRING followed by a #Newline to a STRING-BUFFER.
Appends a STRING to the end of STRING-BUFFER.
Retrieves capacity of a STRING-BUFFER.
Retrieves data vector of a STRING-BUFFER.
Removes characters from a STRING-BUFFER
in the range from the START index and below the END index.
Ensures that a STRING-BUFFER can hold at least REQUIRED-CAPACITY characters.
Extends length of a STRING-BUFFER by COUNT characters.
Inserts a STRING in the STRING-BUFFER.
Retrieves current length of a STRING-BUFFER.
Sets new length for string-buffer
Retrieves the contents of a STRING-BUFFER as a string, taking its length into account.
Converts a STRING-DESIGNATOR to a SIMPLE-CHARACTER-STRING.
Converts a STRING-DESIGNATOR to an upper-case SIMPLE-CHARACTER-STRING.
Returns Non-NIL value in case of character being a white space character.
slot-initializer-missing)) ¶dotnet-char-type)) ¶cffi.
dotnet-char-type)) ¶cffi.
dotnet-char-type)) ¶cffi.
dotnet-char-type)) ¶cffi.
cell-error.
(quote nil)
:message
This slot is read-only.
A line buffer
Read-Write lock with read preferrence
structure-object.
(or null string)
bt2:lock
(bt2:make-lock)
This slot is read-only.
bt2:condition-variable
(bt2:make-condition-variable)
This slot is read-only.
bt2:condition-variable
(bt2:make-condition-variable)
This slot is read-only.
bt2:condition-variable
(bt2:make-condition-variable)
This slot is read-only.
fixnum
0
fixnum
0
fixnum
0
fixnum
0
fixnum
0
fixnum
0
(or null bike-internals::rwlock-thread-info)
(or null bt2:thread)
A character buffer
structure-object.
bike-internals:simple-character-string
(bike-internals:make-simple-character-string bike-internals:*default-string-buffer-capacity*)
(integer 1 17592186044415)
bike-internals:*default-string-buffer-capacity*
alexandria:array-index
0
name.
next.
structure-object.
(or null bt2:thread)
alexandria:non-negative-fixnum
0
alexandria:non-negative-fixnum
0
alexandria:non-negative-fixnum
0
(or null bike-internals::rwlock-thread-info)
enhanced-foreign-type.
| Initarg | Value |
|---|---|
:actual-type | (quote (uint16)) |
| Jump to: | %
(
A B C D E F G L M N P R S T U W |
|---|
| Jump to: | %
(
A B C D E F G L M N P R S T U W |
|---|
| Jump to: | *
+
C D L M N P R S T U W |
|---|
| Jump to: | *
+
C D L M N P R S T U W |
|---|
| Jump to: | B C D F I L M P R S T |
|---|
| Jump to: | B C D F I L M P R S T |
|---|