kremoteencoding.h

/*
    This file is part of the KDE libraries
    SPDX-FileCopyrightText: 2003 Thiago Macieira <thiago.macieira@kdemail.net>
 
    SPDX-License-Identifier: LGPL-2.0-only
*/
 
#ifndef KREMOTEENCODING_H
#define KREMOTEENCODING_H
 
#include "kiocore_export.h"
#include <QByteArray>
#include <QString>
 
#include <memory>
 
class QUrl;
class KRemoteEncodingPrivate;
/**
 * @class KRemoteEncoding kremoteencoding.h <KRemoteEncoding>
 *
 * Allows encoding and decoding properly remote filenames into Unicode.
 *
 * Certain protocols do not specify an appropriate encoding for decoding
 * their 8-bit data into proper Unicode forms. Therefore, KIO workers should
 * use this class in order to convert those forms into QStrings before
 * creating the respective KIO::UDSEntry. The same is true for decoding
 * URLs to its components.
 *
 * Each KIO::WorkerBase has one object of this kind, even if it is not necessary.
 * It can be accessed through KIO::WorkerBase::remoteEncoding.
 *
 * @short A class for handling remote filenames
 * @author Thiago Macieira <thiago.macieira@kdemail.net>
 */
class KIOCORE_EXPORT KRemoteEncoding
{
public:
    /**
     * Constructor.
     *
     * Constructs this object to use the given encoding name.
     * If @p name is a null pointer, the standard encoding will be used.
     */
    explicit KRemoteEncoding(const char *name = nullptr);
 
    /**
     * Destructor
     */
    virtual ~KRemoteEncoding();
 
    /**
     * Converts the given full pathname or filename to Unicode.
     * This function is supposed to work for dirnames, filenames
     * or a full pathname.
     */
    QString decode(const QByteArray &name) const;
 
    /**
     * Converts the given name from Unicode.
     * This function is supposed to work for dirnames, filenames
     * or a full pathname.
     */
    QByteArray encode(const QString &name) const;
 
    /**
     * Converts the given URL into its 8-bit components
     */
    QByteArray encode(const QUrl &url) const;
 
    /**
     * Converts the given URL into 8-bit form and separate the
     * dirname from the filename. This is useful for worker functions
     * like stat or get.
     *
     * The dirname is returned with the final slash always stripped
     */
    QByteArray directory(const QUrl &url, bool ignore_trailing_slash = true) const;
 
    /**
     * Converts the given URL into 8-bit form and retrieve the filename.
     */
    QByteArray fileName(const QUrl &url) const;
 
    /**
     * Returns the encoding being used.
     */
    const char *encoding() const;
 
    /**
     * Sets the encoding being used.
     * This function does not change the global configuration.
     *
     * Pass a null pointer in @p name to revert to the standard
     * encoding.
     */
    void setEncoding(const char *name);
 
protected:
    virtual void virtual_hook(int id, void *data);
 
private:
    std::unique_ptr<KRemoteEncodingPrivate> const d;
 
    Q_DISABLE_COPY(KRemoteEncoding)
};
 
#endif