core.lua

-- Ignore some luacheck warnings about global vars, just use a ton of them in WoW Lua
-- luacheck: no global
-- luacheck: no self
local _, Simulationcraft = ...

Simulationcraft = LibStub("AceAddon-3.0"):NewAddon(Simulationcraft, "Simulationcraft", "AceConsole-3.0", "AceEvent-3.0")
LibRealmInfo = LibStub("LibRealmInfo")

-- Set up DataBroker for minimap button
SimcLDB = LibStub("LibDataBroker-1.1"):NewDataObject("SimulationCraft", {
  type = "data source",
  text = "SimulationCraft",
  label = "SimulationCraft",
  icon = "Interface\\AddOns\\SimulationCraft\\logo",
  OnClick = function()
    if SimcFrame and SimcFrame:IsShown() then
      SimcFrame:Hide()
    else
      Simulationcraft:PrintSimcProfile(false, false, false)
    end
  end,
  OnTooltipShow = function(tt)
    tt:AddLine("SimulationCraft")
    tt:AddLine(" ")
    tt:AddLine("Click to show SimC input")
    tt:AddLine("To toggle minimap button, type '/simc minimap'")
  end
})

LibDBIcon = LibStub("LibDBIcon-1.0")

local SimcFrame = nil
local OptionsDB = nil
local SpellCache = {}
local SpellCacheLoaded = false

local OFFSET_ITEM_ID = 1
local OFFSET_ENCHANT_ID = 2
local OFFSET_GEM_ID_1 = 3
-- local OFFSET_GEM_ID_2 = 4
-- local OFFSET_GEM_ID_3 = 5
local OFFSET_GEM_ID_4 = 6
local OFFSET_GEM_BASE = OFFSET_GEM_ID_1
-- local OFFSET_SUFFIX_ID = 7
-- local OFFSET_FLAGS = 11
local OFFSET_CONTEXT = 12
local OFFSET_BONUS_ID = 13

local OFFSET_GEM_BONUS_FROM_MODS = 2

-- Item Modifiers: https://warcraft.wiki.gg/wiki/ItemLink#Item_Modifiers

local ITEM_MOD_TYPE_DROP_LEVEL = 9
-- ContentTuningID: clamps the drop-level scaling to the tuning's level-squish range
local ITEM_MOD_TYPE_CONTENT_TUNING = 28
local ITEM_MOD_TYPE_CRAFT_STATS_1 = 29
local ITEM_MOD_TYPE_CRAFT_STATS_2 = 30
-- 12.1: catalyst items inherit secondary stats from the source item
-- We think this might be the mechanism to do it - it makes sense if this encodes the source item ID.
-- Adding prospectively to see when the functionality shows up on the PTR
local ITEM_MOD_TYPE_REDIRECTED_BASE_STATS = 64

local SUPPORTED_LOADOUT_SERIALIZATION_VERSION = 2

-- Extra C_Traits systems (beyond class talents) to export.
-- Each entry pairs the SimC option name with its trait system ID
-- (the value passed to C_Traits.SetConfigIDBySystemID by the matching Blizzard UI).
local TRAIT_SYSTEMS = {
  { name = 'omnium_talents',         systemID = 48 }, -- 12.0.7 player power
}

local WeeklyRewards         = _G.C_WeeklyRewards

-- New talents for Dragonflight
local ClassTalents          = _G.C_ClassTalents
local Traits                = _G.C_Traits

local IS_FOREVER = Simulationcraft.IS_FOREVER

-- Which optional parts of the profile each game exports. Anything not listed here is
-- exported for both games. Checked as EXPORTS.<name> in GetSimcProfile.
local MODERN_EXPORTS = {
  'spec',                  -- spec in header, # loot_spec=, and the pick-a-spec sanity check
  'trait_systems',        -- omnium_talents and friends from TRAIT_SYSTEMS
  'catalyst_currencies',
  'upgrade_currencies',
  'slot_high_watermarks',
  'upgrade_achievements',
  'bonus_roll_currencies',
  'bonus_roll_items',
}
local FOREVER_EXPORTS = {
  'character_stats',       -- forever/stats.lua
  'skills',
  'buffs',
  'bags',
  'pet',                   -- forever/pet.lua
}
local EXPORTS = {}
for _, name in ipairs(IS_FOREVER and FOREVER_EXPORTS or MODERN_EXPORTS) do
  EXPORTS[name] = true
end

-- GetAddOnMetadata was global until 10.1. It's now in C_AddOns. This line will use C_AddOns if available and work in either WoW build
local GetAddOnMetadata = C_AddOns and C_AddOns.GetAddOnMetadata or GetAddOnMetadata

-- Some global item functions have been moved into C_Item in 11.0
local GetDetailedItemLevelInfo = C_Item and C_Item.GetDetailedItemLevelInfo or GetDetailedItemLevelInfo
local GetItemInfoInstant = C_Item and C_Item.GetItemInfoInstant or GetItemInfoInstant
local GetItemCount = C_Item and C_Item.GetItemCount or GetItemCount

-- Talent loadout export string header layout (see ClassTalentImportExportMixin)
local bitWidthHeaderVersion = 8
local bitWidthSpecID        = 16

-- load stuff from extras.lua
-- local upgradeTable        = Simulationcraft.upgradeTable
local slotNames           = Simulationcraft.slotNames
local simcSlotNames       = Simulationcraft.simcSlotNames
local specNames           = Simulationcraft.SpecNames
local profNames           = Simulationcraft.ProfNames
local regionString        = Simulationcraft.RegionString
local zandalariLoaBuffs   = Simulationcraft.zandalariLoaBuffs

-- Most of the guts of this addon were based on a variety of other ones, including
-- Statslog, AskMrRobot, and BonusScanner. And a bunch of hacking around with AceGUI.
-- Many thanks to the authors of those addons, and to reia for fixing my awful amateur
-- coding mistakes regarding objects and namespaces.

function Simulationcraft:OnInitialize()
  -- init databroker
  OptionsDB = LibStub("AceDB-3.0"):New("SimulationCraftDB", {
    profile = {
      minimap = {
        hide = false,
      },
      closeOnCopy = true,
      offspecLoadouts = false,
      frame = {
        point = "CENTER",
        relativeFrame = nil,
        relativePoint = "CENTER",
        ofsx = 0,
        ofsy = 0,
        width = 750,
        height = 400,
      },
    },
    char = {
      -- array of { season, spec, currency, source, context, keyLevel, itemId, ts } (one per won roll)
      bonusRolls = {},
    },
  });
  -- expose the db on the shared addon table so bonusrolls.lua can reach it
  Simulationcraft.db = OptionsDB
  LibDBIcon:Register("SimulationCraft", SimcLDB, OptionsDB.profile.minimap)
  Simulationcraft:UpdateMinimapButton()
  Simulationcraft:RegisterChatCommand('simc', 'HandleChatCommand')
  AddonCompartmentFrame:RegisterAddon({
    text = "SimulationCraft",
    icon = "Interface\\AddOns\\SimulationCraft\\logo",
    notCheckable = true,
    func = function()
      Simulationcraft:PrintSimcProfile(false, false, false)
    end,
  })
end

function Simulationcraft:OnEnable()
  self:SetupBonusRolls()
end

function Simulationcraft:OnDisable()

end

function Simulationcraft:UpdateMinimapButton()
  if (OptionsDB.profile.minimap.hide) then
    LibDBIcon:Hide("SimulationCraft")
  else
    LibDBIcon:Show("SimulationCraft")
  end
end

local function getLinks(input)
  local separatedLinks = {}
  for link in input:gmatch("|c.-|h|r") do
     separatedLinks[#separatedLinks + 1] = link
  end
  return separatedLinks
end

function Simulationcraft:HandleChatCommand(input)
  local args = {strsplit(' ', input)}

  local debugOutput = false
  local noBags = false
  local showMerchant = false
  local links = getLinks(input)

  for _, arg in ipairs(args) do
    if arg == 'debug' then
      debugOutput = true
    elseif arg == 'nobag' or arg == 'nobags' or arg == 'nb' then
      noBags = true
    elseif arg == 'merchant' then
      showMerchant = true
    elseif arg == 'minimap' then
      OptionsDB.profile.minimap.hide = not OptionsDB.profile.minimap.hide
      DEFAULT_CHAT_FRAME:AddMessage(
        "SimulationCraft: Minimap button is now " .. (OptionsDB.profile.minimap.hide and "hidden" or "shown")
      )
      Simulationcraft:UpdateMinimapButton()
      return
    end
  end

  self:PrintSimcProfile(debugOutput, noBags, showMerchant, links)
end


local function GetItemSplit(itemLink)
  local itemString = string.match(itemLink, "item:([%-?%d:]+)")
  local itemSplit = {}

  -- Split data into a table
  for _, v in ipairs({strsplit(":", itemString)}) do
    if v == "" then
      itemSplit[#itemSplit + 1] = 0
    else
      itemSplit[#itemSplit + 1] = tonumber(v)
    end
  end

  return itemSplit
end
-- expose the item-string parser and its context field offset so bonusrolls.lua can reuse the
-- single parser instead of re-implementing it
Simulationcraft.GetItemSplit = GetItemSplit
Simulationcraft.OFFSET_CONTEXT = OFFSET_CONTEXT

local function Trim(str)
  return string.match(str, '^%s*(.-)%s*$')
end

-- Returns the trimmed spell description, or nil if the spell has no usable description
local function GetSpellDescriptionOrNil(spell)
  local description = spell:GetSpellDescription()
  if type(description) ~= 'string' then
    return nil
  end
  description = Trim(description)
  return description ~= '' and description or nil
end

local function GetItemName(itemLink)
  local name = string.match(itemLink, '|h%[(.*)%]|')
  local removeIcons = gsub(name, '|%a.+|%a', '')
  local trimmed = Trim(removeIcons)
  -- check for empty string or only spaces
  if string.match(trimmed, '^%s*$') then
    return nil
  end

  return trimmed
end

-- char size for utf8 strings
local function ChrSize(char)
  if not char then
      return 0
  elseif char > 240 then
      return 4
  elseif char > 225 then
      return 3
  elseif char > 192 then
      return 2
  else
      return 1
  end
end

-- SimC tokenize function
local function Tokenize(str)
  str = str or ""
  -- convert to lowercase and remove spaces
  str = string.lower(str)
  str = string.gsub(str, ' ', '_')

  -- keep stuff we want, dumpster everything else
  local s = ""
  for i=1,str:len() do
    local b = str:byte(i)
    -- keep digits 0-9
    if b >= 48 and b <= 57 then
      s = s .. str:sub(i,i)
      -- keep lowercase letters
    elseif b >= 97 and b <= 122 then
      s = s .. str:sub(i,i)
      -- keep %, +, ., _
    elseif b == 37 or b == 43 or b == 46 or b == 95 then
      s = s .. str:sub(i,i)
      -- save all multibyte chars
    elseif ChrSize(b) > 1 then
      local offset = ChrSize(b) - 1
      s = s .. str:sub(i, i + offset)
      i = i + offset -- luacheck: no unused
    end
  end
  -- strip trailing spaces
  if string.sub(s, s:len())=='_' then
    s = string.sub(s, 0, s:len()-1)
  end
  return s
end
Simulationcraft.Tokenize = Tokenize -- for the forever/ modules

-- method to add spaces to UnitRace names for proper tokenization
local function FormatRace(str)
  str = str or ""
  local matches = {}
  for match, _ in string.gmatch(str, '([%u][%l]*)') do
    matches[#matches+1] = match
  end
  return string.join(' ', unpack(matches))
end

-- method for constructing the talent string
local function CreateSimcTalentString()
  local talentInfo = {}
  local maxTiers = 7
  local maxColumns = 3
  for tier = 1, maxTiers do
    for column = 1, maxColumns do
      local _, _, _, selected, _ = GetTalentInfo(tier, column, GetActiveSpecGroup())
      if selected then
        talentInfo[tier] = column
      end
    end
  end

  local str = 'talents='
  for i = 1, maxTiers do
    if talentInfo[i] then
      str = str .. talentInfo[i]
    else
      str = str .. '0'
    end
  end

  return str
end

-- class_talents= builder for dragonflight
-- Older function, leave around for reference
-- local function GetTalentString(configId)
--   local entryStrings = {}
--
--   local active = false
--   if configId == ClassTalents.GetActiveConfigID() then
--     active = true
--   end
--
--   local configInfo = Traits.GetConfigInfo(configId)
--   for _, treeId in pairs(configInfo.treeIDs) do
--     local nodes = Traits.GetTreeNodes(treeId)
--     for _, nodeId in pairs(nodes) do
--       local node = Traits.GetNodeInfo(configId, nodeId)
--       if node.ranksPurchased > 0 then
--         entryStrings[#entryStrings + 1] = node.activeEntry.entryID .. ":" .. node.activeEntry.rank
--       end
--     end
--   end
--
--   local str = "class_talents=" .. table.concat(entryStrings, '/')
--   if not active then
--     -- comment out the class_talents and then prepend a comment with the loadout name
--     str = '# ' .. str
--     str = '# Saved Loadout: ' .. configInfo.name .. '\n' .. str
--   end
--
--   return str
-- end

-- The built-in exporter always writes the player's current spec ID into the
-- string header, so loadouts belonging to other specs need the spec ID patched.
-- Header layout: serialization version (8 bits), spec ID (16 bits), tree hash (128 bits).
local function ReplaceSpecID(loadoutString, specID)
  local importStream = ExportUtil.MakeImportDataStream(loadoutString)
  local exportStream = ExportUtil.MakeExportDataStream()

  exportStream:AddValue(bitWidthHeaderVersion, importStream:ExtractValue(bitWidthHeaderVersion))
  importStream:ExtractValue(bitWidthSpecID) -- discard the current spec ID
  exportStream:AddValue(bitWidthSpecID, specID)

  -- copy the rest of the stream (tree hash + node content) through unchanged
  local remainingBits = importStream:GetNumberOfBits() - bitWidthHeaderVersion - bitWidthSpecID
  while remainingBits > 0 do
    local chunk = math.min(remainingBits, 6)
    exportStream:AddValue(chunk, importStream:ExtractValue(chunk))
    remainingBits = remainingBits - chunk
  end

  return exportStream:GetExportString()
end

local function GetExportString(configID, specID, optionName)
  local active = false
  if configID == ClassTalents.GetActiveConfigID() then
    active = true
  end

  local loadoutString = Traits.GenerateImportString(configID)
  if not loadoutString or loadoutString == '' then
    -- the client has no data for this loadout (e.g. before TRAIT_CONFIG_LIST_UPDATED)
    return nil
  end

  if specID then
    loadoutString = ReplaceSpecID(loadoutString, specID)
  end

  local str = (optionName or "talents") .. "=" .. loadoutString
  if not active then
    -- comment out the talents and then prepend a comment with the loadout name
    local configInfo = Traits.GetConfigInfo(configID)
    str = '# ' .. str
    local label = optionName == 'offspec_talents' and 'Offspec Loadout' or 'Saved Loadout'
    -- Make sure any pipe characters get unescaped, otherwise breaks checksums
    str = '# ' .. label .. ': ' .. configInfo.name:gsub("||", "|") .. '\n' .. str
  end

  return str
end

-- Build a slash-delimited list of purchased traits from any C_Traits config.
-- Format: <optionName>=<entryID>:<rank>/<entryID>:<rank>/...
local function GetTraitString(optionName, configID)
  if not configID then return nil end

  local configInfo = Traits.GetConfigInfo(configID)
  if not configInfo or not configInfo.treeIDs then return nil end

  local entries = {}
  for _, treeID in ipairs(configInfo.treeIDs) do
    for _, nodeID in ipairs(Traits.GetTreeNodes(treeID)) do
      local node = Traits.GetNodeInfo(configID, nodeID)
      if node and node.ranksPurchased and node.ranksPurchased > 0 and node.activeEntry then
        entries[#entries + 1] = node.activeEntry.entryID .. ':' .. (node.currentRank or node.ranksPurchased)
      end
    end
  end

  if #entries == 0 then return nil end
  return optionName .. '=' .. table.concat(entries, '/')
end

-- Forever: Map the SpecGroup to the trait configID
-- Not used by modern
local function GetForeverExportString(groupIndex)
  local configID = C_SpecializationInfo.GetCombatConfigIDForSpecGroup(groupIndex)
  if not configID then
    return nil
  end

  local ok, loadoutString = pcall(Traits.GenerateImportString, configID)
  if not ok or not loadoutString or loadoutString == '' then
    return nil
  end

  return 'talents=' .. loadoutString
end

local function GetForeverLegacyTalentString()
  local ok, legacyString = pcall(Simulationcraft.GetLegacyTalentString, Simulationcraft)
  if not ok or not legacyString then
    return nil
  end

  return 'legacy_talents=' .. legacyString
end

-- function that translates between the game's role values and ours
local function TranslateRole(spec_id, str)
  local spec_role = Simulationcraft.RoleTable[spec_id]
  if spec_role ~= nil then
    return spec_role
  end

  if str == 'TANK' then
    return 'tank'
  elseif str == 'DAMAGER' then
    return 'attack'
  elseif str == 'HEALER' then
    return 'attack'
  else
    return ''
  end
end

local function formatCosts(fmt, costs, idField)
  local out = {}
  for _, c in ipairs(costs) do
    local disc = (c.discountInfo and c.discountInfo.isDiscounted) and 1 or 0
    out[#out + 1] = string.format(fmt, c[idField], c.cost, disc)
  end
  return table.concat(out, ',')
end

-- get item upgrade info if possible
local function getUpgradeComment(itemLoc)
  if not (itemLoc and C_ItemUpgrade.CanUpgradeItem(itemLoc)) then return nil end
  C_ItemUpgrade.SetItemUpgradeFromLocation(itemLoc)
  local info = C_ItemUpgrade.GetItemUpgradeItemInfo()
  C_ItemUpgrade.ClearItemUpgrade()
  if not info or not info.itemUpgradeable then return nil end

  local levelStrs = {}
  for _, lvl in ipairs(info.upgradeLevelInfos) do
    if lvl.upgradeLevel ~= info.currUpgrade then
      levelStrs[#levelStrs + 1] = string.format(
        '%d:%d:%s:%s',
        lvl.upgradeLevel, lvl.itemLevelIncrement,
        formatCosts('c#%d#%d#%d', lvl.currencyCostsToUpgrade, 'currencyID'),
        formatCosts('i#%d#%d#%d', lvl.itemCostsToUpgrade, 'itemID')
      )
    end
  end
  if #levelStrs == 0 then return nil end
  return 'upgrade_levels=' .. table.concat(levelStrs, '/')
end

local function isUpgradeVendorOpen()
  if C_PlayerInteractionManager and C_PlayerInteractionManager.IsInteractingWithNpcOfType then
    return C_PlayerInteractionManager.IsInteractingWithNpcOfType(Enum.PlayerInteractionType.ItemUpgrade)
  end
  return false
end

-- =================== Item Information =========================

local function GetItemStringFromItemLink(slotNum, itemLink, debugOutput)
  local itemSplit = GetItemSplit(itemLink)
  local simcItemOptions = {}
  local gems = {}
  local gemBonuses = {}
  local debugLines = {}

  -- Item id
  local itemId = itemSplit[OFFSET_ITEM_ID]
  simcItemOptions[#simcItemOptions + 1] = ',id=' .. itemId

  -- Enchant
  if itemSplit[OFFSET_ENCHANT_ID] > 0 then
    simcItemOptions[#simcItemOptions + 1] = 'enchant_id=' .. itemSplit[OFFSET_ENCHANT_ID]
  end

  -- Gems
  for gemOffset = OFFSET_GEM_ID_1, OFFSET_GEM_ID_4 do
    local gemIndex = (gemOffset - OFFSET_GEM_BASE) + 1
    gems[gemIndex] = 0
    gemBonuses[gemIndex] = 0
    if itemSplit[gemOffset] > 0 then
      local gemId = itemSplit[gemOffset]
      if gemId > 0 then
        gems[gemIndex] = gemId
      end
    end
  end

  -- Remove any trailing zeros from the gems array
  while #gems > 0 and gems[#gems] == 0 do
    table.remove(gems, #gems)
  end

  if #gems > 0 then
    simcItemOptions[#simcItemOptions + 1] = 'gem_id=' .. table.concat(gems, '/')
  end

  local bonuses = {}

  for index=1, itemSplit[OFFSET_BONUS_ID] do
    bonuses[#bonuses + 1] = itemSplit[OFFSET_BONUS_ID + index]
  end

  if #bonuses > 0 then
    simcItemOptions[#simcItemOptions + 1] = 'bonus_id=' .. table.concat(bonuses, '/')
  end

  -- Shadowlands looks like it changed the item string
  -- There's now a variable list of additional data after bonus IDs, looks like some kind of type/value pairs
  local linkOffset = OFFSET_BONUS_ID + #bonuses + 1

  local craftedStats = {}
  local numPairs = itemSplit[linkOffset]
  for index=1, numPairs do
    local pairOffset = 1 + linkOffset + (2 * (index - 1))
    local pairType = itemSplit[pairOffset]
    local pairValue = itemSplit[pairOffset + 1]
    if pairType == ITEM_MOD_TYPE_DROP_LEVEL then
      simcItemOptions[#simcItemOptions + 1] = 'drop_level=' .. pairValue
    elseif pairType == ITEM_MOD_TYPE_CONTENT_TUNING then
      simcItemOptions[#simcItemOptions + 1] = 'content_tuning=' .. pairValue
    elseif pairType == ITEM_MOD_TYPE_CRAFT_STATS_1 or pairType == ITEM_MOD_TYPE_CRAFT_STATS_2 then
      craftedStats[#craftedStats + 1] = pairValue
    elseif pairType == ITEM_MOD_TYPE_REDIRECTED_BASE_STATS then
      simcItemOptions[#simcItemOptions + 1] = 'redirected_base_stats=' .. pairValue
    end
  end

  if #craftedStats > 0 then
    simcItemOptions[#simcItemOptions + 1] = 'crafted_stats=' .. table.concat(craftedStats, '/')
  end

  -- gem bonuses
  local gemBonusOffset = linkOffset + (2 * numPairs) + OFFSET_GEM_BONUS_FROM_MODS
  local numGemBonuses = itemSplit[gemBonusOffset]
  local gemBonuses = {}
  for index=1, numGemBonuses do
    local offset = gemBonusOffset + index
    gemBonuses[index] = itemSplit[offset]
  end

  if #gemBonuses > 0 then
    simcItemOptions[#simcItemOptions + 1] = 'gem_bonus_id=' .. table.concat(gemBonuses, '/')
  end

  local craftingQuality = C_TradeSkillUI.GetItemCraftedQualityByItemInfo(itemLink);
  if craftingQuality then
    simcItemOptions[#simcItemOptions + 1] = 'crafting_quality=' .. craftingQuality
  end

  -- 11.1.7 Belt
  if itemId == 242664 or itemId == 245964 or itemId == 245965 or itemId == 245966 then
    local titanDiscId, tooltipStrings = Simulationcraft:GetTitanDiscBeltSpell()
    if titanDiscId then
      simcItemOptions[#simcItemOptions + 1] = 'titan_disc_id=' .. titanDiscId
    end
    debugLines[#debugLines + 1] = 'Spell Descriptions:'
    for i = 1, #tooltipStrings do
      debugLines[#debugLines + 1] = tooltipStrings[i]
    end
  end

  local itemStr = ''
  itemStr = itemStr .. (simcSlotNames[slotNum] or 'unknown') .. "=" .. table.concat(simcItemOptions, ',')
  if debugOutput then
    debugLines[#debugLines + 1] = gsub(itemLink, "\124", "\124\124")
    for line = 1, #debugLines do
      itemStr = itemStr .. '\n# ' .. debugLines[line]
    end
    itemStr = itemStr .. '\n'
  end

  return itemStr
end

function Simulationcraft:GetItemStrings(debugOutput)
  local includeUpgrade = debugOutput and isUpgradeVendorOpen()
  local items = {}
  for slotNum=1, #slotNames do
    local slotId = GetInventorySlotInfo(slotNames[slotNum])
    local itemLink = GetInventoryItemLink('player', slotId)

    -- Ammo slot in Forever just has an item ID and count but not item link
    if not itemLink and slotNames[slotNum] == 'AmmoSlot' then
      -- Empty ammo slot returns 0 (not nil) and a count of 1
      local ammoId = GetInventoryItemID('player', slotId)
      if ammoId and ammoId > 0 then
        local ammoName = C_Item and C_Item.GetItemInfo and C_Item.GetItemInfo(ammoId)
        items[slotNum] = {
          string = simcSlotNames[slotNum] .. '=,id=' .. ammoId,
          name = ammoName,
          count = GetInventoryItemCount('player', slotId),
        }
      end
    -- if we don't have an item link, we don't care
    elseif itemLink then
      -- In theory, this should always be loaded/cached
      local name = GetItemName(itemLink)

      -- get correct level for scaling gear
      local level, _, _ = GetDetailedItemLevelInfo(itemLink)

      local itemComment
      if name and level then
        itemComment = name .. ' (' .. level .. ')'
      end

      local upgrade
      if includeUpgrade then
        upgrade = getUpgradeComment(ItemLocation:CreateFromEquipmentSlot(slotId))
      end

      items[slotNum] = {
        string = GetItemStringFromItemLink(slotNum, itemLink, debugOutput),
        name = itemComment,
        upgrade = upgrade,
      }
    end
  end

  return items
end

-- Iterate through all container slots looking for gear that can be equipped.
-- Item name and item level may not be available if other addons are causing lookups to be throttled but
-- item links and IDs should always be available
function Simulationcraft:GetBagItemStrings(debugOutput)
  local includeUpgrade = debugOutput and isUpgradeVendorOpen()
  local bagItems = {}

  -- https://warcraft.wiki.gg/wiki/InventorySlotID#Bags
  -- https://warcraft.wiki.gg/wiki/BagID
  -- 11.2 unifies character, reagent, and void banks and reorganizes the container IDs
  -- Before 11.2, the addon basically needed to iteration from index -5 to 11 or so
  -- After 11.2, it's a much more sane 0 to 17
  -- The bound of the iteration can mostly be gleaned from various constants (that have shifted around between patches)
  -- with the addition of the built-in backpack slot
  -- This should work for a while if they add any more containers and if the container sizes change as it's all pretty
  -- dynamic now

  local invConstants = Constants.InventoryConstants
  local startSlot = nil
  local totalSlots = nil
  if invConstants.NumCharacterBankSlots then
    -- 11.2 and after
    startSlot = 0
    -- add 1 for the backpack
    local numBagSlots = 1 + invConstants.NumBagSlots + invConstants.NumReagentBagSlots
    local numBankSlots = invConstants.NumCharacterBankSlots
    local numWarbandBankSlots = invConstants.NumAccountBankSlots
    endSlot = numBagSlots + numBankSlots + numWarbandBankSlots
  else
    -- 11.1.7 and before
    startSlot = BACKPACK_CONTAINER - ITEM_INVENTORY_BANK_BAG_OFFSET
    endSlot = NUM_TOTAL_EQUIPPED_BAG_SLOTS + NUM_BANKBAGSLOTS
  end

  for bag=startSlot, endSlot do
    for slot=1, C_Container.GetContainerNumSlots(bag) do
      local itemId = C_Container.GetContainerItemID(bag, slot)

      -- something is in the bag slot
      if itemId then
        local _, _, _, itemEquipLoc = GetItemInfoInstant(itemId)
        local slotNum = Simulationcraft.invTypeToSlotNum[itemEquipLoc]

        -- item can be equipped
        if slotNum then
          local info = C_Container.GetContainerItemInfo(bag, slot)
          local itemLink = C_Container.GetContainerItemLink(bag, slot)
          local upgrade
          if includeUpgrade then
            upgrade = getUpgradeComment(ItemLocation:CreateFromBagAndSlot(bag, slot))
          end
          bagItems[#bagItems + 1] = {
            string = GetItemStringFromItemLink(slotNum, itemLink, debugOutput),
            slotNum = slotNum,
            upgrade = upgrade
          }
          local itemName = GetItemName(itemLink)
          local level, _, _ = GetDetailedItemLevelInfo(itemLink)
          if itemName and level then
            bagItems[#bagItems].name = itemName .. ' (' .. level .. ')'
          end
        end
      end
    end
  end

  -- order results by paper doll slot, not bag slot
  table.sort(bagItems, function (a, b) return a.slotNum < b.slotNum end)

  return bagItems
end

-- Scan buffs to determine which loa racial this player has, if any
function Simulationcraft:GetZandalariLoa()
  local zandalariLoa = nil
  for index = 1, 32 do
    local auraData = C_UnitAuras.GetBuffDataByIndex("player", index)
    local spellId = auraData.spellId
    if spellId == nil then
      break
    end
    if issecretvalue(spellId) then
      break
    end
    if zandalariLoaBuffs[spellId] then
      zandalariLoa = zandalariLoaBuffs[spellId]
      break
    end
  end
  return zandalariLoa
end

function Simulationcraft:GetSlotHighWatermarks()
  if C_ItemUpgrade and C_ItemUpgrade.GetHighWatermarkForSlot then
    local slots = {}
    -- These are not normal equipment slots, they are Enum.ItemRedundancySlot
    for slot = 0, 16 do
      local characterHighWatermark, accountHighWatermark = C_ItemUpgrade.GetHighWatermarkForSlot(slot)
      if characterHighWatermark or accountHighWatermark then
        slots[#slots + 1] = table.concat({  slot, characterHighWatermark, accountHighWatermark }, ':')
      end
    end
    return table.concat(slots, '/')
  end
end

function Simulationcraft:GetCatalystCurrencies()
  local catalystCurrencies = {}
  for currencyId, currencyName in pairs(Simulationcraft.catalystCurrencies) do
    local currencyInfo = C_CurrencyInfo.GetCurrencyInfo(currencyId)
    if currencyInfo then
      catalystCurrencies[#catalystCurrencies + 1] = table.concat({ currencyId, currencyInfo.quantity }, ':')
    end
  end

  return table.concat(catalystCurrencies, '/')
end

function Simulationcraft:GetUpgradeCurrencies()
  local upgradeCurrencies = {}
  -- Collect actual currencies
  for currencyId, currencyName in pairs(Simulationcraft.upgradeCurrencies) do
    local currencyInfo = C_CurrencyInfo.GetCurrencyInfo(currencyId)
    if currencyInfo and currencyInfo.quantity > 0 then
      upgradeCurrencies[#upgradeCurrencies + 1] = table.concat({ "c", currencyId, currencyInfo.quantity }, ':')
    end
  end

  -- Collect items that get used as currencies
  for itemId, itemName in pairs(Simulationcraft.upgradeItems) do
    local count = GetItemCount(itemId, true, true, true)
    if count > 0 then
      upgradeCurrencies[#upgradeCurrencies + 1] = table.concat({ "i", itemId, count }, ':')
    end
  end

  return table.concat(upgradeCurrencies, '/')
end

function Simulationcraft:GetBonusRollCurrencies()
  local bonusRollCurrencies = {}
  for currencyId, currencyName in pairs(Simulationcraft.bonusRollCurrencies) do
    local currencyInfo = C_CurrencyInfo.GetCurrencyInfo(currencyId)
    if currencyInfo then
      bonusRollCurrencies[#bonusRollCurrencies + 1] = table.concat({ currencyId, currencyInfo.quantity }, ':')
    end
  end

  return table.concat(bonusRollCurrencies, '/')
end

function Simulationcraft:GetItemUpgradeAchievements()
  local achieves = {}
  for i=1, #Simulationcraft.upgradeAchievements do
    local achId = Simulationcraft.upgradeAchievements[i]
    local _, name, points, complete = GetAchievementInfo(achId)
    if complete then
      achieves[#achieves + 1] = achId
    end
  end
  return table.concat(achieves, '/')
end

local function LoadSpellsAsync(callback)
  local spellIds = Simulationcraft.preloadSpellIds

  -- Build up the SpellCache asynchronously
  local numLoaded = 0
  local function onLoad()
    numLoaded = numLoaded + 1

    if numLoaded == #spellIds then
      SpellCacheLoaded = true
      if callback then
        callback(SpellCache)
      end
    end
  end

  for index=1, #spellIds do
    local spellId = spellIds[index]
    local spell = Spell:CreateFromSpellID(spellId)
    if not spell:IsSpellEmpty() then
      spell:ContinueOnSpellLoad(function()
        -- It's possible that in some cases, ContinueOnSpellLoad may not fire. If that happens,
        -- will need to look into ContinueWithCancelOnSpellLoad which can apparently be used with
        -- timeouts
        SpellCache[spellId] = spell
        onLoad()
      end)
    else
      onLoad()
    end
  end
end

-- This requires the SpellCache with the right spell IDs to be loaded
function Simulationcraft:GetTitanDiscBeltSpell()
  local activeSpell = nil
  local debugTooltipStrings = {}
  local beltSpell = SpellCache[Simulationcraft.discBeltSpell]
  local beltDescription = beltSpell and GetSpellDescriptionOrNil(beltSpell)
  -- The belt is 11.1.7 content, its spells may no longer resolve on newer clients
  if not beltDescription then
    return nil, debugTooltipStrings
  end
  debugTooltipStrings[#debugTooltipStrings + 1] = beltDescription
  for k, v in pairs(Simulationcraft.discBeltEffectSpells) do
    local effectSpell = SpellCache[k]
    local effectDesc = effectSpell and GetSpellDescriptionOrNil(effectSpell)
    -- An empty description would match anything below, so skip it
    if effectDesc then
      debugTooltipStrings[#debugTooltipStrings + 1] = effectDesc
      -- disable pattern matching with the last argument
      if beltDescription:find(effectDesc, 1, true) then
        activeSpell = v
      end
    end
  end

  return activeSpell, debugTooltipStrings
end

function Simulationcraft:GetMainFrame(text)
  -- Frame code largely adapted from https://www.wowinterface.com/forums/showpost.php?p=323901&postcount=2
  if not SimcFrame then
    -- Main Frame
    local frameConfig = OptionsDB.profile.frame
    local f = CreateFrame("Frame", "SimcFrame", UIParent, "DialogBoxFrame")
    f:ClearAllPoints()
    -- load position from local DB
    f:SetPoint(
      frameConfig.point,
      frameConfig.relativeFrame,
      frameConfig.relativePoint,
      frameConfig.ofsx,
      frameConfig.ofsy
    )
    f:SetSize(frameConfig.width, frameConfig.height)
    f:SetBackdrop({
      bgFile = "Interface\\DialogFrame\\UI-DialogBox-Background",
      edgeFile = "Interface\\PVPFrame\\UI-Character-PVP-Highlight",
      edgeSize = 16,
      insets = { left = 8, right = 8, top = 8, bottom = 8 },
    })
    f:SetMovable(true)
    f:SetClampedToScreen(true)
    f:SetScript("OnMouseDown", function(self, button) -- luacheck: ignore
      if button == "LeftButton" then
        self:StartMoving()
      end
    end)
    f:SetScript("OnMouseUp", function(self, _) -- luacheck: ignore
      self:StopMovingOrSizing()
      -- save position between sessions
      local point, relativeFrame, relativeTo, ofsx, ofsy = self:GetPoint()
      frameConfig.point = point
      frameConfig.relativeFrame = relativeFrame
      frameConfig.relativePoint = relativeTo
      frameConfig.ofsx = ofsx
      frameConfig.ofsy = ofsy
    end)

    -- scroll frame
    local sf = CreateFrame("ScrollFrame", "SimcScrollFrame", f, "UIPanelScrollFrameTemplate")
    sf:SetPoint("LEFT", 16, 0)
    sf:SetPoint("RIGHT", -32, 0)
    sf:SetPoint("TOP", 0, -32)
    sf:SetPoint("BOTTOM", SimcFrameButton, "TOP", 0, 0)

    -- edit box
    local ctrlDown = false
    local eb = CreateFrame("EditBox", "SimcEditBox", SimcScrollFrame)
    eb:SetSize(sf:GetSize())
    eb:SetMultiLine(true)
    eb:SetAutoFocus(true)
    eb:SetFontObject("ChatFontNormal")
    eb:SetScript("OnEscapePressed", function() f:Hide() end)
    eb:SetScript("OnKeyDown", function(self, key)
      if key == "LCTRL" or key == "RCTRL" or key == "LMETA" or key == "RMETA" then
        ctrlDown = true
      end
    end)
    eb:SetScript("OnKeyUp", function(self, key)
      if key == "LCTRL" or key == "RCTRL" or key == "LMETA" or key == "RMETA" then
        -- Add a small grace period. In testing, the way I press Ctrl-C would sometimes have Ctrl keyup bfore C
        C_Timer.After(0.2, function() ctrlDown = false end)
      end
      if ctrlDown then
        -- handle copy or cut
        if key == "C" or key == "X" then
          if OptionsDB.profile.closeOnCopy then
            -- Just in case there's some weird way that WoW could close the window before the OS copies
            C_Timer.After(0.1, function()
              f:Hide()
            end)
          end
        end
      end
    end)
    sf:SetScrollChild(eb)

    -- resizing
    f:SetResizable(true)
    if f.SetMinResize then
      -- older function from shadowlands and before
      -- Can remove when Dragonflight is in full swing
      f:SetMinResize(150, 100)
    else
      -- new func for dragonflight
      f:SetResizeBounds(150, 100, nil, nil)
    end
    local rb = CreateFrame("Button", "SimcResizeButton", f)
    rb:SetPoint("BOTTOMRIGHT", -6, 7)
    rb:SetSize(16, 16)

    rb:SetNormalTexture("Interface\\ChatFrame\\UI-ChatIM-SizeGrabber-Up")
    rb:SetHighlightTexture("Interface\\ChatFrame\\UI-ChatIM-SizeGrabber-Highlight")
    rb:SetPushedTexture("Interface\\ChatFrame\\UI-ChatIM-SizeGrabber-Down")

    rb:SetScript("OnMouseDown", function(self, button) -- luacheck: ignore
        if button == "LeftButton" then
            f:StartSizing("BOTTOMRIGHT")
            self:GetHighlightTexture():Hide() -- more noticeable
        end
    end)
    rb:SetScript("OnMouseUp", function(self, _) -- luacheck: ignore
        f:StopMovingOrSizing()
        self:GetHighlightTexture():Show()
        eb:SetWidth(sf:GetWidth())

        -- save size between sessions
        frameConfig.width = f:GetWidth()
        frameConfig.height = f:GetHeight()
    end)

    -- Automatic close checkbox
    local checkbox = CreateFrame("CheckButton", "AutomaticClose", f, "ChatConfigCheckButtonTemplate")
    checkbox:SetPoint("BOTTOMLEFT", 12, 18)
    checkbox.Text:SetText("Close after copy")

    -- nudge the label a little higher
    checkbox.Text:ClearAllPoints()
    checkbox.Text:SetPoint("LEFT", checkbox, "RIGHT", 2, -1)

    checkbox:SetChecked(true)
    checkbox:HookScript("OnClick", function(self)
      OptionsDB.profile.closeOnCopy = self:GetChecked()
    end)

    -- Offspec talent loadouts checkbox
    local offspecCheckbox = CreateFrame("CheckButton", "SimcOffspecLoadouts", f, "ChatConfigCheckButtonTemplate")
    offspecCheckbox.Text:SetText("Offspec Talent Loadouts")

    -- nudge the label a little higher
    offspecCheckbox.Text:ClearAllPoints()
    offspecCheckbox.Text:SetPoint("LEFT", offspecCheckbox, "RIGHT", 2, -1)

    -- template puts the label to the right of the box, so pull the box left of
    -- the resize grabber by the label's width to keep the whole thing inside the frame
    offspecCheckbox:SetPoint("BOTTOMRIGHT", -(offspecCheckbox.Text:GetStringWidth() + 26), 18)
    offspecCheckbox:SetChecked(OptionsDB.profile.offspecLoadouts)

    offspecCheckbox:HookScript("OnClick", function(self)
      OptionsDB.profile.offspecLoadouts = self:GetChecked()
      -- rebuild the profile text with the new setting
      local args = Simulationcraft.lastProfileArgs or {}
      Simulationcraft:PrintSimcProfile(args.debugOutput, args.noBags, args.showMerchant, args.links)
    end)

    SimcFrame = f
  end
  SimcEditBox:SetText(text)
  SimcEditBox:HighlightText()
  return SimcFrame
end

-- Adapted from https://github.com/philanc/plc/blob/master/plc/checksum.lua
local function adler32(s)
  -- return adler32 checksum  (uint32)
  -- adler32 is a checksum defined by Mark Adler for zlib
  -- (based on the Fletcher checksum used in ITU X.224)
  -- implementation based on RFC 1950 (zlib format spec), 1996
  local prime = 65521 --largest prime smaller than 2^16
  local s1, s2 = 1, 0

  -- limit s size to ensure that modulo prime can be done only at end
  -- 2^40 is too large for WoW Lua so limit to 2^30
  if #s > (bit.lshift(1, 30)) then error("adler32: string too large") end

  for i = 1,#s do
    local b = string.byte(s, i)
    s1 = s1 + b
    s2 = s2 + s1
    -- no need to test or compute mod prime every turn.
  end

  s1 = s1 % prime
  s2 = s2 % prime

  return (bit.lshift(s2, 16)) + s1
end --adler32()

function Simulationcraft:GetSimcProfile(debugOutput, noBags, showMerchant, links)
  -- addon metadata
  local versionComment = '# SimC Addon ' .. GetAddOnMetadata('Simulationcraft', 'Version')
  local wowVersion, wowBuild, _, wowToc = GetBuildInfo()
  local wowVersionComment = '# WoW ' .. wowVersion .. '.' .. wowBuild .. ', TOC ' .. wowToc
  local simcVersionWarning = '# Requires SimulationCraft 1000-01 or newer'

  -- Basic player info
  local _, realmName, _, _, _, _, region, _, _, realmLatinName, _ = LibRealmInfo:GetRealmInfoByUnit('player')

  local playerName = UnitName('player')
  local _, playerClass = UnitClass('player')
  local playerLevel = UnitLevel('player')

  -- Try Latin name for Russian servers first, then realm name from LibRealmInfo, then Realm Name from the game
  -- Latin name for Russian servers as most APIs use the latin name, not the cyrillic name
  local playerRealm = realmLatinName or realmName or GetRealmName()

  -- Try region from LibRealmInfo first, then use default API
  -- Default API can be wrong for region-switching players
  local playerRegion = region or GetCurrentRegionName() or regionString[GetCurrentRegion()]

  -- Race info
  local _, playerRace, playerRaceId = UnitRace('player')

  -- fix some races to match SimC format
  if playerRace == 'Scourge' then --lulz
    playerRace = 'Undead'
  elseif playerRaceId == 95 then
    playerRace = "skyborne_alliance"
  elseif playerRaceId == 96 then
    playerRace = "skyborne_horde"
  else
    playerRace = FormatRace(playerRace)
  end

  local isZandalariTroll = false
  if Tokenize(playerRace) == 'zandalari_troll' then
    isZandalariTroll = true
  end

  -- Spec info
  local role, globalSpecID, playerRole
  local specId = C_SpecializationInfo.GetSpecialization()
  if specId then
    globalSpecID,_,_,_,_,role = C_SpecializationInfo.GetSpecializationInfo(specId)
  end
  local playerSpec = specNames[ globalSpecID ] or 'unknown'

  -- Loot spec
  local lootSpecId = GetLootSpecialization()
  if lootSpecId == 0 then
    lootSpecId = globalSpecID
  end
  local playerLootSpec = specNames[ lootSpecId ]

  -- Professions
  -- GetProfessions also returns the secondary skills (archaeology, fishing, cooking, first aid),
  -- SimC only wants the two primaries. Either slot can be nil.
  local pid1, pid2 = GetProfessions()
  local professions = {}
  for _, pid in pairs({ pid1, pid2 }) do
    local _, _, rank, _, _, _, profId = GetProfessionInfo(pid)
    local profName = profNames[ profId ]
    if profName then
      professions[#professions + 1] = Tokenize(profName) .. '=' .. tostring(rank)
    end
  end

  local playerProfessions = ''
  if #professions > 0 then
    playerProfessions = 'professions=' .. table.concat(professions, '/')
  end

  -- create a header comment with basic player info and a date
  local headerComment = "# " .. playerName
  if EXPORTS.spec then
    headerComment = headerComment .. ' - ' .. playerSpec
  end
  headerComment = headerComment .. ' - ' .. date('%Y-%m-%d %H:%M') .. ' - ' .. playerRegion .. '/' .. playerRealm

  -- Construct SimC-compatible strings from the basic information
  local player = Tokenize(playerClass) .. '="' .. playerName .. '"'
  playerLevel = 'level=' .. playerLevel
  playerRace = 'race=' .. Tokenize(playerRace)
  playerRole = 'role=' .. TranslateRole(globalSpecID, role)
  local playerSpecStr = 'spec=' .. Tokenize(playerSpec)
  playerRealm = 'server=' .. Tokenize(playerRealm)
  playerRegion = 'region=' .. Tokenize(playerRegion)
  local playerLootSpecStr = 'loot_spec=' .. Tokenize(playerLootSpec)

  -- Build the output string for the player (not including gear)
  local simcPrintError = nil
  local simulationcraftProfile = ''

  simulationcraftProfile = simulationcraftProfile .. headerComment .. '\n'
  simulationcraftProfile = simulationcraftProfile .. versionComment .. '\n'
  simulationcraftProfile = simulationcraftProfile .. wowVersionComment .. '\n'
  simulationcraftProfile = simulationcraftProfile .. simcVersionWarning .. '\n'
  simulationcraftProfile = simulationcraftProfile .. '\n'

  simulationcraftProfile = simulationcraftProfile .. player .. '\n'
  simulationcraftProfile = simulationcraftProfile .. playerLevel .. '\n'
  simulationcraftProfile = simulationcraftProfile .. playerRace .. '\n'
  if isZandalariTroll then
    local zandalari_loa = Simulationcraft:GetZandalariLoa()
    if zandalari_loa then
      simulationcraftProfile = simulationcraftProfile .. "zandalari_loa=" .. zandalari_loa .. '\n'
    end
  end
  simulationcraftProfile = simulationcraftProfile .. playerRegion .. '\n'
  simulationcraftProfile = simulationcraftProfile .. playerRealm .. '\n'
  simulationcraftProfile = simulationcraftProfile .. playerRole .. '\n'
  simulationcraftProfile = simulationcraftProfile .. playerProfessions .. '\n'
  -- spec= is always written (spec=unknown on Forever for now) so the profile shape stays stable
  simulationcraftProfile = simulationcraftProfile .. playerSpecStr .. '\n'
  if EXPORTS.spec then
    simulationcraftProfile = simulationcraftProfile .. '# ' .. playerLootSpecStr .. '\n'
  end
  simulationcraftProfile = simulationcraftProfile .. '\n'

  if IS_FOREVER then
    -- WoW Forever: primary/secondary talents are organized by SpecGroup, an older concept that is unused in modern.
    -- Map the spec groups to the new trait system and get new-style talent strings
    local activeGroup = C_SpecializationInfo.GetActiveSpecGroup and C_SpecializationInfo.GetActiveSpecGroup() or 1
    local activeTalents = GetForeverExportString(activeGroup)
    if activeTalents then
      simulationcraftProfile = simulationcraftProfile .. activeTalents .. '\n'
    else
      simulationcraftProfile = simulationcraftProfile
        .. '# Unable to export talents - no talent data from the client yet, try /simc again\n'
    end
    simulationcraftProfile = simulationcraftProfile .. '\n'

    local numGroups = GetNumSpecGroups and GetNumSpecGroups() or 1
    local groupLabels = { 'Primary', 'Secondary' }
    for groupIndex = 1, numGroups do
      local exportString = GetForeverExportString(groupIndex)
      if exportString then
        simulationcraftProfile = simulationcraftProfile
          .. '# ' .. (groupLabels[groupIndex] or ('Group ' .. groupIndex)) .. ' Talents\n'
          .. '# ' .. exportString .. '\n'
      end
    end

    local legacyTalents = GetForeverLegacyTalentString()
    if legacyTalents then
      simulationcraftProfile = simulationcraftProfile .. '\n' .. legacyTalents .. '\n'
    end
  elseif playerSpec == 'unknown' then -- luacheck: ignore
    -- do nothing
    -- Player does not have a spec / is in starting player area
  elseif ClassTalents then
    -- DRAGONFLIGHT
    -- new dragonflight talents
    if Traits.GetLoadoutSerializationVersion() ~= SUPPORTED_LOADOUT_SERIALIZATION_VERSION then
      simcPrintError = 'This version of the SimC addon does not work with this version of WoW.\n'
      simcPrintError = simcPrintError .. 'There is a mismatch in the version of talent string exports.\n'
      simcPrintError = simcPrintError .. '\n'
      if Traits.GetLoadoutSerializationVersion() > SUPPORTED_LOADOUT_SERIALIZATION_VERSION then
        simcPrintError = simcPrintError .. 'WoW is using a newer version - you probably need to update your addon.\n'
      else
        simcPrintError = simcPrintError .. 'WoW is using an older version - you may be running an alpha/beta addon that is not currently ready for retail.\n'
      end
      simcPrintError = simcPrintError .. '\n'
      simcPrintError = simcPrintError .. 'WoW talent string export version = ' .. Traits.GetLoadoutSerializationVersion() .. '\n'
      simcPrintError = simcPrintError .. 'Addon talent string export version = ' .. SUPPORTED_LOADOUT_SERIALIZATION_VERSION .. '\n'
    end

    local currentConfigId = ClassTalents.GetActiveConfigID()

    local activeTalents = GetExportString(currentConfigId)
    if activeTalents then
      simulationcraftProfile = simulationcraftProfile .. activeTalents .. '\n'
    else
      simulationcraftProfile = simulationcraftProfile
        .. '# Unable to export talents - no talent data from the client yet, try /simc again\n'
    end
    simulationcraftProfile = simulationcraftProfile .. '\n'

    local specConfigs = ClassTalents.GetConfigIDsBySpecID(globalSpecID)

    for _, configId in pairs(specConfigs) do
      local exportString = GetExportString(configId)
      if exportString then
        simulationcraftProfile = simulationcraftProfile .. exportString .. '\n'
      end
    end

    if OptionsDB.profile.offspecLoadouts then
      -- Saved loadouts from offspecs. The built-in exporter stamps
      -- the current spec ID into every string, so these get their spec bits patched.
      local getNumSpecs = C_SpecializationInfo.GetNumSpecializations or GetNumSpecializations
      for otherSpecIndex = 1, getNumSpecs() do
        if otherSpecIndex ~= specId then
          local otherSpecID, otherSpecName = C_SpecializationInfo.GetSpecializationInfo(otherSpecIndex)
          local otherSpecConfigs = otherSpecID and ClassTalents.GetConfigIDsBySpecID(otherSpecID)
          if otherSpecConfigs and #otherSpecConfigs > 0 then
            local sectionLines = {}
            for _, configId in pairs(otherSpecConfigs) do
              -- Use a different option name so existing consumers that can't handle offspec strings don't choke
              local exportString = GetExportString(configId, otherSpecID, 'offspec_talents')
              if exportString then
                sectionLines[#sectionLines + 1] = exportString
              end
            end
            if #sectionLines > 0 then
              simulationcraftProfile = simulationcraftProfile .. '\n'
              simulationcraftProfile = simulationcraftProfile .. '### Offspec Loadouts: ' .. otherSpecName .. '\n'
              simulationcraftProfile = simulationcraftProfile .. table.concat(sectionLines, '\n') .. '\n'
            end
          end
        end
      end
    end
  else
    -- old talents
    local playerTalents = CreateSimcTalentString()
    simulationcraftProfile = simulationcraftProfile .. playerTalents .. '\n'
  end

  if EXPORTS.trait_systems and Traits and Traits.GetConfigIDBySystemID then
    local firstTraitSystem = true
    for _, system in ipairs(TRAIT_SYSTEMS) do
      local configID = Traits.GetConfigIDBySystemID(system.systemID)
      local traitStr = GetTraitString(system.name, configID)
      if traitStr then
        if firstTraitSystem then
          simulationcraftProfile = simulationcraftProfile .. '\n'
          firstTraitSystem = false
        end
        simulationcraftProfile = simulationcraftProfile .. traitStr .. '\n'
      end
    end
  end

  simulationcraftProfile = simulationcraftProfile .. '\n'

  -- Method that gets gear information
  local items = Simulationcraft:GetItemStrings(debugOutput)

  -- output gear
  for slotNum=1, #slotNames do
    local item = items[slotNum]
    if item then
      if item.name then
        simulationcraftProfile = simulationcraftProfile .. '# ' .. item.name .. '\n'
      end
      if item.upgrade then
        simulationcraftProfile = simulationcraftProfile .. '# ' .. item.upgrade .. '\n'
      end
      simulationcraftProfile = simulationcraftProfile .. items[slotNum].string .. '\n'
      if item.count then
        simulationcraftProfile = simulationcraftProfile .. '# ammo_count=' .. item.count .. '\n'
      end
    end
  end

  -- output equipped bags (Forever)
  if EXPORTS.bags then
    local bagsOk, bags = pcall(Simulationcraft.GetEquippedBags, Simulationcraft)
    if bagsOk and bags and #bags > 0 then
      simulationcraftProfile = simulationcraftProfile .. '\n'
      for _, bagLine in ipairs(bags) do
        simulationcraftProfile = simulationcraftProfile .. bagLine .. '\n'
      end
    end
  end

  -- output hunter pet (Forever)
  if EXPORTS.pet then
    local petOk, petLines = pcall(Simulationcraft.GetPetExport, Simulationcraft)
    if petOk and petLines then
      simulationcraftProfile = simulationcraftProfile .. '\n'
      for _, petLine in ipairs(petLines) do
        simulationcraftProfile = simulationcraftProfile .. petLine .. '\n'
      end
    end
  end

  -- output gear from bags
  if noBags == false then
    local bagItems = Simulationcraft:GetBagItemStrings(debugOutput)

    if #bagItems > 0 then
      simulationcraftProfile = simulationcraftProfile .. '\n'
      simulationcraftProfile = simulationcraftProfile .. '### Gear from Bags\n'
      for i=1, #bagItems do
        simulationcraftProfile = simulationcraftProfile .. '#\n'
        if bagItems[i].name and bagItems[i].name ~= '' then
          simulationcraftProfile = simulationcraftProfile .. '# ' .. bagItems[i].name .. '\n'
        end
        if bagItems[i].upgrade then
          simulationcraftProfile = simulationcraftProfile .. '# ' .. bagItems[i].upgrade .. '\n'
        end
        simulationcraftProfile = simulationcraftProfile .. '# ' .. bagItems[i].string .. '\n'
      end
    end
  end

  -- output weekly reward gear
  if WeeklyRewards then
    if WeeklyRewards:HasAvailableRewards() then
      simulationcraftProfile = simulationcraftProfile .. '\n'
      simulationcraftProfile = simulationcraftProfile .. '### Weekly Reward Choices\n'
      local activities = WeeklyRewards.GetActivities()
      for _, activityInfo in ipairs(activities) do
        for _, rewardInfo in ipairs(activityInfo.rewards) do
          -- itemDBID is nilable, only item rewards carry one. Currency rewards (crests,
          -- valorstones, etc) have none, and GetItemHyperlink errors when passed nil.
          if rewardInfo.itemDBID then
            local _, _, _, itemEquipLoc = GetItemInfoInstant(rewardInfo.id)
            local itemLink = WeeklyRewards.GetItemHyperlink(rewardInfo.itemDBID)
            local slotNum = Simulationcraft.invTypeToSlotNum[itemEquipLoc]
            -- GetItemHyperlink may return nothing even for a valid itemDBID
            if itemLink and slotNum then
              local itemName = GetItemName(itemLink);
              local itemStr = GetItemStringFromItemLink(slotNum, itemLink, debugOutput)
              local level, _, _ = GetDetailedItemLevelInfo(itemLink)
              simulationcraftProfile = simulationcraftProfile .. '#\n'
              if itemName and level then
                local itemNameComment = itemName .. ' ' .. '(' .. level .. ')'
                simulationcraftProfile = simulationcraftProfile .. '# ' .. itemNameComment .. '\n'
              end
              simulationcraftProfile = simulationcraftProfile .. '# ' .. itemStr .. "\n"
            end
          end
        end
      end
      simulationcraftProfile = simulationcraftProfile .. '#\n'
      simulationcraftProfile = simulationcraftProfile .. '### End of Weekly Reward Choices\n'
    end
  end

  -- Dump out equippable items from a vendor, this is mostly for debugging / data collection
  local numMerchantItems = GetMerchantNumItems()
  if showMerchant and numMerchantItems > 0 then
    simulationcraftProfile = simulationcraftProfile .. '\n'
    simulationcraftProfile = simulationcraftProfile .. '\n### Merchant items\n'
    for i=1,numMerchantItems do
      local link = GetMerchantItemLink(i)
      local name,_,_,_,_,_,_,_,invType = GetItemInfo(link)
      if name and invType ~= "" then
        local slotNum = Simulationcraft.invTypeToSlotNum[invType]
        -- Doesn't work, seems to always return base item level
        -- local level, _, _ = GetDetailedItemLevelInfo(itemLink)
        local itemStr = GetItemStringFromItemLink(slotNum, link, false)
        simulationcraftProfile = simulationcraftProfile .. '#\n'
        if name then
          simulationcraftProfile = simulationcraftProfile .. '# ' .. name .. '\n'
        end
        simulationcraftProfile = simulationcraftProfile .. '# ' .. itemStr .. "\n"
      end
    end
  end


  -- output item links that were included in the /simc chat line
  if links and #links > 0 then
    simulationcraftProfile = simulationcraftProfile .. '\n'
    simulationcraftProfile = simulationcraftProfile .. '\n### Linked gear\n'
    for _, v in pairs(links) do
      local name,_,_,_,_,_,_,_,invType = GetItemInfo(v)
      if name and invType ~= "" then
        local slotNum = Simulationcraft.invTypeToSlotNum[invType]
        local itemStr = GetItemStringFromItemLink(slotNum, v, debugOutput)
        simulationcraftProfile = simulationcraftProfile .. '#\n'
        simulationcraftProfile = simulationcraftProfile .. '# ' .. name .. '\n'
        simulationcraftProfile = simulationcraftProfile .. '# ' .. itemStr .. "\n"
      else -- Someone linked something that was not gear.
        simcPrintError = "Error: " .. v .. " is not gear."
        break
      end
    end
  end

  simulationcraftProfile = simulationcraftProfile .. '\n'
  simulationcraftProfile = simulationcraftProfile .. '### Additional Character Info\n'

  if EXPORTS.catalyst_currencies then
    local catalystCurrenciesStr = Simulationcraft:GetCatalystCurrencies()
    simulationcraftProfile = simulationcraftProfile .. '#\n'
    simulationcraftProfile = simulationcraftProfile .. '# catalyst_currencies=' .. catalystCurrenciesStr .. '\n'
  end

  if EXPORTS.upgrade_currencies then
    local upgradeCurrenciesStr = Simulationcraft:GetUpgradeCurrencies()
    simulationcraftProfile = simulationcraftProfile .. '#\n'
    simulationcraftProfile = simulationcraftProfile .. '# upgrade_currencies=' .. upgradeCurrenciesStr .. '\n'
  end

  if EXPORTS.slot_high_watermarks then
    local highWatermarksStr = Simulationcraft:GetSlotHighWatermarks()
    if highWatermarksStr then
      simulationcraftProfile = simulationcraftProfile .. '#\n'
      simulationcraftProfile = simulationcraftProfile .. '# slot_high_watermarks=' .. highWatermarksStr .. '\n'
    end
  end

  if EXPORTS.upgrade_achievements then
    local upgradeAchievementsStr = Simulationcraft:GetItemUpgradeAchievements()
    simulationcraftProfile = simulationcraftProfile .. '#\n'
    simulationcraftProfile = simulationcraftProfile .. '# upgrade_achievements=' .. upgradeAchievementsStr .. '\n'
  end

  if EXPORTS.bonus_roll_currencies then
    local bonusRollCurrenciesStr = Simulationcraft:GetBonusRollCurrencies()
    simulationcraftProfile = simulationcraftProfile .. '#\n'
    simulationcraftProfile = simulationcraftProfile .. '# bonus_roll_currencies=' .. bonusRollCurrenciesStr .. '\n'
  end

  if EXPORTS.bonus_roll_items then
    local bonusRollStr = Simulationcraft:GetBonusRollItems()
    if bonusRollStr and bonusRollStr ~= '' then
      simulationcraftProfile = simulationcraftProfile .. '#\n'
      simulationcraftProfile = simulationcraftProfile .. '# bonus_roll_items=' .. bonusRollStr .. '\n'
    end
  end

  -- Stats are informational only, never let them break the export
  if EXPORTS.character_stats then
    local statsOk, statLines = pcall(Simulationcraft.GetCharacterStats, Simulationcraft)
    if statsOk then
      simulationcraftProfile = simulationcraftProfile .. '#\n'
      for _, line in ipairs(statLines) do
        simulationcraftProfile = simulationcraftProfile .. '# ' .. line[1] .. '=' .. line[2] .. '\n'
      end
    end
  end

  if EXPORTS.skills then
    local skillsOk, skillsStr = pcall(Simulationcraft.GetSkillLevels, Simulationcraft)
    if skillsOk and skillsStr then
      simulationcraftProfile = simulationcraftProfile .. '#\n'
      simulationcraftProfile = simulationcraftProfile .. '# skills=' .. skillsStr .. '\n'
    end
  end

  if EXPORTS.buffs then
    local buffsOk, buffsStr = pcall(Simulationcraft.GetActiveBuffs, Simulationcraft)
    if buffsOk and buffsStr then
      simulationcraftProfile = simulationcraftProfile .. '#\n'
      simulationcraftProfile = simulationcraftProfile .. '# buffs=' .. buffsStr .. '\n'
    end
  end

  -- sanity checks - if there's anything that makes the output completely invalid, punt!
  if EXPORTS.spec and specId==nil then
    simcPrintError = "Error: You need to pick a spec!"
  end

  simulationcraftProfile = simulationcraftProfile .. '\n'

  -- Simple checksum to provide a lightweight verification that the input hasn't been edited/modified.
  -- Pipes are doubled for EditBox display but the clipboard/consumer side sees them un-doubled,
  -- so checksum the un-doubled form to match what a consumer would see
  local checksum = adler32((simulationcraftProfile:gsub("||", "|")))

  simulationcraftProfile = simulationcraftProfile .. '# Checksum: ' .. string.format('%x', checksum)

  return simulationcraftProfile, simcPrintError
end

-- This is the workhorse function that constructs the profile
function Simulationcraft:PrintSimcProfile(debugOutput, noBags, showMerchant, links)
  -- remember the args so UI toggles on the output frame can rebuild the text
  Simulationcraft.lastProfileArgs = {
    debugOutput = debugOutput,
    noBags = noBags,
    showMerchant = showMerchant,
    links = links,
  }
  LoadSpellsAsync(function()
    local simulationcraftProfile, simcPrintError = Simulationcraft:GetSimcProfile(debugOutput, noBags, showMerchant, links)

    local f = Simulationcraft:GetMainFrame(simcPrintError or simulationcraftProfile)
    f:Show()
  end)
end

LoadSpellsAsync()

-- Expose GetSimcProfile so addons can fetch the profile without goin through awkward wordarounds, added inside a global table so its easier to add more things under it later on if needed
SimulationcraftAPI = {
  GetSimcProfile =  Simulationcraft.GetSimcProfile
}