extensions/source/scanner/sane.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 #pragma once
  20
  21 #include <sal/config.h>
  22
  23 #include <string_view>
  24
  25 #include <cppuhelper/implbase.hxx>
  26 #include <osl/thread.h>
  27 #include <osl/module.h>
  28 #include <tools/stream.hxx>
  29 #include <tools/link.hxx>
  30 #include <sane/sane.h>
  31
  32 #include <com/sun/star/awt/XBitmap.hpp>
  33 #include <com/sun/star/uno/Sequence.hxx>
  34
  35 using namespace com::sun::star::uno;
  36
  37
  38 class BitmapTransporter: public cppu::WeakImplHelper<css::awt::XBitmap>
  39 {
  40     SvMemoryStream                      m_aStream;
  41     osl::Mutex                          m_aProtector;
  42
  43 public:
  44
  45                                         BitmapTransporter();
  46     virtual                             ~BitmapTransporter() override;
  47
  48     virtual css::awt::Size SAL_CALL          getSize() override;
  49     virtual Sequence< sal_Int8 > SAL_CALL    getDIB() override;
  50     virtual Sequence< sal_Int8 > SAL_CALL    getMaskDIB() override { return Sequence< sal_Int8 >(); }
  51
  52     // Misc
  53     void                                lock() { m_aProtector.acquire(); }
  54     void                                unlock() { m_aProtector.release(); }
  55     SvMemoryStream&                     getStream() { return m_aStream; }
  56 };
  57
  58
  59 class Sane
  60 {
  61 private:
  62     static int              nRefCount;
  63     static oslModule        pSaneLib;
  64
  65     static SANE_Status      (*p_init)( SANE_Int*,
  66                                        SANE_Auth_Callback );
  67     static void             (*p_exit)();
  68     static SANE_Status      (*p_get_devices)( const SANE_Device***,
  69                                               SANE_Bool );
  70     static SANE_Status      (*p_open)( SANE_String_Const, SANE_Handle );
  71     static void             (*p_close)( SANE_Handle );
  72     static const SANE_Option_Descriptor* (*p_get_option_descriptor)(
  73         SANE_Handle, SANE_Int );
  74     static SANE_Status      (*p_control_option)( SANE_Handle, SANE_Int,
  75                                                  SANE_Action, void*,
  76                                                  SANE_Int* );
  77     static SANE_Status      (*p_get_parameters)( SANE_Handle,
  78                                                  SANE_Parameters* );
  79     static SANE_Status      (*p_start)( SANE_Handle );
  80     static SANE_Status      (*p_read)( SANE_Handle, SANE_Byte*, SANE_Int,
  81                                        SANE_Int* );
  82     static void             (*p_cancel)( SANE_Handle );
  83     static SANE_Status      (*p_set_io_mode)( SANE_Handle, SANE_Bool );
  84     static SANE_Status      (*p_get_select_fd)( SANE_Handle, SANE_Int* );
  85     static SANE_String_Const (*p_strstatus)( SANE_Status );
  86
  87     static SANE_Int             nVersion;
  88     static SANE_Device**        ppDevices;
  89     static int                  nDevices;
  90
  91     std::unique_ptr<const SANE_Option_Descriptor*[]> mppOptions;
  92     int                             mnOptions;
  93     int                             mnDevice;
  94     SANE_Handle                     maHandle;
  95
  96     Link<Sane&,void>                maReloadOptionsLink;
  97
  98     static inline oslGenericFunction
  99                     LoadSymbol( const char* );
 100     static void     Init();
 101     static void     DeInit();
 102
 103     SANE_Status ControlOption( int, SANE_Action, void* );
 104
 105     bool CheckConsistency( const char*, bool bInit = false );
 106
 107 public:
 108     Sane();
 109     ~Sane();
 110
 111     static bool         IsSane()
 112         { return pSaneLib != nullptr; }
 113     bool            IsOpen() const
 114         { return maHandle != nullptr; }
 115     static int              CountDevices()
 116         { return nDevices; }
 117     static OUString         GetName( int n )
 118         { return ppDevices[n]->name ? OUString( ppDevices[n]->name, strlen(ppDevices[n]->name),  osl_getThreadTextEncoding() ) : OUString(); }
 119     static OUString         GetVendor( int n )
 120         { return ppDevices[n]->vendor ? OUString( ppDevices[n]->vendor, strlen(ppDevices[n]->vendor), osl_getThreadTextEncoding() ) : OUString(); }
 121     static OUString         GetModel( int n )
 122         { return ppDevices[n]->model ? OUString( ppDevices[n]->model, strlen(ppDevices[n]->model), osl_getThreadTextEncoding() ) : OUString(); }
 123     static OUString         GetType( int n )
 124         { return ppDevices[n]->type ? OUString( ppDevices[n]->type, strlen(ppDevices[n]->type), osl_getThreadTextEncoding() ) : OUString(); }
 125
 126     OUString        GetOptionName( int n )
 127         { return mppOptions[n]->name ? OUString( mppOptions[n]->name, strlen(mppOptions[n]->name), osl_getThreadTextEncoding() ) : OUString(); }
 128     OUString        GetOptionTitle( int n )
 129         { return mppOptions[n]->title ? OUString( mppOptions[n]->title, strlen(mppOptions[n]->title), osl_getThreadTextEncoding() ) : OUString(); }
 130     SANE_Value_Type GetOptionType( int n )
 131         { return mppOptions[n]->type; }
 132     SANE_Unit       GetOptionUnit( int n )
 133         { return mppOptions[n]->unit; }
 134     OUString        GetOptionUnitName( int n );
 135     SANE_Int        GetOptionCap( int n )
 136         { return mppOptions[n]->cap; }
 137     SANE_Constraint_Type GetOptionConstraintType( int n )
 138         { return mppOptions[n]->constraint_type; }
 139     const char**    GetStringConstraint( int n )
 140         { return const_cast<const char**>(mppOptions[n]->constraint.string_list); }
 141     int             GetRange( int, std::unique_ptr<double[]>& );
 142
 143     inline int      GetOptionElements( int n );
 144     int             GetOptionByName( const char* );
 145     bool            GetOptionValue( int, bool& );
 146     bool            GetOptionValue( int, OString& );
 147     bool            GetOptionValue( int, double&, int nElement = 0 );
 148     bool            GetOptionValue( int, double* );
 149
 150     void            SetOptionValue( int, bool );
 151     void            SetOptionValue( int, std::u16string_view );
 152     void            SetOptionValue( int, double, int nElement = 0 );
 153     void            SetOptionValue( int, double const * );
 154
 155     bool            ActivateButtonOption( int );
 156
 157     int             CountOptions() { return mnOptions; }
 158     int             GetDeviceNumber() const { return mnDevice; }
 159
 160     bool            Open( const char* );
 161     bool            Open( int );
 162     void            Close();
 163     void            ReloadDevices();
 164     void            ReloadOptions();
 165
 166     bool            Start( BitmapTransporter& );
 167
 168     inline Link<Sane&,void>   SetReloadOptionsHdl( const Link<Sane&,void>& rLink );
 169 };
 170
 171
 172 inline int Sane::GetOptionElements( int n )
 173 {
 174     if( mppOptions[n]->type == SANE_TYPE_FIXED ||
 175         mppOptions[n]->type == SANE_TYPE_INT )
 176     {
 177         return mppOptions[n]->size/sizeof( SANE_Word );
 178     }
 179     return 1;
 180 }
 181
 182
 183 inline Link<Sane&,void> Sane::SetReloadOptionsHdl( const Link<Sane&,void>& rLink )
 184 {
 185     Link<Sane&,void> aRet = maReloadOptionsLink;
 186     maReloadOptionsLink = rLink;
 187     return aRet;
 188 }
 189
 190 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */