The with-cached-reader-conditionals Reference Manual

Table of Contents

The with-cached-reader-conditionals Reference Manual

This is the with-cached-reader-conditionals Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 18:17:02 2021 GMT+0.

1 Introduction

with-cached-reader-conditionals

Exposes #'call-with-cached-reader-conditionals and the macro with-cached-reader-conditionals

#'call-with-cached-reader-conditionals

Calls the given function with the given args. Returns the first result of the given function as the first result and the returns a list of the 'feature-expression pairs' as the second result.

A 'feature-expression pair' is defined as: A list of length 2 where the first element is a valid lisp feature-expression and the second element is t or nil depending on whether the feature expression succeeded for the current system.

To get the list of features the function rebinds the #+ and #- conditional reader macros so that they will work as normal but also record the feature expressions they are given. This accumulated list of feature expressions is then flattened and deduplicated so only a set of features remain.

with-cached-reader-conditionals

This macro takes it's body, wraps in in a lambda and passes it to #'call-with-cached-reader-conditionals.

Example Usage

    ;; With this function
	(defun test (string)
	  (with-cached-reader-conditionals
		(with-input-from-string (stream string)
		  (loop for l = (read stream nil) while l collect l))))

	;; this call
	CL-USER> (test "(+ 1 2 3)
	#+windows(print 1)
	#+(or sbcl bsd)(print 2)
	#+(or bsd sbcl)(print 3)")

	;; returns these two values
	((+ 1 2 3) (PRINT 2) (PRINT 3))
	(((:OR :BSD :SBCL) T) (:WINDOWS NIL))

2 Systems

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

2.1 with-cached-reader-conditionals

Author

Chris Bagley <chris.bagley@gmail.com>

License

BSD 2 Clause

Description

Read whilst collecting reader conditionals

Source

with-cached-reader-conditionals.asd (file)

Components

• package.lisp (file)
• with-cached-reader-conditionals.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 with-cached-reader-conditionals.asd

Location

with-cached-reader-conditionals.asd

Systems

with-cached-reader-conditionals (system)

3.1.2 with-cached-reader-conditionals/package.lisp

Parent

with-cached-reader-conditionals (system)

Location

package.lisp

Packages

with-cached-reader-conditionals

3.1.3 with-cached-reader-conditionals/with-cached-reader-conditionals.lisp

Dependency

package.lisp (file)

Parent

with-cached-reader-conditionals (system)

Location

with-cached-reader-conditionals.lisp

Exported Definitions

• call-with-cached-reader-conditionals (function)
• flatten-features (function)
• with-cached-reader-conditionals (macro)

Internal Definitions

• *keyword-package* (special variable)
• cached-feature-list (function)
• dirty-featurep (function)
• feature-cache (class)
• feature-expr-key (function)
• featurep (function)
• make-reader-conditional-caching-sharp-plus-minus (function)
• normalize-feature-list (function)
• sort-feature-expr (function)

4 Packages

Packages are listed by definition order.

4.1 with-cached-reader-conditionals

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• call-with-cached-reader-conditionals (function)
• flatten-features (function)
• with-cached-reader-conditionals (macro)

Internal Definitions

• *keyword-package* (special variable)
• cached-feature-list (function)
• dirty-featurep (function)
• feature-cache (class)
• feature-expr-key (function)
• featurep (function)
• make-reader-conditional-caching-sharp-plus-minus (function)
• normalize-feature-list (function)
• sort-feature-expr (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: with-cached-reader-conditionals &body BODY

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

5.1.2 Functions

Function: call-with-cached-reader-conditionals FUNC &rest ARGS

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

Function: flatten-features FEATURE-EXPRESSIONS

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *keyword-package*

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

5.2.2 Functions

Function: cached-feature-list CACHE

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

Function: dirty-featurep X

Ugly in implementation but will always match the implementations logic :|

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

Function: feature-expr-key EXPR

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

Function: featurep X

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

Function: make-reader-conditional-caching-sharp-plus-minus ()

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

Function: normalize-feature-list PAIRS

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

Function: sort-feature-expr FEATURE-EXPR

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

5.2.3 Classes

Class: feature-cache ()

Package

with-cached-reader-conditionals

Source

with-cached-reader-conditionals.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: cache

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types