This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
yap-6.3/Logtalk/manuals/refman/index.html
pmoura 4569fca292 Logtalk 2.29.5 files.
git-svn-id: https://yap.svn.sf.net/svnroot/yap/trunk@1858 b08c6af1-5177-4d33-ba66-4b1c6b8b522a
2007-03-28 22:44:31 +00:00

310 lines
24 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="content-type" content="application/xml+xhtml; charset=utf-8" />
<title>Logtalk: Reference Manual</title>
<link rel="stylesheet" href="../screen.css" type="text/css" media="screen"/>
<link rel="stylesheet" href="../print.css" type="text/css" media="print"/>
</head>
<body>
<div class="top-left">Logtalk reference manual</div>
<div class="top-right">Glossary</div>
<div class="bottom-left"><span class="page"/></div>
<div class="bottom-right"><span class="page"/></div>
<div class="navtop"><a href="../index.html">contents</a></div>
<h1>Reference Manual</h1>
<h2><a href="grammar.html">Grammar</a></h2>
<dl class="toc-entries">
<dt><a href="grammar.html#compilation_units">Compilation units</a><span class="leader"></span><span class="page-ref"><span class="grammar_compilation_units"></span></span></dt>
<dd><a href="grammar.html#object_definition">Object definition</a><span class="leader"></span><span class="page-ref"><span class="grammar_object_definition"></span></span></dd>
<dd><a href="grammar.html#category_definition">Category definition</a><span class="leader"></span><span class="page-ref"><span class="grammar_category_definition"></span></span></dd>
<dd><a href="grammar.html#protocol_definition">Protocol definition</a><span class="leader"></span><span class="page-ref"><span class="grammar_protocol_definition"></span></span></dd>
</dl>
<dl class="toc-entries">
<dt><a href="grammar.html#entity_relations">Entity relations</a><span class="leader"></span><span class="page-ref"><span class="grammar_entity_relations"></span></span></dt>
<dd><a href="grammar.html#implemented_protocols">Implemented protocols</a><span class="leader"></span><span class="page-ref"><span class="grammar_implemented_protocols"></span></span></dd>
<dd><a href="grammar.html#extended_protocols">Extended protocols</a><span class="leader"></span><span class="page-ref"><span class="grammar_extended_protocols"></span></span></dd>
<dd><a href="grammar.html#imported_categories">Imported categories</a><span class="leader"></span><span class="page-ref"><span class="grammar_imported_categories"></span></span></dd>
<dd><a href="grammar.html#extended_objects">Extended objects</a><span class="leader"></span><span class="page-ref"><span class="grammar_extended_objects"></span></span></dd>
<dd><a href="grammar.html#instantiated_objects">Instantiated objects</a><span class="leader"></span><span class="page-ref"><span class="grammar_instantiated_objects"></span></span></dd>
<dd><a href="grammar.html#specialized_objects">Specialized objects</a><span class="leader"></span><span class="page-ref"><span class="grammar_specialized_objects"></span></span></dd>
<dd><a href="grammar.html#scope">Entity scope</a><span class="leader"></span><span class="page-ref"><span class="grammar_scope"></span></span></dd>
</dl>
<dl class="toc-entries">
<dt><a href="grammar.html#entity_identifiers">Entity identifiers</a><span class="leader"></span><span class="page-ref"><span class="grammar_entity_identifiers"></span></span></dt>
<dd><a href="grammar.html#object_identifiers">Object identifiers</a><span class="leader"></span><span class="page-ref"><span class="grammar_object_identifiers"></span></span></dd>
<dd><a href="grammar.html#category_identifiers">Category identifiers</a><span class="leader"></span><span class="page-ref"><span class="grammar_category_identifiers"></span></span></dd>
<dd><a href="grammar.html#protocol_identifiers">Protocol identifiers</a><span class="leader"></span><span class="page-ref"><span class="grammar_protocol_identifiers"></span></span></dd>
</dl>
<dl class="toc-entries">
<dt><a href="grammar.html#source_file_names">Source file names</a><span class="leader"></span><span class="page-ref"><span class="grammar_source_file_names"></span></span></dt>
</dl>
<dl class="toc-entries">
<dt><a href="grammar.html#directives">Directives</a><span class="leader"></span><span class="page-ref"><span class="grammar_directives"></span></span></dt>
<dd><a href="grammar.html#object_directives">Object directives</a><span class="leader"></span><span class="page-ref"><span class="grammar_object_directives"></span></span></dd>
<dd><a href="grammar.html#category_directives">Category directives</a><span class="leader"></span><span class="page-ref"><span class="grammar_category_directives"></span></span></dd>
<dd><a href="grammar.html#protocol_directives">Protocol directives</a><span class="leader"></span><span class="page-ref"><span class="grammar_protocol_directives"></span></span></dd>
<dd><a href="grammar.html#predicate_directives">Predicate directives</a><span class="leader"></span><span class="page-ref"><span class="grammar_predicate_directives"></span></span></dd>
</dl>
<dl class="toc-entries">
<dt><a href="grammar.html#clauses">Clauses</a><span class="leader"></span><span class="page-ref"><span class="grammar_clauses"></span></span></dt>
</dl>
<dl class="toc-entries">
<dt><a href="grammar.html#entity_properties">Entity properties</a><span class="leader"></span><span class="page-ref"><span class="grammar_entity_properties"></span></span></dt>
</dl>
<dl class="toc-entries">
<dt><a href="grammar.html#predicate_properties">Predicate properties</a><span class="leader"></span><span class="page-ref"><span class="grammar_predicate_properties"></span></span></dt>
</dl>
<h2>Directives</h2>
<h3>Source file directives</h3>
<dl class="toc-entries">
<dt><code><a href="directives/encoding1.html">encoding/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_encoding1"></span></span></dt>
</dl>
<h3>Entity directives</h3>
<dl class="toc-entries">
<dt><code><a href="directives/calls1.html">calls/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_calls1"></span></span></dt>
<dt><code><a href="directives/category1_3.html">category/1-3</a></code><span class="leader"></span><span class="page-ref"><span class="directives_category1_3"></span></span></dt>
<dt><code><a href="directives/dynamic0.html">dynamic/0</a></code><span class="leader"></span><span class="page-ref"><span class="directives_dynamic0"></span></span></dt>
<dt><code><a href="directives/end_category0.html">end_category/0</a></code><span class="leader"></span><span class="page-ref"><span class="directives_end_category0"></span></span></dt>
<dt><code><a href="directives/end_object0.html">end_object/0</a></code><span class="leader"></span><span class="page-ref"><span class="directives_end_object0"></span></span></dt>
<dt><code><a href="directives/end_protocol0.html">end_protocol/0</a></code><span class="leader"></span><span class="page-ref"><span class="directives_end_protocol0"></span></span></dt>
<dt><code><a href="directives/info1.html">info/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_info1"></span></span></dt>
<dt><code><a href="directives/initialization1.html">initialization/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_initialization1"></span></span></dt>
<dt><code><a href="directives/object1_5.html">object/1-5</a></code><span class="leader"></span><span class="page-ref"><span class="directives_object1_5"></span></span></dt>
<dt><code><a href="directives/protocol1_2.html">protocol/1-2</a></code><span class="leader"></span><span class="page-ref"><span class="directives_protocol1_2"></span></span></dt>
<dt><code><a href="directives/synchronized0.html">synchronized/0</a></code><span class="leader"></span><span class="page-ref"><span class="directives_synchronized0"></span></span></dt>
<dt><code><a href="directives/threaded0.html">threaded/0</a></code><span class="leader"></span><span class="page-ref"><span class="directives_threaded0"></span></span></dt>
<dt><code><a href="directives/uses1.html">uses/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_uses1"></span></span></dt>
</dl>
<h3>Predicate directives</h3>
<dl class="toc-entries">
<dt><code><a href="directives/alias3.html">alias/3</a></code><span class="leader"></span><span class="page-ref"><span class="directives_alias3"></span></span></dt>
<dt><code><a href="directives/discontiguous1.html">discontiguous/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_discontiguous1"></span></span></dt>
<dt><code><a href="directives/dynamic1.html">dynamic/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_dynamic1"></span></span></dt>
<dt><code><a href="directives/info2.html">info/2</a></code><span class="leader"></span><span class="page-ref"><span class="directives_info2"></span></span></dt>
<dt><code><a href="directives/meta_predicate1.html">meta_predicate/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_meta_predicate1"></span></span></dt>
<dt><code><a href="directives/mode2.html">mode/2</a></code><span class="leader"></span><span class="page-ref"><span class="directives_mode2"></span></span></dt>
<dt><code><a href="directives/op3.html">op/3</a></code><span class="leader"></span><span class="page-ref"><span class="directives_op3"></span></span></dt>
<dt><code><a href="directives/private1.html">private/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_private1"></span></span></dt>
<dt><code><a href="directives/protected1.html">protected/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_protected1"></span></span></dt>
<dt><code><a href="directives/public1.html">public/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_public1"></span></span></dt>
<dt><code><a href="directives/synchronized1.html">synchronized/1</a></code><span class="leader"></span><span class="page-ref"><span class="directives_synchronized1"></span></span></dt>
<dt><code><a href="directives/uses2.html">uses/2</a></code><span class="leader"></span><span class="page-ref"><span class="directives_uses2"></span></span></dt>
</dl>
<h2>Built-in predicates</h2>
<h3>Enumerating objects, categories and protocols</h3>
<dl class="toc-entries">
<dt><code><a href="builtins/current_category1.html">current_category/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_current_category1"></span></span></dt>
<dt><code><a href="builtins/current_object1.html">current_object/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_current_object1"></span></span></dt>
<dt><code><a href="builtins/current_protocol1.html">current_protocol/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_current_protocol1"></span></span></dt>
</dl>
<h3>Enumerating objects, categories and protocols properties</h3>
<dl class="toc-entries">
<dt><code><a href="builtins/category_property2.html">category_property/2</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_category_property2"></span></span></dt>
<dt><code><a href="builtins/object_property2.html">object_property/2</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_object_property2"></span></span></dt>
<dt><code><a href="builtins/protocol_property2.html">protocol_property/2</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_protocol_property2"></span></span></dt>
</dl>
<h3>Creating new objects, categories and protocols</h3>
<dl class="toc-entries">
<dt><code><a href="builtins/create_category4.html">create_category/4</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_create_category4"></span></span></dt>
<dt><code><a href="builtins/create_object4.html">create_object/4</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_create_object4"></span></span></dt>
<dt><code><a href="builtins/create_protocol3.html">create_protocol/3</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_create_protocol3"></span></span></dt>
</dl>
<h3>Abolishing objects, categories and protocols</h3>
<dl class="toc-entries">
<dt><code><a href="builtins/abolish_category1.html">abolish_category/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_abolish_category1"></span></span></dt>
<dt><code><a href="builtins/abolish_object1.html">abolish_object/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_abolish_object1"></span></span></dt>
<dt><code><a href="builtins/abolish_protocol1.html">abolish_protocol/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_abolish_protocol1"></span></span></dt>
</dl>
<h3>Objects, categories and protocols relations</h3>
<dl class="toc-entries">
<dt><code><a href="builtins/extends_object2_3.html">extends_object/2-3</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_extends_object2_3"></span></span></dt>
<dt><code><a href="builtins/extends_protocol2_3.html">extends_protocol/2-3</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_extends_protocol2_3"></span></span></dt>
<dt><code><a href="builtins/implements_protocol2_3.html">implements_protocol/2-3</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_implements_protocol2_3"></span></span></dt>
<dt><code><a href="builtins/imports_category2_3.html">imports_category/2-3</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_imports_category2_3"></span></span></dt>
<dt><code><a href="builtins/instantiates_class2_3.html">instantiates_class/2-3</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_instantiates_class2_3"></span></span></dt>
<dt><code><a href="builtins/specializes_class2_3.html">specializes_class/2-3</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_specializes_class2_3"></span></span></dt>
</dl>
<h3>Event handling</h3>
<dl class="toc-entries">
<dt><code><a href="builtins/abolish_events5.html">abolish_events/5</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_abolish_events5"></span></span></dt>
<dt><code><a href="builtins/current_event5.html">current_event/5</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_current_event5"></span></span></dt>
<dt><code><a href="builtins/define_events5.html">define_events/5</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_define_events5"></span></span></dt>
</dl>
<h3>Multi-threading meta-predicates</h3>
<dl class="toc-entries">
<dt><code><a href="builtins/threaded1.html">threaded/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_threaded1"></span></span></dt>
</dl>
<dl class="toc-entries">
<dt><code><a href="builtins/threaded_call1.html">threaded_call/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_threaded_call1"></span></span></dt>
<dt><code><a href="builtins/threaded_once1.html">threaded_once/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_threaded_once1"></span></span></dt>
<dt><code><a href="builtins/threaded_ignore1.html">threaded_ignore/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_threaded_ignore1"></span></span></dt>
<dt><code><a href="builtins/threaded_race1.html">threaded_race/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_threaded_race1"></span></span></dt>
</dl>
<dl class="toc-entries">
<dt><code><a href="builtins/threaded_exit1.html">threaded_exit/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_threaded_exit1"></span></span></dt>
<dt><code><a href="builtins/threaded_peek1.html">threaded_peek/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_threaded_peek1"></span></span></dt>
</dl>
<dl class="toc-entries">
<dt><code><a href="builtins/threaded_wait1.html">threaded_wait/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_threaded_wait1"></span></span></dt>
<dt><code><a href="builtins/threaded_notify1.html">threaded_notify/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_threaded_notify1"></span></span></dt>
</dl>
<h3>Compiling and loading objects, categories and protocols</h3>
<dl class="toc-entries">
<dt><code><a href="builtins/logtalk_compile1.html">logtalk_compile/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_logtalk_compile1"></span></span></dt>
<dt><code><a href="builtins/logtalk_compile2.html">logtalk_compile/2</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_logtalk_compile2"></span></span></dt>
<dt><code><a href="builtins/logtalk_load1.html">logtalk_load/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_logtalk_load1"></span></span></dt>
<dt><code><a href="builtins/logtalk_load2.html">logtalk_load/2</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_logtalk_load2"></span></span></dt>
<dt><code><a href="builtins/logtalk_library_path2.html">logtalk_library_path/2</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_logtalk_library_path2"></span></span></dt>
</dl>
<h3>Flags</h3>
<dl class="toc-entries">
<dt><code><a href="builtins/current_logtalk_flag2.html">current_logtalk_flag/2</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_current_logtalk_flag2"></span></span></dt>
<dt><code><a href="builtins/set_logtalk_flag2.html">set_logtalk_flag/2</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_set_logtalk_flag2"></span></span></dt>
</dl>
<h3>Others</h3>
<dl class="toc-entries">
<dt><code><a href="builtins/forall2.html">forall/2</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_forall2"></span></span></dt>
<dt><code><a href="builtins/retractall1.html">retractall/1</a></code><span class="leader"></span><span class="page-ref"><span class="builtins_retractall1"></span></span></dt>
</dl>
<h2>Built-in methods</h2>
<h3>Local methods</h3>
<dl class="toc-entries">
<dt><code><a href="methods/parameter2.html">parameter/2</a></code><span class="leader"></span><span class="page-ref"><span class="methods_parameter2"></span></span></dt>
<dt><code><a href="methods/self1.html">self/1</a></code><span class="leader"></span><span class="page-ref"><span class="methods_self1"></span></span></dt>
<dt><code><a href="methods/sender1.html">sender/1</a></code><span class="leader"></span><span class="page-ref"><span class="methods_sender1"></span></span></dt>
<dt><code><a href="methods/this1.html">this/1</a></code><span class="leader"></span><span class="page-ref"><span class="methods_this1"></span></span></dt>
</dl>
<h3>Reflection methods</h3>
<dl class="toc-entries">
<dt><code><a href="methods/current_predicate1.html">current_predicate/1</a></code><span class="leader"></span><span class="page-ref"><span class="methods_current_predicate1"></span></span></dt>
<dt><code><a href="methods/predicate_property2.html">predicate_property/2</a></code><span class="leader"></span><span class="page-ref"><span class="methods_predicate_property2"></span></span></dt>
</dl>
<h3>Database methods</h3>
<dl class="toc-entries">
<dt><code><a href="methods/abolish1.html">abolish/1</a></code><span class="leader"></span><span class="page-ref"><span class="methods_abolish1"></span></span></dt>
<dt><code><a href="methods/asserta1.html">asserta/1</a></code><span class="leader"></span><span class="page-ref"><span class="methods_asserta1"></span></span></dt>
<dt><code><a href="methods/assertz1.html">assertz/1</a></code><span class="leader"></span><span class="page-ref"><span class="methods_assertz1"></span></span></dt>
<dt><code><a href="methods/clause2.html">clause/2</a></code><span class="leader"></span><span class="page-ref"><span class="methods_clause2"></span></span></dt>
<dt><code><a href="methods/retract1.html">retract/1</a></code><span class="leader"></span><span class="page-ref"><span class="methods_retract1"></span></span></dt>
<dt><code><a href="methods/retractall1.html">retractall/1</a></code><span class="leader"></span><span class="page-ref"><span class="methods_retractall1"></span></span></dt>
</dl>
<h3>Meta-call methods</h3>
<dl class="toc-entries">
<dt><code><a href="methods/call1.html">call/N</a></code><span class="leader"></span><span class="page-ref"><span class="methods_call1"></span></span></dt>
</dl>
<h3>All solutions methods</h3>
<dl class="toc-entries">
<dt><code><a href="methods/bagof3.html">bagof/3</a></code><span class="leader"></span><span class="page-ref"><span class="methods_bagof3"></span></span></dt>
<dt><code><a href="methods/findall3.html">findall/3</a></code><span class="leader"></span><span class="page-ref"><span class="methods_findall3"></span></span></dt>
<dt><code><a href="methods/forall2.html">forall/2</a></code><span class="leader"></span><span class="page-ref"><span class="methods_forall2"></span></span></dt>
<dt><code><a href="methods/setof3.html">setof/3</a></code><span class="leader"></span><span class="page-ref"><span class="methods_setof3"></span></span></dt>
</dl>
<h3>Event handler methods</h3>
<dl class="toc-entries">
<dt><code><a href="methods/before3.html">before/3</a></code><span class="leader"></span><span class="page-ref"><span class="methods_before3"></span></span></dt>
<dt><code><a href="methods/after3.html">after/3</a></code><span class="leader"></span><span class="page-ref"><span class="methods_after3"></span></span></dt>
</dl>
<h3>DCG rules parsing methods</h3>
<dl class="toc-entries">
<dt><code><a href="methods/phrase2.html">phrase/2</a></code><span class="leader"></span><span class="page-ref"><span class="methods_phrase2"></span></span></dt>
<dt><code><a href="methods/phrase3.html">phrase/3</a></code><span class="leader"></span><span class="page-ref"><span class="methods_phrase3"></span></span></dt>
</dl>
<h3>Term expansion methods</h3>
<dl class="toc-entries">
<dt><code><a href="methods/expand_term2.html">expand_term/2</a></code><span class="leader"></span><span class="page-ref"><span class="methods_expand_term2"></span></span></dt>
<dt><code><a href="methods/term_expansion2.html">term_expansion/2</a></code><span class="leader"></span><span class="page-ref"><span class="methods_term_expansion2"></span></span></dt>
</dl>
<h2>Control constructs</h2>
<h3>Message sending</h3>
<dl class="toc-entries">
<dt><code><a href="control/to_object2.html">::/2</a></code><span class="leader"></span><span class="page-ref"><span class="control_to_object2"></span></span></dt>
<dt><code><a href="control/to_self1.html">::/1</a></code><span class="leader"></span><span class="page-ref"><span class="control_to_self1"></span></span></dt>
<dt><code><a href="control/to_super1.html">^^/1</a></code><span class="leader"></span><span class="page-ref"><span class="control_to_super1"></span></span></dt>
</dl>
<h3>Calling external code</h3>
<dl class="toc-entries">
<dt><code><a href="control/external1.html">{}/1</a></code><span class="leader"></span><span class="page-ref"><span class="control_external1"></span></span></dt>
</dl>
<div class="footer">
<div class="copyright">
<span>Copyright &copy; <a href="mailto:pmoura@logtalk.org">Paulo Moura</a> &mdash; <a href="http://logtalk.org">Logtalk.org</a></span><br/>
<span>Last updated on: March 24, 2007</span>
</div>
<div class="navbottom">
<span><a href="../glossary.html">glossary</a></span><br/>
<span><a href="http://validator.w3.org/check/referer">XHTML</a> + <a href="http://jigsaw.w3.org/css-validator/check/referer">CSS</a></span>
</div>
</div>
</body>
</html>