File indexing completed on 2024-04-28 05:45:44

 /*
     SPDX-FileCopyrightText: 2017-2020 Andrius Štikonas <andrius@stikonas.eu>
 
     SPDX-License-Identifier: GPL-3.0-or-later
 */
 
 #ifndef KPMCORE_FSTAB_H
 #define KPMCORE_FSTAB_H
 
 #include "util/libpartitionmanagerexport.h"
 
 #include <memory>
 
 #include <QList>
 #include <QString>
 
 struct FstabEntryPrivate;
 
 /** Base class for fstab handling.
 
     FstabEntry stores a single line of /etc/fstab file which can be a comment
 
     @author Andrius Štikonas <andrius@stikonas.eu>
 */
 
 class LIBKPMCORE_EXPORT FstabEntry
 {
 public:
     enum class Type { deviceNode, uuid, label, partlabel, partuuid, comment, other };
 
     FstabEntry(const QString& fsSpec, const QString& mountPoint, const QString& type, const QString& options, int dumpFreq = 0, int passNumber = 0, const QString& comment = QString());
 
     /**
       * @return the fs_spec field of fstab entry
       */
     const QString& fsSpec() const;
 
     /**
       * @return the device node corresponding to fs_spec entry
       */
     const QString& deviceNode() const;
 
     /**
       * @return the mount point (target) for the file system
       */
     const QString& mountPoint() const;
 
     /**
       * @return the type of the file system
       */
     const QString& type() const;
 
     /**
       * @return the mount options associated with the file system
       */
     const QStringList& options() const;
 
     /**
       * @return the mount options associated with the file system
       */
     const QString optionsString() const;
 
     /**
       * @return the fs_freq field of fstab entry
       */
     int dumpFreq() const;
 
     /**
       * @return the fs_passno field of fstab entry
       */
     int passNumber() const;
 
     /**
       * @return commented part of the line in fstab file
       */
     const QString& comment() const;
 
     /**
       * @return the type of fstab entry, e.g. device node or UUID or comment only
       */
     Type entryType() const;
 
     /**
       * @param s the new value for the fs_spec field of fstab entry
       */
     void setFsSpec(const QString& s);
 
     /**
       * @param s the new value for the mount point
       */
     void setMountPoint(const QString& s);
 
     /**
       * @param s the new list with the mount options
       */
     void setOptions(const QStringList& s);
 
     /**
       * @param s the new value for the dump frequency
       */
     void setDumpFreq(int s);
 
     /**
       * @param s the new value for the pass number
       */
     void setPassNumber(int s);
 
 private:
     std::shared_ptr<FstabEntryPrivate> d;
 };
 
 typedef QList<FstabEntry> FstabEntryList;
 
 QString escapeSpaces(const QString& mountPoint);
 QString unescapeSpaces(const QString& mountPoint);
 
 LIBKPMCORE_EXPORT FstabEntryList readFstabEntries(const QString& fstabPath = QStringLiteral("/etc/fstab"));
 LIBKPMCORE_EXPORT QStringList possibleMountPoints(const QString& deviceNode, const QString& fstabPath = QStringLiteral("/etc/fstab"));
 LIBKPMCORE_EXPORT QString generateFstab(const FstabEntryList& fstabEntries);
 LIBKPMCORE_EXPORT bool writeMountpoints(const FstabEntryList& fstabEntries);
 
 #endif