vcl/unx/headless/svpinst.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: svpinst.hxx,v $
  10  * $Revision: 1.6.116.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _SVP_SALINST_HXX
  32 #define _SVP_SALINST_HXX
  33
  34 #include <vcl/salinst.hxx>
  35 #include <vcl/salwtype.hxx>
  36 #include <vcl/saltimer.hxx>
  37 #include <vos/mutex.hxx>
  38 #include <vos/thread.hxx>
  39
  40 #include <list>
  41
  42 #include <time.h>  // timeval
  43
  44 #define VIRTUAL_DESKTOP_WIDTH 1024
  45 #define VIRTUAL_DESKTOP_HEIGHT 768
  46 #define VIRTUAL_DESKTOP_DEPTH 24
  47
  48 // -------------------------------------------------------------------------
  49 // SalYieldMutex
  50 // -------------------------------------------------------------------------
  51
  52 class SvpSalYieldMutex : public NAMESPACE_VOS(OMutex)
  53 {
  54 protected:
  55     ULONG                                                                               mnCount;
  56     NAMESPACE_VOS(OThread)::TThreadIdentifier   mnThreadId;
  57
  58 public:
  59                                                 SvpSalYieldMutex();
  60
  61     virtual void                                                                acquire();
  62     virtual void                                                                release();
  63     virtual sal_Bool                                                    tryToAcquire();
  64
  65     ULONG                                                                               GetAcquireCount() const { return mnCount; }
  66     NAMESPACE_VOS(OThread)::TThreadIdentifier   GetThreadId() const { return mnThreadId; }
  67 };
  68
  69 // ---------------
  70 // - SalTimer -
  71 // ---------------
  72 class SvpSalInstance;
  73 class SvpSalTimer : public SalTimer
  74 {
  75     SvpSalInstance* m_pInstance;
  76 public:
  77     SvpSalTimer( SvpSalInstance* pInstance ) : m_pInstance( pInstance ) {}
  78     virtual ~SvpSalTimer();
  79
  80     // overload all pure virtual methods
  81     virtual void Start( ULONG nMS );
  82     virtual void Stop();
  83 };
  84
  85 // ---------------
  86 // - SalInstance -
  87 // ---------------
  88 class SvpSalFrame;
  89 class SvpSalInstance : public SalInstance
  90 {
  91     timeval                         m_aTimeout;
  92     ULONG               m_nTimeoutMS;
  93     int                 m_pTimeoutFDS[2];
  94     SvpSalYieldMutex    m_aYieldMutex;
  95
  96     // internal event queue
  97     struct SalUserEvent
  98     {
  99         const SalFrame*         m_pFrame;
 100         void*                       m_pData;
 101         USHORT                     m_nEvent;
 102
 103         SalUserEvent( const SalFrame* pFrame, void* pData, USHORT nEvent = SALEVENT_USEREVENT )
 104                 : m_pFrame( pFrame ),
 105                   m_pData( pData ),
 106                   m_nEvent( nEvent )
 107         {}
 108     };
 109
 110     oslMutex        m_aEventGuard;
 111     std::list< SalUserEvent > m_aUserEvents;
 112
 113     std::list< SalFrame* > m_aFrames;
 114 public:
 115     static SvpSalInstance* s_pDefaultInstance;
 116
 117     SvpSalInstance();
 118     virtual ~SvpSalInstance();
 119
 120     void PostEvent( const SalFrame* pFrame, void* pData, USHORT nEvent );
 121     void CancelEvent( const SalFrame* pFrame, void* pData, USHORT nEvent );
 122
 123     void StartTimer( ULONG nMS );
 124     void StopTimer();
 125     void Wakeup();
 126
 127     void registerFrame( SalFrame* pFrame ) { m_aFrames.push_back( pFrame ); }
 128     void deregisterFrame( SalFrame* pFrame );
 129     const std::list< SalFrame* >& getFrames() const { return m_aFrames; }
 130
 131     bool            CheckTimeout( bool bExecuteTimers = true );
 132
 133     // Frame
 134     virtual SalFrame*           CreateChildFrame( SystemParentData* pParent, ULONG nStyle );
 135     virtual SalFrame*           CreateFrame( SalFrame* pParent, ULONG nStyle );
 136     virtual void                        DestroyFrame( SalFrame* pFrame );
 137
 138     // Object (System Child Window)
 139     virtual SalObject*          CreateObject( SalFrame* pParent, SystemWindowData* pWindowData, BOOL bShow = TRUE );
 140     virtual void                        DestroyObject( SalObject* pObject );
 141
 142     // VirtualDevice
 143     // nDX and nDY in Pixel
 144     // nBitCount: 0 == Default(=as window) / 1 == Mono
 145     // pData allows for using a system dependent graphics or device context
 146     virtual SalVirtualDevice*   CreateVirtualDevice( SalGraphics* pGraphics,
 147                                                      long nDX, long nDY,
 148                                                      USHORT nBitCount, const SystemGraphicsData *pData = NULL );
 149     virtual void                                DestroyVirtualDevice( SalVirtualDevice* pDevice );
 150
 151     // Printer
 152     // pSetupData->mpDriverData can be 0
 153     // pSetupData must be updatet with the current
 154     // JobSetup
 155     virtual SalInfoPrinter*     CreateInfoPrinter( SalPrinterQueueInfo* pQueueInfo,
 156                                                ImplJobSetup* pSetupData );
 157     virtual void                        DestroyInfoPrinter( SalInfoPrinter* pPrinter );
 158     virtual SalPrinter*         CreatePrinter( SalInfoPrinter* pInfoPrinter );
 159     virtual void                        DestroyPrinter( SalPrinter* pPrinter );
 160
 161     virtual void                        GetPrinterQueueInfo( ImplPrnQueueList* pList );
 162     virtual void                        GetPrinterQueueState( SalPrinterQueueInfo* pInfo );
 163     virtual void                        DeletePrinterQueueInfo( SalPrinterQueueInfo* pInfo );
 164     virtual String          GetDefaultPrinter();
 165
 166     // SalTimer
 167     virtual SalTimer*           CreateSalTimer();
 168     // SalI18NImeStatus
 169     virtual SalI18NImeStatus*   CreateI18NImeStatus();
 170     // SalSystem
 171     virtual SalSystem*          CreateSalSystem();
 172     // SalBitmap
 173     virtual SalBitmap*          CreateSalBitmap();
 174
 175     // YieldMutex
 176     virtual vos::IMutex*        GetYieldMutex();
 177     virtual ULONG                       ReleaseYieldMutex();
 178     virtual void                        AcquireYieldMutex( ULONG nCount );
 179
 180     // wait next event and dispatch
 181     // must returned by UserEvent (SalFrame::PostEvent)
 182     // and timer
 183     virtual void                        Yield( bool bWait, bool bHandleAllCurrentEvents );
 184     virtual bool                        AnyInput( USHORT nType );
 185
 186                             // Menues
 187     virtual SalMenu*        CreateMenu( BOOL bMenuBar );
 188     virtual void            DestroyMenu( SalMenu* pMenu);
 189     virtual SalMenuItem*    CreateMenuItem( const SalItemParams* pItemData );
 190     virtual void            DestroyMenuItem( SalMenuItem* pItem );
 191
 192     // may return NULL to disable session management
 193     virtual SalSession*         CreateSalSession();
 194
 195     virtual void*                       GetConnectionIdentifier( ConnectionIdentifierType& rReturnedType, int& rReturnedBytes );
 196
 197     virtual void            AddToRecentDocumentList(const rtl::OUString& rFileUrl, const rtl::OUString& rMimeType);
 198 };
 199
 200 #endif // _SV_SALINST_HXX