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