My Project
UDK 3.2.7 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  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * Copyright 2000, 2010 Oracle and/or its affiliates.
7  *
8  * OpenOffice.org - a multi-platform office productivity suite
9  *
10  * This file is part of OpenOffice.org.
11  *
12  * OpenOffice.org is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU Lesser General Public License version 3
14  * only, as published by the Free Software Foundation.
15  *
16  * OpenOffice.org is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Lesser General Public License version 3 for more details
20  * (a copy is included in the LICENSE file that accompanied this code).
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * version 3 along with OpenOffice.org. If not, see
24  * <http://www.openoffice.org/license.html>
25  * for a copy of the LGPLv3 License.
26  *
27  ************************************************************************/
28 
29 #ifndef _OSL_FILE_HXX_
30 #define _OSL_FILE_HXX_
31 
32 #include "sal/config.h"
33 
34 #include <cassert>
35 
36 #include <osl/time.h>
37 #include <rtl/memory.h>
38 #include <rtl/ustring.hxx>
39 
40 #include <osl/file.h>
41 #include <rtl/byteseq.hxx>
42 
43 #include <stdio.h>
44 
45 namespace osl
46 {
47 
48 
49 // -----------------------------------------------------------------------------
57 class FileBase
58 {
59 public:
60 
61  enum RC {
107  E_invalidError = osl_File_E_invalidError, /* unmapped error: always last entry in enum! */
110  };
111 
112 
113 public:
114 
136  static inline RC getCanonicalName( const ::rtl::OUString& ustrRequestedURL, ::rtl::OUString& ustrValidURL )
137  {
138  return (RC) osl_getCanonicalName( ustrRequestedURL.pData, &ustrValidURL.pData );
139  }
140 
176  static inline RC getAbsoluteFileURL( const ::rtl::OUString& ustrBaseDirectoryURL, const ::rtl::OUString& ustrRelativeFileURL, ::rtl::OUString& ustrAbsoluteFileURL )
177  {
178  return (RC) osl_getAbsoluteFileURL( ustrBaseDirectoryURL.pData, ustrRelativeFileURL.pData, &ustrAbsoluteFileURL.pData );
179  }
180 
196  static inline RC getSystemPathFromFileURL( const ::rtl::OUString& ustrFileURL, ::rtl::OUString& ustrSystemPath )
197  {
198  return (RC) osl_getSystemPathFromFileURL( ustrFileURL.pData, &ustrSystemPath.pData );
199  }
200 
216  static inline RC getFileURLFromSystemPath( const ::rtl::OUString& ustrSystemPath, ::rtl::OUString& ustrFileURL )
217  {
218  return (RC) osl_getFileURLFromSystemPath( ustrSystemPath.pData, &ustrFileURL.pData );
219  }
220 
249  static inline RC searchFileURL( const ::rtl::OUString& ustrFileName, const ::rtl::OUString& ustrSearchPath, ::rtl::OUString& ustrFileURL )
250  {
251  return (RC) osl_searchFileURL( ustrFileName.pData, ustrSearchPath.pData, &ustrFileURL.pData );
252  }
253 
264  static inline RC getTempDirURL( ::rtl::OUString& ustrTempDirURL )
265  {
266  return (RC) osl_getTempDirURL( &ustrTempDirURL.pData );
267  }
268 
318  static inline RC createTempFile(
319  ::rtl::OUString* pustrDirectoryURL,
320  oslFileHandle* pHandle,
321  ::rtl::OUString* pustrTempFileURL)
322  {
323  rtl_uString* pustr_dir_url = pustrDirectoryURL ? pustrDirectoryURL->pData : 0;
324  rtl_uString** ppustr_tmp_file_url = pustrTempFileURL ? &pustrTempFileURL->pData : 0;
325 
326  return (RC) osl_createTempFile(pustr_dir_url, pHandle, ppustr_tmp_file_url);
327  }
328 };
329 
330 
331 // -----------------------------------------------------------------------------
337 class VolumeDevice : public FileBase
338 {
339  oslVolumeDeviceHandle _aHandle;
340 
341 public:
342 
346  VolumeDevice() : _aHandle( NULL )
347  {
348  }
349 
356  VolumeDevice( const VolumeDevice & rDevice )
357  {
358  _aHandle = rDevice._aHandle;
359  if ( _aHandle )
360  osl_acquireVolumeDeviceHandle( _aHandle );
361  }
362 
367  {
368  if ( _aHandle )
369  osl_releaseVolumeDeviceHandle( _aHandle );
370  }
371 
378  inline VolumeDevice & operator =( const VolumeDevice & rDevice )
379  {
380  oslVolumeDeviceHandle newHandle = rDevice._aHandle;
381 
382  if ( newHandle )
383  osl_acquireVolumeDeviceHandle( newHandle );
384 
385  if ( _aHandle )
386  osl_releaseVolumeDeviceHandle( _aHandle );
387 
388  _aHandle = newHandle;
389 
390  return *this;
391  }
392 
399  {
400  rtl::OUString aPath;
401  osl_getVolumeDeviceMountPath( _aHandle, &aPath.pData );
402  return aPath;
403  }
404 
405  friend class VolumeInfo;
406 };
407 
408 // -----------------------------------------------------------------------------
409 
410 class Directory;
411 
421 {
422  oslVolumeInfo _aInfo;
423  sal_uInt32 _nMask;
424  VolumeDevice _aDevice;
425 
430 
434  VolumeInfo& operator = ( VolumeInfo& );
435 
436 public:
437 
444  VolumeInfo( sal_uInt32 nMask ): _nMask( nMask )
445  {
446  _aInfo.uStructSize = sizeof( oslVolumeInfo );
447  rtl_fillMemory( &_aInfo.uValidFields, sizeof( oslVolumeInfo ) - sizeof( sal_uInt32 ), 0 );
448  _aInfo.pDeviceHandle = &_aDevice._aHandle;
449  }
450 
455  {
456  if( _aInfo.ustrFileSystemName )
458  }
459 
468  inline sal_Bool isValid( sal_uInt32 nMask ) const
469  {
470  return ( nMask & _aInfo.uValidFields ) == nMask;
471  }
472 
479  inline sal_Bool getRemoteFlag() const
480  {
481  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_Remote);
482  }
483 
491  {
492  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_Removeable);
493  }
494 
502  {
503  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_CompactDisc);
504  }
505 
513  {
514  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_FloppyDisk);
515  }
516 
523  inline sal_Bool getFixedDiskFlag() const
524  {
525  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_FixedDisk);
526  }
527 
534  inline sal_Bool getRAMDiskFlag() const
535  {
536  return 0 != (_aInfo.uAttributes & osl_Volume_Attribute_RAMDisk);
537  }
538 
546  inline sal_uInt64 getTotalSpace() const
547  {
548  return _aInfo.uTotalSpace;
549  }
550 
558  inline sal_uInt64 getFreeSpace() const
559  {
560  return _aInfo.uFreeSpace;
561  }
562 
570  inline sal_uInt64 getUsedSpace() const
571  {
572  return _aInfo.uUsedSpace;
573  }
574 
582  inline sal_uInt32 getMaxNameLength() const
583  {
584  return _aInfo.uMaxNameLength;
585  }
586 
594  inline sal_uInt32 getMaxPathLength() const
595  {
596  return _aInfo.uMaxPathLength;
597  }
598 
606  inline ::rtl::OUString getFileSystemName() const
607  {
609  }
610 
611 
620  {
621  return _aDevice;
622  }
623 
631  {
633  }
634 
643  {
645  }
646 
647  friend class Directory;
648 };
649 
650 // -----------------------------------------------------------------------------
651 class DirectoryItem;
652 
659 {
660  oslFileStatus _aStatus;
661  sal_uInt32 _nMask;
662 
667 
671  FileStatus& operator = ( FileStatus& );
672 
673 public:
674 
675  enum Type {
684  };
685 
692  FileStatus( sal_uInt32 nMask ): _nMask( nMask )
693  {
694  _aStatus.uStructSize = sizeof( oslFileStatus );
695  rtl_fillMemory( &_aStatus.uValidFields, sizeof( oslFileStatus ) - sizeof( sal_uInt32 ), 0 );
696  }
697 
702  {
703  if ( _aStatus.ustrFileURL )
704  rtl_uString_release( _aStatus.ustrFileURL );
705  if ( _aStatus.ustrLinkTargetURL )
707  if ( _aStatus.ustrFileName )
708  rtl_uString_release( _aStatus.ustrFileName );
709  }
710 
720  inline sal_Bool isValid( sal_uInt32 nMask ) const
721  {
722  return ( nMask & _aStatus.uValidFields ) == nMask;
723  }
724 
730  inline Type getFileType() const
731  {
732  SAL_INFO_IF(
734  "no FileStatus Type determined");
736  ? static_cast< Type >(_aStatus.eType) : Unknown;
737  }
738 
748  inline sal_Bool isDirectory() const
749  {
750  return ( getFileType() == Directory || getFileType() == Volume );
751  }
752 
763  inline sal_Bool isRegular() const
764  {
765  return ( getFileType() == Regular );
766  }
767 
776  inline sal_Bool isLink() const
777  {
778  return ( getFileType() == Link );
779  }
780 
787  inline sal_uInt64 getAttributes() const
788  {
789  SAL_INFO_IF(
791  "no FileStatus Attributes determined");
792  return _aStatus.uAttributes;
793  }
794 
802  inline TimeValue getCreationTime() const
803  {
804  SAL_INFO_IF(
806  "no FileStatus CreationTime determined");
807  return _aStatus.aCreationTime;
808  }
809 
817  inline TimeValue getAccessTime() const
818  {
819  SAL_INFO_IF(
821  "no FileStatus AccessTime determined");
822  return _aStatus.aAccessTime;
823  }
824 
832  inline TimeValue getModifyTime() const
833  {
834  SAL_INFO_IF(
836  "no FileStatus ModifyTime determined");
837  return _aStatus.aModifyTime;
838  }
839 
846  inline sal_uInt64 getFileSize() const
847  {
848  SAL_INFO_IF(
850  "no FileStatus FileSize determined");
851  return _aStatus.uFileSize;
852  }
853 
860  inline ::rtl::OUString getFileName() const
861  {
862  SAL_INFO_IF(
864  "no FileStatus FileName determined");
866  ? rtl::OUString(_aStatus.ustrFileName) : rtl::OUString();
867  }
868 
869 
877  inline ::rtl::OUString getFileURL() const
878  {
879  SAL_INFO_IF(
881  "no FileStatus FileURL determined");
883  ? rtl::OUString(_aStatus.ustrFileURL) : rtl::OUString();
884  }
885 
893  inline ::rtl::OUString getLinkTargetURL() const
894  {
895  SAL_INFO_IF(
897  "no FileStatus LinkTargetURL determined");
900  }
901 
902  friend class DirectoryItem;
903 };
904 
905 
906 // -----------------------------------------------------------------------------
913 class File: public FileBase
914 {
915  oslFileHandle _pData;
916  ::rtl::OUString _aPath;
917 
921  File( File& );
922 
926  File& operator = ( File& );
927 
928 public:
929 
936  File( const ::rtl::OUString& ustrFileURL ): _pData( 0 ), _aPath( ustrFileURL ) {}
937 
941  inline ~File()
942  {
943  close();
944  }
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 
1276  inline RC sync() const
1277  {
1278  OSL_PRECOND(_pData, "File::sync(): File not open");
1279  return (RC)osl_syncFile(_pData);
1280  }
1281 
1308  inline static RC copy( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1309  {
1310  return (RC) osl_copyFile( ustrSourceFileURL.pData, ustrDestFileURL.pData );
1311  }
1312 
1337  inline static RC move( const ::rtl::OUString& ustrSourceFileURL, const ::rtl::OUString& ustrDestFileURL )
1338  {
1339  return (RC) osl_moveFile( ustrSourceFileURL.pData, ustrDestFileURL.pData );
1340  }
1341 
1370  inline static RC remove( const ::rtl::OUString& ustrFileURL )
1371  {
1372  return (RC) osl_removeFile( ustrFileURL.pData );
1373  }
1374 
1390  inline static RC setAttributes( const ::rtl::OUString& ustrFileURL, sal_uInt64 uAttributes )
1391  {
1392  return (RC) osl_setFileAttributes( ustrFileURL.pData, uAttributes );
1393  }
1394 
1417  inline static RC setTime(
1418  const ::rtl::OUString& ustrFileURL,
1419  const TimeValue& rCreationTime,
1420  const TimeValue& rLastAccessTime,
1421  const TimeValue& rLastWriteTime )
1422  {
1423  return (RC) osl_setFileTime(
1424  ustrFileURL.pData,
1425  &rCreationTime,
1426  &rLastAccessTime,
1427  &rLastWriteTime );
1428  }
1429 
1430  friend class DirectoryItem;
1431 };
1432 
1433 // -----------------------------------------------------------------------------
1440 {
1441  oslDirectoryItem _pData;
1442 
1443 public:
1444 
1448  DirectoryItem(): _pData( NULL )
1449  {
1450  }
1451 
1455  DirectoryItem( const DirectoryItem& rItem ): _pData( rItem._pData)
1456  {
1457  if( _pData )
1458  osl_acquireDirectoryItem( _pData );
1459  }
1460 
1465  {
1466  if( _pData )
1467  osl_releaseDirectoryItem( _pData );
1468  }
1469 
1474  {
1475  if (&rItem != this)
1476  {
1477  if( _pData )
1478  osl_releaseDirectoryItem( _pData );
1479 
1480  _pData = rItem._pData;
1481 
1482  if( _pData )
1483  osl_acquireDirectoryItem( _pData );
1484  }
1485  return *this;
1486  }
1487 
1494  inline sal_Bool is()
1495  {
1496  return _pData != NULL;
1497  }
1498 
1533  static inline RC get( const ::rtl::OUString& ustrFileURL, DirectoryItem& rItem )
1534  {
1535  if( rItem._pData)
1536  {
1537  osl_releaseDirectoryItem( rItem._pData );
1538  rItem._pData = NULL;
1539  }
1540 
1541  return (RC) osl_getDirectoryItem( ustrFileURL.pData, &rItem._pData );
1542  }
1543 
1576  inline RC getFileStatus( FileStatus& rStatus )
1577  {
1578  return (RC) osl_getFileStatus( _pData, &rStatus._aStatus, rStatus._nMask );
1579  }
1580 
1597  inline sal_Bool isIdenticalTo( const DirectoryItem &pOther )
1598  {
1599  return osl_identicalDirectoryItem( _pData, pOther._pData );
1600  }
1601 
1602  friend class Directory;
1603 };
1604 
1605 //###########################################
1606 
1618 {
1619 public:
1621 
1631  virtual void DirectoryCreated(const rtl::OUString& aDirectoryUrl) = 0;
1632 };
1633 
1634 //###########################################
1635 // This just an internal helper function for
1636 // private use.
1637 extern "C" inline void SAL_CALL onDirectoryCreated(void* pData, rtl_uString* aDirectoryUrl)
1638 {
1639  (static_cast<DirectoryCreationObserver*>(pData))->DirectoryCreated(aDirectoryUrl);
1640 }
1641 
1648 class Directory: public FileBase
1649 {
1650  oslDirectory _pData;
1651  ::rtl::OUString _aPath;
1652 
1656  Directory( Directory& );
1657 
1661  Directory& operator = ( Directory& );
1662 
1663 public:
1664 
1672  Directory( const ::rtl::OUString& strPath ): _pData( 0 ), _aPath( strPath )
1673  {
1674  }
1675 
1680  {
1681  close();
1682  }
1683 
1702  inline RC open()
1703  {
1704  return (RC) osl_openDirectory( _aPath.pData, &_pData );
1705  }
1706 
1718  inline sal_Bool isOpen() { return _pData != NULL; }
1719 
1732  inline RC close()
1733  {
1734  oslFileError Error = osl_File_E_BADF;
1735 
1736  if( _pData )
1737  {
1738  Error=osl_closeDirectory( _pData );
1739  _pData = NULL;
1740  }
1741 
1742  return (RC) Error;
1743  }
1744 
1745 
1763  inline RC reset()
1764  {
1765  close();
1766  return open();
1767  }
1768 
1792  inline RC getNextItem( DirectoryItem& rItem, sal_uInt32 nHint = 0 )
1793  {
1794  if( rItem._pData )
1795  {
1796  osl_releaseDirectoryItem( rItem._pData );
1797  rItem._pData = 0;
1798  }
1799  return ( RC) osl_getNextDirectoryItem( _pData, &rItem._pData, nHint );
1800  }
1801 
1802 
1834  inline static RC getVolumeInfo( const ::rtl::OUString& ustrDirectoryURL, VolumeInfo& rInfo )
1835  {
1836  return (RC) osl_getVolumeInformation( ustrDirectoryURL.pData, &rInfo._aInfo, rInfo._nMask );
1837  }
1838 
1866  inline static RC create( const ::rtl::OUString& ustrDirectoryURL )
1867  {
1868  return (RC) osl_createDirectory( ustrDirectoryURL.pData );
1869  }
1870 
1899  inline static RC remove( const ::rtl::OUString& ustrDirectoryURL )
1900  {
1901  return (RC) osl_removeDirectory( ustrDirectoryURL.pData );
1902  }
1903 
1956  static RC createPath(
1957  const ::rtl::OUString& aDirectoryUrl,
1958  DirectoryCreationObserver* aDirectoryCreationObserver = NULL)
1959  {
1960  return (RC)osl_createDirectoryPath(
1961  aDirectoryUrl.pData,
1962  (aDirectoryCreationObserver) ? onDirectoryCreated : NULL,
1963  aDirectoryCreationObserver);
1964  }
1965 };
1966 
1967 } /* namespace osl */
1968 
1969 #endif /* _OSL_FILE_HXX_ */
1970 
1971 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */