lib

Prolog files

attvar.pl
get_attr/2	Get the attribute on the current module.
put_attr/2	Put an attribute on the current module.
authenticate.pl  -- Authentication access for SWISH
authentication_hook/3	Is called from the /pengine/create request to establish the logged in user.
authenticate/2	Establish the identity behind the HTTP Request.
user_property/2	True when Identity has Property.
avatar.pl  -- Avatar management
random_avatar/1	Generate a random avatar image url.
release_avatar/1	Release the avatar to the pool of free avatars.
valid_gravatar/1	True if URL is a real gravatar.
bootstrap.pl  -- Bootstrap form generator
bt_button/6
bt_form/4	Emit a Bootstrap form from Contents.
name_label/2	Determine a label from a name by upcasing the first character and replacing all underscores by spaces.
chat.pl  -- The SWISH collaboration backbone
chatstore.pl  -- Store chat messages
config.pl  -- Make HTTP locations known to JSON code
config/2	Define a name/value pair that will end up in the SWISH config object (see web/js/config.js).
login/2	If a login item with 'data-server'(+Server) is clicked, the HTTP handler with id login is called.
login_item/2	This hook is called to find all possible login options.
source_alias/2	Multifile hook that defines properties of file_search_path/2 aliases wrt.
swish_config/2	Define a name/value pair that will end up in the SWISH config object (see web/js/config.js).
swish_config_hash/2	True if Hash is the SHA1 of the SWISH config.
swish_reply_config/2	Emit a configuration object to the client if the client requests for '.../swish_config.json', regardless of the path prefix.
user_info/3	Each login facility must provide this hook.
content_filter.pl  -- Ban list content filter
eval_content/3	Evaluate the content of Text.
cron.pl  -- Schedule HTTP server maintenance tasks
dashboard.pl  -- Provide non-programmer query execution
parameters/1	Fill query parameters.
data_source.pl  -- Cached data access
download.pl  -- Provide a button for downloading data
examples.pl  -- Serve example files
provides/1	Make examples available through swish_provides/1.
flags.pl
form.pl  -- Form handling utilities
validate_field/4	True when Value is a valid value for Field from Dict according to Options.
validate_form/2	Run validate_field/4 on all specified fields, combining the error message.
gitty.pl  -- Single-file GIT like version system
gitty_driver_bdb.pl  -- Gitty BDB driver
gitty_driver_files.pl  -- Gitty plain files driver
help.pl  -- SWISH help system
highlight.pl  -- Highlight token server
xref_open_source/2	Open a source.
config/2	Provides the object config.swish.style, a JSON object that maps style properties of user-defined extensions of library(prolog_colour).
css/3	Multifile hook to define additional style to apply in a specific context.
current_highlight_state/2	Return info on the current highlighter.
server_tokens/1	These predicates help debugging the server side.
show_mirror/1	These predicates help debugging the server side.
style/3	Declare that we map StyleIn as generated by library(prolog_colour) into a token of type SWISHType, providing additional context information based on Attributes.
token_info/3	Generate HTML, providing details about Token.
html_output.pl  -- SWISH HTML Output
http_version.pl  -- Serve version details over HTTP
include.pl  -- Support :- include(File) from SWISH
xref_source_file/3	Deal with the above expansion for :- include(program) to support the cross-referencer.
include/2	Include file at a specific version.
jquery.pl  -- Call jQuery on the SWISH interface
logging.pl  -- Add SWISH query execution to the HTTP log file
markdown.pl  -- SWISH Notebook markdown support
file/4	Hook that deals with linking other notebooks using the following markdown syntax:.
md_eval.pl  -- Provide evaluable markdown
swish_provides/1	True when Term describes a provided feature of the current SWISH instances.
messages.pl
noble_avatar.pl  -- Noble Avatar generator
create_avatar/2	(Re-)create avatar with basename PNG.
noble_avatar/2	True when File is the image file name for a generated avatar of Gender.
noble_avatar/3	True when File is the image file name for a generated avatar of Gender.
oauth2.pl  -- Oauth2 based login
login/3	Multifile hook to realise the actual login.
oauth2_claim/2	True when Claim is the claim made in TokenInfo.
oauth2_login/2	HTTP handler to login using oauth2.
oauth2_reply/2	HTTP handler for the redirect we get back from the oauth2 server.
oauth2_user_info/3	Given the token details obtained in oauth2_reply/2, get extended information about the user from the identity provider.
oauth2_validate_access_token/3	Validates the AccessToken with Unity (implicit or hybrid flow).
server_attribute/3	Multifile hook that defines available oauth2 servers.
page.pl  -- Provide the SWISH application as Prolog HTML component
logo/3	Hook to include the top-left logos.
pengine_logo/3	Emit an <a> element that provides a link to Pengines and SWISH on this server.
swish_content/3	Generate the SWISH editor, Prolog output area and query editor.
swish_logo/3	Emit an <a> element that provides a link to Pengines and SWISH on this server.
swish_navbar/3	Generate the swish navigation bar.
swish_page/3	Generate the entire SWISH default page.
swish_reply/2	HTTP handler to reply the default SWISH page.
swish_reply_resource/1	Serve /swish/Resource files.
swish_resources/2	Include SWISH CSS and JavaScript.
patch.pl  -- Run patch program
patch/4	Patch the string Orig using Diff.
paths.pl  -- Setup SWISH search paths
pep.pl  -- SWISH PEP (Policy Enforcement Point)
not_sandboxed/2	Called by Pengines to see whether User may call non-sandboxed operations in Application.
approve/3	This hook is called by approve/2 and deny/2 before the default rules.
approve/2
authorized/2	Verify that Action is authorized.
deny/2
ws_authorized/2	True when WSUser is allowed to perform action.
procps.pl  -- Get process statistics from Linux /proc
procps_stat/1	Get data from the stat file of the current process, the process identified by PID or the Prolog thread identified by Thread.
procps_stat/2	Get data from the stat file of the current process, the process identified by PID or the Prolog thread identified by Thread.
procps_status/1	Get the data from /proc/self/status as a Prolog dict.
procps_status/2	Get the data from /proc/self/status as a Prolog dict.
procps_thread_stat/2	Get data from the stat file of the current process, the process identified by PID or the Prolog thread identified by Thread.
profiles.pl
projection.pl  -- Define the projection
projection/1	Specify the result variables.
r_swish.pl
render.pl  -- SWISH term-rendering support
current_renderer/2	True when renderer Name is declared with Comment.
register_renderer/2	Register a module as SWISH rendering component.
use_rendering/1	Register an answer renderer.
use_rendering/2	Register an answer renderer with options.
search.pl  -- SWISH search from the navigation bar
match/3	True if Line matches Query, respecting Options.
search_box/3	Render a Bootstrap search box.
typeahead/4	Find typeahead suggestions for a specific search category (Type).
session.pl  -- Setup SWISH sessions
storage.pl  -- Store files on behalve of web clients
typeahead/4	Find files using typeahead from the SWISH search box.
storage_commit/2	Load the commit data for Hash.
storage_file/1	True if File is known in the store.
storage_file/3	True if File is known in the store.
storage_file_extension/2	True if File is known in the store.
storage_file_extension_head/3	True if File is known in the store.
storage_fsck/0	Enumerate and check the consistency of the entire store.
storage_load_term/2	Add/retrieve terms from the gitty store.
storage_meta_data/2	True if File is known in the store.
storage_meta_property/2	True when Meta has Property.
storage_repack/0	Repack the storage directory.
storage_repack/1	Repack the storage directory.
storage_store_term/2	Add/retrieve terms from the gitty store.
storage_unpack/0	Unpack all packed objects of the store.
use_gitty_file/1	Load a file from the Gitty store.
use_gitty_file/2	Load a file from the Gitty store.
swish_chr.pl  -- Make CHR available in SWISH
swish_csv.pl  -- Support CSV output from a Pengines server
write_result/3	Hook into library(pengines) that makes pengines support CSV output.
swish_debug.pl  -- Print debug messages and test assertions
debug/1	Add/remove a topic from being printed.
list_debug_topics/0	List currently known topics for debug/3 and their setting.
list_debug_topics/1	List currently known topics for debug/3 and their setting.
nodebug/1	Add/remove a topic from being printed.
swish_debug/3	Format a message if debug topic is enabled.
swish_debugging/1	Examine debug topics.
swish_diagnostics.pl
pengine_stale_module/1	True if M seems to be a pengine module with no associated pengine.
pengine_stale_module/2	True if M seems to be a pengine module with no associated pengine.
redis_consumer_status/2	True when Status is a dict describing the current status for Consumer.
stale_pengine/1	True if Pengine is a Pengine who's thread died.
start_swish_stat_collector/0	Start collecting statistical performance information for the running SWISH server.
swish_cluster_member/2
swish_died_thread/2	True if Id is a thread that died with Status and has not (yet) been joined.
swish_save_stats/1	Save statistcs to File or the default file.
swish_statistics/1	True if State is a statistics about SWISH.
swish_stats/2	Get the collected statistics for the given Period.
swish_redis.pl  -- Redis stream connection
template_hint.pl  -- Generate template hints for CondeMirror
trace.pl  --
version.pl  -- Manage software versions
check_prolog_version/1	Validate the program is running under Prolog version Required or newer.
git_module_property/2	Property is a property of the named git-component.
prolog_version_atom/1	Atom describes the current Prolog version.
register_git_module/2	Register the directory from which the Prolog file was loaded as a GIT component about which to report version information.
web.pl  -- Serve /plugin