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

  • swipl
    • library
      • error.pl
      • apply.pl -- Apply predicates on a list
      • lists.pl -- List Manipulation
      • debug.pl
      • broadcast.pl
      • socket.pl
      • predicate_options.pl -- Access and analyse predicate options
      • shlib.pl
      • option.pl
      • uid.pl
      • unix.pl
      • syslog.pl -- Unix syslog interface
      • thread_pool.pl
      • gensym.pl
      • settings.pl
      • arithmetic.pl
      • main.pl -- Provide entry point for scripts
      • readutil.pl
      • ssl.pl
      • 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
      • optparse.pl -- command line parsing
      • prolog_debug.pl -- User level debugging tools
      • threadutil.pl -- Interactive thread utilities
      • nb_set.pl -- Non-backtrackable sets
      • backcomp.pl -- Backward compatibility
      • rbtrees.pl -- Red black trees
      • prolog_stream.pl -- A stream with Prolog callbacks
      • charsio.pl -- I/O on Lists of Character Codes
      • streampool.pl -- Input multiplexing
      • redis.pl -- Redis client
      • redis_streams.pl -- Using Redis streams
      • prolog_codewalk.pl -- Prolog code walker
      • prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
      • prolog_metainference.pl -- Infer meta-predicate properties
      • intercept.pl -- Intercept and signal interface
      • c14n2.pl -- C14n2 canonical XML documents
      • sgml_write.pl -- XML/SGML writer module
      • prolog_autoload.pl -- Autoload all dependencies
      • check.pl -- Consistency checking
      • mqi.pl
      • thread.pl -- High level thread primitives
      • make.pl -- Reload modified source files
      • rdf_write.pl -- Write RDF/XML from a list of triples
      • paxos.pl -- A Replicated Data Store
      • 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
      • heaps.pl -- heaps/priority queues
      • base32.pl -- Base32 encoding and decoding
      • codesio.pl -- I/O on Lists of Character Codes
      • coinduction.pl -- Co-Logic Programming
      • date.pl -- Process dates and times
      • statistics.pl -- Get information about resource usage
      • when.pl -- Conditional coroutining
      • odbc.pl
      • portray_text.pl -- Portray text
      • doc_latex.pl -- PlDoc LaTeX backend
      • udp_broadcast.pl -- A UDP broadcast proxy
      • qsave.pl -- Save current program as a state or executable
      • zip.pl -- Access resource ZIP archives
      • plunit.pl -- Unit Testing
      • edit.pl -- Editor interface
      • increval.pl -- Incremental dynamic predicate modification
      • tables.pl -- XSB interface to tables
      • yaml.pl -- Process YAML data
      • protobufs.pl -- Google's Protocol Buffers ("protobufs")
      • prolog_wrap.pl -- Wrapping predicates
      • table.pl
      • isub.pl -- isub: a string similarity measure
      • rdf_triple.pl -- Create triples from intermediate representation
      • rdf_parser.pl
      • rewrite_term.pl
      • xsdp_types.pl -- XML-Schema primitive types
      • xmlenc.pl -- XML encryption library
      • prolog_profile.pl -- Execution profiler
      • xmldsig.pl -- XML Digital signature
      • stomp.pl -- STOMP client.
      • snowball.pl -- The Snowball multi-lingual stemmer library
      • archive.pl -- Access several archive formats
      • crypt.pl
      • readline.pl -- GNU readline interface
      • hashtable.pl -- Hash tables
      • unicode.pl -- Unicode string handling
      • double_metaphone.pl -- Phonetic string matching
      • rdf.pl -- RDF/XML parser
      • prolog_trace.pl -- Print access to predicates
      • utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
      • writef.pl -- Old-style formatted write
      • fastrw.pl -- Fast reading and writing of terms
      • prolog_history.pl -- Per-directory persistent commandline history
      • system.pl -- System utilities
      • quintus.pl -- Quintus compatibility
      • shell.pl -- Elementary shell commands
      • macros.pl -- Macro expansion
      • streams.pl -- Manage Prolog streams
      • test_cover.pl -- Clause coverage analysis
      • doc_files.pl -- Create stand-alone documentation files
      • rwlocks.pl -- Read/write locks
      • readln.pl -- Read line as list of tokens
      • help.pl -- Text based manual
      • files.pl
      • explain.pl -- Describe Prolog Terms
      • prolog_versions.pl -- Demand specific Prolog versions
      • rlimit.pl
      • oset.pl -- Ordered set manipulation
      • cgi.pl -- Read CGI parameters
      • pwp.pl -- Prolog Well-formed Pages
 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.