basctl/source/basicide/documentenumeration.cxx

   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 #include <sal/config.h>
  21
  22 #include <set>
  23
  24 #include "documentenumeration.hxx"
  25
  26 #include <com/sun/star/frame/Desktop.hpp>
  27 #include <com/sun/star/frame/XModel2.hpp>
  28 #include <com/sun/star/frame/FrameSearchFlag.hpp>
  29
  30 #include <tools/diagnose_ex.h>
  31
  32 #include <comphelper/stl_types.hxx>
  33
  34 namespace basctl { namespace docs {
  35
  36     using ::com::sun::star::uno::Exception;
  37     using ::com::sun::star::uno::Reference;
  38     using ::com::sun::star::uno::UNO_QUERY_THROW;
  39     using ::com::sun::star::uno::UNO_SET_THROW;
  40     using ::com::sun::star::frame::Desktop;
  41     using ::com::sun::star::frame::XDesktop2;
  42     using ::com::sun::star::container::XEnumeration;
  43     using ::com::sun::star::frame::XModel;
  44     using ::com::sun::star::frame::XFrames;
  45     using ::com::sun::star::frame::XController;
  46     using ::com::sun::star::frame::XModel2;
  47     using ::com::sun::star::uno::UNO_QUERY;
  48     using ::com::sun::star::uno::Sequence;
  49     using ::com::sun::star::frame::XFrame;
  50
  51     namespace FrameSearchFlag = ::com::sun::star::frame::FrameSearchFlag;
  52
  53     // DocumentEnumeration_Data
  54     struct DocumentEnumeration_Data
  55     {
  56         Reference< css::uno::XComponentContext > aContext;
  57         const IDocumentDescriptorFilter*    pFilter;
  58
  59         DocumentEnumeration_Data( Reference< css::uno::XComponentContext > const & _rContext, const IDocumentDescriptorFilter* _pFilter )
  60             :aContext( _rContext )
  61             ,pFilter( _pFilter )
  62         {
  63         }
  64     };
  65
  66     // DocumentEnumeration
  67     DocumentEnumeration::DocumentEnumeration( Reference< css::uno::XComponentContext > const & _rContext, const IDocumentDescriptorFilter* _pFilter )
  68         :m_pData( new DocumentEnumeration_Data( _rContext, _pFilter ) )
  69     {
  70     }
  71
  72     DocumentEnumeration::~DocumentEnumeration()
  73     {
  74     }
  75
  76     namespace
  77     {
  78         void lcl_getDocumentControllers_nothrow( DocumentDescriptor& _io_rDocDesc )
  79         {
  80             OSL_PRECOND( _io_rDocDesc.xModel.is(), "lcl_getDocumentControllers_nothrow: illegal model!" );
  81
  82             _io_rDocDesc.aControllers.clear();
  83             try
  84             {
  85                 Reference< XModel2 > xModel2( _io_rDocDesc.xModel, UNO_QUERY );
  86                 if ( xModel2.is() )
  87                 {
  88                     Reference< XEnumeration > xEnum( xModel2->getControllers(), UNO_SET_THROW );
  89                     while ( xEnum->hasMoreElements() )
  90                     {
  91                         Reference< XController > xController( xEnum->nextElement(), UNO_QUERY_THROW );
  92                         _io_rDocDesc.aControllers.push_back( xController );
  93                     }
  94                 }
  95                 else if ( _io_rDocDesc.xModel.is() )
  96                     _io_rDocDesc.aControllers.push_back( _io_rDocDesc.xModel->getCurrentController() );
  97             }
  98             catch( const Exception& )
  99             {
 100                 DBG_UNHANDLED_EXCEPTION("basctl.basicide");
 101             }
 102         }
 103
 104         void lcl_getDocuments_nothrow( const Sequence< Reference< XFrame > >& _rFrames, Documents& _out_rDocuments,
 105             const IDocumentDescriptorFilter* _pFilter )
 106         {
 107             // ensure we don't encounter some models multiple times
 108             std::set< Reference< XModel >, ::comphelper::OInterfaceCompare< XModel > > aEncounteredModels;
 109
 110             for ( auto const & rFrame : _rFrames )
 111             {
 112                 try
 113                 {
 114                     OSL_ENSURE( rFrame.is(), "lcl_getDocuments_nothrow: illegal frame!" );
 115                     if ( !rFrame.is() )
 116                         continue;
 117                     Reference< XController > xController( rFrame->getController() );
 118                     if ( !xController.is() )
 119                         continue;
 120
 121                     Reference< XModel > xModel( xController->getModel() );
 122                     if ( !xModel.is() )
 123                         // though it's legal for a controller to not have a model, we're not interested in
 124                         // those
 125                         continue;
 126
 127                     if ( aEncounteredModels.find( xModel ) != aEncounteredModels.end() )
 128                         // there might be multiple frames for the same model
 129                         // handle it only once
 130                         continue;
 131                     aEncounteredModels.insert( xModel );
 132
 133                     // create a DocumentDescriptor
 134                     DocumentDescriptor aDescriptor;
 135                     aDescriptor.xModel = xModel;
 136                     lcl_getDocumentControllers_nothrow( aDescriptor );
 137
 138                     // consult filter, if there is one
 139                     if ( _pFilter && !_pFilter->includeDocument( aDescriptor ) )
 140                         continue;
 141
 142                     _out_rDocuments.push_back( aDescriptor );
 143                 }
 144                 catch( const Exception& )
 145                 {
 146                     DBG_UNHANDLED_EXCEPTION("basctl.basicide");
 147                 }
 148             }
 149         }
 150     }
 151
 152     void DocumentEnumeration::getDocuments( Documents& _out_rDocuments ) const
 153     {
 154         _out_rDocuments.clear();
 155
 156         try
 157         {
 158             const Reference< XDesktop2 > xDesktop = Desktop::create( m_pData->aContext );
 159             const Reference< XFrames > xFrames( xDesktop->getFrames(), UNO_SET_THROW );
 160             const Sequence< Reference< XFrame > > aFrames( xFrames->queryFrames( FrameSearchFlag::ALL ) );
 161
 162             lcl_getDocuments_nothrow( aFrames, _out_rDocuments, m_pData->pFilter );
 163         }
 164         catch( const Exception& )
 165         {
 166             DBG_UNHANDLED_EXCEPTION("basctl.basicide");
 167         }
 168     }
 169
 170 } } // namespace basctl::docs
 171
 172 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */