import { substituteParams } from '../../../script.js'; import { extension_settings } from '../../extensions.js'; export { regex_placement, getRegexedString, runRegexScript, }; /** * @enum {number} Where the regex script should be applied */ const regex_placement = { /** * @deprecated MD Display is deprecated. Do not use. */ MD_DISPLAY: 0, USER_INPUT: 1, AI_OUTPUT: 2, SLASH_COMMAND: 3, }; /** * Instantiates a regular expression from a string. * @param {string} input The input string. * @returns {RegExp} The regular expression instance. * @copyright Originally from: https://github.com/IonicaBizau/regex-parser.js/blob/master/lib/index.js */ function regexFromString(input) { try { // Parse input var m = input.match(/(\/?)(.+)\1([a-z]*)/i); // Invalid flags if (m[3] && !/^(?!.*?(.).*?\1)[gmixXsuUAJ]+$/.test(m[3])) { return RegExp(input); } // Create the regular expression return new RegExp(m[2], m[3]); } catch { return; } } /** * Parent function to fetch a regexed version of a raw string * @param {string} rawString The raw string to be regexed * @param {regex_placement} placement The placement of the string * @param {RegexParams} params The parameters to use for the regex script * @returns {string} The regexed string * @typedef {{characterOverride?: string, isMarkdown?: boolean, isPrompt?: boolean }} RegexParams The parameters to use for the regex script */ function getRegexedString(rawString, placement, { characterOverride, isMarkdown, isPrompt } = {}) { // WTF have you passed me? if (typeof rawString !== 'string') { console.warn('getRegexedString: rawString is not a string. Returning empty string.'); return ''; } let finalString = rawString; if (extension_settings.disabledExtensions.includes('regex') || !rawString || placement === undefined) { return finalString; } extension_settings.regex.forEach((script) => { if ( // Script applies to Markdown and input is Markdown (script.markdownOnly && isMarkdown) || // Script applies to Generate and input is Generate (script.promptOnly && isPrompt) || // Script applies to all cases when neither "only"s are true, but there's no need to do it when `isMarkdown`, the as source (chat history) should already be changed beforehand (!script.markdownOnly && !script.promptOnly && !isMarkdown) ) { if (script.placement.includes(placement)) { finalString = runRegexScript(script, finalString, { characterOverride }); } } }); return finalString; } /** * Runs the provided regex script on the given string * @param {object} regexScript The regex script to run * @param {string} rawString The string to run the regex script on * @param {RegexScriptParams} params The parameters to use for the regex script * @returns {string} The new string * @typedef {{characterOverride?: string}} RegexScriptParams The parameters to use for the regex script */ function runRegexScript(regexScript, rawString, { characterOverride } = {}) { let newString = rawString; if (!regexScript || !!(regexScript.disabled) || !regexScript?.findRegex || !rawString) { return newString; } const findRegex = regexFromString(regexScript.substituteRegex ? substituteParams(regexScript.findRegex) : regexScript.findRegex); // The user skill issued. Return with nothing. if (!findRegex) { return newString; } // Run replacement. Currently does not support the Overlay strategy newString = rawString.replace(findRegex, function(match) { const args = [...arguments]; const replaceString = regexScript.replaceString.replace(/{{match}}/gi, '$0'); const replaceWithGroups = replaceString.replaceAll(/\$(\d)+/g, (_, num) => { // Get a full match or a capture group const match = args[Number(num)]; // No match found - return the empty string if (!match) { return ''; } // Remove trim strings from the match const filteredMatch = filterString(match, regexScript.trimStrings, { characterOverride }); // TODO: Handle overlay here return filteredMatch; }); // Substitute at the end return substituteParams(replaceWithGroups); }); return newString; } /** * Filters anything to trim from the regex match * @param {string} rawString The raw string to filter * @param {string[]} trimStrings The strings to trim * @param {RegexScriptParams} params The parameters to use for the regex filter * @returns {string} The filtered string */ function filterString(rawString, trimStrings, { characterOverride } = {}) { let finalString = rawString; trimStrings.forEach((trimString) => { const subTrimString = substituteParams(trimString, undefined, characterOverride); finalString = finalString.replaceAll(subTrimString, ''); }); return finalString; }