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.2
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(void);
00046 static HERAIA_ERROR init_heraia_plugin_system(heraia_struct_t *main_struct);
00047 static GList *init_heraia_location_list(void);
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  * @return a pointer to a newly initialized main structure
00189  */
00190 static heraia_struct_t *heraia_init_main_struct(void)
00191 {
00192     heraia_struct_t *herwin = NULL;
00193     xml_t *xmls = NULL;
00194 
00195     herwin = (heraia_struct_t *) g_malloc0(sizeof(heraia_struct_t));
00196 
00197     if (!herwin)
00198         {
00199             fprintf(stderr, Q_("Main structure could not be initialiazed !"));
00200             fprintf(stderr, Q_("Do you have a memory problem ?\n"));
00201             return NULL;
00202         }
00203 
00204     /* preference file name initialisation */
00205     herwin->prefs = NULL;
00206     init_preference_struct(herwin);
00207     verify_preference_file(herwin->prefs->pathname, herwin->prefs->filename);
00208 
00209     /**
00210      * First, in this early stage of the development we want to toggle debugging
00211      *  mode ON which is enabled by default in the configure.ac file !
00212      */
00213     herwin->debug = ENABLE_DEBUG;
00214     /* herwin->filename = NULL; */
00215 
00216     herwin->current_doc = NULL;
00217     herwin->plugins_list = NULL;
00218     herwin->location_list = init_heraia_location_list(); /* location list initilization */
00219 
00220     /* xml_t structure initialisation */
00221     xmls = (xml_t *) g_malloc0(sizeof(xml_t));
00222     xmls->main = NULL;
00223     herwin->xmls = xmls;
00224 
00225     /* data interpretor structure initialization */
00226     herwin->current_DW = (data_window_t *) g_malloc0 (sizeof(data_window_t));
00227     herwin->current_DW->diw = NULL;
00228     herwin->current_DW->tab_displayed = 0;  /* the first tab */
00229 
00230     /* init window property structure */
00231     herwin = init_window_property_struct(herwin);
00232 
00233     /* documents */
00234     herwin->documents = g_ptr_array_new();
00235 
00236     /* init global variable for the library */
00237     libheraia_main_struct = herwin;
00238 
00239     return herwin;
00240 }
00241 
00242 
00243 /**
00244  *  Function that initializes the plugin system if any :
00245  *   - loads any plugin where expected to be found
00246  *   - inits the plugin window
00247  * @param main_struct : main structure (heraia_struct_t *)
00248  * @return HERAIA_NO_PLUGINS if no plugins where found or HERAIA_NOERR in
00249  *         case of no errors
00250  */
00251 static HERAIA_ERROR init_heraia_plugin_system(heraia_struct_t *main_struct)
00252 {
00253 
00254     /* Checking for plugins */
00255     if (plugin_capable() == TRUE)
00256         {
00257             log_message(main_struct, G_LOG_LEVEL_INFO, "Enabling plugins");
00258             load_plugins(main_struct);
00259 
00260             /* the plugin_list_window (here the plugins may be loaded !) */
00261             log_message(main_struct, G_LOG_LEVEL_DEBUG, "Inits the plugin list window");
00262             plugin_list_window_init_interface(main_struct);
00263 
00264             return HERAIA_NOERR;
00265         }
00266     else
00267         {
00268             log_message(main_struct, G_LOG_LEVEL_WARNING, "Plugins will be disabled");
00269             return HERAIA_NO_PLUGINS;
00270         }
00271 }
00272 
00273 
00274 /**
00275  *  Here we want to init the location list where we might look for
00276  *  in the future. These can be viewed as default paths
00277  *  @warning when adding new locations, keep in ming that the list is a
00278              prepended list in reverse order.
00279  *  @return a new allocatde GList containing all locations
00280  */
00281 static GList *init_heraia_location_list(void)
00282 {
00283     gchar *path = NULL;
00284     const gchar* const *system_dirs;
00285     guint i = 0;
00286     GList *location_list = NULL;
00287 
00288     /* Heraia's binary path */
00289     path = g_get_current_dir();
00290     location_list = g_list_prepend(location_list, path);
00291 
00292     /* System data dirs */
00293     system_dirs = g_get_system_data_dirs();
00294     i = 0;
00295     while(system_dirs[i] != NULL)
00296         {
00297             path = g_build_path(G_DIR_SEPARATOR_S, system_dirs[i], "heraia", NULL);
00298             location_list = g_list_prepend(location_list, path);
00299             i++;
00300         }
00301 
00302     /* System config dirs */
00303     system_dirs = g_get_system_config_dirs();
00304     i = 0;
00305     while(system_dirs[i] != NULL)
00306         {
00307             path = g_build_path(G_DIR_SEPARATOR_S, system_dirs[i], "heraia", NULL);
00308             location_list = g_list_prepend(location_list, path);
00309             i++;
00310         }
00311 
00312     /* The user path */
00313     path =  g_build_path(G_DIR_SEPARATOR_S, g_get_home_dir(), "heraia", NULL);
00314     location_list = g_list_prepend(location_list, path);
00315 
00316     /* A global user data path */
00317     path = g_build_path(G_DIR_SEPARATOR_S, g_get_user_data_dir(), "heraia", NULL);
00318     location_list = g_list_prepend(location_list, path);
00319 
00320     /* A global config data path */
00321     path = g_build_path(G_DIR_SEPARATOR_S, g_get_user_config_dir(), "heraia", NULL);
00322     location_list = g_list_prepend(location_list, path);
00323 
00324     return location_list;
00325 }
00326 
00327 
00328 /**
00329  *  Inits internationalisation (don't know wether it works or not!)
00330  */
00331 static void init_international_languages(void)
00332 {
00333     gchar *result = NULL;
00334 
00335     setlocale(LC_ALL, "");
00336     result = bindtextdomain(GETTEXT_PACKAGE, LOCALEDIR);
00337 
00338     if (ENABLE_DEBUG == TRUE)
00339         {
00340             fprintf(stdout, "Gettext package : %s\n", GETTEXT_PACKAGE);
00341             fprintf(stdout, "Locale dir : %s\n", LOCALEDIR);
00342             fprintf(stdout, "Bindtextdomain : %s\n", result);
00343         }
00344     bind_textdomain_codeset(GETTEXT_PACKAGE, "UTF-8");
00345     textdomain(GETTEXT_PACKAGE);
00346 }
00347 
00348 
00349 /**
00350  * Does some self tests for code coverage in heraia
00351  *
00352  * This function does some calls to functions that are not called
00353  * on a normal test procedure
00354  *
00355  * @param main_struct : main structure (heraia_struct_t *)
00356  * @return gboolean as an exit value for the program
00357  */
00358 static gboolean do_heraia_coverage_tests(heraia_struct_t *main_struct)
00359 {
00360     heraia_struct_t *tmp_struct;
00361     gboolean exit_value = FALSE;
00362 
00363     exit_value = version();
00364     exit_value = usage(0);
00365     exit_value = usage(1);
00366 
00367     tmp_struct = get_main_struct();
00368     if (tmp_struct != main_struct)
00369         {
00370             fprintf(stderr, "WARNING : tmp_struct is not equal to main_struct!\n");
00371         }
00372 
00373     exit_value = test_decode_functions();
00374     if (exit_value != TRUE)
00375         {
00376             fprintf(stderr, "WARNING : Error while testing decode functions\n");
00377         }
00378 
00379     return TRUE;
00380 }
00381 
00382 
00383 /**
00384  * Does some loading tests in heraia
00385  * @param main_struct : main structure (heraia_struct_t *)
00386  * @return gboolean as an exit value for the program
00387  */
00388 static gboolean do_heraia_loading_tests(heraia_struct_t *main_struct)
00389 {
00390     return TRUE;
00391 }
00392 
00393 
00394 /**
00395  *  Manages all the command line options and populates the
00396  *  Options *opt structure accordingly
00397  *  @param opt (Options *opt) filled here with the parameters found in **argv
00398  *  @param argc : number of command line arguments
00399  *  @param argv : array of string (char *) that contains arguments
00400  *  @return gboolean that seems to always be TRUE
00401  */
00402 static gboolean manage_command_line_options(Options *opt, int argc, char **argv)
00403 {
00404     int exit_value = TRUE;
00405     int c = 0;
00406     gchar *filename = NULL;
00407     int tests = 0;
00408 
00409     while ((c = getopt_long(argc, argv, "vht", long_options, NULL)) != -1)
00410         {
00411             switch (c)
00412                 {
00413                     case 0:         /* long options handler */
00414                         break;
00415 
00416                     case 'v':
00417                         exit_value = version();
00418                         opt->usage = TRUE;  /* We do not want to continue after */
00419                         break;
00420 
00421                     case 'h':
00422                         exit_value = usage(1);
00423                         opt->usage = TRUE;
00424                         break;
00425 
00426                     case 't':
00427                         if (optarg)
00428                             {
00429                                 if (sscanf(optarg, "%d", &tests) < 1)
00430                                     {
00431                                         /* Tests done by default */
00432                                         opt->tests = COVERAGE_TESTS;
00433                                     }
00434                                 else
00435                                     {
00436                                         opt->tests = tests;
00437                                     }
00438                             }
00439                         else
00440                             {
00441                                 opt->tests = COVERAGE_TESTS;
00442                             }
00443                          exit_value = TRUE;
00444                         break;
00445 
00446                     default:
00447                         exit_value = usage(0);
00448                         opt->usage = TRUE;
00449                 }
00450         }
00451 
00452     while (optind < argc)
00453         {
00454             filename = (char *) malloc (sizeof(char) * strlen(argv[optind]) + 1);
00455             strcpy(filename, argv[optind]);
00456             opt->filenames = g_list_prepend(opt->filenames, filename);
00457             optind++;
00458         }
00459 
00460     return exit_value;
00461 }
00462 
00463 
00464 /**
00465  * Inits the Options struct that contains all
00466  * stuff needed to managed command line options
00467  * within heraia
00468  * @return returns a newly allocated Options structure
00469  *         initialized to default values
00470  */
00471 static Options *init_options_struct(void)
00472 {
00473     Options *opt = NULL; /**< Structure to manage prgram's options */
00474 
00475     opt = (Options *) g_malloc0(sizeof(Options));
00476 
00477     opt->filenames = NULL;  /* At first we do not have any filename */
00478     opt->usage = FALSE;
00479     opt->tests = NO_TESTS;
00480 
00481     return opt;
00482 }
00483 
00484 
00485 /**
00486  *  main program
00487  *  options :
00488  *   - --version
00489  *   - --help
00490  *   - --tests
00491  */
00492 int main(int argc, char **argv)
00493 {
00494     Options *opt; /**< A structure to manage the command line options  */
00495     gboolean exit_value = TRUE;
00496     heraia_struct_t *main_struct = NULL;
00497     GList *list = NULL;
00498 
00499 
00500     init_international_languages();
00501 
00502     opt = init_options_struct();
00503 
00504     main_struct = heraia_init_main_struct();
00505 
00506     libheraia_initialize();
00507 
00508     if (main_struct->debug == TRUE)
00509         {
00510             fprintf(stdout, "Main struct initialized !\n");
00511         }
00512 
00513     /* Command line options evaluation */
00514     exit_value = manage_command_line_options(opt, argc, argv);
00515 
00516     if (opt->usage != TRUE)
00517         {
00518             if (main_struct->debug == TRUE)
00519                 {
00520                     fprintf(stderr, "Beginning things\n");
00521                     libheraia_test(); /* testing libheraia */
00522                 }
00523 
00524             /* init of gtk and new window */
00525             exit_value = gtk_init_check(&argc, &argv);
00526 
00527             if (load_heraia_ui(main_struct) == TRUE)
00528                 {
00529 
00530                     log_message(main_struct, G_LOG_LEVEL_INFO, "Main interface loaded");
00531                     log_message(main_struct, G_LOG_LEVEL_DEBUG, "Preference file is %s", main_struct->prefs->filename);
00532                     log_message(main_struct, G_LOG_LEVEL_DEBUG, "data interpretor's tab is %d", main_struct->current_DW->tab_displayed);
00533 
00534                     init_heraia_plugin_system(main_struct);
00535 
00536                     if (opt->filenames != NULL)
00537                         {
00538                             list = g_list_first(opt->filenames);
00539                             while (list != NULL)
00540                                 {
00541                                     load_file_to_analyse(main_struct, list->data);
00542                                     list = g_list_next(list);
00543                                 }
00544                         }
00545 
00546                     log_message(main_struct, G_LOG_LEVEL_DEBUG, "main_struct : %p", main_struct);
00547 
00548                     init_heraia_interface(main_struct);
00549 
00550                     /* tests or main loop */
00551                     switch (opt->tests)
00552                             {
00553                                 case COVERAGE_TESTS:
00554                                     exit_value = do_heraia_coverage_tests(main_struct);
00555                                 break;
00556 
00557                                 case LOADING_TESTS:
00558                                     exit_value = do_heraia_loading_tests(main_struct);
00559                                 break;
00560 
00561                                 default:
00562                                     /* gtk main loop */
00563                                     gtk_main();
00564                                     exit_value = TRUE;
00565                             }
00566                 }
00567             else
00568                 {
00569                     fprintf(stderr, "File heraia.gtkbuilder not found !\n");
00570                 }
00571         }
00572 
00573     libheraia_finalize();
00574 
00575     return !exit_value; /* Apparently gtk TRUE and FALSE are inverted compared to bash ! */
00576 }
Generated on Tue May 11 18:46:08 2010 for Heraia by  doxygen 1.6.3