sal/inc/rtl/bootstrap.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: bootstrap.hxx,v $
  10  * $Revision: 1.9 $
  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 _RTL_BOOTSTRAP_HXX_
  31 #define _RTL_BOOTSTRAP_HXX_
  32 #include <rtl/ustring.hxx>
  33 #include <rtl/bootstrap.h>
  34
  35 namespace rtl
  36 {
  37     class Bootstrap
  38     {
  39         void * _handle;
  40
  41         /** @internal */
  42         inline Bootstrap( Bootstrap const & ); // not impl
  43         /** @internal */
  44         inline Bootstrap & operator = ( Bootstrap const & ); // not impl
  45
  46     public:
  47         /**
  48            @see rtl_bootstrap_setIniFileName()
  49          */
  50         static inline void SAL_CALL setIniFilename( const ::rtl::OUString &sFile );
  51
  52         /** Retrieves a bootstrap parameter
  53            @param sName name of the bootstrap value. case insensitive.
  54            @param outValue (out parameter). On success contains the value, otherwise
  55                   an empty string.
  56            @return sal_False, if no value could be retrieved, otherwise sal_True
  57            @see rtl_bootstrap_get()
  58          */
  59         static inline sal_Bool get(
  60             const ::rtl::OUString &sName,
  61             ::rtl::OUString &outValue );
  62
  63         /** Retrieves a bootstrap parameter
  64
  65            @param sName name of the bootstrap value. case insensitive.
  66            @param outValue (out parameter). Contains the value associated with sName.
  67            @param aDefault if none of the other methods retrieved a value, outValue
  68                            is assigned to a Default.
  69
  70            @see rtl_bootstrap_get()
  71          */
  72         static inline void get(
  73             const ::rtl::OUString &sName,
  74             ::rtl::OUString &outValue,
  75             const ::rtl::OUString &aDefault );
  76
  77         /** Sets a bootstrap parameter.
  78
  79             @param pName
  80                    name of bootstrap parameter
  81             @param pValue
  82                    value of bootstrap parameter
  83
  84             @see rtl_bootstrap_set()
  85         */
  86         static inline void set( ::rtl::OUString const & name, ::rtl::OUString const & value )
  87             SAL_THROW( () );
  88
  89         /** default ctor.
  90          */
  91         inline Bootstrap();
  92
  93         /** Opens a bootstrap argment container
  94             @see rtl_bootstrap_args_open()
  95          */
  96         inline Bootstrap(const OUString & iniName);
  97
  98         /** Closes a bootstrap argument container
  99             @see rtl_bootstrap_args_close()
 100         */
 101         inline ~Bootstrap();
 102
 103         /** Retrieves a bootstrap argument.
 104
 105             It is first tried to retrieve the value via the global function
 106             and second via the special bootstrap container.
 107             @see rtl_bootstrap_get_from_handle()
 108         */
 109
 110         inline sal_Bool getFrom(const ::rtl::OUString &sName,
 111                                 ::rtl::OUString &outValue) const;
 112
 113         /** Retrieves a bootstrap argument.
 114
 115             It is first tried to retrieve the value via the global function
 116             and second via the special bootstrap container.
 117             @see rtl_bootstrap_get_from_handle()
 118         */
 119         inline void getFrom(const ::rtl::OUString &sName,
 120                             ::rtl::OUString &outValue,
 121                             const ::rtl::OUString &aDefault) const;
 122
 123         /** Retrieves the name of the underlying ini-file.
 124             @see rtl_bootstrap_get_iniName_from_handle()
 125          */
 126         inline void getIniName(::rtl::OUString & iniName) const;
 127
 128         /** Expands a macro using bootstrap variables.
 129
 130             @param macro    [inout]  The macro to be expanded
 131         */
 132         inline void expandMacrosFrom( ::rtl::OUString & macro ) const SAL_THROW( () )
 133             { rtl_bootstrap_expandMacros_from_handle( _handle, &macro.pData ); }
 134
 135         /** Expands a macro using default bootstrap variables.
 136
 137             @param macro    [inout]  The macro to be expanded
 138         */
 139         static inline void expandMacros( ::rtl::OUString & macro ) SAL_THROW( () )
 140             { rtl_bootstrap_expandMacros( &macro.pData ); }
 141
 142         /** Provides the bootstrap internal handle.
 143
 144             @return bootstrap handle
 145         */
 146         inline rtlBootstrapHandle getHandle() const SAL_THROW( () )
 147             { return _handle; }
 148
 149         /** Escapes special characters ("$" and "\").
 150
 151             @param value
 152             an arbitrary value
 153
 154             @return
 155             the given value, with all occurences of special characters ("$" and
 156             "\") escaped
 157
 158             @since UDK 3.2.9
 159         */
 160         static inline ::rtl::OUString encode( ::rtl::OUString const & value )
 161             SAL_THROW( () );
 162     };
 163
 164     //----------------------------------------------------------------------------
 165     // IMPLEMENTATION
 166     //----------------------------------------------------------------------------
 167     inline void Bootstrap::setIniFilename( const ::rtl::OUString &sFile )
 168     {
 169         rtl_bootstrap_setIniFileName( sFile.pData );
 170     }
 171
 172     inline sal_Bool Bootstrap::get( const ::rtl::OUString &sName,
 173                                     ::rtl::OUString & outValue )
 174     {
 175         return rtl_bootstrap_get( sName.pData , &(outValue.pData) , 0 );
 176     }
 177
 178     inline void Bootstrap::get( const ::rtl::OUString &sName,
 179                                 ::rtl::OUString & outValue,
 180                                 const ::rtl::OUString & sDefault )
 181     {
 182         rtl_bootstrap_get( sName.pData , &(outValue.pData) , sDefault.pData );
 183     }
 184
 185     inline void Bootstrap::set( ::rtl::OUString const & name, ::rtl::OUString const & value )
 186         SAL_THROW( () )
 187     {
 188         rtl_bootstrap_set( name.pData, value.pData );
 189     }
 190
 191     inline Bootstrap::Bootstrap()
 192     {
 193         _handle = 0;
 194     }
 195
 196     inline Bootstrap::Bootstrap(const OUString & iniName)
 197     {
 198         if(iniName.getLength())
 199             _handle = rtl_bootstrap_args_open(iniName.pData);
 200
 201         else
 202             _handle = 0;
 203     }
 204
 205     inline Bootstrap::~Bootstrap()
 206     {
 207         rtl_bootstrap_args_close(_handle);
 208     }
 209
 210
 211     inline sal_Bool Bootstrap::getFrom(const ::rtl::OUString &sName,
 212                                        ::rtl::OUString &outValue) const
 213     {
 214         return rtl_bootstrap_get_from_handle(_handle, sName.pData, &outValue.pData, 0);
 215     }
 216
 217     inline void Bootstrap::getFrom(const ::rtl::OUString &sName,
 218                                    ::rtl::OUString &outValue,
 219                                    const ::rtl::OUString &aDefault) const
 220     {
 221         rtl_bootstrap_get_from_handle(_handle, sName.pData, &outValue.pData, aDefault.pData);
 222     }
 223
 224     inline void Bootstrap::getIniName(::rtl::OUString & iniName) const
 225     {
 226         rtl_bootstrap_get_iniName_from_handle(_handle, &iniName.pData);
 227     }
 228
 229     inline ::rtl::OUString Bootstrap::encode( ::rtl::OUString const & value )
 230         SAL_THROW( () )
 231     {
 232         ::rtl::OUString encoded;
 233         rtl_bootstrap_encode(value.pData, &encoded.pData);
 234         return encoded;
 235     }
 236 }
 237 #endif