heraia.c

Go to the documentation of this file.
00001 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
00002 /*
00003  *  heraia.c
00004  *  heraia - an hexadecimal file editor and analyser based on ghex
00005  *
00006  *  (C) Copyright 2005 - 2009 Olivier Delhomme
00007  *  e-mail : heraia@delhomme.org
00008  *  URL    : http://heraia.tuxfamily.org
00009  *
00010  *  This program is free software; you can redistribute it and/or modify
00011  *  it under the terms of the GNU General Public License as published by
00012  *  the Free Software Foundation; either version 2, or  (at your option)
00013  *  any later version.
00014  *
00015  *  This program is distributed in the hope that it will be useful,
00016  *  but WITHOUT ANY WARRANTY;  without even the implied warranty of
00017  *  MERCHANTABILITY  or  FITNESS FOR A PARTICULAR PURPOSE.  See the
00018  *  GNU General Public License for more details.
00019  *
00020  *  You should have received a copy of the GNU General Public License
00021  *  along with this program; if not, write to the Free Software
00022  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00023  */
00024 /** @file heraia.c
00025  * This is the main program file.
00026  * Initialization is done here and then hand is passed to gtk's main thread
00027  */
00028 /**
00029  * @author Olivier DELHOMME,
00030  *         Sébastien TRICAUD,
00031  *         Grégory AUDET
00032  * @version 0.0.7
00033  * @date 2005-2009
00034  */
00035 
00036 #include "heraia_types.h"
00037 
00038 static gboolean version(void);
00039 static gboolean usage(int status);
00040 static window_prop_t *init_window_properties(gint x, gint y, gboolean displayed);
00041 static heraia_window_t *init_window_property_struct(heraia_window_t *main_window);
00042 static heraia_window_t *heraia_init_main_struct(void);
00043 static HERAIA_ERROR init_heraia_plugin_system(heraia_window_t *main_window);
00044 static GList *init_heraia_location_list(void);
00045 static gboolean manage_command_line_options(Options *opt, int argc, char **argv);
00046 
00047 /** 
00048  *  libheraia_main_struct is a global variable that points 
00049  *  to the main structure and is intended for the library use ONLY ! 
00050  *  It should not be used anywhere else or for any other purpose
00051  */
00052 static heraia_window_t *libheraia_main_struct = NULL;  
00053 
00054 
00055 /**
00056  *  This is intended to be called by the library or any program that will use
00057  *  the library in order to get the pointer to the main structure heraia_window_t.
00058  *  @return heraia_window_t *, a pointer to the main structure
00059  */
00060 heraia_window_t *get_main_struct(void)
00061 {
00062         return libheraia_main_struct;
00063 }
00064 
00065 /** 
00066  *  prints program name, version, author, date and licence
00067  *  to the standard output
00068  */
00069 static gboolean version(void)
00070 {
00071         fprintf (stdout, "heraia, %s - %s - Version %s - License %s\n", HERAIA_AUTHORS, HERAIA_DATE, HERAIA_VERSION, HERAIA_LICENSE);
00072         return TRUE;
00073 }
00074 
00075 
00076 /** 
00077  *  Function that informs the user about the command line options
00078  *  available with heraia
00079  *  @param status : integer that indicate wether to display help (!=0) or
00080  *                      an error message (0)
00081  *  @return 
00082  *          - TRUE -> help message has been printed
00083  *          - FALSE -> error message has been printed
00084  */
00085 static gboolean usage(int status)
00086 {
00087         if (status == 0)
00088                 {
00089                         fprintf (stderr,
00090                                          "Try `heraia --help' for more information.\n");
00091                         return FALSE;
00092                 }
00093         else
00094                 {
00095                         version();
00096                         fprintf(stdout, "\nheraia is a simple hexadecimal file editor and file analyser");
00097                         fprintf(stdout, "\nUsage :\n  heraia [options] filename\n");
00098                         fprintf(stdout, "\nOptions :\n\
00099   -h, --help\tThis help.\n\
00100   -v, --version\tProgram version information.\n");
00101                         return TRUE;
00102                 }
00103 }
00104 
00105 
00106 /**
00107  *  Inits the properties of a window with defined values
00108  *  @param  x,y are x,y coordinates on the screen
00109  *  @param  displayed says wether the window is displayed or not
00110  *  @return a new allocated window_prop_t * structure.
00111  */
00112 static window_prop_t *init_window_properties(gint x, gint y, gboolean displayed)
00113 {
00114         window_prop_t *window_p;
00115 
00116         /* Malloc the window properties struct */
00117         window_p = (window_prop_t *) g_malloc0(sizeof(window_prop_t));
00118 
00119         /* Sets the default values */
00120         window_p->x = x;
00121         window_p->y = y;
00122         window_p->displayed = displayed;
00123 
00124         return window_p;
00125 }
00126 
00127 
00128 /**
00129  *  Inits the window property structure
00130  *  @param main_window : main structure
00131  *  @return main structure with an initiated window property structure
00132  */
00133 static heraia_window_t *init_window_property_struct(heraia_window_t *main_window)
00134 {
00135         all_window_prop_t *win_prop = NULL;
00136         window_prop_t *about_box = NULL;
00137         window_prop_t *data_interpretor = NULL;
00138         window_prop_t *log_box = NULL;
00139         window_prop_t *main_dialog = NULL;
00140         window_prop_t *plugin_list = NULL;
00141         window_prop_t *ldt = NULL;
00142         window_prop_t *main_pref_window = NULL;
00143 
00144         /* Global struct */
00145         win_prop = (all_window_prop_t *) g_malloc0(sizeof(all_window_prop_t));
00146 
00147         /* Initial states for the dialog boxes (default values) */
00148         about_box = init_window_properties(0, 0, FALSE);
00149         data_interpretor = init_window_properties(0, 0, H_DI_DISPLAYED);
00150         log_box = init_window_properties(0, 0, FALSE);
00151     main_dialog = init_window_properties(0, 0, TRUE);
00152         plugin_list = init_window_properties(0, 0, FALSE);
00153         ldt = init_window_properties(0, 0, FALSE);
00154         main_pref_window = init_window_properties(0, 0, FALSE);
00155 
00156         /* Attach to the struct */
00157         win_prop->about_box = about_box;
00158         win_prop->data_interpretor = data_interpretor;
00159         win_prop->log_box = log_box;
00160         win_prop->main_dialog = main_dialog;
00161         win_prop->plugin_list = plugin_list;
00162         win_prop->ldt = ldt;
00163         win_prop->main_pref_window = main_pref_window;
00164 
00165         /* attach it to the main struct so that it can be read everywhere */
00166         main_window->win_prop = win_prop;
00167 
00168         return main_window;
00169 }
00170 
00171 
00172 
00173 /**
00174  * Initialize the main structure (main_window)
00175  * @return a pointer to a newly initialized main structure 
00176  */
00177 static heraia_window_t *heraia_init_main_struct(void)
00178 {
00179         heraia_window_t *herwin = NULL;
00180         xml_t *xmls = NULL;
00181 
00182         herwin = (heraia_window_t *) g_malloc0(sizeof(heraia_window_t));
00183 
00184         if (!herwin)
00185                 {
00186                         fprintf(stderr, "Main structure could not be initialiazed !");
00187                         fprintf(stderr, "Do you have a memory problem ?\n");
00188                         return NULL;
00189                 }
00190 
00191         /* preference file name initialisation */
00192         herwin->prefs = (prefs_t *) g_malloc0(sizeof(prefs_t));
00193         herwin->prefs->file = g_key_file_new();
00194         herwin->prefs->pathname = g_strdup_printf("%s%c.%s", g_get_home_dir(), G_DIR_SEPARATOR, "heraia");
00195         herwin->prefs->filename = g_strdup_printf("%s%c%s", herwin->prefs->pathname, G_DIR_SEPARATOR, "main_preferences");
00196         verify_preference_file(herwin->prefs->pathname, herwin->prefs->filename);
00197         
00198         /**
00199          * First, in this early stage of the development we want to toggle debugging
00200          *  mode ON which is enabled by default in the configure.ac file !
00201          */
00202         herwin->debug = ENABLE_DEBUG;
00203         herwin->filename = NULL;
00204 
00205         herwin->current_doc = NULL;
00206         herwin->plugins_list = NULL;
00207         herwin->location_list = init_heraia_location_list(); /* location list initilization */
00208         herwin->data_type_list = NULL;
00209         herwin->current_data_type = NULL;
00210         herwin->available_treatment_list = init_treatments(); /* treatment list initialization */
00211 
00212         
00213         /* xml_t structure initialisation */
00214         xmls = (xml_t *) g_malloc0(sizeof(xml_t));
00215         xmls->main = NULL;
00216         herwin->xmls = xmls;
00217 
00218         /* data interpretor structure initialization */
00219         herwin->current_DW = (data_window_t *) g_malloc0 (sizeof(data_window_t));
00220         herwin->current_DW->current_hexwidget = NULL;
00221         herwin->current_DW->diw = NULL;
00222         /* herwin->current_DW->window_displayed = FALSE; */
00223         herwin->current_DW->tab_displayed = 0;  /* the first tab */
00224 
00225         /* init window property structure */
00226         herwin = init_window_property_struct(herwin);
00227 
00228         /* init global variable for the library */
00229         libheraia_main_struct = herwin;
00230 
00231         return herwin;
00232 }
00233 
00234 
00235 
00236 /**
00237  *  Function that initializes the plugin system if any :
00238  *   - loads any plugin where expected to be found
00239  *   - inits the plugin window
00240  * @param main_window : main structure (heraia_window_t *)
00241  * @return HERAIA_NO_PLUGINS if no plugins where found or HERAIA_NOERR in
00242  *         case of no errors
00243  */
00244 static HERAIA_ERROR init_heraia_plugin_system(heraia_window_t *main_window)
00245 {
00246 
00247         /* Checking for plugins */
00248         if (plugin_capable() == TRUE)
00249                 {
00250                         log_message(main_window, G_LOG_LEVEL_INFO, "Enabling plugins");
00251                         load_plugins(main_window);
00252 
00253                         /* the plugin_list_window (here the plugins may be loaded !) */
00254                         log_message(main_window, G_LOG_LEVEL_DEBUG, "Inits the plugin list window");
00255                         plugin_list_window_init_interface(main_window);
00256 
00257                         return HERAIA_NOERR;
00258                 }
00259         else
00260                 {
00261                         log_message(main_window, G_LOG_LEVEL_WARNING, "Plugins will be disabled");
00262                         return HERAIA_NO_PLUGINS;
00263                 }
00264 }
00265 
00266 /**
00267  *  Here we want to init the location list where we might look for
00268  *  in the future. These can be viewed as default paths
00269  *  @warning when adding new locations, keep in ming that the list is a 
00270              prepended list in reverse order.
00271  *  @return a new allocatde GList containing all locations
00272  */
00273 static GList *init_heraia_location_list(void)
00274 {
00275         gchar *path = NULL;
00276         const gchar* const *system_data_dirs;
00277         guint i = 0;
00278         GList *location_list = NULL;
00279 
00280         /* heraia's binary path */
00281         path = g_strdup_printf("%s", g_get_current_dir());
00282         location_list = g_list_prepend(location_list, path);
00283 
00284         /* System data dirs */
00285         system_data_dirs = g_get_system_data_dirs();
00286         i = 0;
00287         while(system_data_dirs[i] != NULL)
00288                 {
00289                         path = g_strdup_printf("%s%c%s", system_data_dirs[i], G_DIR_SEPARATOR, "heraia");
00290                         location_list = g_list_prepend(location_list, path);
00291                         i++;
00292                 }
00293 
00294         /* System config dirs */
00295         system_data_dirs = g_get_system_config_dirs();
00296         i = 0;
00297         while(system_data_dirs[i] != NULL)
00298                 {
00299                         path = g_strdup_printf("%s%c%s", system_data_dirs[i], G_DIR_SEPARATOR, "heraia");
00300                         location_list = g_list_prepend(location_list, path);
00301                         i++;
00302                 }
00303 
00304         /* the user path */
00305         path =  g_strdup_printf("%s%c.%s", g_get_home_dir(), G_DIR_SEPARATOR, "heraia");
00306         location_list = g_list_prepend(location_list, path);
00307 
00308         /* A global user data path */
00309         path = g_strdup_printf("%s%c%s", g_get_user_data_dir(), G_DIR_SEPARATOR, "heraia");
00310         location_list = g_list_prepend(location_list, path);
00311 
00312         /* A global config data path */
00313         path = g_strdup_printf("%s%c%s", g_get_user_config_dir(), G_DIR_SEPARATOR, "heraia");
00314         location_list = g_list_prepend(location_list, path);
00315 
00316         return location_list;
00317 }
00318 
00319 /**
00320  *  Manages all the command line options and populates the
00321  *  Options *opt structure accordingly
00322  *  @param opt (Options *opt) filled here with the parameters found in **argv
00323  *  @param argc : number of command line arguments
00324  *  @param argv : array of string (char *) that contains arguments
00325  *  @return gboolean that seems to always be TRUE
00326  */
00327 static gboolean manage_command_line_options(Options *opt, int argc, char **argv)
00328 {
00329         int exit_value = TRUE;
00330         int c = 0;
00331 
00332         while ((c = getopt_long (argc, argv, "vh", long_options, NULL)) != -1)
00333                 {
00334                         switch (c)
00335                                 {
00336                                 case 0:                 /* long options handler */
00337                                         break;
00338 
00339                                 case 'v':
00340                                         exit_value = version();
00341                                         opt->usage = TRUE;  /* We do not want to continue after */
00342                                         break;
00343 
00344                                 case 'h':
00345                                         exit_value = usage(1);
00346                                         opt->usage = TRUE;
00347                                         break;
00348 
00349                                 default:
00350                                         exit_value = usage(0);
00351                                         opt->usage = TRUE;
00352                                 }
00353                 }
00354 
00355         if (optind < argc) /** @todo manage a list of filenames instead of one filename */
00356                 {
00357                         opt->filename = (char *) malloc (sizeof(char) * strlen(argv[optind]) + 1);
00358                         strcpy(opt->filename, argv[optind]);
00359                 }
00360 
00361         return exit_value;
00362 }
00363 
00364 
00365 /**
00366  *  main program
00367  *  options :
00368  *   - --version
00369  *   - --help
00370  */
00371 int main (int argc, char ** argv)
00372 {
00373         Options *opt; /* A structure to manage the command line options  */
00374         gboolean exit_value = TRUE;
00375         heraia_window_t *main_window = NULL;
00376 
00377         opt = (Options *) g_malloc0(sizeof(Options));
00378 
00379         opt->filename = NULL;  /* At first we do not have any filename */
00380         opt->usage = FALSE;
00381 
00382         main_window = heraia_init_main_struct();
00383 
00384         libheraia_initialize();
00385 
00386         if (main_window->debug == TRUE)
00387                 {
00388                         fprintf(stdout, "Main struct initialized !\n");
00389                 }
00390 
00391         /* Command line options evaluation */
00392         exit_value = manage_command_line_options(opt, argc, argv);
00393 
00394         if (opt->usage != TRUE)
00395                 {
00396                         if (main_window->debug == TRUE)
00397                                 {
00398                                         fprintf(stderr, "Beginning things\n");
00399                                         libheraia_test(); /* testing libheraia */
00400                                 }
00401 
00402                         /* init of gtk and new window */
00403                         exit_value = gtk_init_check(&argc, &argv);
00404 
00405                         if (load_heraia_ui(main_window) == TRUE)
00406                                 {
00407 
00408                                         log_message(main_window, G_LOG_LEVEL_INFO, "Main interface loaded (%s)", main_window->xmls->main->filename);
00409                     log_message(main_window, G_LOG_LEVEL_DEBUG, "Preference file is %s", main_window->prefs->filename);
00410                                         
00411                                         init_heraia_plugin_system(main_window);
00412 
00413                                         if (opt->filename != NULL)
00414                                                 {
00415                                                         load_file_to_analyse(main_window, opt->filename);
00416                                                 }
00417 
00418 
00419                                         log_message(main_window, G_LOG_LEVEL_DEBUG, "Main_window : %p", main_window);
00420 
00421                                         init_heraia_interface(main_window);
00422 
00423                                         /* gtk main loop */
00424                                         gtk_main();
00425 
00426                                         exit_value = TRUE;
00427                                 }
00428                         else
00429                                 {
00430                                         fprintf(stderr, "File heraia.glade not found !\n");
00431                                 }
00432                 }
00433 
00434         libheraia_finalize();
00435 
00436         return !exit_value; /* Apparently gtk TRUE and FALSE are inverted compared to bash ! */
00437 }

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