Update the flightlog rebased

[JonBooth78]

User facing changes:

_Note: This replaces / closes #5636 as due to the way I did some merging along the way (since rebased away and hidden in this branch), I could no-longer update that PR.

Note: Screenshots below have alpha baked into them so the background looks a little off on the export window as that grey is actually transparent so the background actually appears black

Export Collapsed

Export Expanded

Description

• Consolidate the three tabs of the flightlog into a single page with all entries on it
• Add an options bar to the right hand side to toggle on and off individual types of log entry from the displayed list so you can still see what you’d like
• When pruning the flightlog for space reasons, never remove any elements that have a custom annotation/note added by the user
• Split system flight log entries into a separate arrival and destination entry if there are other entries that come chronologically between them
• Add the ability to order the flightlog oldest to newest as well as the default newest to oldest
• Remove the spurious log on game start of the player docking at their starting station
• Add the option showing the current player stats to the flightlog at the top
• Add the ability to export the currently displayed flightlog to a file, located in the userdata folder based on the player’s name, either as plain text or HTML

Potentially controversial changes I’m aware of:

• Adding an optional window layout to the tab layout to allow me to add a floating window at the bottom of the screen. I'm also considering (in the future) to use this to allow a popup when editing a flightlog entry, with a multi-line entry box as although imgui doesn't support word-wrapping entry boxes this would feel nicer and mitigate that a bit too.
• This is very much showing my working in the order of commits

Things I’ve tested:

• Loading existing games
• Saving games and reloading them with the new flightlog format
• Starting a new game
• Jumping between systems
• Landing at spaceports
• Custom flightlog entries and adding custom annotations to other entries

Things I am considering to doing later:

• Change the backing model such that system and station events are container events that can contain events that happened when within that system or station. System events of course will contain station events.
• Buttons to add the location of flightlog entries to the current system navigation route
• Automatic flight log entries when a ship is killed by the player
• Automatic flight log entries when the player changes their ship
• Automatic flight log entries when the player changes the ship equipment
• Automatic flight log entries for commerce, so when the user purchases or sells cargo
• Automatic flight log entries when missions are started/failed/completed
• Automatic flight log entries when a screenshot is taken and some way to view it from the log (as long as it’s still on disc)
• Filters for all of the above
• CSV export

[impaktor]

1. @Web-eWorks I assume this is good to merge, as I think that was the state of the original PR this is based from?

This is very much showing my working in the order of commits

So rebase, or we can just squash merge, or do we want to keep all commits? E.g I see new functions like l_pigui_set_next_window_collapsed and ui.setNextWindowCollapsed that could be their own "New function to allow X". I just don't want the full development history in master, as some developers rely on clean / non-messy commit history to understand which feature caused a line to change.

[JonBooth78]

@Web-eWorks , I think this is ready for final review, although looks like it'll need rebasing again on master.

[JonBooth78]

Rebased. I'm wondering if I'll hit some clang format errors now ?

[JonBooth78]

Yeah, hit some clang format errors, I'll have to sort them out later in the week - sorry

[JonBooth78]

@Web-eWorks , this should now be ready for review.

[sturnclaw]

I'm quite happy with the effect and direction of this PR. I do apologize for not getting through the review until now - my schedule has been quite busy and I've accidentally let things slip through the cracks like this review.

I've left (several!) comments where there are things I'd like to see addressed, either as part of this PR directly or in a follow-up PR if you're not confident in being able to address them all in the next ~2 weeks. We'll be entering formal "feature freeze" on the 27th and anything not bugfix/stability related will be put on hold at that point until the release.

Overall I consider this PR to be functional enough to merge as part of the release, but in addition to the nitpicks that comprise most of the comments I've left there are a few maintainability concerns regarding serialization and dataflow that I'd like to see addressed long-term.

[sturnclaw]

Looks good, thanks for addressing the last round of review comments. I've gone over the diff again and only one additional area has stood out to me as something that could be improved.

Before merge, I'd like you to address the table[key, value] -> table<key, value> annotation issues (they're not high severity but they are very quick to fix) and you indicated prior you intended to address the NaturalDocs formatting - otherwise, the remaining outstanding issues are an "at your discretion" priority.

I plan to merge this PR sometime Sunday evening/night EST - hopefully that gives you enough time to address the remaining issues. If not, let me know any time and I'll merge sometime next week.

[sturnclaw]

Looks good to me, thanks for addressing that formatting issue. At this point I'd recommend rebasing and squashing together related changes / iterative improvement commits to clean up the history (in the name of appeasing @impaktor, the resident git fascist 😄).

[JonBooth78]

@Web-eWorks following up on your recommendation to tidy up counting elements and I found a bug and another issue I'm tidying. Hope to have it done in the next 3-4 hours

[sturnclaw]

@JonBooth78 bump - ETA on final squash + rebase? I'd like to merge this before #5706.

[JonBooth78]

@Web-eWorks , this is all tidied up ready to merge. Apologies it took so long, I was trying to do it step by step and kept tripping over the file split that git failed to track (well github refused to track for pushing new changes to the PR, hence having to create this second one in the first place) - oh that and a bug in my git client (which I've updated and now it's gone away) . In the end realized that if we pulled all the non-flightlog related changes ahead of all the flightlog related ones and the rename that we can track, then the rest can be a single, stand alone commit.

[sturnclaw]

@JonBooth78 started a new game from the latest commit, initial entry is missing its custom description.

[sturnclaw]

Fixed - it was an errant colon in the function declaration for FlightLog.MakeCustomEntry 😄

(My editor apparently cleaned up a lot of trailing whitespace on save too - if using VSCode I'd definitely recommend turning on the Trim Trailing Whitespace and Insert Final Newline options...)

[JonBooth78]

Thanks!

…

On Fri, 26 Jan 2024, 21:38 Webster Sheets, ***@***.***> wrote: Fixed - it was an errant colon in the function declaration for FlightLog.MakeCustomEntry 😄 — Reply to this email directly, view it on GitHub <#5666 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAB44LZOXEXDAEUHGVH4MNDYQNTSFAVCNFSM6AAAAAA7RNIQC2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMJRGY3TGOBRHE> . You are receiving this because you were mentioned.Message ID: ***@***.***>