LibreOffice
LibreOffice 7.1 SDK C/C++ API Reference
file.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_OSL_FILE_HXX
21#define INCLUDED_OSL_FILE_HXX
22
23#include "sal/config.h"
24
25#include <string.h>
26
27#include <cstddef>
28
29#include "sal/log.hxx"
30#include "osl/time.h"
31#include "rtl/ustring.hxx"
32
33#include "osl/file.h"
34#include "osl/diagnose.h"
35
36namespace rtl { class ByteSequence; }
37
38namespace osl
39{
40
41
50{
51public:
52
53 enum RC {
102 };
103
104
105public:
106
127 static RC getCanonicalName( const ::rtl::OUString& ustrRequestedURL, ::rtl::OUString& ustrValidURL )
128 {
129 return static_cast< RC >( osl_getCanonicalName( ustrRequestedURL.pData, &ustrValidURL.pData ) );
130 }
131
166 static RC getAbsoluteFileURL( const ::rtl::OUString& ustrBaseDirectoryURL, const ::rtl::OUString& ustrRelativeFileURL, ::rtl::OUString& ustrAbsoluteFileURL )
167 {
168 return static_cast< RC >( osl_getAbsoluteFileURL( ustrBaseDirectoryURL.pData, ustrRelativeFileURL.pData, &ustrAbsoluteFileURL.pData ) );
169 }
170
185 static RC getSystemPathFromFileURL( const ::rtl::OUString& ustrFileURL, ::rtl::OUString& ustrSystemPath )
186 {
187 return static_cast< RC >( osl_getSystemPathFromFileURL( ustrFileURL.pData, &ustrSystemPath.pData ) );
188 }
189
204 static RC getFileURLFromSystemPath( const ::rtl::OUString& ustrSystemPath, ::rtl::OUString& ustrFileURL )
205 {
206 return static_cast< RC >( osl_getFileURLFromSystemPath( ustrSystemPath.pData, &ustrFileURL.pData ) );
207 }
208
236 static RC searchFileURL( const ::rtl::OUString& ustrFileName, const ::rtl::OUString& ustrSearchPath, ::rtl::OUString& ustrFileURL )
237 {
238 return static_cast< RC >( osl_searchFileURL( ustrFileName.pData, ustrSearchPath.pData, &ustrFileURL.pData ) );
239 }
240
250 static RC getTempDirURL( ::rtl::OUString& ustrTempDirURL )
251 {
252 return static_cast< RC >( osl_getTempDirURL( &ustrTempDirURL.pData ) );
253 }
254
303 ::rtl::OUString* pustrDirectoryURL,
304 oslFileHandle* pHandle,
305 ::rtl::OUString* pustrTempFileURL)
306 {
307 rtl_uString* pustr_dir_url = pustrDirectoryURL ? pustrDirectoryURL->pData : NULL;
308 rtl_uString** ppustr_tmp_file_url = pustrTempFileURL ? &pustrTempFileURL->pData : NULL;
309
310 return static_cast< RC >( osl_createTempFile(pustr_dir_url, pHandle, ppustr_tmp_file_url) );
311 }
312};
313
314
320class VolumeDevice : public FileBase
321{
322 oslVolumeDeviceHandle _aHandle;
323
324public:
325
329 VolumeDevice() : _aHandle( NULL )
330 {
331 }
332
339 VolumeDevice( const VolumeDevice & rDevice )
340 {
341 _aHandle = rDevice._aHandle;
342 if ( _aHandle )
344 }
345
350 {
351 if ( _aHandle )
353 }
354
362 {
363 oslVolumeDeviceHandle newHandle = rDevice._aHandle;
364
365 if ( newHandle )
367
368 if ( _aHandle )
370
371 _aHandle = newHandle;
372
373 return *this;
374 }
375
382 {
383 rtl::OUString aPath;
384 osl_getVolumeDeviceMountPath( _aHandle, &aPath.pData );
385 return aPath;
386 }
387
388 friend class VolumeInfo;
389};
390
391
392class Directory;
393
403{
404 oslVolumeInfo _aInfo;
405 sal_uInt32 _nMask;
406 VolumeDevice _aDevice;
407
412
417
418public:
419
425 VolumeInfo( sal_uInt32 nMask )
426 : _nMask( nMask )
427 {
428 memset( &_aInfo, 0, sizeof( oslVolumeInfo ));
429 _aInfo.uStructSize = sizeof( oslVolumeInfo );
430 _aInfo.pDeviceHandle = &_aDevice._aHandle;
431 }
432
434 {
435 if( _aInfo.ustrFileSystemName )
437 }
438
446 bool isValid( sal_uInt32 nMask ) const
447 {
448 return ( nMask & _aInfo.uValidFields ) == nMask;
449 }
450
456 bool getRemoteFlag() const
457 {
458 return (_aInfo.uAttributes & osl_Volume_Attribute_Remote) != 0;
459 }
460
466 bool getRemoveableFlag() const
467 {
468 return (_aInfo.uAttributes & osl_Volume_Attribute_Removeable) != 0;
469 }
470
478 {
479 return (_aInfo.uAttributes & osl_Volume_Attribute_CompactDisc) != 0;
480 }
481
488 bool getFloppyDiskFlag() const
489 {
490 return (_aInfo.uAttributes & osl_Volume_Attribute_FloppyDisk) != 0;
491 }
492
499 bool getFixedDiskFlag() const
500 {
501 return (_aInfo.uAttributes & osl_Volume_Attribute_FixedDisk) != 0;
502 }
503
510 bool getRAMDiskFlag() const
511 {
512 return (_aInfo.uAttributes & osl_Volume_Attribute_RAMDisk) != 0;
513 }
514
522 sal_uInt64 getTotalSpace() const
523 {
524 return _aInfo.uTotalSpace;
525 }
526
534 sal_uInt64 getFreeSpace() const
535 {
536 return _aInfo.uFreeSpace;
537 }
538
546 sal_uInt64 getUsedSpace() const
547 {
548 return _aInfo.uUsedSpace;
549 }
550
558 sal_uInt32 getMaxNameLength() const
559 {
560 return _aInfo.uMaxNameLength;
561 }
562
570 sal_uInt32 getMaxPathLength() const
571 {
572 return _aInfo.uMaxPathLength;
573 }
574
583 {
585 }
586
587
596 {
597 return _aDevice;
598 }
599
607 {
609 }
610
619 {
621 }
622
623 friend class Directory;
624};
625
626
627class DirectoryItem;
628
635{
636 oslFileStatus _aStatus;
637 sal_uInt32 _nMask;
638
643
648
649public:
650
651 enum Type {
660 };
661
667 FileStatus(sal_uInt32 nMask)
668 : _nMask(nMask)
669 {
670 memset(&_aStatus, 0, sizeof(_aStatus));
671 _aStatus.uStructSize = sizeof(_aStatus);
672 }
673
677 {
678 if ( _aStatus.ustrFileURL )
680 if ( _aStatus.ustrLinkTargetURL )
682 if ( _aStatus.ustrFileName )
684 }
685
695 bool isValid( sal_uInt32 nMask ) const
696 {
697 return ( nMask & _aStatus.uValidFields ) == nMask;
698 }
699
706 {
709 "no FileStatus Type determined");
711 ? static_cast< Type >(_aStatus.eType) : Unknown;
712 }
713
723 bool isDirectory() const
724 {
725 return ( getFileType() == Directory || getFileType() == Volume );
726 }
727
738 bool isRegular() const
739 {
740 return ( getFileType() == Regular );
741 }
742
751 bool isLink() const
752 {
753 return ( getFileType() == Link );
754 }
755
762 sal_uInt64 getAttributes() const
763 {
766 "no FileStatus Attributes determined");
767 return _aStatus.uAttributes;
768 }
769
778 {
781 "no FileStatus CreationTime determined");
782 return _aStatus.aCreationTime;
783 }
784
793 {
796 "no FileStatus AccessTime determined");
797 return _aStatus.aAccessTime;
798 }
799
808 {
811 "no FileStatus ModifyTime determined");
812 return _aStatus.aModifyTime;
813 }
814
821 sal_uInt64 getFileSize() const
822 {
825 "no FileStatus FileSize determined");
826 return _aStatus.uFileSize;
827 }
828
836 {
839 "no FileStatus FileName determined");
842 }
843
844
853 {
856 "no FileStatus FileURL determined");
859 }
860
869 {
872 "no FileStatus LinkTargetURL determined");
875 }
876
877 friend class DirectoryItem;
878};
879
880
887class File: public FileBase
888{
889 oslFileHandle _pData;
890 ::rtl::OUString _aPath;
891
896
900 File& operator = ( File& ) SAL_DELETED_FUNCTION;
901
902public:
903
910 File( const ::rtl::OUString& ustrFileURL ): _pData( NULL ), _aPath( ustrFileURL ) {}
911
916 {
917 close();
918 }
919
927 rtl::OUString getURL() const { return _aPath; }
928
971 RC open( sal_uInt32 uFlags )
972 {
973 return static_cast< RC >( osl_openFile( _aPath.pData, &_pData, uFlags ) );
974 }
975
990 {
992
993 if( _pData )
994 {
995 Error=osl_closeFile( _pData );
996 _pData = NULL;
997 }
998
999 return static_cast< RC >( Error );
1000 }
1001
1018 SAL_WARN_UNUSED_RESULT RC setPos( sal_uInt32 uHow, sal_Int64 uPos )
1019 {
1020 return static_cast< RC >( osl_setFilePos( _pData, uHow, uPos ) );
1021 }
1022
1038 RC getPos( sal_uInt64& uPos )
1039 {
1040 return static_cast< RC >( osl_getFilePos( _pData, &uPos ) );
1041 }
1042
1065 {
1066 return static_cast< RC >( osl_isEndOfFile( _pData, pIsEOF ) );
1067 }
1068
1086 RC setSize( sal_uInt64 uSize )
1087 {
1088 return static_cast< RC >( osl_setFileSize( _pData, uSize ) );
1089 }
1090
1110 RC getSize( sal_uInt64 &rSize )
1111 {
1112 return static_cast< RC >( osl_getFileSize( _pData, &rSize ) );
1113 }
1114
1146 RC read( void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64& rBytesRead )
1147 {
1148 return static_cast< RC >( osl_readFile( _pData, pBuffer, uBytesRequested, &rBytesRead ) );
1149 }
1150
1184 RC write(const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64& rBytesWritten)
1185 {
1186 return static_cast< RC >( osl_writeFile( _pData, pBuffer, uBytesToWrite, &rBytesWritten ) );
1187 }
1188
1189
1214 {
1215 return static_cast< RC >( osl_readLine( _pData, reinterpret_cast<sal_Sequence**>(&aSeq) ) );
1216 }
1217
1237 RC sync() const
1238 {
1239 OSL_PRECOND(_pData, "File::sync(): File not open");
1240 return static_cast< RC >(osl_syncFile(_pData));
1241 }
1242
1268 static RC copy( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1269 {
1270 return static_cast< RC >( osl_copyFile( ustrSourceFileURL.pData, ustrDestFileURL.pData ) );
1271 }
1272
1296 static RC move( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1297 {
1298 return static_cast< RC >( osl_moveFile( ustrSourceFileURL.pData, ustrDestFileURL.pData ) );
1299 }
1300
1328 static RC replace(const ::rtl::OUString& ustrSourceFileURL,
1329 const ::rtl::OUString& ustrDestFileURL)
1330 {
1331 return static_cast<RC>(osl_replaceFile(ustrSourceFileURL.pData, ustrDestFileURL.pData));
1332 }
1333
1360 static RC remove( const ::rtl::OUString& ustrFileURL )
1361 {
1362 return static_cast< RC >( osl_removeFile( ustrFileURL.pData ) );
1363 }
1364
1380 static RC setAttributes( const ::rtl::OUString& ustrFileURL, sal_uInt64 uAttributes )
1381 {
1382 return static_cast< RC >( osl_setFileAttributes( ustrFileURL.pData, uAttributes ) );
1383 }
1384
1406 static RC setTime(
1407 const ::rtl::OUString& ustrFileURL,
1408 const TimeValue& rCreationTime,
1409 const TimeValue& rLastAccessTime,
1410 const TimeValue& rLastWriteTime )
1411 {
1412 return static_cast< RC >( osl_setFileTime(
1413 ustrFileURL.pData,
1414 &rCreationTime,
1415 &rLastAccessTime,
1416 &rLastWriteTime ) );
1417 }
1418
1419 friend class DirectoryItem;
1420};
1421
1422
1429{
1430 oslDirectoryItem _pData;
1431
1432public:
1433
1437 DirectoryItem(): _pData( NULL )
1438 {
1439 }
1440
1444 DirectoryItem( const DirectoryItem& rItem ): _pData( rItem._pData)
1445 {
1446 if( _pData )
1447 osl_acquireDirectoryItem( _pData );
1448 }
1449
1454 {
1455 if( _pData )
1456 osl_releaseDirectoryItem( _pData );
1457 }
1458
1463 {
1464 if (&rItem != this)
1465 {
1466 if( _pData )
1467 osl_releaseDirectoryItem( _pData );
1468
1469 _pData = rItem._pData;
1470
1471 if( _pData )
1472 osl_acquireDirectoryItem( _pData );
1473 }
1474 return *this;
1475 }
1476
1483 bool is()
1484 {
1485 return _pData != NULL;
1486 }
1487
1521 static RC get( const ::rtl::OUString& ustrFileURL, DirectoryItem& rItem )
1522 {
1523 if( rItem._pData)
1524 {
1525 osl_releaseDirectoryItem( rItem._pData );
1526 rItem._pData = NULL;
1527 }
1528
1529 return static_cast< RC >( osl_getDirectoryItem( ustrFileURL.pData, &rItem._pData ) );
1530 }
1531
1564 {
1565 return static_cast< RC >( osl_getFileStatus( _pData, &rStatus._aStatus, rStatus._nMask ) );
1566 }
1567
1583 bool isIdenticalTo( const DirectoryItem &pOther )
1584 {
1585 return osl_identicalDirectoryItem( _pData, pOther._pData );
1586 }
1587
1588 friend class Directory;
1589};
1590
1591
1603{
1604public:
1606
1616 virtual void DirectoryCreated(const rtl::OUString& aDirectoryUrl) = 0;
1617};
1618
1619
1620// This just an internal helper function for
1621// private use.
1622extern "C" inline void SAL_CALL onDirectoryCreated(void* pData, rtl_uString* aDirectoryUrl)
1623{
1624 static_cast<DirectoryCreationObserver*>(pData)->DirectoryCreated(aDirectoryUrl);
1625}
1626
1633class Directory: public FileBase
1634{
1635 oslDirectory _pData;
1636 ::rtl::OUString _aPath;
1637
1642
1646 Directory& operator = ( Directory& ) SAL_DELETED_FUNCTION;
1647
1648public:
1649
1657 Directory( const ::rtl::OUString& strPath ): _pData( NULL ), _aPath( strPath )
1658 {
1659 }
1660
1665 {
1666 close();
1667 }
1668
1676 rtl::OUString getURL() const { return _aPath; }
1677
1696 {
1697 return static_cast< RC >( osl_openDirectory( _aPath.pData, &_pData ) );
1698 }
1699
1710 bool isOpen() { return _pData != NULL; }
1711
1724 {
1726
1727 if( _pData )
1728 {
1729 Error=osl_closeDirectory( _pData );
1730 _pData = NULL;
1731 }
1732
1733 return static_cast< RC >( Error );
1734 }
1735
1736
1754 {
1755 close();
1756 return open();
1757 }
1758
1781 RC getNextItem( DirectoryItem& rItem, sal_uInt32 nHint = 0 )
1782 {
1783 if( rItem._pData )
1784 {
1785 osl_releaseDirectoryItem( rItem._pData );
1786 rItem._pData = NULL;
1787 }
1788 return static_cast<RC>(osl_getNextDirectoryItem( _pData, &rItem._pData, nHint ));
1789 }
1790
1791
1822 static RC getVolumeInfo( const ::rtl::OUString& ustrDirectoryURL, VolumeInfo& rInfo )
1823 {
1824 return static_cast< RC >( osl_getVolumeInformation( ustrDirectoryURL.pData, &rInfo._aInfo, rInfo._nMask ) );
1825 }
1826
1857 static RC create(
1858 const ::rtl::OUString& ustrDirectoryURL,
1859 sal_uInt32 flags = osl_File_OpenFlag_Read | osl_File_OpenFlag_Write )
1860 {
1861 return static_cast< RC >(
1862 osl_createDirectoryWithFlags( ustrDirectoryURL.pData, flags ) );
1863 }
1864
1891 static RC remove( const ::rtl::OUString& ustrDirectoryURL )
1892 {
1893 return static_cast< RC >( osl_removeDirectory( ustrDirectoryURL.pData ) );
1894 }
1895
1933 const ::rtl::OUString& aDirectoryUrl,
1934 DirectoryCreationObserver* aDirectoryCreationObserver = NULL)
1935 {
1936 return static_cast< RC >(osl_createDirectoryPath(
1937 aDirectoryUrl.pData,
1938 aDirectoryCreationObserver ? onDirectoryCreated : NULL,
1939 aDirectoryCreationObserver));
1940 }
1941};
1942
1943} /* namespace osl */
1944
1945#endif // INCLUDED_OSL_FILE_HXX
1946
1947/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
#define SAL_INFO_IF(condition, area, stream)
Produce log entry from stream in the given log area if condition is true.
Definition: log.hxx:347
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition: types.h:374
unsigned char sal_Bool
Definition: types.h:34
#define SAL_WARN_UNUSED_RESULT
Use this as markup for functions and methods whose return value must be checked.
Definition: types.h:280
SAL_DLLPUBLIC void rtl_uString_release(rtl_uString *str) SAL_THROW_EXTERN_C() SAL_HOT
Decrement the reference count of a string.
Main goals and usage hints.
SAL_DLLPUBLIC sal_Bool osl_identicalDirectoryItem(oslDirectoryItem pItemA, oslDirectoryItem pItemB)
Determine if two directory items point the same underlying file.
SAL_DLLPUBLIC oslFileError osl_acquireDirectoryItem(oslDirectoryItem Item)
Increase the refcount of a directory item handle.
SAL_DLLPUBLIC oslFileError osl_releaseDirectoryItem(oslDirectoryItem Item)
Decrease the refcount of a directory item handle.
SAL_DLLPUBLIC oslFileError osl_readFile(oslFileHandle Handle, void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 *pBytesRead)
Read a number of bytes from a file.
SAL_DLLPUBLIC oslFileError osl_getFileSize(oslFileHandle Handle, sal_uInt64 *pSize)
Get the file size of an open file.
SAL_DLLPUBLIC oslFileError osl_getFileURLFromSystemPath(rtl_uString *pustrSystemPath, rtl_uString **ppustrFileURL)
Convert a system dependent path into a file URL.
SAL_DLLPUBLIC oslFileError osl_setFileTime(rtl_uString *pustrFileURL, const TimeValue *aCreationTime, const TimeValue *aLastAccessTime, const TimeValue *aLastWriteTime)
Set the file time.
SAL_DLLPUBLIC oslFileError osl_getVolumeInformation(rtl_uString *pustrDirectoryURL, oslVolumeInfo *pInfo, sal_uInt32 uFieldMask)
Retrieve information about a volume.
SAL_DLLPUBLIC oslFileError osl_getVolumeDeviceMountPath(oslVolumeDeviceHandle Handle, rtl_uString **ppustrDirectoryURL)
Get the full qualified URL where a device is mounted to.
SAL_DLLPUBLIC oslFileError osl_getDirectoryItem(rtl_uString *pustrFileURL, oslDirectoryItem *pItem)
Retrieve a single directory item.
SAL_DLLPUBLIC oslFileError osl_writeFile(oslFileHandle Handle, const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 *pBytesWritten)
Write a number of bytes to a file.
void * oslVolumeDeviceHandle
Definition: file.h:450
SAL_DLLPUBLIC oslFileError osl_removeFile(rtl_uString *pustrFileURL)
Remove a regular file.
#define osl_File_OpenFlag_Write
Definition: file.h:631
SAL_DLLPUBLIC oslFileError osl_getTempDirURL(rtl_uString **pustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
SAL_DLLPUBLIC oslFileError osl_getFilePos(oslFileHandle Handle, sal_uInt64 *pPos)
Retrieve the current position of the internal pointer of an open file.
SAL_DLLPUBLIC oslFileError osl_moveFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Move a file or directory to a new destination or renames it.
SAL_DLLPUBLIC oslFileError osl_searchFileURL(rtl_uString *pustrFileName, rtl_uString *pustrSearchPath, rtl_uString **ppustrFileURL)
Search a full qualified system path or a file URL.
SAL_WARN_UNUSED_RESULT SAL_DLLPUBLIC oslFileError osl_setFilePos(oslFileHandle Handle, sal_uInt32 uHow, sal_Int64 uPos)
Set the internal position pointer of an open file.
oslFileError
Definition: file.h:85
@ osl_File_E_NOLINK
Definition: file.h:126
@ osl_File_E_DOM
Definition: file.h:117
@ osl_File_E_MULTIHOP
Definition: file.h:127
@ osl_File_E_EXIST
Definition: file.h:102
@ osl_File_E_NOSYS
Definition: file.h:122
@ osl_File_E_NXIO
Definition: file.h:92
@ osl_File_E_NOENT
Definition: file.h:88
@ osl_File_E_MLINK
Definition: file.h:115
@ osl_File_E_PERM
Definition: file.h:87
@ osl_File_E_BUSY
Definition: file.h:101
@ osl_File_E_NOMEM
Definition: file.h:98
@ osl_File_E_DEADLK
Definition: file.h:119
@ osl_File_E_TIMEDOUT
Definition: file.h:132
@ osl_File_E_XDEV
Definition: file.h:103
@ osl_File_E_NOTTY
Definition: file.h:110
@ osl_File_E_AGAIN
Definition: file.h:97
@ osl_File_E_2BIG
Definition: file.h:93
@ osl_File_E_NODEV
Definition: file.h:104
@ osl_File_E_ACCES
Definition: file.h:99
@ osl_File_E_MFILE
Definition: file.h:109
@ osl_File_E_NFILE
Definition: file.h:108
@ osl_File_E_BADF
Definition: file.h:95
@ osl_File_E_ROFS
Definition: file.h:114
@ osl_File_E_ISDIR
Definition: file.h:106
@ osl_File_E_OVERFLOW
Definition: file.h:129
@ osl_File_E_PIPE
Definition: file.h:116
@ osl_File_E_SPIPE
Definition: file.h:113
@ osl_File_E_NAMETOOLONG
Definition: file.h:120
@ osl_File_E_INTR
Definition: file.h:90
@ osl_File_E_NOTEMPTY
Definition: file.h:123
@ osl_File_E_CHILD
Definition: file.h:96
@ osl_File_E_INVAL
Definition: file.h:107
@ osl_File_E_invalidError
Definition: file.h:131
@ osl_File_E_ILSEQ
Definition: file.h:125
@ osl_File_E_RANGE
Definition: file.h:118
@ osl_File_E_FBIG
Definition: file.h:111
@ osl_File_E_NOTDIR
Definition: file.h:105
@ osl_File_E_NOTREADY
Definition: file.h:130
@ osl_File_E_NOLCK
Definition: file.h:121
@ osl_File_E_NOEXEC
Definition: file.h:94
@ osl_File_E_None
Definition: file.h:86
@ osl_File_E_USERS
Definition: file.h:128
@ osl_File_E_IO
Definition: file.h:91
@ osl_File_E_NOSPC
Definition: file.h:112
@ osl_File_E_NETWORK
Definition: file.h:133
@ osl_File_E_LOOP
Definition: file.h:124
@ osl_File_E_SRCH
Definition: file.h:89
@ osl_File_E_FAULT
Definition: file.h:100
SAL_DLLPUBLIC oslFileError osl_createDirectoryWithFlags(rtl_uString *url, sal_uInt32 flags)
Create a directory, passing flags.
SAL_DLLPUBLIC oslFileError osl_openFile(rtl_uString *pustrFileURL, oslFileHandle *pHandle, sal_uInt32 uFlags)
Open a regular file.
SAL_DLLPUBLIC oslFileError osl_getCanonicalName(rtl_uString *pustrRequestedURL, rtl_uString **ppustrValidURL)
Determine a valid unused canonical name for a requested name.
void * oslDirectory
Definition: file.h:139
SAL_DLLPUBLIC oslFileError osl_closeDirectory(oslDirectory Directory)
Release a directory handle.
SAL_DLLPUBLIC oslFileError osl_syncFile(oslFileHandle Handle)
Synchronize the memory representation of a file with that on the physical medium.
SAL_DLLPUBLIC oslFileError osl_setFileAttributes(rtl_uString *pustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
void * oslDirectoryItem
Definition: file.h:140
SAL_DLLPUBLIC oslFileError osl_getFileStatus(oslDirectoryItem Item, oslFileStatus *pStatus, sal_uInt32 uFieldMask)
Retrieve information about a single file or directory.
SAL_DLLPUBLIC oslFileError osl_createTempFile(rtl_uString *pustrDirectoryURL, oslFileHandle *pHandle, rtl_uString **ppustrTempFileURL)
Creates a temporary file in the directory provided by the caller or the directory returned by osl_get...
struct _oslVolumeInfo oslVolumeInfo
Structure containing information about volumes.
SAL_DLLPUBLIC oslFileError osl_releaseVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Release a volume device handle.
SAL_DLLPUBLIC oslFileError osl_setFileSize(oslFileHandle Handle, sal_uInt64 uSize)
Set the file size of an open file.
SAL_DLLPUBLIC oslFileError osl_closeFile(oslFileHandle Handle)
Close an open file.
SAL_DLLPUBLIC oslFileError osl_isEndOfFile(oslFileHandle Handle, sal_Bool *pIsEOF)
Test if the end of a file is reached.
SAL_DLLPUBLIC oslFileError osl_replaceFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Move a file to a new destination or rename it, taking old file's identity (if exists).
SAL_DLLPUBLIC oslFileError osl_getNextDirectoryItem(oslDirectory Directory, oslDirectoryItem *pItem, sal_uInt32 uHint)
Retrieve the next item of a previously opened directory.
#define osl_File_OpenFlag_Read
Definition: file.h:630
SAL_DLLPUBLIC oslFileError osl_acquireVolumeDeviceHandle(oslVolumeDeviceHandle Handle)
Acquire a volume device handle.
SAL_DLLPUBLIC oslFileError osl_getAbsoluteFileURL(rtl_uString *pustrBaseDirectoryURL, rtl_uString *pustrRelativeFileURL, rtl_uString **ppustrAbsoluteFileURL)
Convert a path relative to a given directory into an full qualified file URL.
SAL_DLLPUBLIC oslFileError osl_createDirectoryPath(rtl_uString *aDirectoryUrl, oslDirectoryCreationCallbackFunc aDirectoryCreationCallbackFunc, void *pData)
Create a directory path.
SAL_DLLPUBLIC oslFileError osl_getSystemPathFromFileURL(rtl_uString *pustrFileURL, rtl_uString **ppustrSystemPath)
Convert a file URL into a system dependent path.
SAL_DLLPUBLIC oslFileError osl_copyFile(rtl_uString *pustrSourceFileURL, rtl_uString *pustrDestFileURL)
Copy a file to a new destination.
SAL_DLLPUBLIC oslFileError osl_readLine(oslFileHandle Handle, sal_Sequence **ppSequence)
Read a line from a file.
SAL_DLLPUBLIC oslFileError osl_removeDirectory(rtl_uString *pustrDirectoryURL)
Remove an empty directory.
void * oslFileHandle
Definition: file.h:626
SAL_DLLPUBLIC oslFileError osl_openDirectory(rtl_uString *pustrDirectoryURL, oslDirectory *pDirectory)
Open a directory for enumerating its contents.
Provides simple diagnostic support.
#define OSL_PRECOND(c, m)
Check the precondition of functions.
Definition: diagnose.h:109
@ osl_File_Type_Link
Definition: file.h:330
@ osl_File_Type_Directory
Definition: file.h:325
@ osl_File_Type_Volume
Definition: file.h:326
@ osl_File_Type_Fifo
Definition: file.h:328
@ osl_File_Type_Special
Definition: file.h:331
@ osl_File_Type_Regular
Definition: file.h:327
@ osl_File_Type_Socket
Definition: file.h:329
@ osl_File_Type_Unknown
Definition: file.h:332
#define osl_FileStatus_Mask_ModifyTime
Definition: file.h:364
#define osl_FileStatus_Mask_AccessTime
Definition: file.h:363
#define osl_FileStatus_Mask_Type
Definition: file.h:360
#define osl_FileStatus_Mask_FileSize
Definition: file.h:365
#define osl_FileStatus_Mask_FileURL
Definition: file.h:367
#define osl_FileStatus_Mask_LinkTargetURL
Definition: file.h:368
#define osl_FileStatus_Mask_CreationTime
Definition: file.h:362
#define osl_FileStatus_Mask_Attributes
Definition: file.h:361
#define osl_FileStatus_Mask_FileName
Definition: file.h:366
#define osl_Volume_Attribute_Case_Sensitive
Definition: file.h:532
#define osl_Volume_Attribute_FloppyDisk
Definition: file.h:529
#define osl_Volume_Attribute_Case_Is_Preserved
Definition: file.h:531
#define osl_Volume_Attribute_Remote
Definition: file.h:525
#define osl_Volume_Attribute_FixedDisk
Definition: file.h:527
#define osl_Volume_Attribute_RAMDisk
Definition: file.h:528
#define osl_Volume_Attribute_CompactDisc
Definition: file.h:526
#define osl_Volume_Attribute_Removeable
Definition: file.h:524
Definition: unotype.hxx:43
Definition: component.hxx:30
void onDirectoryCreated(void *pData, rtl_uString *aDirectoryUrl)
Definition: file.hxx:1622
Structure containing information about files and directories.
Definition: file.h:378
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:382
TimeValue aAccessTime
Last access time in nanoseconds since 1/1/1970.
Definition: file.h:392
rtl_uString * ustrLinkTargetURL
Full URL of the target file if the file itself is a link.
Definition: file.h:406
sal_uInt64 uAttributes
File attributes.
Definition: file.h:386
rtl_uString * ustrFileName
Case correct name of the file.
Definition: file.h:399
oslFileType eType
The type of the file (file, directory, volume).
Definition: file.h:384
sal_uInt64 uFileSize
Size in bytes of the file.
Definition: file.h:396
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function.
Definition: file.h:380
TimeValue aModifyTime
Last modify time in nanoseconds since 1/1/1970.
Definition: file.h:394
rtl_uString * ustrFileURL
Full URL of the file.
Definition: file.h:402
TimeValue aCreationTime
First creation time in nanoseconds since 1/1/1970.
Definition: file.h:389
Structure containing information about volumes.
Definition: file.h:560
sal_uInt32 uMaxNameLength
Maximum length of file name of a single item.
Definition: file.h:575
sal_uInt32 uValidFields
Determines which members of the structure contain valid data.
Definition: file.h:565
sal_uInt32 uMaxPathLength
Maximum length of a full qualified path in system notation.
Definition: file.h:577
sal_uInt32 uAttributes
Attributes of the volume (remote and/or removable)
Definition: file.h:567
sal_uInt64 uUsedSpace
Used space on the volume for the current process/user.
Definition: file.h:571
oslVolumeDeviceHandle * pDeviceHandle
Pointer to handle the receives underlying device.
Definition: file.h:584
sal_uInt64 uTotalSpace
Total available space on the volume for the current process/user.
Definition: file.h:569
rtl_uString * ustrFileSystemName
Points to a string that receives the name of the file system type.
Definition: file.h:581
sal_uInt32 uStructSize
Must be initialized with the size in bytes of the structure before passing it to any function.
Definition: file.h:563
sal_uInt64 uFreeSpace
Free space on the volume for the current process/user.
Definition: file.h:573
Base class for all File System specific objects.
Definition: file.hxx:50
static RC createTempFile(::rtl::OUString *pustrDirectoryURL, oslFileHandle *pHandle, ::rtl::OUString *pustrTempFileURL)
Creates a temporary file in the directory provided by the caller or the directory returned by getTemp...
Definition: file.hxx:302
static RC getSystemPathFromFileURL(const ::rtl::OUString &ustrFileURL, ::rtl::OUString &ustrSystemPath)
Convert a file URL into a system dependent path.
Definition: file.hxx:185
static RC searchFileURL(const ::rtl::OUString &ustrFileName, const ::rtl::OUString &ustrSearchPath, ::rtl::OUString &ustrFileURL)
Search a full qualified system path or a file URL.
Definition: file.hxx:236
static RC getCanonicalName(const ::rtl::OUString &ustrRequestedURL, ::rtl::OUString &ustrValidURL)
Determine a valid unused canonical name for a requested name.
Definition: file.hxx:127
static RC getAbsoluteFileURL(const ::rtl::OUString &ustrBaseDirectoryURL, const ::rtl::OUString &ustrRelativeFileURL, ::rtl::OUString &ustrAbsoluteFileURL)
Convert a path relative to a given directory into an full qualified file URL.
Definition: file.hxx:166
static RC getTempDirURL(::rtl::OUString &ustrTempDirURL)
Retrieves the file URL of the system's temporary directory path.
Definition: file.hxx:250
static RC getFileURLFromSystemPath(const ::rtl::OUString &ustrSystemPath, ::rtl::OUString &ustrFileURL)
Convert a system dependent path into a file URL.
Definition: file.hxx:204
RC
Definition: file.hxx:53
@ E_ACCES
file permissions do not allow operation
Definition: file.hxx:67
@ E_DEADLK
deadlock avoided
Definition: file.hxx:87
@ E_NOTEMPTY
directory not empty
Definition: file.hxx:91
@ E_NETWORK
Definition: file.hxx:101
@ E_OVERFLOW
value too large for defined data type
Definition: file.hxx:97
@ E_2BIG
argument list too long
Definition: file.hxx:61
@ E_EXIST
file exists where should only be created
Definition: file.hxx:70
@ E_CHILD
there are no child processes
Definition: file.hxx:64
@ E_IO
I/O error occurred.
Definition: file.hxx:59
@ E_DOM
domain error (mathematical error)
Definition: file.hxx:85
@ E_invalidError
unmapped error: always last entry in enum!
Definition: file.hxx:99
@ E_NOENT
no such file or directory
Definition: file.hxx:56
@ E_XDEV
improper link across file systems detected
Definition: file.hxx:71
@ E_PERM
operation not permitted
Definition: file.hxx:55
@ E_NOEXEC
invalid executable file format
Definition: file.hxx:62
@ E_TIMEDOUT
socket operation timed out
Definition: file.hxx:100
@ E_NOSYS
function not implemented
Definition: file.hxx:90
@ E_ILSEQ
invalid or incomplete byte sequence of multibyte char found
Definition: file.hxx:93
@ E_SPIPE
invalid seek operation (such as on pipe)
Definition: file.hxx:81
@ E_MULTIHOP
remote resource is not directly available
Definition: file.hxx:95
@ E_FAULT
bad address; an invalid pointer detected
Definition: file.hxx:68
@ E_MLINK
too many links to file
Definition: file.hxx:83
@ E_ROFS
illegal modification to read-only filesystem
Definition: file.hxx:82
@ E_NOSPC
no space left on device, write failed
Definition: file.hxx:80
@ E_NOTTY
inappropriate I/O control operation
Definition: file.hxx:78
@ E_BADF
bad file descriptor
Definition: file.hxx:63
@ E_BUSY
resource busy
Definition: file.hxx:69
@ E_NXIO
no such device or address
Definition: file.hxx:60
@ E_NFILE
too many distinct file openings
Definition: file.hxx:76
@ E_INVAL
invalid argument to library function
Definition: file.hxx:75
@ E_NOTREADY
device not ready
Definition: file.hxx:98
@ E_AGAIN
resource temp unavailable, try again later
Definition: file.hxx:65
@ E_LOOP
too many levels of symbolic links found during name lookup
Definition: file.hxx:92
@ E_USERS
file quote system is confused as there are too many users
Definition: file.hxx:96
@ E_NOMEM
no memory available
Definition: file.hxx:66
@ E_NODEV
wrong device type specified
Definition: file.hxx:72
@ E_MFILE
process has too many distinct files open
Definition: file.hxx:77
@ E_NOTDIR
file isn't a directory where one is needed
Definition: file.hxx:73
@ E_INTR
function call was interrupted
Definition: file.hxx:58
@ E_PIPE
broken pipe; no process reading from other end of pipe
Definition: file.hxx:84
@ E_NOLCK
no locks available
Definition: file.hxx:89
@ E_ISDIR
file is a directory, invalid operation
Definition: file.hxx:74
@ E_NAMETOOLONG
filename too long
Definition: file.hxx:88
@ E_FBIG
file too large
Definition: file.hxx:79
@ E_NOLINK
link has been severed
Definition: file.hxx:94
@ E_RANGE
range error (mathematical error)
Definition: file.hxx:86
@ E_None
on success
Definition: file.hxx:54
@ E_SRCH
no process matches the PID
Definition: file.hxx:57
The VolumeDevice class.
Definition: file.hxx:321
~VolumeDevice()
Destructor.
Definition: file.hxx:349
VolumeDevice & operator=(const VolumeDevice &rDevice)
Assignment operator.
Definition: file.hxx:361
rtl::OUString getMountPath()
Get the full qualified URL where a device is mounted to.
Definition: file.hxx:381
VolumeDevice()
Constructor.
Definition: file.hxx:329
VolumeDevice(const VolumeDevice &rDevice)
Copy constructor.
Definition: file.hxx:339
The VolumeInfo class.
Definition: file.hxx:403
sal_uInt64 getUsedSpace() const
Determine the used space of a volume device.
Definition: file.hxx:546
VolumeDevice getDeviceHandle() const
Get the volume device handle.
Definition: file.hxx:595
bool getFixedDiskFlag() const
Check the fixed disk flag.
Definition: file.hxx:499
sal_uInt64 getTotalSpace() const
Determine the total space of a volume device.
Definition: file.hxx:522
bool isCaseSensitiveFileSystem() const
Return whether the file system is case sensitive or case insensitive.
Definition: file.hxx:606
bool getRemoteFlag() const
Check the remote flag.
Definition: file.hxx:456
bool isCasePreservingFileSystem() const
Return whether the file system preserves the case of file and directory names or not.
Definition: file.hxx:618
bool getRemoveableFlag() const
Check the removable flag.
Definition: file.hxx:466
bool isValid(sal_uInt32 nMask) const
Check if specified fields are valid.
Definition: file.hxx:446
::rtl::OUString getFileSystemName() const
Determine the name of the volume device's File System.
Definition: file.hxx:582
bool getFloppyDiskFlag() const
Check the floppy disc flag.
Definition: file.hxx:488
sal_uInt32 getMaxNameLength() const
Determine the maximal length of a file name.
Definition: file.hxx:558
VolumeInfo(sal_uInt32 nMask)
Constructor.
Definition: file.hxx:425
sal_uInt32 getMaxPathLength() const
Determine the maximal length of a path name.
Definition: file.hxx:570
bool getCompactDiscFlag() const
Check the compact disc flag.
Definition: file.hxx:477
~VolumeInfo()
Definition: file.hxx:433
sal_uInt64 getFreeSpace() const
Determine the free space of a volume device.
Definition: file.hxx:534
bool getRAMDiskFlag() const
Check the RAM disk flag.
Definition: file.hxx:510
The FileStatus class.
Definition: file.hxx:635
TimeValue getAccessTime() const
Get the file access time.
Definition: file.hxx:792
Type
Definition: file.hxx:651
@ Fifo
Definition: file.hxx:655
@ Regular
Definition: file.hxx:654
@ Unknown
Definition: file.hxx:659
@ Volume
Definition: file.hxx:653
@ Link
Definition: file.hxx:657
@ Special
Definition: file.hxx:658
::rtl::OUString getLinkTargetURL() const
Get the link target URL.
Definition: file.hxx:868
::rtl::OUString getFileURL() const
Get the URL of the file.
Definition: file.hxx:852
sal_uInt64 getFileSize() const
Get the size of the file.
Definition: file.hxx:821
Type getFileType() const
Get the file type.
Definition: file.hxx:705
bool isRegular() const
Is it a regular file?
Definition: file.hxx:738
bool isDirectory() const
Is it a directory? This method returns True for both directories, and volumes.
Definition: file.hxx:723
::rtl::OUString getFileName() const
Get the file name.
Definition: file.hxx:835
~FileStatus()
Destructor.
Definition: file.hxx:676
bool isValid(sal_uInt32 nMask) const
Check if specified fields are valid.
Definition: file.hxx:695
TimeValue getCreationTime() const
Get the creation time of this file.
Definition: file.hxx:777
TimeValue getModifyTime() const
Get the file modification time.
Definition: file.hxx:807
bool isLink() const
Is it a link?
Definition: file.hxx:751
sal_uInt64 getAttributes() const
Get the file attributes.
Definition: file.hxx:762
FileStatus(sal_uInt32 nMask)
Constructor.
Definition: file.hxx:667
The file class object provides access to file contents and attributes.
Definition: file.hxx:888
RC read(void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64 &rBytesRead)
Read a number of bytes from a file.
Definition: file.hxx:1146
~File()
Destructor.
Definition: file.hxx:915
RC close()
Close an open file.
Definition: file.hxx:989
static RC setAttributes(const ::rtl::OUString &ustrFileURL, sal_uInt64 uAttributes)
Set file attributes.
Definition: file.hxx:1380
RC open(sal_uInt32 uFlags)
Open a regular file.
Definition: file.hxx:971
RC readLine(::rtl::ByteSequence &aSeq)
Read a line from a file.
Definition: file.hxx:1213
static RC remove(const ::rtl::OUString &ustrFileURL)
Remove a regular file.
Definition: file.hxx:1360
rtl::OUString getURL() const
Obtain the URL.
Definition: file.hxx:927
static RC copy(const ::rtl::OUString &ustrSourceFileURL, const ::rtl::OUString &ustrDestFileURL)
Copy a file to a new destination.
Definition: file.hxx:1268
RC setSize(sal_uInt64 uSize)
Set the file size of an open file.
Definition: file.hxx:1086
RC write(const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64 &rBytesWritten)
Write a number of bytes to a file.
Definition: file.hxx:1184
RC sync() const
Synchronize the memory representation of a file with that on the physical medium.
Definition: file.hxx:1237
RC getSize(sal_uInt64 &rSize)
Get the file size of an open file.
Definition: file.hxx:1110
static RC setTime(const ::rtl::OUString &ustrFileURL, const TimeValue &rCreationTime, const TimeValue &rLastAccessTime, const TimeValue &rLastWriteTime)
Set the file time.
Definition: file.hxx:1406
static RC replace(const ::rtl::OUString &ustrSourceFileURL, const ::rtl::OUString &ustrDestFileURL)
Move a file to a new destination or rename it, taking old file's identity (if exists).
Definition: file.hxx:1328
RC getPos(sal_uInt64 &uPos)
Retrieve the current position of the internal pointer of an open file.
Definition: file.hxx:1038
File(const ::rtl::OUString &ustrFileURL)
Constructor.
Definition: file.hxx:910
SAL_WARN_UNUSED_RESULT RC setPos(sal_uInt32 uHow, sal_Int64 uPos)
Set the internal position pointer of an open file.
Definition: file.hxx:1018
static RC move(const ::rtl::OUString &ustrSourceFileURL, const ::rtl::OUString &ustrDestFileURL)
Move a file or directory to a new destination or renames it.
Definition: file.hxx:1296
RC isEndOfFile(sal_Bool *pIsEOF)
Test if the end of a file is reached.
Definition: file.hxx:1064
The directory item class object provides access to file status information.
Definition: file.hxx:1429
DirectoryItem()
Constructor.
Definition: file.hxx:1437
static RC get(const ::rtl::OUString &ustrFileURL, DirectoryItem &rItem)
Retrieve a single directory item.
Definition: file.hxx:1521
DirectoryItem(const DirectoryItem &rItem)
Copy constructor.
Definition: file.hxx:1444
bool is()
Check for validity of this instance.
Definition: file.hxx:1483
~DirectoryItem()
Destructor.
Definition: file.hxx:1453
bool isIdenticalTo(const DirectoryItem &pOther)
Determine if a directory item point the same underlying file.
Definition: file.hxx:1583
DirectoryItem & operator=(const DirectoryItem &rItem)
Assignment operator.
Definition: file.hxx:1462
RC getFileStatus(FileStatus &rStatus)
Retrieve information about a single file or directory.
Definition: file.hxx:1563
Base class for observers of directory creation notifications.
Definition: file.hxx:1603
virtual void DirectoryCreated(const rtl::OUString &aDirectoryUrl)=0
This method will be called when a new directory has been created and needs to be overwritten by deriv...
virtual ~DirectoryCreationObserver()
Definition: file.hxx:1605
The directory class object provides an enumeration of DirectoryItems.
Definition: file.hxx:1634
RC getNextItem(DirectoryItem &rItem, sal_uInt32 nHint=0)
Retrieve the next item of a previously opened directory.
Definition: file.hxx:1781
static RC remove(const ::rtl::OUString &ustrDirectoryURL)
Remove an empty directory.
Definition: file.hxx:1891
rtl::OUString getURL() const
Obtain the URL.
Definition: file.hxx:1676
static RC createPath(const ::rtl::OUString &aDirectoryUrl, DirectoryCreationObserver *aDirectoryCreationObserver=NULL)
Create a directory path.
Definition: file.hxx:1932
~Directory()
Destructor.
Definition: file.hxx:1664
RC reset()
Resets the directory item enumeration to the beginning.
Definition: file.hxx:1753
RC open()
Open a directory for enumerating its contents.
Definition: file.hxx:1695
RC close()
Close a directory.
Definition: file.hxx:1723
Directory(const ::rtl::OUString &strPath)
Constructor.
Definition: file.hxx:1657
static RC create(const ::rtl::OUString &ustrDirectoryURL, sal_uInt32 flags=osl_File_OpenFlag_Read|osl_File_OpenFlag_Write)
Create a directory.
Definition: file.hxx:1857
static RC getVolumeInfo(const ::rtl::OUString &ustrDirectoryURL, VolumeInfo &rInfo)
Retrieve information about a volume.
Definition: file.hxx:1822
bool isOpen()
Query if directory is open.
Definition: file.hxx:1710
Definition: socket_decl.hxx:192
Definition: time.h:66
C++ class representing a SAL byte sequence.
Definition: byteseq.h:166
This String class provides base functionality for C++ like Unicode character array handling.
Definition: ustring.hxx:161
This is the binary specification of a SAL sequence.
Definition: types.h:300