LibreOffice
LibreOffice 4.1 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 _OSL_FILE_HXX_
21 #define _OSL_FILE_HXX_
22 
23 #include "sal/config.h"
24 
25 #include <string.h>
26 
27 #include <cassert>
28 
29 #include <osl/time.h>
30 #include <rtl/ustring.hxx>
31 
32 #include <osl/file.h>
33 #include <rtl/byteseq.hxx>
34 
35 #include <stdio.h>
36 
37 namespace osl
38 {
39 
40 
41 // -----------------------------------------------------------------------------
49 class FileBase
50 {
51 public:
52 
53  enum RC {
99  E_invalidError = osl_File_E_invalidError, /* unmapped error: always last entry in enum! */
102  };
103 
104 
105 public:
106 
128  static inline RC getCanonicalName( const ::rtl::OUString& ustrRequestedURL, ::rtl::OUString& ustrValidURL )
129  {
130  return (RC) osl_getCanonicalName( ustrRequestedURL.pData, &ustrValidURL.pData );
131  }
132 
168  static inline RC getAbsoluteFileURL( const ::rtl::OUString& ustrBaseDirectoryURL, const ::rtl::OUString& ustrRelativeFileURL, ::rtl::OUString& ustrAbsoluteFileURL )
169  {
170  return (RC) osl_getAbsoluteFileURL( ustrBaseDirectoryURL.pData, ustrRelativeFileURL.pData, &ustrAbsoluteFileURL.pData );
171  }
172 
188  static inline RC getSystemPathFromFileURL( const ::rtl::OUString& ustrFileURL, ::rtl::OUString& ustrSystemPath )
189  {
190  return (RC) osl_getSystemPathFromFileURL( ustrFileURL.pData, &ustrSystemPath.pData );
191  }
192 
208  static inline RC getFileURLFromSystemPath( const ::rtl::OUString& ustrSystemPath, ::rtl::OUString& ustrFileURL )
209  {
210  return (RC) osl_getFileURLFromSystemPath( ustrSystemPath.pData, &ustrFileURL.pData );
211  }
212 
241  static inline RC searchFileURL( const ::rtl::OUString& ustrFileName, const ::rtl::OUString& ustrSearchPath, ::rtl::OUString& ustrFileURL )
242  {
243  return (RC) osl_searchFileURL( ustrFileName.pData, ustrSearchPath.pData, &ustrFileURL.pData );
244  }
245 
256  static inline RC getTempDirURL( ::rtl::OUString& ustrTempDirURL )
257  {
258  return (RC) osl_getTempDirURL( &ustrTempDirURL.pData );
259  }
260 
309  static inline RC createTempFile(
310  ::rtl::OUString* pustrDirectoryURL,
311  oslFileHandle* pHandle,
312  ::rtl::OUString* pustrTempFileURL)
313  {
314  rtl_uString* pustr_dir_url = pustrDirectoryURL ? pustrDirectoryURL->pData : 0;
315  rtl_uString** ppustr_tmp_file_url = pustrTempFileURL ? &pustrTempFileURL->pData : 0;
316 
317  return (RC) osl_createTempFile(pustr_dir_url, pHandle, ppustr_tmp_file_url);
318  }
319 };
320 
321 
322 // -----------------------------------------------------------------------------
328 class VolumeDevice : public FileBase
329 {
330  oslVolumeDeviceHandle _aHandle;
331 
332 public:
333 
337  VolumeDevice() : _aHandle( NULL )
338  {
339  }
340 
347  VolumeDevice( const VolumeDevice & rDevice )
348  {
349  _aHandle = rDevice._aHandle;
350  if ( _aHandle )
351  osl_acquireVolumeDeviceHandle( _aHandle );
352  }
353 
358  {
359  if ( _aHandle )
360  osl_releaseVolumeDeviceHandle( _aHandle );
361  }
362 
369  inline VolumeDevice & operator =( const VolumeDevice & rDevice )
370  {
371  oslVolumeDeviceHandle newHandle = rDevice._aHandle;
372 
373  if ( newHandle )
374  osl_acquireVolumeDeviceHandle( newHandle );
375 
376  if ( _aHandle )
377  osl_releaseVolumeDeviceHandle( _aHandle );
378 
379  _aHandle = newHandle;
380 
381  return *this;
382  }
383 
390  {
391  rtl::OUString aPath;
392  osl_getVolumeDeviceMountPath( _aHandle, &aPath.pData );
393  return aPath;
394  }
395 
396  friend class VolumeInfo;
397 };
398 
399 // -----------------------------------------------------------------------------
400 
401 class Directory;
402 
412 {
413  oslVolumeInfo _aInfo;
414  sal_uInt32 _nMask;
415  VolumeDevice _aDevice;
416 
421 
425  VolumeInfo& operator = ( VolumeInfo& );
426 
427 public:
428 
435  VolumeInfo( sal_uInt32 nMask ): _nMask( nMask )
436  {
437  _aInfo.uStructSize = sizeof( oslVolumeInfo );
438  memset( &_aInfo.uValidFields, 0, sizeof( oslVolumeInfo ) - sizeof( sal_uInt32 ) );
439  _aInfo.pDeviceHandle = &_aDevice._aHandle;
440  }
441 
446  {
447  if( _aInfo.ustrFileSystemName )
449  }
450 
459  inline sal_Bool isValid( sal_uInt32 nMask ) const
460  {
461  return ( nMask & _aInfo.uValidFields ) == nMask;
462  }
463 
470  inline sal_Bool getRemoteFlag() const
471  {
472  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_Remote);
473  }
474 
482  {
483  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_Removeable);
484  }
485 
493  {
494  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_CompactDisc);
495  }
496 
504  {
505  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_FloppyDisk);
506  }
507 
514  inline sal_Bool getFixedDiskFlag() const
515  {
516  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_FixedDisk);
517  }
518 
525  inline sal_Bool getRAMDiskFlag() const
526  {
527  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_RAMDisk);
528  }
529 
537  inline sal_uInt64 getTotalSpace() const
538  {
539  return _aInfo.uTotalSpace;
540  }
541 
549  inline sal_uInt64 getFreeSpace() const
550  {
551  return _aInfo.uFreeSpace;
552  }
553 
561  inline sal_uInt64 getUsedSpace() const
562  {
563  return _aInfo.uUsedSpace;
564  }
565 
573  inline sal_uInt32 getMaxNameLength() const
574  {
575  return _aInfo.uMaxNameLength;
576  }
577 
585  inline sal_uInt32 getMaxPathLength() const
586  {
587  return _aInfo.uMaxPathLength;
588  }
589 
597  inline ::rtl::OUString getFileSystemName() const
598  {
600  }
601 
602 
611  {
612  return _aDevice;
613  }
614 
622  {
624  }
625 
634  {
636  }
637 
638  friend class Directory;
639 };
640 
641 // -----------------------------------------------------------------------------
642 class DirectoryItem;
643 
650 {
651  oslFileStatus _aStatus;
652  sal_uInt32 _nMask;
653 
658 
662  FileStatus& operator = ( FileStatus& );
663 
664 public:
665 
666  enum Type {
675  };
676 
683  FileStatus( sal_uInt32 nMask ): _nMask( nMask )
684  {
685  _aStatus.uStructSize = sizeof( oslFileStatus );
686  memset( &_aStatus.uValidFields, 0, sizeof( oslFileStatus ) - sizeof( sal_uInt32 ) );
687  }
688 
693  {
694  if ( _aStatus.ustrFileURL )
695  rtl_uString_release( _aStatus.ustrFileURL );
696  if ( _aStatus.ustrLinkTargetURL )
698  if ( _aStatus.ustrFileName )
699  rtl_uString_release( _aStatus.ustrFileName );
700  }
701 
711  inline sal_Bool isValid( sal_uInt32 nMask ) const
712  {
713  return ( nMask & _aStatus.uValidFields ) == nMask;
714  }
715 
721  inline Type getFileType() const
722  {
723  SAL_INFO_IF(
724  !isValid(osl_FileStatus_Mask_Type), "sal.osl",
725  "no FileStatus Type determined");
727  ? static_cast< Type >(_aStatus.eType) : Unknown;
728  }
729 
739  inline sal_Bool isDirectory() const
740  {
741  return ( getFileType() == Directory || getFileType() == Volume );
742  }
743 
754  inline sal_Bool isRegular() const
755  {
756  return ( getFileType() == Regular );
757  }
758 
767  inline sal_Bool isLink() const
768  {
769  return ( getFileType() == Link );
770  }
771 
778  inline sal_uInt64 getAttributes() const
779  {
780  SAL_INFO_IF(
782  "no FileStatus Attributes determined");
783  return _aStatus.uAttributes;
784  }
785 
793  inline TimeValue getCreationTime() const
794  {
795  SAL_INFO_IF(
797  "no FileStatus CreationTime determined");
798  return _aStatus.aCreationTime;
799  }
800 
808  inline TimeValue getAccessTime() const
809  {
810  SAL_INFO_IF(
812  "no FileStatus AccessTime determined");
813  return _aStatus.aAccessTime;
814  }
815 
823  inline TimeValue getModifyTime() const
824  {
825  SAL_INFO_IF(
827  "no FileStatus ModifyTime determined");
828  return _aStatus.aModifyTime;
829  }
830 
837  inline sal_uInt64 getFileSize() const
838  {
839  SAL_INFO_IF(
841  "no FileStatus FileSize determined");
842  return _aStatus.uFileSize;
843  }
844 
851  inline ::rtl::OUString getFileName() const
852  {
853  SAL_INFO_IF(
855  "no FileStatus FileName determined");
857  ? rtl::OUString(_aStatus.ustrFileName) : rtl::OUString();
858  }
859 
860 
868  inline ::rtl::OUString getFileURL() const
869  {
870  SAL_INFO_IF(
872  "no FileStatus FileURL determined");
874  ? rtl::OUString(_aStatus.ustrFileURL) : rtl::OUString();
875  }
876 
884  inline ::rtl::OUString getLinkTargetURL() const
885  {
886  SAL_INFO_IF(
888  "no FileStatus LinkTargetURL determined");
891  }
892 
893  friend class DirectoryItem;
894 };
895 
896 
897 // -----------------------------------------------------------------------------
904 class File: public FileBase
905 {
906  oslFileHandle _pData;
907  ::rtl::OUString _aPath;
908 
912  File( File& );
913 
917  File& operator = ( File& );
918 
919 public:
920 
927  File( const ::rtl::OUString& ustrFileURL ): _pData( 0 ), _aPath( ustrFileURL ) {}
928 
932  inline ~File()
933  {
934  close();
935  }
936 
944  inline rtl::OUString getURL() const { return _aPath; }
945 
989  inline RC open( sal_uInt32 uFlags )
990  {
991  return (RC) osl_openFile( _aPath.pData, &_pData, uFlags );
992  }
993 
1008  inline RC close()
1009  {
1010  oslFileError Error = osl_File_E_BADF;
1011 
1012  if( _pData )
1013  {
1014  Error=osl_closeFile( _pData );
1015  _pData = NULL;
1016  }
1017 
1018  return (RC) Error;
1019  }
1020 
1038  inline RC setPos( sal_uInt32 uHow, sal_Int64 uPos ) SAL_WARN_UNUSED_RESULT
1039  {
1040  return (RC) osl_setFilePos( _pData, uHow, uPos );
1041  }
1042 
1059  inline RC getPos( sal_uInt64& uPos )
1060  {
1061  return (RC) osl_getFilePos( _pData, &uPos );
1062  }
1063 
1086  inline RC isEndOfFile( sal_Bool *pIsEOF )
1087  {
1088  return (RC) osl_isEndOfFile( _pData, pIsEOF );
1089  }
1090 
1109  inline RC setSize( sal_uInt64 uSize )
1110  {
1111  return (RC) osl_setFileSize( _pData, uSize );
1112  }
1113 
1134  inline RC getSize( sal_uInt64 &rSize )
1135  {
1136  return (RC) osl_getFileSize( _pData, &rSize );
1137  }
1138 
1171  inline RC read( void *pBuffer, sal_uInt64 uBytesRequested, sal_uInt64& rBytesRead )
1172  {
1173  return (RC) osl_readFile( _pData, pBuffer, uBytesRequested, &rBytesRead );
1174  }
1175 
1210  inline RC write(const void *pBuffer, sal_uInt64 uBytesToWrite, sal_uInt64& rBytesWritten)
1211  {
1212  return (RC) osl_writeFile( _pData, pBuffer, uBytesToWrite, &rBytesWritten );
1213  }
1214 
1215 
1240  inline RC readLine( ::rtl::ByteSequence& aSeq )
1241  {
1242  return (RC) osl_readLine( _pData, reinterpret_cast<sal_Sequence**>(&aSeq) );
1243  }
1244 
1275  inline RC sync() const
1276  {
1277  OSL_PRECOND(_pData, "File::sync(): File not open");
1278  return (RC)osl_syncFile(_pData);
1279  }
1280 
1307  inline static RC copy( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1308  {
1309  return (RC) osl_copyFile( ustrSourceFileURL.pData, ustrDestFileURL.pData );
1310  }
1311 
1336  inline static RC move( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1337  {
1338  return (RC) osl_moveFile( ustrSourceFileURL.pData, ustrDestFileURL.pData );
1339  }
1340 
1369  inline static RC remove( const ::rtl::OUString& ustrFileURL )
1370  {
1371  return (RC) osl_removeFile( ustrFileURL.pData );
1372  }
1373 
1389  inline static RC setAttributes( const ::rtl::OUString& ustrFileURL, sal_uInt64 uAttributes )
1390  {
1391  return (RC) osl_setFileAttributes( ustrFileURL.pData, uAttributes );
1392  }
1393 
1416  inline static RC setTime(
1417  const ::rtl::OUString& ustrFileURL,
1418  const TimeValue& rCreationTime,
1419  const TimeValue& rLastAccessTime,
1420  const TimeValue& rLastWriteTime )
1421  {
1422  return (RC) osl_setFileTime(
1423  ustrFileURL.pData,
1424  &rCreationTime,
1425  &rLastAccessTime,
1426  &rLastWriteTime );
1427  }
1428 
1429  friend class DirectoryItem;
1430 };
1431 
1432 // -----------------------------------------------------------------------------
1439 {
1440  oslDirectoryItem _pData;
1441 
1442 public:
1443 
1447  DirectoryItem(): _pData( NULL )
1448  {
1449  }
1450 
1454  DirectoryItem( const DirectoryItem& rItem ): _pData( rItem._pData)
1455  {
1456  if( _pData )
1457  osl_acquireDirectoryItem( _pData );
1458  }
1459 
1464  {
1465  if( _pData )
1466  osl_releaseDirectoryItem( _pData );
1467  }
1468 
1473  {
1474  if (&rItem != this)
1475  {
1476  if( _pData )
1477  osl_releaseDirectoryItem( _pData );
1478 
1479  _pData = rItem._pData;
1480 
1481  if( _pData )
1482  osl_acquireDirectoryItem( _pData );
1483  }
1484  return *this;
1485  }
1486 
1493  inline sal_Bool is()
1494  {
1495  return _pData != NULL;
1496  }
1497 
1532  static inline RC get( const ::rtl::OUString& ustrFileURL, DirectoryItem& rItem )
1533  {
1534  if( rItem._pData)
1535  {
1536  osl_releaseDirectoryItem( rItem._pData );
1537  rItem._pData = NULL;
1538  }
1539 
1540  return (RC) osl_getDirectoryItem( ustrFileURL.pData, &rItem._pData );
1541  }
1542 
1575  inline RC getFileStatus( FileStatus& rStatus )
1576  {
1577  return (RC) osl_getFileStatus( _pData, &rStatus._aStatus, rStatus._nMask );
1578  }
1579 
1596  inline sal_Bool isIdenticalTo( const DirectoryItem &pOther )
1597  {
1598  return osl_identicalDirectoryItem( _pData, pOther._pData );
1599  }
1600 
1601  friend class Directory;
1602 };
1603 
1604 //###########################################
1605 
1617 {
1618 public:
1620 
1630  virtual void DirectoryCreated(const rtl::OUString& aDirectoryUrl) = 0;
1631 };
1632 
1633 //###########################################
1634 // This just an internal helper function for
1635 // private use.
1636 extern "C" inline void SAL_CALL onDirectoryCreated(void* pData, rtl_uString* aDirectoryUrl)
1637 {
1638  (static_cast<DirectoryCreationObserver*>(pData))->DirectoryCreated(aDirectoryUrl);
1639 }
1640 
1647 class Directory: public FileBase
1648 {
1649  oslDirectory _pData;
1650  ::rtl::OUString _aPath;
1651 
1655  Directory( Directory& );
1656 
1660  Directory& operator = ( Directory& );
1661 
1662 public:
1663 
1671  Directory( const ::rtl::OUString& strPath ): _pData( 0 ), _aPath( strPath )
1672  {
1673  }
1674 
1679  {
1680  close();
1681  }
1682 
1690  inline rtl::OUString getURL() const { return _aPath; }
1691 
1710  inline RC open()
1711  {
1712  return (RC) osl_openDirectory( _aPath.pData, &_pData );
1713  }
1714 
1726  inline sal_Bool isOpen() { return _pData != NULL; }
1727 
1740  inline RC close()
1741  {
1742  oslFileError Error = osl_File_E_BADF;
1743 
1744  if( _pData )
1745  {
1746  Error=osl_closeDirectory( _pData );
1747  _pData = NULL;
1748  }
1749 
1750  return (RC) Error;
1751  }
1752 
1753 
1771  inline RC reset()
1772  {
1773  close();
1774  return open();
1775  }
1776 
1800  inline RC getNextItem( DirectoryItem& rItem, sal_uInt32 nHint = 0 )
1801  {
1802  if( rItem._pData )
1803  {
1804  osl_releaseDirectoryItem( rItem._pData );
1805  rItem._pData = 0;
1806  }
1807  return ( RC) osl_getNextDirectoryItem( _pData, &rItem._pData, nHint );
1808  }
1809 
1810 
1842  inline static RC getVolumeInfo( const ::rtl::OUString& ustrDirectoryURL, VolumeInfo& rInfo )
1843  {
1844  return (RC) osl_getVolumeInformation( ustrDirectoryURL.pData, &rInfo._aInfo, rInfo._nMask );
1845  }
1846 
1874  inline static RC create( const ::rtl::OUString& ustrDirectoryURL )
1875  {
1876  return (RC) osl_createDirectory( ustrDirectoryURL.pData );
1877  }
1878 
1907  inline static RC remove( const ::rtl::OUString& ustrDirectoryURL )
1908  {
1909  return (RC) osl_removeDirectory( ustrDirectoryURL.pData );
1910  }
1911 
1964  static RC createPath(
1965  const ::rtl::OUString& aDirectoryUrl,
1966  DirectoryCreationObserver* aDirectoryCreationObserver = NULL)
1967  {
1968  return (RC)osl_createDirectoryPath(
1969  aDirectoryUrl.pData,
1970  (aDirectoryCreationObserver) ? onDirectoryCreated : NULL,
1971  aDirectoryCreationObserver);
1972  }
1973 };
1974 
1975 } /* namespace osl */
1976 
1977 #endif /* _OSL_FILE_HXX_ */
1978 
1979 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */