-
Notifications
You must be signed in to change notification settings - Fork 671
/
context.rs
1226 lines (1072 loc) · 44.5 KB
/
context.rs
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
//! Common context that is passed around during parsing and codegen.
use BindgenOptions;
use cexpr;
use clang::{self, Cursor};
use parse::ClangItemParser;
use std::borrow::Cow;
use std::cell::Cell;
use std::collections::{HashMap, VecDeque, hash_map};
use std::collections::btree_map::{self, BTreeMap};
use std::fmt;
use super::derive::{CanDeriveCopy, CanDeriveDebug};
use super::int::IntKind;
use super::item::{Item, ItemCanonicalPath};
use super::item_kind::ItemKind;
use super::module::Module;
use super::ty::{FloatKind, Type, TypeKind};
use super::type_collector::{ItemSet, TypeCollector};
use syntax::ast::Ident;
use syntax::codemap::{DUMMY_SP, Span};
use syntax::ext::base::ExtCtxt;
/// A single identifier for an item.
///
/// TODO: Build stronger abstractions on top of this, like TypeId(ItemId)?
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ItemId(usize);
impl ItemId {
/// Get a numeric representation of this id.
pub fn as_usize(&self) -> usize {
self.0
}
}
impl CanDeriveDebug for ItemId {
type Extra = ();
fn can_derive_debug(&self, ctx: &BindgenContext, _: ()) -> bool {
ctx.resolve_item(*self).can_derive_debug(ctx, ())
}
}
impl<'a> CanDeriveCopy<'a> for ItemId {
type Extra = ();
fn can_derive_copy(&self, ctx: &BindgenContext, _: ()) -> bool {
ctx.resolve_item(*self).can_derive_copy(ctx, ())
}
fn can_derive_copy_in_array(&self, ctx: &BindgenContext, _: ()) -> bool {
ctx.resolve_item(*self).can_derive_copy_in_array(ctx, ())
}
}
/// A key used to index a resolved type, so we only process it once.
///
/// This is almost always a USR string (an unique identifier generated by
/// clang), but it can also be the canonical declaration if the type is unnamed,
/// in which case clang may generate the same USR for multiple nested unnamed
/// types.
#[derive(Eq, PartialEq, Hash, Debug)]
enum TypeKey {
USR(String),
Declaration(Cursor),
}
// This is just convenience to avoid creating a manual debug impl for the
// context.
struct GenContext<'ctx>(ExtCtxt<'ctx>);
impl<'ctx> fmt::Debug for GenContext<'ctx> {
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
write!(fmt, "GenContext {{ ... }}")
}
}
/// A context used during parsing and generation of structs.
#[derive(Debug)]
pub struct BindgenContext<'ctx> {
/// The map of all the items parsed so far.
///
/// It's a BTreeMap because we want the keys to be sorted to have consistent
/// output.
items: BTreeMap<ItemId, Item>,
/// The next item id to use during this bindings regeneration.
next_item_id: ItemId,
/// Clang USR to type map. This is needed to be able to associate types with
/// item ids during parsing.
types: HashMap<TypeKey, ItemId>,
/// A cursor to module map. Similar reason than above.
modules: HashMap<Cursor, ItemId>,
/// The root module, this is guaranteed to be an item of kind Module.
root_module: ItemId,
/// Current module being traversed.
current_module: ItemId,
/// A stack with the current type declarations and types we're parsing. This
/// is needed to avoid infinite recursion when parsing a type like:
///
/// struct c { struct c* next; };
///
/// This means effectively, that a type has a potential ID before knowing if
/// it's a correct type. But that's not important in practice.
///
/// We could also use the `types` HashMap, but my intention with it is that
/// only valid types and declarations end up there, and this could
/// potentially break that assumption.
///
/// FIXME: Should not be public, though... meh.
pub currently_parsed_types: Vec<(Cursor, ItemId)>,
/// A HashSet with all the already parsed macro names. This is done to avoid
/// hard errors while parsing duplicated macros, as well to allow macro
/// expression parsing.
parsed_macros: HashMap<Vec<u8>, cexpr::expr::EvalResult>,
/// The active replacements collected from replaces="xxx" annotations.
replacements: HashMap<Vec<String>, ItemId>,
collected_typerefs: bool,
/// Dummy structures for code generation.
gen_ctx: Option<&'ctx GenContext<'ctx>>,
span: Span,
/// The clang index for parsing.
index: clang::Index,
/// The translation unit for parsing.
translation_unit: clang::TranslationUnit,
/// The options given by the user via cli or other medium.
options: BindgenOptions,
/// Whether a bindgen complex was generated
generated_bindegen_complex: Cell<bool>,
}
impl<'ctx> BindgenContext<'ctx> {
/// Construct the context for the given `options`.
pub fn new(options: BindgenOptions) -> Self {
use clang_sys;
let index = clang::Index::new(false, true);
let parse_options =
clang_sys::CXTranslationUnit_DetailedPreprocessingRecord;
let translation_unit =
clang::TranslationUnit::parse(&index,
"",
&options.clang_args,
&[],
parse_options)
.expect("TranslationUnit::parse");
let root_module = Self::build_root_module(ItemId(0));
let mut me = BindgenContext {
items: Default::default(),
types: Default::default(),
modules: Default::default(),
next_item_id: ItemId(1),
root_module: root_module.id(),
current_module: root_module.id(),
currently_parsed_types: vec![],
parsed_macros: Default::default(),
replacements: Default::default(),
collected_typerefs: false,
gen_ctx: None,
span: DUMMY_SP,
index: index,
translation_unit: translation_unit,
options: options,
generated_bindegen_complex: Cell::new(false),
};
me.add_item(root_module, None, None);
me
}
/// Define a new item.
///
/// This inserts it into the internal items set, and its type into the
/// internal types set.
pub fn add_item(&mut self,
item: Item,
declaration: Option<Cursor>,
location: Option<Cursor>) {
debug!("BindgenContext::add_item({:?}, declaration: {:?}, loc: {:?}",
item,
declaration,
location);
debug_assert!(declaration.is_some() || !item.kind().is_type() ||
item.kind().expect_type().is_builtin_or_named(),
"Adding a type without declaration?");
let id = item.id();
let is_type = item.kind().is_type();
let is_unnamed = is_type && item.expect_type().name().is_none();
// Be sure to track all the generated children under namespace, even
// those generated after resolving typerefs, etc.
if item.id() != item.parent_id() {
if let Some(mut parent) = self.items.get_mut(&item.parent_id()) {
if let Some(mut module) = parent.as_module_mut() {
module.children_mut().push(item.id());
}
}
}
let old_item = self.items.insert(id, item);
assert!(old_item.is_none(), "Inserted type twice?");
// Unnamed items can have an USR, but they can't be referenced from
// other sites explicitly and the USR can match if the unnamed items are
// nested, so don't bother tracking them.
if is_type && declaration.is_some() {
let mut declaration = declaration.unwrap();
if !declaration.is_valid() {
if let Some(location) = location {
if location.is_template_like() {
declaration = location;
}
}
}
declaration = declaration.canonical();
if !declaration.is_valid() {
// This could happen, for example, with types like `int*` or
// similar.
//
// Fortunately, we don't care about those types being
// duplicated, so we can just ignore them.
debug!("Invalid declaration {:?} found for type {:?}",
declaration,
self.items.get(&id).unwrap().kind().expect_type());
return;
}
let key = if is_unnamed {
TypeKey::Declaration(declaration)
} else if let Some(usr) = declaration.usr() {
TypeKey::USR(usr)
} else {
error!("Valid declaration with no USR: {:?}, {:?}",
declaration,
location);
TypeKey::Declaration(declaration)
};
let old = self.types.insert(key, id);
debug_assert_eq!(old, None);
}
}
// TODO: Move all this syntax crap to other part of the code.
/// Given that we are in the codegen phase, get the syntex context.
pub fn ext_cx(&self) -> &ExtCtxt<'ctx> {
&self.gen_ctx.expect("Not in gen phase").0
}
/// Given that we are in the codegen phase, get the current syntex span.
pub fn span(&self) -> Span {
self.span
}
/// Mangles a name so it doesn't conflict with any keyword.
pub fn rust_mangle<'a>(&self, name: &'a str) -> Cow<'a, str> {
use syntax::parse::token;
let ident = self.rust_ident_raw(name);
let token = token::Ident(ident);
if token.is_any_keyword() || name.contains("@") ||
name.contains("?") || name.contains("$") ||
"bool" == name {
let mut s = name.to_owned();
s = s.replace("@", "_");
s = s.replace("?", "_");
s = s.replace("$", "_");
s.push_str("_");
return Cow::Owned(s);
}
Cow::Borrowed(name)
}
/// Returns a mangled name as a rust identifier.
pub fn rust_ident(&self, name: &str) -> Ident {
self.rust_ident_raw(&self.rust_mangle(name))
}
/// Returns a mangled name as a rust identifier.
pub fn rust_ident_raw(&self, name: &str) -> Ident {
self.ext_cx().ident_of(name)
}
/// Iterate over all items that have been defined.
pub fn items<'a>(&'a self) -> btree_map::Iter<'a, ItemId, Item> {
self.items.iter()
}
/// Have we collected all unresolved type references yet?
pub fn collected_typerefs(&self) -> bool {
self.collected_typerefs
}
/// Gather all the unresolved type references.
fn collect_typerefs
(&mut self)
-> Vec<(ItemId, clang::Type, Option<clang::Cursor>, Option<ItemId>)> {
debug_assert!(!self.collected_typerefs);
self.collected_typerefs = true;
let mut typerefs = vec![];
for (id, ref mut item) in &mut self.items {
let kind = item.kind();
let ty = match kind.as_type() {
Some(ty) => ty,
None => continue,
};
match *ty.kind() {
TypeKind::UnresolvedTypeRef(ref ty, loc, parent_id) => {
typerefs.push((*id, ty.clone(), loc, parent_id));
}
_ => {}
};
}
typerefs
}
/// Collect all of our unresolved type references and resolve them.
fn resolve_typerefs(&mut self) {
let typerefs = self.collect_typerefs();
for (id, ty, loc, parent_id) in typerefs {
let _resolved = {
let resolved = Item::from_ty(&ty, loc, parent_id, self)
.expect("What happened?");
let mut item = self.items.get_mut(&id).unwrap();
*item.kind_mut().as_type_mut().unwrap().kind_mut() =
TypeKind::ResolvedTypeRef(resolved);
resolved
};
// Something in the STL is trolling me. I don't need this assertion
// right now, but worth investigating properly once this lands.
//
// debug_assert!(self.items.get(&resolved).is_some(), "How?");
}
}
/// Iterate over all items and replace any item that has been named in a
/// `replaces="SomeType"` annotation with the replacement type.
fn process_replacements(&mut self) {
if self.replacements.is_empty() {
debug!("No replacements to process");
return;
}
// FIXME: This is linear, but the replaces="xxx" annotation was already
// there, and for better or worse it's useful, sigh...
//
// We leverage the ResolvedTypeRef thing, though, which is cool :P.
let mut replacements = vec![];
for (id, item) in self.items.iter() {
if item.annotations().use_instead_of().is_some() {
continue;
}
// Calls to `canonical_name` are expensive, so eagerly filter out
// items that cannot be replaced.
let ty = match item.kind().as_type() {
Some(ty) => ty,
None => continue,
};
match *ty.kind() {
TypeKind::Comp(ref ci) if !ci.is_template_specialization() => {}
TypeKind::TemplateAlias(..) |
TypeKind::Alias(..) => {}
_ => continue,
}
let path = item.canonical_path(self);
let replacement = self.replacements.get(&path[1..]);
if let Some(replacement) = replacement {
if replacement != id {
// We set this just after parsing the annotation. It's
// very unlikely, but this can happen.
if self.items.get(replacement).is_some() {
replacements.push((*id, *replacement));
}
}
}
}
for (id, replacement) in replacements {
debug!("Replacing {:?} with {:?}", id, replacement);
let new_parent = {
let mut item = self.items.get_mut(&id).unwrap();
*item.kind_mut().as_type_mut().unwrap().kind_mut() =
TypeKind::ResolvedTypeRef(replacement);
item.parent_id()
};
// Reparent the item.
let old_parent = self.resolve_item(replacement).parent_id();
if new_parent == old_parent {
continue;
}
if let Some(mut module) = self.items
.get_mut(&old_parent)
.unwrap()
.as_module_mut() {
// Deparent the replacement.
let position = module.children()
.iter()
.position(|id| *id == replacement)
.unwrap();
module.children_mut().remove(position);
}
if let Some(mut module) = self.items
.get_mut(&new_parent)
.unwrap()
.as_module_mut() {
module.children_mut().push(replacement);
}
self.items
.get_mut(&replacement)
.unwrap()
.set_parent_for_replacement(new_parent);
self.items
.get_mut(&id)
.unwrap()
.set_parent_for_replacement(old_parent);
}
}
/// Enter the code generation phase, invoke the given callback `cb`, and
/// leave the code generation phase.
pub fn gen<F, Out>(&mut self, cb: F) -> Out
where F: FnOnce(&Self) -> Out,
{
use syntax::ext::expand::ExpansionConfig;
use syntax::codemap::{ExpnInfo, MacroBang, NameAndSpan};
use syntax::ext::base;
use syntax::parse;
use std::mem;
let cfg = ExpansionConfig::default("xxx".to_owned());
let sess = parse::ParseSess::new();
let mut loader = base::DummyResolver;
let mut ctx = GenContext(base::ExtCtxt::new(&sess, cfg, &mut loader));
ctx.0.bt_push(ExpnInfo {
call_site: self.span,
callee: NameAndSpan {
format: MacroBang(parse::token::intern("")),
allow_internal_unstable: false,
span: None,
},
});
// FIXME: This is evil, we should move code generation to use a wrapper
// of BindgenContext instead, I guess. Even though we know it's fine
// because we remove it before the end of this function.
self.gen_ctx = Some(unsafe { mem::transmute(&ctx) });
self.assert_no_dangling_references();
if !self.collected_typerefs() {
self.resolve_typerefs();
self.process_replacements();
}
let ret = cb(self);
self.gen_ctx = None;
ret
}
/// This function trying to find any dangling references inside of `items`
fn assert_no_dangling_references(&self) {
if cfg!(feature = "assert_no_dangling_items") {
for _ in self.assert_no_dangling_item_traversal() {
// The iterator's next method does the asserting for us.
}
}
}
fn assert_no_dangling_item_traversal<'me>
(&'me self)
-> AssertNoDanglingItemIter<'me, 'ctx> {
assert!(self.in_codegen_phase());
assert!(self.current_module == self.root_module);
let mut roots = self.items().map(|(&id, _)| id);
let mut seen = BTreeMap::<ItemId, ItemId>::new();
let next_child = roots.next().map(|id| id).unwrap();
seen.insert(next_child, next_child);
let to_iterate = seen.iter().map(|(&id, _)| id).rev().collect();
AssertNoDanglingItemIter {
ctx: self,
seen: seen,
to_iterate: to_iterate,
}
}
// This deserves a comment. Builtin types don't get a valid declaration, so
// we can't add it to the cursor->type map.
//
// That being said, they're not generated anyway, and are few, so the
// duplication and special-casing is fine.
//
// If at some point we care about the memory here, probably a map TypeKind
// -> builtin type ItemId would be the best to improve that.
fn add_builtin_item(&mut self, item: Item) {
debug!("add_builtin_item: item = {:?}", item);
debug_assert!(item.kind().is_type());
let id = item.id();
let old_item = self.items.insert(id, item);
assert!(old_item.is_none(), "Inserted type twice?");
}
fn build_root_module(id: ItemId) -> Item {
let module = Module::new(Some("root".into()));
Item::new(id, None, None, id, ItemKind::Module(module))
}
/// Get the root module.
pub fn root_module(&self) -> ItemId {
self.root_module
}
/// Resolve the given `ItemId` as a type.
///
/// Panics if there is no item for the given `ItemId` or if the resolved
/// item is not a `Type`.
pub fn resolve_type(&self, type_id: ItemId) -> &Type {
self.items.get(&type_id).unwrap().kind().expect_type()
}
/// Resolve the given `ItemId` as a type, or `None` if there is no item with
/// the given id.
///
/// Panics if the id resolves to an item that is not a type.
pub fn safe_resolve_type(&self, type_id: ItemId) -> Option<&Type> {
self.items.get(&type_id).map(|t| t.kind().expect_type())
}
/// Resolve the given `ItemId` into an `Item`, or `None` if no such item
/// exists.
pub fn resolve_item_fallible(&self, item_id: ItemId) -> Option<&Item> {
self.items.get(&item_id)
}
/// Resolve the given `ItemId` into an `Item`.
///
/// Panics if the given id does not resolve to any item.
pub fn resolve_item(&self, item_id: ItemId) -> &Item {
match self.items.get(&item_id) {
Some(item) => item,
None => panic!("Not an item: {:?}", item_id),
}
}
/// Get the current module.
pub fn current_module(&self) -> ItemId {
self.current_module
}
/// This is one of the hackiest methods in all the parsing code. This method
/// is used to allow having templates with another argument names instead of
/// the canonical ones.
///
/// This is surprisingly difficult to do with libclang, due to the fact that
/// partial template specializations don't provide explicit template
/// argument information.
///
/// The only way to do this as far as I know, is inspecting manually the
/// AST, looking for TypeRefs inside. This, unfortunately, doesn't work for
/// more complex cases, see the comment on the assertion below.
///
/// To see an example of what this handles:
///
/// ```c++
/// template<typename T>
/// class Incomplete {
/// T p;
/// };
///
/// template<typename U>
/// class Foo {
/// Incomplete<U> bar;
/// };
/// ```
fn build_template_wrapper(&mut self,
with_id: ItemId,
wrapping: ItemId,
parent_id: ItemId,
ty: &clang::Type,
location: clang::Cursor,
declaration: clang::Cursor)
-> ItemId {
use clang_sys::*;
let mut args = vec![];
location.visit(|c| {
if c.kind() == CXCursor_TypeRef {
// The `with_id` id will potentially end up unused if we give up
// on this type (for example, its a tricky partial template
// specialization), so if we pass `with_id` as the parent, it is
// potentially a dangling reference. Instead, use the canonical
// template declaration as the parent. It is already parsed and
// has a known-resolvable `ItemId`.
let new_ty = Item::from_ty_or_ref(c.cur_type(),
Some(c),
Some(wrapping),
self);
args.push(new_ty);
}
CXChildVisit_Continue
});
let item = {
let wrapping_type = self.resolve_type(wrapping);
if let TypeKind::Comp(ref ci) = *wrapping_type.kind() {
let old_args = ci.template_args();
// The following assertion actually fails with partial template
// specialization. But as far as I know there's no way at all to
// grab the specialized types from neither the AST or libclang,
// which sucks. The same happens for specialized type alias
// template declarations, where we have that ugly hack up there.
//
// This flaw was already on the old parser, but I now think it
// has no clear solution (apart from patching libclang to
// somehow expose them, of course).
//
// For an easy example in which there's no way at all of getting
// the `int` type, except manually parsing the spelling:
//
// template<typename T, typename U>
// class Incomplete {
// T d;
// U p;
// };
//
// template<typename U>
// class Foo {
// Incomplete<U, int> bar;
// };
//
// debug_assert_eq!(old_args.len(), args.len());
//
// That being said, this is not so common, so just error! and
// hope for the best, returning the previous type, who knows.
if old_args.len() != args.len() {
error!("Found partial template specialization, \
expect dragons!");
return wrapping;
}
} else {
assert_eq!(declaration.kind(),
::clang_sys::CXCursor_TypeAliasTemplateDecl,
"Expected wrappable type");
}
let type_kind = TypeKind::TemplateRef(wrapping, args);
let name = ty.spelling();
let name = if name.is_empty() { None } else { Some(name) };
let ty = Type::new(name,
ty.fallible_layout().ok(),
type_kind,
ty.is_const());
Item::new(with_id, None, None, parent_id, ItemKind::Type(ty))
};
// Bypass all the validations in add_item explicitly.
debug!("build_template_wrapper: inserting item: {:?}", item);
debug_assert!(with_id == item.id());
self.items.insert(with_id, item);
with_id
}
/// Looks up for an already resolved type, either because it's builtin, or
/// because we already have it in the map.
pub fn builtin_or_resolved_ty(&mut self,
with_id: ItemId,
parent_id: Option<ItemId>,
ty: &clang::Type,
location: Option<clang::Cursor>)
-> Option<ItemId> {
use clang_sys::{CXCursor_TypeAliasTemplateDecl, CXCursor_TypeRef};
debug!("builtin_or_resolved_ty: {:?}, {:?}, {:?}",
ty,
location,
parent_id);
let mut declaration = ty.declaration();
if !declaration.is_valid() {
if let Some(location) = location {
if location.is_template_like() {
declaration = location;
}
}
}
let canonical_declaration = declaration.canonical();
if canonical_declaration.is_valid() {
let id = self.types
.get(&TypeKey::Declaration(canonical_declaration))
.map(|id| *id)
.or_else(|| {
canonical_declaration.usr()
.and_then(|usr| self.types.get(&TypeKey::USR(usr)))
.map(|id| *id)
});
if let Some(id) = id {
debug!("Already resolved ty {:?}, {:?}, {:?} {:?}",
id,
declaration,
ty,
location);
// If the declaration existed, we *might* be done, but it's not
// the case for class templates, where the template arguments
// may vary.
//
// In this case, we create a TemplateRef with the new template
// arguments, pointing to the canonical template.
//
// Note that we only do it if parent_id is some, and we have a
// location for building the new arguments, the template
// argument names don't matter in the global context.
if declaration.is_template_like() &&
*ty != canonical_declaration.cur_type() &&
location.is_some() &&
parent_id.is_some() {
// For specialized type aliases, there's no way to get the
// template parameters as of this writing (for a struct
// specialization we wouldn't be in this branch anyway).
//
// Explicitly return `None` if there aren't any
// unspecialized parameters (contains any `TypeRef`) so we
// resolve the canonical type if there is one and it's
// exposed.
//
// This is _tricky_, I know :(
if declaration.kind() == CXCursor_TypeAliasTemplateDecl &&
!location.unwrap().contains_cursor(CXCursor_TypeRef) &&
ty.canonical_type().is_valid_and_exposed() {
return None;
}
return Some(self.build_template_wrapper(with_id,
id,
parent_id.unwrap(),
ty,
location.unwrap(),
declaration));
}
return Some(self.build_ty_wrapper(with_id, id, parent_id, ty));
}
}
debug!("Not resolved, maybe builtin?");
// Else, build it.
self.build_builtin_ty(ty, declaration)
}
// This is unfortunately a lot of bloat, but is needed to properly track
// constness et. al.
//
// We should probably make the constness tracking separate, so it doesn't
// bloat that much, but hey, we already bloat the heck out of builtin types.
fn build_ty_wrapper(&mut self,
with_id: ItemId,
wrapped_id: ItemId,
parent_id: Option<ItemId>,
ty: &clang::Type)
-> ItemId {
let spelling = ty.spelling();
let is_const = ty.is_const();
let layout = ty.fallible_layout().ok();
let type_kind = TypeKind::ResolvedTypeRef(wrapped_id);
let ty = Type::new(Some(spelling), layout, type_kind, is_const);
let item = Item::new(with_id,
None,
None,
parent_id.unwrap_or(self.current_module),
ItemKind::Type(ty));
self.add_builtin_item(item);
with_id
}
/// Returns the next item id to be used for an item.
pub fn next_item_id(&mut self) -> ItemId {
let ret = self.next_item_id;
self.next_item_id = ItemId(self.next_item_id.0 + 1);
ret
}
fn build_builtin_ty(&mut self,
ty: &clang::Type,
_declaration: Cursor)
-> Option<ItemId> {
use clang_sys::*;
let type_kind = match ty.kind() {
CXType_NullPtr => TypeKind::NullPtr,
CXType_Void => TypeKind::Void,
CXType_Bool => TypeKind::Int(IntKind::Bool),
CXType_Int => TypeKind::Int(IntKind::Int),
CXType_UInt => TypeKind::Int(IntKind::UInt),
CXType_SChar | CXType_Char_S => TypeKind::Int(IntKind::Char),
CXType_UChar | CXType_Char_U => TypeKind::Int(IntKind::UChar),
CXType_Short => TypeKind::Int(IntKind::Short),
CXType_UShort => TypeKind::Int(IntKind::UShort),
CXType_WChar | CXType_Char16 => TypeKind::Int(IntKind::U16),
CXType_Char32 => TypeKind::Int(IntKind::U32),
CXType_Long => TypeKind::Int(IntKind::Long),
CXType_ULong => TypeKind::Int(IntKind::ULong),
CXType_LongLong => TypeKind::Int(IntKind::LongLong),
CXType_ULongLong => TypeKind::Int(IntKind::ULongLong),
CXType_Int128 => TypeKind::Int(IntKind::I128),
CXType_UInt128 => TypeKind::Int(IntKind::U128),
CXType_Float => TypeKind::Float(FloatKind::Float),
CXType_Double => TypeKind::Float(FloatKind::Double),
CXType_LongDouble => TypeKind::Float(FloatKind::LongDouble),
CXType_Float128 => TypeKind::Float(FloatKind::Float128),
CXType_Complex => {
let float_type = ty.elem_type()
.expect("Not able to resolve complex type?");
let float_kind = match float_type.kind() {
CXType_Float => FloatKind::Float,
CXType_Double => FloatKind::Double,
CXType_LongDouble => FloatKind::LongDouble,
_ => panic!("Non floating-type complex?"),
};
TypeKind::Complex(float_kind)
}
_ => return None,
};
let spelling = ty.spelling();
let is_const = ty.is_const();
let layout = ty.fallible_layout().ok();
let ty = Type::new(Some(spelling), layout, type_kind, is_const);
let id = self.next_item_id();
let item =
Item::new(id, None, None, self.root_module, ItemKind::Type(ty));
self.add_builtin_item(item);
Some(id)
}
/// Get the current Clang translation unit that is being processed.
pub fn translation_unit(&self) -> &clang::TranslationUnit {
&self.translation_unit
}
/// Have we parsed the macro named `macro_name` already?
pub fn parsed_macro(&self, macro_name: &[u8]) -> bool {
self.parsed_macros.contains_key(macro_name)
}
/// Get the currently parsed macros.
pub fn parsed_macros(&self) -> &HashMap<Vec<u8>, cexpr::expr::EvalResult> {
debug_assert!(!self.in_codegen_phase());
&self.parsed_macros
}
/// Mark the macro named `macro_name` as parsed.
pub fn note_parsed_macro(&mut self,
id: Vec<u8>,
value: cexpr::expr::EvalResult) {
self.parsed_macros.insert(id, value);
}
/// Are we in the codegen phase?
pub fn in_codegen_phase(&self) -> bool {
self.gen_ctx.is_some()
}
/// Mark the type with the given `name` as replaced by the type with id
/// `potential_ty`.
///
/// Replacement types are declared using the `replaces="xxx"` annotation,
/// and implies that the original type is hidden.
pub fn replace(&mut self, name: &[String], potential_ty: ItemId) {
match self.replacements.entry(name.into()) {
hash_map::Entry::Vacant(entry) => {
debug!("Defining replacement for {:?} as {:?}",
name,
potential_ty);
entry.insert(potential_ty);
}
hash_map::Entry::Occupied(occupied) => {
warn!("Replacement for {:?} already defined as {:?}; \
ignoring duplicate replacement definition as {:?}",
name,
occupied.get(),
potential_ty);
}
}
}
/// Is the item with the given `name` hidden? Or is the item with the given
/// `name` and `id` replaced by another type, and effectively hidden?
pub fn hidden_by_name(&self, path: &[String], id: ItemId) -> bool {
debug_assert!(self.in_codegen_phase(),
"You're not supposed to call this yet");
self.options.hidden_types.contains(&path[1..].join("::")) ||
self.is_replaced_type(path, id)
}
/// Has the item with the given `name` and `id` been replaced by another
/// type?
pub fn is_replaced_type(&self, path: &[String], id: ItemId) -> bool {
match self.replacements.get(path) {
Some(replaced_by) if *replaced_by != id => true,
_ => false,
}
}
/// Is the type with the given `name` marked as opaque?
pub fn opaque_by_name(&self, path: &[String]) -> bool {
debug_assert!(self.in_codegen_phase(),
"You're not supposed to call this yet");
self.options.opaque_types.contains(&path[1..].join("::"))
}
/// Get the options used to configure this bindgen context.
pub fn options(&self) -> &BindgenOptions {
&self.options
}
/// Given a CXCursor_Namespace cursor, return the item id of the
/// corresponding module, or create one on the fly.
pub fn module(&mut self, cursor: clang::Cursor) -> ItemId {
use clang_sys::*;
assert!(cursor.kind() == CXCursor_Namespace, "Be a nice person");
let cursor = cursor.canonical();
if let Some(id) = self.modules.get(&cursor) {
return *id;
}
let module_id = self.next_item_id();
let module_name = self.translation_unit
.tokens(&cursor)
.and_then(|tokens| {
if tokens.len() <= 1 {
None
} else {
match &*tokens[1].spelling {
"{" => None,
s => Some(s.to_owned()),
}
}
});
let module = Module::new(module_name);
let module = Item::new(module_id,
None,
None,
self.current_module,
ItemKind::Module(module));
self.modules.insert(cursor, module.id());
self.add_item(module, None, None);
module_id
}
/// Start traversing the module with the given `module_id`, invoke the
/// callback `cb`, and then return to traversing the original module.
pub fn with_module<F>(&mut self, module_id: ItemId, cb: F)
where F: FnOnce(&mut Self),
{
debug_assert!(self.resolve_item(module_id).kind().is_module(), "Wat");
let previous_id = self.current_module;
self.current_module = module_id;
cb(self);