ghex_heraia_interface.h File Reference


Detailed Description

Header file providing an interface to GtkHex.

Definition in file ghex_heraia_interface.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

gboolean ghex_memcpy (GtkHex *gh, guint pos, guint len, guint endianness, guchar *result)
 Returns 'len' number of bytes located at 'pos' in the GtkHex document and puts it in the result variable.
gboolean ghex_get_data (data_window_t *data_window, guint length, guint endianness, guchar *c)
 Gets the data from the hexwidget, a wrapper to the ghex_memcpy function.
HERAIA_ERROR heraia_hex_document_new (heraia_window_t *main_window, char *filename)
 Removes the old document if it exists and adds a new one from the filename 'filename'.
HERAIA_ERROR heraia_hex_document_save (heraia_window_t *main_window)
 Saves an open and edited document.
HERAIA_ERROR heraia_hex_document_save_as (heraia_window_t *main_window, gchar *filename)
 Saves an opened and edited document to a new file.
gchar * heraia_hex_document_get_filename (Heraia_Document *doc)
 Retrieves the filename of a document which ever it is !
guint64 ghex_file_size (GtkHex *gh)
 Returns the file size of an opened GtkHex document.
guint64 ghex_get_cursor_position (data_window_t *data_window)
 Retrieves the cursor's position from the current hexwidget.


Function Documentation

guint64 ghex_file_size ( GtkHex *  gh  ) 

Returns the file size of an opened GtkHex document.

Parameters:
gh : an opened GtkHex document
Returns:
resturns the file size of that document

Definition at line 279 of file ghex_heraia_interface.c.

Referenced by ghex_memcpy(), populate_stats_histos(), and set_spinbutton_max_range().

Here is the caller graph for this function:

guint64 ghex_get_cursor_position ( data_window_t data_window  ) 

Retrieves the cursor's position from the current hexwidget.

Parameters:
data_window : data interpretor window structure
Returns:
returns the cursor's position

Definition at line 297 of file ghex_heraia_interface.c.

References data_window_t::current_hexwidget.

Referenced by refresh_file_labels().

Here is the caller graph for this function:

gboolean ghex_get_data ( data_window_t data_window,
guint  length,
guint  endianness,
guchar *  c 
)

Gets the data from the hexwidget, a wrapper to the ghex_memcpy function.

Warning:
guchar *c MUST have been pre allocated BEFORE the call.
Parameters:
data_window : data interpretor window structure
length : can be anything but MUST be strictly less than the size allocated to *c
endianness : H_DI_BIG_ENDIAN, H_DI_MIDDLE_ENDIAN or H_DI_LITTLE_ENDIAN
c : a previously g_malloc'ed gchar * string that will contain copied bytes.

Definition at line 253 of file ghex_heraia_interface.c.

References data_window_t::current_hexwidget, and ghex_memcpy().

Referenced by interpret_as_date(), interpret_as_number(), refresh_all_ud_data_interpretor(), and refresh_hex_datas_entry().

Here is the call graph for this function:

Here is the caller graph for this function:

gboolean ghex_memcpy ( GtkHex *  gh,
guint  pos,
guint  len,
guint  endianness,
guchar *  result 
)

Returns 'len' number of bytes located at 'pos' in the GtkHex document and puts it in the result variable.

Warning:
We assume that a previous g_malloc has been done in order to use the function. Here we need the "swap_bytes" function defined in the decode.h header in order to take the endianness into account
Parameters:
gh : A GtkHex document.
pos : position where we want to begin to copy bytes
len : number of bytes we want to copy
endianness : endianness we want to apply to the bytes we want to copy
[out] result : a previously g_malloc'ed gchar * string that will contain copied bytes.
Returns:
TRUE if everything went ok, FALSE otherwise

Definition at line 211 of file ghex_heraia_interface.c.

References change_endianness(), and ghex_file_size().

Referenced by ghex_get_data().

Here is the call graph for this function:

Here is the caller graph for this function:

gchar* heraia_hex_document_get_filename ( Heraia_Document doc  ) 

Retrieves the filename of a document which ever it is !

Parameters:
doc : an existing Heraia_Document
Todo:
: do something if the document does not exist.
Returns:
returns the filename of that document.

Definition at line 66 of file ghex_heraia_interface.c.

Referenced by on_save_activate().

Here is the caller graph for this function:

HERAIA_ERROR heraia_hex_document_new ( heraia_window_t main_window,
char *  filename 
)

Removes the old document if it exists and adds a new one from the filename 'filename'.

Parameters:
main_window : main structure
filename : a char * representing an existing file named "filename"
Returns:
Always returns HERAIA_NOERR;
Todo:
: do something to take errors into account

Definition at line 38 of file ghex_heraia_interface.c.

References connect_cursor_moved_signal(), heraia_window_t::current_doc, heraia_window_t::current_DW, data_window_t::current_hexwidget, and HERAIA_NOERR.

Referenced by load_file_to_analyse().

Here is the call graph for this function:

Here is the caller graph for this function:

HERAIA_ERROR heraia_hex_document_save ( heraia_window_t main_window  ) 

Saves an open and edited document.

Parameters:
main_window : main structure,
Todo:
may be we only need main_window->current_doc here
Returns:
returns HERAIA_NOERR if everything went ok or HERAIA_FILE_ERROR in case of an error

Definition at line 78 of file ghex_heraia_interface.c.

References heraia_window_t::current_doc, HERAIA_FILE_ERROR, and HERAIA_NOERR.

Referenced by on_save_activate().

Here is the caller graph for this function:

HERAIA_ERROR heraia_hex_document_save_as ( heraia_window_t main_window,
gchar *  filename 
)

Saves an opened and edited document to a new file.

Parameters:
main_window : main structure
filename : the new filename where to save the file
Returns:
returns HERAIA_NOERR if everything went ok or HERAIA_FILE_ERROR in case of an error

< to make libghex happy !

Definition at line 104 of file ghex_heraia_interface.c.

References heraia_window_t::current_doc, heraia_window_t::filename, HERAIA_FILE_ERROR, and HERAIA_NOERR.

Referenced by on_save_as_activate().

Here is the caller graph for this function:


Generated on Sat Feb 14 11:44:18 2009 for Heraia by  doxygen 1.5.6