16 Commits
0.2.0 ... 1.1.1

Author SHA1 Message Date
06a1f1177a Version 1.1.1
- bumped versions for WoW Classic and Shadowlands
2021-04-22 16:53:22 +02:00
475b2b3e1f Version 1.1.0
- split of messages preserves item links, textures, substitutions and raid target markers
- added safety measures to prevent endless replacement loops
- bumped version for Shadowlands
- bumped version for Naxxramas
- split of messages with excessive length no longer causes errors or broken texts
- proper handling of umlauts
2020-12-08 19:32:14 +01:00
e53900d2b1 Version 1.0.0
- added info section with contact and thanks
- fixed minor clarifications and spellings errors on help texts
2020-09-01 13:57:03 +02:00
45099a9a3b 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
2020-08-01 01:50:16 +02:00
bafb116bb9 Version 0.9.0-rc1
- 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
- adapted help texts
- spelling errors
2020-07-25 22:52:40 +02:00
cc4df96bac Version 0.8.1-beta
- stop replacements on match
- better ooc recognition patterns

- keep cases of over-long replacements
2020-06-16 01:24:42 +02:00
44dd7ac8eb Version 0.8.0-beta
- handle replacement via slash command
- emote and ooc detection
- de-/activate single mappings
- move buttons and mappings are disabled when already at top/bottom or deactivated
- minimap button is darkened when addon is disabled
- help tab with examples

- 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
2020-06-14 23:36:54 +02:00
5b72ad3b78 Version 0.7.2-beta
- minimap button

- graphical move arrows

- crash on matches with 0-width
2020-06-08 01:55:52 +02:00
8e179692ee Version 0.7.1-beta
- user reporting capabilities
- ignore Battle.net contacts
- screenshots

- graphical move arrows
2020-06-07 15:01:42 +02:00
cb2c995a82 Version 0.7.0-beta
- order buttons

- use numeric LogLevel over booleans
- exact case option reversed (again)
- smart case handling if replacement is longer than match

- Deletion of all mappings
2020-06-07 02:42:26 +02:00
a29f6486fe Version 0.6.0
- honour capital/mixed cases for ignore case
- consolidate consecutive matches
- database upgrade capability

- case sensitivity option reversed
- removed obsolete WIM handling

- skip empty mapping
- Deletion of mapping
2020-06-06 14:49:55 +02:00
ecd6e5c340 Version 0.5.0
- add replacements via options UI
- restructure debug functions
2020-06-01 14:12:53 +02:00
cc26683328 Version 0.4.0
- restructured files
- extract functions and color codes
- filter channels
2020-05-30 03:14:01 +02:00
b572203dd2 Version 0.3.0
- fixed DB storange and debug printing
2020-05-28 02:29:11 +02:00
db3db16594 Version 0.2.2
- added Options UI under Interface Options
- store settings in profiles
- added more translations
2020-05-26 00:55:14 +02:00
32a692279a Version 0.2.1
- support automatic packaging for curseforge via .pkgmeta
- include project logo
- auto-update the project description via .docmeta
2020-05-26 00:51:19 +02:00
99 changed files with 10381 additions and 374 deletions

4
.docmeta Normal file
View File

@@ -0,0 +1,4 @@
-
type: markdown
input-file: README.md
output-page: "Main"

2
.gitignore vendored
View File

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

27
.pkgmeta Normal file
View File

@@ -0,0 +1,27 @@
package-as: Grichelde
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
libs/AceLocale-3.0: https://repos.wowace.com/wow/ace3/trunk/AceLocale-3.0
ignore:
- twitch
manual-changelog:
filename: CHANGELOG.md
markup-type: markdown
license-output: LICENSE

3
.retail.toc Normal file
View File

@@ -0,0 +1,3 @@
## Interface: 90005
## X-Build: Retail

View File

@@ -3,13 +3,136 @@ 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-27
First version to be released
## Version 1.1.1 - 2021-04-22
### Changed
- bumped versions for WoW Classic and Shadowlands
## Version 1.1.0 - 2020-12-08
### Added
- slash commands
- Options GUI
- store settings globally or per character
- added translations
- split of messages preserves item links, textures, substitutions and raid target markers
- added safety measures to prevent endless replacement loops
### Changed
- bumped version for Shadowlands
- bumped version for Naxxramas
### Fixed
- split of messages with excessive length no longer causes errors or broken texts
- proper handling of umlauts
## Version 1.0.1 - 2020-10-17
### Changed
- bumped version for Shadowlands Pre-Patch
## Version 1.0.0 - 2020-09-01 [First Release]
### Added
- info section with contact and thanks
### Fixed
- minor clarifications and spellings errors on help texts
## 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.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 replacements with excessive length
## 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
## 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 (unreleased) - 2020-05-26
### Added
- added Options UI under Interface Options
- store settings in profiles
- added more translations
## Version 0.2.1 (unreleased) - 2020-05-25
### Added
- support automatic packaging for curseforge via .pkgmeta
- include project logo
- auto-update the project description via .docmeta
## Version 0.2 - 2020-05-25
### Added
@@ -18,6 +141,6 @@ First version to be released
- 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 from [Misspelled](https://www.curseforge.com/wow/addons/misspelled)
- bootstrap addon with Ace3 based on [Misspelled](https://www.curseforge.com/wow/addons/misspelled)

View File

@@ -1,365 +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.
--------------------------------------------------------------------------]] --
-----------------------------------------------------------------------------]]
-- read namespace from global env
local AddonName, AddonTable = ...
local _G = _G
local Grichelde = LibStub("AceAddon-3.0"):NewAddon("Grichelde", "AceEvent-3.0", "AceHook-3.0")
-- initialize addon
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 "UNKNOWN"
Grichelde.build = GetAddOnMetadata(AddonName, "X-Build") or "Experimental"
Grichelde.classic = _G.WOW_PROJECT_ID == _G.WOW_PROJECT_CLASSIC
Grichelde.logLevel = 0 -- cannot reference Grichelde.LOG_LEVELs here as they are loaded afterwards
local L = LibStub("AceLocale-3.0"):GetLocale("Grichelde", true)
local Grichelde_Debug = false
-- faster function lookups by mapping to local refs
local string_find = string.find
local string_gsub = string.gsub
local string_len = string.len
local string_rep = string.rep
local string_sub = string.sub
local strtrim = strtrim
local strmatch = strmatch
local tostring = tostring
local tInsert = table.insert
local tContains = tContains
local pairs = pairs
local ipairs = ipairs
local Grichelde_Hooks = {}
--local Grichelde_ChatTypes = { "SAY", "EMOTE", "YELL", "PARTY", "GUILD", "OFFICER", "RAID", "RAID_WARNING", "INSTANCE_CHAT", "BATTLEGROUND", "WHISPER" }
local Grichelde_ChatTypes = { "SAY", "EMOTE", "YELL", "PARTY", "GUILD" }
local Grichelde_ChatCommands = { "/s", "/e", "/me", "/y", "/p", "/pl", "/g", "/o", "/raid", "/rl", "/rw", "/i", "bg", "/w", "/r", "/tt" }
-- do not replace these patterns
local Grichelde_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
}
-- publish to global env
_G[AddonName] = Grichelde
-- Ace3 callbacks
function Grichelde:OnInitialize()
-- Build Interface Options window
--self:CreateInterfaceOptions()
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 (Misspelled) then
print("Misspelled detected, Grichelde will have any messsage being cleansed")
end
self.options, self.dialog = self:SetupOptions()
self.ldb, self.icon = self:MinimapButton()
self:RefreshProfiles("OnEnable")
self:SetupSlashCommands()
-- tell the world we are listening
print(L.AddonLoaded)
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)
--- Register slash commands 'gri' and 'grichelde'
function Grichelde:SetupSlashCommands()
self:RegisterChatCommand("grichelde", "HandleSlashCommand")
self:RegisterChatCommand("gri", "HandleSlashCommand")
end
-- 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)
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
-- 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
end
end
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)
-- todo: globally disabled?
-- check type
if (not tContains(Grichelde_ChatTypes, 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_ChatCommands, 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)
-- Calling find on ever pattern might be inefficient but its way less code.
for _, pattern in ipairs(Grichelde_IgnorePatterns) do
local pos1, pos2 = string_find(text, pattern)
if pos1 == 1 and pos2 ~= nil then
self:DebugPrint("CheckForPreversableText : Found ignore pattern " .. pattern .. " at (" .. 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_ChatCommands, firstWord)) then
self:DebugPrint("ReplaceText : Found slash command " .. (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 : " .. current .. "," .. currentChar)
if currentChar ~= '|' and currentChar ~= '{' then
current = current + 1
-- 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
-- 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
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 \"" .. text .. "\" with \"" .. 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: " .. text .. ", start: " .. self:EmptyIfNil(start))
local pos = 1
if start ~= nil then pos = start end
local left, right = strmatch(text, "^.- .+", pos)
self:DebugPrint("SplitOnFirstMatch : left: " .. self:EmptyIfNil(left) .. ", right: " .. self:EmptyIfNil(right))
return left, right
end
function Grichelde:SplitOnLastMatch(text, start)
self:DebugPrint("SplitOnLastMatch : text: " .. text .. ", start: " .. self:EmptyIfNil(start))
local pos = 1
if start ~= nil then pos = start end
local left, right = strmatch(text, ".+ .-$", pos)
self:DebugPrint("SplitOnLastMatch : left: " .. self:EmptyIfNil(left) .. ", right: " .. self:EmptyIfNil(right))
return left, right
end
function Grichelde:DebugPrint(message)
if (Grichelde_Debug) then
print(GRAY_FONT_COLOR_CODE .. "Grichelde:" .. FONT_COLOR_CODE_CLOSE .. " " .. message)
end
end
function Grichelde:EmptyIfNil(value)
if value == nil then return "" end
return tostring(value)
end
function Grichelde:tprint(t, indent, done)
-- in case we run it standalone
local Note = Note or print
-- local Tell = Tell or io.write
-- show strings differently to distinguish them from numbers
local function show(val)
if type(val) == "string" then
return '"' .. val .. '"'
else
return tostring(val)
end
end
-- entry point here
done = done or {}
indent = indent or 0
for key, value in pairs(t) do
print(string_rep(" ", indent)) -- indent it
if type(value) == "table" and not done[value] then
done[value] = true
Note(show(key), ":");
self:tprint(value, indent + 2, done)
else
print(show(key), "=")
print(show(value))
self:SendChatMessageOverride(input, ...)
end
end
end

BIN
Grichelde.tga Normal file

Binary file not shown.

View File

@@ -1,23 +1,34 @@
## Interface: 11304
## Interface: 11307
## Title: Grichelde
## Notes: Replaces characters you type in the chat box
## Notes-de: Ersetzt eingegebene Zeichen in der Chat-Zeile
## Version: 1.0
## Notes: Replaces characters of your chat input line before sending.
## Notes-de: Ersetzt eingegebene Zeichen in der Chat-Zeile vor dem Versenden.
## Version: 1.1.1
## 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
## SavedVariables: GrichseldeOptions
## SavedVariablesPerCharacter: GrichseldeCharOptions
## 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

980
GricheldeChat.lua Normal file
View File

@@ -0,0 +1,980 @@
-- 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, bytes2Char, 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.bytes2Char, 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 array of chunks
function Grichelde:SplitText(text)
local chunks = {}
local leftGuillemet = bytes2Char(194, 171) .. " "
local rightGuillemet = " " .. bytes2Char(194, 187)
local chunkSize = Grichelde.INPUT_LIMIT - length(leftGuillemet) - length(rightGuillemet)
local function preserveText(newText, chunk, blockText, posEnd)
-- link found, block completed
self:TracePrint("SplitText : Found preservable text up to %s", posEnd)
local preserved = sub(newText, 1, posEnd)
if ((length(chunk) > 0) and (length(chunk .. blockText) > chunkSize)) then
-- block exceeds chunk, chunkify previous blocks
self:DebugPrint("SplitText : add chunk:", chunk)
tInsert(chunks, chunk .. rightGuillemet)
chunk = leftGuillemet .. trim(blockText)
else
chunk = chunk .. blockText
end
if ((length(chunk) > 0) and (length(chunk .. preserved) > chunkSize)) then
-- block exceeds chunk, chunkify previous blocks
self:DebugPrint("SplitText : add chunk:", chunk)
tInsert(chunks, chunk .. rightGuillemet)
chunk = leftGuillemet .. trim(preserved)
else
chunk = chunk .. preserved
end
blockText = ""
newText = sub(newText, posEnd + 1)
return newText, chunk, blockText, posEnd
end
if (length(text or "") <= Grichelde.INPUT_LIMIT) then
self:DebugPrint("SplitText : no chunk:", text)
tInsert(chunks, text)
else
local lookAheads = { '|', '*', '<', '%', '{', '(', 'o' }
local newText = text or ""
local chunk, blockText = "", ""
local currentChar
local escape = 0
-- must not enforce UTF-8 support here, as the positions are used
while ((length(newText) > 0) and (escape < Grichelde.ENDLESS_LOOP_LIMIT)) do
escape = escape + 1
local previousChar = currentChar
local first, textAhead = getNextCharUtf8(newText)
currentChar = first
self:DebugPrint("SplitText : currentChar, escape: %s, %s", currentChar, escape)
self:TracePrint("SplitText : chunk:", chunk)
self:TracePrint("SplitText : newText:", newText)
-- 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 (currentChar == ' ') then
self:TracePrint("SplitText : block completed")
if ((length(chunk) > 0) and (length(chunk .. blockText) > chunkSize)) then
-- block exceeds chunk, chunkify previous blocks
self:DebugPrint("SplitText : add chunk:", chunk)
tInsert(chunks, chunk .. rightGuillemet)
chunk = leftGuillemet .. trim(blockText)
else
chunk = chunk .. blockText
end
blockText = currentChar
newText = textAhead
elseif (tContains(lookAheads, currentChar)) then
-- lookahead-check for all preservable patterns (itemLinks, textures, emotes, ooc, etc.)
-- link detection
local linkPosEnd = self:CheckForLink(newText, currentChar)
if (linkPosEnd ~= nil) then
-- link found, block completed
newText, chunk, blockText = preserveText(newText, chunk, blockText, linkPosEnd)
else
-- substitution detection
local substPosEnd = self:CheckForSubstitutions(newText, currentChar)
if (substPosEnd ~= nil) then
-- substitution found, block completed
newText, chunk, blockText = preserveText(newText, chunk, blockText, substPosEnd)
else
-- raid target marker detection
local rtmPosEnd = self:CheckForRaidTargetMarkers(newText, currentChar)
if (rtmPosEnd ~= nil) then
-- raid target marker found, block completed
newText, chunk, blockText = preserveText(newText, chunk, blockText, rtmPosEnd)
else
blockText = blockText .. currentChar
newText = textAhead
end
end
end
else
blockText = blockText .. currentChar
newText = textAhead
end
end
self:TracePrint("SplitText : main loop completed")
if (length(chunk .. blockText) > 0) then
-- catchup remaining text at the end
if (length(chunk .. blockText) > chunkSize) then
-- block exceeds chunk, chunkify previous blocks
if (length(chunk) > 0) then
self:DebugPrint("SplitText : add chunk:", chunk)
tInsert(chunks, chunk .. rightGuillemet)
chunk = leftGuillemet .. trim(blockText)
else
chunk = chunk .. blockText
end
else
chunk = chunk .. blockText
end
self:DebugPrint("SplitText : last chunk:", chunk)
-- sub(chunk, 1, 255) can result in broken UTF8 chars and error message
tInsert(chunks, chunk)
end
end
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 p, patRest = getNextCharUtf8(pattern)
local escape = 0
while ((p ~= nil) and (escape < Grichelde.ENDLESS_LOOP_LIMIT)) do
escape = escape + 1
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
--- looks for colored items, item links or textures
function Grichelde:CheckForLink(text, currentChar)
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
local match = sub(text, pos1, pos2)
self:DebugPrint("CheckForLink : Found link or texture pattern \"%s\" at (%d, %d)", pattern, pos1, pos2)
return pos2
end
end
end
return nil
end
--- looks for emotes
function Grichelde:CheckForEmote(text, currentChar, replaceEmotes)
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("CheckForEmote : Found emote \"%s\" at (%d, %d), but preserved it", emote, pos1, pos2)
return pos2
else
self:DebugPrint("CheckForEmote : Processing emote \"%s\" at (%d, %d)", emote, pos1, pos2)
end
end
end
end
return nil
end
--- looks for %-substitutions
function Grichelde:CheckForSubstitutions(text, currentChar)
local lowerText = toLower(text)
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
return nil
end
--- looks for general and localized raid target markers
function Grichelde:CheckForRaidTargetMarkers(text, currentChar)
local lowerText = toLower(text)
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
return nil
end
--- looks for ooc with brackets
function Grichelde:CheckForOocBrackets(text, currentChar)
local lowerText = toLower(text)
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
return nil
end
--- looks for ooc without brackets
function Grichelde:CheckForOocNoBrackets(text, currentChar, previousChar)
local lowerText = toLower(text)
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")
-- remaing text is treated as ooc completely!
return length(text)
end
end
return nil
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
local linkPos = self:CheckForLink(text, currentChar)
if (linkPos ~= nil) then
return linkPos
end
local emotePos = self:CheckForEmote(text, currentChar, replaceEmotes)
if (emotePos ~= nil) then
return emotePos
end
local substPos = self:CheckForSubstitutions(text, currentChar)
if (substPos ~= nil) then
return substPos
end
local rtmPos = self:CheckForRaidTargetMarkers(text, currentChar)
if (rtmPos ~= nil) then
return rtmPos
end
local oocBracketPos = self:CheckForOocBrackets(text, currentChar)
if (oocBracketPos ~= nil) then
return oocBracketPos
end
local oocNoBracketPos = self:CheckForOocNoBrackets(text, currentChar, previousChar)
if (oocNoBracketPos ~= nil) then
return oocNoBracketPos
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, replaceText = "", ""
local currentChar
local escape = 0
-- must not enforce UTF-8 support here, as the positions are used
while ((length(newText) > 0) and (escape < Grichelde.ENDLESS_LOOP_LIMIT)) do
escape = escape + 1
local previousChar = currentChar
local first, textAhead = getNextCharUtf8(newText)
currentChar = first
self:TracePrint("ReplaceText : currentChar : %s", 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 (tContains(lookAheads, currentChar)) then
-- lookahead-check for all preservable patterns (itemLinks, textures, emotes, ooc, etc.)
--local textAhead = sub(newText, current)
local posEnd = self:CheckForPreversableText(newText, currentChar, previousChar, preserveEmotes)
if (posEnd > 0) then
self:DebugPrint("ReplaceText : Found an ignore pattern")
-- replace all text up until now
local replacement = self:ReplaceAndConsolidate(replaceText, replacements)
local preserved = sub(newText, 1, posEnd)
finalText = finalText .. replacement .. preserved
replaceText = ""
newText = sub(newText, posEnd + 1)
self:DebugPrint("ReplaceText : remaining text", newText)
else
-- no corresponding end was found to start pattern, continue loop with next char
replaceText = replaceText .. currentChar
newText = textAhead
end
else
replaceText = replaceText .. currentChar
newText = textAhead
end
end
-- catchup remaining text to the end
local replacement = self:ReplaceAndConsolidate(replaceText, 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
local firstChar, rest = getNextCharUtf8(firstWord)
-- scheme <emote>
if (firstChar == "<") then
-- search for emote end
local _, emoteEnd = find(text, "%>", 2)
isEmote = (emoteEnd == lengthUtf8(text))
end
if (not isEmote and (firstChar == "*")) then
if (getNextCharUtf8(rest) == "*") then
-- scheme **emote**
local _, emoteEnd = find(text, "%*%*", 3)
isEmote = (emoteEnd == lengthUtf8(text))
else
-- scheme *emote*
local _, emoteEnd = find(text, "%*", 2)
isEmote = (emoteEnd == lengthUtf8(text))
end
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 (getNextCharUtf8(firstWord) == "/") 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 (getNextCharUtf8(message) == "/") 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

445
GricheldeConstants.lua Normal file
View File

@@ -0,0 +1,445 @@
-- read namespace from global env
local _G = _G
local Grichelde = _G.Grichelde or {}
-- constants and upvalues
Grichelde.LOG_LEVEL = { DEBUG = 1, TRACE = 2 }
Grichelde.INPUT_LIMIT = 255
Grichelde.ENDLESS_LOOP_LIMIT = 10000
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",
BLUE = "|cff0000ff",
HYPERLINK = "|cff4040ff",
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
-- combined item links in the chat will look like this: |cff9d9d9d|Hitem:3299::::::::20:257::::::|h[Fractured Canine]|h|r
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
local function cHyperlink(text)
return Grichelde.F.color(Grichelde.COLOR_CODES.HYPERLINK, 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,
cHyperlink = cHyperlink,
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,
}

161
GricheldeDatabase.lua Normal file
View File

@@ -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

146
GricheldeMinimap.lua Normal file
View File

@@ -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

830
GricheldeOptions.lua Normal file
View File

@@ -0,0 +1,830 @@
-- read namespace from global env
local _G = _G
local Grichelde = _G.Grichelde or {}
local assert, nilOrEmpty, pairs, ipairs, spairs, tContains, tInsert, tClone, tWipe, find, match, cPrefix, cGray, cGreen, cOrange, cRed, format, toString, toNumber
= Grichelde.F.assert, Grichelde.F.nilOrEmpty, Grichelde.F.pairs, Grichelde.F.ipairs, Grichelde.F.spairs, Grichelde.F.tContains, Grichelde.F.tInsert, Grichelde.F.tClone, Grichelde.F.tWipe, Grichelde.F.find, Grichelde.F.match, Grichelde.F.cPrefix, Grichelde.F.cGray, Grichelde.F.cGreen, Grichelde.F.cOrange, Grichelde.F.cRed, Grichelde.F.format, Grichelde.F.toString, Grichelde.F.toNumber
local selectedExample = 1
function Grichelde:CreateOptionsUI()
return {
name = self:Format(self.L.Options_Title, self.L.AddonName),
type = "group",
childGroups = "tab",
set = function(info, val) self:SyncToDatabase(info, val) end,
get = function(info) return self:ReadFromDatabase(info) end,
hidden = false,
disabled = function(info) return self:IsDisabled(info) end,
args = {
enabled = {
order = 0,
type = "toggle",
name = self.L.Options_Enabled_Name,
desc = self:Format(self.L.Options_Enabled_Desc, self.L.AddonName),
set = function() self:ToggleActivation() end,
disabled = false,
},
minimapButton = {
order = 1,
type = "toggle",
name = self.L.Options_Minimap_Button_Name,
desc = self.L.Options_Minimap_Button_Desc,
set = function(_, _) self:ToggleMinimapButton() end,
get = function(_) return not self.db.profile.minimapButton.hide end,
disabled = false,
},
replacements = {
order = 2,
type = "group",
name = self.L.Options_Replacements_Group_Name,
desc = self.L.Options_Replacements_Group_Desc,
args = {
add = {
order = 0,
type = "execute",
confirm = false,
name = self.L.Options_Replacements_Add_Name,
desc = self.L.Options_Replacements_Add_Desc,
func = function(info) self:AddEmptyMapping(info) end,
},
deleteAll = {
order = 1,
type = "execute",
confirm = true,
confirmText = self.L.Options_Replacements_DeleteAll_ConfirmText,
name = self.L.Options_Replacements_DeleteAll_Name,
desc = self.L.Options_Replacements_DeleteAll_Desc,
func = function(info) self:DeleteAllMappings(info) end,
},
header = {
order = 3,
type = "description",
name = self.L.Options_Replacements_Header,
},
spacer1 = {
order = 4,
type = "header",
name = "",
},
},
},
channels = {
order = 3,
type = "group",
name = self.L.Options_Channels_Group_Name,
desc = self:Format(self.L.Options_Channels_Group_Desc, self.L.AddonName),
args = {
header = {
order = 1,
type = "description",
name = self.L.Options_Channels_Header,
},
spacer2 = {
order = 2,
type = "header",
name = "",
},
say = {
order = 10,
type = "toggle",
name = self.L.Options_Channel_Say_Name,
desc = self:Format(self.L.Options_Channel_Say_Desc, self.L.AddonName),
},
emote = {
order = 11,
type = "toggle",
name = self.L.Options_Channel_Emote_Name,
desc = self:Format(self.L.Options_Channel_Emote_Desc, self.L.AddonName),
},
yell = {
order = 12,
type = "toggle",
name = self.L.Options_Channel_Yell_Name,
desc = self:Format(self.L.Options_Channel_Yell_Desc, self.L.AddonName),
},
party = {
order = 13,
type = "toggle",
name = self.L.Options_Channel_Party_Name,
desc = self:Format(self.L.Options_Channel_Party_Desc, self.L.AddonName),
},
guild = {
order = 14,
type = "toggle",
name = self.L.Options_Channel_Guild_Name,
desc = self:Format(self.L.Options_Channel_Guild_Desc, self.L.AddonName),
},
officer = {
order = 15,
type = "toggle",
name = self.L.Options_Channel_Officer_Name,
desc = self:Format(self.L.Options_Channel_Officer_Desc, self.L.AddonName),
},
raid = {
order = 16,
type = "toggle",
name = self.L.Options_Channel_Raid_Name,
desc = self:Format(self.L.Options_Channel_Raid_Desc, self.L.AddonName),
},
raidWarning = {
order = 17,
type = "toggle",
name = self.L.Options_Channel_RaidWarning_Name,
desc = self:Format(self.L.Options_Channel_RaidWarning_Desc, self.L.AddonName),
},
instance = {
order = 18,
type = "toggle",
name = self.L.Options_Channel_Instance_Name,
desc = self:Format(self.L.Options_Channel_Instance_Desc, self.L.AddonName),
},
battleground = {
order = 19,
type = "toggle",
name = self.L.Options_Channel_Battleground_Name,
desc = self:Format(self.L.Options_Channel_Battleground_Desc, self.L.AddonName),
},
whisper = {
order = 20,
type = "toggle",
name = self.L.Options_Channel_Whisper_Name,
desc = self:Format(self.L.Options_Channel_Whisper_Desc, self.L.AddonName),
},
},
},
help = {
order = -1,
type = "group",
childGroups = "tab",
name = self.L.Options_Help_Group_Name,
desc = self.L.Options_Help_Group_Desc,
disabled = false,
args = {
info = {
order = 10,
type = "group",
name = self.L.Options_Help_Tab_Info_Name,
desc = self.L.Options_Help_Tab_Info_Desc,
args = {
paragraph1 = {
order = 1,
type = "description",
name = self:Format(self.L.Options_Help_Info, self.L.AddonName),
fontSize = "medium",
},
},
},
basics = {
order = 11,
type = "group",
name = self.L.Options_Help_Tab_Basics_Name,
desc = self.L.Options_Help_Tab_Basics_Desc,
args = {
paragraph1 = {
order = 1,
type = "description",
name = self.L.Options_Help_Basics,
fontSize = "medium",
},
},
},
expert = {
order = 12,
type = "group",
name = self.L.Options_Help_Tab_Expert_Name,
desc = self.L.Options_Help_Tab_Expert_Desc,
args = {
paragraph4 = {
order = 1,
type = "description",
name = self.L.Options_Help_Expert,
fontSize = "medium",
},
},
},
examples = {
order = 13,
type = "group",
name = self.L.Options_Help_Tab_Examples_Name,
desc = self.L.Options_Help_Tab_Examples_Desc,
args = {
note = {
order = 1,
type = "description",
name = self.L.Options_Help_Examples_Note,
},
header = {
order = 2,
type = "description",
name = self.L.Options_Help_Examples_Header,
fontSize = "medium",
width = 2.1
},
dropDown = {
order = 3,
type = "select",
name = "",
width = 1.2,
values = function(_) return self:ExtractExampleNames() end,
set = function(_, val) selectedExample = val end,
get = function(_)
self.options.args.help.args.examples.args.header.name = self.L.Options_Help_Examples[selectedExample].desc
self.options.args.help.args.examples.args.example.name = self:ExtractExampleCodes(selectedExample),
self.dialog:SelectGroup(self.name, "help", "examples", "header.name")
return selectedExample
end,
},
spacer3 = {
order = 3,
type = "description",
name = "",
desc = "",
width = 2.3,
},
import = {
order = 4,
type = "execute",
width = 1,
confirm = selectedExample > 0,
name = self.L.Options_Help_Examples_Import_Name,
-- desc = self.L.Options_Help_Examples_Import_Desc,
desc = function() return format(self.L.Options_Help_Examples_Import_Desc, cPrefix(self.L.Options_Help_Examples[selectedExample].name)) end,
func = function(info) self:ImportExample(selectedExample) end,
},
spacer4 = {
order = 6,
type = "header",
name = "",
},
example = {
order = 7,
type = "description",
name = self.L.Options_Help_Examples_Text,
fontSize = "medium",
},
},
},
disclaimer = {
order = 14,
type = "description",
name = self.L.Options_Help_Disclaimer,
},
},
},
},
}
end
function Grichelde:CreateMapping(offset)
return {
order = offset or 9999,
type = "group",
name = function(info) return self:MappingName(info) end,
desc = self.L.Options_Mapping_Group_Desc,
childGroups = "tree",
disabled = function(info) return not self:IsMappingActive(info) end,
args = {
moveUp = {
order = 0,
type = "execute",
name = "",
desc = self.L.Options_Mapping_MoveUp_Desc,
image = function(info) return self:GetMoveUpImage(info) end,
width = 0.15,
func = function(info) self:MoveUp(info) end,
},
moveDown = {
order = 1,
type = "execute",
name = "",
desc = self.L.Options_Mapping_MoveDown_Desc,
image = function(info) return self:GetMoveDownImage(info) end,
width = 0.15,
func = function(info) self:MoveDown(info) end,
},
spacer5 = {
order = 2,
type = "description",
name = "",
desc = "",
width = 0.05,
},
--[[
active = {
order = 3,
type = "toggle",
name = self.L.Options_Mapping_Enabled_Name,
desc = self.L.Options_Mapping_Enabled_Desc,
width = 2.2,
},
]]
matchWhenLabel = {
order = 3,
type = "description",
name = self.L.Options_Mapping_MatchWhen_Name,
desc = self.L.Options_Mapping_MatchWhen_Desc,
fontSize = "medium",
width = 0.3,
},
matchWhen = {
order = 4,
type = "select",
name = " ",
desc = self.L.Options_Mapping_MatchWhen_Desc,
values = {
self.L.Options_Mapping_MatchWhen_Select1,
self.L.Options_Mapping_MatchWhen_Select2,
self.L.Options_Mapping_MatchWhen_Select3,
self.L.Options_Mapping_MatchWhen_Select4,
self.L.Options_Mapping_MatchWhen_Select5,
self.L.Options_Mapping_MatchWhen_Select6,
},
width = 1.4,
},
spacer6 = {
order = 5,
type = "description",
name = "",
desc = "",
width = 0.1,
},
delete = {
order = 6,
type = "execute",
confirm = true,
confirmText = self.L.Options_Mapping_Delete_ConfirmText,
name = "",
desc = self.L.Options_Mapping_Delete_Desc,
image = function(info) return self:GetDeleteImage(info) end,
width = 0.1,
func = function(info) self:DeleteMapping(info) end,
},
searchText = {
order = 10,
type = "input",
name = self.L.Options_Mapping_SearchText_Name,
desc = self.L.Options_Mapping_SearchText_Desc,
},
replaceText = {
order = 11,
type = "input",
name = self.L.Options_Mapping_ReplaceText_Name,
desc = self.L.Options_Mapping_ReplaceText_Desc,
},
exactCase = {
order = 21,
type = "toggle",
name = self.L.Options_Mapping_ExactCase_Name,
desc = self.L.Options_Mapping_ExactCase_Desc,
width = "full",
},
consolidate = {
order = 22,
type = "toggle",
name = self.L.Options_Mapping_Consolidate_Name,
desc = self.L.Options_Mapping_Consolidate_Desc,
width = "full",
},
stopOnMatch = {
order = 23,
type = "toggle",
name = self.L.Options_Mapping_StopOnMatch_Name,
desc = self.L.Options_Mapping_StopOnMatch_Desc,
width = "full",
}
}
}
end
function Grichelde:SetupOptions()
-- add DB-backed profiles to UI options
local options = self:CreateOptionsUI(self)
options.args.profiles = LibStub("AceDBOptions-3.0"):GetOptionsTable(self.db)
options.args.profiles.order = 8
options.args.profiles.disabled = false
-- Adding options to blizzard frame
LibStub("AceConfig-3.0"):RegisterOptionsTable(self.name, options)
local dialog = LibStub("AceConfigDialog-3.0")
dialog:AddToBlizOptions(self.name, self.L.AddonName)
return options, dialog
end
function Grichelde:RefreshProfiles(event, _, profileName)
local function replaceReplacements(replacements)
-- do NOT set self.db.profile.replacements = {} it will break defaults
tWipe(self.db.profile.replacements)
-- copy over sorted replacements
for replName, replTable in pairs(replacements) do
self.db.profile.replacements[replName] = replTable
end
self:DebugPrint("RefreshProfiles : reorderReplacements : sorted table")
self:DebugPrint(self.db.profile.replacements)
end
local function addEmptyMappingWithoutRefresh()
self:DebugPrint("RefreshProfiles : addEmptyMappingWithoutRefresh")
self.db.profile.replacements.replacement_10.order = 10
end
self:DebugPrint("RefreshProfiles : event:", event)
--- AceDB will call OnProfileShutdown, OnProfileChanged and OnNewProfile in this order
if (event == "OnNewProfile") then
addEmptyMappingWithoutRefresh()
self:PrefixedPrint(self.L.Profiles_Created, cGreen(self.db:GetCurrentProfile()))
elseif (event == "OnProfileChanged") then
self:DebugPrint(self.L.Profiles_Loaded, cGreen(self.db:GetCurrentProfile()))
elseif (event == "OnProfileDeleted") then
self:PrefixedPrint(self.L.Profiles_Deleted, cRed(profileName))
elseif (event == "OnProfileCopied") then
self:DebugPrint(self.L.Profiles_Copied, cOrange(profileName))
elseif (event == "OnProfileReset") then
addEmptyMappingWithoutRefresh()
self:PrefixedPrint(self.L.Profiles_Reset, cOrange(self.db:GetCurrentProfile()))
else
self:DebugPrint("Refreshing Profile %s on options change: %s", self.db:GetCurrentProfile(), event)
end
local repls = self:ReorderReplacements()
replaceReplacements(repls)
self:RefreshOptions(repls)
self:RefreshDialog()
self:RefreshMinimap()
end
function Grichelde:ToggleOptions()
self:DebugPrint("ToggleOptions : options open: ", not not self.dialog.OpenFrames[self.name])
if (self.dialog ~= nil) and (self.dialog.OpenFrames[self.name] ~= nil) then
self:CloseOptions()
else
self:OpenOptions()
end
end
function Grichelde:OpenOptions()
if (self.dialog ~= nil) then
self.dialog:Open(self.name)
local formatString = self.L.AddonLoaded
if (self.db.profile.enabled == false) then
formatString = self.L.AddonUnloaded
end
local namePlusVersion = self:Format(self.L.AddonNamePlusVersion, self.L.AddonName, self.version)
local statusText = self:Format(formatString, namePlusVersion)
self.dialog.OpenFrames[self.name]:SetStatusText(statusText)
end
end
function Grichelde:CloseOptions()
if (self.dialog ~= nil) then
self.dialog:Close(self.name)
end
end
--- If all replacements were disabled
-- @return (boolean)
function Grichelde:IsDisabled(info)
if (info and (info.option.type == "group")) then
return false
end
return not self.db.profile.enabled
end
--- If all replacements were disabled
-- @return (boolean)
function Grichelde:IsMappingActive(info)
self:TracePrint("IsMappingActive : info")
for i = 0, #info do
self:TracePrint("IsMappingActive : info[%d] = %s", i, info[i])
end
if (info and (info.option.type == "group")) then
return true
end
if (self.db.profile.enabled == false) then
return false
end
local replacements = self.db.profile.replacements or {}
local currentName = info[2]
local uiElem = info[3]
self:DebugPrint("IsMappingActive : \"%s\"", currentName)
self:DebugPrint(replacements[currentName])
if (tContains({"moveUp", "moveDown", "matchWhen", "delete"}, uiElem)) then
return true
else
return replacements[currentName].matchWhen > 1
end
end
function Grichelde:MappingName(info)
-- self:TracePrint("MappingName : info")
-- self:TracePrint(info)
local option = self.db.profile.replacements[info[2]]
if (nilOrEmpty(option.searchText) and nilOrEmpty(option.replaceText)) then
return cGray(self.L.Options_Mapping_EmptyMapping)
else
local name = self:Format(self.L.Options_Mapping_Group_Name, option.searchText or "", option.replaceText or "")
if (option.matchWhen > 1) then
return name
else
return cGray(name)
end
end
end
function Grichelde:ExtractExampleNames()
local exampleNames = {}
for _, example in ipairs(self.L.Options_Help_Examples) do
tInsert(exampleNames, example.name)
end
return exampleNames
end
function Grichelde:ExtractExampleCodes(num)
self:TracePrint("ExtractExampleCodes : number is: %d", num)
if (self.L.Options_Help_Examples[num] == nil) or (#self.L.Options_Help_Examples < num) then
self:DebugPrint("ExtractExampleCodes : invalid number: %d", num)
return self.L.Options_Help_Examples_Text
end
local exampleCodes = ""
for replName, replTable in spairs(self.L.Options_Help_Examples[num].replacements) do
self:TracePrint("ExtractExampleCodes : replacement: %s", replName)
self:TracePrint(replTable)
if (replTable ~= nil) and (replTable.searchText ~= nil) then
if (exampleCodes ~= "") then
exampleCodes = exampleCodes .. "|n|n"
end
exampleCodes = exampleCodes .. cPrefix(format("%s => %s", replTable.searchText, replTable.replaceText))
end
end
return exampleCodes
end
function Grichelde:ImportExample(num)
self:TracePrint("ImportExample : number is: %d", num)
if (self.L.Options_Help_Examples[num] == nil) or (#self.L.Options_Help_Examples < num) then
self:DebugPrint("ImportExample : invalid number: %d", num)
end
local profileName = self.L.Options_Help_Examples[num].name
self:DebugPrint("ImportExample : profile name: %s", profileName)
local allProfiles = self.db:GetProfiles()
if (not tContains(allProfiles, profileName)) then
-- create new profile if not exists
self.db:SetProfile(profileName)
assert(self.db:GetCurrentProfile() == profileName, "profile was not loaded")
tWipe(self.db.profile.replacements)
for replName, replTable in spairs(self.L.Options_Help_Examples[num].replacements) do
self:TracePrint("ImportExample : replacement: %s", replName)
self:TracePrint(replTable)
if (replName ~= nil) and (replTable ~= nil) and (replTable.searchText ~= nil) then
self.db.profile.replacements[replName] = tClone(replTable)
end
end
self:RefreshProfiles("ImportExample" .. num)
else
self:ErrorPrint(self.L.Profiles_AlreadyExistsError, profileName)
end
end
--- Create UI options for the given replacement table (from DB).
--- Usually called with with self.db.profile.replacements
-- @param replacementsTable
function Grichelde:RefreshOptions(replacementsTable)
self:TracePrint("RefreshOptions : DB table:")
self:TracePrint(replacementsTable)
-- remove all previous replacements from options (not DB), except header and buttons
local replacements = self.options.args.replacements.args or {}
for k, _ in pairs(replacements) do
if (k and (find(k, "^replacement_") ~= nil)) then
replacements[k] = nil
end
end
for replName, _ in pairs(replacementsTable or {}) do
local _, replNumber = self:SplitOnFirstMatch(replName, "_")
replacements[replName] = self:CreateMapping(toNumber(replNumber))
end
-- self:TracePrint("RefreshOptions : UI options:")
-- self:TracePrint(replacements)
end
function Grichelde:RefreshDialog()
self.dialog:ConfigTableChanged(nil, self.name)
end
function Grichelde:AddEmptyMapping()
local replacements = self.db.profile.replacements or {}
self:DebugPrint("AddEmptyMapping : old DB entries:")
self:DebugPrint(replacements)
local maxRepl = Grichelde.MAPPING_OFFSET - 1
for replName, _ in pairs(replacements) do
local num = match(replName, "^replacement_(%d+)")
if (num ~= nil) and (maxRepl < toNumber(num)) then
maxRepl = toNumber(num)
end
end
local newMapping = "replacement_" .. toString(maxRepl + 1)
self:DebugPrint("AddEmptyMapping : new mapping key:", newMapping)
-- do NOT set self.db.profile.replacements = {} it will break defaults
replacements[newMapping].order = toString(maxRepl + 1) -- will be reordered anyway
self:DebugPrint("AddEmptyMapping : new DB entries:")
self:DebugPrint(replacements)
self:RefreshProfiles("AddEmptyMapping " .. newMapping)
self.dialog:SelectGroup(self.name, "replacements", newMapping)
end
function Grichelde:MoveUp(info)
self:TracePrint("MoveUp : info")
for i = 0, #info do
self:TracePrint("%d = %s", i, info[i])
end
local replacements = self.db.profile.replacements or {}
local currentName = info[2]
self:DebugPrint("MoveUp : \"%s\"", currentName)
self:DebugPrint(replacements[currentName])
local _, replNumber = self:SplitOnFirstMatch(currentName, "_")
local currentOrder = toNumber(replNumber)
-- if not on top
if (currentOrder ~= Grichelde.MAPPING_OFFSET) then
local swapName = "replacement_" .. toString(currentOrder - 1)
-- swap ordering
self:DebugPrint("swap with option %s", swapName)
replacements[swapName].order = currentOrder
replacements[currentName].order = currentOrder - 1
self:RefreshProfiles("MoveUp " .. currentName)
self:DebugPrint("MoveUp : refresh focus on %s", swapName)
self.dialog:SelectGroup(self.name, "replacements", swapName)
else
self:DebugPrint("MoveUp : already on top")
end
end
function Grichelde:MoveDown(info)
self:TracePrint("MoveDown : info")
for i = 0, #info do
self:TracePrint("%d = %s", i, info[i])
end
local replacements = self.db.profile.replacements or {}
local currentName = info[2]
self:DebugPrint("MoveDown : \"%s\"", currentName)
self:DebugPrint(replacements[currentName])
local _, replNumber = self:SplitOnFirstMatch(currentName, "_")
local currentOrder = toNumber(replNumber)
local maxRepl = Grichelde.MAPPING_OFFSET
for replName, _ in pairs(replacements) do
local num = match(replName, "^replacement_(%d+)")
if num and maxRepl < toNumber(num) then
maxRepl = toNumber(num)
end
end
-- if not last element
self:DebugPrint("MoveDown : maxRepl: %d", maxRepl)
if (currentOrder < maxRepl) then
local swapName = "replacement_" .. toString(currentOrder + 1)
-- swap ordering
self:DebugPrint("swap with option %s", swapName)
replacements[swapName].order = currentOrder
replacements[currentName].order = currentOrder + 1
self:RefreshProfiles("MoveDown " .. currentName)
self:DebugPrint("MoveDown : refresh focus on %s", swapName)
self.dialog:SelectGroup(self.name, "replacements", swapName)
else
self:DebugPrint("MoveDown : already at bottom")
end
end
function Grichelde:GetMoveUpImage(info)
self:TracePrint("GetMoveUpImage : info")
for i = 0, #info do
self:TracePrint("%d = %s", i, info[i])
end
local currentName = info[2]
self:DebugPrint("GetMoveUpImage : \"%s\"", currentName)
local _, replNumber = self:SplitOnFirstMatch(currentName, "_")
local currentOrder = toNumber(replNumber)
if (self:IsMappingActive(info) and (currentOrder > Grichelde.MAPPING_OFFSET)) then
return Grichelde.ICONS.MOVE_UP
else
return Grichelde.ICONS.MOVE_UP_DISABLED
end
end
function Grichelde:GetMoveDownImage(info)
self:TracePrint("GetMoveDownImage : info")
for i = 0, #info do
self:TracePrint("%d = %s", i, info[i])
end
local currentName = info[2]
self:DebugPrint("GetMoveDownImage : \"%s\"", currentName)
local _, replNumber = self:SplitOnFirstMatch(currentName, "_")
local currentOrder = toNumber(replNumber)
local maxRepl = Grichelde.MAPPING_OFFSET
local replacements = self.db.profile.replacements or {}
for replName, _ in pairs(replacements) do
local num = match(replName, "^replacement_(%d+)")
if (num ~= nil) and (maxRepl < toNumber(num)) then
maxRepl = toNumber(num)
end
end
if (self:IsMappingActive(info) and (currentOrder < maxRepl)) then
return Grichelde.ICONS.MOVE_DOWN
else
return Grichelde.ICONS.MOVE_DOWN_DISABLED
end
end
function Grichelde:GetDeleteImage(info)
self:TracePrint("GetDeleteImage : info")
for i = 0, #info do
self:TracePrint("%d = %s", i, info[i])
end
if (self:IsMappingActive(info)) then
return Grichelde.ICONS.DELETE
else
return Grichelde.ICONS.DELETE_DISABLED
end
end
function Grichelde:DeleteMapping(info)
self:TracePrint("DeleteMapping : info")
for i = 0, #info do
self:TracePrint("%d = %s", i, info[i])
end
local currentName = info[2]
self:DebugPrint("delete option: %s", currentName)
self.db.profile.replacements[currentName] = nil
self:RefreshProfiles("DeleteMapping " .. currentName)
local _, replNumber = self:SplitOnFirstMatch(currentName, "_")
local newMapping = "replacement_" .. toNumber(replNumber - 1)
self.dialog:SelectGroup(self.name, "replacements", newMapping)
end
function Grichelde:DeleteAllMappings()
self:DebugPrint("DeleteAllMappings")
-- do NOT set self.db.profile.replacements = {} it will break defaults
tWipe(self.db.profile.replacements)
self:AddEmptyMapping()
self:RefreshProfiles("DeleteAllMappings")
end

786
GricheldeTest.lua Normal file
View File

@@ -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

185
GricheldeUpgrade.lua Normal file
View File

@@ -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

253
GricheldeUtils.lua Normal file
View File

@@ -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

View File

@@ -0,0 +1,58 @@
--- AceConfig-3.0 wrapper library.
-- Provides an API to register an options table with the config registry,
-- as well as associate it with a slash command.
-- @class file
-- @name AceConfig-3.0
-- @release $Id: AceConfig-3.0.lua 1161 2017-08-12 14:30:16Z funkydude $
--[[
AceConfig-3.0
Very light wrapper library that combines all the AceConfig subcomponents into one more easily used whole.
]]
local cfgreg = LibStub("AceConfigRegistry-3.0")
local cfgcmd = LibStub("AceConfigCmd-3.0")
local MAJOR, MINOR = "AceConfig-3.0", 3
local AceConfig = LibStub:NewLibrary(MAJOR, MINOR)
if not AceConfig then return end
--TODO: local cfgdlg = LibStub("AceConfigDialog-3.0", true)
--TODO: local cfgdrp = LibStub("AceConfigDropdown-3.0", true)
-- Lua APIs
local pcall, error, type, pairs = pcall, error, type, pairs
-- -------------------------------------------------------------------
-- :RegisterOptionsTable(appName, options, slashcmd, persist)
--
-- - appName - (string) application name
-- - options - table or function ref, see AceConfigRegistry
-- - slashcmd - slash command (string) or table with commands, or nil to NOT create a slash command
--- Register a option table with the AceConfig registry.
-- You can supply a slash command (or a table of slash commands) to register with AceConfigCmd directly.
-- @paramsig appName, options [, slashcmd]
-- @param appName The application name for the config table.
-- @param options The option table (or a function to generate one on demand). http://www.wowace.com/addons/ace3/pages/ace-config-3-0-options-tables/
-- @param slashcmd A slash command to register for the option table, or a table of slash commands.
-- @usage
-- local AceConfig = LibStub("AceConfig-3.0")
-- AceConfig:RegisterOptionsTable("MyAddon", myOptions, {"/myslash", "/my"})
function AceConfig:RegisterOptionsTable(appName, options, slashcmd)
local ok,msg = pcall(cfgreg.RegisterOptionsTable, self, appName, options)
if not ok then error(msg, 2) end
if slashcmd then
if type(slashcmd) == "table" then
for _,cmd in pairs(slashcmd) do
cfgcmd:CreateChatCommand(cmd, appName)
end
else
cfgcmd:CreateChatCommand(slashcmd, appName)
end
end
end

View File

@@ -0,0 +1,8 @@
<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">
<Include file="AceConfigRegistry-3.0\AceConfigRegistry-3.0.xml"/>
<Include file="AceConfigCmd-3.0\AceConfigCmd-3.0.xml"/>
<Include file="AceConfigDialog-3.0\AceConfigDialog-3.0.xml"/>
<!--<Include file="AceConfigDropdown-3.0\AceConfigDropdown-3.0.xml"/>-->
<Script file="AceConfig-3.0.lua"/>
</Ui>

View File

@@ -0,0 +1,794 @@
--- AceConfigCmd-3.0 handles access to an options table through the "command line" interface via the ChatFrames.
-- @class file
-- @name AceConfigCmd-3.0
-- @release $Id: AceConfigCmd-3.0.lua 1161 2017-08-12 14:30:16Z funkydude $
--[[
AceConfigCmd-3.0
Handles commandline optionstable access
REQUIRES: AceConsole-3.0 for command registration (loaded on demand)
]]
-- TODO: plugin args
local cfgreg = LibStub("AceConfigRegistry-3.0")
local MAJOR, MINOR = "AceConfigCmd-3.0", 14
local AceConfigCmd = LibStub:NewLibrary(MAJOR, MINOR)
if not AceConfigCmd then return end
AceConfigCmd.commands = AceConfigCmd.commands or {}
local commands = AceConfigCmd.commands
local AceConsole -- LoD
local AceConsoleName = "AceConsole-3.0"
-- Lua APIs
local strsub, strsplit, strlower, strmatch, strtrim = string.sub, string.split, string.lower, string.match, string.trim
local format, tonumber, tostring = string.format, tonumber, tostring
local tsort, tinsert = table.sort, table.insert
local select, pairs, next, type = select, pairs, next, type
local error, assert = error, assert
-- WoW APIs
local _G = _G
-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded
-- List them here for Mikk's FindGlobals script
-- GLOBALS: LibStub, SELECTED_CHAT_FRAME, DEFAULT_CHAT_FRAME
local L = setmetatable({}, { -- TODO: replace with proper locale
__index = function(self,k) return k end
})
local function print(msg)
(SELECTED_CHAT_FRAME or DEFAULT_CHAT_FRAME):AddMessage(msg)
end
-- constants used by getparam() calls below
local handlertypes = {["table"]=true}
local handlermsg = "expected a table"
local functypes = {["function"]=true, ["string"]=true}
local funcmsg = "expected function or member name"
-- pickfirstset() - picks the first non-nil value and returns it
local function pickfirstset(...)
for i=1,select("#",...) do
if select(i,...)~=nil then
return select(i,...)
end
end
end
-- err() - produce real error() regarding malformed options tables etc
local function err(info,inputpos,msg )
local cmdstr=" "..strsub(info.input, 1, inputpos-1)
error(MAJOR..": /" ..info[0] ..cmdstr ..": "..(msg or "malformed options table"), 2)
end
-- usererr() - produce chatframe message regarding bad slash syntax etc
local function usererr(info,inputpos,msg )
local cmdstr=strsub(info.input, 1, inputpos-1);
print("/" ..info[0] .. " "..cmdstr ..": "..(msg or "malformed options table"))
end
-- callmethod() - call a given named method (e.g. "get", "set") with given arguments
local function callmethod(info, inputpos, tab, methodtype, ...)
local method = info[methodtype]
if not method then
err(info, inputpos, "'"..methodtype.."': not set")
end
info.arg = tab.arg
info.option = tab
info.type = tab.type
if type(method)=="function" then
return method(info, ...)
elseif type(method)=="string" then
if type(info.handler[method])~="function" then
err(info, inputpos, "'"..methodtype.."': '"..method.."' is not a member function of "..tostring(info.handler))
end
return info.handler[method](info.handler, info, ...)
else
assert(false) -- type should have already been checked on read
end
end
-- callfunction() - call a given named function (e.g. "name", "desc") with given arguments
local function callfunction(info, tab, methodtype, ...)
local method = tab[methodtype]
info.arg = tab.arg
info.option = tab
info.type = tab.type
if type(method)=="function" then
return method(info, ...)
else
assert(false) -- type should have already been checked on read
end
end
-- do_final() - do the final step (set/execute) along with validation and confirmation
local function do_final(info, inputpos, tab, methodtype, ...)
if info.validate then
local res = callmethod(info,inputpos,tab,"validate",...)
if type(res)=="string" then
usererr(info, inputpos, "'"..strsub(info.input, inputpos).."' - "..res)
return
end
end
-- console ignores .confirm
callmethod(info,inputpos,tab,methodtype, ...)
end
-- getparam() - used by handle() to retreive and store "handler", "get", "set", etc
local function getparam(info, inputpos, tab, depth, paramname, types, errormsg)
local old,oldat = info[paramname], info[paramname.."_at"]
local val=tab[paramname]
if val~=nil then
if val==false then
val=nil
elseif not types[type(val)] then
err(info, inputpos, "'" .. paramname.. "' - "..errormsg)
end
info[paramname] = val
info[paramname.."_at"] = depth
end
return old,oldat
end
-- iterateargs(tab) - custom iterator that iterates both t.args and t.plugins.*
local dummytable={}
local function iterateargs(tab)
if not tab.plugins then
return pairs(tab.args)
end
local argtabkey,argtab=next(tab.plugins)
local v
return function(_, k)
while argtab do
k,v = next(argtab, k)
if k then return k,v end
if argtab==tab.args then
argtab=nil
else
argtabkey,argtab = next(tab.plugins, argtabkey)
if not argtabkey then
argtab=tab.args
end
end
end
end
end
local function checkhidden(info, inputpos, tab)
if tab.cmdHidden~=nil then
return tab.cmdHidden
end
local hidden = tab.hidden
if type(hidden) == "function" or type(hidden) == "string" then
info.hidden = hidden
hidden = callmethod(info, inputpos, tab, 'hidden')
info.hidden = nil
end
return hidden
end
local function showhelp(info, inputpos, tab, depth, noHead)
if not noHead then
print("|cff33ff99"..info.appName.."|r: Arguments to |cffffff78/"..info[0].."|r "..strsub(info.input,1,inputpos-1)..":")
end
local sortTbl = {} -- [1..n]=name
local refTbl = {} -- [name]=tableref
for k,v in iterateargs(tab) do
if not refTbl[k] then -- a plugin overriding something in .args
tinsert(sortTbl, k)
refTbl[k] = v
end
end
tsort(sortTbl, function(one, two)
local o1 = refTbl[one].order or 100
local o2 = refTbl[two].order or 100
if type(o1) == "function" or type(o1) == "string" then
info.order = o1
info[#info+1] = one
o1 = callmethod(info, inputpos, refTbl[one], "order")
info[#info] = nil
info.order = nil
end
if type(o2) == "function" or type(o1) == "string" then
info.order = o2
info[#info+1] = two
o2 = callmethod(info, inputpos, refTbl[two], "order")
info[#info] = nil
info.order = nil
end
if o1<0 and o2<0 then return o1<o2 end
if o2<0 then return true end
if o1<0 then return false end
if o1==o2 then return tostring(one)<tostring(two) end -- compare names
return o1<o2
end)
for i = 1, #sortTbl do
local k = sortTbl[i]
local v = refTbl[k]
if not checkhidden(info, inputpos, v) then
if v.type ~= "description" and v.type ~= "header" then
-- recursively show all inline groups
local name, desc = v.name, v.desc
if type(name) == "function" then
name = callfunction(info, v, 'name')
end
if type(desc) == "function" then
desc = callfunction(info, v, 'desc')
end
if v.type == "group" and pickfirstset(v.cmdInline, v.inline, false) then
print(" "..(desc or name)..":")
local oldhandler,oldhandler_at = getparam(info, inputpos, v, depth, "handler", handlertypes, handlermsg)
showhelp(info, inputpos, v, depth, true)
info.handler,info.handler_at = oldhandler,oldhandler_at
else
local key = k:gsub(" ", "_")
print(" |cffffff78"..key.."|r - "..(desc or name or ""))
end
end
end
end
end
local function keybindingValidateFunc(text)
if text == nil or text == "NONE" then
return nil
end
text = text:upper()
local shift, ctrl, alt
local modifier
while true do
if text == "-" then
break
end
modifier, text = strsplit('-', text, 2)
if text then
if modifier ~= "SHIFT" and modifier ~= "CTRL" and modifier ~= "ALT" then
return false
end
if modifier == "SHIFT" then
if shift then
return false
end
shift = true
end
if modifier == "CTRL" then
if ctrl then
return false
end
ctrl = true
end
if modifier == "ALT" then
if alt then
return false
end
alt = true
end
else
text = modifier
break
end
end
if text == "" then
return false
end
if not text:find("^F%d+$") and text ~= "CAPSLOCK" and text:len() ~= 1 and (text:byte() < 128 or text:len() > 4) and not _G["KEY_" .. text] then
return false
end
local s = text
if shift then
s = "SHIFT-" .. s
end
if ctrl then
s = "CTRL-" .. s
end
if alt then
s = "ALT-" .. s
end
return s
end
-- handle() - selfrecursing function that processes input->optiontable
-- - depth - starts at 0
-- - retfalse - return false rather than produce error if a match is not found (used by inlined groups)
local function handle(info, inputpos, tab, depth, retfalse)
if not(type(tab)=="table" and type(tab.type)=="string") then err(info,inputpos) end
-------------------------------------------------------------------
-- Grab hold of handler,set,get,func,etc if set (and remember old ones)
-- Note that we do NOT validate if method names are correct at this stage,
-- the handler may change before they're actually used!
local oldhandler,oldhandler_at = getparam(info,inputpos,tab,depth,"handler",handlertypes,handlermsg)
local oldset,oldset_at = getparam(info,inputpos,tab,depth,"set",functypes,funcmsg)
local oldget,oldget_at = getparam(info,inputpos,tab,depth,"get",functypes,funcmsg)
local oldfunc,oldfunc_at = getparam(info,inputpos,tab,depth,"func",functypes,funcmsg)
local oldvalidate,oldvalidate_at = getparam(info,inputpos,tab,depth,"validate",functypes,funcmsg)
--local oldconfirm,oldconfirm_at = getparam(info,inputpos,tab,depth,"confirm",functypes,funcmsg)
-------------------------------------------------------------------
-- Act according to .type of this table
if tab.type=="group" then
------------ group --------------------------------------------
if type(tab.args)~="table" then err(info, inputpos) end
if tab.plugins and type(tab.plugins)~="table" then err(info,inputpos) end
-- grab next arg from input
local _,nextpos,arg = (info.input):find(" *([^ ]+) *", inputpos)
if not arg then
showhelp(info, inputpos, tab, depth)
return
end
nextpos=nextpos+1
-- loop .args and try to find a key with a matching name
for k,v in iterateargs(tab) do
if not(type(k)=="string" and type(v)=="table" and type(v.type)=="string") then err(info,inputpos, "options table child '"..tostring(k).."' is malformed") end
-- is this child an inline group? if so, traverse into it
if v.type=="group" and pickfirstset(v.cmdInline, v.inline, false) then
info[depth+1] = k
if handle(info, inputpos, v, depth+1, true)==false then
info[depth+1] = nil
-- wasn't found in there, but that's ok, we just keep looking down here
else
return -- done, name was found in inline group
end
-- matching name and not a inline group
elseif strlower(arg)==strlower(k:gsub(" ", "_")) then
info[depth+1] = k
return handle(info,nextpos,v,depth+1)
end
end
-- no match
if retfalse then
-- restore old infotable members and return false to indicate failure
info.handler,info.handler_at = oldhandler,oldhandler_at
info.set,info.set_at = oldset,oldset_at
info.get,info.get_at = oldget,oldget_at
info.func,info.func_at = oldfunc,oldfunc_at
info.validate,info.validate_at = oldvalidate,oldvalidate_at
--info.confirm,info.confirm_at = oldconfirm,oldconfirm_at
return false
end
-- couldn't find the command, display error
usererr(info, inputpos, "'"..arg.."' - " .. L["unknown argument"])
return
end
local str = strsub(info.input,inputpos);
if tab.type=="execute" then
------------ execute --------------------------------------------
do_final(info, inputpos, tab, "func")
elseif tab.type=="input" then
------------ input --------------------------------------------
local res = true
if tab.pattern then
if not(type(tab.pattern)=="string") then err(info, inputpos, "'pattern' - expected a string") end
if not strmatch(str, tab.pattern) then
usererr(info, inputpos, "'"..str.."' - " .. L["invalid input"])
return
end
end
do_final(info, inputpos, tab, "set", str)
elseif tab.type=="toggle" then
------------ toggle --------------------------------------------
local b
local str = strtrim(strlower(str))
if str=="" then
b = callmethod(info, inputpos, tab, "get")
if tab.tristate then
--cycle in true, nil, false order
if b then
b = nil
elseif b == nil then
b = false
else
b = true
end
else
b = not b
end
elseif str==L["on"] then
b = true
elseif str==L["off"] then
b = false
elseif tab.tristate and str==L["default"] then
b = nil
else
if tab.tristate then
usererr(info, inputpos, format(L["'%s' - expected 'on', 'off' or 'default', or no argument to toggle."], str))
else
usererr(info, inputpos, format(L["'%s' - expected 'on' or 'off', or no argument to toggle."], str))
end
return
end
do_final(info, inputpos, tab, "set", b)
elseif tab.type=="range" then
------------ range --------------------------------------------
local val = tonumber(str)
if not val then
usererr(info, inputpos, "'"..str.."' - "..L["expected number"])
return
end
if type(info.step)=="number" then
val = val- (val % info.step)
end
if type(info.min)=="number" and val<info.min then
usererr(info, inputpos, val.." - "..format(L["must be equal to or higher than %s"], tostring(info.min)) )
return
end
if type(info.max)=="number" and val>info.max then
usererr(info, inputpos, val.." - "..format(L["must be equal to or lower than %s"], tostring(info.max)) )
return
end
do_final(info, inputpos, tab, "set", val)
elseif tab.type=="select" then
------------ select ------------------------------------
local str = strtrim(strlower(str))
local values = tab.values
if type(values) == "function" or type(values) == "string" then
info.values = values
values = callmethod(info, inputpos, tab, "values")
info.values = nil
end
if str == "" then
local b = callmethod(info, inputpos, tab, "get")
local fmt = "|cffffff78- [%s]|r %s"
local fmt_sel = "|cffffff78- [%s]|r %s |cffff0000*|r"
print(L["Options for |cffffff78"..info[#info].."|r:"])
for k, v in pairs(values) do
if b == k then
print(fmt_sel:format(k, v))
else
print(fmt:format(k, v))
end
end
return
end
local ok
for k,v in pairs(values) do
if strlower(k)==str then
str = k -- overwrite with key (in case of case mismatches)
ok = true
break
end
end
if not ok then
usererr(info, inputpos, "'"..str.."' - "..L["unknown selection"])
return
end
do_final(info, inputpos, tab, "set", str)
elseif tab.type=="multiselect" then
------------ multiselect -------------------------------------------
local str = strtrim(strlower(str))
local values = tab.values
if type(values) == "function" or type(values) == "string" then
info.values = values
values = callmethod(info, inputpos, tab, "values")
info.values = nil
end
if str == "" then
local fmt = "|cffffff78- [%s]|r %s"
local fmt_sel = "|cffffff78- [%s]|r %s |cffff0000*|r"
print(L["Options for |cffffff78"..info[#info].."|r (multiple possible):"])
for k, v in pairs(values) do
if callmethod(info, inputpos, tab, "get", k) then
print(fmt_sel:format(k, v))
else
print(fmt:format(k, v))
end
end
return
end
--build a table of the selections, checking that they exist
--parse for =on =off =default in the process
--table will be key = true for options that should toggle, key = [on|off|default] for options to be set
local sels = {}
for v in str:gmatch("[^ ]+") do
--parse option=on etc
local opt, val = v:match('(.+)=(.+)')
--get option if toggling
if not opt then
opt = v
end
--check that the opt is valid
local ok
for k,v in pairs(values) do
if strlower(k)==opt then
opt = k -- overwrite with key (in case of case mismatches)
ok = true
break
end
end
if not ok then
usererr(info, inputpos, "'"..opt.."' - "..L["unknown selection"])
return
end
--check that if val was supplied it is valid
if val then
if val == L["on"] or val == L["off"] or (tab.tristate and val == L["default"]) then
--val is valid insert it
sels[opt] = val
else
if tab.tristate then
usererr(info, inputpos, format(L["'%s' '%s' - expected 'on', 'off' or 'default', or no argument to toggle."], v, val))
else
usererr(info, inputpos, format(L["'%s' '%s' - expected 'on' or 'off', or no argument to toggle."], v, val))
end
return
end
else
-- no val supplied, toggle
sels[opt] = true
end
end
for opt, val in pairs(sels) do
local newval
if (val == true) then
--toggle the option
local b = callmethod(info, inputpos, tab, "get", opt)
if tab.tristate then
--cycle in true, nil, false order
if b then
b = nil
elseif b == nil then
b = false
else
b = true
end
else
b = not b
end
newval = b
else
--set the option as specified
if val==L["on"] then
newval = true
elseif val==L["off"] then
newval = false
elseif val==L["default"] then
newval = nil
end
end
do_final(info, inputpos, tab, "set", opt, newval)
end
elseif tab.type=="color" then
------------ color --------------------------------------------
local str = strtrim(strlower(str))
if str == "" then
--TODO: Show current value
return
end
local r, g, b, a
local hasAlpha = tab.hasAlpha
if type(hasAlpha) == "function" or type(hasAlpha) == "string" then
info.hasAlpha = hasAlpha
hasAlpha = callmethod(info, inputpos, tab, 'hasAlpha')
info.hasAlpha = nil
end
if hasAlpha then
if str:len() == 8 and str:find("^%x*$") then
--parse a hex string
r,g,b,a = tonumber(str:sub(1, 2), 16) / 255, tonumber(str:sub(3, 4), 16) / 255, tonumber(str:sub(5, 6), 16) / 255, tonumber(str:sub(7, 8), 16) / 255
else
--parse seperate values
r,g,b,a = str:match("^([%d%.]+) ([%d%.]+) ([%d%.]+) ([%d%.]+)$")
r,g,b,a = tonumber(r), tonumber(g), tonumber(b), tonumber(a)
end
if not (r and g and b and a) then
usererr(info, inputpos, format(L["'%s' - expected 'RRGGBBAA' or 'r g b a'."], str))
return
end
if r >= 0.0 and r <= 1.0 and g >= 0.0 and g <= 1.0 and b >= 0.0 and b <= 1.0 and a >= 0.0 and a <= 1.0 then
--values are valid
elseif r >= 0 and r <= 255 and g >= 0 and g <= 255 and b >= 0 and b <= 255 and a >= 0 and a <= 255 then
--values are valid 0..255, convert to 0..1
r = r / 255
g = g / 255
b = b / 255
a = a / 255
else
--values are invalid
usererr(info, inputpos, format(L["'%s' - values must all be either in the range 0..1 or 0..255."], str))
end
else
a = 1.0
if str:len() == 6 and str:find("^%x*$") then
--parse a hex string
r,g,b = tonumber(str:sub(1, 2), 16) / 255, tonumber(str:sub(3, 4), 16) / 255, tonumber(str:sub(5, 6), 16) / 255
else
--parse seperate values
r,g,b = str:match("^([%d%.]+) ([%d%.]+) ([%d%.]+)$")
r,g,b = tonumber(r), tonumber(g), tonumber(b)
end
if not (r and g and b) then
usererr(info, inputpos, format(L["'%s' - expected 'RRGGBB' or 'r g b'."], str))
return
end
if r >= 0.0 and r <= 1.0 and g >= 0.0 and g <= 1.0 and b >= 0.0 and b <= 1.0 then
--values are valid
elseif r >= 0 and r <= 255 and g >= 0 and g <= 255 and b >= 0 and b <= 255 then
--values are valid 0..255, convert to 0..1
r = r / 255
g = g / 255
b = b / 255
else
--values are invalid
usererr(info, inputpos, format(L["'%s' - values must all be either in the range 0-1 or 0-255."], str))
end
end
do_final(info, inputpos, tab, "set", r,g,b,a)
elseif tab.type=="keybinding" then
------------ keybinding --------------------------------------------
local str = strtrim(strlower(str))
if str == "" then
--TODO: Show current value
return
end
local value = keybindingValidateFunc(str:upper())
if value == false then
usererr(info, inputpos, format(L["'%s' - Invalid Keybinding."], str))
return
end
do_final(info, inputpos, tab, "set", value)
elseif tab.type=="description" then
------------ description --------------------
-- ignore description, GUI config only
else
err(info, inputpos, "unknown options table item type '"..tostring(tab.type).."'")
end
end
--- Handle the chat command.
-- This is usually called from a chat command handler to parse the command input as operations on an aceoptions table.\\
-- AceConfigCmd uses this function internally when a slash command is registered with `:CreateChatCommand`
-- @param slashcmd The slash command WITHOUT leading slash (only used for error output)
-- @param appName The application name as given to `:RegisterOptionsTable()`
-- @param input The commandline input (as given by the WoW handler, i.e. without the command itself)
-- @usage
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceConsole-3.0")
-- -- Use AceConsole-3.0 to register a Chat Command
-- MyAddon:RegisterChatCommand("mychat", "ChatCommand")
--
-- -- Show the GUI if no input is supplied, otherwise handle the chat input.
-- function MyAddon:ChatCommand(input)
-- -- Assuming "MyOptions" is the appName of a valid options table
-- if not input or input:trim() == "" then
-- LibStub("AceConfigDialog-3.0"):Open("MyOptions")
-- else
-- LibStub("AceConfigCmd-3.0").HandleCommand(MyAddon, "mychat", "MyOptions", input)
-- end
-- end
function AceConfigCmd:HandleCommand(slashcmd, appName, input)
local optgetter = cfgreg:GetOptionsTable(appName)
if not optgetter then
error([[Usage: HandleCommand("slashcmd", "appName", "input"): 'appName' - no options table "]]..tostring(appName)..[[" has been registered]], 2)
end
local options = assert( optgetter("cmd", MAJOR) )
local info = { -- Don't try to recycle this, it gets handed off to callbacks and whatnot
[0] = slashcmd,
appName = appName,
options = options,
input = input,
self = self,
handler = self,
uiType = "cmd",
uiName = MAJOR,
}
handle(info, 1, options, 0) -- (info, inputpos, table, depth)
end
--- Utility function to create a slash command handler.
-- Also registers tab completion with AceTab
-- @param slashcmd The slash command WITHOUT leading slash (only used for error output)
-- @param appName The application name as given to `:RegisterOptionsTable()`
function AceConfigCmd:CreateChatCommand(slashcmd, appName)
if not AceConsole then
AceConsole = LibStub(AceConsoleName)
end
if AceConsole.RegisterChatCommand(self, slashcmd, function(input)
AceConfigCmd.HandleCommand(self, slashcmd, appName, input) -- upgradable
end,
true) then -- succesfully registered so lets get the command -> app table in
commands[slashcmd] = appName
end
end
--- Utility function that returns the options table that belongs to a slashcommand.
-- Designed to be used for the AceTab interface.
-- @param slashcmd The slash command WITHOUT leading slash (only used for error output)
-- @return The options table associated with the slash command (or nil if the slash command was not registered)
function AceConfigCmd:GetChatCommandOptions(slashcmd)
return commands[slashcmd]
end

View File

@@ -0,0 +1,4 @@
<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="AceConfigCmd-3.0.lua"/>
</Ui>

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,4 @@
<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="AceConfigDialog-3.0.lua"/>
</Ui>

View File

@@ -0,0 +1,350 @@
--- AceConfigRegistry-3.0 handles central registration of options tables in use by addons and modules.\\
-- Options tables can be registered as raw tables, OR as function refs that return a table.\\
-- Such functions receive three arguments: "uiType", "uiName", "appName". \\
-- * Valid **uiTypes**: "cmd", "dropdown", "dialog". This is verified by the library at call time. \\
-- * The **uiName** field is expected to contain the full name of the calling addon, including version, e.g. "FooBar-1.0". This is verified by the library at call time.\\
-- * The **appName** field is the options table name as given at registration time \\
--
-- :IterateOptionsTables() (and :GetOptionsTable() if only given one argument) return a function reference that the requesting config handling addon must call with valid "uiType", "uiName".
-- @class file
-- @name AceConfigRegistry-3.0
-- @release $Id: AceConfigRegistry-3.0.lua 1169 2018-02-27 16:18:28Z nevcairiel $
local CallbackHandler = LibStub("CallbackHandler-1.0")
local MAJOR, MINOR = "AceConfigRegistry-3.0", 18
local AceConfigRegistry = LibStub:NewLibrary(MAJOR, MINOR)
if not AceConfigRegistry then return end
AceConfigRegistry.tables = AceConfigRegistry.tables or {}
if not AceConfigRegistry.callbacks then
AceConfigRegistry.callbacks = CallbackHandler:New(AceConfigRegistry)
end
-- Lua APIs
local tinsert, tconcat = table.insert, table.concat
local strfind, strmatch = string.find, string.match
local type, tostring, select, pairs = type, tostring, select, pairs
local error, assert = error, assert
-----------------------------------------------------------------------
-- Validating options table consistency:
AceConfigRegistry.validated = {
-- list of options table names ran through :ValidateOptionsTable automatically.
-- CLEARED ON PURPOSE, since newer versions may have newer validators
cmd = {},
dropdown = {},
dialog = {},
}
local function err(msg, errlvl, ...)
local t = {}
for i=select("#",...),1,-1 do
tinsert(t, (select(i, ...)))
end
error(MAJOR..":ValidateOptionsTable(): "..tconcat(t,".")..msg, errlvl+2)
end
local isstring={["string"]=true, _="string"}
local isstringfunc={["string"]=true,["function"]=true, _="string or funcref"}
local istable={["table"]=true, _="table"}
local ismethodtable={["table"]=true,["string"]=true,["function"]=true, _="methodname, funcref or table"}
local optstring={["nil"]=true,["string"]=true, _="string"}
local optstringfunc={["nil"]=true,["string"]=true,["function"]=true, _="string or funcref"}
local optstringnumberfunc={["nil"]=true,["string"]=true,["number"]=true,["function"]=true, _="string, number or funcref"}
local optnumber={["nil"]=true,["number"]=true, _="number"}
local optmethod={["nil"]=true,["string"]=true,["function"]=true, _="methodname or funcref"}
local optmethodfalse={["nil"]=true,["string"]=true,["function"]=true,["boolean"]={[false]=true}, _="methodname, funcref or false"}
local optmethodnumber={["nil"]=true,["string"]=true,["function"]=true,["number"]=true, _="methodname, funcref or number"}
local optmethodtable={["nil"]=true,["string"]=true,["function"]=true,["table"]=true, _="methodname, funcref or table"}
local optmethodbool={["nil"]=true,["string"]=true,["function"]=true,["boolean"]=true, _="methodname, funcref or boolean"}
local opttable={["nil"]=true,["table"]=true, _="table"}
local optbool={["nil"]=true,["boolean"]=true, _="boolean"}
local optboolnumber={["nil"]=true,["boolean"]=true,["number"]=true, _="boolean or number"}
local optstringnumber={["nil"]=true,["string"]=true,["number"]=true, _="string or number"}
local basekeys={
type=isstring,
name=isstringfunc,
desc=optstringfunc,
descStyle=optstring,
order=optmethodnumber,
validate=optmethodfalse,
confirm=optmethodbool,
confirmText=optstring,
disabled=optmethodbool,
hidden=optmethodbool,
guiHidden=optmethodbool,
dialogHidden=optmethodbool,
dropdownHidden=optmethodbool,
cmdHidden=optmethodbool,
icon=optstringnumberfunc,
iconCoords=optmethodtable,
handler=opttable,
get=optmethodfalse,
set=optmethodfalse,
func=optmethodfalse,
arg={["*"]=true},
width=optstringnumber,
}
local typedkeys={
header={},
description={
image=optstringnumberfunc,
imageCoords=optmethodtable,
imageHeight=optnumber,
imageWidth=optnumber,
fontSize=optstringfunc,
},
group={
args=istable,
plugins=opttable,
inline=optbool,
cmdInline=optbool,
guiInline=optbool,
dropdownInline=optbool,
dialogInline=optbool,
childGroups=optstring,
},
execute={
image=optstringnumberfunc,
imageCoords=optmethodtable,
imageHeight=optnumber,
imageWidth=optnumber,
},
input={
pattern=optstring,
usage=optstring,
control=optstring,
dialogControl=optstring,
dropdownControl=optstring,
multiline=optboolnumber,
},
toggle={
tristate=optbool,
image=optstringnumberfunc,
imageCoords=optmethodtable,
},
tristate={
},
range={
min=optnumber,
softMin=optnumber,
max=optnumber,
softMax=optnumber,
step=optnumber,
bigStep=optnumber,
isPercent=optbool,
},
select={
values=ismethodtable,
style={
["nil"]=true,
["string"]={dropdown=true,radio=true},
_="string: 'dropdown' or 'radio'"
},
control=optstring,
dialogControl=optstring,
dropdownControl=optstring,
itemControl=optstring,
},
multiselect={
values=ismethodtable,
style=optstring,
tristate=optbool,
control=optstring,
dialogControl=optstring,
dropdownControl=optstring,
},
color={
hasAlpha=optmethodbool,
},
keybinding={
-- TODO
},
}
local function validateKey(k,errlvl,...)
errlvl=(errlvl or 0)+1
if type(k)~="string" then
err("["..tostring(k).."] - key is not a string", errlvl,...)
end
if strfind(k, "[%c\127]") then
err("["..tostring(k).."] - key name contained control characters", errlvl,...)
end
end
local function validateVal(v, oktypes, errlvl,...)
errlvl=(errlvl or 0)+1
local isok=oktypes[type(v)] or oktypes["*"]
if not isok then
err(": expected a "..oktypes._..", got '"..tostring(v).."'", errlvl,...)
end
if type(isok)=="table" then -- isok was a table containing specific values to be tested for!
if not isok[v] then
err(": did not expect "..type(v).." value '"..tostring(v).."'", errlvl,...)
end
end
end
local function validate(options,errlvl,...)
errlvl=(errlvl or 0)+1
-- basic consistency
if type(options)~="table" then
err(": expected a table, got a "..type(options), errlvl,...)
end
if type(options.type)~="string" then
err(".type: expected a string, got a "..type(options.type), errlvl,...)
end
-- get type and 'typedkeys' member
local tk = typedkeys[options.type]
if not tk then
err(".type: unknown type '"..options.type.."'", errlvl,...)
end
-- make sure that all options[] are known parameters
for k,v in pairs(options) do
if not (tk[k] or basekeys[k]) then
err(": unknown parameter", errlvl,tostring(k),...)
end
end
-- verify that required params are there, and that everything is the right type
for k,oktypes in pairs(basekeys) do
validateVal(options[k], oktypes, errlvl,k,...)
end
for k,oktypes in pairs(tk) do
validateVal(options[k], oktypes, errlvl,k,...)
end
-- extra logic for groups
if options.type=="group" then
for k,v in pairs(options.args) do
validateKey(k,errlvl,"args",...)
validate(v, errlvl,k,"args",...)
end
if options.plugins then
for plugname,plugin in pairs(options.plugins) do
if type(plugin)~="table" then
err(": expected a table, got '"..tostring(plugin).."'", errlvl,tostring(plugname),"plugins",...)
end
for k,v in pairs(plugin) do
validateKey(k,errlvl,tostring(plugname),"plugins",...)
validate(v, errlvl,k,tostring(plugname),"plugins",...)
end
end
end
end
end
--- Validates basic structure and integrity of an options table \\
-- Does NOT verify that get/set etc actually exist, since they can be defined at any depth
-- @param options The table to be validated
-- @param name The name of the table to be validated (shown in any error message)
-- @param errlvl (optional number) error level offset, default 0 (=errors point to the function calling :ValidateOptionsTable)
function AceConfigRegistry:ValidateOptionsTable(options,name,errlvl)
errlvl=(errlvl or 0)+1
name = name or "Optionstable"
if not options.name then
options.name=name -- bit of a hack, the root level doesn't really need a .name :-/
end
validate(options,errlvl,name)
end
--- Fires a "ConfigTableChange" callback for those listening in on it, allowing config GUIs to refresh.
-- You should call this function if your options table changed from any outside event, like a game event
-- or a timer.
-- @param appName The application name as given to `:RegisterOptionsTable()`
function AceConfigRegistry:NotifyChange(appName)
if not AceConfigRegistry.tables[appName] then return end
AceConfigRegistry.callbacks:Fire("ConfigTableChange", appName)
end
-- -------------------------------------------------------------------
-- Registering and retreiving options tables:
-- validateGetterArgs: helper function for :GetOptionsTable (or, rather, the getter functions returned by it)
local function validateGetterArgs(uiType, uiName, errlvl)
errlvl=(errlvl or 0)+2
if uiType~="cmd" and uiType~="dropdown" and uiType~="dialog" then
error(MAJOR..": Requesting options table: 'uiType' - invalid configuration UI type, expected 'cmd', 'dropdown' or 'dialog'", errlvl)
end
if not strmatch(uiName, "[A-Za-z]%-[0-9]") then -- Expecting e.g. "MyLib-1.2"
error(MAJOR..": Requesting options table: 'uiName' - badly formatted or missing version number. Expected e.g. 'MyLib-1.2'", errlvl)
end
end
--- Register an options table with the config registry.
-- @param appName The application name as given to `:RegisterOptionsTable()`
-- @param options The options table, OR a function reference that generates it on demand. \\
-- See the top of the page for info on arguments passed to such functions.
-- @param skipValidation Skip options table validation (primarily useful for extremely huge options, with a noticeable slowdown)
function AceConfigRegistry:RegisterOptionsTable(appName, options, skipValidation)
if type(options)=="table" then
if options.type~="group" then -- quick sanity checker
error(MAJOR..": RegisterOptionsTable(appName, options): 'options' - missing type='group' member in root group", 2)
end
AceConfigRegistry.tables[appName] = function(uiType, uiName, errlvl)
errlvl=(errlvl or 0)+1
validateGetterArgs(uiType, uiName, errlvl)
if not AceConfigRegistry.validated[uiType][appName] and not skipValidation then
AceConfigRegistry:ValidateOptionsTable(options, appName, errlvl) -- upgradable
AceConfigRegistry.validated[uiType][appName] = true
end
return options
end
elseif type(options)=="function" then
AceConfigRegistry.tables[appName] = function(uiType, uiName, errlvl)
errlvl=(errlvl or 0)+1
validateGetterArgs(uiType, uiName, errlvl)
local tab = assert(options(uiType, uiName, appName))
if not AceConfigRegistry.validated[uiType][appName] and not skipValidation then
AceConfigRegistry:ValidateOptionsTable(tab, appName, errlvl) -- upgradable
AceConfigRegistry.validated[uiType][appName] = true
end
return tab
end
else
error(MAJOR..": RegisterOptionsTable(appName, options): 'options' - expected table or function reference", 2)
end
end
--- Returns an iterator of ["appName"]=funcref pairs
function AceConfigRegistry:IterateOptionsTables()
return pairs(AceConfigRegistry.tables)
end
--- Query the registry for a specific options table.
-- If only appName is given, a function is returned which you
-- can call with (uiType,uiName) to get the table.\\
-- If uiType&uiName are given, the table is returned.
-- @param appName The application name as given to `:RegisterOptionsTable()`
-- @param uiType The type of UI to get the table for, one of "cmd", "dropdown", "dialog"
-- @param uiName The name of the library/addon querying for the table, e.g. "MyLib-1.0"
function AceConfigRegistry:GetOptionsTable(appName, uiType, uiName)
local f = AceConfigRegistry.tables[appName]
if not f then
return nil
end
if uiType then
return f(uiType,uiName,1) -- get the table for us
else
return f -- return the function
end
end

View File

@@ -0,0 +1,4 @@
<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="AceConfigRegistry-3.0.lua"/>
</Ui>

View File

@@ -0,0 +1,746 @@
--- **AceDB-3.0** manages the SavedVariables of your addon.
-- It offers profile management, smart defaults and namespaces for modules.\\
-- Data can be saved in different data-types, depending on its intended usage.
-- The most common data-type is the `profile` type, which allows the user to choose
-- the active profile, and manage the profiles of all of his characters.\\
-- The following data types are available:
-- * **char** Character-specific data. Every character has its own database.
-- * **realm** Realm-specific data. All of the players characters on the same realm share this database.
-- * **class** Class-specific data. All of the players characters of the same class share this database.
-- * **race** Race-specific data. All of the players characters of the same race share this database.
-- * **faction** Faction-specific data. All of the players characters of the same faction share this database.
-- * **factionrealm** Faction and realm specific data. All of the players characters on the same realm and of the same faction share this database.
-- * **locale** Locale specific data, based on the locale of the players game client.
-- * **global** Global Data. All characters on the same account share this database.
-- * **profile** Profile-specific data. All characters using the same profile share this database. The user can control which profile should be used.
--
-- Creating a new Database using the `:New` function will return a new DBObject. A database will inherit all functions
-- of the DBObjectLib listed here. \\
-- If you create a new namespaced child-database (`:RegisterNamespace`), you'll get a DBObject as well, but note
-- that the child-databases cannot individually change their profile, and are linked to their parents profile - and because of that,
-- the profile related APIs are not available. Only `:RegisterDefaults` and `:ResetProfile` are available on child-databases.
--
-- For more details on how to use AceDB-3.0, see the [[AceDB-3.0 Tutorial]].
--
-- You may also be interested in [[libdualspec-1-0|LibDualSpec-1.0]] to do profile switching automatically when switching specs.
--
-- @usage
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("DBExample")
--
-- -- declare defaults to be used in the DB
-- local defaults = {
-- profile = {
-- setting = true,
-- }
-- }
--
-- function MyAddon:OnInitialize()
-- -- Assuming the .toc says ## SavedVariables: MyAddonDB
-- self.db = LibStub("AceDB-3.0"):New("MyAddonDB", defaults, true)
-- end
-- @class file
-- @name AceDB-3.0.lua
-- @release $Id: AceDB-3.0.lua 1142 2016-07-11 08:36:19Z nevcairiel $
local ACEDB_MAJOR, ACEDB_MINOR = "AceDB-3.0", 26
local AceDB, oldminor = LibStub:NewLibrary(ACEDB_MAJOR, ACEDB_MINOR)
if not AceDB then return end -- No upgrade needed
-- Lua APIs
local type, pairs, next, error = type, pairs, next, error
local setmetatable, getmetatable, rawset, rawget = setmetatable, getmetatable, rawset, rawget
-- WoW APIs
local _G = _G
-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded
-- List them here for Mikk's FindGlobals script
-- GLOBALS: LibStub
AceDB.db_registry = AceDB.db_registry or {}
AceDB.frame = AceDB.frame or CreateFrame("Frame")
local CallbackHandler
local CallbackDummy = { Fire = function() end }
local DBObjectLib = {}
--[[-------------------------------------------------------------------------
AceDB Utility Functions
---------------------------------------------------------------------------]]
-- Simple shallow copy for copying defaults
local function copyTable(src, dest)
if type(dest) ~= "table" then dest = {} end
if type(src) == "table" then
for k,v in pairs(src) do
if type(v) == "table" then
-- try to index the key first so that the metatable creates the defaults, if set, and use that table
v = copyTable(v, dest[k])
end
dest[k] = v
end
end
return dest
end
-- Called to add defaults to a section of the database
--
-- When a ["*"] default section is indexed with a new key, a table is returned
-- and set in the host table. These tables must be cleaned up by removeDefaults
-- in order to ensure we don't write empty default tables.
local function copyDefaults(dest, src)
-- this happens if some value in the SV overwrites our default value with a non-table
--if type(dest) ~= "table" then return end
for k, v in pairs(src) do
if k == "*" or k == "**" then
if type(v) == "table" then
-- This is a metatable used for table defaults
local mt = {
-- This handles the lookup and creation of new subtables
__index = function(t,k)
if k == nil then return nil end
local tbl = {}
copyDefaults(tbl, v)
rawset(t, k, tbl)
return tbl
end,
}
setmetatable(dest, mt)
-- handle already existing tables in the SV
for dk, dv in pairs(dest) do
if not rawget(src, dk) and type(dv) == "table" then
copyDefaults(dv, v)
end
end
else
-- Values are not tables, so this is just a simple return
local mt = {__index = function(t,k) return k~=nil and v or nil end}
setmetatable(dest, mt)
end
elseif type(v) == "table" then
if not rawget(dest, k) then rawset(dest, k, {}) end
if type(dest[k]) == "table" then
copyDefaults(dest[k], v)
if src['**'] then
copyDefaults(dest[k], src['**'])
end
end
else
if rawget(dest, k) == nil then
rawset(dest, k, v)
end
end
end
end
-- Called to remove all defaults in the default table from the database
local function removeDefaults(db, defaults, blocker)
-- remove all metatables from the db, so we don't accidentally create new sub-tables through them
setmetatable(db, nil)
-- loop through the defaults and remove their content
for k,v in pairs(defaults) do
if k == "*" or k == "**" then
if type(v) == "table" then
-- Loop through all the actual k,v pairs and remove
for key, value in pairs(db) do
if type(value) == "table" then
-- if the key was not explicitly specified in the defaults table, just strip everything from * and ** tables
if defaults[key] == nil and (not blocker or blocker[key] == nil) then
removeDefaults(value, v)
-- if the table is empty afterwards, remove it
if next(value) == nil then
db[key] = nil
end
-- if it was specified, only strip ** content, but block values which were set in the key table
elseif k == "**" then
removeDefaults(value, v, defaults[key])
end
end
end
elseif k == "*" then
-- check for non-table default
for key, value in pairs(db) do
if defaults[key] == nil and v == value then
db[key] = nil
end
end
end
elseif type(v) == "table" and type(db[k]) == "table" then
-- if a blocker was set, dive into it, to allow multi-level defaults
removeDefaults(db[k], v, blocker and blocker[k])
if next(db[k]) == nil then
db[k] = nil
end
else
-- check if the current value matches the default, and that its not blocked by another defaults table
if db[k] == defaults[k] and (not blocker or blocker[k] == nil) then
db[k] = nil
end
end
end
end
-- This is called when a table section is first accessed, to set up the defaults
local function initSection(db, section, svstore, key, defaults)
local sv = rawget(db, "sv")
local tableCreated
if not sv[svstore] then sv[svstore] = {} end
if not sv[svstore][key] then
sv[svstore][key] = {}
tableCreated = true
end
local tbl = sv[svstore][key]
if defaults then
copyDefaults(tbl, defaults)
end
rawset(db, section, tbl)
return tableCreated, tbl
end
-- Metatable to handle the dynamic creation of sections and copying of sections.
local dbmt = {
__index = function(t, section)
local keys = rawget(t, "keys")
local key = keys[section]
if key then
local defaultTbl = rawget(t, "defaults")
local defaults = defaultTbl and defaultTbl[section]
if section == "profile" then
local new = initSection(t, section, "profiles", key, defaults)
if new then
-- Callback: OnNewProfile, database, newProfileKey
t.callbacks:Fire("OnNewProfile", t, key)
end
elseif section == "profiles" then
local sv = rawget(t, "sv")
if not sv.profiles then sv.profiles = {} end
rawset(t, "profiles", sv.profiles)
elseif section == "global" then
local sv = rawget(t, "sv")
if not sv.global then sv.global = {} end
if defaults then
copyDefaults(sv.global, defaults)
end
rawset(t, section, sv.global)
else
initSection(t, section, section, key, defaults)
end
end
return rawget(t, section)
end
}
local function validateDefaults(defaults, keyTbl, offset)
if not defaults then return end
offset = offset or 0
for k in pairs(defaults) do
if not keyTbl[k] or k == "profiles" then
error(("Usage: AceDBObject:RegisterDefaults(defaults): '%s' is not a valid datatype."):format(k), 3 + offset)
end
end
end
local preserve_keys = {
["callbacks"] = true,
["RegisterCallback"] = true,
["UnregisterCallback"] = true,
["UnregisterAllCallbacks"] = true,
["children"] = true,
}
local realmKey = GetRealmName()
local charKey = UnitName("player") .. " - " .. realmKey
local _, classKey = UnitClass("player")
local _, raceKey = UnitRace("player")
local factionKey = UnitFactionGroup("player")
local factionrealmKey = factionKey .. " - " .. realmKey
local localeKey = GetLocale():lower()
local regionTable = { "US", "KR", "EU", "TW", "CN" }
local regionKey = regionTable[GetCurrentRegion()]
local factionrealmregionKey = factionrealmKey .. " - " .. regionKey
-- Actual database initialization function
local function initdb(sv, defaults, defaultProfile, olddb, parent)
-- Generate the database keys for each section
-- map "true" to our "Default" profile
if defaultProfile == true then defaultProfile = "Default" end
local profileKey
if not parent then
-- Make a container for profile keys
if not sv.profileKeys then sv.profileKeys = {} end
-- Try to get the profile selected from the char db
profileKey = sv.profileKeys[charKey] or defaultProfile or charKey
-- save the selected profile for later
sv.profileKeys[charKey] = profileKey
else
-- Use the profile of the parents DB
profileKey = parent.keys.profile or defaultProfile or charKey
-- clear the profileKeys in the DB, namespaces don't need to store them
sv.profileKeys = nil
end
-- This table contains keys that enable the dynamic creation
-- of each section of the table. The 'global' and 'profiles'
-- have a key of true, since they are handled in a special case
local keyTbl= {
["char"] = charKey,
["realm"] = realmKey,
["class"] = classKey,
["race"] = raceKey,
["faction"] = factionKey,
["factionrealm"] = factionrealmKey,
["factionrealmregion"] = factionrealmregionKey,
["profile"] = profileKey,
["locale"] = localeKey,
["global"] = true,
["profiles"] = true,
}
validateDefaults(defaults, keyTbl, 1)
-- This allows us to use this function to reset an entire database
-- Clear out the old database
if olddb then
for k,v in pairs(olddb) do if not preserve_keys[k] then olddb[k] = nil end end
end
-- Give this database the metatable so it initializes dynamically
local db = setmetatable(olddb or {}, dbmt)
if not rawget(db, "callbacks") then
-- try to load CallbackHandler-1.0 if it loaded after our library
if not CallbackHandler then CallbackHandler = LibStub:GetLibrary("CallbackHandler-1.0", true) end
db.callbacks = CallbackHandler and CallbackHandler:New(db) or CallbackDummy
end
-- Copy methods locally into the database object, to avoid hitting
-- the metatable when calling methods
if not parent then
for name, func in pairs(DBObjectLib) do
db[name] = func
end
else
-- hack this one in
db.RegisterDefaults = DBObjectLib.RegisterDefaults
db.ResetProfile = DBObjectLib.ResetProfile
end
-- Set some properties in the database object
db.profiles = sv.profiles
db.keys = keyTbl
db.sv = sv
--db.sv_name = name
db.defaults = defaults
db.parent = parent
-- store the DB in the registry
AceDB.db_registry[db] = true
return db
end
-- handle PLAYER_LOGOUT
-- strip all defaults from all databases
-- and cleans up empty sections
local function logoutHandler(frame, event)
if event == "PLAYER_LOGOUT" then
for db in pairs(AceDB.db_registry) do
db.callbacks:Fire("OnDatabaseShutdown", db)
db:RegisterDefaults(nil)
-- cleanup sections that are empty without defaults
local sv = rawget(db, "sv")
for section in pairs(db.keys) do
if rawget(sv, section) then
-- global is special, all other sections have sub-entrys
-- also don't delete empty profiles on main dbs, only on namespaces
if section ~= "global" and (section ~= "profiles" or rawget(db, "parent")) then
for key in pairs(sv[section]) do
if not next(sv[section][key]) then
sv[section][key] = nil
end
end
end
if not next(sv[section]) then
sv[section] = nil
end
end
end
end
end
end
AceDB.frame:RegisterEvent("PLAYER_LOGOUT")
AceDB.frame:SetScript("OnEvent", logoutHandler)
--[[-------------------------------------------------------------------------
AceDB Object Method Definitions
---------------------------------------------------------------------------]]
--- Sets the defaults table for the given database object by clearing any
-- that are currently set, and then setting the new defaults.
-- @param defaults A table of defaults for this database
function DBObjectLib:RegisterDefaults(defaults)
if defaults and type(defaults) ~= "table" then
error("Usage: AceDBObject:RegisterDefaults(defaults): 'defaults' - table or nil expected.", 2)
end
validateDefaults(defaults, self.keys)
-- Remove any currently set defaults
if self.defaults then
for section,key in pairs(self.keys) do
if self.defaults[section] and rawget(self, section) then
removeDefaults(self[section], self.defaults[section])
end
end
end
-- Set the DBObject.defaults table
self.defaults = defaults
-- Copy in any defaults, only touching those sections already created
if defaults then
for section,key in pairs(self.keys) do
if defaults[section] and rawget(self, section) then
copyDefaults(self[section], defaults[section])
end
end
end
end
--- Changes the profile of the database and all of it's namespaces to the
-- supplied named profile
-- @param name The name of the profile to set as the current profile
function DBObjectLib:SetProfile(name)
if type(name) ~= "string" then
error("Usage: AceDBObject:SetProfile(name): 'name' - string expected.", 2)
end
-- changing to the same profile, dont do anything
if name == self.keys.profile then return end
local oldProfile = self.profile
local defaults = self.defaults and self.defaults.profile
-- Callback: OnProfileShutdown, database
self.callbacks:Fire("OnProfileShutdown", self)
if oldProfile and defaults then
-- Remove the defaults from the old profile
removeDefaults(oldProfile, defaults)
end
self.profile = nil
self.keys["profile"] = name
-- if the storage exists, save the new profile
-- this won't exist on namespaces.
if self.sv.profileKeys then
self.sv.profileKeys[charKey] = name
end
-- populate to child namespaces
if self.children then
for _, db in pairs(self.children) do
DBObjectLib.SetProfile(db, name)
end
end
-- Callback: OnProfileChanged, database, newProfileKey
self.callbacks:Fire("OnProfileChanged", self, name)
end
--- Returns a table with the names of the existing profiles in the database.
-- You can optionally supply a table to re-use for this purpose.
-- @param tbl A table to store the profile names in (optional)
function DBObjectLib:GetProfiles(tbl)
if tbl and type(tbl) ~= "table" then
error("Usage: AceDBObject:GetProfiles(tbl): 'tbl' - table or nil expected.", 2)
end
-- Clear the container table
if tbl then
for k,v in pairs(tbl) do tbl[k] = nil end
else
tbl = {}
end
local curProfile = self.keys.profile
local i = 0
for profileKey in pairs(self.profiles) do
i = i + 1
tbl[i] = profileKey
if curProfile and profileKey == curProfile then curProfile = nil end
end
-- Add the current profile, if it hasn't been created yet
if curProfile then
i = i + 1
tbl[i] = curProfile
end
return tbl, i
end
--- Returns the current profile name used by the database
function DBObjectLib:GetCurrentProfile()
return self.keys.profile
end
--- Deletes a named profile. This profile must not be the active profile.
-- @param name The name of the profile to be deleted
-- @param silent If true, do not raise an error when the profile does not exist
function DBObjectLib:DeleteProfile(name, silent)
if type(name) ~= "string" then
error("Usage: AceDBObject:DeleteProfile(name): 'name' - string expected.", 2)
end
if self.keys.profile == name then
error("Cannot delete the active profile in an AceDBObject.", 2)
end
if not rawget(self.profiles, name) and not silent then
error("Cannot delete profile '" .. name .. "'. It does not exist.", 2)
end
self.profiles[name] = nil
-- populate to child namespaces
if self.children then
for _, db in pairs(self.children) do
DBObjectLib.DeleteProfile(db, name, true)
end
end
-- switch all characters that use this profile back to the default
if self.sv.profileKeys then
for key, profile in pairs(self.sv.profileKeys) do
if profile == name then
self.sv.profileKeys[key] = nil
end
end
end
-- Callback: OnProfileDeleted, database, profileKey
self.callbacks:Fire("OnProfileDeleted", self, name)
end
--- Copies a named profile into the current profile, overwriting any conflicting
-- settings.
-- @param name The name of the profile to be copied into the current profile
-- @param silent If true, do not raise an error when the profile does not exist
function DBObjectLib:CopyProfile(name, silent)
if type(name) ~= "string" then
error("Usage: AceDBObject:CopyProfile(name): 'name' - string expected.", 2)
end
if name == self.keys.profile then
error("Cannot have the same source and destination profiles.", 2)
end
if not rawget(self.profiles, name) and not silent then
error("Cannot copy profile '" .. name .. "'. It does not exist.", 2)
end
-- Reset the profile before copying
DBObjectLib.ResetProfile(self, nil, true)
local profile = self.profile
local source = self.profiles[name]
copyTable(source, profile)
-- populate to child namespaces
if self.children then
for _, db in pairs(self.children) do
DBObjectLib.CopyProfile(db, name, true)
end
end
-- Callback: OnProfileCopied, database, sourceProfileKey
self.callbacks:Fire("OnProfileCopied", self, name)
end
--- Resets the current profile to the default values (if specified).
-- @param noChildren if set to true, the reset will not be populated to the child namespaces of this DB object
-- @param noCallbacks if set to true, won't fire the OnProfileReset callback
function DBObjectLib:ResetProfile(noChildren, noCallbacks)
local profile = self.profile
for k,v in pairs(profile) do
profile[k] = nil
end
local defaults = self.defaults and self.defaults.profile
if defaults then
copyDefaults(profile, defaults)
end
-- populate to child namespaces
if self.children and not noChildren then
for _, db in pairs(self.children) do
DBObjectLib.ResetProfile(db, nil, noCallbacks)
end
end
-- Callback: OnProfileReset, database
if not noCallbacks then
self.callbacks:Fire("OnProfileReset", self)
end
end
--- Resets the entire database, using the string defaultProfile as the new default
-- profile.
-- @param defaultProfile The profile name to use as the default
function DBObjectLib:ResetDB(defaultProfile)
if defaultProfile and type(defaultProfile) ~= "string" then
error("Usage: AceDBObject:ResetDB(defaultProfile): 'defaultProfile' - string or nil expected.", 2)
end
local sv = self.sv
for k,v in pairs(sv) do
sv[k] = nil
end
local parent = self.parent
initdb(sv, self.defaults, defaultProfile, self)
-- fix the child namespaces
if self.children then
if not sv.namespaces then sv.namespaces = {} end
for name, db in pairs(self.children) do
if not sv.namespaces[name] then sv.namespaces[name] = {} end
initdb(sv.namespaces[name], db.defaults, self.keys.profile, db, self)
end
end
-- Callback: OnDatabaseReset, database
self.callbacks:Fire("OnDatabaseReset", self)
-- Callback: OnProfileChanged, database, profileKey
self.callbacks:Fire("OnProfileChanged", self, self.keys["profile"])
return self
end
--- Creates a new database namespace, directly tied to the database. This
-- is a full scale database in it's own rights other than the fact that
-- it cannot control its profile individually
-- @param name The name of the new namespace
-- @param defaults A table of values to use as defaults
function DBObjectLib:RegisterNamespace(name, defaults)
if type(name) ~= "string" then
error("Usage: AceDBObject:RegisterNamespace(name, defaults): 'name' - string expected.", 2)
end
if defaults and type(defaults) ~= "table" then
error("Usage: AceDBObject:RegisterNamespace(name, defaults): 'defaults' - table or nil expected.", 2)
end
if self.children and self.children[name] then
error ("Usage: AceDBObject:RegisterNamespace(name, defaults): 'name' - a namespace with that name already exists.", 2)
end
local sv = self.sv
if not sv.namespaces then sv.namespaces = {} end
if not sv.namespaces[name] then
sv.namespaces[name] = {}
end
local newDB = initdb(sv.namespaces[name], defaults, self.keys.profile, nil, self)
if not self.children then self.children = {} end
self.children[name] = newDB
return newDB
end
--- Returns an already existing namespace from the database object.
-- @param name The name of the new namespace
-- @param silent if true, the addon is optional, silently return nil if its not found
-- @usage
-- local namespace = self.db:GetNamespace('namespace')
-- @return the namespace object if found
function DBObjectLib:GetNamespace(name, silent)
if type(name) ~= "string" then
error("Usage: AceDBObject:GetNamespace(name): 'name' - string expected.", 2)
end
if not silent and not (self.children and self.children[name]) then
error ("Usage: AceDBObject:GetNamespace(name): 'name' - namespace does not exist.", 2)
end
if not self.children then self.children = {} end
return self.children[name]
end
--[[-------------------------------------------------------------------------
AceDB Exposed Methods
---------------------------------------------------------------------------]]
--- Creates a new database object that can be used to handle database settings and profiles.
-- By default, an empty DB is created, using a character specific profile.
--
-- You can override the default profile used by passing any profile name as the third argument,
-- or by passing //true// as the third argument to use a globally shared profile called "Default".
--
-- Note that there is no token replacement in the default profile name, passing a defaultProfile as "char"
-- will use a profile named "char", and not a character-specific profile.
-- @param tbl The name of variable, or table to use for the database
-- @param defaults A table of database defaults
-- @param defaultProfile The name of the default profile. If not set, a character specific profile will be used as the default.
-- You can also pass //true// to use a shared global profile called "Default".
-- @usage
-- -- Create an empty DB using a character-specific default profile.
-- self.db = LibStub("AceDB-3.0"):New("MyAddonDB")
-- @usage
-- -- Create a DB using defaults and using a shared default profile
-- self.db = LibStub("AceDB-3.0"):New("MyAddonDB", defaults, true)
function AceDB:New(tbl, defaults, defaultProfile)
if type(tbl) == "string" then
local name = tbl
tbl = _G[name]
if not tbl then
tbl = {}
_G[name] = tbl
end
end
if type(tbl) ~= "table" then
error("Usage: AceDB:New(tbl, defaults, defaultProfile): 'tbl' - table expected.", 2)
end
if defaults and type(defaults) ~= "table" then
error("Usage: AceDB:New(tbl, defaults, defaultProfile): 'defaults' - table expected.", 2)
end
if defaultProfile and type(defaultProfile) ~= "string" and defaultProfile ~= true then
error("Usage: AceDB:New(tbl, defaults, defaultProfile): 'defaultProfile' - string or true expected.", 2)
end
return initdb(tbl, defaults, defaultProfile)
end
-- upgrade existing databases
for db in pairs(AceDB.db_registry) do
if not db.parent then
for name,func in pairs(DBObjectLib) do
db[name] = func
end
else
db.RegisterDefaults = DBObjectLib.RegisterDefaults
db.ResetProfile = DBObjectLib.ResetProfile
end
end

View File

@@ -0,0 +1,4 @@
<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="AceDB-3.0.lua"/>
</Ui>

View File

@@ -0,0 +1,460 @@
--- AceDBOptions-3.0 provides a universal AceConfig options screen for managing AceDB-3.0 profiles.
-- @class file
-- @name AceDBOptions-3.0
-- @release $Id: AceDBOptions-3.0.lua 1140 2016-07-03 07:53:29Z nevcairiel $
local ACEDBO_MAJOR, ACEDBO_MINOR = "AceDBOptions-3.0", 15
local AceDBOptions, oldminor = LibStub:NewLibrary(ACEDBO_MAJOR, ACEDBO_MINOR)
if not AceDBOptions then return end -- No upgrade needed
-- Lua APIs
local pairs, next = pairs, next
-- WoW APIs
local UnitClass = UnitClass
-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded
-- List them here for Mikk's FindGlobals script
-- GLOBALS: NORMAL_FONT_COLOR_CODE, FONT_COLOR_CODE_CLOSE
AceDBOptions.optionTables = AceDBOptions.optionTables or {}
AceDBOptions.handlers = AceDBOptions.handlers or {}
--[[
Localization of AceDBOptions-3.0
]]
local L = {
choose = "Existing Profiles",
choose_desc = "You can either create a new profile by entering a name in the editbox, or choose one of the already existing profiles.",
choose_sub = "Select one of your currently available profiles.",
copy = "Copy From",
copy_desc = "Copy the settings from one existing profile into the currently active profile.",
current = "Current Profile:",
default = "Default",
delete = "Delete a Profile",
delete_confirm = "Are you sure you want to delete the selected profile?",
delete_desc = "Delete existing and unused profiles from the database to save space, and cleanup the SavedVariables file.",
delete_sub = "Deletes a profile from the database.",
intro = "You can change the active database profile, so you can have different settings for every character.",
new = "New",
new_sub = "Create a new empty profile.",
profiles = "Profiles",
profiles_sub = "Manage Profiles",
reset = "Reset Profile",
reset_desc = "Reset the current profile back to its default values, in case your configuration is broken, or you simply want to start over.",
reset_sub = "Reset the current profile to the default",
}
local LOCALE = GetLocale()
if LOCALE == "deDE" then
L["choose"] = "Vorhandene Profile"
L["choose_desc"] = "Du kannst ein neues Profil erstellen, indem du einen neuen Namen in der Eingabebox 'Neu' eingibst, oder wähle eines der vorhandenen Profile aus."
L["choose_sub"] = "Wählt ein bereits vorhandenes Profil aus."
L["copy"] = "Kopieren von..."
L["copy_desc"] = "Kopiere die Einstellungen von einem vorhandenen Profil in das aktive Profil."
L["current"] = "Aktuelles Profil:"
L["default"] = "Standard"
L["delete"] = "Profil löschen"
L["delete_confirm"] = "Willst du das ausgewählte Profil wirklich löschen?"
L["delete_desc"] = "Lösche vorhandene oder unbenutzte Profile aus der Datenbank, um Platz zu sparen und die SavedVariables-Datei 'sauber' zu halten."
L["delete_sub"] = "Löscht ein Profil aus der Datenbank."
L["intro"] = "Hier kannst du das aktive Datenbankprofil ändern, damit du verschiedene Einstellungen für jeden Charakter erstellen kannst, wodurch eine sehr flexible Konfiguration möglich wird."
L["new"] = "Neu"
L["new_sub"] = "Ein neues Profil erstellen."
L["profiles"] = "Profile"
L["profiles_sub"] = "Profile verwalten"
L["reset"] = "Profil zurücksetzen"
L["reset_desc"] = "Setzt das momentane Profil auf Standardwerte zurück, für den Fall, dass mit der Konfiguration etwas schief lief oder weil du einfach neu starten willst."
L["reset_sub"] = "Das aktuelle Profil auf Standard zurücksetzen."
elseif LOCALE == "frFR" then
L["choose"] = "Profils existants"
L["choose_desc"] = "Vous pouvez créer un nouveau profil en entrant un nouveau nom dans la boîte de saisie, ou en choississant un des profils déjà existants."
L["choose_sub"] = "Permet de choisir un des profils déjà disponibles."
L["copy"] = "Copier à partir de"
L["copy_desc"] = "Copie les paramètres d'un profil déjà existant dans le profil actuellement actif."
L["current"] = "Profil actuel :"
L["default"] = "Défaut"
L["delete"] = "Supprimer un profil"
L["delete_confirm"] = "Etes-vous sûr de vouloir supprimer le profil sélectionné ?"
L["delete_desc"] = "Supprime les profils existants inutilisés de la base de données afin de gagner de la place et de nettoyer le fichier SavedVariables."
L["delete_sub"] = "Supprime un profil de la base de données."
L["intro"] = "Vous pouvez changer le profil actuel afin d'avoir des paramètres différents pour chaque personnage, permettant ainsi d'avoir une configuration très flexible."
L["new"] = "Nouveau"
L["new_sub"] = "Créée un nouveau profil vierge."
L["profiles"] = "Profils"
L["profiles_sub"] = "Gestion des profils"
L["reset"] = "Réinitialiser le profil"
L["reset_desc"] = "Réinitialise le profil actuel au cas où votre configuration est corrompue ou si vous voulez tout simplement faire table rase."
L["reset_sub"] = "Réinitialise le profil actuel avec les paramètres par défaut."
elseif LOCALE == "koKR" then
L["choose"] = "저장 중인 프로필"
L["choose_desc"] = "입력창에 새로운 이름을 입력하거나 저장 중인 프로필 중 하나를 선택하여 새로운 프로필을 만들 수 있습니다."
L["choose_sub"] = "현재 이용할 수 있는 프로필 중 하나를 선택합니다."
L["copy"] = "복사해오기"
L["copy_desc"] = "현재 사용 중인 프로필에 선택한 프로필의 설정을 복사합니다."
L["current"] = "현재 프로필:"
L["default"] = "기본값"
L["delete"] = "프로필 삭제"
L["delete_confirm"] = "정말로 선택한 프로필을 삭제할까요?"
L["delete_desc"] = "저장 공간 절약과 SavedVariables 파일의 정리를 위해 데이터베이스에서 사용하지 않는 프로필을 삭제하세요."
L["delete_sub"] = "데이터베이스의 프로필을 삭제합니다."
L["intro"] = "활성 데이터베이스 프로필을 변경할 수 있고, 각 캐릭터 별로 다른 설정을 할 수 있습니다."
L["new"] = "새로운 프로필"
L["new_sub"] = "새로운 프로필을 만듭니다."
L["profiles"] = "프로필"
L["profiles_sub"] = "프로필 관리"
L["reset"] = "프로필 초기화"
L["reset_desc"] = "설정이 깨졌거나 처음부터 다시 설정을 원하는 경우, 현재 프로필을 기본값으로 초기화하세요."
L["reset_sub"] = "현재 프로필을 기본값으로 초기화합니다"
elseif LOCALE == "esES" or LOCALE == "esMX" then
L["choose"] = "Perfiles existentes"
L["choose_desc"] = "Puedes crear un nuevo perfil introduciendo un nombre en el recuadro o puedes seleccionar un perfil de los ya existentes."
L["choose_sub"] = "Selecciona uno de los perfiles disponibles."
L["copy"] = "Copiar de"
L["copy_desc"] = "Copia los ajustes de un perfil existente al perfil actual."
L["current"] = "Perfil actual:"
L["default"] = "Por defecto"
L["delete"] = "Borrar un Perfil"
L["delete_confirm"] = "¿Estas seguro que quieres borrar el perfil seleccionado?"
L["delete_desc"] = "Borra los perfiles existentes y sin uso de la base de datos para ganar espacio y limpiar el archivo SavedVariables."
L["delete_sub"] = "Borra un perfil de la base de datos."
L["intro"] = "Puedes cambiar el perfil activo de tal manera que cada personaje tenga diferentes configuraciones."
L["new"] = "Nuevo"
L["new_sub"] = "Crear un nuevo perfil vacio."
L["profiles"] = "Perfiles"
L["profiles_sub"] = "Manejar Perfiles"
L["reset"] = "Reiniciar Perfil"
L["reset_desc"] = "Reinicia el perfil actual a los valores por defectos, en caso de que se haya estropeado la configuración o quieras volver a empezar de nuevo."
L["reset_sub"] = "Reinicar el perfil actual al de por defecto"
elseif LOCALE == "zhTW" then
L["choose"] = "現有的設定檔"
L["choose_desc"] = "您可以在文字方塊內輸入名字以建立新的設定檔,或是選擇一個現有的設定檔使用。"
L["choose_sub"] = "從當前可用的設定檔裡面選擇一個。"
L["copy"] = "複製自"
L["copy_desc"] = "從一個現有的設定檔,將設定複製到現在使用中的設定檔。"
L["current"] = "目前設定檔:"
L["default"] = "預設"
L["delete"] = "刪除一個設定檔"
L["delete_confirm"] = "確定要刪除所選擇的設定檔嗎?"
L["delete_desc"] = "從資料庫裡刪除不再使用的設定檔,以節省空間,並且清理 SavedVariables 檔案。"
L["delete_sub"] = "從資料庫裡刪除一個設定檔。"
L["intro"] = "您可以從資料庫中選擇一個設定檔來使用,如此就可以讓每個角色使用不同的設定。"
L["new"] = "新建"
L["new_sub"] = "新建一個空的設定檔。"
L["profiles"] = "設定檔"
L["profiles_sub"] = "管理設定檔"
L["reset"] = "重置設定檔"
L["reset_desc"] = "將現用的設定檔重置為預設值;用於設定檔損壞,或者單純想要重來的情況。"
L["reset_sub"] = "將目前的設定檔重置為預設值"
elseif LOCALE == "zhCN" then
L["choose"] = "现有的配置文件"
L["choose_desc"] = "你可以通过在文本框内输入一个名字创立一个新的配置文件,也可以选择一个已经存在的配置文件。"
L["choose_sub"] = "从当前可用的配置文件里面选择一个。"
L["copy"] = "复制自"
L["copy_desc"] = "从当前某个已保存的配置文件复制到当前正使用的配置文件。"
L["current"] = "当前配置文件:"
L["default"] = "默认"
L["delete"] = "删除一个配置文件"
L["delete_confirm"] = "你确定要删除所选择的配置文件么?"
L["delete_desc"] = "从数据库里删除不再使用的配置文件以节省空间并且清理SavedVariables文件。"
L["delete_sub"] = "从数据库里删除一个配置文件。"
L["intro"] = "你可以选择一个活动的数据配置文件,这样你的每个角色就可以拥有不同的设置值,可以给你的插件配置带来极大的灵活性。"
L["new"] = "新建"
L["new_sub"] = "新建一个空的配置文件。"
L["profiles"] = "配置文件"
L["profiles_sub"] = "管理配置文件"
L["reset"] = "重置配置文件"
L["reset_desc"] = "将当前的配置文件恢复到它的默认值,用于你的配置文件损坏,或者你只是想重来的情况。"
L["reset_sub"] = "将当前的配置文件恢复为默认值"
elseif LOCALE == "ruRU" then
L["choose"] = "Существующие профили"
L["choose_desc"] = "Вы можете создать новый профиль, введя название в поле ввода, или выбрать один из уже существующих профилей."
L["choose_sub"] = "Выбор одиного из уже доступных профилей"
L["copy"] = "Скопировать из"
L["copy_desc"] = "Скопировать настройки из выбранного профиля в активный."
L["current"] = "Текущий профиль:"
L["default"] = "По умолчанию"
L["delete"] = "Удалить профиль"
L["delete_confirm"] = "Вы уверены, что вы хотите удалить выбранный профиль?"
L["delete_desc"] = "Удалить существующий и неиспользуемый профиль из БД для сохранения места, и очистить SavedVariables файл."
L["delete_sub"] = "Удаление профиля из БД"
L["intro"] = "Изменяя активный профиль, вы можете задать различные настройки модификаций для каждого персонажа."
L["new"] = "Новый"
L["new_sub"] = "Создать новый чистый профиль"
L["profiles"] = "Профили"
L["profiles_sub"] = "Управление профилями"
L["reset"] = "Сброс профиля"
L["reset_desc"] = "Сбросить текущий профиль к стандартным настройкам, если ваша конфигурация испорчена или вы хотите настроить всё заново."
L["reset_sub"] = "Сброс текущего профиля на стандартный"
elseif LOCALE == "itIT" then
L["choose"] = "Profili Esistenti"
L["choose_desc"] = "Puoi creare un nuovo profilo digitando il nome della casella di testo, oppure scegliendone uno tra i profili già esistenti."
L["choose_sub"] = "Seleziona uno dei profili attualmente disponibili."
L["copy"] = "Copia Da"
L["copy_desc"] = "Copia le impostazioni da un profilo esistente, nel profilo attivo in questo momento."
L["current"] = "Profilo Attivo:"
L["default"] = "Standard"
L["delete"] = "Cancella un Profilo"
L["delete_confirm"] = "Sei sicuro di voler cancellare il profilo selezionato?"
L["delete_desc"] = "Cancella i profili non utilizzati dal database per risparmiare spazio e mantenere puliti i file di configurazione SavedVariables."
L["delete_sub"] = "Cancella un profilo dal Database."
L["intro"] = "Puoi cambiare il profilo attivo, in modo da usare impostazioni diverse per ogni personaggio."
L["new"] = "Nuovo"
L["new_sub"] = "Crea un nuovo profilo vuoto."
L["profiles"] = "Profili"
L["profiles_sub"] = "Gestisci Profili"
L["reset"] = "Reimposta Profilo"
L["reset_desc"] = "Riporta il tuo profilo attivo alle sue impostazioni predefinite, nel caso in cui la tua configurazione si sia corrotta, o semplicemente tu voglia re-inizializzarla."
L["reset_sub"] = "Reimposta il profilo ai suoi valori predefiniti."
elseif LOCALE == "ptBR" then
L["choose"] = "Perfis Existentes"
L["choose_desc"] = "Você pode tanto criar um perfil novo tanto digitando um nome na caixa de texto, quanto escolher um dos perfis já existentes."
L["choose_sub"] = "Selecione um de seus perfis atualmente disponíveis."
L["copy"] = "Copiar De"
L["copy_desc"] = "Copia as definições de um perfil existente no perfil atualmente ativo."
L["current"] = "Perfil Autal:"
L["default"] = "Padrão"
L["delete"] = "Remover um Perfil"
L["delete_confirm"] = "Tem certeza que deseja remover o perfil selecionado?"
L["delete_desc"] = "Remove perfis existentes e inutilizados do banco de dados para economizar espaço, e limpar o arquivo SavedVariables."
L["delete_sub"] = "Remove um perfil do banco de dados."
L["intro"] = "Você pode alterar o perfil do banco de dados ativo, para que possa ter definições diferentes para cada personagem."
L["new"] = "Novo"
L["new_sub"] = "Cria um novo perfil vazio."
L["profiles"] = "Perfis"
L["profiles_sub"] = "Gerenciar Perfis"
L["reset"] = "Resetar Perfil"
L["reset_desc"] = "Reseta o perfil atual para os valores padrões, no caso de sua configuração estar quebrada, ou simplesmente se deseja começar novamente."
L["reset_sub"] = "Resetar o perfil atual ao padrão"
end
local defaultProfiles
local tmpprofiles = {}
-- Get a list of available profiles for the specified database.
-- You can specify which profiles to include/exclude in the list using the two boolean parameters listed below.
-- @param db The db object to retrieve the profiles from
-- @param common If true, getProfileList will add the default profiles to the return list, even if they have not been created yet
-- @param nocurrent If true, then getProfileList will not display the current profile in the list
-- @return Hashtable of all profiles with the internal name as keys and the display name as value.
local function getProfileList(db, common, nocurrent)
local profiles = {}
-- copy existing profiles into the table
local currentProfile = db:GetCurrentProfile()
for i,v in pairs(db:GetProfiles(tmpprofiles)) do
if not (nocurrent and v == currentProfile) then
profiles[v] = v
end
end
-- add our default profiles to choose from ( or rename existing profiles)
for k,v in pairs(defaultProfiles) do
if (common or profiles[k]) and not (nocurrent and k == currentProfile) then
profiles[k] = v
end
end
return profiles
end
--[[
OptionsHandlerPrototype
prototype class for handling the options in a sane way
]]
local OptionsHandlerPrototype = {}
--[[ Reset the profile ]]
function OptionsHandlerPrototype:Reset()
self.db:ResetProfile()
end
--[[ Set the profile to value ]]
function OptionsHandlerPrototype:SetProfile(info, value)
self.db:SetProfile(value)
end
--[[ returns the currently active profile ]]
function OptionsHandlerPrototype:GetCurrentProfile()
return self.db:GetCurrentProfile()
end
--[[
List all active profiles
you can control the output with the .arg variable
currently four modes are supported
(empty) - return all available profiles
"nocurrent" - returns all available profiles except the currently active profile
"common" - returns all avaialble profiles + some commonly used profiles ("char - realm", "realm", "class", "Default")
"both" - common except the active profile
]]
function OptionsHandlerPrototype:ListProfiles(info)
local arg = info.arg
local profiles
if arg == "common" and not self.noDefaultProfiles then
profiles = getProfileList(self.db, true, nil)
elseif arg == "nocurrent" then
profiles = getProfileList(self.db, nil, true)
elseif arg == "both" then -- currently not used
profiles = getProfileList(self.db, (not self.noDefaultProfiles) and true, true)
else
profiles = getProfileList(self.db)
end
return profiles
end
function OptionsHandlerPrototype:HasNoProfiles(info)
local profiles = self:ListProfiles(info)
return ((not next(profiles)) and true or false)
end
--[[ Copy a profile ]]
function OptionsHandlerPrototype:CopyProfile(info, value)
self.db:CopyProfile(value)
end
--[[ Delete a profile from the db ]]
function OptionsHandlerPrototype:DeleteProfile(info, value)
self.db:DeleteProfile(value)
end
--[[ fill defaultProfiles with some generic values ]]
local function generateDefaultProfiles(db)
defaultProfiles = {
["Default"] = L["default"],
[db.keys.char] = db.keys.char,
[db.keys.realm] = db.keys.realm,
[db.keys.class] = UnitClass("player")
}
end
--[[ create and return a handler object for the db, or upgrade it if it already existed ]]
local function getOptionsHandler(db, noDefaultProfiles)
if not defaultProfiles then
generateDefaultProfiles(db)
end
local handler = AceDBOptions.handlers[db] or { db = db, noDefaultProfiles = noDefaultProfiles }
for k,v in pairs(OptionsHandlerPrototype) do
handler[k] = v
end
AceDBOptions.handlers[db] = handler
return handler
end
--[[
the real options table
]]
local optionsTable = {
desc = {
order = 1,
type = "description",
name = L["intro"] .. "\n",
},
descreset = {
order = 9,
type = "description",
name = L["reset_desc"],
},
reset = {
order = 10,
type = "execute",
name = L["reset"],
desc = L["reset_sub"],
func = "Reset",
},
current = {
order = 11,
type = "description",
name = function(info) return L["current"] .. " " .. NORMAL_FONT_COLOR_CODE .. info.handler:GetCurrentProfile() .. FONT_COLOR_CODE_CLOSE end,
width = "default",
},
choosedesc = {
order = 20,
type = "description",
name = "\n" .. L["choose_desc"],
},
new = {
name = L["new"],
desc = L["new_sub"],
type = "input",
order = 30,
get = false,
set = "SetProfile",
},
choose = {
name = L["choose"],
desc = L["choose_sub"],
type = "select",
order = 40,
get = "GetCurrentProfile",
set = "SetProfile",
values = "ListProfiles",
arg = "common",
},
copydesc = {
order = 50,
type = "description",
name = "\n" .. L["copy_desc"],
},
copyfrom = {
order = 60,
type = "select",
name = L["copy"],
desc = L["copy_desc"],
get = false,
set = "CopyProfile",
values = "ListProfiles",
disabled = "HasNoProfiles",
arg = "nocurrent",
},
deldesc = {
order = 70,
type = "description",
name = "\n" .. L["delete_desc"],
},
delete = {
order = 80,
type = "select",
name = L["delete"],
desc = L["delete_sub"],
get = false,
set = "DeleteProfile",
values = "ListProfiles",
disabled = "HasNoProfiles",
arg = "nocurrent",
confirm = true,
confirmText = L["delete_confirm"],
},
}
--- Get/Create a option table that you can use in your addon to control the profiles of AceDB-3.0.
-- @param db The database object to create the options table for.
-- @return The options table to be used in AceConfig-3.0
-- @usage
-- -- Assuming `options` is your top-level options table and `self.db` is your database:
-- options.args.profiles = LibStub("AceDBOptions-3.0"):GetOptionsTable(self.db)
function AceDBOptions:GetOptionsTable(db, noDefaultProfiles)
local tbl = AceDBOptions.optionTables[db] or {
type = "group",
name = L["profiles"],
desc = L["profiles_sub"],
}
tbl.handler = getOptionsHandler(db, noDefaultProfiles)
tbl.args = optionsTable
AceDBOptions.optionTables[db] = tbl
return tbl
end
-- upgrade existing tables
for db,tbl in pairs(AceDBOptions.optionTables) do
tbl.handler = getOptionsHandler(db)
tbl.args = optionsTable
end

View File

@@ -0,0 +1,4 @@
<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="AceDBOptions-3.0.lua"/>
</Ui>

View File

@@ -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

View File

@@ -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>

View File

@@ -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

View File

@@ -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

View File

@@ -1,11 +1,74 @@
# Grichelde - Text replacer
Grichelde replaces characters you entered in a chatbox with any replacment text you specified in the addon options.
Grichelde is a WoW Classic Addon that replaces any characters or words you typed in a chat input line according to your replacement rules.
The replacement is done **before** the text is send to other players/in the target channel. It does **not** change text other players have written in the chat, but the text they will see **from you**.
Its purpose is 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.

View File

@@ -1,12 +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\AceConsole-3.0\AceConsole-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>

View File

@@ -1,14 +1,584 @@
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 cHyperlink = Grichelde.F.cHyperlink
local cPrefix = Grichelde.F.cPrefix
-- system messages
L.AddonLoaded = 'Grichelde hilft Euch jetzt bei euren Sprachschwierigkeiten.'
L.AddonName = "Grichelde"
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.ProfileCreated = 'Neues Profil "%s" erstellt'
--L.ProfileLoaded = 'Profil auf "%s" festgelegt'
--L.ProfileDeleted = 'Profil "%s" gel\195\182scht'
--L.ProfileCopied = 'Einstellungen von "%s" kopiert'
--L.ProfileReset = 'Profil "%s" zur\195\188ckgesetzt'
--L.CantDeleteCurrentProfile = 'Das aktuelle Profil kann nicht gel\195\182scht werden'
--L.InvalidProfile = 'Ung\195\188ltiges Profil "%s"'
L.Profiles_Available = "Verf\195\188gbare Profile:"
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_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."
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_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_Info_Name = "Info"
L.Options_Help_Tab_Info_Desc = "\195\156ber dieses Addon."
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_Info = cYellow("\195\156ber dieses Addon")
.. "|n%s ersetzt beliebige, selbstdefinierte Zeichenfolgen durch andere selbstdefinierte Zeichenfolgen, die ihr eingebt. Die Ersetzung findet vor dem Versenden an andere Spieler oder Kanäle statt. "
.. "Es \195\164ndert nicht den Text den andere Spieler im Chat geschrieben haben, nur eure eigenen Eingaben. Es soll den individuellen Sprachfehler eures Charakters simulieren und dadurch die Immersion erh\195\182hen."
.. "|n|nNat\195\188rlich kann man es auch f\195\188r andere Dinge zweckentfremden (Trollifizierer, Abk\195\188rzungen, Kosenamen, etc.). Eine ausf\195\188hrliche Beschreibung aller Optionen, der Funktionsweise und viele Beispiele befinden sich auf den nachfolgenden Reitern."
.. "|n|n" .. cYellow("Kontakt")
.. "|nBitte Fehler und Erfahrungsberichte direkt als Kommentar auf der Projektwebseite bei " .. cPrefix("CurseForge") .. " (" .. cHyperlink("https://www.curseforge.com/wow/addons/grichelde") .. ") einmelden. "
.. "Ihr k\195\182nnt auch gern Screenshots der Fehlermeldungen und eurer Zuweisungen anh\195\164ngen. Ein \195\156bersichtsfenster aller Mappings kann mit dem Kommando " .. cPrefix("\"/gri mappings\"") .. " aufgerufen und herauskopiert werden. "
.. "|nIch freue mich \195\188ber euere Erfahrungsberichte und Fehlerreports."
.. "|n|n" .. cYellow("Dank")
.. "|nMein Dank geht an meine lieben Beta-Tester " .. cPrefix("Chamera") .. ", " .. cPrefix("Tabenoca") .. " und " .. cPrefix("Nordraka") .. ", und besondereren Dank an " .. cPrefix("Shinue") .. " f\195\188r die Inspiration und lustigen Momente."
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 wird diese Zuordnung \195\188bersprungen. "
.. "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 alle Zuordnungen. "
.. "|nMit der Zuordnung " .. cPrefix("\"s\" => \"sch\"") .. " wird aus " .. cPrefix("\"Tasse\" => \"Tasche\"") .. " statt " .. cPrefix("\"Taschsche\"") .. ", "
.. "aber aus " .. cPrefix("\"schmeissen\" => \"schchmeischen\"") .. ". Solche Randbedingungen beseitigt in der Regel eine weitere Zuordnung: " .. cPrefix("\"schch\" => \"sch\"") .. "."
.. "|n|n" .. cYellow("Anhalten nach Treffer")
.. "|nAlle nachfolgenden Ersetzungen mehr \195\188bersprungen, wenn die aktuelle Zuordnung zutreffend ist. Wenn bei der aktuelle Zuordnung 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\" => \"Gr\195\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"

View File

@@ -1,5 +1,628 @@
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 cHyperlink = Grichelde.F.cHyperlink
local cPrefix = Grichelde.F.cPrefix
-- system messages
L.AddonLoaded = 'Grichelde now helps you with your spelling disabilities.'
L.AddonName = "Grichelde"
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 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_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 = "Adds a new replacement mapping."
L.Options_Replacements_DeleteAll_Name = "Delete All"
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_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_Info_Name = "Info"
L.Options_Help_Tab_Info_Desc = "About this addon."
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_Info = cYellow("About this addon")
.. "|n%s 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 other players/in the target channel. "
.. "It does not change text other players have written in the chat, but the text they will see from you. Its purpose is to simulate a speaking disability of your toon and to strengthen immersion in roleplay."
.. "|n|nOf course it can be used for many other things, too (trollifier, abbreviations, nick names, etc.). A extensive description of all options, the general replacement workflow and a lot of examples can be found on the next tabs."
.. "|n|n" .. cYellow("Contact")
.. "|nPlease report errors and your experiences directly as a comment on the project website at " .. cPrefix("CurseForge") .. " (" .. cHyperlink("https://www.curseforge.com/wow/addons/grichelde") .. "). "
.. "You are encouraged to attach screenshots of error messages and your mappings. An overview of all your mappings is shnown by using the command " .. cPrefix("\"/gri mappings\"") .. " and copy it out. "
.. "|nI'm looking forward for your feedback and reports."
.. "|n|n" .. cYellow("Thanks")
.. "|Many thanks to my beta testers " .. cPrefix("Chamera") .. ", " .. cPrefix("Tabenoca") .. " and " .. cPrefix("Nordraka") .. ", and very special thanks to " .. cPrefix("Shinue") .. " for the inspiration and hilarious moments."
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")
.. "|nAll other consecutive replacements are skipped, when the current mapping matched. When the current mapping does not match, 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"

17
twitch/announcements.txt Normal file
View File

@@ -0,0 +1,17 @@
https://wow.gamepedia.com/Localizing_an_addon
https://wow.gamepedia.com/Pattern_matching
https://wow.gamepedia.com/Lua_functions#String_Functions
https://wow.gamepedia.com/API_SetRaidTarget
https://www.wowace.com/projects/ace3/pages/ace-db-3-0-tutorial
https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0
https://wowwiki.fandom.com/wiki/Events_A-Z_(full_list)
Liebe RP-Gemeinde, ich benötige eure Mithilfe beim Test meines ersten WoW-Addons. :handshake:
Es heißt "Grichelde" und ersetzt beliebige, selbstdefinierte Zeichenfolgen durch andere selbstdefinierte Zeichenfolgen, die ihr eingebt. Es ändert nicht den Text den andere im Chat geschrieben haben, nur eure eigenen Eingaben. Die Idee wurde nach mehreren lustigen RP-Sitzungen mit einer Untoten ohne Unterkiefer geboren, deren Spielerin den Sprachfehler immer mühsam per Hand eintippen musste. Es soll den individuellen Sprachfehler eures Charakters simulieren und dadurch die Immersion erhöhen. Auf der Webseite findet ihr ein paar Screenshots, die euch die Funktion einfach verbildlichen sollten: https://www.curseforge.com/wow/addons/grichelde/screenshots
Natürlich kann man es auch für andere Dinge zweckentfremden (Trollifizierer :dragon_face: , Abkürzungen, Kosenamen, etc.). Es gibt ein nettes UI zum Konfigurieren der Ersetzungen und der aktiven Kanäle und auch eine großzügige Hilfesektion mit vielen Beispielen. Die Suchtreffer können auf ganze Wörter oder am Anfang, der Mitte und/oder am Ende eines Wortes eingeschränkt werden. Für die Profis gibt es sogar Unterstützung für reguläre Ausdrücke :sunglasses:, das ermöglicht auch schwierigere Ersetzungen mit Wiederholungen, wie Stottern. Für Rollenspieler gibts auch eine eigene Emote- und OOC-Erkennung.
Installieren kann man es über Twitch, dort muss aktuell noch die Suche und Installation von Beta-Versionen aktiviert sein, oder manuell über diesen Link runterladen und in den WoW\Interface\Addons Ordner kopieren: https://www.curseforge.com/wow/addons/grichelde
Bitte Fehler auf der Projektwebseite bei CurseForge einmelden, damit wir den Discord nicht zweckentfremden. Ich freue mich über euere Erfahrungsberichte und Fehlerreports.

BIN
twitch/channels-de.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

BIN
twitch/channels-en.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

BIN
twitch/example-de.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

BIN
twitch/example-en.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

BIN
twitch/example-list-de.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

BIN
twitch/example-list-en.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 129 KiB

BIN
twitch/grichelde.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

BIN
twitch/help-de.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 208 KiB

BIN
twitch/help-en.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 198 KiB

View File

@@ -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"

BIN
twitch/logo.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

BIN
twitch/logo.pptx Normal file

Binary file not shown.

BIN
twitch/minimap-icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

BIN
twitch/profiles-de.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

BIN
twitch/profiles-en.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 107 KiB

BIN
twitch/replacements1-de.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

BIN
twitch/replacements1-en.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

BIN
twitch/replacements2-de.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

BIN
twitch/replacements2-en.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 KiB

BIN
twitch/send-errors.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

BIN
twitch/show-mappings.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

BIN
twitch/text-okay.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.7 KiB