add export to c# button
This commit is contained in:
Mystikfluu
@@ -0,0 +1,176 @@
|
||||
Class files essentially define classes, their fields, and their methods. A lot
|
||||
of essential and non-essential data are attached to these classes, fields, and
|
||||
methods as *attributes*. For instance, attributes can contain bytecode, source
|
||||
file names, line number tables, etc.
|
||||
|
||||
ProGuard's obfuscation step removes attributes that are generally not
|
||||
necessary for executing the code. With the
|
||||
[`-keepattributes`](usage.md#keepattributes) option, you can specify a filter
|
||||
for attributes that you do want to keep, for instance if your code accesses
|
||||
them through reflection, or if you want to preserve some compilation or
|
||||
debugging information. The filter works like any [filter](usage.md#filters) in
|
||||
ProGuard.
|
||||
|
||||
The following wildcards are supported:
|
||||
|
||||
| Wildcard | Meaning
|
||||
|-----|----------------------------------------------------
|
||||
| `?` | matches any single character in an attribute name.
|
||||
| `*` | matches any part of an attribute name.
|
||||
|
||||
An attribute name that is preceded by an exclamation mark '**!**' is
|
||||
*excluded* from further attempts to match with *subsequent* attribute names in
|
||||
the filter. Make sure to specify filters correctly, since they are not checked
|
||||
for potential typos.
|
||||
|
||||
For example, the following setting preserves the optional attributes that are
|
||||
typically necessary when processing code that is intended to be used as a
|
||||
library:
|
||||
```proguard
|
||||
-keepattributes Exceptions,InnerClasses,Signature,Deprecated,
|
||||
SourceFile,LineNumberTable,*Annotation*,EnclosingMethod
|
||||
```
|
||||
|
||||
The Java bytecode specifications currently specify the following list of
|
||||
attributes.
|
||||
|
||||
## Optional attributes
|
||||
|
||||
ProGuard's obfuscation step by default discards the following optional
|
||||
attributes. You can keep them with the
|
||||
[`-keepattributes`](usage.md#keepattributes) option.
|
||||
|
||||
`SourceFile`
|
||||
: Specifies the name of the source file from which the class file was
|
||||
compiled. If present, this name is reported in stack traces.
|
||||
|
||||
`SourceDir`<div>(J++ extension)</div>
|
||||
: Specifies the name of the source directory from which the class file was
|
||||
compiled.
|
||||
|
||||
`Record` <div>(Java 14 or higher)</div>
|
||||
: Specifies the components of a record class. Code may access this information
|
||||
by reflection.
|
||||
|
||||
`InnerClasses`
|
||||
: Specifies the relationship between a class and its inner classes and outer
|
||||
classes. Other than this and the naming convention with a '\$' separator
|
||||
between the names of inner classes and outer classes, inner classes are just
|
||||
like ordinary classes. Compilers may need this information to find classes
|
||||
referenced in a compiled library. Code may access this information by
|
||||
reflection, for instance to derive the simple name of the class.
|
||||
|
||||
`PermittedSubclasses` <div>(Java 15 or higher)</div>
|
||||
: Specifies the allowed extensions or implementations of sealed classes or
|
||||
interfaces.
|
||||
|
||||
`EnclosingMethod`<div>(Java 5 or higher)</div>
|
||||
: Specifies the method in which the class was defined. Compilers may need this
|
||||
information to find classes referenced in a compiled library. Code may
|
||||
access this information by reflection, for instance to derive the simple
|
||||
name of the class.
|
||||
|
||||
`Deprecated`
|
||||
: Indicates that the class, field, or method is deprecated.
|
||||
|
||||
`Synthetic`
|
||||
: Indicates that the class, field, or method was generated by the compiler.
|
||||
|
||||
`Signature`<div>(Java 5 or higher)</div>
|
||||
: Specifies the generic signature of the class, field, or method. Compilers
|
||||
may need this information to properly compile classes that use generic types
|
||||
from compiled libraries. Code may access this signature by reflection.
|
||||
|
||||
`MethodParameters`<div>(Java 8 or higher)</div>
|
||||
: Specifies the names and access flags of the parameters of the method. Code
|
||||
may access this information by reflection.
|
||||
|
||||
`Exceptions`
|
||||
: Specifies the exceptions that a method may throw. Compilers may use this
|
||||
information to enforce catching them.
|
||||
|
||||
`LineNumberTable`
|
||||
: Specifies the line numbers of the method. If present, these line numbers are
|
||||
reported in stack traces.
|
||||
|
||||
`LocalVariableTable`
|
||||
: Specifies the names and types of local variables of the method. If present,
|
||||
some IDEs may use this information for helping with auto-completion.
|
||||
|
||||
`LocalVariableTypeTable`<div>(Java 5 or higher)</div>
|
||||
: Specifies the names and generic types of local variables of the method. If
|
||||
present, some IDEs may use this information for helping with
|
||||
auto-completion.
|
||||
|
||||
`RuntimeVisibleAnnotations`<div>(Java 5 or higher)</div>
|
||||
: Specifies the annotations that are visible at run-time, for classes, fields,
|
||||
and methods. Compilers and annotation processors may use these annotations.
|
||||
Code may access them by reflection.
|
||||
|
||||
`RuntimeInvisibleAnnotations`<div>(Java 5 or higher)</div>
|
||||
|
||||
: Specifies the annotations that are visible at compile-time, for classes,
|
||||
fields, and methods. Compilers and annotation processors may use these
|
||||
annotations.
|
||||
|
||||
`RuntimeVisibleParameterAnnotations`<div>(Java 5 or higher)</div>
|
||||
|
||||
: Specifies the annotations that are visible at run-time, for method
|
||||
parameters. Compilers and annotation processors may use these annotations.
|
||||
Code may access them by reflection.
|
||||
|
||||
`RuntimeInvisibleParameterAnnotations`<div>(Java 5 or higher)</div>
|
||||
|
||||
: Specifies the annotations that are visible at compile-time, for method
|
||||
parameters. Compilers and annotation processors may use these annotations.
|
||||
|
||||
`RuntimeVisibleTypeAnnotations`<div>(Java 8 or higher)</div>
|
||||
: Specifies the annotations that are visible at run-time, for generic types,
|
||||
instructions, etc. Compilers and annotation processors may use these
|
||||
annotations. Code may access them by reflection.
|
||||
|
||||
`RuntimeInvisibleTypeAnnotations`<div>(Java 8 or higher)</div>
|
||||
|
||||
: Specifies the annotations that are visible at compile-time, for generic
|
||||
types, instructions, etc. Compilers and annotation processors may use these
|
||||
annotations.
|
||||
|
||||
`AnnotationDefault`<div>(Java 5 or higher)</div>
|
||||
: Specifies a default value for an annotation.
|
||||
|
||||
## Essential attributes
|
||||
|
||||
ProGuard automatically keeps the following essential attributes, processing
|
||||
them as necessary. We're listing them for the sake of completeness:
|
||||
|
||||
`ConstantValue`
|
||||
: Specifies a constant integer, float, class, string, etc.
|
||||
|
||||
`Code`
|
||||
: Specifies the actual bytecode of a method.
|
||||
|
||||
`StackMap`<div>(Java Micro Edition)</div>
|
||||
: Provides preverification information. The Java Virtual Machine can use this
|
||||
information to speed up the verification step when loading a class.
|
||||
|
||||
`StackMapTable`<div>(Java 6 or higher)</div>
|
||||
: Provides preverification information. The Java Virtual Machine can use this
|
||||
information to speed up the verification step when loading a class.
|
||||
|
||||
`BootstrapMethods`<div>(Java 7 or higher)</div>
|
||||
: Specifies the methods to bootstrap dynamic method invocations.
|
||||
|
||||
`Module`<div>(Java 9 or higher)</div>
|
||||
: Specifies the dependencies of a _module_.
|
||||
|
||||
`ModuleMainClass`<div>(Java 9 or higher)</div>
|
||||
: Specifies the main class of a _module_.
|
||||
|
||||
`ModulePackages`<div>(Java 9 or higher)</div>
|
||||
: Specifies the packages of a _module_.
|
||||
|
||||
`NestHost`<div>(Java 11 or higher)</div>
|
||||
: Specifies the host class of a _nest_, for example an outer class.
|
||||
|
||||
`NestMembers`<div>(Java 11 or higher)</div>
|
||||
: Specifies the members of a _nest_, for example the inner classes.
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,221 @@
|
||||
The optimization step of ProGuard can be switched off with the
|
||||
[`-dontoptimize`](usage.md#dontoptimize) option. For more fine-grained
|
||||
control over individual optimizations, experts can use the
|
||||
[`-optimizations`](usage.md#optimizations) option, with a filter based
|
||||
on the optimization names listed below. The filter works like any
|
||||
[filter](usage.md#filters) in ProGuard.
|
||||
|
||||
The following wildcards are supported:
|
||||
|
||||
| Wildcard | Meaning
|
||||
|-----|-------------------------------------------------------
|
||||
| `?` | matches any single character in an optimization name.
|
||||
| `*` | matches any part of an optimization name.
|
||||
|
||||
An optimization that is preceded by an exclamation mark '**!**' is
|
||||
*excluded* from further attempts to match with *subsequent* optimization
|
||||
names in the filter. Make sure to specify filters correctly, since they
|
||||
are not checked for potential typos.
|
||||
|
||||
For example,
|
||||
"**`code/simplification/variable,code/simplification/arithmetic`**" only
|
||||
performs the two specified peephole optimizations.
|
||||
|
||||
For example, "`!method/propagation/*`" performs all optimizations,
|
||||
except the ones that propagate values between methods.
|
||||
|
||||
For example, "`!code/simplification/advanced,code/simplification/*`"
|
||||
only performs all peephole optimizations.
|
||||
|
||||
Some optimizations necessarily imply other optimizations. These are then
|
||||
indicated. Note that the list is likely to change for newer versions, as
|
||||
optimizations are added and reorganized.
|
||||
|
||||
`library/gson`
|
||||
: Optimizes usages of the Gson library, whenever possible. See [Gson
|
||||
optimization](optimizations.md#gson) for more details.
|
||||
|
||||
`class/marking/final`
|
||||
: Marks classes as final, whenever possible.
|
||||
|
||||
`class/unboxing/enum`
|
||||
: Simplifies enum types to integer constants, whenever possible.
|
||||
|
||||
`class/merging/vertical`
|
||||
: Merges classes vertically in the class hierarchy, whenever possible.
|
||||
|
||||
`class/merging/horizontal`
|
||||
: Merges classes horizontally in the class hierarchy, whenever possible.
|
||||
|
||||
`class/merging/wrapper`
|
||||
: Merges wrapper classes with their wrapped classes, whenever possible.
|
||||
|
||||
`field/removal/writeonly`<div>(⇒ `code/removal/advanced`)</div>
|
||||
: Removes write-only fields.
|
||||
|
||||
`field/marking/private`
|
||||
: Marks fields as private, whenever possible.
|
||||
|
||||
`field/generalization/class`
|
||||
: Generalizes the classes of field accesses, whenever possible.
|
||||
|
||||
`field/specialization/type`
|
||||
: Specializes the types of fields, whenever possible
|
||||
|
||||
`field/propagation/value`<div>(⇒ `code/simplification/advanced`)</div>
|
||||
: Propagates the values of fields across methods.
|
||||
|
||||
`method/marking/private`
|
||||
: Marks methods as private, whenever possible (*devirtualization*).
|
||||
|
||||
`method/marking/static`<div>(⇒ `code/removal/advanced`)</div>
|
||||
: Marks methods as static, whenever possible (*devirtualization*).
|
||||
|
||||
`method/marking/final`
|
||||
: Marks methods as final, whenever possible.
|
||||
|
||||
`method/marking/synchronized`
|
||||
: Unmarks methods as synchronized, whenever possible.
|
||||
|
||||
`method/removal/parameter`<div>(⇒ `code/removal/advanced`)</div>
|
||||
: Removes unused method parameters.
|
||||
|
||||
`method/generalization/class`
|
||||
: Generalizes the classes of method invocations, whenever possible.
|
||||
|
||||
`method/specialization/parametertype`
|
||||
: Specializes the types of method parameters, whenever possible.
|
||||
|
||||
`method/specialization/returntype`
|
||||
: Specializes the types of method return values, whenever possible.
|
||||
|
||||
`method/propagation/parameter`<div>(⇒ `code/simplification/advanced`)</div>
|
||||
: Propagates the values of method parameters from method invocations to the
|
||||
invoked methods.
|
||||
|
||||
`method/propagation/returnvalue`<div>(⇒ `code/simplification/advanced`)</div>
|
||||
: Propagates the values of method return values from methods to their
|
||||
invocations.
|
||||
|
||||
`method/inlining/short`
|
||||
: Inlines short methods.
|
||||
|
||||
`method/inlining/unique`
|
||||
: Inlines methods that are only called once.
|
||||
|
||||
`method/inlining/tailrecursion`
|
||||
: Simplifies tail recursion calls, whenever possible.
|
||||
|
||||
`code/merging`
|
||||
: Merges identical blocks of code by modifying branch targets.
|
||||
|
||||
`code/simplification/variable`
|
||||
: Performs peephole optimizations for variable loading and storing.
|
||||
|
||||
`code/simplification/arithmetic`
|
||||
: Performs peephole optimizations for arithmetic instructions.
|
||||
|
||||
`code/simplification/cast`
|
||||
: Performs peephole optimizations for casting operations.
|
||||
|
||||
`code/simplification/field`
|
||||
: Performs peephole optimizations for field loading and storing.
|
||||
|
||||
`code/simplification/branch`<div>(⇒ `code/removal/simple`)</div>
|
||||
: Performs peephole optimizations for branch instructions.
|
||||
|
||||
`code/simplification/object`
|
||||
: Performs peephole optimizations for object instantiation.
|
||||
|
||||
`code/simplification/string`
|
||||
: Performs peephole optimizations for constant strings.
|
||||
|
||||
`code/simplification/math`
|
||||
: Performs peephole optimizations for Math method calls.
|
||||
|
||||
`code/simplification/advanced`<div>(*best used with* `code/removal/advanced`)</div>
|
||||
: Simplifies code based on control flow analysis and data flow analysis.
|
||||
|
||||
`code/removal/advanced`<div>(⇒ `code/removal/exception`)</div>
|
||||
: Removes dead code based on control flow analysis and data flow analysis.
|
||||
|
||||
`code/removal/simple`<div>(⇒ `code/removal/exception`)</div>
|
||||
: Removes dead code based on a simple control flow analysis.
|
||||
|
||||
`code/removal/variable`
|
||||
: Removes unused variables from the local variable frame.
|
||||
|
||||
`code/removal/exception`
|
||||
: Removes exceptions with empty try blocks.
|
||||
|
||||
`code/allocation/variable`
|
||||
: Optimizes variable allocation on the local variable frame.
|
||||
|
||||
ProGuard also provides some unofficial settings to control
|
||||
optimizations, that may disappear in future versions. These are Java
|
||||
system properties, which can be set as JVM arguments (with `-D...`):
|
||||
|
||||
`maximum.inlined.code.length` (default = 8 bytes)
|
||||
: Specifies the maximum code length (expressed in bytes) of short methods
|
||||
that are eligible to be inlined. Inlining methods that are too long may
|
||||
unnecessarily inflate the code size.
|
||||
|
||||
`maximum.resulting.code.length` (default = 8000 bytes for JSE, 2000 bytes for JME)
|
||||
: Specifies the maximum resulting code length (expressed in bytes) allowed
|
||||
when inlining methods. Many Java virtual machines do not apply just-in-time
|
||||
compilation to methods that are too long, so it's important not to let them
|
||||
grow too large.
|
||||
|
||||
## Aggressive optimization
|
||||
|
||||
ProGuard provides the `-optimizeaggressively` option. If set, this enables more
|
||||
aggressive assumptions during optimization. This might lead to
|
||||
improved performance and/or reduced code size, but might result in different behavior in rare cases.
|
||||
For example, reading from an array might cause an
|
||||
`ArrayIndexOutOfBoundsException` to be thrown. Strictly speaking, this means
|
||||
that such an instruction can have a side effect. If this instruction is removed
|
||||
during optimization, the code will thus behave differently under specific
|
||||
circumstances. By default, such instructions are always preserved. Setting this
|
||||
option will lead to these instructions being candidates for removal during
|
||||
optimization. Additionally, class merging is only enabled when this option is set.
|
||||
|
||||
## Gson optimization {: #gson}
|
||||
|
||||
ProGuard optimizes Gson code by detecting which domain classes are serialized
|
||||
using the Gson library. It replaces the reflection-based implementation of
|
||||
GSON for reading and writing fields with injected and optimized code that
|
||||
accesses the fields of the domain classes directly when reading and writing
|
||||
JSON. The benefits of this optimization are the following:
|
||||
|
||||
- Domain classes used in conjunction with GSON can be freely obfuscated.
|
||||
- The injected serialization code gives better performance compared to the
|
||||
GSON implementation, which relies on reflection.
|
||||
- Less configuration is needed as the optimization automatically keeps classes
|
||||
and fields that are required for serialization.
|
||||
|
||||
### Configuration
|
||||
|
||||
The Gson optimization is enabled by default and doesn't require any additional
|
||||
configuration, as long as the application code doesn't use unsupported Gson
|
||||
features(see [Known limitations](optimizations.md#gsonlimitations)).
|
||||
|
||||
### Known limitations {: #gsonlimitations}
|
||||
|
||||
ProGuard can not optimize the following use cases of Gson:
|
||||
|
||||
- Serializing classes containing one of the following Gson annotations:
|
||||
- `@JsonAdapter`
|
||||
- `@Since`
|
||||
- `@Until`
|
||||
- Serializing classes that have generic type variables in their signature.
|
||||
- Serializing classes using a Gson instance that was built with one of the
|
||||
following settings on the GsonBuilder:
|
||||
- `excludeFieldsWithModifier`
|
||||
- `setFieldNamingPolicy`
|
||||
|
||||
When one of the above Gson features is used, ProGuard automatically preserves
|
||||
the original Gson implementation for all affected domain classes.
|
||||
|
||||
This means that the serialized fields of these domain classes need to be
|
||||
explicitly kept again in the ProGuard configuration so that they can be
|
||||
safely accessed through reflection.
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user