Version 0.9.1-rc

- emote detection mixed in other channels
- minimap button and dialog no longer resets active state after profile change
- default entries are no longer shown after example import
- better handling of capture groups and character sets

.gitignore

@@ -37,6 +37,7 @@ out/
 obj/
 
 # Misc
+.bin/
 *.log
 *.graphml
 coverage.db*

.pkgmeta

@@ -4,9 +4,14 @@ enable-nolib-creation: no
 
 externals:
   libs/LibStub: https://repos.wowace.com/wow/libstub/tags/1.0
+  libs/LibDataBroker: https://github.com/tekkub/libdatabroker-1-1
+  libs/LibDBIcon: https://repos.curseforge.com/wow/libdbicon-1-0/trunk/LibDBIcon-1.0
   libs/CallbackHandler-1.0: https://repos.wowace.com/wow/callbackhandler/trunk/CallbackHandler-1.0
   libs/AceAddon-3.0: https://repos.wowace.com/wow/ace3/trunk/AceAddon-3.0
+  libs/AceConfig-3.0: https://repos.wowace.com/wow/ace3/trunk/AceConfig-3.0
   libs/AceConsole-3.0: https://repos.wowace.com/wow/ace3/trunk/AceConsole-3.0
+  libs/AceDB-3.0: https://repos.wowace.com/wow/ace3/trunk/AceDB-3.0
+  libs/AceDBOptions-3.0: https://repos.wowace.com/wow/ace3/trunk/AceDBOptions-3.0
   libs/AceEvent-3.0: https://repos.wowace.com/wow/ace3/trunk/AceEvent-3.0
   libs/AceGUI-3.0: https://repos.wowace.com/wow/ace3/trunk/AceGUI-3.0
   libs/AceHook-3.0: https://repos.wowace.com/wow/ace3/trunk/AceHook-3.0

CHANGELOG.md

@@ -3,27 +3,107 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased] Version 1.0 - 2020-05-28
-### Added
-- case sensitivity 
-- consolidate consecutive matches
+## Version 0.9.1-rc - 2020-08-01 [Release Candidate]
+### Fixed
+- emote detection mixed in other channels
+- minimap button and dialog no longer resets active state after profile change
+- default entries are no longer shown after example import
+- better handling of capture groups and character sets
 
-## Version 0.3.1 - 2020-05-28
+## Version 0.9.0-rc - 2020-07-25 [Release Candidate]
+### Added
+- enable/disable from slash command
+- matching conditions (never, always, start, end, start or end)
+- support capturing groups
+- import examples
+- testing capabilities
+- compatibility with WoW Retail
+### Changed
+- adapted help texts
+- spelling errors
+
+## Version 0.8.1-beta - 2020-06-16
+### Added
+- stop replacements per mapping
+- more ooc recognition patterns
+### Fixed
+- keep cases of over-long replacements
+
+## Version 0.8.0-beta - 2020-06-14 [Feature Complete]
+### Added
+- handle replacement via slash command
+- emote and ooc detection
+- de-/activate single mappings
+- move buttons are disabled when already at top/bottom or replacements were deactivated
+- minimap button is darkened when addon is disabled
+- help tab with examples
+### Changed
+- right-click on minimap button quickly de-/activates replacements
+### Fixed
+- mapping to raid warning, instance and battleground chats
+- localized raid target markers
+- capital % substitutions
+- incorrect consolidation
+- Umlaut and accent replacements
+
+## Version 0.7.2-beta - 2020-06-08
+### Added
+- minimap button
+### Changed
+- graphical move arrows
+### Fixed
+- crash on matches with 0-width
+
+## Version 0.7.1-beta - 2020-06-07
+### Added
+- user reporting capabilities
+- ignore Battle.net contacts
+### Changed
+- graphical move arrows
+
+## Version 0.7.0-beta - 2020-06-07
+### Added
+- order buttons
+### Changed
+- use numeric LogLevel over booleans
+- exact case option reversed (again)
+- smart case handling if replacement is longer than match
+### Fixed
+- Deletion of all mappings
+
+## Version 0.6.0 (unreleased) - 2020-06-05
+### Added
+- honour capital/mixed cases for ignore case
+- consolidate consecutive matches
+- database upgrade capability
+### Changed
+- case sensitivity option reversed
+- removed obsolete WIM handling
+### Fixed
+- skip empty mapping
+- Deletion of mapping
+
+## Version 0.5.0 - 2020-06-01
 ### Added
 - add replacements via options UI
-- handle replacement via slash command
+
+## Version 0.4.0 (unreleased) - 2020-05-30
+### Added
+- restructured files
+- extract functions and color codes
+- filter channels
 
 ## Version 0.3.0 - 2020-05-27
 ### Fixed
 - fixed DB storange and debug printing
 
-## Version 0.2.2 - 2020-05-26
+## Version 0.2.2 (unreleased) - 2020-05-26
 ### Added
 - added Options UI under Interface Options
 - store settings in profiles
 - added more translations
 
-## Version 0.2.1 - 2020-05-25
+## Version 0.2.1 (unreleased) - 2020-05-25
 ### Added
 - support automatic packaging for curseforge via .pkgmeta
 - include project logo
@@ -36,6 +116,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - handle SendChatMessage ordering if addon Misspelled is also installed
 - break long texts in chunks of 255 length
 
-## Version 0.1 - 2020-05-24
+## Version 0.1 (unreleased) - 2020-05-24
 ### Added
 - bootstrap addon with Ace3 based on [Misspelled](https://www.curseforge.com/wow/addons/misspelled)

Grichelde.lua

@@ -1,444 +1,92 @@
 --[[---------------------------------------------------------------------------
-  Grichelde
+
+  Grichelde - Text Replacer
+
   Copyright 2020 Teilzeit-Jedi <tj@teilzeit-jedi.de>
 
-  based on Misspelled developed by Nathan Pieper - nrpieper (@) gmail (dot) com
+  This addon is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
 
-  This code freely distributed for your use in any GPL compliant project.
-  See conditions in the LICENSE file attached.
+  You should have received a copy of the GNU General Public License
+  along with the addon. If not, see <http://www.gnu.org/licenses/gpl-3.0.txt>.
 
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
+-----------------------------------------------------------------------------]]
 
---------------------------------------------------------------------------]] --
--- upvalues
+-- read namespace from global env
+local AddonName, AddonTable = ...
 local _G = _G
 
--- faster function lookups by mapping to local refs
-local string_find = _G.string.find
-local string_gsub = _G.string.gsub
-local string_len = _G.string.len
-local string_rep = _G.string.rep
-local string_sub = _G.string.sub
-local string_fmt = _G.string.format
-local strtrim = _G.strtrim
-local strmatch = _G.strmatch
-local tostring = _G.tostring
-local tInsert = _G.table.insert
-local tContains = _G.tContains
-local unpack = _G.unpack
-local pairs = _G.pairs
-local ipairs = _G.ipairs
-
--- colors:
-local PREFIX_COLOR_CODE = "|c00FFAA00"
-
 -- initialize addon
-local AddonName, AddonTable = ...
-
-local Grichelde = LibStub("AceAddon-3.0"):NewAddon(AddonName, "AceConsole-3.0", "AceEvent-3.0", "AceHook-3.0")
-Grichelde.L = LibStub("AceLocale-3.0"):GetLocale("Grichelde", true)
+local Grichelde = LibStub("AceAddon-3.0"):NewAddon(AddonTable, AddonName, "AceConsole-3.0", "AceEvent-3.0", "AceHook-3.0")
 Grichelde.version = GetAddOnMetadata(AddonName, "Version")
 Grichelde.build = GetAddOnMetadata(AddonName, "X-Build") or "Experimental"
-Grichelde.hooks = {}
 Grichelde.classic = _G.WOW_PROJECT_ID == _G.WOW_PROJECT_CLASSIC
-Grichelde.debug = false
+Grichelde.logLevel = 0      -- cannot reference Grichelde.LOG_LEVELs here as they are loaded afterwards
 
 -- publish to global env
-_G.Grichelde = Grichelde
-
-Grichelde.config = {
-    enabled = true,
-    channels = { "SAY", "EMOTE", "YELL", "PARTY", "GUILD" },
-    slashCommands = { "/s", "/say", "/e", "/em", "/me", "/emote", "/y", "/yell", "/sh", "/shout", "/p", "/party", "/pl", "/partyleader", "/g", "/gc", "/guild", "/o", "/osay", "/officer", "/raid", "/rsay", "/rl", "/raidleader", "/rw", "/raidwarning", "/i", "/instance", "/bg", "/battleground", "/w", "/whisper", "/t", "/tell", "/send", "/r", "/reply" }
-}
+_G[AddonName] = Grichelde
 
 -- Ace3 callbacks
 function Grichelde:OnInitialize()
-    -- Build Interface Options window
-    self:LoadDatabase()
-    self:SetupOptions()
-    self:SetupSlashCommands()
+    self.L = LibStub("AceLocale-3.0"):GetLocale(self.name, true)
 
-    -- Watch for WIM and Prat to Load, then integrate
-    self:RegisterEvent("ADDON_LOADED", "HookIntoForOtherChatAddons")
+    -- Build Interface Options window
+    self.db = self:LoadDatabase()
+    self:UpgradeDatabase()
 end
 
 function Grichelde:OnEnable()
-
     -- Hook in before message is sent to replace all character occurrences where replacements have been defined in the options
     self:RawHook("SendChatMessage", true)
 
-    if (_G.Misspelled) then
-        self:PrefixedPrint(self.L.Addon_Detected_Misspelled)
-    end
+    self.options, self.dialog = self:SetupOptions()
+    self.ldb, self.icon = self:MinimapButton()
+
+    self:RefreshProfiles("OnEnable")
+    self:SetupSlashCommands()
 
     -- tell the world we are listening
-    self:DebugPrint(self.L.AddonLoaded, self.L.AddonName)
+    if (self.db.profile.enabled == true) then
+        local namePlusVersion = self:Format(self.L.AddonNamePlusVersion, self.L.AddonName, self.version)
+        self.F.print(self:Format(self.L.AddonLoaded, self.COLOR_CODES.PREFIX .. namePlusVersion .. self.COLOR_CODES.CLOSE))
+    end
 end
 
 function Grichelde:OnDisable()
     self:Unhook("SendChatMessage")
+    self:CloseOptions()
+    self:HideMinimapButton()
+    self:UnregisterChatCommand("grichelde")
+    self:UnregisterChatCommand("gri")
 end
 
---- @param event string
---- @param addonName string
-function Grichelde:HookIntoForOtherChatAddons(event, addonName)
-    if event == "ADDON_LOADED" then
-        if addonName == "WIM" then
-            WIM.RegisterWidgetTrigger("msg_box", "whisper,chat,w2w", "OnEnterPressed", Grichelde.EditBox_OnEnterPressed)
-
-            -- If available use the WIM API
-            if (WIM.RegisterPreSendFilterText) then -- avoid error if WIM not up to date.
-                WIM.RegisterPreSendFilterText(function(text)
-                    return Grichelde:CheckAndReplace(text)
-                end)
-            else
-                -- WIM sends its chat messages via the API ChatThrottleLib, which itself hooks the default SendChatMessage api
-                -- many times before Grichelde will. ChatThrottleLib might potentially load before Grichelde, so we just hook
-                -- into ChatThrottleLib to be on the safe side.
-
-                if (ChatThrottleLib) then
-                    Grichelde.hooks["ChatThrottleLib"] = ChatThrottleLib.SendChatMessage
-
-                    function ChatThrottleLib:SendChatMessage(prio, prefix, text, ...)
-                        Grichelde:DebugPrint("ChatThrottleLib:SendChatMessage : Hook called")
-                        local replacedText = Grichelde:CheckAndReplace(text)
-                        return Grichelde.hooks["ChatThrottleLib"](ChatThrottleLib, prio, prefix, replacedText, ...)
-                    end
-                end
-            end
-
-            if (_G.WIM) then
-                self:PrefixedPrint(self.L.Addon_Detected_WIM)
-            end
-        end
-    end
+--- Register  slash commands 'gri' and 'grichelde'
+function Grichelde:SetupSlashCommands()
+    self:RegisterChatCommand("grichelde", "HandleSlashCommand")
+    self:RegisterChatCommand("gri", "HandleSlashCommand")
 end
 
---- Before af chat message is sent, check if replacement is required and replace the text accordingly.
---- @param message string
---- @param type string
---- @param language string
---- @param channel string
-function Grichelde:SendChatMessage(message, type, language, channel, ...)
-    local replacedText = self:CheckAndReplace(message, type)
-
-    self:DebugPrint("SendChatMessage : replacedText: " .. replacedText)
-
-    -- Send text in chunks if length exceeds 255 bytes after replacement
-    local chunks = self:SplitText(replacedText)
-    self:DebugPrint("SendChatMessage : #chunks: " .. #chunks)
-
-    for _, chunk in ipairs(chunks) do
-        self.hooks["SendChatMessage"](chunk, type, language, channel, ...);
-    end
-end
-
-function Grichelde:CheckAndReplace(message, type)
-    local text = message
-    if (Misspelled) then
-        self:DebugPrint("Misspelled detected: cleansing message")
-        text = Misspelled:RemoveHighlighting(text)
-    end
-    text = strtrim(text)
-
-    if (self:CheckReplacement(text, type)) then
-        text = self:ReplaceText(text)
-    end
-    return text
-end
-
-function Grichelde:CheckReplacement(text, type)
-    if (not Grichelde.config.enabled) then
-        self:DebugPrint("CheckReplacement : globally disabled")
-        return false
-    end
-
-    -- check type
-    if (not tContains(Grichelde.config.channels, type)) then
-        self:DebugPrint("CheckReplacement : skip channel type")
-        return false
-    end
-
-    -- don't replace slash commands except chat related commands
-    if string_sub(text, 1, 1) == "/" then
-        local firstWord, _ = self:SplitOnFirstMatch(text)
-        if (firstWord == nil or not tContains(Grichelde.config.slashCommands, firstWord)) then
-            self:DebugPrint("CheckReplacement : ignore slash command")
-            return false
-        end
-    end
-
-    -- in any other case
-    return true
-end
-
---- Checks if the text starts with a preversable ignore pattern, such as itemLinks, textures or raid target icons
---- and returns the end location of the match, or 0 if no pattern was found
---- @param text string
---- @return number
-function Grichelde:CheckForPreversableText(text)
-    self:DebugPrint("CheckForPreversableText : text is " .. text)
-
-    -- do not replace these patterns
-    local ignorePatterns = {
-        "|[Cc]%x%x%x%x%x%x%x%x.-|r",    -- colored items (or links)
-        "|H.-|h",                       -- item links (http://www.wowwiki.com/ItemLink)
-        "|T.-|t",                       -- textures
-        "|n",                           -- newline
-        "{rt[1-8]}",                    -- rumbered raid target icons
-        "{Star}",                       -- named raid target icon 1
-        "{Circle}",                     -- named raid target icon 2
-        "{Coin}",                       -- named raid target icon 2
-        "{Diamond}",                    -- named raid target icon 3
-        "{Triangle}",                   -- named raid target icon 4
-        "{Moon}",                       -- named raid target icon 5
-        "{Square}",                     -- named raid target icon 6
-        "{Cross}",                      -- named raid target icon 7
-        "{X}",                          -- named raid target icon 7
-        "{Skull}"                       -- named raid target icon 8
-    }
-
-    -- Calling find on ever pattern might be inefficient but its way less code.
-    for _, pattern in ipairs(ignorePatterns) do
-        local pos1, pos2 = string_find(text, pattern)
-        if pos1 == 1 and pos2 ~= nil then
-            self:DebugPrint("CheckForPreversableText : Found ignore pattern \"%s\" at (%d, %d)", pattern, pos1, pos2)
-            return pos2
-        end
-    end
-    self:DebugPrint("CheckForPreversableText : no ignore pattern found")
-    return 0
-end
-
---- Replaces all character occurrences for which replacements have been defined in the options,
---- while preserving any itemLinks or textures. (http://www.wowwiki.com/ItemLink)
---- @param text string
---- @return string
-function Grichelde:ReplaceText(text)
-    local finalText = ""
-    local newText = text
-
-    -- don't replace non-chat related slash commands
-    local firstWord, line = self:SplitOnFirstMatch(text)
-    if (firstWord ~= nil and tContains(Grichelde.config.slashCommands, firstWord)) then
-        self:DebugPrint("ReplaceText : Found slash command %s", firstWord )
-        -- skip chat slash command
-        finalText = finalText .. firstWord .. ' '
-        newText = line
-    end
-
-    local current = 1
-    local lastStart = 1
-
-    while current <= string_len(newText) do
-        local currentChar = string_sub(newText, current, current)
-        self:DebugPrint("current/char : %s,%s", current, currentChar)
-
-        if currentChar ~= '|' and currentChar ~= '{' then
-            current = current + 1
-        else
-
-            -- lookahead-check for itemLinks, textures and raid target icons
-            local textAhead = string_sub(newText, current)
-            local posEnd = self:CheckForPreversableText(textAhead)
-            if posEnd > 0 then
-                self:DebugPrint("ReplaceText : Found an ignore pattern")
-
-                local textBehind = string_sub(newText, lastStart, current - 1)
-                local replacement = self:ReplaceCharacters(textBehind)
-                local preservedText = string_sub(textAhead, 1, posEnd)
-
-                finalText = finalText .. replacement .. preservedText
-                current = current + posEnd
-                lastStart = current
-                self:DebugPrint("ReplaceText : restarting at " .. lastStart)
-            else
-                -- no corresponding end was found to start pattern, continue loop with next char
-                current = current + 1
-            end
-        end
-    end
-
-    -- cleanup remaining text to the end
-    local remainingText = string_sub(newText, lastStart)
-    local replacement = self:ReplaceCharacters(remainingText)
-    finalText = finalText .. replacement
-
-    self:DebugPrint("ReplaceText : replaced \"" .. text .. "\"")
-    self:DebugPrint("ReplaceText : with         \"" .. finalText .. "\"")
-    return finalText
-end
-
---- Replaces all character occurrences for which replacements have been defined in the options
---- @param text string
---- @return string
-function Grichelde:ReplaceCharacters(text)
-    -- todo: read from options
-    -- todo: case (in)sensitivity
-    -- todo: consolidate consecutive
-    -- todo: prevent infinite loops - is that even possible?
-    local replacement = text
-    replacement = string_gsub(replacement, "s", "ch")
-    replacement = string_gsub(replacement, "S", "Ch")
-    replacement = string_gsub(replacement, "t", "k")
-    replacement = string_gsub(replacement, "T", "K")
-    self:DebugPrint("ReplaceCharacters : replaced \"%s\" with \"%s\"", text, replacement)
-    return replacement
-end
-
---- Splits a long text in longest possible chunks of <= 255 length, split at last available space
---- @param text string
---- @return table
-function Grichelde:SplitText(text)
-    local chunks = {}
-    local splitText = text
-    local textSize = string_len(splitText)
-
-    while textSize > 255 do
-        local chunk = string_sub(splitText, 1, 255)
-        local remaining = ""
-
-        -- special case: if space is the start of the next chunk, don't split this chunk
-        if string_sub(splitText, 256, 256) ~= ' ' then
-            -- split at last space, don't assign directly as nil might be returned
-            local left, right = self:SplitOnLastMatch(chunk)
-            if left ~= nil then
-                chunk = left
-            end
-            if right ~= nil then
-                remaining = right
-            end
-        end
-
-        self:DebugPrint("SplitText : chunk: " .. chunk )
-
-        tInsert(chunks, chunk)
-        splitText = remaining .. string_sub(splitText, 256)
-        textSize = string_len(splitText)
-    end
-
-    -- pickup remaining text < 255
-    self:DebugPrint("SplitText : last chunk: " .. splitText)
-    tInsert(chunks, splitText)
-
-    return chunks
-end
-
--- split first word of a text line
-function Grichelde:SplitOnFirstMatch(text, start)
-    self:DebugPrint("SplitOnFirstMatch : text: %s, start: %d", text, start)
-    local pos = start or 1
-    local left, right = strmatch(text, "^.- .+", pos)
-    self:DebugPrint("SplitOnFirstMatch : left: %s, right: %s", left, right)
-    return left, right
-end
-
-function Grichelde:SplitOnLastMatch(text, start)
-    self:DebugPrint("SplitOnLastMatch : text: %s, start: %d", text, start)
-    local pos = start or 1
-    local left, right = strmatch(text, ".+ .-$", pos)
-    self:DebugPrint("SplitOnLastMatch : left: %s, right: %s", left, right)
-    return left, right
-end
-
-function Grichelde:Format(message,...)
-    local msg = message
-    local l = select("#", ...)
-    if l > 0 then
-        -- sanitize nil values in vararg
-        local packed = {...}
-        for i = 1,l do
-            packed[i] = packed[i] or "nil"
-        end
---      print("packed = ", packed)
---      self:tPrint(packed)
-        -- cannot assign unpacked to a vararg variable and print it for debug
-        msg = string_fmt(message, unpack(packed))
-    end
-    return msg or "nil"
-end
-
-function Grichelde:Print(...)
-    print(self:Format(...))
-end
-
-local function prefixedPrint(colorCode, prefix, endClose, ...)
-    print(colorCode .. prefix .. endClose .. ": " .. ...)
-end
-
-function Grichelde:PrefixedPrint(...)
-    prefixedPrint(PREFIX_COLOR_CODE, self.L.AddonName, _G.FONT_COLOR_CODE_CLOSE, self:Format(...))
-end
-
-function Grichelde:DebugPrint(...)
-    if (self.debug) then
-        prefixedPrint(_G.GRAY_FONT_COLOR_CODE, self.L.AddonName, _G.FONT_COLOR_CODE_CLOSE, self:Format(...))
-    end
-end
-
-local function tLen(t)
-    local count = 0
-    for _ in pairs(t) do count = count + 1 end
-    return count
-end
-
--- show strings differently to distinguish them from numbers
-function Grichelde:PlainValue(val)
-    if val == nil then
-        return "<nil>"
-    elseif type(val) == "string" then
-        return '"' .. val .. '"'
-    elseif type(val) == "table" then
-        if tLen(val) > 0 then
-            return tostring(val)
-        else
-            return "{}"
-        end
+function Grichelde:HandleSlashCommand(input, ...)
+    -- Show the GUI if no input is supplied, otherwise handle the chat input.
+    if (self.F.nilOrEmpty(input)) then
+        self:ToggleOptions()
     else
-        return tostring(val)
-    end
-end
-
---- Prints any value to default channel, do NOT return a string.
-function Grichelde:tPrint(val, indent, known)
-    if (not self.debug) then return end
-
-    indent = indent or 0
-    known = known or {}
-
-    if val == nil then
-        print(string_rep(" ", indent) .. "<nil>")
-    elseif type(val) == "string" then
-        print(string_rep(" ", indent) .. "\"" .. val .. "\"")
-    elseif type(val) == "table" then
-        if tLen(val) > 0 then
-            for key, value in pairs(val) do
-                if value == nil then
-                    print(string_rep(" ", indent) .. self:PlainValue(key) .. "= <nil>")
-                elseif type(value) == "table" then
-                    print(string_rep(" ", indent) .. self:PlainValue(key) .. "= {")
-                    if tLen(value) > 0 then
-                        if not known[value] then
-                            self:tPrint(value, indent + 4, known)
-                            known[value] = true
-                        else
-                            print("<known table> " .. self:PlainValue(value))
-                        end
-                    end
-                    print(string_rep(" ", indent) .. "}")
-                else
-                    print(string_rep(" ", indent) .. self:PlainValue(key) .. " = ".. self:PlainValue(value))
-                end
-            end
+        -- handle slash ourselves
+        self:DebugPrint("Handle slash command: " .. input)
+        if input == "mappings" then
+            self:ToogleMappings()
+        elseif input == "options" then
+            self:ToggleOptions()
+        elseif input == "profile" then
+            self:PrintProfile()
+        elseif input == "on" or input == "enable" then
+             self:Activate()
+        elseif input == "off" or input == "disable" then
+             self:Deactivate()
         else
-            print(string_rep(" ", indent) .. "{}")
+            self:SendChatMessageOverride(input, ...)
         end
-    else
-        print(string_rep(" ", indent) .. tostring(val))
     end
-end
+end

Grichelde.toc

@@ -1,23 +1,34 @@
-## Interface: 11304
+## Interface: 11305
 
 ## Title: Grichelde
-## Notes: Replaces characters you type in the chat box
+## Notes: Replaces characters from the chat box
 ## Notes-de: Ersetzt eingegebene Zeichen in der Chat-Zeile
-## Version: 0.3.0
+## Version: 0.9.1-rc
 ## Author: Teilzeit-Jedi
 ## eMail: tj@teilzeit-jedi.de
 
 ## X-Build: Classic
 ## X-Curse-Project-ID: 385480
+## X-License: GPLv3
 ## X-Category: Chat/Communication
-## X-Credits: Teilzeit-Jedi, Nathan Pieper
-## X-Embeds: Ace3
+## X-Credits: Teilzeit-Jedi
+## X-Embeds: LibStub, CallbackHandler, Ace3, LibDataBroker, LibDBIcon
 
-## OptionalDeps: Ace3
+## OptionalDeps: LibStub, CallbackHandler, Ace3, LibDataBroker, LibDBIcon
 ## SavedVariables: GricheldeDB
 
 libs.xml
-localisation.xml
 
 Grichelde.lua
+GricheldeConstants.lua
+
+localisation.xml
+
+GricheldeUtils.lua
+GricheldeDatabase.lua
+GricheldeUpgrade.lua
 GricheldeOptions.lua
+GricheldeMinimap.lua
+GricheldeChat.lua
+
+GricheldeTest.lua

GricheldeChat.lua

@@ -0,0 +1,830 @@
+-- import addon read namespace from global env
+local _G = _G
+local Grichelde = _G.Grichelde or {}
+
+local IsAddOnLoaded, assert, nilOrEmpty, pairs, ipairs, spairs, tContains, tFilter, tInsert, tConcat, tSize, tIsEmpty, find, sub, gsub, gmatch, getNextCharUtf8, isLetter, isUpper, isLower, toUpper, toLower, capitalize, trim, length, lengthUtf8
+    = Grichelde.F.IsAddOnLoaded, Grichelde.F.assert, Grichelde.F.nilOrEmpty, Grichelde.F.pairs, Grichelde.F.ipairs, Grichelde.F.spairs, Grichelde.F.tContains, Grichelde.F.tFilter, Grichelde.F.tInsert, Grichelde.F.tConcat, Grichelde.F.tSize, Grichelde.F.tIsEmpty,
+      Grichelde.F.find, Grichelde.F.sub, Grichelde.F.gsub, Grichelde.F.gmatch, Grichelde.F.getNextCharUtf8, Grichelde.F.isLetter, Grichelde.F.isUpper, Grichelde.F.isLower, Grichelde.F.toUpper, Grichelde.F.toLower, Grichelde.F.capitalize, Grichelde.F.trim, Grichelde.F.length, Grichelde.F.lengthUtf8
+
+--- Splits a long text in longest possible chunks of <= 255 length, split at last available space
+-- @param text string
+-- @return table
+function Grichelde:SplitText(text)
+    local chunks = {}
+    local splitText = text
+    local textSize = length(splitText or "")
+
+    while (textSize > 255) do
+        local chunk = sub(splitText, 1, 255)
+        local remaining = ""
+
+        -- special case: if space is the start of the next chunk, don't split this chunk
+        if (sub(splitText, 256, 256) ~= ' ') then
+            -- split at last space, don't assign directly as nil might be returned
+            local left, right = self:SplitOnLastMatch(chunk)
+            if (left ~= nil) then
+                chunk = left
+            end
+            if (right ~= nil) then
+                remaining = right
+            end
+        end
+
+        self:DebugPrint("SplitText : chunk:", chunk)
+
+        tInsert(chunks, chunk)
+        splitText = remaining .. sub(splitText, 256)
+        textSize = length(splitText)
+    end
+
+    -- pickup remaining text < 255
+    self:DebugPrint("SplitText : last chunk:", splitText)
+    tInsert(chunks, splitText)
+
+    return chunks
+end
+
+--- Send text in chunks if length exceeds 255 bytes after replacement.
+function Grichelde:SendChunkifiedChatMessage(message, ...)
+    if (length(message) > 255) then
+        local chunks = self:SplitText(message)
+        self:DebugPrint("SendChunkifiedChatMessage : #chunks:", #chunks)
+
+        for _, chunk in ipairs(chunks) do
+            self.hooks["SendChatMessage"](chunk, ...);
+        end
+    else
+        self.hooks["SendChatMessage"](message, ...);
+    end
+end
+
+function Grichelde:ReplaceCharacters(text, replName, replTable, consolidate, replacedTexts)
+    local function convertToCaseInsensitivePattern(pattern)
+        local ciPattern = ""
+        local ignored = {'^', '$', '(', ')', '.'}
+        local quantifiers = {'*', '+', '-', '?'}
+        local pos = 1
+        local p, patRest = getNextCharUtf8(pattern)
+
+        while (p ~= nil) do
+            if (tContains(ignored, p) or tContains(quantifiers, p)) then
+                -- ignore
+                ciPattern = ciPattern .. p
+            elseif (p == "%") then
+                -- ignore capture references
+                p, patRest = getNextCharUtf8(patRest)
+                if (p ~= nil) then
+                    ciPattern = ciPattern .. "%" .. p
+                end
+            elseif (p == "[") then
+                -- skip pattern sets
+                ciPattern = ciPattern .. "["
+                p, patRest = getNextCharUtf8(patRest)
+                while ((p ~= nil) and (p ~= "]")) do
+                    if (p == "%") then
+                        -- ignore capture references
+                        p, patRest = getNextCharUtf8(patRest)
+                        if (p ~= nil) then
+                            ciPattern = ciPattern .. "%" .. p
+                        end
+                    else
+                        local upperP, lowerP = toUpper(p), toLower(p)
+                        if (upperP ~= lowerP) then
+                            ciPattern = ciPattern .. upperP .. lowerP
+                        else
+                            ciPattern = ciPattern .. p
+                        end
+                    end
+                    p, patRest = getNextCharUtf8(patRest)
+                end
+                ciPattern = ciPattern .. "]"
+            else
+                ciPattern = ciPattern .. "[" ..  Grichelde.F.toUpper(p) .. Grichelde.F.toLower(p) .. "]"
+            end
+
+            p, patRest = getNextCharUtf8(patRest)
+        end
+        self:TracePrint("convertToCaseInsensitivePattern : %s => %s", pattern, ciPattern)
+        return ciPattern
+    end
+
+    local function replaceCaptures(text, replaceText, captures)
+        local replText = replaceText
+        self:TracePrint("replaceCaptures : text: %s, #captures: %d", text, #captures)
+
+        if (#captures > 0) then
+            for i, cap in ipairs(captures) do
+                --self:TracePrint("replaceCaptures : i: %d, cap: %s", i, cap)
+                if (cap == nil) then
+                    break
+                else
+                    local oldRepl = replText
+                    replText = gsub(oldRepl, "%%" .. i, cap)
+                    self:TracePrint("ReplaceCaptures : substitute capture %s: %s => %s", oldRepl, cap, replText)
+                end
+            end
+        else
+            self:TracePrint("ReplaceCaptures : no captures")
+        end
+        return replText
+    end
+
+    --- this is more complicated to get it right than it looks like
+    local function applyCase(replRest, lastCase, nextCase)
+        local repl = ""
+        if (lastCase == nil) then
+            -- lastCase was unknown, always take over nextCase
+            if (nextCase == nil) then
+                repl = repl .. replRest
+            elseif (nextCase == true) then
+                --repl = repl .. toUpper(replRest)
+                repl = repl .. replRest
+            else
+                --repl = repl .. toLower(replRest)
+                repl = repl .. replRest
+            end
+        elseif (lastCase == true) then
+            -- lastCase was UPPER
+            if (nextCase == nil) then
+                repl = repl .. toUpper(replRest)
+            elseif (nextCase == true) then
+                repl = repl .. toUpper(replRest)
+            else
+                repl = repl .. replRest
+            end
+        else
+            -- lastCase was lower
+            if (nextCase == nil) then
+                repl = repl .. replRest
+            elseif (nextCase == true) then
+                --repl = repl .. toLower(replRest)
+                repl = repl .. replRest
+            else
+                --repl = repl .. toLower(replRest)
+                repl = repl .. replRest
+            end
+        end
+        return repl
+    end
+
+    local pos = 1
+    local result = text
+    local findText = result
+    local searchText = replTable.searchText
+    local replaceText = replTable.replaceText
+    local matchWhen = replTable.matchWhen
+    local doExactCase = replTable.exactCase
+    local doConsolidate = replTable.consolidate
+    local doStopOnMatch = replTable.stopOnMatch
+    local stopOnMatch = false
+
+    if doExactCase then
+        self:DebugPrint("ReplaceCharacters : \"%s => %s\" (exact case)", searchText, replaceText)
+    else
+        self:DebugPrint("ReplaceCharacters : \"%s => %s\" (ignoreCase)", searchText, replaceText)
+        searchText = convertToCaseInsensitivePattern(searchText)
+    end
+
+    local pos1, pos2, cap1, cap2, cap3, cap4, cap5, cap6, cap7, cap8, cap9 = find(findText, searchText, pos)
+    self:TracePrint("ReplaceCharacters : pos1: %d, pos2: %d", pos1, pos2)
+    self:TracePrint("ReplaceCharacters : cap1: %s, cap2: %s, cap3: %s, cap4: %s, cap5: %s, cap6: %s, cap7: %s, cap8: %s, cap9: %s", cap1, cap2, cap3, cap4, cap5, cap6, cap7, cap8, cap9)
+    while (pos1 ~= nil) and (pos2 ~= nil) and (pos1 <= pos2) do
+        -- continue from that position later
+        pos = pos2 + 1
+
+        if doStopOnMatch then
+            stopOnMatch = true
+        end
+
+        local pre = sub(result, 1, pos1 - 1)
+        local match = sub(result, pos1, pos2)
+        local post = sub(result, pos2 + 1)
+        local wordStart = sub(pre, -1, -1)
+        local wordEnd = sub(post, 1, 1)
+
+        -- additional checks for word boundaries
+        local doesMatchWhen = false
+        if (matchWhen == 2) then
+            -- replace always
+            doesMatchWhen = true
+        elseif (matchWhen == 3) then
+            -- replace only as a whole word
+            if (nilOrEmpty(wordStart) or (find(wordStart,"[%s%p]") ~= nil)) and (nilOrEmpty(wordEnd) or (find(wordEnd, "[%s%p]") ~= nil)) then
+                doesMatchWhen = true
+            end
+        elseif (matchWhen == 4) then
+            -- replace only at start
+            if (nilOrEmpty(wordStart) or (find(wordStart,"[%s%p]") ~= nil)) then
+                doesMatchWhen = true
+            end
+        elseif (matchWhen == 5) then
+            -- replace only at end
+            if (nilOrEmpty(wordEnd) or (find(wordEnd, "[%s%p]") ~= nil)) then
+                doesMatchWhen = true
+            end
+        elseif (matchWhen == 6) then
+            -- replace only at start or end
+            if (nilOrEmpty(wordStart) or (find(wordStart, "[%s%p]") ~= nil) or nilOrEmpty(wordEnd) or (find(wordEnd, "[%s%p]") ~= nil)) then
+                doesMatchWhen = true
+            end
+        elseif (matchWhen == 7) then
+            -- replace only in the middle
+            if (not nilOrEmpty(wordStart) and (find(wordStart, "[%w]") ~= nil) and not nilOrEmpty(wordEnd) and (find(wordEnd, "[%w]") ~= nil)) then
+                doesMatchWhen = true
+            end
+        end
+
+        if (doesMatchWhen) then
+            -- replace substitutions
+            self:TracePrint("ReplaceCharacters : pre: %s, match: %s, post: %s, repl: %s", pre, match, post, replaceText)
+            local caps = { cap1, cap2, cap3, cap4, cap5, cap6, cap7, cap8, cap9 }
+            local replText = replaceCaptures(match, replaceText, caps)
+            tInsert(replacedTexts[replName], replText)
+            self:DebugPrint("ReplaceCharacters : pre: %s, match: %s, post: %s, repl: %s", pre, match, post, replText)
+
+            if (not doExactCase) then
+                local repl, lastCase = "", nil
+                local c, matchRest = getNextCharUtf8(match)
+                local r, replRest = "", replText
+
+                while (c ~= nil) do
+                    r, replRest = getNextCharUtf8(replRest)
+                    r = r or ""
+                    replRest = replRest or ""
+                    self:TracePrint("ReplaceCharacters : c: %s, rest: %s", c, matchRest)
+                    self:TracePrint("ReplaceCharacters : r: %s, rest: %s", r, replRest)
+
+                    if (isUpper(c)) then
+                        -- UPPER-CASE letter
+                        self:TracePrint("ReplaceCharacters : characters: %s => %s", c, toUpper(r))
+                        lastCase = true
+                        repl = repl .. toUpper(r)
+                    elseif (isLower(c)) then
+                        -- lower_case letter
+                        self:TracePrint("ReplaceCharacters : characters: %s => %s", c, toLower(r))
+                        lastCase = false
+                        repl = repl .. toLower(r)
+                    else
+                        -- no letter
+                        self:TracePrint("ReplaceCharacters : characters: %s => %s", c, r)
+                        lastCase = nil
+                        repl = repl .. r
+                    end
+
+                    c, matchRest = getNextCharUtf8(matchRest)
+                end
+
+                self:TracePrint("ReplaceCharacters : remaining length %d", length(replRest))
+                if (length(replRest) > 0) then
+                    local nextLetter, _ = getNextCharUtf8(post)
+                    nextLetter = nextLetter or ""
+
+                    local nextCase = nil
+                    if (isUpper(nextLetter)) then
+                        nextCase = true
+                    elseif (isLower(nextLetter)) then
+                        nextCase = false
+                    end
+
+                    self:TracePrint("ReplaceCharacters : rest: %s, lastCase: %s, nextLetter: %s, nextCase: %s", replRest, lastCase, nextLetter, nextCase)
+
+                    repl = repl .. applyCase(replRest, lastCase, nextCase)
+                end
+
+                replText = repl
+            end
+
+            -- actual replacement
+            result = pre .. replText .. post
+            self:TracePrint("ReplaceCharacters : result: %s", result)
+
+            -- remember positions for consolidate
+            if doConsolidate then
+                tInsert(consolidate[replName], pos1)
+            end
+
+            -- update previous consolidate markers
+            local diff = lengthUtf8(replText) - lengthUtf8(match)
+            self:TracePrint("ReplaceCharacters : diff = %d - %d", lengthUtf8(replText), lengthUtf8(match))
+            for key, posList in pairs(consolidate) do
+                if (key ~= replName) then
+                    for i, pc in ipairs(posList) do
+                        if (pos1 < pc) then
+                            consolidate[key][i] = consolidate[key][i] + diff
+                        end
+                    end
+                end
+            end
+
+            -- replacement text can lengthen or shorten the result
+            -- after replacement text and lowerText can have different sizes
+            pos = pos + diff
+        else
+            self:DebugPrint("ReplaceCharacters : does not match when: %d", matchWhen)
+        end
+
+        findText = result
+        -- update values for next iteration
+        pos1, pos2, cap1, cap2, cap3, cap4, cap5, cap6, cap7, cap8, cap9 = find(findText, searchText, pos)
+        self:TracePrint("ReplaceCharacters : pos1: %d, pos2: %d", pos1, pos2)
+        self:TracePrint("ReplaceCharacters : cap1: %s, cap2: %s, cap3: %s, cap4: %s, cap5: %s, cap6: %s, cap7: %s, cap8: %s, cap9: %s", cap1, cap2, cap3, cap4, cap5, cap6, cap7, cap8, cap9)
+    end
+
+    if (text ~= result) then
+        self:DebugPrint("ReplaceCharacters : replaced \"%s\" with \"%s\" %s", text, result, stopOnMatch and "(stop)" or "")
+    end
+    if (matchWhen > 1) and doConsolidate then
+        self:DebugPrint("ReplaceCharacters : consolidate[" .. replName .. "] is:")
+        self:DebugPrint(consolidate[replName])
+    end
+
+    return result, stopOnMatch
+end
+
+--- Replaces all character occurrences for which replacements have been defined in the options
+-- @param text string
+-- @param replacements table of mappings
+-- @return string
+function Grichelde:ReplaceAndConsolidate(text, replacements)
+    local replacements = replacements or self.db.profile.replacements or {}
+    self:TracePrint("ReplaceAndConsolidate : replacements")
+    self:TracePrint(replacements)
+
+    local result = text
+    local consolidate = {}
+    local replacedTexts = {}
+    local stopOnMatch = nil
+
+    -- replacements are done first
+    for replName, replTable in spairs(replacements) do
+        local searchText = replTable.searchText
+        if (not nilOrEmpty(searchText) and (replTable.matchWhen > 1)) then
+            consolidate[replName] = {}
+            replacedTexts[replName] = {}
+
+            local stop = false
+            result, stop = self:ReplaceCharacters(result, replName, replTable, consolidate, replacedTexts)
+
+            if stop then
+                stopOnMatch = replName
+                self:DebugPrint("ReplaceAndConsolidate : Stopping followup replacements after %s", replName)
+                break
+            end
+        else
+            -- empty mapping or never matched
+            self:DebugPrint("ReplaceAndConsolidate : Skip replacement %s", replName)
+        end
+    end
+
+    -- consolidation is done last
+    for replName, replTable in spairs(replacements) do
+        local before = result
+        local search = replTable.searchText
+
+        if (not nilOrEmpty(search) and (replTable.matchWhen > 1)) then
+            local lowerResult = toLower(result)
+            local offset = 0
+
+            if (replTable.consolidate) then
+                self:DebugPrint("consolidate[" .. replName .. "] is:")
+                self:DebugPrint(consolidate[replName])
+                self:DebugPrint("replacedTexts[" .. replName .. "] is:")
+                self:DebugPrint(replacedTexts[replName])
+
+                for i, pos1 in spairs(consolidate[replName]) do
+                    local replText = replacedTexts[replName][i]
+                    self:DebugPrint("ReplaceAndConsolidate : consolidating \"%s => %s\"", search, replText)
+
+                    local pos2 = pos1 + length(replText) - 1
+                    self:TracePrint("ReplaceAndConsolidate : pos1: %d, pos2: %d", pos1, pos2)
+                    local match = toLower(replText)
+                    local next = sub(lowerResult, pos2 + 1, pos2 + 1 + pos2 - pos1)
+                    self:TracePrint("ReplaceAndConsolidate : match: %s, next: %s", match, next)
+
+                    local _, p2 = find(next, "^" .. match)
+                    self:TracePrint("ReplaceAndConsolidate : p2: %d", p2)
+                    if (p2 ~= nil) then
+                        result = sub(result, 1, pos2 + offset) .. sub(result, pos2 + 1 + p2 + offset)
+
+                        -- consolidation will shorten the resulting text
+                        offset = offset + length(result) - length(lowerResult)
+                    end
+                    self:DebugPrint("ReplaceAndConsolidate : result: %s", result)
+                end
+            end
+
+            if (before ~= result) then
+                self:DebugPrint("ReplaceAndConsolidate : consolidate \"%s\" with \"%s\"", before, result)
+            end
+        else
+            self:DebugPrint("ReplaceAndConsolidate : Skip consolidation for %s", replName)
+        end
+
+        if (stopOnMatch ~= nil) and (stopOnMatch == replName) then
+            break
+        end
+    end
+
+    self:DebugPrint("ReplaceAndConsolidate : final text:", result)
+    return result
+end
+
+--- Checks if the text starts with a preversable ignore pattern, such as itemLinks, textures, raid target icons,
+--- emotes, ooc or %-substitutons and returns the end location of the match, or 0 if no pattern was found
+-- @param text string
+-- @param currentChar string(1) current character (first one) of the text, given for performance reasons
+-- @param previousChar string(1) previous character of the text, otherwise unreachable
+-- @param preserveEmotes boolean ignore replacements for emotes, for testing purposes
+-- @return number
+function Grichelde:CheckForPreversableText(text, currentChar, previousChar, replaceEmotes)
+    self:DebugPrint("CheckForPreversableText : text:", text)
+    local replaceEmotes = replaceEmotes or self.db.profile.channels.emote or false
+
+    -- Calling find on ever pattern might be inefficient but its way less code than marching over every character
+    if (currentChar == "|" ) then
+        for _, pattern in ipairs(Grichelde.IGNORE_PATTERNS.LINKS) do
+            local pos1, pos2 = find(text, "^" .. pattern)
+            if (pos1 == 1) and (pos2 ~= nil) then
+                self:DebugPrint("CheckForPreversableText : Found link or texture pattern \"%s\" at (%d, %d)", pattern, pos1, pos2)
+                return pos2
+            end
+        end
+    end
+
+    -- emote detection
+    if (currentChar == "*" or currentChar == "<") then
+        for _, pattern in ipairs(Grichelde.IGNORE_PATTERNS.EMOTES) do
+            local pos1, pos2 = find(text, "^" .. pattern)
+            if (pos1 == 1) and (pos2 ~= nil) then
+                local emote = sub(text, pos1, pos2)
+                if (not replaceEmotes) then
+                    self:DebugPrint("CheckForPreversableText : Found emote \"%s\" at (%d, %d), but preserved it", emote, pos1, pos2)
+                    return pos2
+                else
+                    self:DebugPrint("CheckForPreversableText : ignoring emote \"%s\" at (%d, %d)", emote, pos1, pos2)
+                end
+            end
+        end
+    end
+
+    local lowerText = toLower(text)
+
+    -- %-substitutions
+    if (currentChar == "%") then
+        for _, pattern in ipairs(Grichelde.IGNORE_PATTERNS.SUBSTITUTES) do
+            local pos1, pos2 = find(lowerText, "^" .. pattern)
+            if (pos1 == 1) and (pos2 ~= nil) then
+                self:DebugPrint("CheckForPreversableText : Found substitute pattern \"%s\" at (%d, %d)", pattern, pos1, pos2)
+                return pos2
+            end
+        end
+    end
+
+    -- raid target markers
+    if (currentChar == "{") then
+        -- rt1-9
+        local pattern = Grichelde.IGNORE_PATTERNS.RAID_TARGETS[1]
+        local pos1, pos2 = find(lowerText, "^" .. pattern)
+        if (pos1 == 1) and (pos2 ~= nil) then
+            self:DebugPrint("CheckForPreversableText : Found raid target marker \"%s\" at (%d, %d)", pattern, pos1, pos2)
+            return pos2
+        end
+
+        for _, localizedRT in ipairs(Grichelde.IGNORE_PATTERNS.LOCALIZED_RAID_TARGETS) do
+            local translation = toLower(self.L["IgnorePattern_" .. localizedRT])
+            local localizedPattern = "^{" .. translation .. "}"
+            self:TracePrint("CheckForPreversableText : localizedPattern:", localizedPattern)
+            local pos1, pos2 = find(lowerText, localizedPattern)
+            if (pos1 == 1) and (pos2 ~= nil) then
+                self:DebugPrint("CheckForPreversableText : Found localized raid target marker \"%s\" at (%d, %d)", localizedPattern, pos1, pos2)
+                return pos2
+            end
+        end
+    end
+
+    -- ooc bracket detection
+    if (currentChar == "(") then
+        for _, pattern in ipairs(Grichelde.IGNORE_PATTERNS.OOC_BRACKETS) do
+            local pos1, pos2 = find(lowerText, "^" .. pattern)
+            if (pos1 == 1) and (pos2 ~= nil) then
+                self:DebugPrint("CheckForPreversableText : Found ooc pattern \"%s\" at (%d, %d)", pattern, pos1, pos2)
+                return pos2
+            end
+        end
+    end
+
+    -- ooc without brackets: remaing text is treated as ooc completely!
+    if (currentChar == "o") then
+        local pattern = Grichelde.IGNORE_PATTERNS.OOC_NO_BRACKETS[1]
+        if ((previousChar == nil) or (find(previousChar, "%s") ~= nil)) and (find(lowerText, pattern) ~= nil) then
+            self:DebugPrint("CheckForPreversableText : ooc for remaing text")
+            return length(text)
+        end
+    end
+
+    self:DebugPrint("CheckForPreversableText : no ignore pattern found")
+    return 0
+end
+
+--- Replaces all character occurrences for which replacements have been defined in the options,
+--- while preserving any itemLinks or textures. (http://www.wowwiki.com/ItemLink)
+-- @param text string the text to apply the mappings on
+-- @param preserveEmotes boolean ignore replacements for emotes, for testing purposes
+-- @return string
+function Grichelde:ReplaceText(text, replacements, replaceEmotes)
+    local lookAheads = { '|', '*', '<', '%', '{', '(', 'o' }
+    local newText = text
+    local preserveEmotes = replaceEmotes or self.db.profile.channels.emote or false
+    local replacements = replacements or self.db.profile.replacements or {}
+    local finalText = ""
+
+    local currentChar, previousChar
+    local current = 1
+    local lastStart = 1
+
+    -- no UTF-8 support required here, as the positions are used
+    while current <= length(newText) do
+        previousChar = currentChar
+        currentChar = sub(newText, current, current)
+        self:TracePrint("ReplaceText : current/char : %s,%s", current, currentChar)
+
+        -- as there is not OR in Luas pattern matching, search for all of the exclude patterns after another is
+        -- cumbersome and inefficient -> look for each char consecutively if it matches the starting pattern only
+        -- and if if matches do full pattern matching
+        if (not tContains(lookAheads, currentChar)) then
+            current = current + 1
+        else
+            -- lookahead-check for all preservable patterns (itemLinks, textures, emotes, ooc, etc.)
+            local textAhead = sub(newText, current)
+            local posEnd = self:CheckForPreversableText(textAhead, currentChar, previousChar, preserveEmotes)
+            if (posEnd > 0) then
+                self:DebugPrint("ReplaceText : Found an ignore pattern")
+
+                -- split text and continue after preserved text
+                local textBefore = sub(newText, lastStart, current - 1)
+                local replacement = self:ReplaceAndConsolidate(textBefore, replacements)
+                local preservedText = sub(textAhead, 1, posEnd)
+
+                finalText = finalText .. replacement .. preservedText
+                current = current + posEnd
+                lastStart = current
+                self:DebugPrint("ReplaceText : restarting at", lastStart)
+            else
+                -- no corresponding end was found to start pattern, continue loop with next char
+                current = current + 1
+            end
+        end
+    end
+
+    -- catchup remaining text to the end
+    local remainingText = sub(newText, lastStart)
+    local replacement = self:ReplaceAndConsolidate(remainingText, replacements)
+    finalText = finalText .. replacement
+
+    self:DebugPrint("ReplaceText : replaced \"%s\"", text)
+    self:DebugPrint("ReplaceText : with        \"%s\"", finalText)
+    return finalText
+end
+
+function Grichelde:IsOneBigEmote(text)
+    local firstWord, _ = self:SplitOnFirstMatch(text)
+    assert(firstWord ~= nil, "firstWord is never nil")
+
+    -- emote detection
+    local isEmote = false
+    -- scheme *emote*
+    if (sub(firstWord, 1, 1) == "<") then
+        -- search for emote end
+        local _, emoteEnd = find(text, "%>", 2)
+        isEmote = (emoteEnd == length(text))
+    end
+    if (not isEmote and (sub(firstWord, 1, 1) == "*")) then
+        -- search for emote end
+        local _, emoteEnd = find(text, "%*", 2)
+        isEmote = (emoteEnd == length(text))
+    end
+    -- scheme **emote**
+    if (not isEmote and (sub(firstWord, 1, 2) == "**")) then
+        -- search for emote end
+        local _, emoteEnd = find(text, "%*%*", 3)
+        isEmote = (emoteEnd == length(text))
+    end
+
+    -- the whole text is one big emote
+    return isEmote
+end
+
+function Grichelde:ConvertBlizzTypeToOption(channel)
+    local option = tFilter(self.BLIZZ_TYPE_TO_OPTIONS,
+        function(_, k, _) return channel == k end)
+    if (not tIsEmpty(option)) then
+        self:DebugPrint("ConvertBlizzTypeToOption : convert %s to %s", channel, option[1])
+        return option[1]
+    else
+        return nil
+    end
+end
+
+--- Checks if a message can be replaced according to configuration.
+-- @return boolean
+function Grichelde:CheckReplacementAllowed(text, channel)
+    self:DebugPrint("CheckReplacementAllowed : text:", text)
+
+    -- skip if disabled
+    if (not self.db.profile.enabled) then
+        self:DebugPrint("CheckReplacementAllowed : disabled")
+        return false
+    end
+
+    -- skip if no text
+    if (nilOrEmpty(text)) then
+        return false
+    end
+
+    -- skip if wrong channel
+    local chan = self:ConvertBlizzTypeToOption(channel)
+    local allowedChannels = tFilter(self.db.profile.channels,
+        function(_, k, v) return k == chan and v == true end,
+        function(_, k, _) return k end
+    )
+    self:DebugPrint("CheckReplacementAllowed : allowed channels:")
+    self:DebugPrint(allowedChannels)
+
+    if (tIsEmpty(allowedChannels)) then
+        self:DebugPrint("CheckReplacementAllowed : skip channel type:", chan)
+        return false
+    end
+
+    local firstWord, _ = self:SplitOnFirstMatch(text)
+    assert(firstWord ~= nil, "firstWord is never nil")
+
+    -- don't replace slash commands
+    if (sub(firstWord, 1, 1) == "/") then
+        self:DebugPrint("CheckReplacementAllowed : skip other slash commands:", firstWord)
+        return false
+    end
+
+    -- emote detection
+    if (self:IsOneBigEmote(text)) then
+        self:DebugPrint("CheckReplacementAllowed : one big emote")
+        return self.db.profile.channels.emote
+    end
+
+    -- in any other case, treat as ordinary text or emote
+    return true
+end
+
+--- Checks if the text from the Grichelde slash command can be replaced and if so
+--- returns the replacable text, the chat type and target (player or channel) from the message text.
+--- self is used the the override slash command: "/gri /emote text to replace".
+-- @param message (string) the whole message
+-- @return message (string) stripped message
+-- @return type (string) chat type
+-- @return channel (string|number) channel number for whispers
+function Grichelde:CheckAndExtractMessageTypeTarget(message)
+    self:DebugPrint("CheckAndExtractMessageTypeTarget : text:", message)
+
+    -- skip if no further text
+    if (nilOrEmpty(message)) then
+        -- dont send text at all
+        return nil
+    end
+
+    -- first word should be a chat command
+    if (sub(message, 1, 1) == "/") then
+        -- extract chat command
+        local chatCmd, targetAndText = self:SplitOnFirstMatch(message)
+        assert(chatCmd ~= nil, "chatCmd is never nil")
+
+        local type = tFilter(self.SUPPORTED_CHAT_COMMANDS,
+            function(_, k, _) return chatCmd == k end
+        )
+        assert(#type < 2)
+
+        if (not tIsEmpty(type)) then
+            self:DebugPrint("CheckAndExtractMessageTypeTarget : determined type: %s", type[1])
+
+            -- valid /chattype
+            if (type[1] == "WHISPER") then
+                -- special reply handling
+                if ("/r" == chatCmd) or ("/reply" == chatCmd) then
+                    -- reuse last type and target if possible
+                    local lastTold, lastToldType = ChatEdit_GetLastToldTarget()
+                    self:DebugPrint("CheckAndExtractMessageTypeTarget : lastTell, lastTellType =", lastTold, lastToldType)
+                    return targetAndText, lastToldType or "WHISPER", lastTold
+                elseif ("/tt" == chatCmd) then
+                    -- determine target from game world selection
+                    if (not UnitExists("target") or not UnitIsPlayer("target")) then
+                        self:ErrorPrint(self.L.Error_InvalidWhisperTarget)
+                        -- dont send text at all
+                        return nil
+                    end
+
+                    local target = UnitName("target");
+                    if (target == nil) then
+                        self:ErrorPrint(self.L.Error_InvalidWhisperTarget)
+                        -- dont send text at all
+                        return nil
+                    end
+
+                    -- eventually we found our target
+                    self:DebugPrint("CheckAndExtractMessageTypeTarget : target:", target)
+                    return targetAndText, "WHISPER", target
+                else
+                    -- determine target from text
+                    local target, text = self:SplitOnFirstMatch(targetAndText)
+                    if (target == nil) then
+                        self:ErrorPrint(self.L.Error_InvalidWhisperTarget)
+                        -- dont send text at all
+                        return nil
+                    end
+
+                    -- eventually we found our target
+                    self:DebugPrint("CheckAndExtractMessageTypeTarget : determined target:", target)
+                    return text, "WHISPER", target
+                end
+            else
+                -- all other chat types
+                return targetAndText, type[1], nil
+            end
+        else
+            self:DebugPrint("CheckAndExtractMessageTypeTarget : not a standard channel: %s", chatCmd)
+
+            -- if not a valid chat command, try as a numbered channel
+            local _, _, channelNumber = find(chatCmd, "^/(%d+)")
+            if (channelNumber ~= nil) then
+                local channelId = GetChannelName(channelNumber)
+                if (channelId ~= nil) then
+                    return targetAndText, "CHANNEL", channelId
+                end
+            end
+
+            -- ignore any other slash commands
+            self:ErrorPrint(self.L.Error_InvalidChannel)
+            -- dont send text at all
+            return nil
+        end
+    elseif self:IsOneBigEmote(message) then
+        self:DebugPrint("CheckAndExtractMessageTypeTarget : determined EMOTE type")
+        return message, "EMOTE", nil
+    else
+        -- in any other case, treat as ordinary text, assume default type and channel
+        return message
+    end
+end
+
+function Grichelde:CleanseMessage(message)
+    local text = message or ""
+    if (IsAddOnLoaded("Misspelled")) then
+        self:DebugPrint("Misspelled detected: cleansing message")
+        text = _G.Misspelled:RemoveHighlighting(message)
+    end
+    return trim(text)
+end
+
+--- Always replaces the text accoording to the configuration, even if activation or channel was disabled.
+--- self is used the the override slash command: "/gri /emote text to replace".
+--- NOTE: type and channel (in case of whispers) are determined from the message text.
+-- @param message string
+-- @param type string
+function Grichelde:SendChatMessageOverride(message, ...)
+    local cleasendText = self:CleanseMessage(message)
+
+    local fallbackType, fallbackLang = DEFAULT_CHAT_FRAME.editBox.chatType or "SAY", DEFAULT_CHAT_FRAME.editBox.languageID
+    local msg, type, chan = self:CheckAndExtractMessageTypeTarget(cleasendText)
+
+    if (msg ~= nil) then
+        msg = self:ReplaceText(msg)
+
+        if (type ~= nil) then
+            self:SendChunkifiedChatMessage(msg, type, fallbackLang, chan, ...)
+        else
+            self:SendChunkifiedChatMessage(msg, fallbackType, fallbackLang, chan, ...)
+        end
+    else
+        -- suppress invalid messages/channels/targets
+    end
+end
+
+--- Before a chat message is sent, check if replacement is required and replace the text accordingly.
+-- @param message string
+-- @param type string
+-- @param language string
+-- @param channel string
+function Grichelde:SendChatMessage(message, type, ...)
+    if (not self.db.profile.enabled) then
+        self:DebugPrint("SendChatMessage : disabled")
+        self.hooks["SendChatMessage"](message, type, ...);
+    elseif (nilOrEmpty(message)) then
+        self:DebugPrint("SendChatMessage : no text")
+        self.hooks["SendChatMessage"](message, type, ...);
+    else
+        local cleasendText = self:CleanseMessage(message)
+        if (self:CheckReplacementAllowed(cleasendText, type)) then
+            cleasendText = self:ReplaceText(cleasendText)
+            self:SendChunkifiedChatMessage(cleasendText, type, ...)
+        else
+            self.hooks["SendChatMessage"](message, type, ...);
+        end
+    end
+end

GricheldeConstants.lua

@@ -0,0 +1,435 @@
+-- read namespace from global env
+local _G = _G
+local Grichelde = _G.Grichelde or {}
+
+-- constants and upvalues
+Grichelde.LOG_LEVEL = { DEBUG = 1, TRACE = 2 }
+
+Grichelde.MAPPING_OFFSET = 10
+Grichelde.MINIMAP_ENABLED = 1.0
+Grichelde.MINIMAP_DARKENDED = 0.5
+
+Grichelde.ICONS = {
+    MOVE_UP = "Interface\\MainMenuBar\\UI-MainMenu-ScrollUpButton-Up",
+    MOVE_UP_DISABLED = "Interface\\MainMenuBar\\UI-MainMenu-ScrollUpButton-Disabled",
+    MOVE_DOWN = "Interface\\MainMenuBar\\UI-MainMenu-ScrollDownButton-Up",
+    MOVE_DOWN_DISABLED = "Interface\\MainMenuBar\\UI-MainMenu-ScrollDownButton-Disabled",
+    DELETE = "Interface\\Buttons\\UI-Panel-MinimizeButton-Up",
+    DELETE_DISABLED = "Interface\\Buttons\\UI-Panel-MinimizeButton-Disabled",
+}
+
+-- colors:
+Grichelde.COLORS = {
+    NORMAL    = _G.NORMAL_FONT_COLOR,
+    HIGHLIGHT = _G.HIGHLIGHT_FONT_COLOR,
+    RED       = _G.RED_FONT_COLOR,
+    GREEN     = _G.GREEN_FONT_COLOR,
+}
+
+Grichelde.COLOR_CODES = {
+    PREFIX      = "|c00FFAA00",
+    -- https://github.com/stoneharry/Misc-WoW-Stuff/blob/master/EoC%20Interface/FrameXML/Constants.lua
+    NORMAL      = _G.NORMAL_FONT_COLOR_CODE      or "|cffffd200",
+    HIGHLIGHT   = _G.HIGHLIGHT_FONT_COLOR_CODE   or "|cffffffff",
+    RED         = _G.RED_FONT_COLOR_CODE         or "|cffff2020",
+    GREEN       = _G.GREEN_FONT_COLOR_CODE       or "|cff20ff20",
+    LIGHTGRAY   = "|cffC0C0C0",
+    GRAY        = _G.GRAY_FONT_COLOR_CODE        or "|cff808080",
+    DARKGRAY    = "|cff404040",
+    YELLOW      = _G.YELLOW_FONT_COLOR_CODE      or "|cffffff00",
+    LIGHTYELLOW = _G.LIGHTYELLOW_FONT_COLOR_CODE or "|cffffff9a",
+    ORANGE      = _G.ORANGE_FONT_COLOR_CODE      or "|cffff7f3f",
+    CLOSE       = _G.FONT_COLOR_CODE_CLOSE       or "|r",
+}
+
+Grichelde.SLASH_COMMANDS = { "gri", "grichelde" }
+
+Grichelde.SUPPORTED_CHAT_COMMANDS = {
+    ["/s"]               = "SAY",
+    ["/say"]             = "SAY",
+    ["/sprechen"]        = "SAY",
+    ["/c"]               = "CHANNEL",
+    ["/csay"]            = "CHANNEL",
+    ["/e"]               = "EMOTE",
+    ["/em"]              = "EMOTE",
+    ["/me"]              = "EMOTE",
+    ["/emote"]           = "EMOTE",
+    ["/y"]               = "YELL",
+    ["/yell"]            = "YELL",
+    ["/sh"]              = "YELL",
+    ["/shout"]           = "YELL",
+    ["/schreien"]        = "YELL",
+    ["/sch"]             = "YELL",
+    ["/p"]               = "PARTY",
+    ["/party"]           = "PARTY",
+    ["/gruppe"]          = "PARTY",
+    ["/pl"]              = "PARTY",
+    ["/partyleader"]     = "PARTY",
+    ["/g"]               = "GUILD",
+    ["/gc"]              = "GUILD",
+    ["/guild"]           = "GUILD",
+    ["/gilde"]           = "GUILD",
+    ["/o"]               = "OFFICER",
+    ["/osay"]            = "OFFICER",
+    ["/officer"]         = "OFFICER",
+    ["/offizier"]        = "OFFICER",
+    ["/raid"]            = "RAID",
+    ["/rsay"]            = "RAID",
+    ["/rl"]              = "RAID",
+    ["/rsay"]            = "RAID",
+    ["/raidleader"]      = "RAID",
+    ["/schlachtzug"]     = "RAID",
+    ["/rw"]              = "RAID_WARNING",
+    ["/raidwarning"]     = "RAID_WARNING",
+    ["/i"]               = "INSTANCE_CHAT",
+    ["/instance"]        = "INSTANCE_CHAT",
+    ["/instanz"]         = "INSTANCE_CHAT",
+    ["/bg"]              = "BATTLEGROUND",
+    ["/battleground"]    = "BATTLEGROUND",
+    ["/schlachfeld"]     = "BATTLEGROUND",
+    ["/w"]               = "WHISPER",
+    ["/whisper"]         = "WHISPER",
+    ["/t"]               = "WHISPER",
+    ["/tell"]            = "WHISPER",
+    ["/send"]            = "WHISPER",
+    ["/tt"]              = "WHISPER",
+    ["/r"]               = "WHISPER",
+    ["/reply"]           = "WHISPER",
+    ["/fl\195\188stern"] = "WHISPER",
+    ["/antworten"]       = "WHISPER",
+}
+
+Grichelde.BLIZZ_TYPE_TO_OPTIONS = {
+    ["SAY"]          = "say",
+    ["EMOTE"]        = "emote",
+    ["YELL"]         = "yell",
+    ["PARTY"]        = "party",
+    ["GUILD"]        = "guild",
+    ["OFFICER"]      = "officer",
+    ["RAID"]         = "raid",
+    ["RAID_WARNING"] = "raidWarning",
+    ["INSTANCE"]     = "instance",
+    ["BATTLEGROUND"] = "battleground",
+    ["WHISPER"]      = "whisper",
+}
+
+-- do not replace these patterns
+Grichelde.IGNORE_PATTERNS = {
+    LINKS = {
+        "|[Cc]%x%x%x%x%x%x%x%x.-|r", -- colored items (or links)
+        "|H.-|h",     -- item links (http://www.wowwiki.com/ItemLink)
+        "|T.-|t",     -- textures
+        "|K.-|k",     -- Battle.net
+        "|n",         -- newline
+    },
+    EMOTES = {
+        "%*.-%*",     -- emotes *
+        "%*%*.-%*%*", -- emotes **
+        "%<.-%>",     -- emotes < >
+    },
+    SUBSTITUTES = {
+        "%%n",   -- player's name
+        "%%z",   -- player's currnt zone
+        "%%sz",  -- player's current sub-zone
+        "%%loc", -- player's map coordinates
+        "%%t",   -- name of target
+        "%%f",   -- name of focus target
+        "%%m",   -- name of mouseover unit
+        "%%p",   -- name of player pet
+        "%%tt",  -- name of player's target's target
+    },
+    RAID_TARGETS = {
+        "{rt[1-8]}", -- rumbered raid target icons, localized raid targets are handled differently
+    },
+    LOCALIZED_RAID_TARGETS = {
+        "Star",
+        "Circle",
+        "Diamond",
+        "Triangle",
+        "Moon",
+        "Square",
+        "Cross",
+        "Skull",
+    },
+    OOC_BRACKETS = {
+        "%(%(.-%)%)",           -- (( ... ))
+        "%(%s*ooc[%:%s].-%)",   -- ( ooc )
+    },
+    OOC_NO_BRACKETS = {
+        "ooc[%:%s]",
+    },
+}
+
+local function nilOrEmpty(s)
+    return s == nil or s:trim() == ""
+end
+
+local function spairs(t, orderFunc)
+    -- collect the keys
+    local sortedKeys = {}
+    -- for every non-nil value
+    for key, _ in Grichelde.F.pairs(t) do
+        Grichelde.F.tInsert(sortedKeys, key)
+    end
+
+    if (orderFunc ~= nil) then
+        Grichelde.F.tSort(sortedKeys, function(a, b) return orderFunc(sortedKeys, a, b) end)
+    else
+        -- lexicographical order
+        Grichelde.F.tSort(sortedKeys)
+    end
+
+    -- return the iterator function
+    local it = 0
+    return function()
+        it = it + 1
+        if (sortedKeys[it] ~= nil) then
+            return sortedKeys[it], t[sortedKeys[it]]
+        else
+            return nil
+        end
+    end
+end
+
+local function tFilter(t, condition, extract)
+    local filtered = {}
+    for key, value in Grichelde.F.pairs(t) do
+        local cond = false
+        if (condition) then
+            local t = Grichelde.F.type(condition)
+            if (t == "function") then
+                cond = condition(t, key, value)
+            elseif (t == "string") or (t == "number") then
+                cond = (value == condition)
+            end
+        end
+
+        if (cond) then
+            local val = value
+            if (extract and (Grichelde.F.type(extract) == "function")) then
+                val = extract(t, key, value)
+            end
+            Grichelde.F.tInsert(filtered, val)
+        end
+    end
+    return filtered
+end
+
+local function tSize(t)
+    local size = 0
+    if (t ~= nil) then
+        -- for every non-nil value
+        for _, _ in Grichelde.F.pairs(t) do
+            size = size + 1
+        end
+    end
+    return size
+end
+
+local function tIsEmpty(t)
+    if (not t) then return true end
+    return Grichelde.F.tNext(t) == nil
+end
+
+local function tClone(orig)
+    local orig_type = Grichelde.F.type(orig)
+    local copy
+    if (orig_type == 'table') then
+        copy = {}
+        -- for every non-nil value
+        for orig_key, orig_value in Grichelde.F.tNext, orig, nil do
+            copy[tClone(orig_key)] = tClone(orig_value)
+        end
+        Grichelde.F.setmetatable(copy, tClone(Grichelde.F.getmetatable(orig)))
+    else -- number, string, boolean, etc
+        copy = orig
+    end
+    return copy
+end
+
+local function getNextCharUtf8(word)
+    if ((word == nil) or (Grichelde.F.type(word) ~= "string") or (Grichelde.F.length(word) < 1)) then
+        return nil, nil
+    end
+
+    local wordLength = Grichelde.F.length(word)
+    local c1 = Grichelde.F.toByte(word, 1)
+    if (c1 > 0) and (c1 <= 127) then
+        -- UTF8-1
+        return Grichelde.F.bytes2Char(c1), Grichelde.F.sub(word, 2)
+    elseif (c1 >= 194) and (c1 <= 223) then
+        -- UTF8-2
+        Grichelde.F.assert(wordLength >= 2, "broken UTF-8 character")
+        local c2 = Grichelde.F.toByte(word, 2)
+        return Grichelde.F.bytes2Char(c1, c2), Grichelde.F.sub(word, 3)
+    elseif (c1 >= 224) and (c1 <= 239) then
+        -- UTF8-3
+        Grichelde.F.assert(wordLength >= 3, "broken UTF-8 character")
+        local c2 = Grichelde.F.toByte(word, 2)
+        local c3 = Grichelde.F.toByte(word, 3)
+        return Grichelde.F.bytes2Char(c1, c2, c3), Grichelde.F.sub(word, 4)
+    elseif (c1 >= 240) and (c1 <= 244) then
+        -- UTF8-4
+        Grichelde.F.assert(wordLength >= 4, "broken UTF-8 character")
+        local c2 = Grichelde.F.toByte(word, 2)
+        local c3 = Grichelde.F.toByte(word, 3)
+        local c4 = Grichelde.F.toByte(word, 4)
+        return Grichelde.F.bytes2Char(c1, c2, c3, c4), Grichelde.F.sub(word, 5)
+    else
+        return nil, nil
+    end
+end
+
+local function isLetter(word)
+    local char = Grichelde.F.getNextCharUtf8(word)
+    return (char ~= nil) and (Grichelde.F.toUpper(char) ~= Grichelde.F.toLower(char))
+end
+
+local function isNumber(digit)
+    if ((digit == nil) or (Grichelde.F.type(digit) ~= "string") or (Grichelde.F.length(digit) < 1)) then
+        return false
+    else
+        return Grichelde.F.find(digit, "%d+") ~= nil
+    end
+end
+
+local function isUpper(word)
+    if ((word == nil) or (Grichelde.F.type(word) ~= "string") or (Grichelde.F.length(word) < 1)) then
+        return false
+    elseif (Grichelde.F.toUpper(word) == Grichelde.F.toLower(word)) then
+        return false
+    else
+        return word == Grichelde.F.toUpper(word)
+    end
+end
+
+local function isLower(word)
+    if ((word == nil) or (Grichelde.F.type(word) ~= "string") or (Grichelde.F.length(word) < 1)) then
+        return false
+    elseif (Grichelde.F.toUpper(word) == Grichelde.F.toLower(word)) then
+        return false
+    else
+        return word == Grichelde.F.toLower(word)
+    end
+end
+
+local function isCapital(word)
+    if ((word == nil) or (Grichelde.F.type(word) ~= "string") or (Grichelde.F.length(word) < 1)) then
+        return false
+    else
+        local first, rest = Grichelde.F.getNextCharUtf8(word)
+        local isCapital = Grichelde.F.isUpper(first)
+        if (rest ~= nil) then
+            return isCapital and Grichelde.F.isLower(rest)
+        else
+           return isCapital
+        end
+    end
+end
+
+local function capitalize(word)
+    if ((word == nil) or (Grichelde.F.type(word) ~= "string") or (Grichelde.F.length(word) < 1)) then
+        return ""
+    else
+        local first, rest = Grichelde.F.getNextCharUtf8(word)
+        local capital = Grichelde.F.toUpper(first)
+        if (rest ~= nil) then
+            return capital .. Grichelde.F.toLower(rest)
+        else
+           return capital
+        end
+    end
+end
+
+local function color(color, text)
+    return color .. text .. Grichelde.COLOR_CODES.CLOSE
+end
+
+local function cPrefix(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.PREFIX, text)
+end
+
+local function cYellow(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.NORMAL, text)
+end
+
+local function cGray(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.GRAY, text)
+end
+
+local function cDarkgray(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.DARKGRAY, text)
+end
+
+local function cGreen(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.GREEN, text)
+end
+
+local function cOrange(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.ORANGE, text)
+end
+
+local function cRed(text)
+    return Grichelde.F.color(Grichelde.COLOR_CODES.RED, text)
+end
+
+-- faster function lookups by mapping to local refs
+Grichelde.F = {
+    IsAddOnLoaded   = _G.IsAddOnLoaded,
+    assert          = _G.assert,
+    type            = _G.type,
+    print           = _G.print,
+    nilOrEmpty      = nilOrEmpty,
+    pairs           = _G.pairs,
+    ipairs          = _G.ipairs,
+    spairs          = spairs,
+    tContains       = _G.tContains,
+    tFilter         = tFilter,
+    tInsert         = _G.table.insert,
+    tConcat         = _G.table.concat,
+    tSize           = tSize,
+    tIsEmpty        = tIsEmpty,
+    tSort           = _G.table.sort,
+    tClone          = tClone,
+    tNext           = _G.next,
+    tWipe           = _G.wipe,
+    setmetatable    = _G.setmetatable,
+    getmetatable    = _G.getmetatable,
+    select          = _G.select,
+    unpack          = _G.unpack,
+    find            = _G.string.find,
+    sub             = _G.string.sub,
+    gsub            = _G.string.gsub,
+    match           = _G.strmatch,
+    gmatch          = _G.string.gmatch,
+    join            = _G.strjoin,
+    split           = _G.strsplit,
+    toUpper         = _G.strupper,
+    toLower         = _G.strlower,
+    getNextCharUtf8 = getNextCharUtf8,
+    isLetter        = isLetter,
+    isNumber        = isNumber,
+    isUpper         = isUpper,
+    isLower         = isLower,
+    isCapital       = isCapital,
+    capitalize      = capitalize,
+    color           = color,
+    cPrefix         = cPrefix,
+    cYellow         = cYellow,
+    cGray           = cGray,
+    cDarkgray       = cDarkgray,
+    cGreen          = cGreen,
+    cOrange         = cOrange,
+    cRed            = cRed,
+    toByte          = _G.string.byte,
+    bytes2Char      = _G.string.char,
+    format          = _G.string.format,
+    rep             = _G.string.rep,
+    trim            = _G.strtrim,
+    length          = _G.string.len,
+    lengthUtf8      = _G.strlenutf8,
+    toString        = _G.tostring,
+    toNumber        = _G.tonumber,
+    max             = _G.math.max,
+    min             = _G.math.min,
+}

GricheldeDatabase.lua

@@ -0,0 +1,161 @@
+-- read namespace from global env
+local _G = _G
+local Grichelde = _G.Grichelde or {}
+
+local pairs, tInsert, tClone, tWipe, unpack, join, toString
+    = Grichelde.F.pairs, Grichelde.F.tInsert, Grichelde.F.tClone, Grichelde.F.tWipe, Grichelde.F.unpack, Grichelde.F.join, Grichelde.F.toString
+
+function Grichelde.getDefaultConfig()
+    return {
+        global = {},
+        profile = {
+            enabled = true,
+            minimapButton = {
+                hide = false
+            },
+            channels = {
+                ["*"] = false,
+                say = true,
+                emote = false,
+                yell = true,
+                party = true,
+                guild = true,
+                officer = true,
+            },
+            replacements = {
+                ["**"] = {
+                    order = 999,
+                    searchText = "",
+                    replaceText = "",
+                    exactCase = false,
+                    consolidate = true,
+                    matchWhen = 2,
+                    stopOnMatch = false,
+                },
+            }
+        }
+    }
+end
+
+function Grichelde.getDefaultSampleMappings()
+    return {
+        replacement_10 = {
+            order = 10,
+            searchText = "s",
+            replaceText = "ch",
+            exactCase = false,
+            consolidate = true,
+            matchWhen = 2,
+            stopOnMatch = false,
+        },
+        replacement_11 = {
+            order = 11,
+            searchText = "t",
+            replaceText = "ck",
+            exactCase = false,
+            consolidate = true,
+            matchWhen = 2,
+            stopOnMatch = false,
+        },
+        replacement_12 = {
+            order = 12,
+            searchText = "p",
+            replaceText = "b",
+            exactCase = false,
+            consolidate = true,
+            matchWhen = 2,
+            stopOnMatch = false,
+        }
+    }
+end
+
+function Grichelde:LoadDatabase()
+    local db = LibStub("AceDB-3.0"):New(self.name .."DB", self.getDefaultConfig(), true)
+
+    db.RegisterCallback(self, "OnNewProfile", "RefreshProfiles")
+    db.RegisterCallback(self, "OnProfileChanged", "RefreshProfiles")
+    db.RegisterCallback(self, "OnProfileDeleted", "RefreshProfiles")
+    db.RegisterCallback(self, "OnProfileCopied", "RefreshProfiles")
+    db.RegisterCallback(self, "OnProfileReset", "RefreshProfiles")
+    db.RegisterCallback(self, "OnProfileShutdown", "RefreshProfiles")
+
+    return db
+end
+
+function Grichelde:SyncToDatabase(info, val)
+    self:TracePrint("SyncToDatabase : info")
+    for i = 0, #info do
+        self:TracePrint("%d = %s", i, info[i])
+    end
+
+    local option = self.db.profile
+    local path = 1
+    while (path < #info) do
+        if (info[path] ~= "mappings") then
+            option = option[info[path]]
+        end
+        path = path + 1
+    end
+    local optionPath = join(".", unpack(info, 1, #info))
+    self:DebugPrint("change option \"%s\" from %s to %s", optionPath, toString(option[info[path]]), toString(val))
+    option[info[path]] = val
+end
+
+function Grichelde:ReadFromDatabase(info)
+    self:TracePrint("ReadFromDatabase : info")
+    for i = 0, #info do
+        self:TracePrint("%d = %s", i, info[i])
+    end
+
+    local option = self.db.profile
+    local path = 1
+    while (path <= #info) do
+        if (info[path] ~= "mappings") then
+            option = option[info[path]]
+        end
+        path = path + 1
+    end
+    local optionPath = join(".", unpack(info, 1, #info))
+    self:DebugPrint("read option \"%s\": %s", optionPath, toString(option))
+    return option
+end
+
+--- Sorts a replacements table by order sub-field and rename.
+--- Do NOT reassign self.db.profile.replacements here or with its output as it will break defaults
+function Grichelde:ReorderReplacements(replacements)
+    local repls = replacements or self.db.profile.replacements or {}
+
+    self:TracePrint("ReorderReplacements : unsorted table")
+    self:TracePrint(repls)
+
+    local orderToName = {}
+    local size = 0
+    for replName, replTable in pairs(repls) do
+        size = size + 1
+        tInsert(orderToName, replTable.order, replName)
+    end
+
+    self:TracePrint("ReorderReplacements : size: %d, orderToName", size)
+    self:TracePrint(orderToName)
+
+    local sorted = {}
+    local index, count = 0, 0
+
+    while count < size do
+        local replName = orderToName[index]
+        if (replName ~= nil) and (repls[replName] ~= nil) then
+            self:TracePrint("ReorderReplacements : replName: %s, replTable", replName)
+            self:TracePrint(repls[replName])
+            local order = Grichelde.MAPPING_OFFSET + count
+            sorted["replacement_" .. order] = tClone(repls[replName])
+            sorted["replacement_" .. order].order = order
+            count = count + 1
+        end
+        index = index + 1
+        if (index > 999) then break end
+    end
+
+--  self:TracePrint("ReorderReplacements : sorted")
+--  self:TracePrint(sorted)
+    return sorted
+end

GricheldeMinimap.lua

@@ -0,0 +1,146 @@
+-- read namespace from global env
+local _G = _G
+local Grichelde = _G.Grichelde or {}
+
+local cPrefix, cGreen, cRed
+    = Grichelde.F.cPrefix, Grichelde.F.cGreen, Grichelde.F.cRed
+
+
+--- add Minimap button
+function Grichelde:MinimapButton()
+    local function clickHandler(_, button)
+        if (button == "LeftButton") then
+            self:ToggleOptions()
+        elseif (button == "RightButton") then
+            self:ToggleActivation()
+        end
+    end
+
+    local function updateTooltip(tooltip)
+        if (tooltip == nil) or (tooltip.AddLine == nil) then return end
+
+        local tooltipTitle = self:Format(self.L.Minimap_Tooltip_Enabled, self.L.AddonName)
+        if not self.db.profile.enabled then
+            tooltipTitle = self:Format(self.L.Minimap_Tooltip_Disabled, self.L.AddonName)
+        end
+
+        tooltip:SetText(tooltipTitle,
+            Grichelde.COLORS.HIGHLIGHT.r, Grichelde.COLORS.HIGHLIGHT.g, Grichelde.COLORS.HIGHLIGHT.b, Grichelde.COLORS.HIGHLIGHT.a
+        )
+
+        tooltip:AddDoubleLine(self.L.Minimap_Tooltip_Options_Left, self.L.Minimap_Tooltip_Options_Right,
+            Grichelde.COLORS.GREEN.r, Grichelde.COLORS.GREEN.g, Grichelde.COLORS.GREEN.b, Grichelde.COLORS.GREEN.a,
+            Grichelde.COLORS.NORMAL.r, Grichelde.COLORS.NORMAL.g, Grichelde.COLORS.NORMAL.b, Grichelde.COLORS.NORMAL.a
+        )
+        tooltip:AddDoubleLine(self.L.Minimap_Tooltip_Mappings_Left, self.L.Minimap_Tooltip_Mappings_Right,
+            Grichelde.COLORS.GREEN.r, Grichelde.COLORS.GREEN.g, Grichelde.COLORS.GREEN.b, Grichelde.COLORS.GREEN.a,
+            Grichelde.COLORS.NORMAL.r, Grichelde.COLORS.NORMAL.g, Grichelde.COLORS.NORMAL.b, Grichelde.COLORS.NORMAL.a
+        )
+    end
+
+    local darkened = Grichelde.MINIMAP_ENABLED
+    if (self.db.profile.enabled == false) then
+        darkened = Grichelde.MINIMAP_DARKENDED
+    end
+
+    local ldb = LibStub("LibDataBroker-1.1"):NewDataObject(self.name, {
+        type = "launcher",
+        text = self.AddonName,
+        icon = "Interface\\Icons\\Spell_Holy_Silence",
+        --icon = ([[Interface\Addons\%s\%s]]):format(self.name, self.name),
+        OnClick = clickHandler,
+        OnRightClick = function() self:ShowMappings() end,
+        OnTooltipShow = updateTooltip,
+        iconR = darkened,
+        iconG = darkened,
+        iconB = darkened
+    })
+
+    local icon = LibStub("LibDBIcon-1.0")
+    self:DebugPrint("MinimapButton : hidden: ", self.db.profile.minimapButton.hide)
+    icon:Register(self.name, ldb, self.db.profile.minimapButton)
+
+    return ldb, icon
+end
+
+function Grichelde:ToggleMinimapButton()
+    self.db.profile.minimapButton.hide = not self.db.profile.minimapButton.hide
+    self:DebugPrint("ToggleMinimapButton : hidden: ", self.db.profile.minimapButton.hide)
+
+    if (self.db.profile.minimapButton.hide == true) then
+        self:HideMinimapButton()
+    else
+        self:ShowMinimapButton()
+    end
+end
+
+function Grichelde:ShowMinimapButton()
+    if (self.icon ~= nil) then
+        self.icon:Show(self.name)
+    end
+end
+
+function Grichelde:HideMinimapButton()
+    if (self.icon ~= nil) then
+        self.icon:Hide(self.name)
+    end
+end
+
+function Grichelde:ToggleActivation()
+    if (self.db.profile.enabled == true) then
+        if (self.dialog == nil) or (self.dialog.OpenFrames[self.name] == nil) then
+            self:PrefixedPrint(self.L.Profiles_Deactivated, cRed(self.db:GetCurrentProfile()))
+        end
+        self:Deactivate()
+    else
+        if (self.dialog == nil) or (self.dialog.OpenFrames[self.name] == nil) then
+            self:PrefixedPrint(self.L.Profiles_Activated, cGreen(self.db:GetCurrentProfile()))
+        end
+        self:Activate()
+    end
+end
+
+function Grichelde:RefreshMinimap()
+    if (self.db.profile.enabled == true) then
+        self:Activate()
+    else
+        self:Deactivate()
+    end
+end
+
+function Grichelde:Activate()
+    self.db.profile.enabled = true
+
+    -- refresh option UI if open at the moment
+    if (self.dialog ~= nil) and (self.dialog.OpenFrames[self.name] ~= nil) then
+        self.dialog:SelectGroup(self.name)
+        local namePlusVersion = self:Format(self.L.AddonNamePlusVersion, self.L.AddonName, self.version)
+        local statusText = self:Format(self.L.AddonLoaded, namePlusVersion)
+        self.dialog.OpenFrames[self.name]:SetStatusText(statusText)
+    end
+
+    if (self.ldb ~= nil) then
+        self.ldb.iconR = Grichelde.MINIMAP_ENABLED
+        self.ldb.iconG = Grichelde.MINIMAP_ENABLED
+        self.ldb.iconB = Grichelde.MINIMAP_ENABLED
+    end
+end
+
+function Grichelde:Deactivate()
+    self.db.profile.enabled = false
+
+    -- refresh option UI if open at the moment
+    if (self.dialog ~= nil) and (self.dialog.OpenFrames[self.name] ~= nil) then
+        self.dialog:SelectGroup(self.name)
+        local namePlusVersion = self:Format(self.L.AddonNamePlusVersion, self.L.AddonName, self.version)
+        local statusText = self:Format(self.L.AddonUnloaded, namePlusVersion)
+        self.dialog.OpenFrames[self.name]:SetStatusText(statusText)
+    end
+
+    if (self.ldb ~= nil) then
+        self.ldb.iconR = Grichelde.MINIMAP_DARKENDED
+        self.ldb.iconG = Grichelde.MINIMAP_DARKENDED
+        self.ldb.iconB = Grichelde.MINIMAP_DARKENDED
+    end
+end
+

GricheldeTest.lua

@@ -0,0 +1,786 @@
+-- import addon read namespace from global env
+local _G = _G
+local Grichelde = _G.Grichelde or {}
+
+local find, pairs, tSize, cRed, cGreen, format = Grichelde.F.find, Grichelde.F.pairs, Grichelde.F.tSize, Grichelde.F.cRed, Grichelde.F.cGreen, Grichelde.F.format
+
+function Grichelde:TestMatch(text, pattern)
+    -- disable debug print out for testing
+    local oldLogLevel = Grichelde.logLevel
+    Grichelde.logLevel = 0
+
+    local pos1, pos2, cap1, cap2, cap3, cap4, cap5, cap6, cap7, cap8, cap9 = find(text, pattern)
+    self:PrefixedPrint("TestMatch : text: %s, pattern: %s, pos1: %d, pos2: %d", text, pattern, pos1, pos2)
+    self:PrefixedPrint("TestMatch : cap1: %s, cap2: %s, cap3: %s, cap4: %s, cap5: %s, cap6: %s, cap7: %s, cap8: %s, cap9: %s", cap1, cap2, cap3, cap4, cap5, cap6, cap7, cap8, cap9)
+
+    -- restore old loglevel
+    Grichelde.logLevel = oldLogLevel
+end
+
+function Grichelde:RunTests()
+    local function test(name, replacements, testData, replaceEmotes)
+        local i, ok, size = 0, 0, tSize(testData)
+        for input, expected in pairs(testData) do
+            local actual = self:ReplaceText(input, replacements, replaceEmotes or false)
+            i = i + 1
+            if (actual == expected) then
+                ok = ok + 1
+                self:PrefixedPrint("Test \"%s\" (%d/%d) %s: \"%s\" => \"%s\"", name, i, size, cGreen("passed"), input, expected)
+            else
+                self:PrefixedPrint("Test \"%s\" (%d/%d) %s: \"%s\" => \"%s\", but was \"%s\"", name, i, size, cRed("failed"), input, expected, actual)
+            end
+        end
+        return ok, size
+    end
+
+    -- disable debug print out for testing
+    local oldLogLevel = Grichelde.logLevel
+    Grichelde.logLevel = 0
+
+    local ok, all, o, a = 0, 0, 0, 0
+
+    -- basic tests
+    o, a = test(
+        "fehlender Unterkiefer",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "s",
+                replaceText = "ch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["abc"] = "abc",
+            ["soo"] = "choo",
+            ["oos"] = "ooch",
+            ["oso"] = "ocho",
+            ["sos"] = "choch",
+            ["ssoo"] = "choo",
+            ["osso"] = "ocho",
+            ["ooss"] = "ooch",
+            ["ABC"] = "ABC",
+            ["Soo"] = "Choo",
+            ["ooS"] = "ooCH",
+            ["oSo"] = "oCho",
+            ["SOS"] = "CHOCH",
+            ["SSoo"] = "CHoo",
+            ["OSSO"] = "OCHO",
+            ["ooSS"] = "ooCH",
+            ["schmeissen"] = "chmeichen",
+            ["Schön"] = "Chön",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    -- case sensivity and extended replacements
+    o, a = test(
+        "Zark",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "Zark",
+                replaceText = "Schami",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Zark"] = "Schami",
+            ["ZARK"] = "SCHAMI",
+            ["Zarkilein"] = "Schamiilein",
+            ["ZARKILEIN"] = "SCHAMIILEIN",
+            ["Zark!"] = "Schami!",
+            ["ZARK!"] = "SCHAMI!",
+            ["Zark ist tot"] = "Schami ist tot",
+            ["ZARK ist tot"] = "SCHAMI ist tot",
+            ["Zark ist der Tod"] = "Schami ist der Tod",
+            ["ZARK IST DER TOD"] = "SCHAMI IST DER TOD",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    -- start/end of sentence/words
+    o, a = test(
+        "wann",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "bcd",
+                replaceText = "efg",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "uio",
+                replaceText = "bnm",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "hij",
+                replaceText = "klm",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "nop",
+                replaceText = "qrs",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "tuv",
+                replaceText = "wxy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 6,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "wer",
+                replaceText = "sdf",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 7,
+                stopOnMatch = false,
+            },
+        },
+        {
+            -- replacement_10
+            ["bcd"] = "efg",
+            ["abcdz"] = "aefgz",
+            ["abcd"] = "aefg",
+            ["bcdz"] = "efgz",
+            -- replacement_11
+            ["uio"] = "bnm",
+            ["auioz"] = "auioz",
+            ["auio"] = "auio",
+            ["uioz"] = "uioz",
+            -- replacement_12
+            ["hij"] = "klm",
+            ["ahijz"] = "ahijz",
+            ["ahij"] = "ahij",
+            ["hijz"] = "klmz",
+            -- replacement_13
+            ["nop"] = "qrs",
+            ["anopz"] = "anopz",
+            ["anop"] = "aqrs",
+            ["nopz"] = "nopz",
+            -- replacement_14
+            ["tuv"] = "wxy",
+            ["atuvz"] = "atuvz",
+            ["atuv"] = "awxy",
+            ["tuvz"] = "wxyz",
+            -- replacement_15
+            ["wer"] = "wer",
+            ["awerz"] = "asdfz",
+            ["awer"] = "awer",
+            ["werz"] = "werz",
+
+            -- replacement_10
+            ["bcd abcdz abcd bcdz"] = "efg aefgz aefg efgz",
+            -- replacement_11
+            ["uio auioz auio uioz"] = "bnm auioz auio uioz",
+            -- replacement_12
+            ["hij ahijz ahij hijz"] = "klm ahijz ahij klmz",
+            -- replacement_13
+            ["nop anopz anop nopz"] = "qrs anopz aqrs nopz",
+            -- replacement_14
+            ["tuv atuvz atuv tuvz"] = "wxy atuvz awxy wxyz",
+            -- replacement_15
+            ["wer awerz awer werz"] = "wer asdfz awer werz",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "consolidate",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "a",
+                replaceText = "b",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "b",
+                replaceText = "c",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "d",
+                replaceText = "e",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["aaa"] = "c",
+            ["abb"] = "c",
+            ["abc"] = "c",
+            ["bbc"] = "c",
+            ["ace"] = "ce",
+            ["abe"] = "ce",
+            ["bbe"] = "ce",
+            ["ece"] = "ece",
+            ["ede"] = "ee",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    -- stop on match
+    o, a = test(
+        "stopOnMatch",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "a",
+                replaceText = "b",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = true,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "b",
+                replaceText = "c",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "c",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = true,
+            },
+        },
+        {
+            ["aaa"] = "bbb",
+            ["abc"] = "bbc",
+            ["bbc"] = "ddd",
+            ["bca"] = "bcb",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "Jar Jar Binks (DE)",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "ver",
+                replaceText = "va",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "en",
+                replaceText = "'n",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "er",
+                replaceText = "a",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "(%w?)ich",
+                replaceText = "%1ichse",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "(d?m?)ir",
+                replaceText = "%1ichse",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "du",
+                replaceText = "du da",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "er",
+                replaceText = "erse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_17 = {
+                order = 17,
+                searchText = "sie",
+                replaceText = "sie da",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_18 = {
+                order = 18,
+                searchText = "wir",
+                replaceText = "wirse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_19 = {
+                order = 19,
+                searchText = "ihr",
+                replaceText = "ihrse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_20 = {
+                order = 20,
+                searchText = "nicht",
+                replaceText = "nich",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_21 = {
+                order = 21,
+                searchText = "die",
+                replaceText = "de",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Ich kann dich verstehen."] = "Ichse kann dichse vasteh'n.",
+            ["Wir haben sie die ganze Zeit über nicht verstanden"] = "Wirse hab'n sie da de ganze Zeit üba nich vastand'n",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "Stottern 1",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "^([^aeiouy]-)([aeiouy])",
+                replaceText = "%1%2-%1%2-%1%2",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "([^bwp%s]-)([bwp])",
+                replaceText = "%1%2-%1%2-%1%2",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Ich mag dich."] = "I-I-Ich mag dich.",
+            ["Dich mag ich."] = "Di-Di-Dich mag ich.",
+            ["Bmm rrpss w"] = "B-B-Bmm rrp-rrp-rrpss w-w-w",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "trollifier",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "(%w)(%p?)$",
+                replaceText = "%1, mon%2",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "th",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "what are you",
+                replaceText = "whatcha",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "your?s?",
+                replaceText = "ya",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "going to",
+                replaceText = "gonna",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "want to",
+                replaceText = "wanna",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "ing",
+                replaceText = "in'",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["What are you going to do when they come for you?"] = "Whatcha gonna do when dey come for ya, mon?",
+            ["That's what young people are doing"] = "Dat's what young people are doin', mon",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "Jar Jar Binks (EN)",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "me",
+                replaceText = "mesa",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "I am",
+                replaceText = "Mesa",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "I'm",
+                replaceText = "Mesa",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "I",
+                replaceText = "Me",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "you are",
+                replaceText = "yousa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "you're",
+                replaceText = "yousa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "your",
+                replaceText = "yous",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_17 = {
+                order = 17,
+                searchText = "(s?)he is",
+                replaceText = "%1hesa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_18 = {
+                order = 18,
+                searchText = "(s?)he's",
+                replaceText = "%1hesa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_19 = {
+                order = 19,
+                searchText = "they",
+                replaceText = "daysa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_20 = {
+                order = 20,
+                searchText = "them",
+                replaceText = "them-sa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_21 = {
+                order = 21,
+                searchText = "ing",
+                replaceText = "in'",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_22 = {
+                order = 22,
+                searchText = "the",
+                replaceText = "da",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_23 = {
+                order = 23,
+                searchText = "th",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_24 = {
+                order = 24,
+                searchText = "yes",
+                replaceText = "yesa",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_25 = {
+                order = 25,
+                searchText = "oka?y?",
+                replaceText = "okeeday",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["I hear your voice through the thrilling grapewine."] = "Me hear yous voice drough da drillin' grapewine.",
+            ["They gave them their OK"] = "Daysa gave dem-sa deir OKEEDAY",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "old-fashioned",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "oi",
+                replaceText = "oy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "([^aeiou]*)([aeiou])",
+                replaceText = "%1%2e",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "yours",
+                replaceText = "thy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "youe",
+                replaceText = "thou",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Do you want to kill yours?"] = "Doe thou want toe kill thy?",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "emote detection on",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "r",
+                replaceText = "rr",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Der Herr Richter *schaut Herrn Richter an*"] = "Derr Herrrr Rrichterr *schaut Herrn Richter an*",
+            ["*schaut Herrn Richter an*"] = "*schaut Herrn Richter an*",
+        }
+    )
+    ok = ok + o
+    all = all + a
+
+    o, a = test(
+        "emote detection ignored",
+        {
+            replacement_10 = {
+                order = 10,
+                searchText = "r",
+                replaceText = "rr",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        },
+        {
+            ["Der Herr Richter *schaut Herrn Richter an*"] = "Derr Herrrr Rrichterr *schaut Herrrrn Rrichterr an*",
+            ["*schaut Herrn Richter an*"] = "*schaut Herrrrn Rrichterr an*",
+        },
+        true
+    )
+    ok = ok + o
+    all = all + a
+
+    if (ok == all) then
+        self:PrefixedPrint("All %d tests %s", all, cGreen("passed"))
+    else
+        self:PrefixedPrint("%d test %s, %d tests %s", all - ok, cRed("failed"), ok, cGreen("passed"))
+    end
+
+    -- restore old loglevel
+    Grichelde.logLevel = oldLogLevel
+end

GricheldeUpgrade.lua

@@ -0,0 +1,185 @@
+-- read namespace from global env
+local _G = _G
+local Grichelde = _G.Grichelde or {}
+
+local pairs, tSize, tClone, find, sub, cGreen, cOrange, cRed, toNumber
+    = Grichelde.F.pairs, Grichelde.F.tSize,Grichelde.F.tClone, Grichelde.F.find, Grichelde.F.sub, Grichelde.F.cGreen, Grichelde.F.cOrange, Grichelde.F.cRed, Grichelde.F.toNumber
+
+function Grichelde:Upgrade_To_v060()
+    self:PrefixedPrint(self.L.Upgrade_ToVersion, cOrange("0.6.0"))
+
+    local replacements = self.db.profile.replacements or {}
+    self:DebugPrint("Upgrade_To_v060 : old database")
+    self:DebugPrint(replacements)
+
+    for _, replTable in pairs(replacements) do
+        replTable["ignoreCase"] = not replTable["caseSensitive"]
+        replTable["caseSensitive"] = nil
+    end
+
+    self:DebugPrint("Upgrade_To_v060 : new database")
+    self:DebugPrint(replacements)
+    return 0, 6, 0
+end
+
+function Grichelde:Upgrade_To_v070()
+    self:PrefixedPrint(self.L.Upgrade_ToVersion, cOrange("0.7.0"))
+
+    local replacements = self.db.profile.replacements or {}
+    self:DebugPrint("Upgrade_To_v070 : old replacements")
+    self:DebugPrint(replacements)
+
+    for _, replTable in pairs(replacements) do
+        replTable["exactCase"] = not replTable["ignoreCase"]
+        replTable["ignoreCase"] = nil
+    end
+
+    self:DebugPrint("Upgrade_To_v070 : new replacements")
+    self:DebugPrint(replacements)
+    return 0, 7, 0
+end
+
+function Grichelde:Upgrade_To_v072()
+    self:PrefixedPrint(self.L.Upgrade_ToVersion, cOrange("0.7.2"))
+
+    self:DebugPrint("Upgrade_To_v072 : old database")
+    self:DebugPrint(self.db.profile)
+
+    self.db.profile["minimapButton"] = { hide = false }
+
+    self:DebugPrint("Upgrade_To_v072 : new database")
+    self:DebugPrint(self.db.profile)
+    return 0, 7, 2
+end
+
+function Grichelde:Upgrade_To_v080()
+    self:PrefixedPrint(self.L.Upgrade_ToVersion, cOrange("0.8.0"))
+
+    local replacements = self.db.profile.replacements or {}
+    self:DebugPrint("Upgrade_To_v080 : old replacements")
+    self:DebugPrint(replacements)
+
+    for _, replTable in pairs(replacements) do
+        replTable["active"] = true
+    end
+
+    self:DebugPrint("Upgrade_To_v080 : new replacements")
+    self:DebugPrint(self.db.profile)
+    return 0, 8, 0
+end
+
+function Grichelde:Upgrade_To_v090()
+    self:PrefixedPrint(self.L.Upgrade_ToVersion, cOrange("0.9.0"))
+
+    local replacements = self.db.profile.replacements or {}
+    self:DebugPrint("Upgrade_To_v090 : old replacements")
+    self:DebugPrint(replacements)
+
+    for _, replTable in pairs(replacements) do
+        if (replTable["active"] == true) then
+            replTable["matchWhen"] = 2
+        else
+            replTable["matchWhen"] = 1
+        end
+        replTable["active"] = nil
+    end
+
+    self:DebugPrint("Upgrade_To_v090 : new replacements")
+    self:DebugPrint(self.db.profile)
+    return 0, 9, 0
+end
+
+function Grichelde:UpgradeDatabase()
+    local function parseVersion(version)
+        local _, _, major, minor, patch, ext = find(version, "(%d+)%.(%d+)%.(%d+)(.*)")
+        local preBuild, build = ext, ""
+        if (sub(ext, 1, 1) == "-") then
+            local b = find(ext, "+", 2)
+            if (b ~= nil) then
+                preBuild = sub(ext, 1, b)
+                build = sub(ext, b + 1)
+            else
+                preBuild = sub(ext, 1, b)
+            end
+        end
+        return toNumber(major) or 0, toNumber(minor) or 0, toNumber(patch) or 0, preBuild, build
+    end
+
+    local gMajor, gMinor, gPatch = parseVersion(self.version)
+    local dbVersion = self.db.global.version
+
+    if (dbVersion == nil) then
+        self:DebugPrint("New installation detected, add sample mappings")
+        -- do NOT set self.db.profile.replacements = {} it will break defaults
+        local sampleRepl = self.getDefaultSampleMappings()
+        for replName, replTable in pairs(sampleRepl) do
+            self:TracePrint("UpgradeDatabase : copySampleMappings %s", replName)
+            self.db.profile.replacements[replName] = tClone(replTable)
+        end
+
+        self.db.global.version = self:Format("%d.%d.%d", gMajor, gMinor, gPatch)
+        self:DebugPrint("Database version %s sucessfully created", self.db.global.version)
+    else
+        -- detect if upgrade is neccessary or downgrade was done
+        self:DebugPrint("Detected database version:", dbVersion)
+
+        local dbMajor, dbMinor, dbPatch = parseVersion(dbVersion)
+        local downGrade = false
+        if (dbMajor > gMajor) then
+            downGrade = true
+        elseif dbMajor == gMajor then
+            if (dbMinor > gMinor) then
+                downGrade = true
+            elseif dbMinor == gMinor then
+                if (dbPatch > gPatch) then
+                    downGrade = true
+                end
+            end
+        end
+
+        if downGrade then
+            self:PrefixedPrint(cRed(self.L.Downgrade_Detected), self.L.AddonName)
+        else
+            local upgrade = 0
+            local error = false
+
+            if (dbMajor == 0) then
+                if (dbMinor < 6) then
+                    upgrade = upgrade + 1
+                    dbMajor, dbMinor, dbPatch = self:Upgrade_To_v060(dbVersion)
+                end
+                if (dbMinor < 7) then
+                    upgrade = upgrade + 1
+                    dbMajor, dbMinor, dbPatch = self:Upgrade_To_v070(dbVersion)
+                end
+                if (dbMinor == 7) then
+                    if (dbPatch < 2) then
+                        upgrade = upgrade + 1
+                        dbMajor, dbMinor, dbPatch = self:Upgrade_To_v072(dbVersion)
+                    end
+                end
+                if (dbMinor < 8) then
+                    upgrade = upgrade + 1
+                    dbMajor, dbMinor, dbPatch = self:Upgrade_To_v080(dbVersion)
+                end
+                if (dbMinor < 9) then
+                    upgrade = upgrade + 1
+                    dbMajor, dbMinor, dbPatch = self:Upgrade_To_v090(dbVersion)
+                end
+            end
+
+            if (upgrade == 0) or (error == false) then
+                -- bump version number even if no update is required
+                self.db.global.version = self:Format("%d.%d.%d", gMajor, gMinor, gPatch)
+            end
+
+            if (upgrade == 0) then
+                self:DebugPrint("Database was up-to-date")
+            elseif (error == false) then
+                self:PrefixedPrint(cGreen(self.L.Upgrade_Successful))
+            else
+                self:PrefixedPrint(cRed(self.L.Upgrade_Error))
+            end
+        end
+    end
+end

GricheldeUtils.lua

@@ -0,0 +1,253 @@
+-- import addon read namespace from global env
+local _G = _G
+local Grichelde = _G.Grichelde or {}
+
+local type, print, pairs, tSize, select, unpack, find, cGray, cDarkgray, cRed, cPrefix, format, rep, toString
+    = Grichelde.F.type, Grichelde.F.print, Grichelde.F.pairs, Grichelde.F.tSize, Grichelde.F.select, Grichelde.F.unpack, Grichelde.F.find, Grichelde.F.cGray, Grichelde.F.cDarkgray, Grichelde.F.cRed, Grichelde.F.cPrefix, Grichelde.F.format, Grichelde.F.rep, Grichelde.F.toString
+
+-- show strings differently to distinguish them from numbers
+function Grichelde:plainValue(val)
+    if (val == nil) then
+        return "<nil>"
+    elseif (type(val) == "string") then
+        return '"' .. val .. '"'
+    elseif (type(val) == "table") then
+        if (tSize(val) > 0) then
+            return toString(val)
+        else
+            return "{}"
+        end
+    else
+        return toString(val)
+    end
+end
+
+--- Prints any value to default channel, do NOT return a string.
+function Grichelde:tPrint(val, indent, known, printFunc)
+    local printF = printFunc or print
+    indent = indent or 0
+    known = known or {}
+
+    if (val == nil) then
+        printF(rep(" ", indent) .. "<nil>")
+    elseif (type(val) == "string") then
+        printF(rep(" ", indent) .. "\"" .. val .. "\"")
+    elseif (type(val) == "table") then
+        if (tSize(val) > 0) then
+            for key, value in pairs(val) do
+                if (value == nil) then
+                    printF(rep(" ", indent) .. self:plainValue(key) .. " = <nil>")
+                elseif (type(value) == "table") then
+                    printF(rep(" ", indent) .. self:plainValue(key) .. " = {")
+                    if (tSize(value) > 0) then
+                        if not known[value] then
+                            self:tPrint(value, indent + 4, known, printF)
+                            known[value] = true
+                        else
+                            printF("<known table> " .. self:plainValue(value))
+                        end
+                    end
+                    printF(rep(" ", indent) .. "}")
+                else
+                    local k = self:plainValue(key)
+                    local v = self:plainValue(value)
+                    --print( "k: " .. k .. ", v: " ..v)
+                    printF(rep(" ", indent) .. k .. " = " .. v)
+                end
+            end
+        else
+            printF(rep(" ", indent) .. "{}")
+        end
+    else
+        printF(rep(" ", indent) .. toString(val))
+    end
+end
+
+--- Splits at first word of a text line
+function Grichelde:SplitOnFirstMatch(text, delimPattern, start)
+    if (text == nil) then return nil end
+    local pattern = "^(.-)" .. (delimPattern or " " ) .."(.*)"
+    local pos = start or 1
+    self:TracePrint("SplitOnFirstMatch : text: %s, pattern: %s, start: %d", text, pattern, start)
+    local _, _, left, right = find(text, pattern, pos)
+    self:TracePrint("SplitOnFirstMatch : left: %s, right: %s", left, right)
+    return left or text, right
+end
+
+--- Splits at last word of a text line
+function Grichelde:SplitOnLastMatch(text, delimPattern, start)
+    local pattern = "(.*)" .. (delimPattern or " ") .. "(.-)$"
+    local pos = start or 1
+    self:TracePrint("SplitOnLastMatch : text: %s, pattern: %s, start: %d", text, pattern, start)
+    local _, _, left, right = find(text, pattern, pos)
+    self:TracePrint("SplitOnLastMatch : left: %s, right: %s", left, right)
+    return left, right or text
+end
+
+--- Splits at last word of a text line
+function Grichelde:TestMatch(text, pattern)
+    local pos1, pos2, left, right = find(text, pattern, 1)
+    self:DebugPrint("TestMatch : pos1: %d, pos2: %d, left: %s, right: %s", pos1, pos2, left, right)
+end
+
+function Grichelde:Format(message, ...)
+    if (message == nil) then
+        return "<nil>"
+    elseif (type(message) == "string") then
+        if (find(message, "%%") == nil) then
+            --print("message: ", message)
+            --print("...: ", ...)
+            return message, ...
+        else
+            local l = select("#", ...)
+            if (l > 0) then
+                -- sanitize nil values in vararg
+                local packed = { ... }
+                for i = 1, l do
+                    packed[i] = toString(packed[i]) or "nil"
+                    --print("packed[i] = ", packed[i])
+                    --packed[i] = gsub(packed[i], "%%(%d)", "%%%%%1")
+                end
+--              print("packed = ", packed)
+--              self:tPrint(packed)
+                -- cannot assign unpacked to a vararg variable and print it for debug
+                -- Manually set count as unpack() stops on nil (bug with #table)
+                return format(message, unpack(packed, 1, l))
+            else
+                return message
+            end
+        end
+    end
+end
+
+function Grichelde:PrefixedPrint(...)
+    print(cPrefix(self.L.AddonName) .. ":", self:Format(...))
+end
+
+function Grichelde:ErrorPrint(...)
+    print(cPrefix(self.L.AddonName) .. ": " .. cRed(self:Format(...)))
+end
+
+function Grichelde:DebugPrint(obj, ...)
+    if (self.logLevel >= Grichelde.LOG_LEVEL.DEBUG) then
+        self:LogPrint(function(...)
+            print(cGray(self.L.AddonName) .. ":", self:Format(...))
+        end, obj, ...)
+    end
+end
+
+function Grichelde:TracePrint(obj, ...)
+    if (self.logLevel >= Grichelde.LOG_LEVEL.TRACE) then
+        self:LogPrint(function(...)
+            print(cDarkgray(self.L.AddonName) .. ":", self:Format(...))
+        end, obj, ...)
+    end
+end
+
+function Grichelde:LogPrint(printFunc, obj, ...)
+    local printF = printFunc or print
+    if obj == nil then
+        printF("<nil>")
+    else
+        if type(obj) == "string" then
+            local l = select("#", ...)
+            if (l == 0) or (find(obj, "%%") == nil) then
+                printF(obj, ...)
+            else
+                -- sanitize nil values in vararg
+                local packed = { ... }
+                for i = 1, l do
+                    packed[i] = toString(packed[i]) or "nil"
+                end
+
+--              print("packed = ", packed)
+--              self:tPrint(packed)
+                -- cannot assign unpacked to a vararg variable and print it for debug
+                local fmtMsg = format(obj, unpack(packed, 1, l)) -- manually set count as unpack() stops on nil (bug with #table)
+                printF(fmtMsg)
+            end
+        elseif (type(obj) == "table") then
+            self:tPrint(obj, 0, {}, printF)
+        else
+            printF(self:plainValue(obj))
+        end
+    end
+end
+
+--- Print UI options to chat frame
+function Grichelde:PrintOptions()
+    self:PrefixedPrint(cPrefix(self.L.Debug_Options))
+    self:LogPrint(-1, function(...)
+        print(cPrefix(self.L.AddonName) .. ":", self:Format(...))
+    end, self.options.args.replacements.args)
+end
+
+--- Print current DB profile
+function Grichelde:PrintProfile()
+    self:PrefixedPrint(cPrefix(self.L.Debug_Profile))
+    self:LogPrint(-1, function(...)
+        print(cPrefix(self.L.AddonName) .. ":", self:Format(...))
+    end, self.db.profile)
+end
+
+--- Print DB replacements to chat frame
+function Grichelde:PrintMappings()
+    self:PrefixedPrint(cPrefix(self.L.Debug_Mappings))
+    self:LogPrint(-1, function(...)
+        print(cPrefix(self.L.AddonName) .. ":", self:Format(...))
+    end, self.db.profile.replacements)
+end
+
+--- Open window with DB replacements in it
+function Grichelde:ToogleMappings()
+    local AceGUI = LibStub("AceGUI-3.0")
+
+    if (self.debugFrame ~= nil) then
+        AceGUI:Release(self.debugFrame)
+        self.debugFrame = nil
+    else
+        local replacements = self.db.profile.replacements or {}
+        local repls = 0
+        for k, _ in pairs(replacements) do
+            if k and find(k, "^replacement_") then
+                repls = repls + 1
+            end
+        end
+
+        local frame = AceGUI:Create("Frame");
+        frame:SetTitle(self.L.Debug_Mappings);
+        frame:SetStatusText(self:Format(self.L.Debug_Mappings_Found, repls))
+        frame:SetWidth(400);
+        frame:SetAutoAdjustHeight(true)
+        --frame:SetFullHeight(true)
+        frame:SetLayout("Flow");
+        local function closeFrame(widget) AceGUI:Release(widget); self.debugFrame = nil end
+        frame:SetCallback("OnClose", closeFrame)
+
+        local hint = AceGUI:Create("Label");
+        hint:SetText(self.L.Debug_Mappings_Hint)
+        hint:SetFullWidth(true)
+        frame:AddChild(hint);
+
+        local scroll = AceGUI:Create("ScrollFrame");
+        scroll:SetFullWidth(true)
+        scroll:SetFullHeight(true)
+        scroll:SetLayout("Fill");
+
+        local configBox = AceGUI:Create("MultiLineEditBox");
+        configBox:SetLabel("")
+        local text = ""
+        self:tPrint(replacements, 0, {}, function(s) text = text .. s .. "|n" end)
+        configBox:SetText(text)
+        configBox:SetFullWidth(true)
+        --configBox:SetFullHeight(true)
+        configBox:DisableButton(true)
+        --configBox:SetDisabled(true)
+        configBox:SetNumLines(50);
+        configBox:SetFocus()
+        scroll:AddChild(configBox);
+
+        frame:AddChild(scroll);
+        self.debugFrame = frame
+    end
+end

Libs/LibDBIcon-1.0/LibDBIcon-1.0.lua

@@ -0,0 +1,470 @@
+
+-----------------------------------------------------------------------
+-- LibDBIcon-1.0
+--
+-- Allows addons to easily create a lightweight minimap icon as an alternative to heavier LDB displays.
+--
+
+local DBICON10 = "LibDBIcon-1.0"
+local DBICON10_MINOR = 43 -- Bump on changes
+if not LibStub then error(DBICON10 .. " requires LibStub.") end
+local ldb = LibStub("LibDataBroker-1.1", true)
+if not ldb then error(DBICON10 .. " requires LibDataBroker-1.1.") end
+local lib = LibStub:NewLibrary(DBICON10, DBICON10_MINOR)
+if not lib then return end
+
+lib.objects = lib.objects or {}
+lib.callbackRegistered = lib.callbackRegistered or nil
+lib.callbacks = lib.callbacks or LibStub("CallbackHandler-1.0"):New(lib)
+lib.notCreated = lib.notCreated or {}
+lib.radius = lib.radius or 5
+lib.tooltip = lib.tooltip or CreateFrame("GameTooltip", "LibDBIconTooltip", UIParent, "GameTooltipTemplate")
+local next, Minimap = next, Minimap
+local isDraggingButton = false
+
+function lib:IconCallback(event, name, key, value)
+	if lib.objects[name] then
+		if key == "icon" then
+			lib.objects[name].icon:SetTexture(value)
+		elseif key == "iconCoords" then
+			lib.objects[name].icon:UpdateCoord()
+		elseif key == "iconR" then
+			local _, g, b = lib.objects[name].icon:GetVertexColor()
+			lib.objects[name].icon:SetVertexColor(value, g, b)
+		elseif key == "iconG" then
+			local r, _, b = lib.objects[name].icon:GetVertexColor()
+			lib.objects[name].icon:SetVertexColor(r, value, b)
+		elseif key == "iconB" then
+			local r, g = lib.objects[name].icon:GetVertexColor()
+			lib.objects[name].icon:SetVertexColor(r, g, value)
+		end
+	end
+end
+if not lib.callbackRegistered then
+	ldb.RegisterCallback(lib, "LibDataBroker_AttributeChanged__icon", "IconCallback")
+	ldb.RegisterCallback(lib, "LibDataBroker_AttributeChanged__iconCoords", "IconCallback")
+	ldb.RegisterCallback(lib, "LibDataBroker_AttributeChanged__iconR", "IconCallback")
+	ldb.RegisterCallback(lib, "LibDataBroker_AttributeChanged__iconG", "IconCallback")
+	ldb.RegisterCallback(lib, "LibDataBroker_AttributeChanged__iconB", "IconCallback")
+	lib.callbackRegistered = true
+end
+
+local function getAnchors(frame)
+	local x, y = frame:GetCenter()
+	if not x or not y then return "CENTER" end
+	local hhalf = (x > UIParent:GetWidth()*2/3) and "RIGHT" or (x < UIParent:GetWidth()/3) and "LEFT" or ""
+	local vhalf = (y > UIParent:GetHeight()/2) and "TOP" or "BOTTOM"
+	return vhalf..hhalf, frame, (vhalf == "TOP" and "BOTTOM" or "TOP")..hhalf
+end
+
+local function onEnter(self)
+	if isDraggingButton then return end
+
+	for _, button in next, lib.objects do
+		if button.showOnMouseover then
+			button.fadeOut:Stop()
+			button:SetAlpha(1)
+		end
+	end
+
+	local obj = self.dataObject
+	if obj.OnTooltipShow then
+		lib.tooltip:SetOwner(self, "ANCHOR_NONE")
+		lib.tooltip:SetPoint(getAnchors(self))
+		obj.OnTooltipShow(lib.tooltip)
+		lib.tooltip:Show()
+	elseif obj.OnEnter then
+		obj.OnEnter(self)
+	end
+end
+
+local function onLeave(self)
+	lib.tooltip:Hide()
+
+	if not isDraggingButton then
+		for _, button in next, lib.objects do
+			if button.showOnMouseover then
+				button.fadeOut:Play()
+			end
+		end
+	end
+
+	local obj = self.dataObject
+	if obj.OnLeave then
+		obj.OnLeave(self)
+	end
+end
+
+--------------------------------------------------------------------------------
+
+local onDragStart, updatePosition
+
+do
+	local minimapShapes = {
+		["ROUND"] = {true, true, true, true},
+		["SQUARE"] = {false, false, false, false},
+		["CORNER-TOPLEFT"] = {false, false, false, true},
+		["CORNER-TOPRIGHT"] = {false, false, true, false},
+		["CORNER-BOTTOMLEFT"] = {false, true, false, false},
+		["CORNER-BOTTOMRIGHT"] = {true, false, false, false},
+		["SIDE-LEFT"] = {false, true, false, true},
+		["SIDE-RIGHT"] = {true, false, true, false},
+		["SIDE-TOP"] = {false, false, true, true},
+		["SIDE-BOTTOM"] = {true, true, false, false},
+		["TRICORNER-TOPLEFT"] = {false, true, true, true},
+		["TRICORNER-TOPRIGHT"] = {true, false, true, true},
+		["TRICORNER-BOTTOMLEFT"] = {true, true, false, true},
+		["TRICORNER-BOTTOMRIGHT"] = {true, true, true, false},
+	}
+
+	local rad, cos, sin, sqrt, max, min = math.rad, math.cos, math.sin, math.sqrt, math.max, math.min
+	function updatePosition(button, position)
+		local angle = rad(position or 225)
+		local x, y, q = cos(angle), sin(angle), 1
+		if x < 0 then q = q + 1 end
+		if y > 0 then q = q + 2 end
+		local minimapShape = GetMinimapShape and GetMinimapShape() or "ROUND"
+		local quadTable = minimapShapes[minimapShape]
+		local w = (Minimap:GetWidth() / 2) + lib.radius
+		local h = (Minimap:GetHeight() / 2) + lib.radius
+		if quadTable[q] then
+			x, y = x*w, y*h
+		else
+			local diagRadiusW = sqrt(2*(w)^2)-10
+			local diagRadiusH = sqrt(2*(h)^2)-10
+			x = max(-w, min(x*diagRadiusW, w))
+			y = max(-h, min(y*diagRadiusH, h))
+		end
+		button:SetPoint("CENTER", Minimap, "CENTER", x, y)
+	end
+end
+
+local function onClick(self, b)
+	if self.dataObject.OnClick then
+		self.dataObject.OnClick(self, b)
+	end
+end
+
+local function onMouseDown(self)
+	self.isMouseDown = true
+	self.icon:UpdateCoord()
+end
+
+local function onMouseUp(self)
+	self.isMouseDown = false
+	self.icon:UpdateCoord()
+end
+
+do
+	local deg, atan2 = math.deg, math.atan2
+	local function onUpdate(self)
+		local mx, my = Minimap:GetCenter()
+		local px, py = GetCursorPosition()
+		local scale = Minimap:GetEffectiveScale()
+		px, py = px / scale, py / scale
+		local pos = 225
+		if self.db then
+			pos = deg(atan2(py - my, px - mx)) % 360
+			self.db.minimapPos = pos
+		else
+			pos = deg(atan2(py - my, px - mx)) % 360
+			self.minimapPos = pos
+		end
+		updatePosition(self, pos)
+	end
+
+	function onDragStart(self)
+		self:LockHighlight()
+		self.isMouseDown = true
+		self.icon:UpdateCoord()
+		self:SetScript("OnUpdate", onUpdate)
+		isDraggingButton = true
+		lib.tooltip:Hide()
+		for _, button in next, lib.objects do
+			if button.showOnMouseover then
+				button.fadeOut:Stop()
+				button:SetAlpha(1)
+			end
+		end
+	end
+end
+
+local function onDragStop(self)
+	self:SetScript("OnUpdate", nil)
+	self.isMouseDown = false
+	self.icon:UpdateCoord()
+	self:UnlockHighlight()
+	isDraggingButton = false
+	for _, button in next, lib.objects do
+		if button.showOnMouseover then
+			button.fadeOut:Play()
+		end
+	end
+end
+
+local defaultCoords = {0, 1, 0, 1}
+local function updateCoord(self)
+	local coords = self:GetParent().dataObject.iconCoords or defaultCoords
+	local deltaX, deltaY = 0, 0
+	if not self:GetParent().isMouseDown then
+		deltaX = (coords[2] - coords[1]) * 0.05
+		deltaY = (coords[4] - coords[3]) * 0.05
+	end
+	self:SetTexCoord(coords[1] + deltaX, coords[2] - deltaX, coords[3] + deltaY, coords[4] - deltaY)
+end
+
+local function createButton(name, object, db)
+	local button = CreateFrame("Button", "LibDBIcon10_"..name, Minimap)
+	button.dataObject = object
+	button.db = db
+	button:SetFrameStrata("MEDIUM")
+	button:SetSize(31, 31)
+	button:SetFrameLevel(8)
+	button:RegisterForClicks("anyUp")
+	button:RegisterForDrag("LeftButton")
+	button:SetHighlightTexture(136477) --"Interface\\Minimap\\UI-Minimap-ZoomButton-Highlight"
+	local overlay = button:CreateTexture(nil, "OVERLAY")
+	overlay:SetSize(53, 53)
+	overlay:SetTexture(136430) --"Interface\\Minimap\\MiniMap-TrackingBorder"
+	overlay:SetPoint("TOPLEFT")
+	local background = button:CreateTexture(nil, "BACKGROUND")
+	background:SetSize(20, 20)
+	background:SetTexture(136467) --"Interface\\Minimap\\UI-Minimap-Background"
+	background:SetPoint("TOPLEFT", 7, -5)
+	local icon = button:CreateTexture(nil, "ARTWORK")
+	icon:SetSize(17, 17)
+	icon:SetTexture(object.icon)
+	icon:SetPoint("TOPLEFT", 7, -6)
+	button.icon = icon
+	button.isMouseDown = false
+
+	local r, g, b = icon:GetVertexColor()
+	icon:SetVertexColor(object.iconR or r, object.iconG or g, object.iconB or b)
+
+	icon.UpdateCoord = updateCoord
+	icon:UpdateCoord()
+
+	button:SetScript("OnEnter", onEnter)
+	button:SetScript("OnLeave", onLeave)
+	button:SetScript("OnClick", onClick)
+	if not db or not db.lock then
+		button:SetScript("OnDragStart", onDragStart)
+		button:SetScript("OnDragStop", onDragStop)
+	end
+	button:SetScript("OnMouseDown", onMouseDown)
+	button:SetScript("OnMouseUp", onMouseUp)
+
+	button.fadeOut = button:CreateAnimationGroup()
+	local animOut = button.fadeOut:CreateAnimation("Alpha")
+	animOut:SetOrder(1)
+	animOut:SetDuration(0.2)
+	animOut:SetFromAlpha(1)
+	animOut:SetToAlpha(0)
+	animOut:SetStartDelay(1)
+	button.fadeOut:SetToFinalAlpha(true)
+
+	lib.objects[name] = button
+
+	if lib.loggedIn then
+		updatePosition(button, db and db.minimapPos)
+		if not db or not db.hide then
+			button:Show()
+		else
+			button:Hide()
+		end
+	end
+	lib.callbacks:Fire("LibDBIcon_IconCreated", button, name) -- Fire 'Icon Created' callback
+end
+
+-- We could use a metatable.__index on lib.objects, but then we'd create
+-- the icons when checking things like :IsRegistered, which is not necessary.
+local function check(name)
+	if lib.notCreated[name] then
+		createButton(name, lib.notCreated[name][1], lib.notCreated[name][2])
+		lib.notCreated[name] = nil
+	end
+end
+
+-- Wait a bit with the initial positioning to let any GetMinimapShape addons
+-- load up.
+if not lib.loggedIn then
+	local f = CreateFrame("Frame")
+	f:SetScript("OnEvent", function(f)
+		for _, button in next, lib.objects do
+			updatePosition(button, button.db and button.db.minimapPos)
+			if not button.db or not button.db.hide then
+				button:Show()
+			else
+				button:Hide()
+			end
+		end
+		lib.loggedIn = true
+		f:SetScript("OnEvent", nil)
+	end)
+	f:RegisterEvent("PLAYER_LOGIN")
+end
+
+local function getDatabase(name)
+	return lib.notCreated[name] and lib.notCreated[name][2] or lib.objects[name].db
+end
+
+function lib:Register(name, object, db)
+	if not object.icon then error("Can't register LDB objects without icons set!") end
+	if lib.objects[name] or lib.notCreated[name] then error(DBICON10.. ": Object '".. name .."' is already registered.") end
+	if not db or not db.hide then
+		createButton(name, object, db)
+	else
+		lib.notCreated[name] = {object, db}
+	end
+end
+
+function lib:Lock(name)
+	if not lib:IsRegistered(name) then return end
+	if lib.objects[name] then
+		lib.objects[name]:SetScript("OnDragStart", nil)
+		lib.objects[name]:SetScript("OnDragStop", nil)
+	end
+	local db = getDatabase(name)
+	if db then
+		db.lock = true
+	end
+end
+
+function lib:Unlock(name)
+	if not lib:IsRegistered(name) then return end
+	if lib.objects[name] then
+		lib.objects[name]:SetScript("OnDragStart", onDragStart)
+		lib.objects[name]:SetScript("OnDragStop", onDragStop)
+	end
+	local db = getDatabase(name)
+	if db then
+		db.lock = nil
+	end
+end
+
+function lib:Hide(name)
+	if not lib.objects[name] then return end
+	lib.objects[name]:Hide()
+end
+
+function lib:Show(name)
+	check(name)
+	local button = lib.objects[name]
+	if button then
+		button:Show()
+		updatePosition(button, button.db and button.db.minimapPos or button.minimapPos)
+	end
+end
+
+function lib:IsRegistered(name)
+	return (lib.objects[name] or lib.notCreated[name]) and true or false
+end
+
+function lib:Refresh(name, db)
+	check(name)
+	local button = lib.objects[name]
+	if db then
+		button.db = db
+	end
+	updatePosition(button, button.db and button.db.minimapPos or button.minimapPos)
+	if not button.db or not button.db.hide then
+		button:Show()
+	else
+		button:Hide()
+	end
+	if not button.db or not button.db.lock then
+		button:SetScript("OnDragStart", onDragStart)
+		button:SetScript("OnDragStop", onDragStop)
+	else
+		button:SetScript("OnDragStart", nil)
+		button:SetScript("OnDragStop", nil)
+	end
+end
+
+function lib:GetMinimapButton(name)
+	return lib.objects[name]
+end
+
+do
+	local function OnMinimapEnter()
+		if isDraggingButton then return end
+		for _, button in next, lib.objects do
+			if button.showOnMouseover then
+				button.fadeOut:Stop()
+				button:SetAlpha(1)
+			end
+		end
+	end
+	local function OnMinimapLeave()
+		if isDraggingButton then return end
+		for _, button in next, lib.objects do
+			if button.showOnMouseover then
+				button.fadeOut:Play()
+			end
+		end
+	end
+	Minimap:HookScript("OnEnter", OnMinimapEnter)
+	Minimap:HookScript("OnLeave", OnMinimapLeave)
+
+	function lib:ShowOnEnter(name, value)
+		local button = lib.objects[name]
+		if button then
+			if value then
+				button.showOnMouseover = true
+				button.fadeOut:Stop()
+				button:SetAlpha(0)
+			else
+				button.showOnMouseover = false
+				button.fadeOut:Stop()
+				button:SetAlpha(1)
+			end
+		end
+	end
+end
+
+function lib:GetButtonList()
+	local t = {}
+	for name in next, lib.objects do
+		t[#t+1] = name
+	end
+	return t
+end
+
+function lib:SetButtonRadius(radius)
+	if type(radius) == "number" then
+		lib.radius = radius
+		for _, button in next, lib.objects do
+			updatePosition(button, button.db and button.db.minimapPos or button.minimapPos)
+		end
+	end
+end
+
+function lib:SetButtonToPosition(button, position)
+	updatePosition(lib.objects[button] or button, position)
+end
+
+-- Upgrade!
+for name, button in next, lib.objects do
+	local db = getDatabase(name)
+	if not db or not db.lock then
+		button:SetScript("OnDragStart", onDragStart)
+		button:SetScript("OnDragStop", onDragStop)
+	end
+	button:SetScript("OnEnter", onEnter)
+	button:SetScript("OnLeave", onLeave)
+	button:SetScript("OnClick", onClick)
+	button:SetScript("OnMouseDown", onMouseDown)
+	button:SetScript("OnMouseUp", onMouseUp)
+
+	if not button.fadeOut then -- Upgrade to 39
+		button.fadeOut = button:CreateAnimationGroup()
+		local animOut = button.fadeOut:CreateAnimation("Alpha")
+		animOut:SetOrder(1)
+		animOut:SetDuration(0.2)
+		animOut:SetFromAlpha(1)
+		animOut:SetToAlpha(0)
+		animOut:SetStartDelay(1)
+		button.fadeOut:SetToFinalAlpha(true)
+	end
+end
+lib:SetButtonRadius(lib.radius) -- Upgrade to 40

Libs/LibDBIcon-1.0/lib.xml

@@ -0,0 +1,7 @@
+<Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/
+..\FrameXML\UI.xsd">
+
+<Script file="LibDBIcon-1.0.lua"/>
+
+</Ui>
+

Libs/LibDataBroker-1.1/LibDataBroker-1.1.lua

@@ -0,0 +1,90 @@
+
+assert(LibStub, "LibDataBroker-1.1 requires LibStub")
+assert(LibStub:GetLibrary("CallbackHandler-1.0", true), "LibDataBroker-1.1 requires CallbackHandler-1.0")
+
+local lib, oldminor = LibStub:NewLibrary("LibDataBroker-1.1", 4)
+if not lib then return end
+oldminor = oldminor or 0
+
+
+lib.callbacks = lib.callbacks or LibStub:GetLibrary("CallbackHandler-1.0"):New(lib)
+lib.attributestorage, lib.namestorage, lib.proxystorage = lib.attributestorage or {}, lib.namestorage or {}, lib.proxystorage or {}
+local attributestorage, namestorage, callbacks = lib.attributestorage, lib.namestorage, lib.callbacks
+
+if oldminor < 2 then
+	lib.domt = {
+		__metatable = "access denied",
+		__index = function(self, key) return attributestorage[self] and attributestorage[self][key] end,
+	}
+end
+
+if oldminor < 3 then
+	lib.domt.__newindex = function(self, key, value)
+		if not attributestorage[self] then attributestorage[self] = {} end
+		if attributestorage[self][key] == value then return end
+		attributestorage[self][key] = value
+		local name = namestorage[self]
+		if not name then return end
+		callbacks:Fire("LibDataBroker_AttributeChanged", name, key, value, self)
+		callbacks:Fire("LibDataBroker_AttributeChanged_"..name, name, key, value, self)
+		callbacks:Fire("LibDataBroker_AttributeChanged_"..name.."_"..key, name, key, value, self)
+		callbacks:Fire("LibDataBroker_AttributeChanged__"..key, name, key, value, self)
+	end
+end
+
+if oldminor < 2 then
+	function lib:NewDataObject(name, dataobj)
+		if self.proxystorage[name] then return end
+
+		if dataobj then
+			assert(type(dataobj) == "table", "Invalid dataobj, must be nil or a table")
+			self.attributestorage[dataobj] = {}
+			for i,v in pairs(dataobj) do
+				self.attributestorage[dataobj][i] = v
+				dataobj[i] = nil
+			end
+		end
+		dataobj = setmetatable(dataobj or {}, self.domt)
+		self.proxystorage[name], self.namestorage[dataobj] = dataobj, name
+		self.callbacks:Fire("LibDataBroker_DataObjectCreated", name, dataobj)
+		return dataobj
+	end
+end
+
+if oldminor < 1 then
+	function lib:DataObjectIterator()
+		return pairs(self.proxystorage)
+	end
+
+	function lib:GetDataObjectByName(dataobjectname)
+		return self.proxystorage[dataobjectname]
+	end
+
+	function lib:GetNameByDataObject(dataobject)
+		return self.namestorage[dataobject]
+	end
+end
+
+if oldminor < 4 then
+	local next = pairs(attributestorage)
+	function lib:pairs(dataobject_or_name)
+		local t = type(dataobject_or_name)
+		assert(t == "string" or t == "table", "Usage: ldb:pairs('dataobjectname') or ldb:pairs(dataobject)")
+
+		local dataobj = self.proxystorage[dataobject_or_name] or dataobject_or_name
+		assert(attributestorage[dataobj], "Data object not found")
+
+		return next, attributestorage[dataobj], nil
+	end
+
+	local ipairs_iter = ipairs(attributestorage)
+	function lib:ipairs(dataobject_or_name)
+		local t = type(dataobject_or_name)
+		assert(t == "string" or t == "table", "Usage: ldb:ipairs('dataobjectname') or ldb:ipairs(dataobject)")
+
+		local dataobj = self.proxystorage[dataobject_or_name] or dataobject_or_name
+		assert(attributestorage[dataobj], "Data object not found")
+
+		return ipairs_iter, attributestorage[dataobj], 0
+	end
+end

Libs/LibDataBroker-1.1/README.textile

@@ -0,0 +1,13 @@
+LibDataBroker is a small WoW addon library designed to provide a "MVC":http://en.wikipedia.org/wiki/Model-view-controller interface for use in various addons.
+LDB's primary goal is to "detach" plugins for TitanPanel and FuBar from the display addon.
+Plugins can provide data into a simple table, and display addons can receive callbacks to refresh their display of this data.
+LDB also provides a place for addons to register "quicklaunch" functions, removing the need for authors to embed many large libraries to create minimap buttons.
+Users who do not wish to be "plagued" by these buttons simply do not install an addon to render them.
+
+Due to it's simple generic design, LDB can be used for any design where you wish to have an addon notified of changes to a table.
+
+h2. Links
+
+* "API documentation":http://github.com/tekkub/libdatabroker-1-1/wikis/api
+* "Data specifications":http://github.com/tekkub/libdatabroker-1-1/wikis/data-specifications
+* "Addons using LDB":http://github.com/tekkub/libdatabroker-1-1/wikis/addons-using-ldb

README.md

@@ -1,11 +1,75 @@
 # Grichelde - Text replacer
 
-Grichelde is a WoW Classic Addon that replaces characters you typed in a chatbox with any replacement text you specified in the addon options.   
+Grichelde is a WoW Classic Addon that replaces any characters or words you typed in a chatbox according to your replacement rules and text.
+The replacement is done **before** the text is send to others/in the target channel. It does **not** change text others have written in the chat/channel,
+but the text they will see **from you** when you sent it.
+
+Its purpose it to simulate a speaking disability of your toon and hereby strengthen immersion in roleplay. 
+Initially started as a helper addon for a roleplaying friend, Grichelde can be used for much more, like 
 
-Intentionally started as a helper addon for a roleplaying friend, Grichelde can be used for much more, like 
 * fixing your common spelling errors :)
 * replacing toon names with their nick names
 * write out abbreviations for you
 * create hilarious moments during roleplay
 
-<!-- Did you ever had an Undead without a jaw and wondered how it might sound like if s/he'd actually speak? --> 
+However it does not replace slash commands with other slash commands, it only works for chat text. It you want to replace commands, 
+please look at more sophisticated chat addons like [Prat](https://www.curseforge.com/wow/addons/prat-3-0).  
+
+## Disclaimer
+#### No Warranty
+The addon is provided "AS IS" and comes without warranty of any kind of function or correctness (for more details, consult the GPL 3 license).
+Also the author is not held responsible for any risk or damage the addon or its use might cause, especially lost of progress or data due to crashes of the WoW client.
+
+#### Respect others
+This addon does not encourange or intend to hurt or to tease people with speaking disabilities or language disorders. 
+The responsibility rest on the user completely. Please use the features with care and respect to other players.
+                                 
+## FAQ
+
+#### Where do I start?
+
+Grichelde is active right from the start with default mappings. To open the options UI, either left-click on
+the new minimap icon, or type `/gri` or `/grichelde` in the chatbox. All mappings and channels can be configured there.
+
+#### Does it replace only letters but also whole words?
+
+Grichelde is capable of handling both, even whole sentences can be replaced. 
+Only slash commands, item links, textures, placeholders and ooc-markers are excluded from replacement.
+
+#### My replacement is not taken.
+
+After entering a search or replacement text, you see a button "Okay" next to your input. This is **not** a validation message, 
+but the save button for text. This is a restriction from the UI library and can be seen in other addons as well. 
+Please click on "Okay" to save the input permanently, otherwise it will not be stored..
+
+![click "Okay" on text changes](https://media.forgecdn.net/attachments/305/887/text-okay.jpg "change confirmation")
+
+If it still does not work or gives you errors, please read the next question. 
+
+#### I have to disable the Addon frequently. Is there a more elegant solution?
+
+Actually there are two solutions:
+1. A right-click on the minimap button will disable Grichelde instantly. Right-click a second time will activate it again. Easy, isn't it?
+2. You can disable Grichelde permanently and forcefully replace a sentence in the chatbox with manual override. I call it "Grichelde-On-Demand" :) 
+   In the chatbox put `/gri` or `/grichelde` in front of your typed text, you can also include the target channel, 
+   i.e. `/gri /guild hello there` and Grichelde will apply the active replacements and rules even if guild channel or Grichelde was disabled.
+
+#### I get errors, what should I do?
+
+Please report your errors on [project website](https://www.curseforge.com/wow/addons/grichelde) at curse forge. Make a screenshot or copy both the error message as well as your recent mappings.
+You can bring up a small windows with your mapping by entering the `/gri mappings` command on copy them.
+
+#### Why that strange name?
+
+Grichelde is the name of an Undead rogue without a jaw, who was played in RP sessions by a guild member.
+She started replacing `s` and `t` letters manually for each word in the chat, which became cumbersome over time.
+(If you ever wondered how an Undead without a jaw sounds like, its really hilarious, you should try it.) 
+Without spelling errors, "Griselde" in German is an old-fashioned female first name.
+
+#### I'm a Pro. Does it support regular expressions?
+
+RegEx are very powerful search and replacement patterns commonly used in programming. Technically all searches the addon performs on the input are done 
+with regular expression methods, however Lua unfortunately does not support full [PCRE](https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions) syntax and is very limited (read [here](http://www.lua.org/pil/20.1.html) why).
+Nevertheless some patterns can be used like the anchors start of line `^` or end of line `$`, capturing groups `(hello) (world)`, character classes like numbers `%d` or (inversed) sets `[^%p]`.
+
+Capture groups can be accessed in the replacement text with `%<number>` like in `%2 %1`. Also there are some mappings using RegEx in the Example section. 

libs.xml

@@ -1,15 +1,17 @@
 <Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/
 ..\FrameXML\UI.xsd">
 
-  <Script file="libs\LibStub\LibStub.lua"/>
-  <Include file="libs\CallbackHandler-1.0\CallbackHandler-1.0.xml"/>
-  <Include file="libs\AceAddon-3.0\AceAddon-3.0.xml"/>
-  <Include file="libs\AceConfig-3.0\AceConfig-3.0.xml"/>
-  <Include file="libs\AceConsole-3.0\AceConsole-3.0.xml"/>
-  <Include file="libs\AceDB-3.0\AceDB-3.0.xml"/>
-  <Include file="libs\AceDBOptions-3.0\AceDBOptions-3.0.xml"/>
-  <Include file="libs\AceGUI-3.0\AceGUI-3.0.xml"/>
-  <Include file="libs\AceEvent-3.0\AceEvent-3.0.xml" />
-  <Include file="libs\AceLocale-3.0\AceLocale-3.0.xml" />
-  <Include file="libs\AceHook-3.0\AceHook-3.0.xml"/>
+  <Script file="Libs\LibStub\LibStub.lua"/>
+  <Include file="Libs\CallbackHandler-1.0\CallbackHandler-1.0.xml"/>
+  <Include file="Libs\AceAddon-3.0\AceAddon-3.0.xml"/>
+  <Include file="Libs\AceLocale-3.0\AceLocale-3.0.xml" />
+  <Include file="Libs\AceEvent-3.0\AceEvent-3.0.xml" />
+  <Include file="Libs\AceHook-3.0\AceHook-3.0.xml"/>
+  <Include file="Libs\AceConsole-3.0\AceConsole-3.0.xml"/>
+  <Include file="Libs\AceDB-3.0\AceDB-3.0.xml"/>
+  <Include file="Libs\AceDBOptions-3.0\AceDBOptions-3.0.xml"/>
+  <Include file="Libs\AceGUI-3.0\AceGUI-3.0.xml"/>
+  <Include file="Libs\AceConfig-3.0\AceConfig-3.0.xml"/>
+  <Script file="Libs\LibDataBroker-1.1\LibDataBroker-1.1.lua" />
+  <Script file="Libs\LibDBIcon-1.0\LibDBIcon-1.0.lua" />
 </Ui>

localisation/deDE.lua

@@ -1,54 +1,97 @@
-local L = LibStub('AceLocale-3.0'):NewLocale('Grichelde', 'deDE')
+-- read namespace from global env
+local AddonName, _ = ...
+local _G = _G
+local Grichelde = _G.Grichelde
+
+local L = LibStub('AceLocale-3.0'):NewLocale(AddonName, 'deDE')
 if not L then return end
 
+local cYellow = Grichelde.F.cYellow
+local cGray   = Grichelde.F.cGray
+local cPrefix = Grichelde.F.cPrefix
+
 -- system messages
 L.AddonName = "Grichelde"
-L.AddonLoaded = "%s hilft Euch jetzt bei euren Sprachschwierigkeiten."
-L.Addon_Detected_Misspelled = "Das Addon 'Misspelled' wurde erkannt und alle Nachrichten werden automatisch bereinigt."
-L.Addon_Detected_WIM = "Das Addon 'WIM' wurde erkannt und alle Flüsternnachrichten aus IM-Fenster werden behandelt."
+L.AddonNamePlusVersion = "%s v%s"
+L.AddonLoaded = "%s unterst\195\188tzt Euch jetzt bei euren Sprachschwierigkeiten."
+L.AddonUnloaded = "%s wartet geduldig Euch weiter unterst\195\188tzen zu d\195\188rfen."
+L.Upgrade_ToVersion = "Hebe Databank auf Version %s an."
+L.Upgrade_Successful = "Upgrade erfolgreich."
+L.Upgrade_Error = "Upgrade fehlgeschlagen!"
+L.Downgrade_Detected = "Downgrade erkannt, %s kann sich m\195\182glichweise fehlerhaft verhalten!"
+
+-- debug
+L.Debug_Options = "Optionen"
+L.Debug_Mappings = "Ersetzungen"
+L.Debug_Mappings_Hint = "Der Inhalt der Textbox dient nur zur Fehlersuche und kann herauskopiert werden. Es werden keine Werte aus dieser Textbox eingelesen oder anderweitig verwertet."
+L.Debug_Mappings_Found = "%d Ersetzungen gefunden"
+L.Debug_Profile = "Profil"
+
+-- errors
+L.Error_InvalidCommand = "Ung\195\188ltiger Befehl"
+L.Error_InvalidChannel = "Ung\195\188ltiger Kanal"
+L.Error_InvalidWhisperTarget = "Ung\195\188ltiger Fl\195\188sterziel"
+L.Error_UnsupportedChannel = "Nicht unterst\195\188tzter Kanal"
 
 -- profiles
 L.Profiles_Available = "Verf\195\188gbare Profile:"
-L.Profiles_Created = "Neues Profil %s%s%s angelegt."
-L.Profiles_Loaded = "Profil %s%s%s geladen."
-L.Profiles_Refreshed = "Profil %s%s%s aktualisiert."
-L.Profiles_Deleted = "Profil %s%s%s gel\195\182scht."
-L.Profiles_Copied = "Einstellungen von Profil %s%s%s \195\188bernommen."
-L.Profiles_Reset = "Profil %s%s%s zur\195\188ckgesetzt."
-L.Profiles_Invalid = "Ung\195\188ltiges Profil %s%s%s!"
+L.Profiles_Created = "Neues Profil %s angelegt."
+L.Profiles_Loaded = "Profil %s geladen."
+L.Profiles_Activated = "Profil %s aktiviert."
+L.Profiles_Deactivated = "Profil %s deaktiviert."
+L.Profiles_Refreshed = "Profil %s aktualisiert."
+L.Profiles_Deleted = "Profil %s gel\195\182scht."
+L.Profiles_Copied = "Einstellungen von Profil %s \195\188bernommen."
+L.Profiles_Reset = "Profil %s zur\195\188ckgesetzt."
+L.Profiles_Invalid = "Ung\195\188ltiges Profil %s!"
 L.Profiles_DeleteError = "Das aktive Profil kann nicht gel\195\182scht werden!"
+L.Profiles_AlreadyExistsError = "Das Profil %s existiert bereits!"
+
+-- minimap
+L.Minimap_Tooltip_Enabled = "%s"
+L.Minimap_Tooltip_Disabled = "%s " .. cGray("(inaktiv)")
+L.Minimap_Tooltip_Options_Left = "Linksklick"
+L.Minimap_Tooltip_Options_Right = "\195\150ffnet oder schlie\195\159t die Einstellungen."
+L.Minimap_Tooltip_Mappings_Left = "Rechtsklick"
+L.Minimap_Tooltip_Mappings_Right = "Aktiviert oder Deaktivert jegliche Ersetzungen."
 
 -- options
 L.Options_Title = "%s Einstellungen"
 L.Options_Enabled_Name = "Aktiv"
 L.Options_Enabled_Desc = "Aktiviert %s"
+L.Options_Minimap_Button_Name = "Zeige Minimap-Knopf"
+L.Options_Minimap_Button_Desc = "Zeigt oder versteckt den Knopf an der Miniaturkarte"
 
 L.Options_Channels_Group_Name = "Kan\195\164le"
 L.Options_Channels_Group_Desc = "%s ist in folgenden Kan\195\164len aktiv."
-L.Options_Channels_ChannelSay_Name = "Sagen"
-L.Options_Channels_ChannelSay_Desc = "Aktiviert %s im Kanal \"Sagen\"."
-L.Options_Channels_ChannelEmote_Name = "Emote"
-L.Options_Channels_ChannelEmote_Desc = "Aktiviert %s im Kanal \"Emote\"."
-L.Options_Channels_ChannelYell_Name = "Schreien"
-L.Options_Channels_ChannelYell_Desc = "Aktiviert %s im Kanal \"Schreien\"."
-L.Options_Channels_ChannelParty_Name = "Gruppe"
-L.Options_Channels_ChannelParty_Desc = "Aktiviert %s im Kanal \"Gruppe\"."
-L.Options_Channels_ChannelPartyLeader_Name = "Gruppenanf\195\188hrer"
-L.Options_Channels_ChannelPartyLeader_Desc = "Aktiviert %s im Kanal \"Gruppenanf\195\188hrer\"."
-L.Options_Channels_ChannelGuild_Name = "Gilde"
-L.Options_Channels_ChannelGuild_Desc = "Aktiviert %s im Kanal \"Gilde\"."
-L.Options_Channels_ChannelOfficer_Name = "Offiziere"
-L.Options_Channels_ChannelOfficer_Desc = "Aktiviert %s im Kanal \"Offiziere\"."
-L.Options_Channels_ChannelRaid_Name = "Schlachtzug"
-L.Options_Channels_ChannelRaid_Desc = "Aktiviert %s im Kanal \"Schlachtzug\"."
-L.Options_Channels_ChannelRaidLeader_Name = "Schlachtzugsanf\195\188hrer"
-L.Options_Channels_ChannelRaidLeader_Desc = "Aktiviert %s im Kanal \"Schlachtzugsanf\195\188hrer\"."
-L.Options_Channels_ChannelInstance_Name = "Instanz"
-L.Options_Channels_ChannelInstance_Desc = "Aktiviert %s im Kanal \"Instanz\"."
-L.Options_Channels_ChannelBattleground_Name = "Schlachtfeld"
-L.Options_Channels_ChannelBattleground_Desc = "Aktiviert %s im Kanal \"Schlachtfeld\"."
-L.Options_Channels_ChannelWhisper_Name = "Fl\195\188stern"
-L.Options_Channels_ChannelWhisper_Desc = "Aktiviert %s im Kanal \"Fl\195\188stern\"."
+L.Options_Channels_Header = "Eine Ersetzung wird nur in den unten markierten Kan\195\164len durchgef\195\188hrt:"
+
+L.Options_Channel_Say_Name = "Sagen"
+L.Options_Channel_Say_Desc = "Aktiviert %s im Kanal \"Sagen\"."
+L.Options_Channel_Emote_Name = "Emote"
+L.Options_Channel_Emote_Desc = "Aktiviert %s im Kanal \"Emote\"."
+L.Options_Channel_Yell_Name = "Schreien"
+L.Options_Channel_Yell_Desc = "Aktiviert %s im Kanal \"Schreien\"."
+L.Options_Channel_Party_Name = "Gruppe"
+L.Options_Channel_Party_Desc = "Aktiviert %s im Kanal \"Gruppe\"."
+L.Options_Channel_PartyLeader_Name = "Gruppenanf\195\188hrer"
+L.Options_Channel_PartyLeader_Desc = "Aktiviert %s im Kanal \"Gruppenanf\195\188hrer\"."
+L.Options_Channel_Guild_Name = "Gilde"
+L.Options_Channel_Guild_Desc = "Aktiviert %s im Kanal \"Gilde\"."
+L.Options_Channel_Officer_Name = "Offiziere"
+L.Options_Channel_Officer_Desc = "Aktiviert %s im Kanal \"Offiziere\"."
+L.Options_Channel_Raid_Name = "Schlachtzug"
+L.Options_Channel_Raid_Desc = "Aktiviert %s im Kanal \"Schlachtzug\"."
+L.Options_Channel_RaidLeader_Name = "Schlachtzugsanf\195\188hrer"
+L.Options_Channel_RaidLeader_Desc = "Aktiviert %s im Kanal \"Schlachtzugsanf\195\188hrer\"."
+L.Options_Channel_RaidWarning_Name = "Schlachtzugswarnung"
+L.Options_Channel_RaidWarning_Desc = "Aktiviert %s im Kanal \"Schlachtzugswarnung."
+L.Options_Channel_Instance_Name = "Instanz"
+L.Options_Channel_Instance_Desc = "Aktiviert %s im Kanal \"Instanz\"."
+L.Options_Channel_Battleground_Name = "Schlachtfeld"
+L.Options_Channel_Battleground_Desc = "Aktiviert %s im Kanal \"Schlachtfeld\"."
+L.Options_Channel_Whisper_Name = "Fl\195\188stern"
+L.Options_Channel_Whisper_Desc = "Aktiviert %s im Kanal \"Fl\195\188stern\"."
 
 L.Options_Replacements_Group_Name = "Ersetzungen"
 L.Options_Replacements_Group_Desc = "Diese Vorkommen werden in den aktivierten Kan\195\164len ersetzt."
@@ -56,16 +99,474 @@ L.Options_Replacements_Add_Name = "Hinzu"
 L.Options_Replacements_Add_Desc = "F\195\188gt eine neue Zuordnung hinzu."
 L.Options_Replacements_DeleteAll_Name = "Alle L\195\182schen"
 L.Options_Replacements_DeleteAll_Desc = "L\195\182scht alle Zuweisungen."
+L.Options_Replacements_DeleteAll_ConfirmText="Wirklich ALLE Zuweisungen l\195\182schen?"
+L.Options_Replacements_Header = "Die Vorkommen links vom Pfeil \"=>\" werden in den aktivierten Kan\195\164len gesucht und durch den Text rechts vom Pfeil ersetzt."
 
-L.Options_Replacement_Group_Name = "Ersetzung"
-L.Options_Replacement_Group_Desc = "Dieses Vorkommen wird in den aktivierten Kan\195\164len ersetzt."
-L.Options_Replacement_SearchText_Name = "Suchtext:"
-L.Options_Replacement_SearchText_Desc = "Dieser Text wird in der Chateingabe gesucht."
-L.Options_Replacement_ReplaceText_Name = "Ersetzung:"
-L.Options_Replacement_ReplaceText_Desc = "Jeder Suchtreffer wird mit diesem Text ersetzt."
-L.Options_Replacement_CaseSensitive_Name = "Gro\195\159- und Kleinschreibung beachten"
-L.Options_Replacement_CaseSensitive_Desc = "Groß\195\159buchstaben werden mit Gro\195\159buchstaben ersetzt."
-L.Options_Replacement_Consolidate_Name = "Fa\195\159e aufeinanderfolgende Treffer zusammen"
-L.Options_Replacement_Consolidate_Desc = "Wenn durch die Ersetzung die Zeichenfolge mehrfach hintereinander steht,|nfasse sie zu einem Vorkommen zusammen."
-L.Options_Replacement_Delete_Name = "L\195\182schen"
-L.Options_Replacement_Delete_Desc = "L\195\182scht diese Zuweisung."
+L.Options_Mapping_Group_Name = "%s => %s"
+L.Options_Mapping_Group_Desc = "Dieses Vorkommen wird in den aktivierten Kan\195\164len ersetzt."
+L.Options_Mapping_EmptyMapping = "(keine)"
+L.Options_Mapping_MoveUp_Name = "^"
+L.Options_Mapping_MoveUp_Desc = "nach oben verschieben"
+L.Options_Mapping_MoveDown_Name = "v"
+L.Options_Mapping_MoveDown_Desc = "nach unten verschieben"
+L.Options_Mapping_MatchWhen_Name = "wann:"
+L.Options_Mapping_MatchWhen_Desc = "F\195\188hrt die Ersetzung nur durch, wenn der Suchtext |nirgendwo vorkommt (<immer>), |nwenn der Suchtext <als ganzes Wort> \195\188bereinstimmt, |n<nur am Anfang eines Worts>, |noder <nur am Ende eines Worts>, |noder <nur am Anfang oder Ende eines Worts> aber nicht dazwischen, |noder nur in der Wortmitte aber <nie am Anfang und Ende eines Worts>."
+L.Options_Mapping_MatchWhen_Select1 = "nie (deaktivert)"
+L.Options_Mapping_MatchWhen_Select2 = "immer"
+L.Options_Mapping_MatchWhen_Select3 = "als ganzes Wort"
+L.Options_Mapping_MatchWhen_Select4 = "nur am Anfang eines Worts"
+L.Options_Mapping_MatchWhen_Select5 = "nur am Ende eines Worts"
+L.Options_Mapping_MatchWhen_Select6 = "nur am Anfang oder Ende eines Worts"
+L.Options_Mapping_MatchWhen_Select7 = "nie am Anfang und Ende eines Worts"
+L.Options_Mapping_SearchText_Name = "Suchtext:"
+L.Options_Mapping_SearchText_Desc = "Dieser Text wird in der Chateingabe gesucht."
+L.Options_Mapping_ReplaceText_Name = "Ersetzung:"
+L.Options_Mapping_ReplaceText_Desc = "Jeder Suchtreffer wird mit diesem Text ersetzt."
+L.Options_Mapping_ExactCase_Name = "Exakte Gro\195\159- und Kleinschreibung"
+L.Options_Mapping_ExactCase_Desc = "Wenn gesetzt, muss die Gro\195\159- und Kleinschreibung des Suchtextes exakt \195\188berein stimmen. Anderfalls wird die Gro\195\159schreibung jedes Zeichens bei der Ersetzung \195\188bernommen."
+L.Options_Mapping_Consolidate_Name = "Zusammenfassen aufeinanderfolgender Treffer"
+L.Options_Mapping_Consolidate_Desc = "Wenn durch die Ersetzung die Zeichenfolge mehrfach hintereinander steht,|nfasse sie zu einem Vorkommen zusammen."
+L.Options_Mapping_StopOnMatch_Name = "Anhalten nach Treffer"
+L.Options_Mapping_StopOnMatch_Desc = "F\195\188hrt keine nachfolgenden Ersetzungen mehr durch, wenn dieser Eintrag ein Suchtreffer war."
+L.Options_Mapping_Delete_Name = "L\195\182schen"
+L.Options_Mapping_Delete_Desc = "L\195\182scht diese Zuweisung."
+L.Options_Mapping_Delete_ConfirmText="Diese Zuweisung l\195\182schen?"
+
+L.Options_Help_Group_Name = "Hilfe"
+L.Options_Help_Group_Desc = "Hilfstellungen zu den Suchmustern und zur Ersetzungslogik."
+L.Options_Help_Disclaimer = cYellow("Haftungsausschlu\195\159:") .. " Das Addon wird im reinen Ist-Zustand zur Verf\195\188gung gestellt, ohne Garantie auf Funktion und Fehlerfreiheit (f\195\188r mehr Details siehe GPL 3 Lizenzdokument). "
+                            .. "Ferner \195\188bernimmt der Autor keinerlei Haftung oder Gew\195\164hrleistung f\195\188r durch das Addon oder dessen Nutzung entstandene Fehler oder Sch\195\164den, "
+                            .. "insb. den Verlust von Spielfortschritt oder Daten aufgrund von Abst\195\188rzen des WoW-Clients."
+L.Options_Help_Tab_Basics_Name = "Grundlagen"
+L.Options_Help_Tab_Basics_Desc = "Erl\195\164utert die Grundlagen des Addons"
+L.Options_Help_Tab_Expert_Name = "Experte"
+L.Options_Help_Tab_Expert_Desc = "Beleuchtet die Besonderheiten bei der Textsuche."
+L.Options_Help_Tab_Examples_Name = "Beispiele"
+L.Options_Help_Tab_Examples_Desc = "Beispiele f\195\188r bestimmte Szenarien."
+
+L.Options_Help_Basics = cYellow("Reihenfolge")
+                        .. "|nEs sind unbegrenzt viele Textersetzung m\195\182glich, und sie werden in der Reihenfolge der definierten Zuordnungen abgearbeitet, von oben nach unten. "
+                        .. "Ersetzungen sind transitiv, d.h. nachfolgende Zuordnungen beziehen sich nicht auf den Originaltext, sondern das Resultat der vorherigen Ersetzung. "
+                        .. "|nMit der Zuordnung " .. cPrefix("\"a\" => \"b\"") .. " und " .. cPrefix("\"b\" => \"c\"") .. " wird bei Eingabe von " .. cPrefix("\"a\" => \"c\"") .. "."
+                        .. "|n|n" .. cYellow("Exakte Gro\195\159- und Kleinschreibung")
+                        .. "|nBei exakter Gro\195\159- und Kleinschreibung muss die Schreibweise genau \195\188berstimmen, sonst findet keine Textersetzug f\195\188r diese Zuordnung statt. "
+                        .. "Wird die Gro\195\159- und Kleinschreibung ignoriert, wird die Gro\195\159schreibung jedes Zeichens bei der Ersetzung \195\188bernommen. "
+                        .. "|nMit der Zuordnung " .. cPrefix("\"aBcDeF\" => \"uvWXYz\"") .. " wird aus " .. cPrefix("\"abcdef\" => \"uvwxyz\"") .. ", "
+                        .."aus " .. cPrefix("\"ABCDEF\" => \"UVWXYZ\"") .. " und aus " .. cPrefix("\"AbCdEf\" => \"UvWxYz\"") .. "."
+                        .. "|n|n" .. cYellow("Zusammenfassen aufeinanderfolgender Treffer")
+                        .. "|nDas Zusammenfassen aufeinanderfolgender Treffer vermeidet unsch\195\182ne Wiederholungen, die durch die Ersetzung entstehen k\195\182nnen. "
+                        .. "Die Zusammenfassung wird erst nach der Ersetzung vorgenommen, d.h. am vollst\195\164ndig ersetzten Text f\195\188r jede Zuordnung. "
+                        .. "|nMit der Zuordnung " .. cPrefix("\"s\" => \"sch\"") .. " wird aus " .. cPrefix("\"Tasse\" => \"Tasche\"") .. " statt " .. cPrefix("\"Taschsche\"") .. ", "
+                        .. "aber " .. cPrefix("\"schmeissen\" => \"schchmeichen\"") .. ". Solche Randbedingungen beseitigt in der Regel eine weitere Zuordnung wie " .. cPrefix("\"schch\" => \"sch\"") .. "."
+                        .. "|n|n" .. cYellow("Anhalten nach Treffer")
+                        .. "|nEs werden keine weiteren Ersetzungen mehr vorgenommen, wenn die aktuelle Zuordnung zutreffend ist. Alle nachfolgenden Zuordnungen werden dann \195\188bersprungen. "
+                        .. "Wenn kein Treffer vorliegt, werden die restlichen Zuordnung ganz normal weiter abgearbeitet."
+L.Options_Help_Expert = cYellow("verk\195\188rzende/verl\195\163ngernde Ersetzungen")
+                        .. "|nIst der Ersetzungstext k\195\188rzer als der eigentliche Suchtext, werden die \195\188bersch\195\188\195\159igen Zeichen des Suchtreffers entfernt. "
+                        .. "Ist der Ersetzungstext l\195\163nger, werden die \195\188brigen Zeichen nach dem Treffer hinten drangehangen. Dabei wird die Gro\195\159- und Kleinschreibung des letzten Zeichens ber\195\188cksichtigt, "
+                        .. "ebenso wie die Gro\195\159- und Kleinschreibung des nachfolgenden Zeichens. Gro\195\159geschriebene Abk\195\188rzungen und Ausdr\195\188cke bleiben so einheitlich. "
+                        .. "|nMit der Zuordnung " .. cPrefix("\"Kr\195\164uter\" => \"Gr\195\188nzeugs\"") .. " wird aus " .. cPrefix("\"KR\195\132UTER\" => \"GR\195\156NZEUGS\"") .. " statt " .. cPrefix("\"GR\195\156NZEUgs\"") .. " "
+                        .. "unter Beibehaltung von absichtlicher Gro\195\159schreibung wie " .. cPrefix("\"Kr\195\132utERGarten\" => \"Gr195\156nzEUGSgarten\"") .. " statt " .. cPrefix("\"Gr\195\188nzeugsGarten\"") .. "."
+                        .. "|n|n" .. cYellow("Standby")
+                        .. "|nErsetzungen k\195\182nnen auch nur bei Bedarf durchgef\195\188hrt werden, selbst wenn das Addon oder ein Kanal deaktivert wurde. "
+                        .. "Vor der Eingabe in der Chatbox schreibt man " .. cPrefix("/gri").. " oder " .. cPrefix("/grichelde").. " und optional noch den Zielkanal "
+                        .. "z.B. " .. cPrefix("\"/gri /g hallo leute\"") .. " und alle aktiven Zuordnungen werden ersetzt, selbst wenn der Gildenkanal oder das Addon nicht aktiv sind."
+                        .. "|n|n" .. cYellow("Regul\195\164re Ausdr\195\188cke")
+                        .. "|nRegEx sind sehr m\195\163chtige Such- und Ersetzunsgmuster die h\195\163ufig in der Programmierung verwendet werden. Generell werden RegEx in den Suchtexten \195\188bernommen, "
+                        .. "aber Lua unterst\195\188tzt nicht den vollst\195\163ndigen Umfang von PCRE. Trotzdem funktionieren viele Muster wie Anker bei Zeilenanfang " .. cPrefix("\"^\"") .. " oder Zeilenende " .. cPrefix("\"$\"")
+                        .. ", Gruppen " .. cPrefix("\"(Hallo) (Welt)\"") .. "Zeichenklassen wie Zahlen " .. cPrefix("\"%d\"") .. " oder (negierte) Auswahlen " .. cPrefix("\"[^%p]\"") .. ". "
+                        .. "Auf Gruppen kann im Ersetzungtext mit %<Nummer> zugegriffen werden" .. cPrefix("\"%2 %1\"") .. "."
+                        .. "|nIm Beispiel-Reiter gibt es einige Ersetzungen, welche mit regul\195\164ren Ausdr\195\188cke umgesetzt wurden."
+
+L.Options_Help_Examples_Note = cYellow("Hinweis:") .. " Dieses Addon bef\195\188rwortet nicht und beabsichtig nicht Personen mit (Fremd-)Sprachproblemen |nzu verletztem oder herabzuw\195\188rdigen. Die Verantwortung f\195\188r den Einsatz des Addons obliegt dem Benutzer. |nBitte verwendet die Funktion respektvoll und zur\195\188ckhaltend gegen\195\188ber anderen Mitspielern."
+L.Options_Help_Examples_Header = cYellow("Beispiel")
+L.Options_Help_Examples_Text = "Bitte ein Beispiel aus der Auswahlbox ausw\195\164hlen."
+L.Options_Help_Examples_Import_Name = "Importieren"
+L.Options_Help_Examples_Import_Desc = "Importiert das ausgew\195\164hlte Beispiel in ein neues Profil %s."
+L.Options_Help_Examples_Import_ConfirmText = "Wird das Beispiel %s in das neue Profil %s importieren."
+
+L.Options_Help_Examples = {
+    {
+        name = "fehlender Unterkiefer",
+        desc = cYellow("S und P werden durch Zisch- und Klacklaute ersetzt."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "s",
+                replaceText = "ch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "t",
+                replaceText = "ck",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "p",
+                replaceText = "b",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Trollifizierung",
+        desc = cYellow("L\195\164\195\159t euch fast wie Vol'jin klingen."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "(%w)(%p?)$",
+                replaceText = "%1, maan%2",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "ir(r?)",
+                replaceText = "ia",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "ch",
+                replaceText = "ck",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "g",
+                replaceText = "ch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "qu",
+                replaceText = "kw",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "t",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "er",
+                replaceText = "a",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Jar Jar Binks",
+        desc = cYellow("L\195\164\195\159t euch sprechen wie ein ungeschickter Gungan"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "ver",
+                replaceText = "va",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "en",
+                replaceText = "'n",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "er",
+                replaceText = "a",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "(%w?)ich",
+                replaceText = "%1ichse",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "(d?m?)ir",
+                replaceText = "%1ichse",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "du",
+                replaceText = "du da",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "er",
+                replaceText = "erse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_17 = {
+                order = 17,
+                searchText = "sie",
+                replaceText = "sie da",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_18 = {
+                order = 18,
+                searchText = "wir",
+                replaceText = "wirse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_19= {
+                order = 19,
+                searchText = "ihr",
+                replaceText = "ihrse",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_20 = {
+                order = 20,
+                searchText = "nicht",
+                replaceText = "nich",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_21 = {
+                order = 21,
+                searchText = "die",
+                replaceText = "de",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Altmodisch",
+        desc = cYellow("Benutzt eine antiquiertere Schreibweise."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "ei",
+                replaceText = "ey",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "eu",
+                replaceText = "oy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "\195\159",
+                replaceText = "sz",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Abk\195\188rzungen",
+        desc = cYellow("Viel sagen, wenig tippen."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "gz",
+                replaceText = "Herzlichen Gl\195\188ckwunsch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "gn8",
+                replaceText = "Gute Nacht",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "afk",
+                replaceText = "Bin mal kurz weg. (AFK)",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "MC",
+                replaceText = "Geschmolzener Kern",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Eigen-, Kose- und Ortsnamen",
+        desc = cYellow("Ersetzt Spielernamen, NPCs oder Orte durch andere Ausdr\195\188cke."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "Sylvanas",
+                replaceText = "die rachs\195\188chtige Bansheek\195\182nigin",
+                exactCase = true,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "R\195\188tzkn\195\188bbel",
+                replaceText = "R\195\188tzi",
+                exactCase = true,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "Unterstadt",
+                replaceText = "Undercity",
+                exactCase = true,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Lispeln",
+        desc = cYellow("Aussprache von S und Z wird zu einem Zischlaut"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "sch",
+                replaceText = "ch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "s",
+                replaceText = "fs",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "z",
+                replaceText = "ts",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "chs",
+                replaceText = "x",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Stottern",
+        desc = cYellow("Wiederholt Vokale am Satzanfang"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "^([^aeiouy]-)([aeiouy])",
+                replaceText = "%1%2-%1%2-%1%2",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+        }
+    },
+}
+
+L.IgnorePattern_Star = "Stern"
+L.IgnorePattern_Circle = "Kreis"
+L.IgnorePattern_Diamond = "Diamant"
+L.IgnorePattern_Triangle = "Dreieck"
+L.IgnorePattern_Moon = "Mond"
+L.IgnorePattern_Square = "Quadrat"
+L.IgnorePattern_Cross = "Kreuz"
+L.IgnorePattern_Skull = "Totenkopf"

localisation/enUS.lua

@@ -1,72 +1,615 @@
-local L = LibStub('AceLocale-3.0'):NewLocale('Grichelde', 'enUS', true)
+-- read namespace from global env
+local AddonName, _ = ...
+local _G = _G
+local Grichelde = _G.Grichelde
+
+local L = LibStub('AceLocale-3.0'):NewLocale(AddonName, 'enUS', true)
 if not L then return end
 
+local cYellow = Grichelde.F.cYellow
+local cGray = Grichelde.F.cGray
+local cPrefix = Grichelde.F.cPrefix
+
 -- system messages
 L.AddonName = "Grichelde"
-L.AddonLoaded = "%s now helps you with your spelling disabilities."
-L.Addon_Detected_Misspelled = "Addon 'Misspelled' has been detected and any messsage will be cleansed automatically."
-L.Addon_Detected_WIM = "Das Addon 'WIM' has been detected and any whispers will be handled from IM windows."
+L.AddonNamePlusVersion = "%s v%s"
+L.AddonLoaded = "%s happily assists you with your spelling disabilities now."
+L.AddonUnloaded = "%s patiently waits to support you again when needed."
+L.Upgrade_ToVersion = "Upgrade database to version %s."
+L.Upgrade_Successful = "Upgrade successful."
+L.Upgrade_Error = "Upgrade failed!"
+L.Downgrade_Detected = "Downgrade detected, %s might not work correctly!"
 
+-- debug
+L.Debug_Options = "Options"
+L.Debug_Mappings = "Mappings"
+L.Debug_Mappings_Hint = "The content of this input box is used for debugging purposes only and can be copied. No input from this box will be read or processed."
+L.Debug_Mappings_Found = "%d mappings found"
+L.Debug_Profile = "Profile"
+
+-- errors
+L.Error_InvalidCommand = "Invalid command"
+L.Error_InvalidChannel = "Invalid channel"
+L.Error_InvalidWhisperTarget = "Invalid whisper target"
+L.Error_UnsupportedChannel = "Unsupported channel"
 
 -- profiles
 L.Profiles_Available = "Available profiles:"
-L.Profiles_Created = "New profile \"%s\" created."
-L.Profiles_Loaded = "Profile %s%s%s is loaded."
-L.Profiles_Refreshed = "Profil %s%s%s refreshed."
-L.Profiles_Deleted = "Profile %s%s%s deleted."
-L.Profiles_Copied = "Settings applied from profile %s%s%s."
-L.Profiles_Reset = "Profil %s%s%s reset."
-L.Profiles_Invalid = "Invalid profile %s%s%s!"
+L.Profiles_Created = "New profile %s created."
+L.Profiles_Loaded = "Profile %s is loaded."
+L.Profiles_Activated = "Profile %s activated."
+L.Profiles_Deactivated = "Profile %s deactivated."
+L.Profiles_Refreshed = "Profile %s refreshed."
+L.Profiles_Deleted = "Profile %s deleted."
+L.Profiles_Copied = "Settings applied from profile %s."
+L.Profiles_Reset = "Profile %s reset."
+L.Profiles_Invalid = "Invalid profile %s!"
 L.Profiles_DeleteError = "The active profile cannot be deleted!"
+L.Profiles_AlreadyExistsError = "The profile %s already exists!"
+
+-- minimap
+L.Minimap_Tooltip_Enabled = "%s"
+L.Minimap_Tooltip_Disabled = "%s " .. cGray("(inactive)")
+L.Minimap_Tooltip_Options_Left = "Left-Click"
+L.Minimap_Tooltip_Options_Right = "Opens or closes the options UI."
+L.Minimap_Tooltip_Mappings_Left = "Right-Click"
+L.Minimap_Tooltip_Mappings_Right = "Enables or disables any replacements."
 
 -- options
 L.Options_Title = "%s Options"
 L.Options_Enabled_Name = "Enabled"
 L.Options_Enabled_Desc = "Enables %s"
+L.Options_Minimap_Button_Name = "Show minimap button"
+L.Options_Minimap_Button_Desc = "Shows or hides the button on the minimap."
 
 L.Options_Channels_Group_Name = "Channels"
 L.Options_Channels_Group_Desc = "%s is active in the following channels."
-L.Options_Channels_ChannelSay_Name = "Say"
-L.Options_Channels_ChannelSay_Desc = "Activates %s in channel \"Say\"."
-L.Options_Channels_ChannelEmote_Name = "Emote"
-L.Options_Channels_ChannelEmote_Desc = "Activates %s in channel \"Emote\"."
-L.Options_Channels_ChannelYell_Name = "Yell"
-L.Options_Channels_ChannelYell_Desc = "Activates %s in channel \"Yell\"."
-L.Options_Channels_ChannelParty_Name = "Party"
-L.Options_Channels_ChannelParty_Desc = "Activates %s in channel \"Party\"."
-L.Options_Channels_ChannelPartyLeader_Name = "Party Leader"
-L.Options_Channels_ChannelPartyLeader_Desc = "Activates %s in channel \"Party Leader\"."
-L.Options_Channels_ChannelGuild_Name = "Guild"
-L.Options_Channels_ChannelGuild_Desc = "Activates %s in channel \"Guild\"."
-L.Options_Channels_ChannelOfficer_Name = "Officers"
-L.Options_Channels_ChannelOfficer_Desc = "Activates %s in channel \"Officers\"."
-L.Options_Channels_ChannelRaid_Name = "Raid"
-L.Options_Channels_ChannelRaid_Desc = "Activates %s in channel \"Raid\"."
-L.Options_Channels_ChannelRaidLeader_Name = "Raid Leader"
-L.Options_Channels_ChannelRaidLeader_Desc = "Activates %s in channel \"Raid Leader\"."
-L.Options_Channels_ChannelInstance_Name = "Instance"
-L.Options_Channels_ChannelInstance_Desc = "Activates %s in channel \"Instance\"."
-L.Options_Channels_ChannelBattleground_Name = "Battleground"
-L.Options_Channels_ChannelBattleground_Desc = "Activates %s in channel \"Battleground\"."
-L.Options_Channels_ChannelWhisper_Name = "Whisper"
-L.Options_Channels_ChannelWhisper_Desc = "Activates %s in channel \"Whisper\"."
+L.Options_Channels_Header = "Text replacement will only be done for marked channels below:"
+
+L.Options_Channel_Say_Name = "Say"
+L.Options_Channel_Say_Desc = "Activates %s in channel \"Say\"."
+L.Options_Channel_Emote_Name = "Emote"
+L.Options_Channel_Emote_Desc = "Activates %s in channel \"Emote\"."
+L.Options_Channel_Yell_Name = "Yell"
+L.Options_Channel_Yell_Desc = "Activates %s in channel \"Yell\"."
+L.Options_Channel_Party_Name = "Party"
+L.Options_Channel_Party_Desc = "Activates %s in channel \"Party\"."
+L.Options_Channel_PartyLeader_Name = "Party Leader"
+L.Options_Channel_PartyLeader_Desc = "Activates %s in channel \"Party Leader\"."
+L.Options_Channel_Guild_Name = "Guild"
+L.Options_Channel_Guild_Desc = "Activates %s in channel \"Guild\"."
+L.Options_Channel_Officer_Name = "Officers"
+L.Options_Channel_Officer_Desc = "Activates %s in channel \"Officers\"."
+L.Options_Channel_Raid_Name = "Raid"
+L.Options_Channel_Raid_Desc = "Activates %s in channel \"Raid\"."
+L.Options_Channel_RaidLeader_Name = "Raid Leader"
+L.Options_Channel_RaidLeader_Desc = "Activates %s in channel \"Raid Leader\"."
+L.Options_Channel_RaidWarning_Name = "Raid Warning"
+L.Options_Channel_RaidWarning_Desc = "Activates %s in channel \"Raid Warning\"."
+L.Options_Channel_Instance_Name = "Instance"
+L.Options_Channel_Instance_Desc = "Activates %s in channel \"Instance\"."
+L.Options_Channel_Battleground_Name = "Battleground"
+L.Options_Channel_Battleground_Desc = "Activates %s in channel \"Battleground\"."
+L.Options_Channel_Whisper_Name = "Whisper"
+L.Options_Channel_Whisper_Desc = "Activates %s in channel \"Whisper\"."
 
 L.Options_Replacements_Group_Name = "Replacements"
 L.Options_Replacements_Group_Desc = "These lookups will be replaced in activated channels."
 L.Options_Replacements_Add_Name = "Add"
-L.Options_Replacements_Add_Desc = "Add a new replacement mapping."
+L.Options_Replacements_Add_Desc = "Adds a new replacement mapping."
 L.Options_Replacements_DeleteAll_Name = "Delete All"
-L.Options_Replacements_DeleteAll_Desc = "Delete all replacement mappings."
+L.Options_Replacements_DeleteAll_Desc = "Deletes all replacement mappings."
+L.Options_Replacements_DeleteAll_ConfirmText = "Do you really want to delete ALL replacement mappings?"
+L.Options_Replacements_Header = "All matches on the lefthand side of the arrow \"=>\" will be replaced in activated channels by the text on the righthand side. "
 
-L.Options_Replacement_Group_Name = "Mapping"
-L.Options_Replacement_Group_Desc = "This lookup will be replaced in activated channels."
-L.Options_Replacement_SearchText_Name = "Search for:"
-L.Options_Replacement_SearchText_Desc = "This text is looked up in your chat input box."
-L.Options_Replacement_ReplaceText_Name = "Replacement:"
-L.Options_Replacement_ReplaceText_Desc = "Any match will be replaced with this text."
-L.Options_Replacement_CaseSensitive_Name = "case sensitive"
-L.Options_Replacement_CaseSensitive_Desc = "Will not replace occurrences if cases differ."
-L.Options_Replacement_Consolidate_Name = "consolidate consecutive matches"
-L.Options_Replacement_Consolidate_Desc = "If after the replacement a text sequence is repeated|ndirectly after another, treat them as one occurrence."
-L.Options_Replacement_Delete_Name = "Delete"
-L.Options_Replacement_Delete_Desc = "Delete this replacement mapping."
+L.Options_Mapping_Group_Name = "%s => %s"
+L.Options_Mapping_Group_Desc = "This lookup will be replaced in activated channels."
+L.Options_Mapping_EmptyMapping = "(none)"
+L.Options_Mapping_MoveUp_Name = "^"
+L.Options_Mapping_MoveUp_Desc = "move up"
+L.Options_Mapping_MoveDown_Name = "v"
+L.Options_Mapping_MoveDown_Desc = "move down"
+L.Options_Mapping_MatchWhen_Name = "when:"
+L.Options_Mapping_MatchWhen_Desc = "Replacement is only done if the search text matches either |nanywhere (<always>), |nif the search text mantches <as a whole word>, |nolny at the <start of each word>, |nor at the <end of each word>, |nor <only at the start or end of each word> but not in between, |nor only in the middle of each word, but <never at start or end of any word>."
+L.Options_Mapping_MatchWhen_Select1 = "never (disabled)"
+L.Options_Mapping_MatchWhen_Select2 = "always"
+L.Options_Mapping_MatchWhen_Select3 = "as a whole word"
+L.Options_Mapping_MatchWhen_Select4 = "start of each word"
+L.Options_Mapping_MatchWhen_Select5 = "end of each word"
+L.Options_Mapping_MatchWhen_Select6 = "only at start and end of each word"
+L.Options_Mapping_MatchWhen_Select7 = "never at start or end of any word"
+L.Options_Mapping_SearchText_Name = "Search for:"
+L.Options_Mapping_SearchText_Desc = "This text is looked up in your chat input box."
+L.Options_Mapping_ReplaceText_Name = "Replacement:"
+L.Options_Mapping_ReplaceText_Desc = "Any match will be replaced with this text."
+L.Options_Mapping_ExactCase_Name = "exact case"
+L.Options_Mapping_ExactCase_Desc = "When set, matches must be case-sensitive. Otherwise the case for each letter of the matching text is taken over when replaced."
+L.Options_Mapping_Consolidate_Name = "consolidate consecutive matches"
+L.Options_Mapping_Consolidate_Desc = "If after the replacement a text sequence is repeated|ndirectly after another, treat them as one occurrence."
+L.Options_Mapping_StopOnMatch_Name = "stop on match"
+L.Options_Mapping_StopOnMatch_Desc = "Stops looking for any following replacements, when this one matched."
+L.Options_Mapping_Delete_Name = "Delete"
+L.Options_Mapping_Delete_Desc = "Deletes this replacement mapping."
+L.Options_Mapping_Delete_ConfirmText = "Delete this replacement mapping?"
+
+L.Options_Help_Group_Name = "Help"
+L.Options_Help_Group_Desc = "Guideance to search patterns and replacement logic."
+L.Options_Help_Disclaimer = cYellow("Disclaimer of warranty:") .. " The addon is provided \"AS IS\" and comes without warranty of any kind of function or correctness (for more details, consult the GPL 3 license). "
+                            .."Also the author is not held responsible for any risk or damage the addon or its use might cause, especially lost of progress or data due to crashes of the WoW client."
+
+L.Options_Help_Tab_Basics_Name = "Basics"
+L.Options_Help_Tab_Basics_Desc = "Some explanatory notes the the basic behaviour."
+L.Options_Help_Tab_Expert_Name = "Expert"
+L.Options_Help_Tab_Expert_Desc = "More details on special search options."
+L.Options_Help_Tab_Examples_Name = "Examples"
+L.Options_Help_Tab_Examples_Desc = "Templates for particular scenarios."
+
+L.Options_Help_Basics = cYellow("Ordering")
+                        .. "|nYou can have an unlimited number of replacements. All mappings will be processed in same order as defined, from top down. "
+                        .. "Replacements are also transitive, so consecutive mappings do not work on the original input but the resulting text from the previous replacements. "
+                        .. "|nBoth mappings " .. cPrefix("\"a\" => \"b\"") .. " and " .. cPrefix("\"b\" => \"c\"") .. " applied, result in the final text " .. cPrefix("\"a\" => \"c\"") .. "."
+                        .. "|n|n" .. cYellow("exact case")
+                        .. "|nIf \"exact case\" is checked, lower and upper case must match exactly to be replaced, otherwise the mapping is skipped. "
+                        .. "If case sensivity is ignored, the case for each letter of the matching text is taken over when replaced. "
+                        .. "|nWith mapping " .. cPrefix("\"aBcDeF\" => \"uvWXYz\"") .. " text results in " .. cPrefix("\"abcdef\" => \"uvwxyz\"") .. ", "
+                        .. "also " .. cPrefix("\"ABCDEF\" => \"UVWXYZ\"") .. " and " .. cPrefix("\"AbCdEf\" => \"UvWxYz\"") .. "."
+                        .. "|n|n" .. cYellow("consolidate consecutive matches")
+                        .. "|nConsolidation of consecutive matches prevent unaesthetic repetitions of letters introduced during replacements. "
+                        .. "Consolidation takes place after all replacements were done, meaning it's applied to the completely replaced text. "
+                        .. "|nWith mapping " .. cPrefix("\"s\" => \"sh\"") .. " text becomes " .. cPrefix("\"tossing\" => \"toshing\"") .. " instead of " .. cPrefix("\"toshshing\"") .. ", yet still " .. cPrefix("\"paths\" => \"pathsh\"") .. ". "
+                        .. "Such edge cases can usually be mitigated with an additional mapping at the end: " .. cPrefix("\"thsh\" => \"thz\"") .. "."
+                        .. "|n|n" .. cYellow("stop on match")
+                        .. "|nNo other replacements are done, when the current mapping matched. This will skip any other consecutive mappings when hit. When no match ocurred, the remaining mappings are processed as usual."
+L.Options_Help_Expert = cYellow("shortening/lengthening replacements")
+                        .. "|nIf the replacement is shorter than the actual match, all remaining characters will be skipped. If the replacement is longer, all remaining characters will be appended. "
+                        .. "The case of the replaced character is considered as well as the case of the next character in the original text. That way capital case abbreviations and expressions will not be distorted. "
+                        .. "|nWith mapping " .. cPrefix("\"Body\" => \"Corpse\"") .. " the input becomes " .. cPrefix("\"BODY\" => \"CORPSE\"") .. " instead of " .. cPrefix("\"CORPse\"") .. " "
+                        .. "but still keeps intended exceptions like " .. cPrefix("\"BodYGuard\" => \"CorPSEGuard\"") .. " instead of " .. cPrefix("\"CorpseGuard\"") .. ". "
+                        .. "|n|n" .. cYellow("On-Demand")
+                        .. "|nFor convenience input text in a chatbox can be forcefully replaced, even if the addon or the channel was disabled. "
+                        .. "In the chatbox put " .. cPrefix("/gri") .. " or " .. cPrefix("/grichelde") .. " in front of your typed text, you can also include the target channel, "
+                        .. "i.e. " .. cPrefix("\"/gri /guild hello there\"") .. " and the active replacements are applied even if the guild channel or global switch was disabled."
+                        .. "|n|n" .. cYellow("Regular Expressions")
+                        .. "|nRegEx are very powerful search and replacement patterns commonly used in programming. Technically all searches the addon performs on the input are done with regular expression methods, "
+                        .. "however Lua unfortunately does not support full PCRE syntax and is very limited. Nevertheless some patterns can be used like the anchors start of line " .. cPrefix("\"^\"") .. " or end of line " .. cPrefix("\"$\"")
+                        .. ", capturing groups " .. cPrefix("\"(hello) (world)\"") .. "character classes like numbers " .. cPrefix("\"%d\"") .. " or (inversed) sets " .. cPrefix("\"[^%p]\"") .. ". "
+                        .. "Capture groups can be accessed in the replacement text with %<number> like in " .. cPrefix("\"%2 %1\"").. "."
+                        .. "|nAlso there are some mappings using RegEx in the Example section."
+
+L.Options_Help_Examples_Note = cYellow("Note:") .. " This addon does not encourange or intend to hurt or to tease people with speaking disabilities or language disorders. The responsibility rest on the user completely. Please use the features with care and respect to other players."
+L.Options_Help_Examples_Header = cYellow("Example")
+L.Options_Help_Examples_Text = "Select an example from the dropdown above."
+L.Options_Help_Examples_Import_Name = "Import"
+L.Options_Help_Examples_Import_Desc = "Imports the selected example into a new profile."
+L.Options_Help_Examples_Import_ConfirmText = "This will import the example %s into the nre profile %s."
+
+L.Options_Help_Examples = {
+    {
+        name = "absent jaw",
+        desc = cYellow("S and P will be replaced by sibilant and clack sounds."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "s",
+                replaceText = "ch",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "t",
+                replaceText = "ck",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "p",
+                replaceText = "b",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "trollifier",
+        desc = cYellow("Almost sound like Vol'jin."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "(%w)(%p?)$",
+                replaceText = "%1, mon%2",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "th",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "what are you",
+                replaceText = "whatcha",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "your?s?",
+                replaceText = "ya",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "going to",
+                replaceText = "gonna",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "want to",
+                replaceText = "wanna",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "ing",
+                replaceText = "in'",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Jar Jar Binks",
+        desc = cYellow("Lets you sound like a clumsy Gungan"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "me",
+                replaceText = "mesa",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "I am",
+                replaceText = "Mesa",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "I'm",
+                replaceText = "Mesa",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "I",
+                replaceText = "Me",
+                exactCase = true,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_14 = {
+                order = 14,
+                searchText = "you are",
+                replaceText = "yousa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_15 = {
+                order = 15,
+                searchText = "you're",
+                replaceText = "yousa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_16 = {
+                order = 16,
+                searchText = "your",
+                replaceText = "yous",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_17 = {
+                order = 17,
+                searchText = "(s?)he is",
+                replaceText = "%1hesa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_18 = {
+                order = 18,
+                searchText = "(s?)he's",
+                replaceText = "%1hesa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_19 = {
+                order = 19,
+                searchText = "they",
+                replaceText = "daysa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_20 = {
+                order = 20,
+                searchText = "them",
+                replaceText = "them-sa",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_21 = {
+                order = 21,
+                searchText = "ing",
+                replaceText = "in'",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_22 = {
+                order = 22,
+                searchText = "the",
+                replaceText = "da",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_23 = {
+                order = 23,
+                searchText = "th",
+                replaceText = "d",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_24 = {
+                order = 24,
+                searchText = "yes",
+                replaceText = "yesa",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_25 = {
+                order = 25,
+                searchText = "oka?y?",
+                replaceText = "okeeday",
+                exactCase = false,
+                consolidate = false,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "old-fashioned",
+        desc = cYellow("Use an outdated pronounciation."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "oi",
+                replaceText = "oy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "([^aeiou]*)([aeiou])",
+                replaceText = "%1%2e",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 5,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "yours",
+                replaceText = "thy",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "youe",
+                replaceText = "thou",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "abbreviations",
+        desc = cYellow("Say much, type less."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "gz",
+                replaceText = "Congratulations",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "gn8",
+                replaceText = "Good night",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "afk",
+                replaceText = "I'm temporarily unavailable (AFK)",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "MC",
+                replaceText = "Molten Core",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Proper names",
+        desc = cYellow("Replace player names, NPCs or locations."),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "Sylvanas",
+                replaceText = "the revengeful banshee queen",
+                exactCase = true,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "Asmon",
+                replaceText = "Asmongold",
+                exactCase = true,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "x%-?roads",
+                replaceText = "Crossroads",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 3,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "Lisp",
+        desc = cYellow("S and Z will become sibilant"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "s",
+                replaceText = "th",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_11 = {
+                order = 11,
+                searchText = "ch",
+                replaceText = "tsh",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_12 = {
+                order = 12,
+                searchText = "z",
+                replaceText = "tsh",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+            replacement_13 = {
+                order = 13,
+                searchText = "dg",
+                replaceText = "ck",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 2,
+                stopOnMatch = false,
+            },
+        }
+    }, {
+        name = "stammer",
+        desc = cYellow("Repeats vowels at the beginning of a sentence"),
+        replacements = {
+            replacement_10 = {
+                order = 10,
+                searchText = "^([^aeiouy]-)([aeiouy])",
+                replaceText = "%1%2-%1%2-%1%2",
+                exactCase = false,
+                consolidate = true,
+                matchWhen = 4,
+                stopOnMatch = false,
+            },
+        }
+    },
+}
+
+L.IgnorePattern_Star = "Star"
+L.IgnorePattern_Circle = "Circle"
+L.IgnorePattern_Diamond = "Diamond"
+L.IgnorePattern_Triangle = "Triangle"
+L.IgnorePattern_Moon = "Moon"
+L.IgnorePattern_Square = "Square"
+L.IgnorePattern_Cross = "Cross"
+L.IgnorePattern_Skull = "Skull"

twitch/image-descriptions.txt

@@ -0,0 +1,49 @@
+Sample replacement
+Text is replaced in the "Say" channel.
+
+Replacements
+Define your own set of replacements rules
+
+Replacements
+Create multiple mappings between search text and replacement with additional conditions.
+
+Channel configuration
+individual channel activation
+
+Profiles
+global, per server, per class, per character or custom
+
+Examples
+Templates for various situations, now also with import possibility
+
+Help
+Built-in help texts
+
+Confirm text changes
+When you enter a search or replacement text, please confirm your input with the Okay button. Otherwise its not saved.
+
+
+
+Beispielersetzung
+Eine Texteingabe wird im "Sagen"-Kanal ersetzt.
+
+Zeichenersetzung
+Erzeuge bedingte Zuordnungen zwischen Such- und Ersetzungstext.
+
+Kanälekonfiguration
+einzeln pro Kanal aktivierbar
+
+Profile:
+Global, pro Server, pro Klasse, pro Character
+
+Neu: Beispiele
+Vorlagen für verschiedene Zwecke, jetzt mit Import-Funktion
+
+
+
+Error Reporting
+In case of errors please send me the exact error message and please also provide the mapping from "/gri mappings" (see next screen).
+
+
+Debug Mappings
+In case of errors please send me the exact error message and please also provide the mapping from "/gri mappings"