kpmcore/src/core/volumemanagerdevice.h

/*************************************************************************
 *  Copyright (C) 2016 by Chantara Tith <tith.chantara@gmail.com>        *
 *                                                                       *
 *  This program is free software; you can redistribute it and/or        *
 *  modify it under the terms of the GNU General Public License as       *
 *  published by the Free Software Foundation; either version 3 of       *
 *  the License, or (at your option) any later version.                  *
 *                                                                       *
 *  This program is distributed in the hope that it will be useful,      *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of       *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
 *  GNU General Public License for more details.                         *
 *                                                                       *
 *  You should have received a copy of the GNU General Public License    *
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.*
 *************************************************************************/

#if !defined(KPMCORE_VOLUMEMANAGERDEVICE_H)

#define KPMCORE_VOLUMEMANAGERDEVICE_H

#include "util/libpartitionmanagerexport.h"
#include "core/device.h"

#include <QString>
#include <QStringList>
#include <QObject>
#include <QtGlobal>

/** A Volume Manager of physical devices represented as an abstract device.
 *
 *   VolumeManagerDevice is an abstract device class for volume manager. e.g: LVM, SoftRAID.
 *   example of physical device: /dev/sda, /dev/sdb1.
 *
 *   Devices are the outermost entity; they contain a PartitionTable that itself contains Partitions.
 *
 *   @see Device, PartitionTable, Partition
 */
class LIBKPMCORE_EXPORT VolumeManagerDevice : public Device
{
    Q_DISABLE_COPY(VolumeManagerDevice)

public:

    VolumeManagerDevice(const QString& name, const QString& deviceNode, const qint64 logicalSize, const qint64 totalLogical, const QString& iconName = QString(), Device::Type type = Device::Unknown_Device);

    /**
     *  @return list of physical device's path that makes up volumeManagerDevice.(e.g: /dev/sda, /dev/sdb1)
     */
    virtual const QStringList deviceNodes() const = 0;

    /**
     * @return list of logical partition's path.
     */
    virtual const QStringList partitionNodes() const = 0;

    /**
     * @return size of logical partition at the given path in bytes.
     */
    virtual qint64 partitionSize(QString& partitionPath) const = 0;

protected:

    /** Initialize device's partition table and partitions.
     *
     */
    virtual void initPartitions() = 0;

    /** absolute sector as represented inside the device's partitionTable
     *
     *  For VolumeMangerDevice to works with the rest of the codebase, partitions are stringed
     *  one after another to create a representation of PartitionTable and partition just like
     *  real disk device.
     *
     *  @param partitionPath logical partition path
     *  @sector sector value to be mapped (if 0, will return start sector of the partition)
     *  @return absolute sector value as represented inside device's partitionTable
     */
    virtual qint64  mappedSector(const QString& partitionPath, qint64 sector) const = 0;

public:

    /** string deviceNodes together into comma-sperated list
     *
     *  @return comma-seperated list of deviceNodes
     */
    virtual QString prettyDeviceNodeList() const;

    /** Resize device total number of logical sectors.
     *
     * @param n Number of sectors.
     */
    void setTotalLogical(qint64 n) {
        Q_ASSERT(n > 0);
        m_TotalLogical = n;
    }
};

#endif