DolphinQt: Add "File Path" column to Game Grid #8580

AlexApps99 · 2020-01-24T08:09:24Z

The path is generated by finding a file path that contains the filename, then removing the path to that path.

Example:
File paths: /home/foo/games, /home/foo/Desktop/wii
Game path: /home/foo/games/gcn/ntsc/fun game.gcn
~~File name listed: gcn/ntsc/fun game.gcn~~
File name listed: games/gcn/ntsc/fun game.gcn

dir.lastIndexOf uses -2 in the case that the file path ends with a trailing slash.

Fixes https://bugs.dolphin-emu.org/issues/10567

This is my first PR to Dolphin, so a thorough review would be awesome, ~~and let me know if this would be better as its' own column instead of replacing "File name".~~

MayImilae · 2020-01-24T10:15:00Z

Definitely make this a new column please.

AlexApps99 · 2020-01-24T10:16:29Z

Ok, do you have any other feedback?

MayImilae · 2020-01-24T10:19:48Z

Nothing else for the moment. I'll give it a proper try tomorrow and give you additional feedback then, it's 2am here!

CookiePLMonster · 2020-01-26T09:49:18Z

Looks good, but is it hidden by default? I imagine this is one of those columns you'd rather default to hidden and allow the user to show it later.

AlexApps99 · 2020-01-26T09:49:57Z

I think it isn't shown by default, but I haven't verified it

CookiePLMonster · 2020-01-26T09:51:37Z

Please verify then. I'd also appreciate a screenshot as I'm curious how does this display.

AlexApps99 · 2020-01-26T09:53:01Z

Ok, deleted config from ~/.config/dolphin-emu/ and ran it.
It is hidden by default

AlexApps99 · 2020-01-26T09:56:05Z

Screenshots of it in action

CookiePLMonster

As far as I understand, you made it strip "common" parts of the path basing on Game Folders list. If I understand it correctly, then it doesn't work as intended on Windows:

EDIT:
You probably need to convert those QStrings to paths (QFileInfo?) and work from that.

AlexApps99 · 2020-01-26T11:06:51Z

The issue is that the path in Settings uses backslashes and the function to get the path uses forwardslashes.

I'll work on a fix right now

CookiePLMonster · 2020-01-26T11:08:09Z

Hence my remark that you probably need to compare those as paths and not strings - it'd most likely save some headache with more edge cases and not just slashes.

AlexApps99 · 2020-01-26T11:09:06Z

Thanks for the advice, will do that

AlexApps99 · 2020-01-26T11:33:42Z

Is this implementation valid? It removes all symlinks/backslashes so the strings will be correctly formatted.

Otherwise, how would I check if a directory is contained in another? I couldn't find a function for this in QFileInfo's docs

Your feedback is appreciated

CookiePLMonster · 2020-01-26T11:51:56Z

Sorry, I might have been mistaken. Looks like the function you need here is QDir::cleanPath.

So IMO you could erase your last commit by undoing everything in it and just filtering paths with this function, then you should be able to compare everything as you did previously.

As for erasing the commit, you could undo the changes, apply QDir::cleanPath changes, then amend the commit and rename it, then force push (it's fine since it's your own branch).

AlexApps99 · 2020-01-26T12:01:35Z

Done

Source/Core/DolphinQt/GameList/GameListModel.cpp

AlexApps99 · 2020-01-26T12:30:43Z

I gotta go to sleep now (1:30am here), thanks for all of the assistance so far @CookiePLMonster :)

CookiePLMonster · 2020-01-26T13:20:14Z

Unfortunately it still seems to be invalid:

I will debug this in a few hours.

Or maybe I am misunderstanding this feature? How exactly do you expect it to work? Basing on your screenshots I expect my paths to be like

Crash Bandicoot...
Mario Kart...
MGS\Metal Gear...
PaperMario...

CookiePLMonster

Funny, build artifacts for a force pushed build must have been incorrect since I built your branch locally and it works probably as expected:

mbc07 · 2020-01-26T21:20:47Z

Shouldn't it display back slashes instead of forward slashes on Windows?

CookiePLMonster · 2020-01-26T21:22:18Z

~~I don't think it matters. I'm not convinced you can get Qt to output a "platform natural" path, and that's what you'd need in this case.~~

Not true, QDir::toNativeSeparators performs exactly that conversion so we could apply this after comparison/slicing for "better" display style.

AlexApps99 · 2020-01-26T21:24:33Z

cleanPath will always output forwardslashes, I could either check the platform and replace all forwardslashes with backslashes, or find a different function.

CookiePLMonster · 2020-01-26T21:25:36Z

I think performing comparisons and slicing on "clean" paths is a good idea - but may want to use "native separators" path for solely for displaying it to the user.

AlexApps99 · 2020-01-26T21:26:36Z

Maybe I could put the processed path back into QFileInfo or QDir and get a platform-native relative path

CookiePLMonster · 2020-01-26T21:27:11Z

No need - QDir::toNativeSeparators should do exactly what you need :)

AlexApps99 · 2020-01-26T21:27:36Z

Awesome, will add that as soon as I can 👍

CookiePLMonster · 2020-01-26T21:59:23Z

Excellent :)

Note to self: Verify that paths display consistently everywhere, as right now in Game Folders I can see paths with both styles. Ideally, they should be stored in "clean" format (so they are cross platform) but stored in "native" format!

CookiePLMonster · 2020-01-26T22:01:41Z

Hmm now that's interesting, did lint bot spot missing brackets or incorrect indentation? Could be both, depending on what you intended this code to do.

AlexApps99 · 2020-01-26T22:03:15Z

Yeah, it was missing brackets... Oops

CookiePLMonster · 2020-01-26T22:44:33Z

One more nitpick - I see you have edited an example of how it is supposed to work (or it's been there and I am just blind), and it would seem like Game Folder path is not to be included in the shown path at all. Yet, if you see the screens I posted above for me dolphin-games still shows in those paths, despite being part of both game folder paths.

Any idea what's up with that?

AlexApps99 · 2020-01-26T22:46:22Z

That is a typo, the path shortening behaviour works as I intended it to
If you'd prefer that I remove the base folder path from the columns, that's fine too

AlexApps99 · 2020-01-27T00:44:48Z

@CookiePLMonster should I keep the current functionality or change it to reflect the old example?

CookiePLMonster · 2020-01-27T08:34:11Z

@CookiePLMonster should I keep the current functionality or change it to reflect the old example?

For me the way it works now is good - let's wait for somebody else (preferably those who can merge) to comment on it too.

Source/Core/DolphinQt/GameList/GameListModel.cpp

AlexApps99 · 2020-01-30T21:13:30Z

What else needs to be done to complete this PR?

CookiePLMonster · 2020-01-30T21:31:14Z

What else needs to be done to complete this PR?

I would say it's finished. At this point just sit tight and wait until somebody who
a) is involved with UI
b) has merge rights
reviews it.

Pokechu22 · 2020-03-02T01:20:21Z

I've found a slight weird behavior: if one game folder is nested within another, then the way the path is shortened depends on which one comes first in the list. Listing like this:

$F:\Test\Maindir, then F:\Test\Maindir\Subdir$

gives this:

$Maindir\a.dol, then Maindir\Subdir\b.dol$

while listing like this:

$F:\Test\Maindir\Subdir, then F:\Test\Maindir$

gives this:

$Maindir\a.dol, then Subdir\b.dol$

This probably doesn't matter too much, though, since I suspect most people with a nested setup will just have search subfolders on. (Also, the F:\Test\ part was successfully stripped on Windows, so that at least is fixed.)

AlexApps99 · 2020-03-02T01:23:32Z

I did that because of simplicity, if it's a problem then I could try sort the paths by length before comparing so the most nested paths are checked first.

stenzek · 2020-03-02T01:27:11Z

Source/Core/DolphinQt/GameList/GameListModel.cpp

+  case COL_FILE_PATH:
+    if (role == Qt::DisplayRole || role == Qt::InitialSortOrderRole)
+    {
+      QString file_path = QDir::cleanPath(QString::fromStdString(game.GetFilePath()));


I'm a little concerned about the performance impact of the logic here when used with very large game lists. But, I guess if the column is hidden by default, it shouldn't get executed.

How do you suggest I improve the performance impact?

Would probably require caching the string in the game list struct. But again, since it's not enabled by default, I don't think it matters all that much.

MayImilae · 2020-03-02T01:30:48Z

Gave this a quick check. It's not enabled by default, and it all works as advertised!

However, I'm puzzled by the fact that it only shows one tree above the file name. Doesn't that greatly reduce its usefulness?

Here's an example, an issue that I've run into before that this PR could help with, but doesn't.

These two games appear exactly the same under this PR. However, if we take a peek at the full paths...

One is on my NAS, the other is local.

This is something that this PR could genuinely help with over just showing file names. I use my NAS for storing my games, but I do a local mirror of any game I'm playing through at the moment, with both paths accessible to Dolphin at all times. File names won't help with this, and neither would anything else in the GUI. Only file paths could help. But because this PR only goes up one level, it can't show that difference. It's no more useful than file names here.

Of course, I could rename the folder of my local mirror folder. But at that point, I could also just rename the local mirrored version of the iso's file name, which would work without this PR at all, so...

IMO, I think this PR should just show the full file path. Yes it'll be long, but it's useful in handling edge cases like the one I just outlined where file names are not sufficient. There are also other cases, like having games on a bulk storage drive and an SSD mirror that would this would also apply to. Just showing one folder up from the file name doesn't offer much.

As for the length, why not just show only the path and not the file name? Why have the file name present in the file path when there is a dedicated column for that? That would greatly cut down on the length of the file path column and uses can add the file name column if they want that information.

AlexApps99 · 2020-03-02T01:33:32Z

Those are good points you make, I'll use the full file path instead.

Fixes https://bugs.dolphin-emu.org/issues/10567

AlexApps99 · 2020-03-02T08:49:52Z

@MayImilae I've integrated the changes you have requested

Should I include the trailing slash? I'm unsure

CookiePLMonster · 2020-03-02T09:05:26Z

Not to be "that guy", but I guess that if you're to show a full path after all then QFileInfo::path() may be better than tokenizing the path on your own?

MayImilae · 2020-03-02T10:36:10Z

@AlexApps99 Much better! And yea, the final slash might be nice for combination things like this.

AlexApps99 · 2020-03-02T20:22:41Z

Using QFileInfo::path() is a good idea, I'll use that soon

AlexApps99 · 2020-03-02T23:03:45Z

It now uses QFileInfo, and the trailing slash is included too.

MayImilae

LGTM!

spycrab

LGTM

AlexApps99 requested a review from JosJuice January 24, 2020 08:11

AlexApps99 changed the title ~~Add path to File Name column of game grid~~ DolphinQt: Add path to File Name column of game grid Jan 25, 2020

AlexApps99 changed the title ~~DolphinQt: Add path to File Name column of game grid~~ DolphinQt: Add "File Path" column to Game Grid Jan 25, 2020

CookiePLMonster approved these changes Jan 26, 2020

View reviewed changes

CookiePLMonster suggested changes Jan 26, 2020

View reviewed changes

CookiePLMonster reviewed Jan 26, 2020

View reviewed changes

Source/Core/DolphinQt/GameList/GameListModel.cpp Outdated Show resolved Hide resolved

AlexApps99 removed the request for review from JosJuice January 26, 2020 12:29

CookiePLMonster approved these changes Jan 26, 2020

View reviewed changes

Tilka reviewed Jan 27, 2020

View reviewed changes

Source/Core/DolphinQt/GameList/GameListModel.cpp Show resolved Hide resolved

stenzek reviewed Mar 2, 2020

View reviewed changes

Add path to File Name column of game grid

7408c38

Fixes https://bugs.dolphin-emu.org/issues/10567

Used whole path instead of relative path

465e7c2

CookiePLMonster approved these changes Mar 3, 2020

View reviewed changes

MayImilae approved these changes Mar 3, 2020

View reviewed changes

spycrab approved these changes Mar 6, 2020

View reviewed changes

spycrab merged commit dcaabca into dolphin-emu:master Mar 6, 2020

CookiePLMonster mentioned this pull request Mar 19, 2020

Qt/GameListModel: Use native separators in File Path column #8679

Merged

MayImilae mentioned this pull request May 7, 2020

File name column will show the directory name for extracted games #8798

Open

DolphinQt: Add "File Path" column to Game Grid #8580

DolphinQt: Add "File Path" column to Game Grid #8580

Conversation

AlexApps99 commented Jan 24, 2020 • edited

MayImilae commented Jan 24, 2020

AlexApps99 commented Jan 24, 2020

MayImilae commented Jan 24, 2020

CookiePLMonster commented Jan 26, 2020

AlexApps99 commented Jan 26, 2020 • edited

CookiePLMonster commented Jan 26, 2020

AlexApps99 commented Jan 26, 2020

AlexApps99 commented Jan 26, 2020 • edited

CookiePLMonster left a comment • edited

Choose a reason for hiding this comment

AlexApps99 commented Jan 26, 2020

CookiePLMonster commented Jan 26, 2020

AlexApps99 commented Jan 26, 2020

AlexApps99 commented Jan 26, 2020

CookiePLMonster commented Jan 26, 2020

AlexApps99 commented Jan 26, 2020

AlexApps99 commented Jan 26, 2020

CookiePLMonster commented Jan 26, 2020 • edited

CookiePLMonster left a comment

Choose a reason for hiding this comment

mbc07 commented Jan 26, 2020

CookiePLMonster commented Jan 26, 2020 • edited

AlexApps99 commented Jan 26, 2020

CookiePLMonster commented Jan 26, 2020

AlexApps99 commented Jan 26, 2020

CookiePLMonster commented Jan 26, 2020

AlexApps99 commented Jan 26, 2020

CookiePLMonster commented Jan 26, 2020

CookiePLMonster commented Jan 26, 2020

AlexApps99 commented Jan 26, 2020

CookiePLMonster commented Jan 26, 2020

AlexApps99 commented Jan 26, 2020

AlexApps99 commented Jan 27, 2020

CookiePLMonster commented Jan 27, 2020

AlexApps99 commented Jan 30, 2020

CookiePLMonster commented Jan 30, 2020

Pokechu22 commented Mar 2, 2020

AlexApps99 commented Mar 2, 2020

stenzek Mar 2, 2020

Choose a reason for hiding this comment

AlexApps99 Mar 2, 2020

Choose a reason for hiding this comment

stenzek Mar 2, 2020

Choose a reason for hiding this comment

MayImilae commented Mar 2, 2020

AlexApps99 commented Mar 2, 2020

AlexApps99 commented Mar 2, 2020

CookiePLMonster commented Mar 2, 2020

MayImilae commented Mar 2, 2020

AlexApps99 commented Mar 2, 2020

AlexApps99 commented Mar 2, 2020

MayImilae left a comment

Choose a reason for hiding this comment

spycrab left a comment

Choose a reason for hiding this comment

AlexApps99 commented Jan 24, 2020 •

edited

AlexApps99 commented Jan 26, 2020 •

edited

AlexApps99 commented Jan 26, 2020 •

edited

CookiePLMonster left a comment •

edited

CookiePLMonster commented Jan 26, 2020 •

edited

CookiePLMonster commented Jan 26, 2020 •

edited