home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fs.zip / octave / readline / doc / readline.i02 (.txt) < prev    next >
GNU Info File  |  2000-01-15  |  45KB  |  1,038 lines
  1. This is Info file readline.info, produced by Makeinfo-1.64 from the
  2. input file rlman.tex.
  3.    This document describes the GNU Readline Library, a utility which
  4. aids in the consistency of user interface across discrete programs that
  5. need to provide a command line interface.
  6.    Copyright (C) 1988, 1991 Free Software Foundation, Inc.
  7.    Permission is granted to make and distribute verbatim copies of this
  8. manual provided the copyright notice and this permission notice pare
  9. preserved on all copies.
  10.    Permission is granted to copy and distribute modified versions of
  11. this manual under the conditions for verbatim copying, provided that
  12. the entire resulting derived work is distributed under the terms of a
  13. permission notice identical to this one.
  14.    Permission is granted to copy and distribute translations of this
  15. manual into another language, under the above conditions for modified
  16. versions, except that this permission notice may be stated in a
  17. translation approved by the Foundation.
  18. File: readline,  Node: Readline Convenience Functions,  Next: Custom Completers,  Prev: Readline Variables,  Up: Programming with GNU Readline
  19. Readline Convenience Functions
  20. ==============================
  21. * Menu:
  22. * Function Naming::    How to give a function you write a name.
  23. * Keymaps::        Making keymaps.
  24. * Binding Keys::    Changing Keymaps.
  25. * Associating Function Names and Bindings::    Translate function names to
  26.                         key sequences.
  27. * Allowing Undoing::    How to make your functions undoable.
  28. * Redisplay::        Functions to control line display.
  29. * Modifying Text::    Functions to modify `rl_line_buffer'.
  30. * Utility Functions::    Generally useful functions and hooks.
  31. * Alternate Interface::    Using Readline in a `callback' fashion.
  32. File: readline,  Node: Function Naming,  Next: Keymaps,  Up: Readline Convenience Functions
  33. Naming a Function
  34. -----------------
  35.    The user can dynamically change the bindings of keys while using
  36. Readline.  This is done by representing the function with a descriptive
  37. name.  The user is able to type the descriptive name when referring to
  38. the function.  Thus, in an init file, one might find
  39.      Meta-Rubout:    backward-kill-word
  40.    This binds the keystroke Meta-Rubout to the function *descriptively*
  41. named `backward-kill-word'.  You, as the programmer, should bind the
  42. functions you write to descriptive names as well.  Readline provides a
  43. function for doing that:
  44.  - Function: int rl_add_defun (char *name, Function *function, int key)
  45.      Add NAME to the list of named functions.  Make FUNCTION be the
  46.      function that gets called.  If KEY is not -1, then bind it to
  47.      FUNCTION using `rl_bind_key ()'.
  48.    Using this function alone is sufficient for most applications.  It is
  49. the recommended way to add a few functions to the default functions that
  50. Readline has built in.  If you need to do something other than adding a
  51. function to Readline, you may need to use the underlying functions
  52. described below.
  53. File: readline,  Node: Keymaps,  Next: Binding Keys,  Prev: Function Naming,  Up: Readline Convenience Functions
  54. Selecting a Keymap
  55. ------------------
  56.    Key bindings take place on a "keymap".  The keymap is the
  57. association between the keys that the user types and the functions that
  58. get run.  You can make your own keymaps, copy existing keymaps, and tell
  59. Readline which keymap to use.
  60.  - Function: Keymap rl_make_bare_keymap ()
  61.      Returns a new, empty keymap.  The space for the keymap is
  62.      allocated with `malloc ()'; you should `free ()' it when you are
  63.      done.
  64.  - Function: Keymap rl_copy_keymap (Keymap map)
  65.      Return a new keymap which is a copy of MAP.
  66.  - Function: Keymap rl_make_keymap ()
  67.      Return a new keymap with the printing characters bound to
  68.      rl_insert, the lowercase Meta characters bound to run their
  69.      equivalents, and the Meta digits bound to produce numeric
  70.      arguments.
  71.  - Function: void rl_discard_keymap (Keymap keymap)
  72.      Free the storage associated with KEYMAP.
  73.    Readline has several internal keymaps.  These functions allow you to
  74. change which keymap is active.
  75.  - Function: Keymap rl_get_keymap ()
  76.      Returns the currently active keymap.
  77.  - Function: void rl_set_keymap (Keymap keymap)
  78.      Makes KEYMAP the currently active keymap.
  79.  - Function: Keymap rl_get_keymap_by_name (char *name)
  80.      Return the keymap matching NAME.  NAME is one which would be
  81.      supplied in a `set keymap' inputrc line (*note Readline Init
  82.      File::.).
  83.  - Function: char * rl_get_keymap_name (Keymap keymap)
  84.      Return the name matching KEYMAP.  NAME is one which would be
  85.      supplied in a `set keymap' inputrc line (*note Readline Init
  86.      File::.).
  87. File: readline,  Node: Binding Keys,  Next: Associating Function Names and Bindings,  Prev: Keymaps,  Up: Readline Convenience Functions
  88. Binding Keys
  89. ------------
  90.    You associate keys with functions through the keymap.  Readline has
  91. several internal keymaps: `emacs_standard_keymap', `emacs_meta_keymap',
  92. `emacs_ctlx_keymap', `vi_movement_keymap', and `vi_insertion_keymap'.
  93. `emacs_standard_keymap' is the default, and the examples in this manual
  94. assume that.
  95.    These functions manage key bindings.
  96.  - Function: int rl_bind_key (int key, Function *function)
  97.      Binds KEY to FUNCTION in the currently active keymap.  Returns
  98.      non-zero in the case of an invalid KEY.
  99.  - Function: int rl_bind_key_in_map (int key, Function *function,
  100.           Keymap map)
  101.      Bind KEY to FUNCTION in MAP.  Returns non-zero in the case of an
  102.      invalid KEY.
  103.  - Function: int rl_unbind_key (int key)
  104.      Bind KEY to the null function in the currently active keymap.
  105.      Returns non-zero in case of error.
  106.  - Function: int rl_unbind_key_in_map (int key, Keymap map)
  107.      Bind KEY to the null function in MAP.  Returns non-zero in case of
  108.      error.
  109.  - Function: int rl_generic_bind (int type, char *keyseq, char *data,
  110.           Keymap map)
  111.      Bind the key sequence represented by the string KEYSEQ to the
  112.      arbitrary pointer DATA.  TYPE says what kind of data is pointed to
  113.      by DATA; this can be a function (`ISFUNC'), a macro (`ISMACR'), or
  114.      a keymap (`ISKMAP').  This makes new keymaps as necessary.  The
  115.      initial keymap in which to do bindings is MAP.
  116.  - Function: int rl_parse_and_bind (char *line)
  117.      Parse LINE as if it had been read from the `inputrc' file and
  118.      perform any key bindings and variable assignments found (*note
  119.      Readline Init File::.).
  120.  - Function: int rl_read_init_file (char *filename)
  121.      Read keybindings and variable assignments from FILENAME (*note
  122.      Readline Init File::.).
  123. File: readline,  Node: Associating Function Names and Bindings,  Next: Allowing Undoing,  Prev: Binding Keys,  Up: Readline Convenience Functions
  124. Associating Function Names and Bindings
  125. ---------------------------------------
  126.    These functions allow you to find out what keys invoke named
  127. functions and the functions invoked by a particular key sequence.
  128.  - Function: Function * rl_named_function (char *name)
  129.      Return the function with name NAME.
  130.  - Function: Function * rl_function_of_keyseq (char *keyseq, Keymap
  131.           map, int *type)
  132.      Return the function invoked by KEYSEQ in keymap MAP.  If MAP is
  133.      NULL, the current keymap is used.  If TYPE is not NULL, the type
  134.      of the object is returned in it (one of `ISFUNC', `ISKMAP', or
  135.      `ISMACR').
  136.  - Function: char ** rl_invoking_keyseqs (Function *function)
  137.      Return an array of strings representing the key sequences used to
  138.      invoke FUNCTION in the current keymap.
  139.  - Function: char ** rl_invoking_keyseqs_in_map (Function *function,
  140.           Keymap map)
  141.      Return an array of strings representing the key sequences used to
  142.      invoke FUNCTION in the keymap MAP.
  143.  - Function: void rl_function_dumper (int readable)
  144.      Print the readline function names and the key sequences currently
  145.      bound to them to `rl_outstream'.  If READABLE is non-zero, the
  146.      list is formatted in such a way that it can be made part of an
  147.      `inputrc' file and re-read.
  148.  - Function: void rl_list_funmap_names ()
  149.      Print the names of all bindable Readline functions to
  150.      `rl_outstream'.
  151. File: readline,  Node: Allowing Undoing,  Next: Redisplay,  Prev: Associating Function Names and Bindings,  Up: Readline Convenience Functions
  152. Allowing Undoing
  153. ----------------
  154.    Supporting the undo command is a painless thing, and makes your
  155. functions much more useful.  It is certainly easy to try something if
  156. you know you can undo it.  I could use an undo function for the stock
  157. market.
  158.    If your function simply inserts text once, or deletes text once, and
  159. uses `rl_insert_text ()' or `rl_delete_text ()' to do it, then undoing
  160. is already done for you automatically.
  161.    If you do multiple insertions or multiple deletions, or any
  162. combination of these operations, you should group them together into
  163. one operation.  This is done with `rl_begin_undo_group ()' and
  164. `rl_end_undo_group ()'.
  165.    The types of events that can be undone are:
  166.      enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
  167.    Notice that `UNDO_DELETE' means to insert some text, and
  168. `UNDO_INSERT' means to delete some text.  That is, the undo code tells
  169. undo what to undo, not how to undo it.  `UNDO_BEGIN' and `UNDO_END' are
  170. tags added by `rl_begin_undo_group ()' and `rl_end_undo_group ()'.
  171.  - Function: int rl_begin_undo_group ()
  172.      Begins saving undo information in a group construct.  The undo
  173.      information usually comes from calls to `rl_insert_text ()' and
  174.      `rl_delete_text ()', but could be the result of calls to
  175.      `rl_add_undo ()'.
  176.  - Function: int rl_end_undo_group ()
  177.      Closes the current undo group started with `rl_begin_undo_group
  178.      ()'.  There should be one call to `rl_end_undo_group ()' for each
  179.      call to `rl_begin_undo_group ()'.
  180.  - Function: void rl_add_undo (enum undo_code what, int start, int end,
  181.           char *text)
  182.      Remember how to undo an event (according to WHAT).  The affected
  183.      text runs from START to END, and encompasses TEXT.
  184.  - Function: void free_undo_list ()
  185.      Free the existing undo list.
  186.  - Function: int rl_do_undo ()
  187.      Undo the first thing on the undo list.  Returns `0' if there was
  188.      nothing to undo, non-zero if something was undone.
  189.    Finally, if you neither insert nor delete text, but directly modify
  190. the existing text (e.g., change its case), call `rl_modifying ()' once,
  191. just before you modify the text.  You must supply the indices of the
  192. text range that you are going to modify.
  193.  - Function: int rl_modifying (int start, int end)
  194.      Tell Readline to save the text between START and END as a single
  195.      undo unit.  It is assumed that you will subsequently modify that
  196.      text.
  197. File: readline,  Node: Redisplay,  Next: Modifying Text,  Prev: Allowing Undoing,  Up: Readline Convenience Functions
  198. Redisplay
  199. ---------
  200.  - Function: void rl_redisplay ()
  201.      Change what's displayed on the screen to reflect the current
  202.      contents of `rl_line_buffer'.
  203.  - Function: int rl_forced_update_display ()
  204.      Force the line to be updated and redisplayed, whether or not
  205.      Readline thinks the screen display is correct.
  206.  - Function: int rl_on_new_line ()
  207.      Tell the update routines that we have moved onto a new (empty)
  208.      line, usually after ouputting a newline.
  209.  - Function: int rl_reset_line_state ()
  210.      Reset the display state to a clean state and redisplay the current
  211.      line starting on a new line.
  212.  - Function: int rl_message (va_alist)
  213.      The arguments are a string as would be supplied to `printf'.  The
  214.      resulting string is displayed in the "echo area".  The echo area
  215.      is also used to display numeric arguments and search strings.
  216.  - Function: int rl_clear_message ()
  217.      Clear the message in the echo area.
  218. File: readline,  Node: Modifying Text,  Next: Utility Functions,  Prev: Redisplay,  Up: Readline Convenience Functions
  219. Modifying Text
  220. --------------
  221.  - Function: int rl_insert_text (char *text)
  222.      Insert TEXT into the line at the current cursor position.
  223.  - Function: int rl_delete_text (int start, int end)
  224.      Delete the text between START and END in the current line.
  225.  - Function: char * rl_copy_text (int start, int end)
  226.      Return a copy of the text between START and END in the current
  227.      line.
  228.  - Function: int rl_kill_text (int start, int end)
  229.      Copy the text between START and END in the current line to the
  230.      kill ring, appending or prepending to the last kill if the last
  231.      command was a kill command.  The text is deleted.  If START is
  232.      less than END, the text is appended, otherwise prepended.  If the
  233.      last command was not a kill, a new kill ring slot is used.
  234. File: readline,  Node: Utility Functions,  Next: Alternate Interface,  Prev: Modifying Text,  Up: Readline Convenience Functions
  235. Utility Functions
  236. -----------------
  237.  - Function: int rl_read_key ()
  238.      Return the next character available.  This handles input inserted
  239.      into the input stream via PENDING INPUT (*note Readline
  240.      Variables::.) and `rl_stuff_char ()', macros, and characters read
  241.      from the keyboard.
  242.  - Function: int rl_getc (FILE *)
  243.      Return the next character available from the keyboard.
  244.  - Function: int rl_stuff_char (int c)
  245.      Insert C into the Readline input stream.  It will be "read" before
  246.      Readline attempts to read characters from the terminal with
  247.      `rl_read_key ()'.
  248.  - Function: rl_extend_line_buffer (int len)
  249.      Ensure that `rl_line_buffer' has enough space to hold LEN
  250.      characters, possibly reallocating it if necessary.
  251.  - Function: int rl_initialize ()
  252.      Initialize or re-initialize Readline's internal state.
  253.  - Function: int rl_reset_terminal (char *terminal_name)
  254.      Reinitialize Readline's idea of the terminal settings using
  255.      TERMINAL_NAME as the terminal type (e.g., `vt100').
  256.  - Function: int alphabetic (int c)
  257.      Return 1 if C is an alphabetic character.
  258.  - Function: int numeric (int c)
  259.      Return 1 if C is a numeric character.
  260.  - Function: int ding ()
  261.      Ring the terminal bell, obeying the setting of `bell-style'.
  262.    The following are implemented as macros, defined in `chartypes.h'.
  263.  - Function: int uppercase_p (int c)
  264.      Return 1 if C is an uppercase alphabetic character.
  265.  - Function: int lowercase_p (int c)
  266.      Return 1 if C is a lowercase alphabetic character.
  267.  - Function: int digit_p (int c)
  268.      Return 1 if C is a numeric character.
  269.  - Function: int to_upper (int c)
  270.      If C is a lowercase alphabetic character, return the corresponding
  271.      uppercase character.
  272.  - Function: int to_lower (int c)
  273.      If C is an uppercase alphabetic character, return the corresponding
  274.      lowercase character.
  275.  - Function: int digit_value (int c)
  276.      If C is a number, return the value it represents.
  277. File: readline,  Node: Alternate Interface,  Prev: Utility Functions,  Up: Readline Convenience Functions
  278. Alternate Interface
  279. -------------------
  280.    An alternate interface is available to plain `readline()'.  Some
  281. applications need to interleave keyboard I/O with file, device, or
  282. window system I/O, typically by using a main loop to `select()' on
  283. various file descriptors.  To accomodate this need, readline can also
  284. be invoked as a `callback' function from an event loop.  There are
  285. functions available to make this easy.
  286.  - Function: void rl_callback_handler_install (char *prompt, Vfunction
  287.           *lhandler)
  288.      Set up the terminal for readline I/O and display the initial
  289.      expanded value of PROMPT.  Save the value of LHANDLER to use as a
  290.      callback when a complete line of input has been entered.
  291.  - Function: void rl_callback_read_char ()
  292.      Whenever an application determines that keyboard input is
  293.      available, it should call `rl_callback_read_char()', which will
  294.      read the next character from the current input source.  If that
  295.      character completes the line, `rl_callback_read_char' will invoke
  296.      the LHANDLER function saved by `rl_callback_handler_install' to
  297.      process the line.  `EOF' is  indicated by calling LHANDLER with a
  298.      `NULL' line.
  299.  - Function: void rl_callback_handler_remove ()
  300.      Restore the terminal to its initial state and remove the line
  301.      handler.  This may be called from within a callback as well as
  302.      independently.
  303. An Example
  304. ----------
  305.    Here is a function which changes lowercase characters to their
  306. uppercase equivalents, and uppercase characters to lowercase.  If this
  307. function was bound to `M-c', then typing `M-c' would change the case of
  308. the character under point.  Typing `M-1 0 M-c' would change the case of
  309. the following 10 characters, leaving the cursor on the last character
  310. changed.
  311.      /* Invert the case of the COUNT following characters. */
  312.      int
  313.      invert_case_line (count, key)
  314.           int count, key;
  315.      {
  316.        register int start, end, i;
  317.      
  318.        start = rl_point;
  319.      
  320.        if (rl_point >= rl_end)
  321.          return (0);
  322.      
  323.        if (count < 0)
  324.          {
  325.            direction = -1;
  326.            count = -count;
  327.          }
  328.        else
  329.          direction = 1;
  330.      
  331.        /* Find the end of the range to modify. */
  332.        end = start + (count * direction);
  333.      
  334.        /* Force it to be within range. */
  335.        if (end > rl_end)
  336.          end = rl_end;
  337.        else if (end < 0)
  338.          end = 0;
  339.      
  340.        if (start == end)
  341.          return (0);
  342.      
  343.        if (start > end)
  344.          {
  345.            int temp = start;
  346.            start = end;
  347.            end = temp;
  348.          }
  349.      
  350.        /* Tell readline that we are modifying the line, so it will save
  351.           the undo information. */
  352.        rl_modifying (start, end);
  353.      
  354.        for (i = start; i != end; i++)
  355.          {
  356.            if (uppercase_p (rl_line_buffer[i]))
  357.              rl_line_buffer[i] = to_lower (rl_line_buffer[i]);
  358.            else if (lowercase_p (rl_line_buffer[i]))
  359.              rl_line_buffer[i] = to_upper (rl_line_buffer[i]);
  360.          }
  361.        /* Move point to on top of the last character changed. */
  362.        rl_point = (direction == 1) ? end - 1 : start;
  363.        return (0);
  364.      }
  365. File: readline,  Node: Custom Completers,  Prev: Readline Convenience Functions,  Up: Programming with GNU Readline
  366. Custom Completers
  367. =================
  368.    Typically, a program that reads commands from the user has a way of
  369. disambiguating commands and data.  If your program is one of these, then
  370. it can provide completion for commands, data, or both.  The following
  371. sections describe how your program and Readline cooperate to provide
  372. this service.
  373. * Menu:
  374. * How Completing Works::    The logic used to do completion.
  375. * Completion Functions::    Functions provided by Readline.
  376. * Completion Variables::    Variables which control completion.
  377. * A Short Completion Example::    An example of writing completer subroutines.
  378. File: readline,  Node: How Completing Works,  Next: Completion Functions,  Up: Custom Completers
  379. How Completing Works
  380. --------------------
  381.    In order to complete some text, the full list of possible completions
  382. must be available.  That is, it is not possible to accurately expand a
  383. partial word without knowing all of the possible words which make sense
  384. in that context.  The Readline library provides the user interface to
  385. completion, and two of the most common completion functions:  filename
  386. and username.  For completing other types of text, you must write your
  387. own completion function.  This section describes exactly what such
  388. functions must do, and provides an example.
  389.    There are three major functions used to perform completion:
  390.   1. The user-interface function `rl_complete ()'.  This function is
  391.      called with the same arguments as other Readline functions
  392.      intended for interactive use:  COUNT and INVOKING_KEY.  It
  393.      isolates the word to be completed and calls `completion_matches
  394.      ()' to generate a list of possible completions.  It then either
  395.      lists the possible completions, inserts the possible completions,
  396.      or actually performs the completion, depending on which behavior
  397.      is desired.
  398.   2. The internal function `completion_matches ()' uses your
  399.      "generator" function to generate the list of possible matches, and
  400.      then returns the array of these matches.  You should place the
  401.      address of your generator function in
  402.      `rl_completion_entry_function'.
  403.   3. The generator function is called repeatedly from
  404.      `completion_matches ()', returning a string each time.  The
  405.      arguments to the generator function are TEXT and STATE.  TEXT is
  406.      the partial word to be completed.  STATE is zero the first time
  407.      the function is called, allowing the generator to perform any
  408.      necessary initialization, and a positive non-zero integer for each
  409.      subsequent call.  When the generator function returns `(char
  410.      *)NULL' this signals `completion_matches ()' that there are no
  411.      more possibilities left.  Usually the generator function computes
  412.      the list of possible completions when STATE is zero, and returns
  413.      them one at a time on subsequent calls.  Each string the generator
  414.      function returns as a match must be allocated with `malloc()';
  415.      Readline frees the strings when it has finished with them.
  416.  - Function: int rl_complete (int ignore, int invoking_key)
  417.      Complete the word at or before point.  You have supplied the
  418.      function that does the initial simple matching selection algorithm
  419.      (see `completion_matches ()').  The default is to do filename
  420.      completion.
  421.  - Variable: Function * rl_completion_entry_function
  422.      This is a pointer to the generator function for `completion_matches
  423.      ()'.  If the value of `rl_completion_entry_function' is `(Function
  424.      *)NULL' then the default filename generator function,
  425.      `filename_completion_function ()', is used.
  426. File: readline,  Node: Completion Functions,  Next: Completion Variables,  Prev: How Completing Works,  Up: Custom Completers
  427. Completion Functions
  428. --------------------
  429.    Here is the complete list of callable completion functions present in
  430. Readline.
  431.  - Function: int rl_complete_internal (int what_to_do)
  432.      Complete the word at or before point.  WHAT_TO_DO says what to do
  433.      with the completion.  A value of `?' means list the possible
  434.      completions.  `TAB' means do standard completion.  `*' means
  435.      insert all of the possible completions.  `!' means to display all
  436.      of the possible completions, if there is more than one, as well as
  437.      performing partial completion.
  438.  - Function: int rl_complete (int ignore, int invoking_key)
  439.      Complete the word at or before point.  You have supplied the
  440.      function that does the initial simple matching selection algorithm
  441.      (see `completion_matches ()' and `rl_completion_entry_function').
  442.      The default is to do filename completion.  This calls
  443.      `rl_complete_internal ()' with an argument depending on
  444.      INVOKING_KEY.
  445.  - Function: int rl_possible_completions (int count, int invoking_key))
  446.      List the possible completions.  See description of `rl_complete
  447.      ()'.  This calls `rl_complete_internal ()' with an argument of `?'.
  448.  - Function: int rl_insert_completions (int count, int invoking_key))
  449.      Insert the list of possible completions into the line, deleting the
  450.      partially-completed word.  See description of `rl_complete ()'.
  451.      This calls `rl_complete_internal ()' with an argument of `*'.
  452.  - Function: char ** completion_matches (char *text, CPFunction
  453.           *entry_func)
  454.      Returns an array of `(char *)' which is a list of completions for
  455.      TEXT.  If there are no completions, returns `(char **)NULL'.  The
  456.      first entry in the returned array is the substitution for TEXT.
  457.      The remaining entries are the possible completions.  The array is
  458.      terminated with a `NULL' pointer.
  459.      ENTRY_FUNC is a function of two args, and returns a `(char *)'.
  460.      The first argument is TEXT.  The second is a state argument; it is
  461.      zero on the first call, and non-zero on subsequent calls.
  462.      ENTRY_FUNC returns a `NULL'  pointer to the caller when there are
  463.      no more matches.
  464.  - Function: char * filename_completion_function (char *text, int state)
  465.      A generator function for filename completion in the general case.
  466.      Note that completion in Bash is a little different because of all
  467.      the pathnames that must be followed when looking up completions
  468.      for a command.  The Bash source is a useful reference for writing
  469.      custom completion functions.
  470.  - Function: char * username_completion_function (char *text, int state)
  471.      A completion generator for usernames.  TEXT contains a partial
  472.      username preceded by a random character (usually `~').  As with all
  473.      completion generators, STATE is zero on the first call and non-zero
  474.      for subsequent calls.
  475. File: readline,  Node: Completion Variables,  Next: A Short Completion Example,  Prev: Completion Functions,  Up: Custom Completers
  476. Completion Variables
  477. --------------------
  478.  - Variable: Function * rl_completion_entry_function
  479.      A pointer to the generator function for `completion_matches ()'.
  480.      `NULL' means to use `filename_entry_function ()', the default
  481.      filename completer.
  482.  - Variable: CPPFunction * rl_attempted_completion_function
  483.      A pointer to an alternative function to create matches.  The
  484.      function is called with TEXT, START, and END.  START and END are
  485.      indices in `rl_line_buffer' saying what the boundaries of TEXT
  486.      are.  If this function exists and returns `NULL', or if this
  487.      variable is set to `NULL', then `rl_complete ()' will call the
  488.      value of `rl_completion_entry_function' to generate matches,
  489.      otherwise the array of strings returned will be used.
  490.  - Variable: CPFunction * rl_filename_quoting_function
  491.      A pointer to a function that will quote a filename in an
  492.      application- specific fashion.  This is called if filename
  493.      completion is being attempted and one of the characters in
  494.      `rl_filename_quote_characters' appears in a completed filename.
  495.      The function is called with TEXT, MATCH_TYPE, and QUOTE_POINTER.
  496.      The TEXT is the filename to be quoted.  The MATCH_TYPE is either
  497.      `SINGLE_MATCH', if there is only one completion match, or
  498.      `MULT_MATCH'.  Some functions use this to decide whether or not to
  499.      insert a closing quote character.  The QUOTE_POINTER is a pointer
  500.      to any opening quote character the user typed.  Some functions
  501.      choose to reset this character.
  502.  - Variable: CPFunction * rl_filename_dequoting_function
  503.      A pointer to a function that will remove application-specific
  504.      quoting characters from a filename before completion is attempted,
  505.      so those characters do not interfere with matching the text
  506.      against names in the filesystem.  It is called with TEXT, the text
  507.      of the word to be dequoted, and QUOTE_CHAR, which is the quoting
  508.      character that delimits the filename (usually `'' or `"').  If
  509.      QUOTE_CHAR is zero, the filename was not in an embedded string.
  510.  - Variable: Function * rl_char_is_quoted_p
  511.      A pointer to a function to call that determines whether or not a
  512.      specific character in the line buffer is quoted, according to
  513.      whatever quoting mechanism the program calling readline uses.  The
  514.      function is called with two arguments: TEXT, the text of the line,
  515.      and INDEX, the index of the character in the line.  It is used to
  516.      decide whether a character found in
  517.      `rl_completer_word_break_characters' should be used to break words
  518.      for the completer.
  519.  - Variable: int rl_completion_query_items
  520.      Up to this many items will be displayed in response to a
  521.      possible-completions call.  After that, we ask the user if she is
  522.      sure she wants to see them all.  The default value is 100.
  523.  - Variable: char * rl_basic_word_break_characters
  524.      The basic list of characters that signal a break between words for
  525.      the completer routine.  The default value of this variable is the
  526.      characters which break words for completion in Bash, i.e., `"
  527.      \t\n\"\\'`@$><=;|&{("'.
  528.  - Variable: char * rl_basic_quote_characters
  529.      List of quote characters which can cause a word break.
  530.  - Variable: char * rl_completer_word_break_characters
  531.      The list of characters that signal a break between words for
  532.      `rl_complete_internal ()'.  The default list is the value of
  533.      `rl_basic_word_break_characters'.
  534.  - Variable: char * rl_completer_quote_characters
  535.      List of characters which can be used to quote a substring of the
  536.      line.  Completion occurs on the entire substring, and within the
  537.      substring `rl_completer_word_break_characters' are treated as any
  538.      other character, unless they also appear within this list.
  539.  - Variable: char * rl_filename_quote_characters
  540.      A list of characters that cause a filename to be quoted by the
  541.      completer when they appear in a completed filename.  The default
  542.      is empty.
  543.  - Variable: char * rl_special_prefixes
  544.      The list of characters that are word break characters, but should
  545.      be left in TEXT when it is passed to the completion function.
  546.      Programs can use this to help determine what kind of completing to
  547.      do.  For instance, Bash sets this variable to "$@" so that it can
  548.      complete shell variables and hostnames.
  549.  - Variable: int rl_completion_append_character
  550.      When a single completion alternative matches at the end of the
  551.      command line, this character is appended to the inserted
  552.      completion text.  The default is a space character (` ').  Setting
  553.      this to the null character (`\0') prevents anything being appended
  554.      automatically.  This can be changed in custom completion functions
  555.      to provide the "most sensible word separator character" according
  556.      to an application-specific command line syntax specification.
  557.  - Variable: int rl_ignore_completion_duplicates
  558.      If non-zero, then disallow duplicates in the matches.  Default is
  559.      1.
  560.  - Variable: int rl_filename_completion_desired
  561.      Non-zero means that the results of the matches are to be treated as
  562.      filenames.  This is *always* zero on entry, and can only be changed
  563.      within a completion entry generator function.  If it is set to a
  564.      non-zero value, directory names have a slash appended and Readline
  565.      attempts to quote completed filenames if they contain any embedded
  566.      word break characters.
  567.  - Variable: int rl_filename_quoting_desired
  568.      Non-zero means that the results of the matches are to be quoted
  569.      using double quotes (or an application-specific quoting mechanism)
  570.      if the completed filename contains any characters in
  571.      `rl_filename_quote_chars'.  This is *always* non-zero on entry,
  572.      and can only be changed within a completion entry generator
  573.      function.  The quoting is effected via a call to the function
  574.      pointed to by `rl_filename_quoting_function'.
  575.  - Variable: int rl_inhibit_completion
  576.      If this variable is non-zero, completion is inhibit<ed.  The
  577.      completion character will be inserted as any other bound to
  578.      `self-insert'.
  579.  - Variable: Function * rl_ignore_some_completions_function
  580.      This function, if defined, is called by the completer when real
  581.      filename completion is done, after all the matching names have
  582.      been generated.  It is passed a `NULL' terminated array of matches.
  583.      The first element (`matches[0]') is the maximal substring common
  584.      to all matches. This function can re-arrange the list of matches
  585.      as required, but each element deleted from the array must be freed.
  586.  - Variable: Function * rl_directory_completion_hook
  587.      This function, if defined, is allowed to modify the directory
  588.      portion of filenames Readline completes.  It is called with the
  589.      address of a string (the current directory name) as an argument.
  590.      It could be used to expand symbolic links or shell variables in
  591.      pathnames.
  592. File: readline,  Node: A Short Completion Example,  Prev: Completion Variables,  Up: Custom Completers
  593. A Short Completion Example
  594. --------------------------
  595.    Here is a small application demonstrating the use of the GNU Readline
  596. library.  It is called `fileman', and the source code resides in
  597. `examples/fileman.c'.  This sample application provides completion of
  598. command names, line editing features, and access to the history list.
  599.      /* fileman.c -- A tiny application which demonstrates how to use the
  600.         GNU Readline library.  This application interactively allows users
  601.         to manipulate files and their modes. */
  602.      
  603.      #include <stdio.h>
  604.      #include <sys/types.h>
  605.      #include <sys/file.h>
  606.      #include <sys/stat.h>
  607.      #include <sys/errno.h>
  608.      
  609.      #include <readline/readline.h>
  610.      #include <readline/history.h>
  611.      
  612.      extern char *getwd ();
  613.      extern char *xmalloc ();
  614.      
  615.      /* The names of functions that actually do the manipulation. */
  616.      int com_list (), com_view (), com_rename (), com_stat (), com_pwd ();
  617.      int com_delete (), com_help (), com_cd (), com_quit ();
  618.      
  619.      /* A structure which contains information on the commands this program
  620.         can understand. */
  621.      
  622.      typedef struct {
  623.        char *name;            /* User printable name of the function. */
  624.        Function *func;        /* Function to call to do the job. */
  625.        char *doc;            /* Documentation for this function.  */
  626.      } COMMAND;
  627.      
  628.      COMMAND commands[] = {
  629.        { "cd", com_cd, "Change to directory DIR" },
  630.        { "delete", com_delete, "Delete FILE" },
  631.        { "help", com_help, "Display this text" },
  632.        { "?", com_help, "Synonym for `help'" },
  633.        { "list", com_list, "List files in DIR" },
  634.        { "ls", com_list, "Synonym for `list'" },
  635.        { "pwd", com_pwd, "Print the current working directory" },
  636.        { "quit", com_quit, "Quit using Fileman" },
  637.        { "rename", com_rename, "Rename FILE to NEWNAME" },
  638.        { "stat", com_stat, "Print out statistics on FILE" },
  639.        { "view", com_view, "View the contents of FILE" },
  640.        { (char *)NULL, (Function *)NULL, (char *)NULL }
  641.      };
  642.      
  643.      /* Forward declarations. */
  644.      char *stripwhite ();
  645.      COMMAND *find_command ();
  646.      
  647.      /* The name of this program, as taken from argv[0]. */
  648.      char *progname;
  649.      
  650.      /* When non-zero, this global means the user is done using this program. */
  651.      int done;
  652.      
  653.      char *
  654.      dupstr (s)
  655.           int s;
  656.      {
  657.        char *r;
  658.      
  659.        r = xmalloc (strlen (s) + 1);
  660.        strcpy (r, s);
  661.        return (r);
  662.      }
  663.      
  664.      main (argc, argv)
  665.           int argc;
  666.           char **argv;
  667.      {
  668.        char *line, *s;
  669.      
  670.        progname = argv[0];
  671.      
  672.        initialize_readline ();    /* Bind our completer. */
  673.      
  674.        /* Loop reading and executing lines until the user quits. */
  675.        for ( ; done == 0; )
  676.          {
  677.            line = readline ("FileMan: ");
  678.      
  679.            if (!line)
  680.              break;
  681.      
  682.            /* Remove leading and trailing whitespace from the line.
  683.               Then, if there is anything left, add it to the history list
  684.               and execute it. */
  685.            s = stripwhite (line);
  686.      
  687.            if (*s)
  688.              {
  689.                add_history (s);
  690.                execute_line (s);
  691.              }
  692.      
  693.            free (line);
  694.          }
  695.        exit (0);
  696.      }
  697.      
  698.      /* Execute a command line. */
  699.      int
  700.      execute_line (line)
  701.           char *line;
  702.      {
  703.        register int i;
  704.        COMMAND *command;
  705.        char *word;
  706.      
  707.        /* Isolate the command word. */
  708.        i = 0;
  709.        while (line[i] && whitespace (line[i]))
  710.          i++;
  711.        word = line + i;
  712.      
  713.        while (line[i] && !whitespace (line[i]))
  714.          i++;
  715.      
  716.        if (line[i])
  717.          line[i++] = '\0';
  718.      
  719.        command = find_command (word);
  720.      
  721.        if (!command)
  722.          {
  723.            fprintf (stderr, "%s: No such command for FileMan.\n", word);
  724.            return (-1);
  725.          }
  726.      
  727.        /* Get argument to command, if any. */
  728.        while (whitespace (line[i]))
  729.          i++;
  730.      
  731.        word = line + i;
  732.      
  733.        /* Call the function. */
  734.        return ((*(command->func)) (word));
  735.      }
  736.      
  737.      /* Look up NAME as the name of a command, and return a pointer to that
  738.         command.  Return a NULL pointer if NAME isn't a command name. */
  739.      COMMAND *
  740.      find_command (name)
  741.           char *name;
  742.      {
  743.        register int i;
  744.      
  745.        for (i = 0; commands[i].name; i++)
  746.          if (strcmp (name, commands[i].name) == 0)
  747.            return (&commands[i]);
  748.      
  749.        return ((COMMAND *)NULL);
  750.      }
  751.      
  752.      /* Strip whitespace from the start and end of STRING.  Return a pointer
  753.         into STRING. */
  754.      char *
  755.      stripwhite (string)
  756.           char *string;
  757.      {
  758.        register char *s, *t;
  759.      
  760.        for (s = string; whitespace (*s); s++)
  761.          ;
  762.      
  763.        if (*s == 0)
  764.          return (s);
  765.      
  766.        t = s + strlen (s) - 1;
  767.        while (t > s && whitespace (*t))
  768.          t--;
  769.        *++t = '\0';
  770.      
  771.        return s;
  772.      }
  773.      
  774.      /* **************************************************************** */
  775.      /*                                                                  */
  776.      /*                  Interface to Readline Completion                */
  777.      /*                                                                  */
  778.      /* **************************************************************** */
  779.      
  780.      char *command_generator ();
  781.      char **fileman_completion ();
  782.      
  783.      /* Tell the GNU Readline library how to complete.  We want to try to complete
  784.         on command names if this is the first word in the line, or on filenames
  785.         if not. */
  786.      initialize_readline ()
  787.      {
  788.        /* Allow conditional parsing of the ~/.inputrc file. */
  789.        rl_readline_name = "FileMan";
  790.      
  791.        /* Tell the completer that we want a crack first. */
  792.        rl_attempted_completion_function = (CPPFunction *)fileman_completion;
  793.      }
  794.      
  795.      /* Attempt to complete on the contents of TEXT.  START and END bound the
  796.         region of rl_line_buffer that contains the word to complete.  TEXT is
  797.         the word to complete.  We can use the entire contents of rl_line_buffer
  798.         in case we want to do some simple parsing.  Return the array of matches,
  799.         or NULL if there aren't any. */
  800.      char **
  801.      fileman_completion (text, start, end)
  802.           char *text;
  803.           int start, end;
  804.      {
  805.        char **matches;
  806.      
  807.        matches = (char **)NULL;
  808.      
  809.        /* If this word is at the start of the line, then it is a command
  810.           to complete.  Otherwise it is the name of a file in the current
  811.           directory. */
  812.        if (start == 0)
  813.          matches = completion_matches (text, command_generator);
  814.      
  815.        return (matches);
  816.      }
  817.      
  818.      /* Generator function for command completion.  STATE lets us know whether
  819.         to start from scratch; without any state (i.e. STATE == 0), then we
  820.         start at the top of the list. */
  821.      char *
  822.      command_generator (text, state)
  823.           char *text;
  824.           int state;
  825.      {
  826.        static int list_index, len;
  827.        char *name;
  828.      
  829.        /* If this is a new word to complete, initialize now.  This includes
  830.           saving the length of TEXT for efficiency, and initializing the index
  831.           variable to 0. */
  832.        if (!state)
  833.          {
  834.            list_index = 0;
  835.            len = strlen (text);
  836.          }
  837.      
  838.        /* Return the next name which partially matches from the command list. */
  839.        while (name = commands[list_index].name)
  840.          {
  841.            list_index++;
  842.      
  843.            if (strncmp (name, text, len) == 0)
  844.              return (dupstr(name));
  845.          }
  846.      
  847.        /* If no names matched, then return NULL. */
  848.        return ((char *)NULL);
  849.      }
  850.      
  851.      /* **************************************************************** */
  852.      /*                                                                  */
  853.      /*                       FileMan Commands                           */
  854.      /*                                                                  */
  855.      /* **************************************************************** */
  856.      
  857.      /* String to pass to system ().  This is for the LIST, VIEW and RENAME
  858.         commands. */
  859.      static char syscom[1024];
  860.      
  861.      /* List the file(s) named in arg. */
  862.      com_list (arg)
  863.           char *arg;
  864.      {
  865.        if (!arg)
  866.          arg = "";
  867.      
  868.        sprintf (syscom, "ls -FClg %s", arg);
  869.        return (system (syscom));
  870.      }
  871.      
  872.      com_view (arg)
  873.           char *arg;
  874.      {
  875.        if (!valid_argument ("view", arg))
  876.          return 1;
  877.      
  878.        sprintf (syscom, "more %s", arg);
  879.        return (system (syscom));
  880.      }
  881.      
  882.      com_rename (arg)
  883.           char *arg;
  884.      {
  885.        too_dangerous ("rename");
  886.        return (1);
  887.      }
  888.      
  889.      com_stat (arg)
  890.           char *arg;
  891.      {
  892.        struct stat finfo;
  893.      
  894.        if (!valid_argument ("stat", arg))
  895.          return (1);
  896.      
  897.        if (stat (arg, &finfo) == -1)
  898.          {
  899.            perror (arg);
  900.            return (1);
  901.          }
  902.      
  903.        printf ("Statistics for `%s':\n", arg);
  904.      
  905.        printf ("%s has %d link%s, and is %d byte%s in length.\n", arg,
  906.                finfo.st_nlink,
  907.                (finfo.st_nlink == 1) ? "" : "s",
  908.                finfo.st_size,
  909.                (finfo.st_size == 1) ? "" : "s");
  910.        printf ("Inode Last Change at: %s", ctime (&finfo.st_ctime));
  911.        printf ("      Last access at: %s", ctime (&finfo.st_atime));
  912.        printf ("    Last modified at: %s", ctime (&finfo.st_mtime));
  913.        return (0);
  914.      }
  915.      
  916.      com_delete (arg)
  917.           char *arg;
  918.      {
  919.        too_dangerous ("delete");
  920.        return (1);
  921.      }
  922.      
  923.      /* Print out help for ARG, or for all of the commands if ARG is
  924.         not present. */
  925.      com_help (arg)
  926.           char *arg;
  927.      {
  928.        register int i;
  929.        int printed = 0;
  930.      
  931.        for (i = 0; commands[i].name; i++)
  932.          {
  933.            if (!*arg || (strcmp (arg, commands[i].name) == 0))
  934.              {
  935.                printf ("%s\t\t%s.\n", commands[i].name, commands[i].doc);
  936.                printed++;
  937.              }
  938.          }
  939.      
  940.        if (!printed)
  941.          {
  942.            printf ("No commands match `%s'.  Possibilties are:\n", arg);
  943.      
  944.            for (i = 0; commands[i].name; i++)
  945.              {
  946.                /* Print in six columns. */
  947.                if (printed == 6)
  948.                  {
  949.                    printed = 0;
  950.                    printf ("\n");
  951.                  }
  952.      
  953.                printf ("%s\t", commands[i].name);
  954.                printed++;
  955.              }
  956.      
  957.            if (printed)
  958.              printf ("\n");
  959.          }
  960.        return (0);
  961.      }
  962.      
  963.      /* Change to the directory ARG. */
  964.      com_cd (arg)
  965.           char *arg;
  966.      {
  967.        if (chdir (arg) == -1)
  968.          {
  969.            perror (arg);
  970.            return 1;
  971.          }
  972.      
  973.        com_pwd ("");
  974.        return (0);
  975.      }
  976.      
  977.      /* Print out the current working directory. */
  978.      com_pwd (ignore)
  979.           char *ignore;
  980.      {
  981.        char dir[1024], *s;
  982.      
  983.        s = getwd (dir);
  984.        if (s == 0)
  985.          {
  986.            printf ("Error getting pwd: %s\n", dir);
  987.            return 1;
  988.          }
  989.      
  990.        printf ("Current directory is %s\n", dir);
  991.        return 0;
  992.      }
  993.      
  994.      /* The user wishes to quit using this program.  Just set DONE non-zero. */
  995.      com_quit (arg)
  996.           char *arg;
  997.      {
  998.        done = 1;
  999.        return (0);
  1000.      }
  1001.      
  1002.      /* Function which tells you that you can't do this. */
  1003.      too_dangerous (caller)
  1004.           char *caller;
  1005.      {
  1006.        fprintf (stderr,
  1007.                 "%s: Too dangerous for me to distribute.  Write it yourself.\n",
  1008.                 caller);
  1009.      }
  1010.      
  1011.      /* Return non-zero if ARG is a valid argument for CALLER, else print
  1012.         an error message and return zero. */
  1013.      int
  1014.      valid_argument (caller, arg)
  1015.           char *caller, *arg;
  1016.      {
  1017.        if (!arg || !*arg)
  1018.          {
  1019.            fprintf (stderr, "%s: Argument required.\n", caller);
  1020.            return (0);
  1021.          }
  1022.      
  1023.        return (1);
  1024.      }
  1025. File: readline,  Node: Concept Index,  Next: Function and Variable Index,  Prev: Programming with GNU Readline,  Up: Top
  1026. Concept Index
  1027. *************
  1028. * Menu:
  1029. * command editing:                      Readline Bare Essentials.
  1030. * editing command lines:                Readline Bare Essentials.
  1031. * initialization file, readline:        Readline Init File.
  1032. * interaction, readline:                Readline Interaction.
  1033. * kill ring:                            Readline Killing Commands.
  1034. * killing text:                         Readline Killing Commands.
  1035. * notation, readline:                   Readline Bare Essentials.
  1036. * readline, function:                   Basic Behavior.
  1037. * yanking text:                         Readline Killing Commands.
  1038.