Changeset 32830 in project


Ignore:
Timestamp:
10/17/15 22:20:40 (5 years ago)
Author:
Kon Lovett
Message:

rel 2.2.0

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/apropos

    r32712 r32830  
    1717==== apropos
    1818
    19 <procedure>(apropos PATTERN [#:macros? MACROS?] [#:qualified? QUALIFIED?] [#:sort SORT])</procedure>
     19<procedure>(apropos PATTERN [#:macros? MACROS?] [#:qualified? QUALIFIED?] [#:sort SORT] [#:case-insensitive? CASE-INSENSITIVE?])</procedure>
    2020
    2121Displays information about symbols matching {{PATTERN}} in the toplevel
    2222environment.
    2323
    24 ; {{PATTERN}} : A {{symbol}}, {{string}}, {{irregex}}, {{irregex-sre}}, {{(quote symbol)}}, {{(quote string)}}. When unquoted symbol or string substring matching is performed. When quoted the string value is taken as an irregex regular expression string.
     24; {{PATTERN}} : A {{symbol}}, {{string}}, {{irregex}}, {{irregex-sre}}, {{(quote symbol)}}, {{(quote string)}}. When unquoted symbol or string substring matching is performed. When quoted the string value is taken as an irregex regular expression string for use with search.
    2525; {{MACROS?}} : Either {{#t}} to include macros, or {{#f}} to skip them. Default is {{#f}}.
    2626; {{QUALIFIED?}} : Either {{#t}} to include qualified symbols or {{#f}} to skip them. Default is {{#f}}.
     27; {{CASE-INSENSITIVE?}} : Either {{#t}} to use match case-insensitivity for the {{PATTERN}} or {{#f}} to be case-sensitive. Default is {{#f}}.
    2728; {{SORT}} : Either {{#:name}} for an symbol sort, or {{#:type}} for a type+indentifier sort, or {{#f}} for unsorted. The default is {{#:type}}.
    2829
     
    3233==== apropos-list
    3334
    34 <procedure>(apropos-list PATTERN [#:macros? MACROS?] [#:qualified? QUALIFIED?])</procedure>
    35 
    36 Like {{apropos}} but returns a list of matching symbols.
     35<procedure>(apropos-list PATTERN [#:macros? MACROS?] [#:qualified? QUALIFIED?] [#:case-insensitive? CASE-INSENSITIVE?]) => {{list}}</procedure>
     36
     37Like {{apropos}} but returns an, unsorted, list of matching symbols.
    3738
    3839==== apropos-information-list
    3940
    40 <procedure>(apropos-information-list PATTERN [#:macros? MACROS?] [#:qualified? QUALIFIED?] [#:sort? SORT?])</procedure>
     41<procedure>(apropos-information-list PATTERN [#:macros? MACROS?] [#:qualified? QUALIFIED?] [#:sort SORT] [#:case-insensitive? CASE-INSENSITIVE?]) => {{list}}</procedure>
    4142
    4243Like {{apropos}} but returns an association list keyed by symbol. The
     
    4748=== Interpreter Usage
    4849
    49 A {{csi}} toplevel-command is added when the {{apropos}} extension is loaded: {{,a}}.
     50A {{csi}} toplevel-command is added when the {{apropos}} extension is loaded: {{,a PATTERN ARGUMENT...}}.
     51
     52{{ARGUMENT}} is interpreted as:
     53
     54; {{macros|mac}} : {{#:macros? #t}}
     55; {{qualified|qual}} : {{#:qualified? #t}}
     56; {{sort [name|type|#f]}} : {{#:sort #:name|#:type|#f}}
     57; {{case-insensitve|ci}} : {{#:case-insensitive? #t}}
     58
     59The command is interpreted by the {{apropos}} procedure. Unlike {{apropos}}
     60sort by type is the default.
    5061
    5162Example:
    5263
    5364<enscript language=scheme>
    54 #;1> ,a print qualified macros sort name ;default sort type
     65#;1> ,a print qualified macros sort name
    5566char-set:printing                         variable
    5667define-record-printer                     macro
     
    151162== Bugs and Limitations
    152163
     164* Does not support UTF-8!
     165
    153166* Doesn't show something similar to procedure-information for macros.
    154167
     
    170183== Version history
    171184
     185; 2.2.0 : correct interpretation of unquoted string/symbol as a literal string, fix sorting support for apropos-information-list, add case-insensitive option
    172186; 2.1.3 : fix for ticket #1211, incorrect load of regex when irregex is actual dependency
    173187; 2.1.2 : fix for removed core support routine
Note: See TracChangeset for help on using the changeset viewer.