diff --git a/dist/changes-5.0.1 b/dist/changes-5.0.1 index cc5a6704b450c155ddc3469f9ebbaa6045ba4f79..c21590a9e14ec1702cbfbcc8056891df9074e0e3 100644 --- a/dist/changes-5.0.1 +++ b/dist/changes-5.0.1 @@ -22,6 +22,8 @@ information about a particular change. General Improvements -------------------- +-modularized Qt Script Tools documentation; did not exist previously + Third party components ---------------------- @@ -29,6 +31,7 @@ Third party components * Library * **************************************************************************** + - no changes for this version **************************************************************************** * Platform Specific Changes * @@ -40,12 +43,6 @@ Third party components **************************************************************************** -**************************************************************************** -* Tools * -**************************************************************************** - - **************************************************************************** * Plugins * **************************************************************************** - diff --git a/doc/src/examples/defaultprototypes.qdoc b/doc/src/examples/defaultprototypes.qdoc index a98b27730ac1e3e02257323a5c3ceb9cdfe0fad5..4e63b5ca455acc79a4a844ebaf8d68c7bd737791 100644 --- a/doc/src/examples/defaultprototypes.qdoc +++ b/doc/src/examples/defaultprototypes.qdoc @@ -35,7 +35,7 @@ \image defaultprototypes-example.png With QScriptEngine::setDefaultPrototype() you can specify - a QtScript object that defines a scripting interface for + a Qt Script object that defines a scripting interface for a C++ type; Qt Script operations on values of such types will then be delegated to your prototype object. In this example, a simple scripting interface for QListWidgetItem is diff --git a/examples/script/README b/examples/script/README index 60fe33ce170e17ec0a92e87c59bb06e714d885aa..9d37dec7020b41b3fcf506fcfac455ee29727978 100644 --- a/examples/script/README +++ b/examples/script/README @@ -1,4 +1,4 @@ -Qt is provided with a powerful embedded scripting environment through the QtScript +Qt is provided with a powerful embedded scripting environment through the Qt Script classes. These examples demonstrate the fundamental aspects of scripting applications diff --git a/examples/script/calculator/calculator.desktop b/examples/script/calculator/calculator.desktop index 64d6f334639370773c7bb2e55278ed4cbc8eda93..25c0820ae91f23b484a6f098d366aa9aec826efe 100644 --- a/examples/script/calculator/calculator.desktop +++ b/examples/script/calculator/calculator.desktop @@ -3,7 +3,7 @@ Encoding=UTF-8 Version=1.0 Type=Application Terminal=false -Name=QtScript Calculator +Name=Qt Script Calculator Exec=/opt/usr/bin/calculator Icon=calculator X-Window-Icon= diff --git a/examples/script/context2d/environment.cpp b/examples/script/context2d/environment.cpp index bb811d82ddb6f778bbd2c17440a1b98e7b9ddfdf..4b55a79760fa9506664d8e5a9923053901c4dce7 100644 --- a/examples/script/context2d/environment.cpp +++ b/examples/script/context2d/environment.cpp @@ -368,7 +368,7 @@ bool Environment::hasIntervalTimers() const return !m_intervalHash.isEmpty(); } -// This is used by the Context2D QtScript benchmark. +// This is used by the Context2D Qt Script benchmark. void Environment::triggerTimers() { for (int x = 0; x < 2; ++x) { diff --git a/src/3rdparty/javascriptcore/JavaScriptCore/interpreter/Interpreter.cpp b/src/3rdparty/javascriptcore/JavaScriptCore/interpreter/Interpreter.cpp index 9269fdd48b210e44fb8e79a2286021190182a850..4300a5766201bccb56ae285d65eaf6f2153ecd22 100644 --- a/src/3rdparty/javascriptcore/JavaScriptCore/interpreter/Interpreter.cpp +++ b/src/3rdparty/javascriptcore/JavaScriptCore/interpreter/Interpreter.cpp @@ -852,7 +852,7 @@ JSValue Interpreter::execute(EvalExecutable* eval, CallFrame* callFrame, JSObjec } Register* oldEnd = m_registerFile.end(); -#ifdef QT_BUILD_SCRIPT_LIB //with QtScript, we do not necesserly start from scratch +#ifdef QT_BUILD_SCRIPT_LIB //with Qt Script, we do not necesserly start from scratch Register* newEnd = oldEnd + globalRegisterOffset + codeBlock->m_numCalleeRegisters; #else Register* newEnd = m_registerFile.start() + globalRegisterOffset + codeBlock->m_numCalleeRegisters; @@ -862,7 +862,7 @@ JSValue Interpreter::execute(EvalExecutable* eval, CallFrame* callFrame, JSObjec return jsNull(); } -#ifdef QT_BUILD_SCRIPT_LIB //with QtScript, we do not necesserly start from scratch +#ifdef QT_BUILD_SCRIPT_LIB //with Qt Script, we do not necesserly start from scratch CallFrame* newCallFrame = CallFrame::create(oldEnd + globalRegisterOffset); #else CallFrame* newCallFrame = CallFrame::create(m_registerFile.start() + globalRegisterOffset); diff --git a/src/3rdparty/javascriptcore/JavaScriptCore/jit/JITStubs.cpp b/src/3rdparty/javascriptcore/JavaScriptCore/jit/JITStubs.cpp index d8027ff2ae12407c78c62e83604e2b6692721cfa..1abdf8b37654ee92b51ca183152aeef12c2c6a2b 100644 --- a/src/3rdparty/javascriptcore/JavaScriptCore/jit/JITStubs.cpp +++ b/src/3rdparty/javascriptcore/JavaScriptCore/jit/JITStubs.cpp @@ -1170,7 +1170,7 @@ DEFINE_STUB_FUNCTION(int, timeout_check) } #ifdef QT_BUILD_SCRIPT_LIB else { - // It's possible that the call to QtScript's implementation of + // It's possible that the call to Qt Script's implementation of // TimeoutChecker::didTimeOut() caused an error to be thrown. // In that case, didTimeOut() should still return false, since // we don't want the interrupted-exception to override the diff --git a/src/3rdparty/javascriptcore/JavaScriptCore/runtime/JSImmediate.h b/src/3rdparty/javascriptcore/JavaScriptCore/runtime/JSImmediate.h index 053b4c087d9270437ce4762da4d77b0f89427ab9..06548ce5f02ffd33001c37cd2fc7d6af4b213e98 100644 --- a/src/3rdparty/javascriptcore/JavaScriptCore/runtime/JSImmediate.h +++ b/src/3rdparty/javascriptcore/JavaScriptCore/runtime/JSImmediate.h @@ -135,7 +135,7 @@ namespace JSC { class JSImmediate { #ifdef QT_BUILD_SCRIPT_LIB - public: // QtScript needs isImmediate() and from() functions + public: // Qt Script needs isImmediate() and from() functions #else private: #endif diff --git a/src/3rdparty/javascriptcore/JavaScriptCore/runtime/JSObject.cpp b/src/3rdparty/javascriptcore/JavaScriptCore/runtime/JSObject.cpp index 8706b8d8aec97bb9f46a122f433b201f9d5db976..869267b0bbe7c0e95b7578c6c01f874d1770ef59 100644 --- a/src/3rdparty/javascriptcore/JavaScriptCore/runtime/JSObject.cpp +++ b/src/3rdparty/javascriptcore/JavaScriptCore/runtime/JSObject.cpp @@ -533,7 +533,7 @@ NEVER_INLINE void JSObject::fillGetterPropertySlot(PropertySlot& slot, JSValue* Structure* JSObject::createInheritorID() { #ifdef QT_BUILD_SCRIPT_LIB - // ### QtScript needs the hasOwnProperty() calls etc. for QScriptObject + // ### Qt Script needs the hasOwnProperty() calls etc. for QScriptObject m_inheritorID = Structure::create(this, TypeInfo(ObjectType, ImplementsHasInstance | JSC::OverridesHasInstance | JSC::OverridesGetOwnPropertySlot | JSC::OverridesMarkChildren | JSC::OverridesGetPropertyNames)); #else m_inheritorID = JSObject::createStructure(this); diff --git a/src/script/api/qscriptclass.cpp b/src/script/api/qscriptclass.cpp index 2fc2d0a2525c1966cafe6dd756150fb3f11c6dda..8e286c87819a81670fdca051a8d83f41e0e3f004 100644 --- a/src/script/api/qscriptclass.cpp +++ b/src/script/api/qscriptclass.cpp @@ -179,7 +179,7 @@ QScriptEngine *QScriptClass::engine() const your class, then return it in this function. See the "Making Use of Prototype-Based Inheritance" section in the - QtScript documentation for more information on how prototypes are + Qt Script documentation for more information on how prototypes are used. */ QScriptValue QScriptClass::prototype() const diff --git a/src/script/api/qscriptcontext.cpp b/src/script/api/qscriptcontext.cpp index 6ea2b34446076393c75abef0104bc34adb557046..cbded3190cc9f320d40e33ce38af2679a8b6547c 100644 --- a/src/script/api/qscriptcontext.cpp +++ b/src/script/api/qscriptcontext.cpp @@ -179,7 +179,7 @@ QScriptValue QScriptContext::throwValue(const QScriptValue &value) The error object will be initialized to contain information about the location where the error occurred; specifically, it will have properties \c{lineNumber}, \c{fileName} and \c{stack}. These - properties are described in \l {QtScript Extensions to ECMAScript}. + properties are described in \l {Qt Script Extensions to ECMAScript}. \sa throwValue(), state() */ diff --git a/src/script/api/qscriptcontextinfo.cpp b/src/script/api/qscriptcontextinfo.cpp index b838f15443753d23b9ddf825c9e146f00bcb483b..15f09667949230476b9019707be073c22034797d 100644 --- a/src/script/api/qscriptcontextinfo.cpp +++ b/src/script/api/qscriptcontextinfo.cpp @@ -159,7 +159,7 @@ QScriptContextInfoPrivate::QScriptContextInfoPrivate(const QScriptContext *conte if (returnPC && codeBlock && QScriptEnginePrivate::hasValidCodeBlockRegister(frame)) { #if ENABLE(JIT) JSC::JITCode code = codeBlock->getJITCode(); - unsigned jitOffset = code.offsetOf(JSC::ReturnAddressPtr(returnPC).value()); + uintptr_t jitOffset = reinterpret_cast<uintptr_t>(JSC::ReturnAddressPtr(returnPC).value()) - reinterpret_cast<uintptr_t>(code.addressForCall().executableAddress()); // We can only use the JIT code offset if it's smaller than the JIT size; // otherwise calling getBytecodeIndex() is meaningless. if (jitOffset < code.size()) { diff --git a/src/script/api/qscriptengine.cpp b/src/script/api/qscriptengine.cpp index 0b09f43cd312c9f7cfaf0c42559423b3e84b16df..cefcd509b9b86536631e626f133735d3e390c194 100644 --- a/src/script/api/qscriptengine.cpp +++ b/src/script/api/qscriptengine.cpp @@ -98,7 +98,7 @@ QT_BEGIN_NAMESPACE \ingroup script \mainclass - See the \l{QtScript} documentation for information about the Qt Script language, + See the \l{Qt Script} documentation for information about the Qt Script language, and how to get started with scripting your C++ application. \section1 Evaluating Scripts @@ -1262,7 +1262,7 @@ void QScriptEnginePrivate::setContextFlags(JSC::ExecState *exec, uint flags) // This function is called by JSC after all objects reachable by JSC itself // have been processed (see JSC::Heap::markRoots()). -// Here we should mark additional objects managed by QtScript. +// Here we should mark additional objects managed by Qt Script. void QScriptEnginePrivate::mark(JSC::MarkStack& markStack) { Q_Q(QScriptEngine); @@ -2183,7 +2183,7 @@ QScriptValue QScriptEngine::newFunction(QScriptEngine::FunctionSignature fun, #ifndef QT_NO_REGEXP /*! - Creates a QtScript object of class RegExp with the given + Creates a Qt Script object of class RegExp with the given \a regexp. \sa QScriptValue::toRegExp() @@ -2198,7 +2198,7 @@ QScriptValue QScriptEngine::newRegExp(const QRegExp ®exp) #endif // QT_NO_REGEXP /*! - Creates a QtScript object holding the given variant \a value. + Creates a Qt Script object holding the given variant \a value. If a default prototype has been registered with the meta type id of \a value, then the prototype of the created object will be that @@ -2251,13 +2251,13 @@ QScriptValue QScriptEngine::newVariant(const QScriptValue &object, #ifndef QT_NO_QOBJECT /*! - Creates a QtScript object that wraps the given QObject \a + Creates a Qt Script object that wraps the given QObject \a object, using the given \a ownership. The given \a options control various aspects of the interaction with the resulting script object. Signals and slots, properties and children of \a object are available as properties of the created QScriptValue. For more - information, see the \l{QtScript} documentation. + information, see the \l{Qt Script} documentation. If \a object is a null pointer, this function returns nullValue(). @@ -2265,8 +2265,8 @@ QScriptValue QScriptEngine::newVariant(const QScriptValue &object, (or its superclass, recursively), the prototype of the new script object will be set to be that default prototype. - If the given \a object is deleted outside of QtScript's control, any - attempt to access the deleted QObject's members through the QtScript + If the given \a object is deleted outside of Qt Script's control, any + attempt to access the deleted QObject's members through the Qt Script wrapper object (either by script code or C++) will result in a script exception. @@ -2337,7 +2337,7 @@ QScriptValue QScriptEngine::newQObject(const QScriptValue &scriptObject, #endif // QT_NO_QOBJECT /*! - Creates a QtScript object of class Object. + Creates a Qt Script object of class Object. The prototype of the created object will be the Object prototype object. @@ -2355,7 +2355,7 @@ QScriptValue QScriptEngine::newObject() \since 4.4 \overload - Creates a QtScript Object of the given class, \a scriptClass. + Creates a Qt Script Object of the given class, \a scriptClass. The prototype of the created object will be the Object prototype object. @@ -2467,7 +2467,7 @@ QScriptValue QScriptEngine::newFunction(QScriptEngine::FunctionWithArgSignature } /*! - Creates a QtScript object of class Array with the given \a length. + Creates a Qt Script object of class Array with the given \a length. \sa newObject() */ @@ -2479,7 +2479,7 @@ QScriptValue QScriptEngine::newArray(uint length) } /*! - Creates a QtScript object of class RegExp with the given + Creates a Qt Script object of class RegExp with the given \a pattern and \a flags. The legal flags are 'g' (global), 'i' (ignore case), and 'm' @@ -2493,7 +2493,7 @@ QScriptValue QScriptEngine::newRegExp(const QString &pattern, const QString &fla } /*! - Creates a QtScript object of class Date with the given + Creates a Qt Script object of class Date with the given \a value (the number of milliseconds since 01 January 1970, UTC). */ @@ -2505,7 +2505,7 @@ QScriptValue QScriptEngine::newDate(qsreal value) } /*! - Creates a QtScript object of class Date from the given \a value. + Creates a Qt Script object of class Date from the given \a value. \sa QScriptValue::toDateTime() */ @@ -2518,7 +2518,7 @@ QScriptValue QScriptEngine::newDate(const QDateTime &value) #ifndef QT_NO_QOBJECT /*! - Creates a QtScript object that represents a QObject class, using the + Creates a Qt Script object that represents a QObject class, using the the given \a metaObject and constructor \a ctor. Enums of \a metaObject (declared with Q_ENUMS) are available as @@ -2591,7 +2591,7 @@ QScriptValue QScriptEngine::newQMetaObject( valid, and so on. A typical usage of canEvaluate() is to implement an interactive - interpreter for QtScript. The user is repeatedly queried for + interpreter for Qt Script. The user is repeatedly queried for individual lines of code; the lines are concatened internally, and only when canEvaluate() returns true for the resulting program is it passed to evaluate(). @@ -2599,7 +2599,7 @@ QScriptValue QScriptEngine::newQMetaObject( The following are some examples to illustrate the behavior of canEvaluate(). (Note that all example inputs are assumed to have an explicit newline as their last character, since otherwise the - QtScript parser would automatically insert a semi-colon character at + Qt Script parser would automatically insert a semi-colon character at the end of the input, and this could cause canEvaluate() to produce different results.) @@ -2620,7 +2620,7 @@ QScriptValue QScriptEngine::newQMetaObject( Given the input \snippet code/src_script_qscriptengine.cpp 17 canEvaluate() will return true, even though the code is clearly not - syntactically valid QtScript code. evaluate() will throw a + syntactically valid Qt Script code. evaluate() will throw a SyntaxError when this code is evaluated. Given the input @@ -3607,7 +3607,7 @@ void QScriptEngine::installTranslatorFunctions(const QScriptValue &object) once; subsequent calls to importExtension() with the same extension name will do nothing and return undefinedValue(). - \sa availableExtensions(), QScriptExtensionPlugin, {Creating QtScript Extensions} + \sa availableExtensions(), QScriptExtensionPlugin, {Creating Qt Script Extensions} */ QScriptValue QScriptEngine::importExtension(const QString &extension) { @@ -3876,10 +3876,10 @@ QStringList QScriptEngine::importedExtensions() const Note that the template type \c{T} must be known to QMetaType. - See \l{Conversion Between QtScript and C++ Types} for a + See \l{Conversion Between Qt Script and C++ Types} for a description of the built-in type conversion provided by - QtScript. By default, the types that are not specially handled by - QtScript are represented as QVariants (e.g. the \a value is passed + Qt Script. By default, the types that are not specially handled by + Qt Script are represented as QVariants (e.g. the \a value is passed to newVariant()); you can change this behavior by installing your own type conversion functions with qScriptRegisterMetaType(). @@ -3892,9 +3892,9 @@ QStringList QScriptEngine::importedExtensions() const Note that \c{T} must be known to QMetaType. - See \l{Conversion Between QtScript and C++ Types} for a + See \l{Conversion Between Qt Script and C++ Types} for a description of the built-in type conversion provided by - QtScript. + Qt Script. \sa toScriptValue(), qScriptRegisterMetaType() */ @@ -3947,7 +3947,7 @@ QStringList QScriptEngine::importedExtensions() const Additionally, the type of each element in the sequence should be suitable for conversion to a QScriptValue. See - \l{Conversion Between QtScript and C++ Types} for more information + \l{Conversion Between Qt Script and C++ Types} for more information about the restrictions on types that can be used with QScriptValue. \sa QScriptEngine::fromScriptValue() @@ -3967,7 +3967,7 @@ QStringList QScriptEngine::importedExtensions() const Additionally, the type of each element in the sequence must be suitable for conversion to a C++ type from a QScriptValue. See - \l{Conversion Between QtScript and C++ Types} for more information + \l{Conversion Between Qt Script and C++ Types} for more information about the restrictions on types that can be used with QScriptValue. diff --git a/src/script/api/qscriptextensionplugin.cpp b/src/script/api/qscriptextensionplugin.cpp index 425c15c08c2ea3fa4838c06fed2386c895089498..a3e6fe72c25491142496bcffeeaa6c465aac2718 100644 --- a/src/script/api/qscriptextensionplugin.cpp +++ b/src/script/api/qscriptextensionplugin.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE functions, and exporting the class using the Q_PLUGIN_METADATA() macro. See \l {How to Create Qt Plugins} for details. - \sa QScriptEngine::importExtension(), {Creating QtScript Extensions} + \sa QScriptEngine::importExtension(), {Creating Qt Script Extensions} */ /*! diff --git a/src/script/api/qscriptstring.cpp b/src/script/api/qscriptstring.cpp index aceda42241b62777c21d5fc13e3bb927e8d2986b..34767ac106c4b8f4e6ae0924a9342d3d5562799d 100644 --- a/src/script/api/qscriptstring.cpp +++ b/src/script/api/qscriptstring.cpp @@ -156,7 +156,7 @@ bool QScriptString::operator!=(const QScriptString &other) const /*! \since 4.6 - Attempts to convert this QScriptString to a QtScript array index, + Attempts to convert this QScriptString to a Qt Script array index, and returns the result. If a conversion error occurs, *\a{ok} is set to false; otherwise diff --git a/src/script/api/qscriptvalue.cpp b/src/script/api/qscriptvalue.cpp index cfffea211b378caaa9ec18be75e1f431cb1a253d..3e307a26e92935478d3e60014308decf78ed8ef6 100644 --- a/src/script/api/qscriptvalue.cpp +++ b/src/script/api/qscriptvalue.cpp @@ -94,7 +94,7 @@ not have the requested property. Note that this prototype-based lookup is not performed by setProperty(); setProperty() will always create the property in the script object itself. For more - information, see the \l{QtScript} documentation. + information, see the \l{Qt Script} documentation. Function objects (objects for which isFunction() returns true) can be invoked by calling call(). Constructor functions can be used to @@ -2014,7 +2014,7 @@ bool QScriptValue::isValid() const /*! \since 4.4 - Returns the internal data of this QScriptValue object. QtScript uses + Returns the internal data of this QScriptValue object. Qt Script uses this property to store the primitive value of Date, String, Number and Boolean objects. For other types of object, custom data may be stored using setData(). diff --git a/src/script/bridge/qscriptqobject.cpp b/src/script/bridge/qscriptqobject.cpp index a8076bbcb9c7011e82e1b30128e69dae3a46a1fe..1df02647bb22a047fd0b3aeab84ea286270c294d 100644 --- a/src/script/bridge/qscriptqobject.cpp +++ b/src/script/bridge/qscriptqobject.cpp @@ -2317,7 +2317,7 @@ int QObjectData::markConnections(JSC::MarkStack& markStack) // This function assumes all objects reachable elsewhere in the JS environment // (stack, heap) have been marked already (see QScriptEnginePrivate::mark()). -// This determines whether any of QtScript's internal QObject wrappers are only +// This determines whether any of Qt Script's internal QObject wrappers are only // weakly referenced and can be discarded. void QObjectData::markWrappers(JSC::MarkStack& markStack) { diff --git a/src/script/doc/qtscript.qdocconf b/src/script/doc/qtscript.qdocconf index 382e09dbb138fedaf3260c3aa9015cb0bc962c5d..7f8d37c48352d092f1275d355cc0456933b0b105 100644 --- a/src/script/doc/qtscript.qdocconf +++ b/src/script/doc/qtscript.qdocconf @@ -16,7 +16,7 @@ headerdirs += .. imagedirs += images sourcedirs += .. -depends += qtcore qtlinguist +depends += qtcore qtlinguist qtscripttools # The following parameters are for creating a qhp file, the qhelpgenerator # program can convert the qhp file into a qch file which can be opened in @@ -32,7 +32,7 @@ qhp.qtscript.file = qtscript.qhp # Namespace for the output file. This namespace is used to distinguish between # different documentation files in Creator/Assistant. -qhp.qtscript.namespace = org.qt-project.qtscript.500 +qhp.qtscript.namespace = org.qt-project.qtscript.501 # Title for the package, will be the main title for the package in # Assistant/Creator. diff --git a/src/script/doc/snippets/code/doc_src_qtscript.cpp b/src/script/doc/snippets/code/doc_src_qtscript.cpp index bb584002f13eb7e7c4532f5c3ede6b52ea961899..6cbb5ded05e4d31513209b1c359716d8fae57125 100644 --- a/src/script/doc/snippets/code/doc_src_qtscript.cpp +++ b/src/script/doc/snippets/code/doc_src_qtscript.cpp @@ -65,7 +65,7 @@ public: void aNonScriptableFunction(); -public slots: // these functions (slots) will be available in QtScript +public slots: // these functions (slots) will be available in Qt Script void calculate( ... ); void setEnabled( bool enabled ); bool isEnabled() const; @@ -103,7 +103,7 @@ public: void aNonScriptableFunction(); -public slots: // these functions (slots) will be available in QtScript +public slots: // these functions (slots) will be available in Qt Script void calculate( ... ); void setEnabled( bool enabled ); bool isEnabled() const; @@ -132,7 +132,7 @@ public: void aNonScriptableFunction(); -public slots: // these functions (slots) will be available in QtScript +public slots: // these functions (slots) will be available in Qt Script void calculate( ... ); void setEnabled( bool enabled ); bool isEnabled() const; diff --git a/src/script/doc/src/ecmascript.qdoc b/src/script/doc/src/ecmascript.qdoc index c4b879789cdd5b3159388a6e9526898cff58af19..84116c7262d5cb4fae0f0a298e4dd43a368a7fa6 100644 --- a/src/script/doc/src/ecmascript.qdoc +++ b/src/script/doc/src/ecmascript.qdoc @@ -28,10 +28,10 @@ /*! \page ecmascript.html \title ECMAScript Reference - \brief A list of objects, functions and properties supported by QtScript. + \brief A list of objects, functions and properties supported by Qt Script. This reference contains a list of built-in objects, functions and - properties supported by QtScript. For a detailed description, see + properties supported by Qt Script. For a detailed description, see the \l{ECMA-262} specification. \tableofcontents diff --git a/src/script/doc/src/qtscript-index.qdoc b/src/script/doc/src/qtscript-index.qdoc index 05005e98fe09415b9984c48b51e3c75f2c62c44e..ff4013bf8e03410e294f4e2b1bf8c72821c0b941 100644 --- a/src/script/doc/src/qtscript-index.qdoc +++ b/src/script/doc/src/qtscript-index.qdoc @@ -182,7 +182,7 @@ When the argument is a QObject slot, the argument types of the signal and slot do not necessarily have to be compatible; - QtScript will, if necessary, perform conversion of the signal + Qt Script will, if necessary, perform conversion of the signal arguments to match the argument types of the slot. To disconnect from a signal, you invoke the signal's @@ -254,7 +254,7 @@ \section3 Overloaded Signals and Slots - When a signal or slot is overloaded, QtScript will attempt to + When a signal or slot is overloaded, Qt Script will attempt to pick the right overload based on the actual types of the QScriptValue arguments involved in the function invocation. For example, if your class has slots \c{myOverloadedSlot(int)} and \c{myOverloadedSlot(QString)}, the following @@ -268,7 +268,7 @@ \snippet code/doc_src_qtscript.js 12 - If the overloads have different number of arguments, QtScript will + If the overloads have different number of arguments, Qt Script will pick the overload with the argument count that best matches the actual number of arguments passed to the slot. @@ -279,7 +279,7 @@ \section2 Accessing Properties The properties of the QObject are available as properties - of the corresponding QtScript object. When you manipulate + of the corresponding Qt Script object. When you manipulate a property in script code, the C++ get/set method for that property will automatically be invoked. For example, if your C++ class has a property declared as follows: @@ -294,7 +294,7 @@ Every named child of the QObject (that is, for which QObject::objectName() is not an empty string) is by default available as - a property of the QtScript wrapper object. For example, + a property of the Qt Script wrapper object. For example, if you have a QDialog with a child widget whose \c{objectName} property is \c{"okButton"}, you can access this object in script code through the expression @@ -366,7 +366,7 @@ With QScriptEngine::AutoOwnership the ownership is based on whether the QObject has a parent or not. - If the QtScript garbage collector finds that the QObject is no + If the Qt Script garbage collector finds that the QObject is no longer referenced within the script environment, the QObject will be deleted \e{only} if it does not have a parent. @@ -390,7 +390,7 @@ QScriptEngine::newQObject() can take a third argument which allows you to control various aspects of the access to the QObject through - the QtScript wrapper object it returns. + the Qt Script wrapper object it returns. QScriptEngine::ExcludeChildObjects specifies that child objects of the QObject should not appear as properties of the wrapper object. @@ -405,7 +405,7 @@ QScriptEngine::AutoCreateDynamicProperties specifies that properties that don't already exist in the QObject should be created as dynamic - properties of the QObject, rather than as properties of the QtScript + properties of the QObject, rather than as properties of the Qt Script wrapper object. If you want new properties to truly become persistent properties of the QObject, rather than properties that are destroyed along with the wrapper object (and that aren't shared if the QObject @@ -442,14 +442,14 @@ properties of the QMetaObject wrapper object that can be created with QScriptEngine::newQMetaObject(). - \section1 Conversion Between QtScript and C++ Types + \section1 Conversion Between Qt Script and C++ Types - QtScript will perform type conversion when a value needs to be + Qt Script will perform type conversion when a value needs to be converted from the script side to the C++ side or vice versa; for instance, when a C++ signal triggers a script function, when you access a QObject property in script code, or when you call QScriptEngine::toScriptValue() or - QScriptEngine::fromScriptValue() in C++. QtScript provides default + QScriptEngine::fromScriptValue() in C++. Qt Script provides default conversion operations for many of the built-in Qt types. You can change the conversion operation for a type (including your custom C++ types) by registering your own conversion functions with @@ -511,7 +511,7 @@ the result is an empty QList<int>. \endtable - Additionally, QtScript will handle the following cases: + Additionally, Qt Script will handle the following cases: \list \li If the QScriptValue is a QObject and the target type name ends with @@ -592,7 +592,7 @@ This section explains how to implement application objects and provides the necessary technical background material. - \section2 Making a C++ object available to Scripts Written in QtScript + \section2 Making a C++ object available to Scripts Written in Qt Script Making C++ classes and objects available to a scripting language is not trivial because scripting languages tend to be more dynamic than @@ -608,7 +608,7 @@ (Meta-Object Compiler). Classes that wish to take advantage of the meta-object facilities are either subclasses of QObject, or use the \c{Q_OBJECT} macro. Qt has used this approach for many years and it has - proven to be solid and reliable. QtScript uses this meta-object + proven to be solid and reliable. Qt Script uses this meta-object technology to provide scripters with dynamic access to C++ classes and objects. @@ -619,14 +619,14 @@ how to implement application objects. However, this knowledge is not essential in the simplest cases. - To make an object available in QtScript, it must derive from + To make an object available in Qt Script, it must derive from QObject. All classes which derive from QObject can be introspected and can provide the information needed by the scripting engine at run-time; e.g., class name, functions, signatures. Because we obtain the information we need about classes dynamically at run-time, there is no need to write wrappers for QObject derived classes. - \section2 Making C++ Class Member Functions Available in QtScript + \section2 Making C++ Class Member Functions Available in Qt Script The meta-object system also makes information about signals and slots dynamically available at run-time. By default, for QObject subclasses, @@ -634,7 +634,7 @@ This is very convenient because, in practice, we normally only want to make specially chosen functions available to scripters. When you create a QObject subclass, make sure that the functions you want to expose to - QtScript are public slots. + Qt Script are public slots. For example, the following class definition enables scripting only for certain functions: @@ -642,8 +642,8 @@ \snippet code/doc_src_qtscript.cpp 19 In the example above, aNonScriptableFunction() is not declared as a - slot, so it will not be available in QtScript. The other three - functions will automatically be made available in QtScript because + slot, so it will not be available in Qt Script. The other three + functions will automatically be made available in Qt Script because they are declared in the \c{public slots} section of the class definition. @@ -653,7 +653,7 @@ \snippet code/doc_src_qtscript.cpp 20 Once declared with \c{Q_INVOKABLE}, the method can be invoked from - QtScript code just as if it were a slot. Although such a method is + Qt Script code just as if it were a slot. Although such a method is not a slot, you can still specify it as the target function in a call to \c{connect()} in script code; \c{connect()} accepts both native and non-native functions as targets. @@ -664,10 +664,10 @@ to supply conversion functions. This is done using the qScriptRegisterMetaType() function. - \section2 Making C++ Class Properties Available in QtScript + \section2 Making C++ Class Properties Available in Qt Script In the previous example, if we wanted to get or set a property using - QtScript we would have to write code like the following: + Qt Script we would have to write code like the following: \snippet code/doc_src_qtscript.js 21 @@ -691,7 +691,7 @@ the names of the setter and getter functions as arguments. If you don't want a property of your class to be accessible in - QtScript, you set the \c{SCRIPTABLE} attribute to \c false when + Qt Script, you set the \c{SCRIPTABLE} attribute to \c false when declaring the property; by default, the \c{SCRIPTABLE} attribute is \c true. For example: @@ -705,10 +705,10 @@ is called. This connection is established using the QObject::connect() function. - The signals and slots mechanism is also available to QtScript + The signals and slots mechanism is also available to Qt Script programmers. The code to declare a signal in C++ is the same, regardless of whether the signal will be connected to a slot in C++ - or in QtScript. + or in Qt Script. \snippet code/doc_src_qtscript.cpp 25 @@ -722,9 +722,9 @@ \section2 Design of Application Objects The previous section described how to implement C++ objects which - can be used in QtScript. Application objects are the same kind of + can be used in Qt Script. Application objects are the same kind of objects, and they make your application's functionality available to - QtScript scripters. Since the C++ application is already written + Qt Script scripters. Since the C++ application is already written in Qt, many objects are already QObjects. The easiest approach would be to simply add all these QObjects as application objects to the scripting engine. For small applications this might be sufficient, @@ -747,7 +747,7 @@ If you have a slot that returns a QObject pointer, you should note that, by default, Qt Script only handles conversion of the types QObject* and QWidget*. This means that if your slot is declared - with a signature like "MyObject* getMyObject()", QtScript doesn't + with a signature like "MyObject* getMyObject()", Qt Script doesn't automatically know that MyObject* should be handled in the same way as QObject* and QWidget*. The simplest way to solve this is to only use QObject* and QWidget* in the method signatures of your scripting @@ -1285,10 +1285,10 @@ In ECMAScript, inheritance is based on the concept of \e{shared prototype objects}; this is quite different from the class-based - inheritance familiar to C++ programmers. With QtScript, you can + inheritance familiar to C++ programmers. With Qt Script, you can associate a custom prototype object with a C++ type using QScriptEngine::setDefaultPrototype(); this is the key to providing - a script interface to that type. Since the QtScript module is built + a script interface to that type. Since the Qt Script module is built on top of Qt's meta-type system, this can be done for any C++ type. You might be wondering when exactly you would need to use this @@ -1314,25 +1314,25 @@ This section explains the underlying concepts of prototype-based inheritance. Once these concepts are understood, the associated - practices can be applied throughout the QtScript API in order to + practices can be applied throughout the Qt Script API in order to create well-behaved, consistent bindings to C++ that will fit nicely into the ECMAScript universe. - When experimenting with QtScript objects and inheritance, it can be + When experimenting with Qt Script objects and inheritance, it can be helpful to use the interactive interpreter included with the \l{Qt Script Examples}, located in \c{examples/script/qscript}. \section2 Prototype Objects and Shared Properties - The purpose of a QtScript \e{prototype object} is to define - behavior that should be shared by a set of other QtScript + The purpose of a Qt Script \e{prototype object} is to define + behavior that should be shared by a set of other Qt Script objects. We say that objects which share the same prototype object belong to the same \e{class} (again, on the technical side this should not to be confused with the class constructs of languages like C++ and Java; ECMAScript has no such construct). The basic prototype-based inheritance mechanism works as follows: Each - QtScript object has an internal link to another object, its + Qt Script object has an internal link to another object, its \e{prototype}. When a property is looked up in an object, and the object itself does not have the property, the property is looked up in the prototype object instead; if the prototype has the property, @@ -1365,7 +1365,7 @@ \section2 Defining Classes in a Prototype-Based Universe - In QtScript, a class is not defined explicitly; there is no + In Qt Script, a class is not defined explicitly; there is no \c{class} keyword. Instead, you define a new class in two steps: \list 1 @@ -1393,10 +1393,10 @@ Next, you want to set up \c{Person.prototype} as your prototype object; i.e., define the interface that should be common to all - \c{Person} objects. QtScript automatically creates a default + \c{Person} objects. Qt Script automatically creates a default prototype object (by the expression \c{new Object()}) for every script function; you can add properties to this object, or you can - assign your own custom object. (Generally speaking, any QtScript + assign your own custom object. (Generally speaking, any Qt Script object can act as prototype for any other object.) Here's an example of how you might want to override the @@ -1445,7 +1445,7 @@ same as that of \c{Person} objects, but with \c{Employee.prototype} added to the front of the chain. - \section2 Prototype-Based Programming with the QtScript C++ API + \section2 Prototype-Based Programming with the Qt Script C++ API You can use QScriptEngine::newFunction() to wrap native functions. When implementing a constructor function, @@ -1472,7 +1472,7 @@ You associate a prototype object with a C++ type by calling QScriptEngine::setDefaultPrototype(). Once this mapping is - established, QtScript will automatically assign the correct + established, Qt Script will automatically assign the correct prototype when a value of such a type is wrapped in a QScriptValue; either when you explicitly call QScriptEngine::toScriptValue(), or when a value of such a type is returned from a C++ slot and @@ -1637,7 +1637,7 @@ doesn't provide any debugging-specific functionality (e.g. setting breakpoints), but it is the basis of tools that do. - The QScriptEngineDebugger class introduced in Qt 4.5 provides a + The \l{Qt Script Tools} module provides a \l{Qt Script Debugger Manual}{Qt Script debugger} that can be embedded into your application. @@ -1661,7 +1661,7 @@ of the script function itself, so that it can be retrieved when the function is called. - \section1 Using QtScript Extensions + \section1 Using Qt Script Extensions The QScriptEngine::importExtension() function can be used to load plugins into a script engine. Plugins typically add some extra functionality to @@ -1670,7 +1670,7 @@ scripts. There are currently no script plugins shipped with Qt. If you are implementing some Qt Script functionality that you want other - Qt application developers to be able to use, \l{Creating QtScript Extensions} + Qt application developers to be able to use, \l{Creating Qt Script Extensions} {developing an extension} (e.g. by subclassing QScriptExtensionPlugin) is worth looking into. @@ -1798,11 +1798,11 @@ \section1 ECMAScript Compatibility - QtScript implements all the built-in objects and properties defined + Qt Script implements all the built-in objects and properties defined in the \l{ECMA-262} standard; see the \l{ECMAScript Reference}{ECMAScript reference} for an overview. - \section1 QtScript Extensions to ECMAScript + \section1 Qt Script Extensions to ECMAScript \list \li \c{__proto__} \br @@ -1876,4 +1876,3 @@ \brief Classes that add scripting capabilities to Qt applications. */ - diff --git a/src/script/doc/src/qtscript-module.qdoc b/src/script/doc/src/qtscript-module.qdoc index 675b759b19063582e431edef6e741dfd9c3560f5..5f19fd96570f3534b015cf1664e0d7c6d5981f0f 100644 --- a/src/script/doc/src/qtscript-module.qdoc +++ b/src/script/doc/src/qtscript-module.qdoc @@ -31,10 +31,10 @@ \since 4.3 \ingroup modules - \brief The QtScript module provides classes for making Qt applications scriptable. + \brief The Qt Script module provides classes for making Qt applications scriptable. - The QtScript module only provides core scripting facilities; the - QtScriptTools module provides additional Qt Script-related + The Qt Script module only provides core scripting facilities; the + Qt Script Tools module provides additional Qt Script-related components that application developers may find useful. This module is mainly provided for backwards compatibility reasons @@ -52,13 +52,13 @@ \snippet code/doc_src_qtscript.pro 1 For detailed information on how to make your application - scriptable with QtScript, see \l{Making Applications + scriptable with Qt Script, see \l{Making Applications Scriptable}. \section1 License Information Qt Commercial Edition licensees that wish to distribute applications that - use the QtScript module need to be aware of their obligations under the + use the Qt Script module need to be aware of their obligations under the GNU Library General Public License (LGPL). Developers using the Open Source Edition can choose to redistribute @@ -70,7 +70,7 @@ sufficient for most use cases and is not dependent on LGPL code. \legalese - QtScript is licensed under the GNU Library General Public License. + Qt Script is licensed under the GNU Library General Public License. Individual contributor names and copyright dates can be found inline in the code. diff --git a/src/script/doc/src/qtscriptdebugger-manual.qdoc b/src/script/doc/src/qtscriptdebugger-manual.qdoc index fbad2edff1f90cfcfe66e244704351e5438303fd..7de9d6f2648f69ec7f5a6cc654210493822bf289 100644 --- a/src/script/doc/src/qtscriptdebugger-manual.qdoc +++ b/src/script/doc/src/qtscriptdebugger-manual.qdoc @@ -30,8 +30,8 @@ \title Qt Script Debugger Manual \brief A manual describing how to use the Qt Script debugger. - The Qt Script debugger is a tool for debugging script execution in - Qt applications that use Qt Script. Application developers can embed + The \l{Qt Script Tools} module provides a debugger for script execution in + Qt applications that use \l{Qt Script}. Application developers can embed the debugger into their application through the QScriptEngineDebugger class. This manual describes how to use the debugger. We assume that the reader is somewhat familiar with @@ -291,7 +291,7 @@ previously. \section3 ignore <breakpoint-id> <count> - + Sets the ignore-count of a breakpoint, i.e., the breakpoint will not stop the program execution unless it have been reached \c count times. This can, for instance, be useful in loops to stop at a @@ -356,7 +356,7 @@ \section3 eval <program> - Evaluates a program. + Evaluates a program. \section3 finish @@ -402,7 +402,7 @@ Selects the previous (inner) stack frame. The execution will not return to this frame, but you will get access to its local - variables. + variables. \section3 frame <index> diff --git a/src/script/doc/src/qtscriptextensions.qdoc b/src/script/doc/src/qtscriptextensions.qdoc index 2a7c27e1e60516a46cdc7be26b48e3d326f561bc..294513f7f1d1a3915bce5308ad9d3047b3d8eecf 100644 --- a/src/script/doc/src/qtscriptextensions.qdoc +++ b/src/script/doc/src/qtscriptextensions.qdoc @@ -27,10 +27,10 @@ /*! \page qtscriptextensions.html - \title Creating QtScript Extensions - \brief A guide to creating and using QtScript extensions. + \title Creating Qt Script Extensions + \brief A guide to creating and using Qt Script extensions. - QtScript extensions can make additional functionality available to scripts + Qt Script extensions can make additional functionality available to scripts evaluated by a QScriptEngine. Extensions are imported by calling the QScriptEngine::importExtension() function. diff --git a/src/scripttools/debugging/qscriptenginedebugger.cpp b/src/scripttools/debugging/qscriptenginedebugger.cpp index f612ec4b37f74f8e7acff9ae10bc8eff6922e8b9..0a4ae85511c60b406979799202eb65085766de02 100644 --- a/src/scripttools/debugging/qscriptenginedebugger.cpp +++ b/src/scripttools/debugging/qscriptenginedebugger.cpp @@ -70,12 +70,12 @@ public: }; /*! - \since 4.5 - \class QScriptEngineDebugger + \since 4.5 + \class QScriptEngineDebugger + \inmodule QtScriptTools + \brief The QScriptEngineDebugger class provides a QScriptEngine debugger. - \brief The QScriptEngineDebugger class provides a QScriptEngine debugger. - - \ingroup script + \ingroup script The QScriptEngineDebugger class provides a debugger that can be @@ -86,7 +86,7 @@ public: To attach the debugger to a script engine, call the attachTo() function. - \snippet code/src.scripttools.qscriptenginedebugger.cpp 0 + \snippet src.scripttools.qscriptenginedebugger.cpp 0 Once the debugger has been attached to a script engine, you can proceed to evaluate scripts as usual, e.g. by calling @@ -140,7 +140,7 @@ public: the function call does not return until the user has finished interacting with the debugger. - \snippet code/src.scripttools.qscriptenginedebugger.cpp 1 + \snippet src.scripttools.qscriptenginedebugger.cpp 1 When the Qt Script debugger is running, the C++ application itself is not "frozen". This means that it is possible that more scripts @@ -166,7 +166,7 @@ public: currently not supported. If you need to debug painting-related script code, that code should be evaluated outside of the C++ paintEvent(), e.g. by rendering to an image, like the Context2D and - Tetrix QtScript examples do. This will make the code safe for + Tetrix Qt Script examples do. This will make the code safe for debugging. The debugger adds some special properties to the script engine: diff --git a/src/scripttools/doc/qtscripttools.qdocconf b/src/scripttools/doc/qtscripttools.qdocconf new file mode 100644 index 0000000000000000000000000000000000000000..362fc61348ff84d4e63c1bf6121c377bc22a53c0 --- /dev/null +++ b/src/scripttools/doc/qtscripttools.qdocconf @@ -0,0 +1,47 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +# Name of the project which must match the outputdir. Determines the .index file +project = qtscripttools + +# Directories in which to search for files to document and images. +# By default set to the root directory of the project for sources +# and headers and qdoc will therefore generate output for each file. +# Images should be placed in <rootdir>/dic/images and examples in +# <rootdir>/examples. +# Paths are relative to the location of this file. +exampledirs += ../../../examples \ + snippets + +headerdirs += .. +imagedirs += images +sourcedirs += .. + +depends += qtcore qtlinguist qtscript + +# The following parameters are for creating a qhp file, the qhelpgenerator +# program can convert the qhp file into a qch file which can be opened in +# Qt Assistant and/or Qt Creator. + +# Defines the name of the project. You cannot use operators (+, =, -) in +# the name. Properties for this project are set using a qhp.<projectname>.property +# format. +qhp.projects = qtscripttools + +# Sets the name of the output qhp file. +qhp.qtscripttools.file = qtscripttools.qhp + +# Namespace for the output file. This namespace is used to distinguish between +# different documentation files in Creator/Assistant. +qhp.qtscripttools.namespace = org.qt-project.qtscripttools.501 + +# Title for the package, will be the main title for the package in +# Assistant/Creator. +qhp.qtscripttools.indexTitle = Qt Script + +# Only update the name of the project for the next variables. +qhp.qtscripttools.virtualFolder = qtscripttools +qhp.qtscripttools.subprojects = classes +qhp.qtscripttools.subprojects.classes.title = C++ Classes +qhp.qtscripttools.subprojects.classes.indexTitle = Qt Script Tools C++ Classes +qhp.qtscripttools.subprojects.classes.selectors = class fake:headerfile +qhp.qtscripttools.subprojects.classes.sortPages = true diff --git a/src/scripttools/doc/snippets/doc_src_qtscripttools.cpp b/src/scripttools/doc/snippets/doc_src_qtscripttools.cpp new file mode 100644 index 0000000000000000000000000000000000000000..d385f6960637280df4a3369005c622e1982920f5 --- /dev/null +++ b/src/scripttools/doc/snippets/doc_src_qtscripttools.cpp @@ -0,0 +1,43 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//! [0] +#include <QtScriptTools> +//! [0] diff --git a/src/scripttools/doc/snippets/doc_src_qtscripttools.pro b/src/scripttools/doc/snippets/doc_src_qtscripttools.pro new file mode 100644 index 0000000000000000000000000000000000000000..6680f5f36dcae141c95aca61fbcd5fdd078bafde --- /dev/null +++ b/src/scripttools/doc/snippets/doc_src_qtscripttools.pro @@ -0,0 +1,43 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** You may use this file under the terms of the BSD license as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names +** of its contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#! [1] +QT += scripttools +#! [1] diff --git a/doc/src/snippets/scriptdebugger.cpp b/src/scripttools/doc/snippets/scriptdebugger.cpp similarity index 100% rename from doc/src/snippets/scriptdebugger.cpp rename to src/scripttools/doc/snippets/scriptdebugger.cpp diff --git a/doc/src/snippets/code/src.scripttools.qscriptenginedebugger.cpp b/src/scripttools/doc/snippets/src.scripttools.qscriptenginedebugger.cpp similarity index 100% rename from doc/src/snippets/code/src.scripttools.qscriptenginedebugger.cpp rename to src/scripttools/doc/snippets/src.scripttools.qscriptenginedebugger.cpp diff --git a/src/scripttools/doc/src/qtscripttools-index.qdoc b/src/scripttools/doc/src/qtscripttools-index.qdoc new file mode 100644 index 0000000000000000000000000000000000000000..1817753f5ae79e3c473f3b1523756403cccefa4e --- /dev/null +++ b/src/scripttools/doc/src/qtscripttools-index.qdoc @@ -0,0 +1,60 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** 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 Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtscripttools-index.html + \title Qt Script Tools + \brief Provides a debugger for applications that use Qt Script + + The Qt Script Tools module provides a debugger that can be embedded into Qt + applications that use \l{Qt Script}. The debugger enables the application + user to inspect the state of the script environment and control script + execution. + + \section1 Configuring the Build Process + + To include the definitions of the module's classes, use the + following directive: + + \snippet doc_src_qtscripttools.cpp 0 + + To link against the module, add this line to your \l qmake \c .pro file: + + \snippet doc_src_qtscripttools.pro 1 + + \section1 Related Information + + \section2 Guides + \list + \li \l {Qt Script Debugger Manual} + \endlist + \section2 Reference + \list + \li \l{Qt Script Tools C++ Classes}{C++ Classes} + \endlist + +*/ diff --git a/src/scripttools/doc/src/qtscripttools-module.qdoc b/src/scripttools/doc/src/qtscripttools-module.qdoc new file mode 100644 index 0000000000000000000000000000000000000000..bc8999443cfb38b811880f4d92332dc71c9568ee --- /dev/null +++ b/src/scripttools/doc/src/qtscripttools-module.qdoc @@ -0,0 +1,49 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** 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 Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \module QtScriptTools + \title Qt Script Tools C++ Classes + \since 4.5 + \ingroup modules + + \brief Provides additional components for applications that use Qt Script. + + The \l{Qt Script Tools} module provides a debugger for applications that + use Qt Script. + + \section1 Configuring the Build Process + + To include the definitions of the module's classes, use the + following directive: + + \snippet doc_src_qtscripttools.cpp 0 + + To link against the module, add this line to your \l qmake \c .pro file: + + \snippet doc_src_qtscripttools.pro 1 +*/ diff --git a/src/scripttools/scripttools.pro b/src/scripttools/scripttools.pro index 0cb83812b92fb26b0d8cb9b5c2b3d3885a1b010a..12d26a4c4ada57d1f14f2960894652f7b7c1d21c 100644 --- a/src/scripttools/scripttools.pro +++ b/src/scripttools/scripttools.pro @@ -5,6 +5,8 @@ QT_PRIVATE = gui widgets-private script DEFINES += QT_NO_USING_NAMESPACE #win32-msvc*|win32-icc:QMAKE_LFLAGS += /BASE:0x66000000 +QMAKE_DOCS = $$PWD/doc/qtscripttools.qdocconf + load(qt_module) include(debugging/debugging.pri) diff --git a/tests/auto/qscriptcontext/tst_qscriptcontext.cpp b/tests/auto/qscriptcontext/tst_qscriptcontext.cpp index 6d9b8894ac7ded4553016b4787e8741eac3f69eb..2129521b067fa1eb367bffe5403ae04a0014c512 100644 --- a/tests/auto/qscriptcontext/tst_qscriptcontext.cpp +++ b/tests/auto/qscriptcontext/tst_qscriptcontext.cpp @@ -964,9 +964,6 @@ void tst_QScriptContext::backtrace_data() void tst_QScriptContext::backtrace() { -#if defined(UBUNTU_ONEIRIC) && defined(__x86_64__) - QSKIP("Fails on this platform - QTBUG-23463"); -#endif QFETCH(QString, code); QFETCH(QStringList, expectedbacktrace); diff --git a/tests/auto/qscriptengine/tst_qscriptengine.cpp b/tests/auto/qscriptengine/tst_qscriptengine.cpp index 7d110c750c9f5a85b9c9198e99be6c1dd6ccac43..1747b2e6a62b1fc21bcefad9866703891ef01206 100644 --- a/tests/auto/qscriptengine/tst_qscriptengine.cpp +++ b/tests/auto/qscriptengine/tst_qscriptengine.cpp @@ -1559,7 +1559,7 @@ void tst_QScriptEngine::builtinFunctionNames_data() // See ECMA-262 Chapter 15, "Standard Built-in ECMAScript Objects". - QTest::newRow("print") << QString("print") << QString("print"); // QtScript extension. + QTest::newRow("print") << QString("print") << QString("print"); // Qt Script extension. QTest::newRow("parseInt") << QString("parseInt") << QString("parseInt"); QTest::newRow("parseFloat") << QString("parseFloat") << QString("parseFloat"); QTest::newRow("isNaN") << QString("isNaN") << QString("isNaN"); @@ -1570,8 +1570,8 @@ void tst_QScriptEngine::builtinFunctionNames_data() QTest::newRow("encodeURIComponent") << QString("encodeURIComponent") << QString("encodeURIComponent"); QTest::newRow("escape") << QString("escape") << QString("escape"); QTest::newRow("unescape") << QString("unescape") << QString("unescape"); - QTest::newRow("version") << QString("version") << QString("version"); // QtScript extension. - QTest::newRow("gc") << QString("gc") << QString("gc"); // QtScript extension. + QTest::newRow("version") << QString("version") << QString("version"); // Qt Script extension. + QTest::newRow("gc") << QString("gc") << QString("gc"); // Qt Script extension. QTest::newRow("Array") << QString("Array") << QString("Array"); QTest::newRow("Array.prototype.toString") << QString("Array.prototype.toString") << QString("toString"); @@ -4035,7 +4035,7 @@ void tst_QScriptEngine::jsFunctionDeclarationAsStatement() // at the beginning of chapter 12 in ECMA-262 5th edition, where it's // recommended that implementations either disallow this usage or issue // a warning. - // Since we had a bug report long ago about QtScript not supporting this + // Since we had a bug report long ago about Qt Script not supporting this // "feature" (and thus deviating from other implementations), we still // check this behavior. @@ -4376,7 +4376,7 @@ void tst_QScriptEngine::jsShadowReadOnlyPrototypeProperty() // SpiderMonkey has different behavior than JSC and V8; it disallows // creating a property on the instance if there's a property with the // same name in the prototype, and that property is read-only. We - // adopted that behavior in the old (4.5) QtScript back-end, but it + // adopted that behavior in the old (4.5) Qt Script back-end, but it // just seems weird -- and non-compliant. Adopt the JSC behavior instead. QScriptEngine eng; QVERIFY(eng.evaluate("o = {}; o.__proto__ = parseInt; o.length").isNumber()); @@ -5802,7 +5802,7 @@ void tst_QScriptEngine::qRegExpInport() } // QScriptValue::toDateTime() returns a local time, whereas JS dates -// are always stored as UTC. QtScript must respect the current time +// are always stored as UTC. Qt Script must respect the current time // zone, and correctly adjust for daylight saving time that may be in // effect at a given date (QTBUG-9770). void tst_QScriptEngine::dateRoundtripJSQtJS() diff --git a/tests/auto/qscriptextqobject/tst_qscriptextqobject.cpp b/tests/auto/qscriptextqobject/tst_qscriptextqobject.cpp index 21f5b33e4f59d2e3f6ce7a8f0ea153ed27b72616..78c0151f820f11d92870fd021151f64bf26ee5f7 100644 --- a/tests/auto/qscriptextqobject/tst_qscriptextqobject.cpp +++ b/tests/auto/qscriptextqobject/tst_qscriptextqobject.cpp @@ -2343,7 +2343,7 @@ void tst_QScriptExtQObject::cppConnectAndDisconnect2() QVERIFY(qScriptConnect(m_myObject, SIGNAL(mySignal()), QScriptValue(), fun)); QCOMPARE(m_myObject->connectNotifySignals().size(), 2); QVERIFY(m_myObject->hasConnectNotifySignal(QMetaMethod::fromSignal(&MyQObject::mySignal))); - // We get a destroyed() connection as well, used internally by QtScript + // We get a destroyed() connection as well, used internally by Qt Script QVERIFY(m_myObject->hasConnectNotifySignal(QMetaMethod::fromSignal(&QObject::destroyed))); m_myObject->clearDisconnectNotifySignals();