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 - 2010 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  *         Aurélie DERAISME.
00033  * @version 0.1.5
00034  * @date 2005-2010
00035  */
00036 
00037 
00038 #include "heraia_types.h"
00039 
00040 
00041 static gboolean version(void);
00042 static gboolean usage(int status);
00043 static window_prop_t *init_window_properties(gint x, gint y, guint height, guint width, gboolean displayed);
00044 static heraia_struct_t *init_window_property_struct(heraia_struct_t *main_struct);
00045 static heraia_struct_t *heraia_init_main_struct(gchar *heraia_path);
00046 static HERAIA_ERROR init_heraia_plugin_system(heraia_struct_t *main_struct);
00047 static GList *init_heraia_location_list(gchar *heraia_path);
00048 static gboolean manage_command_line_options(Options *opt, int argc, char **argv);
00049 
00050 /**
00051  *  libheraia_main_struct is a global variable that points
00052  *  to the main structure and is intended for the library use ONLY !
00053  *  It should not be used anywhere else or for any other purpose
00054  */
00055 static heraia_struct_t *libheraia_main_struct = NULL;
00056 
00057 
00058 /**
00059  *  This is intended to be called by the library or any program that will use
00060  *  the library in order to get the pointer to the main structure heraia_struct_t.
00061  *  @return heraia_struct_t *, a pointer to the main structure
00062  */
00063 heraia_struct_t *get_main_struct(void)
00064 {
00065     return libheraia_main_struct;
00066 }
00067 
00068 
00069 /**
00070  *  prints program name, version, author, date and licence
00071  *  to the standard output
00072  */
00073 static gboolean version(void)
00074 {
00075     fprintf (stdout, Q_("heraia written by %s\n   %s - Version %s\n   License %s\n"), HERAIA_AUTHORS, HERAIA_DATE, HERAIA_VERSION, HERAIA_LICENSE);
00076     return TRUE;
00077 }
00078 
00079 
00080 /**
00081  *  Function that informs the user about the command line options
00082  *  available with heraia
00083  *  @param status : integer that indicate wether to display help (!=0) or
00084  *                  an error message (0)
00085  *  @return
00086  *          - TRUE -> help message has been printed
00087  *          - FALSE -> error message has been printed
00088  */
00089 static gboolean usage(int status)
00090 {
00091     if (status == 0)
00092         {
00093             fprintf (stderr, Q_("Try `heraia --help' for more information.\n"));
00094 
00095             return FALSE;
00096         }
00097     else
00098         {
00099             version();
00100             fprintf(stdout, Q_("\nheraia is a simple hexadecimal file editor and file analyser"));
00101             fprintf(stdout, Q_("\nUsage :\n  heraia [options] filename(s)\n"));
00102             fprintf(stdout, Q_("\nOptions :\n"));
00103             fprintf(stdout, Q_("  -h, --help\tThis help.\n"));
00104             fprintf(stdout, Q_("  -v, --version\tProgram version information.\n"));
00105             fprintf(stdout, Q_("  -t, --tests=TESTS\tRuns some tests.\n"));
00106             fprintf(stdout, Q_("     TESTS might be :\n"));
00107             fprintf(stdout, Q_("     %d for coverage tests\n"), COVERAGE_TESTS);
00108             fprintf(stdout, Q_("     %d for loading files tests\n"), LOADING_TESTS);
00109 
00110             return TRUE;
00111         }
00112 }
00113 
00114 
00115 /**
00116  *  Inits the properties of a window with defined values
00117  *  @param  x,y are x,y coordinates on the screen
00118  *  @param  height represents the height of the window
00119  *  @param  width represents the width of the window. x+height,y+width is
00120  *          window's right bottom corner
00121  *  @param  displayed says wether the window is displayed or not
00122  *  @return a new allocated window_prop_t * structure.
00123  */
00124 static window_prop_t *init_window_properties(gint x, gint y, guint height, guint width, gboolean displayed)
00125 {
00126     window_prop_t *window_p;
00127 
00128     /* Malloc the window properties struct */
00129     window_p = (window_prop_t *) g_malloc0(sizeof(window_prop_t));
00130 
00131     /* Sets the default values */
00132     window_p->x = x;
00133     window_p->y = y;
00134     window_p->height = height;
00135     window_p->width = width;
00136     window_p->displayed = displayed;
00137 
00138     return window_p;
00139 }
00140 
00141 
00142 /**
00143  *  Inits the window property structure
00144  *  @param main_struct : main structure
00145  *  @return main structure with an initiated window property structure
00146  */
00147 static heraia_struct_t *init_window_property_struct(heraia_struct_t *main_struct)
00148 {
00149     all_window_prop_t *win_prop = NULL;
00150     window_prop_t *about_box = NULL;
00151     window_prop_t *data_interpretor = NULL;
00152     window_prop_t *log_box = NULL;
00153     window_prop_t *main_dialog = NULL;
00154     window_prop_t *plugin_list = NULL;
00155     window_prop_t *ldt = NULL;
00156     window_prop_t *main_pref_window = NULL;
00157 
00158     /* Global struct */
00159     win_prop = (all_window_prop_t *) g_malloc0(sizeof(all_window_prop_t));
00160 
00161     /* Initial states for the dialog boxes (default values) */
00162     about_box = init_window_properties(0, 0, WPT_DEFAULT_HEIGHT, WPT_DEFAULT_WIDTH, FALSE);
00163     data_interpretor = init_window_properties(0, 0, WPT_DEFAULT_HEIGHT, WPT_DEFAULT_WIDTH, H_DI_DISPLAYED);
00164     log_box = init_window_properties(0, 0, WPT_DEFAULT_HEIGHT, WPT_DEFAULT_WIDTH, FALSE);
00165     main_dialog = init_window_properties(0, 0, WPT_DEFAULT_HEIGHT, WPT_DEFAULT_WIDTH, TRUE);
00166     plugin_list = init_window_properties(0, 0, WPT_DEFAULT_HEIGHT, WPT_DEFAULT_WIDTH, FALSE);
00167     ldt = init_window_properties(0, 0, WPT_DEFAULT_HEIGHT, WPT_DEFAULT_WIDTH, FALSE);
00168     main_pref_window = init_window_properties(0, 0, WPT_DEFAULT_HEIGHT, WPT_DEFAULT_WIDTH, FALSE);
00169 
00170     /* Attach to the struct */
00171     win_prop->about_box = about_box;
00172     win_prop->data_interpretor = data_interpretor;
00173     win_prop->log_box = log_box;
00174     win_prop->main_dialog = main_dialog;
00175     win_prop->plugin_list = plugin_list;
00176     win_prop->ldt = ldt;
00177     win_prop->main_pref_window = main_pref_window;
00178 
00179     /* attach it to the main struct so that it can be read everywhere */
00180     main_struct->win_prop = win_prop;
00181 
00182     return main_struct;
00183 }
00184 
00185 
00186 /**
00187  * Initialize the main structure (main_struct)
00188  * @param heraia_path is the path used to invoke heraia : '/usr/bin/heraia'
00189  *        invocation would lead to '/usr/bin'
00190  * @return a pointer to a newly initialized main structure
00191  */
00192 static heraia_struct_t *heraia_init_main_struct(gchar *heraia_path)
00193 {
00194     heraia_struct_t *main_struct = NULL;
00195     xml_t *xmls = NULL;
00196 
00197     main_struct = (heraia_struct_t *) g_malloc0(sizeof(heraia_struct_t));
00198 
00199     if (main_struct == NULL)
00200         {
00201             fprintf(stderr, Q_("Main structure could not be initialiazed !"));
00202             fprintf(stderr, Q_("Do you have a memory problem ?\n"));
00203             return NULL;
00204         }
00205 
00206     /* preference file name initialisation */
00207     main_struct->prefs = NULL;
00208     init_preference_struct(main_struct);
00209     verify_preference_file(main_struct->prefs->pathname, main_struct->prefs->filename);
00210 
00211     /**
00212      * First, in this early stage of the development we want to toggle debugging
00213      *  mode ON which is enabled by default in the configure.ac file !
00214      */
00215     main_struct->debug = ENABLE_DEBUG;
00216 
00217     main_struct->current_doc = NULL;
00218     main_struct->plugins_list = NULL;
00219     main_struct->location_list = init_heraia_location_list(heraia_path); /* location list initilization */
00220 
00221     /* xml_t structure initialisation */
00222     xmls = (xml_t *) g_malloc0(sizeof(xml_t));
00223     xmls->main = NULL;
00224     main_struct->xmls = xmls;
00225 
00226     /* data interpretor structure initialization */
00227     main_struct->current_DW = (data_window_t *) g_malloc0 (sizeof(data_window_t));
00228     main_struct->current_DW->diw = NULL;
00229     main_struct->current_DW->tab_displayed = 0;  /* the first tab */
00230 
00231     /* init window property structure */
00232     main_struct = init_window_property_struct(main_struct);
00233 
00234     /* documents */
00235     main_struct->documents = g_ptr_array_new();
00236 
00237     /* init global variable for the library */
00238     libheraia_main_struct = main_struct;
00239 
00240     return main_struct;
00241 }
00242 
00243 
00244 /**
00245  *  Function that initializes the plugin system if any :
00246  *   - loads any plugin where expected to be found
00247  *   - inits the plugin window
00248  * @param main_struct : main structure (heraia_struct_t *)
00249  * @return HERAIA_NO_PLUGINS if no plugins where found or HERAIA_NOERR in
00250  *         case of no errors
00251  */
00252 static HERAIA_ERROR init_heraia_plugin_system(heraia_struct_t *main_struct)
00253 {
00254 
00255     /* Checking for plugins */
00256     if (plugin_capable() == TRUE)
00257         {
00258             log_message(main_struct, G_LOG_LEVEL_INFO, Q_("Enabling plugins"));
00259             load_plugins(main_struct);
00260 
00261             /* the plugin_list_window (here the plugins may be loaded !) */
00262             log_message(main_struct, G_LOG_LEVEL_DEBUG, Q_("Inits the plugin list window"));
00263             plugin_list_window_init_interface(main_struct);
00264 
00265             return HERAIA_NOERR;
00266         }
00267     else
00268         {
00269             log_message(main_struct, G_LOG_LEVEL_WARNING, Q_("Plugins will be disabled"));
00270             return HERAIA_NO_PLUGINS;
00271         }
00272 }
00273 
00274 
00275 /**
00276  *  Here we want to init the location list where we might look for
00277  *  in the future. These can be viewed as default paths
00278  *  @warning when adding new locations, keep in ming that the list is a
00279              prepended list in reverse order.
00280  *  @return a new allocatde GList containing all locations
00281  */
00282 static GList *init_heraia_location_list(gchar *heraia_path)
00283 {
00284     gchar *path = NULL;
00285     const gchar* const *system_dirs;
00286     guint i = 0;
00287     GList *location_list = NULL;
00288 
00289     /* Heraia's binary path */
00290     path = g_get_current_dir();
00291     location_list = g_list_prepend(location_list, path);
00292 
00293     /* System data dirs */
00294     system_dirs = g_get_system_data_dirs();
00295     i = 0;
00296     while(system_dirs[i] != NULL)
00297         {
00298             path = g_build_path(G_DIR_SEPARATOR_S, system_dirs[i], "heraia", NULL);
00299             location_list = g_list_prepend(location_list, path);
00300             i++;
00301         }
00302 
00303     /* System config dirs */
00304     system_dirs = g_get_system_config_dirs();
00305     i = 0;
00306     while(system_dirs[i] != NULL)
00307         {
00308             path = g_build_path(G_DIR_SEPARATOR_S, system_dirs[i], "heraia", NULL);
00309             location_list = g_list_prepend(location_list, path);
00310             i++;
00311         }
00312 
00313     /* The user path */
00314     path =  g_build_path(G_DIR_SEPARATOR_S, g_get_home_dir(), "heraia", NULL);
00315     location_list = g_list_prepend(location_list, path);
00316 
00317     /* A global user data path */
00318     path = g_build_path(G_DIR_SEPARATOR_S, g_get_user_data_dir(), "heraia", NULL);
00319     location_list = g_list_prepend(location_list, path);
00320 
00321     /* A global config data path */
00322     path = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), "heraia", NULL);
00323     location_list = g_list_prepend(location_list, path);
00324 
00325     /* An absolute path (from where is executed heraia itself) */
00326     path = g_build_path(G_DIR_SEPARATOR_S, heraia_path, "..", "share", "heraia", NULL);
00327     location_list = g_list_prepend(location_list, path);
00328 
00329     return location_list;
00330 }
00331 
00332 
00333 /**
00334  *  Inits internationalisation (don't know wether it works or not!)
00335  */
00336 static void init_international_languages(void)
00337 {
00338     gchar *result = NULL;
00339 
00340     setlocale(LC_ALL, "");
00341     result = bindtextdomain(GETTEXT_PACKAGE, LOCALEDIR);
00342 
00343     if (ENABLE_DEBUG == TRUE)
00344         {
00345             fprintf(stdout, Q_("Gettext package : %s\n"), GETTEXT_PACKAGE);
00346             fprintf(stdout, Q_("Locale dir : %s\n"), LOCALEDIR);
00347             fprintf(stdout, Q_("Bindtextdomain : %s\n"), result);
00348         }
00349     bind_textdomain_codeset(GETTEXT_PACKAGE, "UTF-8");
00350     textdomain(GETTEXT_PACKAGE);
00351 }
00352 
00353 
00354 /**
00355  * Does some self tests for code coverage in heraia
00356  *
00357  * This function does some calls to functions that are not called
00358  * on a normal test procedure
00359  *
00360  * @param main_struct : main structure (heraia_struct_t *)
00361  * @return gboolean as an exit value for the program
00362  */
00363 static gboolean do_heraia_coverage_tests(heraia_struct_t *main_struct)
00364 {
00365     heraia_struct_t *tmp_struct;
00366     gboolean exit_value = FALSE;
00367 
00368     exit_value = version();
00369     exit_value = usage(0);
00370     exit_value = usage(1);
00371 
00372     tmp_struct = get_main_struct();
00373     if (tmp_struct != main_struct)
00374         {
00375             fprintf(stderr, Q_("WARNING : tmp_struct is not equal to main_struct!\n"));
00376         }
00377 
00378     exit_value = test_decode_functions();
00379     if (exit_value != TRUE)
00380         {
00381             fprintf(stderr, Q_("WARNING : Error while testing decode functions\n"));
00382         }
00383 
00384     return TRUE;
00385 }
00386 
00387 
00388 /**
00389  * Does some loading tests in heraia
00390  * @param main_struct : main structure (heraia_struct_t *)
00391  * @return gboolean as an exit value for the program
00392  */
00393 static gboolean do_heraia_loading_tests(heraia_struct_t *main_struct)
00394 {
00395     return TRUE;
00396 }
00397 
00398 
00399 /**
00400  *  Manages all the command line options and populates the
00401  *  Options *opt structure accordingly
00402  *  @param opt (Options *opt) filled here with the parameters found in **argv
00403  *  @param argc : number of command line arguments
00404  *  @param argv : array of string (char *) that contains arguments
00405  *  @return gboolean that seems to always be TRUE
00406  */
00407 static gboolean manage_command_line_options(Options *opt, int argc, char **argv)
00408 {
00409     int exit_value = TRUE;
00410     int c = 0;
00411     gchar *filename = NULL;
00412     int tests = 0;
00413 
00414     while ((c = getopt_long(argc, argv, "vht", long_options, NULL)) != -1)
00415         {
00416             switch (c)
00417                 {
00418                     case 0:         /* long options handler */
00419                         break;
00420 
00421                     case 'v':
00422                         exit_value = version();
00423                         opt->usage = TRUE;  /* We do not want to continue after */
00424                         break;
00425 
00426                     case 'h':
00427                         exit_value = usage(1);
00428                         opt->usage = TRUE;
00429                         break;
00430 
00431                     case 't':
00432                         if (optarg)
00433                             {
00434                                 if (sscanf(optarg, "%d", &tests) < 1)
00435                                     {
00436                                         /* Tests done by default */
00437                                         opt->tests = COVERAGE_TESTS;
00438                                     }
00439                                 else
00440                                     {
00441                                         opt->tests = tests;
00442                                     }
00443                             }
00444                         else
00445                             {
00446                                 opt->tests = COVERAGE_TESTS;
00447                             }
00448                          exit_value = TRUE;
00449                         break;
00450 
00451                     default:
00452                         exit_value = usage(0);
00453                         opt->usage = TRUE;
00454                 }
00455         }
00456 
00457     while (optind < argc)
00458         {
00459             filename = (char *) malloc (sizeof(char) * strlen(argv[optind]) + 1);
00460             strcpy(filename, argv[optind]);
00461             opt->filenames = g_list_prepend(opt->filenames, filename);
00462             optind++;
00463         }
00464 
00465     return exit_value;
00466 }
00467 
00468 
00469 /**
00470  * Inits the Options struct that contains all
00471  * stuff needed to managed command line options
00472  * within heraia
00473  * @return returns a newly allocated Options structure
00474  *         initialized to default values
00475  */
00476 static Options *init_options_struct(void)
00477 {
00478     Options *opt = NULL; /**< Structure to manage prgram's options */
00479 
00480     opt = (Options *) g_malloc0(sizeof(Options));
00481 
00482     opt->filenames = NULL;  /* At first we do not have any filename */
00483     opt->usage = FALSE;
00484     opt->tests = NO_TESTS;
00485 
00486     return opt;
00487 }
00488 
00489 
00490 /**
00491  *  main program
00492  *  options :
00493  *   - --version
00494  *   - --help
00495  *   - --tests
00496  */
00497 int main(int argc, char **argv)
00498 {
00499     Options *opt; /**< A structure to manage the command line options  */
00500     gboolean exit_value = TRUE;
00501     heraia_struct_t *main_struct = NULL;
00502     GList *list = NULL;
00503     gchar *heraia_path = NULL;
00504 
00505     if (argv != NULL && argv[0] != NULL)
00506         {
00507             heraia_path = g_path_get_dirname(argv[0]);
00508         }
00509     else
00510         {
00511             return -1;
00512         }
00513 
00514     init_international_languages();
00515 
00516     opt = init_options_struct();
00517 
00518 
00519 
00520     main_struct = heraia_init_main_struct(heraia_path);
00521 
00522     libheraia_initialize();
00523 
00524     if (main_struct->debug == TRUE)
00525         {
00526             fprintf(stdout, Q_("Main struct initialized !\n"));
00527         }
00528 
00529     /* Command line options evaluation */
00530     exit_value = manage_command_line_options(opt, argc, argv);
00531 
00532     if (opt->usage != TRUE)
00533         {
00534             if (main_struct->debug == TRUE)
00535                 {
00536                     fprintf(stderr, Q_("Beginning things\n"));
00537                     libheraia_test(); /* testing libheraia */
00538                 }
00539 
00540             /* init of gtk and new window */
00541             exit_value = gtk_init_check(&argc, &argv);
00542 
00543             if (load_heraia_ui(main_struct) == TRUE)
00544                 {
00545 
00546                     log_message(main_struct, G_LOG_LEVEL_INFO, Q_("Main interface loaded"));
00547                     log_message(main_struct, G_LOG_LEVEL_DEBUG, Q_("Preference file is %s"), main_struct->prefs->filename);
00548                     log_message(main_struct, G_LOG_LEVEL_DEBUG, Q_("data interpretor's tab is %d"), main_struct->current_DW->tab_displayed);
00549 
00550                     init_heraia_plugin_system(main_struct);
00551 
00552                     if (opt->filenames != NULL)
00553                         {
00554                             list = g_list_first(opt->filenames);
00555                             while (list != NULL)
00556                                 {
00557                                     load_file_to_analyse(main_struct, list->data);
00558                                     list = g_list_next(list);
00559                                 }
00560                         }
00561 
00562                     log_message(main_struct, G_LOG_LEVEL_DEBUG, Q_("main_struct : %p"), main_struct);
00563 
00564                     init_heraia_interface(main_struct);
00565 
00566                     /* tests or main loop */
00567                     switch (opt->tests)
00568                             {
00569                                 case COVERAGE_TESTS:
00570                                     exit_value = do_heraia_coverage_tests(main_struct);
00571                                 break;
00572 
00573                                 case LOADING_TESTS:
00574                                     exit_value = do_heraia_loading_tests(main_struct);
00575                                 break;
00576 
00577                                 default:
00578                                     /* gtk main loop */
00579                                     gtk_main();
00580                                     exit_value = TRUE;
00581                             }
00582                 }
00583             else
00584                 {
00585                     fprintf(stderr, Q_("File heraia.gtkbuilder not found !\n"));
00586                     if (main_struct->debug == TRUE)
00587                         {
00588                             list = main_struct->location_list;
00589                             while (list)
00590                                 {
00591                                     /* here heraia_path is used only as a normal gchar*  */
00592                                     heraia_path = (gchar *) list->data;
00593                                     fprintf(stdout, "\t%s\n", heraia_path);
00594                                     list = g_list_next(list);
00595                                 }
00596                         }
00597                 }
00598         }
00599 
00600     libheraia_finalize();
00601 
00602     return !exit_value; /* Apparently gtk TRUE and FALSE are inverted compared to bash ! */
00603 }
Generated on Fri Aug 20 09:15:18 2010 for Heraia by  doxygen 1.6.3