summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ¼diger Timm <rt@openoffice.org>2008-06-09 12:11:30 +0000
committerRĂ¼diger Timm <rt@openoffice.org>2008-06-09 12:11:30 +0000
commit5536ea6a002feb879e7192a7bb5f0d472bd1b159 (patch)
treed1bd2b60bf4d041fa4a6ab12057c366cf65f709e
parent49b4db2f0be7a1f5a5bd8242c45fc8b36ff122f1 (diff)
INTEGRATION: CWS sb87 (1.1.2); FILE ADDED
2008/04/11 13:26:38 sb 1.1.2.2: #i88166# remove .. segments in tools::buildPath to avoid filepaths that grow too long 2008/04/04 12:27:22 sb 1.1.2.1: #i87548# extracted tools/pathutils from desktop extendloaderenvironment, because it is also needed by extensions nsplugin code
-rw-r--r--tools/inc/tools/pathutils.hxx104
1 files changed, 104 insertions, 0 deletions
diff --git a/tools/inc/tools/pathutils.hxx b/tools/inc/tools/pathutils.hxx
new file mode 100644
index 000000000000..bf31ff2ea0b5
--- /dev/null
+++ b/tools/inc/tools/pathutils.hxx
@@ -0,0 +1,104 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: pathutils.hxx,v $
+ * $Revision: 1.2 $
+ *
+ * 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 INCLUDED_TOOLS_PATHUTILS_HXX
+#define INCLUDED_TOOLS_PATHUTILS_HXX
+
+#include "sal/config.h"
+
+#if defined WNT
+
+#include <cstddef>
+
+#define WIN32_LEAN_AND_MEAN
+#include <windows.h>
+
+// The compiled code is not part of the tl dynamic library, but is delivered as
+// pathutils-obj and pathutils-slo objects (it is linked into special
+// executables and dynamic libraries that do not link against OOo libraries):
+
+namespace tools {
+
+// Determine the filename part of a path.
+//
+// @param path
+// A non-NULL pointer to a null-terminated path.
+//
+// @return
+// A pointer to the trailing filename part of the given path.
+WCHAR * filename(WCHAR * path);
+
+// Concatenate two paths.
+//
+// Either the first path is empty and the second path is an absolute path. Or
+// the first path is an absolute path that ends in a backslash and the second
+// path is a relative path. In the latter case, to avoid paths that grow too
+// long, leading .. segments of the second path are removed together with
+// trailing segments from the first path. This should not cause problems as
+// long as there are no symbolic links on Windows (as with symbolic links,
+// x\y\.. and x might denote different directories).
+//
+// @param path
+// An output paremeter taking the resulting path; must point at a valid range of
+// memory of size at least MAX_PATH. If NULL is returned, the content is
+// unspecified.
+//
+// @param frontBegin, frontEnd
+// Forms a valid range [frontBegin .. frontEnd) of less than MAX_PATH size.
+//
+// @param backBegin, backLength
+// Forms a valid range [backBeghin .. backBegin + backLength) of less than
+// MAX_PATH size.
+//
+// @return
+// A pointer to the terminating null character of the concatenation, or NULL if
+// a failure occurred.
+WCHAR * buildPath(
+ WCHAR * path, WCHAR const * frontBegin, WCHAR const * frontEnd,
+ WCHAR const * backBegin, std::size_t backLength);
+
+// Resolve a link file.
+//
+// @param path
+// An input/output parameter taking the path; must point at a valid range of
+// memory of size at least MAX_PATH. On input, contains the null-terminated
+// full path of the link file. On output, contains the null-terminated full
+// path of the resolved link; if NULL is returned, the content is unspecified.
+//
+// @return
+// A pointer to the terminating null character of path, or NULL if a failure
+// occurred.
+WCHAR * resolveLink(WCHAR * path);
+
+}
+
+#endif
+
+#endif