office-gobmx/sal/osl/w32/path_helper.h
2010-10-27 16:04:46 +01:00

73 lines
2.6 KiB
C

/* -*- 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 _PATH_HELPER_H_
#define _PATH_HELPER_H_
#include <sal/types.h>
#include <rtl/ustring.h>
#include <osl/file.h>
#ifdef __cplusplus
extern "C"
{
#endif
/*******************************************************************
osl_systemPathEnsureSeparator
Adds a trailing path separator to the given system path if not
already there and if the path is not the root path or a logical
drive alone
******************************************************************/
void osl_systemPathEnsureSeparator(/*inout*/ rtl_uString** ppustrPath);
/*******************************************************************
osl_systemPathRemoveSeparator
Removes the last separator from the given system path if any and
if the path is not the root path '\'
******************************************************************/
void SAL_CALL osl_systemPathRemoveSeparator(/*inout*/ rtl_uString** ppustrPath);
/*******************************************************************
osl_is_logical_drive_pattern
Returns whether a given path is only a logical drive pattern or not.
A logical drive pattern is something like "a:\", "c:\".
No logical drive pattern is something like "c:\test"
******************************************************************/
sal_Int32 osl_systemPathIsLogicalDrivePattern(/*in*/ const rtl_uString* pustrPath);
#ifdef __cplusplus
}
#endif
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */