aboutsummaryrefslogtreecommitdiffstats
path: root/share/qbs/imports/qbs/Probes/path-probe.js
blob: b4d745428805ceb607857776964bf84b5f7ec1fe (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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qbs.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms and
** conditions see http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/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 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

var Environment = require("qbs.Environment");
var File = require("qbs.File");
var FileInfo = require("qbs.FileInfo");
var ModUtils = require("qbs.ModUtils");

function asStringList(key, value) {
    if (typeof(value) === "string")
        return [value];
    if (Array.isArray(value))
        return value;
    throw key + " must be a string or a stringList";
}

function canonicalSelectors(selectors, nameSuffixes) {
    var mapper = function(selector) {
        if (typeof(selector) === "string")
            return {names : [selector]};
        if (Array.isArray(selector))
            return {names : selector};
        // dict
        if (!selector.names)
            throw '"names" must be specified';
        selector.names = asStringList("names", selector.names);
        if (selector.nameSuffixes)
            selector.nameSuffixes = asStringList("nameSuffixes", selector.nameSuffixes);
        else
            selector.nameSuffixes = nameSuffixes;
        return selector;
    };
    return selectors.map(mapper);
}

function configure(selectors, names, nameSuffixes, nameFilter, candidateFilter,
                   searchPaths, pathSuffixes, platformSearchPaths, environmentPaths,
                   platformEnvironmentPaths, pathListSeparator) {
    var result = { found: false, files: [] };
    if (!selectors && !names)
        throw '"names" or "selectors" must be specified';

    if (!selectors) {
        selectors = [
            {names: names, nameSuffixes: nameSuffixes}
        ];
    } else {
        selectors = canonicalSelectors(selectors, nameSuffixes);
    }

    if (nameFilter) {
        selectors.forEach(function(selector) {
            selector.names = selector.names.map(nameFilter);
        });
    }

    selectors.forEach(function(selector) {
        selector.names = ModUtils.concatAll.apply(undefined, selector.names.map(function(name) {
            return (selector.nameSuffixes || [""]).map(function(suffix) {
                return name + suffix;
            });
        }));
    });

    // FIXME: Suggest how to obtain paths from system
    var _paths = ModUtils.concatAll(searchPaths, platformSearchPaths);
    // FIXME: Add getenv support
    var envs = ModUtils.concatAll(platformEnvironmentPaths, environmentPaths);
    for (var i = 0; i < envs.length; ++i) {
        var value = Environment.getEnv(envs[i]) || '';
        if (value.length > 0)
            _paths = _paths.concat(value.split(pathListSeparator));
    }
    var _suffixes = ModUtils.concatAll('', pathSuffixes);
    _paths = _paths.map(function(p) { return FileInfo.fromNativeSeparators(p); });
    _suffixes = _suffixes.map(function(p) { return FileInfo.fromNativeSeparators(p); });

    var findFile = function(selector) {
        var file = { found: false, candidatePaths: [] };
        for (var i = 0; i < selector.names.length; ++i) {
            for (var j = 0; j < _paths.length; ++j) {
                for (var k = 0; k < _suffixes.length; ++k) {
                    var _filePath = FileInfo.joinPaths(_paths[j], _suffixes[k], selector.names[i]);
                    file.candidatePaths.push(_filePath);
                    if (File.exists(_filePath)
                            && (!candidateFilter || candidateFilter(_filePath))) {
                        file.found = true;
                        file.filePath = _filePath;

                        // Manually specify the path components that constitute _filePath rather
                        // than using the FileInfo.path and FileInfo.fileName functions because we
                        // want to break _filePath into its constituent parts based on the input
                        // originally given by the user. For example, the FileInfo functions would
                        // produce a different result if any of the items in the names property
                        // contained more than a single path component.
                        file.fileName = selector.names[i];
                        file.path = FileInfo.joinPaths(_paths[j], _suffixes[k]);
                        return file;
                    }
                }
            }
        }

        return file;
    };

    result.files = selectors.map(findFile);
    result.found = result.files.reduce(function(acc, value) { return acc && value.found }, true);

    return result;
}