Refactor output modes to use enum #489
Description
Currently you can often see in the code the following pattern:
RZ_API void rz_core_task_list(RzCore *core, int mode) {
if (mode == 'j') {
...
}
}In some cases it looks like that:
RZ_API int rz_core_disasm_pde(RzCore *core, int nb_opcodes, int mode) {
if (mode == RZ_MODE_JSON) {
...
}
}Sometimes there is no "mode" word, and it looks like that:
RZ_API void rz_analysis_xrefs_list(RzAnalysis *analysis, int rad) {
...
if (rad == 'j') {
...
}
I recommend to search for int mode and char mode patterns in the code.
It prevents catching some errors at the compilation time and reduces the readability.
Should be refactored to use enum instead, across the whole Rizin code.
After everything ported, the following hardcoded values should be removed from librz/include/rz_types.h:
#define RZ_MODE_PRINT 0x000
#define RZ_MODE_SET 0x002
#define RZ_MODE_SIMPLE 0x004
#define RZ_MODE_JSON 0x008
#define RZ_MODE_SIMPLEST 0x020See, for example:
librz/util/range.c
314:int rz_range_list(RRange *rgs, int rad) {
librz/io/io_cache.c
93:RZ_API bool rz_io_cache_list(RzIO *io, int rad) {
librz/main/rz-bin.c
63:static RzOutputMode rad2outputmode(int rad) {
471:static int rabin_do_operation(RzBin *bin, const char *op, int rad, const char *output, const char *file) {
622:static void __listPlugins(RzBin *bin, const char *plugin_name, PJ *pj, int rad) {
656: int rad = 0;
librz/core/core_private.h
123:RZ_IPI bool rz_core_debug_reg_list(RzCore *core, int type, int size, bool skip_covered, PJ *pj, int rad, const char *use_color);
librz/core/cdebug.c
300:RZ_IPI bool rz_core_debug_reg_list(RzCore *core, int type, int size, bool skip_covered, PJ *pj, int rad, const char *use_color) {
librz/core/cmd/cmd_flag.c
734: int rad;
759:static void print_function_labels_for(RzAnalysisFunction *fcn, int rad, PJ *pj) {
772:static void print_function_labels(RzAnalysis *analysis, RzAnalysisFunction *fcn, int rad) {
librz/core/canalysis.c
4157:static bool found_xref(RzCore *core, ut64 at, ut64 xref_to, RzAnalysisXRefType type, PJ *pj, int rad, int cfg_debug, bool cfg_analysis_strings) {
4225:RZ_API int rz_core_analysis_search_xrefs(RzCore *core, ut64 from, ut64 to, PJ *pj, int rad) {
librz/core/cmd/cmd_analysis.c
7005: int rad;
librz/debug/ddesc.c
71:RZ_API int rz_debug_desc_list(RzDebug *dbg, int rad) {
librz/flag/flag.c
374:RZ_API void rz_flag_list(RzFlag *f, int rad, const char *pfx) {
librz/debug/p/bfvm.c
273:RZ_API void bfvm_show_regs(BfvmCPU *c, int rad) {
289:RZ_API void bfvm_maps(BfvmCPU *c, int rad) {
librz/cons/pal.c
526:RZ_API void rz_cons_pal_list(int rad, const char *arg) {
librz/include/rz_flag.h
97:RZ_API void rz_flag_list(RzFlag *f, int rad, const char *pfx);
librz/include/rz_debug.h
518:RZ_API int rz_debug_desc_list(RzDebug *dbg, int rad);
librz/include/rz_cons.h
953:RZ_API void rz_cons_pal_list(int rad, const char *arg);
librz/include/rz_analysis.h
55: int rad;
librz/include/rz_io.h
394:RZ_API bool rz_io_cache_list(RzIO *io, int rad);
librz/include/rz_core.h
670:RZ_API int rz_core_analysis_search_xrefs(RzCore *core, ut64 from, ut64 to, PJ *pj, int rad);
librz/include/rz_util/rz_range.h
35:RZ_API int rz_range_list(RRange *rgs, int rad);