Asa@0: --- AceDBOptions-3.0 provides a universal AceConfig options screen for managing AceDB-3.0 profiles. Asa@0: -- @class file Asa@0: -- @name AceDBOptions-3.0 Asa@0: -- @release $Id: AceDBOptions-3.0.lua 895 2009-12-06 16:28:55Z nevcairiel $ Asa@0: local ACEDBO_MAJOR, ACEDBO_MINOR = "AceDBOptions-3.0", 11 Asa@0: local AceDBOptions, oldminor = LibStub:NewLibrary(ACEDBO_MAJOR, ACEDBO_MINOR) Asa@0: Asa@0: if not AceDBOptions then return end -- No upgrade needed Asa@0: Asa@0: -- Lua APIs Asa@0: local pairs, next = pairs, next Asa@0: Asa@0: -- WoW APIs Asa@0: local UnitClass = UnitClass Asa@0: Asa@0: -- Global vars/functions that we don't upvalue since they might get hooked, or upgraded Asa@0: -- List them here for Mikk's FindGlobals script Asa@0: -- GLOBALS: NORMAL_FONT_COLOR_CODE, FONT_COLOR_CODE_CLOSE Asa@0: Asa@0: AceDBOptions.optionTables = AceDBOptions.optionTables or {} Asa@0: AceDBOptions.handlers = AceDBOptions.handlers or {} Asa@0: Asa@0: --[[ Asa@0: Localization of AceDBOptions-3.0 Asa@0: ]] Asa@0: Asa@0: local L = { Asa@0: default = "Default", Asa@0: intro = "You can change the active database profile, so you can have different settings for every character.", Asa@0: reset_desc = "Reset the current profile back to its default values, in case your configuration is broken, or you simply want to start over.", Asa@0: reset = "Reset Profile", Asa@0: reset_sub = "Reset the current profile to the default", Asa@0: choose_desc = "You can either create a new profile by entering a name in the editbox, or choose one of the already exisiting profiles.", Asa@0: new = "New", Asa@0: new_sub = "Create a new empty profile.", Asa@0: choose = "Existing Profiles", Asa@0: choose_sub = "Select one of your currently available profiles.", Asa@0: copy_desc = "Copy the settings from one existing profile into the currently active profile.", Asa@0: copy = "Copy From", Asa@0: delete_desc = "Delete existing and unused profiles from the database to save space, and cleanup the SavedVariables file.", Asa@0: delete = "Delete a Profile", Asa@0: delete_sub = "Deletes a profile from the database.", Asa@0: delete_confirm = "Are you sure you want to delete the selected profile?", Asa@0: profiles = "Profiles", Asa@0: profiles_sub = "Manage Profiles", Asa@0: current = "Current Profile:", Asa@0: } Asa@0: Asa@0: local LOCALE = GetLocale() Asa@0: if LOCALE == "deDE" then Asa@0: L["default"] = "Standard" Asa@0: L["intro"] = "Hier kannst du das aktive Datenbankprofile \195\164ndern, damit du verschiedene Einstellungen f\195\188r jeden Charakter erstellen kannst, wodurch eine sehr flexible Konfiguration m\195\182glich wird." Asa@0: L["reset_desc"] = "Setzt das momentane Profil auf Standardwerte zur\195\188ck, f\195\188r den Fall das mit der Konfiguration etwas schief lief oder weil du einfach neu starten willst." Asa@0: L["reset"] = "Profil zur\195\188cksetzen" Asa@0: L["reset_sub"] = "Das aktuelle Profil auf Standard zur\195\188cksetzen." Asa@0: L["choose_desc"] = "Du kannst ein neues Profil erstellen, indem du einen neuen Namen in der Eingabebox 'Neu' eingibst, oder w\195\164hle eines der vorhandenen Profile aus." Asa@0: L["new"] = "Neu" Asa@0: L["new_sub"] = "Ein neues Profil erstellen." Asa@0: L["choose"] = "Vorhandene Profile" Asa@0: L["choose_sub"] = "W\195\164hlt ein bereits vorhandenes Profil aus." Asa@0: L["copy_desc"] = "Kopiere die Einstellungen von einem vorhandenen Profil in das aktive Profil." Asa@0: L["copy"] = "Kopieren von..." Asa@0: L["delete_desc"] = "L\195\182sche vorhandene oder unbenutzte Profile aus der Datenbank um Platz zu sparen und um die SavedVariables Datei 'sauber' zu halten." Asa@0: L["delete"] = "Profil l\195\182schen" Asa@0: L["delete_sub"] = "L\195\182scht ein Profil aus der Datenbank." Asa@0: L["delete_confirm"] = "Willst du das ausgew\195\164hlte Profil wirklich l\195\182schen?" Asa@0: L["profiles"] = "Profile" Asa@0: L["profiles_sub"] = "Profile verwalten" Asa@0: --L["current"] = "Current Profile:" Asa@0: elseif LOCALE == "frFR" then Asa@0: L["default"] = "D\195\169faut" Asa@0: L["intro"] = "Vous pouvez changer le profil actuel afin d'avoir des param\195\168tres diff\195\169rents pour chaque personnage, permettant ainsi d'avoir une configuration tr\195\168s flexible." Asa@0: L["reset_desc"] = "R\195\169initialise le profil actuel au cas o\195\185 votre configuration est corrompue ou si vous voulez tout simplement faire table rase." Asa@0: L["reset"] = "R\195\169initialiser le profil" Asa@0: L["reset_sub"] = "R\195\169initialise le profil actuel avec les param\195\168tres par d\195\169faut." Asa@0: L["choose_desc"] = "Vous pouvez cr\195\169er un nouveau profil en entrant un nouveau nom dans la bo\195\174te de saisie, ou en choississant un des profils d\195\169j\195\160 existants." Asa@0: L["new"] = "Nouveau" Asa@0: L["new_sub"] = "Cr\195\169\195\169e un nouveau profil vierge." Asa@0: L["choose"] = "Profils existants" Asa@0: L["choose_sub"] = "Permet de choisir un des profils d\195\169j\195\160 disponibles." Asa@0: L["copy_desc"] = "Copie les param\195\168tres d'un profil d\195\169j\195\160 existant dans le profil actuellement actif." Asa@0: L["copy"] = "Copier \195\160 partir de" Asa@0: L["delete_desc"] = "Supprime les profils existants inutilis\195\169s de la base de donn\195\169es afin de gagner de la place et de nettoyer le fichier SavedVariables." Asa@0: L["delete"] = "Supprimer un profil" Asa@0: L["delete_sub"] = "Supprime un profil de la base de donn\195\169es." Asa@0: L["delete_confirm"] = "Etes-vous s\195\187r de vouloir supprimer le profil s\195\169lectionn\195\169 ?" Asa@0: L["profiles"] = "Profils" Asa@0: L["profiles_sub"] = "Gestion des profils" Asa@0: --L["current"] = "Current Profile:" Asa@0: elseif LOCALE == "koKR" then Asa@0: L["default"] = "기본값" Asa@0: L["intro"] = "모든 캐릭터의 다양한 설정과 사용중인 데이터베이스 프로필, 어느것이던지 매우 다루기 쉽게 바꿀수 있습니다." Asa@0: L["reset_desc"] = "단순히 다시 새롭게 구성을 원하는 경우, 현재 프로필을 기본값으로 초기화 합니다." Asa@0: L["reset"] = "프로필 초기화" Asa@0: L["reset_sub"] = "현재의 프로필을 기본값으로 초기화 합니다" Asa@0: L["choose_desc"] = "새로운 이름을 입력하거나, 이미 있는 프로필중 하나를 선택하여 새로운 프로필을 만들 수 있습니다." Asa@0: L["new"] = "새로운 프로필" Asa@0: L["new_sub"] = "새로운 프로필을 만듭니다." Asa@0: L["choose"] = "프로필 선택" Asa@0: L["choose_sub"] = "당신이 현재 이용할수 있는 프로필을 선택합니다." Asa@0: L["copy_desc"] = "현재 사용중인 프로필에, 선택한 프로필의 설정을 복사합니다." Asa@0: L["copy"] = "복사" Asa@0: L["delete_desc"] = "데이터베이스에 사용중이거나 저장된 프로파일 삭제로 SavedVariables 파일의 정리와 공간 절약이 됩니다." Asa@0: L["delete"] = "프로필 삭제" Asa@0: L["delete_sub"] = "데이터베이스의 프로필을 삭제합니다." Asa@0: L["delete_confirm"] = "정말로 선택한 프로필의 삭제를 원하십니까?" Asa@0: L["profiles"] = "프로필" Asa@0: L["profiles_sub"] = "프로필 설정" Asa@0: --L["current"] = "Current Profile:" Asa@0: elseif LOCALE == "esES" or LOCALE == "esMX" then Asa@0: L["default"] = "Por defecto" Asa@0: L["intro"] = "Puedes cambiar el perfil activo de tal manera que cada personaje tenga diferentes configuraciones." Asa@0: L["reset_desc"] = "Reinicia el perfil actual a los valores por defectos, en caso de que se haya estropeado la configuración o quieras volver a empezar de nuevo." Asa@0: L["reset"] = "Reiniciar Perfil" Asa@0: L["reset_sub"] = "Reinicar el perfil actual al de por defecto" Asa@0: L["choose_desc"] = "Puedes crear un nuevo perfil introduciendo un nombre en el recuadro o puedes seleccionar un perfil de los ya existentes." Asa@0: L["new"] = "Nuevo" Asa@0: L["new_sub"] = "Crear un nuevo perfil vacio." Asa@0: L["choose"] = "Perfiles existentes" Asa@0: L["choose_sub"] = "Selecciona uno de los perfiles disponibles." Asa@0: L["copy_desc"] = "Copia los ajustes de un perfil existente al perfil actual." Asa@0: L["copy"] = "Copiar de" Asa@0: L["delete_desc"] = "Borra los perfiles existentes y sin uso de la base de datos para ganar espacio y limpiar el archivo SavedVariables." Asa@0: L["delete"] = "Borrar un Perfil" Asa@0: L["delete_sub"] = "Borra un perfil de la base de datos." Asa@0: L["delete_confirm"] = "¿Estas seguro que quieres borrar el perfil seleccionado?" Asa@0: L["profiles"] = "Perfiles" Asa@0: L["profiles_sub"] = "Manejar Perfiles" Asa@0: --L["current"] = "Current Profile:" Asa@0: elseif LOCALE == "zhTW" then Asa@0: L["default"] = "預設" Asa@0: L["intro"] = "你可以選擇一個活動的資料設定檔,這樣你的每個角色就可以擁有不同的設定值,可以給你的插件設定帶來極大的靈活性。" Asa@0: L["reset_desc"] = "將當前的設定檔恢復到它的預設值,用於你的設定檔損壞,或者你只是想重來的情況。" Asa@0: L["reset"] = "重置設定檔" Asa@0: L["reset_sub"] = "將當前的設定檔恢復為預設值" Asa@0: L["choose_desc"] = "你可以通過在文本框內輸入一個名字創立一個新的設定檔,也可以選擇一個已經存在的設定檔。" Asa@0: L["new"] = "新建" Asa@0: L["new_sub"] = "新建一個空的設定檔。" Asa@0: L["choose"] = "現有的設定檔" Asa@0: L["choose_sub"] = "從當前可用的設定檔裏面選擇一個。" Asa@0: L["copy_desc"] = "從當前某個已保存的設定檔複製到當前正使用的設定檔。" Asa@0: L["copy"] = "複製自" Asa@0: L["delete_desc"] = "從資料庫裏刪除不再使用的設定檔,以節省空間,並且清理SavedVariables檔。" Asa@0: L["delete"] = "刪除一個設定檔" Asa@0: L["delete_sub"] = "從資料庫裏刪除一個設定檔。" Asa@0: L["delete_confirm"] = "你確定要刪除所選擇的設定檔嗎?" Asa@0: L["profiles"] = "設定檔" Asa@0: L["profiles_sub"] = "管理設定檔" Asa@0: --L["current"] = "Current Profile:" Asa@0: elseif LOCALE == "zhCN" then Asa@0: L["default"] = "默认" Asa@0: L["intro"] = "你可以选择一个活动的数据配置文件,这样你的每个角色就可以拥有不同的设置值,可以给你的插件配置带来极大的灵活性。" Asa@0: L["reset_desc"] = "将当前的配置文件恢复到它的默认值,用于你的配置文件损坏,或者你只是想重来的情况。" Asa@0: L["reset"] = "重置配置文件" Asa@0: L["reset_sub"] = "将当前的配置文件恢复为默认值" Asa@0: L["choose_desc"] = "你可以通过在文本框内输入一个名字创立一个新的配置文件,也可以选择一个已经存在的配置文件。" Asa@0: L["new"] = "新建" Asa@0: L["new_sub"] = "新建一个空的配置文件。" Asa@0: L["choose"] = "现有的配置文件" Asa@0: L["choose_sub"] = "从当前可用的配置文件里面选择一个。" Asa@0: L["copy_desc"] = "从当前某个已保存的配置文件复制到当前正使用的配置文件。" Asa@0: L["copy"] = "复制自" Asa@0: L["delete_desc"] = "从数据库里删除不再使用的配置文件,以节省空间,并且清理SavedVariables文件。" Asa@0: L["delete"] = "删除一个配置文件" Asa@0: L["delete_sub"] = "从数据库里删除一个配置文件。" Asa@0: L["delete_confirm"] = "你确定要删除所选择的配置文件么?" Asa@0: L["profiles"] = "配置文件" Asa@0: L["profiles_sub"] = "管理配置文件" Asa@0: --L["current"] = "Current Profile:" Asa@0: elseif LOCALE == "ruRU" then Asa@0: L["default"] = "По умолчанию" Asa@0: L["intro"] = "Изменяя активный профиль, вы можете задать различные настройки модификаций для каждого персонажа." Asa@0: L["reset_desc"] = "Если ваша конфигурации испорчена или если вы хотите настроить всё заново - сбросьте текущий профиль на стандартные значения." Asa@0: L["reset"] = "Сброс профиля" Asa@0: L["reset_sub"] = "Сброс текущего профиля на стандартный" Asa@0: L["choose_desc"] = "Вы можете создать новый профиль, введя название в поле ввода, или выбрать один из уже существующих профилей." Asa@0: L["new"] = "Новый" Asa@0: L["new_sub"] = "Создать новый чистый профиль" Asa@0: L["choose"] = "Существующие профили" Asa@0: L["choose_sub"] = "Выбор одиного из уже доступных профилей" Asa@0: L["copy_desc"] = "Скопировать настройки из выбранного профиля в активный." Asa@0: L["copy"] = "Скопировать из" Asa@0: L["delete_desc"] = "Удалить существующий и неиспользуемый профиль из БД для сохранения места, и очистить SavedVariables файл." Asa@0: L["delete"] = "Удалить профиль" Asa@0: L["delete_sub"] = "Удаление профиля из БД" Asa@0: L["delete_confirm"] = "Вы уверены, что вы хотите удалить выбранный профиль?" Asa@0: L["profiles"] = "Профили" Asa@0: L["profiles_sub"] = "Управление профилями" Asa@0: --L["current"] = "Current Profile:" Asa@0: end Asa@0: Asa@0: local defaultProfiles Asa@0: local tmpprofiles = {} Asa@0: Asa@0: -- Get a list of available profiles for the specified database. Asa@0: -- You can specify which profiles to include/exclude in the list using the two boolean parameters listed below. Asa@0: -- @param db The db object to retrieve the profiles from Asa@0: -- @param common If true, getProfileList will add the default profiles to the return list, even if they have not been created yet Asa@0: -- @param nocurrent If true, then getProfileList will not display the current profile in the list Asa@0: -- @return Hashtable of all profiles with the internal name as keys and the display name as value. Asa@0: local function getProfileList(db, common, nocurrent) Asa@0: local profiles = {} Asa@0: Asa@0: -- copy existing profiles into the table Asa@0: local currentProfile = db:GetCurrentProfile() Asa@0: for i,v in pairs(db:GetProfiles(tmpprofiles)) do Asa@0: if not (nocurrent and v == currentProfile) then Asa@0: profiles[v] = v Asa@0: end Asa@0: end Asa@0: Asa@0: -- add our default profiles to choose from ( or rename existing profiles) Asa@0: for k,v in pairs(defaultProfiles) do Asa@0: if (common or profiles[k]) and not (nocurrent and k == currentProfile) then Asa@0: profiles[k] = v Asa@0: end Asa@0: end Asa@0: Asa@0: return profiles Asa@0: end Asa@0: Asa@0: --[[ Asa@0: OptionsHandlerPrototype Asa@0: prototype class for handling the options in a sane way Asa@0: ]] Asa@0: local OptionsHandlerPrototype = {} Asa@0: Asa@0: --[[ Reset the profile ]] Asa@0: function OptionsHandlerPrototype:Reset() Asa@0: self.db:ResetProfile() Asa@0: end Asa@0: Asa@0: --[[ Set the profile to value ]] Asa@0: function OptionsHandlerPrototype:SetProfile(info, value) Asa@0: self.db:SetProfile(value) Asa@0: end Asa@0: Asa@0: --[[ returns the currently active profile ]] Asa@0: function OptionsHandlerPrototype:GetCurrentProfile() Asa@0: return self.db:GetCurrentProfile() Asa@0: end Asa@0: Asa@0: --[[ Asa@0: List all active profiles Asa@0: you can control the output with the .arg variable Asa@0: currently four modes are supported Asa@0: Asa@0: (empty) - return all available profiles Asa@0: "nocurrent" - returns all available profiles except the currently active profile Asa@0: "common" - returns all avaialble profiles + some commonly used profiles ("char - realm", "realm", "class", "Default") Asa@0: "both" - common except the active profile Asa@0: ]] Asa@0: function OptionsHandlerPrototype:ListProfiles(info) Asa@0: local arg = info.arg Asa@0: local profiles Asa@0: if arg == "common" and not self.noDefaultProfiles then Asa@0: profiles = getProfileList(self.db, true, nil) Asa@0: elseif arg == "nocurrent" then Asa@0: profiles = getProfileList(self.db, nil, true) Asa@0: elseif arg == "both" then -- currently not used Asa@0: profiles = getProfileList(self.db, (not self.noDefaultProfiles) and true, true) Asa@0: else Asa@0: profiles = getProfileList(self.db) Asa@0: end Asa@0: Asa@0: return profiles Asa@0: end Asa@0: Asa@0: function OptionsHandlerPrototype:HasNoProfiles(info) Asa@0: local profiles = self:ListProfiles(info) Asa@0: return ((not next(profiles)) and true or false) Asa@0: end Asa@0: Asa@0: --[[ Copy a profile ]] Asa@0: function OptionsHandlerPrototype:CopyProfile(info, value) Asa@0: self.db:CopyProfile(value) Asa@0: end Asa@0: Asa@0: --[[ Delete a profile from the db ]] Asa@0: function OptionsHandlerPrototype:DeleteProfile(info, value) Asa@0: self.db:DeleteProfile(value) Asa@0: end Asa@0: Asa@0: --[[ fill defaultProfiles with some generic values ]] Asa@0: local function generateDefaultProfiles(db) Asa@0: defaultProfiles = { Asa@0: ["Default"] = L["default"], Asa@0: [db.keys.char] = db.keys.char, Asa@0: [db.keys.realm] = db.keys.realm, Asa@0: [db.keys.class] = UnitClass("player") Asa@0: } Asa@0: end Asa@0: Asa@0: --[[ create and return a handler object for the db, or upgrade it if it already existed ]] Asa@0: local function getOptionsHandler(db, noDefaultProfiles) Asa@0: if not defaultProfiles then Asa@0: generateDefaultProfiles(db) Asa@0: end Asa@0: Asa@0: local handler = AceDBOptions.handlers[db] or { db = db, noDefaultProfiles = noDefaultProfiles } Asa@0: Asa@0: for k,v in pairs(OptionsHandlerPrototype) do Asa@0: handler[k] = v Asa@0: end Asa@0: Asa@0: AceDBOptions.handlers[db] = handler Asa@0: return handler Asa@0: end Asa@0: Asa@0: --[[ Asa@0: the real options table Asa@0: ]] Asa@0: local optionsTable = { Asa@0: desc = { Asa@0: order = 1, Asa@0: type = "description", Asa@0: name = L["intro"] .. "\n", Asa@0: }, Asa@0: descreset = { Asa@0: order = 9, Asa@0: type = "description", Asa@0: name = L["reset_desc"], Asa@0: }, Asa@0: reset = { Asa@0: order = 10, Asa@0: type = "execute", Asa@0: name = L["reset"], Asa@0: desc = L["reset_sub"], Asa@0: func = "Reset", Asa@0: }, Asa@0: current = { Asa@0: order = 11, Asa@0: type = "description", Asa@0: name = function(info) return L["current"] .. " " .. NORMAL_FONT_COLOR_CODE .. info.handler:GetCurrentProfile() .. FONT_COLOR_CODE_CLOSE end, Asa@0: width = "default", Asa@0: }, Asa@0: choosedesc = { Asa@0: order = 20, Asa@0: type = "description", Asa@0: name = "\n" .. L["choose_desc"], Asa@0: }, Asa@0: new = { Asa@0: name = L["new"], Asa@0: desc = L["new_sub"], Asa@0: type = "input", Asa@0: order = 30, Asa@0: get = false, Asa@0: set = "SetProfile", Asa@0: }, Asa@0: choose = { Asa@0: name = L["choose"], Asa@0: desc = L["choose_sub"], Asa@0: type = "select", Asa@0: order = 40, Asa@0: get = "GetCurrentProfile", Asa@0: set = "SetProfile", Asa@0: values = "ListProfiles", Asa@0: arg = "common", Asa@0: }, Asa@0: copydesc = { Asa@0: order = 50, Asa@0: type = "description", Asa@0: name = "\n" .. L["copy_desc"], Asa@0: }, Asa@0: copyfrom = { Asa@0: order = 60, Asa@0: type = "select", Asa@0: name = L["copy"], Asa@0: desc = L["copy_desc"], Asa@0: get = false, Asa@0: set = "CopyProfile", Asa@0: values = "ListProfiles", Asa@0: disabled = "HasNoProfiles", Asa@0: arg = "nocurrent", Asa@0: }, Asa@0: deldesc = { Asa@0: order = 70, Asa@0: type = "description", Asa@0: name = "\n" .. L["delete_desc"], Asa@0: }, Asa@0: delete = { Asa@0: order = 80, Asa@0: type = "select", Asa@0: name = L["delete"], Asa@0: desc = L["delete_sub"], Asa@0: get = false, Asa@0: set = "DeleteProfile", Asa@0: values = "ListProfiles", Asa@0: disabled = "HasNoProfiles", Asa@0: arg = "nocurrent", Asa@0: confirm = true, Asa@0: confirmText = L["delete_confirm"], Asa@0: }, Asa@0: } Asa@0: Asa@0: --- Get/Create a option table that you can use in your addon to control the profiles of AceDB-3.0. Asa@0: -- @param db The database object to create the options table for. Asa@0: -- @return The options table to be used in AceConfig-3.0 Asa@0: -- @usage Asa@0: -- -- Assuming `options` is your top-level options table and `self.db` is your database: Asa@0: -- options.args.profiles = LibStub("AceDBOptions-3.0"):GetOptionsTable(self.db) Asa@0: function AceDBOptions:GetOptionsTable(db, noDefaultProfiles) Asa@0: local tbl = AceDBOptions.optionTables[db] or { Asa@0: type = "group", Asa@0: name = L["profiles"], Asa@0: desc = L["profiles_sub"], Asa@0: } Asa@0: Asa@0: tbl.handler = getOptionsHandler(db, noDefaultProfiles) Asa@0: tbl.args = optionsTable Asa@0: Asa@0: AceDBOptions.optionTables[db] = tbl Asa@0: return tbl Asa@0: end Asa@0: Asa@0: -- upgrade existing tables Asa@0: for db,tbl in pairs(AceDBOptions.optionTables) do Asa@0: tbl.handler = getOptionsHandler(db) Asa@0: tbl.args = optionsTable Asa@0: end