Fix log trimming logic, rename some variables to be consitent and more intuitive

Author: JonBooth78

data/modules/FlightLog/FlightLog.lua

@@ -19,24 +19,138 @@ local Character = require 'Character'
 
 local FlightLogEntry = require 'modules.FlightLog.FlightLogEntries'
 
-
 -- default values (private)
 ---@type integer
-local MaxTotalDefaultElements = 3000
+local MaxTotalNonCustomElements = 3000
 
 -- private data - the log itself
 ---@type FlightLogEntry.Base[]
 local FlightLogData = {}
-local FlightLogDefaultElementCount = 0
 
-local FlightLog
-FlightLog = {}
+local FlightLog = {}
+
+---How many default (so without custom elements) entries are there?
+---@type integer
+local NonCustomElementCount = 0
+
+---@praram count integer The amount to alter the count of default elements by
+local function AdjustNonCustomElementCount( count )
+	NonCustomElementCount = NonCustomElementCount + count
+end
+
+FlightLogEntry.Base.non_custom_count_change = AdjustNonCustomElementCount
+
+--- If there are two system events back to back, starting at first_index
+--- entering and leaving the same system, it will put them together
+--- as a single system event
+---
+---@param first_index integer The index of the first element in the array (so the latest event) to collapse
+---@return boolean true if the two were collapesed.
+local function ConsiderCollapseSystemEventPair( first_index )
+
+	if #FlightLogData < 2 then return false end
+
+	local second = FlightLogData[first_index]
+	local first = FlightLogData[first_index+1]
+
+	if ( second:IsCustom() ) then return false end
+	if ( second:GetType() ~= "System" ) then return false end
+	---@cast second SystemLogEntry
+
+	-- is the latest one actually an arrival event, or already collapsed.
+	if ( second.arrtime ~= nil ) then return fale end
+
+	if ( first:IsCustom() ) then return false end
+	if ( first:GetType() ~= "System" ) then return false end
+	---@cast first SystemLogEntry
+
+	-- is the first one actually a departure event or already collapsed
+	if ( first.deptime ~= nil ) then return false end
+
+	if ( first.systemp ~= second.systemp ) then return false end
+
+	second.arrtime = first.arrtime
+	table.remove( FlightLogData, first_index+1 )
+
+	AdjustNonCustomElementCount( -1 )
+
+	return true
+end
+
+
+-- This will run through the array of events and if there are two system events
+-- back to back, entering and leaving the same system, it will put them together
+-- as a single system event
+local function CollapseSystemEvents()
+	for i = #FlightLogData-1, 1, -1 do
+		ConsiderCollapseSystemEventPair( i )
+	end
+end
+
+-- This will run through the array of events and remove any non custom ones
+-- if we have exceeded our maximum size, until that maximum size is reattained.
+local function TrimLogSize()
+	if NonCustomElementCount > MaxTotalNonCustomElements then
+		CollapseSystemEvents()
+
+		if NonCustomElementCount > MaxTotalNonCustomElements then
+			for i = #FlightLogData, 1, -1 do
+				local v = FlightLogData[i]
+				if not v:IsCustom() then
+					table.remove( FlightLogData, i )
+					AdjustNonCustomElementCount( -1 )
+					if i > 1 then
+						ConsiderCollapseSystemEventPair( i-1 )
+					end
+
+					if NonCustomElementCount <= MaxTotalNonCustomElements then 
+						return
+					end
+				end
+			end	
+		end
+	end
+end
 
 --
 -- Group: Methods
 --
+-- Method: AddEntry
 --
+-- Adds an entry to the flightlog
 --
+-- Parameters:
+--   entry - The entry to add to the list
+---@param entry FlightLogEntry.Base
+function FlightLog.AddEntry(entry)
+	table.insert(FlightLogData, 1, entry )
+
+	if not entry:IsCustom() then 
+		AdjustNonCustomElementCount( 1 )
+	end
+
+	if not ConsiderCollapseSystemEventPair(1) then
+		TrimLogSize() 
+	end
+end
+
+-- Method: RemoveEntry
+--
+-- Removes an entry from the flightlog
+--
+-- Parameters:
+--   entry - The entry to remove from the list
+---@param entry FlightLogEntry.Base
+function FlightLog:RemoveEntry(entry)
+	if not entry:IsCustom() then
+		AdjustNonCustomElementCount( -1 )
+	end
+	local index = utils.remove_elem( FlightLogData, entry )
+	if index > 1 then
+		ConsiderCollapseSystemEventPair( index-1 )
+	end
+end
+
 -- Method: MakeCustomEntry
 --
 -- Create a custom entry. A set of information is automatically
@@ -92,8 +206,11 @@ function FlightLog:MakeCustomEntry(text)
 		location = {state, sysname}
 	end
 
-	table.insert(FlightLogData,1, FlightLogEntry.Custom.New( path, Game.time, Game.player:GetMoney(), location, text ) )
+	FlightLog.AddEntry( FlightLogEntry.Custom.New( path, Game.time, Game.player:GetMoney(), location, text ) )
 end
+
+
+
 -- Method: GetLogEntries
 --
 -- Example:
@@ -141,91 +258,27 @@ function FlightLog:GetLogEntries(types, maximum, earliest_first)
 	end
 end
 
---- If there are two system events back to back, starting at first_index
---- entering and leaving the same system, it will put them together
---- as a single system event
----
----@param first_index integer The index of the first element in the array (so the latest event) to collapse
-local function ConsiderCollapseSystemEventPair( first_index )
-
-	local second = FlightLogData[first_index] 
-	local first = FlightLogData[first_index+1]
-
-	if ( second:IsCustom() ) then return end
-	if ( second:GetType() ~= "System" ) then return end
-	---@cast second SystemLogEntry
-
-	-- is the latest one actually an arrival event, or already collapsed.
-	if ( second.arrtime ~= nil ) then return end
-
-	if ( first:IsCustom() ) then return end
-	if ( first:GetType() ~= "System" ) then return end
-	---@cast first SystemLogEntry
-
-	-- is the first one actually a departure event or already collapsed
-	if ( first.deptime ~= nil ) then return end
-
-	if ( first.systemp ~= second.systemp ) then return end
-
-	second.arrtime = first.arrtime
-	table.remove( FlightLogData, first_index+1 )
-	
-end
-
-
--- This will run through the array of events and if there are two system events
--- back to back, entering and leaving the same system, it will put them together
--- as a single system event
-local function CollapseSystemEvents()
-	for i = #FlightLogData-1, 1, -1 do
-		ConsiderCollapseSystemEventPair( i )
-	end
-end
-
--- This will run through the array of events and remove any non custom ones
--- if we have exceeded our maximum size, until that maximum size is reattained.
-local function TrimLogSize()
-	if FlightLogEntry.TotalDefaultElements > MaxTotalDefaultElements then
-		CollapseSystemEvents()
-		while FlightLogEntry.TotalDefaultElements > MaxTotalDefaultElements do
-			for i = #FlightLogData, 1, -1 do
-				local v = FlightLogData[i]
-				if not v:IsCustom() then
-					table.remove( FlightLogData, i )
-					FlightLogEntry.TotalDefaultElements = FlightLogEntry.TotalDefaultElements-1
-				end
-			end	
-		end
-		CollapseSystemEvents()
-	end
-end
-
-
 -- LOGGING
 
 -- onLeaveSystem
 local AddSystemDepartureToLog = function (ship)
 	if not ship:IsPlayer() then return end
 
-	table.insert( FlightLogData, 1, FlightLogEntry.System.New( Game.system.path, nil, Game.time, nil ) );
-	ConsiderCollapseSystemEventPair( 1 )
-	TrimLogSize()
+	FlightLog.AddEntry( FlightLogEntry.System.New( Game.system.path, nil, Game.time, nil ) )
 end
 
 -- onEnterSystem
 local AddSystemArrivalToLog = function (ship)
 	if not ship:IsPlayer() then return end
 
-	table.insert( FlightLogData, 1, FlightLogEntry.System.New( Game.system.path, Game.time, nil, nil ) );
-	TrimLogSize()
+	FlightLog.AddEntry( FlightLogEntry.System.New( Game.system.path, Game.time, nil, nil ) )
 end
 
 -- onShipDocked
 local AddStationToLog = function (ship, station)
 	if not ship:IsPlayer() then return end
 
-	table.insert( FlightLogData, 1, FlightLogEntry.Station.New( station.path, Game.time, Game.player:GetMoney(), nil ) );
-	TrimLogSize()
+	FlightLog.AddEntry( FlightLogEntry.Station.New( station.path, Game.time, Game.player:GetMoney(), nil ) )
 end
 
 -- LOADING AND SAVING
@@ -273,12 +326,19 @@ local onGameStart = function ()
 		FlightLogData = loaded_data.Data
 	end
 
+	NonCustomElementCount = 0
+	for _, e in pairs(FlightLogData) do
+		if not e:IsCustom() then
+			AdjustNonCustomElementCount( 1 )
+		end
+	end
+
 	loaded_data = nil
 end
 
 local onGameEnd = function ()
 	FlightLogData = {}
-	FlightLogEntry.TotalDefaultElements = 0
+	NonCustomElementCount = 0
 end
 
 local serialize = function ()