From 2b65bba77d4705d49a01a25350de64d153808504 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Morten=20Johan=20S=C3=B8rvig?= Date: Mon, 2 Sep 2013 10:12:07 +0200 Subject: Add Mac type conversion functions to QtCore New API: static QString QString::fromCFString(CFStringRef string); CFStringRef QString::toCFString() const; static QString QString::fromNSString(const NSString *string); NSString *QString::toNSString() const; static QUrl QUrl::fromCFURL(CFURLRef url); CFURLRef QUrl::toCFURL() const; static QUrl QUrl::fromNSURL(const NSURL *url); NSURL * QUrl::toNSURL() const; Add Q_OS_MAC-protected function declarations to header files, add implementation to _mm files. CF and NS types are forward-declared in the header files to avoid including the CoreFoundation and Foundation headers. This prevents accidental use of native types in application code. Add helper macros for forward- declaration to qglobal.h Add cf_returns_retained/ns_returns_autoreleased attributes to toCFString() and toNSURL(). These attributes assists the clang static analyzer. Add Q_DECL_ helper macros to qcompilerdetection.h. Add test functions (in _mac.mm files) to the QString and QUrl tests. Split out the test class declarations into a separate headers files. Change-Id: I60fd5e93f042316196284c3db0595835fe8c4ad4 Reviewed-by: Gabriel de Dietrich --- src/corelib/global/qcompilerdetection.h | 14 ++++++ src/corelib/global/qglobal.cpp | 32 +++++++++++++ src/corelib/global/qglobal.h | 8 ++++ src/corelib/io/io.pri | 1 + src/corelib/io/qurl.cpp | 27 +++++++++++ src/corelib/io/qurl.h | 12 +++++ src/corelib/io/qurl_mac.mm | 70 +++++++++++++++++++++++++++ src/corelib/tools/qstring.cpp | 25 ++++++++++ src/corelib/tools/qstring.h | 12 ++++- src/corelib/tools/qstring_mac.mm | 85 +++++++++++++++++++++++++++++++++ src/corelib/tools/tools.pri | 3 +- 11 files changed, 287 insertions(+), 2 deletions(-) create mode 100644 src/corelib/io/qurl_mac.mm create mode 100644 src/corelib/tools/qstring_mac.mm (limited to 'src') diff --git a/src/corelib/global/qcompilerdetection.h b/src/corelib/global/qcompilerdetection.h index 5306e432fd..a388bdb96f 100644 --- a/src/corelib/global/qcompilerdetection.h +++ b/src/corelib/global/qcompilerdetection.h @@ -620,6 +620,14 @@ # endif #endif // Q_CC_CLANG +#if defined(Q_CC_CLANG) && defined(__APPLE__) +/* Apple/clang specific features */ +# define Q_DECL_CF_RETURNS_RETAINED __attribute__((cf_returns_retained)) +# ifdef __OBJC__ +# define Q_DECL_NS_RETURNS_AUTORELEASED __attribute__((ns_returns_autoreleased)) +# endif +#endif + #if defined(Q_CC_GNU) && !defined(Q_CC_INTEL) && !defined(Q_CC_CLANG) # if defined(__GXX_EXPERIMENTAL_CXX0X__) || __cplusplus >= 201103L # if (__GNUC__ * 100 + __GNUC_MINOR__) >= 403 @@ -849,6 +857,12 @@ # define Q_FUNC_INFO __FILE__ ":" QT_STRINGIFY(__LINE__) # endif #endif +#ifndef Q_DECL_CF_RETURNS_RETAINED +# define Q_DECL_CF_RETURNS_RETAINED +#endif +#ifndef Q_DECL_NS_RETURNS_AUTORELEASED +# define Q_DECL_NS_RETURNS_AUTORELEASED +#endif /* Workaround for static const members on MSVC++. diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp index ce87e4bfd9..59bdecc868 100644 --- a/src/corelib/global/qglobal.cpp +++ b/src/corelib/global/qglobal.cpp @@ -3361,4 +3361,36 @@ bool QInternal::activateCallbacks(Callback cb, void **parameters) \sa Q_DECL_OVERRIDE */ +/*! + \macro Q_FORWARD_DECLARE_OBJC_CLASS(classname) + \since 5.2 + \relates + + Forward-declares an Objective-C \a classname in a manner such that it can be + compiled as either Objective-C or C++. + + This is primarily intended for use in header files that may be included by + both Objective-C and C++ source files. +*/ + +/*! + \macro Q_FORWARD_DECLARE_CF_TYPE(type) + \since 5.2 + \relates + + Forward-declares a Core Foundation \a type. This includes the actual + type and the ref type. For example, Q_FORWARD_DECLARE_CF_TYPE(CFString) + declares __CFString and CFStringRef. +*/ + +/*! + \macro Q_FORWARD_DECLARE_MUTABLE_CF_TYPE(type) + \since 5.2 + \relates + + Forward-declares a mutable Core Foundation \a type. This includes the actual + type and the ref type. For example, Q_FORWARD_DECLARE_CF_TYPE(CFString) + declares __CFMutableString and CFMutableStringRef. +*/ + QT_END_NAMESPACE diff --git a/src/corelib/global/qglobal.h b/src/corelib/global/qglobal.h index f38672bdc1..b4830bda1f 100644 --- a/src/corelib/global/qglobal.h +++ b/src/corelib/global/qglobal.h @@ -993,6 +993,14 @@ template struct QEnableIf; template struct QEnableIf { typedef T Type; }; } +#ifdef __OBJC__ +#define Q_FORWARD_DECLARE_OBJC_CLASS(classname) @class classname +#else +#define Q_FORWARD_DECLARE_OBJC_CLASS(classname) typedef struct objc_object classname +#endif +#define Q_FORWARD_DECLARE_CF_TYPE(type) typedef const struct __ ## type * type ## Ref +#define Q_FORWARD_DECLARE_MUTABLE_CF_TYPE(type) typedef struct __ ## type * type ## Ref + QT_END_NAMESPACE // Q_GLOBAL_STATIC #include diff --git a/src/corelib/io/io.pri b/src/corelib/io/io.pri index b7fc1bc600..eab3981f7a 100644 --- a/src/corelib/io/io.pri +++ b/src/corelib/io/io.pri @@ -130,6 +130,7 @@ win32 { !nacl:mac: { SOURCES += io/qsettings_mac.cpp + OBJECTIVE_SOURCES += io/qurl_mac.mm } mac { macx { diff --git a/src/corelib/io/qurl.cpp b/src/corelib/io/qurl.cpp index 1854ea9487..5535ae126a 100644 --- a/src/corelib/io/qurl.cpp +++ b/src/corelib/io/qurl.cpp @@ -3319,6 +3319,33 @@ QByteArray QUrl::toPercentEncoding(const QString &input, const QByteArray &exclu return input.toUtf8().toPercentEncoding(exclude, include); } +/*! \fn QUrl QUrl::fromCFURL(CFURLRef url) + \since 5.2 + + Constructs a QUrl containing a copy of the CFURL \a url. +*/ + +/*! \fn CFURLRef QUrl::toCFURL() const + \since 5.2 + + Creates a CFURL from a QUrl. The caller owns the CFURL and is + responsible for releasing it. +*/ + +/*! + \fn QUrl QUrl::fromNSURL(const NSURL *url) + \since 5.2 + + Constructs a QUrl containing a copy of the NSURL \a url. +*/ + +/*! + \fn NSURL* QUrl::toNSURL() const + \since 5.2 + + Creates a NSURL from a QUrl. The NSURL is autoreleased. +*/ + /*! \internal \since 5.0 diff --git a/src/corelib/io/qurl.h b/src/corelib/io/qurl.h index abb7df0056..e7edb4365e 100644 --- a/src/corelib/io/qurl.h +++ b/src/corelib/io/qurl.h @@ -50,6 +50,11 @@ #include #include +#ifdef Q_OS_MAC +Q_FORWARD_DECLARE_OBJC_CLASS(NSURL); +Q_FORWARD_DECLARE_CF_TYPE(CFURL); +#endif + QT_BEGIN_NAMESPACE @@ -257,6 +262,13 @@ public: static QByteArray toPercentEncoding(const QString &, const QByteArray &exclude = QByteArray(), const QByteArray &include = QByteArray()); +#if defined(Q_OS_MAC) || defined(Q_QDOC) + static QUrl fromCFURL(CFURLRef url); + CFURLRef toCFURL() const Q_DECL_CF_RETURNS_RETAINED; + static QUrl fromNSURL(const NSURL *url); + NSURL *toNSURL() const Q_DECL_NS_RETURNS_AUTORELEASED; +#endif + #if QT_DEPRECATED_SINCE(5,0) QT_DEPRECATED static QString fromPunycode(const QByteArray &punycode) { return fromAce(punycode); } diff --git a/src/corelib/io/qurl_mac.mm b/src/corelib/io/qurl_mac.mm new file mode 100644 index 0000000000..c235365ad8 --- /dev/null +++ b/src/corelib/io/qurl_mac.mm @@ -0,0 +1,70 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the QtCore module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** 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 Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qurl.h" + +#ifdef Q_OS_MAC +#include +#endif + +QT_BEGIN_NAMESPACE + +QUrl QUrl::fromCFURL(CFURLRef url) +{ + return QUrl(QString::fromCFString(CFURLGetString(url))); +} + +CFURLRef QUrl::toCFURL() const +{ + return CFURLCreateWithString(0, toString(FullyEncoded).toCFString(), 0); +} + +QUrl QUrl::fromNSURL(const NSURL *url) +{ + return QUrl(QString::fromNSString([url absoluteString])); +} + +NSURL *QUrl::toNSURL() const +{ + return [NSURL URLWithString:toString(FullyEncoded).toNSString()]; +} + +QT_END_NAMESPACE diff --git a/src/corelib/tools/qstring.cpp b/src/corelib/tools/qstring.cpp index 5f12141d2a..9625737d7f 100644 --- a/src/corelib/tools/qstring.cpp +++ b/src/corelib/tools/qstring.cpp @@ -7367,6 +7367,31 @@ QString QString::multiArg(int numArgs, const QString **args) const } +/*! \fn QString QString::fromCFString(CFStringRef string) + \since 5.2 + + Constructs a new QString containing a copy of the \a string CFString. +*/ + +/*! \fn CFStringRef QString::toCFString() const + \since 5.2 + + Creates a CFString from a QString. The caller owns the CFString and is + responsible for releasing it. +*/ + +/*! \fn QString QString::fromNSString(const NSString *string) + \since 5.2 + + Constructs a new QString containing a copy of the \a string NSString. +*/ + +/*! \fn NSString QString::toNSString() const + \since 5.2 + + Creates a NSString from a QString.g. The NSString is autoreleased. +*/ + /*! \fn bool QString::isSimpleText() const \internal diff --git a/src/corelib/tools/qstring.h b/src/corelib/tools/qstring.h index d20b3e227d..701082c7e6 100644 --- a/src/corelib/tools/qstring.h +++ b/src/corelib/tools/qstring.h @@ -64,8 +64,12 @@ namespace std #error qstring.h must be included before any header file that defines truncate #endif -QT_BEGIN_NAMESPACE +#ifdef Q_OS_MAC +Q_FORWARD_DECLARE_OBJC_CLASS(NSString); +Q_FORWARD_DECLARE_CF_TYPE(CFString); +#endif +QT_BEGIN_NAMESPACE class QCharRef; class QRegExp; @@ -674,6 +678,12 @@ public: static inline QString fromStdWString(const std::wstring &s); inline std::wstring toStdWString() const; +#if defined(Q_OS_MAC) || defined(Q_QDOC) + static QString fromCFString(CFStringRef string); + CFStringRef toCFString() const Q_DECL_CF_RETURNS_RETAINED; + static QString fromNSString(const NSString *string); + NSString *toNSString() const Q_DECL_NS_RETURNS_AUTORELEASED; +#endif // compatibility struct Null { }; static const Null null; diff --git a/src/corelib/tools/qstring_mac.mm b/src/corelib/tools/qstring_mac.mm new file mode 100644 index 0000000000..1ed443c405 --- /dev/null +++ b/src/corelib/tools/qstring_mac.mm @@ -0,0 +1,85 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the QtCore module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** 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 Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qstring.h" + +#import + +QT_BEGIN_NAMESPACE + +QString QString::fromCFString(CFStringRef string) +{ + if (!string) + return QString(); + CFIndex length = CFStringGetLength(string); + + // Fast path: CFStringGetCharactersPtr does not copy but may + // return null for any and no reason. + const UniChar *chars = CFStringGetCharactersPtr(string); + if (chars) + return QString(reinterpret_cast(chars), length); + + QString ret(length, Qt::Uninitialized); + CFStringGetCharacters(string, CFRangeMake(0, length), reinterpret_cast(ret.data())); + return ret; +} + +CFStringRef QString::toCFString() const +{ + return CFStringCreateWithCharacters(0, reinterpret_cast(unicode()), length()); +} + +QString QString::fromNSString(const NSString *string) +{ + if (!string) + return QString(); + QString qstring; + qstring.resize([string length]); + [string getCharacters: reinterpret_cast(qstring.data()) range: NSMakeRange(0, [string length])]; + return qstring; +} + +NSString *QString::toNSString() const +{ + return [NSString stringWithCharacters: reinterpret_cast(unicode()) length: length()]; +} + +QT_END_NAMESPACE diff --git a/src/corelib/tools/tools.pri b/src/corelib/tools/tools.pri index 318f84d78e..1f8641c312 100644 --- a/src/corelib/tools/tools.pri +++ b/src/corelib/tools/tools.pri @@ -110,7 +110,8 @@ SOURCES += \ !nacl:mac: { SOURCES += tools/qelapsedtimer_mac.cpp - OBJECTIVE_SOURCES += tools/qlocale_mac.mm + OBJECTIVE_SOURCES += tools/qlocale_mac.mm \ + tools/qstring_mac.mm } else:blackberry { SOURCES += tools/qelapsedtimer_unix.cpp tools/qlocale_blackberry.cpp -- cgit v1.2.3