Ewl_Macros: Useful Macros Used Internally and Available Externally

Detailed Description

Defines a variety of utility macros.


Defines
#define	FREE(dat)
#define	IF_FREE(dat)
#define	IF_FREE_HASH(hash)
#define	IF_FREE_LIST(list)
#define	IF_RELEASE(item)
#define	INT_TO_INTPTR(x) ((void *)((long int)(x)))
#define	INTPTR_TO_INT(x) ((int)((long int)(x)))
#define	MAX(x, y) (((x) > (y)) ? (x) : (y))
#define	MIN(x, y) (((x) > (y)) ? (y) : (x))
#define	NEW(type, num) calloc(num, sizeof(type))
#define	REALLOC(dat, type, num) dat = realloc(dat, sizeof(type) * (num))
#define	UINT_TO_UINTPTR(x) ((void *)((unsigned long int)(x)))
#define	UINTPTR_TO_UINT(x) ((unsigned int)((unsigned long int)(x)))
#define	ZERO(ptr, type, num) ptr = memset(ptr, 0, sizeof(type) * (num))

Define Documentation

#define FREE ( dat )

Value:

do { \
        free(dat); dat = NULL; \
} while (0)

Free the data pointed to by dat and it to NULL.

Referenced by ewl_attach_dnd_drag_set(), ewl_backtrace(), ewl_cell_new(), ewl_config_can_save_system(), ewl_config_destroy(), ewl_config_system_save(), ewl_config_user_save(), ewl_container_new(), ewl_datepicker_cb_value_changed(), ewl_embed_key_down_feed(), ewl_embed_key_up_feed(), ewl_engine_new(), ewl_filelist_model_data_unref(), ewl_filelist_model_directory_new(), ewl_filelist_selected_file_get(), ewl_filelist_selected_file_preview_get(), ewl_filelist_selected_file_set(), ewl_filelist_view_widget_fetch(), ewl_filepicker_directory_set(), ewl_filepicker_selected_file_get(), ewl_grid_cb_child_remove(), ewl_grid_dimensions_set(), ewl_histogram_new(), ewl_model_new(), ewl_print_help(), ewl_scrollpane_cb_destroy(), ewl_spinner_cb_focus_out(), ewl_text_cb_reveal(), ewl_text_context_format_string_create(), ewl_text_context_release(), ewl_text_fmt_clear(), ewl_text_fmt_destroy(), ewl_theme_image_get(), ewl_theme_shutdown(), ewl_view_clone(), ewl_view_new(), ewl_widget_free(), and ewl_widget_new().

#define IF_FREE ( dat )

Value:

do { \
        if (dat) FREE(dat); \
} while (0)

If dat is non-NULL, free dat and assign it to NULL.

Referenced by ewl_config_destroy(), ewl_dnd_accepted_types_set(), ewl_dnd_provided_types_set(), ewl_entry_cb_dnd_data(), ewl_filelist_cb_destroy(), ewl_filelist_directory_set(), ewl_filepicker_selected_file_get(), ewl_grid_cb_child_remove(), ewl_grid_cb_destroy(), ewl_grid_child_position_set(), ewl_grid_dimensions_set(), ewl_icon_cb_destroy(), ewl_icon_label_set(), ewl_image_cb_destroy(), ewl_image_file_key_set(), ewl_image_file_set(), ewl_media_media_set(), ewl_paned_cb_destroy(), ewl_scrollpane_kinetic_scrolling_set(), ewl_text_cb_destroy(), ewl_text_obscure_set(), ewl_text_text_delete(), ewl_theme_theme_set(), ewl_widget_appearance_part_text_set(), ewl_widget_cb_realize(), ewl_window_cb_destroy(), ewl_window_class_set(), ewl_window_name_set(), and ewl_window_title_set().

#define IF_FREE_HASH ( hash )

Value:

do { \
        if (hash) { \
                ecore_hash_destroy(hash); \
                hash = NULL; \
        } \
} while (0)

If hash is non-NULL, free hash and set it NULL.

Referenced by ewl_callbacks_shutdown(), ewl_config_destroy(), ewl_config_instance_keys_remove(), ewl_config_system_keys_remove(), ewl_config_system_save(), ewl_config_user_keys_remove(), ewl_dnd_init(), ewl_dnd_shutdown(), ewl_embed_cache_cleanup(), ewl_engines_shutdown(), ewl_icon_theme_shutdown(), ewl_icon_theme_theme_change(), ewl_io_manager_shutdown(), ewl_text_context_shutdown(), ewl_theme_data_reset(), ewl_theme_shutdown(), ewl_theme_theme_set(), ewl_theme_widget_shutdown(), ewl_tree_cb_destroy(), ewl_widget_data_del(), and ewl_widget_free().

#define IF_FREE_LIST ( list )

Value:

do { \
        if (list) { \
                ecore_list_destroy(list); \
                list = NULL; \
        } \
} while (0)

If list is non-NULL, free list and set it NULL.

Referenced by ewl_config_system_save(), ewl_embed_cache_cleanup(), ewl_engine_names_get(), ewl_filelist_model_directory_new(), ewl_mvc_cb_destroy(), ewl_mvc_selection_mode_set(), ewl_print_help(), ewl_radiobutton_cb_destroy(), ewl_shutdown(), ewl_statusbar_cb_destroy(), ewl_text_cb_destroy(), ewl_text_trigger_cb_destroy(), ewl_theme_shutdown(), ewl_tree_node_collapse(), and ewl_tree_node_expand().

#define IF_RELEASE ( item )

Value:

do { \
        if (item) { \
                ecore_string_release(item); \
                item = NULL; \
        } \
} while (0)

If item is non-NULL, ecore_string_release item and set it NULL.

Referenced by ewl_embed_engine_name_set(), ewl_text_cb_destroy(), ewl_text_context_find(), ewl_text_context_release(), ewl_text_maximum_size_string_set(), ewl_text_minimum_size_string_set(), ewl_widget_cb_realize(), ewl_widget_cb_unrealize(), and ewl_widget_free().

#define INT_TO_INTPTR ( x ) ((void *)((long int)(x)))

Does a cast from the type int to an pointer

#define INTPTR_TO_INT ( x ) ((int)((long int)(x)))

Does a cast from a pointer to the type int, if debug is enabled at compile-time it will add a runtime check if any information get lost.

Referenced by ewl_tree_cb_column_sort().

#define MAX	(	x,
		y		)	(((x) > (y)) ? (x) : (y))

Select the maximum of two values

Referenced by ewl_row_cb_configure(), and ewl_spinner_cb_realize().

#define MIN	(	x,
		y		)	(((x) > (y)) ? (y) : (x))

Select the minimum of two values

Referenced by ewl_grid_dimensions_set(), and ewl_text_length_maximum_set().

#define NEW	(	type,
		num		)	calloc(num, sizeof(type))

Allocates memory of num elements of sizeof(type).

Referenced by ewl_attach_dnd_drag_set(), ewl_border_new(), ewl_box_new(), ewl_button_new(), ewl_calendar_new(), ewl_cell_new(), ewl_check_new(), ewl_checkbutton_new(), ewl_colordialog_new(), ewl_colorpicker_new(), ewl_combo_cell_new(), ewl_combo_new(), ewl_config_new(), ewl_configure_request(), ewl_container_new(), ewl_context_menu_new(), ewl_cursor_new(), ewl_datepicker_new(), ewl_dialog_new(), ewl_embed_new(), ewl_entry_cursor_new(), ewl_entry_new(), ewl_expansion_new(), ewl_filedialog_new(), ewl_filelist_model_directory_new(), ewl_filelist_new(), ewl_filepicker_filter_add(), ewl_filepicker_new(), ewl_filepicker_selected_file_get(), ewl_floater_new(), ewl_freebox_mvc_new(), ewl_freebox_new(), ewl_grid_child_position_set(), ewl_grid_dimensions_set(), ewl_grid_new(), ewl_histogram_new(), ewl_icon_new(), ewl_icondialog_new(), ewl_image_new(), ewl_image_thumbnail_new(), ewl_label_new(), ewl_list_new(), ewl_media_new(), ewl_menu_item_new(), ewl_menu_new(), ewl_menubar_new(), ewl_message_new(), ewl_model_new(), ewl_mvc_selected_get(), ewl_mvc_selection_index_new(), ewl_mvc_selection_range_new(), ewl_notebook_new(), ewl_overlay_new(), ewl_paned_grabber_new(), ewl_paned_new(), ewl_popup_new(), ewl_progressbar_init(), ewl_progressbar_new(), ewl_radiobutton_new(), ewl_row_new(), ewl_scrollbar_new(), ewl_scrollpane_kinetic_scrolling_set(), ewl_scrollpane_new(), ewl_seeker_new(), ewl_separator_new(), ewl_shadow_new(), ewl_spacer_new(), ewl_spectrum_new(), ewl_spinner_new(), ewl_statusbar_new(), ewl_table_new(), ewl_text_cb_reveal(), ewl_text_context_format_string_create(), ewl_text_context_new(), ewl_text_fmt_new(), ewl_text_fmt_node_new(), ewl_text_new(), ewl_text_obscure_set(), ewl_text_trigger_new(), ewl_toolbar_new(), ewl_tree_new(), ewl_tree_node_new(), ewl_tree_view_plain_new(), ewl_tree_view_scrolled_new(), ewl_view_clone(), ewl_view_new(), ewl_widget_appearance_part_text_set(), ewl_widget_appearance_path_get(), ewl_widget_color_set(), ewl_widget_new(), and ewl_window_new().

#define REALLOC	(	dat,
		type,
		num	)	dat = realloc(dat, sizeof(type) * (num))

Reallocates memory pointed to by dat to num elements of sizeof(type).

Referenced by ewl_attach_list_del(), ewl_paned_size_info_add(), ewl_paned_size_info_del(), and ewl_widget_appearance_part_text_set().

#define UINT_TO_UINTPTR ( x ) ((void *)((unsigned long int)(x)))

Does a cast from the type int to an pointer

#define UINTPTR_TO_UINT ( x ) ((unsigned int)((unsigned long int)(x)))

Does a cast from a pointer to the type unsigned int, if debug is enabled at compile-time it will add a runtime check if any information get lost.

#define ZERO	(	ptr,
		type,
		num	)	ptr = memset(ptr, 0, sizeof(type) * (num))

Set the first num elements of sizeof(type) pointed to by ptr to zero.