libheraia.h File Reference


Detailed Description

This file contains all the definitions and includes all other .h file.

This is not very friendly, but ease compilation on exotic systems.

Definition in file libheraia.h.

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <getopt.h>
#include <glib.h>
#include <glib/gstdio.h>
#include <glade/glade.h>
#include <gmodule.h>
#include <gtkhex/gtkhex.h>
#include "config.h"
#include "data_interpretor.h"
#include "data_type.h"
#include "decode.h"
#include "ghex_heraia_interface.h"
#include "heraia_errors.h"
#include "heraia_io.h"
#include "heraia_ui.h"
#include "list_data_types.h"
#include "log.h"
#include "main_pref_window.h"
#include "plugin.h"
#include "plugin_list.h"
#include "treatments.h"
#include "user_prefs.h"

Include dependency graph for libheraia.h:

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

Go to the source code of this file.

Data Structures

struct  data_window_t
 Data interpretor window structure. More...
struct  treatment_t
 Treatment structure. More...
struct  treatment_container_t
 Structure in order to contain one treatment. More...
struct  data_type_t
 Data type structure entry that contains user defined data types This is integrated within a GList. More...
struct  xml_t
 Structure that contains all the xml definitions loaded at running time using libglade. More...
struct  window_prop_t
 Window properties
  • position (x,y) record window's position
  • displayed (boolean) say whether the window is displayed or not.
More...
struct  all_window_prop_t
 Structure to keep window properties for each window. More...
struct  prefs_t
 Data type related to preferences. More...
struct  heraia_window_t
 This is the main structure (mainly named main_window due to historycal reasons) It contains all things that the program needs. More...

Defines

#define HERAIA_REFRESH_NOTHING   0
 When nothing is refreshed.
#define HERAIA_REFRESH_NEW_FILE   1
 When a new file has been loaded.
#define HERAIA_REFRESH_CURSOR_MOVE   2
 When the cursor is moving.

Typedefs

typedef HexDocument Heraia_Document
typedef GtkHex Heraia_Hex
 Abstract layer this may be usefull if we decide to leave GtkHex and use something else !
typedef gint HERAIA_ERROR
 Defines heraia error type (this should be used !).
typedef gint RefreshType
 Refresh type (may be used to decide what to do in a particular case).
typedef GList *(* TreatmentDoFunc )(GList *)
 Treatment function called while operating the treatment.
typedef void(* TreatmentInitFunc )(gpointer)
 Treatment init function.
typedef void(* TreatmentDelFunc )(gpointer)
 Treatment delete function.
typedef gpointer(* TreatmentCopyFunc )(gpointer)
 Treatment copy function that have to copy internal structures (widgets and all stuff in it).

Functions

int libheraia_test (void)
 A simple test function.
void libheraia_initialize (void)
 Python specific.
void libheraia_finalize (void)


Define Documentation

#define HERAIA_REFRESH_CURSOR_MOVE   2

When the cursor is moving.

Definition at line 85 of file libheraia.h.

Referenced by refresh_event_handler().

#define HERAIA_REFRESH_NEW_FILE   1

When a new file has been loaded.

Definition at line 84 of file libheraia.h.

Referenced by on_open_activate(), and refresh().

#define HERAIA_REFRESH_NOTHING   0

When nothing is refreshed.

Definition at line 83 of file libheraia.h.

Referenced by refresh_event_handler().


Typedef Documentation

typedef HexDocument Heraia_Document

Definition at line 62 of file libheraia.h.

Defines heraia error type (this should be used !).

Definition at line 64 of file libheraia.h.

HexDocument Heraia_DocumentGtkHex Heraia_Hex

Abstract layer this may be usefull if we decide to leave GtkHex and use something else !

Abstract layer this may be usefull if we decide to leave GtkHex and use something else !

Definition at line 63 of file libheraia.h.

Refresh type (may be used to decide what to do in a particular case).

Warning:
This is not thread safe !!

Definition at line 82 of file libheraia.h.

typedef gpointer(* TreatmentCopyFunc)(gpointer)

Treatment copy function that have to copy internal structures (widgets and all stuff in it).

Definition at line 106 of file libheraia.h.

typedef void(* TreatmentDelFunc)(gpointer)

Treatment delete function.

Definition at line 105 of file libheraia.h.

typedef GList*(* TreatmentDoFunc)(GList *)

Treatment function called while operating the treatment.

Definition at line 103 of file libheraia.h.

typedef void(* TreatmentInitFunc)(gpointer)

Treatment init function.

Definition at line 104 of file libheraia.h.


Function Documentation

void libheraia_finalize ( void   ) 

Definition at line 65 of file libheraia.c.

Referenced by main().

Here is the caller graph for this function:

void libheraia_initialize ( void   ) 

Python specific.

Definition at line 60 of file libheraia.c.

Referenced by main().

Here is the caller graph for this function:

int libheraia_test ( void   ) 

A simple test function.

Returns:
Always returns 0

Definition at line 54 of file libheraia.c.

Referenced by main().

Here is the caller graph for this function:


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