Logo Search packages:      
Sourcecode: file-roller version File versions  Download package

fr-process.h

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */

/*
 *  File-Roller
 *
 *  Copyright (C) 2001, 2003 Free Software Foundation, Inc.
 *
 *  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 Street #330, Boston, MA 02111-1307, USA.
 */

#ifndef FR_PROCESS_H
#define FR_PROCESS_H

#include <glib.h>
#include <gtk/gtkobject.h>
#include <sys/types.h>
#include "typedefs.h"

#define FR_TYPE_PROCESS            (fr_process_get_type ())
#define FR_PROCESS(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), FR_TYPE_PROCESS, FRProcess))
#define FR_PROCESS_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), FR_TYPE_PROCESS, FRProcessClass))
#define FR_IS_PROCESS(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), FR_TYPE_PROCESS))
#define FR_IS_PROCESS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), FR_TYPE_PROCESS))
#define FR_PROCESS_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), FR_TYPE_PROCESS, FRProcessClass))

typedef struct _FRProcess       FRProcess;
typedef struct _FRProcessClass  FRProcessClass;

#define BUFFER_SIZE 16384


typedef void     (*ProcLineFunc) (char *line, gpointer data);
typedef void     (*ProcFunc)     (gpointer data);
typedef gboolean (*ContinueFunc) (gpointer data);


typedef struct {
      GList *args;              /* command to execute */
      char  *dir;               /* working directory */
      guint  sticky : 1;        /* whether the command must be executed even
                           * if a previous command has failed. */
      guint  ignore_error : 1;  /* whether to continue to execute other 
                           * commands if this command fails. */

      ContinueFunc continue_func;
      gpointer     continue_data;

      ProcFunc     begin_func;
      gpointer     begin_data;

      ProcFunc     end_func;
      gpointer     end_data;
} FRCommandInfo;


struct _FRProcess {
      GObject  __parent;

      /*< public >*/

      gboolean     term_on_stop;     /* whether we must terminate the command
                              * when calling fr_process_stop. */

      /*< protected >*/

      gboolean     restart;          /* Whether the process must restart
                              * after an error. */

      /*< private >*/

      GPtrArray   *comm;             /* FRCommandInfo elements. */
      gint         n_comm;           /* total number of commands */
      gint         current_comm;     /* currenlty editing command. */

      pid_t        command_pid;
      int          output_fd;
      int          error_fd;

      guint        log_timeout;

      char        *o_buffer;
      int          o_not_processed;
      GList       *raw_output;

      char        *e_buffer;
      int          e_not_processed;
      GList       *raw_error;

      ProcLineFunc o_proc_line_func;
      gpointer     o_proc_line_data;

      ProcLineFunc e_proc_line_func;
      gpointer     e_proc_line_data;

      FRProcError  error;
      FRProcError  first_error;

      gboolean     running;
      gboolean     stopping;
      gint         current_command; 
      gint         error_command;    /* command that coused an error. */

      gboolean     use_standard_locale;
      gboolean     sticky_only;      /* whether to execute only sticky 
                              * commands. */
};


struct _FRProcessClass {
      GObjectClass __parent_class;

      /* -- Signals -- */

      void (* start)         (FRProcess   *fr_proc);
      void (* done)          (FRProcess   *fr_proc,
                        FRProcError *error);
      void (* sticky_only)   (FRProcess   *fr_proc);
};


GType       fr_process_get_type             (void);
FRProcess * fr_process_new                  (void);
void        fr_process_clear                (FRProcess    *fr_proc);
void        fr_process_begin_command        (FRProcess    *fr_proc, 
                                   const char   *arg);
void        fr_process_begin_command_at     (FRProcess    *fr_proc, 
                                   const char   *arg,
                                   int           index);
void        fr_process_add_arg              (FRProcess    *fr_proc, 
                                   const char   *arg);
void        fr_process_set_arg_at           (FRProcess    *fr_proc, 
                                   int           n_comm,
                                   int           n_arg,
                                   const char   *arg);
void        fr_process_set_begin_func       (FRProcess    *fr_proc, 
                                   ProcFunc      func,
                                   gpointer      func_data);
void        fr_process_set_end_func         (FRProcess    *fr_proc, 
                                   ProcFunc      func,
                                   gpointer      func_data);
void        fr_process_set_continue_func    (FRProcess    *fr_proc, 
                                   ContinueFunc  func,
                                   gpointer      func_data);
void        fr_process_end_command          (FRProcess    *fr_proc);
void        fr_process_set_working_dir      (FRProcess    *fr_proc, 
                                   const char   *arg);
void        fr_process_set_sticky           (FRProcess    *fr_proc, 
                                   gboolean      sticky);
void        fr_process_set_ignore_error     (FRProcess    *fr_proc, 
                                   gboolean      ignore_error);
void        fr_process_use_standard_locale  (FRProcess    *fr_proc,
                                   gboolean      use_stand_locale);
void        fr_process_set_out_line_func    (FRProcess    *fr_proc, 
                                   ProcLineFunc  func,
                                   gpointer      func_data);
void        fr_process_set_err_line_func    (FRProcess    *fr_proc, 
                                   ProcLineFunc  func,
                                   gpointer      func_data);
void        fr_process_start                (FRProcess    *fr_proc);
void        fr_process_stop                 (FRProcess    *fr_proc);


#endif /* FR_PROCESS_H */

Generated by  Doxygen 1.6.0   Back to index