include/vcl/ppdparser.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_VCL_PPDPARSER_HXX
  20 #define INCLUDED_VCL_PPDPARSER_HXX
  21
  22 #include <list>
  23 #include <unordered_map>
  24 #include <vector>
  25
  26 #include <rtl/string.hxx>
  27 #include <rtl/ustring.hxx>
  28 #include <tools/solar.h>
  29 #include <vcl/dllapi.h>
  30
  31 #include <com/sun/star/lang/Locale.hpp>
  32
  33 #define PRINTER_PPDDIR "driver"
  34
  35 namespace psp {
  36
  37 class PPDCache;
  38 class PPDParser;
  39 class PPDTranslator;
  40
  41 enum PPDValueType { eInvocation, eQuoted, eSymbol, eString, eNo };
  42
  43 struct VCL_DLLPUBLIC PPDValue
  44 {
  45     PPDValueType     m_eType;
  46     //CustomOption stuff for fdo#43049
  47     //see http://www.cups.org/documentation.php/spec-ppd.html#OPTIONS
  48     //for full specs, only the basics are implemented here
  49     bool             m_bCustomOption;
  50     mutable OUString m_aCustomOption;
  51     OUString         m_aOption;
  52     OUString         m_aValue;
  53 };
  54
  55
  56 /*
  57  * PPDKey - a container for the available options (=values) of a PPD keyword
  58  */
  59
  60 class VCL_DLLPUBLIC PPDKey
  61 {
  62     friend class PPDParser;
  63
  64     typedef std::unordered_map< OUString, PPDValue, OUStringHash > hash_type;
  65     typedef std::vector< PPDValue* > value_type;
  66
  67     OUString            m_aKey;
  68     hash_type           m_aValues;
  69     value_type          m_aOrderedValues;
  70     const PPDValue*     m_pDefaultValue;
  71     bool                m_bQueryValue;
  72     PPDValue            m_aQueryValue;
  73     OUString            m_aGroup;
  74
  75 public:
  76     enum UIType { PickOne, PickMany, Boolean };
  77     enum class SetupType { ExitServer, Prolog, DocumentSetup, PageSetup, JCLSetup, AnySetup };
  78 private:
  79
  80     bool                m_bUIOption;
  81     UIType              m_eUIType;
  82     int                 m_nOrderDependency;
  83     SetupType           m_eSetupType;
  84
  85     void eraseValue( const OUString& rOption );
  86 public:
  87     PPDKey( const OUString& rKey );
  88     ~PPDKey();
  89
  90     PPDValue*           insertValue(const OUString& rOption, PPDValueType eType, bool bCustomOption = false);
  91     int                 countValues() const
  92     { return m_aValues.size(); }
  93     // neither getValue will return the query option
  94     const PPDValue*     getValue( int n ) const;
  95     const PPDValue*     getValue( const OUString& rOption ) const;
  96     const PPDValue*     getValueCaseInsensitive( const OUString& rOption ) const;
  97     const PPDValue*     getDefaultValue() const { return m_pDefaultValue; }
  98     const OUString&     getGroup() const { return m_aGroup; }
  99
 100     const OUString&     getKey() const { return m_aKey; }
 101     bool                isUIKey() const { return m_bUIOption; }
 102     SetupType           getSetupType() const { return m_eSetupType; }
 103     int                 getOrderDependency() const { return m_nOrderDependency; }
 104 };
 105
 106 // define a hash for PPDKey
 107 struct PPDKeyhash
 108 {
 109     size_t operator()( const PPDKey * pKey) const
 110         { return reinterpret_cast<size_t>(pKey); }
 111 };
 112
 113
 114 /*
 115  * PPDParser - parses a PPD file and contains all available keys from it
 116  */
 117
 118 class PPDContext;
 119 class CUPSManager;
 120
 121 class VCL_DLLPUBLIC PPDParser
 122 {
 123     friend class PPDContext;
 124     friend class CUPSManager;
 125     friend class PPDCache;
 126
 127     typedef std::unordered_map< OUString, PPDKey*, OUStringHash > hash_type;
 128     typedef std::vector< PPDKey* > value_type;
 129
 130     void insertKey( const OUString& rKey, PPDKey* pKey );
 131 public:
 132     struct PPDConstraint
 133     {
 134         const PPDKey*       m_pKey1;
 135         const PPDValue*     m_pOption1;
 136         const PPDKey*       m_pKey2;
 137         const PPDValue*     m_pOption2;
 138
 139         PPDConstraint() : m_pKey1( nullptr ), m_pOption1( nullptr ), m_pKey2( nullptr ), m_pOption2( nullptr ) {}
 140     };
 141 private:
 142     hash_type                                   m_aKeys;
 143     value_type                                  m_aOrderedKeys;
 144     ::std::list< PPDConstraint >                m_aConstraints;
 145
 146     // some identifying fields
 147     OUString                                    m_aPrinterName;
 148     OUString                                    m_aNickName;
 149     // the full path of the PPD file
 150     OUString                                    m_aFile;
 151     // some basic attributes
 152     bool                                        m_bColorDevice;
 153     bool                                        m_bType42Capable;
 154     sal_uLong                                       m_nLanguageLevel;
 155     rtl_TextEncoding                            m_aFileEncoding;
 156
 157
 158     // shortcuts to important keys and their default values
 159     // imageable area
 160     const PPDValue*                             m_pDefaultImageableArea;
 161     const PPDKey*                               m_pImageableAreas;
 162     // paper dimensions
 163     const PPDValue*                             m_pDefaultPaperDimension;
 164     const PPDKey*                               m_pPaperDimensions;
 165     // paper trays
 166     const PPDValue*                             m_pDefaultInputSlot;
 167     const PPDKey*                               m_pInputSlots;
 168     // resolutions
 169     const PPDValue*                             m_pDefaultResolution;
 170     const PPDKey*                               m_pResolutions;
 171     // duplex commands
 172     const PPDValue*                             m_pDefaultDuplexType;
 173     const PPDKey*                               m_pDuplexTypes;
 174
 175     // fonts
 176     const PPDKey*                               m_pFontList;
 177
 178     // translations
 179     PPDTranslator*                              m_pTranslator;
 180
 181     PPDParser( const OUString& rFile );
 182     ~PPDParser();
 183
 184     void parseOrderDependency(const OString& rLine);
 185     void parseOpenUI(const OString& rLine, const OString& rPPDGroup);
 186     void parseConstraint(const OString& rLine);
 187     void parse( std::list< OString >& rLines );
 188
 189     OUString handleTranslation(const OString& i_rString, bool i_bIsGlobalized);
 190
 191     static void scanPPDDir( const OUString& rDir );
 192     static void initPPDFiles(PPDCache &rPPDCache);
 193     static OUString getPPDFile( const OUString& rFile );
 194 public:
 195     static const PPDParser* getParser( const OUString& rFile );
 196
 197     const PPDKey*   getKey( int n ) const;
 198     const PPDKey*   getKey( const OUString& rKey ) const;
 199     int             getKeys() const { return m_aKeys.size(); }
 200     bool            hasKey( const PPDKey* ) const;
 201
 202     const ::std::list< PPDConstraint >& getConstraints() const { return m_aConstraints; }
 203
 204     bool            isColorDevice() const { return m_bColorDevice; }
 205     bool            isType42Capable() const { return m_bType42Capable; }
 206     sal_uLong       getLanguageLevel() const { return m_nLanguageLevel; }
 207
 208     OUString        getDefaultPaperDimension() const;
 209     void            getDefaultPaperDimension( int& rWidth, int& rHeight ) const
 210     { getPaperDimension( getDefaultPaperDimension(), rWidth, rHeight ); }
 211     bool getPaperDimension( const OUString& rPaperName,
 212                             int& rWidth, int& rHeight ) const;
 213     // width and height in pt
 214     // returns false if paper not found
 215
 216     // match the best paper for width and height
 217     OUString        matchPaper( int nWidth, int nHeight ) const;
 218
 219     bool getMargins( const OUString& rPaperName,
 220                      int &rLeft, int& rRight,
 221                      int &rUpper, int& rLower ) const;
 222     // values in pt
 223     // returns true if paper found
 224
 225     // values int pt
 226
 227     OUString        getDefaultInputSlot() const;
 228
 229     void            getDefaultResolution( int& rXRes, int& rYRes ) const;
 230     // values in dpi
 231     static void     getResolutionFromString( const OUString&, int&, int& );
 232     // helper function
 233
 234     OUString   translateKey( const OUString& i_rKey ) const;
 235     OUString   translateOption( const OUString& i_rKey,
 236                                 const OUString& i_rOption ) const;
 237 };
 238
 239
 240 /*
 241  * PPDContext - a class to manage user definable states based on the
 242  * contents of a PPDParser.
 243  */
 244
 245 class VCL_DLLPUBLIC PPDContext
 246 {
 247     typedef std::unordered_map< const PPDKey*, const PPDValue*, PPDKeyhash > hash_type;
 248     hash_type m_aCurrentValues;
 249     const PPDParser*                                    m_pParser;
 250
 251     // returns false: check failed, new value is constrained
 252     //         true:  check succeeded, new value can be set
 253     bool checkConstraints( const PPDKey*, const PPDValue*, bool bDoReset );
 254     bool resetValue( const PPDKey*, bool bDefaultable = false );
 255 public:
 256     PPDContext();
 257     PPDContext( const PPDContext& rContext ) { operator=( rContext ); }
 258     PPDContext& operator=( const PPDContext& rContext );
 259     PPDContext& operator=( PPDContext&& rContext );
 260     ~PPDContext();
 261
 262     void setParser( const PPDParser* );
 263     const PPDParser* getParser() const { return m_pParser; }
 264
 265     const PPDValue* getValue( const PPDKey* ) const;
 266     const PPDValue* setValue( const PPDKey*, const PPDValue*, bool bDontCareForConstraints = false );
 267
 268     int countValuesModified() const { return m_aCurrentValues.size(); }
 269     const PPDKey* getModifiedKey( int n ) const;
 270
 271     // public wrapper for the private method
 272     bool checkConstraints( const PPDKey*, const PPDValue* );
 273
 274     // for printer setup
 275     char*   getStreamableBuffer( sal_uLong& rBytes ) const;
 276     void    rebuildFromStreamBuffer( char* pBuffer, sal_uLong nBytes );
 277
 278     // convenience
 279     int getRenderResolution() const;
 280
 281     // width, height in points, paper will contain the name of the selected
 282     // paper after the call
 283     void getPageSize( OUString& rPaper, int& rWidth, int& rHeight ) const;
 284 };
 285
 286 } // namespace
 287
 288 #endif // INCLUDED_VCL_PPDPARSER_HXX
 289
 290 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */