src/extension/internal/cairo-render-context.h

   1 #ifndef EXTENSION_INTERNAL_CAIRO_RENDER_CONTEXT_H_SEEN
   2 #define EXTENSION_INTERNAL_CAIRO_RENDER_CONTEXT_H_SEEN
   3
   4 /** \file
   5  * Declaration of CairoRenderContext, a class used for rendering with Cairo.
   6  */
   7 /*
   8  * Authors:
   9  *         Miklos Erdelyi <erdelyim@gmail.com>
  10  *
  11  * Copyright (C) 2006 Miklos Erdelyi
  12  *
  13  * Licensed under GNU GPL
  14  */
  15
  16 #ifdef HAVE_CONFIG_H
  17 # include "config.h"
  18 #endif
  19
  20 #include "extension/extension.h"
  21 #include <set>
  22 #include <string>
  23
  24 #include "libnr/nr-path.h"
  25 #include <libnr/nr-matrix-ops.h>
  26 #include <2geom/forward.h>
  27
  28 #include "style.h"
  29
  30 #include <cairo.h>
  31
  32 class SPClipPath;
  33 class SPMask;
  34
  35 namespace Inkscape {
  36 namespace Extension {
  37 namespace Internal {
  38
  39 class CairoRenderer;
  40 class CairoRenderContext;
  41 class CairoRenderState;
  42 class CairoGlyphInfo;
  43
  44 // Holds info for rendering a glyph
  45 struct CairoGlyphInfo {
  46     unsigned long index;
  47     double x;
  48     double y;
  49 };
  50
  51 struct CairoRenderState {
  52     unsigned int merge_opacity : 1;     // whether fill/stroke opacity can be mul'd with item opacity
  53     unsigned int need_layer : 1;
  54     unsigned int has_overflow : 1;
  55     unsigned int parent_has_userspace : 1;  // whether the parent's ctm should be applied
  56     float opacity;
  57     bool has_filtereffect;
  58     Geom::Matrix item_transform;     // this item's item->transform, for correct clipping
  59
  60     SPClipPath *clip_path;
  61     SPMask* mask;
  62
  63     Geom::Matrix transform;     // the CTM
  64 };
  65
  66 class CairoRenderContext {
  67     friend class CairoRenderer;
  68 public:
  69     CairoRenderContext *cloneMe(void) const;
  70     CairoRenderContext *cloneMe(double width, double height) const;
  71     bool finish(void);
  72
  73     CairoRenderer *getRenderer(void) const;
  74     cairo_t *getCairoContext(void) const;
  75
  76     typedef enum CairoRenderMode {
  77         RENDER_MODE_NORMAL,
  78         RENDER_MODE_CLIP
  79     };
  80
  81     typedef enum CairoClipMode {
  82         CLIP_MODE_PATH,
  83         CLIP_MODE_MASK
  84     };
  85
  86     bool setImageTarget(cairo_format_t format);
  87     bool setPdfTarget(gchar const *utf8_fn);
  88     bool setPsTarget(gchar const *utf8_fn);
  89     /** Set the cairo_surface_t from an external source */
  90     bool setSurfaceTarget(cairo_surface_t *surface, bool is_vector);
  91
  92     void setPSLevel(unsigned int level);
  93     void setEPS(bool eps);
  94     unsigned int getPSLevel(void);
  95     void setPDFLevel(unsigned int level);
  96     void setTextToPath(bool texttopath);
  97     bool getTextToPath(void);
  98     void setFilterToBitmap(bool filtertobitmap);
  99     bool getFilterToBitmap(void);
 100     void setBitmapResolution(int resolution);
 101     int getBitmapResolution(void);
 102
 103     /** Creates the cairo_surface_t for the context with the
 104     given width, height and with the currently set target
 105     surface type. */
 106     bool setupSurface(double width, double height);
 107
 108     cairo_surface_t *getSurface(void);
 109
 110     /** Saves the contents of the context to a PNG file. */
 111     bool saveAsPng(const char *file_name);
 112
 113     /* Render/clip mode setting/query */
 114     void setRenderMode(CairoRenderMode mode);
 115     CairoRenderMode getRenderMode(void) const;
 116     void setClipMode(CairoClipMode mode);
 117     CairoClipMode getClipMode(void) const;
 118
 119     void addPathVector(Geom::PathVector const &pv);
 120     void setPathVector(Geom::PathVector const &pv);
 121
 122     void pushLayer(void);
 123     void popLayer(void);
 124
 125     /* Graphics state manipulation */
 126     void pushState(void);
 127     void popState(void);
 128     CairoRenderState *getCurrentState(void) const;
 129     CairoRenderState *getParentState(void) const;
 130     void setStateForStyle(SPStyle const *style);
 131
 132     void transform(Geom::Matrix const *transform);
 133     void setTransform(Geom::Matrix const *transform);
 134     void getTransform(Geom::Matrix *copy) const;
 135     void getParentTransform(Geom::Matrix *copy) const;
 136
 137     /* Clipping methods */
 138     void addClipPath(Geom::PathVector const &pv, SPIEnum const *fill_rule);
 139     void addClippingRect(double x, double y, double width, double height);
 140
 141     /* Rendering methods */
 142     bool renderPathVector(Geom::PathVector const & pathv, SPStyle const *style, NRRect const *pbox);
 143     bool renderPath(const_NRBPath const *bpath, SPStyle const *style, NRRect const *pbox);
 144     bool renderImage(unsigned char *px, unsigned int w, unsigned int h, unsigned int rs,
 145                      Geom::Matrix const *image_transform, SPStyle const *style);
 146     bool renderGlyphtext(PangoFont *font, Geom::Matrix const *font_matrix,
 147                          std::vector<CairoGlyphInfo> const &glyphtext, SPStyle const *style);
 148
 149     /* More general rendering methods will have to be added (like fill, stroke) */
 150
 151 protected:
 152     CairoRenderContext(CairoRenderer *renderer);
 153     virtual ~CairoRenderContext(void);
 154
 155     float _width;
 156     float _height;
 157     unsigned short _dpi;
 158     unsigned int _pdf_level;
 159     unsigned int _ps_level;
 160     bool _eps;
 161     bool _is_texttopath;
 162     bool _is_filtertobitmap;
 163     int _bitmapresolution;
 164
 165     FILE *_stream;
 166
 167     unsigned int _is_valid : 1;
 168     unsigned int _vector_based_target : 1;
 169
 170     cairo_t *_cr;
 171     cairo_surface_t *_surface;
 172     cairo_surface_type_t _target;
 173     cairo_format_t _target_format;
 174     PangoLayout *_layout;
 175
 176     unsigned int _clip_rule : 8;
 177     unsigned int _clip_winding_failed : 1;
 178
 179     GSList *_state_stack;
 180     CairoRenderState *_state;    // the current state
 181
 182     CairoRenderer *_renderer;
 183
 184     CairoRenderMode _render_mode;
 185     CairoClipMode _clip_mode;
 186
 187     cairo_pattern_t *_createPatternForPaintServer(SPPaintServer const *const paintserver,
 188                                                   NRRect const *pbox, float alpha);
 189     cairo_pattern_t *_createPatternPainter(SPPaintServer const *const paintserver, NRRect const *pbox);
 190
 191     unsigned int _showGlyphs(cairo_t *cr, PangoFont *font, std::vector<CairoGlyphInfo> const &glyphtext, bool is_stroke);
 192
 193     bool _finishSurfaceSetup(cairo_surface_t *surface);
 194     void _setFillStyle(SPStyle const *style, NRRect const *pbox);
 195     void _setStrokeStyle(SPStyle const *style, NRRect const *pbox);
 196
 197     void _initCairoMatrix(cairo_matrix_t *matrix, Geom::Matrix const *transform);
 198     void _concatTransform(cairo_t *cr, double xx, double yx, double xy, double yy, double x0, double y0);
 199     void _concatTransform(cairo_t *cr, Geom::Matrix const *transform);
 200
 201     CairoRenderState *_createState(void);
 202 };
 203
 204 }  /* namespace Internal */
 205 }  /* namespace Extension */
 206 }  /* namespace Inkscape */
 207
 208 #endif /* !EXTENSION_INTERNAL_CAIRO_RENDER_CONTEXT_H_SEEN */
 209
 210 /*
 211   Local Variables:
 212   mode:c++
 213   c-file-style:"stroustrup"
 214   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 215   indent-tabs-mode:nil
 216   fill-column:99
 217   End:
 218 */
 219 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :