src/PrinterParams.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *          LyX, The Document Processor
   6  *
   7  *          Copyright 1995 Matthias Ettrich
   8  *          Copyright 1995-2000 The LyX Team
   9  *
  10  *          This file Copyright 1999-2000
  11  *          Allan Rae
  12  *======================================================
  13  */
  14
  15 #ifndef PRINTERPARAMS_H
  16 #define PRINTERPARAMS_H
  17
  18 #ifndef LYXRC_H
  19 #error You must include lyxrc.h before PrinterParams.h
  20 #endif
  21
  22 #ifdef ENABLE_ASSERTIONS
  23 #include "support/LAssert.h"
  24 extern bool containsOnly(string const &, char const *);
  25 #endif
  26
  27
  28 /**
  29   This struct contains (or should contain) all the parameters required for
  30   printing a buffer.  Some work still needs to be done on this struct and
  31   printing handling in general to make it nice and full-featured.
  32   The main things I'd like to add now is the ability to print a read-only
  33   document with different orientation, papersize or single/duplex state
  34   than the document's settings. ARRae 20000423
  35 */
  36 struct PrinterParams {
  37         ///
  38         enum Target {
  39                 ///
  40                 PRINTER,
  41                 ///
  42                 FILE
  43         };
  44         ///
  45         Target target;
  46         ///
  47         string printer_name;
  48         ///
  49         string file_name;
  50         /// We allow printing of even pages in a range and so on.
  51         enum WhichPages{
  52                 ///
  53                 ALL,
  54                 ///
  55                 ODD,
  56                 ///
  57                 EVEN
  58         };
  59         ///
  60         WhichPages which_pages;
  61         /** Print a page range. Both from_page and to_page used to be strings
  62             because they're actually easier to work with that way.  I've
  63             switched to_page to be an int.  However, from_page will remain a
  64             string because I want the from_page field to be able to be used as
  65             a page range "1,3-5" and so on.
  66             I've modified the invariant test to match. ARRae 20000518
  67          */
  68         string from_page;
  69         ///
  70         int to_page;
  71         ///
  72         bool reverse_order;
  73         ///
  74         bool unsorted_copies;
  75         ///
  76         int count_copies;
  77         // The settings below should allow us to print any read-only doc in
  78         // whatever size/orientation we want it -- overriding the documents
  79         // settings.
  80         // Override the documents orientation
  81         // bool orientation;
  82         // Print n pages per physical sheet
  83         // unsigned int nup;
  84         // Override document settings for duplex.
  85         // bool duplex;
  86
  87         ///
  88         PrinterParams(Target const & t = PRINTER,
  89                       string const & pname = lyxrc.printer,
  90                       string const & fname = string(),
  91                       WhichPages const wp = ALL,
  92                       string const & from = string(),
  93                       int const & to = 0,
  94                       bool const reversed = false,
  95                       bool const unsorted = false,
  96                       int const & num_copies = 1)
  97                 : target(t),
  98                   printer_name(pname),
  99                   file_name(fname),
 100                   which_pages(wp),
 101                   from_page(from),
 102                   to_page(to),
 103                   reverse_order(reversed),
 104                   unsorted_copies(unsorted),
 105                   count_copies(num_copies)
 106                 {
 107                         testInvariant();
 108                 }
 109         ///
 110         PrinterParams(PrinterParams const & pp)
 111                 : target(pp.target),
 112                   printer_name(pp.printer_name),
 113                   file_name(pp.file_name),
 114                   which_pages(pp.which_pages),
 115                   from_page(pp.from_page),
 116                   to_page(pp.to_page),
 117                   reverse_order(pp.reverse_order),
 118                   unsorted_copies(pp.unsorted_copies),
 119                   count_copies(pp.count_copies)
 120                 {
 121                         testInvariant();
 122                 }
 123
 124 // do we need these?
 125 //      friend bool operator==(PrinterParams const &, PrinterParams const &);
 126 //      friend bool operator<(PrinterParams const &, PrinterParams const &);
 127
 128         /** Test that all the fields contain valid entries.  It's unlikely
 129             that the internal code will get this wrong (at least for the
 130             xforms code anyway) however new ports and external scripts
 131             might drive the wrong values in.
 132          */
 133         void testInvariant() const
 134                 {
 135 #ifdef ENABLE_ASSERTIONS
 136                         if (!from_page.empty()) {
 137                                 // Assert(from_page == number or empty)
 138                                 Assert(containsOnly(from_page, "1234567890"));
 139                         }
 140                         if (to_page) {
 141                                 // Assert(to_page == empty
 142                                 //        or number iff from_page set)
 143                                 Assert(!from_page.empty());
 144                         }
 145                         switch (target) {
 146                         case PRINTER:
 147 //                              Assert(!printer_name.empty());
 148                                 break;
 149                         case FILE:
 150                                 Assert(!file_name.empty());
 151                                 break;
 152                         default:
 153                                 Assert(false);
 154                                 break;
 155                         }
 156                         switch (which_pages) {
 157                         case ALL:
 158                         case ODD:
 159                         case EVEN:
 160                                 break;
 161                         default:
 162                                 Assert(false);
 163                                 break;
 164                         }
 165 #endif
 166                 }
 167 };
 168
 169 #endif