blob: 58c5c74f4a08b4c07678baff89c0bd54ad95ad50 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Build Suite.
**
** 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.
**
****************************************************************************/
/*!
\contentspage index.html
\page jsextensions-general.html
\ingroup list-of-builtin-services
\title General Services
\brief Provides various operations.
These are operations that do not fit into any of the other categories.
They are automatically available in any \QBS project file or JavaScript file.
\section1 Available Operations
\section2 qbs.getEnv
\code
qbs.getEnv(key: string): string
\endcode
Tries to find a variable with the given name in the build environment and returns its value. If
no such variable could be found, \c undefined is returned.
\section2 qbs.getHostOS
\code
qbs.getHostOS(): string
\endcode
Returns the name of the operating system on which \QBS is running.
\note Do not confuse this with the \c{qbs.targetOS} property, which represents the operating
system on which the binaries produced by \QBS will run.
\section2 loadFile
\code
loadFile(filePath: string): any
\endcode
Loads a JavaScript file and returns an object that contains the evaluated context of this file.
This function is only available in JavaScript files.
For example:
\code
var MyFunctions = loadFile("myfunctions.js");
MyFunctions.doSomething();
\endcode
\section2 loadExtension
\code
loadExtension(extensionName: string): any
\endcode
Loads a \QBS extension and returns an object that contains all functions of that extension.
This function is only available in JavaScript files.
For example:
\code
var FileInfo = loadExtension("qbs.FileInfo");
var fileName = FileInfo.fileName(filePath);
\endcode
\section1 Extensions to JavaScript Built-in Objects
\section2 Array.contains
\code
Array.contains(e: any): boolean
\endcode
Returns \c{true} if the array contains the element \c{e}. Returns \c{false} otherwise.
\section2 Array.uniqueConcat
\code
Array.uniqueConcat(other: any[]): any[]
\endcode
Returns a copy of this array joined with the array \c{other}.
Duplicates that would originate from the concatenation are removed.
The order of elements is preserved.
\section2 String.contains
\code
String.contains(s: string): boolean
\endcode
Returns \c{true} if the string contains the substring \c{s}. Returns \c{false} otherwise.
\section2 startsWith
\code
String.startsWith(s: string): boolean
\endcode
Returns \c{true} if the string starts with the substring \c{s}. Returns \c{false} otherwise.
\section2 endsWith
\code
String.endsWith(s: string): boolean
\endcode
Returns \c{true} if the string ends with the substring \c{s}. Returns \c{false} otherwise.
*/
|
