-
Notifications
You must be signed in to change notification settings - Fork 130
Rename MethodUnhooker to HookHandle, set minSdk = 26, refine interface
#35
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
Closed
+74
−166
Closed
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
128ead6
Update deps
Dr-TSNG 7d83e02
Rename MethodUnhooker to HookHandle, add invoke method
Dr-TSNG 854af94
Reorder methods
Dr-TSNG a69f707
Rename `getOrigin` to `getMember`
Dr-TSNG 6767f01
Set minSdk = 26 and refine interface
Dr-TSNG bea4b68
Remove default priority hook
Dr-TSNG 83cdd40
Add type in example
Dr-TSNG 00865a0
Move onModuleLoaded out of constructor
Dr-TSNG 158ab34
Merge branch 'master' into hookhandle
Dr-TSNG File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -10,8 +10,8 @@ | |||||
| import java.io.FileNotFoundException; | ||||||
| import java.io.IOException; | ||||||
| import java.lang.reflect.Constructor; | ||||||
| import java.lang.reflect.Executable; | ||||||
| import java.lang.reflect.InvocationTargetException; | ||||||
| import java.lang.reflect.Member; | ||||||
| import java.lang.reflect.Method; | ||||||
| import java.nio.ByteBuffer; | ||||||
|
|
||||||
|
|
@@ -62,12 +62,12 @@ public interface XposedInterface { | |||||
| /** | ||||||
| * Contextual interface for before invocation callbacks. | ||||||
| */ | ||||||
| interface BeforeHookCallback { | ||||||
| interface BeforeHookCallback<T extends Executable> { | ||||||
| /** | ||||||
| * Gets the method / constructor to be hooked. | ||||||
| * Gets the method / constructor being hooked. | ||||||
| */ | ||||||
| @NonNull | ||||||
| Member getMember(); | ||||||
| T getExecutable(); | ||||||
|
|
||||||
| /** | ||||||
| * Gets the {@code this} object, or {@code null} if the method is static. | ||||||
|
|
@@ -102,12 +102,12 @@ interface BeforeHookCallback { | |||||
| /** | ||||||
| * Contextual interface for after invocation callbacks. | ||||||
| */ | ||||||
| interface AfterHookCallback { | ||||||
| interface AfterHookCallback<T extends Executable> { | ||||||
| /** | ||||||
| * Gets the method / constructor to be hooked. | ||||||
| * Gets the method / constructor being hooked. | ||||||
| */ | ||||||
| @NonNull | ||||||
| Member getMember(); | ||||||
| T getExecutable(); | ||||||
|
|
||||||
| /** | ||||||
| * Gets the {@code this} object, or {@code null} if the method is static. | ||||||
|
|
@@ -185,23 +185,23 @@ interface AfterHookCallback { | |||||
| * <pre>{@code | ||||||
| * public class ExampleHooker implements Hooker { | ||||||
| * | ||||||
| * public static void before(@NonNull BeforeHookCallback callback) { | ||||||
| * public static void before(@NonNull BeforeHookCallback<Method> callback) { | ||||||
| * // Pre-hooking logic goes here | ||||||
| * } | ||||||
| * | ||||||
| * public static void after(@NonNull AfterHookCallback callback) { | ||||||
| * public static void after(@NonNull AfterHookCallback<Method> callback) { | ||||||
| * // Post-hooking logic goes here | ||||||
| * } | ||||||
| * } | ||||||
| * | ||||||
| * public class ExampleHookerWithContext implements Hooker { | ||||||
| * | ||||||
| * public static MyContext before(@NonNull BeforeHookCallback callback) { | ||||||
| * public static MyContext before(@NonNull BeforeHookCallback<Method> callback) { | ||||||
| * // Pre-hooking logic goes here | ||||||
| * return new MyContext(); | ||||||
| * } | ||||||
| * | ||||||
| * public static void after(@NonNull AfterHookCallback callback, MyContext context) { | ||||||
| * public static void after(@NonNull AfterHookCallback<Method> callback, MyContext context) { | ||||||
| * // Post-hooking logic goes here | ||||||
| * } | ||||||
| * } | ||||||
|
|
@@ -211,16 +211,16 @@ interface Hooker { | |||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Interface for canceling a hook. | ||||||
| * Handle for a hook. | ||||||
| * | ||||||
| * @param <T> {@link Method} or {@link Constructor} | ||||||
| */ | ||||||
| interface MethodUnhooker<T> { | ||||||
| interface HookHandle<T extends Executable> { | ||||||
| /** | ||||||
| * Gets the method or constructor being hooked. | ||||||
| * Gets the method / constructor being hooked. | ||||||
| */ | ||||||
| @NonNull | ||||||
| T getOrigin(); | ||||||
| T getExecutable(); | ||||||
|
|
||||||
| /** | ||||||
| * Cancels the hook. The behavior of calling this method multiple times is undefined. | ||||||
|
|
@@ -259,32 +259,18 @@ interface MethodUnhooker<T> { | |||||
| int getFrameworkPrivilege(); | ||||||
|
|
||||||
| /** | ||||||
| * Hook a method with default priority. | ||||||
| * Hook a method / constructor with specified priority. | ||||||
| * | ||||||
| * @param origin The method to be hooked | ||||||
| * @param hooker The hooker class | ||||||
| * @return Unhooker for canceling the hook | ||||||
| * @param origin The method / constructor to be hooked | ||||||
| * @param priority The hook priority | ||||||
| * @param hooker The hooker class | ||||||
| * @return Handle for the hook | ||||||
| * @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke}, | ||||||
| * or hooker is invalid | ||||||
| * @throws HookFailedError if hook fails due to framework internal error | ||||||
| */ | ||||||
| @NonNull | ||||||
| MethodUnhooker<Method> hook(@NonNull Method origin, @NonNull Class<? extends Hooker> hooker); | ||||||
|
|
||||||
| /** | ||||||
| * Hook the static initializer of a class with default priority. | ||||||
| * <p> | ||||||
| * Note: If the class is initialized, the hook will never be called. | ||||||
| * </p> | ||||||
| * | ||||||
| * @param origin The class to be hooked | ||||||
| * @param hooker The hooker class | ||||||
| * @return Unhooker for canceling the hook | ||||||
| * @throws IllegalArgumentException if class has no static initializer or hooker is invalid | ||||||
| * @throws HookFailedError if hook fails due to framework internal error | ||||||
| */ | ||||||
| @NonNull | ||||||
| <T> MethodUnhooker<Constructor<T>> hookClassInitializer(@NonNull Class<T> origin, @NonNull Class<? extends Hooker> hooker); | ||||||
| <T extends Executable> HookHandle<T> hook(@NonNull T origin, int priority, @NonNull Class<? extends Hooker> hooker); | ||||||
|
|
||||||
| /** | ||||||
| * Hook the static initializer of a class with specified priority. | ||||||
|
|
@@ -295,58 +281,15 @@ interface MethodUnhooker<T> { | |||||
| * @param origin The class to be hooked | ||||||
| * @param priority The hook priority | ||||||
| * @param hooker The hooker class | ||||||
| * @return Unhooker for canceling the hook | ||||||
| * @return Handle for the hook | ||||||
| * @throws IllegalArgumentException if class has no static initializer or hooker is invalid | ||||||
| * @throws HookFailedError if hook fails due to framework internal error | ||||||
| */ | ||||||
| @NonNull | ||||||
| <T> MethodUnhooker<Constructor<T>> hookClassInitializer(@NonNull Class<T> origin, int priority, @NonNull Class<? extends Hooker> hooker); | ||||||
|
|
||||||
| /** | ||||||
| * Hook a method with specified priority. | ||||||
| * | ||||||
| * @param origin The method to be hooked | ||||||
| * @param priority The hook priority | ||||||
| * @param hooker The hooker class | ||||||
| * @return Unhooker for canceling the hook | ||||||
| * @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke}, | ||||||
| * or hooker is invalid | ||||||
| * @throws HookFailedError if hook fails due to framework internal error | ||||||
| */ | ||||||
| @NonNull | ||||||
| MethodUnhooker<Method> hook(@NonNull Method origin, int priority, @NonNull Class<? extends Hooker> hooker); | ||||||
|
|
||||||
| /** | ||||||
| * Hook a constructor with default priority. | ||||||
| * | ||||||
| * @param <T> The type of the constructor | ||||||
| * @param origin The constructor to be hooked | ||||||
| * @param hooker The hooker class | ||||||
| * @return Unhooker for canceling the hook | ||||||
| * @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke}, | ||||||
| * or hooker is invalid | ||||||
| * @throws HookFailedError if hook fails due to framework internal error | ||||||
| */ | ||||||
| @NonNull | ||||||
| <T> MethodUnhooker<Constructor<T>> hook(@NonNull Constructor<T> origin, @NonNull Class<? extends Hooker> hooker); | ||||||
|
|
||||||
| /** | ||||||
| * Hook a constructor with specified priority. | ||||||
| * | ||||||
| * @param <T> The type of the constructor | ||||||
| * @param origin The constructor to be hooked | ||||||
| * @param priority The hook priority | ||||||
| * @param hooker The hooker class | ||||||
| * @return Unhooker for canceling the hook | ||||||
| * @throws IllegalArgumentException if origin is abstract, framework internal or {@link Method#invoke}, | ||||||
| * or hooker is invalid | ||||||
| * @throws HookFailedError if hook fails due to framework internal error | ||||||
| */ | ||||||
| @NonNull | ||||||
| <T> MethodUnhooker<Constructor<T>> hook(@NonNull Constructor<T> origin, int priority, @NonNull Class<? extends Hooker> hooker); | ||||||
| <T> HookHandle<Constructor<T>> hookClassInitializer(@NonNull Class<T> origin, int priority, @NonNull Class<? extends Hooker> hooker); | ||||||
|
|
||||||
| /** | ||||||
| * Deoptimizes a method in case hooked callee is not called because of inline. | ||||||
| * Deoptimizes a method / constructor in case hooked callee is not called because of inline. | ||||||
| * | ||||||
| * <p>By deoptimizing the method, the method will back all callee without inlining. | ||||||
| * For example, when a short hooked method B is invoked by method A, the callback to B is not invoked | ||||||
|
|
@@ -358,24 +301,13 @@ interface MethodUnhooker<T> { | |||||
| * the deoptimized callers are all you need. Otherwise, it would be better to change the hook point or | ||||||
| * to deoptimize the whole app manually (by simply reinstalling the app without uninstall).</p> | ||||||
| * | ||||||
| * @param method The method to deoptimize | ||||||
| * @param executable The method to deoptimize | ||||||
| * @return Indicate whether the deoptimizing succeed or not | ||||||
| */ | ||||||
| boolean deoptimize(@NonNull Method method); | ||||||
| boolean deoptimize(@NonNull Executable executable); | ||||||
|
|
||||||
| /** | ||||||
| * Deoptimizes a constructor in case hooked callee is not called because of inline. | ||||||
| * | ||||||
| * @param <T> The type of the constructor | ||||||
| * @param constructor The constructor to deoptimize | ||||||
| * @return Indicate whether the deoptimizing succeed or not | ||||||
| * @see #deoptimize(Method) | ||||||
| */ | ||||||
| <T> boolean deoptimize(@NonNull Constructor<T> constructor); | ||||||
|
|
||||||
| /** | ||||||
| * Basically the same as {@link Method#invoke(Object, Object...)}, but calls the original method | ||||||
| * as it was before the interception by Xposed. | ||||||
| * Basically the same as {@link Method#invoke(Object, Object...)}, but skips all Xposed hooks. | ||||||
| * | ||||||
| * @param method The method to be called | ||||||
| * @param thisObject For non-static calls, the {@code this} pointer, otherwise {@code null} | ||||||
|
|
@@ -387,8 +319,7 @@ interface MethodUnhooker<T> { | |||||
| Object invokeOrigin(@NonNull Method method, @Nullable Object thisObject, Object... args) throws InvocationTargetException, IllegalArgumentException, IllegalAccessException; | ||||||
|
|
||||||
| /** | ||||||
| * Basically the same as {@link Constructor#newInstance(Object...)}, but calls the original constructor | ||||||
| * as it was before the interception by Xposed. | ||||||
| * Invoke the constructor as a method, but skips all Xposed hooks. | ||||||
| * | ||||||
| * @param constructor The constructor to create and initialize a new instance | ||||||
|
||||||
| * @param constructor The constructor to create and initialize a new instance | |
| * @param constructor The constructor whose initialization code should be invoked on {@code thisObject} |
This file contains hidden or 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
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.
The parameter is named "executable" but the documentation still says "The method to deoptimize". Consider updating the documentation to say "The method / constructor to deoptimize" to match the new parameter type and name.