ps/gtkgs.h

   1 /*
   2  * Ghostscript widget for GTK/GNOME
   3  *
   4  * Copyright 1998 - 2005 The Free Software Foundation
   5  *
   6  * Authors: Jaka Mocnik, Federico Mena (Quartic), Szekeres Istvan (Pista)
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef __GTK_GS_H__
  25 #define __GTK_GS_H__
  26
  27 #include <gdk/gdk.h>
  28 #include <gtk/gtkwidget.h>
  29
  30 #include <gconf/gconf-client.h>
  31
  32 #include <errno.h>
  33 #include <signal.h>
  34 #include <unistd.h>
  35 #include <sys/types.h>
  36 #include <stdio.h>
  37
  38 G_BEGIN_DECLS
  39
  40 #define GTK_GS_TYPE         (gtk_gs_get_type())
  41 #define GTK_GS(obj)         GTK_CHECK_CAST (obj, gtk_gs_get_type (), GtkGS)
  42 #define GTK_GS_CLASS(klass) GTK_CHECK_CLASS_CAST (klass, gtk_gs_get_type (), GtkGSClass)
  43 #define GTK_IS_GS(obj)      GTK_CHECK_TYPE (obj, gtk_gs_get_type())
  44
  45 typedef struct _GtkGS GtkGS;
  46 typedef struct _GtkGSClass GtkGSClass;
  47 typedef struct _GtkGSPaperSize GtkGSPaperSize;
  48
  49 typedef enum {
  50   GTK_GS_ORIENTATION_NONE = -1,
  51   GTK_GS_ORIENTATION_PORTRAIT = 0,
  52   GTK_GS_ORIENTATION_SEASCAPE = 3,
  53   GTK_GS_ORIENTATION_UPSIDEDOWN = 2,
  54   GTK_GS_ORIENTATION_LANDSCAPE = 1
  55 } GtkGSOrientation;
  56
  57 typedef enum {
  58   GTK_GS_ZOOM_ABSOLUTE = 0,
  59   GTK_GS_ZOOM_FIT_WIDTH = 1,
  60   GTK_GS_ZOOM_FIT_PAGE = 2
  61 } GtkGSZoomMode;
  62
  63 struct _GtkGS {
  64   GtkObject object;             /* the main widget */
  65   GdkWindow *pstarget;          /* the window passed to gv
  66                                  * it is a child of widget...
  67                                  */
  68   GtkAdjustment *hadj, *vadj;
  69
  70   GdkGC *psgc;
  71   gint scroll_start_x, scroll_start_y;
  72   gint scroll_width, scroll_height;
  73   gboolean show_scroll_rect;
  74
  75   GtkGSZoomMode zoom_mode;
  76
  77   GdkPixmap *bpixmap;           /* Backing pixmap */
  78   int use_bpixmap;
  79
  80   long message_window;          /* Used by ghostview to receive messages from app */
  81
  82   int disable_start;            /* Can the interpreter be started? */
  83   pid_t interpreter_pid;        /* PID of interpreter, -1 if none  */
  84   int interpreter_input;        /* stdin of interpreter            */
  85   int interpreter_output;       /* stdout of interpreter           */
  86   int interpreter_err;          /* stderr of interpreter           */
  87   guint interpreter_input_id;
  88   guint interpreter_output_id;
  89   guint interpreter_error_id;
  90
  91   gint llx;
  92   gint lly;
  93   gint urx;
  94   gint ury;
  95   gint left_margin;
  96   gint right_margin;
  97   gint top_margin;
  98   gint bottom_margin;
  99   gint width;                   /* Size of window at last setup()  */
 100   gint height;
 101   gboolean busy;                /* Is gs busy drawing? */
 102   gboolean changed;             /* Anything changed since setup */
 103   gfloat zoom_factor;
 104   gfloat scroll_step;
 105   gint current_page;
 106   gboolean structured_doc;
 107   gboolean loaded;
 108
 109   struct record_list *ps_input;
 110   gchar *input_buffer_ptr;
 111   guint bytes_left;
 112   guint buffer_bytes_left;
 113
 114   FILE *gs_psfile;              /* the currently loaded FILE */
 115   gchar *gs_filename;           /* the currently loaded filename */
 116   gchar *gs_filename_dsc;       /* Used to browse PDF to PS */
 117   gchar *gs_filename_unc;       /* Uncompressed file */
 118   gchar *input_buffer;
 119   gint gs_scanstyle;
 120   gboolean send_filename_to_gs; /* True if gs should read from file directly */
 121   gboolean reading_from_pipe;   /* True if ggv is reading input from pipe */
 122   struct document *doc;
 123
 124   /* User selected options... */
 125   gboolean antialiased;         /* Using antialiased display */
 126   gboolean respect_eof;         /* respect EOF comments? */
 127   gint default_size;
 128   gboolean override_size;
 129   gfloat xdpi, ydpi;
 130   gboolean override_orientation;
 131   gint fallback_orientation;    /* Orientation to use if override */
 132   gint real_orientation;        /* Real orientation from the document */
 133
 134   const gchar *gs_status;       /* GtkGS status */
 135
 136   guint avail_w, avail_h;
 137 };
 138
 139 struct _GtkGSClass {
 140   GObjectClass parent_class;
 141   GdkAtom gs_atom;
 142   GdkAtom gs_colors_atom;
 143   GdkAtom next_atom;
 144   GdkAtom page_atom;
 145   GdkAtom done_atom;
 146   GdkAtom string_atom;
 147
 148   GConfClient *gconf_client;
 149
 150   void (*interpreter_message) (GtkGS *, gchar *, gpointer);
 151   void (*interpreter_error) (GtkGS *, gint, gpointer);
 152   void (*set_scroll_adjustments) (GtkGS *, GtkAdjustment *, GtkAdjustment *);
 153 };
 154
 155
 156 /* structure to describe section of file to send to ghostscript */
 157 struct record_list {
 158   FILE *fp;
 159   long begin;
 160   guint len;
 161   gboolean seek_needed;
 162   gboolean close;
 163   struct record_list *next;
 164 };
 165
 166 struct _GtkGSPaperSize {
 167   gchar *name;
 168   gint width, height;
 169 };
 170
 171 GType gtk_gs_get_type(void);
 172
 173 GObject *gtk_gs_new_from_file(GtkAdjustment * hadj, GtkAdjustment * vadj,
 174                                 gchar * fname);
 175 GObject *gtk_gs_new(GtkAdjustment * hadj, GtkAdjustment * vadj);
 176 gboolean gtk_gs_load(GtkGS * gs, const gchar * fname);
 177 void gtk_gs_reload(GtkGS * gs);
 178
 179 /* control functions */
 180 void gtk_gs_center_page(GtkGS * gs);
 181 void gtk_gs_scroll(GtkGS * gs, gint, gint);
 182 gboolean gtk_gs_scroll_step(GtkGS * gs, GtkScrollType direction,
 183                             gboolean dowrap);
 184 gboolean gtk_gs_scroll_to_edge(GtkGS * gs, GtkPositionType vertical,
 185                                GtkPositionType horizontal);
 186 gboolean gtk_gs_next_page(GtkGS * gs);
 187 gboolean gtk_gs_prev_page(GtkGS * gs);
 188 gboolean gtk_gs_goto_page(GtkGS * gs, gint);
 189 gint gtk_gs_enable_interpreter(GtkGS * gs);
 190 void gtk_gs_disable_interpreter(GtkGS * gs);
 191
 192 gint gtk_gs_get_current_page(GtkGS * gs);
 193 gint gtk_gs_get_page_count(GtkGS * gs);
 194 gboolean gtk_gs_set_page_size(GtkGS * gs, gint new_pagesize, gint pageid);
 195 gboolean gtk_gs_set_default_orientation(GtkGS * gs, gint orientation);
 196 gint gtk_gs_get_default_orientation(GtkGS * gs);
 197 void gtk_gs_set_default_size(GtkGS * gs, gint size);
 198 gint gtk_gs_get_default_size(GtkGS * gs);
 199 void gtk_gs_set_zoom(GtkGS * gs, gfloat zoom);
 200 gfloat gtk_gs_get_zoom(GtkGS * gs);
 201 void gtk_gs_set_scroll_step(GtkGS * gs, gfloat scroll_step);
 202 gfloat gtk_gs_get_scroll_step(GtkGS * gs);
 203 gfloat gtk_gs_zoom_to_fit(GtkGS * gs, gboolean fit_width);
 204 void gtk_gs_set_center(GtkGS * gs, gfloat hval, gfloat vval);
 205 gint gtk_gs_get_orientation(GtkGS * gs);
 206 void gtk_gs_set_override_orientation(GtkGS * gs, gboolean f);
 207 gboolean gtk_gs_get_override_orientation(GtkGS * gs);
 208 void gtk_gs_set_respect_eof(GtkGS * gs, gboolean f);
 209 gboolean gtk_gs_get_respect_eof(GtkGS * gs);
 210 void gtk_gs_set_antialiasing(GtkGS * gs, gboolean f);
 211 gboolean gtk_gs_get_antialiasing(GtkGS * gs);
 212 void gtk_gs_set_override_size(GtkGS * gs, gboolean f);
 213 gboolean gtk_gs_get_override_size(GtkGS * gs);
 214 const gchar *gtk_gs_get_document_title(GtkGS * widget);
 215 guint gtk_gs_get_document_numpages(GtkGS * widget);
 216 const gchar *gtk_gs_get_document_page_label(GtkGS * widget, int page);
 217 void gtk_gs_set_show_scroll_rect(GtkGS * gs, gboolean f);
 218 gboolean gtk_gs_get_show_scroll_rect(GtkGS * gs);
 219
 220 void gtk_gs_start_scroll(GtkGS * gs);
 221 void gtk_gs_end_scroll(GtkGS * gs);
 222
 223 void gtk_gs_set_zoom_mode(GtkGS * gs, GtkGSZoomMode zoom_mode);
 224 GtkGSZoomMode gtk_gs_get_zoom_mode(GtkGS * gs);
 225
 226 void gtk_gs_set_available_size(GtkGS * gs, guint avail_w, guint avail_h);
 227
 228 /* utility functions */
 229 gint gtk_gs_get_size_index(const gchar * string, GtkGSPaperSize * size);
 230
 231 gchar *gtk_gs_get_postscript(GtkGS * gs, gint * pages);
 232
 233 #define GTK_GS_IS_COMPRESSED(gs)       (GTK_GS(gs)->gs_filename_unc != NULL)
 234 #define GTK_GS_GET_PS_FILE(gs)         (GTK_GS_IS_COMPRESSED(gs) ? \
 235                                         GTK_GS(gs)->gs_filename_unc : \
 236                                         GTK_GS(gs)->gs_filename)
 237 #define GTK_GS_IS_PDF(gs)              (GTK_GS(gs)->gs_filename_dsc != NULL)
 238 #define GTK_GS_IS_STRUCTURED_DOC(gs)   (GTK_GS(gs)->structured_doc)
 239
 240 G_END_DECLS
 241
 242 #endif /* __GTK_GS_H__ */