Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Export plugin for Remixed Dungeon #4158

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/plugins/plugins.qbs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Project {
"python",
"replicaisland",
"rpmap",
"rpd",
"tbin",
"tengine",
"tscn",
Expand Down
1 change: 1 addition & 0 deletions src/plugins/rpd/plugin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ "defaultEnable": true }
307 changes: 307 additions & 0 deletions src/plugins/rpd/qjsonparser/json.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,307 @@
/****************************************************************************
**
** Copyright (c) 2010 Girish Ramakrishnan <[email protected]>
**
** Use, modification and distribution is allowed without limitation,
** warranty, liability or support of any kind.
**
****************************************************************************/

#include "json.h"

#include <QDebug>
#include <qnumeric.h>

/*!
\class JsonWriter
\reentrant

\brief The JsonWriter class converts a QVariant into a JSON string.

The writer converts specific supported types stored in a QVariant into JSON.
For example,
\code
QVariantMap map;
map["id"] = 123;
map["class"] = "JsonWriter";
QVariantList list;
list << "Denis" << "Ettrich" << "Girish";
map["authors"] = list;

JsonWriter writer;
if (writer.stringify(map)) {
QString json = writer.result();
qDebug() << json; // {"authors": ["Denis", "Ettrich", "Girish"], "class": "JsonWriter", "id": 123 }
} else {
qDebug() << "Failed to stringify " << writer.errorString();
}
\endcode

The list of QVariant types that the writer supports is listed in stringify(). Note that
custom C++ types registered using Q_DECLARE_METATYPE are not supported.
*/

/*!
Creates a JsonWriter.
*/
JsonWriter::JsonWriter()
: m_autoFormattingIndent(4, QLatin1Char(' '))
{
}

/*!
Destructor.
*/
JsonWriter::~JsonWriter()
{
}

/*!
Enables auto formatting if \a enable is \c true, otherwise
disables it.

When auto formatting is enabled, the writer automatically inserts
spaces and new lines to make the output more human readable.

The default value is \c false.
*/
void JsonWriter::setAutoFormatting(bool enable)
{
m_autoFormatting = enable;
}

/*!
Returns \c true if auto formattting is enabled, otherwise \c false.
*/
bool JsonWriter::autoFormatting() const
{
return m_autoFormatting;
}

/*!
Sets the number of spaces or tabs used for indentation when
auto-formatting is enabled. Positive numbers indicate spaces,
negative numbers tabs.

The default indentation is 4.

\sa setAutoFormatting()
*/
void JsonWriter::setAutoFormattingIndent(int spacesOrTabs)
{
m_autoFormattingIndent = QString(qAbs(spacesOrTabs), QLatin1Char(spacesOrTabs >= 0 ? ' ' : '\t'));
}

/*!
Retuns the numbers of spaces or tabs used for indentation when
auto-formatting is enabled. Positive numbers indicate spaces,
negative numbers tabs.

The default indentation is 4.

\sa setAutoFormatting()
*/
int JsonWriter::autoFormattingIndent() const
{
return m_autoFormattingIndent.count(QLatin1Char(' ')) - m_autoFormattingIndent.count(QLatin1Char('\t'));
}

/*!
Will insert a newline while writing out arrays after every \a count elements.
*/
void JsonWriter::setAutoFormattingWrapArrayCount(int count)
{
m_autoFormattingWrapArrayCount = count;
}

/*! \internal
Inserts escape character \ for characters in string as described in JSON specification.
*/
static QString escape(const QVariant &variant)
{
QString str = variant.toString();
QString res;
res.reserve(str.length());
for (int i = 0; i < str.length(); i++) {
if (str[i] == QLatin1Char('\b')) {
res += QLatin1String("\\b");
} else if (str[i] == QLatin1Char('\f')) {
res += QLatin1String("\\f");
} else if (str[i] == QLatin1Char('\n')) {
res += QLatin1String("\\n");
} else if (str[i] == QLatin1Char('\r')) {
res += QLatin1String("\\r");
} else if (str[i] == QLatin1Char('\t')) {
res += QLatin1String("\\t");
} else if (str[i] == QLatin1Char('\"')) {
res += QLatin1String("\\\"");
} else if (str[i] == QLatin1Char('\\')) {
res += QLatin1String("\\\\");
} else if (str[i] == QLatin1Char('/')) {
res += QLatin1String("\\/");
} else if (str[i].unicode() > 127) {
res += QLatin1String("\\u") + QString::number(str[i].unicode(), 16).rightJustified(4, QLatin1Char('0'));
} else {
res += str[i];
}
}
return res;
}

/*! \internal
Stringifies \a variant.
*/
void JsonWriter::stringify(const QVariant &variant, int depth)
{
if (variant.type() == QVariant::List || variant.type() == QVariant::StringList) {
const QString indent = m_autoFormattingIndent.repeated(depth);
m_result += QLatin1Char('[');
QVariantList list = variant.toList();
for (int i = 0; i < list.count(); i++) {
if (i != 0) {
m_result += QLatin1Char(',');
if (m_autoFormatting) {
if (m_autoFormattingWrapArrayCount && i % m_autoFormattingWrapArrayCount == 0) {
m_result += QLatin1Char('\n');
m_result += indent;
} else {
m_result += QLatin1Char(' ');
}
}
}
stringify(list[i], depth+1);
}
m_result += QLatin1Char(']');
} else if (variant.type() == QVariant::Map) {
const QString indent = m_autoFormattingIndent.repeated(depth);
QVariantMap map = variant.toMap();
if (m_autoFormatting && depth != 0) {
m_result += QLatin1Char('\n');
m_result += indent;
m_result += QLatin1String("{\n");
} else {
m_result += QLatin1Char('{');
}
for (QVariantMap::const_iterator it = map.constBegin(); it != map.constEnd(); ++it) {
if (it != map.constBegin()) {
m_result += QLatin1Char(',');
if (m_autoFormatting)
m_result += QLatin1Char('\n');
}
if (m_autoFormatting)
m_result += indent + QLatin1Char(' ');
m_result += QLatin1Char('\"') + escape(it.key()) + QLatin1String("\":");
stringify(it.value(), depth+1);
}
if (m_autoFormatting) {
m_result += QLatin1Char('\n');
m_result += indent;
}
m_result += QLatin1Char('}');
} else if (variant.type() == QVariant::String || variant.type() == QVariant::ByteArray) {
m_result += QLatin1Char('\"') + escape(variant) + QLatin1Char('\"');
} else if (variant.type() == QVariant::Double || (int)variant.type() == (int)QMetaType::Float) {
double d = variant.toDouble();
if (qIsFinite(d))
m_result += QString::number(variant.toDouble(), 'g', 15);
else
m_result += QLatin1String("null");
} else if (variant.type() == QVariant::Bool) {
m_result += variant.toBool() ? QLatin1String("true") : QLatin1String("false");
} else if (variant.type() == QVariant::Invalid) {
m_result += QLatin1String("null");
} else if (variant.type() == QVariant::ULongLong) {
m_result += QString::number(variant.toULongLong());
} else if (variant.type() == QVariant::LongLong) {
m_result += QString::number(variant.toLongLong());
} else if (variant.type() == QVariant::Int) {
m_result += QString::number(variant.toInt());
} else if (variant.type() == QVariant::UInt) {
m_result += QString::number(variant.toUInt());
} else if (variant.type() == QVariant::Char) {
QChar c = variant.toChar();
if (c.unicode() > 127)
m_result += QLatin1String("\"\\u") + QString::number(c.unicode(), 16).rightJustified(4, QLatin1Char('0')) + QLatin1Char('\"');
else
m_result += QLatin1Char('\"') + c + QLatin1Char('\"');
} else if (variant.canConvert<qlonglong>()) {
m_result += QString::number(variant.toLongLong());
} else if (variant.canConvert<QString>()) {
m_result += QLatin1Char('\"') + escape(variant) + QLatin1Char('\"');
} else {
if (!m_errorString.isEmpty())
m_errorString.append(QLatin1Char('\n'));
QString msg = QStringLiteral("Unsupported type %1 (id: %2)").arg(QString::fromUtf8(variant.typeName())).arg(variant.userType());
m_errorString.append(msg);
qWarning() << "JsonWriter::stringify - " << msg;
m_result += QLatin1String("null");
}
}

/*!
Converts the variant \a var into a JSON string.

The stringizer converts \a var into JSON based on the type of it's contents. The supported
types and their conversion into JSON is as listed below:

\table
\row
\o QVariant::List, QVariant::StringList
\o JSON array []
\row
\o QVariant::Map
\o JSON object {}
\row
\o QVariant::String, QVariant::ByteArray
\o JSON string encapsulated in double quotes. String contents are escaped using '\' if necessary.
\row
\o QVariant::Double, QMetaType::Float
\o JSON number with a precision 15. Infinity and NaN are converted into null.
\row
\o QVariant::Bool
\o JSON boolean true and false
\row
\o QVariant::Invalid
\o JSON null
\row
\o QVariant::ULongLong, QVariant::LongLong, QVariant::Int, QVariant::UInt,
\o JSON number
\row
\o QVariant::Char
\o JSON string. Non-ASCII characters are converted into the \uXXXX notation.
\endtable

As a fallback, the writer attempts to convert a type not listed above into a long long or a
QString using QVariant::canConvert. See the QVariant documentation for possible conversions.

JsonWriter does not support stringizing custom user types stored in the QVariant. Any such
value would be converted into JSON null.
*/
bool JsonWriter::stringify(const QVariant &var)
{
m_errorString.clear();
m_result.clear();
stringify(var, 0 /* depth */);
return m_errorString.isEmpty();
}

/*!
Returns the result of the last stringify() call.

If stringify() failed, this function returns a null QString.
*/
QString JsonWriter::result() const
{
return m_result;
}

/*!
Returns the error message for the last stringify() call.

If stringify() succeeded, this functions return an empty string. The error message
should be used for debugging purposes only.
*/
QString JsonWriter::errorString() const
{
return m_errorString;
}
43 changes: 43 additions & 0 deletions src/plugins/rpd/qjsonparser/json.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/****************************************************************************
**
** Copyright (c) 2010 Girish Ramakrishnan <[email protected]>
**
** Use, modification and distribution is allowed without limitation,
** warranty, liability or support of any kind.
**
****************************************************************************/

#pragma once

#include <QByteArray>
#include <QVariant>

class JsonWriter
{
public:
JsonWriter();
~JsonWriter();

bool stringify(const QVariant &variant);

QString result() const;

QString errorString() const;

void setAutoFormatting(bool autoFormat);
bool autoFormatting() const;

void setAutoFormattingIndent(int spaceOrTabs);
int autoFormattingIndent() const;

void setAutoFormattingWrapArrayCount(int count);

private:
void stringify(const QVariant &variant, int depth);

QString m_result;
QString m_errorString;
bool m_autoFormatting = false;
QString m_autoFormattingIndent;
int m_autoFormattingWrapArrayCount = 0;
};
14 changes: 14 additions & 0 deletions src/plugins/rpd/rpd.qbs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import qbs 1.0

TiledPlugin {
cpp.defines: ["RPD_LIBRARY"]

files: [
"rpd_global.h",
"rpdplugin.cpp",
"rpdplugin.h",
"plugin.json",
"qjsonparser/json.cpp",
"qjsonparser/json.h",
]
}
12 changes: 12 additions & 0 deletions src/plugins/rpd/rpd_global.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#ifndef RPD_GLOBAL_H
#define RPD_GLOBAL_H

#include <QtCore/qglobal.h>

#if defined(RPD_LIBRARY)
# define RPDSHARED_EXPORT Q_DECL_EXPORT
#else
# define RPDSHARED_EXPORT Q_DECL_IMPORT
#endif

#endif // RPD_GLOBAL_H
Loading
Loading