- swipl
- library
- error.pl
- debug.pl -- Print debug messages and test assertions
- apply.pl -- Apply predicates on a list
- lists.pl
- broadcast.pl
- predicate_options.pl
- shlib.pl
- option.pl -- Option list processing
- thread_pool.pl
- gensym.pl -- Generate unique symbols
- settings.pl -- Setting management
- arithmetic.pl -- Extensible arithmetic
- main.pl -- Provide entry point for scripts
- readutil.pl -- Read utilities
- operators.pl -- Manage operators
- pairs.pl -- Operations on key-value lists
- prolog_source.pl -- Examine Prolog source-files
- quasi_quotations.pl -- Define Quasi Quotation syntax
- url.pl -- Analysing and constructing URL
- www_browser.pl -- Open a URL in the users browser
- prolog_colour.pl -- Prolog syntax colouring support.
- record.pl -- Access compound arguments by name
- prolog_xref.pl -- Prolog cross-referencer data collection
- occurs.pl -- Finding and counting sub-terms
- ordsets.pl -- Ordered set manipulation
- assoc.pl -- Binary associations
- ugraphs.pl -- Graph manipulation library
- iostream.pl -- Utilities to deal with streams
- atom.pl -- Operations on atoms
- prolog_pack.pl -- A package manager for Prolog
- solution_sequences.pl -- Modify solution sequences
- git.pl -- Run GIT commands
- ctypes.pl -- Character code classification
- utf8.pl -- UTF-8 encoding/decoding on lists of character codes.
- base64.pl -- Base64 encoding and decoding
- persistency.pl -- Provide persistent dynamic predicates
- pure_input.pl -- Pure Input from files and streams
- nb_set.pl -- Non-backtrackable sets
- aggregate.pl -- Aggregation operators on backtrackable predicates
- csv.pl -- Process CSV (Comma-Separated Values) data
- dialect.pl -- Support multiple Prolog dialects
- apply_macros.pl -- Goal expansion rules to avoid meta-calling
- yall.pl -- Lambda expressions
- prolog_code.pl -- Utilities for reasoning about code
- dif.pl -- The dif/2 constraint
- thread.pl -- High level thread primitives
- rbtrees.pl -- Red black trees
- nb_rbtrees.pl -- Non-backtrackable operations on red black trees
- random.pl -- Random numbers
- sandbox.pl -- Sandboxed Prolog code
- prolog_format.pl -- Analyse format specifications
- pprint.pl -- Pretty Print Prolog terms
- modules.pl -- Module utility predicates
- lazy_lists.pl -- Lazy list handling
- edinburgh.pl -- Some traditional Edinburgh predicates
- prolog_clause.pl -- Get detailed source-information about a clause
- prolog_breakpoints.pl -- Manage Prolog break-points
- dicts.pl -- Dict utilities
- prolog_profile.pl -- Execution profiler
- backcomp.pl -- Backward compatibility
- date.pl -- Process dates and times
- listing.pl -- List programs and pretty print clauses
- quintus.pl -- Quintus compatibility
- terms.pl -- Term manipulation
- prolog_codewalk.pl -- Prolog code walker
- prolog_metainference.pl -- Infer meta-predicate properties
- prolog_jiti.pl -- Just In Time Indexing (JITI) utilities
- system.pl -- System utilities
- check.pl -- Consistency checking
- tables.pl -- XSB interface to tables
- prolog_debug.pl -- User level debugging tools
- optparse.pl -- command line parsing
- threadutil.pl -- Interactive thread utilities
- ansi_term.pl -- Print decorated text to ANSI consoles
- increval.pl -- Incremental dynamic predicate modification
- rwlocks.pl -- Read/write locks
- prolog_trace.pl -- Print access to predicates
- prolog_wrap.pl -- Wrapping predicates
- prolog_stack.pl -- Examine the Prolog stack
- statistics.pl -- Get information about resource usage
- portray_text.pl -- Portray text
- coinduction.pl -- Co-Logic Programming
- sort.pl
- heaps.pl -- heaps/priority queues
- tty.pl -- Terminal operations
- hashtable.pl -- Hash tables
- writef.pl -- Old-style formatted write
- files.pl
- explain.pl -- Describe Prolog Terms
- wfs.pl -- Well Founded Semantics interface
- base32.pl -- Base32 encoding and decoding
- charsio.pl -- I/O on Lists of Character Codes
- codesio.pl -- I/O on Lists of Character Codes
- varnumbers.pl -- Utilities for numbered terms
- when.pl -- Conditional coroutining
- oset.pl -- Ordered set manipulation
- help.pl -- Text based manual
- exceptions.pl -- Exception classification
- edit.pl -- Editor interface
- make.pl -- Reload modified source files
- zip.pl -- Access resource ZIP archives
- prolog_coverage.pl -- Coverage analysis tool
- intercept.pl -- Intercept and signal interface
- strings.pl -- String utilities
- fastrw.pl -- Fast reading and writing of terms
- qsave.pl -- Save current program as a state or executable
- prolog_autoload.pl -- Autoload all dependencies
- streams.pl -- Manage Prolog streams
- win_menu.pl -- Console window menu
- prolog_history.pl -- Per-directory persistent commandline history
- prolog_config.pl -- Provide configuration information
- shell.pl -- Elementary shell commands
- prolog_versions.pl -- Demand specific (Prolog) versions
- macros.pl -- Macro expansion
- library
- argv_options(:Argv, -Positional, -Options) is det
- Parse command line arguments. This predicate acts in one of two
modes.
- If the calling module defines opt_type/3, full featured parsing with long and short options, type conversion and help is provided.
- If opt_type/3 is not defined, only unguided transformation using long options is supported. See argv_untyped_options/3 for details.
When guided, three predicates are called in the calling module. opt_type/3 must be defined, the others need not. Note that these three predicates may be defined as multifile to allow multiple modules contributing to the provided commandline options. Defining them as discontiguous allows for creating blocks that describe a group of related options.
- opt_type(Opt, Name, Type)
- Defines Opt to add an option Name(Value), where Value statisfies
Type. Opt does not include the leading
-
. A single character implies a short option, multiple a long option. Long options use_
as word separator, user options may use either_
or-
. Type is one of:- A | B
- Disjunctive type. Disjunction can be used create long
options with optional values. For example, using the type
nonneg|boolean
, for an optionhttp
handles--http
ashttp(true)
,--no-http
ashttp(false)
and--http=3000
ashttp(3000)
. Note that with an optional boolean a option is considered boolean unless it has a value written as--longopt=value
. - boolean(Default)
- boolean
- Boolean options are special. They do not take a value except
for when using the long
--opt=value
notation. This explicit value specification convertstrue
,True
,TRUE
,on
,On
,ON
,1
and the obvious false equivalents to Prologtrue
orfalse
. If the option is specified, Default is used. If--no-opt
or--noopt
is used, the inverse of Default is used. - integer
- Argument is converted to an integer
- float
- Argument is converted to a float. User may specify an integer
- nonneg
- As
integer
. Requires value >= 0. - natural
- As
integer
. Requires value >= 1. - number
- Any number (integer, float, rational).
- between(Low, High)
- If both one of Low and High is a float, convert as
float
, else convert asinteger
. Then check the range. - atom
- No conversion
- oneof(List)
- As
atom
, but requires the value to be a member of List (enum type). - string
- Convert to a SWI-Prolog string
- file
- Convert to a file name in Prolog canonical notation using prolog_to_os_filename/2.
- directory
- Convert to a file name in Prolog canonical notation
using prolog_to_os_filename/2. No checking is done and
thus this type is the same as
file
- file(Access)
- As
file
, and check access using access_file/2. A value-
is not checked for access, assuming the application handles this as standard input or output. - directory(Access)
- As
directory
, and check access. Access is one ofread
write
orcreate
. In the latter case the parent directory must exist and have write access. - term
- Parse option value to a Prolog term.
- term(+Options)
- As
term
, but passes Options to term_string/3. If the optionvariable_names(Bindings)
is given the option value is set to the pairTerm-Bindings
.
- opt_help(Name, HelpString)
- Help string used by argv_usage/1.
- opt_meta(Name, Meta)
- If a typed argument is required this defines the placeholder
in the help message. The default is the uppercase version of
the type functor name. This produces the
FILE
in e.g.-f FILE
.
By default,
-h
,-?
and--help
are bound to help. Ifopt_type(Opt, help, boolean)
is true for some Opt, the default help binding and help message are disabled and the normal user rules apply. In particular, the user should also provide a rule foropt_help(help, String)
.