library/inspect-vocabularies.factor

   1 ! :folding=indent:collapseFolds=1:
   2
   3 ! $Id$
   4 !
   5 ! Copyright (C) 2003, 2004 Slava Pestov.
   6 !
   7 ! Redistribution and use in source and binary forms, with or without
   8 ! modification, are permitted provided that the following conditions are met:
   9 !
  10 ! 1. Redistributions of source code must retain the above copyright notice,
  11 !    this list of conditions and the following disclaimer.
  12 !
  13 ! 2. Redistributions in binary form must reproduce the above copyright notice,
  14 !    this list of conditions and the following disclaimer in the documentation
  15 !    and/or other materials provided with the distribution.
  16 !
  17 ! THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  18 ! INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  19 ! FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  20 ! DEVELOPERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 ! SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  22 ! PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  23 ! OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24 ! WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  25 ! OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  26 ! ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27
  28 IN: vocabularies
  29 USE: combinators
  30 USE: inspector
  31 USE: lists
  32 USE: kernel
  33 USE: namespaces
  34 USE: prettyprint
  35 USE: stack
  36 USE: stdio
  37 USE: strings
  38 USE: unparser
  39 USE: words
  40
  41 : word-uses? ( of in -- ? )
  42     2dup = [
  43         2drop f ! Don't say that a word uses itself
  44     ] [
  45         worddef>list tree-contains?
  46     ] ifte ;
  47
  48 : usages-in-vocab ( of vocab -- usages )
  49     #! Push a list of all usages of a word in a vocabulary.
  50     words [
  51         dup defined? [
  52             dupd word-uses?
  53         ] [
  54             drop f ! Ignore words without a definition
  55         ] ifte
  56     ] subset nip ;
  57
  58 : usages-in-vocab. ( of vocab -- )
  59     #! List all usages of a word in a vocabulary.
  60     tuck usages-in-vocab dup [
  61         swap "IN: " write print [.]
  62     ] [
  63         2drop
  64     ] ifte ;
  65
  66 : usages. ( word -- )
  67     #! List all usages of a word in all vocabularies.
  68     intern vocabs [ dupd usages-in-vocab. ] each drop ;
  69
  70 : vocabs. ( -- )
  71     #! List vocabularies.
  72     "vocabularies" describe-object-path ;
  73
  74 : words. ( vocab -- )
  75     #! List a vocabulary.
  76     "vocabularies'" swap cat2 describe-object-path ;
  77
  78 : vocab-apropos ( substring vocab -- list )
  79     #! Push a list of all words in a vocabulary whose names
  80     #! contain a string.
  81     words [ dupd str-contains? ] subset nip ;
  82
  83 : vocab-apropos. ( substring vocab -- )
  84     #! List all words in a vocabulary that contain a string.
  85     tuck vocab-apropos dup [
  86         "IN: " write swap print [.]
  87     ] [
  88         2drop
  89     ] ifte ;
  90
  91 : apropos. ( substring -- )
  92     #! List all words that contain a string.
  93     vocabs [ dupd vocab-apropos. ] each drop ;
  94
  95 : in. ( -- )
  96     #! Print the vocabulary where new words are added in
  97     #! interactive parsers.
  98     "in" get print ;
  99
 100 : use. ( -- )
 101     #! Print the vocabulary search path for interactive parsers.
 102     "use" get . ;