Retro/pcjs
Watch
1
0
Fork
You've already forked pcjs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added a cleaner solution for string replacement woes (ie, use Str.replace() instead of applying replace(/\$/g, "$$$$") to replacement strings)

Browse source
This commit is contained in:
Jeff Parsons 2017-06-23 11:56:14 -07:00 • committed by Jeff Parsons
commit 113201fdb4
19 changed files with 237 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

2
modules/htmlout/lib/htmlout.js
View file

@ -2049,7 +2049,7 @@ HTMLOut.prototype.addFilesToHTML = function(asFiles, sScriptEmbed)
sTextInsert += '\n' + sIndent + sScriptEmbed;
}
if (sTextInsert) {
this.sHTML = this.sHTML.replace(sText, sText + sTextInsert.replace(/\$/g, "$$$$"));
this.sHTML = str.replace(sText, sText + sTextInsert, this.sHTML);
}
}
else {

4
modules/markout/lib/markout.js
View file

@ -1202,9 +1202,9 @@ MarkOut.prototype.convertMDMachineLinks = function(sBlock)
sMachineVersion = ((machine['uncompiled'] == "true")? "uncompiled" : "");
sMachineParms = machine['parms'] || "";
sReplacement = machine['name'] || "Embedded PC";
sReplacement = "[" + sReplacement + "](" + sMachineXMLFile + ' "' + sMachineType + '!' + sMachineID + '!' + sMachineXSLFile + '!!' + sMachineOptions + '!' + sMachineParms.replace(/\$/g, "$$$$") + '")';
sReplacement = "[" + sReplacement + "](" + sMachineXMLFile + ' "' + sMachineType + '!' + sMachineID + '!' + sMachineXSLFile + '!!' + sMachineOptions + '!' + sMachineParms + '")';
}
sBlock = sBlock.replace(aMatch[0].substr(1), sReplacement);
sBlock = str.replace(aMatch[0].substr(1), sReplacement, sBlock);
reIncludes.lastIndex = 0; // reset lastIndex, since we just modified the string that reIncludes is iterating over
}

15
modules/pcx86/lib/keyboard.js
View file

@ -409,7 +409,9 @@ class Keyboard extends Component {
* $date: converted to MM-DD-YYYY
* $time: converted to HH:MM
*
* If you want any of those sequences to be typed as-is, then you must specify two "$" (ie, "$$").
* If you want any of those sequences to be typed as-is, then you must specify two "$" (ie, "$$date").
* Pairs of dollar signs will be automatically converted to single dollar signs, and single dollar signs
* will be used as-is.
*
* WARNING: the JavaScript replace() function ALWAYS interprets "$" specially in replacement strings,
* even when the search string is NOT a RegExp; specifically:
@ -424,10 +426,13 @@ class Keyboard extends Component {
* Since we build machine definitions on a page from a potentially indeterminate number of string replace()
* operations, multiple dollar signs could eventually get reduced to a single dollar sign BEFORE we get here.
*
* To compensate, I've attempted add replace(/\$/g, "$$$$") operations where currently needed; eg, in the
* markout.js convertMDMachineLinks() function, the htmlout.js addFilesToHTML() function, and the embed.js
* parseXML() function. Unfortunately, this is something that will be extremely difficult to prevent from
* breaking down the road. So, heads up to future me....
* To compensate, I've changed a few replace() methods, like MarkOut's convertMDMachineLinks() and HTMLOut's
* addFilesToHTML(), from the conventional string replace() to my own Str.replace(), and for situations like the
* embed.js parseXML() function, which needs to use a RegExp-style replace(), I've added a preliminary
* replace(/\$/g, "$$$$") to the replacement string.
*
* Unfortunately, this is something that will be extremely difficult to prevent from breaking down the road.
* So, heads up to future me....
*
* @this {Keyboard}
* @param {string|undefined} sKeys

34
modules/shared/lib/strlib.js
View file

@ -505,6 +505,40 @@ class Str {
});
}
/**
* replace(sFind, sReplace, s)
*
* The JavaScript replace() function ALWAYS interprets "$" specially in replacement strings, even when
* the search string is NOT a RegExp; specifically:
*
* $$ Inserts a "$"
* $& Inserts the matched substring
* $` Inserts the portion of the string that precedes the matched substring
* $' Inserts the portion of the string that follows the matched substring
* $n Where n is a positive integer less than 100, inserts the nth parenthesized sub-match string,
* provided the first argument was a RegExp object
*
* So, if a replacement string containing dollar signs passes through a series of replace() calls, untold
* problems could result. Hence, this function, which simply uses the replacement string as-is.
*
* Similar to the JavaScript replace() method, this replaces only one occurrence (ie, the FIRST occurrence);
* it might be nice to add options to replace the LAST occurrence and/or ALL occurrences, but we'll revisit
* that later.
*
* @param {string} sFind
* @param {string} sReplace
* @param {string} s
* @return {string}
*/
static replace(sFind, sReplace, s)
{
var i = s.indexOf(sFind);
if (i >= 0) {
s = s.substr(0, i) + sReplace + s.substr(i + sFind.length);
}
return s;
}
/**
* replaceAll(sFind, sReplace, s)
*