Enhancement methods - Revision history

Dme: /* Invoking a Local Alias of an enhancement method */

2017-07-25T23:31:51Z

Invoking a Local Alias of an enhancement method

← Older revision		Revision as of 23:31, 25 July 2017
Line 196:		Line 196:

	===Invoking a Local Alias of an enhancement method===		===Invoking a Local Alias of an enhancement method===
	You can also define a [[Local and Common entities#Local aliases\|~~local alias~~]] of an enhancement method, and invoke the enhancement method using the alias:		You can also define a <var>[[Local and Common entities#Local aliases\|Local Alias]]</var> of an enhancement method, and invoke the enhancement method using the alias:

	<p class="code">local alias (stringlist):everyOther for (+utility)everyOther		<p class="code">local alias (stringlist):everyOther for (+utility)everyOther

Dme: /* Invoking a Local Alias of an enhancement method */

2017-07-25T23:30:54Z

Invoking a Local Alias of an enhancement method

← Older revision		Revision as of 23:30, 25 July 2017
Line 198:		Line 198:
	You can also define a [[Local and Common entities#Local aliases\|local alias]] of an enhancement method, and invoke the enhancement method using the alias:		You can also define a [[Local and Common entities#Local aliases\|local alias]] of an enhancement method, and invoke the enhancement method using the alias:

	<p class="code">local alias %(stringlist):everyOther for (+utility)everyOther		<p class="code">local alias (stringlist):everyOther for (+utility)everyOther
	...		...
	%mylist:everyOther:print		%mylist:everyOther:print

JAL: /* Invoking a Local Alias of an enhancement method */ one-word change

2015-09-21T16:00:03Z

Invoking a Local Alias of an enhancement method: one-word change

← Older revision		Revision as of 16:00, 21 September 2015
Line 203:		Line 203:
	</p>		</p>

	~~Which~~ results in a much more natural calling syntax, as though the user-written enhancement method were an integral component of the enhanced class.		This results in a much more natural calling syntax, as though the user-written enhancement method were an integral component of the enhanced class.

	==Enhancement methods and inheritance==		==Enhancement methods and inheritance==

Alan: /* Invoking a Local Alias of an enhancement method */

2015-09-18T17:47:35Z

Invoking a Local Alias of an enhancement method

← Older revision		Revision as of 17:47, 18 September 2015
Line 200:		Line 200:
	<p class="code">local alias %(stringlist):everyOther for (+utility)everyOther		<p class="code">local alias %(stringlist):everyOther for (+utility)everyOther
	...		...
	%mylist:~~(+utility)~~everyOther:print		%mylist:everyOther:print
	</p>		</p>

			Which results in a much more natural calling syntax, as though the user-written enhancement method were an integral component of the enhanced class.

	==Enhancement methods and inheritance==		==Enhancement methods and inheritance==

Dme: /* Enhancement method invocation syntax */

2015-08-29T20:24:41Z

Enhancement method invocation syntax

← Older revision		Revision as of 20:24, 29 August 2015
Line 194:		Line 194:
	This chain of methods can be read from left to right		This chain of methods can be read from left to right
	rather than from the inside out.		rather than from the inside out.

			===Invoking a Local Alias of an enhancement method===
			You can also define a [[Local and Common entities#Local aliases\|local alias]] of an enhancement method, and invoke the enhancement method using the alias:

			<p class="code">local alias %(stringlist):everyOther for (+utility)everyOther
			...
			%mylist:(+utility)everyOther:print
			</p>

	==Enhancement methods and inheritance==		==Enhancement methods and inheritance==

JAL: /* Enhancement method invocation syntax */

2014-06-27T18:35:35Z

Enhancement method invocation syntax

← Older revision		Revision as of 18:35, 27 June 2014
Line 137:		Line 137:
	</th><td>An object variable of the class against which the enhancement method operates.		</th><td>An object variable of the class against which the enhancement method operates.
	</td></tr>		</td></tr>

	<tr><th>+containerClass		<tr><th>+containerClass
	</th><td>The name of the class that contains the enhancement method definition. Note that the class name must be preceded by a plus sign (<tt>+</tt>) to indicate an enhancement method invocation. The plus sign distinguishes an enhancement method container class name from other uses of class names inside parentheses that might appear in the same context.		</th><td>The name of the class that contains the enhancement method definition. Note that the class name must be preceded by a plus sign (<tt>+</tt>) to indicate an enhancement method invocation. The plus sign distinguishes an enhancement method container class name from other uses of class names inside parentheses that might appear in the same context.
	</td></tr>		</td></tr>

	<tr><th>name		<tr><th>name
	</th><td>The name of the enhancement method.		</th><td>The name of the enhancement method.
	</td></tr>		</td></tr>
	<tr><th>~~parameters~~
			<tr><th>arguments
	</th><td>Any arguments the enhancement method might take as input. Optional, default, and named parameters work exactly the same way with enhancement methods as with any other methods.		</th><td>Any arguments the enhancement method might take as input. Optional, default, and named parameters work exactly the same way with enhancement methods as with any other methods.
	</td></tr></table>		</td></tr></table>
Line 191:		Line 194:
	This chain of methods can be read from left to right		This chain of methods can be read from left to right
	rather than from the inside out.		rather than from the inside out.

	==Enhancement methods and inheritance==		==Enhancement methods and inheritance==
	Enhancement methods are never automatically inherited by extension		Enhancement methods are never automatically inherited by extension

JAL: /* Enhancement methods and inheritance */

2013-10-22T20:25:38Z

Enhancement methods and inheritance

JAL at 20:18, 22 October 2013

2013-10-22T20:18:00Z

← Older revision		Revision as of 20:18, 22 October 2013
Line 6:		Line 6:
	[[Classes and Objects#Declaration blocks\|public and private]]		[[Classes and Objects#Declaration blocks\|public and private]]
	variables in the class.		variables in the class.
	For system classes, this data is hidden from <var class="product">~~User Language~~</var> programs, but it is		For system classes, this data is hidden from <var class="product">SOUL</var> programs, but it is
	stored more or less identically to <var class="product">~~User Language~~</var> variables.		stored more or less identically to <var class="product">SOUL</var> variables.
	<li>The operations that can be performed on objects of that class.		<li>The operations that can be performed on objects of that class.
	These operations are the methods		These operations are the methods
Line 18:		Line 18:
	on objects of the class that are ''not'' one of the standard methods		on objects of the class that are ''not'' one of the standard methods
	provided by the class.		provided by the class.
	Before <var class="product">Sirius Mods</var> version 7.2, there were three ways of addressing this:		<!-- Before <var class="product">Sirius Mods</var> version 7.2 -->
			Before the introduction of enhancement methods, there were three ways of addressing this:
	<ol>		<ol>
	<li>Add a new method to the class.		<li>Add a new method to the class.
Line 29:		Line 30:
	<ul>		<ul>
	<li>If the class is a system class, new methods cannot be added		<li>If the class is a system class, new methods cannot be added
	using <var class="product">~~User Language~~</var>.		using <var class="product">SOUL</var>.

	<li>If the class belongs to a different group in the organization,		<li>If the class belongs to a different group in the organization,
	it can be problematic getting a new method added.		it can be problematic getting a new method added.

	<li>The method being added might need access to private variables		<li>The method being added might need access to private variables
	in another class, so the method must be added to the other class, not		in another class, so the method must be added to the other class, not
Line 42:		Line 45:
	[[Intrinsic classes\|intrinsic classes]],		[[Intrinsic classes\|intrinsic classes]],
	and XmlNodes are not allowed to be extended.		and XmlNodes are not allowed to be extended.

	<li>It requires changing variable declarations to use the new class.		<li>It requires changing variable declarations to use the new class.
	If the variables, themselves, are parameters, callers might have to be		If the variables, themselves, are parameters, callers might have to be
Line 47:		Line 51:
	This can produce a cascade effect where large chunks of code have to		This can produce a cascade effect where large chunks of code have to
	be changed to add an extra method to a class.		be changed to add an extra method to a class.

	<li>While inheritance is implemented quite efficiently, there '''is'''		<li>While inheritance is implemented quite efficiently, there '''is'''
	a cost in code complexity to using inheritance, and using inheritance		a cost in code complexity to using inheritance, and using inheritance
Line 96:		Line 101:
	</p>		</p>

	<var class="product">Sirius Mods</var> version 7.2 introduced a new type of shared method called an		<!-- <var class="product">Sirius Mods</var> version 7.2 introduced -->
	'''enhancement method''' ~~to provide~~ a better way of invoking a		A new type of shared method called an
			'''enhancement method''' has provided a better way of invoking a
	method on an object of another class.		method on an object of another class.
	Because enhancement methods do not operate on objects of the containing		Because enhancement methods do not operate on objects of the containing
Line 110:		Line 116:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>method		<tr><th>method
	</th><td>The method type — <var>Subroutine</var>, <var>Function</var>, or <var>Property</var>. An enhancement method cannot be a <var>[[~~Janus SOAP User Language Interface~~#constructor\|Constructor]]</var>.		</th><td>The method type — <var>Subroutine</var>, <var>Function</var>, or <var>Property</var>. An enhancement method cannot be a <var>[[Object oriented programming in SOUL#constructor\|Constructor]]</var>.
	</td></tr>		</td></tr>
	<tr><th>class		<tr><th>class
Line 230:		Line 236:
	the containing class, so an enhancement factory method is		the containing class, so an enhancement factory method is
	perfectly suitable.		perfectly suitable.
	==Intrinsic ~~Enhancement~~ methods==
	~~In addition to Enhancement methods, <var class="product">Sirius Mods</var> 7.2 introduced~~		==Intrinsic enhancement methods==
	~~<var class="syntax">[[Intrinsic classes\|Intrinsic]]</var> methods and classes.~~		Just as you can create enhancement methods for other system
	~~And, just~~ as you can create enhancement methods for other system		classes, you can create enhancement methods for the [[Intrinsic classes\|intrinsic]] classes,
	classes, you can create enhancement methods for intrinsic classes,
	specifically for the <var>Float</var> and <var>String</var> classes.		specifically for the <var>Float</var> and <var>String</var> classes.

JAL: /* See also */

2013-10-14T22:15:07Z

JALWiccan: Automatically generated page update

2013-10-14T20:05:21Z

Automatically generated page update

← Older revision		Revision as of 20:05, 14 October 2013
Line 359:		Line 359:

	[[Category:Overviews]]		[[Category:Overviews]]
	[[Category:~~Janus SOAP ULI~~ topics]]		[[Category:SOUL object-oriented programming topics]]

← Older revision		Revision as of 22:15, 14 October 2013
Line 355:		Line 355:
	<li>[[Narrowing assignments and class tests]]		<li>[[Narrowing assignments and class tests]]
	<li>[[Dynamic dispatch]]		<li>[[Dynamic dispatch]]
	<li>[[~~Janus SOAP ULI essentials~~]]		<li>[[Object oriented programming in SOUL]]
	</ul>		</ul>

	[[Category:Overviews]]		[[Category:Overviews]]
	[[Category:SOUL object-oriented programming topics]]		[[Category:SOUL object-oriented programming topics]]

← Older revision		Revision as of 20:25, 22 October 2013
Line 221:		Line 221:
	be applied to objects of class <code>Funnylist</code> without any extra		be applied to objects of class <code>Funnylist</code> without any extra
	qualification.		qualification.
	<br>'''Note:'''		<blockquote class="note">'''Note:'''
	Because an enhancement method is not defined		Because an enhancement method is not defined
	in the class to which the method applies, it cannot reference private		in the class to which the method applies, it cannot reference private
	variables in that class.		variables in that class.
	However, it '''can''' reference private members of instances		However, it '''can''' reference private members of instances
	of objects of the containing class.		of objects of the containing class.
			<p>
	In fact, one typical application for enhancement methods is to		In fact, one typical application for enhancement methods is to
	provide a method for creating a new instance of the containing		provide a method for creating a new instance of the containing
Line 234:		Line 234:
	Such a method might not need to access private members of the		Such a method might not need to access private members of the
	method object class, but it might need to access private members of		method object class, but it might need to access private members of
	the containing class, so an enhancement factory method is		the containing class, so an enhancement factory method is perfectly suitable. </p>
	perfectly suitable.		</blockquote>

	==Intrinsic enhancement methods==		==Intrinsic enhancement methods==