root / pkpgcounter / trunk / pkpgpdls / pclxl.py @ 463

Revision 463, 28.6 kB (checked in by jerome, 17 years ago)

Licensing terms changed to GNU GPL v3.0 or higher.
Removed old PCL3/4/5 parser which for a long time now wasn't used
anymore, and for which I was not the original copyright owner.
Version number bumped to 3.00alpha to reflect licensing changes.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Auth Date Id Rev
RevLine 
[193]1#! /usr/bin/env python
2# -*- coding: ISO-8859-15 -*-
[191]3#
4# pkpgcounter : a generic Page Description Language parser
5#
[443]6# (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet <alet@librelogiciel.com>
[463]7# This program is free software: you can redistribute it and/or modify
[191]8# it under the terms of the GNU General Public License as published by
[463]9# the Free Software Foundation, either version 3 of the License, or
[191]10# (at your option) any later version.
[463]11#
[191]12# This program is distributed in the hope that it will be useful,
13# but WITHOUT ANY WARRANTY; without even the implied warranty of
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15# GNU General Public License for more details.
16#
17# You should have received a copy of the GNU General Public License
[463]18# along with this program.  If not, see <http://www.gnu.org/licenses/>.
[191]19#
20# $Id$
21#
[193]22
[357]23"""This modules implements a page counter for PCLXL (aka PCL6) documents."""
24
[193]25import sys
[202]26import os
[193]27import mmap
28from struct import unpack
29
[235]30import pdlparser
[252]31import pjl
[193]32
[220]33class Parser(pdlparser.PDLParser) :
[193]34    """A parser for PCLXL (aka PCL6) documents."""
[430]35    totiffcommands = [ 'pcl6 -sDEVICE=pdfwrite -r%(dpi)i -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -sOutputFile=- - | gs -sDEVICE=tiff24nc -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -r%(dpi)i -sOutputFile="%(fname)s" -', 
36                       'pcl6 -sDEVICE=pswrite -r%(dpi)i -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -sOutputFile=- - | gs -sDEVICE=tiff24nc -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -r%(dpi)i -sOutputFile="%(fname)s" -',
[428]37                     ]
[193]38    mediasizes = { 
39                    0 : "Letter",
40                    1 : "Legal",
41                    2 : "A4",
42                    3 : "Executive",
43                    4 : "Ledger",
44                    5 : "A3",
45                    6 : "COM10Envelope",
46                    7 : "MonarchEnvelope",
47                    8 : "C5Envelope",
48                    9 : "DLEnvelope",
49                    10 : "JB4",
50                    11 : "JB5",
51                    12 : "B5Envelope",
[246]52                    12 : "B5",
[193]53                    14 : "JPostcard",
54                    15 : "JDoublePostcard",
55                    16 : "A5",
56                    17 : "A6",
57                    18 : "JB6",
[246]58                    19 : "JIS8K",
59                    20 : "JIS16K",
60                    21 : "JISExec",
61                    96 : "Default",
[193]62                 }   
63                 
64    mediasources = {             
65                     0 : "Default",
66                     1 : "Auto",
67                     2 : "Manual",
68                     3 : "MultiPurpose",
69                     4 : "UpperCassette",
70                     5 : "LowerCassette",
71                     6 : "EnvelopeTray",
72                     7 : "ThirdCassette",
73                   }
74                   
75    orientations = {               
76                     0 : "Portrait",
77                     1 : "Landscape",
78                     2 : "ReversePortrait",
79                     3 : "ReverseLandscape",
[246]80                     4 : "Default",
[193]81                   }
82           
[220]83    def isValid(self) :   
[387]84        """Returns True if data is PCLXL aka PCL6, else False."""
[220]85        if ((self.firstblock[:128].find("\033%-12345X") != -1) and \
86             (self.firstblock.find(" HP-PCL XL;") != -1) and \
87             ((self.firstblock.find("LANGUAGE=PCLXL") != -1) or \
88              (self.firstblock.find("LANGUAGE = PCLXL") != -1))) :
[252]89            self.logdebug("DEBUG: Input file is in the PCLXL (aka PCL6) format.")
[387]90            return True
[220]91        else :   
[387]92            return False
[220]93           
[318]94    def beginPage(self, nextpos) :
[193]95        """Indicates the beginning of a new page, and extracts media information."""
96        self.pagecount += 1
97       
98        # Default values
99        mediatypelabel = "Plain"
100        mediasourcelabel = "Main"
101        mediasizelabel = "Default"
102        orientationlabel = "Portrait"
[299]103        duplexmode = None
[193]104       
105        # Now go upstream to decode media type, size, source, and orientation
106        # this saves time because we don't need a complete parser !
107        minfile = self.minfile
[318]108        pos = nextpos - 2
[193]109        while pos > 0 : # safety check : don't go back to far !
110            val = ord(minfile[pos])
111            if val in (0x44, 0x48, 0x41) : # if previous endPage or openDataSource or beginSession (first page)
112                break
113            if val == 0x26 :   
114                mediasource = ord(minfile[pos - 2])
115                mediasourcelabel = self.mediasources.get(mediasource, str(mediasource))
[302]116                pos -= 4
[193]117            elif val == 0x25 :
[302]118                while (pos > 0) and (ord(minfile[pos]) != 0xc0) :
119                    # we search the preceding ubyte tag
120                    pos -= 1
121                if pos > 0 :
122                    if ord(minfile[pos-1]) == 0xc8 :
123                        # if we found an ubyte_array then the media
124                        # size is completely spelled
125                        arraylength = ord(minfile[pos+1])
126                        mediasizelabel = minfile[pos+2:pos+2+arraylength].title()
127                        pos -= 1
128                    else :   
129                        # if we just found an ubyte, then the media
130                        # size is known by its index
131                        mediasize = ord(minfile[pos+1])
132                        mediasizelabel = self.mediasizes.get(mediasize, str(mediasize))
133                    pos -= 1 
[310]134                    # self.logdebug("Media size : %s" % mediasizelabel)
[193]135            elif val == 0x28 :   
136                orientation = ord(minfile[pos - 2])
[252]137                orientationlabel = self.orientations.get(orientation, str(orientation))
[302]138                pos -= 4
[193]139            elif val == 0x27 :   
140                savepos = pos
[302]141                pos -= 1
[293]142                startpos = size = None 
[193]143                while pos > 0 : # safety check : don't go back to far !
144                    val = ord(minfile[pos])
145                    pos -= 1   
146                    if val == 0xc8 :
[293]147                        length = self.tags[ord(minfile[pos+2])] # will probably always be a byte or uint16
148                        if length == 1 :   
149                            startpos = pos + 4
150                            size = unpack("B", self.minfile[pos+3:startpos])[0]
151                        elif length == 2 :   
152                            startpos = pos + 5
[316]153                            size = unpack(self.unpackShort, self.minfile[pos+3:startpos])[0]
[293]154                        elif length == 4 :   
155                            startpos = pos + 7
[316]156                            size = unpack(self.unpackLong, self.minfile[pos+3:startpos])[0]
[293]157                        else :   
[301]158                            raise pdlparser.PDLParserError, "Error on size at %s : %s" % (pos+2, length)
[193]159                        break
[293]160                mediatypelabel = minfile[startpos:startpos+size]
[310]161                # self.logdebug("Media type : %s" % mediatypelabel)
[299]162            elif val == 0x34 :   
163                duplexmode = "Simplex"
[302]164                pos -= 2
[299]165            elif val in (0x35, 0x36) :   
166                duplexmode = "Duplex"
[302]167                pos -= 2
[193]168            # else : TODO : CUSTOM MEDIA SIZE AND UNIT !
169            else :   
[302]170                pos -= 1  # ignored
[193]171        self.pages[self.pagecount] = { "copies" : 1, 
172                                       "orientation" : orientationlabel, 
173                                       "mediatype" : mediatypelabel, 
174                                       "mediasize" : mediasizelabel,
175                                       "mediasource" : mediasourcelabel,
[299]176                                       "duplex" : duplexmode,
[193]177                                     } 
178        return 0
179       
[318]180    def endPage(self, nextpos) :   
[193]181        """Indicates the end of a page."""
[318]182        pos3 = nextpos - 3
[193]183        minfile = self.minfile
[318]184        if minfile[pos3:nextpos-1] == self.setNumberOfCopies :
[193]185            # The EndPage operator may be preceded by a PageCopies attribute
186            # So set number of copies for current page.
187            # From what I read in PCLXL documentation, the number
188            # of copies is an unsigned 16 bits integer
[258]189            try :
[454]190                nbcopies = unpack(self.unpackShort, minfile[pos3-2:pos3])[0]
[456]191                # self.logdebug("Number of copies : %i" % nbcopies)
[454]192                self.pages[self.pagecount]["copies"] = nbcopies
[258]193            except KeyError :   
194                self.logdebug("It looks like this PCLXL file is corrupted.")
[193]195        return 0
196       
[318]197    def setColorSpace(self, nextpos) :   
[205]198        """Changes the color space."""
[318]199        if self.minfile[nextpos-4:nextpos-1] == self.RGBColorSpace : # TODO : doesn't seem to handle all cases !
[206]200            self.iscolor = 1
[205]201        return 0
202           
[318]203    def array_Generic(self, nextpos, size) :
[317]204        """Handles all arrays."""
[318]205        pos = nextpos
[317]206        datatype = ord(self.minfile[pos])
[193]207        pos += 1
[317]208        length = self.tags[datatype]
[193]209        if callable(length) :
[316]210            length = length(pos)
[318]211        try :
212            return 1 + length + size * unpack(self.unpackType[length], self.minfile[pos:pos+length])[0]
213        except KeyError :
214            raise pdlparser.PDLParserError, "Error on array size at %x" % nextpos
[317]215           
[318]216    def array_8(self, nextpos) :   
[317]217        """Handles byte arrays."""
[318]218        return self.array_Generic(nextpos, 1)
[193]219       
[318]220    def array_16(self, nextpos) :
[424]221        """Handles 16 bits arrays."""
[318]222        return self.array_Generic(nextpos, 2)
[193]223       
[318]224    def array_32(self, nextpos) :
[424]225        """Handles 32 bits arrays."""
[318]226        return self.array_Generic(nextpos, 4)
[193]227       
[318]228    def embeddedDataSmall(self, nextpos) :
[193]229        """Handle small amounts of data."""
[318]230        return 1 + ord(self.minfile[nextpos])
[193]231       
[318]232    def embeddedData(self, nextpos) :
[193]233        """Handle normal amounts of data."""
[318]234        return 4 + unpack(self.unpackLong, self.minfile[nextpos:nextpos+4])[0]
[193]235       
[318]236    def littleEndian(self, nextpos) :
[193]237        """Toggles to little endianness."""
[318]238        self.unpackType = { 1 : "B", 2 : "<H", 4 : "<I" }
239        self.unpackShort = self.unpackType[2]
240        self.unpackLong = self.unpackType[4]
[193]241        return 0
242       
[318]243    def bigEndian(self, nextpos) :
[193]244        """Toggles to big endianness."""
[318]245        self.unpackType = { 1 : "B", 2 : ">H", 4 : ">I" }
246        self.unpackShort = self.unpackType[2]
247        self.unpackLong = self.unpackType[4]
[193]248        return 0
249   
[318]250    def reservedForFutureUse(self, nextpos) :
[245]251        """Outputs something when a reserved byte is encountered."""
[318]252        self.logdebug("Byte at %x is out of the PCLXL Protocol Class 2.0 Specification" % nextpos)
[245]253        return 0   
254       
[318]255    def x46_class3(self, nextpos) :
[310]256        """Undocumented tag 0x46 in class 3.0 streams."""
[318]257        pos = nextpos - 3
[309]258        minfile = self.minfile
[318]259        val = ord(minfile[pos])
260        while val == 0xf8 :
261            funcid = ord(minfile[pos+1])
262            try :
263                offset = self.x46_functions[funcid]
264            except KeyError :   
265                self.logdebug("Unexpected subfunction 0x%02x for undocumented tag 0x46 at %x" % (funcid, nextpos))
266                break
267            else :   
[320]268                pos -= offset
269                length = self.tags[ord(self.minfile[pos])]
[318]270                if callable(length) :
[320]271                    length = length(pos+1)
272                if funcid == 0x92 : # we want to skip these blocks
[318]273                    try :
274                        return unpack(self.unpackType[length], self.minfile[pos+1:pos+length+1])[0]
275                    except KeyError :
276                        raise pdlparser.PDLParserError, "Error on size '%s' at %x" % (length, pos+1)
[309]277            val = ord(minfile[pos])
278        return 0   
279       
[318]280    def escape(self, nextpos) :   
[245]281        """Handles the ESC code."""
[318]282        pos = endpos = nextpos
[314]283        minfile = self.minfile
284        if minfile[pos : pos+8] == r"%-12345X" :
[245]285            endpos = pos + 9
[252]286            endmark = chr(0x0c) + chr(0x00) + chr(0x1b)
[246]287            asciilimit = chr(0x80)
[269]288            quotes = 0
[314]289            while (minfile[endpos] not in endmark) and \
290                   ((minfile[endpos] < asciilimit) or (quotes % 2)) :
291                if minfile[endpos] == '"' :
[269]292                    quotes += 1
[245]293                endpos += 1
294               
295            # Store this in a per page mapping.   
296            # NB : First time will be at page 0 (i.e. **before** page 1) !
297            stuff = self.escapedStuff.setdefault(self.pagecount, [])
[314]298            stuff.append(minfile[pos : endpos])
299            self.logdebug("Escaped datas : [%s]" % repr(minfile[pos : endpos]))
[245]300        return endpos - pos
301       
[318]302    def skipKyoceraPrescribe(self, nextpos) :
[312]303        """Skips Kyocera Prescribe commands."""
[318]304        pos = nextpos - 1
[312]305        minfile = self.minfile
306        if minfile[pos:pos+3] == "!R!" :
[318]307            while (pos - nextpos) < 1024 :   # This is a realistic upper bound, to avoid infinite loops
[312]308                if (minfile[pos] == ";") and (minfile[pos-4:pos] == "EXIT") :
[314]309                    pos += 1
310                    prescribe = self.prescribeStuff.setdefault(self.pagecount, [])
[318]311                    prescribe.append(minfile[nextpos-1:pos])
312                    self.logdebug("Prescribe commands : [%s]" % repr(minfile[nextpos-1:pos]))
[417]313                    break
[312]314                pos += 1   
[417]315            return (pos - nextpos)
[312]316        else :
317            return 0
318           
[193]319    def getJobSize(self) :
320        """Counts pages in a PCLXL (PCL6) document.
321       
322           Algorithm by Jerome Alet.
323           
324           The documentation used for this was :
325         
326           HP PCL XL Feature Reference
327           Protocol Class 2.0
328           http://www.hpdevelopersolutions.com/downloads/64/358/xl_ref20r22.pdf
[246]329           
330           Protocol Class 2.1 Supplement
331           xl_ref21.pdf
332           
333           Protocol Class 3.0 Supplement
334           xl_refsup30r089.pdf
[193]335        """
[206]336        self.iscolor = None
[449]337        found = False
[193]338        while not found :
339            line = self.infile.readline()
340            if not line :
341                break
[293]342            pos = line.find(" HP-PCL XL;")   
343            if pos != -1 :
[449]344                found = True
[293]345                endian = ord(line[pos - 1])
[193]346                if endian == 0x29 :
[316]347                    self.littleEndian(0)
[193]348                elif endian == 0x28 :   
[316]349                    self.bigEndian(0)
[193]350                # elif endian == 0x27 : # TODO : This is the ESC code : parse it for PJL statements !
351                #
352                else :   
[200]353                    raise pdlparser.PDLParserError, "Unknown endianness marker 0x%02x at start !" % endian
[193]354        if not found :
[200]355            raise pdlparser.PDLParserError, "This file doesn't seem to be PCLXL (aka PCL6)"
[193]356           
[246]357        # Initialize Media Sources
358        for i in range(8, 256) :
359            self.mediasources[i] = "ExternalTray%03i" % (i - 7)
360           
[193]361        # Initialize table of tags
362        self.tags = [ 0 ] * 256   
363       
[245]364        self.tags[0x1b] = self.escape # The escape code
365       
[352]366        self.tags[0x21] = self.skipKyoceraPrescribe # 0x21 is not normally used
[312]367       
[193]368        # GhostScript's sources tell us that HP printers
369        # only accept little endianness, but we can handle both.
370        self.tags[0x28] = self.bigEndian    # BigEndian
371        self.tags[0x29] = self.littleEndian # LittleEndian
372       
373        self.tags[0x43] = self.beginPage    # BeginPage
374        self.tags[0x44] = self.endPage      # EndPage
[245]375        self.tags[0x45] = self.reservedForFutureUse # reserved
[313]376       
[309]377        self.tags[0x46] = self.x46_class3 
[193]378       
[245]379        self.tags[0x4a] = self.reservedForFutureUse # reserved
380        self.tags[0x4b] = self.reservedForFutureUse # reserved
381        self.tags[0x4c] = self.reservedForFutureUse # reserved
382        self.tags[0x4d] = self.reservedForFutureUse # reserved
383        self.tags[0x4e] = self.reservedForFutureUse # reserved
384       
385        self.tags[0x56] = self.reservedForFutureUse # TODO : documentation not clear about reserved status
386       
387        self.tags[0x57] = self.reservedForFutureUse # reserved
[313]388       
[245]389        self.tags[0x59] = self.reservedForFutureUse # reserved
390        self.tags[0x5a] = self.reservedForFutureUse # reserved
391       
[206]392        self.tags[0x6a] = self.setColorSpace    # to detect color/b&w mode
[205]393       
[245]394        self.tags[0x87] = self.reservedForFutureUse # reserved
395        self.tags[0x88] = self.reservedForFutureUse # reserved
396        self.tags[0x89] = self.reservedForFutureUse # reserved
397        self.tags[0x8a] = self.reservedForFutureUse # reserved
[313]398       
[245]399        self.tags[0x8b] = self.reservedForFutureUse # reserved
[313]400       
[245]401        self.tags[0x8c] = self.reservedForFutureUse # reserved
402        self.tags[0x8d] = self.reservedForFutureUse # reserved
403        self.tags[0x8e] = self.reservedForFutureUse # reserved
404        self.tags[0x8f] = self.reservedForFutureUse # reserved
405        self.tags[0x90] = self.reservedForFutureUse # reserved
406       
407        self.tags[0x9a] = self.reservedForFutureUse # reserved
408        self.tags[0x9c] = self.reservedForFutureUse # reserved
409       
410        self.tags[0xa4] = self.reservedForFutureUse # reserved
411        self.tags[0xa5] = self.reservedForFutureUse # reserved
412        self.tags[0xa6] = self.reservedForFutureUse # reserved
413        self.tags[0xa7] = self.reservedForFutureUse # reserved
414       
415        self.tags[0xaa] = self.reservedForFutureUse # reserved
416        self.tags[0xab] = self.reservedForFutureUse # reserved
417        self.tags[0xac] = self.reservedForFutureUse # reserved
418        self.tags[0xad] = self.reservedForFutureUse # reserved
419        self.tags[0xae] = self.reservedForFutureUse # reserved
420        self.tags[0xaf] = self.reservedForFutureUse # reserved
421       
422        self.tags[0xb7] = self.reservedForFutureUse # reserved
423       
424        self.tags[0xba] = self.reservedForFutureUse # reserved
425        self.tags[0xbb] = self.reservedForFutureUse # reserved
426        self.tags[0xbc] = self.reservedForFutureUse # reserved
427        self.tags[0xbd] = self.reservedForFutureUse # reserved
428        self.tags[0xbe] = self.reservedForFutureUse # reserved
429       
[316]430        # self.tags[0xbf] = self.passThrough # PassThrough mode should already be taken care of automatically
[298]431       
[193]432        self.tags[0xc0] = 1 # ubyte
433        self.tags[0xc1] = 2 # uint16
434        self.tags[0xc2] = 4 # uint32
435        self.tags[0xc3] = 2 # sint16
436        self.tags[0xc4] = 4 # sint32
437        self.tags[0xc5] = 4 # real32
438       
[245]439        self.tags[0xc6] = self.reservedForFutureUse # reserved
440        self.tags[0xc7] = self.reservedForFutureUse # reserved
441       
[193]442        self.tags[0xc8] = self.array_8  # ubyte_array
443        self.tags[0xc9] = self.array_16 # uint16_array
444        self.tags[0xca] = self.array_32 # uint32_array
445        self.tags[0xcb] = self.array_16 # sint16_array
446        self.tags[0xcc] = self.array_32 # sint32_array
447        self.tags[0xcd] = self.array_32 # real32_array
448       
[245]449        self.tags[0xce] = self.reservedForFutureUse # reserved
450        self.tags[0xcf] = self.reservedForFutureUse # reserved
451       
[193]452        self.tags[0xd0] = 2 # ubyte_xy
453        self.tags[0xd1] = 4 # uint16_xy
454        self.tags[0xd2] = 8 # uint32_xy
455        self.tags[0xd3] = 4 # sint16_xy
456        self.tags[0xd4] = 8 # sint32_xy
457        self.tags[0xd5] = 8 # real32_xy
[245]458        self.tags[0xd6] = self.reservedForFutureUse # reserved
459        self.tags[0xd7] = self.reservedForFutureUse # reserved
460        self.tags[0xd8] = self.reservedForFutureUse # reserved
461        self.tags[0xd9] = self.reservedForFutureUse # reserved
462        self.tags[0xda] = self.reservedForFutureUse # reserved
463        self.tags[0xdb] = self.reservedForFutureUse # reserved
464        self.tags[0xdc] = self.reservedForFutureUse # reserved
465        self.tags[0xdd] = self.reservedForFutureUse # reserved
466        self.tags[0xde] = self.reservedForFutureUse # reserved
467        self.tags[0xdf] = self.reservedForFutureUse # reserved
[193]468       
469        self.tags[0xe0] = 4  # ubyte_box
470        self.tags[0xe1] = 8  # uint16_box
471        self.tags[0xe2] = 16 # uint32_box
472        self.tags[0xe3] = 8  # sint16_box
473        self.tags[0xe4] = 16 # sint32_box
474        self.tags[0xe5] = 16 # real32_box
[245]475        self.tags[0xe6] = self.reservedForFutureUse # reserved
476        self.tags[0xe7] = self.reservedForFutureUse # reserved
477        self.tags[0xe8] = self.reservedForFutureUse # reserved
478        self.tags[0xe9] = self.reservedForFutureUse # reserved
479        self.tags[0xea] = self.reservedForFutureUse # reserved
480        self.tags[0xeb] = self.reservedForFutureUse # reserved
481        self.tags[0xec] = self.reservedForFutureUse # reserved
482        self.tags[0xed] = self.reservedForFutureUse # reserved
483        self.tags[0xee] = self.reservedForFutureUse # reserved
484        self.tags[0xef] = self.reservedForFutureUse # reserved
[193]485       
[245]486        self.tags[0xf0] = self.reservedForFutureUse # reserved
487        self.tags[0xf1] = self.reservedForFutureUse # reserved
488        self.tags[0xf2] = self.reservedForFutureUse # reserved
489        self.tags[0xf3] = self.reservedForFutureUse # reserved
490        self.tags[0xf4] = self.reservedForFutureUse # reserved
491        self.tags[0xf5] = self.reservedForFutureUse # reserved
492        self.tags[0xf6] = self.reservedForFutureUse # reserved
493        self.tags[0xf7] = self.reservedForFutureUse # reserved
494       
[193]495        self.tags[0xf8] = 1 # attr_ubyte
496        self.tags[0xf9] = 2 # attr_uint16
497       
498        self.tags[0xfa] = self.embeddedData      # dataLength
499        self.tags[0xfb] = self.embeddedDataSmall # dataLengthByte
[245]500       
501        self.tags[0xfc] = self.reservedForFutureUse # reserved
502        self.tags[0xfd] = self.reservedForFutureUse # reserved
503        self.tags[0xfe] = self.reservedForFutureUse # reserved
504        self.tags[0xff] = self.reservedForFutureUse # reserved
[193]505           
[206]506        # color spaces   
507        self.BWColorSpace = "".join([chr(0x00), chr(0xf8), chr(0x03)])
508        self.GrayColorSpace = "".join([chr(0x01), chr(0xf8), chr(0x03)])
509        self.RGBColorSpace = "".join([chr(0x02), chr(0xf8), chr(0x03)])
510       
511        # set number of copies
512        self.setNumberOfCopies = "".join([chr(0xf8), chr(0x31)]) 
513       
[318]514        # subcodes for undocumented tag 0x46 and the negative
515        # offset to grab the value from.
516        self.x46_functions = { 0x91 : 5,
517                               0x92 : 5,
518                               0x93 : 3,
519                               0x94 : 3,
520                               0x95 : 5,
521                               0x96 : 2,
522                               0x97 : 2,
523                               0x98 : 2,
524                             }
525                             
[193]526        infileno = self.infile.fileno()
[258]527        self.pages = { 0 : { "copies" : 1, 
528                             "orientation" : "Default", 
529                             "mediatype" : "Plain", 
530                             "mediasize" : "Default", 
531                             "mediasource" : "Default", 
[299]532                             "duplex" : None,
[258]533                           } 
534                     }     
[193]535        self.minfile = minfile = mmap.mmap(infileno, os.fstat(infileno)[6], prot=mmap.PROT_READ, flags=mmap.MAP_SHARED)
536        tags = self.tags
537        self.pagecount = 0
[314]538        self.escapedStuff = {}   # For escaped datas, mostly PJL commands
539        self.prescribeStuff = {} # For Kyocera Prescribe commands
[316]540        pos = oldpos = 0
[193]541        try :
[307]542            try :
543                while 1 :
544                    try :
[316]545                        tag = ord(minfile[pos])
[307]546                    except OverflowError :   
547                        pos = oldpos + 1
548                    pos += 1
[316]549                    length = tags[tag]
[307]550                    if length :
551                        if callable(length) :   
[316]552                            length = length(pos)
[307]553                        oldpos = pos   
554                        pos += length   
555            except IndexError : # EOF ?           
556                pass
557        finally :
558            self.minfile.close()
[193]559           
560        # now handle number of copies for each page (may differ).
[206]561        if self.iscolor :
562            colormode = "Color"
563        else :   
[253]564            colormode = "BW"
[252]565           
[253]566        defaultduplexmode = "Simplex"
567        defaultpapersize = ""
[252]568        defaultpjlcopies = 1   
569        oldpjlcopies = -1
[253]570        oldduplexmode = ""
571        oldpapersize = ""
[193]572        for pnum in range(1, self.pagecount + 1) :
573            # if no number of copies defined, take 1, as explained
574            # in PCLXL documentation.
575            # NB : is number of copies is 0, the page won't be output
576            # but the formula below is still correct : we want
577            # to decrease the total number of pages in this case.
[299]578            page = self.pages.get(pnum, self.pages.get(1, { "copies" : 1, "mediasize" : "Default", "duplex" : None }))
[266]579            pjlstuff = self.escapedStuff.get(pnum, self.escapedStuff.get(0, []))
[252]580            if pjlstuff :
581                pjlparser = pjl.PJLParser("".join(pjlstuff))
582                nbdefaultcopies = int(pjlparser.default_variables.get("COPIES", -1))
583                nbcopies = int(pjlparser.environment_variables.get("COPIES", -1))
584                nbdefaultqty = int(pjlparser.default_variables.get("QTY", -1))
585                nbqty = int(pjlparser.environment_variables.get("QTY", -1))
586                if nbdefaultcopies > -1 :
587                    defaultpjlcopies = nbdefaultcopies
588                if nbdefaultqty > -1 :
589                    defaultpjlcopies = nbdefaultqty
590                if nbcopies > -1 :
[253]591                    pjlcopies = nbcopies
[252]592                elif nbqty > -1 :
[253]593                    pjlcopies = nbqty
[252]594                else :
595                    if oldpjlcopies == -1 :   
[253]596                        pjlcopies = defaultpjlcopies
597                    else :   
598                        pjlcopies = oldpjlcopies   
[299]599                if page["duplex"] :       
600                    duplexmode = page["duplex"]
601                else :   
602                    defaultdm = pjlparser.default_variables.get("DUPLEX", "")
603                    if defaultdm :
604                        if defaultdm.upper() == "ON" :
605                            defaultduplexmode = "Duplex"
606                        else :   
607                            defaultduplexmode = "Simplex"
608                    envdm = pjlparser.environment_variables.get("DUPLEX", "")
609                    if envdm :
610                        if envdm.upper() == "ON" :
611                            duplexmode = "Duplex"
612                        else :   
613                            duplexmode = "Simplex"
614                    else :       
615                        if not oldduplexmode :
616                            duplexmode = defaultduplexmode
617                        else :   
618                            duplexmode = oldduplexmode
[253]619                defaultps = pjlparser.default_variables.get("PAPER", "")
620                if defaultps :
621                    defaultpapersize = defaultps
622                envps = pjlparser.environment_variables.get("PAPER", "")
623                if envps :
624                    papersize = envps
625                else :   
626                    if not oldpapersize :
627                        papersize = defaultpapersize
628                    else :   
629                        papersize = oldpapersize
[252]630            else :       
631                if oldpjlcopies == -1 :
632                    pjlcopies = defaultpjlcopies
633                else :   
634                    pjlcopies = oldpjlcopies
[253]635                if not oldduplexmode :
636                    duplexmode = defaultduplexmode
637                else :   
638                    duplexmode = oldduplexmode
639                if not oldpapersize :   
640                    papersize = defaultpapersize
641                else :   
642                    papersize = oldpapersize
643                duplexmode = oldduplexmode
644                papersize = oldpapersize or page["mediasize"]
645            if page["mediasize"] != "Default" :
646                papersize = page["mediasize"]
647            if not duplexmode :   
648                duplexmode = oldduplexmode or defaultduplexmode
649            oldpjlcopies = pjlcopies   
650            oldduplexmode = duplexmode
651            oldpapersize = papersize
[456]652            copies = max(pjlcopies, page["copies"]) # Was : pjlcopies * page["copies"]
[193]653            self.pagecount += (copies - 1)
[253]654            self.logdebug("%s*%s*%s*%s*%s*%s*%s" % (copies, 
[252]655                                                 page["mediatype"], 
[253]656                                                 papersize, 
[252]657                                                 page["orientation"], 
658                                                 page["mediasource"], 
[253]659                                                 duplexmode, 
[252]660                                                 colormode))
[193]661        return self.pagecount
662       
663if __name__ == "__main__" :   
[415]664    pdlparser.test(Parser)
Note: See TracBrowser for help on using the browser.