libview/ev-jobs.h

   1 /* this file is part of evince, a gnome document viewer
   2  *
   3  *  Copyright (C) 2008 Carlos Garcia Campos <carlosgc@gnome.org>
   4  *  Copyright (C) 2005 Red Hat, Inc
   5  *
   6  * Evince is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Evince is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __EV_JOBS_H__
  22 #define __EV_JOBS_H__
  23
  24 #include <gio/gio.h>
  25 #include <gtk/gtk.h>
  26
  27 #include "ev-document.h"
  28 #include "ev-selection.h"
  29 #include "ev-render-context.h"
  30
  31 G_BEGIN_DECLS
  32
  33 typedef struct _EvJob EvJob;
  34 typedef struct _EvJobClass EvJobClass;
  35
  36 typedef struct _EvJobRender EvJobRender;
  37 typedef struct _EvJobRenderClass EvJobRenderClass;
  38
  39 typedef struct _EvJobThumbnail EvJobThumbnail;
  40 typedef struct _EvJobThumbnailClass EvJobThumbnailClass;
  41
  42 typedef struct _EvJobLinks EvJobLinks;
  43 typedef struct _EvJobLinksClass EvJobLinksClass;
  44
  45 typedef struct _EvJobAttachments EvJobAttachments;
  46 typedef struct _EvJobAttachmentsClass EvJobAttachmentsClass;
  47
  48 typedef struct _EvJobFonts EvJobFonts;
  49 typedef struct _EvJobFontsClass EvJobFontsClass;
  50
  51 typedef struct _EvJobLoad EvJobLoad;
  52 typedef struct _EvJobLoadClass EvJobLoadClass;
  53
  54 typedef struct _EvJobSave EvJobSave;
  55 typedef struct _EvJobSaveClass EvJobSaveClass;
  56
  57 typedef struct _EvJobFind EvJobFind;
  58 typedef struct _EvJobFindClass EvJobFindClass;
  59
  60 typedef struct _EvJobLayers EvJobLayers;
  61 typedef struct _EvJobLayersClass EvJobLayersClass;
  62
  63 typedef struct _EvJobExport EvJobExport;
  64 typedef struct _EvJobExportClass EvJobExportClass;
  65
  66 #define EV_TYPE_JOB                          (ev_job_get_type())
  67 #define EV_JOB(object)                       (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB, EvJob))
  68 #define EV_JOB_CLASS(klass)                  (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB, EvJobClass))
  69 #define EV_IS_JOB(object)                    (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB))
  70 #define EV_JOB_GET_CLASS(object)             (G_TYPE_INSTANCE_GET_CLASS((object), EV_TYPE_JOB, EvJobClass))
  71
  72 #define EV_TYPE_JOB_LINKS                    (ev_job_links_get_type())
  73 #define EV_JOB_LINKS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LINKS, EvJobLinks))
  74 #define EV_JOB_LINKS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LINKS, EvJobLinksClass))
  75 #define EV_IS_JOB_LINKS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LINKS))
  76
  77 #define EV_TYPE_JOB_ATTACHMENTS              (ev_job_attachments_get_type())
  78 #define EV_JOB_ATTACHMENTS(object)           (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachments))
  79 #define EV_JOB_ATTACHMENTS_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_ATTACHMENTS, EvJobAttachmentsClass))
  80 #define EV_IS_JOB_ATTACHMENTS(object)        (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_ATTACHMENTS))
  81
  82 #define EV_TYPE_JOB_RENDER                   (ev_job_render_get_type())
  83 #define EV_JOB_RENDER(object)                (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_RENDER, EvJobRender))
  84 #define EV_JOB_RENDER_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_RENDER, EvJobRenderClass))
  85 #define EV_IS_JOB_RENDER(object)             (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_RENDER))
  86
  87 #define EV_TYPE_JOB_THUMBNAIL                (ev_job_thumbnail_get_type())
  88 #define EV_JOB_THUMBNAIL(object)             (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnail))
  89 #define EV_JOB_THUMBNAIL_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_THUMBNAIL, EvJobThumbnailClass))
  90 #define EV_IS_JOB_THUMBNAIL(object)          (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_THUMBNAIL))
  91
  92 #define EV_TYPE_JOB_FONTS                    (ev_job_fonts_get_type())
  93 #define EV_JOB_FONTS(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FONTS, EvJobFonts))
  94 #define EV_JOB_FONTS_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FONTS, EvJobFontsClass))
  95 #define EV_IS_JOB_FONTS(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FONTS))
  96
  97 #define EV_TYPE_JOB_LOAD                     (ev_job_load_get_type())
  98 #define EV_JOB_LOAD(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LOAD, EvJobLoad))
  99 #define EV_JOB_LOAD_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LOAD, EvJobLoadClass))
 100 #define EV_IS_JOB_LOAD(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LOAD))
 101
 102 #define EV_TYPE_JOB_SAVE                     (ev_job_save_get_type())
 103 #define EV_JOB_SAVE(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_SAVE, EvJobSave))
 104 #define EV_JOB_SAVE_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_SAVE, EvJobSaveClass))
 105 #define EV_IS_JOB_SAVE(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_SAVE))
 106
 107 #define EV_TYPE_JOB_FIND                     (ev_job_find_get_type())
 108 #define EV_JOB_FIND(object)                  (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_FIND, EvJobFind))
 109 #define EV_JOB_FIND_CLASS(klass)             (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_FIND, EvJobFindClass))
 110 #define EV_IS_JOB_FIND(object)               (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_FIND))
 111
 112 #define EV_TYPE_JOB_LAYERS                   (ev_job_layers_get_type())
 113 #define EV_JOB_LAYERS(object)                (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_LAYERS, EvJobLayers))
 114 #define EV_JOB_LAYERS_CLASS(klass)           (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_LAYERS, EvJobLayersClass))
 115 #define EV_IS_JOB_LAYERS(object)             (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_LAYERS))
 116
 117 #define EV_TYPE_JOB_EXPORT                    (ev_job_export_get_type())
 118 #define EV_JOB_EXPORT(object)                 (G_TYPE_CHECK_INSTANCE_CAST((object), EV_TYPE_JOB_EXPORT, EvJobExport))
 119 #define EV_JOB_EXPORT_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST((klass), EV_TYPE_JOB_EXPORT, EvJobExportClass))
 120 #define EV_IS_JOB_EXPORT(object)              (G_TYPE_CHECK_INSTANCE_TYPE((object), EV_TYPE_JOB_EXPORT))
 121
 122 typedef enum {
 123         EV_JOB_RUN_THREAD,
 124         EV_JOB_RUN_MAIN_LOOP
 125 } EvJobRunMode;
 126
 127 struct _EvJob
 128 {
 129         GObject parent;
 130
 131         EvDocument *document;
 132
 133         EvJobRunMode run_mode;
 134
 135         guint cancelled : 1;
 136         guint finished : 1;
 137         guint failed : 1;
 138
 139         GError *error;
 140         GCancellable *cancellable;
 141
 142         guint idle_finished_id;
 143         guint idle_cancelled_id;
 144 };
 145
 146 struct _EvJobClass
 147 {
 148         GObjectClass parent_class;
 149
 150         gboolean (*run)         (EvJob *job);
 151
 152         /* Signals */
 153         void     (* cancelled)  (EvJob *job);
 154         void     (* finished)   (EvJob *job);
 155 };
 156
 157 struct _EvJobLinks
 158 {
 159         EvJob parent;
 160
 161         GtkTreeModel *model;
 162 };
 163
 164 struct _EvJobLinksClass
 165 {
 166         EvJobClass parent_class;
 167 };
 168
 169 struct _EvJobAttachments
 170 {
 171         EvJob parent;
 172
 173         GList *attachments;
 174 };
 175
 176 struct _EvJobAttachmentsClass
 177 {
 178         EvJobClass parent_class;
 179 };
 180
 181 typedef enum {
 182         EV_RENDER_INCLUDE_NONE      = 0,
 183         EV_RENDER_INCLUDE_LINKS     = 1 << 0,
 184         EV_RENDER_INCLUDE_TEXT      = 1 << 1,
 185         EV_RENDER_INCLUDE_SELECTION = 1 << 2,
 186         EV_RENDER_INCLUDE_IMAGES    = 1 << 3,
 187         EV_RENDER_INCLUDE_FORMS     = 1 << 4,
 188         EV_RENDER_INCLUDE_ALL       = (1 << 5) - 1
 189 } EvRenderFlags;
 190
 191 struct _EvJobRender
 192 {
 193         EvJob parent;
 194
 195         gint page;
 196         gint rotation;
 197         gdouble scale;
 198
 199         EvPage *ev_page;
 200         gboolean page_ready;
 201         gint target_width;
 202         gint target_height;
 203         cairo_surface_t *surface;
 204
 205         GList *link_mapping;
 206         GdkRegion *text_mapping;
 207         GList *image_mapping;
 208         GList *form_field_mapping;
 209
 210         cairo_surface_t *selection;
 211         GdkRegion *selection_region;
 212         EvRectangle selection_points;
 213         EvSelectionStyle selection_style;
 214         GdkColor base;
 215         GdkColor text;
 216
 217         EvRenderFlags flags;
 218 };
 219
 220 struct _EvJobRenderClass
 221 {
 222         EvJobClass parent_class;
 223
 224         void    (* page_ready) (EvJobRender *job);
 225 };
 226
 227 struct _EvJobThumbnail
 228 {
 229         EvJob parent;
 230
 231         gint page;
 232         gint rotation;
 233         gdouble scale;
 234
 235         GdkPixbuf *thumbnail;
 236 };
 237
 238 struct _EvJobThumbnailClass
 239 {
 240         EvJobClass parent_class;
 241 };
 242
 243 struct _EvJobFonts
 244 {
 245         EvJob parent;
 246         gboolean scan_completed;
 247 };
 248
 249 struct _EvJobFontsClass
 250 {
 251         EvJobClass parent_class;
 252
 253         /* Signals */
 254         void (* updated)  (EvJobFonts *job,
 255                            gdouble     progress);
 256 };
 257
 258 struct _EvJobLoad
 259 {
 260         EvJob parent;
 261
 262         gchar *uri;
 263         gchar *password;
 264 };
 265
 266 struct _EvJobLoadClass
 267 {
 268         EvJobClass parent_class;
 269 };
 270
 271 struct _EvJobSave
 272 {
 273         EvJob parent;
 274
 275         gchar *uri;
 276         gchar *document_uri;
 277 };
 278
 279 struct _EvJobSaveClass
 280 {
 281         EvJobClass parent_class;
 282 };
 283
 284 struct _EvJobFind
 285 {
 286         EvJob parent;
 287
 288         gint start_page;
 289         gint current_page;
 290         gint n_pages;
 291         GList **pages;
 292         gchar *text;
 293         gboolean case_sensitive;
 294         gboolean has_results;
 295 };
 296
 297 struct _EvJobFindClass
 298 {
 299         EvJobClass parent_class;
 300
 301         /* Signals */
 302         void (* updated)  (EvJobFind *job,
 303                            gint       page);
 304 };
 305
 306 struct _EvJobLayers
 307 {
 308         EvJob parent;
 309
 310         GtkTreeModel *model;
 311 };
 312
 313 struct _EvJobLayersClass
 314 {
 315         EvJobClass parent_class;
 316 };
 317
 318 struct _EvJobExport
 319 {
 320         EvJob parent;
 321
 322         gint page;
 323         EvRenderContext *rc;
 324 };
 325
 326 struct _EvJobExportClass
 327 {
 328         EvJobClass parent_class;
 329 };
 330
 331 /* Base job class */
 332 GType           ev_job_get_type           (void) G_GNUC_CONST;
 333 gboolean        ev_job_run                (EvJob          *job);
 334 void            ev_job_cancel             (EvJob          *job);
 335 void            ev_job_failed             (EvJob          *job,
 336                                            GQuark          domain,
 337                                            gint            code,
 338                                            const gchar    *format,
 339                                            ...);
 340 void            ev_job_failed_from_error  (EvJob          *job,
 341                                            GError         *error);
 342 void            ev_job_succeeded          (EvJob          *job);
 343 gboolean        ev_job_is_cancelled       (EvJob          *job);
 344 gboolean        ev_job_is_finished        (EvJob          *job);
 345 gboolean        ev_job_is_failed          (EvJob          *job);
 346 EvJobRunMode    ev_job_get_run_mode       (EvJob          *job);
 347 void            ev_job_set_run_mode       (EvJob          *job,
 348                                            EvJobRunMode    run_mode);
 349
 350 /* EvJobLinks */
 351 GType           ev_job_links_get_type     (void) G_GNUC_CONST;
 352 EvJob          *ev_job_links_new          (EvDocument     *document);
 353
 354 /* EvJobAttachments */
 355 GType           ev_job_attachments_get_type (void) G_GNUC_CONST;
 356 EvJob          *ev_job_attachments_new      (EvDocument     *document);
 357
 358 /* EvJobRender */
 359 GType           ev_job_render_get_type    (void) G_GNUC_CONST;
 360 EvJob          *ev_job_render_new         (EvDocument      *document,
 361                                            gint             page,
 362                                            gint             rotation,
 363                                            gdouble          scale,
 364                                            gint             width,
 365                                            gint             height,
 366                                            EvRenderFlags    flags);
 367 void     ev_job_render_set_selection_info (EvJobRender     *job,
 368                                            EvRectangle     *selection_points,
 369                                            EvSelectionStyle selection_style,
 370                                            GdkColor        *text,
 371                                            GdkColor        *base);
 372 /* EvJobThumbnail */
 373 GType           ev_job_thumbnail_get_type (void) G_GNUC_CONST;
 374 EvJob          *ev_job_thumbnail_new      (EvDocument      *document,
 375                                            gint             page,
 376                                            gint             rotation,
 377                                            gdouble          scale);
 378 /* EvJobFonts */
 379 GType           ev_job_fonts_get_type     (void) G_GNUC_CONST;
 380 EvJob          *ev_job_fonts_new          (EvDocument      *document);
 381
 382 /* EvJobLoad */
 383 GType           ev_job_load_get_type      (void) G_GNUC_CONST;
 384 EvJob          *ev_job_load_new           (const gchar     *uri);
 385 void            ev_job_load_set_uri       (EvJobLoad       *load,
 386                                            const gchar     *uri);
 387 void            ev_job_load_set_password  (EvJobLoad       *job,
 388                                            const gchar     *password);
 389
 390 /* EvJobSave */
 391 GType           ev_job_save_get_type      (void) G_GNUC_CONST;
 392 EvJob          *ev_job_save_new           (EvDocument      *document,
 393                                            const gchar     *uri,
 394                                            const gchar     *document_uri);
 395 /* EvJobFind */
 396 GType           ev_job_find_get_type      (void) G_GNUC_CONST;
 397 EvJob          *ev_job_find_new           (EvDocument      *document,
 398                                            gint             start_page,
 399                                            gint             n_pages,
 400                                            const gchar     *text,
 401                                            gboolean         case_sensitive);
 402 gint            ev_job_find_get_n_results (EvJobFind       *job,
 403                                            gint             pages);
 404 gdouble         ev_job_find_get_progress  (EvJobFind       *job);
 405 gboolean        ev_job_find_has_results   (EvJobFind       *job);
 406 GList         **ev_job_find_get_results   (EvJobFind       *job);
 407
 408 /* EvJobLayers */
 409 GType           ev_job_layers_get_type    (void) G_GNUC_CONST;
 410 EvJob          *ev_job_layers_new         (EvDocument     *document);
 411
 412 /* EvJobExport */
 413 GType           ev_job_export_get_type    (void) G_GNUC_CONST;
 414 EvJob          *ev_job_export_new         (EvDocument     *document);
 415 void            ev_job_export_set_page    (EvJobExport    *job,
 416                                            gint            page);
 417
 418 G_END_DECLS
 419
 420 #endif /* __EV_JOBS_H__ */