From: <mie...@us...> - 2008-08-01 23:04:30
|
Revision: 2824 http://oorexx.svn.sourceforge.net/oorexx/?rev=2824&view=rev Author: miesfeld Date: 2008-08-01 23:04:38 +0000 (Fri, 01 Aug 2008) Log Message: ----------- Minor formatting Modified Paths: -------------- docs/trunk/oodialog/standarddialog.sgml docs/trunk/rexxref/rexutil.sgml Modified: docs/trunk/oodialog/standarddialog.sgml =================================================================== --- docs/trunk/oodialog/standarddialog.sgml 2008-08-01 23:00:23 UTC (rev 2823) +++ docs/trunk/oodialog/standarddialog.sgml 2008-08-01 23:04:38 UTC (rev 2824) @@ -1660,7 +1660,7 @@ <programlisting> <![CDATA[ curdir = directory() -file = FileNameDialog('*.pdf',,"Adobe PDF Files"'0'x"*.pdf"'0'x) +file = FileNameDialog("*.pdf", , "Adobe PDF Files"'0'x"*.pdf"'0'x) call directory curdir ]]> </programlisting> Modified: docs/trunk/rexxref/rexutil.sgml =================================================================== --- docs/trunk/rexxref/rexutil.sgml 2008-08-01 23:00:23 UTC (rev 2823) +++ docs/trunk/rexxref/rexutil.sgml 2008-08-01 23:04:38 UTC (rev 2824) @@ -192,7 +192,7 @@ <entry></entry> </row> <row> -<entry><link linkend="utlSysgetmessage">SysGetMessage</link></entry><entry>No</entry><entry>YES</entry> +<entry><link linkend="utlSysgetmessage">SysGetMessage</link></entry><entry>NO</entry><entry>YES</entry> <entry></entry> </row> <row> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <wda...@us...> - 2008-12-02 21:02:43
|
Revision: 3741 http://oorexx.svn.sourceforge.net/oorexx/?rev=3741&view=rev Author: wdashley Date: 2008-12-02 21:02:42 +0000 (Tue, 02 Dec 2008) Log Message: ----------- These fixes make DSSSL formatting work on Fedora 10. Now we can see if the Build Machine likes them. Modified Paths: -------------- docs/trunk/oodialog/buttoncontrols.sgml docs/trunk/rexxref/rexxref.sgml Modified: docs/trunk/oodialog/buttoncontrols.sgml =================================================================== --- docs/trunk/oodialog/buttoncontrols.sgml 2008-12-02 20:42:10 UTC (rev 3740) +++ docs/trunk/oodialog/buttoncontrols.sgml 2008-12-02 21:02:42 UTC (rev 3741) @@ -1220,7 +1220,7 @@ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> <listitem><para>The only argument is: <variablelist> -<varlistentry><term>new_style/term> +<varlistentry><term>new_style</term> <listitem><para>A text string that is either: <variablelist> <varlistentry><term>LEFT</term> @@ -1229,6 +1229,7 @@ <varlistentry><term>RIGHT</term> <listitem><para>The label is aligned to the upper right. </para></listitem></varlistentry> +</variablelist> </para></listitem></varlistentry> </variablelist> </para></listitem></varlistentry> Modified: docs/trunk/rexxref/rexxref.sgml =================================================================== --- docs/trunk/rexxref/rexxref.sgml 2008-12-02 20:42:10 UTC (rev 3740) +++ docs/trunk/rexxref/rexxref.sgml 2008-12-02 21:02:42 UTC (rev 3741) @@ -1,4 +1,4 @@ -<?xml version="1.0" standalone="no"?> +<?xml version="1.0" standalone="no"> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ <!ENTITY legalstuff SYSTEM "../shared/legalstuff.sgml"> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-01-01 22:55:35
|
Revision: 3846 http://oorexx.svn.sourceforge.net/oorexx/?rev=3846&view=rev Author: bigrixx Date: 2009-01-01 21:46:24 +0000 (Thu, 01 Jan 2009) Log Message: ----------- update docs to indicate that multiple whitespace characters are accepted Modified Paths: -------------- docs/trunk/rexxpg/rexio.sgml docs/trunk/rexxref/dire.sgml docs/trunk/rexxref/funct.sgml docs/trunk/rexxref/fundclasses.sgml docs/trunk/rexxref/instrc.sgml docs/trunk/rexxref/intro.sgml docs/trunk/rexxref/numarit.sgml docs/trunk/rexxref/parsingch.sgml docs/trunk/rexxref/utilityclasses.sgml docs/trunk/rexxref/xintdeb.sgml Modified: docs/trunk/rexxpg/rexio.sgml =================================================================== --- docs/trunk/rexxpg/rexio.sgml 2009-01-01 21:42:50 UTC (rev 3845) +++ docs/trunk/rexxpg/rexio.sgml 2009-01-01 21:46:24 UTC (rev 3846) @@ -117,7 +117,7 @@ ]]> </programlisting> <para>COUNT uses the String method WORDS to count the words, so COUNT -actually counts blank-delimited tokens: </para> +actually counts whitespace-delimited tokens: </para> <indexterm><primary>counting words in a file</primary></indexterm> <programlisting> <![CDATA[ Modified: docs/trunk/rexxref/dire.sgml =================================================================== --- docs/trunk/rexxref/dire.sgml 2009-01-01 21:42:50 UTC (rev 3845) +++ docs/trunk/rexxref/dire.sgml 2009-01-01 21:46:24 UTC (rev 3846) @@ -260,7 +260,7 @@ (See <link linkend="mthClassInherit">INHERIT</link> .) As with the INHERIT message, each of the classes in <emphasis role="italic">iclasses</emphasis> must be a mixin class. The <emphasis role="italic">iclasses</emphasis> -is a blank-separated list of literal strings or symbols that are taken as +is a whitespace-separated list of literal strings or symbols that are taken as constants. If you omit the INHERIT option, the class inherits only from <emphasis role="italic">sclass</emphasis>.</para> <para><emphasis role="bold">Example:</emphasis></para> Modified: docs/trunk/rexxref/funct.sgml =================================================================== --- docs/trunk/rexxref/funct.sgml 2009-01-01 21:42:50 UTC (rev 3845) +++ docs/trunk/rexxref/funct.sgml 2009-01-01 21:46:24 UTC (rev 3846) @@ -95,8 +95,10 @@ parentheses. These expressions are called the arguments to the function. Each argument expression can include further function calls.</para> <para>Note that the left parenthesis must be adjacent to the name of the function, -with no blank in between. (A blank operator would be assumed at this point -instead.) Only a comment can appear between the name and the left parenthesis.</para> +with no whitespace characters in between. (A blank operator would be assumed at +this point instead.) Only a comment can appear between the name and the left +parenthesis. +</para> <para>The arguments <indexterm><primary>arguments</primary> <secondary>passing to functions</secondary></indexterm> @@ -347,7 +349,7 @@ <itemizedlist> <listitem><para>The parentheses in a function are always needed, even if no arguments are required. The first parenthesis must follow the name of the function with -no space in between.</para></listitem> +no whitespace in between.</para></listitem> <listitem><para>The built-in functions internally work with NUMERIC DIGITS 9 and NUMERIC FUZZ 0 and are unaffected by changes to the NUMERIC settings, except where stated. Any argument named as a <emphasis role="italic">number</emphasis> @@ -517,8 +519,9 @@ <secondary>determining current environment</secondary></indexterm> <indexterm><primary>environment</primary> <secondary>determining current using ADDRESS function</secondary></indexterm> -to which commands are currently submitted. Trailing blanks are removed from -the result.</para> +to which commands are currently submitted. Trailing whitespace characters are +removed from the result. +</para> <para>Here is an example:</para> <indexterm><primary>ADDRESS function</primary> <secondary>example</secondary></indexterm> @@ -633,8 +636,8 @@ last explicitly specified argument string.</para></listitem> <listitem><para>Programs called as commands can have only 0 or 1 argument strings. The program has 0 argument strings if it is called with the name only and has -1 argument string if anything else (including blanks) is included in the -command.</para></listitem> +1 argument string if anything else (including whitespace characters) is included +in the command.</para></listitem> <listitem><para>Programs called by the RexxStart entry point can have several argument strings. (See the <citetitle pubwork="book">Open Object Rexx: Programming Guide</citetitle> @@ -672,12 +675,13 @@ <para>The <emphasis role="italic">binary_string</emphasis> is a string of binary (<computeroutput>0</computeroutput> or <computeroutput>1</computeroutput>) digits. It can be of any length. You can -optionally include blanks in <emphasis role="italic">binary_string</emphasis> -(at 4-digit boundaries only, not leading or trailing) -to improve readability; they are ignored.</para> +optionally include whitespace characters in <emphasis role="italic">binary_string</emphasis> +(at 4-digit boundaries only, not leading or trailing) to improve readability; +they are ignored. +</para> <para>The returned string uses uppercase alphabetical characters for the values <computeroutput>A</computeroutput>-<computeroutput>F</computeroutput>, -and does not include blanks.</para> +and does not include blanks or horizontal tabs.</para> <para>If <emphasis role="italic">binary_string</emphasis> is the null string, B2X returns a null string. If the number of binary digits in <emphasis role="italic">binary_string</emphasis> is not a multiple @@ -997,9 +1001,10 @@ ASCII representation of the character 1 is "31"X.</para> <para>The string returned uses uppercase alphabetical characters for the values <computeroutput>A</computeroutput>-<computeroutput>F</computeroutput> -and does not include blanks. The <emphasis role="italic">string</emphasis> can -be of any length. If <emphasis role="italic">string</emphasis> -is null, a null string is returned.</para> +and does not include whitespace characters. The <emphasis role="italic">string</emphasis> +can be of any length. If +<emphasis role="italic">string</emphasis> is null, a null string is +returned.</para> <para>Here are some examples:</para> <indexterm><primary>C2X function</primary> <secondary>example</secondary></indexterm> @@ -1424,7 +1429,7 @@ <listitem><para>returns the name of the current trapped condition. For user conditions, the returned string is a concatenation of the word <computeroutput>USER</computeroutput> and the -user condition name, separated by a blank. +user condition name, separated by a whitespace character. </para></listitem></varlistentry> <varlistentry><term>Description</term> <listitem><para>returns any descriptive string associated with the current @@ -1641,7 +1646,7 @@ <emphasis role="italic">wholenumber</emphasis>, a decimal number, converted to hexadecimal. The returned string uses uppercase alphabetics for the values <computeroutput>A</computeroutput>-<computeroutput>F</computeroutput> and does -not include blanks.</para> +not include whitespace characters.</para> <para><emphasis role="italic">Wholenumber</emphasis> must not have more digits than the current setting of NUMERIC DIGITS.</para> <para>If you specify <emphasis role="italic">n</emphasis>, @@ -1737,10 +1742,11 @@ </para></listitem></varlistentry> <varlistentry><term>Binary</term> <listitem><para>returns <computeroutput>1</computeroutput> if -<emphasis role="italic">string</emphasis> contains only the character -<computeroutput>0</computeroutput> or <computeroutput>1</computeroutput>, -or a blank. Blanks can appear only between groups -of 4 binary characters. It also returns <computeroutput>1</computeroutput> if +<emphasis role="italic">string</emphasis> contains only the characters +<computeroutput>0</computeroutput> or <computeroutput>1</computeroutput>, or +whitespace. Whitespace characters can appear only between groups of 4 binary +characters. It also returns +<computeroutput>1</computeroutput> if <emphasis role="italic">string</emphasis> is a null string, which is a valid binary string. </para></listitem></varlistentry> @@ -1794,9 +1800,9 @@ <emphasis role="italic">string</emphasis> contains only characters from the ranges <computeroutput>a</computeroutput>-<computeroutput>f</computeroutput>, <computeroutput>A</computeroutput>-<computeroutput>F</computeroutput>, -<computeroutput>0</computeroutput>-<computeroutput>9</computeroutput>, -and blank (as long as blanks appear only between -pairs of hexadecimal characters). It also returns +<computeroutput>0</computeroutput>-<computeroutput>9</computeroutput>, and +whitespace (as long as the whitespace characters appear only between pairs of +hexadecimal characters). It also returns <computeroutput>1</computeroutput> if <emphasis role="italic">string</emphasis> is a null string, which is a valid hexadecimal string. </para></listitem></varlistentry> @@ -1875,9 +1881,9 @@ </term> <listitem><para>returns the number of complete days (that is, not including the current day) since and including the base date, 1 January 0001, in the format: -<emphasis role="italic">dddddd</emphasis> (no leading zeros or blanks). -The expression <computeroutput>DATE("B")//7</computeroutput> returns a number -in the range +<emphasis role="italic">dddddd</emphasis> (no leading zeros or whitespace). The +expression <computeroutput>DATE("B")//7</computeroutput> returns a number in the +range <computeroutput>0</computeroutput>-<computeroutput>6</computeroutput> that corresponds to the current day of the week, where <computeroutput>0</computeroutput> is Monday and @@ -1896,7 +1902,7 @@ </term> <listitem><para>returns the number of days, including the current day, that have passed this year in the format <emphasis role="italic">ddd</emphasis> -(no leading zeros or blanks). +(no leading zeros or whitespace). </para></listitem></varlistentry> <varlistentry><term>European <indexterm><primary>European option of DATE function</primary></indexterm> @@ -1908,7 +1914,8 @@ </term> <listitem><para>returns the number of microseconds since 00:00:00.000000 on 1 January 0001, in the format: -<emphasis role="italic">dddddddddddddddddd</emphasis> (no leading zeros or blanks). +<emphasis role="italic">dddddddddddddddddd</emphasis> (no leading zeros or +whitespace). </para> <note><title>Notes</title> <para>The base date of 1 January 0001 is determined @@ -1966,7 +1973,8 @@ </term> <listitem><para>returns the number of seconds since 00:00:00.000000 on 1 January 1970, in the format: -<emphasis role="italic">dddddddddddd</emphasis> (no leading zeros or blanks). +<emphasis role="italic">dddddddddddd</emphasis> (no leading zeros or +whitespace). </para> <note><title>Notes</title> <para>The base date of 1 January 1970 is determined @@ -2175,8 +2183,9 @@ <para>Returns <emphasis role="italic">string</emphasis> after deleting the substring that starts at the <emphasis role="italic">n</emphasis>th word and -is of <emphasis role="italic">length</emphasis> blank-delimited words. If you -omit <emphasis role="italic">length</emphasis>, or if +is of <emphasis role="italic">length</emphasis> whitespace-delimited words. If +you omit +<emphasis role="italic">length</emphasis>, or if <emphasis role="italic">length</emphasis> is greater than the number of words from <emphasis role="italic">n</emphasis> to the end of <emphasis role="italic">string</emphasis>, the function deletes the remaining @@ -2188,8 +2197,9 @@ If <emphasis role="italic">n</emphasis> is greater than the number of words in <emphasis role="italic">string</emphasis>, the function returns <emphasis role="italic">string</emphasis> unchanged. The string deleted includes any -blanks following the final word involved but none of the blanks preceding -the first word involved.</para> +whitespace characters following the final word involved but none of the +whitespace preceding the first word involved. +</para> <para>Here are some examples:</para> <indexterm><primary>DELWORD function</primary> <secondary>example</secondary></indexterm> @@ -3779,13 +3789,13 @@ ]]> </programlisting> -<para>Returns the blank-delimited words in +<para>Returns the whitespace-delimited words in <emphasis role="italic">string</emphasis> with <emphasis role="italic">n pad</emphasis> characters between each word. If you specify <emphasis role="italic">n</emphasis>, it must be a positive whole number or zero. If it is -<computeroutput>0</computeroutput>, all blanks are removed. Leading and -trailing blanks are always removed. The default for +<computeroutput>0</computeroutput>, all whitespace characters are removed. +Leading and trailing whitespace characters are always removed. The default for <emphasis role="italic">n</emphasis> is <computeroutput>1</computeroutput>, and the default <emphasis role="italic">pad</emphasis> character is a blank. </para> @@ -4265,13 +4275,15 @@ <secondary>STRIP</secondary></indexterm> <indexterm><primary>blanks</primary> <secondary>removal with STRIP function</secondary></indexterm> +<indexterm><primary>whitespace</primary> +<secondary>removal with STRIP function</secondary></indexterm> <indexterm><primary>leading</primary> <secondary>zeros</secondary> <tertiary>removing with STRIP function</tertiary></indexterm> <indexterm><primary>leading</primary> -<secondary>leading blank removal with STRIP function</secondary></indexterm> +<secondary>leading whitespace removal with STRIP function</secondary></indexterm> <indexterm><primary>trailing</primary> -<secondary>blank removed using STRIP function</secondary></indexterm> +<secondary>whitespace removed using STRIP function</secondary></indexterm> <indexterm><primary>zeros</primary> <secondary>removal with STRIP function</secondary></indexterm> @@ -4304,7 +4316,8 @@ </para></listitem></varlistentry> </variablelist> <para>The third argument, <emphasis role="italic">char</emphasis>, specifies -the character to be removed, and the default is a blank. If you specify +the character to be removed, and the default is to remove all whitespace +characters. If you specify <emphasis role="italic">char</emphasis>, it must be exactly one character long.</para> <para>Here are some examples:</para> @@ -4397,13 +4410,15 @@ <para>Returns the substring of <emphasis role="italic">string</emphasis> that starts at the <emphasis role="italic">n</emphasis>th word, and is up to <emphasis role="italic">length</emphasis> -blank-delimited words. <emphasis role="italic">n</emphasis> must -be a positive whole number. If you omit +whitespace-delimited words. +<emphasis role="italic">n</emphasis> must be a positive whole number. If you +omit <emphasis role="italic">length</emphasis>, it defaults to the number of remaining words in <emphasis role="italic">string</emphasis>. The returned string never has -leading or trailing blanks, but includes all blanks between the selected -words.</para> +leading or trailing whitespace, but includes all whitespace characters between +the selected words. +</para> <para>Here are some examples:</para> <indexterm><primary>SUBWORD function</primary> <secondary>example</secondary></indexterm> @@ -4513,8 +4528,9 @@ <varlistentry><term>Elapsed</term> <listitem><para>returns sssssssss.uuuuuu, the number of seconds and microseconds since the elapsed-time clock (described later) was started or reset. The returned -number has no leading zeros or blanks, and the setting of NUMERIC DIGITS does -not affect it. The number has always four trailing zeros in the decimal portion. </para> +number has no leading zeros or whitespace, and the setting of NUMERIC DIGITS +does not affect it. The number has always four trailing zeros in the decimal +portion.</para> <para>The language processor calculates elapsed time by subtracting the time at which the elapsed-time clock was started or reset from the current time. It is possible to change the system time clock while the system is running. @@ -4534,7 +4550,8 @@ </term> <listitem><para>returns the number of microseconds since 00:00:00.000000 on 1 January 0001, in the format: -<emphasis role="italic">dddddddddddddddddd</emphasis> (no leading zeros or blanks). +<emphasis role="italic">dddddddddddddddddd</emphasis> (no leading zeros or +whitespace). </para> <note><title>Notes</title> <para>The base date of 1 January 0001 is determined @@ -4552,8 +4569,9 @@ <indexterm><primary>hours calculated from midnight</primary></indexterm> </term> <listitem><para>returns up to two characters giving the number of hours -since midnight in the format hh (no leading zeros or blanks, except for a -result of <computeroutput>0</computeroutput>). +since midnight in the format hh (no leading zeros or whitespace, except for a +result of +<computeroutput>0</computeroutput>). </para></listitem></varlistentry> <varlistentry><term>Long</term> <listitem><para>returns time in the format hh:mm:ss.uuuuuu (where uuuuuu are @@ -4563,8 +4581,9 @@ <indexterm><primary>minutes calculated from midnight</primary></indexterm> </term> <listitem><para>returns up to four characters giving the number of minutes -since midnight in the format mmmm (no leading zeros or blanks, except for a -result of <computeroutput>0</computeroutput>). +since midnight in the format mmmm (no leading zeros or whitespace, except for a +result of +<computeroutput>0</computeroutput>). </para></listitem></varlistentry> <varlistentry><term>Normal</term> <listitem><para>returns the time in the default format hh:mm:ss. The hours @@ -4584,8 +4603,9 @@ <listitem><para>returns sssssssss.uuuuuu, the number of seconds and microseconds since the elapsed-time clock (described later) was started or reset and also resets the elapsed-time clock to zero. The returned number has no leading -zeros or blanks, and the setting of NUMERIC DIGITS does not affect it. The -number always has four trailing zeros in the decimal portion.</para> +zeros or whitespace, and the setting of NUMERIC DIGITS does not affect it. The +number always has four trailing zeros in the decimal portion. +</para> <para>See the Elapsed option for more information on resetting the system time clock.</para> </listitem></varlistentry> @@ -4593,15 +4613,17 @@ <indexterm><primary>seconds calculated from midnight</primary></indexterm> </term> <listitem><para>returns up to five characters giving the number of seconds -since midnight in the format sssss (no leading zeros or blanks, except for -a result of <computeroutput>0</computeroutput>). +since midnight in the format sssss (no leading zeros or whitespace, except for a +result of +<computeroutput>0</computeroutput>). </para></listitem></varlistentry> <varlistentry><term>Ticks <indexterm><primary>Ticks option of Time function</primary></indexterm> </term> <listitem><para>returns the number of seconds since 00:00:00.000000 on 1 January 1970, in the format: -<emphasis role="italic">dddddddddddd</emphasis> (no leading zeros or blanks). +<emphasis role="italic">dddddddddddd</emphasis> (no leading zeros or +whitespace). </para> <note><title>Notes</title> <para>The base date of 1 January 1970 is determined @@ -5294,9 +5316,10 @@ ]]> </programlisting> -<para>Returns the <emphasis role="italic">n</emphasis>th blank-delimited word -in <emphasis role="italic">string</emphasis> or returns -the null string if less than <emphasis role="italic">n</emphasis> words are in +<para>Returns the <emphasis role="italic">n</emphasis>th whitespace-delimited +word in +<emphasis role="italic">string</emphasis> or returns the null string if less +than <emphasis role="italic">n</emphasis> words are in <emphasis role="italic">string</emphasis>. <emphasis role="italic">n</emphasis> must be a positive whole number. This function is equal to SUBWORD(<emphasis role="italic">string</emphasis>, @@ -5328,8 +5351,8 @@ </programlisting> <para>Returns the position of the first character in the -<emphasis role="italic">n</emphasis>th blank-delimited -word in <emphasis role="italic">string</emphasis> or returns +<emphasis role="italic">n</emphasis>th whitespace-delimited word in <emphasis +role="italic">string</emphasis> or returns <computeroutput>0</computeroutput> if less than <emphasis role="italic">n</emphasis> words are in <emphasis role="italic">string</emphasis>. @@ -5363,7 +5386,7 @@ </programlisting> <para>Returns the length of the <emphasis role="italic">n</emphasis>th -blank-delimited word in the <emphasis role="italic">string</emphasis> or +whitespace-delimited word in the <emphasis role="italic">string</emphasis> or returns <computeroutput>0</computeroutput> if less than <emphasis role="italic">n</emphasis> words are in the <emphasis role="italic">string</emphasis>. @@ -5403,7 +5426,7 @@ <emphasis role="italic">string</emphasis> or returns <computeroutput>0</computeroutput> if <emphasis role="italic">phrase</emphasis> contains no words or if <emphasis role="italic">phrase</emphasis> is not found. -Several blanks between words in either +Several whitespace characters between words in either <emphasis role="italic">phrase</emphasis> or <emphasis role="italic">string</emphasis> are treated as a single blank for the comparison, but otherwise the words must match exactly.</para> @@ -5451,7 +5474,7 @@ ]]> </programlisting> -<para>Returns the number of blank-delimited words in +<para>Returns the number of whitespace-delimited words in <emphasis role="italic">string</emphasis>.</para> <para>Here are some examples:</para> <indexterm><primary>WORDS function</primary> @@ -5488,12 +5511,12 @@ to binary. The <emphasis role="italic">hexstring</emphasis> is a string of hexadecimal characters. It can be of any length. Each hexadecimal character is converted to a string -of 4 binary digits. You can optionally include blanks in +of 4 binary digits. You can optionally include whitespace characters in <emphasis role="italic">hexstring</emphasis> (at byte boundaries only, not leading or trailing) to improve readability; they are ignored.</para> <para>The returned string has a length that is a multiple of 4, and does not -include any blanks.</para> +include any whitespace.</para> <para>If <emphasis role="italic">hexstring</emphasis> is null, the function returns a null string.</para> <para>Here are some examples:</para> @@ -5543,7 +5566,7 @@ <emphasis role="italic">hexstring</emphasis> can be of any length. If necessary, it is padded with a leading zero to make an even number of hexadecimal digits.</para> -<para>You can optionally include blanks in +<para>You can optionally include whitespace characters in <emphasis role="italic">hexstring</emphasis> (at byte boundaries only, not leading or trailing) to improve readability; they are ignored.</para> <para>If <emphasis role="italic">hexstring</emphasis> is null, the function @@ -5586,7 +5609,7 @@ characters. If the result cannot be expressed as a whole number, an error occurs. That is, the result must not have more digits than the current setting of NUMERIC DIGITS.</para> -<para>You can optionally include blanks in +<para>You can optionally include whitespace characters in <emphasis role="italic">hexstring</emphasis> (at byte boundaries only, not leading or trailing) to aid readability; they are ignored.</para> <para>If <emphasis role="italic">hexstring</emphasis> is null, the function Modified: docs/trunk/rexxref/fundclasses.sgml =================================================================== --- docs/trunk/rexxref/fundclasses.sgml 2009-01-01 21:42:50 UTC (rev 3845) +++ docs/trunk/rexxref/fundclasses.sgml 2009-01-01 21:46:24 UTC (rev 3846) @@ -1777,8 +1777,9 @@ are numeric, the language processor does a numeric comparison (ignoring, for example, leading zeros--see <link linkend="numcom">Numeric Comparisons</link>). Otherwise, it treats -both terms as character strings, ignoring leading and trailing blanks and -padding the shorter string on the right with blanks.</para> +both terms as character strings, ignoring leading and trailing whitespace +characters and padding the shorter string on the right with blanks. +</para> <para>Character comparison and strict comparison operations are both case-sensitive, and for both the exact collating order can depend on the character set. In @@ -2099,12 +2100,13 @@ binary string converted to hexadecimal.</para> <para>The receiving string is a string of binary (<computeroutput>0</computeroutput> or <computeroutput>1</computeroutput>) -digits. It can be of any length. It can optionally include blanks (at 4-digit -boundaries only, not leading or trailing). These are to improve readability; -the language processor ignores them.</para> +digits. It can be of any length. It can optionally include whitespace characters +(at 4-digit boundaries only, not leading or trailing). These are to improve +readability; the language processor ignores them. +</para> <para>The returned string uses uppercase alphabetic characters for the values <computeroutput>A</computeroutput>-<computeroutput>F</computeroutput> and does -not include blanks.</para> +not include whitespace.</para> <para>If the receiving binary string is a null string, <emphasis role="bold">b2x</emphasis> returns a null string. If the number of binary digits in the receiving string is not a multiple of @@ -2373,8 +2375,8 @@ is the ASCII representation of <computeroutput>1</computeroutput>.</para> <para>The returned string has uppercase alphabetic characters for the values <computeroutput>A</computeroutput>-<computeroutput>F</computeroutput> and does -not include blanks. The receiving string -can be of any length. If the receiving string is null, +not include whitespace. The receiving string can be of any length. If the +receiving string is null, <emphasis role="bold">c2x</emphasis> returns a null string.</para> <para><emphasis role="bold">Examples:</emphasis></para> <indexterm><primary>examples</primary> @@ -2851,11 +2853,11 @@ receiving string, or <computeroutput>0</computeroutput> if <emphasis role="italic">phrase</emphasis> contains no words or if <emphasis role="italic">phrase</emphasis> is not found. -Word matches are made independent of case. -Several blanks -between words in either <emphasis role="italic">phrase</emphasis> or the -receiving string are treated as a single blank for the -comparison, but, otherwise, the words must match exactly.</para> +Word matches are made independent of case. Several whitespace characters between +words in either +<emphasis role="italic">phrase</emphasis> or the receiving string are treated as +a single blank for the comparison, but, otherwise, the words must match +exactly.</para> <para>By default the search starts at the first word in the receiving string. You can override this by specifying <emphasis @@ -3200,7 +3202,7 @@ string, a decimal number converted to hexadecimal. The returned string uses uppercase alphabetic characters for the values <computeroutput>A</computeroutput>-<computeroutput>F</computeroutput> and does -not include blanks.</para> +not include whitespace.</para> <para>The receiving string must not have more digits than the current setting of NUMERIC DIGITS.</para> <para>If you specify <emphasis role="italic">n</emphasis>, it is the length of @@ -3291,9 +3293,9 @@ <varlistentry><term>Binary</term> <listitem><para>returns <computeroutput>1</computeroutput> if the receiving string contains only the characters <computeroutput>0</computeroutput> or -<computeroutput>1</computeroutput>, or a blank. Blanks can appear only between -groups of 4 binary characters. It also returns 1 if string is -a null string, which is a valid binary string. +<computeroutput>1</computeroutput>, or whitespace. Whitespace characters can +appear only between groups of 4 binary characters. It also returns 1 if string +is a null string, which is a valid binary string. </para></listitem></varlistentry> <varlistentry><term>Lowercase</term> <listitem><para>returns <computeroutput>1</computeroutput> if the receiving @@ -3342,9 +3344,9 @@ string contains only characters from the ranges <computeroutput>a</computeroutput>-<computeroutput>f</computeroutput>, <computeroutput>A</computeroutput>-<computeroutput>F</computeroutput>, -<computeroutput>0</computeroutput>-<computeroutput>9</computeroutput>, -and blank (as long as blanks appear -only between pairs of hexadecimal characters). Also returns +<computeroutput>0</computeroutput>-<computeroutput>9</computeroutput>, and +whitespace characters (as long as whitespace characters appear only between +pairs of hexadecimal characters). Also returns <computeroutput>1</computeroutput> if the receiving string is a null string. </para></listitem></varlistentry> @@ -3493,8 +3495,10 @@ zero. The <emphasis role="italic">n</emphasis> must be a positive whole number. If <emphasis role="italic">n</emphasis> is greater than the number of words in the receiving string, the method returns the receiving -string unchanged. The string deleted includes any blanks following the final -word involved but none of the blanks preceding the first word involved.</para> +string unchanged. The string deleted includes any whitespace characters +following the final word involved but none of the whitespace characters +preceding the first word involved. +</para> <para><emphasis role="bold">Examples:</emphasis></para> <indexterm><primary>examples</primary> <secondary>delWord method</secondary></indexterm> @@ -4339,11 +4343,11 @@ <para>Returns a copy of receiving string, with <emphasis role="italic">n</emphasis> <emphasis role="italic">pad</emphasis> -characters between each blank-delimited word. If you specify +characters between each whitespace-delimited word. If you specify <emphasis role="italic">n</emphasis>, it must be a positive whole number or zero. If it is -<computeroutput>0</computeroutput>, all blanks are -removed. Leading and trailing blanks are always removed. The default for +<computeroutput>0</computeroutput>, all whitespace characters are removed. +Leading and trailing whitespace characters are always removed. The default for <emphasis role="italic">n</emphasis> is <computeroutput>1</computeroutput>, and the default <emphasis role="italic">pad</emphasis> character is a blank. </para> @@ -4369,15 +4373,17 @@ <tertiary>of String class</tertiary></indexterm> <indexterm><primary>blanks</primary> <secondary>removal with strip method</secondary></indexterm> +<indexterm><primary>whitespace</primary> +<secondary>removal with strip method</secondary></indexterm> <indexterm><primary>character</primary> <secondary>removal with strip method</secondary></indexterm> <indexterm><primary>leading</primary> <secondary>zeros</secondary> <tertiary>removing with strip method</tertiary></indexterm> <indexterm><primary>leading</primary> -<secondary>blank removal with strip method</secondary></indexterm> +<secondary>whitespace removal with strip method</secondary></indexterm> <indexterm><primary>trailing</primary> -<secondary>blank removed using strip method</secondary></indexterm> +<secondary>whitespace removed using strip method</secondary></indexterm> <indexterm><primary>zeros</primary> <secondary>removal with strip method</secondary></indexterm> @@ -4515,8 +4521,9 @@ <emphasis role="italic">n</emphasis> must be a positive whole number. If you omit <emphasis role="italic">length</emphasis>, it defaults to the number of remaining words in the receiving string. The returned string -never has leading or trailing blanks, but includes all blanks between the -selected words.</para> +never has leading or trailing whitespace, but includes all whitespace characters +between the selected words. +</para> <para><emphasis role="bold">Examples:</emphasis></para> <indexterm><primary>examples</primary> <secondary>subWord method</secondary></indexterm> @@ -4786,9 +4793,10 @@ ]]> </programlisting> -<para>Returns the <emphasis role="italic">n</emphasis>th blank-delimited word -in the receiving string or the null string if the receiving string has -fewer than <emphasis role="italic">n</emphasis> words. The +<para>Returns the <emphasis role="italic">n</emphasis>th whitespace-delimited +word in the receiving string or the null string if the receiving string has +fewer than +<emphasis role="italic">n</emphasis> words. The <emphasis role="italic">n</emphasis> must be a positive whole number. This method is exactly equivalent to <computeroutput>receiving_string~subWord(n,1)</computeroutput>.</para> @@ -4816,10 +4824,11 @@ </programlisting> <para>Returns the position of the first character in the -<emphasis role="italic">n</emphasis>th blank-delimited -word in the receiving string. It returns <computeroutput>0</computeroutput> -if the receiving string has fewer than <emphasis role="italic">n</emphasis> -words. The <emphasis role="italic">n</emphasis> must be a positive whole number. +<emphasis role="italic">n</emphasis>th whitespace-delimited word in the +receiving string. It returns +<computeroutput>0</computeroutput> if the receiving string has fewer than +<emphasis role="italic">n</emphasis> words. The <emphasis +role="italic">n</emphasis> must be a positive whole number. </para> <para><emphasis role="bold">Examples:</emphasis></para> <indexterm><primary>examples</primary> @@ -4849,7 +4858,7 @@ </programlisting> <para>Returns the length of the <emphasis role="italic">n</emphasis>th -blank-delimited word in the receiving +whitespace-delimited word in the receiving string or <computeroutput>0</computeroutput> if the receiving string has fewer than <emphasis role="italic">n</emphasis> words. The <emphasis role="italic">n</emphasis> must be a positive whole number.</para> @@ -4886,10 +4895,11 @@ <emphasis role="italic">phrase</emphasis> found in the receiving string, or <computeroutput>0</computeroutput> if <emphasis role="italic">phrase</emphasis> contains no words or -if <emphasis role="italic">phrase</emphasis> is not found. Several blanks -between words in either <emphasis role="italic">phrase</emphasis> or the -receiving string are treated as a single blank for the -comparison, but, otherwise, the words must match exactly.</para> +if <emphasis role="italic">phrase</emphasis> is not found. Several whitespace +characters between words in either +<emphasis role="italic">phrase</emphasis> or the receiving string are treated as +a single blank for the comparison, but, otherwise, the words must match +exactly.</para> <para>By default the search starts at the first word in the receiving string. You can override this by specifying <emphasis role="italic">start</emphasis> (which must be positive), @@ -4932,7 +4942,7 @@ ]]> </programlisting> -<para>Returns the number of blank-delimited words in the receiving string. +<para>Returns the number of whitespace-delimited words in the receiving string. </para> <para><emphasis role="bold">Examples:</emphasis></para> <indexterm><primary>examples</primary> @@ -4966,10 +4976,11 @@ string, which is a string of hexadecimal characters converted to binary. The receiving string can be of any length. Each hexadecimal character is converted to a string of 4 binary digits. The receiving string can optionally include -blanks (at byte boundaries only, not leading or trailing) to improve -readability; they are ignored.</para> +whitespace characters (at byte boundaries only, not leading or trailing) to +improve readability; they are ignored. +</para> <para>The returned string has a length that is a multiple of four, and does not -include any blanks.</para> +include any whitespace.</para> <para>If the receiving string is null, the method returns a null string.</para> <para><emphasis role="bold">Examples:</emphasis></para> <indexterm><primary>examples</primary> @@ -5016,8 +5027,10 @@ is half as many bytes as the receiving string. The receiving string can be any length. If necessary, it is padded with a leading 0 to make an even number of hexadecimal digits.</para> -<para>You can optionally include blanks in the receiving string (at byte boundaries -only, not leading or trailing) to improve readability; they are ignored.</para> +<para>You can optionally include whitespace in the receiving string (at byte +boundaries only, not leading or trailing) to improve readability; they are +ignored. +</para> <para>If the receiving string is null, the method returns a null string.</para> <para><emphasis role="bold">Examples:</emphasis></para> <indexterm><primary>examples</primary> @@ -5052,9 +5065,10 @@ string of hexadecimal characters. If the result cannot be expressed as a whole number, an error results. That is, the result must not have more digits than the current setting of NUMERIC DIGITS.</para> -<para>You can optionally include blanks in the receiving string (at byte -boundaries only, not leading or trailing) to improve readability; they are -ignored.</para> +<para>You can optionally include whitespace characters in the receiving string +(at byte boundaries only, not leading or trailing) to improve readability; they +are ignored. +</para> <para>If the receiving string is null, the method returns <computeroutput>0</computeroutput>.</para> <para>If you do not specify <emphasis role="italic">n</emphasis>, Modified: docs/trunk/rexxref/instrc.sgml =================================================================== --- docs/trunk/rexxref/instrc.sgml 2009-01-01 21:42:50 UTC (rev 3845) +++ docs/trunk/rexxref/instrc.sgml 2009-01-01 21:46:24 UTC (rev 3846) @@ -97,15 +97,16 @@ individual instructions. For example, the symbols VALUE and WITH are subkeywords in the ADDRESS and PARSE instructions, respectively. For details, see the description of each instruction.</para> -<para>Blanks adjacent to keywords separate the keyword from the subsequent token. -One or more blanks following VALUE are required to separate -the <emphasis role="italic">expression</emphasis> from the -subkeyword in the example following: </para> -<programlisting> -ADDRESS VALUE expression +<para>Whitespace characters (blanks or horizontal tabs) adjacent to keywords +separate the keyword from the subsequent token. One or more whitespace +characters following VALUE are required to separate the +<emphasis role="italic">expression +</emphasis> from the subkeyword in the example following: </para> +<programlisting> ADDRESS VALUE expression </programlisting> -<para>However, no blank is required after the VALUE subkeyword -in the following example, although it would improve readability: </para> +<para>However, no whitespace character is required after the VALUE subkeyword in +the following example, although it would improve readability: +</para> <programlisting> ADDRESS VALUE"ENVIR"||number </programlisting> @@ -275,8 +276,9 @@ <para>The <emphasis role="italic">template_list</emphasis> can be a single template or list of templates separated by commas. -Each template consists of one or more symbols separated by blanks, patterns, -or both.</para> +Each template consists of one or more symbols separated by whitespace +characters, patterns, or both. +</para> <para>Unless a subroutine, internal function, or method is processed, the objects passed as parameters to the program are converted to string values and parsed into variables according to the rules described in @@ -833,15 +835,16 @@ is not enclosed in parentheses, it identifies a variable you want to drop and must be a symbol that is a valid variable name, separated from any other <emphasis role="italic">name</emphasis> -by one or more blanks or comments.</para> +by one or more whitespace characters or comments.</para> <para>If parentheses enclose a single <emphasis role="italic">name</emphasis>, then its value is used as a <indexterm><primary>subsidiary list</primary></indexterm> -subsidiary list of variables to drop. Blanks are not necessary inside or -outside the parentheses, but you can add them if desired. This subsidiary -list must follow the same rules as the original list, that is, be valid character -strings separated by blanks, except that no parentheses are allowed. The list -needs not contain any names--that is, it can be empty.</para> +subsidiary list of variables to drop. Whitespace characters are not necessary +inside or outside the parentheses, but you can add them if desired. This +subsidiary list must follow the same rules as the original list, that is, be +valid character strings separated by whitespace, except that no parentheses are +allowed. The list needs not contain any names--that is, it can be empty. +</para> <para>Variables are dropped from left to right. It is not an error to specify a name more than once or to drop a variable that is not known. If an exposed variable is named (see <link linkend="keyExpose">EXPOSE</link> @@ -983,13 +986,13 @@ <para>If parentheses enclose a single <emphasis role="italic">name</emphasis>, then, after the variable <emphasis role="italic">name</emphasis> is exposed, the character string value of <emphasis role="italic">name</emphasis> is -immediately used as a subsidiary list of -variables. Blanks are not necessary inside or outside the parentheses, but -you can add them if desired. -<indexterm><primary>subsidiary list</primary></indexterm> -This subsidiary list must follow the same rules -as the original list, that is, valid variable names separated by blanks, except -that no parentheses are allowed.</para> +immediately used as a subsidiary list of variables. Whitespace characters are +not necessary inside or outside the parentheses, but you can add them if +desired. +<indexterm><primary>subsidiary list</primary></indexterm> This subsidiary list +must follow the same rules as the original list, that is, valid variable names +separated by whitespace characters, except that no parentheses are +allowed.</para> <para>Variables are exposed in sequence from left to right. It is not an error to specify a name more than once, or to specify a name that has not been used as a variable.</para> @@ -1983,7 +1986,7 @@ <tertiary>in PARSE instruction</tertiary></indexterm> <para>The <emphasis role="italic">template_list</emphasis> can be a single template or list of templates separated by commas. Each -template consists of one or more symbols separated by blanks, patterns, or +template consists of one or more symbols separated by whitespace, patterns, or both.</para> <para>Each template is applied to a single source string. Specifying several templates is not a syntax error, but only the PARSE ARG variant can supply @@ -2226,17 +2229,20 @@ the routine. If the <emphasis role="italic">name</emphasis> is not enclosed in parentheses, it identifies a variable you want to expose and must be a symbol that is a valid variable name, separated -from any other <emphasis role="italic">name</emphasis> with one or more blanks. +from any other <emphasis role="italic">name</emphasis> with one or more +whitespace characters. </para> <para>If parentheses enclose a single <emphasis role="italic">name</emphasis>, then, after the variable <emphasis role="italic">name</emphasis> is exposed, the character string value of <emphasis role="italic">name</emphasis> is -immediately used as a subsidiary list of variables. Blanks are not -necessary inside or outside the parentheses, but you can add them if desired. +immediately used as a subsidiary list of variables. Whitespace characters are +not necessary inside or outside the parentheses, but you can add them if +desired. <indexterm><primary>subsidiary list</primary></indexterm> This subsidiary list must follow the same rules -as the original list, that is, valid variable names separated by blanks, except -that no parentheses are allowed.</para> +as the original list, that is, valid variable names separated by whitespace +characters, except that no parentheses are allowed. +</para> <para>Variables are exposed from left to right. It is not an error to specify a name more than once, or to specify a name that the caller has not used as a variable.</para> @@ -2387,7 +2393,7 @@ The <emphasis role="italic">template_list</emphasis> can be a single template or list of templates separated by commas, but PULL parses only one source string. Each template consists -of one or more symbols separated by blanks, patterns, or both.</para> +of one or more symbols separated by whitespace, patterns, or both.</para> <para>If you specify several comma-separated templates, variables in templates other than the first one are assigned the null string. The string is translated to uppercase (that is, lowercase @@ -3315,7 +3321,8 @@ one of the alphabetic character options. You can specify the prefix more than once, if desired. Each occurrence of a prefix on an instruction reverses the action of the previous prefix. - The prefix must immediately precede the option (no intervening blanks).</para> + The prefix must immediately precede the option (no intervening + whitespace).</para> <para>The prefix <computeroutput>?</computeroutput> controls interactive debugging. During normal execution, a TRACE option with a prefix of <computeroutput>?</computeroutput> @@ -3409,15 +3416,15 @@ <indexterm><primary>indentation during tracing</primary></indexterm> formatting (indentation) according to its logical depth of nesting, for example. Results, if requested, are indented by two extra spaces and are enclosed in -double quotation marks so that leading and trailing blanks are apparent. Any -control codes in the data encoding (ASCII values less than "20"x) -are replaced by a question mark (?) to avoid screen interference. Results -other than strings appear in the string representation obtained by sending -them a <computeroutput>STRING</computeroutput> -message. The resulting string is enclosed in parentheses. -The line number in the program precedes the first clause traced on any line. -All lines displayed during tracing have a three-character prefix to identify -the type of data being traced. These can be: </para> +double quotation marks so that leading and trailing whitespace characters are +apparent. Any control codes in the data encoding (ASCII values less than "20"x) +are replaced by a question mark (?) to avoid screen interference. Results other +than strings appear in the string representation obtained by sending them a +<computeroutput>STRING</computeroutput> message. The resulting string is +enclosed in parentheses. The line number in the program precedes the first +clause traced on any line. All lines displayed during tracing have a +three-character prefix to identify the type of data being traced. These can be: +</para> <indexterm><primary>tracing</primary> <secondary>data identifiers</secondary></indexterm> <variablelist> Modified: docs/trunk/rexxref/intro.sgml =================================================================== --- docs/trunk/rexxref/intro.sgml 2009-01-01 21:42:50 UTC (rev 3845) +++ docs/trunk/rexxref/intro.sgml 2009-01-01 21:46:24 UTC (rev 3846) @@ -466,10 +466,12 @@ <para>A Rexx program is built from a series of <emphasis>clauses</emphasis> that are composed of: </para> <itemizedlist> -<listitem><para>Zero or more blanks (which are ignored)</para></listitem> +<listitem><para>Zero or more whitespace characters (blank or horizontal tabs) +(which are ignored)</para></listitem> <listitem><para>A sequence of tokens (see <link linkend="xtokens">Tokens</link>)</para></listitem> -<listitem><para>Zero or more blanks (again ignored)</para></listitem> +<listitem><para>Zero or more whitespace characters (again +ignored)</para></listitem> <listitem><para>A semicolon (;) <indexterm><primary>semicolons</primary> <secondary>within a clause</secondary></indexterm> @@ -478,10 +480,13 @@ <para>Conceptually, each clause is scanned from left to right before processing, and the tokens composing it are identified. Instruction keywords are recognized at this stage, -comments are removed, and several blanks (except within literal strings) are -converted to single blanks. Blanks adjacent to operator characters and special +comments are removed, and sequences of whitespace characters (except within +literal strings) are converted to single blanks. Whitespace characters adjacent +to operator characters and special <indexterm><primary>blanks</primary> <secondary>adjacent to special character</secondary></indexterm> +<indexterm><primary>whitespace</primary> +<secondary>adjacent to special character</secondary></indexterm> characters are also removed.</para> <section id="characters"><title>Characters</title> @@ -630,8 +635,9 @@ <para>A <emphasis>token</emphasis> is the unit of low-level syntax from which clauses are built. Programs written in Rexx are composed of tokens. Tokens can be of any length, up to an implementation-restricted maximum. They are -separated by blanks or comments, or by the nature of the tokens themselves. -The classes of tokens are:</para> +separated by whitespace or comments, or by the nature of the tokens themselves. +The classes of tokens are: +</para> <itemizedlist> <listitem><para>Literal strings</para></listitem> <listitem><para>Hexadecimal strings</para></listitem> @@ -718,18 +724,20 @@ grouped in pairs. A single leading 0 is assumed, if necessary, at the beginning of the string to make an even number of hexadecimal digits. The groups of digits are optionally separated -by one or more blanks, and the whole sequence is delimited by single or double -quotation marks and immediately followed by the symbol +by one or more whitespace characters, and the whole sequence is delimited by +single or double quotation marks and immediately followed by the symbol <computeroutput>X</computeroutput> or <computeroutput>x</computeroutput>. Neither <computeroutput>x</computeroutput> nor -<computeroutput>X</computeroutput> can be part of a longer symbol. -The blanks, which can only be byte boundaries (and not at the beginning or -end of the string), are to improve readability. The language processor ignores -them.</para> +<computeroutput>X</computeroutput> can be part of a longer symbol. The +whitespace characters, which can only be byte boundaries (and not at the +beginning or end of the string), are to improve readability. The language +processor ignores them. +</para> <para>A hexadecimal string is a literal string formed by packing the hexadecimal -digits given. Packing the hexadecimal digits removes blanks and converts each -pair of hexadecimal digits into its equivalent character, for example, "41"X -to A.</para> +digits given. Packing the hexadecimal digits removes whitespace and converts +each pair of hexadecimal digits into its equivalent character, for example, +"41"X to A. +</para> <para>Hexadecimal strings let you include characters in a program even if you cannot directly enter the characters themselves. These are valid hexadecimal strings: </para> @@ -754,8 +762,9 @@ <tertiary>implementation maximum</tertiary></indexterm> <indexterm><primary>implementation maximum</primary> <secondary>hexadecimal strings</secondary></indexterm> -The packed length of a hexadecimal string (the string with blanks -removed) is unlimited.</para> +The packed length of a hexadecimal string (the string with whitespace removed) +is unlimited. +</para> </section> <section id="binstrings"><title>Binary Strings</title> @@ -778,15 +787,16 @@ <computeroutput>1</computeroutput>) in groups of 8 (bytes) or 4 (nibbles). The first group can have less than four digits; in this case, up to three 0 digits are assumed to the left of the first digit, making a total of four -digits. The groups of digits are optionally separated by one or more blanks, -and the whole sequence is delimited by matching single or double quotation -marks and immediately followed by the symbol +digits. The groups of digits are optionally separated by one or more whitespace +characters, and the whole sequence is delimited by matching single or double +quotation marks and immediately followed by the symbol <computeroutput>b</computeroutput> or <computeroutput>B</computeroutput>. Neither <computeroutput>b</computeroutput> nor <computeroutput>B</computeroutput> can be part of a longer symbol. The -blanks, which can only be byte or nibble boundaries (and not at the beginning -or end of the string), are to improve readability. The language processor -ignores them.</para> +whitespace characters, which can only be byte or nibble boundaries (and not at +the beginning or end of the string), are to improve readability. The language +processor ignores them. +</para> <para>A binary string is a literal string formed by packing the binary digits given. If the number of binary digits is not a multiple of 8, leading zeros are added on the left to make a multiple of 8 before packing. Binary strings @@ -905,10 +915,11 @@ <para>Numbers <indexterm><primary>restrictions</primary> <secondary>embedded in numbers</secondary></indexterm> -can have leading blanks (before and after the sign) and trailing blanks. Blanks -cannot be embedded among the digits of a number or in the exponential part. -Note that a symbol or a literal string can be a number. A number cannot be -the name of a variable.</para> +can have leading whitespace (before and after the sign) and trailing whitespace. +Whitespace characters cannot be embedded among the digits of a number or in the +exponential part. Note that a symbol or a literal string can be a number. A +number cannot be the name of a variable. +</para> <para>These are valid numbers: </para> <programlisting> 12 @@ -964,8 +975,9 @@ <tertiary>to indicate assignment</tertiary></indexterm> and the sequences <computeroutput>+=, -=, *= /=, %=, //=, ||=, &=, |=, and &&=</computeroutput> are also -used to indicate assignment. Blanks adjacent to operator characters are removed. -Therefore, the following are identical in meaning: </para> +used to indicate assignment. Whitespace characters adjacent to operator +characters are removed. Therefore, the following are identical in meaning: +</para> <programlisting> 345>=123 345 >=123 @@ -1026,12 +1038,13 @@ <para>These characters constitute the set of special characters. They all act as token delimiters, and <indexterm><primary>parentheses</primary> -<secondary>adjacent to blanks</secondary></indexterm> -blanks adjacent to any of these are removed. There -is an exception: a blank adjacent to the outside of a parenthesis or bracket -is deleted only if it is also adjacent to another special character (unless -the character is a parenthesis or bracket and the blank is outside it, too). -For example, the language processor does not remove the blank in +<secondary>adjacent to whitespace</secondary></indexterm> whitespace characters +(blank or horizontal tab) +adjacent to any of these are removed. There is an exception: a whitespace +character adjacent to the outside of a parenthesis or bracket is deleted only if +it is also adjacent to another special character (unless the character is a +parenthesis or bracket and the whitespace character is outside it, too). For +example, the language processor does not remove the blank in <computeroutput>A (Z)</computeroutput>. This is a concatenation that is not equivalent to <computeroutput>A(Z)</computeroutput>, a function call. The language processor removes the blanks in @@ -1226,12 +1239,12 @@ Each operator, except for the prefix operators, acts on two terms, which can be symbols, strings, function calls, message terms, intermediate results, or subexpressions. Each prefix operator acts on the term or subexpression -that follows it. Blanks (and comments) adjacent to operator characters have -no effect on the operator; thus, operators constructed from more than one -character can have embedded blanks and comments. In addition, one or more -blanks, if they occur in expressions but are not adjacent to another operator, -also act as an operator. The language processor functionally translates -operators into message terms. For dyadic operators, +that follows it. Whitespace characters (and comments) adjacent to operator +characters have no effect on the operator; thus, operators constructed from more +than one character can have embedded whitespace and comments. In addition, one +or more whitespace characters, if they occur in expressions but are not adjacent +to another operator, also act as an operator. The language processor +functionally translates operators into message terms. For dyadic operators, <indexterm><primary>dyadic operators</primary></indexterm> which operate on two terms, the language processor sends the operator as a message to the term on the left, @@ -1456,8 +1469,9 @@ involved are numeric, a numeric comparison (see <link linkend="numcom">Numeric Comparisons</link>) is effected. Otherwise, both terms are treated as character strings, leading -and trailing blanks are ignored, and the shorter string is padded with blanks -on the right.</para> +and trailing whitespace characters are ignored, and the shorter string is padded +with blanks on the right. +</para> <para>Character comparison and strict comparison operations are both case-sensitive, and the exact collating order might depend on the character set used for the implementation. In an ASCII environment, @@ -1974,8 +1988,9 @@ <secondary>null</secondary></indexterm> <indexterm><primary>null</primary> <secondary>clauses</secondary></indexterm> -<para>A clause consisting only of blanks, comments, or both -is a <emphasis>null clause</emphasis>. It is completely ignored.</para> +<para>A clause consisting only of whitespace characterss, comments, or both is a +<emphasis>null clause +</emphasis>. It is completely ignored.</para> <note><title>Note</title> <para>A null clause is not an instruction; for example, putting an extra Modified: docs/trunk/rexxref/numarit.sgml =================================================================== --- docs/trunk/rexxref/numarit.sgml 2009-01-01 21:42:50 UTC (rev 3845) +++ docs/trunk/rexxref/numarit.sgml 2009-01-01 21:46:24 UTC (rev 3846) @@ -54,8 +54,9 @@ <secondary>in numbers</secondary></indexterm> <para>This chapter gives an overview of the arithmetic facilities of the Rexx language.</para> -<para> Numbers can be expressed flexibly. Leading and trailing blanks are -permitted, and exponential notation can be used. Valid numbers are, for example: +<para> Numbers can be expressed flexibly. Leading and trailing whitespace +characters are permitted, and exponential notation can be used. Valid numbers +are, for example: </para> <programlisting> 12 /* a whole number */ @@ -70,19 +71,19 @@ <para>A number in Rexx is defined as follows:</para> <programlisting> <![CDATA[ ->>-+--------+--+------------------+--+-digits--------+----------> - +-blanks-+ +-sign--+--------+-+ +-digits.digits-+ - +-blanks-+ +-.digits-------+ - +-digits.-------+ +>>-+------------+--+----------------------+--+-digits--------+----------> + +-whitespace-+ +-sign--+------------+-+ +-digits.digits-+ + +-whitespace-+ +-.digits-------+ + +-digits.-------+ ->--+--------+-------------------------------------------------->< - +-blanks-+ +>--+------------+-------------------------------------------------->< + +-whitespace-+ ]]> </programlisting> <variablelist> -<varlistentry><term>blanks</term> -<listitem><para>are one or more spaces. +<varlistentry><term>whitespace</term> +<listitem><para>are one or more blanks or horizontal tab characters. </para></listitem></varlistentry> <varlistentry><term><emphasis role="italic">sign</emphasis></term> <listitem><para>is either <computeroutput>+</computeroutput> or @@ -331,13 +332,13 @@ <para>The definition of numbers is, therefore, extended as follows:</para> <programlisting> <![CDATA[ ->>-+--------+--+------------------+--+-digits--------+----------> - +-blanks-+ +-sign--+--------+-+ +-digits.digits-+ - +-blanks-+ +-.digits-------+ - +-digits.-------+ +>>-+------------+--+----------------------+--+-digits--------+----------> + +-whitespace-+ +-sign--+------------+-+ +-digits.digits-+ + +-whitesp... [truncated message content] |
From: <bi...@us...> - 2009-01-13 23:37:04
|
Revision: 3919 http://oorexx.svn.sourceforge.net/oorexx/?rev=3919&view=rev Author: bigrixx Date: 2009-01-13 23:36:59 +0000 (Tue, 13 Jan 2009) Log Message: ----------- multiple new method updates Modified Paths: -------------- docs/trunk/rexxpg/classes.sgml docs/trunk/rexxpg/concept.sgml docs/trunk/rexxref/dire.sgml docs/trunk/rexxref/fundclasses.sgml docs/trunk/rexxref/ooRexxMethodClass.odg docs/trunk/rexxref/ooRexxMethodClass.png docs/trunk/rexxref/ooRexxMutableBufferClass.odg docs/trunk/rexxref/ooRexxMutableBufferClass.png docs/trunk/rexxref/ooRexxPackageClass.odg docs/trunk/rexxref/ooRexxPackageClass.png docs/trunk/rexxref/ooRexxRoutineClass.odg docs/trunk/rexxref/ooRexxRoutineClass.png docs/trunk/rexxref/ooRexxStringClass.odg docs/trunk/rexxref/ooRexxStringClass.png docs/trunk/shared/gethelp.sgml Modified: docs/trunk/rexxpg/classes.sgml =================================================================== --- docs/trunk/rexxpg/classes.sgml 2009-01-13 21:53:11 UTC (rev 3918) +++ docs/trunk/rexxpg/classes.sgml 2009-01-13 23:36:59 UTC (rev 3919) @@ -1002,10 +1002,6 @@ named UNKNOWN. If it does, Rexx calls UNKNOWN, passing two arguments. The first is the name of the method that was not located. The second is an array containing the arguments passed with the original message.</para> -<para>To define an UNKNOWN message, you specify: </para> -<programlisting> -UNKNOWN(<emphasis role="italic">message_name,message_args</emphasis>) -</programlisting> </section> </section> Modified: docs/trunk/rexxpg/concept.sgml =================================================================== --- docs/trunk/rexxpg/concept.sgml 2009-01-13 21:53:11 UTC (rev 3918) +++ docs/trunk/rexxpg/concept.sgml 2009-01-13 23:36:59 UTC (rev 3919) @@ -191,7 +191,8 @@ an action, returning data, or both. A message to an object must specify:</para> <itemizedlist> <listitem><para>A receiving object</para></listitem> -<listitem><para>The "message send" symbol, ~, which is called the twiddle +<listitem><para>The "message send" symbol ~, which is called the +twiddle <indexterm><primary>~ (tilde, or twiddle)</primary></indexterm> <indexterm><primary>tilde (~)</primary></indexterm> <indexterm><primary>twiddle (~)</primary></indexterm> Modified: docs/trunk/rexxref/dire.sgml =================================================================== --- docs/trunk/rexxref/dire.sgml 2009-01-13 21:53:11 UTC (rev 3918) +++ docs/trunk/rexxref/dire.sgml 2009-01-13 23:36:59 UTC (rev 3919) @@ -710,10 +710,10 @@ say "In method" name </programlisting> <para>If the EXTERNAL option is specified, then <emphasis role="italic">spec</emphasis> -identifies a function in an external native library that will be defined as the +identifies a routine in an external native library that will be defined as the named routine for this program. The <emphasis role="italic">spec</emphasis> is a literal string containing a series of whitespace delimited tokens defining the -external function. The first token identifies the type of native function to +external function. The first token identifies the type of native routine to locate:</para> <variablelist> <varlistentry><term>LIBRARY</term> @@ -722,8 +722,8 @@ of the external library. The external library is located using platform-specific mechanisms for loading libraries. For Unix-based systems, the library name is case-sensitive. The third token is optional and specifies -the name of the function within the library package. If not specified, the -::ROUTINE name is used. The function name is not case sensitive. +the name of the routine within the library package. If not specified, the +::ROUTINE name is used. The routine name is not case sensitive. </para></listitem></varlistentry> <varlistentry><term>REGISTERED</term> <listitem><para>Identifies a routine in an older-style Rexx function package. Modified: docs/trunk/rexxref/fundclasses.sgml =================================================================== --- docs/trunk/rexxref/fundclasses.sgml 2009-01-13 21:53:11 UTC (rev 3918) +++ docs/trunk/rexxref/fundclasses.sgml 2009-01-13 23:36:59 UTC (rev 3919) @@ -5226,6 +5226,33 @@ </para> </section> +<section id="mthMethodLoadExternalMethod"><title>loadExternalMethod</title> +<indexterm><primary>loadExternalMethod method</primary> +<secondary>of Method class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>loadExternalMethod method</secondary> +<tertiary>of Method class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-loadExternalMethod(name,descriptor)------------------------>< +]]> +</programlisting> +<para>Resolves a native method in an external library package and returns a +Method object instance that can used to call the external method. The +<emphasis role="italic">descriptor</emphasis> is a string containing +blank-delimited tokens that identify the location of the native method. +function. The first token identifies the type of native function and must be +"LIBRARY". The second token must identify +the name of the external library. The external library is located using +platform-specific mechanisms for loading libraries. For Unix-based systems, the +library name is case-sensitive. The third token is optional and specifies the +name of the method within the library package. If not specified, +<emphasis role="italic">name</emphasis> is used. +The method name is not case sensitive. +If the target method cannot be resolved, .nil is returned. +</para> +</section> + <section id="mthMethodPackage"><title>package</title> <indexterm><primary>package method</primary> <secondary>of Method class</secondary></indexterm> @@ -5473,6 +5500,33 @@ </para> </section> +<section id="mthRoutineLoadExternalRoutine"><title>loadExternalRoutine</title> +<indexterm><primary>loadExternalRoutine method</primary> +<secondary>of Routine class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>loadExternalRoutine method</secondary> +<tertiary>of Routine class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-loadExternalRoutine(name,descriptor)------------------------>< +]]> +</programlisting> +<para>Resolves a native routine in an external library package and returns a +Routine object instance that can used to call the external routine. The +<emphasis role="italic">descriptor</emphasis> is a string containing +blank-delimited tokens that identify the location of the native routine. +function. The first token identifies the type of native routine and must be +"LIBRARY". The second token must identify +the name of the external library. The external library is located using +platform-specific mechanisms for loading libraries. For Unix-based systems, the +library name is case-sensitive. The third token is optional and specifies the +name of the routine within the library package. If not specified, +<emphasis role="italic">name</emphasis> is used. +The routine name is not case sensitive. If the target routine cannot be +resolved, .nil is returned. +</para> +</section> + <section id="mthRoutinePackage"><title>package</title> <indexterm><primary>package method</primary> <secondary>of Routine class</secondary></indexterm> @@ -5782,6 +5836,24 @@ packages.</para> </section> +<section id="mthPackageLoadLibrary"><title>loadLibrary</title> +<indexterm><primary>loadLibrary method</primary> +<secondary>of Package class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>loadLibrary method</secondary> +<tertiary>of Package class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-loadLibrary(name)----------------------------------------->< +]]> +</programlisting> +<para>Loads a native library package and adds it to the list of libraries loaded +by the interpreter. The <emphasis role="italic">name</emphasis> identifies a +native external library file that will be located and loaded as if it had been +named on a ::REQUIRES LIBRARY directive. If the library is successfully loaded, +loadLibrary will return 1 (true), other wise it returns 0 (false). +</section> + <section id="mthPackageLoadPackage"><title>loadPackage</title> <indexterm><primary>loadPackage method</primary> <secondary>of Package class</secondary></indexterm> @@ -5790,11 +5862,11 @@ <tertiary>of Package class</tertiary></indexterm> <programlisting> <![CDATA[ ->>-loadPackage(name-+--------+-)---------------------------->< - +-source-+ +>>-loadPackage(name-+---------+-)---------------------------->< + +-,source-+ ]]> </programlisting> -<para>Loads a package and addes it to the list of packages loaded by the package +<para>Loads a package and adds it to the list of packages loaded by the package manager. If only <emphasis role="italic">name</emphasis> is specified, <emphasis role="italic">name</emphasis> identifies a file that will be located and loaded as if it had been named on a ::REQUIRES directive. If Modified: docs/trunk/rexxref/ooRexxMethodClass.odg =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/ooRexxMethodClass.png =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/ooRexxMutableBufferClass.odg =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/ooRexxMutableBufferClass.png =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/ooRexxPackageClass.odg =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/ooRexxPackageClass.png =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/ooRexxRoutineClass.odg =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/ooRexxRoutineClass.png =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/ooRexxStringClass.odg =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/ooRexxStringClass.png =================================================================== (Binary files differ) Modified: docs/trunk/shared/gethelp.sgml =================================================================== --- docs/trunk/shared/gethelp.sgml 2009-01-13 21:53:11 UTC (rev 3918) +++ docs/trunk/shared/gethelp.sgml 2009-01-13 23:36:59 UTC (rev 3919) @@ -69,7 +69,7 @@ <variablelist> <varlistentry><term>The ooRexx Forums</term> <listitem><para>The ooRexx project maintains a set of forums that anyone -my contribute to or monitor. They are located on the +may contribute to or monitor. They are located on the <ulink url="http://sourceforge.net/forum/?group_id=119701"> <citetitle>ooRexx Forums</citetitle></ulink> page. There are currently three forums available: Help, Developers and Open @@ -80,8 +80,10 @@ <listitem><para>You can subscribe to the oorexx-devel mailing list at <ulink url="http://sourceforge.net/mail/?group_id=119701"> <citetitle>ooRexx Mailing List Subscriptions</citetitle></ulink> page. -This list is for discussing ooRexx project development activities. -It also supports a historical archive of past messages.</para></listitem> +This list is for discussing ooRexx project development activities and future +interpreter enhancements. It also supports a historical archive of past +messages. +</para></listitem> </varlistentry> <varlistentry><term>The Users Mailing List</term> <listitem><para>You can subscribe to the oorexx-users mailing list at This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-01-16 00:04:45
|
Revision: 3926 http://oorexx.svn.sourceforge.net/oorexx/?rev=3926&view=rev Author: bigrixx Date: 2009-01-16 00:04:43 +0000 (Fri, 16 Jan 2009) Log Message: ----------- [ 2505667 ] Document new PRIVATE method rules. Modified Paths: -------------- docs/trunk/rexxpg/classes.sgml docs/trunk/rexxpg/provide.sgml docs/trunk/rexxref/dire.sgml docs/trunk/rexxref/fundclasses.sgml Modified: docs/trunk/rexxpg/classes.sgml =================================================================== --- docs/trunk/rexxpg/classes.sgml 2009-01-15 23:13:17 UTC (rev 3925) +++ docs/trunk/rexxpg/classes.sgml 2009-01-16 00:04:43 UTC (rev 3926) @@ -987,12 +987,58 @@ <secondary>private</secondary></indexterm> <para>A method can be public or private. Any object can send a message that runs a public method. -Only a message an object sends to itself, using the special variable SELF -as the message receiver, can run a private method. -Private methods include methods at different scopes within the same object. +A private method can only be invoked from specific calling contexts. These contexts are:</para> +<orderedlist> +<listitem><para>From within a method owned by the same class as the target. This is frequently +the same object, accessed via the special variable SELF. Private methods of an object can also +be accessed from other instances of the same class (or subclass instances). +</para></listitem> +<listitem><para>From within a method defined at the same class scope as the method. For example:</para> +<programlisting> +<![CDATA[ +::class Savings +::method newCheckingAccount CLASS + instance = .self~new + instance~makeChecking + return instance + +::method makeChecking private + expose checking + checking = .true +]]> +</programlisting> +<para>The newCheckingAccount CLASS method is able to invoke the makeChecking method because +the scope of the makeChecking method is .Savings. +</para></listitem> +<listitem><para>From within an instance (or subclass instance) of a class to a private class +method of its class. For example:</para> +<programlisting> +<![CDATA[ +::class Savings +::method init class + expose counter + counter = 0 + +::method allocateAccountNumber private class + expose counter + counter = counter + 1 + return counter + +::method init + expose accountNumber + accountNumber = self~class~allocateAccountNumber +]]> +</programlisting> +<para>The instance init method of the Savings class is able to invoke the allocateAccountNumber private +method of the .Savings class object because it is owned by an instance of the .Savings class.</para> +</listitem> +</orderedlist> +<para>Private methods include methods at different scopes within the same object. This allows superclasses to make methods available to their subclasses while hiding those methods from other objects. A private method is like an internal -subroutine. It shields the internal information of an object.</para> +subroutine. It shields the internal information of an object to outsiders, but allowing +objects to share information with each other and their defining classes. +</para> </section> <section id="unknown"><title>Defining an UNKNOWN Method</title> Modified: docs/trunk/rexxpg/provide.sgml =================================================================== --- docs/trunk/rexxpg/provide.sgml 2009-01-15 23:13:17 UTC (rev 3925) +++ docs/trunk/rexxpg/provide.sgml 2009-01-16 00:04:43 UTC (rev 3926) @@ -475,7 +475,7 @@ <listitem><para>Creating a class method for the most-recent ::CLASS directive (the CLASS option).</para></listitem> <listitem><para>Creating a private method; that is, a method that -works like a subroutine and can only be activated by the object it belongs +works like a subroutine and can only be activated by the objects of the same type it belongs to--otherwise the method is public by default, and any sender can activate it.</para></listitem> <listitem><para>Creating a method that can be called while other methods are active on Modified: docs/trunk/rexxref/dire.sgml =================================================================== --- docs/trunk/rexxref/dire.sgml 2009-01-15 23:13:17 UTC (rev 3925) +++ docs/trunk/rexxref/dire.sgml 2009-01-16 00:04:43 UTC (rev 3926) @@ -197,7 +197,10 @@ <listitem><para>You can specify all options in any order. </para></listitem> <listitem><para>If you specify the PRIVATE option, the created methods are -private methods. (Only a message the same object sends can activate the method.) +private methods. Private methods have restricted access rules on how they can +be invoked. +See <link linkend="public">Public versus Private Methods</link> +for details of how private methods can be used. If you omit the PRIVATE option or specify PUBLIC, the method is a public method that any sender can activate. </para></listitem> @@ -553,10 +556,14 @@ <orderedlist> <listitem><para>You can specify all options in any order. </para></listitem> -<listitem><para>If you specify the PRIVATE option, the method is a private -method. (Only a message the same object sends can activate the -method.) If you omit the PRIVATE option or specify PUBLIC, the method is a public method -that any sender can activate.</para></listitem> +<listitem><para>If you specify the PRIVATE option, the created methods are +private methods. Private methods have restricted access rules on how they can +be invoked. +See <link linkend="public">Public versus Private Methods</link> +for details of how private methods can be used. +If you omit the PRIVATE option or specify PUBLIC, the method is a public method +that any sender can activate. +</para></listitem> <listitem><para>If you <indexterm><primary>UNGUARDED option of ::METHOD</primary></indexterm> specify the UNGUARDED option, the method can be called while other methods are active on Modified: docs/trunk/rexxref/fundclasses.sgml =================================================================== --- docs/trunk/rexxref/fundclasses.sgml 2009-01-15 23:13:17 UTC (rev 3925) +++ docs/trunk/rexxref/fundclasses.sgml 2009-01-16 00:04:43 UTC (rev 3926) @@ -306,15 +306,16 @@ <para>Returns <computeroutput>1</computeroutput> (true) if the receiver object has a method named <emphasis role="italic">methodname</emphasis> -(translated to uppercase) or if the target method is a private method. +(translated to uppercase). Otherwise, it returns <computeroutput>0</computeroutput> (false). </para> <note><title>Note</title> -<para>If you call the <emphasis role="italic">methodname</emphasis> method -although it is private, you receive error 97 -<computeroutput>Object method not found</computeroutput> although -<emphasis role="bold">hasMethod</emphasis> -returns <computeroutput>1</computeroutput> (true).</para></note> +<para>The hasMethod object will return true even if the target method is defined +as private. A private method has restricted access rules, so its possible to +receive an unknown method error (error 97) even if hasMethod indicates the method exits. +See <link linkend="public">Public versus Private Methods</link> +for private method restrictions. +</para></note> </section> <section id="mthObjectIdentityHash"><title>identityHash</title> @@ -600,8 +601,10 @@ <para><emphasis role="bold">Notes:</emphasis></para> <orderedlist> <listitem><para>The <emphasis role="bold">run</emphasis> method is a -private method. See the <emphasis role="bold">setPrivate</emphasis> method -in <link linkend="mthMethodSetPrivate">setPrivate</link> for details.</para></listitem> +private method. +See <link linkend="public">Public versus Private Methods</link> +for information private method restrictions. +</para></listitem> <listitem><para>The RUN method is a protected method.</para></listitem> </orderedlist> </section> @@ -651,8 +654,10 @@ <para><emphasis role="bold">Notes:</emphasis></para> <orderedlist> <listitem><para>The <emphasis role="bold">setMethod</emphasis> -method is a private method. See the <emphasis role="bold">setPrivate</emphasis> -method in <link linkend="mthMethodSetPrivate">setPrivate</link> for details.</para> +method is a private method. +See the <emphasis role="bold">setPrivate</emphasis> method +in <link linkend="mthMethodSetPrivate">setPrivate</link> for details. +</para> </listitem> <listitem><para>The <emphasis role="bold">setMethod</emphasis> method is a protected method.</para></listitem> @@ -780,8 +785,10 @@ <para><emphasis role="bold">Notes:</emphasis></para> <orderedlist> <listitem><para>The <emphasis role="bold">unsetMethod</emphasis> -method is a private method. See the <emphasis role="bold">setPrivate</emphasis> -method in <link linkend="mthMethodSetPrivate">setPrivate</link> for details.</para> +method is a private method. +See the <emphasis role="bold">setPrivate</emphasis> method +in <link linkend="mthMethodSetPrivate">setPrivate</link> for details. +</para> </listitem> <listitem><para>The <emphasis role="bold">unsetMethod</emphasis> method is a protected method.</para></listitem> @@ -5208,6 +5215,8 @@ ]]> </programlisting> <para>Returns true ("1") if the method is a Private method. Returns false ("0") for Public methods. +See <link linkend="public">Public versus Private Methods</link> +for details on private method restrictions. </para> </section> @@ -5301,13 +5310,11 @@ ]]> </programlisting> -<para>Specifies that a method is a private method. Only -a message that an object sends to itself can run a private method. If a method -object does not receive a <emphasis role="bold">setPrivate</emphasis> -message, the method is a public method. -(Any object can send a message to run a public method. See -<link linkend="pubpri">Public and Private Methods</link> for -details.)</para> +<para>Specifies that a method is a private method. +By default, method objects are created as public methods. +See <link linkend="public">Public versus Private Methods</link> +for details on private method restrictions. +</para> </section> <section id="mthMethodSetProtected"><title>setProtected</title> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <sah...@us...> - 2009-01-21 06:29:55
|
Revision: 3985 http://oorexx.svn.sourceforge.net/oorexx/?rev=3985&view=rev Author: sahananda Date: 2009-01-21 06:29:52 +0000 (Wed, 21 Jan 2009) Log Message: ----------- source for diagram - correct page size for rxo90004 Modified Paths: -------------- docs/trunk/rexxpg/rxo90004.odg docs/trunk/rexxpg/rxo90004.png docs/trunk/rexxref/rxo90004.odg docs/trunk/rexxref/rxo90004.png Added Paths: ----------- docs/trunk/rexxpg/rxo90005.odg docs/trunk/rexxpg/rxo90005.png docs/trunk/rexxref/rxo90005.odg docs/trunk/rexxref/rxo90005.png Modified: docs/trunk/rexxpg/rxo90004.odg =================================================================== (Binary files differ) Modified: docs/trunk/rexxpg/rxo90004.png =================================================================== (Binary files differ) Added: docs/trunk/rexxpg/rxo90005.odg =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxpg/rxo90005.odg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: docs/trunk/rexxpg/rxo90005.png =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxpg/rxo90005.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: docs/trunk/rexxref/rxo90004.odg =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/rxo90004.png =================================================================== (Binary files differ) Added: docs/trunk/rexxref/rxo90005.odg =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxref/rxo90005.odg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: docs/trunk/rexxref/rxo90005.png =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxref/rxo90005.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mie...@us...> - 2009-01-29 13:52:35
|
Revision: 4029 http://oorexx.svn.sourceforge.net/oorexx/?rev=4029&view=rev Author: miesfeld Date: 2009-01-29 13:52:30 +0000 (Thu, 29 Jan 2009) Log Message: ----------- Continue ooDialog doc update Modified Paths: -------------- docs/trunk/oodialog/overview.sgml docs/trunk/oodialog/utilityclasses.sgml docs/trunk/shared/gethelp.sgml Modified: docs/trunk/oodialog/overview.sgml =================================================================== --- docs/trunk/oodialog/overview.sgml 2009-01-29 00:31:49 UTC (rev 4028) +++ docs/trunk/oodialog/overview.sgml 2009-01-29 13:52:30 UTC (rev 4029) @@ -44,7 +44,7 @@ <chapter id="chapOverview"><title>Brief Overview</title> <indexterm><primary>overview</primary></indexterm> <para> - ooDialog is a <emphasis role="italic">framework</emphasis> that helps the ooRexx programmers to add + ooDialog is a <emphasis role="italic">framework</emphasis> that aids ooRexx programmers in adding graphical elements to their Rexx progamms. The framework provides the base infrastructure, through a number of classes, that the programmer builds on to quickly produce Windows dialogs. This book is a reference to the ooDialog classes, methods, and utilities that make up the base infrastructure. @@ -582,12 +582,77 @@ <section id="sectooDialogFuture"><title>ooDialog 4.0.0 and the future</title> <indexterm><primary>future directions</primary></indexterm> <para> - Unfortunately, there is little documentation for the newcomer on how to get started using ooDialog. - Until that type of documentation can be written, the sample ooDialog programs that accompany the - ooRexx distribution are probably the best source of help in getting started. However, there are also - numerous snippets of example code in this book. + ooDialog is now open source, being developed by committers who volunter their time. It is no longer + developed by IBM. ooRexx 4.0.0 has introduced a greatly improved native API for extenal packages. + ooDialog is being converted to use the new API. </para> +<para> + What are the implications of these facts? +</para> +<itemizedlist> +<listitem> + <para> + Bug fixes and the addition of new features can only be done at the pace of the committers free + time. + </para> +</listitem> +<listitem> + <para> + Users of ooDialog can directly influence the future direction of ooDialog through participation in + the project. Primarily by filing bug reports, opening requests for features, and discussing on the + <link linkend="helpUsersList">users</link> or <link linkend="helpDevelList">developers</link> list + what they would like to see, or not see. + </para> +</listitem> +<listitem> + <para> + The new API will make it easier to add new features that are more robust. This should allow + ooDialog to add the newer GUI elements of Windows XP and Vista in a reasonable time frame. + </para> +</listitem> +<listitem> + <para> + The new API makes some change in behavior of ooDialog methods unavoidable. + </para> +</listitem> +</itemizedlist> +<para> + The purpose of this section is to briefly expand upon the implications above and outline the direction + ooDialog is currently taking. The point of this is to make users aware of what to look for in version + 4.0.0 and so that they can influence the direction taken, if they choose to. +</para> +<variablelist> +<varlistentry><term>New Classes</term> +<listitem> + <para> + value + </para> +</listitem></varlistentry> +<varlistentry><term>Objects as arguments</term> +<listitem> + <para> + + </para> +</listitem></varlistentry> +<varlistentry><term>Objects as return values</term> +<listitem> + <para> + + </para> +</listitem></varlistentry> +<varlistentry><term>Syntax errors</term> +<listitem> + <para> + + </para> +</listitem></varlistentry> +<varlistentry><term>Deprecated methods</term> +<listitem> + <para> + + </para> +</listitem></varlistentry> +</variablelist> </section> - </chapter> Modified: docs/trunk/oodialog/utilityclasses.sgml =================================================================== --- docs/trunk/oodialog/utilityclasses.sgml 2009-01-29 00:31:49 UTC (rev 4028) +++ docs/trunk/oodialog/utilityclasses.sgml 2009-01-29 13:52:30 UTC (rev 4029) @@ -643,8 +643,8 @@ parse value self~getWindowRect(self~dlgHandle) with x y . do dlg over dialogQueue - x = x + offSetX - y = y + offSetY + x += offSetX + y += offSetY self~setWindowRect(dlg~dlgHandle, x, y, 0, 0, "NOSIZE") end Modified: docs/trunk/shared/gethelp.sgml =================================================================== --- docs/trunk/shared/gethelp.sgml 2009-01-29 00:31:49 UTC (rev 4028) +++ docs/trunk/shared/gethelp.sgml 2009-01-29 13:52:30 UTC (rev 4029) @@ -76,7 +76,7 @@ Discussion. In addition, you can monitor the forums via email. </para></listitem> </varlistentry> -<varlistentry><term>The Developer Mailing List</term> +<varlistentry id="helpDevelList"><term>The Developer Mailing List</term> <listitem><para>You can subscribe to the oorexx-devel mailing list at <ulink url="http://sourceforge.net/mail/?group_id=119701"> <citetitle>ooRexx Mailing List Subscriptions</citetitle></ulink> page. @@ -85,7 +85,7 @@ messages. </para></listitem> </varlistentry> -<varlistentry><term>The Users Mailing List</term> +<varlistentry id="helpUsersList"><term>The Users Mailing List</term> <listitem><para>You can subscribe to the oorexx-users mailing list at <ulink url="http://sourceforge.net/mail/?group_id=119701"> <citetitle>ooRexx Mailing List Subscriptions</citetitle></ulink> page. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <sah...@us...> - 2009-01-30 07:00:49
|
Revision: 4032 http://oorexx.svn.sourceforge.net/oorexx/?rev=4032&view=rev Author: sahananda Date: 2009-01-30 07:00:45 +0000 (Fri, 30 Jan 2009) Log Message: ----------- source for diagram Modified Paths: -------------- docs/trunk/rexxpg/rxo90005.odg docs/trunk/rexxpg/rxo90005.png docs/trunk/rexxref/rxo90005.odg docs/trunk/rexxref/rxo90005.png Added Paths: ----------- docs/trunk/rexxpg/rox900006.png docs/trunk/rexxpg/rxo90006.odg docs/trunk/rexxpg/rxo90007.odg docs/trunk/rexxpg/rxo90007.png docs/trunk/rexxref/rox900006.png docs/trunk/rexxref/rxo90006.odg docs/trunk/rexxref/rxo90007.odg docs/trunk/rexxref/rxo90007.png Added: docs/trunk/rexxpg/rox900006.png =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxpg/rox900006.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: docs/trunk/rexxpg/rxo90005.odg =================================================================== (Binary files differ) Modified: docs/trunk/rexxpg/rxo90005.png =================================================================== (Binary files differ) Added: docs/trunk/rexxpg/rxo90006.odg =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxpg/rxo90006.odg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: docs/trunk/rexxpg/rxo90007.odg =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxpg/rxo90007.odg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: docs/trunk/rexxpg/rxo90007.png =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxpg/rxo90007.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: docs/trunk/rexxref/rox900006.png =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxref/rox900006.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: docs/trunk/rexxref/rxo90005.odg =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/rxo90005.png =================================================================== (Binary files differ) Added: docs/trunk/rexxref/rxo90006.odg =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxref/rxo90006.odg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: docs/trunk/rexxref/rxo90007.odg =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxref/rxo90007.odg ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: docs/trunk/rexxref/rxo90007.png =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxref/rxo90007.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-01-31 18:08:09
|
Revision: 4037 http://oorexx.svn.sourceforge.net/oorexx/?rev=4037&view=rev Author: bigrixx Date: 2009-01-31 18:08:03 +0000 (Sat, 31 Jan 2009) Log Message: ----------- add docs for send(), sendWith(), and startWith() Modified Paths: -------------- docs/trunk/rexxpg/api.sgml docs/trunk/rexxref/fundclasses.sgml Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-01-31 18:07:00 UTC (rev 4036) +++ docs/trunk/rexxpg/api.sgml 2009-01-31 18:08:03 UTC (rev 4037) @@ -4602,7 +4602,7 @@ <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> <varlistentry><term><emphasis role="italic">n</emphasis></term> - <listitem><para>The integer to be converted or the location to return the converted integer.</para></listitem> + <listitem><para>The integer to be converted or the location for returning the converted integer.</para></listitem> </varlistentry> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx object to be converted.</para></listitem> @@ -5805,7 +5805,7 @@ >>--obj = context->NewMethod(name, code, sz);---------------------------->< ]]> </programlisting> -<para>Add a new method to the cuurrent context (method, function or thread). +<para>Create a new Method object from an in-memory buffer. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5813,7 +5813,7 @@ <listitem><para>ASCII-Z name of the Rexx method.</para></listitem> </varlistentry> <varlistentry><term><emphasis role="italic">code</emphasis></term> - <listitem><para>A data buffer containing the new method Rexx code.</para></listitem> + <listitem><para>A data buffer containing the new method's Rexx code.</para></listitem> </varlistentry> <varlistentry><term><emphasis role="italic">sz</emphasis></term> <listitem><para>Size of the <emphasis role="italic">code</emphasis> buffer.</para></listitem> @@ -5871,7 +5871,7 @@ </varlistentry> </variablelist> <para><emphasis role="bold">Returns</emphasis></para> -<para>The create Pointer object.</para> +<para>The created Pointer object.</para> </section> <section id="mthNewRoutine"><title>NewRoutine</title> @@ -5910,7 +5910,7 @@ >>--obj = context->NewRoutine(name, code, sz);--------------------------->< ]]> </programlisting> -<para>Create a new Routine object. +<para>Create a new Routine object from an in-memory buffer. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -5918,7 +5918,7 @@ <listitem><para>ASCII-Z name of the Rexx routine.</para></listitem> </varlistentry> <varlistentry><term><emphasis role="italic">code</emphasis></term> - <listitem><para>Buffer containing the routine Rexx code..</para></listitem> + <listitem><para>Buffer containing the routine Rexx code.</para></listitem> </varlistentry> <varlistentry><term><emphasis role="italic">sz</emphasis></term> <listitem><para>Size of the <emphasis role="italic">code</emphasis> buffer.</para></listitem> @@ -6017,7 +6017,7 @@ >>--obj = context->NewString(str);--------------------------------------->< ]]> </programlisting> -<para>There are two forms of this method. Both create a new Rexx String object from a C string. +<para>There are two forms of this method. Both create a new Rexx String object from program data. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -6264,11 +6264,13 @@ <listitem><para>The source Rexx object for the conversion.</para></listitem> </varlistentry> <varlistentry><term><emphasis role="italic">n</emphasis></term> - <listitem><para>A pointer to the location to store the converted double result.</para></listitem> + <listitem><para>A pointer to the location that receives the converted double result.</para></listitem> </varlistentry> </variablelist> <para><emphasis role="bold">Returns</emphasis></para> -<para>1 = success, 0 = conversion error.</para> +<para>1 = success, 0 = conversion error. The converted value is stored in the +location pointed to by <emphasis role="italic">n</emphasis>. +</para> </section> <section id="mthObjectToInt32"><title>ObjectToInt32</title> @@ -6567,7 +6569,7 @@ >>--flag = context->ObjectToStringSize(obj, &n);------------------------->< ]]> </programlisting> -<para>Convert a Rexx object to a string size number value. +<para>Convert a Rexx object to a stringsize_t number value. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -6628,7 +6630,7 @@ </varlistentry> </variablelist> <para><emphasis role="bold">Returns</emphasis></para> -<para>The C ASCII-Z string.</para> +<para>The C ASCII-Z string representation of the object.</para> </section> <section id="mthObjectToUintptr"><title>ObjectToUintptr</title> @@ -6824,7 +6826,12 @@ >>--flag = context->ObjectToValue(obj, &desc);--------------------------->< ]]> </programlisting> -<para>Convert a Rexx object to a ValueDescriptor struct. +<para>Convert a Rexx object to another type. The target type is identified +by the ValueDescriptor structure, and can by any of the types that may be +used as a method or routine return types. For many conversions, it may be +more appropriate to use more targetted routins such as ObjectToWholeNumber(). +ObjectToValue is capable of conversions to types such as int8_t for which +there are no specific conversion APIs. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -6832,11 +6839,16 @@ <listitem><para>The Rexx object to be converted.</para></listitem> </varlistentry> <varlistentry><term><emphasis role="italic">desc</emphasis></term> - <listitem><para>A C pointer to a ValueDescriptor struct to receive the converted data.</para></listitem> + <listitem><para>A C pointer to a ValueDescriptor struct that identifies + the conversion type. The converted value will be stored in the ValueDescriptor if successful. + </para></listitem> </varlistentry> </variablelist> <para><emphasis role="bold">Returns</emphasis></para> -<para>0 = success, 1 = conversion error.</para> +<para>1 = success, 0 = conversion error. If successful, +<emphasis role="italic">desc</emphasis> is updated with the converted +value of the requested type. +</para> </section> <section id="mthObjectToWholeNumber"><title>ObjectToWholeNumber</title> @@ -6927,7 +6939,7 @@ >>--p = context->PointerValue(obj);-------------------------------------->< ]]> </programlisting> -<para>Return the C pointer value from a RexxPointerObject. +<para>Return the wrappered C pointer value from a RexxPointerObject. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -6936,7 +6948,7 @@ </varlistentry> </variablelist> <para><emphasis role="bold">Returns</emphasis></para> -<para>A C pointer value.</para> +<para>The wrappered C pointer value.</para> </section> <section id="mthRaiseCondition"><title>RaiseCondition</title> @@ -6973,10 +6985,11 @@ RexxArrayObject arr; RexxObjectPtr obj[ ->>--context->RaiseCondition(str, sobj, arr obj);------------------------->< +>>--context->RaiseCondition(str, sobj, arr, obj);------------------------->< ]]> </programlisting> -<para>Raise a condition. +<para>Raise a condition. The raised condition is held in a pending +state until the method, routine, or exit returns to the Rexx runtime. </para> <para><emphasis role="bold">Arguments</emphasis></para> <variablelist> @@ -6984,10 +6997,10 @@ <listitem><para>The condition name.</para></listitem> </varlistentry> <varlistentry><term><emphasis role="italic">sobj</emphasis></term> - <listitem><para>The condition number as a Rexx string object.</para></listitem> + <listitem><para>The condition description as a Rexx String object.</para></listitem> </varlistentry> <varlistentry><term><emphasis role="italic">arr</emphasis></term> - <listitem><para>A Rexx array object containing the substitutable arguments for the condition message.</para></listitem> + <listitem><para>A Rexx array object containing additional information for the condition.</para></listitem> </varlistentry> <varlistentry><term><emphasis role="italic">obj</emphasis></term> <listitem><para>The Rexx object which caused the condition.</para></listitem> Modified: docs/trunk/rexxref/fundclasses.sgml =================================================================== --- docs/trunk/rexxref/fundclasses.sgml 2009-01-31 18:07:00 UTC (rev 4036) +++ docs/trunk/rexxref/fundclasses.sgml 2009-01-31 18:08:03 UTC (rev 4037) @@ -609,6 +609,109 @@ </orderedlist> </section> +<section id="mthObjectSend"><title>send</title> +<indexterm><primary>send method</primary> +<secondary>of Object class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>send method</secondary> +<tertiary>of Object class</tertiary></indexterm> +<programlisting> +<![CDATA[ + +---------------+ + V | +>>-send(messagename---+-----------+-+-)----------------------->< + +-,argument-+ +]]> +</programlisting> + +<para>Returns a result of invoking a method on the target object +using the specified messange name and arguments. +The send() method allows methods to be invoked using dynamically +constructed method names. +</para> +<para>The <emphasis role="italic">messagename</emphasis> can be a string or +an array. If <emphasis role="italic">messagename</emphasis> is an array object, +its first item is the name of the message and its +second item is a class object to use as the starting point for the method +search. For more information, see +<link linkend="meths1">Classes and Inheritance</link>.</para> +<para>The language processor passes any +<emphasis role="italic">argument</emphasis>s to the receiver as +arguments for <emphasis role="italic">messagename</emphasis> in the order you +specify them.</para> +<para><emphasis role="bold">Example:</emphasis></para> +<programlisting> +world=.WorldObject~new +// the following 3 calls are equivalent +msg1=world~hello("Fred") +msg2=world~send("HELLO", "Fred") +msg3=.message~new(world,"HELLO", "i", "Fred")~~send + +say msg1~result /* Produces Hello Fred 21:04:25.065000 */ + /* for example */ +say msg2~result /* Produces Hello Fred 21:04:25.081000 */ + /* for example */ +say msg3~result /* Produces Hello Fred 21:04:25.101000 */ + /* for example */ + +::class 'WorldObject' public +::method hello + use arg name + return "Hello" name time('L') +</programlisting> +</section> + +<section id="mthObjectSendWith"><title>sendWith</title> +<indexterm><primary>sendWith method</primary> +<secondary>of Object class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>sendWith method</secondary> +<tertiary>of Object class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-sendWith(messagename,arguments)-------------------------------->< +]]> +</programlisting> + +<para>Returns a result of invoking a method on the target object +using the specified messange name and arguments. +The send() method allows methods to be invoked using dynamically +constructed method names and arguments. +</para> +<para>The <emphasis role="italic">messagename</emphasis> can be a string or +an array. If <emphasis role="italic">messagename</emphasis> is an array object, +its first item is the name of the message and its +second item is a class object to use as the starting point for the method +search. For more information, see +<link linkend="meths1">Classes and Inheritance</link>.</para> +<para>The <emphasis role="italic">arguments</emphasis> argument must be +a single-dimension array instance. +The language processor passes the values contained in +<emphasis role="italic">arguments</emphasis> to the receiver as +arguments for <emphasis role="italic">messagename</emphasis> in the order you +specify them.</para> +<para><emphasis role="bold">Example:</emphasis></para> +<programlisting> +world=.WorldObject~new +// the following 3 calls are equivalent +msg1=world~hello("Fred") +msg2=world~sendWith("HELLO", .array~of("Fred")) +msg3=.message~new(world,"HELLO", "A", .array~of("Fred"))~~send + +say msg1~result /* Produces Hello Fred 21:04:25.065000 */ + /* for example */ +say msg2~result /* Produces Hello Fred 21:04:25.081000 */ + /* for example */ +say msg3~result /* Produces Hello Fred 21:04:25.101000 */ + /* for example */ + +::class 'WorldObject' public +::method hello + use arg name + return "Hello" name time('L') +</programlisting> +</section> + <section id="mthObjectSetMethod"><title>setMethod</title> <indexterm><primary>setMethod method</primary> <secondary>of Object class</secondary></indexterm> @@ -717,6 +820,59 @@ </programlisting> </section> +<section id="mthObjectStartWith"><title>startWith</title> +<indexterm><primary>startWith method</primary> +<secondary>of Object class</secondary></indexterm> +<indexterm><primary>method</primary> +<secondary>startWith method</secondary> +<tertiary>of Object class</tertiary></indexterm> +<programlisting> +<![CDATA[ +>>-startWith(messagename,arguments)-------------------------------->< +]]> +</programlisting> + +<para>Returns a message object (see +<link linkend="clsMessage">The Message Class</link>) and sends it a +<emphasis role="bold">start</emphasis> message +to start concurrent processing. The object receiving the message +<emphasis role="italic">messagename</emphasis> processes this message +concurrently with the sender's continued processing.</para> +<para>The <emphasis role="italic">messagename</emphasis> can be a string or +an array. If <emphasis role="italic">messagename</emphasis> is an array object, +its first item is the name of the message and its +second item is a class object to use as the starting point for the method +search. For more information, see +<link linkend="meths1">Classes and Inheritance</link>.</para> +<para>The <emphasis role="italic">arguments</emphasis> argument must be +a single-dimension array instance. +The language processor passes the values contained in +<emphasis role="italic">arguments</emphasis> to the receiver as +arguments for <emphasis role="italic">messagename</emphasis> in the order you +specify them.</para> +<para>When the receiver object has finished processing the message, the message +object retains its result and holds it until the sender requests it by sending +a <emphasis role="bold">result</emphasis> message. For further details, +see <link linkend="mthMessageStart">start</link>. +</para> +<para><emphasis role="bold">Example:</emphasis></para> +<programlisting> +world=.WorldObject~new +msg1=world~startWith("HELLO", .array~of("Fred") /* same as next line */ +msg2=.message~new(world,"HELLO", 'i', .array~of("Fred"))~~start /* same as previous line */ + +say msg1~result /* Produces Hello Fred 21:04:25.065000 */ + /* for example */ +say msg2~result /* Produces Hello Fred 21:04:25.081000 */ + /* for example */ + +::class 'WorldObject' public +::method hello + use arg name + return "Hello" name time('L') +</programlisting> +</section> + <section id="mthObjectString"><title>string</title> <indexterm><primary>string method</primary> <secondary>of Object class</secondary></indexterm> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-04 00:55:16
|
Revision: 4060 http://oorexx.svn.sourceforge.net/oorexx/?rev=4060&view=rev Author: bigrixx Date: 2009-02-04 00:55:12 +0000 (Wed, 04 Feb 2009) Log Message: ----------- Start switching over to new graphic versions created by Jon Modified Paths: -------------- docs/trunk/rexxpg/concept.sgml docs/trunk/rexxref/intro.sgml Added Paths: ----------- docs/trunk/rexxpg/ReportObject.odg docs/trunk/rexxpg/ReportObject.png docs/trunk/rexxref/ReportObject.odg docs/trunk/rexxref/ReportObject.png Removed Paths: ------------- docs/trunk/rexxpg/rxo90004.jpg docs/trunk/rexxpg/rxo90004.odg docs/trunk/rexxpg/rxo90004.png docs/trunk/rexxref/rxo90004.jpg docs/trunk/rexxref/rxo90004.odg docs/trunk/rexxref/rxo90004.png Copied: docs/trunk/rexxpg/ReportObject.odg (from rev 4058, docs/trunk/rexxpg/rxo90004.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/ReportObject.png (from rev 4058, docs/trunk/rexxpg/rxo90004.png) =================================================================== (Binary files differ) Modified: docs/trunk/rexxpg/concept.sgml =================================================================== --- docs/trunk/rexxpg/concept.sgml 2009-02-04 00:47:59 UTC (rev 4059) +++ docs/trunk/rexxpg/concept.sgml 2009-02-04 00:55:12 UTC (rev 4060) @@ -91,7 +91,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90004.jpg" scale="75"> +<imagedata fileref="ReportObject.jpg" scale="75"> </imageobject> </mediaobject> </figure> Deleted: docs/trunk/rexxpg/rxo90004.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90004.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90004.png =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/ReportObject.odg (from rev 4058, docs/trunk/rexxref/rxo90004.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/ReportObject.png (from rev 4058, docs/trunk/rexxref/rxo90004.png) =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/intro.sgml =================================================================== --- docs/trunk/rexxref/intro.sgml 2009-02-04 00:47:59 UTC (rev 4059) +++ docs/trunk/rexxref/intro.sgml 2009-02-04 00:55:12 UTC (rev 4060) @@ -129,7 +129,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90004.jpg" scale="70"> +<imagedata fileref="ReportObject.jpg" scale="70"> </imageobject> </mediaobject> </figure> Deleted: docs/trunk/rexxref/rxo90004.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90004.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90004.png =================================================================== (Binary files differ) This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-04 01:00:23
|
Revision: 4062 http://oorexx.svn.sourceforge.net/oorexx/?rev=4062&view=rev Author: bigrixx Date: 2009-02-04 01:00:16 +0000 (Wed, 04 Feb 2009) Log Message: ----------- fix makefiles for image file rename Modified Paths: -------------- docs/trunk/rexxpg/Makefile docs/trunk/rexxref/Makefile Modified: docs/trunk/rexxpg/Makefile =================================================================== --- docs/trunk/rexxpg/Makefile 2009-02-04 00:57:57 UTC (rev 4061) +++ docs/trunk/rexxpg/Makefile 2009-02-04 01:00:16 UTC (rev 4062) @@ -65,7 +65,7 @@ ../shared/gethelp.sgml \ ../shared/CPLv1.0.sgml -IMAGE_FILES = rxo90004.jpg \ +IMAGE_FILES = ReportObject.jpg \ rxo90005.jpg \ rxo90006.jpg \ rxo90007.jpg \ Modified: docs/trunk/rexxref/Makefile =================================================================== --- docs/trunk/rexxref/Makefile 2009-02-04 00:57:57 UTC (rev 4061) +++ docs/trunk/rexxref/Makefile 2009-02-04 01:00:16 UTC (rev 4062) @@ -143,7 +143,7 @@ templates1.png \ templates2.png \ templates3.png \ - rxo90004.jpg \ + ReportObject.jpg \ rxo90005.jpg \ rxo90006.jpg \ rxo90007.jpg \ This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-04 01:17:27
|
Revision: 4063 http://oorexx.svn.sourceforge.net/oorexx/?rev=4063&view=rev Author: bigrixx Date: 2009-02-04 01:17:24 +0000 (Wed, 04 Feb 2009) Log Message: ----------- fix makefiles for image file rename Modified Paths: -------------- docs/trunk/rexxpg/Makefile docs/trunk/rexxpg/concept.sgml docs/trunk/rexxref/Makefile docs/trunk/rexxref/intro.sgml Added Paths: ----------- docs/trunk/rexxpg/BallObject.odg docs/trunk/rexxpg/BallObject.png docs/trunk/rexxpg/BallObjectData.odg docs/trunk/rexxpg/BallObjectData.png docs/trunk/rexxref/BallObject.odg docs/trunk/rexxref/BallObject.png docs/trunk/rexxref/BallObjectData.odg docs/trunk/rexxref/BallObjectData.png Removed Paths: ------------- docs/trunk/rexxpg/rxo90005.jpg docs/trunk/rexxpg/rxo90005.odg docs/trunk/rexxpg/rxo90005.png docs/trunk/rexxpg/rxo90006.jpg docs/trunk/rexxpg/rxo90006.odg docs/trunk/rexxref/rxo90005.jpg docs/trunk/rexxref/rxo90005.odg docs/trunk/rexxref/rxo90005.png docs/trunk/rexxref/rxo90006.jpg docs/trunk/rexxref/rxo90006.odg Copied: docs/trunk/rexxpg/BallObject.odg (from rev 4060, docs/trunk/rexxpg/rxo90005.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/BallObject.png (from rev 4060, docs/trunk/rexxpg/rxo90005.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/BallObjectData.odg (from rev 4060, docs/trunk/rexxpg/rxo90006.odg) =================================================================== (Binary files differ) Added: docs/trunk/rexxpg/BallObjectData.png =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxpg/BallObjectData.png ___________________________________________________________________ Added: svn:mime-type + image/png Modified: docs/trunk/rexxpg/Makefile =================================================================== --- docs/trunk/rexxpg/Makefile 2009-02-04 01:00:16 UTC (rev 4062) +++ docs/trunk/rexxpg/Makefile 2009-02-04 01:17:24 UTC (rev 4063) @@ -65,9 +65,9 @@ ../shared/gethelp.sgml \ ../shared/CPLv1.0.sgml -IMAGE_FILES = ReportObject.jpg \ - rxo90005.jpg \ - rxo90006.jpg \ +IMAGE_FILES = ReportObject.png \ + BallObject.png \ + BallObjectData.png \ rxo90007.jpg \ rxo90008.jpg \ rxo90011.jpg \ Modified: docs/trunk/rexxpg/concept.sgml =================================================================== --- docs/trunk/rexxpg/concept.sgml 2009-02-04 01:00:16 UTC (rev 4062) +++ docs/trunk/rexxpg/concept.sgml 2009-02-04 01:17:24 UTC (rev 4063) @@ -124,7 +124,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90005.jpg" scale="70"> +<imagedata fileref="BallObject.jpg" scale="70"> </imageobject> </mediaobject> </figure> @@ -143,7 +143,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90006.jpg" scale="70"> +<imagedata fileref="BallObjectData.jpg" scale="70"> </imageobject> </mediaobject> </figure> Deleted: docs/trunk/rexxpg/rxo90005.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90005.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90005.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90006.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90006.odg =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/BallObject.odg (from rev 4060, docs/trunk/rexxref/rxo90005.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/BallObject.png (from rev 4060, docs/trunk/rexxref/rxo90005.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/BallObjectData.odg (from rev 4060, docs/trunk/rexxref/rxo90006.odg) =================================================================== (Binary files differ) Added: docs/trunk/rexxref/BallObjectData.png =================================================================== (Binary files differ) Property changes on: docs/trunk/rexxref/BallObjectData.png ___________________________________________________________________ Added: svn:mime-type + image/png Modified: docs/trunk/rexxref/Makefile =================================================================== --- docs/trunk/rexxref/Makefile 2009-02-04 01:00:16 UTC (rev 4062) +++ docs/trunk/rexxref/Makefile 2009-02-04 01:17:24 UTC (rev 4063) @@ -143,9 +143,9 @@ templates1.png \ templates2.png \ templates3.png \ - ReportObject.jpg \ - rxo90005.jpg \ - rxo90006.jpg \ + ReportObject.png \ + BallObject.png \ + BallObjectData.png \ rxo90007.jpg \ rxo90008.jpg \ rxo90011.jpg \ Modified: docs/trunk/rexxref/intro.sgml =================================================================== --- docs/trunk/rexxref/intro.sgml 2009-02-04 01:00:16 UTC (rev 4062) +++ docs/trunk/rexxref/intro.sgml 2009-02-04 01:17:24 UTC (rev 4063) @@ -161,7 +161,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90005.jpg" scale="70"> +<imagedata fileref="BallObject.jpg" scale="70"> </imageobject> </mediaobject> </figure> @@ -184,7 +184,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90006.jpg" scale="70"> +<imagedata fileref="BallObjectData.jpg" scale="70"> </imageobject> </mediaobject> </figure> Deleted: docs/trunk/rexxref/rxo90005.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90005.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90005.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90006.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90006.odg =================================================================== (Binary files differ) This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-04 01:53:53
|
Revision: 4064 http://oorexx.svn.sourceforge.net/oorexx/?rev=4064&view=rev Author: bigrixx Date: 2009-02-04 01:40:08 +0000 (Wed, 04 Feb 2009) Log Message: ----------- fix extension names Modified Paths: -------------- docs/trunk/rexxpg/concept.sgml docs/trunk/rexxref/intro.sgml Modified: docs/trunk/rexxpg/concept.sgml =================================================================== --- docs/trunk/rexxpg/concept.sgml 2009-02-04 01:17:24 UTC (rev 4063) +++ docs/trunk/rexxpg/concept.sgml 2009-02-04 01:40:08 UTC (rev 4064) @@ -91,7 +91,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="ReportObject.jpg" scale="75"> +<imagedata fileref="ReportObject.png" scale="75"> </imageobject> </mediaobject> </figure> @@ -124,7 +124,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="BallObject.jpg" scale="70"> +<imagedata fileref="BallObject.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -143,7 +143,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="BallObjectData.jpg" scale="70"> +<imagedata fileref="BallObjectData.png" scale="70"> </imageobject> </mediaobject> </figure> Modified: docs/trunk/rexxref/intro.sgml =================================================================== --- docs/trunk/rexxref/intro.sgml 2009-02-04 01:17:24 UTC (rev 4063) +++ docs/trunk/rexxref/intro.sgml 2009-02-04 01:40:08 UTC (rev 4064) @@ -129,7 +129,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="ReportObject.jpg" scale="70"> +<imagedata fileref="ReportObject.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -161,7 +161,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="BallObject.jpg" scale="70"> +<imagedata fileref="BallObject.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -184,7 +184,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="BallObjectData.jpg" scale="70"> +<imagedata fileref="BallObjectData.png" scale="70"> </imageobject> </mediaobject> </figure> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-04 22:17:41
|
Revision: 4069 http://oorexx.svn.sourceforge.net/oorexx/?rev=4069&view=rev Author: bigrixx Date: 2009-02-04 22:17:36 +0000 (Wed, 04 Feb 2009) Log Message: ----------- More image replacement work Modified Paths: -------------- docs/trunk/rexxpg/Makefile docs/trunk/rexxpg/concept.sgml docs/trunk/rexxref/Makefile docs/trunk/rexxref/dire.sgml docs/trunk/rexxref/intro.sgml docs/trunk/rexxref/xconcur.sgml Added Paths: ----------- docs/trunk/rexxpg/EncapsulatedObject.odg docs/trunk/rexxpg/EncapsulatedObject.png docs/trunk/rexxref/AfterReply.odg docs/trunk/rexxref/AfterReply.png docs/trunk/rexxref/BeforeReply.odg docs/trunk/rexxref/BeforeReply.png docs/trunk/rexxref/EarlyReply.odg docs/trunk/rexxref/EarlyReply.png docs/trunk/rexxref/EncapsulatedObject.odg docs/trunk/rexxref/EncapsulatedObject.png docs/trunk/rexxref/IndirectRecursion.odg docs/trunk/rexxref/IndirectRecursion.png docs/trunk/rexxref/MultipleRequires.odg docs/trunk/rexxref/MultipleRequires.png Removed Paths: ------------- docs/trunk/rexxpg/rxo90007.jpg docs/trunk/rexxpg/rxo90007.odg docs/trunk/rexxpg/rxo90007.png docs/trunk/rexxref/rox900006.png docs/trunk/rexxref/rxo90007.jpg docs/trunk/rexxref/rxo90007.odg docs/trunk/rexxref/rxo90007.png docs/trunk/rexxref/rxor0f01.jpg docs/trunk/rexxref/rxor0f01.odg docs/trunk/rexxref/rxor0f01.png docs/trunk/rexxref/rxor0f08.jpg docs/trunk/rexxref/rxor0f08.odg docs/trunk/rexxref/rxor0f08.png docs/trunk/rexxref/rxor0f09.jpg docs/trunk/rexxref/rxor0f09.odg docs/trunk/rexxref/rxor0f09.png docs/trunk/rexxref/rxor0f10.jpg docs/trunk/rexxref/rxor0f10.odg docs/trunk/rexxref/rxor0f10.png docs/trunk/rexxref/rxor0f11.jpg docs/trunk/rexxref/rxor0f11.odg docs/trunk/rexxref/rxor0f11.png Copied: docs/trunk/rexxpg/EncapsulatedObject.odg (from rev 4068, docs/trunk/rexxpg/rxo90007.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/EncapsulatedObject.png (from rev 4068, docs/trunk/rexxpg/rxo90007.png) =================================================================== (Binary files differ) Modified: docs/trunk/rexxpg/Makefile =================================================================== --- docs/trunk/rexxpg/Makefile 2009-02-04 04:31:51 UTC (rev 4068) +++ docs/trunk/rexxpg/Makefile 2009-02-04 22:17:36 UTC (rev 4069) @@ -68,7 +68,7 @@ IMAGE_FILES = ReportObject.png \ BallObject.png \ BallObjectData.png \ - rxo90007.jpg \ + EncapsulateObject.png \ rxo90008.jpg \ rxo90011.jpg \ rxo90014.jpg \ Modified: docs/trunk/rexxpg/concept.sgml =================================================================== --- docs/trunk/rexxpg/concept.sgml 2009-02-04 04:31:51 UTC (rev 4068) +++ docs/trunk/rexxpg/concept.sgml 2009-02-04 22:17:36 UTC (rev 4069) @@ -166,7 +166,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90007.jpg" scale="70"> +<imagedata fileref="EncapsulatedObject.png" scale="70"> </imageobject> </mediaobject> </figure> Deleted: docs/trunk/rexxpg/rxo90007.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90007.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90007.png =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/AfterReply.odg (from rev 4068, docs/trunk/rexxref/rxor0f10.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/AfterReply.png (from rev 4068, docs/trunk/rexxref/rxor0f10.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/BeforeReply.odg (from rev 4068, docs/trunk/rexxref/rxor0f09.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/BeforeReply.png (from rev 4068, docs/trunk/rexxref/rxor0f09.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/EarlyReply.odg (from rev 4068, docs/trunk/rexxref/rxor0f08.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/EarlyReply.png (from rev 4068, docs/trunk/rexxref/rxor0f08.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/EncapsulatedObject.odg (from rev 4068, docs/trunk/rexxref/rxo90007.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/EncapsulatedObject.png (from rev 4068, docs/trunk/rexxref/rxo90007.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/IndirectRecursion.odg (from rev 4068, docs/trunk/rexxref/rxor0f11.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/IndirectRecursion.png (from rev 4068, docs/trunk/rexxref/rxor0f11.png) =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/Makefile =================================================================== --- docs/trunk/rexxref/Makefile 2009-02-04 04:31:51 UTC (rev 4068) +++ docs/trunk/rexxref/Makefile 2009-02-04 22:17:36 UTC (rev 4069) @@ -146,7 +146,7 @@ ReportObject.png \ BallObject.png \ BallObjectData.png \ - rxo90007.jpg \ + EncapsulatedObject.png \ rxo90008.jpg \ rxo90011.jpg \ rxo90014.jpg \ @@ -154,11 +154,11 @@ rxo90018.jpg \ rxo90019.jpg \ rxo90020.jpg \ - rxor0f01.jpg \ - rxor0f08.jpg \ - rxor0f09.jpg \ - rxor0f10.jpg \ - rxor0f11.jpg \ + MultipleRequires.png \ + EarlyReply.png \ + BeforeReply.png \ + AfterReply.png \ + IndirectRecursion.png \ externalFunction.png \ externalFileSearch.png \ oorexx.jpg \ Copied: docs/trunk/rexxref/MultipleRequires.odg (from rev 4068, docs/trunk/rexxref/rxor0f01.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/MultipleRequires.png (from rev 4068, docs/trunk/rexxref/rxor0f01.png) =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/dire.sgml =================================================================== --- docs/trunk/rexxref/dire.sgml 2009-02-04 04:31:51 UTC (rev 4068) +++ docs/trunk/rexxref/dire.sgml 2009-02-04 22:17:36 UTC (rev 4069) @@ -647,7 +647,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxor0f01.jpg" scale="70"> +<imagedata fileref="MultipleRequires.png" scale="70"> </imageobject> </mediaobject> Modified: docs/trunk/rexxref/intro.sgml =================================================================== --- docs/trunk/rexxref/intro.sgml 2009-02-04 04:31:51 UTC (rev 4068) +++ docs/trunk/rexxref/intro.sgml 2009-02-04 22:17:36 UTC (rev 4069) @@ -210,7 +210,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90007.jpg" scale="70"> +<imagedata fileref="EncapsulatedObject.png" scale="70"> </imageobject> </mediaobject> </figure> Deleted: docs/trunk/rexxref/rox900006.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90007.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90007.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90007.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f01.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f01.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f01.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f08.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f08.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f08.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f09.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f09.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f09.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f10.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f10.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f10.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f11.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f11.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxor0f11.png =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/xconcur.sgml =================================================================== --- docs/trunk/rexxref/xconcur.sgml 2009-02-04 04:31:51 UTC (rev 4068) +++ docs/trunk/rexxref/xconcur.sgml 2009-02-04 22:17:36 UTC (rev 4069) @@ -66,7 +66,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxor0f08.jpg" scale="60"> +<imagedata fileref="EarlyReply.png" scale="60"> </imageobject> </mediaobject> </figure> @@ -100,7 +100,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxor0f09.jpg" scale="70"> +<imagedata fileref="BeforeReply.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -109,7 +109,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxor0f10.jpg" scale="70"> +<imagedata fileref="AfterReply.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -346,7 +346,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxor0f11.jpg" scale="70"> +<imagedata fileref="IndirectRecursion.png" scale="70"> </imageobject> </mediaobject> </figure> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-05 21:13:30
|
Revision: 4079 http://oorexx.svn.sourceforge.net/oorexx/?rev=4079&view=rev Author: bigrixx Date: 2009-02-05 21:13:25 +0000 (Thu, 05 Feb 2009) Log Message: ----------- More image file replacements Modified Paths: -------------- docs/trunk/rexxpg/Makefile docs/trunk/rexxpg/concept.sgml docs/trunk/rexxref/Makefile docs/trunk/rexxref/intro.sgml Added Paths: ----------- docs/trunk/rexxpg/IconClass.odg docs/trunk/rexxpg/IconClass.png docs/trunk/rexxpg/IconClassInstances.odg docs/trunk/rexxpg/IconClassInstances.png docs/trunk/rexxpg/Modules.odg docs/trunk/rexxpg/Modules.png docs/trunk/rexxpg/MultipleInheritance.odg docs/trunk/rexxpg/MultipleInheritance.png docs/trunk/rexxpg/ScreenObject.odg docs/trunk/rexxpg/ScreenObject.png docs/trunk/rexxpg/SimpleClass.odg docs/trunk/rexxpg/SimpleClass.png docs/trunk/rexxpg/Subclasses.odg docs/trunk/rexxpg/Subclasses.png docs/trunk/rexxref/IconClass.odg docs/trunk/rexxref/IconClass.png docs/trunk/rexxref/IconClassInstances.odg docs/trunk/rexxref/IconClassInstances.png docs/trunk/rexxref/Modules.odg docs/trunk/rexxref/Modules.png docs/trunk/rexxref/MultipleInheritance.odg docs/trunk/rexxref/MultipleInheritance.png docs/trunk/rexxref/ScreenObject.odg docs/trunk/rexxref/ScreenObject.png docs/trunk/rexxref/SimpleClass.odg docs/trunk/rexxref/SimpleClass.png docs/trunk/rexxref/Subclasses.odg docs/trunk/rexxref/Subclasses.png Removed Paths: ------------- docs/trunk/rexxpg/rxo90008.jpg docs/trunk/rexxpg/rxo90008.odg docs/trunk/rexxpg/rxo90008.png docs/trunk/rexxpg/rxo90011.jpg docs/trunk/rexxpg/rxo90011.odg docs/trunk/rexxpg/rxo90011.png docs/trunk/rexxpg/rxo90014.jpg docs/trunk/rexxpg/rxo90014.odg docs/trunk/rexxpg/rxo90014.png docs/trunk/rexxpg/rxo90017.jpg docs/trunk/rexxpg/rxo90017.odg docs/trunk/rexxpg/rxo90017.png docs/trunk/rexxpg/rxo90018.jpg docs/trunk/rexxpg/rxo90018.odg docs/trunk/rexxpg/rxo90018.png docs/trunk/rexxpg/rxo90019.jpg docs/trunk/rexxpg/rxo90019.odg docs/trunk/rexxpg/rxo90019.png docs/trunk/rexxpg/rxo90020.jpg docs/trunk/rexxpg/rxo90020.odg docs/trunk/rexxpg/rxo90020.png docs/trunk/rexxref/rxo90008.jpg docs/trunk/rexxref/rxo90008.odg docs/trunk/rexxref/rxo90008.png docs/trunk/rexxref/rxo90011.jpg docs/trunk/rexxref/rxo90011.odg docs/trunk/rexxref/rxo90011.png docs/trunk/rexxref/rxo90014.jpg docs/trunk/rexxref/rxo90014.odg docs/trunk/rexxref/rxo90014.png docs/trunk/rexxref/rxo90017.jpg docs/trunk/rexxref/rxo90017.odg docs/trunk/rexxref/rxo90017.png docs/trunk/rexxref/rxo90018.jpg docs/trunk/rexxref/rxo90018.odg docs/trunk/rexxref/rxo90018.png docs/trunk/rexxref/rxo90019.jpg docs/trunk/rexxref/rxo90019.odg docs/trunk/rexxref/rxo90019.png docs/trunk/rexxref/rxo90020.jpg docs/trunk/rexxref/rxo90020.odg docs/trunk/rexxref/rxo90020.png Copied: docs/trunk/rexxpg/IconClass.odg (from rev 4077, docs/trunk/rexxpg/rxo90011.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/IconClass.png (from rev 4077, docs/trunk/rexxpg/rxo90011.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/IconClassInstances.odg (from rev 4077, docs/trunk/rexxpg/rxo90014.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/IconClassInstances.png (from rev 4077, docs/trunk/rexxpg/rxo90014.png) =================================================================== (Binary files differ) Modified: docs/trunk/rexxpg/Makefile =================================================================== --- docs/trunk/rexxpg/Makefile 2009-02-05 21:10:07 UTC (rev 4078) +++ docs/trunk/rexxpg/Makefile 2009-02-05 21:13:25 UTC (rev 4079) @@ -69,13 +69,13 @@ BallObject.png \ BallObjectData.png \ EncapsulatedObject.png \ - rxo90008.jpg \ - rxo90011.jpg \ - rxo90014.jpg \ - rxo90017.jpg \ - rxo90018.jpg \ - rxo90019.jpg \ - rxo90020.jpg \ + SimpleClass.png \ + IconClass.png \ + IconClassInstances.png \ + Subclasses.png \ + ScreenObject.png \ + MultipleInheritance.png \ + Modules.png \ rxoq0s01.jpg \ rxoq0s02.jpg \ rxoq0s03.jpg \ Copied: docs/trunk/rexxpg/Modules.odg (from rev 4077, docs/trunk/rexxpg/rxo90020.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/Modules.png (from rev 4077, docs/trunk/rexxpg/rxo90020.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/MultipleInheritance.odg (from rev 4077, docs/trunk/rexxpg/rxo90019.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/MultipleInheritance.png (from rev 4077, docs/trunk/rexxpg/rxo90019.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/ScreenObject.odg (from rev 4077, docs/trunk/rexxpg/rxo90018.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/ScreenObject.png (from rev 4077, docs/trunk/rexxpg/rxo90018.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/SimpleClass.odg (from rev 4077, docs/trunk/rexxpg/rxo90008.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/SimpleClass.png (from rev 4077, docs/trunk/rexxpg/rxo90008.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/Subclasses.odg (from rev 4077, docs/trunk/rexxpg/rxo90017.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/Subclasses.png (from rev 4077, docs/trunk/rexxpg/rxo90017.png) =================================================================== (Binary files differ) Modified: docs/trunk/rexxpg/concept.sgml =================================================================== --- docs/trunk/rexxpg/concept.sgml 2009-02-05 21:10:07 UTC (rev 4078) +++ docs/trunk/rexxpg/concept.sgml 2009-02-05 21:13:25 UTC (rev 4079) @@ -79,7 +79,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90020.jpg" scale="50"> +<imagedata fileref="Modules.png" scale="50"> </imageobject> </mediaobject> @@ -280,7 +280,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90008.jpg" scale="70"> +<imagedata fileref="SimpleClass.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -297,7 +297,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90011.jpg" scale="70"> +<imagedata fileref="IconClass.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -323,7 +323,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90014.jpg" scale="70"> +<imagedata fileref="IconClassInstances.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -378,7 +378,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90017.jpg" scale="70"> +<imagedata fileref="Subclasses.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -390,7 +390,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90018.jpg" scale="70"> +<imagedata fileref="ScreenObject.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -409,7 +409,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90019.jpg" scale="70"> +<imagedata fileref="MultipleInheritance.png" scale="70"> </imageobject> </mediaobject> </figure> Deleted: docs/trunk/rexxpg/rxo90008.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90008.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90008.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90011.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90011.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90011.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90014.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90014.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90014.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90017.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90017.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90017.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90018.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90018.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90018.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90019.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90019.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90019.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90020.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90020.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxo90020.png =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/IconClass.odg (from rev 4077, docs/trunk/rexxref/rxo90011.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/IconClass.png (from rev 4077, docs/trunk/rexxref/rxo90011.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/IconClassInstances.odg (from rev 4077, docs/trunk/rexxref/rxo90014.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/IconClassInstances.png (from rev 4077, docs/trunk/rexxref/rxo90014.png) =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/Makefile =================================================================== --- docs/trunk/rexxref/Makefile 2009-02-05 21:10:07 UTC (rev 4078) +++ docs/trunk/rexxref/Makefile 2009-02-05 21:13:25 UTC (rev 4079) @@ -147,13 +147,13 @@ BallObject.png \ BallObjectData.png \ EncapsulatedObject.png \ - rxo90008.jpg \ - rxo90011.jpg \ - rxo90014.jpg \ - rxo90017.jpg \ - rxo90018.jpg \ - rxo90019.jpg \ - rxo90020.jpg \ + SimpleClass.png \ + IconClass.png \ + IconClassInstances.png \ + Subclasses.png \ + ScreenObject.png \ + MultipleInheritance.png \ + Modules.png \ MultipleRequires.png \ EarlyReply.png \ BeforeReply.png \ Copied: docs/trunk/rexxref/Modules.odg (from rev 4077, docs/trunk/rexxref/rxo90020.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/Modules.png (from rev 4077, docs/trunk/rexxref/rxo90020.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/MultipleInheritance.odg (from rev 4077, docs/trunk/rexxref/rxo90019.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/MultipleInheritance.png (from rev 4077, docs/trunk/rexxref/rxo90019.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/ScreenObject.odg (from rev 4077, docs/trunk/rexxref/rxo90018.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/ScreenObject.png (from rev 4077, docs/trunk/rexxref/rxo90018.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/SimpleClass.odg (from rev 4077, docs/trunk/rexxref/rxo90008.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/SimpleClass.png (from rev 4077, docs/trunk/rexxref/rxo90008.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/Subclasses.odg (from rev 4077, docs/trunk/rexxref/rxo90017.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxref/Subclasses.png (from rev 4077, docs/trunk/rexxref/rxo90017.png) =================================================================== (Binary files differ) Modified: docs/trunk/rexxref/intro.sgml =================================================================== --- docs/trunk/rexxref/intro.sgml 2009-02-05 21:10:07 UTC (rev 4078) +++ docs/trunk/rexxref/intro.sgml 2009-02-05 21:13:25 UTC (rev 4079) @@ -117,7 +117,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90020.jpg" scale="65"> +<imagedata fileref="Modules.png" scale="65"> </imageobject> </mediaobject> @@ -330,7 +330,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90008.jpg" scale="70"> +<imagedata fileref="SimpleClass.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -345,7 +345,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90011.jpg" scale="70"> +<imagedata fileref="IconClass.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -363,7 +363,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90014.jpg" scale="70"> +<imagedata fileref="IconClassInstances.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -415,7 +415,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90017.jpg" scale="70"> +<imagedata fileref="Subclasses.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -427,7 +427,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90018.jpg" scale="70"> +<imagedata fileref="ScreenObject.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -442,7 +442,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxo90019.jpg" scale="70"> +<imagedata fileref="MultipleInheritance.png" scale="70"> </imageobject> </mediaobject> </figure> Deleted: docs/trunk/rexxref/rxo90008.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90008.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90008.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90011.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90011.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90011.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90014.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90014.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90014.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90017.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90017.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90017.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90018.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90018.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90018.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90019.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90019.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90019.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90020.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90020.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90020.png =================================================================== (Binary files differ) This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-06 01:01:33
|
Revision: 4083 http://oorexx.svn.sourceforge.net/oorexx/?rev=4083&view=rev Author: bigrixx Date: 2009-02-06 01:01:29 +0000 (Fri, 06 Feb 2009) Log Message: ----------- Some editorial updates Modified Paths: -------------- docs/trunk/rexxref/intro.sgml docs/trunk/rexxref/preface.sgml docs/trunk/shared/gethelp.sgml Modified: docs/trunk/rexxref/intro.sgml =================================================================== --- docs/trunk/rexxref/intro.sgml 2009-02-05 23:28:26 UTC (rev 4082) +++ docs/trunk/rexxref/intro.sgml 2009-02-06 01:01:29 UTC (rev 4083) @@ -67,8 +67,8 @@ clause can occupy more than one line. Indentation is allowed. You can, therefore, code programs in a format that emphasizes their structure, making them easier to read.</para> -<para>There is no limit to the length of the values of variables, as long as -all variables fit into the storage available. There are no restrictions on +<para>There is no limit to the size of variable values, as long as +all values fit into the storage available. There are no restrictions on the types of data that variables can contain.</para> <para>The limit on the length of symbols (variable names) is 250 characters. You can use compound symbols, such as </para> @@ -238,12 +238,13 @@ <itemizedlist> <listitem><para>A receiving object</para></listitem> <listitem> +<para>The "message send" symbol, ~, +which is called the <emphasis>twiddle</emphasis> <indexterm><primary>~ (tilde or twiddle)</primary></indexterm> <indexterm><primary>tilde (~)</primary></indexterm> <indexterm><primary>twiddle (~)</primary></indexterm> <indexterm><primary>message-send operator (~)</primary></indexterm> -<para>The "message send" symbol, ~, -which is called the <emphasis>twiddle</emphasis></para></listitem> +</para></listitem> <listitem><para>The action and, optionally in parentheses, any parameters required</para></listitem> </itemizedlist></para> @@ -458,11 +459,6 @@ <indexterm><primary>structure and syntax</primary></indexterm> <indexterm><primary>variables</primary> <secondary>aquiring</secondary></indexterm> -<para>On Windows and *nix, Rexx programs are not required -to start with a standard comment. However, for portability reasons, start -each Rexx program with a standard comment that begins in the first column -of the first line. For more information on comments, refer to -<link linkend="cmts">Comments</link>.</para> <para>A Rexx program is built from a series of <emphasis>clauses</emphasis> that are composed of: </para> <itemizedlist> Modified: docs/trunk/rexxref/preface.sgml =================================================================== --- docs/trunk/rexxref/preface.sgml 2009-02-05 23:28:26 UTC (rev 4082) +++ docs/trunk/rexxref/preface.sgml 2009-02-06 01:01:29 UTC (rev 4083) @@ -42,9 +42,10 @@ ######################################################################### --> <preface id="preface"><title>About This Book</title> -<para>This book describes the Open Object Rexx Interpreter, called -<emphasis role="bold">interpreter</emphasis> or language processor in the -following, and the Object-Oriented Rexx language.</para> +<para>This book describes the Open Object Rexx Interpreter, called the +<emphasis role="italic">interpreter</emphasis> or +<emphasis role="italic">language processor</emphasis> in the +following, and the object-oriented Rexx language.</para> <para>This book is intended for people who plan to develop applications using Rexx. Its users range from the novice, who might have experience in some programming language but no Rexx experience, to the experienced application Modified: docs/trunk/shared/gethelp.sgml =================================================================== --- docs/trunk/shared/gethelp.sgml 2009-02-05 23:28:26 UTC (rev 4082) +++ docs/trunk/shared/gethelp.sgml 2009-02-06 01:01:29 UTC (rev 4083) @@ -55,7 +55,7 @@ refer to the <ulink url="http://rexxla.org/"><citetitle>RexxLA Home Page</citetitle></ulink> or the -<ulink url="http://rexxla.org/About_RexxLA/member.html"> +<ulink url="http://www.rexxla.org/rexxla/join.html"> <citetitle>RexxLA Membership Application</citetitle></ulink> page.</para> </section> @@ -106,43 +106,28 @@ This list is only used for monitoring changes to the ooRexx bug tracking system.</para></listitem> </varlistentry> -<varlistentry><term>Support Requests</term> -<listitem><para>You can create a support request at -<ulink url="http://sourceforge.net/tracker/?group_id=119701&atid=684731"> -<citetitle>ooRexx Support Request</citetitle></ulink> page. -Please be sure to log in to Sourceforge -before creating the request so that it will record your e-mail address. This -will allow SourceForge (and the ooRexx developers) a way to contact you when -updates are made to your request. Otherwise you will need to manually check -back on this page to track any updates to the request.</para> -<para>Also, please try to provide as much information in the support request -as possible so that the developers can determine the problem as quickly as -possible.</para></listitem> -</varlistentry> <varlistentry><term>Bug Reports</term> <listitem><para>You can create a bug report at <ulink url="http://sourceforge.net/tracker/?group_id=119701&atid=684730"> <citetitle>ooRexx Bug Report</citetitle></ulink> page. -Please be sure to log in to Sourceforge -before creating the report so that it will record your e-mail address. This -will allow SourceForge (and the ooRexx developers) a way to contact you when -updates are made to your report. Otherwise you will need to manually check -back on this page to track any updates to the report.</para> -<para>Also, please try to provide as much information in the bug report +Please try to provide as much information in the bug report as possible so that the developers can determine the problem as quickly as -possible.</para></listitem> +possible. Sample programs that can reproduce your problem will make it easier to +debug reported problems. +</para></listitem> </varlistentry> +<varlistentry><term>Request For Enhancement</term> +<listitem><para>You can suggest ooRexx features at the +<ulink url="http://sourceforge.net/tracker/?group_id=119701&atid=684733"> +<citetitle>ooRexx Feature Requests</citetitle></ulink> page. +</para></listitem> +</varlistentry> <varlistentry><term>Patch Reports</term> <listitem><para>If you create an enhancement patch for ooRexx please post the patch using the <ulink url="http://sourceforge.net/tracker/?group_id=119701&atid=684732"> <citetitle>ooRexx Patch Report</citetitle></ulink> page. -Please be sure to log in to Sourceforge -before creating the report so that it will record your e-mail address. This -will allow SourceForge (and the ooRexx developers) a way to contact you when -updates are made to your report. Otherwise you will need to manually check -back on this page to track any updates to the report.</para> -<para>Also, please try to provide as much information in the patch report +Please provide as much information in the patch report as possible so that the developers can evaluate the enhancement as quickly as possible.</para> <para>Please do not post bug patches here, instead you should open a bug report This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-08 16:07:37
|
Revision: 4103 http://oorexx.svn.sourceforge.net/oorexx/?rev=4103&view=rev Author: bigrixx Date: 2009-02-08 16:07:33 +0000 (Sun, 08 Feb 2009) Log Message: ----------- Some editorial updates Modified Paths: -------------- docs/trunk/rexxref/instrc.sgml docs/trunk/shared/legalstuff.sgml Modified: docs/trunk/rexxref/instrc.sgml =================================================================== --- docs/trunk/rexxref/instrc.sgml 2009-02-08 00:52:36 UTC (rev 4102) +++ docs/trunk/rexxref/instrc.sgml 2009-02-08 16:07:33 UTC (rev 4103) @@ -332,8 +332,8 @@ of argument objects to Rexx variables. You should use this when your program needs a direct reference to the argument object, without string conversion or parsing. -ARG and PARSE ARG produce string values from the arguments, and the -language processor then parses these.</para></listitem> +ARG and PARSE ARG produce string values from the argument objects, and the +language processor then parses the string values.</para></listitem> </orderedlist> </section> @@ -1827,7 +1827,8 @@ <listitem><para>controls the precision to which arithmetic operations and built-in functions are evaluated. If you omit <emphasis role="italic">expression1</emphasis>, the precision defaults to -9 digits. Otherwise, the character string value result of +9 digits on 32-bit systems and 18 on 64-bit systems. +Otherwise, the character string value result of <emphasis role="italic">expression1</emphasis> must evaluate to a positive whole number and must be larger than the current NUMERIC FUZZ setting.</para> <para>There is no limit to the value for DIGITS @@ -1949,10 +1950,10 @@ <secondary>with PARSE UPPER</secondary></indexterm> <indexterm><primary>lowercase translation</primary> <secondary>with PARSE LOWER</secondary></indexterm> -UPPER or LOWER, any character strings to be parsed are first translated. -Otherwise no translation takes place during the parsing. If you specify UPPER, -the strings are translated to uppercase. If you specify LOWER, the strings are -translated to lowercase.</para> +If you specify UPPER, +the strings to be parsed are translated to uppercase before parsing. If you specify LOWER, the strings are +translated to lowercase. Otherwise no translation takes place. +</para> <para>If you specify CASELESS, character string matches during parsing are made independent of the case. This means a letter in uppercase is equal to the same letter @@ -1984,15 +1985,15 @@ <indexterm><primary>arguments</primary> <secondary>retrieving with PARSE ARG instruction</secondary></indexterm> </term> -<listitem><para>parses the strings passed to a program or internal routine as +<listitem><para>parses the strings passed to a program, routine, or method as input arguments. (See the ARG instruction in <link linkend="keyArg">ARG</link> for details and examples.) <note><title>Note</title> -<para>Parsing uses the argument string values. The -USE ARG instruction provides access to string and non-string argument objects. -You can also retrieve or check the argument objects to a Rexx program or -internal routine with the ARG built-in function (see +<para>Parsing uses the string values of the argument objects. The +USE ARG instruction provides direct access to argument objects. +You can also retrieve or check the argument objects to a Rexx program, routine, or +method with the ARG built-in function (see <link linkend="bifArg">ARG (Argument)</link>). </para></note> </para></listitem></varlistentry> @@ -2009,15 +2010,17 @@ </para> <programlisting> <![CDATA[ ->>-PARSE VALUE LINEIN()WITH--+---------------+--;-------------->< - +-template_list-+ +>>-PARSE VALUE LINEIN() WITH--+---------------+--;-------------->< + +-template_list-+ ]]> </programlisting> <para>If no line is available, program execution usually pauses until a line is complete. Use PARSE LINEIN only when direct access to the character input stream is necessary. Use the PULL or PARSE PULL instructions -for the usual line-by-line dialog with the user to maintain generality.</para> +for the usual line-by-line dialog with the user to maintain generality. +PARSE LINEIN will not pull lines from the external data queue. +</para> <para>To check if any lines are available in the default input stream, use the built-in function LINES. See <link linkend="bifLines">LINES (Lines Remaining)</link> @@ -2042,7 +2045,7 @@ <note><title>Note</title> <para>PULL and PARSE PULL read the current data queue. If the queue is -empty, they read the default input stream, STDIN (typically, the keyboard). +empty, they read the default input stream, .INPUT (typically, the keyboard). </para></note> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">PARSE SOURCE</emphasis> @@ -2061,18 +2064,14 @@ <para>The source string contains operating system name, followed by either <computeroutput>COMMAND</computeroutput>, <computeroutput>FUNCTION</computeroutput>, -<computeroutput>METHOD</computeroutput>, or -<computeroutput>SUBROUTINE</computeroutput>, depending on +<computeroutput>SUBROUTINE</computeroutput>, or +<computeroutput>METHOD</computeroutput>, depending on whether the program was called as a host command or from a function call in -an expression or as a method of an object or using the CALL instruction. These +an expression or using the CALL instruction or as a method of an object. These two tokens are followed by the complete path specification of the program file.</para> <para>The string parsed might, therefore, look like this:</para> <programlisting> -Windows95 COMMAND C:\MYDIR\RexxTRY.CMD -</programlisting> -<para>or</para> -<programlisting> WindowsNT COMMAND C:\MYDIR\RexxTRY.CMD </programlisting> <para>or</para> @@ -2140,11 +2139,11 @@ <listitem><para>The string <computeroutput>REXX-ooRexx</computeroutput></para> </listitem> <listitem><para>The language level description, for example -<computeroutput>6.00</computeroutput>.</para></listitem> +<computeroutput>6.03</computeroutput>.</para></listitem> <listitem><para>Three tokens that describe the language processor release date in the same format as the default for the DATE built-in function (see <link linkend="bifDate">DATE</link>), -for example, "27 Sep 1997".</para></listitem></itemizedlist> +for example, "27 Sep 2007".</para></listitem></itemizedlist> </para></listitem></varlistentry> </variablelist> </section> @@ -2186,7 +2185,7 @@ <para>PROCEDURE, within an internal routine (subroutine or function), protects the caller's variables by making them unknown to the instructions that follow it. After a RETURN instruction -is processed, the original variables environment is restored and any variables +is processed, the original variable environment is restored and any variables used in the routine (that were not exposed) are dropped. (An exposed variable is one belonging the caller of a routine that the PROCEDURE instruction has exposed. When the routine refers to, or alters, the variable, the original @@ -2349,7 +2348,8 @@ ]]> </programlisting> -<para>PULL reads a string from the head of the external data queue. +<para>PULL reads a string from the head of the external data queue or, if +the external data queue is empty, from the standard input stream (typically the keyboard). (See <link linkend="iostrms">Input and Output Streams</link> for a discussion of Rexx input and output.) It is a short form of the following instruction:</para> @@ -2384,8 +2384,8 @@ <para>If the current data queue is empty, PULL reads from the standard input (typically, the keyboard). If there is a PULL from the standard input, the program waits for -keyboard input with no prompt. The length of data read by the PULL instruction -is restricted to the length of strings contained by variables.</para></note> +keyboard input with no prompt. +</para></note> <para><emphasis role="bold">Example:</emphasis></para> <indexterm><primary>PULL instruction</primary> <secondary>example</secondary></indexterm> @@ -2594,7 +2594,7 @@ of the condition object and the <computeroutput>"A"</computeroutput> option of the CONDITION built-in function return this additional object information. For SYNTAX conditions, -the ADDITIONAL value must evaluate to a Rexx array object.</para> +the ADDITIONAL value must evaluate to a single-dimension Rexx array object.</para> <para>If you specify the ARRAY option, each <emphasis role="italic">expri</emphasis> is an expression (use commas to separate the expressions). The language processor evaluates the @@ -2690,7 +2690,7 @@ <para>REPLY sends an early reply from a method to its caller. The method issuing REPLY returns control, and possibly a result, to its caller to the point from which the message was -sent; meanwhile, the method issuing REPLY continues running.</para> +sent; meanwhile, the method issuing REPLY continues running on a newly created thread.</para> <para>If you specify <emphasis role="italic">expression</emphasis>, it is evaluated and the object resulting from the evaluation is passed back. If you omit <emphasis role="italic">expression</emphasis>, no object @@ -2716,11 +2716,11 @@ <listitem><para>A method can execute only one REPLY instruction.</para> </listitem> <listitem><para>When the method issuing the REPLY instruction is the only -method on the -current activity with exclusive access to the object's variable pool, -the method retains exclusive access on the new activity. When the other methods -on the activity also have access, the method issuing REPLY releases its access -and reacquires the access on the new activity. This might force the method +active method on the +current thread with exclusive access to the object's variable pool, +the method retains exclusive access on the new thread. When other methods +on the thread also have access, the method issuing the REPLY releases its access +and reacquires the access on the new thread. This might force the method to wait until the original activity has released its access.</para></listitem> </orderedlist> <para>See <link linkend="xconcur">Concurrency</link> for a complete @@ -2752,11 +2752,11 @@ </programlisting> <para>RETURN returns control, and possibly a result, from a Rexx program, -method, or internal routine to the point of its invocation.</para> +method, or routine to the point of its invocation.</para> <para>If no internal routine (subroutine or function) is active, RETURN and EXIT are identical in their effect on the program that is run. (See <link linkend="keyExit">EXIT</link>.)</para> -<para>If a subroutine is run, <emphasis role="italic">expression</emphasis> +<para>If called as a routine, <emphasis role="italic">expression</emphasis> (if any) is evaluated, control is passed back to the caller, and the Rexx special variable <indexterm><primary>RESULT special variable</primary> @@ -2766,7 +2766,7 @@ the special variable RESULT is dropped (becomes uninitialized). The various settings saved at the time of the CALL (for example, tracing and addresses) are also restored. (See <link linkend="keyCall">CALL</link>.)</para> -<para>If a function is processed, the action taken is identical, except that +<para>If a function call is active, the action taken is identical, except that <emphasis role="italic">expression</emphasis> must be specified on the RETURN instruction. The result of <emphasis role="italic">expression</emphasis> is then used in the original expression at the point where the function @@ -2785,11 +2785,11 @@ <indexterm><primary>special</primary> <secondary>variables</secondary> <tertiary>RESULT</tertiary></indexterm> -RESULT if you specify -it. If the method has previously issued a REPLY instruction, the RETURN instruction +RESULT if a return <emphasis role="italic">expression</emphasis> is specified. +If the method has previously issued a REPLY instruction, the RETURN instruction must not include a result <emphasis role="italic">expression</emphasis>.</para> -<para>If a PROCEDURE instruction was processed within the routine (subroutine -or internal function), all variables of the current generation are dropped +<para>If a PROCEDURE instruction was processed within an internal subroutine +or internal function, all variables of the current generation are dropped (and those of the previous generation are exposed) after <emphasis role="italic">expression</emphasis> is evaluated and before the result is used or assigned to RESULT.</para> @@ -2845,7 +2845,7 @@ <listitem><para>If you use SAY and omit <emphasis role="italic">expression</emphasis>, a null string is used.</para> </listitem> -<listitem><para>CALL LINEOUT can raise NOTREADY; SAY cannot.</para></listitem> +<listitem><para>CALL LINEOUT can raise NOTREADY; SAY will not.</para></listitem> </itemizedlist> <para>See <link linkend="bifLineout">LINEOUT (Line Output)</link> for details of the LINEOUT function.</para> @@ -2865,7 +2865,7 @@ <para><emphasis role="bold">Notes:</emphasis></para> <orderedlist> <listitem><para>Data from the SAY instruction is sent to the default output -stream (STDOUT). However, the standard rules for redirecting output apply +stream (.OUTPUT). However, the standard rules for redirecting output apply to the SAY output. </para></listitem> <listitem><para>The SAY instruction does not format data; the operating system @@ -3434,9 +3434,22 @@ </term> <listitem><para>Identifies the result of an expression (for <computeroutput>TRACE R</computeroutput>) or the -value assigned to a variable during parsing, the value returned from a +the value returned from a subroutine call, or a value evaluated by execution of a DO loop. </para></listitem></varlistentry> +<varlistentry><term><computeroutput>>=></computeroutput> +<indexterm><primary>flag, tracing</primary> +<secondary>>=></secondary></indexterm> +<indexterm><primary>tracing flag</primary> +<secondary>=>></secondary></indexterm> +<indexterm><primary>>=> tracing flag</primary></indexterm> +</term> +<listitem><para>Identifies a variable assignment or a message assignment result. +The trace message includes both the name of the assignment target and the +assigned value. Assignment trace lines are displayed by assignment instructions, +variable assigned via PARSE, ARG, PULL, or USE ARG, as well as control variable +updates for DO and LOOP instructions. +</para></listitem></varlistentry> <varlistentry><term><computeroutput>>.></computeroutput> <indexterm><primary>flag, tracing</primary> <secondary>>.></secondary></indexterm> @@ -3535,6 +3548,9 @@ </variablelist> <note><para>The characters <computeroutput>=></computeroutput> indicate the value of a variable or the result of an operation.</para> +<para>The characters <computeroutput><=</computeroutput> indicate a value assignment. +The name to the left of the marker is the assignment topic. The data to the right +of the marker is the assigned value.</para> <para>The character <computeroutput>?</computeroutput> could indicate a non-printable character in the output.</para> </note> @@ -3574,7 +3590,7 @@ </programlisting> <para>USE ARG retrieves the argument objects provided in a program, routine, -function, or method and assigns them to variables.</para> +function, or method and assigns them to variables or message term assignments.</para> <para>Each <emphasis role="italic">name</emphasis> must be a valid variable name. The <emphasis role="italic">name</emphasis>s are assigned from left to right. For each <emphasis role="italic">name</emphasis> @@ -3583,7 +3599,8 @@ argument, <emphasis role="italic">name</emphasis> is assigned the value of <emphasis role="italic">expr</emphasis>. If <emphasis role="italic">expr</emphasis> is not specified for the given argument, the variable <emphasis role="italic">name</emphasis> -is dropped.</para> +is dropped. If the assignment target is a messaging term, no action is taken for omitted arguments. +</para> <para>A USE ARG instruction can be processed repeatedly and it always accesses the same current argument data.</para> <para>If <emphasis role="italic">expr</emphasis> is specified for an argument, the @@ -3680,14 +3697,25 @@ arg # 5=[five] -- </programlisting> +<para>The assignment targets may be any term that can be on the left side of +an assignment statement. For example,</para> +<programlisting> +expose myArray myDirectory +use arg myArray[1], myDirectory~name +</programlisting> +<para>would be equivalent to</para> +<programlisting> +myArray[1] = arg(1) +myDirectory~name = arg(2) +</programlisting> <para>You can retrieve or check the arguments by using the ARG built-in function (see <link linkend="bifArg">ARG (Argument)</link>). The ARG and PARSE ARG instructions are alternative ways of retrieving arguments. ARG and PARSE ARG access the string values of -arguments. USE ARG performs a direct, one-to-one assignment of arguments to -Rexx variables. This is preferable when you need an exact copy of the argument, +arguments. USE ARG performs a direct, one-to-one assignment of arguments. +This is preferable when you need direct access to an argument, without translation or parsing. USE ARG also allows access to both string -and non-string argument objects; ARG and PARSE ARG parse the string values -of the arguments.</para> +and non-string argument objects; ARG and PARSE ARG convert the arguments to values +before parsing.</para> </section> </chapter> Modified: docs/trunk/shared/legalstuff.sgml =================================================================== --- docs/trunk/shared/legalstuff.sgml 2009-02-08 00:52:36 UTC (rev 4102) +++ docs/trunk/shared/legalstuff.sgml 2009-02-08 16:07:33 UTC (rev 4103) @@ -52,6 +52,7 @@ <year>2006</year> <year>2007</year> <year>2008</year> + <year>2009</year> <holder>Rexx Language Association. All rights reserved.</holder> </copyright> <authorgroup> @@ -61,13 +62,14 @@ <collab><collabname>Rick McGuire</collabname></collab> <collab><collabname>Mark Miesfeld</collabname></collab> <collab><collabname>Lee Peedin</collabname></collab> + <collab><collabname>Jon Wolfers</collabname></collab> </authorgroup> <!--####################################################################### # The following need to be modified for each release! #######################################################################--> -<edition>Version 4.4.0 (beta)</edition> -<pubdate>July 20, 2008</pubdate> +<edition>Version 4.0.0 (beta)</edition> +<pubdate>March 1, 2009</pubdate> <!--####################################################################### # The releaseinfo tag is used to show the release status of a document. # This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-09 23:47:42
|
Revision: 4115 http://oorexx.svn.sourceforge.net/oorexx/?rev=4115&view=rev Author: bigrixx Date: 2009-02-09 23:47:38 +0000 (Mon, 09 Feb 2009) Log Message: ----------- More image updates from Jon Modified Paths: -------------- docs/trunk/rexxpg/Makefile docs/trunk/rexxpg/classes.sgml docs/trunk/rexxpg/meet.sgml docs/trunk/rexxpg/provide.sgml Added Paths: ----------- docs/trunk/rexxpg/BillingApplication.odg docs/trunk/rexxpg/BillingApplication.png docs/trunk/rexxpg/InstanceMethods.odg docs/trunk/rexxpg/InstanceMethods.png docs/trunk/rexxpg/PartClass.odg docs/trunk/rexxpg/PartClass.png docs/trunk/rexxpg/SubclassInheritance.odg docs/trunk/rexxpg/SubclassInheritance.png Removed Paths: ------------- docs/trunk/rexxpg/rxoq0s01.jpg docs/trunk/rexxpg/rxoq0s01.odg docs/trunk/rexxpg/rxoq0s01.png docs/trunk/rexxpg/rxoq0s02.jpg docs/trunk/rexxpg/rxoq0s02.odg docs/trunk/rexxpg/rxoq0s02.png docs/trunk/rexxpg/rxoq0s03.jpg docs/trunk/rexxpg/rxoq0s03.odg docs/trunk/rexxpg/rxoq0s03.png docs/trunk/rexxpg/rxoq0s04.jpg docs/trunk/rexxpg/rxoq0s04.odg docs/trunk/rexxpg/rxoq0s04.png docs/trunk/rexxref/rxo90017.odg docs/trunk/rexxref/rxo90017.png docs/trunk/rexxref/rxo90018.odg docs/trunk/rexxref/rxo90018.png docs/trunk/rexxref/rxo90019.odg docs/trunk/rexxref/rxo90019.png Copied: docs/trunk/rexxpg/BillingApplication.odg (from rev 4114, docs/trunk/rexxpg/rxoq0s01.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/BillingApplication.png (from rev 4114, docs/trunk/rexxpg/rxoq0s01.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/InstanceMethods.odg (from rev 4114, docs/trunk/rexxpg/rxoq0s03.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/InstanceMethods.png (from rev 4114, docs/trunk/rexxpg/rxoq0s03.png) =================================================================== (Binary files differ) Modified: docs/trunk/rexxpg/Makefile =================================================================== --- docs/trunk/rexxpg/Makefile 2009-02-09 23:25:19 UTC (rev 4114) +++ docs/trunk/rexxpg/Makefile 2009-02-09 23:47:38 UTC (rev 4115) @@ -76,10 +76,10 @@ ScreenObject.png \ MultipleInheritance.png \ Modules.png \ - rxoq0s01.jpg \ - rxoq0s02.jpg \ - rxoq0s03.jpg \ - rxoq0s04.jpg \ + BillingApplication.png \ + SubclassInheritance.png \ + InstanceMethods.png \ + PartClass.png \ rxoq0s05.jpg \ rxoq0s06.jpg \ rxoq0s07.jpg \ Copied: docs/trunk/rexxpg/PartClass.odg (from rev 4114, docs/trunk/rexxpg/rxoq0s04.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/PartClass.png (from rev 4114, docs/trunk/rexxpg/rxoq0s04.png) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/SubclassInheritance.odg (from rev 4114, docs/trunk/rexxpg/rxoq0s02.odg) =================================================================== (Binary files differ) Copied: docs/trunk/rexxpg/SubclassInheritance.png (from rev 4114, docs/trunk/rexxpg/rxoq0s02.png) =================================================================== (Binary files differ) Modified: docs/trunk/rexxpg/classes.sgml =================================================================== --- docs/trunk/rexxpg/classes.sgml 2009-02-09 23:25:19 UTC (rev 4114) +++ docs/trunk/rexxpg/classes.sgml 2009-02-09 23:47:38 UTC (rev 4115) @@ -86,7 +86,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxoq0s03.jpg" scale="70"> +<imagedata fileref="InstanceMethods.png" scale="70"> </imageobject> </mediaobject> </figure> @@ -275,7 +275,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxoq0s04.jpg" scale="75"> +<imagedata fileref="PartClass.png" scale="75"> </imageobject> </mediaobject> </figure> Modified: docs/trunk/rexxpg/meet.sgml =================================================================== --- docs/trunk/rexxpg/meet.sgml 2009-02-09 23:25:19 UTC (rev 4114) +++ docs/trunk/rexxpg/meet.sgml 2009-02-09 23:47:38 UTC (rev 4115) @@ -183,7 +183,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxoq0s01.jpg" scale="70"> +<imagedata fileref="BillingApplication" scale="70"> </imageobject> </mediaobject> </figure> Modified: docs/trunk/rexxpg/provide.sgml =================================================================== --- docs/trunk/rexxpg/provide.sgml 2009-02-09 23:25:19 UTC (rev 4114) +++ docs/trunk/rexxpg/provide.sgml 2009-02-09 23:47:38 UTC (rev 4115) @@ -284,7 +284,7 @@ <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> -<imagedata fileref="rxoq0s02.jpg" scale="75"> +<imagedata fileref="SubclassInheritance.png" scale="75"> </imageobject> </mediaobject> </figure> Deleted: docs/trunk/rexxpg/rxoq0s01.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxoq0s01.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxoq0s01.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxoq0s02.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxoq0s02.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxoq0s02.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxoq0s03.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxoq0s03.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxoq0s03.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxoq0s04.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxoq0s04.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxpg/rxoq0s04.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90017.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90017.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90018.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90018.png =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90019.odg =================================================================== (Binary files differ) Deleted: docs/trunk/rexxref/rxo90019.png =================================================================== (Binary files differ) This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mie...@us...> - 2009-02-10 03:22:22
|
Revision: 4116 http://oorexx.svn.sourceforge.net/oorexx/?rev=4116&view=rev Author: miesfeld Date: 2009-02-10 01:40:17 +0000 (Tue, 10 Feb 2009) Log Message: ----------- As discussed on the dev list, move the Windows specific extensions out of the Open Object Rexx Reference document into their own document. Modified Paths: -------------- docs/trunk/rexxref/Makefile docs/trunk/rexxref/classes.sgml docs/trunk/rexxref/rexxref.sgml Added Paths: ----------- docs/trunk/winextensions/ docs/trunk/winextensions/Makefile docs/trunk/winextensions/winclasses.sgml docs/trunk/winextensions/winextensions.sgml docs/trunk/winextensions/wsheng.sgml Removed Paths: ------------- docs/trunk/rexxref/winclasses.sgml docs/trunk/rexxref/wsheng.sgml Modified: docs/trunk/rexxref/Makefile =================================================================== --- docs/trunk/rexxref/Makefile 2009-02-09 23:47:38 UTC (rev 4115) +++ docs/trunk/rexxref/Makefile 2009-02-10 01:40:17 UTC (rev 4116) @@ -52,7 +52,6 @@ classes.sgml \ streamclasses.sgml \ utilityclasses.sgml \ - winclasses.sgml \ dire.sgml \ errnum.sgml \ errnums.sgml \ @@ -73,7 +72,6 @@ secman.sgml \ spvard.sgml \ usepcom.sgml \ - wsheng.sgml \ xconcur.sgml \ xintdeb.sgml \ collectionclassmethods.sgml \ Modified: docs/trunk/rexxref/classes.sgml =================================================================== --- docs/trunk/rexxref/classes.sgml 2009-02-09 23:47:38 UTC (rev 4115) +++ docs/trunk/rexxref/classes.sgml 2009-02-10 01:40:17 UTC (rev 4116) @@ -97,25 +97,11 @@ the <link linkend="clsTimeSpan">TimeSpan class</link> and the <link linkend="clsTimeSpan">WeakReference class</link>.</para> </listitem></varlistentry> -<varlistentry><term> -<link linkend="winclasses">Windows Classes</link></term> -<listitem><para>This set of classes implement specific Windows operating -system specific features. These classes are only available on Windows. -It includes the <link linkend="clsWinMenuObject">MenuObject class</link>, -the <link linkend="clsWinOLEObject">OLEObject class</link>, the <link -linkend="clsWinClipboard">WindowsClipboard class</link>, the <link -linkend="clsWinEventLog">WindowsEventLog class</link>, the <link -linkend="clsWinManager">WindowsManager class</link>, the <link -linkend="clsWinObject">WindowsObject class</link>, the <link -linkend="clsWinProgramManager">WindowsProgramManager class</link>, and the <link -linkend="clsWinRegistry">WindowsRegistry class</link>.</para> -</listitem></varlistentry> </variablelist> &fundclasses; &strmclasses; &collclasses; &utilityclasses; -&winclasses; </chapter> Modified: docs/trunk/rexxref/rexxref.sgml =================================================================== --- docs/trunk/rexxref/rexxref.sgml 2009-02-09 23:47:38 UTC (rev 4115) +++ docs/trunk/rexxref/rexxref.sgml 2009-02-10 01:40:17 UTC (rev 4116) @@ -12,7 +12,6 @@ <!ENTITY strmclasses SYSTEM "streamclasses.sgml"> <!ENTITY collclasses SYSTEM "collclasses.sgml"> <!ENTITY utilityclasses SYSTEM "utilityclasses.sgml"> -<!ENTITY winclasses SYSTEM "winclasses.sgml"> <!ENTITY xothcla SYSTEM "xothcla.sgml"> <!ENTITY oneof SYSTEM "oneof.sgml"> <!ENTITY funct SYSTEM "funct.sgml"> @@ -27,7 +26,6 @@ <!ENTITY resvkey SYSTEM "resvkey.sgml"> <!ENTITY spvard SYSTEM "spvard.sgml"> <!ENTITY usepcom SYSTEM "usepcom.sgml"> -<!ENTITY wsheng SYSTEM "wsheng.sgml"> <!ENTITY dokey SYSTEM "dokey.sgml"> <!ENTITY mig SYSTEM "mig.sgml"> <!ENTITY errnum SYSTEM "errnum.sgml"> @@ -115,7 +113,6 @@ &resvkey; <!-- Reserved Keywords --> &spvard; <!-- Special Variables --> &usepcom; <!-- Useful Services --> -&wsheng; <!-- Windows Scripting Host Engine --> <!-- start of appendix --> &dokey; <!-- Using the DO Keyword --> &mig; <!-- Migration --> Deleted: docs/trunk/rexxref/winclasses.sgml =================================================================== --- docs/trunk/rexxref/winclasses.sgml 2009-02-09 23:47:38 UTC (rev 4115) +++ docs/trunk/rexxref/winclasses.sgml 2009-02-10 01:40:17 UTC (rev 4116) @@ -1,5542 +0,0 @@ -<!--######################################################################### - # - # Description: Open Object Rexx: Reference SGML file. - # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. - # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. - # - # This program and the accompanying materials are made available under - # the terms of the Common Public License v1.0 which accompanies this - # distribution. A copy is also available at the following address: - # http://www.oorexx.org/license.html - # - # Redistribution and use in source and binary forms, with or - # without modification, are permitted provided that the following - # conditions are met: - # - # Redistributions of source code must retain the above copyright - # notice, this list of conditions and the following disclaimer. - # Redistributions in binary form must reproduce the above copyright - # notice, this list of conditions and the following disclaimer in - # the documentation and/or other materials provided with the distribution. - # - # Neither the name of Rexx Language Association nor the names - # of its contributors may be used to endorse or promote products - # derived from this software without specific prior written permission. - # - # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS - # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED - # TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, - # OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY - # OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING - # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS - # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - # - # Author(s): - # W. David Ashley <da...@us...> - # - ######################################################################### ---> -<section id="winclasses"><title>The Windows Specific Classes</title> -<para>This section describes the Windows-specific classes supplied with -ooRexx.</para> - -<section id="clsWinMenuObject"><title>The Windows MenuObject Class</title> -<indexterm><primary>MenuObject class</primary></indexterm> -<indexterm><primary>class</primary> -<secondary>MenuObject class</secondary></indexterm> -<para>The MenuObject class provides methods to query, manipulate, and interact -with the menu or submenu of a window.</para> -<para>Access to MenuObjects requires that the following directive -appear in the Rexx program.</para> -<programlisting> -::requires 'winsystm.cls' -</programlisting> -<para><emphasis role="bold">Methods the MenuObject Class Defines</emphasis> -</para> -<itemizedlist> -<listitem><para>findItem</para></listitem> -<listitem><para>findSubmenu</para></listitem> -<listitem><para>idOf</para></listitem> -<listitem><para>ischecked</para></listitem> -<listitem><para>isMenu</para></listitem> -<listitem><para>isSubMenu</para></listitem> -<listitem><para>isSeparator</para></listitem> -<listitem><para>items</para></listitem> -<listitem><para>processItem</para></listitem> -<listitem><para>submenu</para></listitem> -<listitem><para>textOf(id)</para></listitem> -<listitem><para>textOf(position)</para></listitem></itemizedlist> - -<section id="ismenumo"><title>isMenu</title> -<indexterm><primary>isMenu method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>isMenu method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-isMenu------------------------------------------------------>< -]]> -</programlisting> - -<para>Returns 1 if the associated window is a menu, otherwise 0.</para> -</section> - -<section id="issubmenumo"><title>isSubMenu</title> -<indexterm><primary>isSubMenu method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>isSubMenu method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-isSubMenu(--position--)------------------------------------->< -]]> -</programlisting> - -<para> - Returns <computeroutput>.true</computeroutput> if the menu item at the position specified is a submenu - of this menu, otherwise <computeroutput>.false</computeroutput>. Menu items are zero-based, so the - first menu item is at position 0. -</para> -</section> - -<section id="ischeckedmo"><title>isChecked</title> -<indexterm><primary>isChecked method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>isChecked method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-isChecked(--position--)------------------------------------->< -]]> -</programlisting> - -<para> - Returns <computeroutput>.true</computeroutput> if the menu item at the position specified is checked, - otherwise <computeroutput>.false</computeroutput>. Menu items are zero-based, so the first menu item is - at position 0. Submenus and separators can be be checked. -</para> -<para> - This method can not be 100% reliable. Some applications do not set the check mark for a menu item until - the menu is displayed. To be confident of the result, the programmer should first test how a specific - application behaves. -</para> -</section> - -<section id="isseparatormo"><title>isSeparator</title> -<indexterm><primary>isSeparator method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>isSeparator method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-isSeparator(--position--)----------------------------------->< -]]> -</programlisting> - -<para> - Returns <computeroutput>.true</computeroutput> if the menu item at the position specified is a - separator line,, otherwise <computeroutput>.false</computeroutput>. Menu items are zero-based, so the - first menu item is at position 0. -</para> -</section> - -<section id="itemsmo"><title>items</title> -<indexterm><primary>items method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>items method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-items------------------------------------------------------->< -]]> -</programlisting> - -<para>Returns the number of menu items contained in the associated menu.</para> -</section> - -<section id="idofmo"><title>idOf</title> -<indexterm><primary>idOf method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>idOf method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-idOf--(--position--)---------------------------------------->< -]]> -</programlisting> - -<para>Returns the ID of the menu item at the specified -<emphasis role="italic">position</emphasis>, starting with 0.</para> -</section> - -<section id="textofpositionmo"><title>textOf(position)</title> -<indexterm><primary>textOf(position) method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>textOf(position) method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-textOf--(--position--)-------------------------------------->< -]]> -</programlisting> - -<para>Returns the text of the menu item at the specified -<emphasis role="italic">position</emphasis>, starting -with 0. A mnemonic (underscored letter) is represented by a leading ampersand -(&). If the menu item contains an accelerator, it is separated by a tab. -</para> -</section> - -<section id="textofidmo"><title>textOf(id)</title> -<indexterm><primary>textOf(id) method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>textOf(id) method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-textOf--(--id--)-------------------------------------------->< -]]> -</programlisting> - -<para>Returns the text of menu item <emphasis role="italic">id</emphasis>. -A mnemonic is represented by a leading ampersand (&). If the menu item -contains an accelerator, it is separated by a tab.</para> -</section> - -<section id="submenumo"><title>submenu</title> -<indexterm><primary>submenu method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>submenu method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-submenu--(--position--)------------------------------------->< -]]> -</programlisting> - -<para>Returns an instance of the MenuObject class that is associated with the -submenu at the specified <emphasis role="italic">position</emphasis>, -starting with 0. If no submenu -exists at this position, the .Nil object is returned.</para> -<para><emphasis role="bold">Example:</emphasis></para> -<programlisting> -sub = menu~submenu(5) - if sub \= .Nil then do - say "Items:" sub~items - end -</programlisting> -</section> - -<section id="findsubmenumo"><title>findSubmenu</title> -<indexterm><primary>findSubmenu method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>findSubmenu method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-findSubmenu--(--label--)------------------------------------>< -]]> -</programlisting> - -<para>Returns an instance of the MenuObject class that is associated with the -submenu with the specified <emphasis role="italic">label</emphasis>. -If the associated menu does not -contain such a submenu, the .Nil object is returned.</para> -</section> - -<section id="finditemmo"><title>findItem</title> -<indexterm><primary>findItem method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>findItem method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-findItem--(--label--)--------------------------------------->< -]]> -</programlisting> - -<para>Returns the ID of the menu item <emphasis role="italic">label</emphasis>. -If the specified label -does not include an accelerator, the comparison excludes the accelerators -of the menu items. If no menu item is found that matches the specified label, -0 is returned.</para> -<para><emphasis role="bold">Example:</emphasis></para> -<programlisting> -f = menu~findItem("&Tools" || "9"x || "Ctrl+T") - if f \= 0 then menu~processItem(f) -</programlisting> -</section> - -<section id="processitemmo"><title>processItem</title> -<indexterm><primary>processItem method</primary> -<secondary>of MenuObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>processItem method</secondary> -<tertiary>of MenuObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-processItem--(--id--)--------------------------------------->< -]]> -</programlisting> - -<para>Selects the menu item <emphasis role="italic">id</emphasis>. This causes -a WM_COMMAND to be sent to the window owning the menu.</para> -</section> -</section> - -<section id="clsWinOLEObject"><title>The Windows OLEObject Class</title> -<indexterm><primary>OLEObject class</primary></indexterm> -<indexterm><primary>class</primary> -<secondary>OLEObject class</secondary></indexterm> -<para> - This class provides support for OLE automation. OLE (Object Linking and Embedding) is an implementation - of COM (Component Object Model). OLE automation makes it possible for one application to manipulate - objects implemented in another application, or to expose objects so they can be manipulated. -</para> -<para> - An automation client is an application that can manipulate exposed objects belonging to another - application. An automation server is an application that exposes the objects. The OLEObject class - enables Rexx to be an OLE automation client. In addition, some automation servers have an event <link - linkend="oleevents">mechanism</link> that allows them to invoke methods in the OLE automation client. - The OLEObject class also supports this mechanism. -</para> -<para> - Applications can provide OLE objects, and OLE objects that support automation can be used by a Rexx - script to remotely control the object through the supplied methods. This lets you write a Rexx script - that, for example, starts a Web browser, navigates to a certain page, and changes the display mode of - the browser. -</para> -<para> - Every application that supports OLE places a unique identifier in the registry. This identifier is - called the class ID (CLSID) of the OLE object. It consists of several hexadecimal numbers separated by - the minus symbol. -</para> -<para> - <emphasis role="bold">Example:</emphasis> CLSID of <trademark class="registered">Microsoft</trademark> - Internet Explorer (Version 5.00.2014.0216): -</para> -<programlisting> -"{0002DF01-0000-0000-C000-000000000046}" -</programlisting> -<para> - The CLSID number can prove inconvenient when you want to create or access a certain object, so a - corresponding easy-to-remember entry is provided in the registry, and this entry is mapped to the - CLSID. This entry is called the ProgID (the program ID), and is a string containing words separated by - periods. -</para> -<para> - <emphasis role="bold">Example:</emphasis> ProgID of Microsoft Internet Explorer: - <computeroutput>"InternetExplorer.Application"</computeroutput> -</para> -<para> - To find the ProgID of an application, you can use the sample script - <computeroutput>OLEINFO.REX</computeroutput> or the Microsoft OLEViewer, you can consult the - documentation of the application, or you can search the registry manually. -</para> -<para> - The OLEObject class is a built-in class. No <computeroutput>::requires</computeroutput> directive is - needed to use the class. -</para> -<para> - Several sample programs are provided in the Open Object Rexx installation directory under - <computeroutput>samples\ole</computeroutput> -</para> -<itemizedlist> -<listitem> -<para> - The apps directory contains examples of how to use Rexx to remote-control other applications. -</para> -</listitem> -<listitem> -<para> - The oleinfo directory is a sample Rexx application that can be used to browse through the information - an OLE object provides. -</para> -</listitem> -<listitem> -<para> - In the adsi directory there are eight examples of how to use the Active Directory Services Interface - with the Rexx OLE interface. -</para> -</listitem> -<listitem> -<para> - The methinfo directory contains a very basic example of how to access the information an OLE object - provides. -</para> -</listitem> -<listitem> -<para> - Finally, the wmi directory contains five examples of how to work with the Windows Management - Instrumentation. -</para> -</listitem> -</itemizedlist> -<para> - <emphasis role="bold">Methods available to the OLEObject class:</emphasis> -</para> -<simplelist> -<member>new (Class method)</member> -<member>addEventMethod</member> -<member>connectEvents</member> -<member>disconnectEvents</member> -<member>dispatch</member> -<member>getConstant</member> -<member>getKnownEvents</member> -<member>getKnownMethods</member> -<member>getObject(Class method)</member> -<member>getOutParameters</member> -<member>isConnected</member> -<member>isConnectable</member> -<member>removeEvents</member> -<member>removeEventHandler</member> -<member>unknown</member> -</simplelist> -<para> - <emphasis role="bold">Note:</emphasis> It is somewhat useful to think of the Rexx OLEObject object as a - proxy to the real OLE object. The real OLE object has its own methods. Which methods it has is - dependent on its individual implementation. These methods are then accessed transparently through the - <link linkend="oleobunk">unknown</link>() method mechanism of the OLEObject by invoking a method of the - same name on the OLEObject object. -</para> - -<section id="oleevents"><title>OLE Events</title> -<indexterm><primary>OLE Events</primary> -<secondary>of OLEObject class</secondary></indexterm> -<para> - Some, but not all, OLE automation objects support <emphasis role="italic">events</emphasis>. The most - prevalent use of OLE is for the automation server (the OLE object) to implement methods that the - automation client (the ooRexx OLEObject) invokes. However, it is also possible for the automation - client (the ooRexx OLEOjbect) to implement methods that the automation server (the OLE object) invokes. -</para> -<para> - The methods that the automation client implements are called event methods and the automation server - that suports event methods is called a <emphasis role="italic">connectable</emphasis> object. The - connectable object defines the events it supports by defining the name of the method and its arugments, - but does not implement the method. Rather the automation client implements the method. The client asks - the automation server to make a <emphasis role="italic">connection</emphasis>. If the connection is - established, then from that point on whenever one of the defined events occurs, the server invokes the - event method on the connected client. -</para> -<para> - In effect, what is happening is that the automation server is <emphasis - role="italic">notifying</emphasis> the automation client that some event has occurred and giving the - client a chance to react to the event. Any number of clients can be connected to the same connectable - object at the same time. Each client will recieve a notification for any event they are interested in. - There is no need for the client to receive notifications for evey event. When the client is not - interested in an event, the client simply does not implement a method for that event. -</para> -<para> - The original implementation of OLEObject allowed the Rexx programmer to use events in this way: The - programmer defines and implements a subclass of the OLEObject. Within the subclass, the programmer - defines and implements the event methods for which she wants to recieve notifications. The progammer - has the client make a connection to the automation server at the time the OLEObject object is <link - linkend="oleobjinit">instantiated</link> by using the <computeroutput>WITHEVENTS</computeroutput> - keyword for the <emphasis role="italic">events</emphasis> argument. If the - <computeroutput>WITHEVENTS</computeroutput> keyword is not used during instantiation, then no event - connection can be made. -</para> -<para> - This is relatively easy to understand and a simple example should make this clear. In the following, - rather than create a new OLEObject, the programmer defines a subclass of the OLEObject, a WatchedIE - class. The WatcheID object is instantiated with events. This tells the OLEObject to make an event - connection, if possible. In the subclass, the programmer implements the events he is interested in - receiving notifications for. -</para> -<para><emphasis role="bold">Example:</emphasis></para> -<programlisting> -<![CDATA[ - --- Instantiate an instance of the subclassed OLEObject -myIE = .WatchedIE~new("InternetExplorer.Application", "WITHEVENTS") -... - --- This class is derived from OLEObject and contains several methods --- that will be called when certain events take place. -::class 'WatchedIE' subclass OLEObject - --- This is an event of the Internet Explorer */ -::method titleChange - use arg Text - say "The title has changed to:" text - --- This is an event of the Internet Explorer -::method beforeNavigate2 - use arg pDisp, URL, Flags, TargetFrameName, PostData, Headers, Cancel - ... - --- This is an event of the Internet Explorer */ -::method onQuit - ... - -]]> -</programlisting> -<para> - However, the process described above only allows using events with OLEObject objects that are directly - instantiated by the programmer. There are a number of OLE objects that support events, where the - OLEObject object is not instantiated by the programmer, but rather is returned from a method - invocation. Prior to ooRexx 4.0.0, events could not be used with these objects. In 4.0.0, methods were - added to the OLEObject class that allow using events with any OLE object that supports events. -</para> -<para> - This second process works this way: With an already instantiated object, the programmer can create - method objects for any events of interest and use the <link - linkend="oleobjaddeventmethod">addEventMethod</link>() method to add the method to the instantiated - object. Then the <link linkend="oleobjconnectevents">connectEvents</link>() method is used to connect - the automation client (the instantiated object in this case) to the connectable OLE automation server. -</para> -<para> - The following example demonstrates this second process that is available in ooRexx 4.0.0 and onwards. -</para> -<para><emphasis role="bold">Example:</emphasis></para> -<programlisting> -<![CDATA[ - - wordApp = .OLEObject~new("Word.Application") - wordApp~visible = .true - document = wordApp~documents~Add - - -- Use the isConnectable method to ensure the object supports connections. - if document~isConnectable then do - - -- Create a method for the OLEEvent_Close event. From the Word documentation - --and experimentation, it is known that this event has no arguments. - mArray = .array~new - mArray[1] = 'say "Received the OLEEvent_Close event."' - mArray[2] = 'say " Event has" arg() "parameters."' - mArray[3] = 'say' - - mClose = .Method~new("OLEEvent_Close", mArray) - - -- Now add this method to the document object. - document~addEventMethod("OLEEvent_Close", mClose) - - -- Tell the object to make an events connection. - document~connectEvents - end - -]]> -</programlisting> -<para> - The preceding example brings up one last point that is important to note when defining event methods. - It is possible for an event method to have the same name as a normal invocation method of the OLE - object. This gives rise to this scenario: -</para> -<para> - The programmer adds an ooRexx event method to the OLEObject with that name. Then the programmer tries - to invoke the normal method. However, the invocation will no longer get forwarded to the <link - linkend="oleobunk">unknown</link>() method. Instead the event method by the same name is invoked. This - is the case in the above example. The document object has a <computeroutput>close</computeroutput>() - method that is used to close the document. The document also has the - <computeroutput>close</computeroutput>() event method that is used to notify clients that the document - is about to close. -</para> -<para> - To prevent this scenario, when an event method of an OLE object has the same name as a normal method - name, the programmer must prepend <computeroutput>OLEEvent_</computeroutput> to the method name. The - implementation of OLEObject assumes the programer has done so. If the programmer does not name the - event methods using this convention, the results are unpredicatable. -</para> -<para> - <emphasis role="bold">Note</emphasis> that <emphasis role="italic">only</emphasis> the event method - names that have matching normal event names can be prepended with the OLEEvent_prefix. Other event - names must not have the prefix. One way to check for this is to use the <link - linkend="oleobgetknev">getKnownEvents</link>() method. This method will return the correct names for - all events the OLE object supports. -</para> -<para><emphasis role="bold">Example:</emphasis></para> -<para> - This example is a compelete working program. To run it, Microsoft OutLook must be installed. The - program demonstrates some of the various methods of the OLEObject that deal with events. The interface - to the program is simplistic, but workable. -</para> -<para> - Once the program starts, the user controls it by creating specific named files in working directory of - the program. This could be done for example using echo: -<programlisting> -<![CDATA[ -echo " " > stop.monitor -]]> -</programlisting> - The three specific file names are: <computeroutput>stop.monitor</computeroutput>, - <computeroutput>pause.monitor</computeroutput>, and <computeroutput>restart.monitor</computeroutput>. - The stop file ends the program. The pause file has the program stop monitoring for new mail, but keep - running. The restart file has the program restart monitoring from the paused state. -</para> -<programlisting> -<![CDATA[ - -/* Monitor OutLook for new mail */ - say; say; say 'ooRexx Mail Monitor version 1.0.0' - - outLook = .oleObject~new("Outlook.Application") - - inboxID = outLook~getConstant(olFolderInBox) - inboxItems = outLook~getNameSpace("MAPI")~getDefaultFolder(inboxID)~items - - if \ inboxItems~isConnectable then do - say 'Inbox items is NOT connectable, quitting' - return 99 - end - - inboxItems~addEventMethod("ItemAdd", .methods~printNewMail) - inboxItems~connectEvents - - if \ inboxItems~isConnected then do - say 'Error connecting to inbox events, quitting' - return 99 - end - - monitor = .Monitor~new - say 'ooRexx Mail Monitor - monitoring ...' - do while monitor~isActive - j = SysSleep(1) - status = monitor~getStatus - - select - when status == 'disconnect' then do - inboxItems~disconnectEvents - say 'ooRexx Mail Monitor - paused ...' - end - when status == "reconnect" then do - inboxItems~connectEvents - say 'ooRexx Mail Monitor - monitoring ...' - end - otherwise do - nop - end - end - -- End select - end - say 'ooRexx Mail Monitor version 1.0.0 ended' - -return 0 - -::method printNewMail unguarded - use arg mailItem - say 'You have mail' - say 'Subject:' mailItem~subject - -::class 'Monitor' -::method init - expose state active - - state = 'continue' - active = .true - j = SysFileDelete('stop.monitor') - j = SysFileDelete('pause.monitor') - j = SysFileDelete('restart.monitor') - -::method isActive - expose active - return active - -::method getStatus - expose state active - - if SysIsFile('stop.monitor') then do - j = SysFileDelete('stop.monitor') - active = .false - state = 'quit' - return state - end - - if SysIsFile('pause.monitor') then do - j = SysFileDelete('pause.monitor') - if state == "paused" then return "continue" - - if state \== 'quit' then do - state = "paused" - return 'disconnect' - end - end - - if SysIsFile('restart.monitor') then do - j = SysFileDelete('restart.monitor') - if state == 'continue' then return state - - if state \== 'quit' then do - state = 'continue' - return 'reconnect' - end - end - - return 'continue' - -]]> -</programlisting> -</section> - -<section id="oleobjinit"><title>new (Class method)</title> -<indexterm><primary>new method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>new method</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>--new(--classID--+-----------+--+--------------+--)------------------->< - +-,-events--+ +-,-getObject--+ -]]> -</programlisting> - -<para> - Instantiates a new OLEObject as a proxy for a COM / OLE object with the specified <emphasis - role="italic">classID</emphasis> (the <computeroutput>ProgID</computeroutput> or - <computeroutput>CLSID</computeroutput>). If the COM / OLE object can not be accessed or created, an - error will be raised. See the list of <link linkend="ERR92">OLE specific errors</link>. -</para> -<variablelist> - <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> - <listitem> - <para>The arguments are: - <variablelist> - <varlistentry><term>classID</term> - <listitem> - <para> - The <computeroutput>ProgID</computeroutput> or <computeroutput>CLSID</computeroutput> that - identifies the COM / OLE object to proxy for. - </para> - </listitem></varlistentry> - <varlistentry><term>events</term> - <listitem> - <para> - Controls how the event methods of the COM / OLE object are handled: - </para> - <para> - If the argument is omitted completely, then no action concerning the event methods is taken. - </para> - <para> - If the argument is NOEVENTS then the COM / OLE object is queried to determine if it is a - connectable object. If it is, an internal table is constructed listing all the event methods. - But the object is not connected. - </para> - <para> - If the argument is WITHEVENTS then the COM / OLE object is queried to determine if it is a - connectable object. If it is, an internal table is constructed listing all the event methods, - and an event connection is established. - </para> - </listitem></varlistentry> - <varlistentry><term>getObject</term> - <listitem> - <para> - A flag asking to first try to get an already instantiated OLE object, rather than instantiate a - new object. Some OLE automation servers register themselves with the operating system when an - object is first created, but not all do. If this flag is true, then the OLEObject first tries - to proxy for an already running OLE / COM object. If this fails, then a new OLE / COM object is - instantiated. - </para> - <para> - If the flag is omitted, or <computeroutput>.false</computeroutput> then no attempt to look for - an already running OLE / COM object is made. - </para> - </listitem></varlistentry> - </variablelist> - </para> - </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Example:</emphasis></term> - <listitem> -<programlisting> -<![CDATA[ -myOLEObject = .OLEObject~new("InternetExplorer.Application") -]]> -</programlisting> - </listitem></varlistentry> -</variablelist> - -</section> - -<section id="oledispatch"><title>dispatch</title> -<indexterm><primary>dispatch method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>dispatch method</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> - -<programlisting> -<![CDATA[ ->>-dispatch(methodname--+------------+--)---------------------->< - | +------+ | - | V | | - +----,arg-+--+ -]]> -</programlisting> - -<para> -Dispatches a method with the optionally supplied arguments. -</para> -</section> - -<section id="oleobgetcon"><title>getConstant</title> -<indexterm><primary>getConstant method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>getConstant</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-getConstant(-+--------------+-)----------------------------->< - +-ConstantName-+ -]]> -</programlisting> - -<para>Retrieves the value of a constant that is associated with this -OLE object. If no constant of that name exists, the .Nil object will be returned. -You can also omit the name of the constant; this returns a stem with all known -constants and their values. In this case the constant names will be prefixed -with a "!" symbol.</para> -<para><emphasis role="bold">Example 1:</emphasis></para> -<programlisting> -myExcel = .OLEObject~new("Excel.Application") -say "xlCenter has the value" myExcel~getConstant("xlCenter") -myExcel~quit -exit -</programlisting> -<para>Possible output:</para> -<programlisting> -xlCenter has the value -4108 -</programlisting> -<para><emphasis role="bold">Example 2:</emphasis></para> -<programlisting> -myExcel = .OLEObject~new("Excel.Application") -constants. = myExcel~getConstant -myExcel~quit - -do i over constants. - say i"="constants.i -end -</programlisting> -<para>Possible output:</para> -<programlisting> -!XLFORMULA=5 -!XLMOVE=2 -!XLTEXTMAC=19 -... -</programlisting> -</section> - -<section id="oleobgetknev"><title>getKnownEvents</title> -<indexterm><primary>getKnownEvents method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>getKnownEvents method</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-getKnownEvents---------------------------------------------->< -]]> -</programlisting> - -<para> - Returns a stem with information on the <link linkend="oleevents">events</link> that the connectable OLE - object supports. It collects this information from the type library of the OLE object. A type library - provides the names, types, and arguments of the provided methods. The OLEObject object does not need to - be currently connected to connectable OLE object. -</para> -<para> - This method will return the event methods for any connectable object. Prior to ooRexx 4.0.0, only - OLEObjects created directly, and created with the 'event' flag (WITHEVENTS or NOEVENTS) would return - any known events. This fact had not been fully documented. Therefore, if the user did not create the - OLEObject correctly, .nil would be returned for objects that did support event connections. -</para> -<para> - In 4.0.0, the behavior is fixed (or enhanced depending on the point of view) so that the known events - are returned for all connectable objects under all circumstances. -</para> -<para>The stem provides the following information:</para> - -<table frame="all"> -<title>Stem Information</title> -<tgroup cols="2"> -<tbody> -<row> -<entry>stem.0</entry> -<entry>The number of events.</entry> -</row> -<row> -<entry>stem.n.!NAME</entry> -<entry>Name of n-th event.</entry> -</row> -<row> -<entry>stem.n.!DOC</entry> -<entry>Description of n-th event (if available).</entry> -</row> -<row> -<entry>stem.n.!PARAMS.0</entry> -<entry>Number of parameters for n-th event.</entry> -</row> -<row> -<entry>stem.n.!PARAMS.i.!NAME</entry> -<entry>Name of i-th parameter of n-th event.</entry> -</row> -<row> -<entry>stem.n.!PARAMS.i.!TYPE</entry> -<entry>Type of i-th parameter of n-th event.</entry> -</row> -<row> -<entry>stem.n.!PARAMS.i.!FLAGS</entry> -<entry>Flags of i-th parameter of n-th event; can be "in", -"out", "opt", or any combination of these.</entry> -</row> -</tbody> -</tgroup> -</table> -<para> - If no information is available, the .NIL object is returned. This indicates that the OLE object does - support events. -</para> -<para><emphasis role="bold">Example script:</emphasis></para> -<programlisting> -myIE = .OLEObject~new("InternetExplorer.Application","NOEVENTS") -events. = myIE~getKnownEvents - -if events. == .nil then - say "Sorry, this object does not have any events." -else do - say "The following events may occur:" - do i = 1 to events.0 - say events.i.!NAME - end -end - -exit -</programlisting> -<para><emphasis role="bold">Sample output:</emphasis></para> -<programlisting> -The following events may occur: -ONTHEATERMODE -ONFULLSCREEN -ONSTATUSBAR -... -</programlisting> -<para> - For an example of how to use events, see examples - <computeroutput>samples\ole\apps\samp12.rex</computeroutput> and - <computeroutput>samples\ole\apps\samp13.rex</computeroutput>. The samples directory is installed as - part of the normal Windows installation. -</para> -</section> - -<section id="oleobjconnectevents"><title>connectEvents</title> -<indexterm><primary>connectEvents method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>connectEvents</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>--connectEvents---------------------------------------------->< -]]> -</programlisting> - -<para> - The connectEvents() method is used to connect the instantiated automation client (the OLEObject - subclass object) to the automation server (the OLE object) at any time. The method returns - <computeroutput>.true</computeroutput> if the connection was made, otherwise - <computeroutput>.false</computeroutput>. Remember, not all OLE objects support events. The programmer - can determine if the OLE object supports events by using the <link - linkend="oleobjisconnectable">isConnectable</link>() method. -</para> -<para><emphasis role="bold">Example:</emphasis></para> -<programlisting> -<![CDATA[ - - wordApp = .OLEObject~new("Word.Application") - wordApp~visible = .true - document = wordApp~documents~Add - - wordApp~connectEvents - -]]> -</programlisting> -</section> - -<section id="oleobjisconnected"><title>isConnected</title> -<indexterm><primary>isConnected method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>isConnected</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>--isConnected------------------------------------------------>< -]]> -</programlisting> - -<para> - Determines if the OLEObject instance is currently connected to a connectable OLE automation server. - Returns <computeroutput>.true</computeroutput> if the instance is connected and - <computeroutput>.false</computeroutput> if not. -</para> -<para><emphasis role="bold">Example:</emphasis></para> -<programlisting> -<![CDATA[ - wordObj = .oleObject~new("Word.Application", "WITHEVENTS") - if wordObj~isConnected then do - ... - end - else do - ... - end - -]]> -</programlisting> -</section> - -<section id="oleobjisconnectable"><title>isConnectable</title> -<indexterm><primary>isConnectable method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>isConnectable</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>--isConnectable---------------------------------------------->< -]]> -</programlisting> - -<para> - Determines if the OLE object is a connectable object. In other words, does the OLE object support event - methods and will it accept connections at this time. Not all OLE objects support events, probably the - majority do not support events. This method returns <computeroutput>.true</computeroutput> if the - object is connectable, otherwise <computeroutput>.false</computeroutput>. -</para> -<para><emphasis role="bold">Example:</emphasis></para> -<programlisting> -<![CDATA[ - - outLook = .oleObject~new("Outlook.Application") - - -- This searches all folders for the 'Mailbox - .. ' folder. Which is - -- usually the default folder in a business installation of Outlook. - nameSpace = outLook~getNameSpace('MAPI') - folders = nameSpace~folders - do i = 1 to folders~count - if folders~item(i)~name~caselessPos("Mailbox") <> 0 then do - theMailBoxFolder = folders~item(i) - leave - end - end - - -- Now that we have the Mailbox folder, get the collection of folders that - -- are contained in the Mailbox folder. - folders = theMailBoxFolder~folders - - if folders~isConnectable then do - -- Add event methods to the folders object. - ... - end - -]]> -</programlisting> -</section> - -<section id="oleobjdisconnectevents"><title>disconnectEvents</title> -<indexterm><primary>disconnectEvents method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>disconnectEvents</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>--disconnectEvents------------------------------------------->< -]]> -</programlisting> - -<para> - This method disconnects from the connectable OLE object. The method returns - <computeroutput>.false</computeroutput> if there is not a current connection, otherwise - <computeroutput>.true</computeroutput>. After this method is called, the OLE object will no longer - invoke the event methods, in effect stopping event notifications. -</para> -<para> - The internal data structures used to manage events remain intact. The programmer can use the <link - linkend="oleobjconnectevents">connectEvents</link>() method to reconnect at any time. Since the - internal data structures do not need to be rebuilt, this will save some small amount of processor time. - To completely remove the internal data structures use the <link - linkend="oleobjremoveeventhandler">removeEventHandler</link>() method. -</para> -<para><emphasis role="bold">Example:</emphasis></para> -<para> - This example shows some code snippets from a program that monitors the user's inbox in OutLook. When a - new mail item arrives, the user is notified. The interface for the program allows the user to turn off - the notifications when she wants, then turn them back on later. When the interface signals the program - to stop the notifications, the program simply disconnects the events from the OutLook object. When the - user wants to resume notifications, the program reconnects the events. -</para> -<programlisting> -<![CDATA[ - - outLook = .oleObject~new("Outlook.Application") - inboxID = outLook~getConstant(olFolderInBox) - inboxItems = outLook~getNameSpace("MAPI")~getDefaultFolder(inboxID)~items - - ... - - inboxItems~addEventMethod("ItemAdd", .methods~printNewMail) - inboxItems~connectEvents - - ... - - select - when status == 'disconnect' then do - inboxItems~disconnectEvents - say 'ooRexx Mail Monitor - paused ...' - end - when status == "reconnect" then do - inboxItems~connectEvents - say 'ooRexx Mail Monitor - monitoring ...' - end - otherwise do - nop - end - end - -- End select - - -]]> -</programlisting> -</section> - -<section id="oleobjremoveeventhandler"><title>removeEventHandler</title> -<indexterm><primary>removeEventHandler method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>removeEventHandler</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>--removeEventHandler----------------------------------------->< -]]> -</programlisting> - -<para> - Removes the event handler and cleans up the internal data structures used to manage events. No event - methods will be invoked after this method is called. See the <link - linkend="oleobjdisconnectevents">disconnectEvents</link>() method for a way to temporarily disconnect - from event notifications. -</para> -<para><emphasis role="bold">Example:</emphasis></para> -<programlisting> -<![CDATA[ - - inboxItems~removeEventHandler - inboxItems~removeEventMethod("ItemAdd") - -]]> -</programlisting> -</section> - -<section id="oleobjaddeventmethod"><title>addEventMethod</title> -<indexterm><primary>addEventMethod method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>addEventMethod</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>--addEventMethod(--name-,-methodObject--)-------------------->< -]]> -</programlisting> - -<para> - <computeroutput>addEventMethod</computeroutput> adds a new method to this object's collection of - methods. The <emphasis role="italic">name</emphasis> argument specifies the name of the new method and - the <emphasis role="italic">methodObject</emphasis> argument defines the method. The acceptable values - for <emphasis role="italic">methodObject</emphasis> are the same as those for the second argument to - the <computeroutput>setMethod</computeroutput> method of the<computeroutput>.Object</computeroutput> - class. That is, it can be a method object, a string containing a method source line, or an array of - strings containgin individual method source lines. -</para> -<para> - The purpose of this method is to add an event method to a OLEObject after the object has been - instantiated. See the <link linkend="oleevents">OLE Events</link> section for more details on events. -</para> -<para><emphasis role="bold">Example:</emphasis></para> -<para> - Note that in this example, the printNewMail method is defined as a floating method. See the - documentation for the <computeroutput>.methods</computeroutput> directory in the Open Object Rexx - Reference book for more details if needed. -</para> -<programlisting> -<![CDATA[ - - inboxID = outLook~getConstant(olFolderInBox) - inboxItems = outLook~getNameSpace("MAPI")~getDefaultFolder(inboxID)~items - - inboxItems~addEventMethod("ItemAdd", .methods~printNewMail) - -... - -::method printNewMail unguarded - use arg mailItem - say 'You have mail' - say 'Subject:' mailItem~subject - - -]]> -</programlisting> -</section> - -<section id="oleobjremoveeventmethod"><title>removeEventMethod</title> -<indexterm><primary>removeEventMethod method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>removeEventMethod</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>--removeEventMethod(--name--)----------------------------------->< -]]> -</programlisting> - -<para> - Removes the event method with the specified <emphasis role="italic">name</emphasis> that has been - previously added to this object by the <link linkend="oleobjaddeventmethod">addEventMethod</link>() - method. -</para> -<para><emphasis role="bold">Example:</emphasis></para> -<programlisting> -<![CDATA[ - - inboxID = outLook~getConstant(olFolderInBox) - inboxItems = outLook~getNameSpace("MAPI")~getDefaultFolder(inboxID)~items - - inboxItems~addEventMethod("ItemAdd", .methods~printNewMail) - inboxItems~connectEvents - - ... - -::method doneWithItemEvents private - expose inboxItems - - inboxItems~removeEventHandler - inboxItems~removeEventMethod("ItemAdd") - -]]> -</programlisting> -</section> - -<section id="oleobgetknme"><title>getKnownMethods</title> -<indexterm><primary>getKnownMethods method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>getKnownMethods method</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-getKnownMethods--------------------------------------------->< -]]> -</programlisting> - -<para>Returns a stem with information on the methods that the OLE object -supplies. It collects this information from the type library of the object. A -type library provides the names, types, and arguments of the provided methods. -Parts of the supplied information have only informational character as you -cannot use them directly.</para> -<para>The stem provides the following information:</para> - -<table frame="all"> -<title>Stem Information</title> -<tgroup cols="2"> -<tbody> -<row> -<entry>stem.0</entry> -<entry>The number of methods.</entry> -</row> -<row> -<entry>stem.!LIBNAME</entry> -<entry>Name of the type library that describes this object.</entry> -</row> -<row> -<entry>stem.!LIBDOC</entry> -<entry>A help string describing the type library. Only set -when the string is available.</entry> -</row> -<row> -<entry>stem.!COCLASSNAME</entry> -<entry>COM class name of this object.</entry> -</row> -<row> -<entry>stem.!COCLASSDOC</entry> -<entry>A string describing the COM class. Only set -when the string is supplied by the type library.</entry> -</row> -<row> -<entry>stem.n.!NAME</entry> -<entry>The name of the n-th method.</entry> -</row> -<row> -<entry>stem.n.!DOC</entry> -<entry>A help string for the n-th method. If this information -is not supplied in the type library this value will not be set.</entry> -</row> -<row> -<entry>stem.n.!INVKIND</entry> -<entry>A number that represents the invocation kind of the -method: 1 = normal method call, 2 = -<computeroutput>property get</computeroutput>, 4 = <computeroutput>property -put</computeroutput>. A normal method call is used with brackets; for a -<computeroutput>property -get</computeroutput> only the name is to be specified; and a -<computeroutput>property set</computeroutput> uses -the "=" symbol, as in these examples: -<computeroutput>object~methodCall(a,b,c)</computeroutput> -<computeroutput>object~propertyPut="Hello"</computeroutput> -<computeroutput>say object~propertyGet</computeroutput></entry> -</row> -<row> -<entry>stem.n.!RETTYPE</entry> -<entry>The return type of the n-th method. The return type -will be automatically converted to a Rexx object (see -<link linkend="oleobtypconv">Type Conversion</link> in -the description of the UNKNOWN method of the OLEObject class).</entry> -</row> -<row> -<entry>stem.n.!MEMID</entry> -<entry>The MemberID of the n-th method. This is only used internally -to call the method.</entry> -</row> -<row> -<entry>stem.n.!PARAMS.0</entry> -<entry>The number of parameters of the n-th method.</entry> -</row> -<row> -<entry>stem.n.!PARAMS.i.!NAME</entry> -<entry>The name of the i-th parameter of the n-th method.</entry> -</row> -<row> -<entry>stem.n.!PARAMS.i.!TYPE</entry> -<entry>The type of the i-th parameter of the n-th method.</entry> -</row> -<row> -<entry>stem.n.!PARAMS.i.!FLAGS</entry> -<entry>The flags of the i-th parameter of the n-th method; -can be "in", "out", "opt", or any combination of these (for example: "[in, -opt]").</entry> -</row> -</tbody> -</tgroup> -</table> -<para>If no information is available, the .NIL object is returned.</para> - -<para> - <emphasis role="bold">Note</emphasis> that it is not required that an OLE object supply a type library. - The methods of OLE objects that do not supply a type library can still be invoked by name, but there is - no way for <computeroutput>getKnownMethods</computeroutput> to look up the methods. To use these OLE - objects the Rexx programmer would need to consult the documentation for the OLE object. -</para> -<para> - In addition all OLE objects have methods that can only be used internally. There are mechanisms to - <emphasis role="italic">hide</emphasis> these methods from the user, because they can not be used by - the automation client. It is possible that these are not hidden properly and will be listed when using - <computeroutput>getKnownMethods</computeroutput>. The following methods can not be used by an instance - of the OLEObject: -</para> -<simplelist> -<member>AddRef</member> -<member>GetTypeInfoCount</member> -<member>GetTypeInfo</member> -<member>GetIDsOfNames</member> -<member>QueryInterface</member> -<member>Release</member> -</simplelist> -<para><emphasis role="bold">Example script:</emphasis></para> -<programlisting> -myOLEObject = .OLEObject~new("InternetExplorer.Application") -methods. = myOLEObject~getKnownMethods - -if methods. == .nil then - say "Sorry, no information on the methods available!" -else do - say "The following methods are available to this OLE object:" - do i = 1 to methods.0 - say methods.i.!NAME - end -end - -exit -</programlisting> -<para><emphasis role="bold">Sample output:</emphasis></para> -<programlisting> -The following methods are available to this OLE object: -GoBack -GoForward -GoHome -... -</programlisting> -</section> - -<section id="oleobgetob"><title>getObject (Class method)</title> -<indexterm><primary>getObject method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>getObject method</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-getObject(Moniker-+--------+-)------------------------------>< - +-,class-+ -]]> -</programlisting> - -<para> - This is a class method that allows you to obtain an OLE object through the use of a moniker. A moniker - is a string and is similar to a nickname. Monikers are used by OLE to connect to and activate OLE - objects. OLE returns the object that the moniker identifies. -</para> -<para> - If the object is already running, OLE will find it in memory. If the object is stored passively on - disk, OLE will locate a server for the object, run the server, and have the server bring the object - into the running state. This makes monikers very easy for the automation client to use. OLE hides all - the details from the client. However, since the OLEObject also hides all the details when a new OLE - object is instantiated, for the Rexx programmer there is not much difference between using the - <computeroutput>getObject</computeroutput> method and using the <computeroutput>new</computeroutput> - method. -</para> -<para> - Note that file system names are monikers. Therefore, if a file is assoicated with an application that - is an OLE automation server, a new OLE object can be instantiated by using the file name as the - moniker. Obviously, this is not true of every file. It is true for files like - <computeroutput>.xls</computeroutput> and <computeroutput>.doc</computeroutput> files, for example, - because Word and Excel are OLE automation applications. -</para> -<para> - The optional <emphasis role="italic">class</emphasis> argument can be used to specify a subclass of - OLEObject, and can be used to obtain an OLE object that supports events - (the<computeroutput>'WITHEVENTS'</computeroutput> option will be used in this case). This - method is similar to the <computeroutput>new</computeroutput> method where the programmer supplies a - ProgID or CLSID. In this case the programmer supplies a moniker. -</para> -<para><emphasis role="bold">Example:</emphasis></para> -<programlisting> -/* create a Word.Document by opening a certain file */ -myOLEObject = .OLEObject~GetObject("C:\DOCS\HELLOWORLD.DOC") -</programlisting> -</section> - -<section id="oleobgetoutpar"><title>getOutParameters</title> -<indexterm><primary>getOutParameters method</primary> -<secondary>of OLEObject class</secondary></indexterm> -<indexterm><primary>method</primary> -<secondary>getOutParameters method</secondary> -<tertiary>of OLEObject class</tertiary></indexterm> -<programlisting> -<![CDATA[ ->>-getOutParameters-------------------------------------------->< -]]> -</programlisting> - -<para>Returns an array containing the results of the single -<computeroutput>out</computeroutput> parameters -of the OLE object, or the .NIL object if it does not have any. -<computeroutput>Out</computeroutput> parameters -are arguments to the OLE object that are filled in by the OLE object. As this -is not possible in Rexx due to data encapsulation, the results are placed -in the array mentioned above.</para> -<para><emphasis role="bold">Example:</emphasis></para> -<para>Consider an OLE object method with the following signature:</para> -<programlisting> -aMethod([in] A, [in] B, [out] sumAB) -</programlisting> -<para>The resulting <computeroutput>out</computeroutput> parameter of the -method invocation will be placed in the <computeroutput>out</computeroutput> -array at position one; the "normal" return -value gets processed as usual. In this case the method will return the .NIL -object:</para> -<programlisting> -resultTest = myOLEObject~aMethod(1, 2, .NIL) -say "Invocation result :" resultTest -say "Result in out array:" myOLEObject~getOutParameters~at(1) -</programlisting> -<para>The output of this sample script will be:</para> -<programlisting> -The NIL object -3 -</programlisting> -<para><computer... [truncated message content] |
From: <mie...@us...> - 2009-02-10 05:14:14
|
Revision: 4118 http://oorexx.svn.sourceforge.net/oorexx/?rev=4118&view=rev Author: miesfeld Date: 2009-02-10 05:14:03 +0000 (Tue, 10 Feb 2009) Log Message: ----------- Fix the Windows Extensions document so it builds as a book on its own. Modified Paths: -------------- docs/trunk/Makefile docs/trunk/winextensions/Makefile docs/trunk/winextensions/preface.sgml docs/trunk/winextensions/winclasses.sgml docs/trunk/winextensions/winextensions.sgml Added Paths: ----------- docs/trunk/winextensions/docbook-1.png docs/trunk/winextensions/hyperref.cfg docs/trunk/winextensions/oorexx.jpg Modified: docs/trunk/Makefile =================================================================== --- docs/trunk/Makefile 2009-02-10 03:19:40 UTC (rev 4117) +++ docs/trunk/Makefile 2009-02-10 05:14:03 UTC (rev 4118) @@ -41,7 +41,7 @@ #---------------------------------------------------------------------------- -SUBDIRS=oodialog readme rexxpg rexxref rxftp rxmath rxsock +SUBDIRS=oodialog readme rexxpg rexxref rxftp rxmath rxsock winextensions all: for d in $(SUBDIRS); do (cd $$d && make all); done Modified: docs/trunk/winextensions/Makefile =================================================================== --- docs/trunk/winextensions/Makefile 2009-02-10 03:19:40 UTC (rev 4117) +++ docs/trunk/winextensions/Makefile 2009-02-10 05:14:03 UTC (rev 4118) @@ -2,7 +2,7 @@ # # Description: Makefile for the Object Rexx Reference Documents. # -# Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. +# Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # # This program and the accompanying materials are made available under # the terms of the Common Public License v1.0 which accompanies this @@ -42,157 +42,48 @@ STYLESHEET = /usr/share/sgml/docbook/dsssl-stylesheets/print/docbook.dsl \ - ../shared/oorexx.print.dsl + ../shared/oorexx.print.dsl + HTML_STYLESHEET = /usr/share/sgml/docbook/dsssl-stylesheets/html/docbook.dsl \ - ../shared/oorexx.html.dsl + ../shared/oorexx.html.dsl +SGML_FILES = winclasses.sgml \ + wsheng.sgml \ + ../shared/legalstuff.sgml \ + ../shared/notices.sgml \ + ../shared/gethelp.sgml \ + ../shared/CPLv1.0.sgml -SGML_FILES = collclasses.sgml \ - condtra.sgml \ - classes.sgml \ - streamclasses.sgml \ - utilityclasses.sgml \ - winclasses.sgml \ - dire.sgml \ - errnum.sgml \ - errnums.sgml \ - funct.sgml \ - fundclasses.sgml \ - instrc.sgml \ - intro.sgml \ - iostrms.sgml \ - mig.sgml \ - numarit.sgml \ - oneof.sgml \ - parsingch.sgml \ - preface.sgml \ - provide.sgml \ - resvkey.sgml \ - rexutil.sgml \ - rexxref.sgml \ - secman.sgml \ - spvard.sgml \ - usepcom.sgml \ - wsheng.sgml \ - xconcur.sgml \ - xintdeb.sgml \ - collectionclassmethods.sgml \ - mapcollectionclassmethods.sgml \ - orderedcollectionclassmethods.sgml \ - ../shared/legalstuff.sgml \ - ../shared/notices.sgml \ - ../shared/gethelp.sgml \ - ../shared/CPLv1.0.sgml +IMAGE_FILES = docbook-1.png \ + oorexx.jpg -IMAGE_FILES = ooRexxObjectClass.png \ - ooRexxClassClass.png \ - ooRexxMethodClass.png \ - ooRexxMessageClass.png \ - ooRexxStringClass.png \ - ooRexxArrayClass.png \ - ooRexxCollectionsClass.png \ - ooRexxOrderedCollectionClass.png \ - ooRexxCircularQueueClass.png \ - ooRexxListClass.png \ - ooRexxQueueClass.png \ - ooRexxDirectoryClass.png \ - ooRexxPropertiesClass.png \ - ooRexxStemClass.png \ - ooRexxMapCollectionClass.png \ - ooRexxRelationClass.png \ - ooRexxTableClass.png \ - ooRexxSetCollectionClass.png \ - ooRexxSetClass.png \ - ooRexxBagClass.png \ - ooRexxStreamClass.png \ - ooRexxInputStreamClass.png \ - ooRexxInputOutputStreamClass.png \ - ooRexxOutputStreamClass.png \ - ooRexxComparableClass.png \ - ooRexxAlarmClass.png \ - ooRexxMonitorClass.png \ - ooRexxMutableBufferClass.png \ - ooRexxRegularExpressionClass.png \ - ooRexxSupplierClass.png \ - ooRexxComparatorClass.png \ - ooRexxCaselessColumnComparatorClass.png \ - ooRexxColumnComparatorClass.png \ - ooRexxCaselessComparatorClass.png \ - ooRexxCaselessDescendingComparatorClass.png \ - ooRexxDescendingComparatorClass.png \ - ooRexxInvertingComparatorClass.png \ - ooRexxIteratorClass.png \ - ooRexxCircularIteratorClass.png \ - ooRexxStreamSupplierClass.png \ - ooRexxRexxQueueClass.png \ - ooRexxDateTimeClass.png \ - ooRexxTimeSpanClass.png \ - ooRexxClasses1.png \ - ooRexxClasses2.png \ - ooRexxClasses3.png \ - ooRexxClasses4.png \ - ooRexxClasses5.png \ - ooRexxClasses6.png \ - ooRexxClasses7.png \ - doloopconcept.png \ - doloopcollection.png \ - parseconcepts1.png \ - parseconcepts2.png \ - parseconcepts3.png \ - filerecord.png \ - templates1.png \ - templates2.png \ - templates3.png \ - ReportObject.png \ - BallObject.png \ - BallObjectData.png \ - EncapsulatedObject.png \ - SimpleClass.png \ - IconClass.png \ - IconClassInstances.png \ - Subclasses.png \ - ScreenObject.png \ - MultipleInheritance.png \ - Modules.png \ - MultipleRequires.png \ - EarlyReply.png \ - BeforeReply.png \ - AfterReply.png \ - IndirectRecursion.png \ - externalFunction.png \ - externalFileSearch.png \ - oorexx.jpg \ - docbook-1.png \ - new_rexxla.jpg - JADETEXFMT = ./pdfjadetex.fmt HYPERREFCFG = ./hyperref.cfg TEXMF = /usr/share/texmf export TEXFORMATS=.: - all: pdf html -pdf: rexxref.pdf +pdf: winextensions.pdf -html: rexxref-html.zip +html: winextensions-html.zip -rexxref.pdf: $(IMAGE_FILES) $(STYLESHEET) $(JADETEXFMT) genindex.sgml svnrev.tmp - docbook2pdf -d ../shared/oorexx.print.dsl rexxref.sgml +winextensions.pdf: $(IMAGE_FILES) $(STYLESHEET) $(JADETEXFMT) genindex.sgml svnrev.tmp + docbook2pdf -d ../shared/oorexx.print.dsl winextensions.sgml book1.htm: $(IMAGE_FILES) $(HTML_STYLESHEET) genindex.sgml svnrev.tmp - docbook2html -d ../shared/oorexx.html.dsl rexxref.sgml + docbook2html -d ../shared/oorexx.html.dsl winextensions.sgml -rexxref-html.zip: book1.htm - zip rexxref-html *.htm *.jpg +winextensions-html.zip: book1.htm + zip winextensions-html *.htm *.jpg $(JADETEXFMT): $(HYPERREFCFG) pdftex -ini \&pdflatex pdfjadetex.ini genindex.sgml: $(HTML_STYLESHEET) $(SGML_FILES) svnrev.tmp collateindex.pl -N -o genindex.sgml - jade -t sgml -d ../shared/oorexx.html.dsl -V html-index rexxref.sgml + jade -t sgml -d ../shared/oorexx.html.dsl -V html-index winextensions.sgml rm *.htm collateindex.pl -p -g -o genindex.sgml HTML.index @@ -200,9 +91,6 @@ svnversion > svnrev.tmp - - clean: - rm *.log *.aux *.out *.fmt *.pdf genindex.sgml *.htm *.zip \ - HTML.index *.tmp + rm -f *.log *.aux *.out *.fmt *.pdf genindex.sgml *.htm *.zip HTML.index *.tmp Copied: docs/trunk/winextensions/docbook-1.png (from rev 4115, docs/trunk/rexxref/docbook-1.png) =================================================================== (Binary files differ) Copied: docs/trunk/winextensions/hyperref.cfg (from rev 4115, docs/trunk/rexxref/hyperref.cfg) =================================================================== --- docs/trunk/winextensions/hyperref.cfg (rev 0) +++ docs/trunk/winextensions/hyperref.cfg 2009-02-10 05:14:03 UTC (rev 4118) @@ -0,0 +1,8 @@ +\PassOptionsToPackage{pdftitle={Open Object Rexx: Reference}}{hyperref} +\PassOptionsToPackage{pdfauthor={Rexx Language Association}}{hyperref} +\PassOptionsToPackage{pdfsubject={ooRexx Reference}}{hyperref} +\PassOptionsToPackage{pdfkeywords={ooRexx, Classes, Reference, Functions}}{hyperref} +\PassOptionsToPackage{linkcolor=blue}{hyperref} +\PassOptionsToPackage{citecolor=blue}{hyperref} +\PassOptionsToPackage{urlcolor=blue}{hyperref} +\PassOptionsToPackage{anchorcolor=blue}{hyperref} Copied: docs/trunk/winextensions/oorexx.jpg (from rev 4115, docs/trunk/rexxref/oorexx.jpg) =================================================================== (Binary files differ) Modified: docs/trunk/winextensions/preface.sgml =================================================================== --- docs/trunk/winextensions/preface.sgml 2009-02-10 03:19:40 UTC (rev 4117) +++ docs/trunk/winextensions/preface.sgml 2009-02-10 05:14:03 UTC (rev 4118) @@ -1,8 +1,8 @@ <!--######################################################################### # - # Description: Open Object Rexx: Reference SGML file. + # Description: Open Object Rexx: Windows Extensions Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under @@ -42,23 +42,35 @@ ######################################################################### --> <preface id="preface"><title>About This Book</title> -<para>This book describes the Open Object Rexx Interpreter, called the -<emphasis role="italic">interpreter</emphasis> or -<emphasis role="italic">language processor</emphasis> in the -following, and the object-oriented Rexx language.</para> -<para>This book is intended for people who plan to develop applications using -Rexx. Its users range from the novice, who might have experience in some -programming language but no Rexx experience, to the experienced application -developer, who might have had some experience with Object Rexx.</para> -<para>This book is a reference rather than a tutorial. It assumes you are -already familiar with object-oriented programming concepts.</para> -<para>Descriptions include the use and syntax of the language and explain how -the language processor "interprets" the language as a program is -running.</para> +<para> + This book describes extensions to the Open Object Rexx Interpreter that are specific to the Windows + operating system. The extensions described in this book are currently only available on Windows. Each + of the extensions is implemented as a class. Some of the classes, such as the <link + linkend="clsWinEventLog">WindowsEventLog</link> and the <link + linkend="clsWinRegistry">WindowsRegistry</link> classes, by their nature, can only be Windows specific. + Some of the other classes, such as the <link linkend="clsWinMenuObject">MenuObject</link> or <link + linkend="clsWinObject">WindowObject</link> classes could certainly be + enhanced to be cross-platform. However, at this time there are no plans to do + so. +</para> +<para> + This book is intended for people who plan to develop applications using ooRexx and one or more of the + Windows specific classes. In general no special knowledge of Windows programming is needed to use the + Windows extensions. Therefore this book is applicable for users ranging in experience from the novice + ooRexx programmer, to the experienced application developer. +</para> +<para> + This book is a reference rather than a tutorial. It assumes you are already familiar with + object-oriented programming concepts. +</para> +<para> + This book covers the use and syntax of the Windows specific classes and their methods. Many of the + descriptions of class methods also include example code snippets. +</para> <section id="relinf"><title>Related Information</title> <para>See also: -<citetitle pubwork="book">Open Object Rexx: Programming Guide</citetitle></para> +<citetitle pubwork="book">Open Object Rexx: Reference</citetitle></para> </section> <section id="readsy"><title>How to Read the Syntax Diagrams</title> Modified: docs/trunk/winextensions/winclasses.sgml =================================================================== --- docs/trunk/winextensions/winclasses.sgml 2009-02-10 03:19:40 UTC (rev 4117) +++ docs/trunk/winextensions/winclasses.sgml 2009-02-10 05:14:03 UTC (rev 4118) @@ -41,7 +41,7 @@ # ######################################################################### --> -<section id="winclasses"><title>The Windows Specific Classes</title> +<chapter id="winclasses"><title>The Windows Specific Classes</title> <para>This section describes the Windows-specific classes supplied with ooRexx.</para> @@ -700,7 +700,7 @@ Instantiates a new OLEObject as a proxy for a COM / OLE object with the specified <emphasis role="italic">classID</emphasis> (the <computeroutput>ProgID</computeroutput> or <computeroutput>CLSID</computeroutput>). If the COM / OLE object can not be accessed or created, an - error will be raised. See the list of <link linkend="ERR92">OLE specific errors</link>. + error will be raised. See the list of OLE specific errors in the Open Object Rexx Reference document. </para> <variablelist> <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> @@ -1499,7 +1499,7 @@ </para> <para> For further information on the details on how an <computeroutput>unknown</computeroutput> method works, - see <link linkend="unkno">Defining an unknown Method</link>. + see <emphasis role="italic">Defining an unknown Method</emphasis> in the Open Object Rexx Reference. </para> <para> The programmer can invoke the methods of the real OLE object by simply invoking the methods on the @@ -1511,7 +1511,7 @@ <para> This calls the method <computeroutput>"OLEMethodName"</computeroutput> of the real OLE object for any message (method) <emphasis role="italic">that does not exist</emphasis> in the Rexx OLEObject object - through the <link linkend="unkno">unknown</link> method mechanism. The implementation for the + through the <emphasis role="italic">unknown</emphasis> method mechanism. The implementation for the <computeroutput>unknown</computeroutput>() method in the OLEObject class does this by dispatching the method call to the real OLE object. </para> @@ -1522,8 +1522,8 @@ <para> One choice is for the programmer to call the <computeroutput>unknown</computeroutput> method directly. E.g., take an OLE object that has the method <computeroutput>copy</computeroutput> used to copy - something from a source to a destination. Since <link linkend="mthObjectCopy">copy</link> is a method - of the <link linkend="clsObject">Object</link> class, the copy method of the OLE object is a method + something from a source to a destination. Since <computeroutput>copy</computeroutput> is a method + of the <computeroutput>Object</computeroutput> class, the copy method of the OLE object is a method name already defined for the OLEObject. The programmer can invoke the <computeroutput>unknown</computeroutput> method directly, like this: </para> @@ -5538,5 +5538,5 @@ </section> </section> -</section> +</chapter> Modified: docs/trunk/winextensions/winextensions.sgml =================================================================== --- docs/trunk/winextensions/winextensions.sgml 2009-02-10 03:19:40 UTC (rev 4117) +++ docs/trunk/winextensions/winextensions.sgml 2009-02-10 05:14:03 UTC (rev 4118) @@ -3,50 +3,19 @@ [ <!ENTITY legalstuff SYSTEM "../shared/legalstuff.sgml"> <!ENTITY preface SYSTEM "preface.sgml"> -<!ENTITY intro SYSTEM "intro.sgml"> -<!ENTITY instrc SYSTEM "instrc.sgml"> -<!ENTITY dire SYSTEM "dire.sgml"> -<!ENTITY provide SYSTEM "provide.sgml"> -<!ENTITY classes SYSTEM "classes.sgml"> -<!ENTITY fundclasses SYSTEM "fundclasses.sgml"> -<!ENTITY strmclasses SYSTEM "streamclasses.sgml"> -<!ENTITY collclasses SYSTEM "collclasses.sgml"> -<!ENTITY utilityclasses SYSTEM "utilityclasses.sgml"> <!ENTITY winclasses SYSTEM "winclasses.sgml"> -<!ENTITY xothcla SYSTEM "xothcla.sgml"> -<!ENTITY oneof SYSTEM "oneof.sgml"> -<!ENTITY funct SYSTEM "funct.sgml"> -<!ENTITY rexutil SYSTEM "rexutil.sgml"> -<!ENTITY parsingch SYSTEM "parsingch.sgml"> -<!ENTITY numarit SYSTEM "numarit.sgml"> -<!ENTITY condtra SYSTEM "condtra.sgml"> -<!ENTITY xconcur SYSTEM "xconcur.sgml"> -<!ENTITY secman SYSTEM "secman.sgml"> -<!ENTITY iostrms SYSTEM "iostrms.sgml"> -<!ENTITY xintdeb SYSTEM "xintdeb.sgml"> -<!ENTITY resvkey SYSTEM "resvkey.sgml"> -<!ENTITY spvard SYSTEM "spvard.sgml"> -<!ENTITY usepcom SYSTEM "usepcom.sgml"> <!ENTITY wsheng SYSTEM "wsheng.sgml"> -<!ENTITY dokey SYSTEM "dokey.sgml"> -<!ENTITY mig SYSTEM "mig.sgml"> -<!ENTITY errnum SYSTEM "errnum.sgml"> -<!ENTITY errnums SYSTEM "errnums.sgml"> <!ENTITY notices SYSTEM "../shared/notices.sgml"> <!ENTITY cpl SYSTEM "../shared/CPLv1.0.sgml"> <!ENTITY gethelp SYSTEM "../shared/gethelp.sgml"> <!ENTITY genindex SYSTEM "genindex.sgml"> -<!ENTITY objclsmthods SYSTEM "objectclassmethods.sgml"> -<!ENTITY collclsmthods SYSTEM "collectionclassmethods.sgml"> -<!ENTITY ocollclsmthods SYSTEM "orderedcollectionclassmethods.sgml"> -<!ENTITY mcollclsmthods SYSTEM "mapcollectionclassmethods.sgml"> <!ENTITY svnrev SYSTEM "svnrev.tmp"> ]> <!--######################################################################### # - # Description: Open Object Rexx: Reference SGML file. + # Description: Open Object Rexx: Windows Extensions SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under @@ -88,41 +57,21 @@ <book> <bookinfo> <title>Open Object Rexx™</title> -<subtitle>Reference</subtitle> -<titleabbrev>ooRexx Reference</titleabbrev> +<subtitle>Windows Extensions Reference</subtitle> +<titleabbrev>Win Extensions Reference</titleabbrev> &legalstuff; </bookinfo> -&preface; <!-- About This Book --> +&preface; <!-- About This Book --> <!-- start of body --> -&intro; <!-- Rexx General Concepts --> -&instrc; <!-- Keyword Instructions --> -&dire; <!-- Directives --> -&provide; <!-- Objects and Classes --> -&classes; <!-- The Builtin Classes --> -&oneof; <!-- Other Objects --> -&funct; <!-- Functions --> -&rexutil; <!-- Rexx Utilities (RexxUtil) --> -&parsingch; <!-- Parsing --> -&numarit; <!-- Numbers and Arithmetic --> -&condtra; <!-- Conditions and Condition Traps --> -&xconcur; <!-- Concurrency --> -&secman; <!-- The Security Manager --> -&iostrms; <!-- Input and Output Streams --> -&xintdeb; <!-- Debugging Aids --> -&resvkey; <!-- Reserved Keywords --> -&spvard; <!-- Special Variables --> -&usepcom; <!-- Useful Services --> -&wsheng; <!-- Windows Scripting Host Engine --> +&winclasses; <!-- Rexx General Concepts --> +&wsheng; <!-- Windows Scripting Host Engine --> <!-- start of appendix --> -&dokey; <!-- Using the DO Keyword --> -&mig; <!-- Migration --> -&errnum; <!-- Error Numbers and Messages --> -¬ices; <!-- Notices --> -&cpl; <!-- CPL --> +¬ices; <!-- Notices --> +&cpl; <!-- CPL --> <!-- start of index --> -&genindex; <!-- Index --> +&genindex; <!-- Index --> </book> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-14 16:02:23
|
Revision: 4148 http://oorexx.svn.sourceforge.net/oorexx/?rev=4148&view=rev Author: bigrixx Date: 2009-02-14 16:02:18 +0000 (Sat, 14 Feb 2009) Log Message: ----------- editorial updates Modified Paths: -------------- docs/trunk/oodialog/advcntlc.sgml docs/trunk/oodialog/basedialog.sgml docs/trunk/oodialog/buttoncontrols.sgml docs/trunk/oodialog/dialogcontrolc.sgml docs/trunk/oodialog/standarddialog.sgml docs/trunk/rexxpg/api.sgml docs/trunk/rexxpg/classes.sgml docs/trunk/rexxref/classes.sgml docs/trunk/rexxref/collclasses.sgml docs/trunk/rexxref/condtra.sgml docs/trunk/rexxref/funct.sgml docs/trunk/rexxref/fundclasses.sgml docs/trunk/rexxref/oneof.sgml docs/trunk/rexxref/provide.sgml docs/trunk/rexxref/rexutil.sgml docs/trunk/rexxref/streamclasses.sgml docs/trunk/rexxref/utilityclasses.sgml docs/trunk/rxsock/socketclass.sgml Modified: docs/trunk/oodialog/advcntlc.sgml =================================================================== --- docs/trunk/oodialog/advcntlc.sgml 2009-02-14 13:30:07 UTC (rev 4147) +++ docs/trunk/oodialog/advcntlc.sgml 2009-02-14 16:02:18 UTC (rev 4148) @@ -229,7 +229,7 @@ <note><title>Note</title><para> GetStaticControl connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -286,7 +286,7 @@ <note><title>Note</title><para> GetEditControl connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -342,7 +342,7 @@ <note><title>Note</title><para> GetButtonControl connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -399,7 +399,7 @@ <note><title>Note</title><para> GetRadioControl connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -455,7 +455,7 @@ <note><title>Note</title><para> GetCheckControl connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -582,7 +582,7 @@ <note><title>Note</title><para> GetListBox connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -657,7 +657,7 @@ <note><title>Note</title><para> GetComboBox connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -714,7 +714,7 @@ <note><title>Note</title><para> GetScrollBar connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -778,7 +778,7 @@ <note><title>Note</title><para> GetTreeControl connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -835,7 +835,7 @@ <note><title>Note</title><para> GetListControl connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -897,7 +897,7 @@ <note><title>Note</title><para> getProgressBar connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -960,7 +960,7 @@ <note><title>Note</title><para> GetSliderControl connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> @@ -1014,7 +1014,7 @@ <note><title>Note</title><para> GetTabControl connects an Object Rexx object with a Windows object. -If the object does not exist, the NIL object is returned. Therefore, this +If the object does not exist, the Nil object is returned. Therefore, this method can only be applied after the Windows dialog has been created (after the invocation of <link linkend="h002048">StartIt</link>). </para></note> Modified: docs/trunk/oodialog/basedialog.sgml =================================================================== --- docs/trunk/oodialog/basedialog.sgml 2009-02-14 13:30:07 UTC (rev 4147) +++ docs/trunk/oodialog/basedialog.sgml 2009-02-14 16:02:18 UTC (rev 4148) @@ -2404,7 +2404,7 @@ <indexterm><primary>connect event methods</primary> <secondary>BaseDialog class</secondary></indexterm> <para>The following methods create a connection between an event of the Windows -dialog, or a dialog control, and a method of the ooRexx dialog object. In the +dialog, or a dialog control, and a method of the Rexx dialog object. In the Windows user interface, as the user interacts with the system, events are generated that specify what the action of the user was. Mouse clicks, keyboard presses, moving or sizing windows, all generate events. In the ooDialog @@ -8238,7 +8238,7 @@ <listitem><para><link linkend="h000025">Init</link>: This program uses a header file, <computeroutput>fileView.h</computeroutput> to define symbolic IDs for the dialog controls. The name of the file is one of the arguments used to create a -new instance of a dialog object. (As in all ooRexx classes, the arguments used +new instance of a dialog object. (As in all Rexx classes, the arguments used in <computeroutput>new</computeroutput> are passed on to the <computeroutput> init</computeroutput> method of the class.) </para></listitem> Modified: docs/trunk/oodialog/buttoncontrols.sgml =================================================================== --- docs/trunk/oodialog/buttoncontrols.sgml 2009-02-14 13:30:07 UTC (rev 4147) +++ docs/trunk/oodialog/buttoncontrols.sgml 2009-02-14 16:02:18 UTC (rev 4148) @@ -119,7 +119,7 @@ </para> <para> The ButtonControl class provides methods to query and modify push button controls. In addition, the - class has methods that allow the ooRexx programmer to partially implement owner drawn buttons using + class has methods that allow the Rexx programmer to partially implement owner drawn buttons using bitmaps. </para> <variablelist> @@ -298,7 +298,7 @@ </programlisting> <para> - The push method simulates the user pushing the associated button control. It allows an ooRexx + The push method simulates the user pushing the associated button control. It allows a Rexx programmer to produce the exact same behavior from within an ooDialog program as the behavior produced by the user pushing the button in the dialog. </para> @@ -987,7 +987,7 @@ <varlistentry><term>The <computeroutput>.nil</computeroutput> object</term> <listitem> <para> - The .nil object is returned if the button does not have an image list, or for some other + The Nil object is returned if the button does not have an image list, or for some other unanticipated error. </para> </listitem></varlistentry> @@ -1112,7 +1112,7 @@ <listitem> <para> A <link linkend="clsImageList">.ImageList</link> object containing the images for the button. - If this argument is the .nil object, then any existing image list is removed. + If this argument is the Nil object, then any existing image list is removed. </para> </listitem></varlistentry> <varlistentry><term>margin</term> @@ -1159,7 +1159,7 @@ <varlistentry><term>.nil</term> <listitem> <para> - The .nil object is returned if there was no existing image list, and also if an error is + The Nil object is returned if there was no existing image list, and also if an error is encountered. In general, the .SystemErrorCode variable should be set to non-zero if an error happend. </para> Modified: docs/trunk/oodialog/dialogcontrolc.sgml =================================================================== --- docs/trunk/oodialog/dialogcontrolc.sgml 2009-02-14 13:30:07 UTC (rev 4147) +++ docs/trunk/oodialog/dialogcontrolc.sgml 2009-02-14 16:02:18 UTC (rev 4148) @@ -93,7 +93,7 @@ </para></listitem></varlistentry> <varlistentry><term>SizeX</term> <listitem><para>The width of the dialog control, in dialog units, when the -ooRexx object that represents the control is created.</para> +Rexx object that represents the control is created.</para> <para><emphasis role="bold">Note: </emphasis> The <computeroutput>SizeX</computeroutput> attribute is not changed by ooDialog after the object is instantiated. If the programmer resizes the dialog control @@ -102,7 +102,7 @@ </para></listitem></varlistentry> <varlistentry><term>SizeY</term> <listitem><para>The height of the dialog control, in dialog units, when the -ooRexx object that represents the control is created.</para> +Rexx object that represents the control is created.</para> <para><emphasis role="bold">Note: </emphasis> The <computeroutput>SizeY</computeroutput> attribute is not changed by ooDialog after the object is instantiated. If the programmer resizes the dialog control @@ -1899,7 +1899,7 @@ <variablelist> <varlistentry><term><emphasis role="bold">Note Well:</emphasis></term> <listitem><para>The <computeroutput>AssignWindow</computeroutput> method is used -internally to connect ooRexx objects (a <computeroutput>DialogControl +internally to connect Rexx objects (a <computeroutput>DialogControl </computeroutput> object) to the underlying Windows dialog control. It is not recommended that the programmer use this method unless he throughly understands the ooDialog framework. Otherwise, using this method has the potential for Modified: docs/trunk/oodialog/standarddialog.sgml =================================================================== --- docs/trunk/oodialog/standarddialog.sgml 2009-02-14 13:30:07 UTC (rev 4147) +++ docs/trunk/oodialog/standarddialog.sgml 2009-02-14 16:02:18 UTC (rev 4148) @@ -45,9 +45,9 @@ <indexterm><primary>Standard Dialogs, Public Routines</primary></indexterm> <para> The ooDialog framework provides a number of easy to use standard dialogs and public routines that allow - programmers to include simple graphical elements in their ooRexx applications. A few of the functions, + programmers to include simple graphical elements in their Rexx applications. A few of the functions, like <link linkend="rtnMSSleep">MSSleep</link> expose functionality that can be useful in any type of - ooRexx application. The public routines can be called with a single line of code and the standard + Rexx application. The public routines can be called with a single line of code and the standard dialogs can usually be executed with only two lines of code. This does not require the programmer to do much set up and makes them simple to work with. </para> @@ -1017,7 +1017,7 @@ <section id="sctPublicRoutines"><title>Public Routines</title> <indexterm><primary>ooDialog public routines</primary></indexterm> -<para>The routines listed in this section can be used in any ooRexx +<para>The routines listed in this section can be used in any Rexx program. They are designed to be even easier to use than the standard dialogs or the external functions. They do not require that an ooDialog dialog be initialized prior to their use, or that any ooDialog dialog be used in the @@ -1027,7 +1027,7 @@ <variablelist> <varlistentry><term><emphasis role="bold">Requires:</emphasis></term> <listitem><para>Use a requires directive for the <computeroutput> -ooDialog.cls</computeroutput> file in an ooRexx program to use any of these +ooDialog.cls</computeroutput> file in an Rexx program to use any of these routines. <programlisting> <![CDATA[ ::requires ooDialog.cls ]]> @@ -1314,7 +1314,7 @@ </para></listitem></varlistentry> <varlistentry><term><emphasis role="bold">Notes:</emphasis></term> <listitem><para>If the user changes directory with the File Open or File Save -dialog, then the current directory of the ooRexx program will be changed. This +dialog, then the current directory of the Rexx program will be changed. This is the behavior of the underlying Windows dialog, which is designed to work that way. The ooDialog programmer should be aware of this behavior and insert code to change the directory back if that is needed. For example: Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-02-14 13:30:07 UTC (rev 4147) +++ docs/trunk/rexxpg/api.sgml 2009-02-14 16:02:18 UTC (rev 4148) @@ -53,7 +53,7 @@ for Rexx methods, external functions, and system exits. </para> <variablelist> <varlistentry><term>Rexx methods</term> -<listitem><para>are extensions to ooRexx classes. An ooRexx class can define a +<listitem><para>are extensions to Rexx classes. A Rexx class can define a method as being contained in an external shared library. </para></listitem></varlistentry> <varlistentry><term>Functions</term> @@ -7398,12 +7398,12 @@ >>--obj = context->Nil();------------------------------------------------>< ]]> </programlisting> -<para>Returns the Rexx .nil object. +<para>Returns the Rexx Nil object. </para> <para><emphasis role="bold">Arguments</emphasis></para> <para>None.</para> <para><emphasis role="bold">Returns</emphasis></para> -<para>The Rexx .nil object.</para> +<para>The Rexx Nil object.</para> </section> <section id="mthNullString"><title>NullString</title> Modified: docs/trunk/rexxpg/classes.sgml =================================================================== --- docs/trunk/rexxpg/classes.sgml 2009-02-14 13:30:07 UTC (rev 4147) +++ docs/trunk/rexxpg/classes.sgml 2009-02-14 16:02:18 UTC (rev 4148) @@ -571,13 +571,13 @@ an environment symbol, and refers to the Savings class. The classes you create can be referenced with an environment symbol. There is an environment symbol for each Rexx-defined class, as well as for each of the unique objects -this section describes, such as the NIL object.</para> +this section describes, such as the Nil object.</para> <section id="nilobject"><title>The NIL Object (.nil)</title> <indexterm><primary>symbols</primary> <secondary>.nil symbol</secondary></indexterm> -<indexterm><primary>.NIL object</primary></indexterm> -<para>The NIL object is +<indexterm><primary>.Nil object</primary></indexterm> +<para>The Nil object is a special environment object that does not contain any data. It represents the absence of an object, the way a null string represents a string with no characters. Its only methods are those of the Object class. You use the NIL Modified: docs/trunk/rexxref/classes.sgml =================================================================== --- docs/trunk/rexxref/classes.sgml 2009-02-14 13:30:07 UTC (rev 4147) +++ docs/trunk/rexxref/classes.sgml 2009-02-14 16:02:18 UTC (rev 4148) @@ -42,7 +42,7 @@ ######################################################################### --> <chapter id="classes"><title>The Builtin Classes</title> -<para>This chapter describes all of the builtin classes supplied with ooRexx.</para> +<para>This chapter describes all of the Rexx built-in classes.</para> <variablelist> <varlistentry><term> Modified: docs/trunk/rexxref/collclasses.sgml =================================================================== --- docs/trunk/rexxref/collclasses.sgml 2009-02-14 13:30:07 UTC (rev 4147) +++ docs/trunk/rexxref/collclasses.sgml 2009-02-14 16:02:18 UTC (rev 4148) @@ -1244,7 +1244,7 @@ ]]> </programlisting> -<para>Returns the index of the last item in the array or the NIL object if the +<para>Returns the index of the last item in the array or the Nil object if the array is empty. For multi-dimension arrays, index is returned as an array of index items. </para> @@ -1689,7 +1689,7 @@ directions=.array~of("North","South", ,"West") do i=1 to 4 /* Produces: North */ say directions[i] /* South */ - /* The NIL object */ + /* The Nil object */ end /* West */ </programlisting> @@ -1837,7 +1837,8 @@ <para>Returns <computeroutput>1</computeroutput> (true) if the collection contains any item associated with index <emphasis role="italic">index</emphasis>, -or <computeroutput>0</computeroutput> (false). Index equality is determined by +or <computeroutput>0</computeroutput> (false). +Index equality is determined by using the == method of <emphasis role="italic">index</emphasis>. </para> </section> @@ -3660,7 +3661,7 @@ <para>Loads a set of properties from <emphasis role="italic">source</emphasis> and returns them as a new Properties object. The load source can be either the string name of a file or a stream object. Properties are read from the source as -individual lines using <emphasis role="bold">linein</emphasis>. Blank lines and lines with a Rexx line comment ("--") +individual lines using <link linkend="mthStreamLineIn">linein()</link>. Blank lines and lines with a Rexx line comment ("--") as the first non-blank characters are ignored. Otherwise, the lines are assumed to be of the form "name=value" and are added to the receiver Properties value using name as the index for the value. </para> @@ -3694,9 +3695,10 @@ ]]> </programlisting> -<para>This method is the same as the -<emphasis role="bold">put</emphasis> method. See -<link linkend="mthPropertiesPut">put</link>.</para> +<para>Adds <emphasis role="bold">item</emphasis> using the index +<emphasis role="bold">index</emphasis>. +This method is the same as the +<link linkend="mthPropertiesPut">put()</link> method.</para> </section> <section id="mthPropertiesGetLogical"><title>getLogical</title> @@ -3736,7 +3738,7 @@ <para>Returns the value of <emphasis role="italic">name</emphasis>. If property <emphasis role="italic">name</emphasis> does not exist and <emphasis role="italic">default</emphasis> has been specified, the default value will be returned. If <emphasis role="italic">default</emphasis> has not -been specified, .nil is returned for the property value.</para> +been specified, the Nil object is returned.</para> </section> <section id="mthPropertiesGetWhole"><title>getWhole</title> @@ -3772,7 +3774,7 @@ <para>Loads a set of properties into the receiving Properties object from <emphasis role="italic">source</emphasis>. The load source can be either the string name of a file or a stream object. Properties are read from the source as -individual lines using <emphasis role="bold">linein</emphasis>. Blank lines and lines with a Rexx line comment ("--") +individual lines using <link linkend="mthStreamLineIn">linein()</link>. Blank lines and lines with a Rexx line comment ("--") as the first non-blank characters are ignored. Otherwise, the lines are assumed to be of the form "name=value" and are added to the receiver Properties value using name as the index for the value. Properties loaded from <emphasis role="italic">source</emphasis> that have the @@ -3816,9 +3818,9 @@ <para>Saves a set of properties into <emphasis role="italic">target</emphasis>. The save target can be either the string name of a file or a stream object. Properties are stored as -individual lines using <emphasis role="bold">lineout</emphasis>. +individual lines using <link linkend="mthStreamLineOut">lineout()</link>. The lines are written in the form "name=value". A saved Properties file can be reloaded using the Properties -<emphasis role="bold">load</emphasis> method. +<link linkend="mthPropertiesLoad">load()</link> method. </para> </section> @@ -3852,7 +3854,7 @@ >>-setProperty(name,value)------------------------------------->< ]]> </programlisting> -<para>Sets a named property the property bundle. The <emphasis role="italic">value</emphasis> +<para>Sets a named property in the property bundle. The <emphasis role="italic">value</emphasis> argument must be a character string value.</para> </section> @@ -3897,7 +3899,7 @@ <para>The Queue class also has available class methods that its metaclass, the <link linkend="clsClass">Class class</link>, defines. It also inherits methods from the <link linkend="clsOrderedCollection">Ordered Collection -class</link>, although there are not currently any methods defined in that class. +class</link>. </para></note> <section><title>Inherited Methods</title> @@ -3953,10 +3955,9 @@ ]]> </programlisting> -<para>Returns the same value as the <emphasis role="bold">at</emphasis> method. See -<link linkend="mthQueueAt">at</link>.</para> -<para>The order in which the queue items appear in the array is the same as their -queuing order, with the head of the queue as index 1.</para> +<para>Returns the item located at index <emphasis role="italic">index</emphasis>. +This is the same as the +<link linkend="mthQueueAt">at()</link> method.</para> </section> <section id="mthQueuePutSet"><title>[]=</title> @@ -3971,8 +3972,10 @@ ]]> </programlisting> -<para>This method is the same as the <emphasis role="bold">put</emphasis> -method. See <link linkend="mthQueuePut">put</link>. +<para>Replaces item at <emphasis role="italic">index</emphasis> with +<emphasis role="italic">item</emphasis>. +This method is the same as the +<link linkend="mthQueuePut">put()</link> method. </para> </section> @@ -3988,7 +3991,7 @@ ]]> </programlisting> -<para>Returns an array of all element containing all the index values for the +<para>Returns an array of all index values for the queue. For the Queue class, the indices are integers 1 - <link linkend="mthQueueItems">items</link>.</para> </section> @@ -4005,7 +4008,7 @@ ]]> </programlisting> -<para>Returns an array of all items contained in the queue.</para> +<para>Returns an array of all items contained in the queue, in queue order.</para> </section> <section id="mthQueueAppend"><title>append</title> @@ -4020,7 +4023,8 @@ ]]> </programlisting> -<para>Appends <emphasis role="italic">item</emphasis> to the end of the queue.</para> +<para>Appends <emphasis role="italic">item</emphasis> to the end of the queue, +returning the index of the inserted item.</para> </section> <section id="mthQueueAt"><title>at</title> @@ -4036,8 +4040,8 @@ </programlisting> <para>Returns the item associated with index -<emphasis role="italic">index</emphasis>. If the collection has no item associated with -<emphasis role="italic">index</emphasis>, this method returns the Nil object.</para> +<emphasis role="italic">index</emphasis>. Returns the Nil object if the collection has no item associated with +<emphasis role="italic">index</emphasis>.</para> </section> <section id="mthQueueEmpty"><title>empty</title> @@ -4068,7 +4072,7 @@ </programlisting> <para>Returns the index of the first item in the queue or the Nil object if the -queue is empty.</para> +queue is empty. The index will always be 1 for non-empty queues.</para> </section> <section id="mthQueueHasIndex"><title>hasIndex</title> @@ -4083,7 +4087,7 @@ ]]> </programlisting> -<para>Returns <computeroutput>1</computeroutput> (true) if the collection +<para>Returns <computeroutput>1</computeroutput> (true) if the queue contains any item associated with index <emphasis role="italic">index</emphasis>, or <computeroutput>0</computeroutput> (false).</para> </section> @@ -4096,13 +4100,14 @@ <tertiary>of Queue class</tertiary></indexterm> <programlisting> <![CDATA[ ->>-hasItem(value)---------------------------------------------->< +>>-hasItem(item)---------------------------------------------->< ]]> </programlisting> -<para>Returns <computeroutput>1</computeroutput> (true) if the collection -contains the <emphasis role="italic">value</emphasis> at any index position or +<para>Returns <computeroutput>1</computeroutput> (true) if the queue +contains the <emphasis role="italic">item</emphasis> at any index position or otherwise returns <computeroutput>0</computeroutput> (false).</para> +Item equality is determined by using the == method of <emphasis role="italic">item</emphasis>. </section> <section id="mthQueueIndex"><title>index</title> @@ -4119,8 +4124,8 @@ <para>Returns the index of the specified item within the queue. If the target item appears at more than one index, the first located index will -be returned. If the queue does not contain the specified item, .nil is -returned. +be returned. Returns the Nil object if the queue does not contain the specified item. +Item equality is determined by using the == method of <emphasis role="italic">item</emphasis>. </para> </section> @@ -4137,22 +4142,20 @@ ]]> </programlisting> -<para>Returns a queue-supplied index for a new item -<emphasis role="italic">item</emphasis>, which is added to the queue. The new -item follows the existing item with index +<para>Returns a queue-supplied index for +<emphasis role="italic">item</emphasis>, which is added to the queue. The inserted +item follows any existing item with index <emphasis role="italic">index</emphasis> in the queue ordering. -If <emphasis role="italic">index</emphasis> is the Nil object, the new item -becomes the first item in the queue. If you omit -<emphasis role="italic">index</emphasis>, the new item becomes the last item in +If <emphasis role="italic">index</emphasis> is the Nil object, +<emphasis role="italic">item</emphasis> +is inserted at the head of the queue. If you omit +<emphasis role="italic">index</emphasis>, <emphasis role="italic">item</emphasis> +becomes the last item in the queue. </para> <para>Inserting an item in the queue at position <emphasis role="italic">index</emphasis> will cause the items in the queue after position <emphasis role="italic">index</emphasis> to have their indexes modified by the queue object.</para> -<note><para>The term <emphasis role="italic">index</emphasis> as used above does -not imply that the queue order is maintained via an array-like index. The indexes -referred to above are internal handles maintained by the interpreter and are not -available to the user.</para></note> <indexterm><primary>examples</primary> <secondary>insert method</secondary> <tertiary>of Queue class</tertiary></indexterm> @@ -4277,8 +4280,7 @@ ]]> </programlisting> -<para>Returns the item at the head of the queue. If the queue is empty then -the method returns the .Nil object. +<para>Returns the item at the head of the queue. Returns the Nil object if the queue is empty. The collection remains unchanged.</para> </section> @@ -4311,8 +4313,8 @@ ]]> </programlisting> -<para>Returns and removes the item at the head of the queue. If the queue is -empty then the method returns the .Nil object</para> +<para>Returns and removes the item at the head of the queue. +Returns the Nil object if the queue is empty.</para> </section> <section id="mthQueuePush"><title>push</title> @@ -4378,9 +4380,9 @@ </programlisting> <para>Returns and removes from a collection the member item with index -<emphasis role="italic">index</emphasis>. If no item has index -<emphasis role="italic">index</emphasis>, this method returns -the Nil object and removes no item.</para> +<emphasis role="italic">index</emphasis>. Returns the Nil object if no item has index +<emphasis role="italic">index</emphasis>. +</para> </section> <section id="mthQueueRemoveItem"><title>removeItem</title> @@ -4398,6 +4400,7 @@ <para>Removes an item from the queue. If the target item exists at more than one index, the first located item is removed. The return value is the removed item. +Item equality is determined by using the == method of <emphasis role="italic">item</emphasis>. </para> </section> @@ -4413,11 +4416,10 @@ ]]> </programlisting> -<para>Returns a supplier object for the collection. After you have obtained a -supplier, you can send it messages (see -<link linkend="clsSupplier">The Supplier Class</link>) to enumerate -all the items that were in the queue at the time of the supplier's creation. -The supplier enumerates the items in their queuing order, with the head of +<para>Returns a <link linkend="clsSupplier">Supplier</link>object for the queue. +The supplier allows you to iterate over the index/item pair contained in the queue +at the time the supplier was created. +The supplier iterates the items in their queuing order, with the head of the queue first.</para> </section> </section> @@ -4430,7 +4432,7 @@ <secondary>Relation class</secondary></indexterm> <para>A relation is a collection with indexes that can -be any objects the user supplies. In a relation, each item is associated with +be any object. In a relation, each item is associated with a single index, but there can be more than one item with the same index (unlike a table, which can contain only one item for any index).</para> <figure><title>The Relation class and methods</title> @@ -4445,7 +4447,7 @@ <para>The Relation class also has available class methods that its metaclass, the <link linkend="clsClass">Class class</link>, defines. It also inherits methods from the <link linkend="clsMapCollection">Map Collection -class</link>, although there are not currently any methods defined in that class. +class</link>. </para></note> <section><title>Inherited Methods</title> @@ -4483,9 +4485,9 @@ ]]> </programlisting> -<para>Returns the same item as the -<emphasis role="bold">at</emphasis> method. See -<link linkend="mthRelationAt">at</link>.</para> +<para>Returns an item associated with <emphasis role="italic">index</emphasis>. +Thie is the same as the +<link linkend="mthRelationAt">at()</link> method.</para> </section> <section id="mthRelationPutSet"><title>[]=</title> @@ -4500,9 +4502,9 @@ ]]> </programlisting> -<para>This method is the same as the -<emphasis role="bold">put</emphasis> method. See -<link linkend="mthRelationPut">put</link>.</para> +<para>Adds <emphasis role="italic">item</link> to the relation associated with index +<emphasis role="italic">index</link>. This is the same as the +<link linkend="mthRelationPut">put()</link> method.</para> </section> <section id="mthRelationAllAt"><title>allAt</title> @@ -4518,9 +4520,11 @@ </programlisting> <para>Returns a single-index array containing all the items associated with -index <emphasis role="italic">index</emphasis>. The indexes of the returned -array range from <computeroutput>1</computeroutput> to the -number of items. Items in the array appear in an unspecified order.</para> +index <emphasis role="italic">index</emphasis>. +Items in the array appear in an unspecified order. +Index equality is determined by +using the == method of <emphasis role="italic">index</emphasis>. +</para> </section> <section id="mthRelationAllIndex"><title>allIndex</title> @@ -4537,7 +4541,10 @@ <para>Returns a single-index array containing all indexes for item <emphasis role="italic">item</emphasis>, -in an unspecified order (the program should not rely on any order).</para> +in an unspecified order. +Item equality is determined by +using the == method of <emphasis role="italic">item</emphasis>. +</para> </section> <section id="mthRelationAllIndexes"><title>allIndexes</title> @@ -4595,8 +4602,11 @@ contains more than one item associated with index <emphasis role="italic">index</emphasis>, the item returned is unspecified. (The program should not rely on any particular item -being returned.) If the relation has no item associated with index -<emphasis role="italic">index</emphasis>, this method returns the Nil object.</para> +being returned.) Returns the Nil object if the relation has no item associated with index +<emphasis role="italic">index</emphasis>. +Index equality is determined by +using the == method of <emphasis role="italic">index</emphasis>. +</para> </section> <section id="mthRelationDifference"><title>difference</title> @@ -4611,7 +4621,7 @@ ]]> </programlisting> -<para>Returns a new collection (of the same class as the receiver) containing +<para>Returns a new Relation containing only those items that the <emphasis role="italic">argument</emphasis> collection does not contain (with the same associated index). The <emphasis role="italic">argument</emphasis> can be any @@ -4648,7 +4658,10 @@ <para>Returns <computeroutput>1</computeroutput> (true) if the collection contains any item associated with index <emphasis role="italic">index</emphasis>, or <computeroutput>0</computeroutput> -(false).</para> +(false). +Index equality is determined by +using the == method of <emphasis role="italic">index</emphasis>. +</para> </section> <section id="mthRelationHasItem"><title>hasItem</title> @@ -4667,10 +4680,11 @@ <para>Returns <computeroutput>1</computeroutput> (true) if the relation contains the member item <emphasis role="italic">item</emphasis>, <computeroutput>0</computeroutput> (false). -If is specified, hasIndex +If <emphasis role="italic">index</emphasis> is specified, hasIndex() will only return true if the relation contains the pairing of <emphasis role="italic">item</emphasis> associated with index <emphasis role="italic">index</emphasis>. +Item and index equality is determined by using the == method. </para> </section> @@ -4688,8 +4702,11 @@ <para>Returns the index for item <emphasis role="italic">item</emphasis>. If there is more than one index associated with item -<emphasis role="italic">item</emphasis>, the one this method returns is not -defined.</para> +<emphasis role="italic">item</emphasis>, the one returned is not +defined. +Item equality is determined by +using the == method of <emphasis role="italic">item</emphasis>. +</para> </section> <section id="mthRelationIntersection"><title>intersection</title> @@ -4744,7 +4761,10 @@ <para>Returns the number of relation items with index <emphasis role="italic">index</emphasis>. If you specify no <emphasis role="italic">index</emphasis>, this method returns the -total number of items associated with all indexes in the relation.</para> +total number of items associated with all indexes in the relation. +Index equality is determined by +using the == method of <emphasis role="italic">index</emphasis>. +</para> </section> <section id="mthRelationMakeArray"><title>makeArray</title> @@ -4759,10 +4779,9 @@ ]]> </programlisting> -<para>Returns a single-index array containing the index objects. The array -indexes range from <computeroutput>1</computeroutput> to the number of items. -The collection items appear in the array in an unspecified order. (The program -should not rely on any order.)</para> +<para>Returns a single-index array containing the index objects. +The collection items appear in the array in an unspecified order. +</para> </section> <section id="mthRelationPut"><title>put</title> @@ -4801,9 +4820,11 @@ <para>Returns and removes from a relation the member item with index <emphasis role="italic">index</emphasis>. If the relation contains more than one item associated with index <emphasis role="italic">index</emphasis>, -the item returned and removed is unspecified. If no item has index -<emphasis role="italic">index</emphasis>, this method returns the NIL object -and removes nothing.</para> +the item returned and removed is unspecified. Returns the Nil object if no item has index +<emphasis role="italic">index</emphasis>. +Index equality is determined by +using the == method of <emphasis role="italic">index</emphasis>. +</para> </section> <section id="mthRelationRemoveItem"><title>removeItem</title> @@ -4820,10 +4841,10 @@ <para>Returns and removes from a relation the member item <emphasis role="italic">item</emphasis> (associated with index -<emphasis role="italic">index</emphasis>). If +<emphasis role="italic">index</emphasis>). Returns the Nil object if <emphasis role="italic">value</emphasis> is not a member item associated -with index <emphasis role="italic">index</emphasis>, this method returns -the Nil object and removes no item. If +with index <emphasis role="italic">index</emphasis>. +If <emphasis role="italic">item</emphasis> is the only member with <emphasis role="italic">index</emphasis>) then the <emphasis role="italic">index</emphasis>) is also removed from the Relation. @@ -4843,7 +4864,7 @@ </programlisting> <para>Returns <computeroutput>1</computeroutput> (true) if all items in the -receiver collection are also contained in the +receiver Relation are also contained in the <emphasis role="italic">argument</emphasis> collection with the same associated index; returns <computeroutput>0</computeroutput> (false) otherwise. The <emphasis role="italic">argument</emphasis> can be any @@ -4863,14 +4884,13 @@ ]]> </programlisting> -<para>Returns a supplier object for the collection. After you have obtained a -supplier, you can send it messages (see -<link linkend="clsSupplier">The Supplier Class</link>) to enumerate -all the items that were in the collection at the time of the supplier's -creation. The supplier enumerates the items in an unspecified order. (The -program should not rely on any order.) If you specify +<para>Returns a <link linkend="clsSupplier">The Supplier Class</link> object for the relation. +The supplier allows you to iterate over all index/item pairs in the relation at the time +the supplier was created. +The supplier enumerates the items in an unspecified order. +If you specify <emphasis role="italic">index</emphasis>, the -supplier enumerates all of the items in the relation with the specified index. +supplier contains all of the items with the specified index. </para> </section> @@ -4961,10 +4981,13 @@ <indexterm><primary>Set Collection classes</primary> <secondary>Set class</secondary></indexterm> -<para>A set is a collection containing the member items +<para>A Set is a collection containing member items where the index is the same as the item (similar to a Bag collection). Any object can be placed in a set. There can be only one occurrence of any object in -a set (unlike a Bag collection).</para> +a set (unlike a Bag collection). +Item equality is determined by +using the == method. +</para> <figure><title>The Set class and methods</title> <mediaobject> <imageobject> @@ -4976,13 +4999,14 @@ <note><title>Note</title> <para>The Set class also has available class methods that its metaclass, the <link linkend="clsClass">Class class</link>, defines. -It also inherits methods from the <link linkend="clsSetCollection">Set Collection -class</link>, although there are not currently any methods defined in that class. </para></note> <para>The Set class is a subclass of the Table class. In addition to its own methods, it inherits the methods of the Object class (see <link linkend="clsObject">The Object Class</link>) -and the Table class.</para> +and the Table class. +It also inherits methods from the <link linkend="clsSetCollection">Set Collection +class</link>. +</para> <section><title>Inherited Methods</title> @@ -5014,39 +5038,39 @@ </section> -<section id="mthSetPutSet"><title>[]=</title> -<indexterm><primary>[]= method</primary> +<section id="mthSetOf"><title>of (Class Method)</title> +<indexterm><primary>of method</primary> <secondary>of Set class</secondary></indexterm> <indexterm><primary>method</primary> -<secondary>[]= method</secondary> +<secondary>of method</secondary> <tertiary>of Set class</tertiary></indexterm> <programlisting> <![CDATA[ ->>-[index]=item------------------------------------------------>< + +-,----+ + V | +>>-of(---item-+-)---------------------------------------------->< ]]> </programlisting> -<para>This method is the same as the -<emphasis role="bold">put</emphasis> method. See -<link linkend="mthSetPut">put</link>.</para> +<para>Returns a newly created set containing the specified +<emphasis role="italic">item</emphasis> objects.</para> </section> -<section id="mthSetOf"><title>of (Class Method)</title> -<indexterm><primary>of method</primary> +<section id="mthSetPutSet"><title>[]=</title> +<indexterm><primary>[]= method</primary> <secondary>of Set class</secondary></indexterm> <indexterm><primary>method</primary> -<secondary>of method</secondary> +<secondary>[]= method</secondary> <tertiary>of Set class</tertiary></indexterm> <programlisting> <![CDATA[ - +-,----+ - V | ->>-of(---item-+-)---------------------------------------------->< +>>-[index]=item------------------------------------------------>< ]]> </programlisting> -<para>Returns a newly created set containing the specified -<emphasis role="italic">item</emphasis> objects.</para> +<para>Add an item to the Set. +This method is the same as the +<link linkend="mthSetPut">put()</link> method.</para> </section> <section id="mthSetIntersection"><title>intersection</title> @@ -5079,14 +5103,17 @@ <tertiary>of Set class</tertiary></indexterm> <programlisting> <![CDATA[ ->>-put(item,index)--------------------------------------------->< +>>-put(item-+--------+-)----------------------------------------->< + +-,index-+ ]]> </programlisting> -<para>Makes the object <emphasis role="italic">item</emphasis> -a member item of the collection and associates it with index -<emphasis role="italic">index</emphasis>. The new item replaces any existing -items associated with index <emphasis role="italic">index</emphasis>.</para> +<para>Adds <emphasis role="italic">item</emphasis> to the Set. +If there is an equivalent item in the Set, the exiting item will +be replaced by the new instance. +Item equality is determined by using the == method of <emphasis role="italic">item</emphasis>. +If <emphasis role="italic">index</emphasis> is specified, it must be the same +as <emphasis role="italic">item</emphasis>. </section> <section id="mthSetPutAll"><title>putAll</title> @@ -5103,12 +5130,10 @@ </programlisting> <para>Adds all items <emphasis role="italic">collection</emphasis> to the target set. The <emphasis role="italic">collection</emphasis> argument can be any object that supports a supplier -method. Items from <emphasis role="italic">collection</emphasis> are added using the index values +method. Items from <emphasis role="italic">collection</emphasis> are added using the item values returned by the supplier. -The items are -added in the order provided by the supplier object. If duplicate -indexes exist in <emphasis role="italic">collection</emphasis>, the last item provided by the +items exist in <emphasis role="italic">collection</emphasis>, the last item provided by the supplier will overwrite previous items with the same index. </para> </section> @@ -5126,7 +5151,7 @@ ]]> </programlisting> -<para>Returns <computeroutput>1</computeroutput> (true) if all indexes in the +<para>Returns <computeroutput>1</computeroutput> (true) if all items in the receiver collection are also contained in the <emphasis role="italic">argument</emphasis> collection; returns <computeroutput>0</computeroutput> (false) otherwise. The @@ -5149,19 +5174,15 @@ ]]> </programlisting> -<para>Returns a new collection of the same class as the receiver that contains +<para>Returns a new Set contains all the items from the receiver collection and selected items from the <emphasis role="italic">argument</emphasis> collection. This method includes an item from <emphasis role="italic">argument</emphasis> in -the new collection only if there is no item with the same associated index -in the receiver collection and the method has not already included an item -with the same index. The order in which this method selects items in -<emphasis role="italic">argument</emphasis> is unspecified. (The program -should not rely on any order.) See also the -<emphasis role="bold">union</emphasis> method of the Collection -(<link linkend="mthCollectionUnion">union</link>) and Relation -(<link linkend="mthRelationUnion">union</link>) classes. The -<emphasis role="italic">argument</emphasis> can be any +the new collection only if there is no item already in the +in the receiver collection and the method has not already included a matching item. +The order in which this method selects items in +<emphasis role="italic">argument</emphasis> is unspecified. +The <emphasis role="italic">argument</emphasis> can be any collection class object. The <emphasis role="italic">argument</emphasis> must also allow all of the index values in the receiver collection.</para> @@ -5180,10 +5201,10 @@ ]]> </programlisting> -<para>Returns a new collection of the same class as the receiver that contains +<para>Returns a new Set that contains all items from the receiver collection and the <emphasis role="italic">argument</emphasis> collection; -all indexes that appear in both collections are removed. The +all items that appear in both collections are removed. The <emphasis role="italic">argument</emphasis> can be any collection class object. The <emphasis role="italic">argument</emphasis> must also allow all of the @@ -5212,7 +5233,7 @@ <para>The Stem class also has available class methods that its metaclass, the <link linkend="clsClass">Class class</link>, defines. It also inherits methods from the <link linkend="clsMapCollection">Map Collection -class</link>, although there are not currently any methods defined in that class. +class</link>. </para></note> <para>Stems are automatically created whenever a Rexx stem variable or Rexx compound variable is used. For example: </para> @@ -5269,7 +5290,7 @@ <para>Returns a new stem object. If you specify a string <emphasis role="italic">name</emphasis>, this value is used to create the derived name of compound variables. The default -stem name is a null string.</para> +stem name is a null string ("").</para> </section> <section id="mthStemAtGet"><title>[]</title> @@ -5290,10 +5311,10 @@ <para>Returns the item associated with the specified <emphasis role="italic">index</emphasis>es. Each <emphasis role="italic">index</emphasis> is an expression; use commas to -separate the expressions. The language processor concatenates the -<emphasis role="italic">index</emphasis> expression string values, separating +separate the expressions. The Stem object concatenates the +<emphasis role="italic">index</emphasis> string values, separating them with a period (.), to create a derived index. A null string ("") -is used for any omitted expressions. The resulting string references the stem +is used for any omitted expressions. The resulting string is the index of the target stem item. If the stem has no item associated with the specified final <emphasis role="italic">index</emphasis>, the stem default value is returned. If a default value has not been @@ -5303,8 +5324,8 @@ If no default value has been assigned, the stem name is returned. </para> <note><title>Note</title> -<para>You cannot use the [] method in a DROP or PROCEDURE instruction -or in a parsing template.</para></note> +<para>You cannot use the [] method in a DROP or PROCEDURE instruction. +</para></note> </section> <section id="mthStemPutSet"><title>[]=</title> @@ -5323,10 +5344,14 @@ </programlisting> <para>Makes the value a member item of the stem collection and associates it -with the specified index. If you specify no -<emphasis role="italic">index</emphasis> expressions, a +with the specified index. The final index is derived by concatenation each of +the <emphasis role="italic">index</emphasis> arguments together with a "." +separator. +If you specify no +<emphasis role="italic">index</emphasis> arguments, a new default stem value is assigned. Assigning a new default value will -re-initialize the stem and remove all existing assigned indexes.</para> +re-initialize the stem and remove all existing assigned indexes. +</para> </section> <section id="mthStemAllIndexes"><title>allIndexes</title> @@ -5372,9 +5397,10 @@ </programlisting> <para>Returns the item associated with the specified -<emphasis role="italic">tail</emphasis>. If the stem has no item associated -with the specified <emphasis role="italic">tail</emphasis> -this method returns the Nil object.</para> +<emphasis role="italic">tail</emphasis>. The Nil object is returned +if the stem has no item associated +with the specified <emphasis role="italic">tail</emphasis>. +</para> </section> <section id="mthStemEmpty"><title>empty</title> @@ -5424,7 +5450,9 @@ <para>Returns <computeroutput>1</computeroutput> (true) if the collection contains the <emphasis role="italic">value</emphasis> at any tail position or -otherwise returns <computeroutput>0</computeroutput> (false).</para> +otherwise returns <computeroutput>0</computeroutput> (false). +Item equality is determined by using the == method of <emphasis role="italic">item</emphasis>. +</para> </section> <section id="mthStemIndex"><title>index</title> @@ -5440,8 +5468,8 @@ </programlisting> <para>Returns the index of the specified item within the stem. -If the stem does not contain the specified item, .nil is -returned. +Returns the Nil object if the stem does not contain the specified item. +Item equality is determined by using the == method of <emphasis role="italic">item</emphasis>. </para> </section> @@ -5490,8 +5518,8 @@ </programlisting> <para>Returns an array of all stem indexes that currently have an associated -value. The items appear in the array in an unspecified order. (The program -should not rely on any order.)</para> +value. The items appear in the array in an unspecified order. +</para> </section> <section id="mthStemPut"><title>put</title> @@ -5508,9 +5536,8 @@ <para>Replaces any existing item associated with the specified <emphasis role="italic">tail</emphasis> with -the new item <emphasis role="italic">item</emphasis>. If the -<emphasis role="italic">tail</emphasis> does not exist in the stem, -an error is raised.</para> +the new item <emphasis role="italic">item</emphasis>. +</para> </section> <section id="mthStemRemove"><title>remove</title> @@ -5526,9 +5553,9 @@ </programlisting> <para>Returns and removes from the stem the member item with index -<emphasis role="italic">tail</emphasis>. If no item has index -<emphasis role="italic">tail</emphasis>, this method returns -the Nil object and removes no item.</para> +<emphasis role="italic">tail</emphasis>. Returns the Nil object if no item has index +<emphasis role="italic">tail</emphasis>. +</para> </section> <section id="mthStemRemoveItem"><title>removeItem</title> @@ -5544,7 +5571,9 @@ </programlisting> <para>Removes an item from the stem. If the target item exists at more than -one tail, the first located item is removed. The return value is the +one tail, the first located item is removed. +Item equality is determined by using the == method of <emphasis role="italic">item</emphasis>. +The return value is the removed item. </para> </section> @@ -5561,13 +5590,16 @@ ]]> </programlisting> -<para>Returns the result of the Stem class +<para> +This method requests +conversion to a specific class. All conversion requests except Array are +forwarded to the stem's current stem default value. +Returns the result of the Stem class <emphasis role="bold">makeArray</emphasis> method, if the requested class is Array. For all other classes, <emphasis role="bold">request</emphasis> forwards the message to the -default value of the stem and returns this result. This method requests -conversion to a specific class. All conversion requests except Array are -forwarded to the current stem default value.</para> +stem object's default value. +</para> </section> <section id="mthStemSupplier"><title>supplier</title> @@ -5582,12 +5614,11 @@ ]]> </programlisting> -<para>Returns a supplier object for the stem. After you have obtained a -supplier, you can send it messages (see -<link linkend="clsSupplier">The Supplier Class</link>) to enumerate -all the items that were in the stem at the time of the supplier's -creation. The supplier enumerates the items in an unspecified order. (The -program should not rely on any order.)</para> +<para>Returns a <link linkend="clsSupplier">Supplier</link> object for the stem. +The supplier allows you to iterate though the index/item pairs contained in the Stem +object at the time the supplier was created. +The supplier iterams the items in an unspecified order. +</para> </section> <section id="mthStemToDirectory"><title>toDirectory</title> @@ -5602,8 +5633,9 @@ ]]> </programlisting> -<para>Returns a directory object for the stem. The directory will contain a -name/value pair for each stem index with a directly assigned value. </para> +<para>Returns a <link linkend="clsDirectory">Directory</link> object for the stem. +The directory will contain a +name/value pair for each stem index with a directly assigned value.</para> </section> <section id="mthStemUnknown"><title>unknown</title> @@ -5618,8 +5650,8 @@ ]]> </programlisting> -<para>Reissues or forwards to the current stem default value all unknown -messages sent to a stem collection. For additional information, see +<para>Reissues or forwards all unknown +messages to the stem's current default value. For additional information, see <link linkend="unkno">Defining an unknown Method</link>.</para> </section> </section> @@ -5632,9 +5664,12 @@ <secondary>Table class</secondary></indexterm> <para>A table is a collection with indexes -that can be any object the user supplies. In a table, each item is associated +that can be any object. In a table, each item is associated with a single index, and there can be only one item for each index (unlike -a relation, which can contain more than one item with the same index).</para> +a relation, which can contain more than one item with the same index). +Index equality is determined by +using the == method. +</para> <figure><title>The Table class and methods</title> <mediaobject> <imageobject> @@ -5647,7 +5682,7 @@ <para>The Table class also has available class methods that its metaclass, the <link linkend="clsClass">Class class</link>, defines. It also inherits methods from the <link linkend="clsMapCollection">Map Collection -class</link>, although there are not currently any methods defined in that class. +class</link>. </para></note> <section><title>Inherited Methods</title> @@ -5685,9 +5720,9 @@ ]]> </programlisting> -<para>Returns the same item as the -<emphasis role="bold">at</emphasis> method. See -<link linkend="mthTableAt">at</link>.</para> +<para>Returns the item associated with <emphasis role="italic">index</emphasis>. +This is the same as the +<link linkend="mthTableAt">at()</link> method.</para> </section> <section id="mthTablePutSet"><title>[]=</title> @@ -5702,9 +5737,10 @@ ]]> </programlisting> -<para>This method is the same as the -<emphasis role="bold">put</emphasis> method. See -<link linkend="mthTablePut">put</link>.</para> +<para>Adds <emphasis role="italic">item</emphasis> to the table at index +<emphasis role="italic">index</emphasis>. +This method is the same as the +<link linkend="mthTablePut">put()</link> method.</para> </section> <section id="mthTableAllIndexes"><title>allIndexes</title> @@ -5719,7 +5755,7 @@ ]]> </programlisting> -<para>Returns an array of all indices contained in the table.</para> +<para>Returns an array of all indexes contained in the table.</para> </section> <section id="mthTableAllItems"><title>allItems</title> @@ -5750,9 +5786,9 @@ </programlisting> <para>Returns the item associated with index -<emphasis role="italic">index</emphasis>. If the collection -has no item associated with <emphasis role="italic">index</emphasis>, this -method returns the Nil object.</para> +<emphasis role="italic">index</emphasis>. Returns the Nil object if the collection +has no item associated with <emphasis role="italic">index</emphasis>. +</para> </section> <section id="mthTableEmpty"><title>empty</title> @@ -5801,7 +5837,9 @@ <para>Returns <computeroutput>1</computeroutput> (true) if the collection contains the <emphasis role="italic">value</emphasis> at any index position or -otherwise returns <computeroutput>0</computeroutput> (false).</para> +otherwise returns <computeroutput>0</computeroutput> (false). +Item equality is determined by using the == method of <emphasis role="italic">item</emphasis>. +</para> </section> <section id="mthTableIndex"><title>index</title> @@ -5818,8 +5856,8 @@ <para>Returns the index of the specified item within the table. If the target item appears at more than one index, the first located index will -be returned. If the table does not contain the specified item, .nil is -returned. +be returned. Returns the Nil object if the table does not contain the specified item. +Item equality is determined by using the == method of <emphasis role="italic">item</emphasis>. </para> </section> @@ -5869,8 +5907,8 @@ <para>Returns a single-index array containing the index objects. The array indexes range from <computeroutput>1</computeroutput> to the number of items. -The collection items appear in the array in an unspecified order. (The program -should not rely on any order.)</para> +The collection items appear in the array in an unspecified order. +</para> </section> <section id="mthTablePut"><title>put</title> @@ -5903,10 +5941,10 @@ ]]> </programlisting> -<para>Returns and removes from a collection the member item with index -<emphasis role="italic">index</emphasis>. If no item has index -<emphasis role="italic">index</emphasis>, this method returns -the Nil object and removes no item.</para> +<para>Returns and removes the table item with index +<emphasis role="italic">index</emphasis>. Returns the Nil object if no item has index +<emphasis role="italic">index</emphasis>. +</para> </section> <s... [truncated message content] |
From: <bi...@us...> - 2009-02-15 02:55:45
|
Revision: 4157 http://oorexx.svn.sourceforge.net/oorexx/?rev=4157&view=rev Author: bigrixx Date: 2009-02-15 01:52:06 +0000 (Sun, 15 Feb 2009) Log Message: ----------- editorial updates Modified Paths: -------------- docs/trunk/rexxpg/classicapi.sgml docs/trunk/rexxref/dire.sgml docs/trunk/rexxref/errnum.sgml docs/trunk/rexxref/errnums.sgml docs/trunk/rexxref/funct.sgml docs/trunk/rexxref/mig.sgml docs/trunk/rexxref/numarit.sgml docs/trunk/rexxref/oneof.sgml docs/trunk/rexxref/parsingch.sgml docs/trunk/rexxref/utilityclasses.sgml Modified: docs/trunk/rexxpg/classicapi.sgml =================================================================== --- docs/trunk/rexxpg/classicapi.sgml 2009-02-15 01:30:59 UTC (rev 4156) +++ docs/trunk/rexxpg/classicapi.sgml 2009-02-15 01:52:06 UTC (rev 4157) @@ -3064,7 +3064,7 @@ <para>where: <variablelist> <varlistentry> -<term><emphasis>size</emphasis></term> +<term><emphasis role="italic">size</emphasis></term> <listitem><para>is the number of bytes of requested memory.</para></listitem> </varlistentry> </variablelist></para> @@ -3089,7 +3089,7 @@ <para>where: <variablelist> <varlistentry> -<term><emphasis>MemoryBlock</emphasis></term> +<term><emphasis role="italic">MemoryBlock</emphasis></term> <listitem> <para>is a void pointer to the block of memory allocated by the Object REXX interpreter, or allocated by a previous call to RexxAllocateMemory().</para> Modified: docs/trunk/rexxref/dire.sgml =================================================================== --- docs/trunk/rexxref/dire.sgml 2009-02-15 01:30:59 UTC (rev 4156) +++ docs/trunk/rexxref/dire.sgml 2009-02-15 01:52:06 UTC (rev 4157) @@ -43,7 +43,7 @@ --> <chapter id="dire"><title>Directives</title> <para>A Rexx program contains one or more executable code units. -<emphasis>Directive instructions</emphasis> separate these executable units. A +<emphasis role="italic">Directive instructions</emphasis> separate these executable units. A directive begins with a double colon (::) and is a nonexecutable instruction. For example, it cannot appear in a string for the INTERPRET instruction to be interpreted. @@ -740,7 +740,7 @@ optional and specifies the name of the function within the library package. If not specified, the ::ROUTINE name is used. Loading of the function will be attempted using the name as given and as all uppercase. Using REGISTERED is the -equivalent of loading an external function using the RXFUNCADD() builtin +equivalent of loading an external function using the RXFUNCADD() built-in function. See <link linkend="bifRxfuncadd">.METHODS</link> for more details. </para></listitem></varlistentry> Modified: docs/trunk/rexxref/errnum.sgml =================================================================== --- docs/trunk/rexxref/errnum.sgml 2009-02-15 01:30:59 UTC (rev 4156) +++ docs/trunk/rexxref/errnum.sgml 2009-02-15 01:52:06 UTC (rev 4157) @@ -68,16 +68,7 @@ further defines the source of the error is given. The ERRORTEXT built-in function cannot retrieve the secondary message, but it is available from the condition object created when SIGNAL ON SYNTAX traps an error.</para> -<para>Some errors are only or not displayed under certain conditions:</para> -<itemizedlist> -<listitem><para>Errors 3 and 5 cannot be trapped by SIGNAL ON SYNTAX.</para></listitem> -<listitem><para>Error 4 can only be trapped by SIGNAL ON HALT or CALL ON HALT. -</para></listitem> -<listitem><para>Errors 6 and 30 can only be trapped by SIGNAL ON SYNTAX if they occur -during the execution of an INTERPRET instruction.</para></listitem> -</itemizedlist> - &errnums; Modified: docs/trunk/rexxref/errnums.sgml =================================================================== --- docs/trunk/rexxref/errnums.sgml 2009-02-15 01:30:59 UTC (rev 4156) +++ docs/trunk/rexxref/errnums.sgml 2009-02-15 01:52:06 UTC (rev 4157) @@ -11,39 +11,39 @@ <varlistentry> <term>001</term> <listitem> -<para>Failure during initialization: File "<emphasis>filename</emphasis>" is unreadable</para> +<para>Failure during initialization: File "<emphasis role="italic">filename</emphasis>" is unreadable</para> </listitem> </varlistentry> <varlistentry> <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>901</term> <listitem> -<para>Failure during initialization: Program "<emphasis>program</emphasis>" was not found</para> +<para>Failure during initialization: Program "<emphasis role="italic">program</emphasis>" was not found</para> </listitem> </varlistentry> <varlistentry> <term>902</term> <listitem> -<para>Error writing output file "<emphasis>file</emphasis>"</para> +<para>Error writing output file "<emphasis role="italic">file</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>903</term> <listitem> -<para>Program "<emphasis>program_name</emphasis>" cannot be run by this version of the REXX interpreter</para> +<para>Program "<emphasis role="italic">program_name</emphasis>" cannot be run by this version of the REXX interpreter</para> </listitem> </varlistentry> <varlistentry> <term>904</term> <listitem> -<para>Failure during initialization: Program "<emphasis>program</emphasis>" needs to be tokenized. To run untokenized scripts you need a full version of Object REXX.</para> +<para>Failure during initialization: Program "<emphasis role="italic">program</emphasis>" needs to be tokenized. To run untokenized scripts you need a full version of Object REXX.</para> </listitem> </varlistentry> </variablelist> @@ -59,14 +59,14 @@ <varlistentry> <term>001</term> <listitem> -<para>Program interrupted with <emphasis>condition</emphasis> condition</para> +<para>Program interrupted with <emphasis role="italic">condition</emphasis> condition</para> </listitem> </varlistentry> <varlistentry> <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -84,7 +84,7 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -110,7 +110,7 @@ <varlistentry> <term>001</term> <listitem> -<para>Unmatched comment delimiter ("/*") on line <emphasis>line_number</emphasis> +<para>Unmatched comment delimiter ("/*") on line <emphasis role="italic">line_number</emphasis> </para> </listitem> </varlistentry> @@ -130,7 +130,7 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -163,13 +163,13 @@ <varlistentry> <term>001</term> <listitem> -<para>SELECT on line <emphasis>line_number</emphasis> requires WHEN</para> +<para>SELECT on line <emphasis role="italic">line_number</emphasis> requires WHEN</para> </listitem> </varlistentry> <varlistentry> <term>002</term> <listitem> -<para>SELECT on line <emphasis>line_number</emphasis> requires WHEN, OTHERWISE, or END</para> +<para>SELECT on line <emphasis role="italic">line_number</emphasis> requires WHEN, OTHERWISE, or END</para> </listitem> </varlistentry> <varlistentry> @@ -255,19 +255,19 @@ <varlistentry> <term>002</term> <listitem> -<para>Symbol following END ("<emphasis>symbol</emphasis>") must match block specification name ("<emphasis>control_variable</emphasis>") on line <emphasis>line_number</emphasis> or be omitted</para> +<para>Symbol following END ("<emphasis role="italic">symbol</emphasis>") must match block specification name ("<emphasis role="italic">control_variable</emphasis>") on line <emphasis role="italic">line_number</emphasis> or be omitted</para> </listitem> </varlistentry> <varlistentry> <term>003</term> <listitem> -<para>END corresponding to block on line <emphasis>symbol</emphasis> must not have a symbol following it because there is no LABEL or control variable; found "<emphasis>line_number</emphasis>"</para> +<para>END corresponding to block on line <emphasis role="italic">symbol</emphasis> must not have a symbol following it because there is no LABEL or control variable; found "<emphasis role="italic">line_number</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>004</term> <listitem> -<para>Symbol following END ("<emphasis>symbol</emphasis>") must match LABEL of SELECT specification ("<emphasis>control_variable</emphasis>") on line <emphasis>line_number</emphasis> or be omitted</para> +<para>Symbol following END ("<emphasis role="italic">symbol</emphasis>") must match LABEL of SELECT specification ("<emphasis role="italic">control_variable</emphasis>") on line <emphasis role="italic">line_number</emphasis> or be omitted</para> </listitem> </varlistentry> <varlistentry> @@ -285,7 +285,7 @@ <varlistentry> <term>007</term> <listitem> -<para>END corresponding to SELECT on line <emphasis>symbol</emphasis> must not have a symbol following it because there is no LABEL; found "<emphasis>line_number</emphasis>"</para> +<para>END corresponding to SELECT on line <emphasis role="italic">symbol</emphasis> must not have a symbol following it because there is no LABEL; found "<emphasis role="italic">line_number</emphasis>"</para> </listitem> </varlistentry> </variablelist> @@ -297,10 +297,10 @@ </para> <para>Your program exceeds the nesting level limit for control structures (for example, DO...END and IF...THEN...ELSE). This could be because of a looping INTERPRET instruction, such as:</para> <programlisting> - + line='INTERPRET line' INTERPRET line - + </programlisting> <para>These lines loop until they exceed the nesting level limit and the language processor issues this message. Similarly, a recursive subroutine or internal function that does not end correctly can loop until it causes this message.</para> <para>The associated subcodes are: </para> @@ -315,7 +315,7 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -326,20 +326,20 @@ <para> <emphasis role="bold">Explanation:</emphasis> </para> -<para>A character was found outside a literal (quoted) string that is not a blank or one of the valid alphanumeric and special characters.</para> +<para>A character was found outside a literal (quoted) string that is not a whitespace character or one of the valid alphanumeric and special characters.</para> <para>The associated subcodes are: </para> <variablelist> <varlistentry> <term>001</term> <listitem> -<para>Incorrect character in program "<emphasis>character</emphasis>" ('<emphasis>hex_character</emphasis>'X)</para> +<para>Incorrect character in program "<emphasis role="italic">character</emphasis>" ('<emphasis role="italic">hex_character</emphasis>'X)</para> </listitem> </varlistentry> <varlistentry> <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -356,31 +356,31 @@ <varlistentry> <term>001</term> <listitem> -<para>DO instruction on line <emphasis>line_number</emphasis> requires matching END</para> +<para>DO instruction on line <emphasis role="italic">line_number</emphasis> requires matching END</para> </listitem> </varlistentry> <varlistentry> <term>002</term> <listitem> -<para>SELECT instruction on line <emphasis>line_number</emphasis> requires matching END</para> +<para>SELECT instruction on line <emphasis role="italic">line_number</emphasis> requires matching END</para> </listitem> </varlistentry> <varlistentry> <term>003</term> <listitem> -<para>THEN on line <emphasis>line_number</emphasis> must be followed by an instruction</para> +<para>THEN on line <emphasis role="italic">line_number</emphasis> must be followed by an instruction</para> </listitem> </varlistentry> <varlistentry> <term>004</term> <listitem> -<para>ELSE on line <emphasis>line_number</emphasis> must be followed by an instruction</para> +<para>ELSE on line <emphasis role="italic">line_number</emphasis> must be followed by an instruction</para> </listitem> </varlistentry> <varlistentry> <term>901</term> <listitem> -<para>OTHERWISE on line <emphasis>line_number</emphasis> requires matching END</para> +<para>OTHERWISE on line <emphasis role="italic">line_number</emphasis> requires matching END</para> </listitem> </varlistentry> </variablelist> @@ -390,21 +390,21 @@ <para> <emphasis role="bold">Explanation:</emphasis> </para> -<para>Hexadecimal strings must not have leading or trailing blanks and blanks can only be embedded at byte boundaries. Only the digits 0-9 and the letters a-f and A-F are allowed. The following are valid hexadecimal strings: </para> +<para>Hexadecimal strings must not have leading or trailing whitespace characters and whitespace can only be embedded at byte boundaries. Only the digits 0-9 and the letters a-f and A-F are allowed. The following are valid hexadecimal strings: </para> <programlisting> - + '13'x 'A3C2 1c34'x '1de8'x - + </programlisting> -<para>Binary strings can have blanks only at the boundaries of groups of four binary digits. Only the digits 0 and 1 are allowed. These are valid binary strings: </para> +<para>Binary strings can have whitespace only at the boundaries of groups of four binary digits. Only the digits 0 and 1 are allowed. These are valid binary strings: </para> <programlisting> - + '1011'b '110 1101'b '101101 11010011'b - + </programlisting> <para>You might have mistyped one of the digits, for example, typing a letter O instead of the number 0. Or you might have used the one-character symbol X or B (the name of the variable X or B, respectively) after a literal string when the string is not intended as a hexadecimal or binary specification. In this case, use the explicit concatenation operator (||) to concatenate the string to the value of the symbol.</para> <para>The associated subcodes are: </para> @@ -412,25 +412,25 @@ <varlistentry> <term>001</term> <listitem> -<para>Incorrect location of blank in position <emphasis>position</emphasis> in hexadecimal string</para> +<para>Incorrect location of whitespace character in position <emphasis role="italic">position</emphasis> in hexadecimal string</para> </listitem> </varlistentry> <varlistentry> <term>002</term> <listitem> -<para>Incorrect location of blank in position <emphasis>position</emphasis> in binary string</para> +<para>Incorrect location of whitespace character in position <emphasis role="italic">position</emphasis> in binary string</para> </listitem> </varlistentry> <varlistentry> <term>003</term> <listitem> -<para>Only 0-9, a-f, A-F, and blank are valid in a hexadecimal string; found "<emphasis>character</emphasis>"</para> +<para>Only 0-9, a-f, A-F, and whitespace characters are valid in a hexadecimal string; found "<emphasis role="italic">character</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>004</term> <listitem> -<para>Only 0, 1, and blank are valid in a binary string; found "<emphasis>character</emphasis>"</para> +<para>Only 0, 1, and whitespace characters are valid in a binary string; found "<emphasis role="italic">character</emphasis>"</para> </listitem> </varlistentry> </variablelist> @@ -446,7 +446,7 @@ <varlistentry> <term>001</term> <listitem> -<para>Label "<emphasis>label_name</emphasis>" not found</para> +<para>Label "<emphasis role="italic">label_name</emphasis>" not found</para> </listitem> </varlistentry> </variablelist> @@ -484,13 +484,13 @@ <varlistentry> <term>001</term> <listitem> -<para>IF instruction on line <emphasis>line_number</emphasis> requires matching THEN clause</para> +<para>IF instruction on line <emphasis role="italic">line_number</emphasis> requires matching THEN clause</para> </listitem> </varlistentry> <varlistentry> <term>002</term> <listitem> -<para>WHEN instruction on line <emphasis>line_number</emphasis> requires matching THEN clause</para> +<para>WHEN instruction on line <emphasis role="italic">line_number</emphasis> requires matching THEN clause</para> </listitem> </varlistentry> </variablelist> @@ -546,7 +546,7 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -622,6 +622,24 @@ <para>String or symbol expected after MIXINCLASS keyword</para> </listitem> </varlistentry> +<varlistentry> +<term>914</term> +<listitem> +<para>String or symbol expected as ::ATTRIBUTE directive name</para> +</listitem> +</varlistentry> +<varlistentry> +<term>915</term> +<listitem> +<para>String or symbol expected as ::CONSTANT directive name</para> +</listitem> +</varlistentry> +<varlistentry> +<term>916</term> +<listitem> +<para>String or symbol expected as ::CONSTANT value</para> +</listitem> +</varlistentry> </variablelist> </section> <section id="ERR20"> @@ -636,7 +654,7 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -667,7 +685,7 @@ <varlistentry> <term>905</term> <listitem> -<para>NUMERIC must be followed by one of the keywords DIGITS, FORM, or FUZZ; found "<emphasis>symbol</emphasis>"</para> +<para>NUMERIC must be followed by one of the keywords DIGITS, FORM, or FUZZ; found "<emphasis role="italic">symbol</emphasis>"</para> </listitem> </varlistentry> <varlistentry> @@ -756,76 +774,82 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>901</term> <listitem> -<para>Data must not follow the NOP keyword; found "<emphasis>data</emphasis>"</para> +<para>Data must not follow the NOP keyword; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>902</term> <listitem> -<para>Data must not follow the SELECT keyword; found "<emphasis>data</emphasis>"</para> +<para>Data must not follow the SELECT keyword; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>903</term> <listitem> -<para>Data must not follow the NAME keyword; found "<emphasis>data</emphasis>"</para> +<para>Data must not follow the NAME keyword; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>904</term> <listitem> -<para>Data must not follow the condition name; found "<emphasis>data</emphasis>"</para> +<para>Data must not follow the condition name; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>905</term> <listitem> -<para>Data must not follow the SIGNAL label name; found "<emphasis>data</emphasis>"</para> +<para>Data must not follow the SIGNAL label name; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>906</term> <listitem> -<para>Data must not follow the TRACE setting; found "<emphasis>data</emphasis>"</para> +<para>Data must not follow the TRACE setting; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>907</term> <listitem> -<para>Data must not follow the LEAVE control variable name; found "<emphasis>data</emphasis>"</para> +<para>Data must not follow the LEAVE control variable name; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>908</term> <listitem> -<para>Data must not follow the ITERATE control variable name; found "<emphasis>data</emphasis>"</para> +<para>Data must not follow the ITERATE control variable name; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>909</term> <listitem> -<para>Data must not follow the END control variable name; found "<emphasis>data</emphasis>"</para> +<para>Data must not follow the END control variable name; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>911</term> <listitem> -<para>Data must not follow the NUMERIC FORM specification; found "<emphasis>data</emphasis>"</para> +<para>Data must not follow the NUMERIC FORM specification; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>912</term> <listitem> -<para>Data must not follow the GUARD OFF specification; found "<emphasis>data</emphasis>"</para> +<para>Data must not follow the GUARD OFF specification; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> +<varlistentry> +<term>913</term> +<listitem> +<para>Data must not follow the ::CONSTANT value; found "<emphasis role="italic">data</emphasis>"</para> +</listitem> +</varlistentry> </variablelist> </section> <section id="ERR22"> @@ -839,14 +863,14 @@ <varlistentry> <term>001</term> <listitem> -<para>Incorrect character string "<emphasis>character_string</emphasis>" ('<emphasis>hex_string</emphasis>'X)</para> +<para>Incorrect character string "<emphasis role="italic">character_string</emphasis>" ('<emphasis role="italic">hex_string</emphasis>'X)</para> </listitem> </varlistentry> <varlistentry> <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -869,14 +893,14 @@ <varlistentry> <term>001</term> <listitem> -<para>Incorrect data string "<emphasis>string</emphasis>" ('<emphasis>hex_string</emphasis>'X)</para> +<para>Incorrect data string "<emphasis role="italic">string</emphasis>" ('<emphasis role="italic">hex_string</emphasis>'X)</para> </listitem> </varlistentry> <varlistentry> <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -902,7 +926,7 @@ <varlistentry> <term>001</term> <listitem> -<para>TRACE request letter must be one of "ACEFILNOR"; found "<emphasis>value</emphasis>"</para> +<para>TRACE request letter must be one of "ACEFILNOR"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> @@ -924,99 +948,99 @@ <varlistentry> <term>001</term> <listitem> -<para>CALL ON must be followed by one of the keywords ERROR, FAILURE, HALT, NOTREADY, USER, or ANY; found "<emphasis>word</emphasis>"</para> +<para>CALL ON must be followed by one of the keywords ERROR, FAILURE, HALT, NOTREADY, USER, or ANY; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>002</term> <listitem> -<para>CALL OFF must be followed by one of the keywords ERROR, FAILURE, HALT, NOTREADY, USER, or ANY; found "<emphasis>word</emphasis>"</para> +<para>CALL OFF must be followed by one of the keywords ERROR, FAILURE, HALT, NOTREADY, USER, or ANY; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>003</term> <listitem> -<para>SIGNAL ON must be followed by one of the keywords ERROR, FAILURE, HALT, LOSTDIGITS, NOTREADY, NOMETHOD, NOSTRING, NOVALUE, SYNTAX, USER, or ANY; found "<emphasis>word</emphasis>"</para> +<para>SIGNAL ON must be followed by one of the keywords ERROR, FAILURE, HALT, LOSTDIGITS, NOTREADY, NOMETHOD, NOSTRING, NOVALUE, SYNTAX, USER, or ANY; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>004</term> <listitem> -<para>SIGNAL OFF must be followed by one of the keywords ERROR, FAILURE, HALT, LOSTDIGITS, NOTREADY, NOMETHOD, NOSTRING, NOVALUE, SYNTAX, USER, or ANY; found "<emphasis>word</emphasis>"</para> +<para>SIGNAL OFF must be followed by one of the keywords ERROR, FAILURE, HALT, LOSTDIGITS, NOTREADY, NOMETHOD, NOSTRING, NOVALUE, SYNTAX, USER, or ANY; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>011</term> <listitem> -<para>NUMERIC FORM must be followed by one of the keywords SCIENTIFIC or ENGINEERING; found "<emphasis>word</emphasis>"</para> +<para>NUMERIC FORM must be followed by one of the keywords SCIENTIFIC or ENGINEERING; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>012</term> <listitem> -<para>PARSE must be followed by one of the keywords ARG, LINEIN, PULL, SOURCE, VALUE, VAR, or VERSION; found "<emphasis>word</emphasis>"</para> +<para>PARSE must be followed by one of the keywords ARG, LINEIN, PULL, SOURCE, VALUE, VAR, or VERSION; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>015</term> <listitem> -<para>NUMERIC must be followed by one of the keywords DIGITS, FORM, or FUZZ; found "<emphasis>word</emphasis>"</para> +<para>NUMERIC must be followed by one of the keywords DIGITS, FORM, or FUZZ; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>017</term> <listitem> -<para>PROCEDURE must be followed by the keyword EXPOSE or nothing; found "<emphasis>word</emphasis>"</para> +<para>PROCEDURE must be followed by the keyword EXPOSE or nothing; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>901</term> <listitem> -<para>Unknown keyword on ::CLASS directive; found "<emphasis>word</emphasis>"</para> +<para>Unknown keyword on ::CLASS directive; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>902</term> <listitem> -<para>Unknown keyword on ::METHOD directive; found "<emphasis>word</emphasis>"</para> +<para>Unknown keyword on ::METHOD directive; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>903</term> <listitem> -<para>Unknown keyword on ::ROUTINE directive; found "<emphasis>word</emphasis>"</para> +<para>Unknown keyword on ::ROUTINE directive; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>904</term> <listitem> -<para>Unknown keyword on ::REQUIRES directive; found "<emphasis>word</emphasis>"</para> +<para>Unknown keyword on ::REQUIRES directive; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>905</term> <listitem> -<para>USE must be followed by the keyword ARG; found "<emphasis>word</emphasis>"</para> +<para>USE must be followed by the keyword ARG; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>906</term> <listitem> -<para>RAISE must be followed by one of the keywords ERROR, FAILURE, HALT, LOSTDIGITS, NOMETHOD, NOSTRING, NOTREADY, NOVALUE, SYNTAX, or USER; found "<emphasis>word</emphasis>"</para> +<para>RAISE must be followed by one of the keywords ERROR, FAILURE, HALT, LOSTDIGITS, NOMETHOD, NOSTRING, NOTREADY, NOVALUE, SYNTAX, or USER; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>907</term> <listitem> -<para>Unknown keyword on RAISE instruction; found "<emphasis>word</emphasis>"</para> +<para>Unknown keyword on RAISE instruction; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> @@ -1040,31 +1064,31 @@ <varlistentry> <term>912</term> <listitem> -<para>GUARD ON or GUARD OFF must be followed by the keyword WHEN; found "<emphasis>word</emphasis>"</para> +<para>GUARD ON or GUARD OFF must be followed by the keyword WHEN; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>913</term> <listitem> -<para>GUARD must be followed by the keyword ON or OFF; found "<emphasis>word</emphasis>"</para> +<para>GUARD must be followed by the keyword ON or OFF; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>914</term> <listitem> -<para>CALL ON condition must be followed by the keyword NAME; found "<emphasis>word</emphasis>"</para> +<para>CALL ON condition must be followed by the keyword NAME; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>915</term> <listitem> -<para>SIGNAL ON condition must be followed by the keyword NAME; found "<emphasis>word</emphasis>"</para> +<para>SIGNAL ON condition must be followed by the keyword NAME; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>916</term> <listitem> -<para>Unknown keyword on FORWARD instruction; found "<emphasis>keyword</emphasis>"</para> +<para>Unknown keyword on FORWARD instruction; found "<emphasis role="italic">keyword</emphasis>"</para> </listitem> </varlistentry> <varlistentry> @@ -1100,7 +1124,7 @@ <varlistentry> <term>923</term> <listitem> -<para>SELECT must be followed by the keyword LABEL; found "<emphasis>word</emphasis>"</para> +<para>SELECT must be followed by the keyword LABEL; found "<emphasis role="italic">word</emphasis>"</para> </listitem> </varlistentry> </variablelist> @@ -1110,7 +1134,8 @@ <para> <emphasis role="bold">Explanation:</emphasis> </para> -<para>An expression was found that did not evaluate to a whole number or is greater than the limit (the default is 999 999 999): +<para>An expression was found that did not evaluate to a whole number or is greater than the limit (the default is 999,999,999 for 32-bit system + and 999,999,999,999,999,999 for 64-bit systems): <itemizedlist> <listitem> <para>The positional patterns in parsing templates (including variable positional patterns)</para> @@ -1134,43 +1159,43 @@ <varlistentry> <term>002</term> <listitem> -<para>Value of repetition count expression in DO instruction must be zero or a positive whole number; found "<emphasis>value</emphasis>"</para> +<para>Value of repetition count expression in DO instruction must be zero or a positive whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>003</term> <listitem> -<para>Value of FOR expression in DO instruction must be zero or a positive whole number; found "<emphasis>value</emphasis>"</para> +<para>Value of FOR expression in DO instruction must be zero or a positive whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>004</term> <listitem> -<para>Positional pattern of PARSE template must be a whole number; found "<emphasis>value</emphasis>"</para> +<para>Positional pattern of PARSE template must be a whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>005</term> <listitem> -<para>NUMERIC DIGITS value must be a positive whole number; found "<emphasis>value</emphasis>"</para> +<para>NUMERIC DIGITS value must be a positive whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>006</term> <listitem> -<para>NUMERIC FUZZ value must be zero or a positive whole number; found "<emphasis>value</emphasis>"</para> +<para>NUMERIC FUZZ value must be zero or a positive whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>007</term> <listitem> -<para>Number used in TRACE setting must be a whole number; found "<emphasis>value</emphasis>"</para> +<para>Number used in TRACE setting must be a whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>008</term> <listitem> -<para>Operand to the right of the power operator (**) must be a whole number; found "<emphasis>value</emphasis>"</para> +<para>Operand to the right of the power operator (**) must be a whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> @@ -1189,26 +1214,26 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>901</term> <listitem> -<para>Result of a method call did not result in a whole number; found "<emphasis>value</emphasis>"</para> +<para>Result of a method call did not result in a whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>902</term> <listitem> -<para>Result of a COMPARETO method call did not result in a whole number; found "<emphasis>value</emphasis>"</para> +<para>Result of a COMPARETO method call did not result in a whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>903</term> <listitem> -<para>Result of a COMPARE method call did not result in a whole number; found "<emphasis>value</emphasis>"</para> +<para>Result of a COMPARE method call did not result in a whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> </variablelist> @@ -1230,13 +1255,13 @@ <varlistentry> <term>901</term> <listitem> -<para>Incorrect data following FOREVER keyword on the DO loop; found "<emphasis>data</emphasis>"</para> +<para>Incorrect data following FOREVER keyword on the DO loop; found "<emphasis role="italic">data</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>902</term> <listitem> -<para>DO keyword <emphasis>keyword</emphasis> can be specified only once</para> +<para>DO keyword <emphasis role="italic">keyword</emphasis> can be specified only once</para> </listitem> </varlistentry> </variablelist> @@ -1264,19 +1289,19 @@ <varlistentry> <term>003</term> <listitem> -<para>Symbol following LEAVE ("<emphasis>symbol</emphasis>") must either match the label of a current loop or block instruction.</para> +<para>Symbol following LEAVE ("<emphasis role="italic">symbol</emphasis>") must either match the label of a current loop or block instruction.</para> </listitem> </varlistentry> <varlistentry> <term>004</term> <listitem> -<para>Symbol following ITERATE ("<emphasis>symbol</emphasis>") must either match the label of a current loop or be omitted</para> +<para>Symbol following ITERATE ("<emphasis role="italic">symbol</emphasis>") must either match the label of a current loop or be omitted</para> </listitem> </varlistentry> <varlistentry> <term>005</term> <listitem> -<para>Symbol following ITERATE ("<emphasis>symbol</emphasis>") does not match a repetitive block instruction</para> +<para>Symbol following ITERATE ("<emphasis role="italic">symbol</emphasis>") does not match a repetitive block instruction</para> </listitem> </varlistentry> </variablelist> @@ -1292,7 +1317,7 @@ <varlistentry> <term>001</term> <listitem> -<para>Environment name exceeds <emphasis>limit</emphasis> characters; found "<emphasis>environment_name</emphasis>"</para> +<para>Environment name exceeds <emphasis role="italic">limit</emphasis> characters; found "<emphasis role="italic">environment_name</emphasis>"</para> </listitem> </varlistentry> </variablelist> @@ -1308,33 +1333,33 @@ <varlistentry> <term>001</term> <listitem> -<para>Name exceeds 250 characters: "<emphasis>name</emphasis>"</para> +<para>Name exceeds 250 characters: "<emphasis role="italic">name</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>002</term> <listitem> -<para>Literal string exceeds 250 characters: "<emphasis>string</emphasis>"</para> +<para>Literal string exceeds 250 characters: "<emphasis role="italic">string</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>901</term> <listitem> -<para>Hexadecimal literal string exceeds 250 characters "<emphasis>string</emphasis>"</para> +<para>Hexadecimal literal string exceeds 250 characters "<emphasis role="italic">string</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>902</term> <listitem> -<para>Binary literal string exceeds 250 characters "<emphasis>string</emphasis>"</para> +<para>Binary literal string exceeds 250 characters "<emphasis role="italic">string</emphasis>"</para> </listitem> </varlistentry> </variablelist> @@ -1350,26 +1375,26 @@ <varlistentry> <term>001</term> <listitem> -<para>A value cannot be assigned to a number; found "<emphasis>number</emphasis>"</para> +<para>A value cannot be assigned to a number; found "<emphasis role="italic">number</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>002</term> <listitem> -<para>Variable symbol must not start with a number; found "<emphasis>symbol</emphasis>"</para> +<para>Variable symbol must not start with a number; found "<emphasis role="italic">symbol</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>003</term> <listitem> -<para>Variable symbol must not start with a "."; found "<emphasis>symbol</emphasis>"</para> +<para>Variable symbol must not start with a "."; found "<emphasis role="italic">symbol</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -1386,13 +1411,13 @@ <varlistentry> <term>001</term> <listitem> -<para>Value of NUMERIC DIGITS ("<emphasis>value</emphasis>") must exceed value of NUMERIC FUZZ ("<emphasis>value</emphasis>")</para> +<para>Value of NUMERIC DIGITS ("<emphasis role="italic">value</emphasis>") must exceed value of NUMERIC FUZZ ("<emphasis role="italic">value</emphasis>")</para> </listitem> </varlistentry> <varlistentry> <term>002</term> <listitem> -<para>Value of NUMERIC DIGITS ("<emphasis>value</emphasis>") must not exceed <emphasis>value</emphasis> +<para>Value of NUMERIC DIGITS ("<emphasis role="italic">value</emphasis>") must not exceed <emphasis role="italic">value</emphasis> </para> </listitem> </varlistentry> @@ -1400,7 +1425,7 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -1441,69 +1466,69 @@ <varlistentry> <term>001</term> <listitem> -<para>Value of expression following IF keyword must be exactly "0" or "1"; found "<emphasis>value</emphasis>"</para> +<para>Value of expression following IF keyword must be exactly "0" or "1"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>002</term> <listitem> -<para>Value of expression following WHEN keyword must be exactly "0" or "1"; found "<emphasis>value</emphasis>"</para> +<para>Value of expression following WHEN keyword must be exactly "0" or "1"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>003</term> <listitem> -<para>Value of expression following WHILE keyword must be exactly "0" or "1"; found "<emphasis>value</emphasis>"</para> +<para>Value of expression following WHILE keyword must be exactly "0" or "1"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>004</term> <listitem> -<para>Value of expression following UNTIL keyword must be exactly "0" or "1"; found "<emphasis>value</emphasis>"</para> +<para>Value of expression following UNTIL keyword must be exactly "0" or "1"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>005</term> <listitem> -<para>Value of expression to the left of the logical operator "<emphasis>operator</emphasis>" must be exactly "0" or "1"; found "<emphasis>value</emphasis>"</para> +<para>Value of expression to the left of the logical operator "<emphasis role="italic">operator</emphasis>" must be exactly "0" or "1"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>006</term> <listitem> -<para>Value of logical list expression element must be exactly "0" or "1"; found "<emphasis>value</emphasis>"</para> +<para>Value of logical list expression element must be exactly "0" or "1"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>901</term> <listitem> -<para>Logical value must be exactly "0" or "1"; found "<emphasis>value</emphasis>"</para> +<para>Logical value must be exactly "0" or "1"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>902</term> <listitem> -<para>Value of expression following GUARD keyword must be exactly "0" or "1"; found "<emphasis>value</emphasis>"</para> +<para>Value of expression following GUARD keyword must be exactly "0" or "1"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>903</term> <listitem> -<para>Authorization return value must be exactly "0" or "1"; found "<emphasis>value</emphasis>"</para> +<para>Authorization return value must be exactly "0" or "1"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>904</term> <listitem> -<para>Property logical value must be exactly "0", "1", "true", or "false"; found "<emphasis>value</emphasis>"</para> +<para>Property logical value must be exactly "0", "1", "true", or "false"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> </variablelist> @@ -1537,21 +1562,21 @@ <varlistentry> <term>001</term> <listitem> -<para>Incorrect expression detected at "<emphasis>token</emphasis>"</para> +<para>Incorrect expression detected at "<emphasis role="italic">token</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>901</term> <listitem> -<para>Prefix operator "<emphasis>operator</emphasis>" is not followed by an expression term</para> +<para>Prefix operator "<emphasis role="italic">operator</emphasis>" is not followed by an expression term</para> </listitem> </varlistentry> <varlistentry> @@ -1653,7 +1678,7 @@ <varlistentry> <term>919</term> <listitem> -<para>Operator "<emphasis>operator</emphasis>" is not followed by an expression term</para> +<para>Operator "<emphasis role="italic">operator</emphasis>" is not followed by an expression term</para> </listitem> </varlistentry> <varlistentry> @@ -1730,20 +1755,20 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>901</term> <listitem> -<para>Left parenthesis "(" in position <emphasis>position</emphasis> on line <emphasis>line_number</emphasis> requires a corresponding right parenthesis ")"</para> +<para>Left parenthesis "(" in position <emphasis role="italic">position</emphasis> on line <emphasis role="italic">line_number</emphasis> requires a corresponding right parenthesis ")"</para> </listitem> </varlistentry> <varlistentry> <term>902</term> <listitem> -<para>Square bracket "[" in position <emphasis>position</emphasis> on line <emphasis>line_number</emphasis> requires a corresponding right square bracket "]"</para> +<para>Square bracket "[" in position <emphasis role="italic">position</emphasis> on line <emphasis role="italic">line_number</emphasis> requires a corresponding right square bracket "]"</para> </listitem> </varlistentry> </variablelist> @@ -1779,7 +1804,7 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -1802,13 +1827,13 @@ <varlistentry> <term>001</term> <listitem> -<para>Incorrect PARSE template detected at "<emphasis>column_position</emphasis>"</para> +<para>Incorrect PARSE template detected at "<emphasis role="italic">column_position</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>002</term> <listitem> -<para>Incorrect PARSE position detected at "<emphasis>column_position</emphasis>"</para> +<para>Incorrect PARSE position detected at "<emphasis role="italic">column_position</emphasis>"</para> </listitem> </varlistentry> <varlistentry> @@ -1821,7 +1846,7 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> @@ -1863,156 +1888,156 @@ <varlistentry> <term>001</term> <listitem> -<para>External routine "<emphasis>routine</emphasis>" failed</para> +<para>External routine "<emphasis role="italic">routine</emphasis>" failed</para> </listitem> </varlistentry> <varlistentry> <term>003</term> <listitem> -<para>Not enough arguments in invocation of <emphasis>routine</emphasis>; minimum expected is <emphasis>number</emphasis> +<para>Not enough arguments in invocation of <emphasis role="italic">routine</emphasis>; minimum expected is <emphasis role="italic">number</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>004</term> <listitem> -<para>Too many arguments in invocation of <emphasis>routine</emphasis>; maximum expected is <emphasis>number</emphasis> +<para>Too many arguments in invocation of <emphasis role="italic">routine</emphasis>; maximum expected is <emphasis role="italic">number</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>005</term> <listitem> -<para>Missing argument in invocation of <emphasis>routine</emphasis>; argument <emphasis>argument_number</emphasis> is required</para> +<para>Missing argument in invocation of <emphasis role="italic">routine</emphasis>; argument <emphasis role="italic">argument_number</emphasis> is required</para> </listitem> </varlistentry> <varlistentry> <term>011</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be a number; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be a number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>012</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be a whole number; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be a whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>013</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be zero or positive; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be zero or positive; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>014</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be positive; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be positive; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>019</term> <listitem> <para> -<emphasis>function_name</emphasis> argument 2, "<emphasis>value</emphasis>", is not in the format described by argument 3, "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument 2, "<emphasis role="italic">value</emphasis>", is not in the format described by argument 3, "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>021</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must not be a null string</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must not be a null string</para> </listitem> </varlistentry> <varlistentry> <term>022</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be a single character or null; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be a single character or null; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>023</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be a single character; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be a single character; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>024</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be a binary string; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be a binary string; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>025</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be a hexadecimal string; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be a hexadecimal string; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>026</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be a valid symbol; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be a valid symbol; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>027</term> <listitem> <para> -<emphasis>function_name</emphasis> argument 1 must be a valid stream name; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument 1 must be a valid stream name; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>029</term> <listitem> <para> -<emphasis>function_name</emphasis> conversion to format "<emphasis>value</emphasis>" is not allowed</para> +<emphasis role="italic">function_name</emphasis> conversion to format "<emphasis role="italic">value</emphasis>" is not allowed</para> </listitem> </varlistentry> <varlistentry> <term>032</term> <listitem> -<para>RANDOM difference between argument 1 ("<emphasis>value</emphasis>") and argument 2 ("<emphasis>value</emphasis>") must not exceed 100000</para> +<para>RANDOM difference between argument 1 ("<emphasis role="italic">value</emphasis>") and argument 2 ("<emphasis role="italic">value</emphasis>") must not exceed 999,999,999</para> </listitem> </varlistentry> <varlistentry> <term>033</term> <listitem> -<para>RANDOM argument 1 ("<emphasis>argument</emphasis>") must be less than or equal to argument 2 ("<emphasis>argument</emphasis>")</para> +<para>RANDOM argument 1 ("<emphasis role="italic">argument</emphasis>") must be less than or equal to argument 2 ("<emphasis role="italic">argument</emphasis>")</para> </listitem> </varlistentry> <varlistentry> <term>034</term> <listitem> -<para>SOURCELINE argument 1 ("<emphasis>argument</emphasis>") must be less than or equal to the number of lines in the program (<emphasis>argument</emphasis>)</para> +<para>SOURCELINE argument 1 ("<emphasis role="italic">argument</emphasis>") must be less than or equal to the number of lines in the program (<emphasis role="italic">argument</emphasis>)</para> </listitem> </varlistentry> <varlistentry> <term>035</term> <listitem> -<para>X2D argument 1 cannot be expressed as a whole number; found "<emphasis>value</emphasis>"</para> +<para>X2D argument 1 cannot be expressed as a whole number; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>043</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>number</emphasis> must be a single non-alphanumeric character or the null string; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">number</emphasis> must be a single non-alphanumeric character or the null string; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>044</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>number</emphasis>, "<emphasis>value</emphasis>", is a format incompatible with the separator specified in argument <emphasis>number</emphasis> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">number</emphasis>, "<emphasis role="italic">value</emphasis>", is a format incompatible with the separator specified in argument <emphasis role="italic">number</emphasis> </para> </listitem> </varlistentry> @@ -2020,68 +2045,68 @@ <term>900</term> <listitem> <para> -<emphasis>message</emphasis> +<emphasis role="italic">message</emphasis> </para> </listitem> </varlistentry> <varlistentry> <term>901</term> <listitem> -<para>Result returned by <emphasis>routine</emphasis> is longer than <emphasis>length</emphasis>: "<emphasis>value</emphasis>"</para> +<para>Result returned by <emphasis role="italic">routine</emphasis> is longer than <emphasis role="italic">length</emphasis>: "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>902</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must not exceed 999,999,999</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must not exceed the whole number limit.</para> </listitem> </varlistentry> <varlistentry> <term>903</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be in the range 0-99; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be in the range 0-99; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>904</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be one of <emphasis>values</emphasis>; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be one of <emphasis role="italic">values</emphasis>; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>905</term> <listitem> -<para>TRACE setting letter must be one of "ACEFILNOR"; found "<emphasis>value</emphasis>"</para> +<para>TRACE setting letter must be one of "ACEFILNOR"; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>912</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must be a single-dimensional array; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must be a single-dimensional array; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>913</term> <listitem> <para> -<emphasis>function_name</emphasis> argument <emphasis>argument_number</emphasis> must have a string value; found "<emphasis>value</emphasis>"</para> +<emphasis role="italic">function_name</emphasis> argument <emphasis role="italic">argument_number</emphasis> must have a string value; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>914</term> <listitem> -<para>Unknown VALUE function variable environment selector; found "<emphasis>value</emphasis>"</para> +<para>Unknown VALUE function variable environment selector; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>915</term> <listitem> <para> -<emphasis>function_name</emphasis> cannot be used with QUEUE:</para> +<emphasis role="italic">function_name</emphasis> cannot be used with QUEUE:</para> </listitem> </varlistentry> <varlistentry> @@ -2096,6 +2121,18 @@ <para>Cannot write to a read-only property or typelib element.</para> </listitem> </varlistentry> +<varlistentry> +<term>918</term> +<listitem> +<para>Invalid native function signature specification</para> +</listitem> +</varlistentry> +<varlistentry> +<term>919</term> +<listitem> +<para>Argument <emphasis role="italic">argument</emphasis> must have a stem object or stem name value; found "<emphasis role="italic">value</emphasis>"</para> +</listitem> +</varlistentry> </variablelist> </section> <section id="ERR41"> @@ -2103,58 +2140,58 @@ <para> <emphasis role="bold">Explanation:</emphasis> </para> -<para>A term in an arithmetic expression is not a valid number or has an exponent outside the allowed range of -999 999 999 to +999 999 999.</para> +<para>A term in an arithmetic expression is not a valid number or has an exponent outside the allowed range of whole number range.</para> <para>You might have mistyped a variable name, or included an arithmetic operator in a character expression without putting it in quotation marks.</para> <para>The associated subcodes are: </para> <variablelist> <varlistentry> <term>001</term> <listitem> -<para>Nonnumeric value ("<emphasis>value</emphasis>") used in arithmetic operation</para> +<para>Nonnumeric value ("<emphasis role="italic">value</emphasis>") used in arithmetic operation</para> </listitem> </varlistentry> <varlistentry> <term>003</term> <listitem> -<para>Nonnumeric value ("<emphasis>value</emphasis>") used with prefix operator</para> +<para>Nonnumeric value ("<emphasis role="italic">value</emphasis>") used with prefix operator</para> </listitem> </varlistentry> <varlistentry> <term>004</term> <listitem> -<para>Value of TO expression of DO instruction must be numeric; found "<emphasis>value</emphasis>"</para> +<para>Value of TO expression of DO instruction must be numeric; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>005</term> <listitem> -<para>Value of BY expression of DO instruction must be numeric; found "<emphasis>value</emphasis>"</para> +<para>Value of BY expression of DO instruction must be numeric; found "<emphasis role="italic">value</emphasis>"</para> </listitem> </varlistentry> <varlistentry> <term>006</term> <listitem> -<para>Value of control variable expression of DO instruction must be numeric; found "<emphasis>value</emphasis>"</para> +<para>Value of control variable expression of DO instruction must be numeric; ... [truncated message content] |
From: <bi...@us...> - 2009-02-15 17:10:57
|
Revision: 4167 http://oorexx.svn.sourceforge.net/oorexx/?rev=4167&view=rev Author: bigrixx Date: 2009-02-15 17:10:53 +0000 (Sun, 15 Feb 2009) Log Message: ----------- fix syntax errors Modified Paths: -------------- docs/trunk/buildmachine/legalstuff.sgml docs/trunk/oodialog/advcntlc.sgml docs/trunk/oodialog/basedialog.sgml docs/trunk/oodialog/buttoncontrols.sgml docs/trunk/oodialog/categorydialog.sgml docs/trunk/oodialog/comboboxc.sgml docs/trunk/oodialog/dialogcontrolc.sgml docs/trunk/oodialog/editcontrolc.sgml docs/trunk/oodialog/listboxc.sgml docs/trunk/oodialog/listcontrolc.sgml docs/trunk/oodialog/menus.sgml docs/trunk/oodialog/mesextcl.sgml docs/trunk/oodialog/oodialog.sgml docs/trunk/oodialog/preface.sgml docs/trunk/oodialog/progressbarc.sgml docs/trunk/oodialog/propertysheetc.sgml docs/trunk/oodialog/resdialog.sgml docs/trunk/oodialog/scrollbarc.sgml docs/trunk/oodialog/slidercontrolc.sgml docs/trunk/oodialog/standarddialog.sgml docs/trunk/oodialog/staticcontrolc.sgml docs/trunk/oodialog/tabcontrolc.sgml docs/trunk/oodialog/treecontrolc.sgml docs/trunk/oodialog/userdialog.sgml docs/trunk/readme/readme.sgml docs/trunk/readme/unix.sgml docs/trunk/readme/windows.sgml docs/trunk/rexxpg/api.sgml docs/trunk/rexxpg/classes.sgml docs/trunk/rexxpg/classicapi.sgml docs/trunk/rexxpg/command.sgml docs/trunk/rexxpg/concept.sgml docs/trunk/rexxpg/meet.sgml docs/trunk/rexxpg/preface.sgml docs/trunk/rexxpg/provide.sgml docs/trunk/rexxpg/rexio.sgml docs/trunk/rexxpg/rexxpg.sgml docs/trunk/rexxpg/rxruntime.sgml docs/trunk/rexxpg/samples.sgml docs/trunk/rexxpg/tour.sgml docs/trunk/rexxref/classes.sgml docs/trunk/rexxref/collclasses.sgml docs/trunk/rexxref/condtra.sgml docs/trunk/rexxref/dire.sgml docs/trunk/rexxref/dokey.sgml docs/trunk/rexxref/errnum.sgml docs/trunk/rexxref/funct.sgml docs/trunk/rexxref/fundclasses.sgml docs/trunk/rexxref/instrc.sgml docs/trunk/rexxref/intro.sgml docs/trunk/rexxref/iostrms.sgml docs/trunk/rexxref/mig.sgml docs/trunk/rexxref/numarit.sgml docs/trunk/rexxref/oneof.sgml docs/trunk/rexxref/parsingch.sgml docs/trunk/rexxref/preface.sgml docs/trunk/rexxref/provide.sgml docs/trunk/rexxref/resvkey.sgml docs/trunk/rexxref/rexutil.sgml docs/trunk/rexxref/rexxref.sgml docs/trunk/rexxref/secman.sgml docs/trunk/rexxref/spvard.sgml docs/trunk/rexxref/streamclasses.sgml docs/trunk/rexxref/usepcom.sgml docs/trunk/rexxref/utilityclasses.sgml docs/trunk/rexxref/xconcur.sgml docs/trunk/rexxref/xintdeb.sgml docs/trunk/rxftp/rxftp.sgml docs/trunk/rxmath/rxmath.sgml docs/trunk/rxsock/rxsock.sgml docs/trunk/shared/notices.sgml Modified: docs/trunk/buildmachine/legalstuff.sgml =================================================================== --- docs/trunk/buildmachine/legalstuff.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/buildmachine/legalstuff.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Common SGML file for all Open Object Rexx Documentation. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/advcntlc.sgml =================================================================== --- docs/trunk/oodialog/advcntlc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/advcntlc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/basedialog.sgml =================================================================== --- docs/trunk/oodialog/basedialog.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/basedialog.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/buttoncontrols.sgml =================================================================== --- docs/trunk/oodialog/buttoncontrols.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/buttoncontrols.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/categorydialog.sgml =================================================================== --- docs/trunk/oodialog/categorydialog.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/categorydialog.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/comboboxc.sgml =================================================================== --- docs/trunk/oodialog/comboboxc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/comboboxc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/dialogcontrolc.sgml =================================================================== --- docs/trunk/oodialog/dialogcontrolc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/dialogcontrolc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/editcontrolc.sgml =================================================================== --- docs/trunk/oodialog/editcontrolc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/editcontrolc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/listboxc.sgml =================================================================== --- docs/trunk/oodialog/listboxc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/listboxc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/listcontrolc.sgml =================================================================== --- docs/trunk/oodialog/listcontrolc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/listcontrolc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/menus.sgml =================================================================== --- docs/trunk/oodialog/menus.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/menus.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/mesextcl.sgml =================================================================== --- docs/trunk/oodialog/mesextcl.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/mesextcl.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/oodialog.sgml =================================================================== --- docs/trunk/oodialog/oodialog.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/oodialog.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -40,7 +40,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/preface.sgml =================================================================== --- docs/trunk/oodialog/preface.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/preface.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/progressbarc.sgml =================================================================== --- docs/trunk/oodialog/progressbarc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/progressbarc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/propertysheetc.sgml =================================================================== --- docs/trunk/oodialog/propertysheetc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/propertysheetc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/resdialog.sgml =================================================================== --- docs/trunk/oodialog/resdialog.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/resdialog.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/scrollbarc.sgml =================================================================== --- docs/trunk/oodialog/scrollbarc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/scrollbarc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/slidercontrolc.sgml =================================================================== --- docs/trunk/oodialog/slidercontrolc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/slidercontrolc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/standarddialog.sgml =================================================================== --- docs/trunk/oodialog/standarddialog.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/standarddialog.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/staticcontrolc.sgml =================================================================== --- docs/trunk/oodialog/staticcontrolc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/staticcontrolc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/tabcontrolc.sgml =================================================================== --- docs/trunk/oodialog/tabcontrolc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/tabcontrolc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/treecontrolc.sgml =================================================================== --- docs/trunk/oodialog/treecontrolc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/treecontrolc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/oodialog/userdialog.sgml =================================================================== --- docs/trunk/oodialog/userdialog.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/oodialog/userdialog.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: OODialog Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/readme/readme.sgml =================================================================== --- docs/trunk/readme/readme.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/readme/readme.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -11,7 +11,7 @@ # # Description: Open Object Rexx: Release Notes SGML File # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/readme/unix.sgml =================================================================== --- docs/trunk/readme/unix.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/readme/unix.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Release Notes SGML File # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/readme/windows.sgml =================================================================== --- docs/trunk/readme/windows.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/readme/windows.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Release Notes SGML File # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/api.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxpg/classes.sgml =================================================================== --- docs/trunk/rexxpg/classes.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/classes.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxpg/classicapi.sgml =================================================================== --- docs/trunk/rexxpg/classicapi.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/classicapi.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxpg/command.sgml =================================================================== --- docs/trunk/rexxpg/command.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/command.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxpg/concept.sgml =================================================================== --- docs/trunk/rexxpg/concept.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/concept.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under @@ -431,5 +431,6 @@ </mediaobject> </figure> </section> +</section> </chapter> Modified: docs/trunk/rexxpg/meet.sgml =================================================================== --- docs/trunk/rexxpg/meet.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/meet.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxpg/preface.sgml =================================================================== --- docs/trunk/rexxpg/preface.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/preface.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxpg/provide.sgml =================================================================== --- docs/trunk/rexxpg/provide.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/provide.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under @@ -374,7 +374,7 @@ </figure> <figure float="1"> -<title id="meths7">Classes and Inheritance (part 8 of 9)</title> +<title id="meths8">Classes and Inheritance (part 8 of 9)</title> <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> @@ -384,7 +384,7 @@ </figure> <figure float="1"> -<title id="meths7">Classes and Inheritance (part 9 of 9)</title> +<title id="meths9">Classes and Inheritance (part 9 of 9)</title> <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> @@ -693,7 +693,6 @@ ]]> </programlisting> </section> -</section> <section id="types"><title>Types of Classes</title> <para>In Rexx there are four class types: </para> Modified: docs/trunk/rexxpg/rexio.sgml =================================================================== --- docs/trunk/rexxpg/rexio.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/rexio.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxpg/rexxpg.sgml =================================================================== --- docs/trunk/rexxpg/rexxpg.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/rexxpg.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -24,7 +24,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxpg/rxruntime.sgml =================================================================== --- docs/trunk/rexxpg/rxruntime.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/rxruntime.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxpg/samples.sgml =================================================================== --- docs/trunk/rexxpg/samples.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/samples.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxpg/tour.sgml =================================================================== --- docs/trunk/rexxpg/tour.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxpg/tour.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Programming Guide SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/classes.sgml =================================================================== --- docs/trunk/rexxref/classes.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/classes.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/collclasses.sgml =================================================================== --- docs/trunk/rexxref/collclasses.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/collclasses.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/condtra.sgml =================================================================== --- docs/trunk/rexxref/condtra.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/condtra.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/dire.sgml =================================================================== --- docs/trunk/rexxref/dire.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/dire.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/dokey.sgml =================================================================== --- docs/trunk/rexxref/dokey.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/dokey.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/errnum.sgml =================================================================== --- docs/trunk/rexxref/errnum.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/errnum.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/funct.sgml =================================================================== --- docs/trunk/rexxref/funct.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/funct.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/fundclasses.sgml =================================================================== --- docs/trunk/rexxref/fundclasses.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/fundclasses.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/instrc.sgml =================================================================== --- docs/trunk/rexxref/instrc.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/instrc.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/intro.sgml =================================================================== --- docs/trunk/rexxref/intro.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/intro.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/iostrms.sgml =================================================================== --- docs/trunk/rexxref/iostrms.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/iostrms.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/mig.sgml =================================================================== --- docs/trunk/rexxref/mig.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/mig.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/numarit.sgml =================================================================== --- docs/trunk/rexxref/numarit.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/numarit.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/oneof.sgml =================================================================== --- docs/trunk/rexxref/oneof.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/oneof.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/parsingch.sgml =================================================================== --- docs/trunk/rexxref/parsingch.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/parsingch.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/preface.sgml =================================================================== --- docs/trunk/rexxref/preface.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/preface.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/provide.sgml =================================================================== --- docs/trunk/rexxref/provide.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/provide.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/resvkey.sgml =================================================================== --- docs/trunk/rexxref/resvkey.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/resvkey.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/rexutil.sgml =================================================================== --- docs/trunk/rexxref/rexutil.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/rexutil.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/rexxref.sgml =================================================================== --- docs/trunk/rexxref/rexxref.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/rexxref.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -45,7 +45,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/secman.sgml =================================================================== --- docs/trunk/rexxref/secman.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/secman.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/spvard.sgml =================================================================== --- docs/trunk/rexxref/spvard.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/spvard.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/streamclasses.sgml =================================================================== --- docs/trunk/rexxref/streamclasses.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/streamclasses.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/usepcom.sgml =================================================================== --- docs/trunk/rexxref/usepcom.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/usepcom.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/utilityclasses.sgml =================================================================== --- docs/trunk/rexxref/utilityclasses.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/utilityclasses.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/xconcur.sgml =================================================================== --- docs/trunk/rexxref/xconcur.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/xconcur.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rexxref/xintdeb.sgml =================================================================== --- docs/trunk/rexxref/xintdeb.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rexxref/xintdeb.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Open Object Rexx: Reference SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rxftp/rxftp.sgml =================================================================== --- docs/trunk/rxftp/rxftp.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rxftp/rxftp.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -12,7 +12,7 @@ # # Description: Open Object Rexx: FTP Class Library SGML File # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rxmath/rxmath.sgml =================================================================== --- docs/trunk/rxmath/rxmath.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rxmath/rxmath.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -12,7 +12,7 @@ # # Description: Open Object RexxMath Library Functions SGML file. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/rxsock/rxsock.sgml =================================================================== --- docs/trunk/rxsock/rxsock.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/rxsock/rxsock.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -13,7 +13,7 @@ # # Description: Open Object Rexx: RxSock TCP/IP Socket Functions Reference # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under Modified: docs/trunk/shared/notices.sgml =================================================================== --- docs/trunk/shared/notices.sgml 2009-02-15 17:05:09 UTC (rev 4166) +++ docs/trunk/shared/notices.sgml 2009-02-15 17:10:53 UTC (rev 4167) @@ -2,7 +2,7 @@ # # Description: Common SGML file for all Open Object Rexx Documentation. # - # Copyright (c) 2005-2007, Rexx Language Association. All rights reserved. + # Copyright (c) 2005-2009, Rexx Language Association. All rights reserved. # Portions Copyright (c) 2004, IBM Corporation. All rights reserved. # # This program and the accompanying materials are made available under @@ -46,7 +46,7 @@ <para>Any reference to a non-open source product, program, or service is not intended to state or imply that only non-open source product, program, or service may be used. Any functionally equivalent -product, program, or service that does not infringe any +product, program, or service that does not infringe any Rexx Language Association (RexxLA) intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-15 20:36:25
|
Revision: 4169 http://oorexx.svn.sourceforge.net/oorexx/?rev=4169&view=rev Author: bigrixx Date: 2009-02-15 20:36:21 +0000 (Sun, 15 Feb 2009) Log Message: ----------- fix syntax errors Modified Paths: -------------- docs/trunk/rexxpg/provide.sgml docs/trunk/rexxref/provide.sgml Modified: docs/trunk/rexxpg/provide.sgml =================================================================== --- docs/trunk/rexxpg/provide.sgml 2009-02-15 20:30:30 UTC (rev 4168) +++ docs/trunk/rexxpg/provide.sgml 2009-02-15 20:36:21 UTC (rev 4169) @@ -719,8 +719,8 @@ the object has, and the object instance completes the job of constructing the object. </para> <para> -The <link linkend="clsString">String class</link> and the -<link linkend="clsArray">Array Class</link>) +The String class and the +Array Class are examples of object classes.</para> </section> @@ -736,7 +736,7 @@ methods to other classes are called <emphasis>mixin classes</emphasis>, or simply mixins.</para> <para>You can add mixin methods to an existing class by sending an INHERIT -message or using the INHERIT option on the <link linkend="clasdi">::CLASS directive</link>. +message or using the INHERIT option on the ::CLASS directive. In either case, the class to be inherited must be a mixin. During both class creation and multiple inheritance, subclasses inherit both class and instance methods from their superclasses.</para> @@ -771,7 +771,7 @@ </para> </section> -<section id="xmetac"><title>Metaclasses</title> +<section id="meta"><title>Metaclasses</title> <indexterm><primary>metaclasses</primary></indexterm> <indexterm><primary>class</primary> <secondary>types</secondary> @@ -784,7 +784,7 @@ objects.</para> <para>To change the behavior of an object that is an instance, you generally use subclassing. For example, you can create Statarray, a subclass of the -<link linkend="clsArray">Array class</link>). +Array class. The statArray class can include a method for computing a total of all the numeric elements of an array.</para> <programlisting> @@ -795,7 +795,6 @@ ::method init /* Initialize running total and forward to superclass */ expose total total = 0 - /* <link linkend="mthMessageNew">init</link> describes the init method. */ forward class (super) ::method put /* Modify to increment running total */ Modified: docs/trunk/rexxref/provide.sgml =================================================================== --- docs/trunk/rexxref/provide.sgml 2009-02-15 20:30:30 UTC (rev 4168) +++ docs/trunk/rexxref/provide.sgml 2009-02-15 20:36:21 UTC (rev 4169) @@ -96,7 +96,7 @@ </para> <para> The <link linkend="clsString">String class</link> and the -<link linkend="clsArray">Array Class</link>) +<link linkend="clsArray">Array Class</link> are examples of object classes.</para> </section> @@ -160,7 +160,7 @@ objects.</para> <para>To change the behavior of an object that is an instance, you generally use subclassing. For example, you can create Statarray, a subclass of the -<link linkend="clsArray">Array class</link>). +<link linkend="clsArray">Array class</link>. The statArray class can include a method for computing a total of all the numeric elements of an array.</para> <programlisting> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <bi...@us...> - 2009-02-22 15:00:04
|
Revision: 4205 http://oorexx.svn.sourceforge.net/oorexx/?rev=4205&view=rev Author: bigrixx Date: 2009-02-22 14:59:57 +0000 (Sun, 22 Feb 2009) Log Message: ----------- editorial updates Modified Paths: -------------- docs/trunk/buildmachine/ooRexxBuild.sgml docs/trunk/oodialog/preface.sgml docs/trunk/ootest/ootest.sgml docs/trunk/rexxpg/api.sgml docs/trunk/rexxref/intro.sgml docs/trunk/rexxref/preface.sgml Modified: docs/trunk/buildmachine/ooRexxBuild.sgml =================================================================== --- docs/trunk/buildmachine/ooRexxBuild.sgml 2009-02-21 14:53:10 UTC (rev 4204) +++ docs/trunk/buildmachine/ooRexxBuild.sgml 2009-02-22 14:59:57 UTC (rev 4205) @@ -69,15 +69,6 @@ <para>This book is intended to document the release build environment for ooRexx. It is a complete description of the build machine environment as well as a user guide to building ooRexx releases using the build machine.</para> - -<section><title>A Note About Program Examples in this Document</title> -<para>The program examples in this document are rendered in a mono-spaced -font that is not completely compatible for cut-and-paste functionality. -Pasteing text into an editor could result in some characters outside of -the standard ASCII character set. Specifically, single-qoute and -double-quote characters are sometimes converted incorrectly when -pasted into an editor.</para> -</section> </preface> <chapter><title>Release Build Environment Description</title> Modified: docs/trunk/oodialog/preface.sgml =================================================================== --- docs/trunk/oodialog/preface.sgml 2009-02-21 14:53:10 UTC (rev 4204) +++ docs/trunk/oodialog/preface.sgml 2009-02-22 14:59:57 UTC (rev 4205) @@ -216,16 +216,6 @@ </programlisting> </section> -<section><title>A Note About Program Examples in this Document</title> -<para>The program examples in this document are rendered in a mono-spaced -font that is not completely compatible for cut-and-paste functionality. -Pasteing text into an editor could result in some characters outside of -the standard ASCII character set. Specifically, single-qoute and -double-quote characters are sometimes converted incorrectly when -pasted into an editor.</para> - -</section> - &gethelp; </chapter> Modified: docs/trunk/ootest/ootest.sgml =================================================================== --- docs/trunk/ootest/ootest.sgml 2009-02-21 14:53:10 UTC (rev 4204) +++ docs/trunk/ootest/ootest.sgml 2009-02-22 14:59:57 UTC (rev 4205) @@ -197,16 +197,6 @@ </programlisting> </section> -<section><title>A Note About Program Examples in this Document</title> -<para>The program examples in this document are rendered in a mono-spaced -font that is not completely compatible for cut-and-paste functionality. -Pasting text into an editor could result in some characters outside of -the standard ASCII character set. Specifically, single-quote and -double-quote characters are sometimes converted incorrectly when -pasted into an editor.</para> - -</section> - &gethelp; </preface> Modified: docs/trunk/rexxpg/api.sgml =================================================================== --- docs/trunk/rexxpg/api.sgml 2009-02-21 14:53:10 UTC (rev 4204) +++ docs/trunk/rexxpg/api.sgml 2009-02-22 14:59:57 UTC (rev 4205) @@ -1478,9 +1478,252 @@ </para></listitem></varlistentry> </variablelist> </section> + +<section id="cself"><title>Pointer, Buffer, and CSELF</title> +<para>Methods written in C++ frequently need to acquire access to data that is associated +with an object instance. ooRexx provides two classes, Buffer and Pointer, that allow +these associations to be made. Both classes are real Rexx classes that can be passed +as arguments, returned as method results, and assigned to object instance variables. For +the Rexx prgrammer who might encounter one of these instances, these are opaque objects that +don't appear to be of much use. To the native library writer, the usefulness derives from +what's stored inside these objects.</para> +<section id="clsBuffer"><title>The Buffer class</title> +<para>The Buffer class allows the library writer to allocate blocks of memory from the +Rexx object space. The memory is a part of the Buffer object instance, and will be reclaimed +automatically when the Buffer object is garbage collected. This means the programmer does not +need to explicitly release a Buffer object, this is handled automatically. It does, however, +require that steps be taken to protect the Buffer object from garbage collection while it is +still needed. The usual protection mechanism it to store the buffer object in an object +instance variable using <link linkend="mthSetObjectVariable">SetObjectVariable()</link>. Once +assigned to a variable, the Buffer is protected from garbage collection until its associated +object instance is also reclaimed. The buffer is part of the persistent state of the +the object.<para> +<para>Buffer objects are allocated using the <link linkend="mthNewBuffer">NewBuffer()</link> that's part +of the RexxThreadContext interface. Once created, you access the Buffer's data area using +<link linkend="mthBufferData">BufferData()</link>, which returns a pointer to the beginning of the +data buffer. The data buffer area is writeable storage, into which any data may be placed. This +is frequently used to allocate a C++ struct or class instance that is the native embodiment of the +class implementation. For example</para> +<programlisting> +<![CDATA[ +RexxMethod0(RexxObjectPtr, myclass_init) +{ + // create a buffer for my internal data. + RexxBufferObject data = context->NewBuffer(sizeof(MyDataClass)); + // store this someplace safe + context->SetObjectVariable("MYDATA", data); + // get access to the data area + void *dataPtr = context->BufferData(data); + // construct a C++ object in place in the buffer + MyDataClass *myData = new (dataPtr) MyDataClass(); + // initialize the data below + ... + + return NULLOBJECT; +} +]]> +</programlisting> +<para>This example allocates a Buffer object instance, creates a C++ class in its data area, and +stores a reference to the Buffer in the MYDATA object variable. Other C++ methods can access +this instance by using the C++ equivalent to the Rexx EXPOSE instruction.</para> +<programlisting> +<![CDATA[ +RexxMethod0(RexxObjectPtr, myclass_dosomething) +{ + // retrieve my instance buffer + RexxBufferObject data = (RexxBufferObject)context->GetObjectVariable("MYDATA"); + // Get the data pointer and cast it back to my class type + MyDataClass *myData = (MyDataClass *)context->BufferData(data); + // perform the operation below + ... +} +]]> +</programlisting> +<para>Since Buffer object instances are reclaimed automatically when the object +is gabage collected, no additional steps are required to cleanup that memory. +However, if there are additional dymanically allocated resources associated with +the Buffer, such as pointers to system allocated resources or dynamically allocated +memory, it may be necessary to add an UNINIT method to your class to ensure the +resources are not leaked.</para> +<programlisting> +<![CDATA[ +RexxMethod0(RexxObjectPtr, myclass_uninit) +{ + // retrieve my instance buffer + RexxBufferObject data = context->GetObjectVariable("MYDATA"); + // Get the data pointer and cast it back to my class type + MyDataClass *myData = (MyDataClass *)context->BufferData(data); + // delete any resources I've obtained (but not the MyDataClass + // instance itself + delete ((void *)myData) myData; +} +]]> +</programlisting> </section> +<section id="clsPointer"><title>The Pointer class</title> +<para>The Pointer class has similar uses as the Buffer class, but Pointer instances +only hold a single pointer value to native C/C++ resources. A Pointer instance is +effectively a Buffer object where the buffer data area is a single void * pointer. +Like Buffer objects, Pointers can be stored in Rexx variables and retrieved in +native methods. Pointer object instances are garbage collected just like Buffer +objects, but when a Pointer is reclaimed, whatever values refererenced by the +Pointer instance are not cleaned up. If additional cleanup is required, then +it will be necessary to implement an UNINIT method to handle the cleanup. Here +are the Buffer examples above reworked for the Pointer class:</para> +<programlisting> +<![CDATA[ +RexxMethod0(RexxObjectPtr, myclass_init) +{ + // construct a C++ object to associate with the object + MyDataClass *myData = new MyDataClass(); + // create a Pointer to store this in the object + RexxPointerObject data = context->NewPointer(myData); + // store this someplace safe + context->SetObjectVariable("MYDATA", data); + // initialize the data below + ... + + return NULLOBJECT; +} + + +RexxMethod0(RexxObjectPtr, myclass_dosomething) +{ + // retrieve my instance data + RexxPointerObject data = (RexxPointerObject)context->GetObjectVariable("MYDATA"); + // Get the data pointer and cast it back to my class type + MyDataClass *myData = (MyDataClass *)context->PointerValue(data); + // perform the operation below + ... +} + + +RexxMethod0(RexxObjectPtr, myclass_uninit) +{ + // retrieve my instance data + RexxPointerObject data = (RexxPointerObject)context->GetObjectVariable("MYDATA"); + // Get the data pointer and cast it back to my class type + MyDataClass *myData = (MyDataClass *)context->PointerValue(data); + // delete the backing instance + delete myData; +} +]]> +</programlisting> </section> +<section id="clsPointer"><title>The POINTER method type</title> +<para>The Rexx runtime has some special support for Pointer and Buffer objects +when they are passed as method arguments and also when used as return values. The +RexxMethod macros used to define method instances support the POINTER special argument +type. When an argument is defined as a POINTER, then the argument value must be either +a Buffer object or a Pointer object. The Rexx runtime will automatically pass this +argument to the native method as the Buffer BufferData() value or the Pointer PointerValue() +value, thus removing the need to unwrapper these in the method code. The POINTER type +is generally used for private methods of a class where the Rexx versions of the methods +pass Pointer or Buffer references to the private native code. For example, the Rexx +code might look like this:</para> +<programlisting> +::method setTitle + expose title prefix handle + use arg title + // set the title to the title concatenated to the prefix + self~privateSetTitle(handle, prefix title) +::method privateSetTitle PRIVATE EXTERNAL "LIBRARY mygui setTitle" +</programlisting> +<para>The corresponding C++ method would look like this: +<programlisting> +<![CDATA[ +RexxMethod2(RexxObjectPtr, setTitle, POINTER, handle, CSTRING, title) +{ + // the pointer object was unwrapped for me + MyWindowHandle *myHandle = (MyWindowHandle *)handle; + + // other stuff here +} +]]> +</programlisting> +<para>When POINTER is used as a method return type, the runtime will automatically +create a Pointer object instance that wrappers the returned void *value. The created +Pointer instance is the result returned to the Rexx code.</para> +</section> +<section id="clsPointer"><title>The POINTER method type</title> +<para>There's one additional concept using Pointer and Buffer objects supported by the +C++ APIs. When a method definition specifies the special type CSELF, the runtime will +look for an object variable named CSELF. If the variable is found, and if the variable +is assigned to an instance of Pointer or Buffer, then the corresponding data pointer +is returned as the argument. The CSELF is most useful when just a single anchor to +native C++ data is backing an object instance and the backing data is created in the +object INIT method. Here's the Pointer example above reworked to use CSELF:</para> +<programlisting> +<![CDATA[ +RexxMethod0(RexxObjectPtr, myclass_init) +{ + // construct a C++ object to associate with the object + MyDataClass *myData = new MyDataClass(); + // create a Pointer to store this in the object + RexxPointerObject data = context->NewPointer(myData); + // assign this to the special CSELF variable + context->SetObjectVariable("CSELF", data); + // initialize the data below + ... + + return NULLOBJECT; +} + + +RexxMethod1(RexxObjectPtr, myclass_dosomething, CSELF, cself) +{ + // We can just cast this to our data value + MyDataClass *myData = (MyDataClass *)cself; + // perform the operation below + ... +} + + +RexxMethod1(RexxObjectPtr, myclass_uninit, CSELF, cself) +{ + // We can just cast this to our data value + MyDataClass *myData = (MyDataClass *)cself; + // delete the backing instance + delete myData; +} +]]> +</programlisting> +<para>Using the CSELF argument type eliminates the need to directly +access the Rexx variable used to anchor the value in every method except +the INIT method. This produces generally smaller code and more reliable too +since the runtime is managing the retrieval.</para> +<para>There are other advantages to using the CSELF convention. +The example above is equivalent to the examples using Pointer and Buffer +objects. If, however, you were to create a subclass of the Buffer example and +try to access the value stored in MYDATA from a subclass method, you'll find that +GetObjectVariable("MYDATA") will return NULLOBJECT. The GetObjectVariable() method +retrieves variables from the current method's variable scope. Since the INIT method +that set MYDATA originally and the subclass method that wishes to access the data +are defined at different class scopes, GetObjectVariable() will access different variable +pools and MYDATA will not be found. One solution would be to create a private +attributed method in the base class:</para> +<programlisting> +::attribute mydata get private +</programlisting> +<para>The subclass method can then access the method using <link linkend="mthSendMessage0">SendMessage0()</link> +to access the value.</para> +<programlisting> +RexxPointerObject = context->SendMessage0("MYDATA"); +</programlisting> +<para>The CSELF type handles this detail automatically. When used as an argument, +all variable scopes of the object's class hiearchy are searched for a variable named CSELF. +if one is located, it will be used for the value passed to the method. This allows all subclasses +of a class using the CSELF convention to access the backing native data. +</para> +<para>Frequently, one class instance might need access to the native information associated with another +object instance. The other object instance might be of the same class or another class that is designed +to interoperate with the current class. The <link linkend="mthObjectToCSelf">ObjectToCSelf()</link> allows +the CSELF information for an object other than the current active object to be retieved.</para> +</section> +</section> +</section> + <section id="exitsapi"><title>Rexx Exits Interface</title> <indexterm><primary>exits</primary></indexterm> <indexterm><primary>application programming interfaces</primary> Modified: docs/trunk/rexxref/intro.sgml =================================================================== --- docs/trunk/rexxref/intro.sgml 2009-02-21 14:53:10 UTC (rev 4204) +++ docs/trunk/rexxref/intro.sgml 2009-02-22 14:59:57 UTC (rev 4205) @@ -53,10 +53,14 @@ <listitem><para>Prototyping</para></listitem> <listitem><para>Personal computing</para></listitem> </itemizedlist></para> -<para> As an object-oriented language, Rexx provides, for example, data +<para> As an object-oriented language, Rexx provides data encapsulation, polymorphism, an object class hierarchy, class-based inheritance of methods, -and concurrency. Object Rexx is compatible with earlier Rexx versions. It +and concurrency. It includes a number of useful base classes and allows you +create new object classes of your own.</para> +<para> +Open Object Rexx is compatible with earlier, +non-object based Rexx versions. It has the usual structured-programming instructions, for example IF, SELECT, DO WHILE, and LEAVE, and a number of useful built-in functions.</para> <para>The language imposes few restrictions @@ -64,20 +68,12 @@ <indexterm><primary>restrictions</primary> <secondary>in programming</secondary></indexterm> on the program format. There can be more than one clause on a line, or a single -clause can occupy more than one line. Indentation is allowed. You can, +clause can occupy more than one line. Any indentation scheme is allowed. You can, therefore, code programs in a format that emphasizes their structure, making them easier to read.</para> <para>There is no limit to the size of variable values, as long as all values fit into the storage available. There are no restrictions on the types of data that variables can contain.</para> -<para>The limit on the length of symbols (variable names) is 250 characters. -You can use compound symbols, such as </para> -<programlisting> -NAME.Y.Z -</programlisting> -<para>where <varname>Y</varname> and <varname>Z</varname> can be the names -of variables or can -be constant symbols, for constructing arrays and for other purposes.</para> <indexterm><primary>execution</primary> <secondary>by language processor</secondary></indexterm> <indexterm><primary>language</primary> @@ -100,8 +96,9 @@ <para>Real-world objects, such as a company's employees, money in a bank account, or a report, are stored as data so the computer can act upon it. For example, when you print a report, print is the action -and report is the object acted upon. Often several actions apply; you could -also send or erase the report.</para> +and report is the object acted upon. Essentially, the objects are the +"nouns", while the actions are the "verbs". +</para> </section> <section id="module"><title>Modularizing Data</title> @@ -111,8 +108,10 @@ <para> In conventional, structured programming, actions like print are often isolated from the data by placing them in subroutines or modules. A module typically contains an operation for implementing one simple action. -You might have a PRINT module, a SEND module, an ERASE module. These actions -are independent of the data they operate on.</para> +You might have a PRINT module, a SEND module, an ERASE module. The data these +modules operate on must be constructed by the programmer and passed in to the +modules. +</para> <mediaobject> <imageobject> @@ -123,7 +122,9 @@ <para>But with object-oriented programming, it is the data that is modularized. And each data module includes its own operations for performing actions directly -related to its data.</para> +related to its data. The programmer that uses the objects need only be aware of the +operations an object performs and not how the data is organized internall. +</para> <figure><title>Modular Data—a Report Object</title> <mediaobject> @@ -176,9 +177,11 @@ strings, collections, and input and output streams. An object—such as a character string—always consists of two parts: the possible actions or operations related to it, and its characteristics or variables. A variable -has a variable <emphasis>name</emphasis>, and an associated data value -that can change over time. These actions and characteristics are so closely -associated that they cannot be separated:</para> +has a <emphasis>name</emphasis>, and an associated data value +that can change over time. +The variables represent the internal state of the object, and can be directly +accessed only by the code that implementes the object's actions. +</para> <figure><title>Ball Object with Variable Names and Values</title> <mediaobject> @@ -203,7 +206,7 @@ characteristics of an object are its <indexterm><primary>variables</primary> <secondary>in objects</secondary></indexterm> -<emphasis>variables</emphasis>. Variables are associated +<emphasis>variables</emphasis>. The variables are associated with an object and exist for the lifetime of that object:</para> <figure><title>Encapsulated 5 Object</title> @@ -215,11 +218,6 @@ </mediaobject> </figure> -<para>Rexx comes with a basic set of classes for creating objects (see -<link linkend="provide">Objects and Classes</link>). Therefore, you can create -objects that exactly match the needs of a particular application.</para> -</section> - <section id="interac"><title>How Objects Interact</title> <indexterm><primary>messages</primary></indexterm> <para>The actions within an object Modified: docs/trunk/rexxref/preface.sgml =================================================================== --- docs/trunk/rexxref/preface.sgml 2009-02-21 14:53:10 UTC (rev 4204) +++ docs/trunk/rexxref/preface.sgml 2009-02-22 14:59:57 UTC (rev 4205) @@ -188,16 +188,6 @@ </programlisting> </section> -<section><title>A Note About Program Examples in this Document</title> -<para>The program examples in this document are rendered in a mono-spaced -font that is not completely compatible for cut-and-paste functionality. -Pasting text into an editor could result in some characters outside of -the standard ASCII character set. Specifically, single-quote and -double-quote characters are sometimes converted incorrectly when -pasted into an editor.</para> - -</section> - &gethelp; </preface> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |