Mixed-case SOUL - Revision history

Dme: /* How to enable and disable: the Sirius Case statement */

2019-08-04T11:41:07Z

How to enable and disable: the Sirius Case statement

← Older revision		Revision as of 11:41, 4 August 2019
Line 142:		Line 142:
	(and so case-insensitivity) with the <var>Sirius Case</var> compiler directive:		(and so case-insensitivity) with the <var>Sirius Case</var> compiler directive:

	<~~p class="code"~~ id="sirCaseSyn">Sirius Case ~~{ToUpper \| Leave~~} ~~</p>~~		<b id="sirCaseSyn"></b>{{Template:Sirius Case statement syntax}}

	Specifying <var>ToUpper</var> requests internal uppercase translation; <var>Leave</var> means no such translation.		Specifying <var>ToUpper</var> requests internal uppercase translation; <var>Leave</var> means no such translation.

JAL: add category

2018-04-20T21:13:17Z

add category

← Older revision		Revision as of 21:13, 20 April 2018
Line 206:		Line 206:
	image-item names are not likely in most applications. </p>		image-item names are not likely in most applications. </p>
	</dl>		</dl>

			[[Category:SOUL]]

JAL: typo

2017-09-15T15:22:03Z

typo

← Older revision		Revision as of 15:22, 15 September 2017
Line 28:		Line 28:
	Mixed case facilitates the use of a coding style common to most object-oriented languages.		Mixed case facilitates the use of a coding style common to most object-oriented languages.

	Historically, <var class="~~Product~~">[[Model 204]]</var> <var class="product">User Language</var> was actually a case-sensitive		Historically, <var class="product">[[Model 204]]</var> <var class="product">User Language</var> was actually a case-sensitive
	language with uppercase keywords.		language with uppercase keywords.
	This means that keywords such as IF, THEN, FOR, ADD, etc. had to be		This means that keywords such as IF, THEN, FOR, ADD, etc. had to be
Line 34:		Line 34:
	There are basically three approaches to providing support for mixed case:		There are basically three approaches to providing support for mixed case:
	<ol>		<ol>
	<li>Case-sensitive with lowercase or mixed-case keywords. This is the approach used in languages such as [http://en.wikipedia.org/wiki/C_%28programming_language%29 C] and [http://en.wikipedia.org/wiki/Java_%28programming_language%29 Java]. Unfortunately, it was too late for this approach in <var class="product">User Language</var> as the language already has case-sensitivity with uppercase keywords. While it might have been possible to use this approach with lowercase variants of all keywords, such an approach would have been complex, and the case-sensitivity for variable names would make migration to mixed-case code extremely difficult as explained in the next item.		<li>Case-sensitive with lowercase or mixed-case keywords. This is the approach used in languages such as [http://en.wikipedia.org/wiki/C_%28programming_language%29 C] and [http://en.wikipedia.org/wiki/Java_%28programming_language%29 Java]. Unfortunately, it was too late for this approach in <var class="product">User Language</var> as the language already has case-sensitivity with uppercase keywords. While it might have been possible to use this approach with lowercase variants of all keywords, such an approach would have been complex, and the case-sensitivity for variable names would make migration to mixed-case code extremely difficult as explained in the next item. </li>

	<li>Case-insensitive for keywords but case-sensitive for variable names. A few languages use this approach, but it is quite complex to implement because it makes case-insensitivity of tokens depend upon context. Furthermore, it makes code migration extremely difficult — all references to a variable must be changed to the correct mixed-case variant at once before any of them can be changed. This can be very difficult to do, especially for ''Common'' variables that are used in many different pieces of code, so it is likely that any case-sensitive approach would result in some variables remaining indefinitely in uppercase.		<li>Case-insensitive for keywords but case-sensitive for variable names. A few languages use this approach, but it is quite complex to implement because it makes case-insensitivity of tokens depend upon context. Furthermore, it makes code migration extremely difficult — all references to a variable must be changed to the correct mixed-case variant at once before any of them can be changed. This can be very difficult to do, especially for ''Common'' variables that are used in many different pieces of code, so it is likely that any case-sensitive approach would result in some variables remaining indefinitely in uppercase. </li>

	<li>Case-insensitivity for keywords and variable names. Because this seemed to provide the best migration path to using mixed case in existing applications, this approach was taken in <var class="product">SOUL</var>. It is probably for these very reasons that many other languages with uppercase keyword roots such as [http://en.wikipedia.org/wiki/Visual_Basic Visual Basic], [http://en.wikipedia.org/wiki/COBOL Cobol], [http://en.wikipedia.org/wiki/Fortran Fortran], and many others have taken the same approach toward providing support for mixed case.		<li>Case-insensitivity for keywords and variable names. Because this seemed to provide the best migration path to using mixed case in existing applications, this approach was taken in <var class="product">SOUL</var>. It is probably for these very reasons that many other languages with uppercase keyword roots such as [http://en.wikipedia.org/wiki/Visual_Basic Visual Basic], [http://en.wikipedia.org/wiki/COBOL Cobol], [http://en.wikipedia.org/wiki/Fortran Fortran], and many others have taken the same approach toward providing support for mixed case. </li>
	</ol>		</ol>
	It is worth noting that, at least in theory, case-insensitive <var class="product">User Language</var> is a major backward compatibility problem.		It is worth noting that, at least in theory, case-insensitive <var class="product">User Language</var> is a major backward compatibility problem.
Line 61:		Line 61:
	variable because they all get internally translated to <code>%CUSTOMER</code> before being processed.		variable because they all get internally translated to <code>%CUSTOMER</code> before being processed.
	Similarly, <code>if</code>, <code>If</code>, and <code>IF</code> all get translated to <code>IF</code> before being compiled.		Similarly, <code>if</code>, <code>If</code>, and <code>IF</code> all get translated to <code>IF</code> before being compiled.
	This translation is useful in allowing reference to existing uppercase fieldnames		This translation is useful in allowing reference to existing uppercase fieldnames in mixed case.
	in mixed case.
	For example, field <code>RECTYPE</code> could be referred to as <code>recType</code> when		For example, field <code>RECTYPE</code> could be referred to as <code>recType</code> when
	case-insensitive <var class="product">SOUL</var> is enabled.		case-insensitive <var class="product">SOUL</var> is enabled.
Line 69:		Line 68:
	they were entered in mixed case.		they were entered in mixed case.

	The following sections summarize the entities affected by uppercase translation		The following sections summarize the entities affected by uppercase translation and describe how to invoke it.
	and describe how to invoke it.

	===What is affected===		===What is affected===
	If <var class="product">SOUL</var> case-insensitivity is enabled, these entities become case-insensitive:		If <var class="product">SOUL</var> case-insensitivity is enabled, these entities become case-insensitive:
	<ul>		<ul>
	<li>'''SOUL keywords'''. For example: <var>For</var>, <var>If</var>, <var>Then</var>, <var>eq</var>.		<li>'''SOUL keywords'''. For example: <var>For</var>, <var>If</var>, <var>Then</var>, <var>eq</var>. </li>

	<li>'''Names of members of SOUL classes'''. For example: [[XmlDoc API]], [[File classes\|File class]], and [[HTTP Helper]] methods and variables.		<li>'''Names of members of SOUL classes'''. For example: [[XmlDoc API]], [[File classes\|File class]], and [[HTTP Helper]] methods and variables. </li>

	<li>'''Variable elements'''. For example: %variables, Screen/Image names and items, Class/Structure members. Note, however, that in this mode you cannot define two variable elements whose names differ only because some letters have different case.		<li>'''Variable elements'''. For example: %variables, Screen/Image names and items, Class/Structure members. Note, however, that in this mode you cannot define two variable elements whose names differ only because some letters have different case. </li>

	<li>'''Labels and subroutine names'''. <p class="note"><b>Note: </b>In this mode, you cannot define two labels whose names differ only because some letters are different case. </p>		<li>'''Labels and subroutine names'''.
			<p class="note"><b>Note: </b>In this mode, you cannot define two labels whose names differ only because some letters are different case. </p></li>

	<li>'''Field names'''. <p class="note"><b>Note: </b>In this mode, you cannot access field names containing lowercase letters. </p>		<li>'''Field names'''.
			<p class="note"><b>Note: </b>In this mode, you cannot access field names containing lowercase letters. </p></li>

	<li>'''$functions'''. <p class="note"><b>Note: </b>In this mode, you cannot access $functions containing lowercase letters. </p>		<li>'''$functions'''.
			<p class="note"><b>Note: </b>In this mode, you cannot access $functions containing lowercase letters. </p></li>

	<li>'''Procedure names''' (on the Include statement). <p class="note"><b>Note: </b>In this mode, you cannot include procedures whose names contain lowercase letters. </p>		<li>'''Procedure names''' (on the Include statement).
			<p class="note"><b>Note: </b>In this mode, you cannot include procedures whose names contain lowercase letters. </p></li>

	<li>'''SOUL object documentation'''. Keywords and variable name references use mixed case. Keywords will generally be indicated by an uppercase first letter.		<li>'''SOUL object documentation'''. Keywords and variable name references use mixed case. Keywords will generally be indicated by an uppercase first letter. </li>
	</ul>		</ul>

Line 115:		Line 117:
	</ul>		</ul>

	<~~div~~ id="sirCaseStmt"></~~div~~>		===<b id="sirCaseStmt"></b>How to enable and disable: the Sirius Case statement===
	~~===~~How to enable and disable: the Sirius Case statement===
	~~<!--Caution: <div> above-->~~

	You can enable case-insensitive <var class="product">SOUL</var> in one of these ways:		You can enable case-insensitive <var class="product">SOUL</var> in one of these ways:
	<ul>		<ul>
Line 192:		Line 191:
	<dt>X'04'		<dt>X'04'
	<dd>If on, image or image-item names, either literal or in variables,		<dd>If on, image or image-item names, either literal or in variables,
	are to be automatically converted to uppercase before being used in methods or		are to be automatically converted to uppercase before being used in methods or $functions.
	$functions.
	Since mixed-case <var class="product">SOUL</var> is accomplished by translating unquoted tokens to		Since mixed-case <var class="product">SOUL</var> is accomplished by translating unquoted tokens to
	uppercase, this case conversion for image or image-item names is the runtime		uppercase, this case conversion for image or image-item names is the runtime
	equivalent of the compiler mixed-case support.		equivalent of the compiler mixed-case support.
	<p>		<p>
	Setting the <var>COMPOPT</var> X'04' bit enables image and image-item names that		Setting the <var>COMPOPT</var> X'04' bit enables image and image-item names that appear as literals in <var class="product">SOUL</var> programs to be entered in mixed case.
	appear as literals in <var class="product">SOUL</var> programs to be entered in mixed case.
	The only time this might be a problem is if there are true mixed-case image		The only time this might be a problem is if there are true mixed-case image
	or image-item names in an application. </p>		or image-item names in an application. </p>

Dme: /* How to enable and disable: the Sirius Case statement */

2017-09-14T14:56:11Z

How to enable and disable: the Sirius Case statement

← Older revision		Revision as of 14:56, 14 September 2017
Line 143:		Line 143:
	(and so case-insensitivity) with the <var>Sirius Case</var> compiler directive:		(and so case-insensitivity) with the <var>Sirius Case</var> compiler directive:

	<p class="code">Sirius Case {ToUpper \| Leave} </p>		<p class="code" id="sirCaseSyn">Sirius Case {ToUpper \| Leave} </p>

	Specifying <var>ToUpper</var> requests internal uppercase translation; <var>Leave</var> means no such translation.		Specifying <var>ToUpper</var> requests internal uppercase translation; <var>Leave</var> means no such translation.

JAL: /* How to enable and disable; the Sirius Case statement */

2015-01-26T17:49:22Z

How to enable and disable; the Sirius Case statement

← Older revision		Revision as of 17:49, 26 January 2015
Line 116:		Line 116:

	<div id="sirCaseStmt"></div>		<div id="sirCaseStmt"></div>
	===How to enable and disable; the Sirius Case statement===		===How to enable and disable: the Sirius Case statement===
	<!--Caution: <div> above-->		<!--Caution: <div> above-->

JAL: /* How to enable and disable; the Sirius Case statement */

2015-01-26T17:48:33Z

How to enable and disable; the Sirius Case statement

← Older revision		Revision as of 17:48, 26 January 2015
Line 121:		Line 121:
	You can enable case-insensitive <var class="product">SOUL</var> in one of these ways:		You can enable case-insensitive <var class="product">SOUL</var> in one of these ways:
	<ul>		<ul>
	<li>Start a program with a mixed-case or lowercase <var>Begin</var> statement.		<li>Start a program with a mixed-case or lowercase <var>Begin</var> statement.</li>

	<li>Use the <code>Sirius Case ToUpper</code> compiler directive.		<li>Use the <code>Sirius Case ToUpper</code> compiler directive.</li>

	<li>Use the <var>[[COMPOPT parameter\|COMPOPT]]</var> system parameter to globally enable case-insensitive <var class="product">SOUL</var>.</li>		<li>Use the <var>[[COMPOPT parameter\|COMPOPT]]</var> system parameter to globally enable case-insensitive <var class="product">SOUL</var>.</li>
Line 140:		Line 140:
	Sometimes, however, one might be working on <var class="product">SOUL</var> that is Included		Sometimes, however, one might be working on <var class="product">SOUL</var> that is Included
	in many outer programs, some of which might not have been converted to		in many outer programs, some of which might not have been converted to
	case-insensitivity yet.		case-insensitivity yet. In such a case, it is possible to enable internal translation to uppercase
			(and so case-insensitivity) with the <var>Sirius Case</var> compiler directive:
	In such a case, it is possible to enable internal translation to uppercase
	(and so case-insensitivity) with the <~~code~~>Sirius Case</~~code~~> compiler directive:

	<p class="code">Sirius Case {ToUpper \| Leave} </p>		<p class="code">Sirius Case {ToUpper \| Leave} </p>

	Specifying <~~code~~>ToUpper</~~code~~> requests internal uppercase translation; <~~code~~>Leave</~~code~~> means no such translation.		Specifying <var>ToUpper</var> requests internal uppercase translation; <var>Leave</var> means no such translation.

	If procedure ''P'' contains a complex subroutine that might		If procedure <code>P</code> contains a complex subroutine that might
	be included in outer procedures, some of which might not have been converted		be included in outer procedures, some of which might not have been converted
	to use case-sensitivity, you can insert a <var>Sirius Case</var> directive		to use case-sensitivity, you can insert a <var>Sirius Case</var> directive
	at the top of procedure:		at the top of the procedure:

	<p class="code">sirius case toUpper		<p class="code">sirius case toUpper

Dme: /* How to enable and disable; the Sirius Case statement */

2015-01-23T23:17:53Z

How to enable and disable; the Sirius Case statement

← Older revision		Revision as of 23:17, 23 January 2015
Line 125:		Line 125:
	<li>Use the <code>Sirius Case ToUpper</code> compiler directive.		<li>Use the <code>Sirius Case ToUpper</code> compiler directive.

	<li>Use the <var>[[COMPOPT parameter\|COMPOPT]]</var> system parameter to globally enable case-insensitive <var class="product">SOUL</var>.		<li>Use the <var>[[COMPOPT parameter\|COMPOPT]]</var> system parameter to globally enable case-insensitive <var class="product">SOUL</var>.</li>
			</ul>

	Because the following programs begin with mixed-case <var>Begin</var> statements,		Because the following programs begin with mixed-case <var>Begin</var> statements,
	they are compiled with case-insensitivity:		they are compiled with case-insensitivity:

Dme: Dme moved page Mixed-case User Language to Mixed-case SOUL

2015-01-22T21:41:21Z

Dme moved page Mixed-case User Language to Mixed-case SOUL

← Older revision	Revision as of 21:41, 22 January 2015
(No difference)

Dme at 21:39, 22 January 2015

2015-01-22T21:39:21Z

← Older revision		Revision as of 21:39, 22 January 2015
Line 115:		Line 115:
	</ul>		</ul>

	===How to enable and disable===		<div id="sirCaseStmt"></div>
			===How to enable and disable; the Sirius Case statement===
			<!--Caution: <div> above-->

	You can enable case-insensitive <var class="product">SOUL</var> in one of these ways:		You can enable case-insensitive <var class="product">SOUL</var> in one of these ways:
	<ul>		<ul>

Dme at 20:04, 19 June 2014

2014-06-19T20:04:41Z

← Older revision		Revision as of 20:04, 19 June 2014
Line 1:		Line 1:
	You can compose a <var class="product">User Language</var> (now <var class="product">SOUL</var>) request in case-insensitive mode.		You can compose a <var class="product">User Language</var> (now <var class="product">SOUL</var>) request in case-insensitive mode.
	When in this mode, all elements of a <var class="product">SOUL</var> program excepting ''literal strings'' are processed after converting lowercase letters to uppercase. <var class="product">SOUL</var> includes enhanced support for mixed case as of <var class="product">Model 204</var> ~~version 7.5~~.		When in this mode, all elements of a <var class="product">SOUL</var> program excepting ''literal strings'' are processed after converting lowercase letters to uppercase. <var class="product">SOUL</var> includes enhanced support for mixed case as of version 7.5 of <var class="product">Model 204</var>.

	===Background===		===Background===