VirtualBox

source: vbox/trunk/src/VBox/Runtime/include/internal/path.h@ 46113

Last change on this file since 46113 was 44528, checked in by vboxsync, 12 years ago

header (C) fixes

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 5.2 KB
Line 
1/* $Id: path.h 44528 2013-02-04 14:27:54Z vboxsync $ */
2/** @file
3 * IPRT - RTPath Internal header.
4 */
5
6/*
7 * Copyright (C) 2006-2011 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27#ifndef ___internal_path_h
28#define ___internal_path_h
29
30#include <iprt/cdefs.h>
31#include <iprt/param.h>
32
33RT_C_DECLS_BEGIN
34
35#if defined(RT_OS_OS2) || defined(RT_OS_WINDOWS)
36# define HAVE_UNC 1
37# define HAVE_DRIVE 1
38#endif
39
40/** The name of the environment variable that is used to override the default
41 * codeset used when talking to the file systems. This is only available on
42 * Mac OS X and UNIX systems. */
43#define RTPATH_CODESET_ENV_VAR "IPRT_PATH_CODESET"
44
45
46DECLHIDDEN(size_t) rtPathRootSpecLen(const char *pszPath);
47DECLHIDDEN(size_t) rtPathVolumeSpecLen(const char *pszPath);
48DECLHIDDEN(int) rtPathPosixRename(const char *pszSrc, const char *pszDst, unsigned fRename, RTFMODE fFileType);
49DECLHIDDEN(int) rtPathWin32MoveRename(const char *pszSrc, const char *pszDst, uint32_t fFlags, RTFMODE fFileType);
50
51
52/**
53 * Converts a path from IPRT to native representation.
54 *
55 * This may involve querying filesystems what codeset they speak and so forth.
56 *
57 * @returns IPRT status code.
58 * @param ppszNativePath Where to store the pointer to the native path.
59 * Free by calling rtPathFreeHost(). NULL on failure.
60 * Can be the same as pszPath.
61 * @param pszPath The path to convert.
62 * @param pszBasePath What pszPath is relative to. NULL if current
63 * directory.
64 *
65 * @remark This function is not available on hosts using something else than
66 * byte sequences as names (eg win32).
67 */
68int rtPathToNative(char const **ppszNativePath, const char *pszPath, const char *pszBasePath);
69
70/**
71 * Frees a native path returned by rtPathToNative() or rtPathToNativeEx().
72 *
73 * @param pszNativePath The host path to free. NULL allowed.
74 * @param pszPath The original path. This is for checking if
75 * rtPathToNative returned the pointer to the original.
76 *
77 * @remark This function is not available on hosts using something else than
78 * byte sequences as names (eg win32).
79 */
80void rtPathFreeNative(char const *pszNativePath, const char *pszPath);
81
82/**
83 * Converts a path from the native to the IPRT representation.
84 *
85 * @returns IPRT status code.
86 * @param ppszPath Where to store the pointer to the IPRT path.
87 * Free by calling rtPathFreeIprt(). NULL on failure.
88 * @param pszNativePath The native path to convert.
89 * @param pszBasePath What pszNativePath is relative to - in IPRT
90 * representation. NULL if current directory.
91 *
92 * @remark This function is not available on hosts using something else than
93 * byte sequences as names (eg win32).
94 */
95int rtPathFromNative(const char **ppszPath, const char *pszNativePath, const char *pszBasePath);
96
97/**
98 * Frees a path returned by rtPathFromNative or rtPathFromNativeEx.
99 *
100 * @param pszPath The returned path.
101 * @param pszNativePath The original path.
102 */
103void rtPathFreeIprt(const char *pszPath, const char *pszNativePath);
104
105/**
106 * Convert a path from the native representation to the IPRT one, using the
107 * specified path buffer.
108 *
109 * @returns VINF_SUCCESS, VERR_BUFFER_OVERFLOW, and recoding errors.
110 *
111 * @param pszPath The output buffer.
112 * @param cbPath The size of the output buffer.
113 * @param pszNativePath The path to convert.
114 * @param pszBasePath What pszNativePath is relative to - in IPRT
115 * representation. NULL if current directory.
116 */
117int rtPathFromNativeCopy(char *pszPath, size_t cbPath, const char *pszNativePath, const char *pszBasePath);
118
119/**
120 * Convert a path from the native representation to the IPRT one, allocating a
121 * string buffer for the result.
122 *
123 * @returns VINF_SUCCESS, VERR_NO_STR_MEMORY, and recoding errors.
124 *
125 * @param ppszPath Where to return the pointer to the IPRT path. Must
126 * be freed by calling RTStrFree.
127 * @param pszNativePath The path to convert.
128 * @param pszBasePath What pszNativePath is relative to - in IPRT
129 * representation. NULL if current directory.
130 */
131int rtPathFromNativeDup(char **ppszPath, const char *pszNativePath, const char *pszBasePath);
132
133
134RT_C_DECLS_END
135
136#endif
137
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette