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-2001 The LyX Team
   9  *
  10  *          This file Copyright 1999-2001
  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         /** Test that all the fields contain valid entries.  It's unlikely
  88             that the internal code will get this wrong (at least for the
  89             xforms code anyway) however new ports and external scripts
  90             might drive the wrong values in.
  91          */
  92         void testInvariant() const
  93                 {
  94 #ifdef ENABLE_ASSERTIONS
  95                         if (!from_page.empty()) {
  96                                 // Assert(from_page == number or empty)
  97                                 lyx::Assert(containsOnly(from_page,
  98                                                          "1234567890"));
  99                         }
 100                         if (to_page) {
 101                                 // Assert(to_page == empty
 102                                 //        or number iff from_page set)
 103                                 lyx::Assert(!from_page.empty());
 104                         }
 105                         switch (target) {
 106                         case PRINTER:
 107 //                              Assert(!printer_name.empty());
 108                                 break;
 109                         case FILE:
 110                                 lyx::Assert(!file_name.empty());
 111                                 break;
 112                         default:
 113                                 lyx::Assert(false);
 114                                 break;
 115                         }
 116                         switch (which_pages) {
 117                         case ALL:
 118                         case ODD:
 119                         case EVEN:
 120                                 break;
 121                         default:
 122                                 lyx::Assert(false);
 123                                 break;
 124                         }
 125 #endif
 126                 }
 127
 128         ///
 129         PrinterParams(Target const & t = PRINTER,
 130                       string const & pname = lyxrc.printer,
 131                       string const & fname = string(),
 132                       WhichPages const wp = ALL,
 133                       string const & from = string(),
 134                       int const & to = 0,
 135                       bool const reversed = false,
 136                       bool const unsorted = false,
 137                       int const & num_copies = 1)
 138                 : target(t),
 139                   printer_name(pname),
 140                   file_name(fname),
 141                   which_pages(wp),
 142                   from_page(from),
 143                   to_page(to),
 144                   reverse_order(reversed),
 145                   unsorted_copies(unsorted),
 146                   count_copies(num_copies)
 147                 {
 148                         testInvariant();
 149                 }
 150         ///
 151         PrinterParams(PrinterParams const & pp)
 152                 : target(pp.target),
 153                   printer_name(pp.printer_name),
 154                   file_name(pp.file_name),
 155                   which_pages(pp.which_pages),
 156                   from_page(pp.from_page),
 157                   to_page(pp.to_page),
 158                   reverse_order(pp.reverse_order),
 159                   unsorted_copies(pp.unsorted_copies),
 160                   count_copies(pp.count_copies)
 161                 {
 162                         testInvariant();
 163                 }
 164 };
 165
 166 #endif