Author: orcmid
Date: Mon Mar 7 23:34:03 2016
New Revision: 1734003
URL: http://svn.apache.org/viewvc?rev=1734003&view=rev
Log:
Provide copies of selected materials for analysis and annotation separate from
the trunk.
Added:
openoffice/branches/olcProfileNano/olcProfileNano.txt (with props)
openoffice/branches/olcProfileNano/sal/
openoffice/branches/olcProfileNano/sal/inc/
openoffice/branches/olcProfileNano/sal/inc/osl/
openoffice/branches/olcProfileNano/sal/inc/osl/diagnose.h (with props)
openoffice/branches/olcProfileNano/sal/inc/osl/diagnose.hxx
openoffice/branches/olcProfileNano/sal/inc/osl/file.h (with props)
openoffice/branches/olcProfileNano/sal/inc/osl/process.h (with props)
openoffice/branches/olcProfileNano/sal/inc/osl/profile.h (with props)
openoffice/branches/olcProfileNano/sal/inc/osl/thread.h (with props)
openoffice/branches/olcProfileNano/sal/inc/osl/util.h (with props)
openoffice/branches/olcProfileNano/sal/inc/rtl/
openoffice/branches/olcProfileNano/sal/inc/rtl/alloc.h (with props)
openoffice/branches/olcProfileNano/sal/inc/rtl/ustring.h (with props)
openoffice/branches/olcProfileNano/sal/inc/sal/
openoffice/branches/olcProfileNano/sal/inc/sal/types.h (with props)
openoffice/branches/olcProfileNano/sal/osl/
openoffice/branches/olcProfileNano/sal/osl/unx/
openoffice/branches/olcProfileNano/sal/osl/unx/profile.c (with props)
openoffice/branches/olcProfileNano/sal/osl/unx/system.h (with props)
openoffice/branches/olcProfileNano/sal/osl/w32/
openoffice/branches/olcProfileNano/sal/osl/w32/file_url.h (with props)
openoffice/branches/olcProfileNano/sal/osl/w32/path_helper.hxx
openoffice/branches/olcProfileNano/sal/osl/w32/profile.cxx
openoffice/branches/olcProfileNano/sal/osl/w32/system.h (with props)
Added: openoffice/branches/olcProfileNano/olcProfileNano.txt
URL:
http://svn.apache.org/viewvc/openoffice/branches/olcProfileNano/olcProfileNano.txt?rev=1734003&view=auto
==============================================================================
--- openoffice/branches/olcProfileNano/olcProfileNano.txt (added)
+++ openoffice/branches/olcProfileNano/olcProfileNano.txt [UTF-8] Mon Mar 7
23:34:03 2016
@@ -0,0 +1,42 @@
+olcProfileNano.txt UTF-8
+
+ NANO BRANCH FOR PROFILE ANALYSIS
+ ================================
+
+This branch is for snalysis of the profile.c (and profile.cxx) code that may
+be vulnerable to race and threading issues. The initial problem is the
+mutex unlock operation against a NULL pointer identified in bugzilla issue
+<https://bz.apache.org/ooo/show_bug.cgi?id=126669>.
+
+The approach is to make copies of only the essential files and their unique
+dependencies. Those files will be used in a collaborative analysis and will
+be annotated to establish the essential repairs and also the identify the
+conditions that are satisfied in having the repair work.
+
+BASE MATERIALS
+
+The essential materials are in the olcProfileNano/ branch subtree:
+
+ sal/ The trunk/main/ folder extracted from
+ /inc the headers related to the code under analysis
+ osl/ relevant headers included via #include "osl/..."
+ rtl/ relevant headers included via #include "rtl/..."
+ sal/ relevant headers included via #include "sal/..."
+ /osl the source code for sal/osl/ functions
+ unx/ the *nix-specific implementations of sal/osl/
+ w32/ the Windows32-specific implementations of sal/osl
+
+The folders provide marked-up annotations and possibly additional text.
+
+
+
+
+
+0.00 2016-03-08T Add branch with a selection of unmodified base materials.
+
+
+ *** end of olcProfileNano.txt ***
+
+
+
+
\ No newline at end of file
Propchange: openoffice/branches/olcProfileNano/olcProfileNano.txt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: openoffice/branches/olcProfileNano/olcProfileNano.txt
------------------------------------------------------------------------------
svn:mime-type = text/plain;charset=UTF-8
Added: openoffice/branches/olcProfileNano/sal/inc/osl/diagnose.h
URL:
http://svn.apache.org/viewvc/openoffice/branches/olcProfileNano/sal/inc/osl/diagnose.h?rev=1734003&view=auto
==============================================================================
--- openoffice/branches/olcProfileNano/sal/inc/osl/diagnose.h (added)
+++ openoffice/branches/olcProfileNano/sal/inc/osl/diagnose.h Mon Mar 7
23:34:03 2016
@@ -0,0 +1,148 @@
+/**************************************************************
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ *************************************************************/
+
+
+
+
+#ifndef _OSL_DIAGNOSE_H_
+#define _OSL_DIAGNOSE_H_
+
+#include <sal/types.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/* //////////////////////////////////////////////////////////////////////////
+ Diagnostic support
+*/
+
+void SAL_CALL osl_breakDebug(void);
+sal_Bool SAL_CALL osl_assertFailedLine(const sal_Char* pszFileName,
sal_Int32 nLine, const sal_Char* pszMessage);
+void SAL_CALL osl_trace(const sal_Char* pszFormat, ...);
+sal_Int32 SAL_CALL osl_reportError(sal_uInt32 nType, const sal_Char*
pszErrorMessage);
+
+/*
+ For message delivery
+*/
+
+/** a message delivery function which receives a pre-formatted message string
+*/
+typedef void (SAL_CALL *pfunc_osl_printDebugMessage)( const sal_Char *
pszMessage );
+
+/** a message delivery function which receives detailed information about
where the message was triggered
+*/
+typedef void (SAL_CALL *pfunc_osl_printDetailedDebugMessage)( const sal_Char *
pszFileName, sal_Int32 nLine, const sal_Char* pszMessage );
+
+/** sets a message delivery function
+
+ The function set here is ignored if a function for detailed message
information
+ (pfunc_osl_printDetailedDebugMessage) has been set.
+
+ The given message handler must be able to cope with a <NULL/> message.
+*/
+pfunc_osl_printDebugMessage SAL_CALL osl_setDebugMessageFunc(
pfunc_osl_printDebugMessage pNewFunc );
+
+/** sets a delivery function for detailed message information.
+
+ The given message handler must be able to cope with a <NULL/> message.
+*/
+pfunc_osl_printDetailedDebugMessage SAL_CALL osl_setDetailedDebugMessageFunc(
pfunc_osl_printDetailedDebugMessage pNewFunc );
+
+#ifdef __cplusplus
+}
+#endif
+
+#define OSL_THIS_FILE __FILE__
+
+/* the macro OSL_THIS_FUNC is intended to be an office internal macro for now
*/
+#define OSL_THIS_FUNC "<unknown>"
+
+/* the macro OSL_TO_STRING is intended to be an office internal macro for now
*/
+#define OSL_TO_STRING( x ) #x
+
+/* the macro OSL_MACRO_VALUE_TO_STRING is intended to be an office internal
macro for now */
+#define OSL_MACRO_VALUE_TO_STRING( x ) OSL_TO_STRING( x )
+
+/* the macro OSL_LOG_PREFIX is intended to be an office internal macro for now
*/
+#define OSL_LOG_PREFIX OSL_THIS_FILE ":" OSL_THIS_FUNC ":"
OSL_MACRO_VALUE_TO_STRING( __LINE__ ) "; "
+
+#define OSL_DEBUG_ONLY(s) _OSL_DEBUG_ONLY(s)
+#define OSL_TRACE _OSL_TRACE
+#define OSL_ASSERT(c) _OSL_ASSERT(c, OSL_THIS_FILE, __LINE__)
+#define OSL_ENSURE(c, m) _OSL_ENSURE(c, OSL_THIS_FILE, __LINE__, m)
+
+#define OSL_VERIFY(c) do { if (!(c)) OSL_ASSERT(0); } while (0)
+#define OSL_PRECOND(c, m) OSL_ENSURE(c, m)
+#define OSL_POSTCOND(c, m) OSL_ENSURE(c, m)
+
+
+#ifdef __cplusplus
+#define _OSL_GLOBAL ::
+#else
+#define _OSL_GLOBAL
+#endif /* __cplusplus */
+
+#ifdef _WIN16
+#if OSL_DEBUG_LEVEL > 0
+#undef OSL_DEBUG_LEVEL
+#define OSL_DEBUG_LEVEL 0
+#endif
+#endif
+
+
+
+#if OSL_DEBUG_LEVEL > 0
+
+#define _OSL_DEBUG_ONLY(f) (f)
+#define _OSL_ASSERT(c, f, l) \
+ do \
+ { \
+ if (!(c) && _OSL_GLOBAL osl_assertFailedLine(f, l, 0)) \
+ _OSL_GLOBAL osl_breakDebug(); \
+ } while (0)
+
+#define _OSL_ENSURE(c, f, l, m) \
+ do \
+ { \
+ if (!(c) && _OSL_GLOBAL osl_assertFailedLine(f, l, m)) \
+ _OSL_GLOBAL osl_breakDebug(); \
+ } while (0)
+
+#else
+
+#define _OSL_DEBUG_ONLY(f) ((void)0)
+#define _OSL_ASSERT(c, f, l) ((void)0)
+#define _OSL_ENSURE(c, f, l, m) ((void)0)
+
+#endif /* OSL_DEBUG_LEVEL */
+
+#if OSL_DEBUG_LEVEL > 1
+
+#define _OSL_TRACE _OSL_GLOBAL osl_trace
+
+#else
+
+#define _OSL_TRACE 1 ? ((void)0) : _OSL_GLOBAL osl_trace
+
+#endif /* OSL_DEBUG_LEVEL */
+
+#endif /* _OSL_DIAGNOSE_H_ */
Propchange: openoffice/branches/olcProfileNano/sal/inc/osl/diagnose.h
------------------------------------------------------------------------------
svn:eol-style = native
Added: openoffice/branches/olcProfileNano/sal/inc/osl/diagnose.hxx
URL:
http://svn.apache.org/viewvc/openoffice/branches/olcProfileNano/sal/inc/osl/diagnose.hxx?rev=1734003&view=auto
==============================================================================
--- openoffice/branches/olcProfileNano/sal/inc/osl/diagnose.hxx (added)
+++ openoffice/branches/olcProfileNano/sal/inc/osl/diagnose.hxx Mon Mar 7
23:34:03 2016
@@ -0,0 +1,189 @@
+/**************************************************************
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ *************************************************************/
+
+
+#if ! defined(OSL_DIAGNOSE_HXX_INCLUDED)
+#define OSL_DIAGNOSE_HXX_INCLUDED
+
+#include "osl/diagnose.h"
+#include "osl/interlck.h"
+#include "osl/mutex.hxx"
+#include "rtl/instance.hxx"
+#include <hash_set>
+#include <functional>
+#include <typeinfo>
+
+namespace osl {
+/// @internal
+namespace detail {
+
+struct ObjectRegistryData;
+
+} // namespace detail
+} // namespace osl
+
+extern "C" {
+
+/** @internal */
+bool SAL_CALL osl_detail_ObjectRegistry_storeAddresses( char const* pName )
+ SAL_THROW_EXTERN_C();
+
+/** @internal */
+bool SAL_CALL osl_detail_ObjectRegistry_checkObjectCount(
+ ::osl::detail::ObjectRegistryData const& rData, ::std::size_t nExpected )
+ SAL_THROW_EXTERN_C();
+
+/** @internal */
+void SAL_CALL osl_detail_ObjectRegistry_registerObject(
+ ::osl::detail::ObjectRegistryData & rData, void const* pObj )
+ SAL_THROW_EXTERN_C();
+
+/** @internal */
+void SAL_CALL osl_detail_ObjectRegistry_revokeObject(
+ ::osl::detail::ObjectRegistryData & rData, void const* pObj )
+ SAL_THROW_EXTERN_C();
+
+/** @internal */
+::osl::Mutex & SAL_CALL osl_detail_ObjectRegistry_getMutex()
+ SAL_THROW_EXTERN_C();
+
+} // extern "C"
+
+namespace osl {
+
+/// @internal
+namespace detail {
+
+struct VoidPtrHash : ::std::unary_function<void const*, ::std::size_t> {
+ ::std::size_t operator()( void const* p ) const {
+ ::std::size_t const d = static_cast< ::std::size_t >(
+ reinterpret_cast< ::std::ptrdiff_t >(p) );
+ return d + (d >> 3);
+ }
+};
+
+typedef ::std::hash_set<void const*, VoidPtrHash, ::std::equal_to<void const*>
> VoidPointerSet;
+
+struct ObjectRegistryData {
+ ObjectRegistryData( ::std::type_info const& rTypeInfo )
+ : m_pName(rTypeInfo.name()), m_nCount(0), m_addresses(),
+
m_bStoreAddresses(osl_detail_ObjectRegistry_storeAddresses(m_pName)){}
+
+ char const* const m_pName;
+ oslInterlockedCount m_nCount;
+ VoidPointerSet m_addresses;
+ bool const m_bStoreAddresses;
+};
+
+template <typename T>
+class ObjectRegistry
+{
+public:
+ ObjectRegistry() : m_data( typeid(T) ) {}
+ ~ObjectRegistry() { checkObjectCount(0); }
+
+ bool checkObjectCount( ::std::size_t nExpected ) const {
+ bool const bRet = osl_detail_ObjectRegistry_checkObjectCount(
+ m_data, nExpected );
+ if (!bRet && m_data.m_bStoreAddresses) {
+ MutexGuard const guard( osl_detail_ObjectRegistry_getMutex() );
+ // following loop is for debugging purposes, iterating over map:
+ VoidPointerSet::const_iterator iPos(m_data.m_addresses.begin());
+ VoidPointerSet::const_iterator const
iEnd(m_data.m_addresses.end());
+ for ( ; iPos != iEnd; ++iPos ) {
+ OSL_ASSERT( *iPos != 0 );
+ }
+ }
+ return bRet;
+ }
+
+ void registerObject( void const* pObj ) {
+ osl_detail_ObjectRegistry_registerObject(m_data, pObj);
+ }
+
+ void revokeObject( void const* pObj ) {
+ osl_detail_ObjectRegistry_revokeObject(m_data, pObj);
+ }
+
+private:
+ // not impl:
+ ObjectRegistry( ObjectRegistry const& );
+ ObjectRegistry const& operator=( ObjectRegistry const& );
+
+ ObjectRegistryData m_data;
+};
+
+} // namespace detail
+
+/** Helper class which indicates leaking object(s) of a particular class in
+ non-pro builds; use e.g.
+
+ <pre>
+ class MyClass : private osl::DebugBase<MyClass> {...};
+ </pre>
+
+ Using the environment variable
+
+ OSL_DEBUGBASE_STORE_ADDRESSES=MyClass;YourClass;...
+
+ you can specify a ';'-separated list of strings matching to class names
+ (or "all" for all classes), for which DebugBase stores addresses to created
+ objects instead of just counting them. This enables you to iterate over
+ leaking objects in your debugger.
+
+ @tpl InheritingClassT binds the template instance to that class
+ @internal Use at own risk.
+ For now this is just public (yet unpublished) API and may change
+ in the future!
+*/
+template <typename InheritingClassT>
+class DebugBase
+{
+public:
+#if OSL_DEBUG_LEVEL <= 0
+ static bool checkObjectCount( ::std::size_t = 0 ) { return true; }
+#else // OSL_DEBUG_LEVEL > 0
+ /** @return whether the expected number of objects is alive,
+ else this function OSL_ASSERTs
+ */
+ static bool checkObjectCount( ::std::size_t nExpected = 0 ) {
+ return StaticObjectRegistry::get().checkObjectCount(nExpected);
+ }
+
+protected:
+ DebugBase() {
+ StaticObjectRegistry::get().registerObject( this );
+ }
+ ~DebugBase() {
+ StaticObjectRegistry::get().revokeObject( this );
+ }
+
+private:
+ struct StaticObjectRegistry
+ : ::rtl::Static<detail::ObjectRegistry<InheritingClassT>,
+ StaticObjectRegistry> {};
+#endif
+};
+
+} // namespace osl
+
+#endif // ! defined(OSL_DIAGNOSE_HXX_INCLUDED)
+
Added: openoffice/branches/olcProfileNano/sal/inc/osl/file.h
URL:
http://svn.apache.org/viewvc/openoffice/branches/olcProfileNano/sal/inc/osl/file.h?rev=1734003&view=auto
==============================================================================
--- openoffice/branches/olcProfileNano/sal/inc/osl/file.h (added)
+++ openoffice/branches/olcProfileNano/sal/inc/osl/file.h Mon Mar 7 23:34:03
2016
@@ -0,0 +1,1590 @@
+/**************************************************************
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ *************************************************************/
+
+
+
+/** @HTML */
+
+#ifndef _OSL_FILE_H_
+#define _OSL_FILE_H_
+
+#include <osl/time.h>
+# include <rtl/ustring.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** @file
+
+Main goals and usage hints
+
+The main intentention of this interface is to provide an universal portable and
+high performance access to file system issues on any operating system.<p>
+
+There are a few main goals:<p>
+
+1.The path specifications always has to be absolut. Any usage of relative path
+specifications is forbidden. Exceptions are
<code>osl_getSystemPathFromFileURL</code>,
+<code>osl_getFileURLFromSystemPath</code> and
<code>osl_getAbsoluteFileURL</code>. Most operating systems
+provide a "Current Directory" per process. This is the reason why relative path
+specifications can cause problems in multithreading environments.<p>
+
+2.Proprietary notations of file paths are not supported. Every path notation
+must the file URL specification. File URLs must be encoded in UTF8 and
+after that escaped. Although the URL parameter is a unicode string, the must
+contain only ASCII characters<p>
+
+3.The caller cannot get any information whether a file system is case
sensitive,
+case preserving or not. The operating system implementation itself should
+determine if it can map case-insensitive paths. The case correct notation of
+a filename or file path is part of the "File Info". This case correct name
+can be used as a unique key if necessary.<p>
+
+4. Obtaining information about files or volumes is controlled by a
+bitmask which specifies which fields are of interest. Due to performance
+issues it is not recommended to obtain information which is not needed.
+But if the operating system provides more information anyway the
+implementation can set more fields on output as were requested. It is in the
+responsibility of the caller to decide if he uses this additional information
+or not. But he should do so to prevent further unnecessary calls if the
information
+is already there.<br>
+
+The input bitmask supports a flag <code>osl_FileStatus_Mask_Validate</code>
which
+can be used to force retrieving uncached validated information. Setting this
flag
+when calling <code>osl_getFileStatus</code> in combination with no other flag
is
+a synonym for a "FileExists". This should only be done when processing a
single file
+(f.e. before opening) and NEVER during enumeration of directory contents on
any step
+of information processing. This would change the runtime behaviour from O(n) to
+O(n*n/2) on nearly every file system.<br>
+On Windows NT reading the contents of an directory with 7000 entries and
+getting full information about every file only takes 0.6 seconds. Specifying
the
+flag <code>osl_FileStatus_Mask_Validate</code> for each entry will increase the
+time to 180 seconds (!!!).
+
+*/
+
+
+
+/* Error codes according to errno */
+
+typedef enum {
+ osl_File_E_None,
+ osl_File_E_PERM,
+ osl_File_E_NOENT,
+ osl_File_E_SRCH,
+ osl_File_E_INTR,
+ osl_File_E_IO,
+ osl_File_E_NXIO,
+ osl_File_E_2BIG,
+ osl_File_E_NOEXEC,
+ osl_File_E_BADF,
+ osl_File_E_CHILD,
+ osl_File_E_AGAIN,
+ osl_File_E_NOMEM,
+ osl_File_E_ACCES,
+ osl_File_E_FAULT,
+ osl_File_E_BUSY,
+ osl_File_E_EXIST,
+ osl_File_E_XDEV,
+ osl_File_E_NODEV,
+ osl_File_E_NOTDIR,
+ osl_File_E_ISDIR,
+ osl_File_E_INVAL,
+ osl_File_E_NFILE,
+ osl_File_E_MFILE,
+ osl_File_E_NOTTY,
+ osl_File_E_FBIG,
+ osl_File_E_NOSPC,
+ osl_File_E_SPIPE,
+ osl_File_E_ROFS,
+ osl_File_E_MLINK,
+ osl_File_E_PIPE,
+ osl_File_E_DOM,
+ osl_File_E_RANGE,
+ osl_File_E_DEADLK,
+ osl_File_E_NAMETOOLONG,
+ osl_File_E_NOLCK,
+ osl_File_E_NOSYS,
+ osl_File_E_NOTEMPTY,
+ osl_File_E_LOOP,
+ osl_File_E_ILSEQ,
+ osl_File_E_NOLINK,
+ osl_File_E_MULTIHOP,
+ osl_File_E_USERS,
+ osl_File_E_OVERFLOW,
+ osl_File_E_NOTREADY,
+ osl_File_E_invalidError, /* unmapped error: always last
entry in enum! */
+ osl_File_E_TIMEDOUT,
+ osl_File_E_NETWORK,
+ osl_File_E_FORCE_EQUAL_SIZE,
+ osl_File_E_LOCKED = SAL_MAX_ENUM
+} oslFileError;
+
+typedef void *oslDirectory;
+typedef void *oslDirectoryItem;
+
+
+/** Open a directory for enumerating its contents.
+
+ @param pustrDirectoryURL [in]
+ The full qualified URL of the directory.
+
+ @param pDirectory [out]
+ On success it receives a handle used for subsequent calls by
osl_getNextDirectoryItem().
+ The handle has to be released by a call to osl_closeDirectory().
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOENT the specified path doesn't exist<br>
+ osl_File_E_NOTDIR the specified path is not an directory <br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_MFILE too many open files used by the process<br>
+ osl_File_E_NFILE too many open files in the system<br>
+ osl_File_E_NAMETOOLONG File name too long<br>
+ osl_File_E_LOOP Too many symbolic links encountered<p>
+
+ @see osl_getNextDirectoryItem()
+ @see osl_closeDirectory()
+*/
+
+oslFileError SAL_CALL osl_openDirectory( rtl_uString *pustrDirectoryURL,
oslDirectory *pDirectory);
+
+
+/** Retrieve the next item of a previously opened directory.
+
+ Retrieves the next item of a previously opened directory.
+ All handles have an initial refcount of 1.
+
+ @param Directory [in]
+ A directory handle received from a previous call to osl_openDirectory().
+
+ @param pItem [out]
+ On success it receives a handle that can be used for subsequent calls
to osl_getFileStatus().
+ The handle has to be released by a call to osl_releaseDirectoryItem().
+
+ @param uHint [in]
+ With this parameter the caller can tell the implementation that (s)he
+ is going to call this function uHint times afterwards. This enables the
implementation to
+ get the information for more than one file and cache it until the next
calls.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_NOENT no more entries in this directory<br>
+ osl_File_E_BADF invalid oslDirectory parameter<br>
+ osl_File_E_OVERFLOW the value too large for defined data type
+
+ @see osl_releaseDirectoryItem()
+ @see osl_acquireDirectoryItem()
+ @see osl_getDirectoryItem()
+ @see osl_getFileStatus()
+*/
+
+oslFileError SAL_CALL osl_getNextDirectoryItem(
+ oslDirectory Directory,
+ oslDirectoryItem *pItem,
+ sal_uInt32 uHint
+ );
+
+
+/** Release a directory handle.
+
+ @param Directory [in]
+ A handle received by a call to osl_openDirectory().
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOMEM not enough memory for allocating structures<br>
+ osl_File_E_BADF invalid oslDirectory parameter<br>
+ osl_File_E_INTR the function call was interrupted<p>
+
+ @see osl_openDirectory()
+*/
+
+oslFileError SAL_CALL osl_closeDirectory(oslDirectory Directory);
+
+
+/** Retrieve a single directory item.
+
+ Retrieves a single directory item. The returned handle has an initial
refcount of 1.
+ Due to performance issues it is not recommended to use this function while
+ enumerating the contents of a directory. In this case use
osl_getNextDirectoryItem() instead.
+
+ @param pustrFileURL [in]
+ An absolute file URL.
+
+ @param pItem [out]
+ On success it receives a handle which can be used for subsequent calls
to osl_getFileStatus().
+ The handle has to be released by a call to osl_releaseDirectoryItem().
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_MFILE too many open files used by the process<br>
+ osl_File_E_NFILE too many open files in the system<br>
+ osl_File_E_NOENT no such file or directory<br>
+ osl_File_E_LOOP too many symbolic links encountered<br>
+ osl_File_E_NAMETOOLONG the file name is too long<br>
+ osl_File_E_NOTDIR a component of the path prefix of path is not a
directory<br>
+ osl_File_E_IO on I/O errors<br>
+ osl_File_E_MULTIHOP multihop attempted<br>
+ osl_File_E_NOLINK link has been severed<br>
+ osl_File_E_FAULT bad address<br>
+ osl_File_E_INTR the function call was interrupted<p>
+
+ @see osl_releaseDirectoryItem()
+ @see osl_acquireDirectoryItem()
+ @see osl_getFileStatus()
+ @see osl_getNextDirectoryItem()
+*/
+
+oslFileError SAL_CALL osl_getDirectoryItem(
+ rtl_uString *pustrFileURL,
+ oslDirectoryItem *pItem
+ );
+
+
+/** Increase the refcount of a directory item handle.
+
+ The caller responsible for releasing the directory item handle using
osl_releaseDirectoryItem().
+
+ @param Item [in]
+ A handle received by a call to osl_getDirectoryItem() or
osl_getNextDirectoryItem().
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_NOMEM not enough memory for allocating structures<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+
+ @see osl_getDirectoryItem()
+ @see osl_getNextDirectoryItem()
+ @see osl_releaseDirectoryItem()
+*/
+
+oslFileError SAL_CALL osl_acquireDirectoryItem( oslDirectoryItem Item );
+
+
+/** Decrease the refcount of a directory item handle.
+
+ Decreases the refcount of a directory item handle.
+ If the refcount reaches 0 the data associated with
+ this directory item handle will be released.
+
+ @param Item [in]
+ A handle received by a call to osl_getDirectoryItem() or
osl_getNextDirectoryItem().
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_NOMEM not enough memory for allocating structures<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+
+ @see osl_getDirectoryItem()
+ @see osl_getNextDirectoryItem()
+ @see osl_acquireDirectoryItem()
+*/
+
+oslFileError SAL_CALL osl_releaseDirectoryItem( oslDirectoryItem Item );
+
+/* File types */
+
+typedef enum {
+ osl_File_Type_Directory,
+ osl_File_Type_Volume,
+ osl_File_Type_Regular,
+ osl_File_Type_Fifo,
+ osl_File_Type_Socket,
+ osl_File_Type_Link,
+ osl_File_Type_Special,
+ osl_File_Type_Unknown
+} oslFileType;
+
+/* File attributes */
+#define osl_File_Attribute_ReadOnly 0x00000001
+#define osl_File_Attribute_Hidden 0x00000002
+#define osl_File_Attribute_Executable 0x00000010
+#define osl_File_Attribute_GrpWrite 0x00000020
+#define osl_File_Attribute_GrpRead 0x00000040
+#define osl_File_Attribute_GrpExe 0x00000080
+#define osl_File_Attribute_OwnWrite 0x00000100
+#define osl_File_Attribute_OwnRead 0x00000200
+#define osl_File_Attribute_OwnExe 0x00000400
+#define osl_File_Attribute_OthWrite 0x00000800
+#define osl_File_Attribute_OthRead 0x00001000
+#define osl_File_Attribute_OthExe 0x00002000
+
+/* Flags specifying which fields to retrieve by osl_getFileStatus */
+
+#define osl_FileStatus_Mask_Type
0x00000001
+#define osl_FileStatus_Mask_Attributes 0x00000002
+#define osl_FileStatus_Mask_CreationTime 0x00000010
+#define osl_FileStatus_Mask_AccessTime 0x00000020
+#define osl_FileStatus_Mask_ModifyTime 0x00000040
+#define osl_FileStatus_Mask_FileSize 0x00000080
+#define osl_FileStatus_Mask_FileName 0x00000100
+#define osl_FileStatus_Mask_FileURL 0x00000200
+#define osl_FileStatus_Mask_LinkTargetURL 0x00000400
+#define osl_FileStatus_Mask_All
0x7FFFFFFF
+#define osl_FileStatus_Mask_Validate 0x80000000
+
+
+typedef
+
+/** Structure containing information about files and directories
+
+ @see osl_getFileStatus()
+ @see oslFileType
+*/
+
+struct _oslFileStatus {
+/** Must be initialized with the size in bytes of the structure before passing
it to any function */
+ sal_uInt32 uStructSize;
+/** Determines which members of the structure contain valid data */
+ sal_uInt32 uValidFields;
+/** The type of the file (file, directory, volume). */
+ oslFileType eType;
+/** File attributes */
+ sal_uInt64 uAttributes;
+/** First creation time in nanoseconds since 1/1/1970. Can be the last modify
time depending on
+ platform or file system. */
+ TimeValue aCreationTime;
+/** Last access time in nanoseconds since 1/1/1970. Can be the last modify
time depending on
+ platform or file system. */
+ TimeValue aAccessTime;
+/** Last modify time in nanoseconds since 1/1/1970. */
+ TimeValue aModifyTime;
+/** Size in bytes of the file. Zero for directories and volumes. */
+ sal_uInt64 uFileSize;
+/** Case correct name of the file. Should be set to zero before calling
<code>osl_getFileStatus</code>
+ and released after usage. */
+ rtl_uString *ustrFileName;
+/** Full URL of the file. Should be set to zero before calling
<code>osl_getFileStatus</code>
+ and released after usage. */
+ rtl_uString *ustrFileURL;
+/** Full URL of the target file if the file itself is a link.
+ Should be set to zero before calling <code>osl_getFileStatus</code>
+ and released after usage. */
+ rtl_uString *ustrLinkTargetURL;
+} oslFileStatus;
+
+
+/** Retrieve information about a single file or directory.
+
+ @param Item [in]
+ A handle received by a previous call to osl_getDirectoryItem() or
osl_getNextDirectoryItem().
+
+ @param pStatus [in|out]
+ Points to a structure which receives the information of the file or
directory
+ represented by the handle Item. The member uStructSize has to be
initialized to
+ sizeof(oslFileStatus) before calling this function.
+
+ @param uFieldMask [in]
+ Specifies which fields of the structure pointed to by pStatus are of
interest to the caller.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_LOOP too many symbolic links encountered<br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_NOENT no such file or directory<br>
+ osl_File_E_NAMETOOLONG file name too long<br>
+ osl_File_E_BADF invalid oslDirectoryItem parameter<br>
+ osl_File_E_FAULT bad address<br>
+ osl_File_E_OVERFLOW value too large for defined data type<br>
+ osl_File_E_INTR function call was interrupted<br>
+ osl_File_E_NOLINK link has been severed<br>
+ osl_File_E_MULTIHOP components of path require hopping to multiple
remote machines and the file system does not allow it<br>
+ osl_File_E_MFILE too many open files used by the process<br>
+ osl_File_E_NFILE too many open files in the system<br>
+ osl_File_E_NOSPC no space left on device<br>
+ osl_File_E_NXIO no such device or address<br>
+ osl_File_E_IO on I/O errors<br>
+ osl_File_E_NOSYS function not implemented<p>
+
+ @see osl_getDirectoryItem()
+ @see osl_getNextDirectoryItem()
+ @see oslFileStatus
+*/
+
+oslFileError SAL_CALL osl_getFileStatus( oslDirectoryItem Item, oslFileStatus
*pStatus, sal_uInt32 uFieldMask );
+
+
+typedef void *oslVolumeDeviceHandle;
+
+
+/** Unmount a volume device.
+
+ Unmount the volume specified by the given oslVolumeDeviceHandle.
+
+ @param Handle [in]
+ An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
+
+ @return
+ osl_File_E_None on success<br>
+
+ @todo
+ specify all error codes that may be returned
+
+ @see osl_getVolumeInformation()
+*/
+
+oslFileError SAL_CALL osl_unmountVolumeDevice( oslVolumeDeviceHandle Handle );
+
+
+/** Automount a volume device.
+
+ Automount the volume device specified by the given oslVolumeDeviceHandle.
+
+ @param Handle [in]
+ An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
+
+ @return
+ osl_File_E_None on success<br>
+
+ @todo
+ specify all error codes that may be returned
+
+ @see osl_getVolumeInformation()
+*/
+
+oslFileError SAL_CALL osl_automountVolumeDevice( oslVolumeDeviceHandle Handle
);
+
+
+/** Release a volume device handle.
+
+ Releases the given oslVolumeDeviceHandle which was acquired by a call to
+ osl_getVolumeInformation() or osl_acquireVolumeDeviceHandle().
+
+ @param Handle [in]
+ An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
+
+ @return
+ osl_File_E_None on success<br>
+
+ @todo
+ specify all error codes that may be returned
+
+ @see osl_acquireVolumeDeviceHandle()
+ @see osl_getVolumeInformation()
+*/
+
+oslFileError SAL_CALL osl_releaseVolumeDeviceHandle( oslVolumeDeviceHandle
Handle );
+
+/** Acquire a volume device handle.
+
+ Acquires the given oslVolumeDeviceHandle which was acquired by a call to
+ osl_getVolumeInformation(). The caller is responsible for releasing the
+ acquired handle by calling osl_releaseVolumeDeviceHandle().
+
+ @param Handle [in]
+ An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
+
+ @return
+ osl_File_E_None on success<br>
+
+ @todo
+ specify all error codes that may be returned
+
+ @see osl_getVolumeInformation()
+*/
+
+oslFileError SAL_CALL osl_acquireVolumeDeviceHandle( oslVolumeDeviceHandle
Handle );
+
+
+/** Get the full qualified URL where a device is mounted to.
+
+ @param Handle [in]
+ An oslVolumeDeviceHandle received by a call to
osl_getVolumeInformation().
+
+ @param ppustrDirectoryURL [out]
+ Receives the full qualified URL where the device is mounted to.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_NXIO no such device or address<br>
+ osl_File_E_NODEV no such device<br>
+ osl_File_E_NOENT no such file or directory<br>
+ osl_File_E_FAULT bad address<br>
+ osl_FilE_E_INTR function call was interrupted<br>
+ osl_File_E_IO on I/O errors<br>
+ osl_File_E_MULTIHOP multihop attempted<br>
+ osl_File_E_NOLINK link has been severed<br>
+ osl_File_E_EOVERFLOW value too large for defined data type<br>
+
+ @see osl_getVolumeInformation()
+ @see osl_automountVolumeDevice()
+ @see osl_unmountVolumeDevice()
+*/
+
+oslFileError SAL_CALL osl_getVolumeDeviceMountPath( oslVolumeDeviceHandle
Handle, rtl_uString **ppustrDirectoryURL);
+
+/* Volume attributes */
+
+#define osl_Volume_Attribute_Removeable 0x00000001L
+#define osl_Volume_Attribute_Remote 0x00000002L
+#define osl_Volume_Attribute_CompactDisc 0x00000004L
+#define osl_Volume_Attribute_FixedDisk 0x00000008L
+#define osl_Volume_Attribute_RAMDisk 0x00000010L
+#define osl_Volume_Attribute_FloppyDisk 0x00000020L
+
+#define osl_Volume_Attribute_Case_Is_Preserved 0x00000040L
+#define osl_Volume_Attribute_Case_Sensitive 0x00000080L
+
+/* Flags specifying which fields to retrieve by osl_getVolumeInfo */
+
+#define osl_VolumeInfo_Mask_Attributes 0x00000001L
+#define osl_VolumeInfo_Mask_TotalSpace 0x00000002L
+#define osl_VolumeInfo_Mask_UsedSpace 0x00000004L
+#define osl_VolumeInfo_Mask_FreeSpace 0x00000008L
+#define osl_VolumeInfo_Mask_MaxNameLength 0x00000010L
+#define osl_VolumeInfo_Mask_MaxPathLength 0x00000020L
+#define osl_VolumeInfo_Mask_FileSystemName 0x00000040L
+#define osl_VolumeInfo_Mask_DeviceHandle 0x00000080L
+#define osl_VolumeInfo_Mask_FileSystemCaseHandling 0x00000100L
+
+typedef
+
+/** Structure containing information about volumes
+
+ @see osl_getVolumeInformation()
+ @see oslFileType
+*/
+
+struct _oslVolumeInfo {
+/** Must be initialized with the size in bytes of the structure before passing
it to any function */
+ sal_uInt32 uStructSize;
+/** Determines which members of the structure contain valid data */
+ sal_uInt32 uValidFields;
+/** Attributes of the volume (remote and/or removable) */
+ sal_uInt32 uAttributes;
+/** Total available space on the volume for the current process/user */
+ sal_uInt64 uTotalSpace;
+/** Used space on the volume for the current process/user */
+ sal_uInt64 uUsedSpace;
+/** Free space on the volume for the current process/user */
+ sal_uInt64 uFreeSpace;
+/** Maximum length of file name of a single item */
+ sal_uInt32 uMaxNameLength;
+/** Maximum length of a full quallified path in system notation */
+ sal_uInt32 uMaxPathLength;
+/** Points to a string that receives the name of the file system type. String
should be set to zero before calling <code>osl_getVolumeInformation</code>
+ and released after usage. */
+ rtl_uString *ustrFileSystemName;
+/** Pointer to handle the receives underlying device. Handle should be set to
zero before calling <code>osl_getVolumeInformation</code>*/
+ oslVolumeDeviceHandle *pDeviceHandle;
+} oslVolumeInfo;
+
+
+/** Retrieve information about a volume.
+
+ Retrieves information about a volume. A volume can either be a mount
point, a network
+ resource or a drive depending on Operating System and File System.
Before calling this
+ function osl_getFileStatus() should be called to determine if the type
is
+ osl_file_Type_Volume.
+
+ @param pustrDirectoryURL [in]
+ Full qualified URL of the volume
+
+ @param pInfo [out]
+ On success it receives information about the volume.
+
+ @param uFieldMask [in]
+ Specifies which members of the structure should be filled
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOTDIR not a directory<br>
+ osl_File_E_NAMETOOLONG file name too long<br>
+ osl_File_E_NOENT no such file or directory<br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_LOOP too many symbolic links encountered<br>
+ ols_File_E_FAULT Bad address<br>
+ osl_File_E_IO on I/O errors<br>
+ osl_File_E_NOSYS function not implemented<br>
+ osl_File_E_MULTIHOP multihop attempted<br>
+ osl_File_E_NOLINK link has been severed<br>
+ osl_File_E_INTR function call was interrupted<br>
+
+ @see osl_getFileStatus()
+ @see oslVolumeInfo
+*/
+
+oslFileError SAL_CALL osl_getVolumeInformation(
+ rtl_uString *pustrDirectoryURL,
+ oslVolumeInfo *pInfo,
+ sal_uInt32 uFieldMask );
+
+typedef void *oslFileHandle;
+
+/* Open flags */
+
+#define osl_File_OpenFlag_Read 0x00000001L
+#define osl_File_OpenFlag_Write 0x00000002L
+#define osl_File_OpenFlag_Create 0x00000004L
+#define osl_File_OpenFlag_NoLock 0x00000008L
+
+/** Open a regular file.
+
+ Open a file. Only regular files can be openend.
+
+ @param pustrFileURL [in]
+ The full qualified URL of the file to open.
+
+ @param pHandle [out]
+ On success it receives a handle to the open file.
+
+ @param uFlags [in]
+ Specifies the open mode.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NAMETOOLONG pathname was too long<br>
+ osl_File_E_NOENT no such file or directory<br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_AGAIN a write lock could not be established<br>
+ osl_File_E_NOTDIR not a directory<br>
+ osl_File_E_NXIO no such device or address<br>
+ osl_File_E_NODEV no such device<br>
+ osl_File_E_ROFS read-only file system<br>
+ osl_File_E_TXTBSY text file busy<br>
+ osl_File_E_FAULT bad address<br>
+ osl_File_E_LOOP too many symbolic links encountered<br>
+ osl_File_E_NOSPC no space left on device<br>
+ osl_File_E_ISDIR is a directory<br>
+ osl_File_E_MFILE too many open files used by the process<br>
+ osl_File_E_NFILE too many open files in the system<br>
+ osl_File_E_DQUOT quota exceeded<br>
+ osl_File_E_EXIST file exists<br>
+ osl_FilE_E_INTR function call was interrupted<br>
+ osl_File_E_IO on I/O errors<br>
+ osl_File_E_MULTIHOP multihop attempted<br>
+ osl_File_E_NOLINK link has been severed<br>
+ osl_File_E_EOVERFLOW value too large for defined data type<br>
+
+ @see osl_closeFile()
+ @see osl_setFilePos()
+ @see osl_getFilePos()
+ @see osl_readFile()
+ @see osl_writeFile()
+ @see osl_setFileSize()
+ @see osl_getFileSize()
+*/
+
+oslFileError SAL_CALL osl_openFile( rtl_uString *pustrFileURL, oslFileHandle
*pHandle, sal_uInt32 uFlags );
+
+#define osl_Pos_Absolut 1
+#define osl_Pos_Current 2
+#define osl_Pos_End 3
+
+/** Set the internal position pointer of an open file.
+
+ @param Handle [in]
+ Handle to a file received by a previous call to osl_openFile().
+
+ @param uHow [in]
+ Distance to move the internal position pointer (from uPos).
+
+ @param uPos [in]
+ Absolute position from the beginning of the file.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_OVERFLOW the resulting file offset would be a value which
cannot be represented correctly for regular files<br>
+
+ @see osl_openFile()
+ @see osl_getFilePos()
+*/
+
+oslFileError SAL_CALL osl_setFilePos( oslFileHandle Handle, sal_uInt32 uHow,
sal_Int64 uPos );
+
+
+/** Retrieve the current position of the internal pointer of an open file.
+
+ @param Handle [in]
+ Handle to a file received by a previous call to osl_openFile().
+
+ @param pPos [out]
+ On success receives the current position of the file pointer.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_OVERFLOW the resulting file offset would be a value which
cannot be represented correctly for regular files<br>
+
+ @see osl_openFile()
+ @see osl_setFilePos()
+ @see osl_readFile()
+ @see osl_writeFile()
+*/
+
+oslFileError SAL_CALL osl_getFilePos( oslFileHandle Handle, sal_uInt64 *pPos );
+
+
+/** Set the file size of an open file.
+
+ Sets the file size of an open file. The file can be truncated or enlarged
by the function.
+ The position of the file pointer is not affeced by this function.
+
+ @param Handle [in]
+ Handle to a file received by a previous call to osl_openFile().
+
+ @param uSize [in]
+ New size in bytes.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_OVERFLOW the resulting file offset would be a value which
cannot be represented correctly for regular files<br>
+
+ @see osl_openFile()
+ @see osl_setFilePos()
+ @see osl_getFileStatus()
+ @see osl_getFileSize()
+*/
+
+oslFileError SAL_CALL osl_setFileSize( oslFileHandle Handle, sal_uInt64 uSize
);
+
+
+/** Get the file size of an open file.
+
+ Gets the file size of an open file.
+ The position of the file pointer is not affeced by this function.
+
+ @param Handle [in]
+ Handle to a file received by a previous call to osl_openFile().
+
+ @param pSize [out]
+ Current size in bytes.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_OVERFLOW the resulting file offset would be a value which
cannot be represented correctly for regular files<br>
+
+ @see osl_openFile()
+ @see osl_setFilePos()
+ @see osl_getFileStatus()
+*/
+
+oslFileError SAL_CALL osl_getFileSize( oslFileHandle Handle, sal_uInt64 *pSize
);
+
+
+/** Map flags.
+
+ @since UDK 3.2.10
+ */
+#define osl_File_MapFlag_RandomAccess ((sal_uInt32)(0x1))
+
+/** Map flag denoting that the mapped address space will be accessed by the
+ process soon (and it is advantageous for the operating system to already
+ start paging in the data).
+
+ @since UDK 3.2.12
+ */
+#define osl_File_MapFlag_WillNeed ((sal_uInt32)(0x2))
+
+/** Map a shared file into memory.
+
+ @since UDK 3.2.10
+ */
+oslFileError
+SAL_CALL osl_mapFile (
+ oslFileHandle Handle,
+ void** ppAddr,
+ sal_uInt64 uLength,
+ sal_uInt64 uOffset,
+ sal_uInt32 uFlags
+);
+
+
+/** Unmap a shared file from memory.
+
+ @since UDK 3.2.10
+ */
+oslFileError
+SAL_CALL osl_unmapFile (
+ void* pAddr,
+ sal_uInt64 uLength
+);
+
+
+/** Read a number of bytes from a file.
+
+ Reads a number of bytes from a file. The internal file pointer is
+ increased by the number of bytes read.
+
+ @param Handle [in]
+ Handle to a file received by a previous call to osl_openFile().
+
+ @param pBuffer [out]
+ Points to a buffer which receives data. The buffer must be large enough
+ to hold uBytesRequested bytes.
+
+ @param uBytesRequested [in]
+ Number of bytes which should be retrieved.
+
+ @param pBytesRead [out]
+ On success the number of bytes which have actually been retrieved.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_INTR function call was interrupted<br>
+ osl_File_E_IO on I/O errors<br>
+ osl_File_E_ISDIR is a directory<br>
+ osl_File_E_BADF bad file<br>
+ osl_File_E_FAULT bad address<br>
+ osl_File_E_AGAIN operation would block<br>
+ osl_File_E_NOLINK link has been severed<br>
+
+ @see osl_openFile()
+ @see osl_writeFile()
+ @see osl_readLine()
+ @see osl_setFilePos()
+*/
+
+oslFileError SAL_CALL osl_readFile( oslFileHandle Handle, void *pBuffer,
sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead );
+
+
+/** Test if the end of a file is reached.
+
+ @param Handle [in]
+ Handle to a file received by a previous call to osl_openFile().
+
+ @param pIsEOF [out]
+ Points to a variable that receives the end-of-file status.
+
+ @return
+ osl_File_E_None on success <br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_INTR function call was interrupted<br>
+ osl_File_E_IO on I/O errors<br>
+ osl_File_E_ISDIR is a directory<br>
+ osl_File_E_BADF bad file<br>
+ osl_File_E_FAULT bad address<br>
+ osl_File_E_AGAIN operation would block<br>
+ osl_File_E_NOLINK link has been severed<p>
+
+ @see osl_openFile()
+ @see osl_readFile()
+ @see osl_readLine()
+ @see osl_setFilePos()
+*/
+
+oslFileError SAL_CALL osl_isEndOfFile( oslFileHandle Handle, sal_Bool *pIsEOF
);
+
+
+/** Write a number of bytes to a file.
+
+ Writes a number of bytes to a file.
+ The internal file pointer is increased by the number of bytes read.
+
+ @param Handle [in]
+ Handle to a file received by a previous call to osl_openFile().
+
+ @param pBuffer [in]
+ Points to a buffer which contains the data.
+
+ @param uBytesToWrite [in]
+ Number of bytes which should be written.
+
+ @param pBytesWritten [out]
+ On success the number of bytes which have actually been written.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_FBIG file too large<br>
+ osl_File_E_DQUOT quota exceeded<p>
+ osl_File_E_AGAIN operation would block<br>
+ osl_File_E_BADF bad file<br>
+ osl_File_E_FAULT bad address<br>
+ osl_File_E_INTR function call was interrupted<br>
+ osl_File_E_IO on I/O errosr<br>
+ osl_File_E_NOLCK no record locks available<br>
+ osl_File_E_NOLINK link has been severed<br>
+ osl_File_E_NOSPC no space left on device<br>
+ osl_File_E_NXIO no such device or address<br>
+
+ @see osl_openFile()
+ @see osl_readFile()
+ @see osl_setFilePos()
+*/
+
+oslFileError SAL_CALL osl_writeFile( oslFileHandle Handle, const void
*pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten );
+
+/** Read a number of bytes from a specified offset in a file.
+
+ The current position of the internal file pointer may or may not be
changed.
+
+ @since UDK 3.2.10
+ */
+oslFileError SAL_CALL osl_readFileAt(
+ oslFileHandle Handle,
+ sal_uInt64 uOffset,
+ void* pBuffer,
+ sal_uInt64 uBytesRequested,
+ sal_uInt64* pBytesRead
+);
+
+
+/** Write a number of bytes to a specified offset in a file.
+
+ The current position of the internal file pointer may or may not be
changed.
+
+ @since UDK 3.2.10
+ */
+oslFileError SAL_CALL osl_writeFileAt(
+ oslFileHandle Handle,
+ sal_uInt64 uOffset,
+ const void* pBuffer,
+ sal_uInt64 uBytesToWrite,
+ sal_uInt64* pBytesWritten
+);
+
+
+/** Read a line from a file.
+
+ Reads a line from a file. The new line delimiter is NOT returned!
+
+ @param Handle [in]
+ Handle to a file received by a previous call to osl_openFile().
+
+ @param ppSequence [in/out]
+ A pointer pointer to a sal_Sequence that will hold the line read on
success.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_INTR function call was interrupted<br>
+ osl_File_E_IO on I/O errors<br>
+ osl_File_E_ISDIR is a directory<br>
+ osl_File_E_BADF bad file<br>
+ osl_File_E_FAULT bad address<br>
+ osl_File_E_AGAIN operation would block<br>
+ osl_File_E_NOLINK link has been severed<p>
+
+ @see osl_openFile()
+ @see osl_readFile()
+ @see osl_writeFile()
+ @see osl_setFilePos()
+*/
+
+oslFileError SAL_CALL osl_readLine( oslFileHandle Handle, sal_Sequence**
ppSequence );
+
+/** Synchronize the memory representation of a file with that on the physical
medium.
+
+ The function ensures that all modified data and attributes of the file
associated with
+ the given file handle have been written to the physical medium.
+ In case the hard disk has a write cache enabled, the data may not really
be on
+ permanent storage when osl_syncFile returns.
+
+ @param Handle
+ [in] Handle to a file received by a previous call to osl_openFile().
+
+ @return
+ <dl>
+ <dt>osl_File_E_None</dt>
+ <dd>On success</dd>
+ <dt>osl_File_E_INVAL</dt>
+ <dd>The value of the input parameter is invalid</dd>
+ </dl>
+ <br><p><strong>In addition to these error codes others may occur as
well, for instance:</strong></p><br>
+ <dl>
+ <dt>osl_File_E_BADF</dt>
+ <dd>The file associated with the given file handle is not open for
writing</dd>
+ <dt>osl_File_E_IO</dt>
+ <dd>An I/O error occurred</dd>
+ <dt>osl_File_E_NOSPC</dt>
+ <dd>There is no enough space on the target device</dd>
+ <dt>osl_File_E_ROFS</dt>
+ <dd>The file associated with the given file handle is located on a read
only file system</dd>
+ <dt>osl_File_E_TIMEDOUT</dt>
+ <dd>A remote connection timed out. This may happen when a file is on a
remote location</dd>
+ </dl>
+
+ @see osl_openFile()
+ @see osl_writeFile()
+*/
+oslFileError SAL_CALL osl_syncFile(oslFileHandle Handle);
+
+/** Close an open file.
+
+ @param Handle [in]
+ Handle to a file received by a previous call to osl_openFile().
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_BADF Bad file<br>
+ osl_File_E_INTR function call was interrupted<br>
+ osl_File_E_NOLINK link has been severed<br>
+ osl_File_E_NOSPC no space left on device<br>
+ osl_File_E_IO on I/O errors<br>
+
+ @see osl_openFile()
+*/
+
+oslFileError SAL_CALL osl_closeFile( oslFileHandle Handle );
+
+
+/** Create a directory.
+
+ @param pustrDirectoryURL [in]
+ Full qualified URL of the directory to create.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_EXIST file exists<br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_NAMETOOLONG file name too long<br>
+ osl_File_E_NOENT no such file or directory<br>
+ osl_File_E_NOTDIR not a directory<br>
+ osl_File_E_ROFS read-only file system<br>
+ osl_File_E_NOSPC no space left on device<br>
+ osl_File_E_DQUOT quota exceeded<br>
+ osl_File_E_LOOP too many symbolic links encountered<br>
+ osl_File_E_FAULT bad address<br>
+ osl_FileE_IO on I/O errors<br>
+ osl_File_E_MLINK too many links<br>
+ osl_File_E_MULTIHOP multihop attempted<br>
+ osl_File_E_NOLINK link has been severed<br>
+
+ @see osl_removeDirectory()
+*/
+
+oslFileError SAL_CALL osl_createDirectory( rtl_uString* pustrDirectoryURL );
+
+
+/** Remove an empty directory.
+
+ @param pustrDirectoryURL [in]
+ Full qualified URL of the directory.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_PERM operation not permitted<br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_NOENT no such file or directory<br>
+ osl_File_E_NOTDIR not a directory<br>
+ osl_File_E_NOTEMPTY directory not empty<br>
+ osl_File_E_FAULT bad address<br>
+ osl_File_E_NAMETOOLONG file name too long<br>
+ osl_File_E_BUSY device or resource busy<br>
+ osl_File_E_ROFS read-only file system<br>
+ osl_File_E_LOOP too many symbolic links encountered<br>
+ osl_File_E_BUSY device or resource busy<br>
+ osl_File_E_EXIST file exists<br>
+ osl_File_E_IO on I/O errors<br>
+ osl_File_E_MULTIHOP multihop attempted<br>
+ osl_File_E_NOLINK link has been severed<br>
+
+ @see osl_createDirectory()
+*/
+
+oslFileError SAL_CALL osl_removeDirectory( rtl_uString* pustrDirectoryURL );
+
+/** Function pointer representing a function that will be called by
osl_createDirectoryPath
+ if a directory has been created.
+
+ To avoid unpredictable results the callee must not access the directory
whose
+ creation is just notified.
+
+ @param pData
+ [in] User specified data given in osl_createDirectoryPath.
+
+ @param aDirectoryUrl
+ [in] The absolute file URL of the directory that was just created by
+ osl_createDirectoryPath.
+
+ @see osl_createDirectoryPath
+*/
+typedef void (SAL_CALL *oslDirectoryCreationCallbackFunc)(void* pData,
rtl_uString* aDirectoryUrl);
+
+/** Create a directory path.
+
+ The osl_createDirectoryPath function creates a specified directory path.
+ All nonexisting sub directories will be created.
+ <p><strong>PLEASE NOTE:</strong> You cannot rely on getting the error code
+ osl_File_E_EXIST for existing directories. Programming against this error
+ code is in general a strong indication of a wrong usage of
osl_createDirectoryPath.</p>
+
+ @param aDirectoryUrl
+ [in] The absolute file URL of the directory path to create.
+ A relative file URL will not be accepted.
+
+ @param aDirectoryCreationFunc
+ [in] Pointer to a function that will be called synchronously
+ for each sub directory that was created. The value of this
+ parameter may be NULL, in this case notifications will not be
+ sent.
+
+ @param pData
+ [in] User specified data to be passed to the directory creation
+ callback function. The value of this parameter may be arbitrary
+ and will not be interpreted by osl_createDirectoryPath.
+
+ @return
+ <dl>
+ <dt>osl_File_E_None</dt>
+ <dd>On success</dd>
+ <dt>osl_File_E_INVAL</dt>
+ <dd>The format of the parameters was not valid</dd>
+ <dt>osl_File_E_ACCES</dt>
+ <dd>Permission denied</dd>
+ <dt>osl_File_E_EXIST</dt>
+ <dd>The final node of the specified directory path already exist</dd>
+ <dt>osl_File_E_NAMETOOLONG</dt>
+ <dd>The name of the specified directory path exceeds the maximum allowed
length</dd>
+ <dt>osl_File_E_NOTDIR</dt>
+ <dd>A component of the specified directory path already exist as file in
any part of the directory path</dd>
+ <dt>osl_File_E_ROFS</dt>
+ <dd>Read-only file system</dd>
+ <dt>osl_File_E_NOSPC</dt>
+ <dd>No space left on device</dd>
+ <dt>osl_File_E_DQUOT</dt>
+ <dd>Quota exceeded</dd>
+ <dt>osl_File_E_FAULT</dt>
+ <dd>Bad address</dd>
+ <dt>osl_File_E_IO</dt>
+ <dd>I/O error</dd>
+ <dt>osl_File_E_LOOP</dt>
+ <dd>Too many symbolic links encountered</dd>
+ <dt>osl_File_E_NOLINK</dt>
+ <dd>Link has been severed</dd>
+ <dt>osl_File_E_invalidError</dt>
+ <dd>An unknown error occurred</dd>
+ </dl>
+
+ @see oslDirectoryCreationFunc
+ @see oslFileError
+ @see osl_createDirectory
+*/
+oslFileError SAL_CALL osl_createDirectoryPath(
+ rtl_uString* aDirectoryUrl,
+ oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc,
+ void* pData);
+
+/** Remove a regular file.
+
+ @param pustrFileURL [in]
+ Full qualified URL of the file to remove.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_PERM operation not permitted<br>
+ osl_File_E_NAMETOOLONG file name too long<br>
+ osl_File_E_NOENT no such file or directory<br>
+ osl_File_E_ISDIR is a directory<br>
+ osl_File_E_ROFS read-only file system<br>
+ osl_File_E_FAULT bad address<br>
+ osl_File_E_LOOP too many symbolic links encountered<br>
+ osl_File_E_IO on I/O errors<br>
+ osl_File_E_BUSY device or resource busy<br>
+ osl_File_E_INTR function call was interrupted<br>
+ osl_File_E_LOOP too many symbolic links encountered<br>
+ osl_File_E_MULTIHOP multihop attempted<br>
+ osl_File_E_NOLINK link has been severed<br>
+ osl_File_E_TXTBSY text file busy<br>
+
+ @see osl_openFile()
+*/
+
+oslFileError SAL_CALL osl_removeFile( rtl_uString* pustrFileURL );
+
+
+/** Copy a file to a new destination.
+
+ Copies a file to a new destination. Copies only files not directories.
+ No assumptions should be made about preserving attributes or file time.
+
+ @param pustrSourceFileURL [in]
+ Full qualified URL of the source file.
+
+ @param pustrDestFileURL [in]
+ Full qualified URL of the destination file. A directory is NOT a valid
destination file!
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_PERM operation not permitted<br>
+ osl_File_E_NAMETOOLONG file name too long<br>
+ osl_File_E_NOENT no such file or directory<br>
+ osl_File_E_ISDIR is a directory<br>
+ osl_File_E_ROFS read-only file system<p>
+
+ @see osl_moveFile()
+ @see osl_removeFile()
+*/
+
+oslFileError SAL_CALL osl_copyFile( rtl_uString* pustrSourceFileURL,
rtl_uString *pustrDestFileURL );
+
+
+/** Move a file or directory to a new destination or renames it.
+
+ Moves a file or directory to a new destination or renames it.
+ File time and attributes are preserved.
+
+ @param pustrSourceFileURL [in]
+ Full qualified URL of the source file.
+
+ @param pustrDestFileURL [in]
+ Full qualified URL of the destination file. An existing directory is
NOT a valid destination !
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_PERM operation not permitted<br>
+ osl_File_E_NAMETOOLONG file name too long<br>
+ osl_File_E_NOENT no such file or directory<br>
+ osl_File_E_ROFS read-only file system<br>
+
+ @see osl_copyFile()
+*/
+
+oslFileError SAL_CALL osl_moveFile( rtl_uString* pustrSourceFileURL,
rtl_uString *pustrDestFileURL );
+
+
+/** Determine a valid unused canonical name for a requested name.
+
+ Determines a valid unused canonical name for a requested name.
+ Depending on the Operating System and the File System the illegal
characters are replaced by valid ones.
+ If a file or directory with the requested name already exists a new name
is generated following
+ the common rules on the actual Operating System and File System.
+
+ @param pustrRequestedURL [in]
+ Requested name of a file or directory.
+
+ @param ppustrValidURL [out]
+ On success receives a name which is unused and valid on the actual
Operating System and
+ File System.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+
+ @see osl_getFileStatus()
+*/
+
+oslFileError SAL_CALL osl_getCanonicalName( rtl_uString *pustrRequestedURL,
rtl_uString **ppustrValidURL);
+
+
+/** Convert a path relative to a given directory into an full qualified
file URL.
+
+ Convert a path relative to a given directory into an full qualified
file URL.
+ The function resolves symbolic links if possible and path ellipses, so
on success
+ the resulting absolute path is fully resolved.
+
+ @param pustrBaseDirectoryURL [in]
+ Base directory URL to which the relative path is related to.
+
+ @param pustrRelativeFileURL [in]
+ An URL of a file or directory relative to the directory path specified
by pustrBaseDirectoryURL
+ or an absolute path.
+ If pustrRelativeFileURL denotes an absolute path pustrBaseDirectoryURL
will be ignored.
+
+ @param ppustrAbsoluteFileURL [out]
+ On success it receives the full qualified absoulte file URL.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOMEM not enough memory for allocating structures <br>
+ osl_File_E_NOTDIR not a directory<br>
+ osl_File_E_ACCES permission denied<br>
+ osl_File_E_NOENT no such file or directory<br>
+ osl_File_E_NAMETOOLONG file name too long<br>
+ osl_File_E_OVERFLOW value too large for defined data type<br>
+ osl_File_E_FAULT bad address<br>
+ osl_File_E_INTR function call was interrupted<br>
+ osl_File_E_LOOP too many symbolic links encountered<br>
+ osl_File_E_MULTIHOP multihop attempted<br>
+ osl_File_E_NOLINK link has been severed<br>
+
+ @see osl_getFileStatus()
+*/
+
+oslFileError SAL_CALL osl_getAbsoluteFileURL(
+ rtl_uString* pustrBaseDirectoryURL,
+ rtl_uString *pustrRelativeFileURL,
+ rtl_uString **ppustrAbsoluteFileURL );
+
+
+/** Convert a system dependend path into a file URL.
+
+ @param pustrSystemPath [in]
+ A System dependent path of a file or directory.
+
+ @param ppustrFileURL [out]
+ On success it receives the file URL.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+
+ @see osl_getSystemPathFromFileURL()
+*/
+
+oslFileError SAL_CALL osl_getFileURLFromSystemPath( rtl_uString
*pustrSystemPath, rtl_uString **ppustrFileURL);
+
+
+/** Searche a full qualified system path or a file URL.
+
+ @param pustrFileName [in]
+ A system dependent path, a file URL, a file or relative directory.
+
+ @param pustrSearchPath [in]
+ A list of system paths, in which a given file has to be searched. The
Notation of a path list is
+ system dependend, e.g. on UNIX system "/usr/bin:/bin" and on Windows
"C:\BIN;C:\BATCH".
+ These paths are only for the search of a file or a relative path,
otherwise it will be ignored.
+ If pustrSearchPath is NULL or while using the search path the search
failed, the function searches for
+ a matching file in all system directories and in the directories listed in
the PATH environment
+ variable.
+ The value of an environment variable should be used (e.g. LD_LIBRARY_PATH)
if the caller is not
+ aware of the Operating System and so doesn't know which path list
delimiter to use.
+
+ @param ppustrFileURL [out]
+ On success it receives the full qualified file URL.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOTDIR not a directory<br>
+ osl_File_E_NOENT no such file or directory not found<br>
+
+ @see osl_getFileURLFromSystemPath()
+ @see osl_getSystemPathFromFileURL()
+*/
+
+oslFileError SAL_CALL osl_searchFileURL( rtl_uString *pustrFileName,
rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL );
+
+
+/** Convert a file URL into a system dependend path.
+
+ @param pustrFileURL [in]
+ A File URL.
+
+ @param ppustrSystemPath [out]
+ On success it receives the system path.
+
+ @return
+ osl_File_E_None on success
+ osl_File_E_INVAL the format of the parameters was not valid
+
+ @see osl_getFileURLFromSystemPath()
+*/
+
+oslFileError SAL_CALL osl_getSystemPathFromFileURL( rtl_uString *pustrFileURL,
rtl_uString **ppustrSystemPath);
+
+
+/** Function pointer representing the function called back from
osl_abbreviateSystemPath
+
+ @param ustrText [in]
+ Text to calculate the width for
+
+ @return
+ The width of the text specified by ustrText, e.g. it can return the
width in pixel
+ or the width in character count.
+
+ @see osl_abbreviateSystemPath()
+*/
+
+typedef sal_uInt32 (SAL_CALL *oslCalcTextWidthFunc)( rtl_uString *ustrText );
+
+
+/** Abbreviate a system notation path.
+
+ @param ustrSystemPath [in]
+ The full system path to abbreviate
+
+ @param pustrCompacted [out]
+ Receives the compacted system path on output
+
+ @param pfnCalcWidth [in]
+ Function ptr that calculates the width of a string. Can be zero.
+
+ @param uMaxWidth [in]
+ Maximum width allowed that is retunrned from pfnCalcWidth.
+ If pfnCalcWidth is zero the character count is assumed as width.
+
+ @return
+ osl_File_E_None on success<br>
+
+ @see oslCalcTextWidthFunc
+*/
+
+oslFileError SAL_CALL osl_abbreviateSystemPath(
+ rtl_uString *ustrSystemPath,
+ rtl_uString **pustrCompacted,
+ sal_uInt32 uMaxWidth,
+ oslCalcTextWidthFunc pCalcWidth );
+
+
+/** Set file attributes.
+
+ @param pustrFileURL [in]
+ The full qualified file URL.
+
+ @param uAttributes [in]
+ Attributes of the file to be set.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+
+ @see osl_getFileStatus()
+*/
+
+oslFileError SAL_CALL osl_setFileAttributes( rtl_uString *pustrFileURL,
sal_uInt64 uAttributes );
+
+
+/** Set the file time.
+
+ @param pustrFileURL [in]
+ The full qualified URL of the file.
+
+ @param aCreationTime [in]
+ Creation time of the given file.
+
+ @param aLastAccessTime [in]
+ Time of the last access of the given file.
+
+ @param aLastWriteTime [in]
+ Time of the last modifying of the given file.
+
+ @return
+ osl_File_E_None on success<br>
+ osl_File_E_INVAL the format of the parameters was not valid<br>
+ osl_File_E_NOENT no such file or directory not found<br>
+
+ @see osl_getFileStatus()
+*/
+
+oslFileError SAL_CALL osl_setFileTime(
+ rtl_uString *pustrFileURL,
+ const TimeValue *aCreationTime,
+ const TimeValue *aLastAccessTime,
+ const TimeValue *aLastWriteTime);
+
+
+/** Retrieves the file URL of the system's temporary directory path
+
+ @param pustrTempDirURL[out]
+ On success receives the URL of system's temporary directory path.
+
+ @return
+ osl_File_E_None on success
+ osl_File_E_NOENT no such file or directory not found
+*/
+
+oslFileError SAL_CALL osl_getTempDirURL( rtl_uString **pustrTempDirURL );
+
+
+/** Creates a temporary file in the directory provided by the caller or the
+ directory returned by osl_getTempDirURL.
+
+ Creates a temporary file in the directory provided by the caller or the
+ directory returned by osl_getTempDirURL.
+ Under UNIX Operating Systems the file will be created with read and write
+ access for the user exclusively.
+ If the caller requests only a handle to the open file but not the name of
+ it, the file will be automatically removed on close else the caller is
+ responsible for removing the file on success.
+
+ @param pustrDirectoryURL [in]
+ Specifies the full qualified URL where the temporary file should be
created.
+ If pustrDirectoryURL is 0 the path returned by osl_getTempDirURL will be
used.
+
+ @param pHandle [out]
+ On success receives a handle to the open file. If pHandle is 0 the file
will
+ be closed on return, in this case ppustrTempFileURL must not be 0.
+
+ @param ppustrTempFileURL [out]
+ On success receives the full qualified URL of the temporary file.
+ If ppustrTempFileURL is 0 the file will be automatically removed on close,
+ in this case pHandle must not be 0.
+ If ppustrTempFileURL is not 0 the caller receives the name of the created
+ file and is responsible for removing the file, in this case
+ *ppustrTempFileURL must be 0 or must point to a valid rtl_uString.
+
+ @descr
+ Description of the different pHandle, ppustrTempFileURL parameter
combinations.
+ pHandle is 0 and ppustrTempDirURL is 0 - this combination is invalid
+ pHandle is not 0 and ppustrTempDirURL is 0 - a handle to the open file
+ will be returned on success and the file will be automatically removed on
close.
+ pHandle is 0 and ppustrTempDirURL is not 0 - the name of the file will be
returned,
+ the caller is responsible for opening, closing and removing the file.
+ pHandle is not 0 and ppustrTempDirURL is not 0 - a handle to the open file
as well as
+ the file name will be returned, the caller is responsible for closing and
removing
+ the file.
+
+ @return
+ osl_File_E_None on success
+ osl_File_E_INVAL the format of the parameter is invalid
+ osl_File_E_NOMEM not enough memory for allocating structures
+ osl_File_E_ACCES Permission denied
+ osl_File_E_NOENT No such file or directory
+ osl_File_E_NOTDIR Not a directory
+ osl_File_E_ROFS Read-only file system
+ osl_File_E_NOSPC No space left on device
+ osl_File_E_DQUOT Quota exceeded
+
+ @see osl_getTempDirURL()
+*/
+
+oslFileError SAL_CALL osl_createTempFile(
+ rtl_uString* pustrDirectoryURL,
+ oslFileHandle* pHandle,
+ rtl_uString** ppustrTempFileURL);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _OSL_FILE_H_ */
+
+
Propchange: openoffice/branches/olcProfileNano/sal/inc/osl/file.h
------------------------------------------------------------------------------
svn:eol-style = native
Added: openoffice/branches/olcProfileNano/sal/inc/osl/process.h
URL:
http://svn.apache.org/viewvc/openoffice/branches/olcProfileNano/sal/inc/osl/process.h?rev=1734003&view=auto
==============================================================================
--- openoffice/branches/olcProfileNano/sal/inc/osl/process.h (added)
+++ openoffice/branches/olcProfileNano/sal/inc/osl/process.h Mon Mar 7
23:34:03 2016
@@ -0,0 +1,439 @@
+/**************************************************************
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ *************************************************************/
+
+
+
+
+#ifndef _OSL_PROCESS_H_
+#define _OSL_PROCESS_H_
+
+#include <rtl/ustring.h>
+#include <rtl/textenc.h>
+#include <rtl/locale.h>
+
+#include <osl/time.h>
+#include <osl/file.h>
+#include <osl/pipe.h>
+#include <osl/socket.h>
+#include <osl/security.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+typedef sal_Int32 oslProcessOption;
+#define osl_Process_WAIT 0x0001 /* wait for completion
*/
+#define osl_Process_SEARCHPATH 0x0002 /* search path for
executable */
+#define osl_Process_DETACHED 0x0004 /* run detached */
+#define osl_Process_NORMAL 0x0000 /* run in normal
window */
+#define osl_Process_HIDDEN 0x0010 /* run hidden */
+#define osl_Process_MINIMIZED 0x0020 /* run in minimized
window */
+#define osl_Process_MAXIMIZED 0x0040 /* run in maximized
window */
+#define osl_Process_FULLSCREEN 0x0080 /* run in fullscreen
window */
+
+typedef sal_Int32 oslProcessData;
+
+/* defines for osl_getProcessInfo , can be OR'ed */
+#define osl_Process_IDENTIFIER 0x0001 /* retrieves the
process identifier */
+#define osl_Process_EXITCODE 0x0002 /* retrieves exit code
of the process */
+#define osl_Process_CPUTIMES 0x0004 /* retrieves used cpu
time */
+#define osl_Process_HEAPUSAGE 0x0008 /* retrieves the used
size of heap */
+
+typedef sal_uInt32 oslProcessIdentifier;
+typedef sal_uInt32 oslProcessExitCode;
+
+typedef enum {
+ osl_Process_E_None, /* no error */
+ osl_Process_E_NotFound, /* image not found */
+ osl_Process_E_TimedOut, /* timout occurred */
+ osl_Process_E_NoPermission, /* permission denied */
+ osl_Process_E_Unknown, /* unknown error */
+ osl_Process_E_InvalidError, /* unmapped error */
+ osl_Process_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
+} oslProcessError;
+
+typedef enum {
+ osl_Process_TypeNone, /* no descriptor */
+ osl_Process_TypeSocket, /* socket */
+ osl_Process_TypeFile, /* file */
+ osl_Process_TypePipe, /* pipe */
+ osl_Process_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
+} oslDescriptorType;
+
+typedef sal_Int32 oslDescriptorFlag;
+#define osl_Process_DFNONE 0x0000
+#define osl_Process_DFWAIT 0x0001
+
+#ifdef SAL_W32
+# pragma pack(push, 8)
+#elif defined(SAL_OS2)
+# pragma pack(push, 4)
+#endif
+
+typedef struct {
+ sal_uInt32 Size;
+ oslProcessData Fields;
+ oslProcessIdentifier Ident;
+ oslProcessExitCode Code;
+ TimeValue UserTime;
+ TimeValue SystemTime;
+ sal_uInt32 HeapUsage;
+} oslProcessInfo;
+
+#if defined( SAL_W32) || defined(SAL_OS2)
+# pragma pack(pop)
+#endif
+
+/** Process handle
+
+ @see osl_executeProcess
+ @see osl_terminateProcess
+ @see osl_freeProcessHandle
+ @see osl_getProcessInfo
+ @see osl_joinProcess
+*/
+typedef void* oslProcess;
+
+/** Execute a process.
+
+ Executes the program image provided in strImageName in a new process.
+
+ @param ustrImageName
+ [in] The file URL of the executable to be started.
+ Can be NULL in this case the file URL of the executable must be the first
element
+ in ustrArguments.
+
+ @param ustrArguments
+ [in] An array of argument strings. Can be NULL if strImageName is not
NULL.
+ If strImageName is NULL it is expected that the first element contains
+ the file URL of the executable to start.
+
+ @param nArguments
+ [in] The number of arguments provided. If this number is 0 strArguments
will be ignored.
+
+ @param Options
+ [in] A combination of int-constants to describe the mode of execution.
+
+ @param Security
+ [in] The user and his rights for which the process is started. May be
NULL in which case
+ the process will be started in the context of the current user.
+
+ @param ustrDirectory
+ [in] The file URL of the working directory of the new process. If the
specified directory
+ does not exist or is inaccessible the working directory of the newly
created process
+ is undefined. If this parameter is NULL or the caller provides an empty
string the
+ new process will have the same current working directory as the calling
process.
+
+ @param ustrEnviroments
+ [in] An array of strings describing environment variables that should
be merged into the
+ environment of the new process. Each string has to be in the form
"variable=value".
+ This parameter can be NULL in which case the new process gets the same
environment
+ as the parent process.
+
+ @param nEnvironmentVars
+ [in] The number of environment variables to set.
+
+ @param pProcess
+ [out] Pointer to a oslProcess variable, which receives the handle of
the newly created process.
+ This parameter must not be NULL.
+
+ @return
+ <dl>
+ <dt>osl_Process_E_None</dt>
+ <dd>on success</dd>
+ <dt>osl_Process_E_NotFound</dt>
+ <dd>if the specified executable could not be found</dd>
+ <dt>osl_Process_E_InvalidError</dt>
+ <dd>if invalid parameters will be detected</dd>
+ <dt>osl_Process_E_Unknown</dt>
+ <dd>if arbitrary other errors occur</dd>
+ </dl>
+
+ @see oslProcessOption
+ @see osl_executeProcess_WithRedirectedIO
+ @see osl_freeProcessHandle
+ @see osl_loginUser
+*/
+oslProcessError SAL_CALL osl_executeProcess(
+ rtl_uString* ustrImageName,
+ rtl_uString* ustrArguments[],
+ sal_uInt32 nArguments,
+ oslProcessOption Options,
+ oslSecurity Security,
+ rtl_uString* ustrDirectory,
+ rtl_uString* ustrEnvironments[],
+ sal_uInt32 nEnvironmentVars,
+ oslProcess* pProcess);
+
+
+/** Execute a process and redirect child process standard IO.
+
+ @param ustrImageName
+ [in] The file URL of the executable to be started.
+ Can be NULL in this case the file URL of the executable must be the first
element
+ in ustrArguments.
+
+ @param ustrArguments
+ [in] An array of argument strings. Can be NULL if strImageName is not
NULL.
+ If strImageName is NULL it is expected that the first element contains
+ the file URL of the executable to start.
+
+ @param nArguments
+ [in] The number of arguments provided. If this number is 0 strArguments
will be ignored.
+
+ @param Options
+ [in] A combination of int-constants to describe the mode of execution.
+
+ @param Security
+ [in] The user and his rights for which the process is started. May be
NULL in which case
+ the process will be started in the context of the current user.
+
+ @param ustrDirectory
+ [in] The file URL of the working directory of the new process. If the
specified directory
+ does not exist or is inaccessible the working directory of the newly
created process
+ is undefined. If this parameter is NULL or the caller provides an empty
string the
+ new process will have the same current working directory as the calling
process.
+
+ @param ustrEnviroments
+ [in] An array of strings describing environment variables that should
be merged into the
+ environment of the new process. Each string has to be in the form
"variable=value".
+ This parameter can be NULL in which case the new process gets the same
environment
+ as the parent process.
+
+ @param nEnvironmentVars
+ [in] The number of environment variables to set.
+
+ @param pProcess
+ [out] Pointer to a oslProcess variable, which receives the handle of
the newly created process.
+ This parameter must not be NULL.
+
+ @param pChildInputWrite
+ [in] Pointer to a oslFileHandle variable that receives the handle which
can be used to write
+ to the child process standard input device. The returned handle is not
random accessible.
+ The handle has to be closed with osl_closeFile if no longer used. This
parameter can be NULL.
+
+ @param pChildOutputRead
+ [in] Pointer to a oslFileHandle variable that receives the handle which
can be used to read from
+ the child process standard output device. The returned handle is not
random accessible.
+ The Handle has to be closed with osl_closeFile if no longer used. This
parameter can be NULL.
+
+ @param pChildErrorRead
+ [in] Pointer to a oslFileHandle variable that receives the handle which
can be used to read from
+ the child process standard error device. The returned handle is not
random accessible.
+ The Handle has to be closed with osl_closeFile if no longer used. This
parameter can be NULL.
+
+ @return
+ <dl>
+ <dt>osl_Process_E_None</dt>
+ <dd>on success</dd>
+ <dt>osl_Process_E_NotFound</dt>
+ <dd>if the specified executable could not be found</dd>
+ <dt>osl_Process_E_InvalidError</dt>
+ <dd>if invalid parameters will be detected</dd>
+ <dt>osl_Process_E_Unknown</dt>
+ <dd>if arbitrary other errors occur</dd>
+ </dl>
+
+ @see oslProcessOption
+ @see osl_executeProcess
+ @see osl_freeProcessHandle
+ @see osl_loginUser
+ @see osl_closeFile
+*/
+oslProcessError SAL_CALL osl_executeProcess_WithRedirectedIO(
+ rtl_uString* strImageName,
+ rtl_uString* ustrArguments[],
+ sal_uInt32 nArguments,
+ oslProcessOption Options,
+ oslSecurity Security,
+ rtl_uString* ustrDirectory,
+ rtl_uString* ustrEnvironments[],
+ sal_uInt32 nEnvironmentVars,
+ oslProcess* pProcess,
+ oslFileHandle* pChildInputWrite,
+ oslFileHandle* pChildOutputRead,
+ oslFileHandle* pChildErrorRead);
+
+/** Terminate a process
+ @param Process [in] the handle of the process to be terminated
+
+ @see osl_executeProcess
+ @see osl_getProcess
+ @see osl_joinProcess
+ */
+oslProcessError SAL_CALL osl_terminateProcess(oslProcess Process);
+
+
+/** @deprecated
+ Retrieve the process handle of a process identifier
+ @param Ident [in] a process identifier
+
+ @return the process handle on success, NULL in all other cases
+ */
+oslProcess SAL_CALL osl_getProcess(oslProcessIdentifier Ident);
+
+
+/** Free the specified proces-handle.
+ @param Process [in]
+*/
+void SAL_CALL osl_freeProcessHandle(oslProcess Process);
+
+
+/** Wait for completation of the specified childprocess.
+ @param Process [in]
+ @return ols_Process_E_None
+ @see osl_executeProcess
+*/
+oslProcessError SAL_CALL osl_joinProcess(oslProcess Process);
+
+/** Wait with a timeout for the completion of the specified child
+ process.
+
+ @param Process [in]
+ A process identifier.
+
+ @param pTimeout [in]
+ A timeout value or NULL for infinite waiting.
+ The unit of resolution is second.
+
+ @return
+ osl_Process_E_None on success
+ osl_Process_E_TimedOut waiting for the child process timed out
+ osl_Process_E_Unknown an error occurred or the parameter are invalid
+
+ @see osl_executeProcess
+*/
+oslProcessError SAL_CALL osl_joinProcessWithTimeout(oslProcess Process, const
TimeValue* pTimeout);
+
+/** Retrieves information about a Process
+ @param Process [in] the process handle of the process
+ @param Field [in] the information which is to be retrieved
+ this can be one or more of
+ osl_Process_IDENTIFIER
+ osl_Process_EXITCODE
+ osl_Process_CPUTIMES
+ osl_Process_HEAPUSAGE
+ @param pInfo [out] a pointer to a vaid oslProcessInfo structure.
+ the Size field has to be initialized with the size
+ of the oslProcessInfo structure.
+ on success the the Field member holds the (or'ed)
+ retrieved valid information fields.
+ @return osl_Process_E_None on success, osl_Process_E_Unknown on failure.
+ */
+oslProcessError SAL_CALL osl_getProcessInfo(oslProcess Process, oslProcessData
Fields,
+ oslProcessInfo* pInfo);
+
+/** Get the filename of the executable.
+ @param strFile [out] the string that receives the executable file path.
+ @return osl_Process_E_None or does not return.
+ @see osl_executeProcess
+*/
+oslProcessError SAL_CALL osl_getExecutableFile(rtl_uString **strFile);
+
+/** @return the number of commandline arguments passed to the main-function of
+ this process
+ @see osl_getCommandArg
+*/
+sal_uInt32 SAL_CALL osl_getCommandArgCount(void);
+
+/** Get the nArg-th command-line argument passed to the main-function of this
process.
+ @param nArg [in] The number of the argument to return.
+ @param strCommandArg [out] The string receives the nArg-th command-line
argument.
+ @return osl_Process_E_None or does not return.
+ @see osl_executeProcess
+*/
+oslProcessError SAL_CALL osl_getCommandArg(sal_uInt32 nArg, rtl_uString
**strCommandArg);
+
+/** Set the command-line arguments as passed to the main-function of this
process.
+
+ Depricated: This function is only for internal use. Passing the args from
main will
+ only work for Unix, on Windows there's no effect, the full command line
will automtically
+ be taken. This is due to Windows 9x/ME limitation that don't allow
UTF-16 wmain to provide
+ a osl_setCommandArgsU( int argc, sal_Unicode **argv );
+
+ @param argc [in] The number of elements in the argv array.
+ @param argv [in] The array of command-line arguments.
+ @see osl_getExecutableFile
+ @see osl_getCommandArgCount
+ @see osl_getCommandArg
+*/
+void SAL_CALL osl_setCommandArgs (int argc, char **argv);
+
+/** Get the value of one environment variable.
+ @param strVar [in] denotes the name of the variable to get.
+ @param strValue [out] string that receives the value of environment
variable.
+*/
+oslProcessError SAL_CALL osl_getEnvironment(rtl_uString *strVar, rtl_uString
**strValue);
+
+/** Set the value of one environment variable.
+ @param strVar [in] denotes the name of the variable to set.
+ @param strValue [in] string of the new value of environment variable.
+
+ @since UDK 3.2.13
+*/
+oslProcessError SAL_CALL osl_setEnvironment(rtl_uString *strVar, rtl_uString
*strValue);
+
+/** Unsets the value of one environment variable.
+ @param strVar [in] denotes the name of the variable to unset.
+
+ @since UDK 3.2.13
+*/
+oslProcessError SAL_CALL osl_clearEnvironment(rtl_uString *strVar);
+
+/** Get the working directory of the current process as a file URL.
+
+ The file URL is encoded as common for the OSL file API.
+ @param pustrWorkingDir [out] string that receives the working
directory file URL.
+*/
+
+oslProcessError SAL_CALL osl_getProcessWorkingDir( rtl_uString
**pustrWorkingDir );
+
+/** Get the locale the process is currently running in.
+
+ The unix implementation caches the value it returns, so if you have to
change the locale
+ your are running in, you will have to use osl_setProcessLocale therefor.
+
+ @param ppLocale [out] a pointer that receives the currently selected
locale structure
+ @see osl_setProcessLocale
+*/
+
+oslProcessError SAL_CALL osl_getProcessLocale( rtl_Locale ** ppLocale );
+
+/** Change the locale of the process.
+
+ @param pLocale [in] a pointer to the locale to be set
+ @see osl_getProcessLocale
+*/
+
+oslProcessError SAL_CALL osl_setProcessLocale( rtl_Locale * pLocale );
+
+
+sal_Bool SAL_CALL osl_sendResourcePipe(oslPipe Pipe, oslSocket Socket);
+
+oslSocket SAL_CALL osl_receiveResourcePipe(oslPipe Pipe);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _OSL_PROCESS_H_ */
+
Propchange: openoffice/branches/olcProfileNano/sal/inc/osl/process.h
------------------------------------------------------------------------------
svn:eol-style = native
