summaryrefslogtreecommitdiffstats
path: root/tests/auto/concurrent/qtconcurrentfiltermapgenerated/generator/generate_testcase.py
blob: 9ba03a31a0801ebbcd1bf4914ffe420dbb80621a (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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
#############################################################################
#
# Copyright (C) 2020 The Qt Company Ltd.
# Contact: https://www.qt.io/licensing/
#
# This file is part of the test suite of the Qt Toolkit.
#
# $QT_BEGIN_LICENSE:GPL-EXCEPT$
# 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 https://www.qt.io/terms-conditions. For further
# information use the contact form at https://www.qt.io/contact-us.
#
# GNU General Public License Usage
# Alternatively, this file may be used under the terms of the GNU
# General Public License version 3 as published by the Free Software
# Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
# included in the packaging of this file. Please review the following
# information to ensure the GNU General Public License requirements will
# be met: https://www.gnu.org/licenses/gpl-3.0.html.
#
# $QT_END_LICENSE$
#
#############################################################################
import textwrap
import time
from subprocess import Popen, PIPE

from function_signature import build_function_signature, build_function_name
from option_management import need_separate_output_sequence, qt_quirk_case


def InputSequenceItem(toptions):
    if toptions["inputitemtype"] == "standard":
        return "SequenceItem<tag_input>"
    if toptions["inputitemtype"] == "noconstruct":
        return "NoConstructSequenceItem<tag_input>"
    if toptions["inputitemtype"] == "moveonly":
        return "MoveOnlySequenceItem<tag_input>"
    if toptions["inputitemtype"] == "moveonlynoconstruct":
        return "MoveOnlyNoConstructSequenceItem<tag_input>"
    assert False


def InputSequence(toptions):
    item = InputSequenceItem(toptions)
    if toptions["inputsequence"] == "standard":
        return "std::vector<{}>".format(item)
    if toptions["inputsequence"] == "moveonly":
        return "MoveOnlyVector<{}>".format(item)
    assert False


def InputSequenceInitializationString(toptions):
    t = InputSequenceItem(toptions)
    # construct IILE
    mystring = ("[](){" + InputSequence(toptions) + " result;\n"
                + "\n".join("result.push_back({}({}, true));".format(t, i) for i in range(1, 7))
                + "\n return result; }()")
    return mystring


def OutputSequenceItem(toptions):
    if toptions["map"] and (toptions["inplace"] or toptions["maptype"] == "same"):
        return InputSequenceItem(toptions)

    if toptions["map"]:
        if toptions["mappeditemtype"] == "standard":
            return "SequenceItem<tag_mapped>"
        if toptions["mappeditemtype"] == "noconstruct":
            return "NoConstructSequenceItem<tag_mapped>"
        if toptions["mappeditemtype"] == "moveonly":
            return "MoveOnlySequenceItem<tag_mapped>"
        if toptions["mappeditemtype"] == "moveonlynoconstruct":
            return "MoveOnlyNoConstructSequenceItem<tag_mapped>"
        assert(False)
    else:
        return InputSequenceItem(toptions)


def ReducedItem(toptions):
    if toptions["reductiontype"] == "same":
        return OutputSequenceItem(toptions)
    else:
        if toptions["reductionitemtype"] == "standard":
            return "SequenceItem<tag_reduction>"
        if toptions["reductionitemtype"] == "noconstruct":
            return "NoConstructSequenceItem<tag_reduction>"
        if toptions["reductionitemtype"] == "moveonly":
            return "MoveOnlySequenceItem<tag_reduction>"
        if toptions["reductionitemtype"] == "moveonlynoconstruct":
            return "MoveOnlyNoConstructSequenceItem<tag_reduction>"
        assert(False)


def OutputSequence(toptions):
    item = OutputSequenceItem(toptions)
    # quirk of qt: not a QFuture<Sequence> is returned
    if qt_quirk_case(toptions):
        return "QList<{}>".format(item)

    needs_extra = need_separate_output_sequence(toptions)
    if not needs_extra:
        return InputSequence(toptions)


    if toptions["outputsequence"] == "standard":
        return "std::vector<{}>".format(item)
    if toptions["outputsequence"] == "moveonly":
        return "MoveOnlyVector<{}>".format(item)
    assert False


def resultData(toptions):
    result = [1, 2, 3, 4, 5, 6]
    if toptions["filter"]:
        result = filter(lambda x: x % 2 == 1, result)
    if toptions["map"]:
        result = map(lambda x: 2 * x, result)
    if toptions["reduce"]:
        result = sum(result)
    return result


def OutputSequenceInitializationString(toptions):
    t = OutputSequenceItem(toptions)
    # construct IILE
    mystring = ("[](){" + OutputSequence(toptions) + " result;\n"
                + "\n".join("result.push_back({}({}, true));".format(t, i) for i in resultData(toptions))
                + "\n return result; }()")
    return mystring


def OutputScalarInitializationString(toptions):
    result = resultData(toptions)
    assert isinstance(result, int)
    return ReducedItem(toptions) + "(" + str(result) + ", true)"


def FilterInitializationString(toptions):
    item = InputSequenceItem(toptions)
    if toptions["filterfunction"] == "function":
        return "myfilter<{}>".format(item)
    if toptions["filterfunction"] == "functor":
        return "MyFilter<{}>{{}}".format(item)
    if toptions["filterfunction"] == "memberfunction":
        return "&{}::isOdd".format(item)
    if toptions["filterfunction"] == "lambda":
        return "[](const {}& x){{ return myfilter<{}>(x); }}".format(item, item)
    if toptions["filterfunction"] == "moveonlyfunctor":
        return "MyMoveOnlyFilter<{}>{{}}".format(item)
    assert False


def MapInitializationString(toptions):
    oldtype = InputSequenceItem(toptions)
    newtype = OutputSequenceItem(toptions)
    if toptions["inplace"]:
        assert oldtype == newtype
        if toptions["mapfunction"] == "function":
            return "myInplaceMap<{}>".format(oldtype)
        if toptions["mapfunction"] == "functor":
            return "MyInplaceMap<{}>{{}}".format(oldtype)
        if toptions["mapfunction"] == "memberfunction":
            return "&{}::multiplyByTwo".format(oldtype)
        if toptions["mapfunction"] == "lambda":
            return "[]({}& x){{ return myInplaceMap<{}>(x); }}".format(oldtype, oldtype)
        if toptions["mapfunction"] == "moveonlyfunctor":
            return "MyMoveOnlyInplaceMap<{}>{{}}".format(oldtype)
        assert False
    else:
        if toptions["mapfunction"] == "function":
            return "myMap<{f},{t}>".format(f=oldtype, t=newtype)
        if toptions["mapfunction"] == "functor":
            return "MyMap<{f},{t}>{{}}".format(f=oldtype, t=newtype)
        if toptions["mapfunction"] == "memberfunction":
            return "&{}::multiplyByTwo".format(newtype)
        if toptions["mapfunction"] == "lambda":
            return "[](const {f}& x){{ return myMap<{f},{t}>(x); }}".format(f=oldtype, t=newtype)
        if toptions["mapfunction"] == "moveonlyfunctor":
            return "MyMoveOnlyMap<{f},{t}>{{}}".format(f=oldtype, t=newtype)
        assert False


def ReductionInitializationString(toptions):
    elementtype = OutputSequenceItem(toptions)
    sumtype = ReducedItem(toptions)

    if toptions["reductionfunction"] == "function":
        return "myReduce<{f},{t}>".format(f=elementtype, t=sumtype)
    if toptions["reductionfunction"] == "functor":
        return "MyReduce<{f},{t}>{{}}".format(f=elementtype, t=sumtype)
    if toptions["reductionfunction"] == "lambda":
        return "[]({t}& sum, const {f}& x){{ return myReduce<{f},{t}>(sum, x); }}".format(f=elementtype, t=sumtype)
    if toptions["reductionfunction"] == "moveonlyfunctor":
        return "MyMoveOnlyReduce<{f},{t}>{{}}".format(f=elementtype, t=sumtype)
    assert False


def ReductionInitialvalueInitializationString(options):
    return ReducedItem(options) + "(0, true)"


def function_template_args(options):
    args = []
    out_s = OutputSequence(options)
    in_s = InputSequence(options)
    if options["reduce"] and options["reductionfunction"] == "lambda":
        args.append(ReducedItem(options))
    elif out_s != in_s:
        if not qt_quirk_case(options):
            args.append(out_s)

    if len(args):
        return "<" + ", ".join(args) + ">"

    return ""


numcall = 0


def generate_testcase(function_options, testcase_options):
    options = {**function_options, **testcase_options}

    option_description = "\n".join("  {}={}".format(
        a, b) for a, b in testcase_options.items())
    option_description = textwrap.indent(option_description, " "*12)
    function_signature = textwrap.indent(build_function_signature(function_options), " "*12)
    testcase_name = "_".join("{}_{}".format(x, y) for x, y in options.items())
    global numcall
    numcall += 1
    testcase_name = "test" + str(numcall)
    function_name = build_function_name(options)

    arguments = []

    template_args = function_template_args(options)

    # care about the thread pool
    if options["pool"]:
        pool_initialization = """QThreadPool pool;
    pool.setMaxThreadCount(1);"""
        arguments.append("&pool")
    else:
        pool_initialization = ""

    # care about the input sequence
    input_sequence_initialization_string = InputSequenceInitializationString(options)

    if "inputsequencepassing" in options and options["inputsequencepassing"] == "lvalue" or options["inplace"]:
        input_sequence_initialization = "auto input_sequence = " + \
                                        input_sequence_initialization_string + ";"
        arguments.append("input_sequence")
    elif "inputsequencepassing" in options and options["inputsequencepassing"] == "rvalue":
        input_sequence_initialization = ""
        arguments.append(input_sequence_initialization_string)
    else:
        input_sequence_initialization = "auto input_sequence = " + \
                                        input_sequence_initialization_string + ";"
        arguments.append("input_sequence.begin()")
        arguments.append("input_sequence.end()")

    # care about the map:
    if options["map"]:
        map_initialization_string = MapInitializationString(options)
        if options["mapfunctionpassing"] == "lvalue":
            map_initialization = "auto map = " + map_initialization_string + ";"
            arguments.append("map")
        elif options["mapfunctionpassing"] == "rvalue":
            map_initialization = ""
            arguments.append(map_initialization_string)
        else:
            assert False
    else:
        map_initialization = ""

    # care about the filter
    if options["filter"]:
        filter_initialization_string = FilterInitializationString(options)
        if options["filterfunctionpassing"] == "lvalue":
            filter_initialization = "auto filter = " + filter_initialization_string + ";"
            arguments.append("filter")
        elif options["filterfunctionpassing"] == "rvalue":
            filter_initialization = ""
            arguments.append(filter_initialization_string)
        else:
            assert (False)
    else:
        filter_initialization = ""

    reduction_initialvalue_initialization = ""
    # care about reduction
    if options["reduce"]:
        reduction_initialization_expression = ReductionInitializationString(options)
        if options["reductionfunctionpassing"] == "lvalue":
            reduction_initialization = "auto reductor = " + reduction_initialization_expression + ";"
            arguments.append("reductor")
        elif options["reductionfunctionpassing"] == "rvalue":
            reduction_initialization = ""
            arguments.append(reduction_initialization_expression)
        else:
            assert (False)

        # initialvalue:
        if options["initialvalue"]:
            reduction_initialvalue_initialization_expression = ReductionInitialvalueInitializationString(options)
            if options["reductioninitialvaluepassing"] == "lvalue":
                reduction_initialvalue_initialization = "auto initialvalue = " + reduction_initialvalue_initialization_expression + ";"
                arguments.append("initialvalue")
            elif options["reductioninitialvaluepassing"] == "rvalue":
                reduction_initialvalue_initialization = ""
                arguments.append(reduction_initialvalue_initialization_expression)
            else:
                assert (False)

        if options["reductionoptions"] == "UnorderedReduce":
            arguments.append("QtConcurrent::UnorderedReduce")
        elif options["reductionoptions"] == "OrderedReduce":
            arguments.append("QtConcurrent::OrderedReduce")
        elif options["reductionoptions"] == "SequentialReduce":
            arguments.append("QtConcurrent::SequentialReduce")
        else:
            assert options["reductionoptions"] == "unspecified"
    else:
        reduction_initialization = ""

    # what is the expected result
    if options["filter"]:
        if not options["reduce"]:
            expected_result_expression = OutputSequenceInitializationString(options)
        else:
            expected_result_expression = OutputScalarInitializationString(options)
    elif options["map"]:
        if not options["reduce"]:
            expected_result_expression = OutputSequenceInitializationString(options)
        else:
            expected_result_expression = OutputScalarInitializationString(options)

    wait_result_expression = ""
    if options["inplace"]:
        if options["blocking"]:
            result_accepting = ""
            result_variable = "input_sequence"
        else:
            result_accepting = "auto future = "
            result_variable = "input_sequence"
            wait_result_expression = "future.waitForFinished();"
    elif options["blocking"]:
        result_accepting = "auto result = "
        result_variable = "result"
    else:
        if not options["reduce"]:
            result_accepting = "auto result = "
            result_variable = "result.results()"
        else:
            result_accepting = "auto result = "
            result_variable = "result.takeResult()"

    arguments_passing = ", ".join(arguments)
    final_string = f"""
        void tst_QtConcurrentFilterMapGenerated::{testcase_name}()
        {{
            /* test for
{function_signature}

            with
{option_description}
            */

            {pool_initialization}
            {input_sequence_initialization}
            {filter_initialization}
            {map_initialization}
            {reduction_initialization}
            {reduction_initialvalue_initialization}

            {result_accepting}QtConcurrent::{function_name}{template_args}({arguments_passing});

            auto expected_result = {expected_result_expression};
            {wait_result_expression}
            QCOMPARE({result_variable}, expected_result);
        }}
        """
    p = Popen(["clang-format"], stdin=PIPE, stdout=PIPE, stderr=PIPE)
    final_string = p.communicate(final_string.encode())[0].decode()

    return (f"    void {testcase_name}();\n", final_string)