prnt/hpcups/Encapsulator.h

   1 /*****************************************************************************\
   2   Encapsulator.h : Interface for the Encapsulator class
   3
   4   Copyright (c) 1996 - 2001, Hewlett-Packard Co.
   5   All rights reserved.
   6
   7   Redistribution and use in source and binary forms, with or without
   8   modification, are permitted provided that the following conditions
   9   are met:
  10   1. Redistributions of source code must retain the above copyright
  11      notice, this list of conditions and the following disclaimer.
  12   2. Redistributions in binary form must reproduce the above copyright
  13      notice, this list of conditions and the following disclaimer in the
  14      documentation and/or other materials provided with the distribution.
  15   3. Neither the name of Hewlett-Packard nor the names of its
  16      contributors may be used to endorse or promote products derived
  17      from this software without specific prior written permission.
  18
  19   THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
  20   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  21   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
  22   NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  24   TO, PATENT INFRINGEMENT; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  25   OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  26   ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 \*****************************************************************************/
  30
  31 #ifndef ENCAPSULATOR_H
  32 #define ENCAPSULATOR_H
  33
  34 #include "CommonDefinitions.h"
  35 #include "SystemServices.h"
  36 #include "Pipeline.h"
  37
  38 class Encapsulator
  39 {
  40 public:
  41     Encapsulator();
  42     virtual ~Encapsulator();
  43     virtual DRIVER_ERROR    StartJob (SystemServices *pSystemServices, JobAttributes *pJA);
  44     virtual DRIVER_ERROR    EndJob ();
  45     virtual DRIVER_ERROR    FormFeed ();
  46     virtual DRIVER_ERROR    SendCAPy (int iOffset);
  47     virtual DRIVER_ERROR    Encapsulate (RASTERDATA *InputRaster, bool bLastPlane) = 0;
  48     virtual DRIVER_ERROR    Send(const BYTE *pBuffer, int length);
  49     virtual DRIVER_ERROR    StartPage(JobAttributes *pJA) = 0;
  50     virtual DRIVER_ERROR    Cleanup();
  51     virtual DRIVER_ERROR    Configure(Pipeline **pipeline) = 0;
  52     virtual bool            CanSkipRasters() {return true;}
  53     virtual void            SetLastBand() {}
  54     virtual bool            UnpackBits() {return true;}
  55     virtual void            CancelJob();
  56     virtual DRIVER_ERROR    preProcessRasterData(cups_raster_t **cups_raster, cups_page_header2_t* firstpage_cups_header, char* pSwapedPagesFileName);
  57
  58 protected:
  59     void         addToHeader(const BYTE *command_string, int length);
  60     void         addToHeader(const char *fmt, ...);
  61     DRIVER_ERROR sendBuffer(const BYTE *pBuffer, int length);
  62     virtual DRIVER_ERROR addJobSettings()
  63     {
  64         cur_pcl_buffer_ptr += sprintf((char *) cur_pcl_buffer_ptr, "@PJL ENTER LANGUAGE=%s\012", m_szLanguage);
  65         return NO_ERROR;
  66     }
  67     virtual DRIVER_ERROR    flushPrinterBuffer()
  68     {
  69         return m_pSystemServices->Send((const BYTE *) pcl_buffer, 10000);
  70     }
  71     virtual bool jobAttrPJLAllowed() {return false;}
  72     virtual bool needPJLHeaders(JobAttributes *pJA)
  73     {
  74         return true;
  75     }
  76     virtual void configureRasterData() {}
  77     void sendJobHeader();
  78
  79     SystemServices      *m_pSystemServices;
  80     int          page_number;
  81     int          cur_pcl_buffer_size;
  82     BYTE         *pcl_buffer;
  83     BYTE         *cur_pcl_buffer_ptr;
  84     char         m_szLanguage[16];
  85
  86     JobAttributes      *m_pJA;
  87     MediaAttributes    *m_pMA;
  88     QualityAttributes  *m_pQA;
  89 };
  90 #endif // ENCAPSULATOR_H
  91