File indexing completed on 2024-05-12 04:51:03

 /*
     SPDX-FileCopyrightText: 1998-2008 Sebastian Trueg <trueg@k3b.org>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 
 #ifndef K3BDATAITEM_H
 #define K3BDATAITEM_H
 
 #include "k3bmsf.h"
 #include "k3b_export.h"
 
 #include <KIO/Global>
 
 #include <QMimeType>
 #include <QString>
 
 namespace K3b {
     class DirItem;
     class DataDoc;
 
     /**
      *@author Sebastian Trueg
      */
     class LIBK3B_EXPORT DataItem
     {
     public:
         enum ItemFlag {
             DIR = 0x1,
             FILE = 0x2,
             SPECIALFILE = 0x4,
             SYMLINK = 0x8,
             OLD_SESSION = 0x10,
             BOOT_IMAGE = 0x20
         };
         Q_DECLARE_FLAGS( ItemFlags, ItemFlag )
         
     public:
         explicit DataItem( const ItemFlags& flags = ItemFlags() );
 
         /**
          * Default copy constructor.
          *
          * The result is an exact copy except that no parent dir it set and, thus, also no doc.
          */
         DataItem( const DataItem& );
 
         virtual ~DataItem();
 
         /**
          * Return an exact copy of this data item.
          *
          * The result is an exact copy except that no parent dir it set and, thus, also no doc.
          *
          * Implementations should use the default constructor.
          */
         virtual DataItem* copy() const = 0;
 
         DirItem* parent() const { return m_parentDir; }
 
         /**
          * Remove this item from it's parent and return a pointer to it.
          */
         DataItem* take();
 
         virtual DataDoc* getDoc() const;
         virtual QString k3bName() const;
         virtual void setK3bName( const QString& );
 
         /**
          * returns the path as defined by the k3b-hierarchy, NOT starting with a slash
          * (since this is used for graft-points!)
          * directories have a trailing "/"
          */
         virtual QString k3bPath() const;
 
         /**
          * Returns the name of the item as used on the CD or DVD image.
          *
          * This is only valid after a call to @p DataDoc::prepareFilenames()
          */
         QString writtenName() const { return m_writtenName; }
 
         /**
          * \return the pure name used in the Iso9660 tree.
          *
          * This is only valid after a call to @p DataDoc::prepareFilenames()
          */
         QString iso9660Name() const { return m_rawIsoName; }
 
         /**
          * Returns the path of the item as written to the CD or DVD image.
          *
          * This is suited to be used for mkisofs graftpoints.
          *
          * This is only valid after a call to @p DataDoc::prepareFilenames()
          */
         virtual QString writtenPath() const;
 
         virtual QString iso9660Path() const;
 
         /**
          * Used to set the written name by @p DataDoc::prepareFilenames()
          */
         void setWrittenName( const QString& s ) { m_writtenName = s; }
 
         /**
          * Used to set the pure Iso9660 name by @p DataDoc::prepareFilenames()
          */
         void setIso9660Name( const QString& s ) { m_rawIsoName = s; }
 
         virtual DataItem* nextSibling() const;
 
         /** returns the path to the file on the local filesystem */
         virtual QString localPath() const { return QString(); }
 
         /**
          * The size of the item
          */
         KIO::filesize_t size() const;
 
         /**
          * \return The number of blocks (2048 bytes) occupied by this item.
          *         This value equals to ceil(size()/2048)
          */
         Msf blocks() const;
 
         /**
          * \return the dir of the item (or the item itself if it is a dir)
          */
         virtual DirItem* getDirItem() const { return parent(); }
 
         virtual void reparent( DirItem* );
 
         const ItemFlags& flags() const;
         bool isDir() const;
         bool isFile() const;
         bool isSpecialFile() const;
         bool isSymLink() const;
         bool isFromOldSession() const;
         bool isBootItem() const;
 
         bool hideOnRockRidge() const;
         bool hideOnJoliet() const;
 
         virtual void setHideOnRockRidge( bool b );
         virtual void setHideOnJoliet( bool b );
 
         virtual long sortWeight() const { return m_sortWeight; }
         virtual void setSortWeight( long w ) { m_sortWeight = w; }
 
         virtual int depth() const;
 
         virtual bool isValid() const { return true; }
 
         // these are all needed for special fileitems like
         // imported sessions or the movix filesystem
         virtual bool isRemoveable() const { return m_bRemoveable; }
         virtual bool isMoveable() const { return m_bMovable; }
         virtual bool isRenameable() const { return m_bRenameable; }
         virtual bool isHideable() const { return m_bHideable; }
         virtual bool writeToCd() const { return m_bWriteToCd; }
         virtual QString extraInfo() const { return m_extraInfo; }
 
         /**
          * Default implementation returns the default mimetype.
          */
         virtual QMimeType mimeType() const;
 
         void setRenameable( bool b ) { m_bRenameable = b; }
         void setMoveable( bool b ) { m_bMovable = b; }
         void setRemoveable( bool b ) { m_bRemoveable = b; }
         void setHideable( bool b ) { m_bHideable = b; }
         void setWriteToCd( bool b ) { m_bWriteToCd = b; }
         void setExtraInfo( const QString& i ) { m_extraInfo = i; }
 
     protected:
         virtual KIO::filesize_t itemSize( bool followSymlinks ) const = 0;
 
         /**
          * \param followSymlinks If true symlinks will be followed and their
          *                       size equals the size of the file they are
          *                       pointing to.
          *
          * \return The number of blocks (2048 bytes) occupied by this item.
          */
         virtual Msf itemBlocks( bool followSymlinks ) const;
 
         QString m_k3bName;
 
         void setFlags( const ItemFlags& flags );
         void setParentDir( DirItem* parentDir ) { m_parentDir = parentDir; }
 
     private:
         class Private;
         Private* d;
 
         QString m_writtenName;
         QString m_rawIsoName;
         QString m_extraInfo;
 
         DirItem* m_parentDir;
         long m_sortWeight;
 
         bool m_bHideOnRockRidge;
         bool m_bHideOnJoliet;
         bool m_bRemoveable;
         bool m_bRenameable;
         bool m_bMovable;
         bool m_bHideable;
         bool m_bWriteToCd;
         
         friend class DirItem;
     };
 }
 
 #endif