libheraia.h File Reference

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

#include "config.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 <glib/gi18n-lib.h>
#include <gmodule.h>
#include <gtkhex/gtkhex.h>
#include "data_interpretor.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  date_and_time_t
 A human struct to store a date with a time. More...
struct  decode_parameters_t
 Used to pass decoding options to the functions. More...
struct  decode_t
 Basic way to associate a decode function and an entry that will receive the result. More...
struct  decode_generic_t
 Basic way to have as many as we want decoding functions corresponding to one label. More...
struct  tab_t
 Tabulation structure to be used in the GtkNoteBook of data_interpretor's window. More...
struct  data_window_t
 Data interpretor window structure. More...
struct  xml_t
 Structure that contains all the xml definitions loaded at running time using GtkBuilder. 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  doc_t
 Proposal for a structure that will group all informations about a single document. More...
struct  selection_t
 A structure to manage a single selection. More...
struct  heraia_struct_t
 This is the main structure (mainly named main_struct 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.
#define HERAIA_REFRESH_TAB_CHANGED   3
 When user selects another tab in main notebook.
#define WPT_DEFAULT_HEIGHT   200
 Defines the default height for a window (set in window_prop_t).
#define WPT_DEFAULT_WIDTH   200
 Defines the default width for a window (set in window_prop_t).

Typedefs

typedef HexDocument Heraia_Document
typedef GtkHex Heraia_Hex
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 gchar *(* DecodeFunc )(guchar *, gpointer)
 Templates for the decoding functions.

Functions

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

Detailed Description

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

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

Definition in file libheraia.h.


Define Documentation

#define HERAIA_REFRESH_CURSOR_MOVE   2

When the cursor is moving.

Definition at line 95 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 94 of file libheraia.h.

Referenced by on_open_activate(), and refresh().

#define HERAIA_REFRESH_NOTHING   0

When nothing is refreshed.

Definition at line 93 of file libheraia.h.

Referenced by file_notebook_tab_changed(), and refresh_event_handler().

#define HERAIA_REFRESH_TAB_CHANGED   3

When user selects another tab in main notebook.

Definition at line 96 of file libheraia.h.

Referenced by file_notebook_tab_changed(), and refresh().

#define WPT_DEFAULT_HEIGHT   200

Defines the default height for a window (set in window_prop_t).

Definition at line 211 of file libheraia.h.

Referenced by init_window_property_struct(), and record_dialog_box_position().

#define WPT_DEFAULT_WIDTH   200

Defines the default width for a window (set in window_prop_t).

Definition at line 212 of file libheraia.h.

Referenced by init_window_property_struct(), and record_dialog_box_position().


Typedef Documentation

typedef gchar*(* DecodeFunc)(guchar *, gpointer)

Templates for the decoding functions.

Decode function template

Definition at line 117 of file libheraia.h.

typedef HexDocument Heraia_Document

Definition at line 69 of file libheraia.h.

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

Definition at line 71 of file libheraia.h.

HexDocument Heraia_DocumentHeraia_Hex Heraia_Hex

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

Definition at line 70 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 92 of file libheraia.h.


Function Documentation

void libheraia_finalize ( void   ) 

Definition at line 64 of file libheraia.c.

Referenced by main().

Here is the caller graph for this function:

void libheraia_initialize ( void   ) 

Python specific.

Definition at line 59 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 53 of file libheraia.c.

Referenced by main().

Here is the caller graph for this function:

Generated on Tue May 11 18:47:06 2010 for Heraia by  doxygen 1.6.3