forked from qt-creator/qt-creator
8bd1969e7f
* Added QDebug operator<< for the Field classes so that they could be inspected during runtime (i.e. logged) * Added optional QDebug operator<< overloads for QVariant (wizarddebug.h) - to better visualize the data parsed from the wizard.json files (QVariant objects), by using a format more in the like of json. Change-Id: I53a729b24e4f2d9c9acf1ed802ac9dc3bb67f373 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
103 lines
3.3 KiB
C++
103 lines
3.3 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "core_global.h"
|
|
|
|
#include <utils/id.h>
|
|
|
|
#include <QList>
|
|
#include <QSharedDataPointer>
|
|
|
|
namespace Utils { class FilePath; }
|
|
|
|
namespace Core {
|
|
class GeneratedFilePrivate;
|
|
|
|
class CORE_EXPORT GeneratedFile
|
|
{
|
|
public:
|
|
enum Attribute {
|
|
// Open this file in editor
|
|
OpenEditorAttribute = 0x01,
|
|
// Open project
|
|
OpenProjectAttribute = 0x02,
|
|
// File is generated by external scripts, do not write out, see BaseFileWizard::writeFiles()
|
|
CustomGeneratorAttribute = 0x4,
|
|
// File exists and the user indicated that he wants to keep it
|
|
KeepExistingFileAttribute = 0x8,
|
|
// Force overwriting of a file without asking the user to keep it
|
|
ForceOverwrite = 0x10,
|
|
// Mark the document temporary after opening the file
|
|
TemporaryFile = 0x20
|
|
};
|
|
Q_DECLARE_FLAGS(Attributes, Attribute)
|
|
|
|
GeneratedFile();
|
|
explicit GeneratedFile(const Utils::FilePath &path);
|
|
explicit GeneratedFile(const QString &path);
|
|
GeneratedFile(const GeneratedFile &);
|
|
GeneratedFile &operator=(const GeneratedFile &);
|
|
~GeneratedFile();
|
|
|
|
// Full path of the file should be created, or the suggested file name
|
|
QString path() const;
|
|
void setPath(const QString &p);
|
|
void setFilePath(const Utils::FilePath &p);
|
|
Utils::FilePath filePath() const;
|
|
|
|
// Contents of the file (UTF8)
|
|
QString contents() const;
|
|
void setContents(const QString &c);
|
|
|
|
QByteArray binaryContents() const;
|
|
void setBinaryContents(const QByteArray &c);
|
|
|
|
// Defaults to false (Text file).
|
|
bool isBinary() const;
|
|
void setBinary(bool b);
|
|
|
|
// Id of editor to open the file with
|
|
Utils::Id editorId() const;
|
|
void setEditorId(Utils::Id id);
|
|
|
|
bool write(QString *errorMessage) const;
|
|
|
|
Attributes attributes() const;
|
|
void setAttributes(Attributes a);
|
|
|
|
private:
|
|
QSharedDataPointer<GeneratedFilePrivate> m_d;
|
|
|
|
friend CORE_EXPORT QDebug &operator<<(QDebug &debug, const Core::GeneratedFile &file);
|
|
};
|
|
|
|
CORE_EXPORT QDebug &operator<<(QDebug &debug, const Core::GeneratedFile &file);
|
|
|
|
using GeneratedFiles = QList<GeneratedFile>;
|
|
|
|
} // namespace Core
|