-
Notifications
You must be signed in to change notification settings - Fork 5.6k
/
generator.py
2829 lines (2250 loc) · 124 KB
/
generator.py
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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (C) 2018-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#
# pylint: disable=too-many-lines
"""IDL C++ Code Generator."""
import hashlib
import io
import os
import re
import sys
import textwrap
from abc import ABCMeta, abstractmethod
from typing import Dict, Iterable, List, Mapping, Tuple, Union
from . import (ast, bson, common, cpp_types, enum_types, generic_field_list_types, struct_types,
writer)
def _get_field_member_name(field):
# type: (ast.Field) -> str
"""Get the C++ class member name for a field."""
return '_%s' % (common.camel_case(field.cpp_name))
def _get_field_member_setter_name(field):
# type: (ast.Field) -> str
"""Get the C++ class setter name for a field."""
return "set%s" % (common.title_case(field.cpp_name))
def _get_field_member_getter_name(field):
# type: (ast.Field) -> str
"""Get the C++ class getter name for a field."""
return "get%s" % (common.title_case(field.cpp_name))
def _get_has_field_member_name(field):
# type: (ast.Field) -> str
"""Get the C++ class member name for bool 'has' member field."""
return '_has%s' % (common.title_case(field.cpp_name))
def _is_required_serializer_field(field):
# type: (ast.Field) -> bool
"""
Get whether we require this field to have a value set before serialization.
Fields that must be set before serialization are fields without default values, that are not
optional, and are not chained.
"""
return not field.ignore and not field.optional and not field.default and not field.chained and not field.chained_struct_field
def _get_field_constant_name(field):
# type: (ast.Field) -> str
"""Get the C++ string constant name for a field."""
return common.template_args('k${constant_name}FieldName',
constant_name=common.title_case(field.cpp_name))
def _get_field_member_validator_name(field):
# type: (ast.Field) -> str
"""Get the name of the validator method for this field."""
return 'validate%s' % common.title_case(field.cpp_name)
def _access_member(field):
# type: (ast.Field) -> str
"""Get the declaration to access a member for a field."""
member_name = _get_field_member_name(field)
if not field.optional:
return '%s' % (member_name)
# optional types need a method call to access their values
return '%s.get()' % (member_name)
def _get_bson_type_check(bson_element, ctxt_name, ast_type):
# type: (str, str, ast.Type) -> str
"""Get the C++ bson type check for a Type."""
bson_types = ast_type.bson_serialization_type
if len(bson_types) == 1:
if bson_types[0] in ['any', 'chain']:
# Skip BSON validation for 'any' types since they are required to validate the
# BSONElement.
# Skip BSON validation for 'chain' types since they process the raw BSONObject the
# encapsulating IDL struct parser is passed.
return None
if not bson_types[0] == 'bindata':
return '%s.checkAndAssertType(%s, %s)' % (ctxt_name, bson_element,
bson.cpp_bson_type_name(bson_types[0]))
return '%s.checkAndAssertBinDataType(%s, %s)' % (
ctxt_name, bson_element, bson.cpp_bindata_subtype_type_name(ast_type.bindata_subtype))
else:
type_list = '{%s}' % (', '.join([bson.cpp_bson_type_name(b) for b in bson_types]))
return '%s.checkAndAssertTypes(%s, %s)' % (ctxt_name, bson_element, type_list)
def _get_comparison(field, rel_op, left, right):
# type: (ast.Field, str, str, str) -> str
"""Generate a comparison for a field."""
name = _get_field_member_name(field)
if "BSONObj" not in field.type.cpp_type:
return "%s.%s %s %s.%s" % (left, name, rel_op, right, name)
access = name
if field.optional:
access = name + ".get()"
comp = "(SimpleBSONObjComparator::kInstance.compare(%s.%s, %s.%s) %s 0)" % (left, access, right,
access, rel_op)
# boost::optional implements the various operator comparisons but we need to reimplement them
# for BSONObj
if field.optional:
if rel_op == "==":
# optional values are equal if they do not contain values otherwise compare the values
pred = "( (static_cast<bool>(${left}.${name}) == static_cast<bool>(${right}.${name}))" +\
" && (!static_cast<bool>(${left}.${name}) || ${comp}) )"
elif rel_op == "!=":
pred = "( (static_cast<bool>(${left}.${name}) != static_cast<bool>(${right}.${name}))" +\
" && (static_cast<bool>(${left}.${name}) && ${comp}) )"
elif rel_op == "<":
pred = "( static_cast<bool>(${right}.${name}) && (!static_cast<bool>(${left}.${name})" +\
" || ${comp}) )"
comp = common.template_args(pred, name=name, comp=comp, left=left, right=right)
return comp
def _get_comparison_less(fields):
# type: (List[ast.Field]) -> str
"""Generate a less than comparison for a list of fields recursively."""
field = fields[0]
if len(fields) == 1:
return _get_comparison(field, "<", "left", "right")
return "%s || (!(%s) && (%s))" % (_get_comparison(field, "<", "left", "right"),
_get_comparison(field, "<", "right", "left"),
_get_comparison_less(fields[1:]))
def _get_all_fields(struct):
# type: (ast.Struct) -> List[ast.Field]
"""Get a list of all the fields, including the command field."""
all_fields = []
if isinstance(struct, ast.Command) and struct.command_field:
all_fields.append(struct.command_field)
all_fields += struct.fields
return sorted([field for field in all_fields], key=lambda f: f.cpp_name)
class _FieldUsageCheckerBase(object, metaclass=ABCMeta):
"""Check for duplicate fields, and required fields as needed."""
def __init__(self, indented_writer):
# type: (writer.IndentedTextWriter) -> None
"""Create a field usage checker."""
self._writer = indented_writer # type: writer.IndentedTextWriter
self._fields = [] # type: List[ast.Field]
@abstractmethod
def add_store(self, field_name):
# type: (str) -> None
"""Create the C++ field store initialization code."""
pass
@abstractmethod
def add(self, field, bson_element_variable):
# type: (ast.Field, str) -> None
"""Add a field to track."""
pass
@abstractmethod
def add_final_checks(self):
# type: () -> None
"""Output the code to check for missing fields."""
pass
class _SlowFieldUsageChecker(_FieldUsageCheckerBase):
"""
Check for duplicate fields, and required fields as needed.
Detects duplicate extra fields.
Generates code with a C++ std::set to maintain a set of fields seen while parsing a BSON
document. The std::set has O(N lg N) lookup, and allocates memory in the heap.
"""
def __init__(self, indented_writer):
# type: (writer.IndentedTextWriter) -> None
super(_SlowFieldUsageChecker, self).__init__(indented_writer)
self._writer.write_line('std::set<StringData> usedFields;')
def add_store(self, field_name):
# type: (str) -> None
self._writer.write_line('auto push_result = usedFields.insert(%s);' % (field_name))
with writer.IndentedScopedBlock(self._writer,
'if (MONGO_unlikely(push_result.second == false)) {', '}'):
self._writer.write_line('ctxt.throwDuplicateField(%s);' % (field_name))
def add(self, field, bson_element_variable):
# type: (ast.Field, str) -> None
if not field in self._fields:
self._fields.append(field)
def add_final_checks(self):
# type: () -> None
for field in self._fields:
if (not field.optional) and (not field.ignore) and (not field.chained):
pred = 'if (MONGO_unlikely(usedFields.find(%s) == usedFields.end())) {' % \
(_get_field_constant_name(field))
with writer.IndentedScopedBlock(self._writer, pred, '}'):
if field.default:
if field.chained_struct_field:
self._writer.write_line('%s.%s(%s);' % (_get_field_member_name(
field.chained_struct_field), _get_field_member_setter_name(field),
field.default))
elif field.type.is_enum:
self._writer.write_line(
'%s = %s::%s;' % (_get_field_member_name(field),
field.type.cpp_type, field.default))
else:
self._writer.write_line(
'%s = %s;' % (_get_field_member_name(field), field.default))
else:
self._writer.write_line(
'ctxt.throwMissingField(%s);' % (_get_field_constant_name(field)))
def _gen_field_usage_constant(field):
# type: (ast.Field) -> str
"""Get the name for a bitset constant in field usage checking."""
return "k%sBit" % (common.title_case(field.cpp_name))
def _get_constant(name):
# type: (str) -> str
"""Transform an arbitrary label to a constant name."""
return 'k' + re.sub(r'([^a-zA-Z0-9_]+)', '_', common.title_case(name))
class _FastFieldUsageChecker(_FieldUsageCheckerBase):
"""
Check for duplicate fields, and required fields as needed.
Does not detect duplicate extra fields. Only works for strict parsers.
Generates code with a C++ std::bitset to maintain a record each field seen while parsing a
document. The std::bitset has O(1) lookup, and allocates a single int or similar on the stack.
"""
def __init__(self, indented_writer, fields):
# type: (writer.IndentedTextWriter, List[ast.Field]) -> None
super(_FastFieldUsageChecker, self).__init__(indented_writer)
self._writer.write_line('std::bitset<%d> usedFields;' % (len(fields)))
bit_id = 0
for field in fields:
if field.chained:
continue
self._writer.write_line(
'const size_t %s = %d;' % (_gen_field_usage_constant(field), bit_id))
bit_id += 1
def add_store(self, field_name):
# type: (str) -> None
"""Create the C++ field store initialization code."""
pass
def add(self, field, bson_element_variable):
# type: (ast.Field, str) -> None
"""Add a field to track."""
if not field in self._fields:
self._fields.append(field)
with writer.IndentedScopedBlock(
self._writer,
'if (MONGO_unlikely(usedFields[%s])) {' % (_gen_field_usage_constant(field)), '}'):
self._writer.write_line('ctxt.throwDuplicateField(%s);' % (bson_element_variable))
self._writer.write_empty_line()
self._writer.write_line('usedFields.set(%s);' % (_gen_field_usage_constant(field)))
self._writer.write_empty_line()
if field.unstable:
self._writer.write_line(
'ctxt.throwAPIStrictErrorIfApplicable(%s);' % (bson_element_variable))
self._writer.write_empty_line()
def add_final_checks(self):
# type: () -> None
"""Output the code to check for missing fields."""
with writer.IndentedScopedBlock(self._writer, 'if (MONGO_unlikely(!usedFields.all())) {',
'}'):
for field in self._fields:
if (not field.optional) and (not field.ignore):
with writer.IndentedScopedBlock(
self._writer,
'if (!usedFields[%s]) {' % (_gen_field_usage_constant(field)), '}'):
if field.default:
if field.chained_struct_field:
self._writer.write_line(
'%s.%s(%s);' %
(_get_field_member_name(field.chained_struct_field),
_get_field_member_setter_name(field), field.default))
elif field.type.is_enum:
self._writer.write_line(
'%s = %s::%s;' % (_get_field_member_name(field),
field.type.cpp_type, field.default))
else:
self._writer.write_line(
'%s = %s;' % (_get_field_member_name(field), field.default))
else:
self._writer.write_line(
'ctxt.throwMissingField(%s);' % (_get_field_constant_name(field)))
def _get_field_usage_checker(indented_writer, struct):
# type: (writer.IndentedTextWriter, ast.Struct) -> _FieldUsageCheckerBase
# Only use the fast field usage checker if we never expect extra fields that we need to ignore
# but still wish to do duplicate detection on.
if struct.strict:
return _FastFieldUsageChecker(indented_writer, struct.fields)
return _SlowFieldUsageChecker(indented_writer)
# Turn a python string into a C++ literal.
def _encaps(val):
# type: (str) -> str
if val is None:
return '""'
for i in ["\\", '"', "'"]:
if i in val:
val = val.replace(i, '\\' + i)
return '"' + val + '"'
# Turn a list of pything strings into a C++ initializer list.
def _encaps_list(vals):
# type: (List[str]) -> str
if vals is None:
return '{}'
return '{' + ', '.join([_encaps(v) for v in vals]) + '}'
# Translate an ast.Expression into C++ code.
def _get_expression(expr):
# type: (ast.Expression) -> str
if not expr.validate_constexpr:
return expr.expr
# Wrap in a lambda to let the compiler enforce constexprness for us.
# The optimization pass should end up inlining it.
return '([]{ constexpr auto value = %s; return value; })()' % expr.expr
class _CppFileWriterBase(object):
"""
C++ File writer.
Encapsulates low level knowledge of how to print a C++ file.
Relies on caller to orchestrate calls correctly though.
"""
def __init__(self, indented_writer):
# type: (writer.IndentedTextWriter) -> None
"""Create a C++ code writer."""
self._writer = indented_writer # type: writer.IndentedTextWriter
def write_unindented_line(self, msg):
# type: (str) -> None
"""Write an unindented line to the stream."""
self._writer.write_unindented_line(msg)
def write_empty_line(self):
# type: () -> None
"""Write an empty line to the stream."""
self._writer.write_empty_line()
def gen_file_header(self):
# type: () -> None
"""Generate a file header saying the file is generated."""
self._writer.write_unindented_line(
textwrap.dedent("""\
/**
* WARNING: This is a generated file. Do not modify.
*
* Source: %s
*/
""" % (" ".join(sys.argv))))
def gen_system_include(self, include):
# type: (str) -> None
"""Generate a system C++ include line."""
self._writer.write_unindented_line('#include <%s>' % (include))
def gen_include(self, include):
# type: (str) -> None
"""Generate a non-system C++ include line."""
self._writer.write_unindented_line('#include "%s"' % (include))
def gen_namespace_block(self, namespace):
# type: (str) -> writer.NamespaceScopeBlock
"""Generate a namespace block."""
namespace_list = namespace.split("::")
return writer.NamespaceScopeBlock(self._writer, namespace_list)
def get_initializer_lambda(self, decl, unused=False, return_type=None):
# type: (str, bool, str) -> writer.IndentedScopedBlock
"""Generate an indented block lambda initializing an outer scope variable."""
prefix = '[[maybe_unused]] ' if unused else ''
prefix = prefix + decl + ' = ([]'
if return_type:
prefix = prefix + '() -> ' + return_type
return writer.IndentedScopedBlock(self._writer, prefix + ' {', '})();')
def gen_description_comment(self, description):
# type: (str) -> None
"""Generate a multiline comment with the description from the IDL."""
self._writer.write_line(
textwrap.dedent("""\
/**
* %s
*/""" % (description)))
def _with_template(self, template_params):
# type: (Mapping[str,str]) -> writer.TemplateContext
"""Generate a template context for the current parameters."""
return writer.TemplateContext(self._writer, template_params)
def _block(self, opening, closing):
# type: (str, str) -> Union[writer.IndentedScopedBlock,writer.EmptyBlock]
"""Generate an indented block if opening is not empty."""
if not opening:
return writer.EmptyBlock()
return writer.IndentedScopedBlock(self._writer, opening, closing)
def _predicate(self, check_str, use_else_if=False, constexpr=False):
# type: (str, bool, bool) -> Union[writer.IndentedScopedBlock,writer.EmptyBlock]
"""
Generate an if block if the condition is not-empty.
Generate 'else if' instead of use_else_if is True.
"""
if not check_str:
return writer.EmptyBlock()
conditional = 'if'
if use_else_if:
conditional = 'else if'
if constexpr:
conditional = conditional + ' constexpr'
return writer.IndentedScopedBlock(self._writer, '%s (%s) {' % (conditional, check_str), '}')
def _condition(self, condition, preprocessor_only=False):
# type: (ast.Condition, bool) -> writer.WriterBlock
"""Generate one or more blocks for multiple conditional types."""
if not condition:
return writer.EmptyBlock()
blocks = [] # type: List[writer.WriterBlock]
if condition.preprocessor:
blocks.append(
writer.UnindentedBlock(self._writer, '#if ' + condition.preprocessor, '#endif'))
if not preprocessor_only:
if condition.constexpr:
blocks.append(self._predicate(condition.constexpr, constexpr=True))
if condition.expr:
blocks.append(self._predicate(condition.expr))
if not blocks:
return writer.EmptyBlock()
if len(blocks) == 1:
return blocks[0]
return writer.MultiBlock(blocks)
class _CppHeaderFileWriter(_CppFileWriterBase):
"""C++ .h File writer."""
# pylint: disable=too-many-public-methods
def gen_class_declaration_block(self, class_name):
# type: (str) -> writer.IndentedScopedBlock
"""Generate a class declaration block."""
return writer.IndentedScopedBlock(self._writer,
'class %s {' % common.title_case(class_name), '};')
def gen_class_constructors(self, struct):
# type: (ast.Struct) -> None
"""Generate the declarations for the class constructors."""
struct_type_info = struct_types.get_struct_info(struct)
constructor = struct_type_info.get_constructor_method()
self._writer.write_line(constructor.get_declaration())
required_constructor = struct_type_info.get_required_constructor_method()
if len(required_constructor.args) != len(constructor.args):
self._writer.write_line(required_constructor.get_declaration())
def gen_field_list_entry_lookup_methods(self, field_list):
# type: (ast.FieldListBase) -> None
"""Generate the declarations for generic argument or reply field lookup methods."""
field_list_info = generic_field_list_types.get_field_list_info(field_list)
self._writer.write_line(field_list_info.get_has_field_method().get_declaration())
self._writer.write_line(field_list_info.get_should_forward_method().get_declaration())
def gen_serializer_methods(self, struct):
# type: (ast.Struct) -> None
"""Generate a serializer method declarations."""
struct_type_info = struct_types.get_struct_info(struct)
parse_method = struct_type_info.get_deserializer_static_method()
if parse_method:
self._writer.write_line(parse_method.get_declaration())
parse_method = struct_type_info.get_op_msg_request_deserializer_static_method()
if parse_method:
self._writer.write_line(parse_method.get_declaration())
self._writer.write_line(struct_type_info.get_serializer_method().get_declaration())
parse_method = struct_type_info.get_op_msg_request_serializer_method()
if parse_method:
self._writer.write_line(parse_method.get_declaration())
self._writer.write_line(struct_type_info.get_to_bson_method().get_declaration())
self._writer.write_empty_line()
def gen_protected_serializer_methods(self, struct):
# type: (ast.Struct) -> None
# pylint: disable=invalid-name
"""Generate protected serializer method declarations."""
struct_type_info = struct_types.get_struct_info(struct)
parse_method = struct_type_info.get_deserializer_method()
if parse_method:
self._writer.write_line(parse_method.get_declaration())
parse_method = struct_type_info.get_op_msg_request_deserializer_method()
if parse_method:
self._writer.write_line(parse_method.get_declaration())
self._writer.write_empty_line()
def gen_getter(self, struct, field):
# type: (ast.Struct, ast.Field) -> None
"""Generate the C++ getter definition for a field."""
cpp_type_info = cpp_types.get_cpp_type(field)
param_type = cpp_type_info.get_getter_setter_type()
member_name = _get_field_member_name(field)
if cpp_type_info.return_by_reference():
param_type += "&"
template_params = {
'method_name': _get_field_member_getter_name(field),
'param_type': param_type,
'body': cpp_type_info.get_getter_body(member_name),
'const_type': 'const ' if cpp_type_info.is_const_type() else '',
}
# Generate a getter that disables xvalue for view types (i.e. StringData), constructed
# optional types, and non-primitive types.
with self._with_template(template_params):
if field.chained_struct_field:
self._writer.write_template(
'${const_type} ${param_type} ${method_name}() const { return %s.%s(); }' % (
(_get_field_member_name(field.chained_struct_field),
_get_field_member_getter_name(field))))
elif cpp_type_info.disable_xvalue():
self._writer.write_template(
'const ${param_type} ${method_name}() const& { ${body} }')
self._writer.write_template('void ${method_name}() && = delete;')
elif field.type.is_struct:
# Support mutable accessors
self._writer.write_template(
'const ${param_type} ${method_name}() const { ${body} }')
if not struct.immutable:
self._writer.write_template('${param_type} ${method_name}() { ${body} }')
else:
self._writer.write_template(
'${const_type}${param_type} ${method_name}() const { ${body} }')
if field.non_const_getter:
self._writer.write_template('${param_type} ${method_name}() { ${body} }')
def gen_validators(self, field):
# type: (ast.Field) -> None
"""Generate the C++ validators definition for a field."""
assert field.validator
cpp_type_info = cpp_types.get_cpp_type_without_optional(field)
param_type = cpp_type_info.get_storage_type()
if not cpp_types.is_primitive_type(param_type):
param_type += '&'
template_params = {
'method_name': _get_field_member_validator_name(field),
'param_type': param_type,
}
with self._with_template(template_params):
# Declare method implemented in C++ file.
self._writer.write_template('void ${method_name}(const ${param_type} value);')
self._writer.write_template(
'void ${method_name}(IDLParserErrorContext& ctxt, const ${param_type} value);')
self._writer.write_empty_line()
def gen_setter(self, field):
# type: (ast.Field) -> None
"""Generate the C++ setter definition for a field."""
cpp_type_info = cpp_types.get_cpp_type(field)
param_type = cpp_type_info.get_getter_setter_type()
member_name = _get_field_member_name(field)
post_body = ''
if _is_required_serializer_field(field):
post_body = '%s = true;' % (_get_has_field_member_name(field))
validator_method_name = ''
if field.validator is not None:
validator_method_name = _get_field_member_validator_name(field)
template_params = {
'method_name': _get_field_member_setter_name(field),
'member_name': member_name,
'param_type': param_type,
'body': cpp_type_info.get_setter_body(member_name, validator_method_name),
'post_body': post_body,
}
with self._with_template(template_params):
self._writer.write_template(
'void ${method_name}(${param_type} value) & { ${body} ${post_body} }')
self._writer.write_empty_line()
def gen_member(self, field):
# type: (ast.Field) -> None
"""Generate the C++ class member definition for a field."""
cpp_type_info = cpp_types.get_cpp_type(field)
member_type = cpp_type_info.get_storage_type()
member_name = _get_field_member_name(field)
if field.default and not field.constructed:
if field.type.is_enum:
self._writer.write_line('%s %s{%s::%s};' % (member_type, member_name,
field.type.cpp_type, field.default))
else:
self._writer.write_line('%s %s{%s};' % (member_type, member_name, field.default))
else:
self._writer.write_line('%s %s;' % (member_type, member_name))
def gen_serializer_member(self, field):
# type: (ast.Field) -> None
"""Generate the C++ class bool has_<field> member definition for a field."""
has_member_name = _get_has_field_member_name(field)
# Use a bitfield to save space
self._writer.write_line('bool %s : 1;' % (has_member_name))
def gen_string_constants_declarations(self, struct):
# type: (ast.Struct) -> None
# pylint: disable=invalid-name
"""Generate a StringData constant for field name."""
for field in _get_all_fields(struct):
self._writer.write_line(
common.template_args('static constexpr auto ${constant_name} = "${field_name}"_sd;',
constant_name=_get_field_constant_name(field),
field_name=field.name))
if isinstance(struct, ast.Command):
self._writer.write_line(
common.template_args('static constexpr auto kCommandName = "${command_name}"_sd;',
command_name=struct.command_name))
# Initialize constexpr for command alias if specified in the IDL spec.
if struct.command_alias:
self._writer.write_line(
common.template_args(
'static constexpr auto kCommandAlias = "${command_alias}"_sd;',
command_alias=struct.command_alias))
def gen_authorization_contract_declaration(self, struct):
# type: (ast.Struct) -> None
"""Generate the authorization contract declaration."""
if not isinstance(struct, ast.Command):
return
if struct.access_checks is None:
return
self._writer.write_line('static AuthorizationContract kAuthorizationContract;')
self.write_empty_line()
def gen_enum_functions(self, idl_enum):
# type: (ast.Enum) -> None
"""Generate the declaration for an enum's supporting functions."""
enum_type_info = enum_types.get_type_info(idl_enum)
self._writer.write_line("%s;" % (enum_type_info.get_deserializer_declaration()))
self._writer.write_line("%s;" % (enum_type_info.get_serializer_declaration()))
def gen_enum_declaration(self, idl_enum):
# type: (ast.Enum) -> None
"""Generate the declaration for an enum."""
enum_type_info = enum_types.get_type_info(idl_enum)
with self._block('enum class %s : std::int32_t {' % (enum_type_info.get_cpp_type_name()),
'};'):
for enum_value in idl_enum.values:
self._writer.write_line(
common.template_args('${name} ${value},', name=enum_value.name,
value=enum_type_info.get_cpp_value_assignment(enum_value)))
self._writer.write_line("static constexpr uint32_t kNum%s = %d;" %
(enum_type_info.get_cpp_type_name(), len(idl_enum.values)))
def gen_op_msg_request_methods(self, command):
# type: (ast.Command) -> None
"""Generate the methods for a command."""
if command.command_field:
self.gen_getter(command, command.command_field)
else:
struct_type_info = struct_types.get_struct_info(command)
struct_type_info.gen_getter_method(self._writer)
self._writer.write_empty_line()
def gen_op_msg_request_member(self, command):
# type: (ast.Command) -> None
"""Generate the class members for a command."""
if command.command_field:
self.gen_member(command.command_field)
else:
struct_type_info = struct_types.get_struct_info(command)
struct_type_info.gen_member(self._writer)
self._writer.write_empty_line()
def gen_field_list_entries_declaration(self, field_list):
# type: (ast.FieldListBase) -> None
"""Generate the field list entries map for a generic argument or reply field list."""
field_list_info = generic_field_list_types.get_field_list_info(field_list)
self._writer.write_line(
common.template_args('// Map: fieldName -> ${should_forward_name}',
should_forward_name=field_list_info.get_should_forward_name()))
self._writer.write_line(
"static const stdx::unordered_map<std::string, bool> _genericFields;")
self.write_empty_line()
def gen_known_fields_declaration(self):
# type: () -> None
"""Generate all the known fields vectors for a command."""
self._writer.write_line("static const std::vector<StringData> _knownBSONFields;")
self._writer.write_line("static const std::vector<StringData> _knownOP_MSGFields;")
self.write_empty_line()
def gen_comparison_operators_declarations(self, struct):
# type: (ast.Struct) -> None
"""Generate comparison operators declarations for the type."""
# pylint: disable=invalid-name
sorted_fields = sorted([
field for field in struct.fields if (not field.ignore) and field.comparison_order != -1
], key=lambda f: f.comparison_order)
for rel_op in [('==', " && "), ('!=', " || ")]:
self.write_empty_line()
decl = common.template_args(
"friend bool operator${rel_op}(const ${class_name}& left, const ${class_name}& right) {",
rel_op=rel_op[0], class_name=common.title_case(struct.name))
with self._block(decl, "}"):
self._writer.write_line('return %s;' % (rel_op[1].join(
[_get_comparison(field, rel_op[0], "left", "right")
for field in sorted_fields])))
decl = common.template_args(
"friend bool operator<(const ${class_name}& left, const ${class_name}& right) {",
class_name=common.title_case(struct.name))
with self._block(decl, "}"):
self._writer.write_line("return %s;" % (_get_comparison_less(sorted_fields)))
decl = common.template_args(
"friend bool operator>(const ${class_name}& left, const ${class_name}& right) {",
class_name=common.title_case(struct.name))
with self._block(decl, "}"):
self._writer.write_line('return right < left;')
decl = common.template_args(
"friend bool operator<=(const ${class_name}& left, const ${class_name}& right) {",
class_name=common.title_case(struct.name))
with self._block(decl, "}"):
self._writer.write_line('return !(right < left);')
decl = common.template_args(
"friend bool operator>=(const ${class_name}& left, const ${class_name}& right) {",
class_name=common.title_case(struct.name))
with self._block(decl, "}"):
self._writer.write_line('return !(left < right);')
self.write_empty_line()
def _gen_exported_constexpr(self, name, suffix, expr, condition):
# type: (str, str, ast.Expression, ast.Condition) -> None
"""Generate exports for default initializer."""
if not (name and expr and expr.export):
return
with self._condition(condition, preprocessor_only=True):
self._writer.write_line(
'constexpr auto %s%s = %s;' % (_get_constant(name), suffix, expr.expr))
self.write_empty_line()
def _gen_extern_declaration(self, vartype, varname, condition):
# type: (str, str, ast.Condition) -> None
"""Generate externs for storage declaration."""
if (vartype is None) or (varname is None):
return
with self._condition(condition, preprocessor_only=True):
idents = varname.split('::')
decl = idents.pop()
for ns in idents:
self._writer.write_line('namespace %s {' % (ns))
self._writer.write_line('extern %s %s;' % (vartype, decl))
for ns in reversed(idents):
self._writer.write_line('} // namespace ' + ns)
if idents:
self.write_empty_line()
def _gen_config_function_declaration(self, spec):
# type: (ast.IDLAST) -> None
"""Generate function declarations for config initializers."""
initializer = spec.globals.configs and spec.globals.configs.initializer
if not initializer:
return
if initializer.register:
self._writer.write_line(
'Status %s(optionenvironment::OptionSection*);' % (initializer.register))
if initializer.store:
self._writer.write_line(
'Status %s(const optionenvironment::Environment&);' % (initializer.store))
if initializer.register or initializer.store:
self.write_empty_line()
def gen_server_parameter_class(self, scp):
# type: (ast.ServerParameter) -> None
"""Generate a C++ class definition for a ServerParameter."""
if scp.cpp_class is None:
return
cls = scp.cpp_class
with self._block('class %s : public ServerParameter {' % (cls.name), '};'):
self._writer.write_unindented_line('public:')
if scp.default is not None:
self._writer.write_line(
'static constexpr auto kDataDefault = %s;' % (scp.default.expr))
if cls.override_ctor:
# Explicit custom constructor.
self._writer.write_line(cls.name + '(StringData name, ServerParameterType spt);')
else:
# Inherit base constructor.
self._writer.write_line('using ServerParameter::ServerParameter;')
self.write_empty_line()
self._writer.write_line(
'void append(OperationContext*, BSONObjBuilder&, const std::string&) final;')
self._writer.write_line('Status set(const BSONElement&) final;')
self._writer.write_line('Status setFromString(const std::string&) final;')
if cls.data is not None:
self.write_empty_line()
if scp.default is not None:
self._writer.write_line('%s _data{kDataDefault};' % (cls.data))
else:
self._writer.write_line('%s _data;' % (cls.data))
self.write_empty_line()
def gen_template_declaration(self):
# type: () -> None
"""Generate a template declaration for a command's base class."""
self._writer.write_line('template <typename Derived>')
def gen_derived_class_declaration_block(self, class_name):
# type: (str) -> writer.IndentedScopedBlock
"""Generate a command's base class declaration block."""
return writer.IndentedScopedBlock(
self._writer, 'class %s : public TypedCommand<Derived> {' % class_name, '};')
def gen_type_alias_declaration(self, new_type_name, old_type_name):
# type: (str, str) -> None
"""Generate a type alias declaration."""
self._writer.write_line(
'using %s = %s;' % (new_type_name, common.title_case(old_type_name)))
def gen_derived_class_constructor(self, command_name, api_version, base_class,
*base_class_args):
# type: (str, str, str, *str) -> None
"""Generate a derived class constructor."""
class_name = common.title_case(command_name) + "CmdVersion" + api_version + "Gen"
args = ", ".join(base_class_args)
self._writer.write_line('%s(): %s(%s) {}' % (class_name, base_class, args))
def gen_derived_class_destructor(self, command_name, api_version):
# type: (str, str) -> None
"""Generate a derived class destructor."""
class_name = common.title_case(command_name) + "CmdVersion" + api_version + "Gen"
self._writer.write_line('virtual ~%s() = default;' % (class_name))
def gen_api_version_fn(self, is_api_versions, api_version):
# type: (bool, Union[str, bool]) -> None
"""Generate an apiVersions or deprecatedApiVersions function for a command's base class."""
fn_name = "apiVersions" if is_api_versions else "deprecatedApiVersions"
fn_def = 'virtual const std::set<std::string>& %s() const final' % fn_name
value = "kApiVersions1" if api_version else "kNoApiVersions"
with self._block('%s {' % (fn_def), '}'):
self._writer.write_line('return %s;' % value)
def gen_invocation_base_class_declaration(self, command):
# type: (ast.Command) -> None
"""Generate the InvocationBaseGen class for a command's base class."""
class_declaration = 'class InvocationBaseGen : public _TypedCommandInvocationBase {'
with writer.IndentedScopedBlock(self._writer, class_declaration, '};'):
# public requires special indentation that aligns with the class definition.
self._writer.unindent()
self._writer.write_line('public:')
self._writer.indent()
# Inherit base constructor.
self._writer.write_line(
'using _TypedCommandInvocationBase::_TypedCommandInvocationBase;')