/usr/lib/swipl/library/editline.pl
AllApplicationManualNameSummaryHelp

  • swipl
    • library
      • error.pl
      • apply.pl -- Apply predicates on a list
      • lists.pl -- List Manipulation
      • debug.pl -- Print debug messages and test assertions
      • broadcast.pl -- Event service
      • socket.pl -- Network socket (TCP and UDP) library
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl -- Utility library for loading foreign objects (DLLs, shared objects)
      • option.pl -- Option list processing
      • uid.pl -- User and group management on Unix systems
      • unix.pl -- Unix specific operations
      • syslog.pl -- Unix syslog interface
      • thread_pool.pl
      • gensym.pl -- Generate unique symbols
      • settings.pl -- Setting management
      • arithmetic.pl -- Extensible arithmetic
      • main.pl
      • readutil.pl -- Read utilities
      • ssl.pl -- Secure Socket Layer (SSL) library
      • crypto.pl -- Cryptography and authentication library
      • pldoc.pl -- Process source documentation
      • operators.pl -- Manage operators
      • pairs.pl -- Operations on key-value lists
      • prolog_source.pl -- Examine Prolog source-files
      • pengines.pl -- Pengines: Web Logic Programming Made Easy
      • record.pl -- Access compound arguments by name
      • memfile.pl
      • sgml.pl -- SGML, XML and HTML parser
      • quasi_quotations.pl -- Define Quasi Quotation syntax
      • pure_input.pl -- Pure Input from files and streams
      • time.pl -- Time and alarm library
      • uri.pl -- Process URIs
      • solution_sequences.pl -- Modify solution sequences
      • uuid.pl -- Universally Unique Identifier (UUID) Library
      • ordsets.pl -- Ordered set manipulation
      • random.pl -- Random numbers
      • base64.pl -- Base64 encoding and decoding
      • aggregate.pl -- Aggregation operators on backtrackable predicates
      • pcre.pl -- Perl compatible regular expression matching for SWI-Prolog
      • pengines_io.pl -- Provide Prolog I/O for HTML clients
      • sandbox.pl -- Sandboxed Prolog code
      • apply_macros.pl -- Goal expansion rules to avoid meta-calling
      • assoc.pl -- Binary associations
      • prolog_format.pl -- Analyse format specifications
      • yall.pl -- Lambda expressions
      • sha.pl -- SHA secure hashes
      • process.pl -- Create processes and redirect I/O
      • filesex.pl -- Extended operations on files
      • zlib.pl -- Zlib wrapper for SWI-Prolog
      • bdb.pl -- Berkeley DB interface
      • hash_stream.pl -- Maintain a hash on a stream
      • md5.pl -- MD5 hashes
      • porter_stem.pl
      • csv.pl -- Process CSV (Comma-Separated Values) data
      • pprint.pl -- Pretty Print Prolog terms
      • atom.pl -- Operations on atoms
      • ctypes.pl -- Character code classification
      • modules.pl -- Module utility predicates
      • occurs.pl -- Finding and counting sub-terms
      • prolog_xref.pl -- Prolog cross-referencer data collection
      • prolog_colour.pl
      • lazy_lists.pl -- Lazy list handling
      • prolog_code.pl -- Utilities for reasoning about code
      • ugraphs.pl -- Graph manipulation library
      • xpath.pl -- Select nodes in an XML DOM
      • iostream.pl -- Utilities to deal with streams
      • doc_http.pl -- Documentation server
      • url.pl -- Analysing and constructing URL
      • www_browser.pl -- Open a URL in the users browser
      • prolog_pack.pl -- A package manager for Prolog
      • prolog_config.pl -- Provide configuration information
      • git.pl -- Run GIT commands
      • strings.pl -- String utilities
      • dif.pl -- The dif/2 constraint
      • dialect.pl -- Support multiple Prolog dialects
      • edinburgh.pl -- Some traditional Edinburgh predicates
      • ansi_term.pl -- Print decorated text to ANSI consoles
      • terms.pl -- Term manipulation
      • listing.pl -- List programs and pretty print clauses
      • persistency.pl -- Provide persistent dynamic predicates
      • pengines_sandbox.pl -- Declare Pengine interaction sandbox-safe
      • term_to_json.pl
      • prolog_stack.pl -- Examine the Prolog stack
      • prolog_clause.pl -- Get detailed source-information about a clause
      • prolog_breakpoints.pl -- Manage Prolog break-points
      • wfs.pl -- Well Founded Semantics interface
      • mallocinfo.pl -- Memory allocation details
      • chr.pl
      • sort.pl
      • dicts.pl -- Dict utilities
      • varnumbers.pl -- Utilities for numbered terms
      • nb_set.pl -- Non-backtrackable sets
      • rbtrees.pl -- Red black trees
      • prolog_stream.pl -- A stream with Prolog callbacks
      • backcomp.pl -- Backward compatibility
      • charsio.pl -- I/O on Lists of Character Codes
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • base32.pl -- Base32 encoding and decoding
      • date.pl -- Process dates and times
      • heaps.pl -- heaps/priority queues
      • statistics.pl -- Get information about resource usage
      • when.pl -- Conditional coroutining
      • tables.pl -- XSB interface to tables
      • thread.pl -- High level thread primitives
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • mqi.pl
      • optparse.pl -- command line parsing
      • udp_broadcast.pl -- A UDP broadcast proxy
      • make.pl -- Reload modified source files
      • sgml_write.pl -- XML/SGML writer module
      • macros.pl -- Macro expansion
      • check.pl -- Consistency checking
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • redis_streams.pl -- Using Redis streams
      • redis.pl -- Redis client
      • isub.pl -- isub: a string similarity measure
      • stomp.pl -- STOMP client.
      • doc_latex.pl -- PlDoc LaTeX backend
      • system.pl -- System utilities
      • odbc.pl
      • oset.pl -- Ordered set manipulation
      • plunit.pl -- Unit Testing
      • prolog_versions.pl -- Demand specific Prolog versions
      • doc_files.pl -- Create stand-alone documentation files
      • editline.pl -- BSD libedit based command line editing
        • el_wrap/0
        • el_wrap/4
        • el_setup/1
        • el_wrapped/1
        • el_unwrap/1
        • el_source/2
        • el_bind/2
        • el_addfn/4
        • el_line/2
        • el_cursor/2
        • el_insertstr/2
        • el_deletestr/2
        • el_history/2
        • el_history_events/2
        • el_add_history/2
        • el_read_history/2
        • el_write_history/2
      • prolog_debug.pl -- User level debugging tools
      • unicode.pl -- Unicode string handling
      • prolog_codewalk.pl -- Prolog code walker
      • threadutil.pl -- Interactive thread utilities
      • edit.pl -- Editor interface
      • explain.pl -- Describe Prolog Terms
      • writef.pl -- Old-style formatted write
      • quintus.pl -- Quintus compatibility
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • pwp.pl -- Prolog Well-formed Pages
      • crypt.pl
      • streams.pl -- Manage Prolog streams
      • help.pl -- Text based manual
      • paxos.pl -- A Replicated Data Store
      • xmldsig.pl -- XML Digital signature
      • archive.pl -- Access several archive formats
      • rdf.pl -- RDF/XML parser
      • readline.pl -- GNU readline interface
      • prolog_trace.pl -- Print access to predicates
      • prolog_wrap.pl -- Wrapping predicates
      • shell.pl -- Elementary shell commands
      • hashtable.pl -- Hash tables
      • table.pl
      • increval.pl -- Incremental dynamic predicate modification
      • intercept.pl -- Intercept and signal interface
      • c14n2.pl -- C14n2 canonical XML documents
      • prolog_profile.pl -- Execution profiler
      • streampool.pl -- Input multiplexing
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • portray_text.pl -- Portray text
      • prolog_autoload.pl -- Autoload all dependencies
      • rewrite_term.pl
      • xsdp_types.pl -- XML-Schema primitive types
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • prolog_history.pl -- Per-directory persistent commandline history
      • double_metaphone.pl -- Phonetic string matching
      • test_cover.pl -- Clause coverage analysis
      • rdf_triple.pl -- Create triples from intermediate representation
      • rdf_parser.pl
      • tty.pl -- Terminal operations
      • cgi.pl -- Read CGI parameters
      • fastrw.pl -- Fast reading and writing of terms
      • yaml.pl -- Process YAML data
      • rwlocks.pl -- Read/write locks
      • xmlenc.pl -- XML encryption library
      • files.pl
      • rlimit.pl
      • prolog_metainference.pl -- Infer meta-predicate properties
      • readln.pl -- Read line as list of tokens
 el_addfn(+Input:stream, +Command, +Help, :Goal) is det
Add a new command to the command line editor associated with Input. Command is the name of the command, Help is the help string printed with e.g. bind -a (see el_bind/2) and Goal is called of the associated key-binding is activated. Goal is called as
call(:Goal, +Input, +Char, -Continue)

where Input is the input stream providing access to the editor, Char the activating character and Continue must be instantated with one of the known continuation codes as defined by libedit: norm, newline, eof, arghack, refresh, refresh_beep, cursor, redisplay, error or fatal. In addition, the following Continue code is provided.

electric(Move, TimeOut, Continue)
Show electric caret at Move positions to the left of the normal cursor positions for the given TimeOut. Continue as defined by the Continue value.

The registered Goal typically used el_line/2 to fetch the input line and el_cursor/2, el_insertstr/2 and/or el_deletestr/2 to manipulate the input line.

Normally el_bind/2 is used to associate the defined command with a keyboard sequence.

See also
- el_set(3) EL_ADDFN for details.