Mercurial > wow > hansgar_and_franzok_assist

annotate Libs/LibSharedMedia-3.0/LibSharedMedia-3.0.lua @ 63:3552946c0b9a tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag v8.2.0.062 for changeset d6704922ef5d
author Tercioo
date Fri, 28 Jun 2019 20:06:18 -0300
parents 0682d738499b
children
rev   line source
Tercio@23 1 --[[
Tercio@23 2 Name: LibSharedMedia-3.0
Tercio@58 3 Revision: $Revision: 91 $
Tercio@23 4 Author: Elkano (elkano@gmx.de)
Tercio@23 5 Inspired By: SurfaceLib by Haste/Otravi (troeks@gmail.com)
Tercio@23 6 Website: http://www.wowace.com/projects/libsharedmedia-3-0/
Tercio@23 7 Description: Shared handling of media data (fonts, sounds, textures, ...) between addons.
Tercio@23 8 Dependencies: LibStub, CallbackHandler-1.0
Tercio@23 9 License: LGPL v2.1
Tercio@23 10 ]]
Tercio@23 11
Tercio@58 12 local MAJOR, MINOR = "LibSharedMedia-3.0", 6010002 -- 6.1.0 v2 / increase manually on changes
Tercio@23 13 local lib = LibStub:NewLibrary(MAJOR, MINOR)
Tercio@23 14
Tercio@23 15 if not lib then return end
Tercio@23 16
Tercio@23 17 local _G = getfenv(0)
Tercio@23 18
Tercio@23 19 local pairs = _G.pairs
Tercio@23 20 local type = _G.type
Tercio@23 21
Tercio@23 22 local band = _G.bit.band
Tercio@23 23
Tercio@23 24 local table_insert = _G.table.insert
Tercio@23 25 local table_sort = _G.table.sort
Tercio@23 26
Tercio@23 27 local locale = GetLocale()
Tercio@23 28 local locale_is_western
Tercio@23 29 local LOCALE_MASK = 0
Tercio@23 30 lib.LOCALE_BIT_koKR = 1
Tercio@23 31 lib.LOCALE_BIT_ruRU = 2
Tercio@23 32 lib.LOCALE_BIT_zhCN = 4
Tercio@23 33 lib.LOCALE_BIT_zhTW = 8
Tercio@23 34 lib.LOCALE_BIT_western = 128
Tercio@23 35
Tercio@23 36 local CallbackHandler = LibStub:GetLibrary("CallbackHandler-1.0")
Tercio@23 37
Tercio@23 38 lib.callbacks = lib.callbacks or CallbackHandler:New(lib)
Tercio@23 39
Tercio@23 40 lib.DefaultMedia = lib.DefaultMedia or {}
Tercio@23 41 lib.MediaList = lib.MediaList or {}
Tercio@23 42 lib.MediaTable = lib.MediaTable or {}
Tercio@23 43 lib.MediaType = lib.MediaType or {}
Tercio@23 44 lib.OverrideMedia = lib.OverrideMedia or {}
Tercio@23 45
Tercio@23 46 local defaultMedia = lib.DefaultMedia
Tercio@23 47 local mediaList = lib.MediaList
Tercio@23 48 local mediaTable = lib.MediaTable
Tercio@23 49 local overrideMedia = lib.OverrideMedia
Tercio@23 50
Tercio@23 51
Tercio@23 52 -- create mediatype constants
Tercio@23 53 lib.MediaType.BACKGROUND = "background" -- background textures
Tercio@23 54 lib.MediaType.BORDER = "border" -- border textures
Tercio@23 55 lib.MediaType.FONT = "font" -- fonts
Tercio@23 56 lib.MediaType.STATUSBAR = "statusbar" -- statusbar textures
Tercio@23 57 lib.MediaType.SOUND = "sound" -- sound files
Tercio@23 58
Tercio@23 59 -- populate lib with default Blizzard data
Tercio@23 60 -- BACKGROUND
Tercio@23 61 if not lib.MediaTable.background then lib.MediaTable.background = {} end
Tercio@23 62 lib.MediaTable.background["None"] = [[]]
Tercio@58 63 lib.MediaTable.background["Blizzard Collections Background"] = [[Interface\Collections\CollectionsBackgroundTile]]
Tercio@23 64 lib.MediaTable.background["Blizzard Dialog Background"] = [[Interface\DialogFrame\UI-DialogBox-Background]]
Tercio@23 65 lib.MediaTable.background["Blizzard Dialog Background Dark"] = [[Interface\DialogFrame\UI-DialogBox-Background-Dark]]
Tercio@23 66 lib.MediaTable.background["Blizzard Dialog Background Gold"] = [[Interface\DialogFrame\UI-DialogBox-Gold-Background]]
Tercio@58 67 lib.MediaTable.background["Blizzard Garrison Background"] = [[Interface\Garrison\GarrisonUIBackground]]
Tercio@58 68 lib.MediaTable.background["Blizzard Garrison Background 2"] = [[Interface\Garrison\GarrisonUIBackground2]]
Tercio@58 69 lib.MediaTable.background["Blizzard Garrison Background 3"] = [[Interface\Garrison\GarrisonMissionUIInfoBoxBackgroundTile]]
Tercio@23 70 lib.MediaTable.background["Blizzard Low Health"] = [[Interface\FullScreenTextures\LowHealth]]
Tercio@23 71 lib.MediaTable.background["Blizzard Marble"] = [[Interface\FrameGeneral\UI-Background-Marble]]
Tercio@23 72 lib.MediaTable.background["Blizzard Out of Control"] = [[Interface\FullScreenTextures\OutOfControl]]
Tercio@23 73 lib.MediaTable.background["Blizzard Parchment"] = [[Interface\AchievementFrame\UI-Achievement-Parchment-Horizontal]]
Tercio@23 74 lib.MediaTable.background["Blizzard Parchment 2"] = [[Interface\AchievementFrame\UI-GuildAchievement-Parchment-Horizontal]]
Tercio@23 75 lib.MediaTable.background["Blizzard Rock"] = [[Interface\FrameGeneral\UI-Background-Rock]]
Tercio@23 76 lib.MediaTable.background["Blizzard Tabard Background"] = [[Interface\TabardFrame\TabardFrameBackground]]
Tercio@23 77 lib.MediaTable.background["Blizzard Tooltip"] = [[Interface\Tooltips\UI-Tooltip-Background]]
Tercio@23 78 lib.MediaTable.background["Solid"] = [[Interface\Buttons\WHITE8X8]]
Tercio@23 79 lib.DefaultMedia.background = "None"
Tercio@23 80
Tercio@23 81 -- BORDER
Tercio@23 82 if not lib.MediaTable.border then lib.MediaTable.border = {} end
Tercio@23 83 lib.MediaTable.border["None"] = [[]]
Tercio@23 84 lib.MediaTable.border["Blizzard Achievement Wood"] = [[Interface\AchievementFrame\UI-Achievement-WoodBorder]]
Tercio@23 85 lib.MediaTable.border["Blizzard Chat Bubble"] = [[Interface\Tooltips\ChatBubble-Backdrop]]
Tercio@23 86 lib.MediaTable.border["Blizzard Dialog"] = [[Interface\DialogFrame\UI-DialogBox-Border]]
Tercio@23 87 lib.MediaTable.border["Blizzard Dialog Gold"] = [[Interface\DialogFrame\UI-DialogBox-Gold-Border]]
Tercio@23 88 lib.MediaTable.border["Blizzard Party"] = [[Interface\CHARACTERFRAME\UI-Party-Border]]
Tercio@23 89 lib.MediaTable.border["Blizzard Tooltip"] = [[Interface\Tooltips\UI-Tooltip-Border]]
Tercio@23 90 lib.DefaultMedia.border = "None"
Tercio@23 91
Tercio@23 92 -- FONT
Tercio@23 93 if not lib.MediaTable.font then lib.MediaTable.font = {} end
Tercio@23 94 local SML_MT_font = lib.MediaTable.font
Tercio@58 95 --[[
Tercio@58 96 All font files are currently in all clients, the following table depicts which font supports which charset as of 5.0.4
Tercio@58 97 Fonts were checked using langcover.pl from DejaVu fonts (http://sourceforge.net/projects/dejavu/) and FontForge (http://fontforge.org/)
Tercio@58 98 latin means check for: de, en, es, fr, it, pt
Tercio@58 99
Tercio@58 100 file name latin koKR ruRU zhCN zhTW
Tercio@58 101 2002.ttf 2002 X X X - -
Tercio@58 102 2002B.ttf 2002 Bold X X X - -
Tercio@58 103 ARHei.ttf AR CrystalzcuheiGBK Demibold X - X X X
Tercio@58 104 ARIALN.TTF Arial Narrow X - X - -
Tercio@58 105 ARKai_C.ttf AR ZhongkaiGBK Medium (Combat) X - X X X
Tercio@58 106 ARKai_T.ttf AR ZhongkaiGBK Medium X - X X X
Tercio@58 107 bHEI00M.ttf AR Heiti2 Medium B5 - - - - X
Tercio@58 108 bHEI01B.ttf AR Heiti2 Bold B5 - - - - X
Tercio@58 109 bKAI00M.ttf AR Kaiti Medium B5 - - - - X
Tercio@58 110 bLEI00D.ttf AR Leisu Demi B5 - - - - X
Tercio@58 111 FRIZQT__.TTF Friz Quadrata TT X - - - -
Tercio@58 112 FRIZQT___CYR.TTF FrizQuadrataCTT x - X - -
Tercio@58 113 K_Damage.TTF YDIWingsM - X X - -
Tercio@58 114 K_Pagetext.TTF MoK X X X - -
Tercio@58 115 MORPHEUS.TTF Morpheus X - - - -
Tercio@58 116 MORPHEUS_CYR.TTF Morpheus X - X - -
Tercio@58 117 NIM_____.ttf Nimrod MT X - X - -
Tercio@58 118 SKURRI.TTF Skurri X - - - -
Tercio@58 119 SKURRI_CYR.TTF Skurri X - X - -
Tercio@58 120
Tercio@58 121 WARNING: Although FRIZQT___CYR is available on western clients, it doesn't support special European characters e.g. é, ï, ö
Tercio@58 122 Due to this, we cannot use it as a replacement for FRIZQT__.TTF
Tercio@58 123 ]]
Tercio@58 124
Tercio@23 125 if locale == "koKR" then
Tercio@23 126 LOCALE_MASK = lib.LOCALE_BIT_koKR
Tercio@23 127 --
Tercio@23 128 SML_MT_font["굵은 글꼴"] = [[Fonts\2002B.TTF]]
Tercio@23 129 SML_MT_font["기본 글꼴"] = [[Fonts\2002.TTF]]
Tercio@23 130 SML_MT_font["데미지 글꼴"] = [[Fonts\K_Damage.TTF]]
Tercio@23 131 SML_MT_font["퀘스트 글꼴"] = [[Fonts\K_Pagetext.TTF]]
Tercio@23 132 --
Tercio@23 133 lib.DefaultMedia["font"] = "기본 글꼴" -- someone from koKR please adjust if needed
Tercio@23 134 --
Tercio@23 135 elseif locale == "zhCN" then
Tercio@23 136 LOCALE_MASK = lib.LOCALE_BIT_zhCN
Tercio@23 137 --
Tercio@23 138 SML_MT_font["伤害数字"] = [[Fonts\ARKai_C.ttf]]
Tercio@23 139 SML_MT_font["默认"] = [[Fonts\ARKai_T.ttf]]
Tercio@23 140 SML_MT_font["聊天"] = [[Fonts\ARHei.ttf]]
Tercio@23 141 --
Tercio@23 142 lib.DefaultMedia["font"] = "默认" -- someone from zhCN please adjust if needed
Tercio@23 143 --
Tercio@23 144 elseif locale == "zhTW" then
Tercio@23 145 LOCALE_MASK = lib.LOCALE_BIT_zhTW
Tercio@23 146 --
Tercio@23 147 SML_MT_font["提示訊息"] = [[Fonts\bHEI00M.ttf]]
Tercio@23 148 SML_MT_font["聊天"] = [[Fonts\bHEI01B.ttf]]
Tercio@23 149 SML_MT_font["傷害數字"] = [[Fonts\bKAI00M.ttf]]
Tercio@23 150 SML_MT_font["預設"] = [[Fonts\bLEI00D.ttf]]
Tercio@23 151 --
Tercio@23 152 lib.DefaultMedia["font"] = "預設" -- someone from zhTW please adjust if needed
Tercio@23 153
Tercio@23 154 elseif locale == "ruRU" then
Tercio@23 155 LOCALE_MASK = lib.LOCALE_BIT_ruRU
Tercio@23 156 --
Tercio@58 157 SML_MT_font["2002"] = [[Fonts\2002.TTF]]
Tercio@58 158 SML_MT_font["2002 Bold"] = [[Fonts\2002B.TTF]]
Tercio@58 159 SML_MT_font["AR CrystalzcuheiGBK Demibold"] = [[Fonts\ARHei.TTF]]
Tercio@58 160 SML_MT_font["AR ZhongkaiGBK Medium (Combat)"] = [[Fonts\ARKai_C.TTF]]
Tercio@58 161 SML_MT_font["AR ZhongkaiGBK Medium"] = [[Fonts\ARKai_T.TTF]]
Tercio@58 162 SML_MT_font["Arial Narrow"] = [[Fonts\ARIALN.TTF]]
Tercio@58 163 SML_MT_font["Friz Quadrata TT"] = [[Fonts\FRIZQT___CYR.TTF]]
Tercio@58 164 SML_MT_font["MoK"] = [[Fonts\K_Pagetext.TTF]]
Tercio@58 165 SML_MT_font["Morpheus"] = [[Fonts\MORPHEUS_CYR.TTF]]
Tercio@58 166 SML_MT_font["Nimrod MT"] = [[Fonts\NIM_____.ttf]]
Tercio@58 167 SML_MT_font["Skurri"] = [[Fonts\SKURRI_CYR.TTF]]
Tercio@23 168 --
Tercio@23 169 lib.DefaultMedia.font = "Friz Quadrata TT"
Tercio@23 170 --
Tercio@23 171 else
Tercio@23 172 LOCALE_MASK = lib.LOCALE_BIT_western
Tercio@23 173 locale_is_western = true
Tercio@23 174 --
Tercio@58 175 SML_MT_font["2002"] = [[Fonts\2002.TTF]]
Tercio@58 176 SML_MT_font["2002 Bold"] = [[Fonts\2002B.TTF]]
Tercio@58 177 SML_MT_font["AR CrystalzcuheiGBK Demibold"] = [[Fonts\ARHei.TTF]]
Tercio@58 178 SML_MT_font["AR ZhongkaiGBK Medium (Combat)"] = [[Fonts\ARKai_C.TTF]]
Tercio@58 179 SML_MT_font["AR ZhongkaiGBK Medium"] = [[Fonts\ARKai_T.TTF]]
Tercio@58 180 SML_MT_font["Arial Narrow"] = [[Fonts\ARIALN.TTF]]
Tercio@58 181 SML_MT_font["Friz Quadrata TT"] = [[Fonts\FRIZQT__.TTF]]
Tercio@58 182 SML_MT_font["MoK"] = [[Fonts\K_Pagetext.TTF]]
Tercio@58 183 SML_MT_font["Morpheus"] = [[Fonts\MORPHEUS_CYR.TTF]]
Tercio@58 184 SML_MT_font["Nimrod MT"] = [[Fonts\NIM_____.ttf]]
Tercio@58 185 SML_MT_font["Skurri"] = [[Fonts\SKURRI_CYR.TTF]]
Tercio@23 186 --
Tercio@23 187 lib.DefaultMedia.font = "Friz Quadrata TT"
Tercio@23 188 --
Tercio@23 189 end
Tercio@23 190
Tercio@23 191 -- STATUSBAR
Tercio@23 192 if not lib.MediaTable.statusbar then lib.MediaTable.statusbar = {} end
Tercio@23 193 lib.MediaTable.statusbar["Blizzard"] = [[Interface\TargetingFrame\UI-StatusBar]]
Tercio@23 194 lib.MediaTable.statusbar["Blizzard Character Skills Bar"] = [[Interface\PaperDollInfoFrame\UI-Character-Skills-Bar]]
Tercio@58 195 lib.MediaTable.statusbar["Blizzard Raid Bar"] = [[Interface\RaidFrame\Raid-Bar-Hp-Fill]]
Tercio@23 196 lib.DefaultMedia.statusbar = "Blizzard"
Tercio@23 197
Tercio@23 198 -- SOUND
Tercio@23 199 if not lib.MediaTable.sound then lib.MediaTable.sound = {} end
Tercio@23 200 lib.MediaTable.sound["None"] = [[Interface\Quiet.ogg]] -- Relies on the fact that PlaySound[File] doesn't error on non-existing input.
Tercio@23 201 lib.DefaultMedia.sound = "None"
Tercio@23 202
Tercio@23 203 local function rebuildMediaList(mediatype)
Tercio@23 204 local mtable = mediaTable[mediatype]
Tercio@23 205 if not mtable then return end
Tercio@23 206 if not mediaList[mediatype] then mediaList[mediatype] = {} end
Tercio@23 207 local mlist = mediaList[mediatype]
Tercio@23 208 -- list can only get larger, so simply overwrite it
Tercio@23 209 local i = 0
Tercio@23 210 for k in pairs(mtable) do
Tercio@23 211 i = i + 1
Tercio@23 212 mlist[i] = k
Tercio@23 213 end
Tercio@23 214 table_sort(mlist)
Tercio@23 215 end
Tercio@23 216
Tercio@23 217 function lib:Register(mediatype, key, data, langmask)
Tercio@23 218 if type(mediatype) ~= "string" then
Tercio@23 219 error(MAJOR..":Register(mediatype, key, data, langmask) - mediatype must be string, got "..type(mediatype))
Tercio@23 220 end
Tercio@23 221 if type(key) ~= "string" then
Tercio@23 222 error(MAJOR..":Register(mediatype, key, data, langmask) - key must be string, got "..type(key))
Tercio@23 223 end
Tercio@23 224 mediatype = mediatype:lower()
Tercio@58 225 if mediatype == lib.MediaType.FONT and ((langmask and band(langmask, LOCALE_MASK) == 0) or not (langmask or locale_is_western)) then return false end
Tercio@58 226 if mediatype == lib.MediaType.SOUND and type(data) == "string" then
Tercio@58 227 local path = data:lower()
Tercio@58 228 -- Only ogg and mp3 are valid sounds.
Tercio@58 229 if not path:find(".ogg", nil, true) and not path:find(".mp3", nil, true) then
Tercio@58 230 return false
Tercio@58 231 end
Tercio@58 232 end
Tercio@23 233 if not mediaTable[mediatype] then mediaTable[mediatype] = {} end
Tercio@23 234 local mtable = mediaTable[mediatype]
Tercio@23 235 if mtable[key] then return false end
Tercio@23 236
Tercio@23 237 mtable[key] = data
Tercio@23 238 rebuildMediaList(mediatype)
Tercio@23 239 self.callbacks:Fire("LibSharedMedia_Registered", mediatype, key)
Tercio@23 240 return true
Tercio@23 241 end
Tercio@23 242
Tercio@23 243 function lib:Fetch(mediatype, key, noDefault)
Tercio@23 244 local mtt = mediaTable[mediatype]
Tercio@23 245 local overridekey = overrideMedia[mediatype]
Tercio@23 246 local result = mtt and ((overridekey and mtt[overridekey] or mtt[key]) or (not noDefault and defaultMedia[mediatype] and mtt[defaultMedia[mediatype]])) or nil
Tercio@23 247 return result ~= "" and result or nil
Tercio@23 248 end
Tercio@23 249
Tercio@23 250 function lib:IsValid(mediatype, key)
Tercio@23 251 return mediaTable[mediatype] and (not key or mediaTable[mediatype][key]) and true or false
Tercio@23 252 end
Tercio@23 253
Tercio@23 254 function lib:HashTable(mediatype)
Tercio@23 255 return mediaTable[mediatype]
Tercio@23 256 end
Tercio@23 257
Tercio@23 258 function lib:List(mediatype)
Tercio@23 259 if not mediaTable[mediatype] then
Tercio@23 260 return nil
Tercio@23 261 end
Tercio@23 262 if not mediaList[mediatype] then
Tercio@23 263 rebuildMediaList(mediatype)
Tercio@23 264 end
Tercio@23 265 return mediaList[mediatype]
Tercio@23 266 end
Tercio@23 267
Tercio@23 268 function lib:GetGlobal(mediatype)
Tercio@23 269 return overrideMedia[mediatype]
Tercio@23 270 end
Tercio@23 271
Tercio@23 272 function lib:SetGlobal(mediatype, key)
Tercio@23 273 if not mediaTable[mediatype] then
Tercio@23 274 return false
Tercio@23 275 end
Tercio@23 276 overrideMedia[mediatype] = (key and mediaTable[mediatype][key]) and key or nil
Tercio@23 277 self.callbacks:Fire("LibSharedMedia_SetGlobal", mediatype, overrideMedia[mediatype])
Tercio@23 278 return true
Tercio@23 279 end
Tercio@23 280
Tercio@23 281 function lib:GetDefault(mediatype)
Tercio@23 282 return defaultMedia[mediatype]
Tercio@23 283 end
Tercio@23 284
Tercio@23 285 function lib:SetDefault(mediatype, key)
Tercio@23 286 if mediaTable[mediatype] and mediaTable[mediatype][key] and not defaultMedia[mediatype] then
Tercio@23 287 defaultMedia[mediatype] = key
Tercio@23 288 return true
Tercio@23 289 else
Tercio@23 290 return false
Tercio@23 291 end
Tercio@23 292 end