Mercurial > wow > wowdb-profiler

annotate Comments.lua @ 261:2f493bc054e5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added support for quest comments. Left-justified the text of the link dialog box as well as highlighting the name of the comment subject.
author James D. Callahan III <jcallahan@curse.com>
date Tue, 19 Mar 2013 12:29:24 -0500
parents 3558ba83eacd
children 7f5982e01953
rev   line source
jcallahan@249 1 -- LUA API ------------------------------------------------------------
jcallahan@249 2
jcallahan@249 3 local _G = getfenv(0)
jcallahan@249 4
jcallahan@249 5 local table = _G.table
jcallahan@249 6
jcallahan@249 7 -- ADDON NAMESPACE ----------------------------------------------------
jcallahan@249 8
jcallahan@249 9 local ADDON_NAME, private = ...
jcallahan@249 10
jcallahan@249 11 local LibStub = _G.LibStub
jcallahan@249 12 local WDP = LibStub("AceAddon-3.0"):GetAddon(ADDON_NAME)
jcallahan@259 13 local Dialog = LibStub("LibDialog-1.0")
jcallahan@249 14
jcallahan@249 15 local ParseGUID = private.ParseGUID
jcallahan@260 16 local ItemLinkToID = private.ItemLinkToID
jcallahan@249 17
jcallahan@258 18 -- CONSTANTS ----------------------------------------------------------
jcallahan@258 19
jcallahan@258 20 local EDIT_MAXCHARS = 3000
jcallahan@259 21 local EDIT_DESCRIPTION_FORMAT = "Enter your comment below, being as descriptive as possible. Comments are limited to %s characters, including newlines and spaces."
jcallahan@259 22 local LINK_COMMENT_TOOLTIP = "Click here to create a link to the comment page on WoWDB."
jcallahan@261 23 local LINK_EDITBOX_DESC_FORMAT = "Copy the highlighted text and paste it into your browser to visit the comments for |cffffd200%s|r."
jcallahan@259 24
jcallahan@259 25 local URL_BASE = "http://www.wowdb.com/"
jcallahan@259 26
jcallahan@259 27 local URL_TYPE_MAP = {
jcallahan@259 28 ITEM = "items",
jcallahan@259 29 OBJECT = "objects",
jcallahan@259 30 NPC = "npcs",
jcallahan@261 31 QUEST = "quests",
jcallahan@260 32 SPELL = "spells",
jcallahan@259 33 VEHICLE = "npcs",
jcallahan@259 34 }
jcallahan@259 35
jcallahan@259 36 Dialog:Register("WDP_CommentLink", {
jcallahan@259 37 text = "",
jcallahan@259 38 editboxes = {
jcallahan@259 39 {
jcallahan@259 40 text = _G.UNKNOWN,
jcallahan@259 41 on_escape_pressed = function(self)
jcallahan@259 42 self:ClearFocus()
jcallahan@259 43 end,
jcallahan@259 44 },
jcallahan@259 45 },
jcallahan@259 46 buttons = {
jcallahan@259 47 {
jcallahan@259 48 text = _G.OKAY,
jcallahan@259 49 }
jcallahan@259 50 },
jcallahan@259 51 show_while_dead = true,
jcallahan@259 52 hide_on_escape = true,
jcallahan@259 53 is_exclusive = true,
jcallahan@259 54 on_show = function(self, data)
jcallahan@259 55 local editbox = self.editboxes[1]
jcallahan@259 56 editbox:SetWidth(self:GetWidth() - 20)
jcallahan@259 57 editbox:SetText(("%s%s/%d#related:comments"):format(URL_BASE, URL_TYPE_MAP[data.type_name], data.id))
jcallahan@259 58 editbox:HighlightText()
jcallahan@259 59 editbox:SetFocus()
jcallahan@259 60
jcallahan@261 61 self.text:SetJustifyH("LEFT")
jcallahan@259 62 self.text:SetFormattedText(LINK_EDITBOX_DESC_FORMAT:format(data.label))
jcallahan@259 63 end,
jcallahan@259 64 })
jcallahan@259 65
jcallahan@259 66 local comment_subject = {}
jcallahan@258 67
jcallahan@249 68 -- HELPERS ------------------------------------------------------------
jcallahan@249 69
jcallahan@249 70 local comment_frame
jcallahan@249 71 do
jcallahan@249 72 local panel = _G.CreateFrame("Frame", "WDP_CommentFrame", _G.UIParent, "TranslucentFrameTemplate")
jcallahan@258 73 panel:SetSize(480, 350)
jcallahan@249 74 panel:SetPoint("CENTER", _G.UIParent, "CENTER")
jcallahan@249 75 panel:SetFrameStrata("DIALOG")
jcallahan@249 76 panel.Bg:SetTexture([[Interface\FrameGeneral\UI-Background-Rock]], true, true)
jcallahan@249 77 panel.Bg:SetHorizTile(true)
jcallahan@249 78 panel.Bg:SetVertTile(true)
jcallahan@249 79 panel:Hide()
jcallahan@249 80 comment_frame = panel
jcallahan@249 81
jcallahan@249 82 table.insert(_G.UISpecialFrames, panel:GetName())
jcallahan@249 83
jcallahan@249 84 local streaks = panel:CreateTexture("$parentTopTileStreaks", "BORDER", "_UI-Frame-TopTileStreaks", -6)
jcallahan@249 85 streaks:SetPoint("TOPLEFT", 13, -13)
jcallahan@249 86 streaks:SetPoint("BOTTOMRIGHT", panel, "TOPRIGHT", -13, -35)
jcallahan@249 87
jcallahan@249 88 local header = _G.CreateFrame("Frame", "$parentHeader", panel, "TranslucentFrameTemplate")
jcallahan@249 89 header:SetSize(128, 64)
jcallahan@249 90 header:SetPoint("CENTER", panel, "TOP", 0, -8)
jcallahan@249 91 header.Bg:SetTexture([[Interface\FrameGeneral\UI-Background-Marble]])
jcallahan@249 92 header.Bg:SetHorizTile(true)
jcallahan@249 93 header.Bg:SetVertTile(true)
jcallahan@249 94 panel.header = header
jcallahan@249 95
jcallahan@249 96 local logo = header:CreateTexture(nil, "ARTWORK")
jcallahan@249 97 logo:SetTexture([[Interface\AddOns\WoWDBProfiler\wowdb-logo]])
jcallahan@249 98 logo:SetPoint("TOPLEFT", header, 10, -10)
jcallahan@249 99 logo:SetPoint("BOTTOMRIGHT", header, -10, 10)
jcallahan@249 100
jcallahan@258 101 local subject_name = panel:CreateFontString(nil, "ARTWORK", "GameFontNormal")
jcallahan@258 102 subject_name:SetPoint("TOP", header, "BOTTOM", 0, -10)
jcallahan@258 103 panel.subject_name = subject_name
jcallahan@258 104
jcallahan@258 105 local subject_data = panel:CreateFontString(nil, "ARTWORK", "GameFontNormal")
jcallahan@258 106 subject_data:SetPoint("TOP", subject_name, "BOTTOM", 0, -3)
jcallahan@258 107 panel.subject_data = subject_data
jcallahan@249 108
jcallahan@249 109 local close = _G.CreateFrame("Button", nil, panel, "UIPanelCloseButton")
jcallahan@249 110 close:SetPoint("TOPRIGHT", panel, "TOPRIGHT", -7, -7)
jcallahan@249 111
jcallahan@249 112 local scroll_frame = _G.CreateFrame("ScrollFrame", "$parentScrollFrame", panel)
jcallahan@249 113 scroll_frame:SetSize(435, 150)
jcallahan@249 114 scroll_frame:SetPoint("BOTTOM", 0, 70)
jcallahan@249 115
jcallahan@249 116 scroll_frame:SetScript("OnScrollRangeChanged", function(self, x, y)
jcallahan@249 117 _G.ScrollFrame_OnScrollRangeChanged(self, x, y)
jcallahan@249 118 end)
jcallahan@249 119
jcallahan@249 120 scroll_frame:SetScript("OnVerticalScroll", function(self, offset)
jcallahan@249 121 local scrollbar = self.ScrollBar
jcallahan@249 122 scrollbar:SetValue(offset)
jcallahan@249 123
jcallahan@249 124 local min, max = scrollbar:GetMinMaxValues()
jcallahan@249 125
jcallahan@249 126 if offset == 0 then
jcallahan@249 127 scrollbar.ScrollUpButton:Disable()
jcallahan@249 128 else
jcallahan@249 129 scrollbar.ScrollUpButton:Enable()
jcallahan@249 130 end
jcallahan@249 131
jcallahan@249 132 if (scrollbar:GetValue() - max) == 0 then
jcallahan@249 133 scrollbar.ScrollDownButton:Disable()
jcallahan@249 134 else
jcallahan@249 135 scrollbar.ScrollDownButton:Enable()
jcallahan@249 136 end
jcallahan@249 137 end)
jcallahan@249 138
jcallahan@249 139 scroll_frame:SetScript("OnMouseWheel", function(self, delta)
jcallahan@249 140 _G.ScrollFrameTemplate_OnMouseWheel(self, delta)
jcallahan@249 141 end)
jcallahan@249 142
jcallahan@258 143 panel.scroll_frame = scroll_frame
jcallahan@258 144
jcallahan@249 145 local edit_container = _G.CreateFrame("Frame", nil, scroll_frame)
jcallahan@249 146 edit_container:SetPoint("TOPLEFT", scroll_frame, -7, 7)
jcallahan@249 147 edit_container:SetPoint("BOTTOMRIGHT", scroll_frame, 7, -7)
jcallahan@249 148 edit_container:SetFrameLevel(scroll_frame:GetFrameLevel() - 1)
jcallahan@249 149 edit_container:SetBackdrop({
jcallahan@249 150 bgFile = [[Interface\Tooltips\UI-Tooltip-Background]],
jcallahan@249 151 edgeFile = [[Interface\Tooltips\UI-Tooltip-Border]],
jcallahan@249 152 tile = true,
jcallahan@249 153 tileSize = 16,
jcallahan@249 154 edgeSize = 16,
jcallahan@249 155 insets = {
jcallahan@249 156 left = 5,
jcallahan@249 157 right = 5,
jcallahan@249 158 top = 5,
jcallahan@249 159 bottom = 5
jcallahan@249 160 }
jcallahan@249 161 })
jcallahan@249 162
jcallahan@249 163 edit_container:SetBackdropBorderColor(_G.TOOLTIP_DEFAULT_COLOR.r, _G.TOOLTIP_DEFAULT_COLOR.g, _G.TOOLTIP_DEFAULT_COLOR.b)
jcallahan@249 164 edit_container:SetBackdropColor(0, 0, 0)
jcallahan@249 165
jcallahan@259 166 local link_button = _G.CreateFrame("Button", "$parentLinkButton", panel)
jcallahan@259 167 link_button:SetSize(32, 16)
jcallahan@259 168 link_button:SetPoint("TOPRIGHT", edit_container, "BOTTOMRIGHT", 5, 0)
jcallahan@259 169
jcallahan@259 170 link_button:SetNormalTexture([[Interface\TradeSkillFrame\UI-TradeSkill-LinkButton]])
jcallahan@259 171 link_button:GetNormalTexture():SetTexCoord(0, 1, 0, 0.5)
jcallahan@259 172
jcallahan@259 173 link_button:SetHighlightTexture([[Interface\TradeSkillFrame\UI-TradeSkill-LinkButton]])
jcallahan@259 174 link_button:GetHighlightTexture():SetTexCoord(0, 1, 0.5, 1)
jcallahan@259 175
jcallahan@259 176 link_button:SetScript("OnClick", function(self)
jcallahan@259 177 Dialog:Spawn("WDP_CommentLink", { type_name = comment_subject.type_name, id = comment_subject.id, label = comment_subject.label })
jcallahan@259 178 end)
jcallahan@259 179
jcallahan@259 180 link_button:SetScript("OnEnter", function(self)
jcallahan@259 181 _G.GameTooltip:SetOwner(self, "ANCHOR_TOPLEFT")
jcallahan@259 182 _G.GameTooltip:SetText(LINK_COMMENT_TOOLTIP, nil, nil, nil, nil, 1)
jcallahan@259 183 _G.GameTooltip:Show()
jcallahan@259 184 end)
jcallahan@259 185
jcallahan@259 186 link_button:SetScript("OnLeave", _G.GameTooltip_Hide)
jcallahan@259 187
jcallahan@258 188 local edit_description = edit_container:CreateFontString("MUFASA", "ARTWORK", "GameFontHighlight")
jcallahan@258 189 edit_description:SetHeight(36)
jcallahan@258 190 edit_description:SetPoint("BOTTOMLEFT", edit_container, "TOPLEFT", 5, 3)
jcallahan@258 191 edit_description:SetPoint("BOTTOMRIGHT", edit_container, "TOPRIGHT", 5, 3)
jcallahan@258 192 edit_description:SetFormattedText(EDIT_DESCRIPTION_FORMAT, _G.BreakUpLargeNumbers(EDIT_MAXCHARS))
jcallahan@258 193 edit_description:SetWordWrap(true)
jcallahan@258 194 edit_description:SetJustifyH("LEFT")
jcallahan@258 195
jcallahan@249 196 local edit_box = _G.CreateFrame("EditBox", nil, scroll_frame)
jcallahan@249 197 edit_box:SetMultiLine(true)
jcallahan@258 198 edit_box:SetMaxLetters(EDIT_MAXCHARS)
jcallahan@249 199 edit_box:EnableMouse(true)
jcallahan@249 200 edit_box:SetAutoFocus(false)
jcallahan@249 201 edit_box:SetFontObject("ChatFontNormal")
jcallahan@249 202 edit_box:SetSize(420, 220)
jcallahan@249 203 edit_box:HighlightText(0)
jcallahan@258 204 edit_box:SetFrameLevel(scroll_frame:GetFrameLevel() - 1)
jcallahan@249 205
jcallahan@249 206 edit_box:SetScript("OnCursorChanged", _G.ScrollingEdit_OnCursorChanged)
jcallahan@249 207 edit_box:SetScript("OnEscapePressed", _G.EditBox_ClearFocus)
jcallahan@249 208 edit_box:SetScript("OnShow", function(self)
jcallahan@249 209 _G.EditBox_SetFocus(self)
jcallahan@249 210
jcallahan@249 211 if self:GetNumLetters() > 0 then
jcallahan@249 212 panel.submitButton:Enable()
jcallahan@249 213 else
jcallahan@249 214 panel.submitButton:Disable()
jcallahan@249 215 end
jcallahan@249 216 end)
jcallahan@249 217
jcallahan@249 218 edit_box:SetScript("OnTextChanged", function(self, user_input)
jcallahan@249 219 local parent = self:GetParent()
jcallahan@249 220 local num_letters = self:GetNumLetters()
jcallahan@249 221 _G.ScrollingEdit_OnTextChanged(self, parent)
jcallahan@258 222 parent.charCount:SetFormattedText(_G.BreakUpLargeNumbers(self:GetMaxLetters() - num_letters))
jcallahan@249 223
jcallahan@249 224 if num_letters > 0 then
jcallahan@249 225 panel.submitButton:Enable();
jcallahan@258 226 else
jcallahan@258 227 panel.submitButton:Disable()
jcallahan@249 228 end
jcallahan@249 229 end)
jcallahan@249 230
jcallahan@249 231 edit_box:SetScript("OnUpdate", function(self, elapsed)
jcallahan@249 232 _G.ScrollingEdit_OnUpdate(self, elapsed, self:GetParent())
jcallahan@249 233 end)
jcallahan@249 234
jcallahan@258 235 edit_container:SetScript("OnMouseUp", function()
jcallahan@258 236 _G.EditBox_SetFocus(edit_box)
jcallahan@258 237 end)
jcallahan@258 238
jcallahan@258 239 scroll_frame.edit_box = edit_box
jcallahan@249 240 scroll_frame:SetScrollChild(edit_box)
jcallahan@249 241
jcallahan@249 242 local char_count = scroll_frame:CreateFontString(nil, "OVERLAY", "GameFontDisableLarge")
jcallahan@249 243 char_count:SetPoint("BOTTOMRIGHT", -15, 0)
jcallahan@249 244 scroll_frame.charCount = char_count
jcallahan@249 245
jcallahan@249 246 local scroll_bar = _G.CreateFrame("Slider", "$parentScrollBar", scroll_frame, "UIPanelScrollBarTemplate")
jcallahan@249 247 scroll_bar:SetPoint("TOPLEFT", scroll_frame, "TOPRIGHT", -13, -16)
jcallahan@249 248 scroll_bar:SetPoint("BOTTOMLEFT", scroll_frame, "BOTTOMRIGHT", -13, 16)
jcallahan@249 249 scroll_frame.ScrollBar = scroll_bar
jcallahan@249 250
jcallahan@249 251 _G.ScrollFrame_OnLoad(scroll_frame)
jcallahan@249 252
jcallahan@249 253 local submit = _G.CreateFrame("Button", "$parentSubmit", panel, "GameMenuButtonTemplate")
jcallahan@249 254 submit:SetSize(160, 30)
jcallahan@249 255 submit:SetPoint("BOTTOM", 0, 15)
jcallahan@249 256 submit:SetText(_G.SUBMIT)
jcallahan@249 257 submit:Enable(false)
jcallahan@249 258
jcallahan@249 259 submit:SetScript("OnClick", function()
jcallahan@249 260 -- TODO: Make this assign the comment to the correct SavedVariables entry.
jcallahan@249 261 edit_box:SetText("")
jcallahan@249 262 _G.HideUIPanel(panel)
jcallahan@249 263 end)
jcallahan@249 264 panel.submitButton = submit
jcallahan@249 265 end
jcallahan@249 266
jcallahan@260 267 local function CreateUnitComment(unit_id)
jcallahan@260 268 if not _G.UnitExists(unit_id) then
jcallahan@260 269 WDP:Printf("Unit '%s' does not exist.", unit_id)
jcallahan@260 270 return
jcallahan@260 271 end
jcallahan@260 272 local unit_type, unit_idnum = ParseGUID(_G.UnitGUID(unit_id))
jcallahan@260 273
jcallahan@260 274 if not unit_idnum then
jcallahan@260 275 WDP:Printf("Unable to determine unit from '%s'", unit_id)
jcallahan@260 276 return
jcallahan@260 277 end
jcallahan@259 278 local type_name = private.UNIT_TYPE_NAMES[unit_type + 1]
jcallahan@259 279 local unit_name = _G.UnitName(unit_id)
jcallahan@259 280 comment_subject.type_name = type_name
jcallahan@259 281 comment_subject.id = unit_idnum
jcallahan@259 282 comment_subject.label = unit_name
jcallahan@259 283
jcallahan@259 284 comment_frame.subject_name:SetText(unit_name)
jcallahan@259 285 comment_frame.subject_data:SetFormattedText("(%s #%d)", type_name, unit_idnum)
jcallahan@258 286 comment_frame.scroll_frame.edit_box:SetText("")
jcallahan@249 287 comment_frame:Show()
jcallahan@249 288 end
jcallahan@249 289
jcallahan@260 290 local DATA_TYPE_MAPPING = {
jcallahan@260 291 merchant = "ITEM",
jcallahan@260 292 }
jcallahan@260 293
jcallahan@260 294 local CURSOR_DATA_FUNCS = {
jcallahan@260 295 item = function(data_type, data, data_subtype)
jcallahan@260 296 local item_name = _G.GetItemInfo(data)
jcallahan@260 297 comment_subject.type_name = data_type
jcallahan@260 298 comment_subject.id = data
jcallahan@260 299 comment_subject.label = item_name
jcallahan@260 300
jcallahan@260 301 comment_frame.subject_name:SetText(item_name)
jcallahan@260 302 comment_frame.subject_data:SetFormattedText("(%s #%d)", data_type, data)
jcallahan@260 303 end,
jcallahan@260 304 merchant = function(data_type, data)
jcallahan@260 305 local item_link = _G.GetMerchantItemLink(data)
jcallahan@260 306 local item_name = _G.GetItemInfo(item_link)
jcallahan@260 307 local item_id = ItemLinkToID(item_link)
jcallahan@260 308 comment_subject.type_name = data_type
jcallahan@260 309 comment_subject.id = item_id
jcallahan@260 310 comment_subject.label = item_name
jcallahan@260 311
jcallahan@260 312 comment_frame.subject_name:SetText(item_name)
jcallahan@260 313 comment_frame.subject_data:SetFormattedText("(%s #%d)", data_type, item_id)
jcallahan@260 314 end,
jcallahan@260 315 spell = function(data_type, data, data_subtype, subdata)
jcallahan@260 316 local spell_name = _G.GetSpellInfo(subdata)
jcallahan@260 317 comment_subject.type_name = data_type
jcallahan@260 318 comment_subject.id = subdata
jcallahan@260 319 comment_subject.label = spell_name
jcallahan@260 320
jcallahan@260 321 comment_frame.subject_name:SetText(spell_name)
jcallahan@260 322 comment_frame.subject_data:SetFormattedText("(%s #%d)", data_type, subdata)
jcallahan@260 323 end,
jcallahan@260 324 }
jcallahan@260 325
jcallahan@249 326 local function CreateCursorComment()
jcallahan@260 327 local data_type, data, data_subtype, subdata = _G.GetCursorInfo()
jcallahan@260 328
jcallahan@260 329 if not CURSOR_DATA_FUNCS[data_type] then
jcallahan@260 330 WDP:Print("Unable to determine comment subject from cursor.")
jcallahan@260 331 return
jcallahan@260 332 end
jcallahan@260 333 CURSOR_DATA_FUNCS[data_type](DATA_TYPE_MAPPING[data_type] or data_type:upper(), data, data_subtype, subdata)
jcallahan@260 334 comment_frame.scroll_frame.edit_box:SetText("")
jcallahan@260 335 comment_frame:Show()
jcallahan@249 336 end
jcallahan@249 337
jcallahan@261 338 local function CreateQuestComment()
jcallahan@261 339 local index = _G.GetQuestLogSelection()
jcallahan@261 340
jcallahan@261 341 if not index or not _G.QuestLogFrame:IsShown() then
jcallahan@261 342 WDP:Print("You must select a quest from the Quest frame.")
jcallahan@261 343 return
jcallahan@261 344 end
jcallahan@261 345 local title, _, tag, _, is_header, _, _, _, idnum = _G.GetQuestLogTitle(index)
jcallahan@261 346
jcallahan@261 347 if is_header then
jcallahan@261 348 WDP:Print("You must select a quest from the Quest frame.")
jcallahan@261 349 return
jcallahan@261 350 end
jcallahan@261 351 comment_subject.type_name = "QUEST"
jcallahan@261 352 comment_subject.id = idnum
jcallahan@261 353 comment_subject.label = title
jcallahan@261 354
jcallahan@261 355 comment_frame.subject_name:SetText(title)
jcallahan@261 356 comment_frame.subject_data:SetFormattedText("(%s #%d)", "QUEST", idnum)
jcallahan@261 357 comment_frame.scroll_frame.edit_box:SetText("")
jcallahan@261 358 comment_frame:Show()
jcallahan@261 359 end
jcallahan@261 360
jcallahan@249 361 -- METHODS ------------------------------------------------------------
jcallahan@249 362
jcallahan@249 363 function private.ProcessCommentCommand(arg)
jcallahan@249 364 if not arg or arg == "" then
jcallahan@249 365 WDP:Print("You must supply a valid comment type.")
jcallahan@249 366 return
jcallahan@249 367 end
jcallahan@249 368
jcallahan@249 369 if arg == "cursor" then
jcallahan@260 370 CreateCursorComment()
jcallahan@249 371 return
jcallahan@261 372 elseif arg == "quest" then
jcallahan@261 373 CreateQuestComment()
jcallahan@261 374 return
jcallahan@249 375 end
jcallahan@260 376 CreateUnitComment(arg)
jcallahan@249 377 end