239 lines
8.6 KiB
C++
239 lines
8.6 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_VCL_PRINTERINFOMANAGER_HXX
|
|
#define INCLUDED_VCL_PRINTERINFOMANAGER_HXX
|
|
|
|
#include <boost/unordered_map.hpp>
|
|
#include <list>
|
|
|
|
#include <vcl/dllapi.h>
|
|
#include <vcl/helper.hxx>
|
|
#include <vcl/jobdata.hxx>
|
|
#include <osl/file.hxx>
|
|
|
|
#include <cstdio>
|
|
|
|
namespace psp
|
|
{
|
|
|
|
class SystemQueueInfo;
|
|
|
|
struct PrinterInfo : JobData
|
|
{
|
|
// basename of PPD
|
|
OUString m_aDriverName;
|
|
// can be the queue
|
|
OUString m_aLocation;
|
|
// a user defined comment
|
|
OUString m_aComment;
|
|
// a command line to pipe a PS-file to
|
|
OUString m_aCommand;
|
|
// a command line to pipe a PS-file to in case of direct print
|
|
OUString m_aQuickCommand;
|
|
// a list of special features separated by ',' not used by psprint
|
|
// but assigned from the outside (currently for "fax","pdf=","autoqueue","external_dialog")
|
|
OUString m_aFeatures;
|
|
// a mapping of fonts to other fonts.
|
|
// this provides a method for the user
|
|
// to replace arbitrary fonts by printer builtin fonts
|
|
// currently this is only a mapping between font names
|
|
// assuming that only adbobe standard encoding fonts are
|
|
// built into the printer. in future it may be necessary
|
|
// to map to a font name and UCS2 vector which should be mapped
|
|
// this vector is currently implicitly given by the adobe
|
|
// standard encoding
|
|
bool m_bPerformFontSubstitution;
|
|
boost::unordered_map< OUString, OUString, OUStringHash >
|
|
m_aFontSubstitutes;
|
|
boost::unordered_map< fontID, fontID >
|
|
m_aFontSubstitutions;
|
|
|
|
PrinterInfo() :
|
|
JobData(),
|
|
m_bPerformFontSubstitution( false )
|
|
{}
|
|
};
|
|
|
|
class VCL_DLLPUBLIC PrinterInfoManager
|
|
{
|
|
public:
|
|
enum Type { Default = 0, CUPS = 1 };
|
|
|
|
struct SystemPrintQueue
|
|
{
|
|
OUString m_aQueue;
|
|
OUString m_aLocation;
|
|
OUString m_aComment;
|
|
};
|
|
protected:
|
|
// needed for checkPrintersChanged: files (not necessarily existant)
|
|
// and their last known modification time
|
|
struct WatchFile
|
|
{
|
|
// the file in question
|
|
OUString m_aFilePath;
|
|
// the last know modification time or 0, if file did not exist
|
|
TimeValue m_aModified;
|
|
};
|
|
|
|
// internal data to describe a printer
|
|
struct Printer
|
|
{
|
|
// configuration file containing this printer
|
|
// empty means a freshly added printer that has to be saved yet
|
|
OUString m_aFile;
|
|
// details other config files that have this printer
|
|
// in case of removal all have to be removed
|
|
std::list< OUString > m_aAlternateFiles;
|
|
// group in m_aFile containing the printer
|
|
// this must be unique over all configuration files
|
|
// it usually should be the printer name
|
|
OString m_aGroup;
|
|
// whether changes need to be saved
|
|
bool m_bModified;
|
|
// the corresponding info and job data
|
|
PrinterInfo m_aInfo;
|
|
};
|
|
|
|
boost::unordered_map< OUString, Printer, OUStringHash > m_aPrinters;
|
|
PrinterInfo m_aGlobalDefaults;
|
|
std::list< WatchFile > m_aWatchFiles;
|
|
OUString m_aDefaultPrinter;
|
|
OUString m_aSystemPrintCommand;
|
|
|
|
std::list< SystemPrintQueue > m_aSystemPrintQueues;
|
|
|
|
SystemQueueInfo* m_pQueueInfo;
|
|
|
|
Type m_eType;
|
|
bool m_bUseIncludeFeature;
|
|
bool m_bUseJobPatch;
|
|
OUString m_aSystemDefaultPaper;
|
|
|
|
bool m_bDisableCUPS;
|
|
|
|
PrinterInfoManager( Type eType = Default );
|
|
|
|
virtual void initialize();
|
|
|
|
// fill in font substitutions
|
|
// the resulting boost::unordered_map maps from source to target font ids
|
|
void fillFontSubstitutions( PrinterInfo& rInfo ) const;
|
|
|
|
// fill default paper if not configured in config file
|
|
// default paper is e.g. locale dependent
|
|
// if a paper is already set it will not be overwritten
|
|
void setDefaultPaper( PPDContext& rInfo ) const;
|
|
|
|
void initSystemDefaultPaper();
|
|
public:
|
|
|
|
// there can only be one
|
|
static PrinterInfoManager& get();
|
|
// only called by SalData destructor, frees the global instance
|
|
static void release();
|
|
|
|
// get PrinterInfoManager type
|
|
Type getType() const { return m_eType; }
|
|
|
|
// lists the names of all known printers
|
|
void listPrinters( std::list< OUString >& rList ) const;
|
|
|
|
// gets the number of known printers
|
|
int countPrinters() const { return m_aPrinters.size(); }
|
|
|
|
// gets info about a named printer
|
|
const PrinterInfo& getPrinterInfo( const OUString& rPrinter ) const;
|
|
|
|
// gets the name of the default printer
|
|
const OUString& getDefaultPrinter() const { return m_aDefaultPrinter; }
|
|
|
|
virtual void setupJobContextData( JobData& rData );
|
|
|
|
// changes the info about a named printer
|
|
virtual void changePrinterInfo( const OUString& rPrinter, const PrinterInfo& rNewInfo );
|
|
|
|
// check if the printer configuration has changed
|
|
// if bwait is true, then this method waits for eventual asynchronous
|
|
// printer discovery to finish
|
|
virtual bool checkPrintersChanged( bool bWait );
|
|
|
|
// members for administration (->padmin)
|
|
|
|
// add a named printer
|
|
// addPrinter fails if a printer with the same name already exists
|
|
// or the driver does not exist
|
|
virtual bool addPrinter( const OUString& rPrinterName, const OUString& rDriverName );
|
|
|
|
// remove a named printer
|
|
// this fails if the config file belonging to this printer
|
|
// is not writeable
|
|
// if bCheckOnly is true, the printer is not really removed;
|
|
// this is for checking if the removal would fail
|
|
virtual bool removePrinter( const OUString& rPrinterName, bool bCheckOnly = false );
|
|
|
|
// save the changes to all printers. this fails if there
|
|
// is no writable config file at all
|
|
virtual bool writePrinterConfig();
|
|
|
|
// set a new default printer
|
|
// fails if the specified printer does not exist
|
|
virtual bool setDefaultPrinter( const OUString& rPrinterName );
|
|
|
|
// primarily used internally but also by padmin
|
|
// returns the printer queue names
|
|
virtual const std::list< SystemPrintQueue >& getSystemPrintQueues();
|
|
|
|
// similar but returnse whole commandlines
|
|
virtual void getSystemPrintCommands( std::list< OUString >& rCommands );
|
|
|
|
// abstract print command
|
|
// returns a stdio FILE* that a postscript file may be written to
|
|
// this may either be a regular file or the result of popen()
|
|
virtual FILE* startSpool( const OUString& rPrinterName, bool bQuickCommand );
|
|
// close the FILE* returned by startSpool and does the actual spooling
|
|
// set bBanner to "false" will attempt to suppress banner printing
|
|
// set bBanner to "true" will rely on the system default
|
|
// returns a numerical job id
|
|
virtual int endSpool( const OUString& rPrinterName, const OUString& rJobTitle, FILE* pFile, const JobData& rDocumentJobData, bool bBanner );
|
|
|
|
// for spadmin: whether adding or removing a printer is possible
|
|
virtual bool addOrRemovePossible() const;
|
|
|
|
bool getUseIncludeFeature() const { return m_bUseIncludeFeature; }
|
|
bool getUseJobPatch() const { return m_bUseJobPatch; }
|
|
|
|
// check whether a printer's feature string contains a subfeature
|
|
bool checkFeatureToken( const OUString& rPrinterName, const char* pToken ) const;
|
|
|
|
// set m_bDisableCUPS and update printer config
|
|
void setCUPSDisabled( bool );
|
|
|
|
// gets m_bDisableCUPS, initialized from printer config
|
|
bool isCUPSDisabled() const;
|
|
|
|
virtual ~PrinterInfoManager();
|
|
};
|
|
|
|
} // namespace
|
|
|
|
#endif // INCLUDED_VCL_PRINTERINFOMANAGER_HXX
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|