aw_device.hxx

Go to the documentation of this file.

#ifndef AW_DEVICE_HXX
#define AW_DEVICE_HXX

#ifndef SIZED_CSTR_H
#include <sized_cstr.h>
#endif
#ifndef AW_POSITION_HXX
#include <aw_position.hxx>
#endif
#ifndef AW_FONT_LIMITS_HXX
#include <aw_font_limits.hxx>
#endif
#ifndef ATTRIBUTES_H
#include <attributes.h>
#endif
#ifndef ARBTOOLS_H
#include <arbtools.h>
#endif

#if defined(DEBUG) && defined(DEBUG_GRAPHICS)
// if you want flush() to be called after every motif command :
#define AUTO_FLUSH(device) (device)->flush()
#else
#define AUTO_FLUSH(device)
#endif

#define AW_INT(x) ((int)(((x)>=0.0) ? ((float)(x)+.5) : ((float)(x)-.5)))

// #define AW_PIXELS_PER_MM 1.0001 // stupid and wrong

#define DPI_SCREEN  80   // fixed
#define DPI_PRINTER 1200 // default resolution of xfig 3.2

const AW_bitset AW_SCREEN        = 1;
const AW_bitset AW_CLICK         = 2;
const AW_bitset AW_CLICK_DROP    = 4;
const AW_bitset AW_SIZE          = 8;
const AW_bitset AW_SIZE_UNSCALED = 16;  // for text and text-size dependant parts
const AW_bitset AW_PRINTER       = 32;  // print/xfig-export
const AW_bitset AW_PRINTER_EXT   = 64;  // (+Handles) use combined with AW_PRINTER only
const AW_bitset AW_PRINTER_CLIP  = 128; // print screen only
const AW_bitset AW_TRACK         = 256; // species tracking

const AW_bitset AW_ALL_DEVICES          = (AW_bitset)-1; // @@@ allowed to used this ?
const AW_bitset AW_ALL_DEVICES_SCALED   = (AW_ALL_DEVICES & ~AW_SIZE_UNSCALED);
const AW_bitset AW_ALL_DEVICES_UNSCALED = (AW_ALL_DEVICES & ~AW_SIZE);

enum AW_DEVICE_TYPE {
    AW_DEVICE_SCREEN  = AW_SCREEN,
    AW_DEVICE_CLICK   = AW_CLICK,
    AW_DEVICE_SIZE    = AW_SIZE,
    AW_DEVICE_PRINTER = AW_PRINTER,
};

enum {
    AW_FIXED             = -1,
    AW_TIMES             = 0,
    AW_TIMES_ITALIC      = 1,
    AW_TIMES_BOLD        = 2,
    AW_TIMES_BOLD_ITALIC = 3,

    AW_COURIER              = 12,
    AW_COURIER_OBLIQUE      = 13,
    AW_COURIER_BOLD         = 14,
    AW_COURIER_BOLD_OBLIQUE = 15,

    AW_HELVETICA                     = 16,
    AW_HELVETICA_OBLIQUE             = 17,
    AW_HELVETICA_BOLD                = 18,
    AW_HELVETICA_BOLD_OBLIQUE        = 19,
    AW_HELVETICA_NARROW              = 20,
    AW_HELVETICA_NARROW_OBLIQUE      = 21,
    AW_HELVETICA_NARROW_BOLD         = 22,
    AW_HELVETICA_NARROW_BOLD_OBLIQUE = 23,

    AW_LUCIDA_SANS                 = 35,
    AW_LUCIDA_SANS_OBLIQUE         = 36,
    AW_LUCIDA_SANS_BOLD            = 37,
    AW_LUCIDA_SANS_BOLD_OBLIQUE    = 38,
    AW_LUCIDA_SANS_TYPEWRITER      = 39,
    AW_LUCIDA_SANS_TYPEWRITER_BOLD = 40,
    AW_SCREEN_MEDIUM               = 41,
    AW_SCREEN_BOLD                 = 42,
    AW_CLEAN_MEDIUM                = 43,
    AW_CLEAN_BOLD                  = 44,
    AW_TERMINAL_MEDIUM             = 45,
    AW_TERMINAL_BOLD               = 46,

    AW_NUM_FONTS      = 68,
    AW_NUM_FONTS_XFIG = 35, // immutable

    AW_DEFAULT_NORMAL_FONT = AW_LUCIDA_SANS,
    AW_DEFAULT_BOLD_FONT   = AW_LUCIDA_SANS_BOLD,
    AW_DEFAULT_FIXED_FONT  = AW_LUCIDA_SANS_TYPEWRITER,
};

enum AW_cursor_type {
    AW_cursor_insert,
    AW_cursor_overwrite
};

// --------------------------------------------------
// general note on world- vs. pixel-positions:(WORLD_vs_PIXEL)
//
// A position is interpreted as the center of the corresponding pixel
// (pixel refers to screen; printer pixel are 15 times smaller!)
//
// Hence, when scaling factor is 1.0, then
// - any position inside [-0.5, 0.5[ will fall into the pixel 0, any inside [0.5, 1.5[ into pixel 1.
// - a line from 0.0 to 2.0 will paint THREE pixels (0, 1 and 2). A line from -0.5 to 2.499 will to the same
// - clipping to area [0, 100] should in fact clip to [-0.5, 100.5[ (@@@ check this)

class AW_zoomable {
    AW::Vector offset;
    AW_pos     scale;
    AW_pos     unscale;         // = 1.0/scale

public:
    AW_zoomable() { this->reset(); };
    virtual ~AW_zoomable() {}

    void zoom(AW_pos scale);

    AW_pos get_scale() const { return scale; };
    AW_pos get_unscale() const { return unscale; };
    AW::Vector get_offset() const { return offset; }

    void rotate(AW_pos angle);

    void set_offset(const AW::Vector& off) { offset = off*scale; }
    void shift(const AW::Vector& doff) { offset += doff*scale; }

    void reset();

    double transform_size(const double& size) const { return size*scale; }
    double rtransform_size(const double& size) const { return size*unscale; }

    double rtransform_pixelsize(int pixelsize) const {
        // return world-size needed to draw line/box with length/size == 'pixelsize'
        return (pixelsize-1)*unscale;
    }

    // transforming a Vector only scales the vector (a Vector has no position!)
    AW::Vector transform (const AW::Vector& vec) const { return vec*scale; }
    AW::Vector rtransform(const AW::Vector& vec) const { return vec*unscale; }

    // transform a Position
    AW::Position transform (const AW::Position& pos) const { return transform(AW::Vector(pos+offset)).endpoint(); }
    AW::Position rtransform(const AW::Position& pos) const { return rtransform(AW::Vector(pos)).endpoint()-offset; }
#if defined(WARN_TODO) && 0
#warning fix transformations
    // @@@ I think this calculation is wrong, cause offset is already scaled
    //     (same applies to old-style transform/rtransform below)
#endif

    AW::LineVector transform (const AW::LineVector& lvec) const { return AW::LineVector(transform(lvec.start()), transform(lvec.line_vector())); }
    AW::LineVector rtransform(const AW::LineVector& lvec) const { return AW::LineVector(rtransform(lvec.start()), rtransform(lvec.line_vector())); }

    AW::Rectangle transform (const AW::Rectangle& rect) const { return AW::Rectangle(transform(static_cast<const AW::LineVector&>(rect))); }
    AW::Rectangle rtransform(const AW::Rectangle& rect) const { return AW::Rectangle(rtransform(static_cast<const AW::LineVector&>(rect))); }

    // old style functions, not preferred:
    void transform(AW_pos x, AW_pos y, AW_pos& xout, AW_pos& yout) const {
        xout = (x+offset.x())*scale;
        yout = (y+offset.y())*scale;
    }
    void rtransform(AW_pos x, AW_pos y, AW_pos& xout, AW_pos& yout) const {
        xout = x*unscale - offset.x();
        yout = y*unscale - offset.y();
    }
};

struct AW_font_overlap { bool top, bottom, left, right; };

class AW_clipable {
    const AW_screen_area& common_screen;
    const AW_screen_area& get_screen() const { return common_screen; }

    AW_screen_area  clip_rect;    // holds the clipping rectangle coordinates
    AW_font_overlap font_overlap;

    void set_cliprect_oversize(const AW_screen_area& rect, bool allow_oversize);

    bool need_extra_clip_position(const AW::Position& p1, const AW::Position& p2, AW::Position& extra);

protected:
    int compoutcode(AW_pos xx, AW_pos yy) const {
        // calculate outcode for clipping the current line
        // order - top,bottom,right,left
        int code = 0;
        if (clip_rect.b - yy < 0)       code = 4;
        else if (yy - clip_rect.t < 0)  code = 8;
        if (clip_rect.r - xx < 0)       code |= 2;
        else if (xx - clip_rect.l < 0)  code |= 1;
        return code;
    };

    void set_cliprect(const AW_screen_area& rect) { clip_rect = rect; }

public:

    AW_clipable(const AW_screen_area& screen)
        : common_screen(screen)
    {
        clip_rect.clear();
        set_font_overlap(false);
    }
    virtual ~AW_clipable() {}

    bool is_below_clip(double ypos) const { return ypos > clip_rect.b; }
    bool is_above_clip(double ypos) const { return ypos < clip_rect.t; }
    bool is_leftof_clip(double xpos) const { return xpos < clip_rect.l; }
    bool is_rightof_clip(double xpos) const { return xpos > clip_rect.r; }

    bool is_outside_clip(AW::Position pos) const {
        return
            is_below_clip(pos.ypos()) || is_above_clip(pos.ypos()) ||
            is_leftof_clip(pos.xpos()) || is_rightof_clip(pos.xpos());
    }
    bool is_outside_clip(AW::Rectangle rect) const {
        return !rect.overlaps_with(AW::Rectangle(get_cliprect(), AW::INCLUSIVE_OUTLINE));
    }

    bool clip(AW_pos x0, AW_pos y0, AW_pos x1, AW_pos y1, AW_pos& x0out, AW_pos& y0out, AW_pos& x1out, AW_pos& y1out);
    bool clip(const AW::LineVector& line, AW::LineVector& clippedLine);

    bool box_clip(AW_pos x0, AW_pos y0, AW_pos x1, AW_pos y1, AW_pos& x0out, AW_pos& y0out, AW_pos& x1out, AW_pos& y1out);
    bool box_clip(const AW::Rectangle& rect, AW::Rectangle& clippedRect);
    bool box_clip(int npos, const AW::Position *pos, int& nclippedPos, AW::Position*& clippedPos);
    bool force_into_clipbox(const AW::Position& pos, AW::Position& forcedPos);

    void set_top_clip_border(int top, bool allow_oversize = false);
    void set_bottom_clip_border(int bottom, bool allow_oversize = false); // absolute
    void set_bottom_clip_margin(int bottom, bool allow_oversize = false); // relative
    void set_left_clip_border(int left, bool allow_oversize = false);
    void set_right_clip_border(int right, bool allow_oversize = false);
    const AW_screen_area& get_cliprect() const { return clip_rect; }

    void set_clipall() {
        // clip all -> nothing drawn afterwards
        AW_screen_area rect = { 0, -1, 0, -1};
        set_cliprect_oversize(rect, false);
    }

    bool completely_clipped() const { return clip_rect.l>clip_rect.r || clip_rect.t>clip_rect.b; }

    bool allow_top_font_overlap() const { return font_overlap.top; }
    bool allow_bottom_font_overlap() const { return font_overlap.bottom; }
    bool allow_left_font_overlap() const { return font_overlap.left; }
    bool allow_right_font_overlap() const { return font_overlap.right; }
    const AW_font_overlap& get_font_overlap() const { return font_overlap; }

    void set_top_font_overlap(bool allow) { font_overlap.top = allow; }
    void set_bottom_font_overlap(bool allow) { font_overlap.bottom = allow; }
    void set_left_font_overlap(bool allow) { font_overlap.left = allow; }
    void set_right_font_overlap(bool allow) { font_overlap.right = allow; }

    void set_vertical_font_overlap(bool allow) { font_overlap.top = font_overlap.bottom = allow; }
    void set_horizontal_font_overlap(bool allow) { font_overlap.left = font_overlap.right = allow; }
    void set_font_overlap(bool allow) { set_vertical_font_overlap(allow); set_horizontal_font_overlap(allow); }
    void set_font_overlap(const AW_font_overlap& fo) { font_overlap = fo; }

    // like set_xxx_clip_border but make window only smaller:

    void reduce_top_clip_border(int top);
    void reduce_bottom_clip_border(int bottom);
    void reduce_left_clip_border(int left);
    void reduce_right_clip_border(int right);

    int reduceClipBorders(int top, int bottom, int left, int right);
};

// -----------------------------------------------
//      Graphic context (linestyle, width ...)

enum AW_linestyle {
    AW_SOLID,
    AW_DASHED,
    AW_DOTTED,
};


enum AW_function {
    AW_COPY,
    AW_XOR
};

class AW_common;

class AW_stylable : virtual Noncopyable {
    AW_common *common;
public:
    AW_stylable(AW_common *common_) : common(common_) {}
    virtual ~AW_stylable() {};

    AW_common *get_common() const { return common; }

    void new_gc(int gc);

    void          set_grey_level(int gc, AW_grey_level grey_level);
    AW_grey_level get_grey_level(int gc);

    void set_font(int gc, AW_font fontnr, int size, int *found_size);
    void set_line_attributes(int gc, short width, AW_linestyle style);
    void set_function(int gc, AW_function function);
    void establish_default(int gc);
    void set_foreground_color(int gc, AW_color_idx color);

    int get_string_size(int gc, long textlen) const;
    int get_string_size(int gc, const SizedCstr& cstr) const;

    const AW_font_limits& get_font_limits(int gc, char c) const; // for one characters (c == 0 -> for all characters)

    int get_available_fontsizes(int gc, AW_font font_nr, int *available_sizes);

    void reset_style();
};

class  AW_clip_scale_stack;
struct AW_world;
class  AW_device;

class AW_click_cd : virtual Noncopyable {
    AW_CL              cd1;
    AW_CL              cd2;
    AW_device         *my_device;
    const AW_click_cd *previous;

    void link();

public:
    AW_click_cd(AW_device *device, AW_CL CD1, AW_CL CD2)
        : cd1(CD1),
          cd2(CD2),
          my_device(device)
    { link(); }
    AW_click_cd(AW_device *device, AW_CL CD1)
        : cd1(CD1),
          cd2(0),
          my_device(device)
    { link(); }
    ~AW_click_cd();

    void disable();
    void enable();

    AW_CL get_cd1() const { return cd1; }
    AW_CL get_cd2() const { return cd2; }

    void set_cd1(AW_CL cd) { cd1 = cd; }
    void set_cd2(AW_CL cd) { cd2 = cd; }
};

typedef bool (*TextOverlayCallback)(AW_device *device, int gc, const char *textBuffer, size_t textStart, size_t textLen, const AW::Position& pos, AW_CL cduser);

class AW_device : public AW_zoomable, public AW_stylable, public AW_clipable {
    AW_device(const AW_device& other);
    AW_device& operator=(const AW_device& other);

protected:
    AW_clip_scale_stack *clip_scale_stack;

    const AW_click_cd *click_cd;
    friend class       AW_click_cd;

    AW_bitset filter;

    enum Fill_Style { FS_EMPTY, FS_GREY, FS_SOLID };

    static const AW_screen_area& get_common_screen(const AW_common *common_);

public:
    AW_device(class AW_common *common_) :
        AW_stylable(common_),
        AW_clipable(get_common_screen(common_)),
        clip_scale_stack(NULp),
        click_cd(NULp),
        filter(AW_ALL_DEVICES)
    {}
    virtual ~AW_device() {}

    const AW_click_cd *get_click_cd() const { return click_cd; }
    AW_bitset get_filter() const { return filter; }

    void reset(); // pops all clip_scales

    const AW_screen_area& get_area_size() const;
    AW::Rectangle get_rtransformed_cliprect() const { return rtransform(AW::Rectangle(get_cliprect(), AW::INCLUSIVE_OUTLINE)); }

    void set_filter(AW_bitset filteri);   // set the main filter mask

    void push_clip_scale();     // push clipping area and scale
    void pop_clip_scale();     // pop them

    virtual AW_DEVICE_TYPE type() = 0;

    bool ready_to_draw(int gc); // unused atm

private:
    // * functions below return 1 if any pixel is drawn, 0 otherwise
    // * primary functions (always virtual; pure virtual in all devices used as baseclass)

    virtual bool line_impl(int gc, const AW::LineVector& Line, AW_bitset filteri)                                       = 0;
    virtual bool text_impl(int gc, const SizedCstr& cstr, const AW::Position& pos, AW_pos alignment, AW_bitset filteri) = 0;
    virtual bool box_impl(int gc, AW::FillStyle filled, const AW::Rectangle& rect, AW_bitset filteri)                   = 0;
    virtual bool polygon_impl(int gc, AW::FillStyle filled, int npos, const AW::Position *pos, AW_bitset filteri)       = 0;

    virtual bool circle_impl(int gc, AW::FillStyle filled, const AW::Position& center, const AW::Vector& radius, AW_bitset filteri)                                  = 0;
    virtual bool arc_impl(int gc, AW::FillStyle filled, const AW::Position& center, const AW::Vector& radius, int start_degrees, int arc_degrees, AW_bitset filteri) = 0;

    virtual bool invisible_impl(const AW::Position& pos, AW_bitset filteri) = 0;

    virtual void specific_reset() = 0;

protected:

    // * second level functions
    // generic implementations which may be used by primary functions of derived classes

    bool generic_box(int gc, const AW::Rectangle& rect, AW_bitset filteri);
    bool generic_circle(int gc, const AW::Position& center, const AW::Vector& radius, AW_bitset filteri) {
        return generic_box(gc, AW::Rectangle(center-radius, center+radius), filteri);
    }
    bool generic_polygon(int gc, int npos, const AW::Position *pos, AW_bitset filteri);
    bool generic_invisible(const AW::Position& pos, AW_bitset filteri);

public:
    // * third level functions (never virtual/overloaded by derived classes)

    bool line(int gc, const AW::LineVector& Line, AW_bitset filteri = AW_ALL_DEVICES_SCALED) {
        return line_impl(gc, Line, filteri);
    }
    bool line(int gc, const AW::Position& pos1, const AW::Position& pos2, AW_bitset filteri = AW_ALL_DEVICES_SCALED) {
        return line_impl(gc, AW::LineVector(pos1, pos2), filteri);
    }
    bool line(int gc, AW_pos x0, AW_pos y0, AW_pos x1, AW_pos y1, AW_bitset filteri = AW_ALL_DEVICES_SCALED) {
        return line_impl(gc, AW::LineVector(x0, y0, x1, y1), filteri);
    }

    bool text(int                 gc,
              const SizedCstr&    cstr,
              const AW::Position& pos,
              AW_pos              alignment   = 0.0, // 0.0 alignment left 0.5 centered 1.0 right justified
              AW_bitset           filteri     = AW_ALL_DEVICES_UNSCALED)
    {
        return text_impl(gc, cstr, pos, alignment, filteri);
    }
    bool text(int                  gc,
              const char          *str,
              const AW::Position&  pos,
              AW_pos               alignment  = 0.0, // 0.0 alignment left 0.5 centered 1.0 right justified
              AW_bitset            filteri    = AW_ALL_DEVICES_UNSCALED)
    {
        return text_impl(gc, SizedCstr(str), pos, alignment, filteri);
    }

    bool text(int         gc,
              const char *str,
              AW_pos      x,
              AW_pos      y,
              AW_pos      alignment  = 0.0, // 0.0 alignment left 0.5 centered 1.0 right justified
              AW_bitset   filteri    = AW_ALL_DEVICES_UNSCALED)
    {
        return text_impl(gc, SizedCstr(str), AW::Position(x, y), alignment, filteri);
    }

    bool invisible(const AW::Position& pos, AW_bitset filteri = AW_ALL_DEVICES_SCALED) {
        return invisible_impl(pos, filteri);
    }

    bool box(int gc, AW::FillStyle filled, const AW::Rectangle& rect, AW_bitset filteri = AW_ALL_DEVICES_SCALED) {
        return box_impl(gc, filled, rect, filteri);
    }
    bool box(int gc, AW::FillStyle filled, const AW::Position& pos, const AW::Vector& size, AW_bitset filteri = AW_ALL_DEVICES_SCALED) {
        return box_impl(gc, filled, AW::Rectangle(pos, size), filteri);
    }
    bool box(int gc, AW::FillStyle filled, AW_pos x0, AW_pos y0, AW_pos width, AW_pos height, AW_bitset filteri = AW_ALL_DEVICES_SCALED) {
        return box_impl(gc, filled, AW::Rectangle(AW::Position(x0, y0), AW::Vector(width, height)), filteri);
    }

    bool circle(int gc, AW::FillStyle filled, const AW::Position& center, const AW::Vector& radius, AW_bitset filteri = AW_ALL_DEVICES_SCALED) {
        return circle_impl(gc, filled, center, radius, filteri);
    }
    bool circle(int gc, AW::FillStyle filled, AW_pos x0, AW_pos y0, AW_pos xradius, AW_pos yradius, AW_bitset filteri = AW_ALL_DEVICES_SCALED)  {
        return circle_impl(gc, filled, AW::Position(x0, y0), AW::Vector(xradius, yradius), filteri);
    }
    bool circle(int gc, AW::FillStyle filled, const AW::Rectangle& rect, AW_bitset filteri = AW_ALL_DEVICES_SCALED) {
        // draw ellipse into Rectangle
        return circle_impl(gc, filled, rect.centroid(), AW::Vector(rect.width()/2, rect.height()/2), filteri);
    }

    // draw arcs (Note: passed degrees are non-standard: 90 degrees = downwards)
    bool arc(int gc, AW::FillStyle filled, AW_pos x0, AW_pos y0, AW_pos xradius, AW_pos yradius, int start_degrees, int arc_degrees, AW_bitset filteri = AW_ALL_DEVICES_SCALED)  {
        return arc_impl(gc, filled, AW::Position(x0, y0), AW::Vector(xradius, yradius), start_degrees, arc_degrees, filteri);
    }
    bool arc(int gc, AW::FillStyle filled, const AW::Position& pos, const AW::Vector& radius, int start_degrees, int arc_degrees, AW_bitset filteri = AW_ALL_DEVICES_SCALED) {
        return arc_impl(gc, filled, pos, radius, start_degrees, arc_degrees, filteri);
    }

    bool polygon(int gc, AW::FillStyle filled, int npoints, const AW_pos *points, AW_bitset filteri = AW_ALL_DEVICES_SCALED)  {
        AW::Position *pos = new AW::Position[npoints];
        for (int n = 0; n<npoints; ++n) {
            pos[n].setx(points[n*2]);
            pos[n].sety(points[n*2+1]);
        }
        bool result = polygon_impl(gc, filled, npoints, pos, filteri);
        delete [] pos;
        return result;
    }
    bool polygon(int gc, AW::FillStyle filled, int npos, const AW::Position *pos, AW_bitset filteri = AW_ALL_DEVICES_SCALED)  {
        return polygon_impl(gc, filled, npos, pos, filteri);
    }

    bool text_overlay(int gc, const SizedCstr& cstr, const AW::Position& pos, AW_pos alignment, AW_bitset filteri, TextOverlayCallback toc, AW_CL cduser = 0);

    // ********* X11 Device only ********
    virtual void clear(AW_bitset filteri);
    virtual void clear_part(const AW::Rectangle& rect, AW_bitset filteri);

    void clear_part(AW_pos x, AW_pos y, AW_pos width, AW_pos height, AW_bitset filteri) {
        clear_part(AW::Rectangle(AW::Position(x, y), AW::Vector(width, height)), filteri);
    }

    virtual void move_region(AW_pos src_x, AW_pos src_y, AW_pos width, AW_pos height, AW_pos dest_x, AW_pos dest_y);
    virtual void fast();                                         // e.g. zoom linewidth off
    virtual void slow();
    virtual void flush();                                        // empty X11 buffers
};
MARK_NONFINAL_METHOD(AW_device,move_region,(AW_pos,AW_pos,AW_pos,AW_pos,AW_pos,AW_pos));
MARK_NONFINAL_METHOD(AW_device,clear,(AW_bitset));
MARK_NONFINAL_METHOD(AW_device,clear_part,(const AW::Rectangle&,AW_bitset));
MARK_NONFINAL_METHOD(AW_device,flush,());

inline void AW_click_cd::link() {
    previous            = my_device->click_cd;
    my_device->click_cd = this;
}
inline AW_click_cd::~AW_click_cd() { my_device->click_cd = previous; }
inline void AW_click_cd::disable() { my_device->click_cd = NULp; }
inline void AW_click_cd::enable() { my_device->click_cd = this; }

class AW_device_print FINAL_TYPE : public AW_device { // derived from a Noncopyable
    FILE          *xfig;
    class SPOOLER *spooler;
    bool           color_mode;

    bool line_impl(int gc, const AW::LineVector& Line, AW_bitset filteri) OVERRIDE;
    bool text_impl(int gc, const SizedCstr& cstr, const AW::Position& pos, AW_pos alignment, AW_bitset filteri) OVERRIDE;
    bool box_impl(int gc, AW::FillStyle filled, const AW::Rectangle& rect, AW_bitset filteri) OVERRIDE;
    bool circle_impl(int gc, AW::FillStyle filled, const AW::Position& center, const AW::Vector& radius, AW_bitset filteri) OVERRIDE;
    bool arc_impl(int gc, AW::FillStyle filled, const AW::Position& center, const AW::Vector& radius, int start_degrees, int arc_degrees, AW_bitset filteri) OVERRIDE;
    bool polygon_impl(int gc, AW::FillStyle filled, int npos, const AW::Position *pos, AW_bitset filteri) OVERRIDE;
    bool invisible_impl(const AW::Position& pos, AW_bitset filteri) OVERRIDE;

    void specific_reset() {}

    int find_color_idx(AW_rgb color);

    AW_device::Fill_Style detectFillstyleForGreylevel(int gc, AW::FillStyle filled);
    int calcAreaFill(AW_device::Fill_Style fillStyle, AW_grey_level grey_level);

    friend class SPOOLER;

public:
    AW_device_print(AW_common *common_) :
        AW_device(common_),
        xfig(NULp),
        spooler(NULp),
        color_mode(false)
    {}

    GB_ERROR open(const char *path) __ATTR__USERESULT;
    void close();

    void set_color_mode(bool mode) { color_mode = mode; }

    // AW_device interface:
    AW_DEVICE_TYPE type();

    // internal (do not use):
    void draw_text(int gc, const char *textBuffer, size_t textStart, size_t textLen, const AW::Position& pos);
};

class AW_simple_device : public AW_device {
    bool box_impl(int gc, AW::FillStyle /*filled*/, const AW::Rectangle& rect, AW_bitset filteri) OVERRIDE {
        return generic_box(gc, rect, filteri);
    }
    bool polygon_impl(int gc, AW::FillStyle /*filled*/, int npos, const AW::Position *pos, AW_bitset filteri) OVERRIDE {
        return generic_polygon(gc, npos, pos, filteri);
    }
    bool circle_impl(int gc, AW::FillStyle /*filled*/, const AW::Position& center, const AW::Vector& radius, AW_bitset filteri) OVERRIDE {
        return generic_circle(gc, center, radius, filteri);
    }
    bool arc_impl(int gc, AW::FillStyle /*filled*/, const AW::Position& center, const AW::Vector& radius, int /*start_degrees*/, int /*arc_degrees*/, AW_bitset filteri) OVERRIDE {
        return generic_circle(gc, center, radius, filteri);
    }
public:
    AW_simple_device(AW_common *common_) : AW_device(common_) {}
};

class AW_size_tracker {
    bool     drawn;
    AW_world size;

    void extend(AW_pos& low, AW_pos val, AW_pos& high) {
        low = std::min(low, val);
        high = std::max(high, val);
    }
public:
    AW_size_tracker() { restart(); }

    void restart() { drawn = false; size.clear(); }
    void track(const AW::Position& pos) {
        if (drawn) {
            extend(size.l, pos.xpos(), size.r);
            extend(size.t, pos.ypos(), size.b);
        }
        else {
            size.l = size.r = pos.xpos();
            size.t = size.b = pos.ypos();
            drawn  = true;
        }
    }

    bool was_drawn() const { return drawn; }
    const AW_world& get_size() const { return size; }
    AW::Rectangle get_size_as_Rectangle() const {
        return AW::Rectangle(AW::Position(size.l, size.t), AW::Position(size.r, size.b));
    }
};

class AW_device_size : public AW_simple_device {
    AW_size_tracker scaled;   // all zoomable parts (e.g. tree skeleton)
    AW_size_tracker unscaled; // all unzoomable parts (e.g. text at tree-tips or group-brackets)

    void dot_transformed(const AW::Position& pos, AW_bitset filteri);
    void dot_transformed(AW_pos X, AW_pos Y, AW_bitset filteri) { dot_transformed(AW::Position(X, Y), filteri); }

    void dot(const AW::Position& p, AW_bitset filteri) { dot_transformed(transform(p), filteri); }
    void dot(AW_pos x, AW_pos y, AW_bitset filteri) { dot(AW::Position(x, y), filteri); }

    bool line_impl(int gc, const AW::LineVector& Line, AW_bitset filteri) OVERRIDE;
    bool text_impl(int gc, const SizedCstr& cstr, const AW::Position& pos, AW_pos alignment, AW_bitset filteri) OVERRIDE;
    bool invisible_impl(const AW::Position& pos, AW_bitset filteri) OVERRIDE;

    void specific_reset();

public:
    AW_device_size(AW_common *common_) : AW_simple_device(common_) {}

    void restart_tracking();

    AW_DEVICE_TYPE type();

    // all get_size_information...() return screen coordinates

    void get_size_information(AW_world *ptr) const __ATTR__DEPRECATED_TODO("whole AW_world is deprecated") {
        *ptr = scaled.get_size();
    }
    AW::Rectangle get_size_information() const { return scaled.get_size_as_Rectangle(); }
    AW::Rectangle get_size_information_unscaled() const { return unscaled.get_size_as_Rectangle(); }
    AW::Rectangle get_size_information_inclusive_text() const {
        return get_size_information().bounding_box(get_size_information_unscaled());
    }

    AW_borders get_unscaleable_overlap() const;
};

#else
#error aw_device.hxx included twice
#endif