xref: /aoo4110/main/sal/osl/w32/path_helper.h (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef _PATH_HELPER_H_
25*b1cdbd2cSJim Jagielski #define _PATH_HELPER_H_
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include <sal/types.h>
28*b1cdbd2cSJim Jagielski #include <rtl/ustring.h>
29*b1cdbd2cSJim Jagielski #include <osl/file.h>
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski #ifdef __cplusplus
32*b1cdbd2cSJim Jagielski extern "C"
33*b1cdbd2cSJim Jagielski {
34*b1cdbd2cSJim Jagielski #endif
35*b1cdbd2cSJim Jagielski 
36*b1cdbd2cSJim Jagielski /*******************************************************************
37*b1cdbd2cSJim Jagielski  osl_systemPathEnsureSeparator
38*b1cdbd2cSJim Jagielski  Adds a trailing path separator to the given system path if not
39*b1cdbd2cSJim Jagielski  already there and if the path is not the root path or a logical
40*b1cdbd2cSJim Jagielski  drive alone
41*b1cdbd2cSJim Jagielski  ******************************************************************/
42*b1cdbd2cSJim Jagielski 
43*b1cdbd2cSJim Jagielski void osl_systemPathEnsureSeparator(/*inout*/ rtl_uString** ppustrPath);
44*b1cdbd2cSJim Jagielski 
45*b1cdbd2cSJim Jagielski /*******************************************************************
46*b1cdbd2cSJim Jagielski  osl_systemPathRemoveSeparator
47*b1cdbd2cSJim Jagielski  Removes the last separator from the given system path if any and
48*b1cdbd2cSJim Jagielski  if the path is not the root path '\'
49*b1cdbd2cSJim Jagielski  ******************************************************************/
50*b1cdbd2cSJim Jagielski 
51*b1cdbd2cSJim Jagielski void SAL_CALL osl_systemPathRemoveSeparator(/*inout*/ rtl_uString** ppustrPath);
52*b1cdbd2cSJim Jagielski 
53*b1cdbd2cSJim Jagielski /*******************************************************************
54*b1cdbd2cSJim Jagielski  osl_is_logical_drive_pattern
55*b1cdbd2cSJim Jagielski  Returns whether a given path is only a logical drive pattern or not.
56*b1cdbd2cSJim Jagielski  A logical drive pattern is something like "a:\", "c:\".
57*b1cdbd2cSJim Jagielski  No logical drive pattern is something like "c:\test"
58*b1cdbd2cSJim Jagielski  ******************************************************************/
59*b1cdbd2cSJim Jagielski 
60*b1cdbd2cSJim Jagielski sal_Int32 osl_systemPathIsLogicalDrivePattern(/*in*/ const rtl_uString* pustrPath);
61*b1cdbd2cSJim Jagielski 
62*b1cdbd2cSJim Jagielski #ifdef __cplusplus
63*b1cdbd2cSJim Jagielski }
64*b1cdbd2cSJim Jagielski #endif
65*b1cdbd2cSJim Jagielski 
66*b1cdbd2cSJim Jagielski #endif
67