Reorganized code to allow compilation with Fl_Device, Fl_Display but without Fl_Abstract_Printer

(may be useful for embarked devices)

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@7330 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

7 files changed, 329 insertions, 155 deletions

diff --git a/src/Fl_Abstract_Printer.cxx b/src/Fl_Abstract_Printer.cxx
new file mode 100644
index 000000000..404f52ae7
--- /dev/null
+++ b/src/Fl_Abstract_Printer.cxx
@@ -0,0 +1,297 @@
+//
+// "$Id$"
+//
+// implementation of Fl_Abstract_Printer class for the Fast Light Tool Kit (FLTK).
+//
+// Copyright 2010 by Bill Spitzak and others.
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
+//
+// This library 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
+// Library General Public License for more details.
+//
+// You should have received a copy of the GNU Library General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+// USA.
+//
+// Please report all bugs and problems to:
+//
+//     http://www.fltk.org/str.php
+//
+/** \file Fl_Abstract_Printer.cxx
+ \brief implementation of class Fl_Abstract_Printer.
+ */
+
+#include <FL/Fl.H>
+#include <FL/Fl_Printer.H>
+
+/**
+ @brief Draws the widget on the printed page.
+ *
+ The widget's position on the printed page is determined by the last call to origin()
+ and by the optional delta_x and delta_y arguments.
+ Its dimensions are in points unless there was a previous call to scale().
+ <br>Under MSWindows and X11, Fl_RGB_Image's are printed without transparency.
+ A workaround is to use the print_window_part() call. 
+ @param[in] widget Any FLTK widget (e.g., standard, custom, window).
+ @param[in] delta_x Optional horizontal offset for positioning the widget relatively
+ to the current origin of graphics functions.
+ @param[in] delta_y Same as above, vertically.
+ */
+void Fl_Abstract_Printer::print_widget(Fl_Widget* widget, int delta_x, int delta_y) 
+{ 
+  int old_x, old_y, new_x, new_y, is_window;
+  if ( ! widget->visible() ) return;
+  is_window = (widget->as_window() != NULL);
+  widget->damage(FL_DAMAGE_ALL);
+  // set origin to the desired top-left position of the widget
+  origin(&old_x, &old_y);
+  new_x = old_x + delta_x;
+  new_y = old_y + delta_y;
+  if (!is_window) {
+    new_x -= widget->x();
+    new_y -= widget->y();
+  }
+  if (new_x != old_x || new_y != old_y) {
+    translate(new_x - old_x, new_y - old_y );
+  }
+  // if widget is a window, clip all drawings to the window area
+  if (is_window) fl_push_clip(0, 0, widget->w(), widget->h() );
+  // we do some trickery to recognize OpenGL windows and draw them via a plugin
+  int drawn_by_plugin = 0;
+  if (widget->as_gl_window()) {
+    Fl_Plugin_Manager pm("fltk:device");  
+    Fl_Device_Plugin *pi = (Fl_Device_Plugin*)pm.plugin("opengl.device.fltk.org");
+    if (pi) drawn_by_plugin = pi->print(this, widget, 0, 0);
+  }
+  if (!drawn_by_plugin) {
+    widget->draw();
+  }
+  if (is_window) fl_pop_clip();
+  // find subwindows of widget and print them
+  traverse(widget);
+  // reset origin to where it was
+  if (new_x != old_x || new_y != old_y) {
+    untranslate();
+  }
+}
+
+
+void Fl_Abstract_Printer::traverse(Fl_Widget *widget)
+{
+  Fl_Group *g = widget->as_group();
+  if (!g) return;
+  int n = g->children();
+  for (int i = 0; i < n; i++) {
+    Fl_Widget *c = g->child(i);
+    if ( !c->visible() ) continue;
+    if ( c->as_window() ) {
+      print_widget(c, c->x(), c->y());
+    }
+    else traverse(c);
+  }
+}
+
+/**
+ @brief Computes the page coordinates of the current origin of graphics functions.
+ *
+ @param[out] x If non-null, *x is set to the horizontal page offset of graphics origin.
+ @param[out] y Same as above, vertically.
+ */
+void Fl_Abstract_Printer::origin(int *x, int *y)
+{
+  if (x) *x = x_offset;
+  if (y) *y = y_offset;
+}
+
+/**
+ @brief Prints a rectangular part of an on-screen window.
+ *
+ @param win The window from where to capture.
+ @param x The rectangle left
+ @param y The rectangle top
+ @param w The rectangle width
+ @param h The rectangle height
+ @param delta_x Optional horizontal offset from current graphics origin where to print the captured rectangle.
+ @param delta_y As above, vertically.
+ */
+void Fl_Abstract_Printer::print_window_part(Fl_Window *win, int x, int y, int w, int h, int delta_x, int delta_y)
+{
+  int slice, width, offset, count = 0;
+  Fl_Device::display_device()->set_current();
+  Fl_Window *save_front = Fl::first_window();
+  win->show();
+  fl_gc = NULL;
+  Fl::check();
+  win->make_current();
+  uchar *image_data[20];
+#ifdef WIN32 // because of bug in StretchDIBits, vertically cut image in pieces of width slice
+  slice = 500;
+#else
+  slice = w;
+#endif
+  for ( offset = 0; offset < w; offset += slice) {
+    width = slice; 
+    if (offset + width > w) width = w - offset;
+    image_data[count++] = fl_read_image(NULL, x + offset, y, width, h);
+  }  
+  save_front->show();
+  this->set_current();
+  for ( int i = 0, offset = 0; i < count; i++, offset += slice) {
+    width = slice; 
+    if (offset + width > w) width = w - offset;
+    fl_draw_image(image_data[i], delta_x + offset, delta_y, width, h, 3);
+#ifdef __APPLE__
+    add_image(NULL, image_data[i]);
+#else
+    delete image_data[i];
+#endif
+  }
+}
+
+#ifdef __APPLE__
+void Fl_Abstract_Printer::add_image(Fl_Image *image, const uchar *data)
+{
+  struct chain_elt *elt =  (struct chain_elt *)calloc(sizeof(struct chain_elt), 1);
+  elt->image = image;
+  elt->data = data;
+  if (image_list_) { elt->next = image_list_; }
+  image_list_ = elt;
+}
+
+void Fl_Abstract_Printer::delete_image_list()
+{
+  while(image_list_) {
+    struct chain_elt *next = image_list_->next;
+    if(image_list_->image) delete image_list_->image;
+    if (image_list_->data) delete (uchar*) image_list_->data; // msvc6 compilation fix
+    free(image_list_);
+    image_list_ = next;
+  }
+}
+#endif
+
+Fl_Device *Fl_Abstract_Printer::set_current(void)
+{
+#ifdef __APPLE__
+  fl_gc = (CGContextRef)gc;
+#elif defined(WIN32)
+  fl_gc = (HDC)gc;
+#else
+  fl_gc = (_XGC*)gc;
+#endif
+  return this->Fl_Device::set_current();
+}
+
+
+/**
+ @brief Starts a print job.
+ *
+ @param[in] pagecount the total number of pages of the job
+ @param[out] frompage if non-null, *frompage is set to the first page the user wants printed
+ @param[out] topage if non-null, *topage is set to the last page the user wants printed
+ @return 0 iff OK
+ */
+int Fl_Abstract_Printer::start_job(int pagecount, int *frompage, int *topage) {return 1;}
+
+/**
+ @brief Starts a new printed page
+ *
+ The page coordinates are initially in points, i.e., 1/72 inch, 
+ and with origin at the top left of the printable page area.
+ @return 0 iff OK
+ */
+int Fl_Abstract_Printer::start_page (void) {return 1;}
+
+/**
+ @brief Computes the width and height of the printable area of the page.
+ *
+ Values are in the same unit as that used by FLTK drawing functions,
+ are unchanged by calls to origin(), but are changed by scale() calls.
+ Values account for the user-selected paper type and print orientation.
+ @return 0 iff OK.
+ */
+int Fl_Abstract_Printer::printable_rect(int *w, int *h) {return 1;}
+
+/**
+ @brief Computes the dimensions of margins that lie between the printable page area and
+ the full page.
+ *
+ Values are in the same unit as that used by FLTK drawing functions. They are changed
+ by scale() calls.
+ @param[out] left If non-null, *left is set to the left margin size.
+ @param[out] top If non-null, *top is set to the top margin size.
+ @param[out] right If non-null, *right is set to the right margin size.
+ @param[out] bottom If non-null, *bottom is set to the bottom margin size.
+ */
+void Fl_Abstract_Printer::margins(int *left, int *top, int *right, int *bottom) {}
+
+/**
+ @brief Sets the position in page coordinates of the origin of graphics functions.
+ *
+ Arguments should be expressed relatively to the result of a previous printable_rect() call.
+ That is, <tt>printable_rect(&w, &h); origin(w/2, 0);</tt> sets the graphics origin at the
+ top center of the page printable area.
+ Origin() calls are not affected by rotate() calls.
+ Successive origin() calls don't combine their effects.
+ @param[in] x Horizontal position in page coordinates of the desired origin of graphics functions.
+ @param[in] y Same as above, vertically.
+ */
+void Fl_Abstract_Printer::origin(int x, int y) {}
+
+/**
+ @brief Changes the scaling of page coordinates.
+ *
+ This function also resets the origin of graphics functions at top left of printable page area.
+ After a scale() call, do a printable_rect() call to get the new dimensions of the printable page area.
+ Successive scale() calls don't combine their effects.
+ @param scale_x Horizontal dimensions of plot are multiplied by this quantity.
+ @param scale_y Same as above, vertically.
+ */
+void Fl_Abstract_Printer::scale (float scale_x, float scale_y) {}
+
+/**
+ @brief Rotates the graphics operations relatively to paper.
+ *
+ The rotation is centered on the current graphics origin. Successive rotate() calls don't combine their effects.
+ On MSWindows, Fl_RGB_Image's don't rotate well; print_window_part() is an efficient workaround.
+ @param angle Rotation angle in counterclockwise degrees.
+ */
+void Fl_Abstract_Printer::rotate(float angle) {}
+
+/**
+ @brief To be called at the end of each page.
+ *
+ @return 0 iff OK.
+ */
+int Fl_Abstract_Printer::end_page (void) {return 1;}
+
+/**
+ @brief To be called at the end of a print job.
+ */
+void Fl_Abstract_Printer::end_job (void) {}
+
+/**
+ @brief Translates the current graphics origin accounting for the current rotation.
+ *
+ This function is only useful after a rotate() call. 
+ Each translate() call must be matched by an untranslate() call.
+ Successive translate() calls add up their effects.
+ */
+void Fl_Abstract_Printer::translate(int x, int y) {}
+
+/**
+ @brief Undoes the effect of a previous translate() call.
+ */
+void Fl_Abstract_Printer::untranslate(void) {}
+
+//
+// End of "$Id$".
+//
+
diff --git a/src/Fl_Bitmap.cxx b/src/Fl_Bitmap.cxx
index ecb126d6a..c07f4e23f 100644
--- a/src/Fl_Bitmap.cxx
+++ b/src/Fl_Bitmap.cxx
@@ -37,7 +37,6 @@
 #include <FL/Fl_Widget.H>
 #include <FL/Fl_Menu_Item.H>
 #include <FL/Fl_Bitmap.H>
-#include <FL/Fl_Printer.H>
 #include "flstring.h"
 
 #if defined(__APPLE_QUARTZ__)
@@ -266,7 +265,7 @@ Fl_Bitmask fl_create_alphamask(int w, int h, int d, int ld, const uchar *array)
 
 void Fl_Bitmap::draw(int XP, int YP, int WP, int HP, int cx, int cy) {
   if(fl_device->type() == Fl_Device::postscript_device) {
-    ((Fl_Abstract_Printer*)fl_device)->draw(this, XP, YP, WP, HP, cx, cy);
+    fl_device->draw(this, XP, YP, WP, HP, cx, cy);
     return;
   }
   if (!array) {
diff --git a/src/Fl_Device.cxx b/src/Fl_Device.cxx
index 82e8b7b56..1fe885928 100644
--- a/src/Fl_Device.cxx
+++ b/src/Fl_Device.cxx
@@ -1,7 +1,7 @@
 //
 // "$Id$"
 //
-// implementation of Fl_Device and Fl_Abstract_Printer classes for the Fast Light Tool Kit (FLTK).
+// implementation of Fl_Device class for the Fast Light Tool Kit (FLTK).
 //
 // Copyright 2010 by Bill Spitzak and others.
 //
@@ -27,166 +27,44 @@
 
 #include <FL/Fl.H>
 #include <FL/Fl_Device.H>
-#include <FL/Fl_Printer.H>
-#include <FL/fl_draw.H>
+//#include <FL/fl_draw.H>
 #include <FL/Fl_Image.H>
 
-extern Fl_Device *fl_device;
-
+/** \brief Draws an Fl_RGB_Image object to the device. 
+ *
+ Specifies a bounding box for the image, with the origin (upper left-hand corner) of 
+ the image offset by the cx and cy arguments.
+ */
 void Fl_Device::draw(Fl_Pixmap *pxm,int XP, int YP, int WP, int HP, int cx, int cy)
 {
-  // presently, never gets called
+  pxm->draw(XP, YP, WP, HP, cx, cy);
 }
 
+/** \brief Draws an Fl_Bitmap object to the device. 
+ *
+ Specifies a bounding box for the image, with the origin (upper left-hand corner) of 
+ the image offset by the cx and cy arguments.
+ */
 void Fl_Device::draw(Fl_Bitmap *bm,int XP, int YP, int WP, int HP, int cx, int cy)
 {
-  // presently, never gets called
+  bm->draw(XP, YP, WP, HP, cx, cy);
 }
 
+/** \brief Draws an Fl_Pixmap object to the device. 
+ *
+ Specifies a bounding box for the image, with the origin (upper left-hand corner) of 
+ the image offset by the cx and cy arguments.
+ */
 void Fl_Device::draw(Fl_RGB_Image *rgb,int XP, int YP, int WP, int HP, int cx, int cy)
 {
-  // presently, never gets called
-}
-
-void Fl_Abstract_Printer::print_widget(Fl_Widget* widget, int delta_x, int delta_y) 
-{ 
-  int old_x, old_y, new_x, new_y, is_window;
-  if ( ! widget->visible() ) return;
-  is_window = (widget->as_window() != NULL);
-  widget->damage(FL_DAMAGE_ALL);
-  // set origin to the desired top-left position of the widget
-  origin(&old_x, &old_y);
-  new_x = old_x + delta_x;
-  new_y = old_y + delta_y;
-  if (!is_window) {
-    new_x -= widget->x();
-    new_y -= widget->y();
-  }
-  if (new_x != old_x || new_y != old_y) {
-    translate(new_x - old_x, new_y - old_y );
-  }
-  // if widget is a window, clip all drawings to the window area
-  if (is_window) fl_push_clip(0, 0, widget->w(), widget->h() );
-  // we do some trickery to recognize OpenGL windows and draw them via a plugin
-  int drawn_by_plugin = 0;
-  if (widget->as_gl_window()) {
-    Fl_Plugin_Manager pm("fltk:device");  
-    Fl_Device_Plugin *pi = (Fl_Device_Plugin*)pm.plugin("opengl.device.fltk.org");
-    if (pi) drawn_by_plugin = pi->print(this, widget, 0, 0);
-  }
-  if (!drawn_by_plugin) {
-    widget->draw();
-  }
-  if (is_window) fl_pop_clip();
-  // find subwindows of widget and print them
-  traverse(widget);
-  // reset origin to where it was
-  if (new_x != old_x || new_y != old_y) {
-    untranslate();
-  }
-}
-
-
-void Fl_Abstract_Printer::traverse(Fl_Widget *widget)
-{
-  Fl_Group *g = widget->as_group();
-  if (!g) return;
-  int n = g->children();
-  for (int i = 0; i < n; i++) {
-    Fl_Widget *c = g->child(i);
-    if ( !c->visible() ) continue;
-    if ( c->as_window() ) {
-      print_widget(c, c->x(), c->y());
-    }
-    else traverse(c);
-  }
-}
-
-void Fl_Abstract_Printer::origin(int *x, int *y)
-{
-  if (x) *x = x_offset;
-  if (y) *y = y_offset;
-}
-
-void Fl_Abstract_Printer::print_window_part(Fl_Window *win, int x, int y, int w, int h, int delta_x, int delta_y)
-{
-  int slice, width, offset, count = 0;
-  Fl_Device::display_device()->set_current();
-  Fl_Window *save_front = Fl::first_window();
-  win->show();
-  fl_gc = NULL;
-  Fl::check();
-  win->make_current();
-  uchar *image_data[20];
-#ifdef WIN32 // because of bug in StretchDIBits, vertically cut image in pieces of width slice
-  slice = 500;
-#else
-  slice = w;
-#endif
-  for ( offset = 0; offset < w; offset += slice) {
-    width = slice; 
-    if (offset + width > w) width = w - offset;
-    image_data[count++] = fl_read_image(NULL, x + offset, y, width, h);
-    }  
-  save_front->show();
-  this->set_current();
-  for ( int i = 0, offset = 0; i < count; i++, offset += slice) {
-    width = slice; 
-    if (offset + width > w) width = w - offset;
-    fl_draw_image(image_data[i], delta_x + offset, delta_y, width, h, 3);
-#ifdef __APPLE__
-    add_image(NULL, image_data[i]);
-#else
-    delete image_data[i];
-#endif
-  }
-}
-
-void Fl_Abstract_Printer::add_image(Fl_Image *image, const uchar *data)
-{
-  struct chain_elt *elt =  (struct chain_elt *)calloc(sizeof(struct chain_elt), 1);
-  elt->image = image;
-  elt->data = data;
-  if (image_list_) { elt->next = image_list_; }
-  image_list_ = elt;
-}
-
-void Fl_Abstract_Printer::delete_image_list()
-{
-  while(image_list_) {
-    struct chain_elt *next = image_list_->next;
-    if(image_list_->image) delete image_list_->image;
-    if (image_list_->data) delete (uchar*) image_list_->data; // msvc6 compilation fix
-    free(image_list_);
-    image_list_ = next;
-  }
-}
-
-Fl_Device *Fl_Abstract_Printer::set_current(void)
-{
-#ifdef __APPLE__
-  fl_gc = (CGContextRef)gc;
-#elif defined(WIN32)
-  fl_gc = (HDC)gc;
-#else
-  fl_gc = (_XGC*)gc;
-#endif
-  return this->Fl_Device::set_current();
+  rgb->draw(XP, YP, WP, HP, cx, cy);
 }
 
-
-int Fl_Abstract_Printer::start_job(int pagecount, int *frompage, int *topage) {return 1;}
-int Fl_Abstract_Printer::start_page (void) {return 1;}
-int Fl_Abstract_Printer::printable_rect(int *w, int *h) {return 1;}
-void Fl_Abstract_Printer::margins(int *left, int *top, int *right, int *bottom) {}
-void Fl_Abstract_Printer::origin(int x, int y) {}
-void Fl_Abstract_Printer::scale (float scale_x, float scale_y) {}
-void Fl_Abstract_Printer::rotate(float angle) {}
-int Fl_Abstract_Printer::end_page (void) {return 1;}
-void Fl_Abstract_Printer::end_job (void) {}
-void Fl_Abstract_Printer::translate(int x, int y) {}
-void Fl_Abstract_Printer::untranslate(void) {}
-
+/**
+ @brief Sets this device (display, printer, local file) as the target of future graphics calls.
+ *
+ @return  The current target device of graphics calls.
+ */
 Fl_Device *Fl_Device::set_current(void)
 {
   Fl_Device *current = fl_device;
@@ -194,6 +72,9 @@ Fl_Device *Fl_Device::set_current(void)
   return current;
 }
 
+/**
+ @brief    Returns the current target device of graphics calls.
+ */
 Fl_Device *Fl_Device::current(void)
 {
   return fl_device;
diff --git a/src/Fl_GDI_Printer.cxx b/src/Fl_GDI_Printer.cxx
index 6717a3803..8dd83a8b4 100644
--- a/src/Fl_GDI_Printer.cxx
+++ b/src/Fl_GDI_Printer.cxx
@@ -234,7 +234,6 @@ int Fl_Printer::end_page (void)
       rsult = 1;
     }
   }
-  delete_image_list();
   gc = NULL;
   return rsult;
 }
diff --git a/src/Fl_Image.cxx b/src/Fl_Image.cxx
index e5a16ab51..cc544efd3 100644
--- a/src/Fl_Image.cxx
+++ b/src/Fl_Image.cxx
@@ -31,7 +31,6 @@
 #include <FL/Fl_Widget.H>
 #include <FL/Fl_Menu_Item.H>
 #include <FL/Fl_Image.H>
-#include <FL/Fl_Printer.H>
 #include "flstring.h"
 
 #ifdef WIN32
@@ -436,7 +435,7 @@ static void alpha_blend(Fl_RGB_Image *img, int X, int Y, int W, int H, int cx, i
 
 void Fl_RGB_Image::draw(int XP, int YP, int WP, int HP, int cx, int cy) {
   if(fl_device->type() == Fl_Device::postscript_device) {
-    ((Fl_Abstract_Printer*)fl_device)->draw(this, XP, YP, WP, HP, cx, cy);
+    fl_device->draw(this, XP, YP, WP, HP, cx, cy);
     return;
   }
   // Don't draw an empty image...
diff --git a/src/Fl_PS_Printer.cxx b/src/Fl_PS_Printer.cxx
index 9963b1193..c776e70b8 100644
--- a/src/Fl_PS_Printer.cxx
+++ b/src/Fl_PS_Printer.cxx
@@ -68,7 +68,7 @@ const Fl_PSfile_Device::page_format Fl_PSfile_Device::page_formats[NO_PAGE_FORMA
   { 127,  181, "B9"},
   {  91,  127, "B10"},
 
-  // others (look at Fl_Printer.H} //
+  // others
   { 459,  649, "EnvC5"}, // envelope
   { 312,  624, "EnvDL"}, // envelope
   { 522,  756, "Executive"},
diff --git a/src/Fl_Pixmap.cxx b/src/Fl_Pixmap.cxx
index 02f047b26..eb030c615 100644
--- a/src/Fl_Pixmap.cxx
+++ b/src/Fl_Pixmap.cxx
@@ -47,7 +47,6 @@
 #include <FL/Fl_Widget.H>
 #include <FL/Fl_Menu_Item.H>
 #include <FL/Fl_Pixmap.H>
-#include <FL/Fl_Printer.H>
 
 #include <stdio.h>
 #include "flstring.h"
@@ -76,7 +75,7 @@ void Fl_Pixmap::measure() {
 
 void Fl_Pixmap::draw(int XP, int YP, int WP, int HP, int cx, int cy) {
   if(fl_device->type() == Fl_Device::postscript_device) {
-    ((Fl_Abstract_Printer*)fl_device)->draw(this, XP, YP, WP, HP, cx, cy);
+    fl_device->draw(this, XP, YP, WP, HP, cx, cy);
     return;
     }
   // ignore empty or bad pixmap data: