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