* Searching for usages of these keys will show what listeners/classes fire in which order.
*
* @author Matt Coley
*/
public final class PriorityKeys {
public static final int EARLIEST = -1000;
public static final int EARLIER = -100;
public static final int EARLY = -10;
public static final int DEFAULT = 0;
public static final int LATE = 10;
public static final int LATER = 100;
public static final int LATEST = 1000;
private PriorityKeys() {}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/behavior/PrioritySortable.java
================================================
package software.coley.recaf.behavior;
import jakarta.annotation.Nonnull;
import software.coley.collections.Lists;
import java.util.List;
/**
* Priority sortable item.
*
* @author Matt Coley
*/
public interface PrioritySortable extends Comparable {
/**
* @return This item's priority value.
* Negative values have higher priority.
* Positive values have lower priority.
*
* @see PriorityKeys
*/
default int getPriority() {
// Everything will default to '0' and the order of items is not guaranteed.
//
// The idea is that most things do not need a guaranteed run order, but for the few edge cases that do
// those specific cases will use higher/lower values to be moved to the front/end of the sorted list.
return PriorityKeys.DEFAULT;
}
@Override
default int compareTo(@Nonnull PrioritySortable o) {
return Integer.compare(getPriority(), o.getPriority());
}
/**
* Add a sortable item to a sortable list.
*
* @param items
* List to add to.
* @param item
* Item to add.
* @param
* Child priority-sortable type.
*
* @return {@code true} on add. {@code false} on failure (Insertion index cannot be computed),
*/
static boolean add(@Nonnull List items, @Nonnull T item) {
return Lists.sortedInsert(PrioritySortable::compareTo, items, item);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/cdi/EagerInitialization.java
================================================
package software.coley.recaf.cdi;
import jakarta.enterprise.context.ApplicationScoped;
import jakarta.enterprise.event.Observes;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Applied to beans to enable eager initialization, which is to say they and their dependencies get created as soon as
* possible depending on the {@link #value() value of the intended} {@link InitializationStage}. This will result in
* the bean's {@code @Inject} annotated constructor being called.
*
* Alternatively, you could also observe the events {@link InitializationEvent} or {@link UiInitializationEvent}
* in a method with {@link Observes}. This would allow you to separate the initialization logic from the constructor
* and have it reside in a separate method.
*
* NOTE: Beans are not eagerly initialized while in a test environment.
*
* @author Matt Coley
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface EagerInitialization {
/**
* Determines when to run early initialization.
*
* Changing this value is mostly applicable to {@link ApplicationScoped} beans.
* Having the value set to {@link InitializationStage#IMMEDIATE} will result in the bean and all of
* its dependencies being created as soon as the application begins. For beans dealing with UI capabilities this
* will likely lead to problems. For those situations, use {@link InitializationStage#AFTER_UI_INIT} to delay
* initialization until after the UI has been populated.
*
* @return When the initialization should occur.
*/
InitializationStage value() default InitializationStage.IMMEDIATE;
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/cdi/EagerInitializationExtension.java
================================================
package software.coley.recaf.cdi;
import jakarta.annotation.Nonnull;
import jakarta.enterprise.context.ApplicationScoped;
import jakarta.enterprise.event.Observes;
import jakarta.enterprise.inject.spi.Annotated;
import jakarta.enterprise.inject.spi.Bean;
import jakarta.enterprise.inject.spi.BeanManager;
import jakarta.enterprise.inject.spi.Extension;
import jakarta.enterprise.inject.spi.ProcessBean;
import jakarta.inject.Inject;
import java.util.ArrayList;
import java.util.List;
/**
* Extension to force creation of {@link EagerInitialization} annotated beans without the need to
* {@link Inject} and reference them externally.
*
* @author Matt Coley
*/
public class EagerInitializationExtension implements Extension {
private static final EagerInitializationExtension INSTANCE = new EagerInitializationExtension();
private static final List> applicationScopedEagerBeans = new ArrayList<>();
private static final List> applicationScopedEagerBeansForUi = new ArrayList<>();
private static BeanManager beanManager;
private EagerInitializationExtension() {
}
/**
* @return Extension singleton.
*/
@Nonnull
public static EagerInitializationExtension getInstance() {
return INSTANCE;
}
/**
* @return Application scoped {@link EagerInitialization} beans.
*/
@Nonnull
public static List> getApplicationScopedEagerBeans() {
return applicationScopedEagerBeans;
}
/**
* @return Application scoped {@link EagerInitialization} beans which will wait for the UI to be initialized before being initialized.
*/
@Nonnull
public static List> getApplicationScopedEagerBeansForUi() {
return applicationScopedEagerBeansForUi;
}
/**
* Called when a bean is discovered and processed.
* We will record eager beans here so that we can initialize them later.
*
* @param event
* CDI bean process event.
*/
public void onProcessBean(@Observes ProcessBean event) {
Annotated annotated = event.getAnnotated();
EagerInitialization eager = annotated.getAnnotation(EagerInitialization.class);
if (eager != null && annotated.isAnnotationPresent(ApplicationScoped.class)) {
if (eager.value() == InitializationStage.IMMEDIATE)
applicationScopedEagerBeans.add(event.getBean());
else if (eager.value() == InitializationStage.AFTER_UI_INIT)
applicationScopedEagerBeansForUi.add(event.getBean());
}
}
/**
* Called when Recaf initializes the CDI container, and after plugins are loaded.
*
* @param event
* Recaf initialization event.
* @param beanManager
* CDI bean manager.
*/
public void onInitialize(@Observes InitializationEvent event, @Nonnull BeanManager beanManager) {
EagerInitializationExtension.beanManager = beanManager;
for (Bean bean : applicationScopedEagerBeans)
create(bean);
}
/**
* Called when the UI is populated.
* This obviously means that this only gets called when running from the UI module.
*
* @param event
* UI initialization event.
* @param beanManager
* CDI bean manager.
*/
public void onUiInitialize(@Observes UiInitializationEvent event, @Nonnull BeanManager beanManager) {
EagerInitializationExtension.beanManager = beanManager;
for (Bean bean : applicationScopedEagerBeansForUi)
create(bean);
}
static void create(@Nonnull Bean bean) {
// NOTE: Calling toString() triggers the bean's proxy to the real implementation to initialize it.
// We have a null check here because under some test environments this may trigger without being set (see above)
if (beanManager != null)
beanManager.getReference(bean, bean.getBeanClass(), beanManager.createCreationalContext(bean)).toString();
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/cdi/InitializationEvent.java
================================================
package software.coley.recaf.cdi;
/**
* Empty type, used to notify CDI consumers observing this type that the application has been launched.
*
* @author Matt Coley
* @see UiInitializationEvent Alternative which waits for the UI to initialize.
*/
public class InitializationEvent {
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/cdi/InitializationStage.java
================================================
package software.coley.recaf.cdi;
/**
* Initialization stage for {@link EagerInitialization#value()}.
*
* @author Matt Coley
* @see EagerInitialization
*/
public enum InitializationStage {
/**
* Occurs as soon as possible.
*/
IMMEDIATE,
/**
* Occurs after the UI is initialized.
*/
AFTER_UI_INIT
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/cdi/UiInitializationEvent.java
================================================
package software.coley.recaf.cdi;
/**
* Empty type, used to notify CDI consumers observing this type that the UI has been populated.
*
* @author Matt Coley
* @see InitializationEvent Alternative which runs before the UI is initialized.
*/
public class UiInitializationEvent {
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/config/BasicCollectionConfigValue.java
================================================
package software.coley.recaf.config;
import jakarta.annotation.Nonnull;
import software.coley.observables.ObservableCollection;
import java.util.Collection;
/**
* Basic implementation of {@link ConfigCollectionValue}.
*
* @param
* Value type.
* @param
* Collection type.
*
* @author Matt Coley
*/
public class BasicCollectionConfigValue> implements ConfigCollectionValue {
private final String key;
private final Class collectionType;
private final Class itemType;
private final ObservableCollection observable;
private final boolean hidden;
/**
* @param key
* Value key.
* @param type
* Value type class.
* @param observable
* Observable of value.
*/
@SuppressWarnings("rawtypes")
public BasicCollectionConfigValue(@Nonnull String key,
@Nonnull Class type,
@Nonnull Class itemType,
@Nonnull ObservableCollection observable) {
this(key, type, itemType, observable, false);
}
/**
* @param key
* Value key.
* @param type
* Value type class.
* @param observable
* Observable of value.
* @param hidden
* Hidden flag.
*/
@SuppressWarnings({"rawtypes", "unchecked"})
public BasicCollectionConfigValue(@Nonnull String key,
@Nonnull Class type,
@Nonnull Class itemType,
@Nonnull ObservableCollection observable,
boolean hidden) {
this.key = key;
this.collectionType = (Class) type;
this.itemType = itemType;
this.observable = observable;
this.hidden = hidden;
}
@Nonnull
@Override
public String getId() {
return key;
}
@Nonnull
@Override
public Class getType() {
return collectionType;
}
@Override
public Class getItemType() {
return itemType;
}
@Nonnull
@Override
public ObservableCollection getObservable() {
return observable;
}
@Override
public boolean isHidden() {
return hidden;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
BasicCollectionConfigValue other = (BasicCollectionConfigValue) o;
if (!key.equals(other.key)) return false;
if (!collectionType.equals(other.collectionType)) return false;
if (!itemType.equals(other.itemType)) return false;
return observable.equals(other.observable);
}
@Override
public int hashCode() {
int result = key.hashCode();
result = 31 * result + collectionType.hashCode();
result = 31 * result + itemType.hashCode();
result = 31 * result + observable.hashCode();
return result;
}
@Override
public String toString() {
return "BasicCollectionConfigValue{" +
"key='" + key + '\'' +
", collectionType=" + collectionType +
", itemType=" + itemType +
'}';
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/config/BasicConfigContainer.java
================================================
package software.coley.recaf.config;
import jakarta.annotation.Nonnull;
import java.util.Map;
import java.util.TreeMap;
/**
* Basic implementation of {@link ConfigContainer}
*
* @author Matt Coley
*/
public class BasicConfigContainer implements ConfigContainer {
private final Map> configMap = new TreeMap<>();
private final String group;
private final String id;
/**
* @param group
* Container group.
* @param id
* Container ID.
*/
public BasicConfigContainer(@Nonnull String group, @Nonnull String id) {
this.group = group;
this.id = id;
}
/**
* @param value
* Value to add.
*/
protected void addValue(@Nonnull ConfigValue value) {
configMap.put(value.getId(), value);
}
@Nonnull
@Override
public String getGroup() {
return group;
}
@Nonnull
@Override
public String getId() {
return id;
}
@Nonnull
@Override
public Map> getValues() {
return configMap;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
BasicConfigContainer that = (BasicConfigContainer) o;
if (!configMap.equals(that.configMap)) return false;
return id.equals(that.id);
}
@Override
public int hashCode() {
int result = configMap.hashCode();
result = 31 * result + id.hashCode();
return result;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/config/BasicConfigValue.java
================================================
package software.coley.recaf.config;
import jakarta.annotation.Nonnull;
import software.coley.observables.Observable;
/**
* Basic implementation of {@link ConfigValue}.
*
* @param
* Value type.
*
* @author Matt Coley
*/
public class BasicConfigValue implements ConfigValue {
private final String key;
private final Class type;
private final Observable observable;
private final boolean hidden;
/**
* @param key
* Value key.
* @param type
* Value type class.
* @param observable
* Observable of value.
*/
public BasicConfigValue(String key, Class type, Observable observable) {
this(key, type, observable, false);
}
/**
* @param key
* Value key.
* @param type
* Value type class.
* @param observable
* Observable of value.
* @param hidden
* Hidden flag.
*/
public BasicConfigValue(String key, Class type, Observable observable, boolean hidden) {
this.key = key;
this.type = type;
this.observable = observable;
this.hidden = hidden;
}
@Nonnull
@Override
public String getId() {
return key;
}
@Nonnull
@Override
public Class getType() {
return type;
}
@Nonnull
@Override
public Observable getObservable() {
return observable;
}
@Override
public boolean isHidden() {
return hidden;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
BasicConfigValue other = (BasicConfigValue) o;
if (!key.equals(other.key)) return false;
return type.equals(other.type);
}
@Override
public int hashCode() {
int result = key.hashCode();
result = 31 * result + type.hashCode();
return result;
}
@Override
public String toString() {
return "BasicConfigValue{" +
"key='" + key + '\'' +
", type=" + type +
'}';
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/config/BasicMapConfigValue.java
================================================
package software.coley.recaf.config;
import jakarta.annotation.Nonnull;
import software.coley.observables.ObservableMap;
import java.util.Map;
/**
* Basic implementation of {@link ConfigMapValue}.
*
* @param
* Map key type.
* @param
* Map value type.
* @param
* Map type.
*
* @author Matt Coley
*/
public class BasicMapConfigValue> implements ConfigMapValue {
private final String key;
private final Class keyType;
private final Class valueType;
private final Class mapType;
private final ObservableMap observable;
private final boolean hidden;
/**
* @param key
* Value key.
* @param type
* Value type class.
* @param observable
* Observable of value.
*/
@SuppressWarnings("rawtypes")
public BasicMapConfigValue(String key,
Class type,
Class keyType,
Class valueType,
ObservableMap observable) {
this(key, type, keyType, valueType, observable, false);
}
/**
* @param key
* Value key.
* @param type
* Value type class.
* @param observable
* Observable of value.
* @param hidden
* Hidden flag.
*/
@SuppressWarnings({"rawtypes", "unchecked"})
public BasicMapConfigValue(String key,
Class type,
Class keyType,
Class valueType,
ObservableMap observable,
boolean hidden) {
this.key = key;
this.mapType = (Class) type;
this.keyType = keyType;
this.valueType = valueType;
this.observable = observable;
this.hidden = hidden;
}
@Nonnull
@Override
public String getId() {
return key;
}
@Nonnull
@Override
public Class getType() {
return mapType;
}
@Override
public Class getKeyType() {
return keyType;
}
@Override
public Class getValueType() {
return valueType;
}
@Nonnull
@Override
public ObservableMap getObservable() {
return observable;
}
@Override
public boolean isHidden() {
return hidden;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
BasicMapConfigValue that = (BasicMapConfigValue) o;
if (hidden != that.hidden) return false;
if (!key.equals(that.key)) return false;
if (!keyType.equals(that.keyType)) return false;
if (!valueType.equals(that.valueType)) return false;
if (!mapType.equals(that.mapType)) return false;
return observable.equals(that.observable);
}
@Override
public int hashCode() {
int result = key.hashCode();
result = 31 * result + keyType.hashCode();
result = 31 * result + valueType.hashCode();
result = 31 * result + mapType.hashCode();
result = 31 * result + observable.hashCode();
result = 31 * result + (hidden ? 1 : 0);
return result;
}
@Override
public String toString() {
return "BasicMapConfigValue{" +
"key='" + key + '\'' +
", keyType=" + keyType +
", valueType=" + valueType +
", mapType=" + mapType +
", observable=" + observable +
", hidden=" + hidden +
'}';
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/config/ConfigCollectionValue.java
================================================
package software.coley.recaf.config;
import java.util.Collection;
/**
* An option stored in a {@link ConfigContainer} object representing a collection.
*
* @param
* Collection value type.
* @param
* Collection type.
*
* @author Matt Coley
*/
public interface ConfigCollectionValue> extends ConfigValue {
/**
* @return Collection type.
*/
Class getItemType();
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/config/ConfigContainer.java
================================================
package software.coley.recaf.config;
import jakarta.annotation.Nonnull;
import jakarta.enterprise.context.ApplicationScoped;
import java.util.Map;
import static software.coley.recaf.config.ConfigGroups.PACKAGE_SPLIT;
/**
* Configurable object. Implementations will almost always want to use {@link ApplicationScoped} for their scope.
* This is so that the config container is shared between all instances of the item it is a config for.
*
* @author Matt Coley.
* @see ConfigValue Values within this container.
* @see ConfigGroups Values for {@link #getGroup()}.
*/
public interface ConfigContainer {
String CONFIG_SUFFIX = "-config";
/**
* @return Group ID the container belongs to.
*
* @see ConfigGroups For constant values.
*/
@Nonnull
String getGroup();
/**
* The unique ID of this container should be globally unique.
* The {@link #getGroup() group} does not act as an identifier prefix.
*
* @return Unique ID of this container.
*/
@Nonnull
String getId();
/**
* @return Combined {@link #getGroup()} and {@link #getId()}.
*/
@Nonnull
default String getGroupAndId() {
return getGroup() + PACKAGE_SPLIT + getId();
}
/**
* @return Values in the container.
*/
@Nonnull
Map> getValues();
/**
* @param value
* Value to get path of.
*
* @return Full path, scoped to this container.
*/
@Nonnull
default String getScopedId(ConfigValue value) {
return getGroupAndId() + PACKAGE_SPLIT + value.getId();
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/config/ConfigGroups.java
================================================
package software.coley.recaf.config;
import software.coley.recaf.services.Service;
/**
* Constants for {@link ConfigContainer#getGroup()}.
*
* @author Matt Coley
*/
public final class ConfigGroups {
/**
* Used to split group into sections.
*/
public static final String PACKAGE_SPLIT = ".";
/**
* Group base for {@link Service} classes.
*/
public static final String SERVICE = "service";
/**
* Group for analyzing components.
*/
public static final String SERVICE_ANALYSIS = SERVICE + PACKAGE_SPLIT + "analysis";
/**
* Group for assembler components.
*/
public static final String SERVICE_ASSEMBLER = SERVICE + PACKAGE_SPLIT + "assembler";
/**
* Group for compiler components.
*/
public static final String SERVICE_COMPILE = SERVICE + PACKAGE_SPLIT + "compile";
/**
* Group for debug/attach components.
*/
public static final String SERVICE_DEBUG = SERVICE + PACKAGE_SPLIT + "debug";
/**
* Group for decompilation components.
*/
public static final String SERVICE_DECOMPILE = SERVICE + PACKAGE_SPLIT + "decompile";
/**
* Group for specific decompiler components.
*/
public static final String SERVICE_DECOMPILE_IMPL = SERVICE_DECOMPILE + PACKAGE_SPLIT + "impl";
/**
* Group for IO components.
*/
public static final String SERVICE_IO = SERVICE + PACKAGE_SPLIT + "io";
/**
* Group for mapping components.
*/
public static final String SERVICE_MAPPING = SERVICE + PACKAGE_SPLIT + "mapping";
/**
* Group for plugin components.
*/
public static final String SERVICE_PLUGIN = SERVICE + PACKAGE_SPLIT + "plugin";
/**
* Group for transformation components.
*/
public static final String SERVICE_TRANSFORM = SERVICE + PACKAGE_SPLIT + "transform";
/**
* Group base for UI classes.
*/
public static final String SERVICE_UI = SERVICE + PACKAGE_SPLIT + "ui";
/**
* Group for 3rd party.
*
* Plugin registering new {@link ConfigContainer} instances should use this as the {@link ConfigContainer#getGroup()}.
* This group is given special treatment in the UI.
*/
public static final String EXTERNAL = "external";
private ConfigGroups() {
}
/**
* @param container
* Container to get packages from.
*
* @return Group packages.
*/
public static String[] getGroupPackages(ConfigContainer container) {
return container.getGroup().split('\\' + PACKAGE_SPLIT);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/config/ConfigMapValue.java
================================================
package software.coley.recaf.config;
import java.util.Map;
/**
* An option stored in a {@link ConfigContainer} object representing a map.
*
* @param
* Map key type.
* @param
* Map value type.
* @param
* Map type.
*
* @author Matt Coley
*/
public interface ConfigMapValue> extends ConfigValue {
/**
* @return Map key type.
*/
Class getKeyType();
/**
* @return Map value type.
*/
Class getValueType();
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/config/ConfigPersistence.java
================================================
package software.coley.recaf.config;
import jakarta.annotation.Nonnull;
/**
* Outline of persistence for {@link ConfigContainer}
*
* @author Matt Coley
*/
public interface ConfigPersistence {
/**
* @param container
* Container with values to save to persistent medium.
*/
void save(@Nonnull ConfigContainer container);
/**
* @param container
* Container with values to load from persistent medium.
*/
void load(@Nonnull ConfigContainer container);
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/config/ConfigValue.java
================================================
package software.coley.recaf.config;
import jakarta.annotation.Nonnull;
import software.coley.observables.Observable;
/**
* An option stored in a {@link ConfigContainer} object.
*
* @param
* Value type.
*
* @author Matt Coley
*/
public interface ConfigValue {
/**
* @return Unique ID of this value.
*/
@Nonnull
String getId();
/**
* @return Value type class.
*/
@Nonnull
Class getType();
/**
* @return Observable of value.
*/
@Nonnull
Observable getObservable();
/**
* @param value
* Value to set.
*/
default void setValue(@Nonnull T value) {
getObservable().setValue(value);
}
/**
* @return Current value.
*/
@Nonnull
default T getValue() {
return getObservable().getValue();
}
/**
* @return {@code true} for hidden values not to be shown to users (Strictly in the UI).
*/
default boolean isHidden() {
return false;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/config/RestoreAwareConfigContainer.java
================================================
package software.coley.recaf.config;
import software.coley.recaf.services.config.ConfigManager;
/**
* Outline of a config container that is aware of when its contents are restored.
*
* @author Matt Coley
*/
public interface RestoreAwareConfigContainer extends ConfigContainer {
/**
* Called when this container has its contents restored via {@link ConfigManager}.
*/
default void onRestore() {}
/**
* Called when this container was checked for contents via {@link ConfigManager} for restoration,
* but no local files were found and thus there was nothing to restore.
*/
default void onNoRestore() {}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/Accessed.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.member.ClassMember;
import static java.lang.reflect.Modifier.*;
/**
* Outline of a class or member with access modifiers.
*
* @author Matt Coley
* @see ClassMember
* @see ClassInfo
*/
public interface Accessed {
/**
* @return Access modifiers.
*/
int getAccess();
/**
* @return {@code true} when this item's access modifiers contains {@code public}.
*/
default boolean hasPublicModifier() {
return hasModifierMask(PUBLIC);
}
/**
* @return {@code true} when this item's access modifiers contains {@code protected}.
*/
default boolean hasProtectedModifier() {
return hasModifierMask(PROTECTED);
}
/**
* @return {@code true} when this item's access modifiers contains {@code private}.
*/
default boolean hasPrivateModifier() {
return hasModifierMask(PRIVATE);
}
/**
* @return {@code true} when this item's access modifiers contains none of:
* {@code public}, {@code protected}, or {@code private}.
*/
default boolean hasPackagePrivateModifier() {
return hasNoneOfMask(PRIVATE | PROTECTED | PUBLIC);
}
/**
* @return {@code true} when this item's access modifiers contains {@code static}.
*/
default boolean hasStaticModifier() {
return hasModifierMask(STATIC);
}
/**
* @return {@code true} when this item's access modifiers contains {@code final}.
*/
default boolean hasFinalModifier() {
return hasModifierMask(FINAL);
}
/**
* @return {@code true} when this item's access modifiers contains {@code synchronized}.
*/
default boolean hasSynchronizedModifier() {
return hasModifierMask(SYNCHRONIZED);
}
/**
* @return {@code true} when this item's access modifiers contains {@code volatile}.
*/
default boolean hasVolatileModifier() {
return hasModifierMask(VOLATILE);
}
/**
* @return {@code true} when this item's access modifiers contains {@code transient}.
*/
default boolean hasTransientModifier() {
return hasModifierMask(TRANSIENT);
}
/**
* @return {@code true} when this item's access modifiers contains {@code native}.
*/
default boolean hasNativeModifier() {
return hasModifierMask(NATIVE);
}
/**
* @return {@code true} when this item's access modifiers contains {@code enum}.
*/
default boolean hasEnumModifier() {
return hasModifierMask(0x00004000);
}
/**
* @return {@code true} when this item's access modifiers contains {@code annotation}.
*/
default boolean hasAnnotationModifier() {
return hasModifierMask(0x00002000);
}
/**
* @return {@code true} when this item's access modifiers contains {@code interface}.
*/
default boolean hasInterfaceModifier() {
return hasModifierMask(INTERFACE);
}
/**
* @return {@code true} when this item's access modifiers contains {@code module}.
*/
default boolean hasModuleModifier() {
return hasModifierMask(0x8000);
}
/**
* @return {@code true} when this item's access modifiers contains {@code abstract}.
*/
default boolean hasAbstractModifier() {
return hasModifierMask(ABSTRACT);
}
/**
* @return {@code true} when this item's access modifiers contains {@code strictfp}.
*/
default boolean hasStrictFpModifier() {
return hasModifierMask(STRICT);
}
/**
* @return {@code true} when this item's access modifiers contains {@code varargs}.
*/
default boolean hasVarargsModifier() {
return hasModifierMask(0x00000080);
}
/**
* @return {@code true} when this item's access modifiers contains {@code bridge}.
*/
default boolean hasBridgeModifier() {
return hasModifierMask(0x00000040);
}
/**
* @return {@code true} when this item's access modifiers contains {@code synthetic}.
*/
default boolean hasSyntheticModifier() {
return hasModifierMask(0x00001000);
}
/**
* @return {@code true} when {@link #hasSyntheticModifier()} or {@link #hasBridgeModifier()} are {@code true}.
*/
default boolean isCompilerGenerated() {
return hasBridgeModifier() || hasSyntheticModifier();
}
/**
* @param mask
* Mask to check.
*
* @return {@code true} if the access modifiers of this item match the given mask.
*/
default boolean hasModifierMask(int mask) {
return (getAccess() & mask) == mask;
}
/**
* @param modifiers
* Modifiers to check.
*
* @return {@code true} if the access modifiers of this item contain all the given modifiers.
*/
default boolean hasAllModifiers(int... modifiers) {
for (int modifier : modifiers)
if (!hasModifierMask(modifier))
return false;
return true;
}
/**
* @param modifiers
* Modifiers to check.
*
* @return {@code true} if the access modifiers of this item contain any the given modifiers.
*/
default boolean hasAnyModifiers(int... modifiers) {
for (int modifier : modifiers)
if (hasModifierMask(modifier))
return true;
return false;
}
/**
* @param mask
* Mask to check.
*
* @return {@code true} if the access modifiers of this item do not match the mask.
*/
default boolean hasNoneOfMask(int mask) {
return (getAccess() & mask) == 0;
}
/**
* @param modifiers
* Modifiers to check.
*
* @return {@code true} if the access modifiers of this item contain none the given modifiers.
*/
default boolean hasNoneOfModifiers(int... modifiers) {
for (int modifier : modifiers)
if (!hasNoneOfMask(modifier))
return false;
return true;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/AndroidChunkFileInfo.java
================================================
package software.coley.recaf.info;
import com.google.devrel.gmscore.tools.apk.arsc.BinaryResourceFile;
import jakarta.annotation.Nonnull;
/**
* Outline of files that utilize the Android chunk format.
*
* @author Matt Coley
* @see BinaryXmlFileInfo For {@code AndroidManifest.xml} contents.
* @see ArscFileInfo For {@code resources.arsc} contents.
*/
public interface AndroidChunkFileInfo extends FileInfo {
/**
* @return Model representation of the chunk file.
*/
@Nonnull
BinaryResourceFile getChunkModel();
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/AndroidClassInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import software.coley.recaf.info.builder.AndroidClassInfoBuilder;
import java.util.function.Consumer;
import java.util.function.Predicate;
/**
* Outline of an Android class.
*
* @author Matt Coley
*/
public interface AndroidClassInfo extends ClassInfo {
/**
* @return {@code true} when {@link #asJvmClass()} can act as a mapping operation.
* {@code false} when mapping to JVM classes is unsupported.
*/
default boolean canMapToJvmClass() {
return false;
}
/**
* @return New builder wrapping this class information.
*/
@Nonnull
default AndroidClassInfoBuilder toAndroidBuilder() {
return new AndroidClassInfoBuilder(this);
}
@Override
default void acceptIfJvmClass(@Nonnull Consumer action) {
// no-op
}
@Override
default void acceptIfAndroidClass(@Nonnull Consumer action) {
action.accept(this);
}
@Override
default boolean testIfJvmClass(@Nonnull Predicate predicate) {
return false;
}
@Override
default boolean testIfAndroidClass(@Nonnull Predicate predicate) {
return predicate.test(this);
}
@Nonnull
@Override
default JvmClassInfo asJvmClass() {
throw new IllegalStateException("Android class cannot be cast to JVM class");
}
@Nonnull
@Override
default AndroidClassInfo asAndroidClass() {
return this;
}
@Override
default boolean isJvmClass() {
return false;
}
@Override
default boolean isAndroidClass() {
return true;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/ApkFileInfo.java
================================================
package software.coley.recaf.info;
/**
* Outline of an APK Android file container.
*
* @author Matt Coley
*/
public interface ApkFileInfo extends ZipFileInfo {
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/ArscFileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import software.coley.android.xml.AndroidResourceProvider;
/**
* Outline of a ARSC file, used by Android APK's.
*
* @author Matt Coley
*/
public interface ArscFileInfo extends AndroidChunkFileInfo {
/**
* Standard name of ARSC resource file in APK files.
*/
String NAME = "resources.arsc";
/**
* @return Resource information extracted from the ARSC file contents.
*/
@Nonnull
AndroidResourceProvider getResourceInfo();
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/AudioFileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
/**
* Outline of an audio file.
*
* @author Matt Coley
*/
public interface AudioFileInfo extends FileInfo {
@Nonnull
@Override
default AudioFileInfo asAudioFile() {
return this;
}
@Override
default boolean isAudioFile() {
return true;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicAndroidChunkFileInfo.java
================================================
package software.coley.recaf.info;
import com.google.devrel.gmscore.tools.apk.arsc.BinaryResourceFile;
import jakarta.annotation.Nonnull;
import software.coley.recaf.info.builder.ChunkFileInfoBuilder;
/**
* Common implementation for {@link BasicBinaryXmlFileInfo} and {@link BasicArscFileInfo}.
*
* @author Matt Coley
*/
public class BasicAndroidChunkFileInfo extends BasicFileInfo implements AndroidChunkFileInfo {
private BinaryResourceFile resourceFile;
/**
* @param builder
* Builder to pull information from.
*/
public BasicAndroidChunkFileInfo(ChunkFileInfoBuilder builder) {
super(builder);
}
@Nonnull
@Override
public BinaryResourceFile getChunkModel() {
if (resourceFile == null)
resourceFile = new BinaryResourceFile(getRawContent());
return resourceFile;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicAndroidClassInfo.java
================================================
package software.coley.recaf.info;
import com.android.tools.r8.graph.DexProgramClass;
import jakarta.annotation.Nonnull;
import org.objectweb.asm.ClassReader;
import software.coley.dextranslator.Options;
import software.coley.dextranslator.ir.ConversionException;
import software.coley.dextranslator.model.ApplicationData;
import software.coley.recaf.info.builder.AndroidClassInfoBuilder;
import software.coley.recaf.info.builder.JvmClassInfoBuilder;
import java.io.IOException;
import java.util.Collections;
/**
* Basic Android class info implementation.
*
* @author Matt Coley
*/
public class BasicAndroidClassInfo extends BasicClassInfo implements AndroidClassInfo {
private final DexProgramClass dexClass;
private JvmClassInfo converted;
/**
* @param builder
* Builder to pull info from.
*/
public BasicAndroidClassInfo(@Nonnull AndroidClassInfoBuilder builder) {
super(builder);
dexClass = builder.getDexClass();
}
@Override
public boolean canMapToJvmClass() {
// See below
return true;
}
/**
* @return Translation into JVM class.
*/
@Nonnull
@Override
public JvmClassInfo asJvmClass() {
if (converted == null) {
// This is an expensive operation, so it's best to make other thread access wait until it is done and
// then use the singular return value.
synchronized (this) {
// If there are 2+ requests here, and we let one through to completion, when the others are let in
// this value should be computed then.
if (converted != null)
return converted;
try {
String name = getName();
ApplicationData data = ApplicationData.fromProgramClasses(Collections.singleton(dexClass));
data.setOperationOptionsProvider(() -> new Options()
.enableLoadStoreOptimization()
.setLenient(true)
.setReplaceInvalidMethodBodies(true));
byte[] convertedBytecode = data.exportToJvmClass(name);
if (convertedBytecode == null)
throw new IllegalStateException("Failed to convert Dalvik model of " + name + " to JVM bytecode, " +
"conversion results did not include type name.");
ClassReader reader = new ClassReader(convertedBytecode);
converted = new JvmClassInfoBuilder(reader).build();
} catch (ConversionException | IOException ex) {
throw new IllegalStateException(ex);
}
}
}
return converted;
}
/**
* @return Backing program class node.
*/
@Nonnull
public DexProgramClass getDexClass() {
return dexClass;
}
@Override
public String toString() {
return "Android class: " + getName();
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicApkFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.ZipFileInfoBuilder;
/**
* Basic implementation of an Android APK file info.
*
* @author Matt Coley
*/
public class BasicApkFileInfo extends BasicZipFileInfo implements ApkFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicApkFileInfo(ZipFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicArscFileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import org.slf4j.Logger;
import software.coley.android.xml.AndroidResourceProvider;
import software.coley.android.xml.NoopAndroidResourceProvider;
import software.coley.recaf.analytics.logging.Logging;
import software.coley.recaf.info.builder.ArscFileInfoBuilder;
import software.coley.recaf.util.android.AndroidRes;
/**
* Basic implementation of ARSC file info.
*
* @author Matt Coley
*/
public class BasicArscFileInfo extends BasicAndroidChunkFileInfo implements ArscFileInfo {
private static final Logger logger = Logging.get(BasicArscFileInfo.class);
private AndroidResourceProvider res;
/**
* @param builder
* Builder to pull information from.
*/
public BasicArscFileInfo(ArscFileInfoBuilder builder) {
super(builder);
}
@Nonnull
@Override
public AndroidResourceProvider getResourceInfo() {
if (res == null)
try {
res = AndroidRes.fromArsc(getChunkModel());
} catch (Throwable t) {
logger.error("Failed to decode '{}', will use an empty model instead", getName(), t);
res = NoopAndroidResourceProvider.INSTANCE;
}
return res;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicAudioFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.AudioFileInfoBuilder;
/**
* Basic implementation of an audio file info.
*
* @author Matt Coley
*/
public class BasicAudioFileInfo extends BasicFileInfo implements AudioFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicAudioFileInfo(AudioFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicBinaryXmlFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.BinaryXmlFileInfoBuilder;
/**
* Basic implementation of binary XML file info.
*
* @author Matt Coley
*/
public class BasicBinaryXmlFileInfo extends BasicAndroidChunkFileInfo implements BinaryXmlFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicBinaryXmlFileInfo(BinaryXmlFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicClassInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import software.coley.recaf.info.annotation.AnnotationInfo;
import software.coley.recaf.info.annotation.TypeAnnotationInfo;
import software.coley.recaf.info.builder.AbstractClassInfoBuilder;
import software.coley.recaf.info.member.BasicMember;
import software.coley.recaf.info.member.FieldMember;
import software.coley.recaf.info.member.LocalVariable;
import software.coley.recaf.info.member.MethodMember;
import software.coley.recaf.info.properties.Property;
import software.coley.recaf.info.properties.PropertyContainer;
import software.coley.recaf.util.Types;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Stream;
/**
* Basic implementation of class info.
*
* @author Matt Coley
* @see BasicJvmClassInfo
* @see BasicAndroidClassInfo
*/
public abstract class BasicClassInfo implements ClassInfo {
private static final int SIGS_VALID = 1;
private static final int SIGS_INVALID = 0;
private static final int SIGS_UNKNOWN = -1;
private final PropertyContainer properties;
private final String name;
private final String superName;
private final List interfaces;
private final int access;
private final String signature;
private final String sourceFileName;
private final List annotations;
private final List typeAnnotations;
private final String outerClassName;
private final String outerMethodName;
private final String outerMethodDescriptor;
private final List innerClasses;
private final List fields;
private final List methods;
private List breadcrumbs;
private int sigCheck = SIGS_UNKNOWN;
protected BasicClassInfo(@Nonnull AbstractClassInfoBuilder builder) {
this(builder.getName(),
builder.getSuperName(),
builder.getInterfaces(),
builder.getAccess(),
builder.getSignature(),
builder.getSourceFileName(),
builder.getAnnotations(),
builder.getTypeAnnotations(),
builder.getOuterClassName(),
builder.getOuterMethodName(),
builder.getOuterMethodDescriptor(),
builder.getInnerClasses(),
builder.getFields(),
builder.getMethods(),
builder.getPropertyContainer());
}
protected BasicClassInfo(@Nonnull String name, String superName, @Nonnull List interfaces, int access,
String signature, String sourceFileName,
@Nonnull List annotations,
@Nonnull List typeAnnotations,
String outerClassName, String outerMethodName,
String outerMethodDescriptor,
@Nonnull List innerClasses,
@Nonnull List fields, @Nonnull List methods,
@Nonnull PropertyContainer properties) {
this.name = name;
this.superName = superName;
this.interfaces = interfaces;
this.access = access;
this.signature = signature;
this.sourceFileName = sourceFileName;
this.annotations = annotations;
this.typeAnnotations = typeAnnotations;
this.outerClassName = outerClassName;
this.outerMethodName = outerMethodName;
this.outerMethodDescriptor = outerMethodDescriptor;
this.innerClasses = innerClasses;
this.fields = fields;
this.methods = methods;
this.properties = properties;
// Link fields/methods to self
Stream.concat(fields.stream(), methods.stream())
.filter(member -> member instanceof BasicMember)
.map(member -> (BasicMember) member)
.forEach(member -> member.setDeclaringClass(this));
}
@Nonnull
@Override
public String getName() {
return name;
}
@Override
public String getSuperName() {
return superName;
}
@Nonnull
@Override
public List getInterfaces() {
return interfaces;
}
@Override
public int getAccess() {
return access;
}
@Override
public String getSignature() {
return signature;
}
@Override
public String getSourceFileName() {
return sourceFileName;
}
@Nonnull
@Override
public List getAnnotations() {
return annotations;
}
@Nonnull
@Override
public List getTypeAnnotations() {
return typeAnnotations;
}
@Override
public String getOuterClassName() {
return outerClassName;
}
@Override
public String getOuterMethodName() {
return outerMethodName;
}
@Override
public String getOuterMethodDescriptor() {
return outerMethodDescriptor;
}
@Nonnull
@Override
public List getOuterClassBreadcrumbs() {
if (breadcrumbs == null) {
String currentOuter = getOuterClassName();
if (currentOuter == null)
return breadcrumbs = Collections.emptyList();
int maxOuterDepth = 10;
List list = new ArrayList<>();
int counter = 0;
while (currentOuter != null) {
if (++counter > maxOuterDepth) {
list.clear(); // assuming some obfuscator is at work, so breadcrumbs might be invalid.
break;
}
list.addFirst(currentOuter);
String targetOuter = currentOuter;
currentOuter = innerClasses.stream()
.filter(i -> i.getInnerClassName().equals(targetOuter) && i.getOuterClassName() != null)
.map(InnerClassInfo::getOuterClassName)
.findFirst().orElse(null);
}
breadcrumbs = Collections.unmodifiableList(list);
}
return breadcrumbs;
}
@Nonnull
@Override
public List getInnerClasses() {
return innerClasses;
}
@Nonnull
@Override
public List getFields() {
return fields;
}
@Nonnull
@Override
public List getMethods() {
return methods;
}
@Override
public void setProperty(Property property) {
properties.setProperty(property);
}
@Override
public void removeProperty(String key) {
properties.removeProperty(key);
}
@Nonnull
@Override
public Map> getProperties() {
return properties.getProperties();
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null) return false;
if (o instanceof ClassInfo other) {
// NOTE: Do NOT consider the properties since contents of the map can point back to this instance
// or our containing resource, causing a cycle.
if (access != other.getAccess()) return false;
if (!name.equals(other.getName())) return false;
if (!Objects.equals(superName, other.getSuperName())) return false;
if (!interfaces.equals(other.getInterfaces())) return false;
if (!Objects.equals(signature, other.getSignature())) return false;
if (!Objects.equals(sourceFileName, other.getSourceFileName())) return false;
if (!annotations.equals(other.getAnnotations())) return false;
if (!typeAnnotations.equals(other.getTypeAnnotations())) return false;
if (!Objects.equals(outerClassName, other.getOuterClassName())) return false;
if (!Objects.equals(outerMethodName, other.getOuterMethodName())) return false;
if (!Objects.equals(outerMethodDescriptor, other.getOuterMethodDescriptor())) return false;
if (!innerClasses.equals(other.getInnerClasses())) return false;
if (!fields.equals(other.getFields())) return false;
return methods.equals(other.getMethods());
}
return false;
}
@Override
public int hashCode() {
// NOTE: Do NOT consider the properties since contents of the map can point back to this instance
// or our containing resource, causing a cycle.
int result = name.hashCode();
result = 31 * result + (superName != null ? superName.hashCode() : 0);
result = 31 * result + interfaces.hashCode();
result = 31 * result + access;
result = 31 * result + (signature != null ? signature.hashCode() : 0);
result = 31 * result + (sourceFileName != null ? sourceFileName.hashCode() : 0);
result = 31 * result + annotations.hashCode();
result = 31 * result + typeAnnotations.hashCode();
result = 31 * result + (outerClassName != null ? outerClassName.hashCode() : 0);
result = 31 * result + (outerMethodName != null ? outerMethodName.hashCode() : 0);
result = 31 * result + (outerMethodDescriptor != null ? outerMethodDescriptor.hashCode() : 0);
result = 31 * result + innerClasses.hashCode();
result = 31 * result + fields.hashCode();
result = 31 * result + methods.hashCode();
return result;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicDexFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.DexFileInfoBuilder;
/**
* Basic implementation of an Android DEX file info.
*
* @author Matt Coley
*/
public class BasicDexFileInfo extends BasicFileInfo implements DexFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicDexFileInfo(DexFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicFileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import software.coley.recaf.info.builder.FileInfoBuilder;
import software.coley.recaf.info.properties.Property;
import software.coley.recaf.info.properties.PropertyContainer;
import java.util.Arrays;
import java.util.Map;
/**
* Basic implementation of file info.
*
* @author Matt Coley
*/
public class BasicFileInfo implements FileInfo {
private final PropertyContainer properties;
private final String name;
private final byte[] rawContent;
public BasicFileInfo(@Nonnull FileInfoBuilder builder) {
this(builder.getName(),
builder.getRawContent(),
builder.getProperties());
}
/**
* @param name
* File name/path.
* @param rawContent
* Raw contents of file.
* @param properties
* Assorted properties.
*/
public BasicFileInfo(@Nonnull String name, @Nonnull byte[] rawContent, @Nonnull PropertyContainer properties) {
this.name = name;
this.rawContent = rawContent;
this.properties = properties;
}
@Nonnull
@Override
public byte[] getRawContent() {
return rawContent;
}
@Nonnull
@Override
public String getName() {
return name;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null) return false;
if (o instanceof FileInfo other) {
if (!name.equals(other.getName())) return false;
return Arrays.equals(rawContent, other.getRawContent());
}
return false;
}
@Override
public int hashCode() {
int result = name.hashCode();
result = 31 * result + Arrays.hashCode(rawContent);
return result;
}
@Override
public void setProperty(Property property) {
properties.setProperty(property);
}
@Override
public void removeProperty(String key) {
properties.removeProperty(key);
}
@Nonnull
@Override
public Map> getProperties() {
return properties.getProperties();
}
@Override
public String toString() {
return name;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicImageFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.ImageFileInfoBuilder;
/**
* Basic implementation of an image file info.
*
* @author Matt Coley
*/
public class BasicImageFileInfo extends BasicFileInfo implements ImageFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicImageFileInfo(ImageFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicInnerClassInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import java.util.Objects;
/**
* Basic implementation of inner class info.
*
* @author Matt Coley
*/
public class BasicInnerClassInfo implements InnerClassInfo {
private final String outerDeclaringClassName; // Recaf specific, not modeling class spec
private final String innerClassName;
private final String outerClassName;
private final String innerName;
private final int access;
private String simpleName;
/**
* @param outerDeclaringClassName
* Declaring class name,
* @param innerClassName
* Inner name.
* @param outerClassName
* Outer name.
* @param innerName
* Local inner name.
* @param access
* Inner class flags originally declared.
*/
public BasicInnerClassInfo(String outerDeclaringClassName, String innerClassName,
String outerClassName, String innerName, int access) {
this.outerDeclaringClassName = outerDeclaringClassName;
this.innerClassName = innerClassName;
this.outerClassName = outerClassName;
this.innerName = innerName;
this.access = access;
}
@Override
public int getAccess() {
return access;
}
@Nonnull
@Override
public String getOuterDeclaringClassName() {
return outerDeclaringClassName;
}
@Nonnull
@Override
public String getInnerClassName() {
return innerClassName;
}
@Override
public String getOuterClassName() {
return outerClassName;
}
@Override
public String getInnerName() {
return innerName;
}
@Nonnull
@Override
public String getSimpleName() {
// Cache simple name computation
if (simpleName == null) simpleName = InnerClassInfo.super.getSimpleName();
return simpleName;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null) return false;
if (o instanceof InnerClassInfo inner) {
if (access != inner.getAccess()) return false;
if (!innerClassName.equals(inner.getInnerClassName())) return false;
if (!Objects.equals(outerClassName, inner.getOuterClassName())) return false;
return Objects.equals(innerName, inner.getInnerName());
}
return false;
}
@Override
public int hashCode() {
int result = innerClassName.hashCode();
result = 31 * result + (outerClassName != null ? outerClassName.hashCode() : 0);
result = 31 * result + (innerName != null ? innerName.hashCode() : 0);
result = 31 * result + access;
return result;
}
@Override
public String toString() {
return "Inner class: " + getSimpleName();
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicJModFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.JModFileInfoBuilder;
/**
* Basic implementation of JMod file info.
*
* @author Matt Coley
*/
public class BasicJModFileInfo extends BasicZipFileInfo implements JModFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicJModFileInfo(JModFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicJarFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.JarFileInfoBuilder;
/**
* Basic implementation of JAR file info.
*
* @author Matt Coley
*/
public class BasicJarFileInfo extends BasicZipFileInfo implements JarFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicJarFileInfo(JarFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicJvmClassInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import org.objectweb.asm.ClassReader;
import software.coley.recaf.info.builder.JvmClassInfoBuilder;
import java.util.Arrays;
/**
* Basic JVM class info implementation.
*
* @author Matt Coley
*/
public class BasicJvmClassInfo extends BasicClassInfo implements JvmClassInfo {
private final byte[] bytecode;
private final int version;
private ClassReader reader;
/**
* @param builder
* Builder to pull info from.
*/
public BasicJvmClassInfo(@Nonnull JvmClassInfoBuilder builder) {
super(builder);
this.bytecode = builder.getBytecode();
this.version = builder.getVersion();
}
@Nonnull
@Override
public byte[] getBytecode() {
return bytecode;
}
@Nonnull
@Override
public ClassReader getClassReader() {
if (reader == null)
reader = new ClassReader(bytecode);
return reader;
}
@Override
public int getVersion() {
return version;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null) return false;
if (o instanceof JvmClassInfo other) {
if (version != other.getVersion()) return false;
return Arrays.equals(bytecode, other.getBytecode());
} else if (!super.equals(o)) {
return false;
}
return false;
}
@Override
public int hashCode() {
int result = super.hashCode();
result = 31 * result + Arrays.hashCode(bytecode);
result = 31 * result + version;
return result;
}
@Override
public String toString() {
return "JVM class: " + getName();
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicModulesFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.ModulesFileInfoBuilder;
/**
* Basic implementation of Modules file info.
*
* @author Matt Coley
*/
public class BasicModulesFileInfo extends BasicFileInfo implements ModulesFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicModulesFileInfo(ModulesFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicNativeLibraryFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.NativeLibraryFileInfoBuilder;
/**
* Basic implementation of a native-library file info.
*
* @author Matt Coley
*/
public class BasicNativeLibraryFileInfo extends BasicFileInfo implements NativeLibraryFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicNativeLibraryFileInfo(NativeLibraryFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicTextFileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import software.coley.recaf.info.builder.TextFileInfoBuilder;
import java.nio.charset.Charset;
/**
* Basic implementation of text file info.
*
* @author Matt Coley
*/
public class BasicTextFileInfo extends BasicFileInfo implements TextFileInfo {
private final Charset charset;
private final String text;
private String[] lines;
/**
* @param builder
* Builder to pull information from.
*/
public BasicTextFileInfo(@Nonnull TextFileInfoBuilder builder) {
super(builder);
text = builder.getText();
charset = builder.getCharset();
}
@Nonnull
@Override
public String getText() {
return text;
}
@Nonnull
@Override
public String[] getTextLines() {
if (lines == null)
lines = getText().lines().toArray(String[]::new);
return lines;
}
@Nonnull
@Override
public Charset getCharset() {
return charset;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicVideoFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.VideoFileInfoBuilder;
/**
* Basic implementation of a video file info.
*
* @author Matt Coley
*/
public class BasicVideoFileInfo extends BasicFileInfo implements VideoFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicVideoFileInfo(VideoFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicWarFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.WarFileInfoBuilder;
/**
* Basic implementation of WAR file info.
*
* @author Matt Coley
*/
public class BasicWarFileInfo extends BasicZipFileInfo implements WarFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicWarFileInfo(WarFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BasicZipFileInfo.java
================================================
package software.coley.recaf.info;
import software.coley.recaf.info.builder.ZipFileInfoBuilder;
/**
* Basic implementation of ZIP file info.
*
* @author Matt Coley
*/
public class BasicZipFileInfo extends BasicFileInfo implements ZipFileInfo {
/**
* @param builder
* Builder to pull information from.
*/
public BasicZipFileInfo(ZipFileInfoBuilder builder) {
super(builder);
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/BinaryXmlFileInfo.java
================================================
package software.coley.recaf.info;
/**
* Outline of a binary XML file, used by Android APK's.
*
* @author Matt Coley
*/
public interface BinaryXmlFileInfo extends AndroidChunkFileInfo {
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/ClassInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import software.coley.recaf.info.annotation.Annotated;
import software.coley.recaf.info.member.ClassMember;
import software.coley.recaf.info.member.FieldMember;
import software.coley.recaf.info.member.MethodMember;
import software.coley.recaf.util.Types;
import software.coley.recaf.util.visitors.IllegalSignatureRemovingVisitor;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.stream.Stream;
/**
* Outline of a class.
*
* @author Matt Coley
* @see JvmClassInfo For JVM classes.
* @see AndroidClassInfo For Android classes.
*/
public interface ClassInfo extends Info, Annotated, Accessed {
/**
* @return Name of the source file the class was compiled from.
* May be {@code null} when there is no debug data attached to the class.
*/
@Nullable
String getSourceFileName();
/**
* @return List of implemented interfaces.
*/
@Nonnull
List getInterfaces();
/**
* @return Super-name of the class.
* May be {@code null} for {@link java.lang.annotation.Annotation} and {@code module-info} classes.
*/
@Nullable
String getSuperName();
/**
* @return Package the class resides in.
* May be {@code null} for classes in the default package.
*/
@Nullable
default String getPackageName() {
String className = getName();
int packageIndex = className.lastIndexOf('/');
if (packageIndex <= 0) return null;
return className.substring(0, packageIndex);
}
/**
* @return {@code true} when the class name has no package.
*/
default boolean isInDefaultPackage() {
return getPackageName() == null;
}
/**
* @return Stream of all parent types, where the {@link #getSuperName()} is first if present,
* followed by any {@link #getInterfaces()}.
*/
@Nonnull
default Stream parentTypesStream() {
return Stream.concat(
Stream.ofNullable(getSuperName()),
getInterfaces().stream()
);
}
/**
* @return Signature containing generic information. May be {@code null}.
*/
@Nullable
String getSignature();
/**
* @return Name of outer class that this is declared in, if this is an inner class.
* {@code null} when this class is not an inner class.
*/
@Nullable
String getOuterClassName();
/**
* @return Name of the outer method that this is declared in, as an anonymous inner class.
* {@code null} when this class is not an inner anonymous class.
*
* @see #getOuterMethodDescriptor() Descriptor of outer method
*/
@Nullable
String getOuterMethodName();
/**
* @return Descriptor of the outer method that this is declared in, as an anonymous inner class.
* {@code null} when this class is not an inner anonymous class.
*
* @see #getOuterMethodName() Name of outer method.
*/
@Nullable
String getOuterMethodDescriptor();
/**
* Breadcrumbs of the outer class.
* This List MUST be sorted in order of the outermost first.
* The last element is the outer of the class itself.
*
* For an example, if our class is 'C' then this list will be {@code [foo/A, foo/A$B]}:
*
{@code
* package foo;
*
* class A {
* class B {
* class C {} // This class
* }
* }
* }
*
* @return Breadcrumbs of the outer class.
*/
@Nonnull
List getOuterClassBreadcrumbs();
/**
* @return List of declared inner classes.
*/
@Nonnull
List getInnerClasses();
/**
* Gets a named inner class by the local name.
* Given the following example, you would pass {@code "Bar"} or even {@code "FizzBuzz"}:
*
{@code
* class Foo {
* class Bar {
* class FizzBuzz {}
* }
* }
* }
* Because anonymous inner classes do not have a name declared, they cannot be yielded here.
*
* @param innerName
* Local name of inner class.
*
* @return Inner class of the matching name, or {@code null} if no such inner exists.
*/
@Nullable
default InnerClassInfo getInnerClassByInnerName(@Nonnull String innerName) {
for (InnerClassInfo innerClass : getInnerClasses())
if (innerName.equals(innerClass.getInnerName()))
return innerClass;
return null;
}
/**
* @return {@code true} when this class is an inner class of another class.
*/
default boolean isInnerClass() {
return getOuterClassName() != null || getOuterMethodName() != null;
}
/**
* @param className
* Name of a supposed outer class.
*
* @return {@code true} if this class is an inner class of the given outer class.
*/
default boolean isInnerClassOf(@Nonnull String className) {
// If we don't start with that class name, we can't possibly be an inner class.
if (!getName().startsWith(className + "$"))
return false;
return getOuterClassBreadcrumbs().contains(className);
}
/**
* @return {@code true} when this class is an anonymous inner class of another class.
*/
default boolean isAnonymousInnerClass() {
// Check if the 'full' name of the inner 'InnerClassName' is the current class (entry representing ourselves)
// Then if the 'OuterClassName' is null, this means our class does not expose a name because it is anonymous.
return getInnerClasses().stream()
.anyMatch(inner -> inner.getInnerClassName().equals(getName()) && inner.getOuterClassName() == null);
}
/**
* @return List of declared fields.
*/
@Nonnull
List getFields();
/**
* @return List of declared methods.
*/
@Nonnull
List getMethods();
/**
* @return Stream of declared fields.
*/
@Nonnull
default Stream fieldStream() {
return Stream.of(this).flatMap(self -> self.getFields().stream());
}
/**
* @return Stream of declared methods.
*/
@Nonnull
default Stream methodStream() {
return Stream.of(this).flatMap(self -> self.getMethods().stream());
}
/**
* @return Stream of declared fields and methods.
*/
@Nonnull
default Stream fieldAndMethodStream() {
return Stream.concat(fieldStream(), methodStream());
}
/**
* Do note that there can be multiple fields with one name if there are different descriptors for each.
* To differentiate properly, please use {@link #getDeclaredField(String, String)}.
*
* @param name
* Field name.
*
* @return First matching field definition, or {@code null} if none were found.
*/
@Nullable
default FieldMember getFirstDeclaredFieldByName(@Nonnull String name) {
return fieldStream()
.filter(f -> f.getName().equals(name))
.findFirst().orElse(null);
}
/**
* @param name
* Field name.
* @param descriptor
* Field descriptor.
*
* @return Field matching definition, or {@code null} if none were found.
*/
@Nullable
default FieldMember getDeclaredField(@Nonnull String name, @Nonnull String descriptor) {
return fieldStream()
.filter(f -> f.getName().equals(name) && f.getDescriptor().equals(descriptor))
.findFirst().orElse(null);
}
/**
* @param name
* Method name.
* @param descriptor
* Method descriptor.
*
* @return Method matching definition, or {@code null} if none were found.
*/
@Nullable
default MethodMember getDeclaredMethod(@Nonnull String name, @Nonnull String descriptor) {
return methodStream()
.filter(m -> m.getName().equals(name) && m.getDescriptor().equals(descriptor))
.findFirst().orElse(null);
}
/**
* Do note that there can be multiple methods with one name if there are different method descriptors for each.
* To differentiate properly, please use {@link #getDeclaredMethod(String, String)}.
*
* @param name
* Method name.
*
* @return First matching method definition, or {@code null} if none were found.
*/
@Nullable
default MethodMember getFirstDeclaredMethodByName(@Nonnull String name) {
return methodStream()
.filter(m -> m.getName().equals(name))
.findFirst().orElse(null);
}
/**
* @param action
* Action to run if this is a JVM class.
*/
void acceptIfJvmClass(@Nonnull Consumer action);
/**
* @param action
* Action to run if this is an Android class.
*/
void acceptIfAndroidClass(@Nonnull Consumer action);
/**
* @param action
* Action to run.
*/
default void acceptClass(@Nonnull Consumer action) {
action.accept(this);
}
/**
* @param predicate
* Predicate to run if this is a JVM class.
*
* @return {@code true} when the predicate passes.
* {@code false} when it does not, or the class is not a JVM class.
*/
boolean testIfJvmClass(@Nonnull Predicate predicate);
/**
* @param predicate
* Predicate to run if this is an Android class.
*
* @return {@code true} when the predicate passes.
* {@code false} when it does not, or the class is not an Android class.
*/
boolean testIfAndroidClass(@Nonnull Predicate predicate);
/**
* @param predicate
* Predicate to run.
*
* @return Predicate evaluation.
*/
default boolean testClass(@Nonnull Predicate predicate) {
return predicate.test(this);
}
/**
* @param function
* Mapping function.
* @param
* Function return type.
*
* @return Mapped value.
*/
default R mapClass(@Nonnull Function function) {
return function.apply(this);
}
@Nonnull
@Override
default ClassInfo asClass() {
return this;
}
@Nonnull
@Override
default FileInfo asFile() {
throw new IllegalStateException("Class cannot be cast to generic file");
}
/**
* @return Self cast to JVM class.
*/
@Nonnull
JvmClassInfo asJvmClass();
/**
* @return Self cast to Android class.
*/
@Nonnull
AndroidClassInfo asAndroidClass();
@Override
default boolean isClass() {
return true;
}
@Override
default boolean isFile() {
return false;
}
/**
* @return {@code true} if self is a JVM class.
*/
boolean isJvmClass();
/**
* @return {@code true} if self is an Android class.
*/
boolean isAndroidClass();
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/DexFileInfo.java
================================================
package software.coley.recaf.info;
/**
* Outline of an Android dex file.
*
* @author Matt Coley
*/
public interface DexFileInfo extends FileInfo {
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/FileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import software.coley.recaf.info.builder.FileInfoBuilder;
/**
* Outline of a file.
*
* @author Matt Coley
*/
public interface FileInfo extends Info {
/**
* @return New builder wrapping this file information.
*/
@Nonnull
default FileInfoBuilder toFileBuilder() {
return FileInfoBuilder.forFile(this);
}
/**
* @return Raw bytes of file content.
*/
@Nonnull
byte[] getRawContent();
/**
* @return File extension of {@link #getName() the file name}, if any exists.
*/
@Nullable
default String getFileExtension() {
String fileName = getName();
int i = fileName.indexOf('.') + 1;
if (i > 0)
return fileName.toLowerCase().substring(i);
return null;
}
/**
* @return Directory the file resides in.
* May be {@code null} for files in the root directory.
*/
@Nullable
default String getDirectoryName() {
String fileName = getName();
int directoryIndex = fileName.lastIndexOf('/');
if (directoryIndex <= 0) return null;
return fileName.substring(0, directoryIndex);
}
@Nonnull
@Override
default ClassInfo asClass() {
throw new IllegalStateException("File cannot be cast to generic class");
}
@Nonnull
@Override
default FileInfo asFile() {
return this;
}
/**
* @return Self cast to text file.
*/
@Nonnull
default TextFileInfo asTextFile() {
throw new IllegalStateException("Non-text file cannot be cast to text file");
}
/**
* @return Self cast to image file.
*/
@Nonnull
default ImageFileInfo asImageFile() {
throw new IllegalStateException("Non-image file cannot be cast to image file");
}
/**
* @return Self cast to audio file.
*/
@Nonnull
default AudioFileInfo asAudioFile() {
throw new IllegalStateException("Non-audio file cannot be cast to audio file");
}
/**
* @return Self cast to video file.
*/
@Nonnull
default VideoFileInfo asVideoFile() {
throw new IllegalStateException("Non-video file cannot be cast to video file");
}
/**
* @return Self cast to video file.
*/
@Nonnull
default NativeLibraryFileInfo asNativeLibraryFile() {
throw new IllegalStateException("Non-native-library file cannot be cast to native-library file");
}
/**
* @return Self cast to zip file.
*/
@Nonnull
default ZipFileInfo asZipFile() {
throw new IllegalStateException("Non-zip file cannot be cast to zip file");
}
@Override
default boolean isClass() {
return false;
}
@Override
default boolean isFile() {
return true;
}
/**
* @return {@code true} if self is a text file.
*/
default boolean isTextFile() {
return false;
}
/**
* @return {@code true} if self is an image file.
*/
default boolean isImageFile() {
return false;
}
/**
* @return {@code true} if self is an audio file.
*/
default boolean isAudioFile() {
return false;
}
/**
* @return {@code true} if self is a video file.
*/
default boolean isVideoFile() {
return false;
}
/**
* @return {@code true} if self is a native-library file.
*/
default boolean isNativeLibraryFile() {
return false;
}
/**
* @return {@code true} if self is a zip file.
*/
default boolean isZipFile() {
return false;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/ImageFileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
/**
* Outline of an image file.
*
* @author Matt Coley
*/
public interface ImageFileInfo extends FileInfo {
@Nonnull
@Override
default ImageFileInfo asImageFile() {
return this;
}
@Override
default boolean isImageFile() {
return true;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/Info.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import software.coley.recaf.info.properties.PropertyContainer;
/**
* Outline of all info types.
*
* @author Matt Coley
*/
public interface Info extends Named, PropertyContainer {
/**
* @return Self cast to general class.
*/
@Nonnull
ClassInfo asClass();
/**
* @return Self cast to general file.
*/
@Nonnull
FileInfo asFile();
/**
* @return {@code true} if self is a general class.
*/
boolean isClass();
/**
* @return {@code true} if self is a general file.
*/
boolean isFile();
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/InnerClassInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
/**
* Outline of an inner class for a declaring {@link ClassInfo}.
*
* Important note: Oracle's Java Virtual Machine implementation
* does not check the consistency of an InnerClasses attribute against a class
* file representing a class or interface referenced by the attribute.
*
* @author Matt Coley
* @author Amejonah
*/
public interface InnerClassInfo extends Accessed, Named {
@Nonnull
@Override
default String getName() {
return getInnerClassName();
}
/**
* @return The name of the outer declaring class for this inner class.
*/
@Nonnull
String getOuterDeclaringClassName();
/**
* Given the following example, the inner name is {@code Apple$Worm}.
*
* class Apple {
* class Worm {}
* }
*
*
* @return The internal name of an inner class.
*/
@Nonnull
String getInnerClassName();
/**
* Given the following example, the inner name is {@code Apple}.
*
* class Apple {
* class Worm {}
* }
*
*
* @return The internal name of the class to which the inner class belongs.
* May be {@code null} for anonymous classes.
*/
@Nullable
String getOuterClassName();
/**
* Given the following example, the inner name is {@code Worm}.
*
* class Apple {
* class Worm {}
* }
*
*
* @return The (simple) name of the inner class inside its enclosing class.
* May be {@code null} for anonymous inner classes.
*/
@Nullable
String getInnerName();
/**
* There are some wierd cases where there can be inner-class entries of classes defined by other classes.
* You can use this to filter those cases out.
*
* @return {@code true} when this inner-class entry denotes an inner-class
* reference to a class defined in another class.
*/
default boolean isExternalReference() {
return !getInnerClassName().startsWith(getOuterDeclaringClassName());
}
/**
* @return The access modifiers of the inner class as originally declared in the enclosing class.
*/
default int getInnerAccess() {
return getAccess();
}
/**
* @return Either {@link #getInnerName()} if not {@code null},
* otherwise the last "part" (after last $ or /) of {@link #getOuterClassName()}.
*/
@Nonnull
default String getSimpleName() {
// Check for inner name
String innerName = getInnerName();
if (innerName != null) return innerName;
// Substring from outer class prefix
String outerDeclaringClass = getOuterDeclaringClassName();
String outerName = getOuterClassName();
if (outerName != null) {
int outerDeclaringLength = outerDeclaringClass.length();
int lastIndex = 0;
int endIndex = Math.min(outerDeclaringLength, outerName.length());
for (; lastIndex < endIndex; lastIndex++) {
if (outerDeclaringClass.charAt(lastIndex) != outerName.charAt(lastIndex)) break;
}
// Edge case handling with outer name
if (lastIndex == 0)
return outerName;
else if (outerName.startsWith("$", lastIndex))
lastIndex++;
return outerName.substring(lastIndex);
}
// Class entry is for anonymous class.
String innerClassName = getInnerClassName();
return "Anonymous '" + innerClassName.substring(innerClassName.lastIndexOf('$') + 1) + "'";
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/JModFileInfo.java
================================================
package software.coley.recaf.info;
/**
* Outline of a JVM JMod file.
* These files are found at {@code %JAVA%/jmods/}.
*
* @author Matt Coley
*/
public interface JModFileInfo extends ZipFileInfo {
/**
* Classes in the JMod archive are prefixed with this path.
*/
String CLASSES_PREFIX = "classes/";
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/JarFileInfo.java
================================================
package software.coley.recaf.info;
/**
* Outline of a JAR file container.
*
* @author Matt Coley
*/
public interface JarFileInfo extends ZipFileInfo {
/**
* Multi-release JARs prefix class names with this, plus the target version.
* For example: Multiple versions of {@code foo/Bar.class}
*
*
{@code foo/Bar.class}
*
{@code META-INF/versions/9/foo/Bar.class}
*
{@code META-INF/versions/11/foo/Bar.class}
*
* The first item is used for Java 8.
* The second item for Java 9 and 10.
* The third item for Java 11+.
*/
String MULTI_RELEASE_PREFIX = "META-INF/versions/";
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/JvmClassInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import org.objectweb.asm.ClassReader;
import org.objectweb.asm.Opcodes;
import org.objectweb.asm.Type;
import software.coley.cafedude.classfile.ConstantPoolConstants;
import software.coley.recaf.info.builder.JvmClassInfoBuilder;
import software.coley.recaf.info.properties.builtin.ReferencedClassesProperty;
import software.coley.recaf.info.properties.builtin.StringDefinitionsProperty;
import software.coley.recaf.util.JavaVersion;
import software.coley.recaf.util.Types;
import software.coley.recaf.util.visitors.TypeVisitor;
import java.util.*;
import java.util.function.Consumer;
import java.util.function.Predicate;
/**
* Outline of a JVM class.
*
* @author Matt Coley
*/
public interface JvmClassInfo extends ClassInfo {
/**
* Denotes the base version offset.
*
*
For version 1 of you would use {@code BASE_VERSION + 1}.
*
For version 2 of you would use {@code BASE_VERSION + 2}.
*
...
*
For version N of you would use {@code BASE_VERSION + N}.
*
*/
int BASE_VERSION = 44;
/**
* @return New builder wrapping this class information.
*/
@Nonnull
default JvmClassInfoBuilder toJvmClassBuilder() {
return new JvmClassInfoBuilder(this);
}
/**
* @return Java class file version.
*/
int getVersion();
/**
* @return Bytecode of class.
*/
@Nonnull
byte[] getBytecode();
/**
* @return Class reader of {@link #getBytecode()}.
*/
@Nonnull
ClassReader getClassReader();
/**
* @return Default flags to use with {@link #getClassReader()}
*/
default int getClassReaderFlags() {
// There are some old classes with stack-frame data.
// These aren't strictly required on old classes, and ASM dies when re-writing them (
// - MethodWriter.visitFrame checks for pre Java 6 and throws
return getVersion() <= Opcodes.V1_5 ?
ClassReader.SKIP_FRAMES : 0;
}
/**
* @return Set of all classes referenced in the constant pool.
*/
@Nonnull
default NavigableSet getReferencedClasses() {
NavigableSet classes = ReferencedClassesProperty.get(this);
if (classes != null)
return classes;
Set classNames = new HashSet<>();
ClassReader reader = getClassReader();
// Iterate over pool entries. Supe fast way to discover most of the referenced types.
int itemCount = reader.getItemCount();
char[] buffer = new char[reader.getMaxStringLength()];
for (int i = 1; i < itemCount; i++) {
int offset = reader.getItem(i);
if (offset >= 10) {
try {
int itemTag = reader.readByte(offset - 1);
if (itemTag == ConstantPoolConstants.CLASS) {
String className = reader.readUTF8(offset, buffer);
if (className.isEmpty())
continue;
addName(className, classNames);
} else if (itemTag == ConstantPoolConstants.NAME_TYPE) {
String desc = reader.readUTF8(offset + 2, buffer);
if (desc.isEmpty())
continue;
if (desc.charAt(0) == '(') {
addMethodType(Type.getMethodType(desc), classNames);
} else {
Type type = Type.getType(desc);
addType(type, classNames);
}
} else if (itemTag == ConstantPoolConstants.METHOD_TYPE) {
String methodDesc = reader.readUTF8(offset, buffer);
if (methodDesc.isEmpty() || methodDesc.charAt(0) != '(')
continue;
addMethodType(Type.getMethodType(methodDesc), classNames);
}
} catch (Throwable ignored) {
// Exists only to catch situations where obfuscators put unused junk pool entries
// with malformed descriptors, which cause ASM's type parser to crash.
}
}
}
// In some cases like interface classes, there may be UTF8 pool entries outlining method descriptors which
// are not directly linked in NameType or MethodType pool entries. We need to iterate over fields and methods
// to get the descriptors in these cases.
reader.accept(new TypeVisitor(t -> {
if (t.getSort() == Type.METHOD)
addMethodType(t, classNames);
else
addType(t, classNames);
}), ClassReader.SKIP_DEBUG | ClassReader.SKIP_CODE);
return ReferencedClassesProperty.set(this, classNames);
}
private static void addMethodType(@Nonnull Type methodType, @Nonnull Set classNames) {
for (Type argumentType : methodType.getArgumentTypes())
addType(argumentType, classNames);
Type returnType = methodType.getReturnType();
addType(returnType, classNames);
}
private static void addType(@Nonnull Type type, @Nonnull Set classNames) {
if (type.getSort() == Type.ARRAY)
type = type.getElementType();
if (!Types.isPrimitive(type))
addName(type.getInternalName(), classNames);
}
private static void addName(@Nonnull String className, @Nonnull Set classNames) {
if (className.isEmpty())
return;
if (className.indexOf(0) == '[' || className.charAt(className.length() - 1) == ';')
addType(Type.getType(className), classNames);
else if (className.indexOf(0) == '(')
addMethodType(Type.getMethodType(className), classNames);
else
classNames.add(className);
}
/**
* @return Set of all string constants listed in the constant pool.
*/
@Nonnull
default Set getStringConstants() {
SortedSet strings = StringDefinitionsProperty.get(this);
if (strings != null)
return strings;
Set stringSet = new HashSet<>();
ClassReader reader = getClassReader();
int itemCount = reader.getItemCount();
char[] buffer = new char[reader.getMaxStringLength()];
for (int i = 1; i < itemCount; i++) {
int offset = reader.getItem(i);
if (offset >= 10) {
int itemTag = reader.readByte(offset - 1);
if (itemTag == ConstantPoolConstants.STRING) {
String string = reader.readUTF8(offset, buffer);
stringSet.add(string);
}
}
}
StringDefinitionsProperty.set(this, stringSet);
return stringSet;
}
@Override
default void acceptIfJvmClass(@Nonnull Consumer action) {
action.accept(this);
}
@Override
default void acceptIfAndroidClass(@Nonnull Consumer action) {
// no-op
}
@Override
default boolean testIfJvmClass(@Nonnull Predicate predicate) {
return predicate.test(this);
}
@Override
default boolean testIfAndroidClass(@Nonnull Predicate predicate) {
return false;
}
@Nonnull
@Override
default JvmClassInfo asJvmClass() {
return this;
}
@Nonnull
@Override
default AndroidClassInfo asAndroidClass() {
throw new IllegalStateException("JVM class cannot be cast to Android class");
}
@Override
default boolean isJvmClass() {
return true;
}
@Override
default boolean isAndroidClass() {
return false;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/ModulesFileInfo.java
================================================
package software.coley.recaf.info;
/**
* Outline of a JVM modules file.
* This file is found at {@code %JAVA%/lib/modules}.
*
* @author Matt Coley
*/
public interface ModulesFileInfo extends FileInfo {
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/Named.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import net.greypanther.natsort.CaseInsensitiveSimpleNaturalComparator;
import software.coley.recaf.util.StringUtil;
import java.util.Comparator;
import java.util.Objects;
/**
* Outline of a type that can be identified by name.
*
* @author Matt Coley
*/
public interface Named {
/**
* Comparator for {@link String} items.
* First compares case-insensitively with natural ordering, then falls back to case-sensitive comparison.
*/
Comparator STRING_COMPARATOR = (a, b) -> {
// Fallback to natural string comparison, first case-insensitive but then case-sensitive to differentiate.
int cmp = CaseInsensitiveSimpleNaturalComparator.getInstance().compare(a, b);
if (cmp == 0)
cmp = a.compareTo(b);
return cmp;
};
/**
* Comparator for {@link Named} items.
* First compares case-insensitively with natural ordering, then falls back to case-sensitive comparison.
*
* @see #STRING_COMPARATOR
*/
Comparator NAMED_COMPARATOR = (o1, o2) -> {
String a = o1.getName();
String b = o2.getName();
return STRING_COMPARATOR.compare(a, b);
};
/**
* Comparator for {@link String} items whose content represent file paths.
*/
@SuppressWarnings("StringEquality")
Comparator STRING_PATH_COMPARATOR = (a, b) -> {
// Get parent directory path for each item.
String directoryPathA = StringUtil.cutOffAtLast(a, '/');
String directoryPathB = StringUtil.cutOffAtLast(b, '/');
if (!Objects.equals(directoryPathA, directoryPathB)) {
// The directory path is the input path (same reference) if there is no '/'.
// We always want root paths to be shown first since we group them in a container directory anyways.
if (directoryPathA == a && directoryPathB != b)
return -1;
if (directoryPathA != a && directoryPathB == b)
return 1;
// We want subdirectories to be shown first over files in the directory.
// The top-level directory being an empty string is an edge case.
if (directoryPathA.isEmpty())
return -1;
else if (directoryPathB.isEmpty())
return 1;
// If both paths have the same number of separators, then we can do a normal string comparison on the directory paths.
// If they have different numbers of separators, then we want to check if one is a parent of the other (or vice versa).
int sectionCountA = StringUtil.count('/', directoryPathA);
int sectionCountB = StringUtil.count('/', directoryPathB);
if (sectionCountA == sectionCountB) {
// Compare directories as paths.
int cmp = STRING_COMPARATOR.compare(directoryPathA, directoryPathB);
if (cmp != 0)
return cmp;
} else {
// Check for parent-child relationship between the directory paths. The parent directory should be shown first.
if (directoryPathB.startsWith(directoryPathA))
return 1;
else if (directoryPathA.startsWith(directoryPathB))
return -1;
}
}
return STRING_COMPARATOR.compare(a, b);
};
/**
* Comparator for {@link Named} items whose names represent file paths.
*
* @see #STRING_PATH_COMPARATOR
*/
Comparator NAMED_PATH_COMPARATOR = (o1, o2) -> {
String a = o1.getName();
String b = o2.getName();
return STRING_PATH_COMPARATOR.compare(a, b);
};
/**
* @return Identifying name.
*/
@Nonnull
String getName();
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/NativeLibraryFileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
/**
* Outline of a native library or application file.
*
* @author Matt Coley
*/
public interface NativeLibraryFileInfo extends FileInfo {
@Nonnull
@Override
default NativeLibraryFileInfo asNativeLibraryFile() {
return this;
}
@Override
default boolean isNativeLibraryFile() {
return true;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/StubClassInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import org.objectweb.asm.ClassReader;
import software.coley.recaf.info.annotation.AnnotationInfo;
import software.coley.recaf.info.annotation.TypeAnnotationInfo;
import software.coley.recaf.info.member.FieldMember;
import software.coley.recaf.info.member.MethodMember;
import software.coley.recaf.info.properties.Property;
import software.coley.recaf.util.ExcludeFromJacocoGeneratedReport;
import software.coley.recaf.util.JavaVersion;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Predicate;
/**
* Stub implementation of {@link ClassInfo}.
*
* @author Matt Coley
*/
@ExcludeFromJacocoGeneratedReport(justification = "Stub/placeholder type")
public class StubClassInfo implements ClassInfo {
private final String name;
private final List fields;
private final List methods;
/**
* @param name
* Class name.
*/
public StubClassInfo(@Nonnull String name) {
this(name, Collections.emptyList(), Collections.emptyList());
}
/**
* @param name
* Class name.
* @param fields
* Fields to include.
* @param methods
* Methods to include.
*/
public StubClassInfo(@Nonnull String name,
@Nonnull List fields,
@Nonnull List methods) {
this.name = name;
this.fields = fields;
this.methods = methods;
}
@Override
public int getAccess() {
return 0;
}
@Nullable
@Override
public String getSourceFileName() {
return null;
}
@Nonnull
@Override
public List getInterfaces() {
return Collections.emptyList();
}
@Nullable
@Override
public String getSuperName() {
return "java/lang/Object";
}
@Nullable
@Override
public String getSignature() {
return null;
}
@Nullable
@Override
public String getOuterClassName() {
return null;
}
@Nullable
@Override
public String getOuterMethodName() {
return null;
}
@Nullable
@Override
public String getOuterMethodDescriptor() {
return null;
}
@Nonnull
@Override
public List getOuterClassBreadcrumbs() {
return Collections.emptyList();
}
@Nonnull
@Override
public List getInnerClasses() {
return Collections.emptyList();
}
@Nonnull
@Override
public List getFields() {
return fields;
}
@Nonnull
@Override
public List getMethods() {
return methods;
}
@Override
public void acceptIfJvmClass(@Nonnull Consumer action) {
// no-op
}
@Override
public void acceptIfAndroidClass(@Nonnull Consumer action) {
// no-op
}
@Override
public boolean testIfJvmClass(@Nonnull Predicate predicate) {
return false;
}
@Override
public boolean testIfAndroidClass(@Nonnull Predicate predicate) {
return false;
}
@Override
public boolean isJvmClass() {
return false;
}
@Override
public boolean isAndroidClass() {
return false;
}
@Nonnull
@Override
public String getName() {
return name;
}
@Nonnull
@Override
public List getAnnotations() {
return Collections.emptyList();
}
@Nonnull
@Override
public List getTypeAnnotations() {
return Collections.emptyList();
}
@Override
public void setProperty(Property property) {
// no-op
}
@Override
public void removeProperty(String key) {
// no-op
}
@Nonnull
@Override
public Map> getProperties() {
return Collections.emptyMap();
}
@Nonnull
@Override
public JvmClassInfo asJvmClass() {
return new Jvm(name);
}
@Nonnull
@Override
public AndroidClassInfo asAndroidClass() {
return new Android(name);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
StubClassInfo that = (StubClassInfo) o;
return name.equals(that.name);
}
@Override
public int hashCode() {
return name.hashCode();
}
@Override
public String toString() {
return name;
}
private static class Android extends StubClassInfo implements AndroidClassInfo {
public Android(@Nonnull String name) {
super(name);
}
@Nonnull
@Override
public AndroidClassInfo asAndroidClass() {
return this;
}
}
private static class Jvm extends StubClassInfo implements JvmClassInfo {
public Jvm(@Nonnull String name) {
super(name);
}
@Nonnull
@Override
public JvmClassInfo asJvmClass() {
return this;
}
@Override
public int getVersion() {
return JavaVersion.VERSION_OFFSET + JavaVersion.get();
}
@Nonnull
@Override
public byte[] getBytecode() {
return new byte[0];
}
@Nonnull
@Override
public ClassReader getClassReader() {
throw new IllegalStateException("Cannot read from stub class!");
}
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/StubFieldMember.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import software.coley.recaf.info.member.FieldMember;
import software.coley.recaf.util.ExcludeFromJacocoGeneratedReport;
/**
* Stub implementation of {@link FieldMember}.
*
* @author Matt Coley
*/
@ExcludeFromJacocoGeneratedReport(justification = "Stub/placeholder type")
public class StubFieldMember extends StubMember implements FieldMember {
/**
* @param name
* Field name.
* @param desc
* Field descriptor.
* @param access
* Field access flags.
*/
public StubFieldMember(@Nonnull String name, @Nonnull String desc, int access) {
super(name, desc, access);
}
@Nullable
@Override
public Object getDefaultValue() {
return null;
}
@Override
public String toString() {
return getDescriptor() + ' ' + getName();
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/StubFileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import software.coley.recaf.info.properties.Property;
import software.coley.recaf.util.ExcludeFromJacocoGeneratedReport;
import software.coley.recaf.util.StringUtil;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.Collections;
import java.util.Map;
/**
* Stub implementation of {@link FileInfo}.
*
* @author Matt Coley
*/
@ExcludeFromJacocoGeneratedReport(justification = "Stub/placeholder type")
public class StubFileInfo implements FileInfo {
private final String name;
/**
* @param name
* File name.
*/
public StubFileInfo(@Nonnull String name) {
this.name = name;
}
/**
* @param text
* Text to assign.
*
* @return This file, with text content.
*/
@Nonnull
public TextFileInfo withText(@Nonnull String text) {
return withText(StandardCharsets.ISO_8859_1, text);
}
/**
* @param charset
* Charset of text.
* @param text
* Text to assign.
*
* @return This file, with text content.
*/
@Nonnull
public TextFileInfo withText(@Nonnull Charset charset, @Nonnull String text) {
return new StubTextFileInfo(name, charset, text);
}
@Nonnull
@Override
public byte[] getRawContent() {
return new byte[0];
}
@Nonnull
@Override
public String getName() {
return name;
}
@Override
public void setProperty(Property property) {
// no-op
}
@Override
public void removeProperty(String key) {
// no-op
}
@Nonnull
@Override
public Map> getProperties() {
return Collections.emptyMap();
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null) return false;
if (o instanceof FileInfo other) {
return name.equals(other.getName());
}
return false;
}
@Override
public int hashCode() {
return name.hashCode();
}
private static class StubTextFileInfo extends StubFileInfo implements TextFileInfo {
private final String text;
private final Charset charset;
/**
* @param name
* File name.
* @param charset
* Charset of text.
* @param text
* Text content.
*/
public StubTextFileInfo(@Nonnull String name, @Nonnull Charset charset, @Nonnull String text) {
super(name);
this.text = text;
this.charset = charset;
}
@Nonnull
@Override
public String getText() {
return text;
}
@Nonnull
@Override
public String[] getTextLines() {
return StringUtil.splitNewline(text);
}
@Nonnull
@Override
public Charset getCharset() {
return charset;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null) return false;
if (!super.equals(o)) return false;
if (o instanceof TextFileInfo other) {
return (text.equals(other.getText()));
}
return false;
}
@Override
public int hashCode() {
int result = super.hashCode();
result = 31 * result + text.hashCode();
return result;
}
@Override
public String toString() {
return getName() + " : <" + text + ">";
}
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/StubMember.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import software.coley.recaf.info.annotation.AnnotationInfo;
import software.coley.recaf.info.annotation.TypeAnnotationInfo;
import software.coley.recaf.info.member.ClassMember;
import software.coley.recaf.info.properties.Property;
import software.coley.recaf.util.ExcludeFromJacocoGeneratedReport;
import java.util.Collections;
import java.util.List;
import java.util.Map;
/**
* Stub implementation of {@link ClassMember}.
*
* @author Matt Coley
*/
@ExcludeFromJacocoGeneratedReport(justification = "Stub/placeholder type")
public abstract class StubMember implements ClassMember {
private final String name;
private final String desc;
private final int access;
/**
* @param name Member name.
* @param desc Member descriptor.
* @param access Member access flags.
*/
public StubMember(@Nonnull String name, @Nonnull String desc, int access) {
this.name = name;
this.desc = desc;
this.access = access;
}
@Nonnull
@Override
public String getName() {
return name;
}
@Nonnull
@Override
public String getDescriptor() {
return desc;
}
@Nullable
@Override
public String getSignature() {
return null;
}
@Override
public int getAccess() {
return access;
}
@Nonnull
@Override
public List getAnnotations() {
return Collections.emptyList();
}
@Nonnull
@Override
public List getTypeAnnotations() {
return Collections.emptyList();
}
@Override
public void setProperty(Property property) {}
@Override
public void removeProperty(String key) {}
@Nonnull
@Override
public Map> getProperties() {
return Collections.emptyMap();
}
@Override
public final boolean equals(Object o) {
if (!(o instanceof StubMember that)) return false;
return access == that.access
&& name.equals(that.name)
&& desc.equals(that.desc);
}
@Override
public int hashCode() {
int result = name.hashCode();
result = 31 * result + desc.hashCode();
result = 31 * result + access;
return result;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/StubMethodMember.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import jakarta.annotation.Nullable;
import software.coley.recaf.info.annotation.AnnotationElement;
import software.coley.recaf.info.member.LocalVariable;
import software.coley.recaf.info.member.MethodMember;
import software.coley.recaf.util.ExcludeFromJacocoGeneratedReport;
import java.util.Collections;
import java.util.List;
/**
* Stub implementation of {@link MethodMember}.
*
* @author Matt Coley
*/
@ExcludeFromJacocoGeneratedReport(justification = "Stub/placeholder type")
public class StubMethodMember extends StubMember implements MethodMember {
/**
* @param name
* Method name.
* @param desc
* Method descriptor.
* @param access
* Method access flags.
*/
public StubMethodMember(@Nonnull String name, @Nonnull String desc, int access) {
super(name, desc, access);
}
@Nonnull
@Override
public List getThrownTypes() {
return Collections.emptyList();
}
@Nonnull
@Override
public List getLocalVariables() {
return Collections.emptyList();
}
@Nullable
@Override
public AnnotationElement getAnnotationDefault() {
return null;
}
@Override
public String toString() {
return getName() + getDescriptor();
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/TextFileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
import software.coley.recaf.info.builder.TextFileInfoBuilder;
import java.nio.charset.Charset;
/**
* Outline of a text file.
*
* @author Matt Coley
*/
public interface TextFileInfo extends FileInfo {
/**
* @return New builder wrapping this file information.
*/
@Nonnull
default TextFileInfoBuilder toTextBuilder() {
return new TextFileInfoBuilder(this);
}
/**
* @return The {@link #getRawContent()} as text.
*/
@Nonnull
String getText();
/**
* @return The {@link #getText() text content} split into lines.
*/
@Nonnull
String[] getTextLines();
/**
* @return The charset used to encode {@link #getText() the text content}.
*/
@Nonnull
Charset getCharset();
@Nonnull
@Override
default TextFileInfo asTextFile() {
return this;
}
@Override
default boolean isTextFile() {
return true;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/VideoFileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
/**
* Outline of a video file.
*
* @author Matt Coley
*/
public interface VideoFileInfo extends FileInfo {
@Nonnull
@Override
default VideoFileInfo asVideoFile() {
return this;
}
@Override
default boolean isVideoFile() {
return true;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/WarFileInfo.java
================================================
package software.coley.recaf.info;
/**
* Outline of a WAR file container.
*
* @author Matt Coley
*/
public interface WarFileInfo extends ZipFileInfo {
/**
* WAR files prefix their class names with this.
*/
String WAR_CLASS_PREFIX = "WEB-INF/classes/";
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/ZipFileInfo.java
================================================
package software.coley.recaf.info;
import jakarta.annotation.Nonnull;
/**
* Outline of a ZIP file container.
*
* @author Matt Coley
* @see JarFileInfo
* @see WarFileInfo
* @see JModFileInfo
* @see ApkFileInfo
*/
public interface ZipFileInfo extends FileInfo {
@Nonnull
@Override
default ZipFileInfo asZipFile() {
return this;
}
@Override
default boolean isZipFile() {
return true;
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/annotation/Annotated.java
================================================
package software.coley.recaf.info.annotation;
import jakarta.annotation.Nonnull;
import software.coley.recaf.info.ClassInfo;
import software.coley.recaf.info.member.ClassMember;
import java.util.List;
import java.util.stream.Stream;
/**
* Outline of an annotated class or member.
*
* @author Matt Coley
* @see ClassInfo
* @see ClassMember
*/
public interface Annotated {
/**
* @return List of declared annotations.
*/
@Nonnull
List getAnnotations();
/**
* @return List of type annotations.
*/
@Nonnull
List getTypeAnnotations();
/**
* @return Stream of declared annotations.
*/
@Nonnull
default Stream annotationStream() {
return Stream.of(this).flatMap(self -> self.getAnnotations().stream());
}
/**
* @return Stream of type annotations.
*/
@Nonnull
default Stream typeAnnotationStream() {
return Stream.of(this).flatMap(self -> self.getAnnotations().stream());
}
/**
* @return Stream of both normal and type anotations.
*/
@Nonnull
default Stream allAnnotationsStream() {
return Stream.concat(annotationStream(), typeAnnotationStream());
}
}
================================================
FILE: recaf-core/src/main/java/software/coley/recaf/info/annotation/AnnotationArrayReference.java
================================================
package software.coley.recaf.info.annotation;
import jakarta.annotation.Nonnull;
import java.util.List;
/**
* Outline of a potential value for {@link AnnotationElement#getElementValue()}.
*
* @author Matt Coley
*/
public interface AnnotationArrayReference {
/**
* @return List of values.
*/
@Nonnull
List