/usr/include/libreoffice/rtl/bootstrap.hxx is in libreoffice-dev 1:3.5.7-0ubuntu13.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _RTL_BOOTSTRAP_HXX_
#define _RTL_BOOTSTRAP_HXX_
#include <rtl/ustring.hxx>
#include <rtl/bootstrap.h>
namespace rtl
{
class Bootstrap
{
void * _handle;
/** @internal */
inline Bootstrap( Bootstrap const & ); // not impl
/** @internal */
inline Bootstrap & operator = ( Bootstrap const & ); // not impl
public:
/**
@see rtl_bootstrap_setIniFileName()
*/
static inline void SAL_CALL setIniFilename( const ::rtl::OUString &sFile );
/** Retrieves a bootstrap parameter
@param sName name of the bootstrap value. case insensitive.
@param outValue (out parameter). On success contains the value, otherwise
an empty string.
@return sal_False, if no value could be retrieved, otherwise sal_True
@see rtl_bootstrap_get()
*/
static inline sal_Bool get(
const ::rtl::OUString &sName,
::rtl::OUString &outValue );
/** Retrieves a bootstrap parameter
@param sName name of the bootstrap value. case insensitive.
@param outValue (out parameter). Contains the value associated with sName.
@param aDefault if none of the other methods retrieved a value, outValue
is assigned to a Default.
@see rtl_bootstrap_get()
*/
static inline void get(
const ::rtl::OUString &sName,
::rtl::OUString &outValue,
const ::rtl::OUString &aDefault );
/** Sets a bootstrap parameter.
@param pName
name of bootstrap parameter
@param pValue
value of bootstrap parameter
@see rtl_bootstrap_set()
*/
static inline void set( ::rtl::OUString const & name, ::rtl::OUString const & value )
SAL_THROW( () );
/** default ctor.
*/
inline Bootstrap();
/** Opens a bootstrap argment container
@see rtl_bootstrap_args_open()
*/
inline Bootstrap(const OUString & iniName);
/** Closes a bootstrap argument container
@see rtl_bootstrap_args_close()
*/
inline ~Bootstrap();
/** Retrieves a bootstrap argument.
It is first tried to retrieve the value via the global function
and second via the special bootstrap container.
@see rtl_bootstrap_get_from_handle()
*/
inline sal_Bool getFrom(const ::rtl::OUString &sName,
::rtl::OUString &outValue) const;
/** Retrieves a bootstrap argument.
It is first tried to retrieve the value via the global function
and second via the special bootstrap container.
@see rtl_bootstrap_get_from_handle()
*/
inline void getFrom(const ::rtl::OUString &sName,
::rtl::OUString &outValue,
const ::rtl::OUString &aDefault) const;
/** Retrieves the name of the underlying ini-file.
@see rtl_bootstrap_get_iniName_from_handle()
*/
inline void getIniName(::rtl::OUString & iniName) const;
/** Expands a macro using bootstrap variables.
@param macro [inout] The macro to be expanded
*/
inline void expandMacrosFrom( ::rtl::OUString & macro ) const SAL_THROW( () )
{ rtl_bootstrap_expandMacros_from_handle( _handle, ¯o.pData ); }
/** Expands a macro using default bootstrap variables.
@param macro [inout] The macro to be expanded
*/
static inline void expandMacros( ::rtl::OUString & macro ) SAL_THROW( () )
{ rtl_bootstrap_expandMacros( ¯o.pData ); }
/** Provides the bootstrap internal handle.
@return bootstrap handle
*/
inline rtlBootstrapHandle getHandle() const SAL_THROW( () )
{ return _handle; }
/** Escapes special characters ("$" and "\").
@param value
an arbitrary value
@return
the given value, with all occurrences of special characters ("$" and
"\") escaped
@since UDK 3.2.9
*/
static inline ::rtl::OUString encode( ::rtl::OUString const & value )
SAL_THROW( () );
};
//----------------------------------------------------------------------------
// IMPLEMENTATION
//----------------------------------------------------------------------------
inline void Bootstrap::setIniFilename( const ::rtl::OUString &sFile )
{
rtl_bootstrap_setIniFileName( sFile.pData );
}
inline sal_Bool Bootstrap::get( const ::rtl::OUString &sName,
::rtl::OUString & outValue )
{
return rtl_bootstrap_get( sName.pData , &(outValue.pData) , 0 );
}
inline void Bootstrap::get( const ::rtl::OUString &sName,
::rtl::OUString & outValue,
const ::rtl::OUString & sDefault )
{
rtl_bootstrap_get( sName.pData , &(outValue.pData) , sDefault.pData );
}
inline void Bootstrap::set( ::rtl::OUString const & name, ::rtl::OUString const & value )
SAL_THROW( () )
{
rtl_bootstrap_set( name.pData, value.pData );
}
inline Bootstrap::Bootstrap()
{
_handle = 0;
}
inline Bootstrap::Bootstrap(const OUString & iniName)
{
if(iniName.getLength())
_handle = rtl_bootstrap_args_open(iniName.pData);
else
_handle = 0;
}
inline Bootstrap::~Bootstrap()
{
rtl_bootstrap_args_close(_handle);
}
inline sal_Bool Bootstrap::getFrom(const ::rtl::OUString &sName,
::rtl::OUString &outValue) const
{
return rtl_bootstrap_get_from_handle(_handle, sName.pData, &outValue.pData, 0);
}
inline void Bootstrap::getFrom(const ::rtl::OUString &sName,
::rtl::OUString &outValue,
const ::rtl::OUString &aDefault) const
{
rtl_bootstrap_get_from_handle(_handle, sName.pData, &outValue.pData, aDefault.pData);
}
inline void Bootstrap::getIniName(::rtl::OUString & iniName) const
{
rtl_bootstrap_get_iniName_from_handle(_handle, &iniName.pData);
}
inline ::rtl::OUString Bootstrap::encode( ::rtl::OUString const & value )
SAL_THROW( () )
{
::rtl::OUString encoded;
rtl_bootstrap_encode(value.pData, &encoded.pData);
return encoded;
}
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|