fpicker/source/win32/filepicker/FilterContainer.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 <memory>
  23 #include <stdexcept>
  24 #include <osl/diagnose.h>
  25 #include "FilterContainer.hxx"
  26
  27 #include <utility>
  28
  29 #if !defined WIN32_LEAN_AND_MEAN
  30 # define WIN32_LEAN_AND_MEAN
  31 #endif
  32 #include <windows.h>
  33
  34 CFilterContainer::CFilterContainer( sal_Int32 initSize ) :
  35     m_vFilters( initSize ),
  36     m_bIterInitialized( false )
  37 {
  38 }
  39
  40 // add a name/filter pair
  41
  42 bool CFilterContainer::addFilter(
  43     const OUString& aName, const OUString& aFilter, bool bAllowDuplicates )
  44 {
  45     // check if the filter is already in the container
  46     sal_Int32 pos = -1;
  47
  48     if ( !bAllowDuplicates )
  49     {
  50         pos = getFilterTagPos( aName );
  51         if ( pos < 0 ) // if not there, append
  52         {
  53             m_vFilters.push_back( std::make_pair( aName, aFilter ) );
  54             m_bIterInitialized = false;
  55         }
  56     }
  57     else
  58     {
  59         m_vFilters.push_back( std::make_pair( aName, aFilter ) );
  60         m_bIterInitialized = false;
  61     }
  62
  63     return pos < 0;
  64 }
  65
  66 // delete a filter
  67 // Precondition: the container is not empty
  68 //               there is a filter identified by the given name
  69
  70 bool CFilterContainer::delFilter( const OUString& aName )
  71 {
  72     OSL_ASSERT( !m_vFilters.empty() );
  73
  74     sal_Int32 pos = getFilterTagPos( aName );
  75     if ( pos > -1 )
  76     {
  77         m_vFilters.erase( m_vFilters.begin() + pos );
  78         m_bIterInitialized = false;
  79     }
  80
  81     return pos > -1;
  82 }
  83
  84 // return the number of filters currently in the container
  85
  86 sal_Int32 CFilterContainer::numFilter( )
  87 {
  88     return m_vFilters.size( );
  89 }
  90
  91 // clear all entries
  92
  93 void CFilterContainer::empty()
  94 {
  95     m_vFilters.clear( );
  96 }
  97
  98 // get a filter by name
  99 // Precondition: the container is not empty
 100 //               there is a filter identified by the name
 101
 102 bool CFilterContainer::getFilter( const OUString& aName, OUString& theFilter ) const
 103 {
 104     OSL_PRECOND( !m_vFilters.empty() , "Empty filter container" );
 105
 106     sal_Int32 pos = getFilterTagPos( aName );
 107
 108     try
 109     {
 110         if ( pos > -1 )
 111             theFilter = m_vFilters.at( pos ).second;
 112     }
 113     catch( std::out_of_range& )
 114     {
 115         OSL_FAIL( "Filter not in filter container" );
 116         pos = -1;
 117     }
 118
 119     return pos > -1;
 120 }
 121
 122 bool CFilterContainer::getFilter( sal_Int32 aIndex, OUString& theFilter ) const
 123 {
 124     bool bRet = true;
 125
 126     try
 127     {
 128         theFilter = m_vFilters.at( aIndex ).first;
 129     }
 130     catch( std::out_of_range& )
 131     {
 132         OSL_FAIL( "Filter index out of range" );
 133         bRet = false;
 134     }
 135
 136     return bRet;
 137 }
 138
 139 sal_Int32 CFilterContainer::getFilterPos( const OUString& aName ) const
 140 {
 141     return getFilterTagPos( aName );
 142 }
 143
 144 // returns the index of the filter identified by name
 145
 146 sal_Int32 CFilterContainer::getFilterTagPos( const OUString& aName ) const
 147 {
 148     if ( !m_vFilters.empty() )
 149     {
 150         sal_Int32 i = 0;
 151         FILTER_VECTOR_T::const_iterator iter;
 152         FILTER_VECTOR_T::const_iterator iter_end = m_vFilters.end( );
 153
 154         for ( iter = m_vFilters.begin( ); iter != iter_end; ++iter, ++i )
 155             if ( ( *iter ).first.equalsIgnoreAsciiCase( aName ) )
 156                 return i;
 157     }
 158
 159     return -1;
 160 }
 161
 162 // starts enumerating the filter in the container
 163
 164 void CFilterContainer::beginEnumFilter( )
 165 {
 166     m_iter = m_vFilters.begin( );
 167     m_bIterInitialized = true;
 168 }
 169
 170 // returns true if another filter has been retrieved
 171
 172 bool CFilterContainer::getNextFilter( FILTER_ENTRY_T& nextFilterEntry )
 173 {
 174     OSL_ASSERT( m_bIterInitialized );
 175
 176     bool bRet = ( m_iter != m_vFilters.end( ) );
 177
 178     if ( bRet )
 179         nextFilterEntry = *m_iter++;
 180     else
 181         m_bIterInitialized = false;
 182
 183     return bRet;
 184 }
 185
 186 void CFilterContainer::setCurrentFilter( const OUString& aName )
 187 {
 188     m_sCurrentFilter = aName;
 189 }
 190
 191 OUString CFilterContainer::getCurrentFilter() const
 192 {
 193     return m_sCurrentFilter;
 194 }
 195
 196 // calculates the length of a '\0' separated filter, that means
 197 // length of the name + '\0' + length of the filter string +
 198 // a trailing '\0'
 199
 200 static sal_uInt32 getLengthFilter( CFilterContainer::FILTER_ENTRY_T aFilterEntry )
 201 {
 202     return (
 203         aFilterEntry.first.getLength( )  + 1 +
 204         aFilterEntry.second.getLength( ) + 1 );
 205 }
 206
 207 // calculates the length of all filters currently in the container
 208
 209 static sal_uInt32 getTotalFilterLength( CFilterContainer& aFilterContainer )
 210 {
 211     CFilterContainer::FILTER_ENTRY_T nextFilter;
 212
 213     aFilterContainer.beginEnumFilter( );
 214
 215     sal_uInt32 totalLength = 0;
 216     while( aFilterContainer.getNextFilter( nextFilter ) )
 217         totalLength += getLengthFilter( nextFilter );
 218
 219     return ( totalLength > 0 ) ? totalLength + 1 : totalLength;
 220 }
 221
 222 inline
 223 void wcsmemcpy( sal_Unicode* pDest, const sal_Unicode* pSrc, sal_uInt32 nLength )
 224 {
 225     memcpy( pDest, pSrc, nLength * sizeof( sal_Unicode ) );
 226 }
 227
 228 // a helper trivial helper function to create a filter buffer in the
 229 // format the Win32 API requires,
 230 // e.g. "Text\0*.txt\0Doc\0*.doc;*xls\0\0"
 231
 232 OUString makeWinFilterBuffer( CFilterContainer& aFilterContainer )
 233 {
 234     // calculate the required buffer size
 235     sal_uInt32 reqBuffSize = getTotalFilterLength( aFilterContainer );
 236
 237     // return if there are no filters
 238     if ( !reqBuffSize )
 239         return OUString( );
 240
 241     auto pBuff = std::unique_ptr<sal_Unicode[]>(new sal_Unicode[reqBuffSize]);
 242
 243     // initialize the buffer with 0
 244     ZeroMemory( pBuff.get(), sizeof( sal_Unicode ) * reqBuffSize );
 245
 246     OUString winFilterBuff;
 247     CFilterContainer::FILTER_ENTRY_T nextFilter;
 248     sal_uInt32 memPos = 0;
 249
 250     aFilterContainer.beginEnumFilter( );
 251
 252     while( aFilterContainer.getNextFilter( nextFilter ) )
 253     {
 254         wcsmemcpy(
 255             pBuff.get() + memPos,
 256             nextFilter.first.getStr( ),
 257             nextFilter.first.getLength( ) );
 258
 259         memPos += nextFilter.first.getLength( ) + 1;
 260
 261         wcsmemcpy(
 262             pBuff.get() + memPos,
 263             nextFilter.second.getStr( ),
 264             nextFilter.second.getLength( ) );
 265
 266         memPos += nextFilter.second.getLength( ) + 1 ;
 267     }
 268
 269     winFilterBuff = OUString( pBuff.get(), reqBuffSize );
 270
 271     return winFilterBuff;
 272 }
 273
 274 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */