PatchString (Stringlist function) - Revision history

JAL: minor cleanup

2015-02-03T17:25:41Z

minor cleanup

← Older revision		Revision as of 17:25, 3 February 2015
Line 1:		Line 1:
	{{Template:Stringlist:PatchString subtitle}}		{{Template:Stringlist:PatchString subtitle}}

	This method uses Unix-style ~~<var class="term">~~[http://en.wikipedia.org/wiki/Diff diff]~~</var>~~ output to update text lines that are stored in a string. Typically, a <~~var class="term"~~>~~[http://en.wikipedia.org/wiki/Diff~~ diff]</~~var~~> utility creates a report (aka a "patch file") of the differences between two "files," a base file and an updated version of the base file: that is,		This method uses Unix-style [http://en.wikipedia.org/wiki/Diff diff] output to update text lines that are stored in a string. Typically, a <tt>diff</tt> utility creates a report (aka a "patch file") of the differences between two "files," a base file and an updated version of the base file: that is:

	<p class="code">patch = diff(base, updated)		<p class="code">patch = diff(base, updated)
	</p>		</p>

	Depending on which diff utility is used and the command format that creates it, a patch may report the differences between the two files using a line orientation or a character orientation. <var>PatchString</var> supports only a character-oriented patch. <var>PatchString</var> applies a given patch file (converted to a <var>Stringlist</var>) to a base file (converted to a string), returning a string that is the base file updated by the differences contained in the patch file. For working with line-oriented diff output, use the <var>[[Patch (Stringlist function)\|Patch]]</var> or <var>[[PatchLines (Stringlist function)\|PatchLines]]</var>.		Depending on which <tt>diff</tt> utility is used and the command format that creates it, a patch may report the differences between the two files using a line orientation or a character orientation. <var>PatchString</var> supports only a character-oriented patch. <var>PatchString</var> applies a given patch file (converted to a <var>Stringlist</var>) to a base file (converted to a string), returning a string that is the base file updated by the differences contained in the patch file. For working with line-oriented <tt>diff</tt> output, use the <var>[[Patch (Stringlist function)\|Patch]]</var> or <var>[[PatchLines (Stringlist function)\|PatchLines]]</var>.

	The patch file you use is assumed to have the format of a patch from the Google Code <var class="term">[http://code.google.com/p/google-diff-match-patch/ "Diff, Match and Patch Library for Plain Text"]</var>. Only output like that from that API's patch_toText function is supported. Except for being character-oriented, such output looks like unified Gnu diff output format <b><i>without the two header lines</i></b> which contain file names and timestamps, and it has context character strings instead of context lines.		The patch file you use is assumed to have the format of a patch from the Google Code <var class="term">[http://code.google.com/p/google-diff-match-patch/ "Diff, Match and Patch Library for Plain Text"]</var>. Only output like that from that API's <code>patch_toText</code> function is supported. Except for being character-oriented, such output looks like unified Gnu <tt>diff</tt> output format <b><i>without the two header lines</i></b> which contain file names and timestamps, and it has context character strings instead of context lines.

	==Syntax==		==Syntax==
	{{Template:Stringlist:PatchString syntax}}		{{Template:Stringlist:PatchString syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>updString</th>		<tr><th>%updString</th>
	<td>A string to contain the updated version of <var class="term">baseString</var>, the base file. </td></tr>		<td>A string to contain the updated version of <var class="term">baseString</var>, the base file. </td></tr>

	<tr><th>sl</th>		<tr><th>sl</th>
	<td>A <var>Stringlist</var> object that contains the patch file (each line stored as an individual <var class="term">sl</var> item). </td></tr>		<td>A <var>Stringlist</var> object that contains the patch file (each line stored as an individual <var class="term">sl</var> item). </td></tr>

	<tr><th>baseString</th>		<tr><th>baseString</th>
	<td>A string that contains the base file.</td></tr>		<td>A string that contains the base file.</td></tr>

	<tr><th><var>Options</var></th>		<tr><th><var>Options</var></th>
	<td>The optional Options argument (name required) is the string value <code>ErrRet</code>, which may be specified in uppercase or lowercase. If you specify <code>Options='ErrRet'</code>, <var>PatchString</var> method errors return a null <var class="term">updString</var> string and no error message instead of canceling the request. If you do not specify <code>Options='ErrRet'</code> and a method error occurs, you receive an error message and the request is cancelled.</td></tr>		<td>The optional Options argument ([[Notation conventions for methods#Named arguments\|name required]]) is the string value <code>ErrRet</code>, which may be specified in uppercase or lowercase. If you specify <code>Options='ErrRet'</code>, <var>PatchString</var> method errors return a null <var class="term">%updString</var> string and no error message instead of canceling the request. If you do not specify <code>Options='ErrRet'</code> and a method error occurs, you receive an error message and the request is cancelled.</td></tr>
	</table>		</table>

Line 81:		Line 85:
	The program results show the updated version of the base file, preceded by a display of the base file and the patch file. In the base and updated files, the number signs (#), which are added by the CreateLines method, separate the concatenated <var>Stringlist</var> items that constitute the strings.		The program results show the updated version of the base file, preceded by a display of the base file and the patch file. In the base and updated files, the number signs (#), which are added by the CreateLines method, separate the concatenated <var>Stringlist</var> items that constitute the strings.

	<p class="~~code~~">*************Here is base:*************		<p class="output">*************Here is base:*************
	Hamlet: Do you see yonder cloud that's almost in shape of a camel?#Polonius: By the mass, and 'tis like a camel, indeed.#		Hamlet: Do you see yonder cloud that's almost in shape of a camel?#Polonius: By the mass, and 'tis like a camel, indeed.#
	<nowiki>**************Here is patch:*************</nowiki>		<nowiki>**************Here is patch:*************</nowiki>

JAL: /* See also */

2015-02-03T16:12:02Z

JAL: /* Examples */

2012-10-31T19:28:11Z

Examples

← Older revision		Revision as of 19:28, 31 October 2012
Line 31:		Line 31:

	==Examples==		==Examples==
	~~<ol><li>~~In the following example, a patch file (procedure <code>BASEDIFF.STR</code>) is applied to a base file (<code>BASEFILE.STR</code>) to reproduce the updated version of the base file. The contents of <code>BASEDIFF.STR</code> were initially created at a PC. Since simple transfer to a procedure loses some required trailing blanks, the approach used below (explicit specification of <var>Stringlist</var> items) is a workaround to preserve the necessary blanks in the patch file.		In the following example, a patch file (procedure <code>BASEDIFF.STR</code>) is applied to a base file (<code>BASEFILE.STR</code>) to reproduce the updated version of the base file. The contents of <code>BASEDIFF.STR</code> were initially created at a PC. Since simple transfer to a procedure loses some required trailing blanks, the approach used below (explicit specification of <var>Stringlist</var> items) is a workaround to preserve the necessary blanks in the patch file.

	<p class="code">Begin		<p class="code">Begin
Line 101:		Line 101:
	<nowiki>**************Here is updated base:*************</nowiki>		<nowiki>**************Here is updated base:*************</nowiki>
	Hamlet: Do you see the cloud over there that's almost the shape of a camel?#Polonius: By golly, it is like a camel, indeed.#		Hamlet: Do you see the cloud over there that's almost the shape of a camel?#Polonius: By golly, it is like a camel, indeed.#
	</p~~></ol~~>		</p>

	==See also==		==See also==
	<ul><li><var class="term">[http://en.wikipedia.org/wiki/Diff diff]</var> for creation of the patch file <var class="term">sl</var><li><var>[[Patch (Stringlist function)\|Patch]]</var> for working with line-oriented diff output.<li><var>[[PatchLines (Stringlist function)\|PatchLines]]</var> for revised syntax layout.</ul>		<ul><li><var class="term">[http://en.wikipedia.org/wiki/Diff diff]</var> for creation of the patch file <var class="term">sl</var><li><var>[[Patch (Stringlist function)\|Patch]]</var> for working with line-oriented diff output.<li><var>[[PatchLines (Stringlist function)\|PatchLines]]</var> for revised syntax layout.</ul>
	{{Template:Stringlist:PatchString footer}}		{{Template:Stringlist:PatchString footer}}

JAL2: /* See also */

2012-02-22T22:04:10Z

Dme at 16:36, 7 February 2012

2012-02-07T16:36:28Z

← Older revision		Revision as of 16:36, 7 February 2012
Line 64:		Line 64:
	%ptch:add('@@ -77,24 +86,18 @@')		%ptch:add('@@ -77,24 +86,18 @@')
	%ptch:add(' By ')		%ptch:add(' By ')
	%ptch:add('-the mass, and ' WITH '''t')		%ptch:add('-the mass, and ' WITH '''t')
	%ptch:add('+golly, it ')		%ptch:add('+golly, it ')
	%ptch:add(' is l')		%ptch:add(' is l')

JALWiccan: 1 revision

2011-04-13T22:33:40Z

1 revision

← Older revision	Revision as of 22:33, 13 April 2011
(No difference)

Wiccan: 1 revision

2011-04-13T22:33:38Z

1 revision

← Older revision		Revision as of 22:33, 13 April 2011
Line 20:		Line 20:
	<tr><th>baseString</th>		<tr><th>baseString</th>
	<td>A string that contains the base file.</td></tr>		<td>A string that contains the base file.</td></tr>
	<tr><th>Options</th>		<tr><th><var>Options</var></th>
	<td>The optional Options argument (name required) is the string value <code>ErrRet</code>, which may be specified in uppercase or lowercase. If you specify <code>Options='ErrRet'</code>, <var>PatchString</var> method errors return a null <var class="term">updString</var> string and no error message instead of canceling the request. If you do not specify <code>Options='ErrRet'</code> and a method error occurs, you receive an error message and the request is cancelled.</td></tr>		<td>The optional Options argument (name required) is the string value <code>ErrRet</code>, which may be specified in uppercase or lowercase. If you specify <code>Options='ErrRet'</code>, <var>PatchString</var> method errors return a null <var class="term">updString</var> string and no error message instead of canceling the request. If you do not specify <code>Options='ErrRet'</code> and a method error occurs, you receive an error message and the request is cancelled.</td></tr>
	</table>		</table>

Wiccan: 1 revision

2011-02-07T21:23:55Z

1 revision

← Older revision	Revision as of 21:23, 7 February 2011
(No difference)

Wiccan: 1 revision

2011-02-07T21:23:51Z

1 revision

← Older revision		Revision as of 21:23, 7 February 2011
Line 34:		Line 34:

	<p class="code">Begin		<p class="code">Begin
	~~<p class="code">~~%base is Longstring		%base is Longstring
	%baselist is object stringlist		%baselist is object stringlist
	%ptch is object stringList		%ptch is object stringList
	%upd is Longstring		%upd is Longstring
	%rc is float		%rc is float
	%i is fixed		%i is fixed

	<nowiki>*</nowiki> move base file into stringlist then into longstring		<nowiki>*</nowiki> move base file into stringlist then into longstring
	%baselist = new		%baselist = new
	%rc = $procopn('BASEFILE.STR', 'JALPROC')		%rc = $procopn('BASEFILE.STR', 'JALPROC')
	%baselist:appendOpenProcedure		%baselist:appendOpenProcedure
	%base=%baselist:CreateLines('#')		%base=%baselist:CreateLines('#')
	Print '*************Here is base:*************'		Print '*************Here is base:*************'
	Print %base		Print %base

	<nowiki>*</nowiki> move patch file into stringlist		<nowiki>*</nowiki> move patch file into stringlist
	%ptch = new		%ptch = new
	%rc = $procopn('BASEDIFF.STR', 'JALPROC')		%rc = $procopn('BASEDIFF.STR', 'JALPROC')
	%ptch:add('@@ -16,20 +16,28 @@')		%ptch:add('@@ -16,20 +16,28 @@')
	%ptch:add(' see ')		%ptch:add(' see ')
	%ptch:add('-yonder cloud')		%ptch:add('-yonder cloud')
	%ptch:add('+the cloud over there')		%ptch:add('+the cloud over there')
	%ptch:add(' tha')		%ptch:add(' tha')
	%ptch:add('@@ -39,18 +47,19 @@')		%ptch:add('@@ -39,18 +47,19 @@')
	%ptch:add(' almost ')		%ptch:add(' almost ')
	%ptch:add('-in')		%ptch:add('-in')
	%ptch:add('+the')		%ptch:add('+the')
	%ptch:add(' shape o')		%ptch:add(' shape o')
	%ptch:add('@@ -77,24 +86,18 @@')		%ptch:add('@@ -77,24 +86,18 @@')
	%ptch:add(' By ')		%ptch:add(' By ')
	%ptch:add('-the mass, and ' WITH '''t')		%ptch:add('-the mass, and ' WITH '''t')
	%ptch:add('+golly, it ')		%ptch:add('+golly, it ')
	%ptch:add(' is l')		%ptch:add(' is l')
	Print '*************Here is patch:*************'		Print '*************Here is patch:*************'
	for %i from 1 to %ptch:Count		for %i from 1 to %ptch:Count
	Print 'ptch(' %i ') {' %ptch(%i) '}'		Print 'ptch(' %i ') {' %ptch(%i) '}'
	end for		end for

	<nowiki>*</nowiki> produce updated version of base file		<nowiki>*</nowiki> produce updated version of base file
	%upd = %ptch:Patchstring(%base)		%upd = %ptch:Patchstring(%base)
	Print '*************Here is updated base:*************'		Print '*************Here is updated base:*************'
	Print %upd		Print %upd
	~~</p>~~
	End		End
	</p>		</p>

Wiccan: 1 revision

2011-02-06T22:35:26Z

1 revision

← Older revision	Revision as of 22:35, 6 February 2011
(No difference)

← Older revision		Revision as of 16:12, 3 February 2015
Line 104:		Line 104:

	==See also==		==See also==
	<ul>~~<li><var class="term">[http://en.wikipedia.org/wiki/Diff diff]</var> for creation of the patch file <var class="term">sl</var>~~<li><var>[[Patch (Stringlist function)\|Patch]]</var> for working with line-oriented diff output.<li><var>[[PatchLines (Stringlist function)\|PatchLines]]</var> for revised syntax layout.</ul>		<ul>
			<li><var>[[Patch (Stringlist function)\|Patch]]</var> for working with line-oriented diff output. </li>
			<li><var>[[PatchLines (Stringlist function)\|PatchLines]]</var> for revised syntax layout. </li>
			</ul>

	{{Template:Stringlist:PatchString footer}}		{{Template:Stringlist:PatchString footer}}

← Older revision		Revision as of 22:04, 22 February 2012
Line 104:		Line 104:

	==See also==		==See also==
	<ul><li><var class="term">[http://en.wikipedia.org/wiki/Diff diff]</var> for creation of the patch file <var class="term">sl</var><li><var>[[Patch (Stringlist function)\|Patch]]</var> for working with line-oriented diff output.<li><var>[[~~Patchlines~~ (Stringlist function)\|~~Patchlines~~]]</var> for revised syntax layout.</ul>		<ul><li><var class="term">[http://en.wikipedia.org/wiki/Diff diff]</var> for creation of the patch file <var class="term">sl</var><li><var>[[Patch (Stringlist function)\|Patch]]</var> for working with line-oriented diff output.<li><var>[[PatchLines (Stringlist function)\|PatchLines]]</var> for revised syntax layout.</ul>
	{{Template:Stringlist:PatchString footer}}		{{Template:Stringlist:PatchString footer}}