summaryrefslogtreecommitdiffstats
path: root/src/interpreter/imports/qtsystemtest/scripts/ComponentCacher.js
blob: 5a66d18a4f0887e9bd56656a2527fb067cf52a92 (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
139
140
141
142
143
144
145
146
147
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of QtSystemTest.
**
** $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$
**
****************************************************************************/

Js.include_check(ComponentCacher === undefined, 'ComponentCacher.js already included');
Js.require('Exception.js');
Js.require('Class.js');

var OriginalCallerDepth = 5; // explaination below
/*
  the stack for factory.register(foo, bar) or this.setDefaultItemFile would  lead to
  1. something.register()
  2. class.call (register)
  3. this.register
  3.      absolutePathOf
  4.            inside register
  to get the file that called register, we would have to traverse back in stack 5 levels
*/

    function absolutePathOf(path) {
        if ( !Qt.qst.isRelativePath(path) ) {
            return path;
        }
        // get the filename that called applicaton.register
        var stack = Js.Engine.callSite(OriginalCallerDepth);
        var callerFilePath = stack.last().fileName;
        var lastSlash = callerFilePath.lastIndexOf('/');
        return callerFilePath.left(lastSlash + 1) + path;
    }


var ComponentCacher = Class.create(function() {
    var __registry = {
        //key: qmlFile
    };

    var __componentsCache = {
        //key: Component
    };
    var __defaultItemFile;
    var fallbackToDefault = true;

    function setDefaultItemFile(qmlFilePath) {
        __defaultItemFile = absolutePathOf(qmlFilePath);
    }

    function unregister(key)  {
        if (key in __registry) {
           delete __registry[key];
        }
        if (key in __componentsCache) {
           delete __componentsCache[key];
        }
    }

    function register(key, qmlFilePath)  {
        __registry[key] = absolutePathOf(qmlFilePath);
    }

    function fileForKey(key) {
        if (key in __registry) {
            return __registry[key];
        }
        if ( !fallbackToDefault) {
            return null;
        }

        if ( !__defaultItemFile) {
            throw new Qtt.Error( 'Error: ComponentCacher - unable to find a file for ' + key);
        }
        return __defaultItemFile;
    }

    function componentForKey(key) {
        var qmlFile = this.fileForKey(key);
        if (qmlFile === null) {
            return null;
        }

        var component = null;
        if ( ! (qmlFile in __componentsCache)) {

            component = Qt.createComponent(qmlFile)
            // HACK ... 1 means Component.Ready I want to access Component.Ready here...
            if (component.status !== 1) {
                // fix me ... Change error to accept msg and formatted msg,
                throw new Qtt.Error('Component creation failed : ' + component.errorString(), 2);
            }
            __componentsCache[qmlFile] = component;
        } else  {
            component = __componentsCache[qmlFile];
        }

        return component;
    }
    function setFallbackToDefault(value) {
        fallbackToDefault = value;
    }

    return {

        setFallbackToDefault: setFallbackToDefault,
        setDefaultItemFile: setDefaultItemFile,
        fileForKey: fileForKey,
        register: register,
        unregister: unregister,
        componentForKey: componentForKey,
        keys: function() { return  Object.keys(__registry); },
    };
});