1/*  Part of SWI-Prolog
   2
   3    Author:        Jan Wielemaker
   4    E-mail:        J.Wielemaker@vu.nl
   5    WWW:           http://www.swi-prolog.org
   6    Copyright (c)  2016, VU University Amsterdam
   7    All rights reserved.
   8
   9    Redistribution and use in source and binary forms, with or without
  10    modification, are permitted provided that the following conditions
  11    are met:
  12
  13    1. Redistributions of source code must retain the above copyright
  14       notice, this list of conditions and the following disclaimer.
  15
  16    2. Redistributions in binary form must reproduce the above copyright
  17       notice, this list of conditions and the following disclaimer in
  18       the documentation and/or other materials provided with the
  19       distribution.
  20
  21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32    POSSIBILITY OF SUCH DAMAGE.
  33*/
  34
  35:- module(readline,
  36          [ rl_read_init_file/1,
  37            rl_add_history/1,
  38            rl_write_history/1,
  39            rl_read_history/1
  40          ]).
  41
  42:- use_foreign_library(foreign(readline4pl)).
  43
  44/** <module> GNU readline interface
  45
  46This library binds GNU  libreadline  to   SWI-Prolog.  The  GNU readline
  47library provides emacs and vi based  editing   of  queries on the Prolog
  48toplevel, including TAB-based completion and history.
  49
  50This library is by default  loaded   into  an interactive Prolog process
  51that is connected to a  (Unix)  terminal.   Loading  can  be  stopped by
  52setting the Prolog flag `readline` to `false`.
  53
  54@license Although the  interface  is   BSD-licensed,  the  GNU  readline
  55library itself is covered by  the   GPL  (General  Public License). This
  56implies that loading this  library  in   an  application  makes all code
  57loaded into the application subject to the GPL conditions.
  58*/
  59
  60%!  rl_read_init_file(+File) is det.
  61%
  62%   Read a GNU readline config file.  See   the  GNU readline manual for
  63%   details.
  64
  65%!  rl_add_history(+Line) is det.
  66%
  67%   Add a line to the history.
  68
  69%!  rl_write_history(+File) is det.
  70%
  71%   Save the history to File. This  can   be  reloaded in a next session
  72%   using rl_read_history/1.
  73
  74%!  rl_read_history(+File) is det.
  75%
  76%   Read a saved history from File.
  77
  78
  79:- multifile
  80    prolog:history/2.
  81
  82prolog:history(_Input, add(Line)) :-
  83    rl_add_history(Line).
  84prolog:history(_Input, load(File)) :-
  85    rl_read_history(File).
  86prolog:history(_Input, save(File)) :-
  87    rl_write_history(File).