qabstractfileengine.h
上传用户:detong
上传日期:2022-06-22
资源大小:20675k
文件大小:7k
源码类别:

系统编程

开发平台:

Unix_Linux

  1. /****************************************************************************
  2. **
  3. ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
  4. ** Contact: Qt Software Information (qt-info@nokia.com)
  5. **
  6. ** This file is part of the QtCore module of the Qt Toolkit.
  7. **
  8. ** Commercial Usage
  9. ** Licensees holding valid Qt Commercial licenses may use this file in
  10. ** accordance with the Qt Commercial License Agreement provided with the
  11. ** Software or, alternatively, in accordance with the terms contained in
  12. ** a written agreement between you and Nokia.
  13. **
  14. **
  15. ** GNU General Public License Usage
  16. ** Alternatively, this file may be used under the terms of the GNU
  17. ** General Public License versions 2.0 or 3.0 as published by the Free
  18. ** Software Foundation and appearing in the file LICENSE.GPL included in
  19. ** the packaging of this file.  Please review the following information
  20. ** to ensure GNU General Public Licensing requirements will be met:
  21. ** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
  22. ** http://www.gnu.org/copyleft/gpl.html.  In addition, as a special
  23. ** exception, Nokia gives you certain additional rights. These rights
  24. ** are described in the Nokia Qt GPL Exception version 1.3, included in
  25. ** the file GPL_EXCEPTION.txt in this package.
  26. **
  27. ** Qt for Windows(R) Licensees
  28. ** As a special exception, Nokia, as the sole copyright holder for Qt
  29. ** Designer, grants users of the Qt/Eclipse Integration plug-in the
  30. ** right for the Qt/Eclipse Integration to link to functionality
  31. ** provided by Qt Designer and its related libraries.
  32. **
  33. ** If you are unsure which license is appropriate for your use, please
  34. ** contact the sales department at qt-sales@nokia.com.
  35. **
  36. ****************************************************************************/
  37. #ifndef QABSTRACTFILEENGINE_H
  38. #define QABSTRACTFILEENGINE_H
  39. #include <QtCore/qdir.h>
  40. #ifdef open
  41. #error qabstractfileengine.h must be included before any header file that defines open
  42. #endif
  43. QT_BEGIN_HEADER
  44. QT_BEGIN_NAMESPACE
  45. QT_MODULE(Core)
  46. class QFileExtension;
  47. class QFileExtensionResult;
  48. class QVariant;
  49. class QAbstractFileEngineIterator;
  50. class QAbstractFileEnginePrivate;
  51. class Q_CORE_EXPORT QAbstractFileEngine
  52. {
  53. public:
  54.     enum FileFlag {
  55.         //perms (overlaps the QFile::Permission)
  56.         ReadOwnerPerm = 0x4000, WriteOwnerPerm = 0x2000, ExeOwnerPerm = 0x1000,
  57.         ReadUserPerm  = 0x0400, WriteUserPerm  = 0x0200, ExeUserPerm  = 0x0100,
  58.         ReadGroupPerm = 0x0040, WriteGroupPerm = 0x0020, ExeGroupPerm = 0x0010,
  59.         ReadOtherPerm = 0x0004, WriteOtherPerm = 0x0002, ExeOtherPerm = 0x0001,
  60.         //types
  61.         LinkType      = 0x10000,
  62.         FileType      = 0x20000,
  63.         DirectoryType = 0x40000,
  64.         BundleType    = 0x80000,
  65.         //flags
  66.         HiddenFlag     = 0x0100000,
  67.         LocalDiskFlag  = 0x0200000,
  68.         ExistsFlag     = 0x0400000,
  69.         RootFlag       = 0x0800000,
  70.         Refresh        = 0x1000000,
  71.         //masks
  72.         PermsMask  = 0x0000FFFF,
  73.         TypesMask  = 0x000F0000,
  74.         FlagsMask  = 0x0FF00000,
  75.         FileInfoAll = FlagsMask | PermsMask | TypesMask
  76.     };
  77.     Q_DECLARE_FLAGS(FileFlags, FileFlag)
  78.     enum FileName {
  79.         DefaultName,
  80.         BaseName,
  81.         PathName,
  82.         AbsoluteName,
  83.         AbsolutePathName,
  84.         LinkName,
  85.         CanonicalName,
  86.         CanonicalPathName,
  87.         BundleName
  88.     };
  89.     enum FileOwner {
  90.         OwnerUser,
  91.         OwnerGroup
  92.     };
  93.     enum FileTime {
  94.         CreationTime,
  95.         ModificationTime,
  96.         AccessTime
  97.     };
  98.     virtual ~QAbstractFileEngine();
  99.     virtual bool open(QIODevice::OpenMode openMode);
  100.     virtual bool close();
  101.     virtual bool flush();
  102.     virtual qint64 size() const;
  103.     virtual qint64 pos() const;
  104.     virtual bool seek(qint64 pos);
  105.     virtual bool isSequential() const;
  106.     virtual bool remove();
  107.     virtual bool copy(const QString &newName);
  108.     virtual bool rename(const QString &newName);
  109.     virtual bool link(const QString &newName);
  110.     virtual bool mkdir(const QString &dirName, bool createParentDirectories) const;
  111.     virtual bool rmdir(const QString &dirName, bool recurseParentDirectories) const;
  112.     virtual bool setSize(qint64 size);
  113.     virtual bool caseSensitive() const;
  114.     virtual bool isRelativePath() const;
  115.     virtual QStringList entryList(QDir::Filters filters, const QStringList &filterNames) const;
  116.     virtual FileFlags fileFlags(FileFlags type=FileInfoAll) const;
  117.     virtual bool setPermissions(uint perms);
  118.     virtual QString fileName(FileName file=DefaultName) const;
  119.     virtual uint ownerId(FileOwner) const;
  120.     virtual QString owner(FileOwner) const;
  121.     virtual QDateTime fileTime(FileTime time) const;
  122.     virtual void setFileName(const QString &file);
  123.     virtual int handle() const;
  124.     bool atEnd() const;
  125.     uchar *map(qint64 offset, qint64 size, QFile::MemoryMapFlags flags);
  126.     bool unmap(uchar *ptr);
  127.     typedef QAbstractFileEngineIterator Iterator;
  128.     virtual Iterator *beginEntryList(QDir::Filters filters, const QStringList &filterNames);
  129.     virtual Iterator *endEntryList();
  130.     virtual qint64 read(char *data, qint64 maxlen);
  131.     virtual qint64 readLine(char *data, qint64 maxlen);
  132.     virtual qint64 write(const char *data, qint64 len);
  133.     QFile::FileError error() const;
  134.     QString errorString() const;
  135.     enum Extension {
  136.         AtEndExtension,
  137.         FastReadLineExtension,
  138.         MapExtension,
  139.         UnMapExtension
  140.     };
  141.     class ExtensionOption
  142.     {};
  143.     class ExtensionReturn
  144.     {};
  145.     class MapExtensionOption : public ExtensionOption {
  146.     public:
  147.         qint64 offset;
  148.         qint64 size;
  149.         QFile::MemoryMapFlags flags;
  150.     };
  151.     class MapExtensionReturn : public ExtensionReturn {
  152.     public:
  153.         uchar *address;
  154.     };
  155.     class UnMapExtensionOption : public ExtensionOption {
  156.     public:
  157.         uchar *address;
  158.     };
  159.     virtual bool extension(Extension extension, const ExtensionOption *option = 0, ExtensionReturn *output = 0);
  160.     virtual bool supportsExtension(Extension extension) const;
  161.     // Factory
  162.     static QAbstractFileEngine *create(const QString &fileName);
  163. protected:
  164.     void setError(QFile::FileError error, const QString &str);
  165.     QAbstractFileEngine();
  166.     QAbstractFileEngine(QAbstractFileEnginePrivate &);
  167.     QAbstractFileEnginePrivate *d_ptr;
  168. private:
  169.     Q_DECLARE_PRIVATE(QAbstractFileEngine)
  170.     Q_DISABLE_COPY(QAbstractFileEngine)
  171. };
  172. Q_DECLARE_OPERATORS_FOR_FLAGS(QAbstractFileEngine::FileFlags)
  173. class Q_CORE_EXPORT QAbstractFileEngineHandler
  174. {
  175. public:
  176.     QAbstractFileEngineHandler();
  177.     virtual ~QAbstractFileEngineHandler();
  178.     virtual QAbstractFileEngine *create(const QString &fileName) const = 0;
  179. };
  180. class QAbstractFileEngineIteratorPrivate;
  181. class Q_CORE_EXPORT QAbstractFileEngineIterator
  182. {
  183. public:
  184.     QAbstractFileEngineIterator(QDir::Filters filters, const QStringList &nameFilters);
  185.     virtual ~QAbstractFileEngineIterator();
  186.     virtual QString next() = 0;
  187.     virtual bool hasNext() const = 0;
  188.     QString path() const;
  189.     QStringList nameFilters() const;
  190.     QDir::Filters filters() const;
  191.     virtual QString currentFileName() const = 0;
  192.     virtual QFileInfo currentFileInfo() const;
  193.     QString currentFilePath() const;
  194. protected:
  195.     enum EntryInfoType {
  196.     };
  197.     virtual QVariant entryInfo(EntryInfoType type) const;
  198. private:
  199.     Q_DISABLE_COPY(QAbstractFileEngineIterator)
  200.     friend class QDirIterator;
  201.     friend class QDirIteratorPrivate;
  202.     void setPath(const QString &path);
  203.     QAbstractFileEngineIteratorPrivate *d;
  204. };
  205. QT_END_NAMESPACE
  206. QT_END_HEADER
  207. #endif // QABSTRACTFILEENGINE_H