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