scripting/source/storage/ScriptMetadataImporter.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef _SCRIPTING_STORAGE_SCRIPTMETADATAIMPORTER_HXX_
  29 #define _SCRIPTING_STORAGE_SCRIPTMETADATAIMPORTER_HXX_
  30
  31 #include <vector>
  32
  33 #include <rtl/ustring.h>
  34 #include <rtl/ustrbuf.hxx>
  35 #include <osl/mutex.hxx>
  36 #include <cppuhelper/implbase1.hxx> // helper for component factory
  37
  38 #include <com/sun/star/uno/XComponentContext.hpp>
  39 #include <com/sun/star/lang/XServiceInfo.hpp>
  40 #include <com/sun/star/lang/XInitialization.hpp>
  41 #include <com/sun/star/xml/sax/XExtendedDocumentHandler.hpp>
  42 #include <com/sun/star/io/XInputStream.hpp>
  43
  44 #include "ScriptData.hxx"
  45
  46 namespace scripting_impl
  47 {
  48 // for simplification
  49 #define css ::com::sun::star
  50 #define dcsssf ::drafts::com::sun::star::script::framework
  51
  52 typedef ::std::vector< ScriptData > InfoImpls_vec;
  53 typedef ::std::pair< ::rtl::OUString, ::std::pair< ::rtl::OUString,
  54     ::rtl::OUString > > strpair_pair;
  55
  56 /**
  57  * Script Meta Data Importer
  58  */
  59 class ScriptMetadataImporter : public
  60     ::cppu::WeakImplHelper1< css::xml::sax::XExtendedDocumentHandler >
  61 {
  62 public:
  63
  64     /**
  65      * This function will begin the parser and parse the meta data
  66      *
  67      * @param xInput The XInputStream for the parser which contains the XML
  68      * @param parcelURI The parcel's URI in the document or the application
  69      *
  70      * @see css::io::XInputStream
  71      */
  72     void parseMetaData( css::uno::Reference< css::io::XInputStream >
  73         const & xInput, const ::rtl::OUString & parcelURI,
  74         InfoImpls_vec & io_ScriptDatas )
  75         throw ( css::xml::sax::SAXException, css::io::IOException,
  76             css::uno::RuntimeException );
  77
  78     /**
  79      * Constructor for the meta-data parser
  80      *
  81      * @param XComponentContext
  82      */
  83     explicit ScriptMetadataImporter(
  84         const css::uno::Reference< css::uno::XComponentContext >&  );
  85
  86     /**
  87      * Destructor for the parser
  88      */
  89     virtual ~ScriptMetadataImporter() SAL_THROW( () );
  90
  91     // XExtendedDocumentHandler impl
  92     /**
  93      * Function to handle the start of CDATA in XML
  94      *
  95      * @see com::sun::star::xml::sax::XExtendedDocumentHandler
  96      */
  97     virtual void SAL_CALL startCDATA()
  98         throw ( css::xml::sax::SAXException, css::uno::RuntimeException );
  99
 100     /**
 101      * Function to handle the end of CDATA in XML
 102      *
 103      * @see com::sun::star::xml::sax::XExtendedDocumentHandler
 104      */
 105     virtual void SAL_CALL endCDATA() throw ( css::uno::RuntimeException );
 106
 107     /**
 108      * Function to handle comments in XML
 109      *
 110      * @see com::sun::star::xml::sax::XExtendedDocumentHandler
 111      */
 112     virtual void SAL_CALL comment( const ::rtl::OUString & sComment )
 113         throw ( css::xml::sax::SAXException, css::uno::RuntimeException );
 114
 115     /**
 116      * Function to handle line breaks in XML
 117      *
 118      * @see com::sun::star::xml::sax::XExtendedDocumentHandler
 119      */
 120     virtual void SAL_CALL allowLineBreak()
 121         throw ( css::xml::sax::SAXException, css::uno::RuntimeException );
 122
 123     /**
 124      * Function to handle unknowns in XML
 125      *
 126      * @see com::sun::star::xml::sax::XExtendedDocumentHandler
 127      */
 128     virtual void SAL_CALL unknown( const ::rtl::OUString & sString )
 129         throw ( css::xml::sax::SAXException, css::uno::RuntimeException );
 130
 131     /**
 132      * Function to handle the start of XML document
 133      *
 134      * @see com::sun::star::xml::sax::XExtendedDocumentHandler
 135      */
 136     // XDocumentHandler impl
 137     virtual void SAL_CALL startDocument()
 138         throw ( css::xml::sax::SAXException, css::uno::RuntimeException );
 139
 140     /**
 141      * Function to handle the end of the XML document
 142      *
 143      * @see com::sun::star::xml::sax::XDocumentHandler
 144      */
 145     virtual void SAL_CALL endDocument()
 146         throw ( css::xml::sax::SAXException, css::uno::RuntimeException );
 147
 148     /**
 149      * Function to handle the start of an element
 150      *
 151      * @see com::sun::star::xml::sax::XDocumentHandler
 152      */
 153     virtual void SAL_CALL startElement( const ::rtl::OUString& aName,
 154         const css::uno::Reference< css::xml::sax::XAttributeList > & xAttribs )
 155         throw ( css::xml::sax::SAXException,
 156             css::uno::RuntimeException );
 157
 158     /**
 159      * Function to handle the end of an element
 160      *
 161      * @see com::sun::star::xml::sax::XDocumentHandler
 162      */
 163     virtual void SAL_CALL endElement( const ::rtl::OUString & aName )
 164         throw ( css::xml::sax::SAXException, css::uno::RuntimeException );
 165
 166     /**
 167      * Function to handle characters in elements
 168      *
 169      * @see com::sun::star::xml::sax::XDocumentHandler
 170      */
 171     virtual void SAL_CALL characters( const ::rtl::OUString & aChars )
 172         throw ( css::xml::sax::SAXException, css::uno::RuntimeException );
 173
 174     /**
 175      * Function to handle whitespace
 176      *
 177      * @see com::sun::star::xml::sax::XDocumentHandler
 178      */
 179     virtual void SAL_CALL ignorableWhitespace( const ::rtl::OUString & aWhitespaces )
 180         throw ( css::xml::sax::SAXException, css::uno::RuntimeException );
 181
 182     /**
 183      * Function to handle XML processing instructions
 184      *
 185      * @see com::sun::star::xml::sax::XDocumentHandler
 186      */
 187     virtual void SAL_CALL processingInstruction(
 188         const ::rtl::OUString & aTarget, const ::rtl::OUString & aData )
 189         throw ( css::xml::sax::SAXException, css::uno::RuntimeException );
 190
 191     /**
 192      * Function to set the document locator
 193      *
 194      * @see com::sun::star::xml::sax::XDocumentHandler
 195      */
 196     virtual void SAL_CALL setDocumentLocator(
 197         const css::uno::Reference< css::xml::sax::XLocator >& xLocator )
 198         throw ( css::xml::sax::SAXException, css::uno::RuntimeException );
 199
 200
 201
 202 private:
 203
 204     /** Vector contains the ScriptData structs */
 205     InfoImpls_vec* mpv_ScriptDatas;
 206
 207     /** @internal */
 208     osl::Mutex     m_mutex;
 209
 210     /** @internal */
 211     css::uno::Reference< css::uno::XComponentContext >  m_xContext;
 212
 213     /** Placeholder for the parcel URI */
 214     ::rtl::OUString ms_parcelURI;
 215
 216     /** States for state machine during parsing */
 217     enum { PARCEL, SCRIPT, LOCALE, DISPLAYNAME, DESCRIPTION, FUNCTIONNAME,
 218         LOGICALNAME, LANGUAGEDEPPROPS, LANGDEPPROPS, FILESET, FILESETPROPS,
 219         FILES, FILEPROPS } m_state;
 220
 221     /** Build up the struct during parsing the meta data */
 222     ScriptData m_ScriptData;
 223
 224     /** @internal */
 225     ::rtl::OUString ms_localeLang;
 226     ::rtl::OUString ms_localeDisName;
 227     ::rtl::OUStringBuffer *ms_localeDesc;
 228
 229     props_vec mv_filesetprops;
 230
 231     ::rtl::OUString ms_filename;
 232     ::rtl::OUString ms_filesetname;
 233
 234     props_vec mv_fileprops;
 235
 236     strpairvec_map mm_files;
 237
 238     InfoImpls_vec mv_ScriptDatas;
 239
 240     /**
 241      *   Helper function to set the state
 242      *
 243      *   @param tagName
 244      *           The current tag being processed
 245      */
 246     void setState(const ::rtl::OUString & tagName);
 247 }
 248 ; // class ScriptMetadataImporter
 249
 250 }
 251
 252 #endif
 253
 254 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */