ddesktopentry.h

/*
 * Copyright (C) 2019 Deepin Technology Co., Ltd.
 *               2019 Gary Wang
 *
 * Author:     Gary Wang <[email protected]>
 *
 * Maintainer: Gary Wang <[email protected]>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * 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 Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <dtkcore_global.h>
 
#include <QIODevice>
#include <QObject>
#include <QVariant>
 
DCORE_BEGIN_NAMESPACE
 
class DDesktopEntryPrivate;
class LIBDTKCORESHARED_EXPORT DDesktopEntry
{
    Q_GADGET
public:
    enum EntryType {
        Unknown = 0, 
        Application, 
        Link,        
        Directory,   
        ServiceType, 
        Service,     
        FSDevice     
    };
    Q_ENUM(EntryType)
 
    enum ValueType {
        Unparsed = 0, // Maybe useless, consider remove it?
        String,
        Strings,
        Boolean,
        Numeric,
        NotExisted = 99
    };
    Q_ENUM(ValueType)
 
    enum Status {
        NoError = 0, 
        AccessError, 
        FormatError  
    };
    Q_ENUM(Status)
 
    explicit DDesktopEntry(const QString &filePath) noexcept;
    ~DDesktopEntry();
 
    bool save() const;
 
    Status status() const;
    QStringList keys(const QString &section = "Desktop Entry") const;
    QStringList allGroups(bool sorted = false) const;
 
    bool contains(const QString &key, const QString &section = "Desktop Entry") const;
 
    QString name() const;
    QString genericName() const;
    QString ddeDisplayName() const;
    QString comment() const;
 
    QString rawValue(const QString &key, const QString &section = "Desktop Entry",
                     const QString &defaultValue = QString()) const;
    QString stringValue(const QString &key, const QString &section = "Desktop Entry",
                        const QString &defaultValue = QString()) const;
    QString localizedValue(const QString &key, const QString &localeKey = "default",
                           const QString &section = "Desktop Entry", const QString& defaultValue = QString()) const;
    QString localizedValue(const QString &key, const QLocale &locale,
                           const QString &section = "Desktop Entry", const QString& defaultValue = QString()) const;
    QStringList stringListValue(const QString &key, const QString &section = "Desktop Entry") const;
 
    bool setRawValue(const QString &value, const QString &key, const QString& section = "Desktop Entry");
    bool setStringValue(const QString &value, const QString &key, const QString& section = "Desktop Entry");
    bool setLocalizedValue(const QString &value, const QString& localeKey,
                           const QString &key, const QString& section = "Desktop Entry");
 
    bool removeEntry(const QString &key, const QString &section = "Desktop Entry");
 
    static QString &escape(QString &str);
    static QString &escapeExec(QString &str);
    static QString &unescape(QString &str, bool unescapeSemicolons = false);
    static QString &unescapeExec(QString &str);
 
protected:
    bool setStatus(const Status &status);
 
private:
    QScopedPointer<DDesktopEntryPrivate> d_ptr;
 
    Q_DECLARE_PRIVATE(DDesktopEntry)
};
 
DCORE_END_NAMESPACE