home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / xref_v1.1.lha / XRef / Doc / english / XRefAPI.doc < prev    next >
Encoding:
Text File  |  1994-11-29  |  3.1 KB  |  83 lines
  1. XRef-Tools/XRefAPI                                          XRef-Tools/XRefAPI
  2.  
  3. $VER: XRefAPI.doc 1.4 (16.09.94)
  4.  
  5. NAME
  6.     XRefAPI - GoldED API client for use with the xref.library to complete
  7.               phrases
  8.  
  9. FUNCTION
  10.     Just run GoldED and load this as an API-Client ! Then you have the
  11.     following new ARexx command :
  12.  
  13. TEMPLATE
  14.     XREFPHRASE CATEGORY/K,TYPES/K,MATCH/K,COMPLETEBEGIN/S,UPPERCASE/S,
  15.                SPACE/S
  16.  
  17. FORMAT
  18.     XREFPHRASE [CATEGORY <string|pattern>] [TYPES <to search for>]
  19.                [MATCH matchmode] [COMPLETEBEGIN] [UPPERCASE] [SPACE]
  20.  
  21.  
  22.  
  23. FUNCTION
  24.     the XREFPHRASE command tries to complete the current pharse (before 
  25.     the cursor) with the entries from the xref.library. This is done by
  26.     two algorithms :
  27.         - First uppercase letter match :
  28.             This means each character in the phrase must match the
  29.             next uppercase letter in the name ! For example :
  30.             the pharse "ow" matches "OpenWindow()" ("O"pen"W"indow())
  31.         - Second begin match :
  32.             The entry must match the beginning of the phrase !
  33.     There is a automatic two switch between to algorithms :
  34.         - if the pharse consists only of lower case letters the
  35.           uppercase letter match algorithm is used !
  36.         - if in the pharse is a uppercase letter the begin match
  37.           algorithm is used !
  38.     Note the matchmode RECURSIVE uses only the begin match algorithm !
  39.  
  40. INPUTS
  41.     CATEGORY (STRING) - category string|pattern to search in
  42.  
  43.     TYPES (STRING) - types, which would only match ("function","struct",
  44.         "function|struct" or so on)
  45.  
  46.     MATCH (STRING) - one of the following three matchmode strings 
  47.         (default is FIRST) :
  48.         FIRST - always get the first entry, which match the given pharse
  49.         RECURSIVE - much like a Tab-Completion algorithm, it search for
  50.             all entries matches the given phrase and complete it to the
  51.             last character equal to all entries ! If you pass UPPERCASE
  52.             argument the search is case-insenitive !
  53.             If you pass the phrase you passed last and cannot be more
  54.             completed, it switches to the SELECT matchmode and displays
  55.             the window !
  56.             This mode uses everytime the begin match algorithm !!!
  57.         SELECT - it searchs for all entries matching the given phrase and
  58.             if more than one is found, it opens a window you can select
  59.             one !
  60.  
  61.     COMPLETEBEGIN (BOOLEAN) - use the begin match algorithm instead of
  62.         uppercase letter match !
  63.  
  64.     UPPERCASE (BOOLEAN) - convert the phrase to upper
  65.  
  66.     SPACE (BOOLEAN) - if a name is found and inserted place a space behind
  67.  
  68. RESULTS
  69.     the command returns RC_OK, if it could complete the pharse. RC_WARN
  70.     if not !
  71.  
  72. EXAMPLE
  73.     'XREFPHRASE CATEGORY #?AutoDoc TYPES "function"' :
  74.  
  75.     This command will parse all AutoDoc categories and compare the given
  76.     shortcut with any function found in the xreffiles.For example the two
  77.     letters "ow" will completed to "OpenWindow(", if you have the
  78.     sys_autodoc.xref installed from the XRef-System package !
  79.  
  80. SEE ALSO
  81.     XRef-System.guide, GoldED/API, xref.library/ParseXRef(), ParseXRef
  82.  
  83.