external_converter.C

Go to the documentation of this file.

/* Gnome gxsm - Gnome X Scanning Microscopy
 * universal STM/AFM/SARLS/SPALEED/... controlling and
 * data analysis software
 * 
 * Gxsm Plugin Name: external_converter.C
 * ========================================
 * 
 * Copyright (C) 2006 The Free Software Foundation
 *
 * Authors: Thorsten Wagner <stm@users.sf.net>
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */

/* Please do not change the Begin/End lines of this comment section!
 * this is a LaTeX style section used for auto generation of the PlugIn Manual 
 * Chapter. Add a complete PlugIn documentation inbetween the Begin/End marks!
 * --------------------------------------------------------------------------------
% BeginPlugInDocuSection
% PlugInDocuCaption: external_converter 
% PlugInName: external_converter
% PlugInAuthor: Thorsten Wagner
% PlugInAuthorEmail: stm@users.sf.net
% PlugInMenuPath: Tools/external_converter 
% PlugInDescription
Simple plugin to call an external converter
% PlugInUsage
Registers itself. Select source file,a destination folder, a suitable suffix, the external converter (full path) and press okey. You can also path some options to the external program
% EndPlugInDocuSection
 * -------------------------------------------------------------------------------- 
 */

#include "external_converter.h"

// Plugin Prototypes
static void external_converter_init (void);
static void external_converter_query (void);
static void external_converter_about (void);
static void external_converter_configure (void);
static void external_converter_cleanup (void);

static void external_converter_run(GtkWidget *w, void *data);


//
// Gxsm plugin discription
//
GxsmPlugin external_converter_pi = {
  NULL,                   // filled in and used by Gxsm, don't touch !
  NULL,                   // filled in and used by Gxsm, don't touch !
  0,                      // filled in and used by Gxsm, don't touch !
  NULL,                   // filled in just after init() is called !!!
  "external_converter",
  NULL,                      
  "Calls an external converter",
  "Thorsten Wagner",
  N_("_Tools/"),
  N_("External Converter"),
  NULL,
  "No further info",
  NULL,
  NULL,
  external_converter_init,
  external_converter_query,
  external_converter_about,
  external_converter_configure,
  NULL,
  external_converter_cleanup
};

//
//Text used in the About Box
//
static const char *about_text = N_("Tool to call an external converter.");
                                   
        
//
// Symbol "get_gxsm_plugin_info" is resolved by dlsym from Gxsm, used to get Plugin's info!! 
// Essential Plugin Function!!
//
GxsmPlugin *get_gxsm_plugin_info ( void ){ 
  external_converter_pi.description = g_strdup_printf(N_("Tool to call an external converter. Version: %s"), VERSION);
  return &external_converter_pi; 
}

//
// Query Function, installs Plugin's in the apropriate menupath
// !!!! make sure the "external_converter_cleanup()" function (see below) !!!!
// !!!! removes the correct menuentries !!!!
//
static void external_converter_query(void)
{
  static GnomeUIInfo menuinfo_external_converter[] = { 
    { GNOME_APP_UI_ITEM, 
      N_("External Converter"), N_("Tool to call an external converter"),
      (gpointer) external_converter_run, NULL,
      NULL, GNOME_APP_PIXMAP_STOCK, GNOME_STOCK_MENU_OPEN,
      0, GDK_CONTROL_MASK, NULL },
    GNOMEUIINFO_END
  };

  gnome_app_insert_menus (
          GNOME_APP(external_converter_pi.app->getApp()), 
          N_("Tools/"),
          menuinfo_external_converter
          );
 
  if(external_converter_pi.status) g_free(external_converter_pi.status); 
  external_converter_pi.status = g_strconcat (
          N_("Plugin query has attached "),
          external_converter_pi.name, 
          N_(": File external_converter is ready to use"),
          NULL);
}

//
// init-Function
//

static void external_converter_init(void)
{
  PI_DEBUG(DBG_L2,"external_converter Plugin Init");
}

//
// about-Function
//
static void external_converter_about(void)
{
  const gchar *authors[] = { external_converter_pi.authors, NULL};
  gtk_widget_show(gnome_about_new ( external_converter_pi.name,
                                    VERSION,
                                    N_("(C) 2006 the Free Software Foundation"),
                                    about_text,
                                    authors,
                                    NULL,NULL,NULL
                                    ));
}

//
// configure-Function
//
static void external_converter_configure(void)
{
  if(external_converter_pi.app)
    external_converter_pi.app->message("External Converter Plugin Configuration");
}

//
// cleanup-Function, make sure the Menustrings are matching those above!!!
//
static void external_converter_cleanup(void)
{
  PI_DEBUG(DBG_L2,"External Converter Plugin Cleanup");
  gnome_app_remove_menus (GNOME_APP (external_converter_pi.app->getApp()),
                          N_("Tools/External Converter"), 1);
}


//Gtk+ Signal Funktion
static void external_converter_run(GtkWidget *w, void *data)
{
  external_converter_Control *Popup = new external_converter_Control();
  Popup->run();
  PI_DEBUG(DBG_L2,"External Converter dialog opened");
}


// ANFANG external_converter

gchar *select_mask;

// ENDE external_converter

// ANFANG external_converter_Control

gint file_error(const gchar *err_msg, const gchar *dir);

external_converter_Control::external_converter_Control ()
{ 
        frontenddata = new external_converter_Data(getenv("PWD"),getenv("PWD"));
        XsmRescourceManager xrm("FilePathSelectionHistory","external_converter");
        xrm.Get ("SourceFile",&frontenddata->sourceFile, getenv("PWD"));
        xrm.Get ("DestFile", &frontenddata->destFile, getenv("PWD"));
        xrm.Get ("DestSuffix", &frontenddata->destSuffix, ".txt");
        xrm.Get ("ConverterPath", &frontenddata->converterPath, "/usr/local/bin/converter");
        xrm.Get ("ConverterOptions", &frontenddata->converterOptions, "PWD");
}


external_converter_Control::~external_converter_Control ()
{
  delete frontenddata;
}


void external_converter_Control::run()
{
        GtkWidget *dialog;
        GtkWidget *vbox;
        GtkWidget *hbox;
        GtkWidget *VarName;
        GtkWidget *variable;
        GtkWidget *help;
  
  DlgStart();
  dialog = gnome_dialog_new(_("External Converter"), _("Convert"), GNOME_STOCK_BUTTON_CANCEL, NULL); 

   gnome_dialog_set_close(GNOME_DIALOG(dialog), FALSE);
   gnome_dialog_close_hides(GNOME_DIALOG(dialog), FALSE);
   gnome_dialog_set_default(GNOME_DIALOG(dialog), 3);      

        vbox = gtk_vbox_new (FALSE, 0);
        gtk_widget_show (vbox);

        gtk_box_pack_start(GTK_BOX(GNOME_DIALOG(dialog)->vbox), vbox, TRUE, TRUE, GNOME_PAD);

        // Create entry for source file
        hbox = gtk_hbox_new (FALSE, 0);
        gtk_widget_show (hbox);
        gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);

        VarName = gtk_label_new (_("Source File"));
        gtk_widget_set_usize (VarName, 100, -1);
        gtk_widget_show (VarName);
        gtk_label_set_justify(GTK_LABEL(VarName), GTK_JUSTIFY_LEFT);
        gtk_misc_set_alignment (GTK_MISC (VarName), 0.0, 0.5);
        gtk_misc_set_padding (GTK_MISC (VarName), 5, 0);
        gtk_box_pack_start (GTK_BOX (hbox), VarName, TRUE, TRUE, 0);
        
        SrcFile = variable = gnome_file_entry_new( NULL, "Choose the source file");
        gnome_file_entry_set_default_path( GNOME_FILE_ENTRY ( variable ), frontenddata->sourceFile);
        gnome_file_entry_set_directory_entry(GNOME_FILE_ENTRY (variable), FALSE);
        gnome_file_entry_set_filename (GNOME_FILE_ENTRY (variable), frontenddata->sourceFile);
        gtk_box_pack_start (GTK_BOX (hbox), variable, TRUE, TRUE, 0);
        gtk_widget_show(variable);

        // Create entry for destination path
        hbox = gtk_hbox_new (FALSE, 0);
        gtk_widget_show (hbox);
        gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);

        VarName = gtk_label_new (_("Destination Path"));
        gtk_widget_set_usize (VarName, 100, -1);
        gtk_widget_show (VarName);
        gtk_label_set_justify(GTK_LABEL(VarName), GTK_JUSTIFY_LEFT);
        gtk_misc_set_alignment (GTK_MISC (VarName), 0.0, 0.5);
        gtk_misc_set_padding (GTK_MISC (VarName), 5, 0);
        gtk_box_pack_start (GTK_BOX (hbox), VarName, TRUE, TRUE, 0);

        DestinationPath = variable = gnome_file_entry_new( NULL, "Choose the destination directory");
        gnome_file_entry_set_default_path( GNOME_FILE_ENTRY ( variable ), frontenddata->destFile);
        gnome_file_entry_set_directory_entry(GNOME_FILE_ENTRY (variable), TRUE);
        gnome_file_entry_set_filename (GNOME_FILE_ENTRY (variable), frontenddata->destFile);
        gtk_box_pack_start (GTK_BOX (hbox), variable, TRUE, TRUE,0 );
        gtk_widget_show(variable);

  hbox = gtk_hbox_new (FALSE, 0);
  gtk_widget_show (hbox);
  gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);

  VarName = gtk_label_new (_("Suffix of Destination"));
  gtk_widget_set_usize (VarName, 100, -1);
  gtk_widget_show (VarName);
  gtk_label_set_justify(GTK_LABEL(VarName), GTK_JUSTIFY_LEFT);
  gtk_misc_set_alignment (GTK_MISC (VarName), 0.0, 0.5);
  gtk_misc_set_padding (GTK_MISC (VarName), 5, 0);
  gtk_box_pack_start (GTK_BOX (hbox), VarName, TRUE, TRUE, 0);

  DestinationSuffix = variable = gtk_entry_new ();
  gtk_widget_show (variable);
  gtk_box_pack_start (GTK_BOX (hbox), variable, TRUE, TRUE, 0);
  gtk_entry_set_text (GTK_ENTRY (variable), frontenddata->destSuffix);

  help = gtk_button_new_with_label (_("Help"));
  gtk_widget_show (help);
  gtk_box_pack_start (GTK_BOX (hbox), help, TRUE, TRUE, 0);
  gtk_signal_connect (GTK_OBJECT (help), "clicked", GTK_SIGNAL_FUNC (show_info_callback),(void*)(_("Enter the file format suffix without any special characters.")));

        gtk_signal_connect(GTK_OBJECT(dialog), "clicked", GTK_SIGNAL_FUNC(external_converter_Control::dlg_clicked), this);

        // Create entry for converter
        hbox = gtk_hbox_new (FALSE, 0);
        gtk_widget_show (hbox);
        gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);

        VarName = gtk_label_new (_("Path to Converter"));
        gtk_widget_set_usize (VarName, 100, -1);
        gtk_widget_show (VarName);
        gtk_label_set_justify(GTK_LABEL(VarName), GTK_JUSTIFY_LEFT);
        gtk_misc_set_alignment (GTK_MISC (VarName), 0.0, 0.5);
        gtk_misc_set_padding (GTK_MISC (VarName), 5, 0);
        gtk_box_pack_start (GTK_BOX (hbox), VarName, TRUE, TRUE, 0);

        ConverterPath = variable = gnome_file_entry_new( NULL, "Choose the path to the external converter");
        gnome_file_entry_set_default_path( GNOME_FILE_ENTRY ( variable ), frontenddata->destFile);
        gnome_file_entry_set_directory_entry(GNOME_FILE_ENTRY (variable), FALSE);
        gnome_file_entry_set_filename (GNOME_FILE_ENTRY (variable), frontenddata->converterPath);
        gtk_box_pack_start (GTK_BOX (hbox), variable, TRUE, TRUE,0 );
        gtk_widget_show(variable);
        gtk_signal_connect(GTK_OBJECT(dialog), "clicked",GTK_SIGNAL_FUNC(external_converter_Control::dlg_clicked),this);

        hbox = gtk_hbox_new (FALSE, 0);
        gtk_widget_show (hbox);
        gtk_box_pack_start (GTK_BOX (vbox), hbox, FALSE, FALSE, 0);

        VarName = gtk_label_new (_("Converter Options"));
        gtk_widget_set_usize (VarName, 100, -1);
        gtk_widget_show (VarName);
        gtk_label_set_justify(GTK_LABEL(VarName), GTK_JUSTIFY_LEFT);
        gtk_misc_set_alignment (GTK_MISC (VarName), 0.0, 0.5);
        gtk_misc_set_padding (GTK_MISC (VarName), 5, 0);
        gtk_box_pack_start (GTK_BOX (hbox), VarName, TRUE, TRUE, 0);

        ConverterOptions = variable = gtk_entry_new ();
        gtk_widget_show (variable);
        gtk_box_pack_start (GTK_BOX (hbox), variable, TRUE, TRUE, 0);
        gtk_entry_set_text (GTK_ENTRY (variable), frontenddata->converterOptions);

        help = gtk_button_new_with_label (_("Help"));
        gtk_widget_show (help);
        gtk_box_pack_start (GTK_BOX (hbox), help, TRUE, TRUE, 0);
        gtk_signal_connect (GTK_OBJECT (help), "clicked", GTK_SIGNAL_FUNC (show_info_callback),(void*)(_("Enter options for the external converter.")));

        gtk_signal_connect(GTK_OBJECT(dialog), "clicked", GTK_SIGNAL_FUNC(external_converter_Control::dlg_clicked), this);
        
        gtk_widget_show(dialog);
}

void external_converter_Control::dlg_clicked(GnomeDialog * dialog, gint button_number, external_converter_Control *mic){

        g_free(mic->frontenddata->sourceFile); 
        mic->frontenddata->sourceFile = g_strdup(gnome_file_entry_get_full_path(GNOME_FILE_ENTRY (mic->SrcFile),TRUE));
        if(mic->frontenddata->sourceFile == NULL && !button_number)
                if(file_error("Source file does not exist",NULL)){
                        gnome_dialog_close(dialog);
                        goto finish;
                }
        
        g_free(mic->frontenddata->destFile); 
        mic->frontenddata->destFile = g_strdup(gnome_file_entry_get_full_path(GNOME_FILE_ENTRY (mic->DestinationPath),FALSE));
        if(access(mic->frontenddata->destFile,F_OK) && !button_number)
                if(file_error("Destination file does not exist",mic->frontenddata->destFile)){
                        gnome_dialog_close(dialog); 
                        goto finish;
                }

        g_free(mic->frontenddata->destSuffix);
        mic->frontenddata->destSuffix = g_strdup(gtk_entry_get_text (GTK_ENTRY (mic->DestinationSuffix)));      

        g_free(mic->frontenddata->converterPath); 
        mic->frontenddata->converterPath = g_strdup(gnome_file_entry_get_full_path(GNOME_FILE_ENTRY (mic->ConverterPath),FALSE));
        if(access(mic->frontenddata->converterPath,F_OK) && !button_number)
                if(file_error("Destination file does not exist",mic->frontenddata->converterPath)){
                        gnome_dialog_close(dialog); 
                        goto finish;
                }
        
        g_free(mic->frontenddata->converterOptions);
        mic->frontenddata->converterOptions = g_strdup(gtk_entry_get_text (GTK_ENTRY (mic->ConverterOptions))); 

  switch(button_number){
  case 0:       {gnome_dialog_close(dialog);
                                //show_info_callback(NULL, _("Converting ..."));
                                char command[1000];
                                int len = strlen(mic->frontenddata->sourceFile);
                                gchar* fname = g_strndup(mic->frontenddata->sourceFile,1000);
                                gchar* buffer;
                                while(buffer=strstr(fname,"/")){
                                        fname = strndup(buffer+1,1000);
                                }
                                buffer = g_strndup(fname,strlen(fname)-strlen(strrchr(fname, '.')));

                                len = strlen(mic->frontenddata->destFile);
                                if (len > 0) {
                                        if(mic->frontenddata->destFile[len-1] != '/') strcat(mic->frontenddata->destFile, "/");
                                }
                                snprintf(command, 1000, "%s %s %s%s.%s %s &", mic->frontenddata->converterPath, mic->frontenddata->sourceFile, mic->frontenddata->destFile, buffer, mic->frontenddata->destSuffix, mic->frontenddata->converterOptions);
                                system(command);
                        break;}

        case 1: {gnome_dialog_close(dialog); 
                                break;}
        }
finish:
        XsmRescourceManager xrm("FilePathSelectionHistory","external_converter");
        xrm.Put ("SourceFile", mic->frontenddata->sourceFile);
        xrm.Put ("DestFile", mic->frontenddata->destFile);
        xrm.Put ("DestSuffix", mic->frontenddata->destSuffix);
        xrm.Put ("ConverterPath", mic->frontenddata->converterPath);
        xrm.Put ("ConverterOptions", mic->frontenddata->converterOptions);

mic->DlgDone();

}

// ENDE external_converter_Control

//ANFANG external_converter_Data

external_converter_Data :: external_converter_Data(gchar *src, gchar *dst)
{
        sourceFile   =  g_strdup(src);
        destFile     =  g_strdup(dst); 
}
        
external_converter_Data :: ~external_converter_Data() 
{
        g_free(sourceFile);
        g_free(destFile);
}

// ENDE external_converter_Data

---