include/cppuhelper/bootstrap.hxx

   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 #ifndef INCLUDED_CPPUHELPER_BOOTSTRAP_HXX
  20 #define INCLUDED_CPPUHELPER_BOOTSTRAP_HXX
  21
  22 #include <sal/config.h>
  23 #include <com/sun/star/uno/Reference.hxx>
  24 #include <rtl/ustring.hxx>
  25 #include <sal/types.h>
  26 #include <cppuhelper/cppuhelperdllapi.h>
  27
  28 namespace com { namespace sun { namespace star {
  29     namespace container { class XHierarchicalNameAccess; }
  30     namespace uno { class XComponentContext; }
  31 } } }
  32
  33 namespace cppu
  34 {
  35
  36 /** Installs type description manager instance, i.e. registers a callback at cppu core.
  37
  38     @param xTDMgr manager instance
  39     @return true, if successfully registered
  40 */
  41 CPPUHELPER_DLLPUBLIC sal_Bool SAL_CALL installTypeDescriptionManager(
  42     ::com::sun::star::uno::Reference< ::com::sun::star::container::XHierarchicalNameAccess > const & xTDMgr );
  43
  44 /** Bootstraps an initial component context with service manager upon
  45     information from bootstrap variables.
  46
  47     This function tries to find its parameters via these bootstrap variables:
  48
  49       - UNO_TYPES         -- a space separated list of file urls of type rdbs
  50       - UNO_SERVICES      -- a space separated list of file urls of service rdbs
  51
  52     Please look at http://udk.openoffice.org/common/man/concept/uno_default_bootstrapping.html
  53     for further info.
  54
  55     @return component context
  56 */
  57 CPPUHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > SAL_CALL
  58 defaultBootstrap_InitialComponentContext();
  59
  60
  61 /** Bootstraps an initial component context with service manager upon
  62     information from an ini file.
  63
  64     This function tries to find its parameters via these bootstrap variables:
  65
  66       - UNO_TYPES         -- a space separated list of file urls of type rdbs
  67       - UNO_SERVICES      -- a space separated list of file urls of service rdbs
  68
  69     Please look at http://udk.openoffice.org/common/man/concept/uno_default_bootstrapping.html
  70     for further info.
  71
  72     @param iniFile ini filename to get bootstrap variables
  73     @return component context
  74 */
  75 CPPUHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > SAL_CALL
  76 defaultBootstrap_InitialComponentContext(const ::rtl::OUString & iniFile);
  77
  78 /**
  79  * An exception indicating a bootstrap error.
  80  *
  81  * @since UDK 3.2.0
  82  */
  83 class CPPUHELPER_DLLPUBLIC BootstrapException
  84 {
  85 public:
  86     /**
  87      * Constructs a BootstrapException.
  88      */
  89     BootstrapException();
  90
  91     /**
  92      * Constructs a BootstrapException with the specified detail message.
  93      *
  94      * @param rMessage
  95      * A message containing any details about the exception.
  96      */
  97     BootstrapException( const ::rtl::OUString & rMessage );
  98
  99     /**
 100      * Copy constructs a BootstrapException.
 101      */
 102     BootstrapException( const BootstrapException & e );
 103
 104     /**
 105      * Destructs a BootstrapException.
 106      */
 107     virtual ~BootstrapException();
 108
 109     /**
 110      * Assigns a BootstrapException.
 111      */
 112     BootstrapException & operator=( const BootstrapException & e );
 113
 114     /** Gets the message.
 115
 116         @return
 117         A reference to the message. The reference is valid for the lifetime of
 118         this BootstrapException.
 119      */
 120     const ::rtl::OUString & getMessage() const;
 121
 122 private:
 123     ::rtl::OUString m_aMessage;
 124 };
 125
 126 /**
 127  * Bootstraps the component context from a UNO installation.
 128  *
 129  * @return a bootstrapped component context
 130  * @exception BootstrapException
 131  * Thrown in case bootstrap() signals an exception due to a
 132  * bootstrap error.
 133  *
 134  * @since UDK 3.2.0
 135  */
 136 CPPUHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
 137 SAL_CALL bootstrap();
 138
 139 /// @cond INTERNAL
 140 /**
 141  * Helper function to expand vnd.sun.star.expand URLs in contexts where no
 142  * properly bootstrapped UNO is (yet) available.
 143  *
 144  * @param uri
 145  * Some URI (but not a URI reference).
 146  *
 147  * @return
 148  * If uri is a vnd.sun.star.expand URL, then the expansion of that URL is
 149  * returned; expansion may lead to a string that is not a legal URI. Otherwise,
 150  * the uri is returned unchanged.
 151  *
 152  * @exception com::sun::star::lang::IllegalArgumentException
 153  * If uri is a vnd.sun.star.expand URL that contains unknown macros.
 154  *
 155  * @since UDK 3.2.8
 156  */
 157 CPPUHELPER_DLLPUBLIC ::rtl::OUString
 158 SAL_CALL bootstrap_expandUri(::rtl::OUString const & uri);
 159 /// @endcond
 160
 161 } // end namespace cppu
 162
 163 #endif
 164
 165 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */