#include <rz_demangler.h>
#include <rz_util.h>
#include <rz_libdemangle.h>
#include <config.h>

Macros
#define	DEFINE_DEMANGLER_PLUGIN(name, lang, lic, auth, handler)

Functions
	DEFINE_DEMANGLER_PLUGIN (java, "java", "LGPL3", "deroad", libdemangle_handler_java)

	DEFINE_DEMANGLER_PLUGIN (msvc, "msvc", "LGPL3", "inisider", libdemangle_handler_msvc)

	DEFINE_DEMANGLER_PLUGIN (objc, "objc", "LGPL3", "pancake", libdemangle_handler_objc)

	RZ_LIB_VERSION (rz_demangler)

RZ_API RZ_OWN char *	rz_demangler_java (RZ_NULLABLE const char *symbol)
	Demangles java symbols. More...

RZ_API RZ_OWN char *	rz_demangler_cxx (RZ_NONNULL const char *symbol)
	Demangles c++ symbols. More...

RZ_API RZ_OWN char *	rz_demangler_objc (RZ_NONNULL const char *symbol)
	Demangles objc symbols. More...

RZ_API RZ_OWN char *	rz_demangler_rust (RZ_NONNULL const char *symbol)
	Demangles rust symbols. More...

RZ_API RZ_OWN char *	rz_demangler_msvc (RZ_NONNULL const char *symbol)
	Demangles microsft vc symbols. More...

RZ_API RZ_OWN RzDemangler *	rz_demangler_new (void)
	Initializes the plugin list and returns a RzDemangler struct. More...

RZ_API void	rz_demangler_free (RZ_NULLABLE RzDemangler *dem)
	Frees the RzDemangler struct. More...

RZ_API void	rz_demangler_plugin_iterate (RZ_NONNULL RzDemangler dem, RZ_NONNULL RzDemanglerIter iter, RZ_NULLABLE void data)
	Iterates over the plugin list. More...

RZ_API bool	rz_demangler_plugin_add (RZ_NONNULL RzDemangler dem, RZ_NONNULL RzDemanglerPlugin plugin)
	Adds a new demangler plugin to the plugin list. More...

RZ_API RZ_BORROW const RzDemanglerPlugin *	rz_demangler_plugin_get (RZ_NONNULL RzDemangler dem, RZ_NONNULL const char language)
	Returns a demangler plugin pointer based on the language that is found. More...

RZ_API bool	rz_demangler_resolve (RZ_NONNULL RzDemangler dem, RZ_NULLABLE const char symbol, RZ_NONNULL const char language, RZ_NONNULL RZ_OWN char *output)
	Resolves a symbol based on its language and return an output that needs to be freed. More...

Variables
static RzDemanglerPlugin *	demangler_static_plugins [] = { RZ_DEMANGLER_STATIC_PLUGINS }

Macro Definition Documentation

◆ DEFINE_DEMANGLER_PLUGIN

#define DEFINE_DEMANGLER_PLUGIN	(	name,
		lang,
		lic,
		auth,
		handler
	)

Value:

    RZ_API RzDemanglerPlugin rz_demangler_plugin_##name = { \
        .language = lang, \
        .license = lic, \
        .author = auth, \
        .demangle = &handler, \
    }

Definition at line 10 of file demangler.c.

Function Documentation

◆ DEFINE_DEMANGLER_PLUGIN() [1/3]

DEFINE_DEMANGLER_PLUGIN	(	java	,
		"java"	,
		"LGPL3"	,
		"deroad"	,
		libdemangle_handler_java
	)

◆ DEFINE_DEMANGLER_PLUGIN() [2/3]

DEFINE_DEMANGLER_PLUGIN	(	msvc	,
		"msvc"	,
		"LGPL3"	,
		"inisider"	,
		libdemangle_handler_msvc
	)

◆ DEFINE_DEMANGLER_PLUGIN() [3/3]

DEFINE_DEMANGLER_PLUGIN	(	objc	,
		"objc"	,
		"LGPL3"	,
		"pancake"	,
		libdemangle_handler_objc
	)

◆ rz_demangler_cxx()

RZ_API RZ_OWN char* rz_demangler_cxx ( RZ_NONNULL const char * symbol )

Demangles c++ symbols.

Definition at line 45 of file demangler.c.

                                                                     {
 #if WITH_GPL
     return libdemangle_handler_cxx(symbol);
 #else
     return NULL;
 #endif
 }

References NULL.

◆ rz_demangler_free()

RZ_API void rz_demangler_free ( RZ_NULLABLE RzDemangler * dem )

Frees the RzDemangler struct.

Definition at line 112 of file demangler.c.

                                                             {
     if (!dem) {
         return;
     }
     rz_list_free(dem->plugins);
     free(dem);
 }

References free(), and rz_list_free().

Referenced by rz_bin_free(), and rz_bin_new().

◆ rz_demangler_java()

RZ_API RZ_OWN char* rz_demangler_java ( RZ_NULLABLE const char * symbol )

Demangles java symbols.

Definition at line 38 of file demangler.c.

                                                                       {
     return libdemangle_handler_java(symbol);
 }

References libdemangle_handler_java().

Referenced by classdump_java(), demangle_type(), rz_bin_demangle(), rz_bin_java_class_as_source_code(), rz_bin_java_class_const_pool_as_text(), rz_bin_java_class_methods_as_symbols(), and rz_cmd_javar_handler().

◆ rz_demangler_msvc()

RZ_API RZ_OWN char* rz_demangler_msvc ( RZ_NONNULL const char * symbol )

Demangles microsft vc symbols.

Definition at line 74 of file demangler.c.

                                                                      {
     return libdemangle_handler_msvc(symbol);
 }

References libdemangle_handler_msvc().

Referenced by pdb_set_symbols(), rz_bin_demangle(), and rz_core_bin_pdb_gvars_as_string().

◆ rz_demangler_new()

RZ_API RZ_OWN RzDemangler* rz_demangler_new ( void )

Initializes the plugin list and returns a RzDemangler struct.

Definition at line 81 of file demangler.c.

                                                   {
     RzDemangler *dem = RZ_NEW0(RzDemangler);
     if (!dem) {
         return NULL;
     }
  
     RzList *plugins = rz_list_new();
     if (!plugins) {
         free(dem);
         return NULL;
     }
  
     for (ut32 i = 0; i < RZ_ARRAY_SIZE(demangler_static_plugins); ++i) {
         RzDemanglerPlugin *p = demangler_static_plugins[i];
         rz_warn_if_fail(p->language);
         rz_warn_if_fail(p->license);
         rz_warn_if_fail(p->author);
         rz_warn_if_fail(p->demangle);
         if (!p->demangle || !rz_list_append(plugins, p)) {
             const char *lang = p->language ? p->language : "";
             RZ_LOG_WARN("rz_demangler: failed to add '%s' plugin at index %u", lang, i);
         }
     }
  
     dem->plugins = plugins;
     return dem;
 }

References demangler_static_plugins, free(), i, NULL, p, rz_demangler_t::plugins, RZ_ARRAY_SIZE, rz_list_append(), rz_list_new(), RZ_LOG_WARN, RZ_NEW0, and rz_warn_if_fail.

Referenced by rz_bin_new().

◆ rz_demangler_objc()

RZ_API RZ_OWN char* rz_demangler_objc ( RZ_NONNULL const char * symbol )

Demangles objc symbols.

Definition at line 56 of file demangler.c.

                                                                      {
     return libdemangle_handler_objc(symbol);
 }

References libdemangle_handler_objc().

Referenced by rz_bin_demangle().

◆ rz_demangler_plugin_add()

RZ_API bool rz_demangler_plugin_add	(	RZ_NONNULL RzDemangler *	dem,
		RZ_NONNULL RzDemanglerPlugin *	plugin
	)

Adds a new demangler plugin to the plugin list.

If two plugins handles the same language, then the old plugin is removed.

Definition at line 144 of file demangler.c.

                                                                                                        {
     rz_return_val_if_fail(dem && dem->plugins && plugin && plugin->language, false);
     rz_warn_if_fail(plugin->author);
     rz_warn_if_fail(plugin->license);
  
     const RzDemanglerPlugin *cp;
     RzListIter *it = NULL;
  
     rz_list_foreach (dem->plugins, it, cp) {
         if (!strcmp(cp->language, plugin->language)) {
             // avoids to have duplicates
             rz_list_delete(dem->plugins, it);
             break;
         }
     }
  
     return rz_list_append(dem->plugins, plugin);
 }

References rz_demangler_plugin_t::language, NULL, rz_list_append(), rz_list_delete(), rz_return_val_if_fail, and rz_warn_if_fail.

Referenced by __lib_demangler_cb().

◆ rz_demangler_plugin_get()

RZ_API RZ_BORROW const RzDemanglerPlugin* rz_demangler_plugin_get	(	RZ_NONNULL RzDemangler *	dem,
		RZ_NONNULL const char *	language
	)

Returns a demangler plugin pointer based on the language that is found.

This function returns NULL only when the requested language is not available.

Definition at line 168 of file demangler.c.

                                                                                                                                 {
     rz_return_val_if_fail(RZ_STR_ISNOTEMPTY(language) && dem && dem->plugins, NULL);
  
     RzListIter *it;
     const RzDemanglerPlugin *plugin;
     rz_list_foreach (dem->plugins, it, plugin) {
         if (!strcmp(language, plugin->language)) {
             return plugin;
         }
     }
  
     return NULL;
 }

References rz_demangler_plugin_t::language, NULL, rz_return_val_if_fail, and RZ_STR_ISNOTEMPTY.

Referenced by rz_main_rz_bin().

◆ rz_demangler_plugin_iterate()

RZ_API void rz_demangler_plugin_iterate	(	RZ_NONNULL RzDemangler *	dem,
		RZ_NONNULL RzDemanglerIter	iter,
		RZ_NULLABLE void *	data
	)

Iterates over the plugin list.

Iterates over the plugin list and passes a RzDemanglerPlugin pointer to the iter function; if the iter function returns false, then the iteration is halted.

Definition at line 127 of file demangler.c.

                                                                                                                               {
     rz_return_if_fail(dem && dem->plugins && iter);
     const RzDemanglerPlugin *plugin;
     RzListIter *it;
  
     rz_list_foreach (dem->plugins, it, plugin) {
         if (!iter(plugin, data)) {
             break;
         }
     }
 }

References rz_return_if_fail.

Referenced by rz_cmd_info_demangle_handler(), rz_cmd_info_demangle_list_handler(), and rz_main_rz_bin().

◆ rz_demangler_resolve()

RZ_API bool rz_demangler_resolve	(	RZ_NONNULL RzDemangler *	dem,
		RZ_NULLABLE const char *	symbol,
		RZ_NONNULL const char *	language,
		RZ_NONNULL RZ_OWN char **	output
	)

Resolves a symbol based on its language and return an output that needs to be freed.

This function fails only when the requested language is not available.

Definition at line 187 of file demangler.c.

                                                                                                                                                                 {
     rz_return_val_if_fail(language && dem->plugins && output, false);
  
     if (RZ_STR_ISEMPTY(symbol)) {
         *output = NULL;
         return true;
     }
  
     const RzDemanglerPlugin *plugin;
     RzListIter *it;
  
     rz_list_foreach (dem->plugins, it, plugin) {
         if (!strcmp(plugin->language, language)) {
             *output = plugin->demangle(symbol);
             return true;
         }
     }
  
     return false;
 }

References rz_demangler_plugin_t::demangle, rz_demangler_plugin_t::language, NULL, output, rz_return_val_if_fail, and RZ_STR_ISEMPTY.

Referenced by rz_bin_demangle(), and rz_cmd_info_demangle_handler().

◆ rz_demangler_rust()

RZ_API RZ_OWN char* rz_demangler_rust ( RZ_NONNULL const char * symbol )

Demangles rust symbols.

Definition at line 63 of file demangler.c.

                                                                      {
 #if WITH_GPL
     return libdemangle_handler_rust(symbol);
 #else
     return NULL;
 #endif
 }

References libdemangle_handler_rust(), and NULL.

◆ RZ_LIB_VERSION()

RZ_LIB_VERSION ( rz_demangler )

Variable Documentation

◆ demangler_static_plugins

RzDemanglerPlugin* demangler_static_plugins[] = { RZ_DEMANGLER_STATIC_PLUGINS }

static

Definition at line 31 of file demangler.c.

Referenced by rz_demangler_new().

Macros

Functions

Variables