Mercurial > wow > wowdb-profiler

annotate Comments.lua @ 260:3558ba83eacd

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