Added standard Kernel32Util#closeHandle method that throws an exception if failed to close the handle #614
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -80,6 +80,90 @@ public static void freeGlobalMemory(Pointer ptr) { | |
| } | ||
| } | ||
|
|
||
| /** | ||
| * Closes all referenced handles. If an exception is thrown for | ||
| * a specific handle, then it is accumulated until all | ||
| * handles have been closed. If more than one exception occurs, | ||
| * then it is added as a suppressed exception to the first one. | ||
| * Once closed all handles, the accumulated exception (if any) is thrown | ||
| * | ||
| * @param refs The references to close | ||
| * @see #closeHandleRef(HANDLEByReference) | ||
| */ | ||
| public static void closeHandleRefs(HANDLEByReference... refs) { | ||
|
There was a problem hiding this comment. Maybe should just be called There was a problem hiding this comment. I thought about that, but decided it would be easier to understand the code - if you feel strongly about it I have no major objection to renaming it to closeHandles There was a problem hiding this comment. I don’t think there’s a problem understanding it when simply named “closeHandles"; the goal is to close handles, regardless of the form used to specify the handles. I generally don’t like codifying parameter types into function names.
There was a problem hiding this comment. Agreed, @lgoldstein you should change it. Thanks! |
||
| Win32Exception err = null; | ||
| for (HANDLEByReference r : refs) { | ||
| try { | ||
| closeHandleRef(r); | ||
| } catch(Win32Exception e) { | ||
| if (err == null) { | ||
| err = e; | ||
| } else { | ||
| err.addSuppressed(e); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (err != null) { | ||
| throw err; | ||
| } | ||
| } | ||
| /** | ||
| * Closes the handle in the reference | ||
| * | ||
| * @param ref The handle reference - ignored if {@code null} | ||
| * @see #closeHandle(HANDLE) | ||
| */ | ||
| public static void closeHandleRef(HANDLEByReference ref) { | ||
|
|
||
| closeHandle((ref == null) ? null : ref.getValue()); | ||
| } | ||
|
|
||
| /** | ||
| * Invokes {@link #closeHandle(HANDLE)} on each handle. If an exception | ||
| * is thrown for a specific handle, then it is accumulated until all | ||
| * handles have been closed. If more than one exception occurs, then it | ||
| * is added as a suppressed exception to the first one. Once closed all | ||
| * handles, the accumulated exception (if any) is thrown | ||
| * | ||
| * @param handles The handles to be closed | ||
| * @see Throwable#getSuppressed() | ||
| */ | ||
| public static void closeHandles(HANDLE... handles) { | ||
| Win32Exception err = null; | ||
| for (HANDLE h : handles) { | ||
| try { | ||
| closeHandle(h); | ||
| } catch(Win32Exception e) { | ||
| if (err == null) { | ||
| err = e; | ||
| } else { | ||
| err.addSuppressed(e); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if (err != null) { | ||
| throw err; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Invokes {@link Kernel32#CloseHandle(HANDLE)} and checks the success code. | ||
| * If not successful, then throws a {@link Win32Exception} with the | ||
| * {@code GetLastError} value | ||
| * | ||
| * @param h The handle to be closed - ignored if {@code null} | ||
| */ | ||
| public static void closeHandle(HANDLE h) { | ||
| if (h == null) { | ||
| return; | ||
| } | ||
|
|
||
| if (!Kernel32.INSTANCE.CloseHandle(h)) { | ||
| throw new Win32Exception(Kernel32.INSTANCE.GetLastError()); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Format a message from the value obtained from | ||
| * {@link Kernel32#GetLastError()} or {@link Native#getLastError()}. | ||
|
|
@@ -220,6 +304,7 @@ public static int getFileType(String fileName) throws FileNotFoundException { | |
| } | ||
|
|
||
| HANDLE hFile = null; | ||
| Win32Exception err = null; | ||
| try { | ||
| hFile = Kernel32.INSTANCE.CreateFile(fileName, WinNT.GENERIC_READ, | ||
| WinNT.FILE_SHARE_READ, new WinBase.SECURITY_ATTRIBUTES(), | ||
|
|
@@ -232,25 +317,36 @@ public static int getFileType(String fileName) throws FileNotFoundException { | |
|
|
||
| int type = Kernel32.INSTANCE.GetFileType(hFile); | ||
| switch (type) { | ||
| case WinNT.FILE_TYPE_UNKNOWN: | ||
| int rc = Kernel32.INSTANCE.GetLastError(); | ||
| switch (rc) { | ||
| case WinError.NO_ERROR: | ||
| break; | ||
| default: | ||
| throw new Win32Exception(rc); | ||
| } | ||
| // fall-thru | ||
|
|
||
| default: | ||
| return type; | ||
| } | ||
| } catch(Win32Exception e) { | ||
| err = e; | ||
| throw err; // re-throw so finally block executed | ||
| } finally { | ||
| try { | ||
| closeHandle(hFile); | ||
| } catch(Win32Exception e) { | ||
| if (err == null) { | ||
| err = e; | ||
| } else { | ||
| err.addSuppressed(e); | ||
| } | ||
| } | ||
|
|
||
| if (err != null) { | ||
| throw err; | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -942,16 +1038,17 @@ public static List<Tlhelp32.MODULEENTRY32W> getModules(int processID) { | |
| throw new Win32Exception(Kernel32.INSTANCE.GetLastError()); | ||
| } | ||
|
|
||
| Win32Exception we = null; | ||
| try { | ||
| Tlhelp32.MODULEENTRY32W first = new Tlhelp32.MODULEENTRY32W(); | ||
|
|
||
| if (!Kernel32.INSTANCE.Module32FirstW(snapshot, first)) { | ||
| throw new Win32Exception(Kernel32.INSTANCE.GetLastError()); | ||
| } | ||
|
|
||
| List<Tlhelp32.MODULEENTRY32W> modules = new ArrayList<Tlhelp32.MODULEENTRY32W>(); | ||
| modules.add(first); | ||
|
|
||
| Tlhelp32.MODULEENTRY32W next = new Tlhelp32.MODULEENTRY32W(); | ||
| while (Kernel32.INSTANCE.Module32NextW(snapshot, next)) { | ||
| modules.add(next); | ||
|
|
@@ -965,23 +1062,25 @@ public static List<Tlhelp32.MODULEENTRY32W> getModules(int processID) { | |
| if (lastError != W32Errors.ERROR_SUCCESS && lastError != W32Errors.ERROR_NO_MORE_FILES) { | ||
| throw new Win32Exception(lastError); | ||
| } | ||
|
|
||
| return modules; | ||
| } catch (Win32Exception e) { | ||
| we = e; | ||
| throw we; // re-throw so finally block is executed | ||
| } finally { | ||
| try { | ||
| closeHandle(snapshot); | ||
| } catch(Win32Exception e) { | ||
| if (we == null) { | ||
| we = e; | ||
| } else { | ||
| we.addSuppressed(e); | ||
| } | ||
| } | ||
|
|
||
| if (we != null) { | ||
| throw we; | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Those backticks are the wrong kind ;) Also above there's a typo, Kerne32Util is missing an L :)