# Cppcheck report - LibreOffice: framework/source/services/taskcreatorsrv.cxx

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394

    /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
    /*
     * This file is part of the LibreOffice project.
     *
     * This Source Code Form is subject to the terms of the Mozilla Public
     * License, v. 2.0. If a copy of the MPL was not distributed with this
     * file, You can obtain one at http://mozilla.org/MPL/2.0/.
     *
     * This file incorporates work covered by the following license notice:
     *
     *   Licensed to the Apache Software Foundation (ASF) under one or more
     *   contributor license agreements. See the NOTICE file distributed
     *   with this work for additional information regarding copyright
     *   ownership. The ASF licenses this file to you under the Apache
     *   License, Version 2.0 (the "License"); you may not use this file
     *   except in compliance with the License. You may obtain a copy of
     *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
     */

    #include <helper/persistentwindowstate.hxx>
    #include <helper/tagwindowasmodified.hxx>
    #include <helper/titlebarupdate.hxx>
    #include <loadenv/targethelper.hxx>
    #include <taskcreatordefs.hxx>

    #include <com/sun/star/frame/Frame.hpp>
    #include <com/sun/star/frame/XFrame2.hpp>
    #include <com/sun/star/frame/XDesktop.hpp>
    #include <com/sun/star/awt/Rectangle.hpp>
    #include <com/sun/star/awt/Toolkit.hpp>
    #include <com/sun/star/awt/WindowDescriptor.hpp>
    #include <com/sun/star/awt/WindowAttribute.hpp>
    #include <com/sun/star/awt/VclWindowPeerAttribute.hpp>
    #include <com/sun/star/lang/XServiceInfo.hpp>
    #include <com/sun/star/lang/XSingleServiceFactory.hpp>

    #include <comphelper/sequenceashashmap.hxx>
    #include <cppuhelper/basemutex.hxx>
    #include <cppuhelper/compbase2.hxx>
    #include <cppuhelper/supportsservice.hxx>
    #include <svtools/colorcfg.hxx>
    #include <toolkit/helper/vclunohelper.hxx>
    #include <vcl/svapp.hxx>
    #include <vcl/window.hxx>

    using namespace framework;

    namespace {

    typedef ::cppu::WeakComponentImplHelper2<
        css::lang::XServiceInfo,
        css::lang::XSingleServiceFactory> TaskCreatorService_BASE;

    class TaskCreatorService : private cppu::BaseMutex,
                               public TaskCreatorService_BASE
    {
    private:

        /** @short  the global uno service manager.
            @descr  Must be used to create own needed services.
         */
        css::uno::Reference< css::uno::XComponentContext > m_xContext;

    public:

                 TaskCreatorService(const css::uno::Reference< css::uno::XComponentContext >& xContext);
        virtual ~TaskCreatorService(                                                                   );

        virtual OUString SAL_CALL getImplementationName()
            throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE
        {
            return OUString("com.sun.star.comp.framework.TaskCreator");
        }

        virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName)
            throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE
        {
            return cppu::supportsService(this, ServiceName);
        }

        virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames()
            throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE
        {
            css::uno::Sequence< OUString > aSeq(1);
            aSeq[0] = "com.sun.star.frame.TaskCreator";
            return aSeq;
        }

        // XSingleServiceFactory
        virtual css::uno::Reference< css::uno::XInterface > SAL_CALL createInstance()
            throw(css::uno::Exception       ,
                  css::uno::RuntimeException, std::exception) SAL_OVERRIDE;

        virtual css::uno::Reference< css::uno::XInterface > SAL_CALL createInstanceWithArguments(const css::uno::Sequence< css::uno::Any >& lArguments)
            throw(css::uno::Exception       ,
                  css::uno::RuntimeException, std::exception) SAL_OVERRIDE;

    private:

        css::uno::Reference< css::awt::XWindow > implts_createContainerWindow( const css::uno::Reference< css::awt::XWindow >& xParentWindow ,
                                                                               const css::awt::Rectangle&                      aPosSize      ,
                                                                                     bool                                  bTopWindow    );

        void implts_applyDocStyleToWindow(const css::uno::Reference< css::awt::XWindow >& xWindow) const;

        css::uno::Reference< css::frame::XFrame2 > implts_createFrame( const css::uno::Reference< css::frame::XFrame >& xParentFrame     ,
                                                                      const css::uno::Reference< css::awt::XWindow >&  xContainerWindow ,
                                                                      const OUString&                           sName            );

        void implts_establishWindowStateListener( const css::uno::Reference< css::frame::XFrame2 >& xFrame );
        void implts_establishTitleBarUpdate( const css::uno::Reference< css::frame::XFrame2 >& xFrame );

        void implts_establishDocModifyListener( const css::uno::Reference< css::frame::XFrame2 >& xFrame );

        OUString impl_filterNames( const OUString& sName );
    };

    TaskCreatorService::TaskCreatorService(const css::uno::Reference< css::uno::XComponentContext >& xContext)
        : TaskCreatorService_BASE(m_aMutex)
        , m_xContext         (xContext                     )
    {
    }

    TaskCreatorService::~TaskCreatorService()
    {
    }

    css::uno::Reference< css::uno::XInterface > SAL_CALL TaskCreatorService::createInstance()
        throw(css::uno::Exception       ,
              css::uno::RuntimeException, std::exception)
    {
        return createInstanceWithArguments(css::uno::Sequence< css::uno::Any >());
    }

    css::uno::Reference< css::uno::XInterface > SAL_CALL TaskCreatorService::createInstanceWithArguments(const css::uno::Sequence< css::uno::Any >& lArguments)
        throw(css::uno::Exception       ,
              css::uno::RuntimeException, std::exception)
    {
        ::comphelper::SequenceAsHashMap lArgs(lArguments);

        css::uno::Reference< css::frame::XFrame > xParentFrame                  = lArgs.getUnpackedValueOrDefault(OUString(ARGUMENT_PARENTFRAME)                  , css::uno::Reference< css::frame::XFrame >());
        OUString                           sFrameName                    = lArgs.getUnpackedValueOrDefault(OUString(ARGUMENT_FRAMENAME)                    , OUString()                          );
        bool                                  bVisible                      = lArgs.getUnpackedValueOrDefault(OUString(ARGUMENT_MAKEVISIBLE)                  , sal_False                                  );
        bool                                  bCreateTopWindow              = lArgs.getUnpackedValueOrDefault(OUString(ARGUMENT_CREATETOPWINDOW)              , sal_True                                   );
        // only possize=[0,0,0,0] triggers default handling of vcl !
        css::awt::Rectangle                       aPosSize                      = lArgs.getUnpackedValueOrDefault(OUString(ARGUMENT_POSSIZE)                      , css::awt::Rectangle(0, 0, 0, 0)            );
        css::uno::Reference< css::awt::XWindow >  xContainerWindow              = lArgs.getUnpackedValueOrDefault(OUString(ARGUMENT_CONTAINERWINDOW)              , css::uno::Reference< css::awt::XWindow >() );
        bool                                  bSupportPersistentWindowState = lArgs.getUnpackedValueOrDefault(OUString(ARGUMENT_SUPPORTPERSISTENTWINDOWSTATE) , sal_False                                  );
        bool                                  bEnableTitleBarUpdate         = lArgs.getUnpackedValueOrDefault(OUString(ARGUMENT_ENABLE_TITLEBARUPDATE)        , sal_True                                   );

        // We use FrameName property to set it as API name of the new created frame later.
        // But those frame names must be different from the set of special target names as e.g. _blank, _self etcpp !
        OUString sRightName = impl_filterNames(sFrameName);

        // if no external frame window was given ... create a new one.
        if ( ! xContainerWindow.is())
        {
            css::uno::Reference< css::awt::XWindow > xParentWindow;
            if (xParentFrame.is())
                xParentWindow = xParentFrame->getContainerWindow();

            // Parent has no own window ...
            // So we have to create a top level window always !
            if ( ! xParentWindow.is())
                bCreateTopWindow = true;

            xContainerWindow = implts_createContainerWindow(xParentWindow, aPosSize, bCreateTopWindow);
        }

        // #i53630#
        // Mark all document windows as "special ones", so VCL can bind
        // special features to it. Because VCL doesn't know anything about documents ...
        // Note: Doing so it's no longer supported, that e.g. our wizards can use findFrame(_blank)
        // to create it's previes frames. They must do it manually by using WindowDescriptor+Toolkit!
        css::uno::Reference< css::frame::XDesktop > xDesktop(xParentFrame, css::uno::UNO_QUERY);
        bool bTopLevelDocumentWindow = (
                                                sRightName.isEmpty() &&
                                                (
                                                    (! xParentFrame.is() )    ||
                                                    (  xDesktop.is()     )
                                                )
                                             );
        if (bTopLevelDocumentWindow)
            implts_applyDocStyleToWindow(xContainerWindow);
        //------------------->

        // create the new frame
        css::uno::Reference< css::frame::XFrame2 > xFrame = implts_createFrame(xParentFrame, xContainerWindow, sRightName);

        // special freature:
        // A special listener will restore pos/size states in case
        // a component was loaded into the frame first time.
        if (bSupportPersistentWindowState)
            implts_establishWindowStateListener(xFrame);

        // special feature: On Mac we need tagging the window in case
        // the underlying model was modified.
        // VCL will ignore our calls in case different platform then Mac
        // is used ...
        if (bTopLevelDocumentWindow)
            implts_establishDocModifyListener (xFrame);

        // special freature:
        // A special listener will update title bar (text and icon)
        // if component of frame will be changed.
        if (bEnableTitleBarUpdate)
            implts_establishTitleBarUpdate(xFrame);

        // Make it visible directly here ...
        // if its required from outside.
        if (bVisible)
            xContainerWindow->setVisible(bVisible);

        return css::uno::Reference< css::uno::XInterface >(xFrame, css::uno::UNO_QUERY_THROW);
    }

    void TaskCreatorService::implts_applyDocStyleToWindow(const css::uno::Reference< css::awt::XWindow >& xWindow) const
    {
        // SYNCHRONIZED ->
        SolarMutexGuard aSolarGuard;
        vcl::Window* pVCLWindow = VCLUnoHelper::GetWindow(xWindow);
        if (pVCLWindow)
            pVCLWindow->SetExtendedStyle(WB_EXT_DOCUMENT);
        // <- SYNCHRONIZED
    }

    css::uno::Reference< css::awt::XWindow > TaskCreatorService::implts_createContainerWindow( const css::uno::Reference< css::awt::XWindow >& xParentWindow ,
                                                                                               const css::awt::Rectangle&                      aPosSize      ,
                                                                                                     bool                                  bTopWindow    )
    {
        // get toolkit to create task container window
        css::uno::Reference< css::awt::XToolkit2 > xToolkit = css::awt::Toolkit::create( m_xContext );

        // Check if child frames can be created really. We need at least a valid window at the parent frame ...
        css::uno::Reference< css::awt::XWindowPeer > xParentWindowPeer;
        if ( ! bTopWindow)
        {
            if ( ! xParentWindow.is())
                bTopWindow = false;
            else
                xParentWindowPeer = css::uno::Reference< css::awt::XWindowPeer >(xParentWindow, css::uno::UNO_QUERY_THROW);
        }

        // describe window properties.
        css::awt::WindowDescriptor aDescriptor;
        if (bTopWindow)
        {
            aDescriptor.Type                =   css::awt::WindowClass_TOP;
            aDescriptor.WindowServiceName   =   "window";
            aDescriptor.ParentIndex         =   -1;
            aDescriptor.Parent              =   css::uno::Reference< css::awt::XWindowPeer >();
            aDescriptor.Bounds              =   aPosSize;
            aDescriptor.WindowAttributes    =   css::awt::WindowAttribute::BORDER               |
                                                css::awt::WindowAttribute::MOVEABLE             |
                                                css::awt::WindowAttribute::SIZEABLE             |
                                                css::awt::WindowAttribute::CLOSEABLE            |
                                                css::awt::VclWindowPeerAttribute::CLIPCHILDREN;
        }
        else
        {
            aDescriptor.Type                =   css::awt::WindowClass_TOP;
            aDescriptor.WindowServiceName   =   "dockingwindow";
            aDescriptor.ParentIndex         =   1;
            aDescriptor.Parent              =   xParentWindowPeer;
            aDescriptor.Bounds              =   aPosSize;
            aDescriptor.WindowAttributes    =   css::awt::VclWindowPeerAttribute::CLIPCHILDREN;
        }

        // create a new blank container window and get access to parent container to append new created task.
        css::uno::Reference< css::awt::XWindowPeer > xPeer      = xToolkit->createWindow( aDescriptor );
        css::uno::Reference< css::awt::XWindow >     xWindow    ( xPeer, css::uno::UNO_QUERY );
        if ( ! xWindow.is())
            throw css::uno::Exception("TaskCreator service was not able to create suitable frame window.",
                                      static_cast< ::cppu::OWeakObject* >(this));

        sal_Int32 nBackground = 0xffffffff;

        if (bTopWindow)
        {
            try
            {
                nBackground = ::svtools::ColorConfig().GetColorValue(::svtools::APPBACKGROUND).nColor;
            }
            catch (const css::uno::Exception &)
            {
                // Ignore
            }
        }
        xPeer->setBackground(nBackground);

        return xWindow;
    }

    css::uno::Reference< css::frame::XFrame2 > TaskCreatorService::implts_createFrame( const css::uno::Reference< css::frame::XFrame >& xParentFrame    ,
                                                                                      const css::uno::Reference< css::awt::XWindow >&  xContainerWindow,
                                                                                      const OUString&                           sName           )
    {
        // create new frame.
        css::uno::Reference< css::frame::XFrame2 > xNewFrame = css::frame::Frame::create( m_xContext );

        // Set window on frame.
        // Do it before calling any other interface methods ...
        // The new created frame must be initialized before you can do anything else there.
        xNewFrame->initialize( xContainerWindow );

        // Put frame to the frame tree.
        // Note: The property creator/parent will be set on the new putted frame automatically ... by the parent container.
        if (xParentFrame.is())
        {
            css::uno::Reference< css::frame::XFramesSupplier > xSupplier  (xParentFrame, css::uno::UNO_QUERY_THROW);
            css::uno::Reference< css::frame::XFrames >         xContainer = xSupplier->getFrames();
            xContainer->append( css::uno::Reference<css::frame::XFrame>(xNewFrame, css::uno::UNO_QUERY_THROW) );
        }

        // Set it's API name (if there is one from outside)
        if (!sName.isEmpty())
            xNewFrame->setName( sName );

        return xNewFrame;
    }

    void TaskCreatorService::implts_establishWindowStateListener( const css::uno::Reference< css::frame::XFrame2 >& xFrame )
    {
        // Special feature: It's allowed for frames using a top level window only!
        // We must create a special listener service and couple it with the new created task frame.
        // He will restore or save the window state of it ...
        // See used classes for further information too.
        PersistentWindowState* pPersistentStateHandler = new PersistentWindowState( m_xContext );
        css::uno::Reference< css::lang::XInitialization > xInit(static_cast< ::cppu::OWeakObject* >(pPersistentStateHandler), css::uno::UNO_QUERY_THROW);

        css::uno::Sequence< css::uno::Any > lInitData(1);
        lInitData[0] <<= xFrame;
        xInit->initialize(lInitData);
    }

    void TaskCreatorService::implts_establishDocModifyListener( const css::uno::Reference< css::frame::XFrame2 >& xFrame )
    {
        // Special feature: It's allowed for frames using a top level window only!
        // We must create a special listener service and couple it with the new created task frame.
        // It will tag the window as modified if the underlying model was modified ...
        TagWindowAsModified* pTag = new TagWindowAsModified();
        css::uno::Reference< css::lang::XInitialization > xInit(static_cast< ::cppu::OWeakObject* >(pTag), css::uno::UNO_QUERY_THROW);

        css::uno::Sequence< css::uno::Any > lInitData(1);
        lInitData[0] <<= xFrame;
        xInit->initialize(lInitData);
    }

    void TaskCreatorService::implts_establishTitleBarUpdate( const css::uno::Reference< css::frame::XFrame2 >& xFrame )
    {
        TitleBarUpdate* pHelper = new TitleBarUpdate (m_xContext);
        css::uno::Reference< css::lang::XInitialization > xInit(static_cast< ::cppu::OWeakObject* >(pHelper), css::uno::UNO_QUERY_THROW);

        css::uno::Sequence< css::uno::Any > lInitData(1);
        lInitData[0] <<= xFrame;
        xInit->initialize(lInitData);
    }

    OUString TaskCreatorService::impl_filterNames( const OUString& sName )
    {
        OUString sFiltered;
        if (TargetHelper::isValidNameForFrame(sName))
            sFiltered = sName;
        return sFiltered;
    }

    struct Instance {
        explicit Instance(
            css::uno::Reference<css::uno::XComponentContext> const & context):
            instance(
                static_cast<cppu::OWeakObject *>(new TaskCreatorService(context)))
        {
        }

        css::uno::Reference<css::uno::XInterface> instance;
    };

    struct Singleton:
        public rtl::StaticWithArg<
            Instance, css::uno::Reference<css::uno::XComponentContext>, Singleton>
    {};

    }

    extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface * SAL_CALL
    com_sun_star_comp_framework_TaskCreator_get_implementation(<--- The function 'com_sun_star_comp_framework_TaskCreator_get_implementation' is never used.
        css::uno::XComponentContext *context,
        css::uno::Sequence<css::uno::Any> const &)
    {
        return cppu::acquire(static_cast<cppu::OWeakObject *>(
                    Singleton::get(context).instance.get()));
    }

    /* vim:set shiftwidth=4 softtabstop=4 expandtab: */