CommonLua/GedEditedObject.lua

-- Supports storing of editor data via :EditorData() and tracking dirty status

DefineClass("GedEditedObject")

if FirstLoad then
	g_GedEditorData = setmetatable({}, weak_keys_meta)
	g_DirtyObjects = {}
	g_DirtyObjectsById = {}
end

local function notify_dirty_status(obj, dirty)
	g_DirtyObjects[obj] = dirty or nil
	GedUpdateDirtyObjectsById()
	GedNotify(obj, "OnEditorDirty", dirty)
	for id, ged in pairs(GedConnections) do
		GedUpdateObjectValue(ged, nil, "root|dirty_objects")
	end
end

function GedEditedObject:EditorData()
	local data = g_GedEditorData[self]
	if not data then
		data = {}
		g_GedEditorData[self] = data
	end
	return data
end

-- calculate original hash when the object is displayed in Ged for editing
function OnMsg.GedBindObj(obj)
	while obj do
		if IsKindOf(obj, "GedEditedObject") then
			obj:TrackDirty()
		end
		obj = ParentTableCache[obj]
	end
end

-- update current hash when the object is modified in Ged
function OnMsg.ObjModified(obj)
	while obj do
		if IsKindOf(obj, "GedEditedObject") and obj:IsOpenInGed() then
			obj:UpdateDirtyStatus()
		end
		obj = ParentTableCache[obj] and GetParentTableOfKind(obj, "GedEditedObject")
	end
end

function GedEditedObject:IsOpenInGed()
	assert(false, "Not implemented") -- please implement in the children classes
end

function GedEditedObject:TrackDirty()
	local data = self:EditorData()
	if not data.old_hash then
		data.old_hash = self:CalculatePersistHash()
		data.current_hash = data.old_hash
	end
end

function GedEditedObject:UpdateDirtyStatus()
	local data = self:EditorData()
	local old_hash = data.old_hash
	if old_hash then
		local new_hash = self:CalculatePersistHash()
		if data.current_hash ~= new_hash then
			data.current_hash = new_hash
			notify_dirty_status(self, old_hash ~= new_hash)
		end
	end
end

function GedEditedObject:IsDirty()
	local data = self:EditorData()
	local old_hash = data.old_hash
	return old_hash and (old_hash == 0 or old_hash ~= data.current_hash)
end

function GedEditedObject:MarkDirty(notify)
	if not self:IsDirty() then
		self:EditorData().old_hash = 0
		if notify ~= false then
			notify_dirty_status(self, true)
		end
	end
end

function GedEditedObject:MarkClean()
	local data = self:EditorData()
	data.current_hash = self:CalculatePersistHash()
	if self:IsDirty() then
		data.old_hash = data.current_hash
		notify_dirty_status(self, false)
	end
end


----- Send dirty objects to Ged, so * modified marks can be displayed for them

function GedUpdateDirtyObjectsById()
	local dirty = {}
	for obj in pairs(g_DirtyObjects) do
		dirty[tostring(obj)] = true
		-- mark a preset as dirty if any of its linked presets (defined via a linked_presets property) are dirty
		for parent_preset, linked_presets in pairs(LinkedPresetClasses) do
			if table.find(linked_presets, obj.class) then
				local obj = FindLinkedPresetOfClass(obj, parent_preset)
				if obj then
					dirty[tostring(obj)] = true
				end
			end
		end
	end
	g_DirtyObjectsById = dirty
end

function GedGetDirtyObjects(obj, filter, preset_class)
	return g_DirtyObjectsById
end