xref: /aoo42x/main/sal/osl/os2/path_helper.h (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _PATH_HELPER_H_
29*cdf0e10cSrcweir #define _PATH_HELPER_H_
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <sal/types.h>
32*cdf0e10cSrcweir #include <rtl/ustring.h>
33*cdf0e10cSrcweir #include <osl/file.h>
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir #ifdef __cplusplus
36*cdf0e10cSrcweir extern "C"
37*cdf0e10cSrcweir {
38*cdf0e10cSrcweir #endif
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir /*******************************************************************
41*cdf0e10cSrcweir  osl_systemPathEnsureSeparator
42*cdf0e10cSrcweir  Adds a trailing path separator to the given system path if not
43*cdf0e10cSrcweir  already there and if the path is not the root path or a logical
44*cdf0e10cSrcweir  drive alone
45*cdf0e10cSrcweir  ******************************************************************/
46*cdf0e10cSrcweir 
47*cdf0e10cSrcweir void osl_systemPathEnsureSeparator(/*inout*/ rtl_uString** ppustrPath);
48*cdf0e10cSrcweir 
49*cdf0e10cSrcweir /*******************************************************************
50*cdf0e10cSrcweir  osl_systemPathRemoveSeparator
51*cdf0e10cSrcweir  Removes the last separator from the given system path if any and
52*cdf0e10cSrcweir  if the path is not the root path '\'
53*cdf0e10cSrcweir  ******************************************************************/
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir void SAL_CALL osl_systemPathRemoveSeparator(/*inout*/ rtl_uString** ppustrPath);
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir /*******************************************************************
58*cdf0e10cSrcweir  osl_is_logical_drive_pattern
59*cdf0e10cSrcweir  Returns whether a given path is only a logical drive pattern or not.
60*cdf0e10cSrcweir  A logical drive pattern is something like "a:\", "c:\".
61*cdf0e10cSrcweir  No logical drive pattern is something like "c:\test"
62*cdf0e10cSrcweir  ******************************************************************/
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir sal_Int32 osl_systemPathIsLogicalDrivePattern(/*in*/ const rtl_uString* pustrPath);
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir #ifdef __cplusplus
67*cdf0e10cSrcweir }
68*cdf0e10cSrcweir #endif
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir #endif
71