forms/source/runtime/formoperations.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
  20 #ifndef INCLUDED_FORMS_SOURCE_RUNTIME_FORMOPERATIONS_HXX
  21 #define INCLUDED_FORMS_SOURCE_RUNTIME_FORMOPERATIONS_HXX
  22
  23 #include <com/sun/star/form/runtime/XFormOperations.hpp>
  24 #include <com/sun/star/lang/XServiceInfo.hpp>
  25 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  26 #include <com/sun/star/form/XForm.hpp>
  27 #include <com/sun/star/beans/XPropertySet.hpp>
  28 #include <com/sun/star/form/XLoadable.hpp>
  29 #include <com/sun/star/sdb/XSingleSelectQueryComposer.hpp>
  30 #include <com/sun/star/util/XModifyListener.hpp>
  31 #include <com/sun/star/container/XIndexAccess.hpp>
  32 #include <com/sun/star/lang/XInitialization.hpp>
  33 #include <com/sun/star/sdb/SQLFilterOperator.hpp>
  34 #include <com/sun/star/uno/XComponentContext.hpp>
  35
  36 #include <cppuhelper/basemutex.hxx>
  37 #include <cppuhelper/compbase.hxx>
  38
  39
  40 namespace frm
  41 {
  42
  43
  44     //= FormOperations
  45
  46     typedef ::cppu::WeakComponentImplHelper    <   css::form::runtime::XFormOperations
  47                                                 ,   css::lang::XInitialization
  48                                                 ,   css::lang::XServiceInfo
  49                                                 ,   css::beans::XPropertyChangeListener
  50                                                 ,   css::util::XModifyListener
  51                                                 ,   css::sdbc::XRowSetListener
  52                                                 >   FormOperations_Base;
  53
  54     class FormOperations    :public ::cppu::BaseMutex
  55                             ,public FormOperations_Base
  56     {
  57     public:
  58         class MethodGuard;
  59
  60     private:
  61         css::uno::Reference<css::uno::XComponentContext>                      m_xContext;
  62         css::uno::Reference< css::form::runtime::XFormController >            m_xController;
  63         css::uno::Reference< css::sdbc::XRowSet >                             m_xCursor;
  64         css::uno::Reference< css::sdbc::XResultSetUpdate >                    m_xUpdateCursor;
  65         css::uno::Reference< css::beans::XPropertySet >                       m_xCursorProperties;
  66         css::uno::Reference< css::form::XLoadable >                           m_xLoadableForm;
  67         css::uno::Reference< css::form::runtime::XFeatureInvalidation >       m_xFeatureInvalidation;
  68         mutable css::uno::Reference< css::sdb::XSingleSelectQueryComposer >   m_xParser;
  69
  70         bool    m_bInitializedParser;
  71         bool    m_bActiveControlModified;
  72         bool    m_bConstructed;
  73     #ifdef DBG_UTIL
  74         mutable long
  75                 m_nMethodNestingLevel;
  76     #endif
  77
  78     public:
  79         explicit FormOperations( const css::uno::Reference< css::uno::XComponentContext >& _rxContext );
  80
  81         // XServiceInfo - static versions
  82         static OUString getImplementationName_Static(  ) throw(css::uno::RuntimeException);
  83         static css::uno::Sequence< OUString > getSupportedServiceNames_Static(  ) throw(css::uno::RuntimeException);
  84
  85         struct MethodAccess { friend class MethodGuard; private: MethodAccess() { } };
  86
  87         inline void enterMethod( MethodAccess ) const
  88         {
  89             m_aMutex.acquire();
  90             impl_checkDisposed_throw();
  91         #ifdef DBG_UTIL
  92             ++m_nMethodNestingLevel;
  93         #endif
  94         }
  95
  96         inline void leaveMethod( MethodAccess ) const
  97         {
  98             m_aMutex.release();
  99         #ifdef DBG_UTIL
 100             --m_nMethodNestingLevel;
 101         #endif
 102         }
 103
 104     protected:
 105         virtual ~FormOperations();
 106
 107         // XInitialization
 108         virtual void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any >& aArguments ) throw (css::uno::Exception, css::uno::RuntimeException, std::exception) override;
 109
 110         // XServiceInfo
 111         virtual OUString SAL_CALL getImplementationName(  ) throw (css::uno::RuntimeException, std::exception) override;
 112         virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) throw (css::uno::RuntimeException, std::exception) override;
 113         virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) throw (css::uno::RuntimeException, std::exception) override;
 114
 115         // XFormOperations
 116         virtual css::uno::Reference< css::sdbc::XRowSet > SAL_CALL getCursor() throw (css::uno::RuntimeException, std::exception) override;
 117         virtual css::uno::Reference< css::sdbc::XResultSetUpdate > SAL_CALL getUpdateCursor() throw (css::uno::RuntimeException, std::exception) override;
 118         virtual css::uno::Reference< css::form::runtime::XFormController > SAL_CALL getController() throw (css::uno::RuntimeException, std::exception) override;
 119         virtual css::uno::Reference< css::form::runtime::XFeatureInvalidation > SAL_CALL getFeatureInvalidation() throw (css::uno::RuntimeException, std::exception) override;
 120         virtual void SAL_CALL setFeatureInvalidation(const css::uno::Reference< css::form::runtime::XFeatureInvalidation > & the_value) throw (css::uno::RuntimeException, std::exception) override;
 121         virtual css::form::runtime::FeatureState SAL_CALL getState(::sal_Int16 Feature) throw (css::uno::RuntimeException, std::exception) override;
 122         virtual sal_Bool SAL_CALL isEnabled(::sal_Int16 Feature) throw (css::uno::RuntimeException, std::exception) override;
 123         virtual void SAL_CALL execute(::sal_Int16 Feature) throw (css::uno::RuntimeException, css::lang::IllegalArgumentException, css::sdbc::SQLException, css::lang::WrappedTargetException, std::exception) override;
 124         virtual void SAL_CALL executeWithArguments(::sal_Int16 Feature, const css::uno::Sequence< css::beans::NamedValue >& Arguments) throw (css::uno::RuntimeException, css::lang::IllegalArgumentException, css::sdbc::SQLException, css::lang::WrappedTargetException, std::exception) override;
 125         virtual sal_Bool SAL_CALL commitCurrentRecord(sal_Bool & RecordInserted) throw (css::uno::RuntimeException, css::sdbc::SQLException, std::exception) override;
 126         virtual sal_Bool SAL_CALL commitCurrentControl() throw (css::uno::RuntimeException, css::sdbc::SQLException, std::exception) override;
 127         virtual sal_Bool SAL_CALL isInsertionRow() throw (css::uno::RuntimeException, css::lang::WrappedTargetException, std::exception) override;
 128         virtual sal_Bool SAL_CALL isModifiedRow() throw (css::uno::RuntimeException, css::lang::WrappedTargetException, std::exception) override;
 129
 130         // XRowSetListener
 131         virtual void SAL_CALL cursorMoved( const css::lang::EventObject& event ) throw (css::uno::RuntimeException, std::exception) override;
 132         virtual void SAL_CALL rowChanged( const css::lang::EventObject& event ) throw (css::uno::RuntimeException, std::exception) override;
 133         virtual void SAL_CALL rowSetChanged( const css::lang::EventObject& event ) throw (css::uno::RuntimeException, std::exception) override;
 134
 135         // XModifyListener
 136         virtual void SAL_CALL modified( const css::lang::EventObject& _rSource ) throw( css::uno::RuntimeException, std::exception ) override;
 137
 138         // XPropertyChangeListener
 139         virtual void SAL_CALL propertyChange( const css::beans::PropertyChangeEvent& evt ) throw (css::uno::RuntimeException, std::exception) override;
 140
 141         // XEventListener
 142         virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) throw (css::uno::RuntimeException, std::exception) override;
 143
 144         // XComponent/OComponentHelper
 145         virtual void SAL_CALL disposing() override;
 146
 147     private:
 148         // service constructors
 149         void    createWithFormController( const css::uno::Reference< css::form::runtime::XFormController >& _rxController );
 150         void    createWithForm( const css::uno::Reference< css::form::XForm >& _rxForm );
 151
 152         /** determines whether or not we're already disposed
 153         */
 154         inline bool impl_isDisposed_nothrow() const { return !m_xCursor.is(); }
 155
 156         /** checks whether the instance is already disposed, and throws an exception if so
 157         */
 158         void        impl_checkDisposed_throw() const;
 159
 160         /** initializes the instance after m_xController has been set
 161             @precond
 162                 m_xController is not <NULL/>
 163         */
 164         void        impl_initFromController_throw();
 165
 166         /** initializes the instance after m_xCursor has been set
 167             @precond
 168                 m_xCursor is not <NULL/>
 169         */
 170         void        impl_initFromForm_throw();
 171
 172         /// invalidate the full palette of features which we know
 173         void        impl_invalidateAllSupportedFeatures_nothrow( MethodGuard& _rClearForCallback ) const;
 174
 175         /** invalidate the features which depend on the "modified" state of the current control
 176             of our controller
 177         */
 178         void        impl_invalidateModifyDependentFeatures_nothrow( MethodGuard& _rClearForCallback ) const;
 179
 180         /** ensures that our parse is initialized, or at least that we attempted to do so
 181             @precond
 182                 we're not disposed
 183         */
 184         void        impl_ensureInitializedParser_nothrow();
 185
 186         /// disposes our parser, if we have one
 187         void        impl_disposeParser_nothrow();
 188
 189         /** determines whether our cursor can be moved left
 190             @precond hasCursor()
 191         */
 192         bool        impl_canMoveLeft_throw() const;
 193
 194         /** determines whether our cursor can be moved right
 195             @precond hasCursor()
 196         */
 197         bool        impl_canMoveRight_throw() const;
 198
 199         /// determines whether we're positioned on the insertion row
 200         bool        impl_isInsertionRow_throw() const;
 201
 202         /// retrieves the RowCount property of the form
 203         sal_Int32   impl_getRowCount_throw() const;
 204
 205         /// retrieves the RowCountFinal property of the form
 206         bool        impl_isRowCountFinal_throw() const;
 207
 208         /// retrieves the IsModified property of the form
 209         bool        impl_isModifiedRow_throw() const;
 210
 211         /// determines whether we can parse the query of our form
 212         bool        impl_isParseable_throw() const;
 213
 214         /// determines if we have an active filter or order condition
 215         bool        impl_hasFilterOrOrder_throw() const;
 216
 217         /// determines whether our form is in "insert-only" mode
 218         bool        impl_isInsertOnlyForm_throw() const;
 219
 220         /** retrieces the column to which the current control of our controller is bound
 221             @precond
 222                 m_xController.is()
 223         */
 224         css::uno::Reference< css::beans::XPropertySet >
 225                     impl_getCurrentBoundField_nothrow( ) const;
 226
 227         /** returns the control model of the current control
 228
 229             If the current control is a grid control, then the returned model is the
 230             model of the current <em>column</em> in the grid.
 231
 232             @precond
 233                 m_xController.is()
 234         */
 235         css::uno::Reference< css::awt::XControlModel >
 236                     impl_getCurrentControlModel_throw() const;
 237
 238         /// determines if we have a valid cursor
 239         inline  bool    impl_hasCursor_nothrow() const { return m_xCursorProperties.is(); }
 240
 241         /** determines the model position from a grid control column's view position
 242
 243             A grid control can have columns which are currently hidden, so the index of a
 244             column in the view is not necessarily the same as its index in the model.
 245         */
 246         static sal_Int16   impl_gridView2ModelPos_nothrow( const css::uno::Reference< css::container::XIndexAccess >& _rxColumns, sal_Int16 _nViewPos );
 247
 248         /** moves our cursor one position to the left, caring for different possible
 249             cursor states.
 250
 251             Before the movement is done, the current row is saved, if necessary.
 252
 253             @precond
 254                 canMoveLeft()
 255         */
 256         void        impl_moveLeft_throw() const;
 257
 258         /** moves our cursor one position to the right, caring for different possible
 259             cursor states.
 260
 261             Before the movement is done, the current row is saved, if necessary.
 262
 263             @precond
 264                 canMoveRight()
 265         */
 266         void        impl_moveRight_throw( ) const;
 267
 268         /** impl-version of commitCurrentRecord, which can be called without caring for
 269             an output parameter, and within const-contexts
 270
 271             @precond
 272                 our mutex is locked
 273         */
 274         bool        impl_commitCurrentRecord_throw( sal_Bool* _pRecordInserted = nullptr ) const;
 275
 276         /** impl-version of commitCurrentControl, which can be called in const-contexts
 277
 278             @precond
 279                 our mutex is locked
 280         */
 281         bool        impl_commitCurrentControl_throw() const;
 282
 283         /// resets all control models in our own form
 284         void        impl_resetAllControls_nothrow() const;
 285
 286         /// executes the "auto sort ascending" and "auto sort descending" features
 287         void        impl_executeAutoSort_throw( bool _bUp ) const;
 288
 289         /// executes the "auto filter" feature
 290         void        impl_executeAutoFilter_throw( ) const;
 291
 292         /// executes the interactive sort resp. filter feature
 293         void        impl_executeFilterOrSort_throw( bool _bFilter ) const;
 294
 295     private:
 296         /** calls a (member) function, catches SQLExceptions, extends them with additional context information,
 297             and rethrows them
 298
 299             @param f
 300                 a functionoid with no arguments to do the work
 301             @param _nErrorResourceId
 302                 the id of the resources string to use as error message
 303         */
 304         template < typename FunctObj >
 305         void        impl_doActionInSQLContext_throw( FunctObj f, sal_uInt16 _nErrorResourceId ) const;
 306
 307         // functionoid to call appendOrderByColumn
 308         class impl_appendOrderByColumn_throw
 309         {
 310         public:
 311             impl_appendOrderByColumn_throw(const FormOperations *pFO,
 312                                            css::uno::Reference< css::beans::XPropertySet > xField,
 313                                            bool bUp)
 314                 : m_pFO(pFO)
 315                 , m_xField(xField)
 316                 , m_bUp(bUp)
 317             {};
 318
 319             void operator()() { m_pFO->m_xParser->appendOrderByColumn(m_xField, m_bUp); }
 320         private:
 321             const FormOperations *m_pFO;
 322             css::uno::Reference< css::beans::XPropertySet > m_xField;
 323             bool m_bUp;
 324         };
 325
 326         // functionoid to call appendFilterByColumn
 327         class impl_appendFilterByColumn_throw
 328         {
 329         public:
 330             impl_appendFilterByColumn_throw(const FormOperations *pFO,
 331                                             css::uno::Reference< css::beans::XPropertySet > xField)
 332                 : m_pFO(pFO)
 333                 , m_xField(xField)
 334             {};
 335
 336             void operator()() { m_pFO->m_xParser->appendFilterByColumn( m_xField, true, css::sdb::SQLFilterOperator::EQUAL ); }
 337         private:
 338             const FormOperations *m_pFO;
 339             css::uno::Reference< css::beans::XPropertySet > m_xField;
 340         };
 341
 342     private:
 343         FormOperations( const FormOperations& ) = delete;
 344         FormOperations& operator=( const FormOperations& ) = delete;
 345
 346     public:
 347         class MethodGuard
 348         {
 349             FormOperations& m_rOwner;
 350             bool            m_bCleared;
 351
 352         public:
 353             explicit MethodGuard( FormOperations& _rOwner )
 354                 :m_rOwner( _rOwner )
 355                 ,m_bCleared( false )
 356             {
 357                 m_rOwner.enterMethod( FormOperations::MethodAccess() );
 358             }
 359
 360             inline ~MethodGuard()
 361             {
 362                 clear();
 363             }
 364
 365             inline void clear()
 366             {
 367                 if ( !m_bCleared )
 368                     m_rOwner.leaveMethod( FormOperations::MethodAccess() );
 369                 m_bCleared = true;
 370             }
 371         };
 372     };
 373
 374
 375 } // namespace frm
 376
 377
 378 #endif // INCLUDED_FORMS_SOURCE_RUNTIME_FORMOPERATIONS_HXX
 379
 380 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */