Changeset 4599 for trunk/manuals/refman

Timestamp:

11/21/08 12:47:26 (7 weeks ago)

Author:

pmoura

Message:

Added an expand_goal/2 built-in method to support explicit calls to the goal_expansion/2 user-defined hook. Updated the term expansion mechanism to allow the expansion to be a single term instead of a list of terms. Improved the documentation of the term and goal expansion predicates.

Added syntax coloring support for the new expand_goal/2 method to the supported text editors and syntax highlighters.

Location:

trunk/manuals/refman

Files:

• index.html (modified) (2 diffs)
• methods/expand_term2.html (modified) (2 diffs)
• methods/goal_expansion2.html (modified) (2 diffs)
• methods/term_expansion2.html (modified) (2 diffs)
• refman.header (modified) (1 diff)

trunk/manuals/refman/index.html

@@ -294 +294 @@
 </dl>
 
-<h3>Term expansion methods</h3>
+<h3>Term and goal 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>
+    <dt><code><a href="methods/expand_goal2.html">expand_goal/2</a></code><span class="leader"></span><span class="page-ref"><span class="methods_expand_goal2"></span></span></dt>
     <dt><code><a href="methods/goal_expansion2.html">goal_expansion/2</a></code><span class="leader"></span><span class="page-ref"><span class="methods_goal_expansion2"></span></span></dt>
 </dl>
@@ -333 +334 @@
     <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: November 7, 2008</span>
+        <span>Last updated on: November 21, 2008</span>
     </div>
     <div class="navbottom">

trunk/manuals/refman/methods/expand_term2.html

@@ -29 +29 @@
 </p>
 <p>
-The expansion works as follows: if the first argument is a variable, then it is unified with the second argument; if the first argument is not a variable and clauses for the <code>term_expansion/2</code> predicate are within scope, then this predicate is called to provide an expansion that is then unified with the second argument; if the <code>term_expansion/2</code> predicate is not used and the first argument is a compound term with functor <code>--&gt;/2</code> then the default Logtalk grammar rule translator is used, with the resulting clause being unified with the second argument; when the translator is not used, the two arguments are unified.
+The expansion works as follows: if the first argument is a variable, then it is unified with the second argument; if the first argument is not a variable and clauses for the <code>term_expansion/2</code> predicate are within scope, then this predicate is called to provide an expansion that is then unified with the second argument; if the <code>term_expansion/2</code> predicate is not used and the first argument is a compound term with functor <code>--&gt;/2</code> then the default Logtalk grammar rule translator is used, with the resulting clause being unified with the second argument; when the translator is not used, the two arguments are unified. The <code>expand_term/2</code> predicate may return a list of terms.
 </p>
 <p>
@@ -54 +54 @@
     <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: October 26, 2006</span>
+        <span>Last updated on: November 21, 2008</span>
     </div>
     <div class="navbottom">

trunk/manuals/refman/methods/goal_expansion2.html

@@ -26 +26 @@
 <pre>goal_expansion(Goal, ExpandedGoal)</pre>
 <p>
-Defines an expansion for a goal. The first argument is the goal to be expanded. The expanded goal is returned in the second argument. This predicate is called recursively on the expanded goal. Thus, care must be taken to avoid compilation loops. This predicate is called when compiling source files, when dynamically creating new objects, and when asserting predicate clauses. 
+Defines an expansion for a goal. The first argument is the goal to be expanded. The expanded goal is returned in the second argument. This predicate is called recursively on the expanded goal. Thus, care must be taken to avoid compilation loops. This predicate, when defined, is automatically called by the <a href="expand_goal2.html"><code>expand_goal/2</code></a> method. Use of this predicate by the <code>expand_goal/2</code> method may be restricted by using a scope directive for it. This predicate is called when compiling source files, when dynamically creating new objects, and when asserting predicate clauses. 
 </p>
 
@@ -48 +48 @@
     <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: December 3, 2007</span>
+        <span>Last updated on: November 21, 2008</span>
     </div>
     <div class="navbottom">
-        <span><a href="term_expansion2.html">previous</a> | <a href="../../glossary.html">glossary</a> | <a href="../index.html#methods">next</a></span><br/>
+        <span><a href="expand_goal2.html">previous</a> | <a href="../../glossary.html">glossary</a> | <a href="../index.html#methods">next</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>

trunk/manuals/refman/methods/term_expansion2.html

@@ -26 +26 @@
 <pre>term_expansion(Term, Expansion)</pre>
 <p>
-Defines an expansion for a term. This predicate, when defined, is automatically called by the <a href="expand_term2.html"><code>expand_term/2</code></a> method. Use of this predicate by the <code>expand_term/2</code> method may be restricted by using a scope directive for it. The <code>term_expansion/2</code> clauses are only used by the <code>expand_term/2</code> method if they are within the scope of the <em>sender</em>. When that is not the case, the <code>expand_term/2</code> method only uses the default expansions.
+Defines an expansion for a term. This predicate, when defined, is automatically called by the <a href="expand_term2.html"><code>expand_term/2</code></a> method. Use of this predicate by the <code>expand_term/2</code> method may be restricted by using a scope directive for it. The <code>term_expansion/2</code> clauses are only used by the <code>expand_term/2</code> method if they are within the scope of the <em>sender</em>. When that is not the case, the <code>expand_term/2</code> method only uses the default expansions. The <code>term_expansion/2</code> predicate may return a list of terms.
 </p>
 
@@ -48 +48 @@
     <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: October 26, 2006</span>
+        <span>Last updated on: November 21, 2008</span>
     </div>
     <div class="navbottom">
-        <span><a href="expand_term2.html">previous</a> | <a href="../../glossary.html">glossary</a> | <a href="goal_expansion2.html">next</a></span><br/>
+        <span><a href="expand_term2.html">previous</a> | <a href="../../glossary.html">glossary</a> | <a href="expand_goal2.html">next</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>

trunk/manuals/refman/refman.header

@@ -36 +36 @@
         <span>http://logtalk.org/</span>
     </p>
-    <p class="date">Last updated on November 7, 2008</p>
+    <p class="date">Last updated on November 21, 2008</p>
 </div>