Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8182043: Access to Windows Large Icons #2875

Closed
wants to merge 18 commits into from
Closed
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -263,8 +263,8 @@ public Icon getSystemIcon(File f) {
* The default implementation gets information from the
* {@code ShellFolder} class. Whenever possible, the icon
* returned will be a multi-resolution icon image,
* which will allow better scaling with different
* scaling factors.
* which will allow better support for High DPI environments

This comment has been minimized.

@aivanov-jdk

aivanov-jdk May 14, 2021
Member Outdated

I'm not sure but probably “…which allows better…” is more grammatical, as well as in the line above: “the icon returned is a multi-resolution”.

Phil or Joe could correct this.

This comment has been minimized.

@azuev-java

azuev-java May 14, 2021
Author Member Outdated

Agree.

* with different scaling factors.

This comment has been minimized.

@mrserb

mrserb May 20, 2021
Member

Is the above text correct on all platforms? If it is not always MRI then how the user should use the icon? instanceof+cast? BTW an example does not show how to solve the bug itself, on how to access the "large icons".

Need to clarify: the implSpec is a part of the specification so can we point the non public "ShellFolder" class?

This comment has been minimized.

@azuev-java

azuev-java May 20, 2021
Author Member

implSpec marks that the paragraph below describes the details and logic of the default implementation and not the API specification. This tag also says that it can be changed in overriding or extending methods so it is Ok to specify non-public class to help describe the implementation specifics.

As for the correctness on all platforms - that's the end goal of this new method and i believe it should be implemented this way everywhere where technically possible. But exact implementation on all platforms except Windows is outside of the scope of this exact changeset.

This comment has been minimized.

@mrserb

mrserb May 20, 2021
Member

The @implSpec is part of the specification, it is different from the @implNote, no?
https://bugs.openjdk.java.net/browse/JDK-8266541?focusedCommentId=14419988&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-14419988

If we will specify this method in a way that will require support on all platforms we will get tck-red immediately after this push.

This comment has been minimized.

@azuev-java

azuev-java May 20, 2021
Author Member

The @implSpec is part of the specification, it is different from the @implNote, no?
https://bugs.openjdk.java.net/browse/JDK-8266541?focusedCommentId=14419988&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-14419988

If we will specify this method in a way that will require support on all platforms we will get tck-red immediately after this push.

Not exactly. The implNote is a note for future maintainers or people who will extend the functionality of the method. There will be no tck-red because the method is working and we did noted that we are taking into consideration the icon size and whenever technical possible we should return the multiresolution icon. So, for example, on Linux code
` FileSystemView fsv = FileSystemView.getFileSystemView();

    Icon icon = fsv.getSystemIcon(new File("."));
    Icon icon2 = fsv.getSystemIcon(new File("."), 16);
    System.out.println("icon = " + icon);
    System.out.println("icon2 = " + icon2);

`
will get icon and icon2 as the same single-resolution icon - but that will change when underlying implementation will be fixed. Right now it is not technical possible to return multi-resolution icon - we do not do it on Linux. Implementing the underlaying code for different system, as i said, is outside of the scope of this change.

This comment has been minimized.

@mrserb

mrserb May 20, 2021
Member

My point was that the implspec is a normative specification and we cannot refer to non-public classes in that documentation.

This comment has been minimized.

@mrserb

mrserb May 20, 2021
Member

As for the example on Linux, how it will work for different sizes?
Icon icon1 = fsv.getSystemIcon(new File("."), 16);
Icon icon2 = fsv.getSystemIcon(new File("."), 32);
Will the resulted icons have proper size 16 and 32?

This comment has been minimized.

@azuev-java

azuev-java May 20, 2021
Author Member

No they will have the same size. That's why the broad wording is used that we take a requested size into consideration but we will return the best possible icon we can get and we do not guarantee that the icon size will change the outcome. Even on Windows if we request icon if sizes 1, 2, 3 and 4 the icon will be basically the same - minimal quality icon available.

This comment has been minimized.

@azuev-java

azuev-java May 20, 2021
Author Member

My point was that the implspec is a normative specification and we cannot refer to non-public classes in that documentation.

implSpec may describe the behavior of the default implementation and if it means referring the non-public API to clarify the behavior of this method i do not see any issue here.

This comment has been minimized.

@mrserb

mrserb May 20, 2021
Member

But it is still part of the specification unlike implnote/apinote, and we cannot use non-public classes there, since other JavaSE implementations may not have this class. see discussion on the link above.

This comment has been minimized.

@azuev-java

azuev-java May 20, 2021
Author Member

But it is still part of the specification unlike implnote/apinote

I think you can suggest usage of the implNote here - i am going from the initial description of the reason implSpec in the JEP saying that implementation and logic of it may vary between different Java SE implementations and even between different platforms so i am going with the original reasoning for implSpec tag existence. If you disagree, please file the separate issue for spec amendment once this PR is integrated. Or we can discuss it and i file follow-up bug - whatever you prefer, but i honestly think it is not a blocker and that this technical issue linger in this state for way too long.

This comment has been minimized.

@prrace

prrace May 20, 2021
Contributor

We absolutely should NOT reference a non-API class in the public javadoc, no matter whether
it is an implNote or implSpec.
Additionally, if you add or remove an implNote or implSpec or update it for something much more than a typo you will need to revise the CSR.

Really I would need to see what the actual delta ends up being to be sure for this case.

This comment has been minimized.

@azuev-java

azuev-java May 20, 2021
Author Member

Really I would need to see what the actual delta ends up being to be sure for this case.

I have updated the method documentation. Could you please take a look before i finalized the CSR again? I am really trying to push this functionality into 17 and there's not much time left. Thanks.

* <p>
* Example: <pre>
* FileSystemView fsv = FileSystemView.getFileSystemView();
@@ -1095,7 +1095,7 @@ public Image call() {
} else {
imageCache = getLargeIcon ? smallSystemImages : largeSystemImages;
}
newIcon2 = imageCache.get(Integer.valueOf(index));
newIcon2 = imageCache.get(index);
if (newIcon2 == null) {
long hIcon = getIcon(getAbsolutePath(), !getLargeIcon);
newIcon2 = makeIcon(hIcon);
@@ -936,14 +936,17 @@ JNIEXPORT jboolean JNICALL Java_sun_awt_shell_Win32ShellFolder2_hiResIconAvailab
UINT uFlags = GIL_FORSHELL | GIL_ASYNC;
hres = pIcon->GetIconLocation(uFlags, szBuf, MAX_PATH, &index, &flags);
if (SUCCEEDED(hres)) {
pIcon->Release();
return wcscmp(szBuf, L"*") != 0;
} else if (hres == E_PENDING) {
uFlags = GIL_DEFAULTICON;
hres = pIcon->GetIconLocation(uFlags, szBuf, MAX_PATH, &index, &flags);
if (SUCCEEDED(hres)) {
pIcon->Release();
return wcscmp(szBuf, L"*") != 0;
}
}
pIcon->Release();
}
return FALSE;
}