widget/src/gtk2/nsCUPSShim.h

   1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ex: set tabstop=8 softtabstop=4 shiftwidth=4 expandtab: */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla PostScript driver printer list component.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Kenneth Herron <kherron+mozilla@fmailbox.com>
  20  * Portions created by the Initial Developer are Copyright (C) 2004
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsCUPSShim_h___
  40 #define nsCUPSShim_h___
  41
  42 #include "prtypes.h"
  43
  44 /* Various CUPS data types. We don't #include cups headers to avoid
  45  * requiring CUPS to be installed on the build host (and to avoid having
  46  * to test for CUPS in configure).
  47  */
  48 typedef struct                          /**** Printer Options ****/
  49 {
  50     char          *name;                  /* Name of option */
  51     char          *value;                 /* Value of option */
  52 } cups_option_t;
  53
  54 typedef struct               /**** Destination ****/
  55 {
  56     char          *name,       /* Printer or class name */
  57                   *instance;   /* Local instance name or NULL */
  58     int           is_default;  /* Is this printer the default? */
  59     int           num_options; /* Number of options */
  60     cups_option_t *options;    /* Options */
  61 } cups_dest_t;
  62
  63 typedef cups_dest_t* (PR_CALLBACK *CupsGetDestType)(const char *printer,
  64                                                     const char *instance,
  65                                                     int num_dests,
  66                                                     cups_dest_t *dests);
  67 typedef int (PR_CALLBACK *CupsGetDestsType)(cups_dest_t **dests);
  68 typedef int (PR_CALLBACK *CupsFreeDestsType)(int         num_dests,
  69                                              cups_dest_t *dests);
  70 typedef int (PR_CALLBACK *CupsPrintFileType)(const char    *printer,
  71                                              const char    *filename,
  72                                              const char    *title,
  73                                              int           num_options,
  74                                              cups_option_t *options);
  75 typedef int (PR_CALLBACK *CupsTempFdType)(char *filename,
  76                                           int   length);
  77 typedef int (PR_CALLBACK *CupsAddOptionType)(const char    *name,
  78                                              const char    *value,
  79                                              int           num_options,
  80                                              cups_option_t **options);
  81
  82 struct PRLibrary;
  83
  84 /* Note: this class relies on static initialization. */
  85 class nsCUPSShim {
  86     public:
  87         /**
  88          * Initialize this object. Attempt to load the CUPS shared
  89          * library and find function pointers for the supported
  90          * functions (see below).
  91          * @return PR_FALSE if the shared library could not be loaded, or if
  92          *                  any of the functions could not be found.
  93          *         PR_TRUE  for successful initialization.
  94          */
  95         PRBool Init();
  96
  97         /**
  98          * @return PR_TRUE  if the object was initialized successfully.
  99          *         PR_FALSE otherwise.
 100          */
 101         PRBool IsInitialized() { return nsnull != mCupsLib; }
 102
 103         /* Function pointers for supported functions. These are only
 104          * valid after successful initialization.
 105          */
 106         CupsAddOptionType   mCupsAddOption;
 107         CupsFreeDestsType   mCupsFreeDests;
 108         CupsGetDestType     mCupsGetDest;
 109         CupsGetDestsType    mCupsGetDests;
 110         CupsPrintFileType   mCupsPrintFile;
 111         CupsTempFdType      mCupsTempFd;
 112
 113     private:
 114         PRLibrary *mCupsLib;
 115 };
 116
 117
 118
 119 #endif /* nsCUPSShim_h___ */