scripting/source/storage/ScriptStorage.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ScriptStorage.hxx,v $
  10  * $Revision: 1.17 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __SCRIPTING_STORAGE_SCRIPTSTORAGE_HXX_
  31 #define __SCRIPTING_STORAGE_SCRIPTSTORAGE_HXX_
  32
  33 #include <vector>
  34 #include <hash_map>
  35
  36 #include <osl/mutex.hxx>
  37 #include <cppuhelper/implbase5.hxx> // helper for component factory
  38
  39 #include <com/sun/star/uno/XComponentContext.hpp>
  40 #include <com/sun/star/lang/XServiceInfo.hpp>
  41 #include <com/sun/star/lang/XInitialization.hpp>
  42 #include <com/sun/star/io/XInputStream.hpp>
  43 #include <com/sun/star/io/XOutputStream.hpp>
  44 #include <com/sun/star/ucb/XSimpleFileAccess.hpp>
  45 #include <com/sun/star/xml/sax/XExtendedDocumentHandler.hpp>
  46
  47 #include <drafts/com/sun/star/script/framework/storage/XScriptInfoAccess.hpp>
  48 #include <drafts/com/sun/star/script/framework/storage/XScriptStorageExport.hpp>
  49 #include <drafts/com/sun/star/script/framework/storage/XScriptStorageRefresh.hpp>
  50 #include <drafts/com/sun/star/script/framework/storage/XScriptInfo.hpp>
  51
  52 namespace scripting_impl
  53 {
  54 // for simplification
  55 #define css ::com::sun::star
  56 #define dcsssf ::drafts::com::sun::star::script::framework
  57
  58 //Typedefs
  59 //=============================================================================
  60 typedef ::std::vector< ScriptData > Datas_vec;
  61 //-----------------------------------------------------------------------------
  62 // function name -> ScriptData
  63 typedef ::std::hash_map < ::rtl::OUString, ScriptData, ::rtl::OUStringHash,
  64             ::std::equal_to< ::rtl::OUString > > ScriptFunction_hash;
  65 //-----------------------------------------------------------------------------
  66 // language -> hash of function name -> ScriptData
  67 typedef ::std::hash_map < ::rtl::OUString, ScriptFunction_hash,
  68             ::rtl::OUStringHash, ::std::equal_to< ::rtl::OUString > >
  69 ScriptData_hash;
  70 //-----------------------------------------------------------------------------
  71 typedef ::std::hash_map < ::rtl::OUString,
  72 css::uno::Reference< css::xml::sax::XExtendedDocumentHandler >,
  73 ::rtl::OUStringHash, ::std::equal_to< ::rtl::OUString > >
  74 ScriptOutput_hash;
  75 //-----------------------------------------------------------------------------
  76 typedef ::std::hash_map < ::rtl::OUString,
  77 ::rtl::OUString, ::rtl::OUStringHash, ::std::equal_to< ::rtl::OUString > >
  78 ScriptLanguages_hash;
  79
  80 //=============================================================================
  81
  82 class ScriptStorage : public
  83     ::cppu::WeakImplHelper5<
  84         css::lang::XServiceInfo,
  85         css::lang::XInitialization,
  86         dcsssf::storage::XScriptInfoAccess,
  87         dcsssf::storage::XScriptStorageExport,
  88     dcsssf::storage::XScriptStorageRefresh >
  89 {
  90 public:
  91     //Constructors and Destructors
  92     //=========================================================================
  93     explicit ScriptStorage(
  94         const css::uno::Reference< css::uno::XComponentContext > & xContext )
  95         throw ( css::uno::RuntimeException );
  96     //-------------------------------------------------------------------------
  97     virtual ~ScriptStorage() SAL_THROW( () );
  98     //=========================================================================
  99
 100     // XServiceInfo impl
 101     //=========================================================================
 102     virtual ::rtl::OUString SAL_CALL getImplementationName()
 103         throw ( css::uno::RuntimeException );
 104     //-------------------------------------------------------------------------
 105     virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString & ServiceName )
 106         throw ( css::uno::RuntimeException );
 107     //-------------------------------------------------------------------------
 108     virtual css::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames()
 109         throw ( css::uno::RuntimeException );
 110     //-------------------------------------------------------------------------
 111     static css::uno::Sequence< ::rtl::OUString > SAL_CALL
 112         getSupportedServiceNames_Static();
 113     //=========================================================================
 114
 115     // XInitialization impl
 116     //=========================================================================
 117     virtual void SAL_CALL
 118         initialize( css::uno::Sequence< css::uno::Any > const & args )
 119         throw ( css::uno::RuntimeException, css::uno::Exception );
 120     //=========================================================================
 121
 122     //XScriptInfoAccess
 123     //=========================================================================
 124     /**
 125      * Get the logical names for this storage
 126      *
 127      * @return sequence < ::rtl::OUString >
 128      *      The logical names
 129      */
 130     virtual css::uno::Sequence< ::rtl::OUString >
 131         SAL_CALL getScriptLogicalNames()
 132         throw ( css::uno::RuntimeException );
 133
 134     //=========================================================================
 135     /**
 136      * Get the implementations for a given URI
 137      *
 138      * @param queryURI
 139      *      The URI to get the implementations for
 140      *
 141      * @return sequence < XScriptInfo >
 142      *      The URIs of the implementations
 143      */
 144     virtual css::uno::Sequence< css::uno::Reference< dcsssf::storage::XScriptInfo > >
 145         SAL_CALL getImplementations(
 146             const ::rtl::OUString& queryURI )
 147         throw ( css::lang::IllegalArgumentException, css::uno::RuntimeException );
 148
 149     //=========================================================================
 150     /**
 151      * Get all script implementations
 152      *
 153      *
 154      * @return sequence < XScriptInfo >
 155      *      script implementations
 156      */
 157     virtual css::uno::Sequence< css::uno::Reference< dcsssf::storage::XScriptInfo > >
 158         SAL_CALL getAllImplementations()
 159         throw ( css::uno::RuntimeException );
 160
 161     //=========================================================================
 162
 163     /**
 164      * Save the scripts stored in the ScriptStorage into the corresponding
 165      * area (document or application)
 166      */
 167     void SAL_CALL save()
 168         throw ( css::uno::RuntimeException );
 169     //=========================================================================
 170
 171     /**
 172      * Refresh the ScriptStorage from the data stored in the corresponding area
 173      * (document or application).
 174      */
 175     void SAL_CALL refresh()
 176         throw ( css::uno::RuntimeException );
 177     //=========================================================================
 178
 179 private:
 180
 181     css::uno::Reference< css::uno::XComponentContext > m_xContext;
 182     css::uno::Reference< css::ucb::XSimpleFileAccess > m_xSimpleFileAccess;
 183     css::uno::Reference< css::lang::XMultiComponentFactory > m_xMgr;
 184
 185     ::std::vector < ::rtl::OUString >  mv_logicalNames;
 186     static ScriptLanguages_hash* mh_scriptLangs;
 187     ScriptData_hash mh_implementations;
 188     ScriptOutput_hash mh_parcels;
 189     sal_Int32 m_scriptStorageID;
 190     ::rtl::OUString m_stringUri;
 191
 192     osl::Mutex m_mutex;
 193     bool m_bInitialised;
 194
 195     void updateMaps( const Datas_vec & vScriptDatas );
 196     void writeMetadataHeader(
 197         css::uno::Reference < css::xml::sax::XExtendedDocumentHandler > & xExDocHandler );
 198     void create ()
 199     throw (css::uno::RuntimeException, css::uno::Exception);
 200     void createForFilesystem ( const ::rtl::OUString & scriptLanguage )
 201     throw (css::uno::RuntimeException, css::uno::Exception);
 202     ::rtl::OUString getFileExtension ( const ::rtl::OUString & stringUri );
 203
 204 }; // class ScriptingStorage
 205
 206 } // namespace scripting_impl
 207
 208 #endif