fix: reword rename flags in cli and gui (#1178)

README.md

@@ -92,24 +92,29 @@ options:
   --deobf-min                         - min length of name, renamed if shorter, default: 3
   --deobf-max                         - max length of name, renamed if longer, default: 64
   --deobf-cfg-file                    - deobfuscation map file, default: same dir and name as input file with '.jobf' extension
-  --deobf-rewrite-cfg                 - force to save deobfuscation map
+  --deobf-rewrite-cfg                 - force to ignore and overwrite deobfuscation map file
   --deobf-use-sourcename              - use source file name as class name alias
   --deobf-parse-kotlin-metadata       - parse kotlin metadata to class and package names
-  --rename-flags                      - what to rename, comma-separated, 'case' for system case sensitivity, 'valid' for java identifiers, 'printable' characters, 'none' or 'all' (default)
+  --rename-flags                      - fix options (comma-separated list of):
+                                         'case' - fix case sensitivity issues (according to --fs-case-sensitive option),
+                                         'valid' - rename java identifiers to make them valid,
+                                         'printable' - remove non-printable chars from identifiers,
+                                        or single 'none' - to disable all renames
+                                        or single 'all' - to enable all (default)
   --fs-case-sensitive                 - treat filesystem as case sensitive, false by default
   --cfg                               - save methods control flow graph to dot file
   --raw-cfg                           - save methods control flow graph (use raw instructions)
   -f, --fallback                      - make simple dump (using goto instead of 'if', 'for', etc)
+  --log-level                         - set log level, values: QUIET, PROGRESS, ERROR, WARN, INFO, DEBUG, default: PROGRESS
   -v, --verbose                       - verbose output (set --log-level to DEBUG)
   -q, --quiet                         - turn off output (set --log-level to QUIET)
-  --log-level                         - set log level, values: QUIET, PROGRESS, ERROR, WARN, INFO, DEBUG, default: PROGRESS
   --version                           - print jadx version
   -h, --help                          - print this help
-Example:
- jadx -d out classes.dex
- jadx --rename-flags "none" classes.dex
- jadx --rename-flags "valid,printable" classes.dex
- jadx --log-level error app.apk
+Examples:
+  jadx -d out classes.dex
+  jadx --rename-flags "none" classes.dex
+  jadx --rename-flags "valid, printable" classes.dex
+  jadx --log-level ERROR app.apk
 ```
 These options also worked on jadx-gui running from command line and override options from preferences dialog
 

jadx-cli/src/main/java/jadx/cli/JCommanderWrapper.java

@@ -5,7 +5,6 @@ import java.lang.reflect.Field;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.LinkedHashMap;
-import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
 
@@ -80,26 +79,37 @@ public class JCommanderWrapper<T> {
 			}
 			StringBuilder opt = new StringBuilder();
 			opt.append("  ").append(p.getNames());
+			String description = p.getDescription();
 			addSpaces(opt, maxNamesLen - opt.length() + 3);
-			opt.append("- ").append(p.getDescription());
+			if (description.contains("\n")) {
+				String[] lines = description.split("\n");
+				opt.append("- ").append(lines[0]);
+				for (int i = 1; i < lines.length; i++) {
+					opt.append('\n');
+					addSpaces(opt, maxNamesLen + 5);
+					opt.append(lines[i]);
+				}
+			} else {
+				opt.append("- ").append(description);
+			}
 			String defaultValue = getDefaultValue(args, f, opt);
 			if (defaultValue != null) {
 				opt.append(", default: ").append(defaultValue);
 			}
 			out.println(opt);
 		}
-		out.println("Example:");
+		out.println("Examples:");
 		out.println("  jadx -d out classes.dex");
+		out.println("  jadx --rename-flags \"none\" classes.dex");
+		out.println("  jadx --rename-flags \"valid, printable\" classes.dex");
+		out.println("  jadx --log-level ERROR app.apk");
 	}
 
 	/**
 	 * Get all declared fields of the specified class and all super classes
-	 *
-	 * @param clazz
-	 * @return
 	 */
 	private List<Field> getFields(Class<?> clazz) {
-		List<Field> fieldList = new LinkedList<>();
+		List<Field> fieldList = new ArrayList<>();
 		while (clazz != null) {
 			fieldList.addAll(Arrays.asList(clazz.getDeclaredFields()));
 			clazz = clazz.getSuperclass();

jadx-cli/src/main/java/jadx/cli/JadxCLIArgs.java

@@ -91,7 +91,7 @@ public class JadxCLIArgs {
 	)
 	protected String deobfuscationMapFile;
 
-	@Parameter(names = { "--deobf-rewrite-cfg" }, description = "force to save deobfuscation map")
+	@Parameter(names = { "--deobf-rewrite-cfg" }, description = "force to ignore and overwrite deobfuscation map file")
 	protected boolean deobfuscationForceSave = false;
 
 	@Parameter(names = { "--deobf-use-sourcename" }, description = "use source file name as class name alias")
@@ -102,11 +102,12 @@ public class JadxCLIArgs {
 
 	@Parameter(
 			names = { "--rename-flags" },
-			description = "what to rename, comma-separated,"
-					+ " 'case' for system case sensitivity,"
-					+ " 'valid' for java identifiers,"
-					+ " 'printable' characters,"
-					+ " 'none' or 'all' (default)",
+			description = "fix options (comma-separated list of): "
+					+ "\n 'case' - fix case sensitivity issues (according to --fs-case-sensitive option),"
+					+ "\n 'valid' - rename java identifiers to make them valid,"
+					+ "\n 'printable' - remove non-printable chars from identifiers,"
+					+ "\nor single 'none' - to disable all renames"
+					+ "\nor single 'all' - to enable all (default)",
 			converter = RenameConverter.class
 	)
 	protected Set<RenameEnum> renameFlags = EnumSet.allOf(RenameEnum.class);
@@ -123,12 +124,6 @@ public class JadxCLIArgs {
 	@Parameter(names = { "-f", "--fallback" }, description = "make simple dump (using goto instead of 'if', 'for', etc)")
 	protected boolean fallbackMode = false;
 
-	@Parameter(names = { "-v", "--verbose" }, description = "verbose output (set --log-level to DEBUG)")
-	protected boolean verbose = false;
-
-	@Parameter(names = { "-q", "--quiet" }, description = "turn off output (set --log-level to QUIET)")
-	protected boolean quiet = false;
-
 	@Parameter(
 			names = { "--log-level" },
 			description = "set log level, values: QUIET, PROGRESS, ERROR, WARN, INFO, DEBUG",
@@ -136,6 +131,12 @@ public class JadxCLIArgs {
 	)
 	protected LogHelper.LogLevelEnum logLevel = LogHelper.LogLevelEnum.PROGRESS;
 
+	@Parameter(names = { "-v", "--verbose" }, description = "verbose output (set --log-level to DEBUG)")
+	protected boolean verbose = false;
+
+	@Parameter(names = { "-q", "--quiet" }, description = "turn off output (set --log-level to QUIET)")
+	protected boolean quiet = false;
+
 	@Parameter(names = { "--version" }, description = "print jadx version")
 	protected boolean printVersion = false;
 
@@ -219,9 +220,7 @@ public class JadxCLIArgs {
 		args.setInsertDebugLines(addDebugLines);
 		args.setInlineAnonymousClasses(inlineAnonymousClasses);
 		args.setInlineMethods(inlineMethods);
-		args.setRenameCaseSensitive(isRenameCaseSensitive());
-		args.setRenameValid(isRenameValid());
-		args.setRenamePrintable(isRenamePrintable());
+		args.setRenameFlags(renameFlags);
 		args.setFsCaseSensitive(fsCaseSensitive);
 		return args;
 	}
@@ -368,7 +367,7 @@ public class JadxCLIArgs {
 			Set<RenameEnum> set = EnumSet.noneOf(RenameEnum.class);
 			for (String s : value.split(",")) {
 				try {
-					set.add(RenameEnum.valueOf(s.toUpperCase(Locale.ROOT)));
+					set.add(RenameEnum.valueOf(s.trim().toUpperCase(Locale.ROOT)));
 				} catch (IllegalArgumentException e) {
 					throw new IllegalArgumentException(
 							'\'' + s + "' is unknown for parameter " + paramName

jadx-gui/src/main/java/jadx/gui/settings/JadxSettings.java

@@ -535,13 +535,15 @@ public class JadxSettings extends JadxCLIArgs {
 		LOG.debug("upgrade settings from version: {} to {}", fromVersion, CURRENT_SETTINGS_VERSION);
 		if (fromVersion == 0) {
 			setDeobfuscationMinLength(3);
+			setDeobfuscationMaxLength(64);
 			setDeobfuscationUseSourceNameAsAlias(true);
 			setDeobfuscationParseKotlinMetadata(true);
-			setDeobfuscationForceSave(true);
-			setThreadsCount(1);
+			setDeobfuscationForceSave(false);
+			setThreadsCount(JadxArgs.DEFAULT_THREADS_COUNT);
 			setReplaceConsts(true);
 			setSkipResources(false);
 			setAutoStartJobs(false);
+			setAutoSaveProject(true);
 			fromVersion++;
 		}
 		if (fromVersion == 1) {

jadx-gui/src/main/resources/i18n/Messages_en_US.properties

@@ -148,10 +148,10 @@ preferences.reset_message=Reset settings to default values?
 preferences.reset_title=Reset settings
 preferences.copy=Copy to clipboard
 preferences.copy_message=All settings values has been copied to clipboard
-preferences.rename=Rename
-preferences.rename_case=System case sensitivity
-preferences.rename_valid=To be valid identifier
-preferences.rename_printable=To be printable
+preferences.rename=Rename identifiers
+preferences.rename_case=To fix case sensitivity issues
+preferences.rename_valid=To make them valid
+preferences.rename_printable=To make printable
 preferences.search_res_title=Search Resource
 preferences.res_file_ext=File Extensions (e.g. .xml|.html), * means all
 preferences.res_skip_file=Skip files exceed (MB)