6.2.4 Functions

Function: %version TYPE MAJOR MINOR STATUS LEVEL NAME
Package

net.didierverna.clon.setup

Source

version.lisp (file)

Function: add-subface FACE SUBFACE

Add SUBFACE to FACE’s subfaces and return it.

Package

net.didierverna.clon

Source

face.lisp (file)

Function: allocate-winsize ()
Package

net.didierverna.clon

Source

/Users/didier/.cache/common-lisp/sbcl-2.1.2.72-f990ff7ad-macosx-x64/Users/didier/Documents/Science/Software/Common Lisp/clon/termio/sbcl/constants.lisp-temp

Function: argument-popable-p CMDLINE

Return true if the first CMDLINE item is an argument.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Function: attach-face-tree FACE FACE-TREE &aux NEW-TREE

Create a copy of FACE-TREE, attach it to FACE and return it.
Apart from the parenting information, the copied faces share slot values with the original ones.

Package

net.didierverna.clon

Source

face.lisp (file)

Function: available-right-margin SHEET

Return SHEET’s available right margin.
This margin is the first non-self margin specified by a frame. All inner self frames can potentially write until the available right margin.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: beginning-of-string-p BEGINNING STRING &optional IGNORE-CASE &aux LENGTH

Check that STRING starts with BEGINNING. If IGNORE-CASE, well, ignore case.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: clindent SYMBOL INDENT

Send SYMBOL’s INDENTation information to Emacs.
Emacs will set the ’common-lisp-indent-function property.
If INDENT is a symbol, use its indentation definition. Otherwise, INDENT is considered as an indentation definition.

Package

net.didierverna.clon.setup

Source

readtable.lisp (file)

Function: close-line SHEET

Close all frames on SHEET’s current line and go to next line.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: close-sface SHEET

Close SHEET’s current sface.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: closest-match MATCH LIST &key IGNORE-CASE KEY &aux MATCH-LENGTH SHORTEST-DISTANCE CLOSEST-MATCH

Return the LIST element closest to MATCH, or nil.
If IGNORE-CASE, well, ignore case.
KEY should provide a way to get a string from each LIST element.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: cmdline-convert VALUED-OPTION CMDLINE-NAME CMDLINE-ARGUMENT

Convert CMDLINE-ARGUMENT to VALUED-OPTION’s value.
This function is used when the conversion comes from a command-line usage of VALUED-OPTION, called by CMDLINE-NAME, and intercepts invalid-argument errors to raise the higher level invalid-cmdline-argument error instead.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Function: cmdline-option-name INSTANCE
Function: (setf cmdline-option-name) VALUE INSTANCE
Package

net.didierverna.clon

Source

context.lisp (file)

Function: cmdline-option-option INSTANCE
Function: (setf cmdline-option-option) VALUE INSTANCE
Package

net.didierverna.clon

Source

context.lisp (file)

Function: cmdline-option-p OBJECT
Package

net.didierverna.clon

Source

context.lisp (file)

Function: cmdline-option-source INSTANCE
Function: (setf cmdline-option-source) VALUE INSTANCE
Package

net.didierverna.clon

Source

context.lisp (file)

Function: cmdline-option-value INSTANCE
Function: (setf cmdline-option-value) VALUE INSTANCE
Package

net.didierverna.clon

Source

context.lisp (file)

Function: complete-string BEGINNING COMPLETE

Complete BEGINNING with the rest of COMPLETE in parentheses. For instance, completing ’he’ with ’help’ will produce ’he(lp)’.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: copy-cmdline-option INSTANCE
Package

net.didierverna.clon

Source

context.lisp (file)

Function: copy-frame INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: copy-highlight-frame INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: copy-highlight-property-instance INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: current-frame SHEET

Return SHEET’s current frame.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: current-left-margin SHEET

Return SHEET’s current left margin.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: current-right-margin SHEET

Return SHEET’s current right margin.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: current-sface SHEET

Return SHEET’s current sface or nil.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: directory-pathname-p PATHNAME

Return true if PATHNAME denotes a directory.

Package

net.didierverna.clon

Source

path.lisp (file)

Function: environment-convert VALUED-OPTION ENV-VAL

Convert ENV-VAL to VALUED-OPTION’s value.
This function is used when the conversion comes from an environment variable associated with VALUED-OPTION, and intercepts invalid-argument errors
to raise the higher level invalid-environment-value error instead.

Package

net.didierverna.clon

Source

environ.lisp (file)

Function: exit-abnormally ERROR

Print ERROR on *ERROR-OUTPUT* and exit with status code 1.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: face-highlight-property-set-p FACE PROPERTY

Return t if PROPERTY is set explicitely in FACE.

Package

net.didierverna.clon

Source

face.lisp (file)

Function: face-highlight-property-value FACE PROPERTY

Return PROPERTY’s value in FACE.
Since faces inherit highlight properties, the actual value might come from one of FACE’s ancestors.
if PROPERTY is not et, return nil.

Package

net.didierverna.clon

Source

face.lisp (file)

Function: find-sface SFACE NAME &aux SIBLING SUB-SFACE

Find an sface starting at SFACE named NAME.
If the sface can’t be found in SFACE’s face tree, find one in SFACE’s sibling instead, and make a copy of it.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: flush-sheet SHEET

Flush SHEET.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: frame-left-margin INSTANCE
Function: (setf frame-left-margin) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: frame-p OBJECT
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: frame-right-margin INSTANCE
Function: (setf frame-right-margin) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: frame-sface INSTANCE
Function: (setf frame-sface) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: get-top-padding SFACE ITEMS

Return top padding of the next item in ITEMS that will print under SFACE.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: getenv VARIABLE

Get environment VARIABLE’s value. VARIABLE may be null.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: help-spec-items-will-print SFACE ITEMS

Return t if at least one of ITEMS will print under SFACE.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-frame-highlight-property-instances INSTANCE
Function: (setf highlight-frame-highlight-property-instances) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-frame-left-margin INSTANCE
Function: (setf highlight-frame-left-margin) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-frame-p OBJECT
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-frame-right-margin INSTANCE
Function: (setf highlight-frame-right-margin) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-frame-sface INSTANCE
Function: (setf highlight-frame-sface) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-property-instance-escape-sequence INSTANCE

Return highlight property INSTANCE’s escape sequence.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-property-instance-name INSTANCE
Function: (setf highlight-property-instance-name) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-property-instance-p OBJECT
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: highlight-property-instance-value INSTANCE
Function: (setf highlight-property-instance-value) VALUE INSTANCE
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: home-directory ()

Return user’s home directory in canonical form.
If the user’s home directory cannot be computed, signal a warning and return NIL.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: i-reader STREAM SUBCHAR ARG

Construct a call to ‘defindent’ by reading an argument list from STREAM. This dispatch macro character function is installed on #i in the NET.DIDIERVERNA.CLON named readtable.

Package

net.didierverna.clon.setup

Source

readtable.lisp (file)

Function: list-to-string LIST &key KEY SEPARATOR

Return a SEPARATOR-separated string of all LIST elements.
- KEY should provide a way to get a string from each LIST element. - SEPARATOR is the string to insert between elements.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: macosp ()

Return t if running on Mac OS.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: make-cmdline-option &key (NAME NAME) (OPTION OPTION) (VALUE VALUE) (SOURCE SOURCE)
Package

net.didierverna.clon

Source

context.lisp (file)

Function: make-frame &key (SFACE SFACE) (LEFT-MARGIN LEFT-MARGIN) (RIGHT-MARGIN RIGHT-MARGIN)
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: make-highlight-frame &key (SFACE SFACE) (LEFT-MARGIN LEFT-MARGIN) (RIGHT-MARGIN RIGHT-MARGIN) (HIGHLIGHT-PROPERTY-INSTANCES HIGHLIGHT-PROPERTY-INSTANCES)
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: make-highlight-property-instance &key (NAME NAME) (VALUE VALUE)
Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: make-internal-enum LONG-NAME DESCRIPTION &rest KEYS &key ARGUMENT-NAME ARGUMENT-TYPE ENUM ENV-VAR FALLBACK-VALUE DEFAULT-VALUE HIDDEN

Make a new internal (Clon-specific) enum option.
- LONG-NAME is the option’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the options’s description.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENUM is the set of possible values.
- ENV-VAR is the option’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon

Source

enum.lisp (file)

Function: make-internal-flag LONG-NAME DESCRIPTION &rest KEYS &key ENV-VAR HIDDEN

Make a new internal (Clon-specific) flag.
- LONG-NAME is the flag’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the flag’s description.
- ENV-VAR is the flag’s associated environment variable, sans the ’CLON_’ prefix. It default to nil.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon

Source

flag.lisp (file)

Function: make-internal-lispobj LONG-NAME DESCRIPTION &rest KEYS &key ARGUMENT-NAME ARGUMENT-TYPE ENV-VAR TYPESPEC FALLBACK-VALUE DEFAULT-VALUE HIDDEN

Make a new internal (Clon-specific) string option.
- LONG-NAME is the option’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the options’s description.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the option’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- TYPESPEC is a type specifier the option’s value should satisfy.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon

Source

lispobj.lisp (file)

Function: make-internal-path LONG-NAME DESCRIPTION &rest KEYS &key ARGUMENT-NAME ARGUMENT-TYPE ENV-VAR FALLBACK-VALUE DEFAULT-VALUE TYPE HIDDEN

Make a new internal (Clon-specific) path option.
- LONG-NAME is the option’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the options’s description.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the option’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- TYPE is the pathname type. It can be one of :file, :directory, :file-list, :directory-list or nil meaning that everything is allowed.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon

Source

path.lisp (file)

Function: make-internal-stropt LONG-NAME DESCRIPTION &rest KEYS &key ARGUMENT-NAME ARGUMENT-TYPE ENV-VAR FALLBACK-VALUE DEFAULT-VALUE HIDDEN

Make a new internal (Clon-specific) string option.
- LONG-NAME is the option’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the options’s description.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the option’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- FALLBACK-VALUE is the option’s fallback value (for missing optional arguments), if any.
- DEFAULT-VALUE is the option’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon

Source

stropt.lisp (file)

Function: make-internal-switch LONG-NAME DESCRIPTION &rest KEYS &key ARGUMENT-STYLE ARGUMENT-TYPE ENV-VAR DEFAULT-VALUE HIDDEN

Make a new internal (Clon-specific) switch.
- LONG-NAME is the switch’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the switch’s description.
- ARGUMENT-STYLE is the switch’s argument display style. It can be one of :yes/no, :on/off, :true/false, :yup/nope or :yeah/nah.
It defaults to :yes/no.
- ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENV-VAR is the switch’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- DEFAULT-VALUE is the switch’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon

Source

switch.lisp (file)

Function: make-internal-text &rest KEYS &key CONTENTS HIDDEN
Package

net.didierverna.clon

Source

text.lisp (file)

Function: make-internal-xswitch LONG-NAME DESCRIPTION &rest KEYS &key ARGUMENT-NAME ARGUMENT-TYPE ENUM ENV-VAR DEFAULT-VALUE HIDDEN

Make a new internal (Clon-specific) xswitch.
- LONG-NAME is the xswitch’s long-name, sans the ’clon-’ prefix. (Internal options don’t have short names.)
- DESCRIPTION is the xswitch’s description.
- ARGUMENT-NAME is the option’s argument name appearing in help strings. - ARGUMENT-TYPE is one of :required, :mandatory or :optional (:required and :mandatory are synonyms).
It defaults to :optional.
- ENUM is the set of possible non-boolean values.
- ENV-VAR is the xswitch’s associated environment variable, sans the ’CLON_’ prefix. It defaults to nil.
- DEFAULT-VALUE is the xswitch’s default value, if any.
- When HIDDEN, the option doesn’t appear in help strings.

Package

net.didierverna.clon

Source

xswitch.lisp (file)

Function: make-raw-face-tree &optional FACE-CLASS

Make a raw (boring yet functional) face tree.

Package

net.didierverna.clon

Source

face.lisp (file)

Function: make-raw-sface SIBLING &aux SFACE

Return a new SFace based on SIBLING.
This function does not consider SIBLING as a face tree:
only face properties are copied; the face parent and children are set to nil.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: make-sheet &rest KEYS &key OUTPUT-STREAM SEARCH-PATH THEME LINE-WIDTH HIGHLIGHT

Make a new SHEET.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: match-option OPTION &key SHORT-NAME LONG-NAME

Try to match OPTION against SHORT-NAME, LONG-NAME. If OPTION matches, return the name that matched.

Package

net.didierverna.clon

Source

option.lisp (file)

Function: open-line SHEET

Open all frames on SHEET’s current line.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: open-next-line SHEET

Close SHEET’s current line and open the next one.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: open-sface SHEET SFACE

Create a frame for SFACE and open it.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: option-abbreviation-distance OPTION PARTIAL-NAME

Return the distance between OPTION’s long name and PARTIAL-NAME. If PARTIAL-NAME does not abbreviate OPTION’s long name, return MOST-POSITIVE-FIXNUM.

Package

net.didierverna.clon

Source

option.lisp (file)

Function: option-call-p STR

Return true if STR looks like an option call.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Function: parent-generation FACE PARENT-NAME

Return FACE’s parent generation for PARENT-NAME.
That is, 1 if PARENT-NAME names FACE’s parent, 2 if it names its grand-parent etc. If PARENT-NAME does not name one of FACE’s ancestors, trigger an error.

Package

net.didierverna.clon

Source

face.lisp (file)

Function: pathname-component-null-p COMPONENT

Return true if COMPONENT is either null or :unspecific.

Package

net.didierverna.clon

Source

path.lisp (file)

Function: pop-frame SHEET

Pop SHEET’s current frame.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: potential-pack-char OPTION &optional AS-STRING

Return OPTION’s potential pack character, if any. If AS-STRING, return a string of that character.

Package

net.didierverna.clon

Source

option.lisp (file)

Function: princ-char SHEET CHAR

Princ CHAR on SHEET’s stream and increment the column position.
The effect of printing CHAR must be exactly to move right by one column, so control characters, as well as newlines and tabs are forbidden here.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: princ-highlight-property-instances SHEET INSTANCES

Princ highlight proeprty INSTANCES on SHEET’s stream.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: princ-spaces SHEET NUMBER

Princ NUMBER spaces to SHEET’s stream and update the column position.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: princ-string SHEET STRING

Princ STRING on SHEET’s stream and update the column position.
The effect of printing STRING must be exactly to move right by the corresponding string length, so control characters, as well as newlines and tabs are forbidden here.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: print-error ERROR &optional INTERACTIVEP &aux STREAM *PRINT-ESCAPE*

Print ERROR on *ERROR-OUTPUT*.
When INTERACTIVEP, print on *QUERY-IO* instead.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: print-faced-help-spec SHEET SFACE ITEMS

Print all help specification ITEMS on SHEET with SFACE.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: print-help SHEET HELP

Open the toplevel help face and print HELP on SHEET with it.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: print-string SHEET STRING

Output STRING to SHEET.
STRING is output within the current frame’s bounds.
Spacing characters are honored but newlines might replace spaces when the output reaches the rightmost bound.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: push-frame SHEET FRAME

Push a new frame to SHEET’s frames.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: putenv VARIABLE VALUE

Set environment VARIABLE to VALUE.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: reach-column SHEET COLUMN

Reach COLUMN on SHEET by princ’ing spaces.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: read-argument ()

Read an option argument from standard input.

Package

net.didierverna.clon

Source

valued.lisp (file)

Function: read-call &optional NEGATED

Read an option’s call or pack from standard input.
If NEGATED, read a negated call or pack. Otherwise, read a short call or pack.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: read-env-val ENV-VAR

Read ENV-VAR’s new value from standard input.

Package

net.didierverna.clon

Source

environ.lisp (file)

Function: read-long-name ()

Read an option’s long name from standard input.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: read-sface-tree PATHNAME

Read an sface tree from PATHNAME.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: read-value ()

Read an option value from standard input.

Package

net.didierverna.clon

Source

valued.lisp (file)

Function: release-status-number RELEASE-STATUS
Package

net.didierverna.clon.setup

Source

version.lisp (file)

Function: remove-keys KEYS &rest REMOVED

Return a new property list from KEYS without REMOVED ones.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: replace-key REPLACEMENT KEYS

Return a new property list from KEYS with REPLACEMENT.
REPLACEMENT can take the following forms:
- :KEY
The effect is to remove :KEY from KEYS, as per REMOVE-KEYS.
- (:KEY :NEW-KEY)
The effect is to replace :KEY with :NEW-KEY, leaving the values unchanged. - (:KEY :NEW-KEY (VAL-OR-VALS NEW-VAL)*), with VAL-OR-VALS being
either a value or a list of values. The effect is to replace :KEY with :NEW-KEY and a value matching one of the VAL-OR-VALS with the corresponding NEW-VAL. Values not matching any VAL-OR-VALS remain unchanged. - (:KEY (VAL-OR-VALS :NEW-KEY NEW-VAL...)*), with VAL-OR-VALS as above. The effect is the same as above, but :NEW-KEY additionally depends on the matched value. If multiple :NEW-KEY NEW-VAL couples are provided, that many new keys are inserted along with their values. For values not matching any VAL-OR-VALS, :KEY and its value remain unchanged.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: replace-keys KEYS &rest REPLACEMENTS &aux NEW-KEYS

Return a new property list from KEYS with REPLACEMENTS.
See REPLACE-KEY for more information on the replacement syntax.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: restart-on-error ERROR

Print ERROR and offer available restarts on *QUERY-IO*.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: restartable-check VALUED-OPTION VALUE

Restartably check that VALUE is valid for VALUED-OPTION.
The only restart available, use-value, offers to try a different value from the one that was provided.

Package

net.didierverna.clon

Source

valued.lisp (file)

Function: restartable-cmdline-convert VALUED-OPTION CMDLINE-NAME CMDLINE-ARGUMENT

Restartably convert CMDLINE-ARGUMENT to VALUED-OPTION’s value.
This function is used when the conversion comes from a command-line usage of VALUED-OPTION, called by CMDLINE-NAME.

As well as conversion errors, this function might raise a missing-cmdline-argument error if CMDLINE-ARGUMENT is nil and an argument is required.

Available restarts are (depending on the context):
- use-fallback-value: return FALLBACK-VALUE,
- use-default-value: return VALUED-OPTION’s default value,
- use-value: return another (already converted) value,
- use-argument: return the conversion of another argument.

Return two values: VALUED-OPTION’s value and the actual value source. The value source may be :cmdline, :fallback or :default.

Package

net.didierverna.clon

Source

cmdline.lisp (file)

Function: restartable-cmdline-junk-error JUNK
Package

net.didierverna.clon

Source

context.lisp (file)

Function: restartable-convert VALUED-OPTION ARGUMENT

Restartably convert ARGUMENT to VALUED-OPTION’s value. Available restarts are:
- use-default-value: return OPTION’s default value,
- use-value: return another (already converted) value, - use-argument: return the conversion of another argument.

Package

net.didierverna.clon

Source

valued.lisp (file)

Function: restartable-environment-convert VALUED-OPTION ENV-VAL

Restartably convert ENV-VAL to VALUED-OPTION’s value.
This function is used when the conversion comes from an environment variable associated with VALUED-OPTION.

Available restarts are:
- use-default-value: return VALUED-OPTION’s default value,
- use-value: return another (already converted) value,
- use-argument: return the conversion of another argument,
- modify-env: modify the environment variable’s value.

Package

net.didierverna.clon

Source

environ.lisp (file)

Function: restrict-because REASON

Put Clon in restricted mode because of REASON.

Package

net.didierverna.clon.setup

Source

termio.lisp (file)

Function: safe-left-margin SHEET MARGIN

Return either MARGIN or a safe value instead.
To be safe, margin must be greater than the current left margin and smaller than the currently available margin.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: safe-right-margin SHEET LEFT-MARGIN MARGIN

Return either MARGIN or a safe value instead.
To be safe, margin must be greater than LEFT-MARGIN and smaller than the currently available right margin.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: search-branch FACE NAMES

Search for a branch of faces named NAMES starting at FACE.
The branch is searched for as a direct subbranch of FACE, or as a direct subbranch of FACE’s ancestors.
If a branch is found, return its leaf face. Otherwise return nil.

Package

net.didierverna.clon

Source

face.lisp (file)

Function: search-face FACE NAME &optional ERROR-ME

Search for a face named NAME starting at FACE.
The face is looked for as a direct subface of FACE (in which case it is simply returned), or up in the hierarchy and by successive upper branches (in which case it is copied and attached to FACE).
If ERROR-ME, trigger an error if no face is found; otherwise, return nil.

Package

net.didierverna.clon

Source

face.lisp (file)

Function: search-option CONTEXT &rest KEYS &key SHORT-NAME LONG-NAME PARTIAL-NAME

Search for an option in CONTEXT.
The search is done with SHORT-NAME, LONG-NAME, or PARTIAL-NAME.
In case of a PARTIAL-NAME search, look for an option the long name of which begins with it.
In case of multiple matches by PARTIAL-NAME, the longest match is selected. When such an option exists, return wo values:
- the option itself,
- the name used to find the option, possibly completed if partial.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: search-option-by-abbreviation CONTEXT PARTIAL-NAME

Search for option abbreviated with PARTIAL-NAME in CONTEXT. When such an option exists, return two values:
- the option itself,
- the completed name.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: search-option-by-name CONTEXT &rest KEYS &key SHORT-NAME LONG-NAME

Search for option with either SHORT-NAME or LONG-NAME in CONTEXT. When such an option exists, return two values:
- the option itself,
- the name that matched.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: search-sticky-option CONTEXT NAMEARG

Search for a sticky option in CONTEXT, matching NAMEARG.
NAMEARG is the concatenation of the option’s short name and its argument. In case of multiple matches, the option with the longest name is selected. When such an option exists, return two values:
- the option itself,
- the argument part of NAMEARG.

Package

net.didierverna.clon

Source

context.lisp (file)

Function: select-keys KEYS &rest SELECTED

Return a new property list from KEYS with only SELECTED ones.

Package

net.didierverna.clon

Source

util.lisp (file)

Function: split-path PATH

Split PATH into a list of directories.

Package

net.didierverna.clon

Source

path.lisp (file)

Function: stream-line-width STREAM &aux HANDLE

Get STREAM’s line width.
Return two values:
- the stream’s line width, or nil if it can’t be computed (typically when the stream does not denote a tty), - an error message if the operation failed.

Package

net.didierverna.clon

Source

termio.lisp (file)

Function: try-read-sface-tree PATHNAME

Read an sface tree from PATHNAME if it exists or return nil.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: try-read-theme PATHNAME

Read a theme from PATHNAME or PATHNAME.cth if it exists or return nil.

Package

net.didierverna.clon

Source

sheet.lisp (file)

Function: winsize-ws-col STRUCT
Function: (setf winsize-ws-col) VAR-21 STRUCT
Package

net.didierverna.clon

Source

/Users/didier/.cache/common-lisp/sbcl-2.1.2.72-f990ff7ad-macosx-x64/Users/didier/Documents/Science/Software/Common Lisp/clon/termio/sbcl/constants.lisp-temp

Function: winsize-ws-row STRUCT
Function: (setf winsize-ws-row) VAR-0 STRUCT
Package

net.didierverna.clon

Source

/Users/didier/.cache/common-lisp/sbcl-2.1.2.72-f990ff7ad-macosx-x64/Users/didier/Documents/Science/Software/Common Lisp/clon/termio/sbcl/constants.lisp-temp

Function: winsize-ws-xpixel STRUCT
Function: (setf winsize-ws-xpixel) VAR-22 STRUCT
Package

net.didierverna.clon

Source

/Users/didier/.cache/common-lisp/sbcl-2.1.2.72-f990ff7ad-macosx-x64/Users/didier/Documents/Science/Software/Common Lisp/clon/termio/sbcl/constants.lisp-temp

Function: winsize-ws-ypixel STRUCT
Function: (setf winsize-ws-ypixel) VAR-23 STRUCT
Package

net.didierverna.clon

Source

/Users/didier/.cache/common-lisp/sbcl-2.1.2.72-f990ff7ad-macosx-x64/Users/didier/Documents/Science/Software/Common Lisp/clon/termio/sbcl/constants.lisp-temp

Function: ~-reader STREAM CHAR

Read a series of ~"string" to be concatenated together.

Package

net.didierverna.clon.setup

Source

readtable.lisp (file)