The prompt-for Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The prompt-for Reference Manual

This is the prompt-for Reference Manual, version 2.0.3, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 12:01:04 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

PROMPT-FOR 2.0.0

What is this?

Type safe user input.

Current lisp world

Now we get ROSWELL.

Issues

Thanks ros-scripts, sometime we need to intaractive read/write with user. But CL:READ is fragile.

Proposal

Remember CLtL2, there is a imaginary function named PROMPT-FOR. This is the time to implement it.

Usage

From developer

Product's goal

Already?

License

MIT

Tested with


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 prompt-for

Author

Shinichi Sato

License

MIT

Description

Type safe user input.

Long Description

# PROMPT-FOR 2.0.0
## What is this?
Type safe user input.

### Current lisp world
Now we get ROSWELL.

### Issues
Thanks ros-scripts, sometime we need to intaractive read/write with user. But CL:READ is fragile.

### Proposal
Remember CLtL2, there is a imaginary function named PROMPT-FOR.
This is the time to implement it.

## Usage

## From developer

### Product’s goal
Already?
### License
MIT

### Tested with
* SBCL/2.0.2
* CCL/1.12
* ECL/20.4.24
* CLISP/2.49

Version

2.0.3

Dependency

required module sb-posix (for feature sbcl)

Source

prompt-for.asd (file)

Component

prompt-for.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 prompt-for.asd

Location

prompt-for.asd

Systems

prompt-for (system)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 prompt-for/prompt-for.lisp

Parent

prompt-for (system)

Location

prompt-for.lisp

Packages

prompt-for

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 prompt-for

Source

prompt-for.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: do-with-prompt-input ((OUT &rest FORMAT-ARGS) (VAR READER)) &body BODY
Package

prompt-for

Source

prompt-for.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Generic functions

Generic Function: prompt-for TARGET &rest ARGS
Package

prompt-for

Source

prompt-for.lisp (file)

Methods
Method: prompt-for (S (eql secret)) &rest ARGS

Get user input string silently.

Method: prompt-for (PRED function) &rest ARGS

Ensure user input satisfies PRED.

Method: prompt-for (TARGET list) &rest ARGS

Ensure user input is type of TARGET.

Method: prompt-for (TARGET symbol) &rest ARGS

Ensure user input is type of TARGET.

Method: prompt-for TARGET &rest ARGS around

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: echo-off ()
Package

prompt-for

Source

prompt-for.lisp (file)

Function: echo-on ()
Package

prompt-for

Source

prompt-for.lisp (file)

Function: retrieve-keyword-arg KEY ARGS &optional DEFAULT
Package

prompt-for

Source

prompt-for.lisp (file)

Function: secret-reader READER
Package

prompt-for

Source

prompt-for.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   P  
Index Entry  Section

F
File, Lisp, prompt-for.asd: The prompt-for․asd file
File, Lisp, prompt-for/prompt-for.lisp: The prompt-for/prompt-for․lisp file

L
Lisp File, prompt-for.asd: The prompt-for․asd file
Lisp File, prompt-for/prompt-for.lisp: The prompt-for/prompt-for․lisp file

P
prompt-for.asd: The prompt-for․asd file
prompt-for/prompt-for.lisp: The prompt-for/prompt-for․lisp file

Jump to:   F   L   P  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   D   E   F   G   M   P   R   S  
Index Entry  Section

D
do-with-prompt-input: Exported macros

E
echo-off: Internal functions
echo-on: Internal functions

F
Function, echo-off: Internal functions
Function, echo-on: Internal functions
Function, retrieve-keyword-arg: Internal functions
Function, secret-reader: Internal functions

G
Generic Function, prompt-for: Exported generic functions

M
Macro, do-with-prompt-input: Exported macros
Method, prompt-for: Exported generic functions
Method, prompt-for: Exported generic functions
Method, prompt-for: Exported generic functions
Method, prompt-for: Exported generic functions
Method, prompt-for: Exported generic functions

P
prompt-for: Exported generic functions
prompt-for: Exported generic functions
prompt-for: Exported generic functions
prompt-for: Exported generic functions
prompt-for: Exported generic functions
prompt-for: Exported generic functions

R
retrieve-keyword-arg: Internal functions

S
secret-reader: Internal functions

Jump to:   D   E   F   G   M   P   R   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, prompt-for: The prompt-for package
prompt-for: The prompt-for system
prompt-for: The prompt-for package

S
System, prompt-for: The prompt-for system

Jump to:   P   S