forked from RosettaCommons/binder
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclass.cpp
1242 lines (977 loc) · 51.9 KB
/
class.cpp
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
// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;rm-trailing-spaces:t -*-
// vi: set ts=2 noet:
//
// Copyright (c) 2018 Sergey Lyskov <[email protected]>
//
// All rights reserved. Use of this source code is governed by a
// MIT license that can be found in the LICENSE file.
/// @file binder/class.cpp
/// @brief Binding generation for C++ struct and class objects
/// @author Sergey Lyskov
#include <binder.hpp>
#include <class.hpp>
#include <function.hpp>
#include <enum.hpp>
#include <type.hpp>
#include <util.hpp>
#include <fmt/format.h>
#include <clang/AST/DeclTemplate.h>
//#include <clang/AST/TemplateBase.h>
using namespace llvm;
using namespace clang;
using std::string;
using std::pair;
using std::tuple;
using std::make_pair;
using std::vector;
using std::set;
//using std::unordered_map;
using namespace fmt::literals;
namespace binder {
// generate class template specialization for ClassTemplateSpecializationDecl or empty string otherwise
string template_specialization(clang::CXXRecordDecl const *C)
{
string templ;
if( auto t = dyn_cast<ClassTemplateSpecializationDecl>(C) ) {
templ += "<";
for(uint i=0; i < t->getTemplateArgs().size(); ++i) {
//if( t->getTemplateArgs()[i].isInstantiationDependent() ) break; // avoid explicitly specifying SFINAE related arguments
//outs() << " template argument: " << template_argument_to_string(t->getTemplateArgs()[i]) << "\n";
templ += template_argument_to_string(t->getTemplateArgs()[i]) + ",";
//if( t->getTemplateArgs()[i].ArgKind() == TemplateArgument::ArgKind::Integral ) outs() << " template arg:" << t->getTemplateArgs()[i].<< "\n";
//outs() << expresion_to_string( t->getTemplateArgs()[i].getAsExpr() ) << "\n";
}
templ.back() = '>';
}
fix_boolean_types(templ);
return templ;
}
// generate class name that could be used in bindings code indcluding template specialization if any
string class_name(CXXRecordDecl const *C)
{
string res = standard_name( C->getNameAsString() + template_specialization(C) );
if( namespace_from_named_decl(C) == "std" ) res = simplify_std_class_name(res);
return res;
}
// generate string represetiong class name that could be used in python
string python_class_name(CXXRecordDecl const *C)
{
string name = class_name(C);
return mangle_type_name(name);
}
// generate qualified class name that could be used in bindings code indcluding template specialization if any
string class_qualified_name(CXXRecordDecl const *C)
{
return standard_name(C->getQualifiedNameAsString() + template_specialization(C));
}
// generate vector<QualType> with all types that class uses if it tempalated
vector<QualType> get_type_dependencies(CXXRecordDecl const *C /*, bool include_members*/)
{
vector<QualType> r;
if( auto t = dyn_cast<ClassTemplateSpecializationDecl>(C) ) {
for(uint i=0; i < t->getTemplateArgs().size(); ++i) {
if( t->getTemplateArgs()[i].getKind() == TemplateArgument::Type ) {
r.push_back( t->getTemplateArgs()[i].getAsType() /*.getDesugaredType(C->getASTContext())*/ );
}
}
}
return r;
}
// Return true if class have direct or inderect std::enable_shared_from_this as base class
bool is_inherited_from_enable_shared_from_this(CXXRecordDecl const *C)
{
if( C->getQualifiedNameAsString() == "std::enable_shared_from_this" ) return true;
if( C->isCompleteDefinition() ) {
for(auto b = C->bases_begin(); b!=C->bases_end(); ++b) {
if( auto r = dyn_cast<RecordType>(b->getType().getCanonicalType().getTypePtr() ) ) {
CXXRecordDecl *rd = cast<CXXRecordDecl>(r->getDecl());
if( rd /*and rd->isCompleteDefinition()*/ and is_inherited_from_enable_shared_from_this(rd) ) return true;
}
}
}
return false;
}
bool is_field_assignable(FieldDecl const *f)
{
if( RecordType const* r = dyn_cast<RecordType>( f->getType() ) ) {
if( CXXRecordDecl *C = cast<CXXRecordDecl>(r->getDecl() ) ) { // checking if this type has deleted operator=
for(auto m = C->method_begin(); m != C->method_end(); ++m) {
//if( m->getAccess() == AS_public and m->isCopyAssignmentOperator() /*and !m->doesThisDeclarationHaveABody()*/ and m->isDeleted() ) return false;
if( m->isCopyAssignmentOperator() and ( m->getAccess() != AS_public or m->isDeleted() ) ) return false;
}
}
}
return true;
}
/// check if generator can create binding
bool is_bindable(FieldDecl *f)
{
if( f->getType()->isAnyPointerType() or f->getType()->isReferenceType() or f->getType()->isArrayType() ) return false;
if( !is_field_assignable(f) ) return false;
if( f->isAnonymousStructOrUnion() ) return false;
if( !is_bindable( f->getType() ) ) return false;
return true;
}
// Generate bindings for class data member
string bind_data_member(FieldDecl const *d, string const &class_qualified_name_)
{
static vector<string> anonymous_types {
"::(anonymous)",
"::(anonymous union)"
};
string class_qualified_name = class_qualified_name_;
for(const auto& anonymous: anonymous_types)
{
if( ends_with(class_qualified_name, anonymous) ) class_qualified_name.resize( class_qualified_name.size() - anonymous.size() );
}
if( d->getType().isConstQualified() ) return ".def_readonly(\"{}\", &{}::{})"_format(d->getNameAsString(), class_qualified_name, d->getNameAsString());
else return ".def_readwrite(\"{}\", &{}::{})"_format(d->getNameAsString(), class_qualified_name, d->getNameAsString());
}
// Check if given method is const-overload (and return-const-overload) of some other method in class
bool is_const_overload(CXXMethodDecl *mc)
{
if( mc->isConst() ) {
string name = function_qualified_name(mc, true);
string const _const = " const";
if( name.size() > _const.size() ) {
name.resize( name.size() - _const.size() );
CXXRecordDecl const *C = mc->getParent();
for(auto m = C->method_begin(); m != C->method_end(); ++m) {
if( m->getAccess() == mc->getAccess() and !m->isConst() and function_qualified_name(*m, true) == name ) return true;
}
}
}
//outs() << "is_const_overload: " << function_qualified_name(mc, false) << " -> false\n\n";
return false;
}
// check if given CXXRecordDecl (which known to be template specialization of std::function) is bindable
bool is_std_function_bindable(CXXRecordDecl const *C)
{
//outs() << "is_std_function_bindable( " << class_qualified_name(C) << "\n";
if( auto t = dyn_cast<ClassTemplateSpecializationDecl>(C) ) {
for(uint i=0; i < t->getTemplateArgs().size(); ++i) {
if (t->getTemplateArgs()[i].getKind() == TemplateArgument::Declaration) {
//outs() << " template argument: " << template_argument_to_string(t->getTemplateArgs()[i]) << "\n";
//t->getTemplateArgs()[i].dump();
QualType qt = t->getTemplateArgs()[i].getParamTypeForDecl();
//qt.dump();
if( FunctionProtoType const *ft = dyn_cast<FunctionProtoType>( qt.getTypePtr() ) ) {
if( not is_bindable( ft->getReturnType() ) ) return false;
for(uint i=0; i < ft->getNumParams(); ++i) {
if( not is_bindable( ft->getParamType(i) ) ) return false;
}
}
}
}
}
return true;
}
bool is_bindable_raw(clang::CXXRecordDecl const *C);
/// check if generator can create binding
bool is_bindable(clang::CXXRecordDecl const *C)
{
static std::unordered_map<CXXRecordDecl const *, bool> cache;
auto it = cache.find(C);
if( it != cache.end() ) return it->second;
else {
bool r = is_bindable_raw(C);
cache.emplace(C, r);
return r;
}
}
/// check if generator can create binding
bool is_bindable_raw(clang::CXXRecordDecl const *C)
{
bool r = true;
// outs() << "is_bindable(CXXRecordDecl): " << C->getQualifiedNameAsString() << template_specialization(C)
// << " C->hasDefinition():" << C->hasDefinition()
// << " C->isCompleteDefinition():" << C->isCompleteDefinition()
// // << " C->isThisDeclarationADefinition():" << C->isThisDeclarationADefinition()
// // << " C->getDefinition():" << C->getDefinition()
// << " C->isDependentType():" << C->isDependentType()
// <<"\n";
string qualified_name = C->getQualifiedNameAsString();
// if( qualified_name != "std::pair" and qualified_name != "std::tuple" ) {
// if( C->isDependentType() ) return false;
// if( !C->isCompleteDefinition() ) return false;
// if( C->getAccess() == AS_protected or C->getAccess() == AS_private ) return false;
// }
//if( C->getNameAsString() == "" ) return false;
// enabling binding of anonymous classes and handle it as special case in `bind_nested_classes`
//if( qualified_name == "(anonymous)" ) return false;
//if( qualified_name.rfind(')') != std::string::npos ) return false; // check for anonymous structs and types in anonymous namespaces
// disabling bindings for anonymous namespace's
// if( qualified_name.rfind("(anonymous namespace)") != std::string::npos ) return false;
if( C->isInAnonymousNamespace() ) return false;
//if( C->isAnonymousStructOrUnion() ) return false;
if( !C->hasNameForLinkage() and !C->isCXXClassMember() ) return false;
bool anonymous_name = qualified_name.rfind(')') != std::string::npos; // check if type name is "(anonymous)"
if( anonymous_name and C->hasNameForLinkage() ) return false;
if( anonymous_name and !C->hasNameForLinkage() and !C->isAnonymousStructOrUnion() ) return false;
//if( C->isAnonymousStructOrUnion() and C->hasNameForLinkage() ) return false;
//outs() << qualified_name << ": anonymous_name:" << anonymous_name << " isAnonymousStructOrUnion: " << C->isAnonymousStructOrUnion() << " hasNameForLinkage:" << C->hasNameForLinkage() << "\n";
if( C->isDependentType() ) return false;
if( C->getAccess() == AS_protected or C->getAccess() == AS_private ) return false;
if( !C->isCompleteDefinition() ) {
if( auto ts = dyn_cast<ClassTemplateSpecializationDecl>(C) ) {
if( qualified_name == "std::function" ) {
if( not is_std_function_bindable(C) ) return false;
}
else {
if( ts->getPointOfInstantiation()/* SourceLocation */.isInvalid() and not is_python_builtin(C) ) {
//outs() << "is_bindable( " << qualified_name << " " << class_qualified_name(C) << " ): no point of instantiation found, skipping...\n";
return false;
}
}
}
else return false;
}
// if( auto t = dyn_cast<ClassTemplateSpecializationDecl>(C) ) {
// for(uint i=0; i < t->getTemplateArgs().size(); ++i) {
// if( t->getTemplateArgs()[i].getKind() == TemplateArgument::Type ) {
// if( !is_bindable( t->getTemplateArgs()[i].getAsType() ) ) return false;
// }
// if( t->getTemplateArgs()[i].getKind() == TemplateArgument::Declaration ) {
// if( ValueDecl *v = t->getTemplateArgs()[i].getAsDecl() ) {
// if( v->getAccess() == AS_protected or v->getAccess() == AS_private ) {
// outs() << "Private template VALUE arg: " << v->getNameAsString() << "\n";
// return false;
// }
// }
// }
// }
// }
// Actually just always bind _all_ abstarct classes (but do not create trampoline for them if they can not be derived-from in Python!) so we can access base interfaces from Python
// if( C->hasDefinition() and C->isAbstract() ) {
// for(auto m = C->method_begin(); m != C->method_end(); ++m) {
// if( m->isPure() and is_const_overload(*m) ) return false; // it is not clear how to deal with this case since we can't overrdie const versions in Python, - so disabling for now
// }
// }
if( r && is_banned_symbol(C) ) return false;
return r;
}
/// check if user requested binding for the given declaration
bool is_binding_requested(clang::CXXRecordDecl const *C, Config const &config)
{
if( dyn_cast<ClassTemplateSpecializationDecl>(C) ) return false;
bool bind = config.is_class_binding_requested( standard_name( C->getQualifiedNameAsString() ) ) or config.is_class_binding_requested( class_qualified_name(C) ) or config.is_namespace_binding_requested( namespace_from_named_decl(C) );
for(auto & t : get_type_dependencies(C) ) bind &= !is_skipping_requested(t, config);
return bind;
}
// check if user requested skipping for the given declaration
bool is_skipping_requested(clang::CXXRecordDecl const *C, Config const &config)
{
bool skip = config.is_class_skipping_requested( standard_name( C->getQualifiedNameAsString() ) ) or config.is_class_skipping_requested( class_qualified_name(C) ) or config.is_namespace_skipping_requested( namespace_from_named_decl(C) );
for(auto & t : get_type_dependencies(C) ) skip |= is_skipping_requested(t, config);
return skip;
}
// extract include needed for declaration and add it to includes
void add_relevant_includes(clang::CXXRecordDecl const *C, IncludeSet &includes, int level)
{
if( !includes.add_decl(C, level) ) return;
add_relevant_include_for_decl(C, includes);
if( auto t = dyn_cast<ClassTemplateSpecializationDecl>(C) ) {
for(uint i=0; i < t->getTemplateArgs().size(); ++i) {
if( t->getTemplateArgs()[i].getKind() == TemplateArgument::Type ) {
add_relevant_includes( t->getTemplateArgs()[i].getAsType().getDesugaredType(C->getASTContext()) , includes, level+1);
}
if( t->getTemplateArgs()[i].getKind() == TemplateArgument::Template ) {
add_relevant_include_for_decl( t->getTemplateArgs()[i].getAsTemplate().getAsTemplateDecl()->getTemplatedDecl(), includes);
}
if( t->getTemplateArgs()[i].getKind() == TemplateArgument::Declaration ) {
ValueDecl *v = t->getTemplateArgs()[i].getAsDecl();
add_relevant_include_for_decl(v, includes);
}
if( t->getTemplateArgs()[i].getKind() == TemplateArgument::Integral ) {
add_relevant_includes(t->getTemplateArgs()[i].getIntegralType(), includes, level+1);
}
}
}
// member function templates: we have to treat them separatly because instantiation types might not be included in class header
for(auto d = C->decls_begin(); d != C->decls_end(); ++d) {
if(FunctionTemplateDecl *ft = dyn_cast<FunctionTemplateDecl>(*d) ) {
for(auto s = ft->spec_begin(); s != ft->spec_end(); ++s) {
if(CXXMethodDecl *m = dyn_cast<CXXMethodDecl>(*s) ) {
if( m->getAccess() == AS_public
and is_bindable(m) //and !is_skipping_requested(FunctionDecl const *F, Config const &config)
and !is_skipping_requested(m, Config::get())
and !isa<CXXConstructorDecl>(m) and !isa<CXXDestructorDecl>(m)
// and !is_const_overload(m) // commenting out for now - because const overload functions might be not bound but still re-implemented in call-back struct's for pure-virtual methods
) {
//m->dump();
add_relevant_includes(m, includes, level+1);
}
}
}
// ArrayRef< TemplateArgument > args = ft->getInjectedTemplateArgs();
// for(auto a = args.begin(); a != args.end(); ++a) {
// outs() << "function template argument: " << template_argument_to_string( *a ) << " type:" << a->getKind() << "\n";
// if( a->isDependent() ) {
// outs() << "isDependent!" << "\n";
// }
// if( a->isInstantiationDependent() ) {
// outs() << "isInstantiationDependent!" << "\n";
// }
// }
// if( FunctionDecl const *td = ft->getTemplatedDecl() ) {
// td->dump();
// if( TemplateArgumentList const *ta = td->getTemplateSpecializationArgs() ) {
// for(uint i=0; i < ta->size(); ++i) {
// outs() << "function template argument: " << template_argument_to_string( ta->get(i) ) << "\n";
// if( ta->get(i).isDependent() ) {
// outs() << "isDependent!" << "\n";
// }
// if( ta->get(i).isInstantiationDependent() ) {
// outs() << "isInstantiationDependent!" << "\n";
// }
// }
// }
// }
}
}
//outs() << "isCompleteDefinition:" << C->isCompleteDefinition() << " id: " << C->getQualifiedNameAsString() << "\n";
if( level < 2 ) {
for(auto m = C->method_begin(); m != C->method_end(); ++m) {
if( m->getAccess() == AS_public and is_bindable(*m) /*and !isa<CXXConstructorDecl>(*m)*/ and !isa<CXXDestructorDecl>(*m) ) {
add_relevant_includes(*m, includes, level+1);
}
}
}
}
/// DEPRECATED Check if all bases have public default constructors
// bool is_default_default_constructor_available(CXXRecordDecl const *C)
// {
// for(auto b = C->bases_begin(); b!=C->bases_end(); ++b) {
// if( auto rt = dyn_cast<RecordType>(b->getType().getCanonicalType().getTypePtr() ) ) {
// if(CXXRecordDecl *R = cast<CXXRecordDecl>(rt->getDecl()) ) {
// if( !R->hasDefaultConstructor() ) return false;
// bool default_constructor_processed = false;
// for(auto t = R->ctor_begin(); t != R->ctor_end(); ++t) {
// if( t->isDefaultConstructor() ) {
// if( t->getAccess() == AS_private or !t->isUserProvided() or t->isDeleted() ) return false;
// }
// default_constructor_processed = true;
// }
// if( R->ctor_begin() != R->ctor_end() and !default_constructor_processed ) return false;
// if( !is_default_default_constructor_available(R) ) return false;
// }
// }
// }
// return true;
// }
// Check if all bases have public default constructors
bool base_default_default_constructor_available(CXXRecordDecl const *C)
{
for(auto b = C->bases_begin(); b!=C->bases_end(); ++b) {
if( auto rt = dyn_cast<RecordType>(b->getType().getCanonicalType().getTypePtr() ) ) {
if(CXXRecordDecl *R = cast<CXXRecordDecl>(rt->getDecl()) ) {
if( !R->hasDefaultConstructor() ) return false;
for(auto t = R->ctor_begin(); t != R->ctor_end(); ++t) {
if( t->isDefaultConstructor() ) {
if( t->getAccess() == AS_private /*or !t->isUserProvided()*/ or t->isDeleted() ) return false;
}
}
if( !base_default_default_constructor_available(R) ) return false;
}
}
}
return true;
}
/// Generate string id that uniquly identify C++ binding object. For functions this is function prototype and for classes forward declaration.
string ClassBinder::id() const
{
return class_qualified_name(C);
}
/// check if generator can create binding
bool ClassBinder::bindable() const
{
return is_bindable(C) and !skipping_requested();
}
/// check if user requested binding for the given declaration
void ClassBinder::request_bindings_and_skipping(Config const &config)
{
if( is_skipping_requested(C, config) ) Binder::request_skipping();
else if( is_binding_requested(C, config) ) Binder::request_bindings();
}
/// extract include needed for this generator and add it to includes vector
void ClassBinder::add_relevant_includes(IncludeSet &includes) const
{
string const qualified_name_without_template = standard_name( C->getQualifiedNameAsString() );
std::map<string, std::vector<string>> const &class_includes= Config::get().class_includes();
auto pci = class_includes.find(qualified_name_without_template);
if(pci != class_includes.end()) {
for(auto const & i : pci->second) includes.add_include(O_annotate_includes ? i + " // +include_for_class" : i);
}
for_public_nested_classes([&includes](CXXRecordDecl const *innerC) {
ClassBinder(innerC).add_relevant_includes(includes);
});
for(auto & m : prefix_includes ) binder::add_relevant_includes(m, includes, 0);
binder::add_relevant_includes(C, includes, 0);
includes.add_include("<sstream> // __str__");
}
string binding_public_data_members(CXXRecordDecl const *C)
{
string c;
// binding protected data member that was made public in child class by 'using' declaration
for(auto d = C->decls_begin(); d != C->decls_end(); ++d) {
if(UsingDecl *u = dyn_cast<UsingDecl>(*d) ) {
if( u->getAccess() == AS_public ) {
for(auto s = u->shadow_begin(); s != u->shadow_end(); ++s) {
if(UsingShadowDecl *us = dyn_cast<UsingShadowDecl>(*s) ) {
if( FieldDecl *f = dyn_cast<FieldDecl>( us->getTargetDecl() ) ) {
if( is_bindable(f) ) c += "\tcl" + bind_data_member(f, class_qualified_name(C)) + ";\n";
}
}
}
}
}
}
for(auto d = C->decls_begin(); d != C->decls_end(); ++d) {
if(FieldDecl *f = dyn_cast<FieldDecl>(*d) ) {
if( f->getAccess() == AS_public and is_bindable(f) ) c += "\tcl" + bind_data_member(f, class_qualified_name(C)) + ";\n";
}
}
return c;
}
// generate call-back structure name for given class
inline string callback_structure_name(CXXRecordDecl const *C)
{
string ns = replace_(namespace_from_named_decl(C), "::", "_");
return "PyCallBack_" + (ns.empty() ? "" : ns + '_') + python_class_name(C);
}
// Check if binding this class require creation of call-back structure to allow overriding virtual functions in Python
bool is_callback_structure_needed(CXXRecordDecl const *C)
{
//C->dump();
// check if all pure-virtual methods could be overridden in Python
if( C->isAbstract() ) {
for(auto m = C->method_begin(); m != C->method_end(); ++m) {
if( m->isPure() and is_const_overload(*m) ) return false; // it is not clear how to deal with this case since we can't overrdie const versions in Python, - so disabling for now
}
}
if( C->hasAttr<FinalAttr>() ) return false;
for(auto m = C->method_begin(); m != C->method_end(); ++m) {
if( m->getAccess() != AS_private and is_bindable(*m) and m->isVirtual() and !isa<CXXDestructorDecl>(*m) ) return true;
}
for(auto b = C->bases_begin(); b!=C->bases_end(); ++b) {
if( b->getAccessSpecifier() != AS_private ) {
if( auto rt = dyn_cast<RecordType>(b->getType().getCanonicalType().getTypePtr() ) ) {
if(CXXRecordDecl *R = cast<CXXRecordDecl>(rt->getDecl()) ) {
if( is_callback_structure_needed(R) ) return true;
}
}
}
}
return false;
}
// Check if call-back structure that we can create will be constructible
bool is_callback_structure_constructible(CXXRecordDecl const *C)
{
if( C->isAbstract() ) {
for(auto m = C->method_begin(); m != C->method_end(); ++m) {
if( m->isPure() and !isa<CXXConstructorDecl>(*m) and ( m->getAccess() == AS_private or !is_bindable(*m) or is_skipping_requested(*m, Config::get()) ) ) return false;
}
for(auto b = C->bases_begin(); b!=C->bases_end(); ++b) {
if( auto rt = dyn_cast<RecordType>(b->getType().getCanonicalType().getTypePtr() ) ) {
if(CXXRecordDecl *R = cast<CXXRecordDecl>(rt->getDecl()) ) {
if( b->getAccessSpecifier() != AS_private ) {
if( !is_callback_structure_constructible(R) ) return false;
}
else if( R->isAbstract() ) return false;
}
}
}
}
return true;
}
// call_back_function_body_template is almost like PYBIND11_OVERLOAD_INT but specify pybind11::return_value_policy::reference
// #define PYBIND11_OVERLOAD_INT(ret_type, cname, name, ...) { \
// pybind11::gil_scoped_acquire gil; \
// pybind11::function overload = pybind11::get_overload(static_cast<const cname *>(this), name); \
// if (overload) \
// return overload(__VA_ARGS__).template cast<ret_type>(); }
//
// pybind11::gil_scoped_acquire gil; \
// pybind11::function overload = pybind11::get_overload(static_cast<const cname *>(this), name); \
// if (overload) { \
// auto o = overload(__VA_ARGS__); \
// if (pybind11::detail::cast_is_temporary_value_reference<ret_type>::value) { \
// static pybind11::detail::overload_caster_t<ret_type> caster; \
// return pybind11::detail::cast_ref<ret_type>(std::move(o), caster); \
// } \
// else return pybind11::detail::cast_safe<ret_type>(std::move(o)); \
// } \
// }
const char * call_back_function_body_template = R"_(
pybind11::gil_scoped_acquire gil;
pybind11::function overload = pybind11::get_overload(static_cast<const {0} *>(this), "{1}");
if (overload) {{
auto o = overload.operator()<pybind11::return_value_policy::reference>({2});
if (pybind11::detail::cast_is_temporary_value_reference<{3}>::value) {{
static pybind11::detail::override_caster_t<{3}> caster;
return pybind11::detail::cast_ref<{3}>(std::move(o), caster);
}}
else return pybind11::detail::cast_safe<{3}>(std::move(o));
}}
)_";
// generate call-back overloads for all public virtual functions in C including it bases
string bind_member_functions_for_call_back(CXXRecordDecl const *C, string const & class_name, /*string const & base_type_alias,*/ set<string> &binded, int &ret_id, std::vector<clang::FunctionDecl const *> &prefix_includes/*, std::set<clang::NamedDecl const *> &prefix_includes_stack*/)
{
string c;
for(auto m = C->method_begin(); m != C->method_end(); ++m) {
if( (m->getAccess() != AS_private) and is_bindable(*m) and is_overloadable(*m)
and !is_skipping_requested(*m, Config::get())
and !isa<CXXConstructorDecl>(*m) and !isa<CXXDestructorDecl>(*m) and m->isVirtual()
and !is_const_overload(*m) // was ( !is_const_overload(*m) or m->isPure() ) but now we ignoring this case since it is not possible to overload both const and non-const variants in Python anyway
) {
//if( m->hasAttr<NoExceptAttr>() ) {
// (*m)->dump();
// }
string return_type = standard_name( m->getReturnType().getCanonicalType().getAsString() ); fix_boolean_types(return_type);
// check if we need to fix return class to be 'derived-class &' or 'derived-class *'
// if( m->isVirtual() ) {
// if( begins_with(return_type, "class ") ) return_type = return_type.substr(6/*len("class ")*/);
// else if( begins_with(return_type, "struct ") ) return_type = return_type.substr(7/*len("struct ")*/);
// if( return_type == class_qualified_name(C) + " &") return_type = class_name + " &";
// if( return_type == class_qualified_name(C) + " *") return_type = class_name + " *";
// }
tuple<string, string, string> args = function_arguments_for_py_overload(*m);
string key = /*return_type + ' ' +*/ m->getNameAsString() + '(' + std::get<0>(args) + (m->isConst() ? ") const" : ")");
//outs() << "Class: " << C->getNameAsString() << "Key: " << key << "\n";
//c += "// Key: " + key + "\n";
if( !binded.count(key) ) {
binded.insert(key);
// m->hasAttr<OverrideAttr>, attribute list is automatically generated, see <release>/tools/clang/include/clang/Basic/AttrList.inc for attribute list
if( m->hasAttr<FinalAttr>() ) continue; // we can not test this condition in a big if above because we need 'final' function to be marked as 'binded' so they will be binded by some of the base classes
if( return_type.find(',') != std::string::npos ) {
string return_type_alias = "_binder_ret_" + std::to_string(ret_id); ++ret_id;
c += "\tusing {} = {};\n"_format(return_type_alias, return_type);
return_type = std::move(return_type_alias);
}
string python_name = python_function_name(*m);
string exception_specification;
if(FunctionProtoType const *fpt = dyn_cast<FunctionProtoType>( m->getType().getTypePtr() ) ) {
if( fpt->getExceptionSpecType() & clang::ExceptionSpecificationType::EST_BasicNoexcept ) exception_specification = "noexcept ";
if( fpt->getExceptionSpecType() & (clang::ExceptionSpecificationType::EST_DynamicNone | clang::ExceptionSpecificationType::EST_Dynamic | clang::ExceptionSpecificationType::EST_MSAny) ) exception_specification = "throw() ";
}
c += "\t{} {}({}){} {}override {{"_format(return_type, m->getNameAsString(), std::get<0>(args), m->isConst() ? " const" : "", exception_specification);
c += indent( fmt::format(call_back_function_body_template, class_name, /*class_qualified_name(C), */python_name, std::get<1>(args), return_type), "\t\t");
if( m->isPure() ) c+= "\t\tpybind11::pybind11_fail(\"Tried to call pure virtual function \\\"{}::{}\\\"\");\n"_format(C->getNameAsString(), python_name);
else c+= "\t\treturn {}::{}({});\n"_format(C->getNameAsString(), m->getNameAsString(), std::get<1>(args));
c += "\t}\n";
// c += string(m->isPure() ? "PYBIND11_OVERLOAD_PURE_NAME" : "PYBIND11_OVERLOAD_NAME") + '(';
// c += return_type + ", " + base_type_alias + ", \"" + python_function_name(*m) + "\", " + C->getNameAsString() + "::" + m->getNameAsString();
// c += ( args.second.size() ? ", " + args.second : "");
// c += "); }\n";
// Note: does not work when argument is std::shared_ptr passed by-reference...
// string python_name = python_function_name(*m);
// c += "PYBIND11_OVERLOAD_INT({}, \"{}\"{}); "_format(return_type, python_name, std::get<2>(args).size() ? ", " + std::get<2>(args) : "");
// if( m->isPure() ) c+= "pybind11::pybind11_fail(\"Tried to call pure virtual function \\\"{}::{}\\\"\");"_format(C->getNameAsString(), python_name);
// else c+= "return {}::{}({});"_format(C->getNameAsString(), m->getNameAsString(), std::get<1>(args));
// c += " }\n";
prefix_includes.push_back(*m);
//add_relevant_includes(*m, prefix_includes, prefix_includes_stack, 0);
}
}
}
for(auto b = C->bases_begin(); b!=C->bases_end(); ++b) {
if( b->getAccessSpecifier() != AS_private ) {
if( auto rt = dyn_cast<RecordType>(b->getType().getCanonicalType().getTypePtr() ) ) {
if(CXXRecordDecl *R = cast<CXXRecordDecl>(rt->getDecl()) ) {
c += bind_member_functions_for_call_back(R, class_name, /*base_type_alias,*/ binded, ret_id, prefix_includes);
//add_relevant_includes(R, prefix_includes, prefix_includes_stack, 0);
}
}
}
}
return c;
}
// Genarate code for defining 'call-back struct' that act as 'trampoline' and allows overlading virtual functions in Python
void ClassBinder::generate_prefix_code()
{
if( !is_callback_structure_needed(C) ) return;
prefix_code_ = generate_comment_for_declaration(C);
prefix_code_ += "struct {0} : public {1} {{\n\tusing {1}::{2};\n\n"_format(callback_structure_name(C), class_qualified_name(C), C->getNameAsString());
// string base_type_alias = "_binder_base_";
// prefix_code_ += "\tusing {} = {};\n\n"_format(base_type_alias, class_qualified_name(C));
set<string> binded; int ret_id = 0;
prefix_code_ += bind_member_functions_for_call_back(C, class_qualified_name(C), /*base_type_alias,*/ binded, ret_id, prefix_includes);
prefix_code_ += "};\n\n";
}
string binding_public_member_functions(CXXRecordDecl const *C, bool callback_structure, bool callback_structure_constructible, Context &context)
{
string c;
// binding protected/private member functions that was made public in child class by 'using' declaration
for(auto d = C->decls_begin(); d != C->decls_end(); ++d) {
if(UsingDecl *u = dyn_cast<UsingDecl>(*d) ) {
if( u->getAccess() == AS_public ) {
for(auto s = u->shadow_begin(); s != u->shadow_end(); ++s) {
if(UsingShadowDecl *us = dyn_cast<UsingShadowDecl>(*s) ) {
if( CXXMethodDecl *m = dyn_cast<CXXMethodDecl>( us->getTargetDecl() ) ) {
if( is_bindable(m) and !is_skipping_requested(m, Config::get()) and !isa<CXXConstructorDecl>(m) and !isa<CXXDestructorDecl>(m) and !is_const_overload(m) ) {
// Create a new CXXRecordDecl and insert base method into inherited class so bind_function correctly resolve parent namespace for function as 'child::' instead of 'base::'
// CXXRecordDecl NC(*C);
// CXXMethodDecl *nm = CXXMethodDecl::Create(m->getParentASTContext(), &NC, m->getLocStart(), m->getNameInfo(), m->getType(), m->getTypeSourceInfo(),
// m->getStorageClass(), m->isInlineSpecified(), m->isConstexpr() , m->getLocStart());
// it looks like LLVM will delete this object when parent CXXRecordDecl is destroyed so commenting out for now... // delete nm;
c += bind_function("\tcl", m, context, C, /*always_use_lambda=*/true);
}
}
}
}
}
}
if(FunctionTemplateDecl *ft = dyn_cast<FunctionTemplateDecl>(*d) ) {
for(auto s = ft->spec_begin(); s != ft->spec_end(); ++s) {
if(CXXMethodDecl *m = dyn_cast<CXXMethodDecl>(*s) ) {
if( m->getAccess() == AS_public
and is_bindable(m) //and !is_skipping_requested(FunctionDecl const *F, Config const &config)
and !is_skipping_requested(m, Config::get())
and !isa<CXXConstructorDecl>(m) and !isa<CXXDestructorDecl>(m)
and !is_const_overload(m) ) {
//m->dump();
c += bind_function("\tcl", m, context);
}
}
}
}
}
for(auto m = C->method_begin(); m != C->method_end(); ++m) {
if( m->getAccess() == AS_public
and is_bindable(*m) //and !is_skipping_requested(FunctionDecl const *F, Config const &config)
and !is_skipping_requested(*m, Config::get())
and !isa<CXXConstructorDecl>(*m) and !isa<CXXDestructorDecl>(*m)
and !is_const_overload(*m) ) {
//(*m)->dump();
c += bind_function("\tcl", *m, context);
}
}
return c;
}
string binding_template_bases(CXXRecordDecl const *C, bool callback_structure, bool callback_structure_constructible, Context &context)
{
string c;
if( dyn_cast<ClassTemplateSpecializationDecl>(C) ) { // for template classes explicitly bind data members and member functions from public base classes
for(auto b = C->bases_begin(); b!=C->bases_end(); ++b) {
if( b->getAccessSpecifier() == AS_public) {
if( auto rt = dyn_cast<RecordType>(b->getType().getCanonicalType().getTypePtr() ) ) {
if(CXXRecordDecl *R = cast<CXXRecordDecl>(rt->getDecl()) ) {
if( !is_skipping_requested(R, Config::get()) ) {
c += binding_public_data_members(R);
c += binding_public_member_functions(R, callback_structure, callback_structure_constructible, context);
c += binding_template_bases(R, callback_structure, callback_structure_constructible, context);
}
}
}
}
}
}
return c;
}
/// Create forward-binding for given class which consist of only class type without any member, function or constructors
string bind_forward_declaration(CXXRecordDecl const *C, Context &context)
{
string const qualified_name{ class_qualified_name(C) };
string const module_variable_name = context.module_variable_name( namespace_from_named_decl(C) );
//string const decl_namespace = namespace_from_named_decl(C);
string const include = relevant_include(C);
string c = "\t// Forward declaration for: " + qualified_name + " file:" + (include.size() ? include.substr(1, include.size()-2) : "") + " line:" + line_number(C) + "\n";
string maybe_holder_type = ", std::shared_ptr<{}>"_format(qualified_name);
if( is_inherited_from_enable_shared_from_this(C) ) maybe_holder_type = ", std::shared_ptr<{}>"_format(qualified_name);
else if( CXXDestructorDecl * d = C->getDestructor() ) {
if( d->getAccess() != AS_public ) maybe_holder_type = ", " + qualified_name + '*';
}
c += '\t' + R"(pybind11::class_<{}{}>({}, "{}");)"_format(qualified_name, maybe_holder_type, module_variable_name, python_class_name(C)) + "\n\n";
return c;
}
/// check if any of the base classes is wrappable and if generate a string describing them: , pybind11::base<BaseClass>()
string ClassBinder::maybe_base_classes(Context &context)
{
string r;
static std::vector<string> const skip_list = {"std::enable_shared_from_this", "std::string", "std::basic_string", "std::pair", "std::tuple"};
for(auto b = C->bases_begin(); b!=C->bases_end(); ++b) {
if( b->getAccessSpecifier() == AS_public) {
if( auto rt = dyn_cast<RecordType>(b->getType().getCanonicalType().getTypePtr() ) ) {
if(CXXRecordDecl *R = cast<CXXRecordDecl>(rt->getDecl()) ) {
auto e = std::find(skip_list.begin(), skip_list.end(), standard_name( R->getQualifiedNameAsString() ));
if( e == skip_list.end() and is_bindable(R) and !is_skipping_requested(R, Config::get()) ) {
//r = ", pybind11::base<{}>()"_format( class_qualified_name(R) );
r += ", {}"_format( class_qualified_name(R) );
binder::request_bindings(b->getType().getCanonicalType(), context);
dependencies_.push_back(R);
}
}
}
}
}
return r;
}
/// generate binding code for this object by using external user-provided binder
void ClassBinder::bind_with(string const &binder, Context &context)
{
string c = '\t' + generate_comment_for_declaration(C);
string const module_variable_name = context.module_variable_name( namespace_from_named_decl(C) );
c += '\t' + binder + standard_name( template_specialization(C) ) + '(' + module_variable_name;
if( auto t = dyn_cast<ClassTemplateSpecializationDecl>(C) ) {
for(uint i=0; i < t->getTemplateArgs().size(); ++i) {
string templ = mangle_type_name( standard_name( template_argument_to_string(t->getTemplateArgs()[i]) ), true);
fix_boolean_types(templ);
c += ", \"" + templ + '"';
}
}
c += ");\n\n";
code() = c;
}
struct ConstructorBindingInfo
{
CXXRecordDecl const * C;
CXXConstructorDecl const * T;
bool trampoline;
string class_qualified_name;
string trampoline_qualified_name;
Context &context;
};
//char const * constructor_template = "\tcl.def(\"__init__\", []({2} *self_{0}) {{ new (self_) {2}({1}); }}, \"doc\");";
//char const * constructor_if_template = "\tcl.def(\"__init__\", [cl_type](pybind11::handle self_{0}) {{ if (self_.get_type() == cl_type) new (self_.cast<{2} *>()) {2}({1}); else new (self_.cast<{3} *>()) {3}({1}); }}, \"doc\");";
char const * constructor_template = "\tcl.def( pybind11::init( []({0}){{ return new {2}({1}); }} ), \"doc\");";
char const * constructor_template_with_py_arg = "\tcl.def( pybind11::init( []({0}){{ return new {2}({1}); }} ), \"doc\" {3});";
char const * constructor_with_trampoline_template = "\tcl.def( pybind11::init( []({0}){{ return new {2}({1}); }}, []({0}){{ return new {3}({1}); }} ), \"doc\");";
//char const * constructor_lambda_template = "\tcl.def(pybind11::init( []({0}){{ return new {2}({1}); }}, []({0}){{ return new {3}({1}); }} ), \"doc\");";
// Generate binding for given function: .def("foo", (std::string (aaaa::A::*)(int) ) &aaaa::A::foo, "doc")
// constructor_types is pair<Base, Alias> - if one of these is absent empty string is expected
//string bind_constructor(CXXConstructorDecl const *T, pair<string, string> const &constructor_types, uint args_to_bind, bool request_bindings_f, Context &context)
string bind_constructor(ConstructorBindingInfo const &CBI, uint args_to_bind, bool request_bindings_f)
{
//string function_name = python_function_name(F);
//string function_qualified_name { F->getQualifiedNameAsString() };
string c;
if( args_to_bind == CBI.T->getNumParams() and not CBI.T->isVariadic()) {
c = "\tcl.def( pybind11::init<{}>()"_format( function_arguments(CBI.T) );
for(uint i=0; i<CBI.T->getNumParams() and i < args_to_bind; ++i) {
c += ", pybind11::arg(\"{}\")"_format( string( CBI.T->getParamDecl(i)->getName() ) );
if(request_bindings_f) request_bindings( CBI.T->getParamDecl(i)->getOriginalType(), CBI.context);
}
c += " );\n";
}
else {
pair<string, string> args = function_arguments_for_lambda(CBI.T, args_to_bind);
//string params = args_to_bind ? ", " + args.first : "";
string params = args_to_bind ? args.first : "";
string args_helper;
for(uint i=0; i<CBI.T->getNumParams() and i < args_to_bind; ++i) {
args_helper += ", pybind11::arg(\"{}\")"_format( string( CBI.T->getParamDecl(i)->getName() ) );
}
// if( CBI.T->isVariadic() ) c = fmt::format(constructor_lambda_template, params, args.second, constructor_types.first, constructor_types.second);
// else if( constructor_types.first.size() and constructor_types.second.size() ) c = fmt::format(constructor_lambda_template, params, args.second, constructor_types.first, constructor_types.second);
// else if( constructor_types.first.size() ) c = fmt::format(constructor_template, params, args.second, constructor_types.first);
// else c = fmt::format(constructor_template, params, args.second, constructor_types.second);
if( CBI.C->isAbstract() ) c = fmt::format(constructor_template, params, args.second, CBI.trampoline_qualified_name);
else if( CBI.trampoline ) c = fmt::format(constructor_with_trampoline_template, params, args.second, CBI.class_qualified_name, CBI.trampoline_qualified_name);
else c = fmt::format(constructor_template_with_py_arg, params, args.second, CBI.class_qualified_name, args_helper);
}
return c;
}
/// Generate code for binding default constructor
string bind_default_constructor(ConstructorBindingInfo const &CBI) // CXXRecordDecl const *, string const & binding_qualified_name)
{
// version before error: chosen constructor is explicit in copy-initialization
// return "\tcl.def(pybind11::init<>());__\n";
//return "\tcl.def( pybind11::init( [](){{ return new {0}(); }} ) );\n"_format(binding_qualified_name);
if( CBI.C->isAbstract() ) return "\tcl.def( pybind11::init( [](){{ return new {0}(); }} ) );\n"_format(CBI.trampoline_qualified_name);
else if( CBI.trampoline ) return "\tcl.def( pybind11::init( [](){{ return new {0}(); }}, [](){{ return new {1}(); }} ) );\n"_format(CBI.class_qualified_name, CBI.trampoline_qualified_name);
else return "\tcl.def( pybind11::init( [](){{ return new {0}(); }} ) );\n"_format(CBI.class_qualified_name);
}
/// Generate copy constructor in most cases this will be just: "\tcl.def(pybind11::init<{} const &>());\n"_format(binding_qualified_name);
/// but for POD structs with zero data mambers this will be a lambda function. This is done as a workaround for Pybind11 2,2+ bug
string bind_copy_constructor(ConstructorBindingInfo const &CBI) //CXXConstructorDecl const *T, string const & binding_qualified_name)
{
//CXXRecordDecl const *C = T->getParent();
//C->dump();
//outs() << "isCLike=" << C->isCLike() << " isTrivial=" << T->isTrivial() << " isEmpty=" << C->isEmpty() << " isPOD=" << C->isPOD() << " isAggregate=" << C->isAggregate() << "\n";