This repository was archived by the owner on Sep 9, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 162
Expand file tree
/
Copy pathgraph.rs
More file actions
1632 lines (1467 loc) · 53.4 KB
/
graph.rs
File metadata and controls
1632 lines (1467 loc) · 53.4 KB
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
// -*- coding: utf-8 -*-
// ------------------------------------------------------------------------------------------------
// Copyright © 2021, stack-graphs authors.
// Licensed under either of Apache License, Version 2.0, or MIT license, at your option.
// Please see the LICENSE-APACHE or LICENSE-MIT files in this distribution for license details.
// ------------------------------------------------------------------------------------------------
//! Defines the structure of a stack graph.
//!
//! This module contains all of the types that you need to define the structure of a particular
//! stack graph.
//!
//! The stack graph as a whole lives in an instance of [`StackGraph`][]. This type contains
//! several [`Arena`s][`Arena`], which are used to manage the life cycle of the data instances that
//! comprise the stack graph. You cannot delete anything from the stack graph; all of its contents
//! are dropped in a single operation when the graph itself is dropped.
//!
//! [`Arena`]: ../arena/struct.Arena.html
//! [`StackGraph`]: struct.StackGraph.html
//!
//! There are several different kinds of node that can appear in a stack graph. As we search for a
//! path representing a name binding, each kind of node has different rules for how it interacts
//! with the symbol and scope stacks:
//!
//! - the singleton [_root node_][`RootNode`], which allows name binding paths to cross between
//! files
//! - [_scope_][`ScopeNode`] nodes, which define the name binding structure within a single file
//! - [_push symbol_][`PushSymbolNode`] and [_push scoped symbol_][`PushScopedSymbolNode`] nodes,
//! which push onto the symbol stack new things for us to look for
//! - [_pop symbol_][`PopSymbolNode`] and [_pop scoped symbol_][`PopScopedSymbolNode`] nodes,
//! which pop things off the symbol stack once they've been found
//! - [_drop scopes_][`DropScopesNode`] and [_jump to scope_][`JumpToNode`] nodes, which
//! manipulate the scope stack
//!
//! [`DropScopesNode`]: struct.DropScopesNode.html
//! [`JumpToNode`]: struct.JumpToNode.html
//! [`PushScopedSymbolNode`]: struct.PushScopedSymbolNode.html
//! [`PushSymbolNode`]: struct.PushSymbolNode.html
//! [`PopScopedSymbolNode`]: struct.PopScopedSymbolNode.html
//! [`PopSymbolNode`]: struct.PopSymbolNode.html
//! [`RootNode`]: struct.RootNode.html
//! [`ScopeNode`]: struct.ScopeNode.html
//!
//! All nodes except for the singleton _root node_ and _jump to scope_ node belong to
//! [files][`File`].
//!
//! Nodes are connected via [edges][`Edge`].
//!
//! [`Edge`]: struct.Edge.html
//! [`File`]: struct.File.html
use std::collections::HashMap;
use std::fmt::Display;
use std::num::NonZeroU32;
use std::ops::Index;
use std::ops::IndexMut;
use controlled_option::ControlledOption;
use either::Either;
use fxhash::FxHashMap;
use smallvec::SmallVec;
use crate::arena::Arena;
use crate::arena::Handle;
use crate::arena::SupplementalArena;
//-------------------------------------------------------------------------------------------------
// String content
#[repr(C)]
struct InternedStringContent {
// See InternedStringArena below for how we fill in these fields safely.
start: *const u8,
len: usize,
}
const INITIAL_STRING_CAPACITY: usize = 512;
/// The content of each interned string is stored in one of the buffers inside of a
/// `InternedStringArena` instance, following the trick [described by Aleksey Kladov][interner].
///
/// The buffers stored in this type are preallocated, and are never allowed to grow. That ensures
/// that pointers into the buffer are stable, as long as the buffer has not been destroyed.
/// (`InternedStringContent` instances are also stored in an arena, ensuring that the strings that
/// we hand out don't outlive the buffers.)
///
/// [interner]: https://matklad.github.io/2020/03/22/fast-simple-rust-interner.html
struct InternedStringArena {
current_buffer: Vec<u8>,
full_buffers: Vec<Vec<u8>>,
}
impl InternedStringArena {
fn new() -> InternedStringArena {
InternedStringArena {
current_buffer: Vec::with_capacity(INITIAL_STRING_CAPACITY),
full_buffers: Vec::new(),
}
}
// Adds a new string. This does not check whether we've already stored a string with the same
// content; that is handled down below in `StackGraph::add_symbol` and `add_file`.
fn add(&mut self, value: &str) -> InternedStringContent {
// Is there enough room in current_buffer to hold this string?
let value = value.as_bytes();
let len = value.len();
let capacity = self.current_buffer.capacity();
let remaining_capacity = capacity - self.current_buffer.len();
if len > remaining_capacity {
// If not, move current_buffer over into full_buffers (so that we hang onto it until
// we're dropped) and allocate a new current_buffer that's at least big enough to hold
// this string.
let new_capacity = (capacity.max(len) + 1).next_power_of_two();
let new_buffer = Vec::with_capacity(new_capacity);
let old_buffer = std::mem::replace(&mut self.current_buffer, new_buffer);
self.full_buffers.push(old_buffer);
}
// Copy the string's content into current_buffer and return a pointer to it. That pointer
// is stable since we never allow the current_buffer to be resized — once we run out of
// room, we allocate a _completely new buffer_ to replace it.
let start_index = self.current_buffer.len();
self.current_buffer.extend_from_slice(value);
let start = unsafe { self.current_buffer.as_ptr().add(start_index) };
InternedStringContent { start, len }
}
}
impl InternedStringContent {
/// Returns the content of this string as a `str`. This is safe as long as the lifetime of the
/// InternedStringContent is outlived by the lifetime of the InternedStringArena that holds its
/// data. That is guaranteed because we store the InternedStrings in an Arena alongside the
/// InternedStringArena, and only hand out references to them.
fn as_str(&self) -> &str {
unsafe {
let bytes = std::slice::from_raw_parts(self.start, self.len);
std::str::from_utf8_unchecked(bytes)
}
}
// Returns a supposedly 'static reference to the string's data. The string data isn't really
// static, but we are careful only to use this as a key in the HashMap that StackGraph uses to
// track whether we've stored a particular symbol already. That HashMap lives alongside the
// InternedStringArena that holds the data, so we can get away with a technically incorrect
// 'static lifetime here. As an extra precaution, this method is is marked as unsafe so that
// we don't inadvertently call it from anywhere else in the crate.
unsafe fn as_hash_key(&self) -> &'static str {
let bytes = std::slice::from_raw_parts(self.start, self.len);
std::str::from_utf8_unchecked(bytes)
}
}
unsafe impl Send for InternedStringContent {}
unsafe impl Sync for InternedStringContent {}
//-------------------------------------------------------------------------------------------------
// Symbols
/// A name that we are trying to resolve using stack graphs.
///
/// This typically represents a portion of an identifier as it appears in the source language. It
/// can also represent some other "operation" that can occur in source code, and which needs to be
/// modeled in a stack graph — for instance, many languages will use a "fake" symbol named `.` to
/// represent member access.
///
/// We deduplicate `Symbol` instances in a `StackGraph` — that is, we ensure that there are never
/// multiple `Symbol` instances with the same content. That means that you can compare _handles_
/// to symbols using simple equality, without having to dereference into the `StackGraph` arena.
#[repr(C)]
pub struct Symbol {
content: InternedStringContent,
}
impl Symbol {
pub fn as_str(&self) -> &str {
self.content.as_str()
}
}
impl PartialEq<&str> for Symbol {
fn eq(&self, other: &&str) -> bool {
self.as_str() == *other
}
}
impl StackGraph {
/// Adds a symbol to the stack graph, ensuring that there's only ever one copy of a particular
/// symbol stored in the graph.
pub fn add_symbol<S: AsRef<str> + ?Sized>(&mut self, symbol: &S) -> Handle<Symbol> {
let symbol = symbol.as_ref();
if let Some(handle) = self.symbol_handles.get(symbol) {
return *handle;
}
let interned = self.interned_strings.add(symbol);
let hash_key = unsafe { interned.as_hash_key() };
let handle = self.symbols.add(Symbol { content: interned });
self.symbol_handles.insert(hash_key, handle);
handle
}
/// Returns an iterator over all of the handles of all of the symbols in this stack graph.
/// (Note that because we're only returning _handles_, this iterator does not retain a
/// reference to the `StackGraph`.)
pub fn iter_symbols(&self) -> impl Iterator<Item = Handle<Symbol>> {
self.symbols.iter_handles()
}
}
impl Index<Handle<Symbol>> for StackGraph {
type Output = str;
#[inline(always)]
fn index(&self, handle: Handle<Symbol>) -> &str {
self.symbols.get(handle).as_str()
}
}
#[doc(hidden)]
pub struct DisplaySymbol<'a> {
wrapped: Handle<Symbol>,
graph: &'a StackGraph,
}
impl<'a> Display for DisplaySymbol<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{}", &self.graph[self.wrapped])
}
}
impl Handle<Symbol> {
pub fn display(self, graph: &StackGraph) -> impl Display + '_ {
DisplaySymbol {
wrapped: self,
graph,
}
}
}
//-------------------------------------------------------------------------------------------------
// Interned strings
/// Arbitrary string content associated with some part of a stack graph.
#[repr(C)]
pub struct InternedString {
content: InternedStringContent,
}
impl InternedString {
fn as_str(&self) -> &str {
self.content.as_str()
}
}
impl PartialEq<&str> for InternedString {
fn eq(&self, other: &&str) -> bool {
self.as_str() == *other
}
}
impl StackGraph {
/// Adds an interned string to the stack graph, ensuring that there's only ever one copy of a
/// particular string stored in the graph.
pub fn add_string<S: AsRef<str> + ?Sized>(&mut self, string: &S) -> Handle<InternedString> {
let string = string.as_ref();
if let Some(handle) = self.string_handles.get(string) {
return *handle;
}
let interned = self.interned_strings.add(string);
let hash_key = unsafe { interned.as_hash_key() };
let handle = self.strings.add(InternedString { content: interned });
self.string_handles.insert(hash_key, handle);
handle
}
/// Returns an iterator over all of the handles of all of the interned strings in this stack
/// graph. (Note that because we're only returning _handles_, this iterator does not retain a
/// reference to the `StackGraph`.)
pub fn iter_strings(&self) -> impl Iterator<Item = Handle<InternedString>> {
self.strings.iter_handles()
}
}
impl Index<Handle<InternedString>> for StackGraph {
type Output = str;
#[inline(always)]
fn index(&self, handle: Handle<InternedString>) -> &str {
self.strings.get(handle).as_str()
}
}
#[doc(hidden)]
pub struct DisplayInternedString<'a> {
wrapped: Handle<InternedString>,
graph: &'a StackGraph,
}
impl<'a> Display for DisplayInternedString<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{}", &self.graph[self.wrapped])
}
}
impl Handle<InternedString> {
pub fn display(self, graph: &StackGraph) -> impl Display + '_ {
DisplayInternedString {
wrapped: self,
graph,
}
}
}
//-------------------------------------------------------------------------------------------------
// Files
/// A source file that we have extracted stack graph data from.
///
/// It's up to you to choose what names to use for your files, but they must be unique within a
/// stack graph. If you are analyzing files from the local filesystem, the file's path is a good
/// choice. If your files belong to packages or repositories, they should include the package or
/// repository IDs to make sure that files in different packages or repositories don't clash with
/// each other.
pub struct File {
/// The name of this source file.
name: InternedStringContent,
}
impl File {
pub fn name(&self) -> &str {
self.name.as_str()
}
}
impl StackGraph {
/// Adds a file to the stack graph. There can only ever be one file with a particular name in
/// the graph. If a file with the requested name already exists, we return `Err`; if it
/// doesn't already exist, we return `Ok`. In both cases, the value of the result is the
/// file's handle.
pub fn add_file<S: AsRef<str> + ?Sized>(
&mut self,
name: &S,
) -> Result<Handle<File>, Handle<File>> {
let name = name.as_ref();
if let Some(handle) = self.file_handles.get(name) {
return Err(*handle);
}
let interned = self.interned_strings.add(name);
let hash_key = unsafe { interned.as_hash_key() };
let handle = self.files.add(File { name: interned });
self.file_handles.insert(hash_key, handle);
Ok(handle)
}
/// Adds a file to the stack graph, returning its handle. There can only ever be one file with
/// a particular name in the graph, so if you call this multiple times with the same name,
/// you'll get the same handle each time.
#[inline(always)]
pub fn get_or_create_file<S: AsRef<str> + ?Sized>(&mut self, name: &S) -> Handle<File> {
self.add_file(name).unwrap_or_else(|handle| handle)
}
/// Returns the file with a particular name, if it exists.
pub fn get_file<S: AsRef<str> + ?Sized>(&self, name: &S) -> Option<Handle<File>> {
let name = name.as_ref();
self.file_handles.get(name).copied()
}
}
impl StackGraph {
/// Returns an iterator of all of the nodes that belong to a particular file. Note that this
/// does **_not_** include the singleton _root_ or _jump to scope_ nodes.
pub fn nodes_for_file(&self, file: Handle<File>) -> impl Iterator<Item = Handle<Node>> + '_ {
self.node_id_handles.nodes_for_file(file)
}
/// Returns an iterator over all of the handles of all of the files in this stack graph. (Note
/// that because we're only returning _handles_, this iterator does not retain a reference to
/// the `StackGraph`.)
pub fn iter_files(&self) -> impl Iterator<Item = Handle<File>> + '_ {
self.files.iter_handles()
}
}
impl Display for File {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{}", self.name())
}
}
impl Index<Handle<File>> for StackGraph {
type Output = File;
#[inline(always)]
fn index(&self, handle: Handle<File>) -> &File {
&self.files.get(handle)
}
}
#[doc(hidden)]
pub struct DisplayFile<'a> {
wrapped: Handle<File>,
graph: &'a StackGraph,
}
impl<'a> Display for DisplayFile<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{}", self.graph[self.wrapped])
}
}
impl Handle<File> {
pub fn display(self, graph: &StackGraph) -> impl Display + '_ {
DisplayFile {
wrapped: self,
graph,
}
}
}
//-------------------------------------------------------------------------------------------------
// Nodes
/// Uniquely identifies a node in a stack graph.
///
/// Each node (except for the _root node_ and _jump to scope_ node) lives in a file, and has a
/// _local ID_ that must be unique within its file.
#[repr(C)]
#[derive(Clone, Copy, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct NodeID {
file: ControlledOption<Handle<File>>,
local_id: u32,
}
pub(crate) const ROOT_NODE_ID: u32 = 1;
pub(crate) const JUMP_TO_NODE_ID: u32 = 2;
impl NodeID {
/// Returns the ID of the singleton _root node_.
#[inline(always)]
pub fn root() -> NodeID {
NodeID {
file: ControlledOption::none(),
local_id: ROOT_NODE_ID,
}
}
/// Returns the ID of the singleton _jump to scope_ node.
#[inline(always)]
pub fn jump_to() -> NodeID {
NodeID {
file: ControlledOption::none(),
local_id: JUMP_TO_NODE_ID,
}
}
/// Creates a new file-local node ID.
#[inline(always)]
pub fn new_in_file(file: Handle<File>, local_id: u32) -> NodeID {
NodeID {
file: ControlledOption::some(file),
local_id,
}
}
/// Returns whether this ID refers to the singleton _root node_.
#[inline(always)]
pub fn is_root(self) -> bool {
self.file.is_none() && self.local_id == ROOT_NODE_ID
}
/// Returns whether this ID refers to the singleton _jump to scope_ node.
#[inline(always)]
pub fn is_jump_to(self) -> bool {
self.file.is_none() && self.local_id == JUMP_TO_NODE_ID
}
/// Returns the file that this node belongs to. Returns `None` for the singleton _root_ and
/// _jump to scope_ nodes, which belong to all files.
#[inline(always)]
pub fn file(self) -> Option<Handle<File>> {
self.file.into()
}
/// Returns the local ID of this node within its file. Panics if this node ID refers to the
/// singleton _root_ or _jump to scope_ nodes.
#[inline(always)]
pub fn local_id(self) -> u32 {
self.local_id
}
/// Returns whether this node belongs to a particular file. Always returns `true` for the
/// singleton _root_ and _jump to scope_ nodes, which belong to all files.
#[inline(always)]
pub fn is_in_file(self, file: Handle<File>) -> bool {
match self.file.into_option() {
Some(this_file) => this_file == file,
_ => true,
}
}
}
#[doc(hidden)]
pub struct DisplayNodeID<'a> {
wrapped: NodeID,
graph: &'a StackGraph,
}
impl<'a> Display for DisplayNodeID<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self.wrapped.file.into_option() {
Some(file) => write!(f, "{}({})", file.display(self.graph), self.wrapped.local_id),
None => {
if self.wrapped.is_root() {
write!(f, "[root]")
} else if self.wrapped.is_jump_to() {
write!(f, "[jump]")
} else {
unreachable!();
}
}
}
}
}
impl NodeID {
pub fn display(self, graph: &StackGraph) -> impl Display + '_ {
DisplayNodeID {
wrapped: self,
graph,
}
}
}
/// A node in a stack graph.
#[repr(C)]
pub enum Node {
DropScopes(DropScopesNode),
JumpTo(JumpToNode),
PopScopedSymbol(PopScopedSymbolNode),
PopSymbol(PopSymbolNode),
PushScopedSymbol(PushScopedSymbolNode),
PushSymbol(PushSymbolNode),
Root(RootNode),
Scope(ScopeNode),
}
impl Node {
#[inline(always)]
pub fn is_exported_scope(&self) -> bool {
match self {
Node::Scope(node) => node.is_exported,
_ => false,
}
}
#[inline(always)]
pub fn is_definition(&self) -> bool {
match self {
Node::PopScopedSymbol(node) => node.is_definition,
Node::PopSymbol(node) => node.is_definition,
_ => false,
}
}
#[inline(always)]
pub fn is_reference(&self) -> bool {
match self {
Node::PushScopedSymbol(node) => node.is_reference,
Node::PushSymbol(node) => node.is_reference,
_ => false,
}
}
#[inline(always)]
pub fn is_jump_to(&self) -> bool {
matches!(self, Node::JumpTo(_))
}
#[inline(always)]
pub fn is_root(&self) -> bool {
matches!(self, Node::Root(_))
}
#[inline(always)]
pub fn is_endpoint(&self) -> bool {
self.is_definition() || self.is_exported_scope() || self.is_reference() || self.is_root()
}
/// Returns this node's symbol, if it has one. (_Pop symbol_, _pop scoped symbol_, _push
/// symbol_, and _push scoped symbol_ nodes have symbols.)
pub fn symbol(&self) -> Option<Handle<Symbol>> {
match self {
Node::PushScopedSymbol(node) => Some(node.symbol),
Node::PushSymbol(node) => Some(node.symbol),
Node::PopScopedSymbol(node) => Some(node.symbol),
Node::PopSymbol(node) => Some(node.symbol),
_ => None,
}
}
/// Returns this node's attached scope, if it has one. (_Push scoped symbol_ nodes have
/// attached scopes.)
pub fn scope(&self) -> Option<NodeID> {
match self {
Node::PushScopedSymbol(node) => Some(node.scope),
_ => None,
}
}
/// Returns the ID of this node.
pub fn id(&self) -> NodeID {
match self {
Node::DropScopes(node) => node.id,
Node::JumpTo(node) => node.id,
Node::PushScopedSymbol(node) => node.id,
Node::PushSymbol(node) => node.id,
Node::PopScopedSymbol(node) => node.id,
Node::PopSymbol(node) => node.id,
Node::Root(node) => node.id,
Node::Scope(node) => node.id,
}
}
/// Returns the file that this node belongs to. Returns `None` for the singleton _root_ and
/// _jump to scope_ nodes, which belong to all files.
#[inline(always)]
pub fn file(&self) -> Option<Handle<File>> {
self.id().file()
}
/// Returns whether this node belongs to a particular file. Always returns `true` for the
/// singleton _root_ and _jump to scope_ nodes, which belong to all files.
#[inline(always)]
pub fn is_in_file(&self, file: Handle<File>) -> bool {
self.id().is_in_file(file)
}
pub fn display<'a>(&'a self, graph: &'a StackGraph) -> impl Display + 'a {
DisplayNode {
wrapped: self,
graph,
}
}
}
impl StackGraph {
/// Returns a handle to the stack graph's singleton _jump to scope_ node.
#[inline(always)]
pub fn jump_to_node() -> Handle<Node> {
Handle::new(unsafe { NonZeroU32::new_unchecked(2) })
}
/// Returns a handle to the stack graph's singleton _root node_.
#[inline(always)]
pub fn root_node() -> Handle<Node> {
Handle::new(unsafe { NonZeroU32::new_unchecked(1) })
}
/// Returns an unused [`NodeID`][] for the given file.
///
/// [`NodeID`]: struct.NodeID.html
pub fn new_node_id(&mut self, file: Handle<File>) -> NodeID {
self.node_id_handles.unused_id(file)
}
/// Returns an iterator of all of the nodes in the graph. (Note that because we're only
/// returning _handles_, this iterator does not retain a reference to the `StackGraph`.)
pub fn iter_nodes(&self) -> impl Iterator<Item = Handle<Node>> {
self.nodes.iter_handles()
}
/// Returns the handle to the node with a particular ID, if it exists.
pub fn node_for_id(&self, id: NodeID) -> Option<Handle<Node>> {
if id.file().is_some() {
self.node_id_handles.try_handle_for_id(id)
} else if id.is_root() {
Some(StackGraph::root_node())
} else if id.is_jump_to() {
Some(StackGraph::jump_to_node())
} else {
None
}
}
pub(crate) fn add_node(&mut self, id: NodeID, node: Node) -> Option<Handle<Node>> {
if let Some(_) = self.node_id_handles.handle_for_id(id) {
return None;
}
let handle = self.nodes.add(node);
self.node_id_handles.set_handle_for_id(id, handle);
Some(handle)
}
pub(crate) fn get_or_create_node(&mut self, id: NodeID, node: Node) -> Handle<Node> {
if let Some(handle) = self.node_id_handles.handle_for_id(id) {
return handle;
}
let handle = self.nodes.add(node);
self.node_id_handles.set_handle_for_id(id, handle);
handle
}
}
#[doc(hidden)]
pub struct DisplayNode<'a> {
wrapped: &'a Node,
graph: &'a StackGraph,
}
impl<'a> Display for DisplayNode<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self.wrapped {
Node::DropScopes(node) => node.display(self.graph).fmt(f),
Node::JumpTo(node) => node.fmt(f),
Node::PushScopedSymbol(node) => node.display(self.graph).fmt(f),
Node::PushSymbol(node) => node.display(self.graph).fmt(f),
Node::PopScopedSymbol(node) => node.display(self.graph).fmt(f),
Node::PopSymbol(node) => node.display(self.graph).fmt(f),
Node::Root(node) => node.fmt(f),
Node::Scope(node) => node.display(self.graph).fmt(f),
}
}
}
impl Handle<Node> {
pub fn display(self, graph: &StackGraph) -> impl Display + '_ {
DisplayNode {
wrapped: &graph[self],
graph,
}
}
}
impl Index<Handle<Node>> for StackGraph {
type Output = Node;
#[inline(always)]
fn index(&self, handle: Handle<Node>) -> &Node {
self.nodes.get(handle)
}
}
impl IndexMut<Handle<Node>> for StackGraph {
#[inline(always)]
fn index_mut(&mut self, handle: Handle<Node>) -> &mut Node {
self.nodes.get_mut(handle)
}
}
/// Removes everything from the current scope stack.
#[repr(C)]
pub struct DropScopesNode {
/// The unique identifier for this node.
pub id: NodeID,
_symbol: ControlledOption<Handle<Symbol>>,
_scope: NodeID,
_is_endpoint: bool,
}
impl From<DropScopesNode> for Node {
fn from(node: DropScopesNode) -> Node {
Node::DropScopes(node)
}
}
impl StackGraph {
/// Adds a _drop scopes_ node to the stack graph.
pub fn add_drop_scopes_node(&mut self, id: NodeID) -> Option<Handle<Node>> {
let node = DropScopesNode {
id,
_symbol: ControlledOption::none(),
_scope: NodeID::default(),
_is_endpoint: false,
};
self.add_node(id, node.into())
}
}
impl DropScopesNode {
pub fn display<'a>(&'a self, graph: &'a StackGraph) -> impl Display + 'a {
DisplayDropScopesNode {
wrapped: self,
graph,
}
}
}
#[doc(hidden)]
pub struct DisplayDropScopesNode<'a> {
wrapped: &'a DropScopesNode,
graph: &'a StackGraph,
}
impl<'a> Display for DisplayDropScopesNode<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
if f.alternate() {
write!(f, "[{}]", self.wrapped.id.display(self.graph))
} else {
write!(f, "[{} drop scopes]", self.wrapped.id.display(self.graph))
}
}
}
/// The singleton "jump to" node, which allows a name binding path to jump back to another part of
/// the graph.
#[repr(C)]
pub struct JumpToNode {
id: NodeID,
_symbol: ControlledOption<Handle<Symbol>>,
_scope: NodeID,
_is_endpoint: bool,
}
impl From<JumpToNode> for Node {
fn from(node: JumpToNode) -> Node {
Node::JumpTo(node)
}
}
impl JumpToNode {
fn new() -> JumpToNode {
JumpToNode {
id: NodeID::jump_to(),
_symbol: ControlledOption::none(),
_scope: NodeID::default(),
_is_endpoint: false,
}
}
}
impl Display for JumpToNode {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "[jump to scope]")
}
}
/// Pops a scoped symbol from the symbol stack. If the top of the symbol stack doesn't match the
/// requested symbol, or if the top of the symbol stack doesn't have an attached scope list, then
/// the path is not allowed to enter this node.
#[repr(C)]
pub struct PopScopedSymbolNode {
/// The unique identifier for this node.
pub id: NodeID,
/// The symbol to pop off the symbol stack.
pub symbol: Handle<Symbol>,
_scope: NodeID,
/// Whether this node represents a reference in the source language.
pub is_definition: bool,
}
impl From<PopScopedSymbolNode> for Node {
fn from(node: PopScopedSymbolNode) -> Node {
Node::PopScopedSymbol(node)
}
}
impl StackGraph {
/// Adds a _pop scoped symbol_ node to the stack graph.
pub fn add_pop_scoped_symbol_node(
&mut self,
id: NodeID,
symbol: Handle<Symbol>,
is_definition: bool,
) -> Option<Handle<Node>> {
let node = PopScopedSymbolNode {
id,
symbol,
_scope: NodeID::default(),
is_definition,
};
self.add_node(id, node.into())
}
}
impl PopScopedSymbolNode {
pub fn display<'a>(&'a self, graph: &'a StackGraph) -> impl Display + 'a {
DisplayPopScopedSymbolNode {
wrapped: self,
graph,
}
}
}
#[doc(hidden)]
pub struct DisplayPopScopedSymbolNode<'a> {
wrapped: &'a PopScopedSymbolNode,
graph: &'a StackGraph,
}
impl<'a> Display for DisplayPopScopedSymbolNode<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
if f.alternate() {
write!(f, "[{}]", self.wrapped.id.display(self.graph))
} else {
write!(
f,
"[{} {} {}]",
self.wrapped.id.display(self.graph),
if self.wrapped.is_definition {
"scoped definition"
} else {
"pop scoped"
},
self.wrapped.symbol.display(self.graph),
)
}
}
}
/// Pops a symbol from the symbol stack. If the top of the symbol stack doesn't match the
/// requested symbol, then the path is not allowed to enter this node.
#[repr(C)]
pub struct PopSymbolNode {
/// The unique identifier for this node.
pub id: NodeID,
/// The symbol to pop off the symbol stack.
pub symbol: Handle<Symbol>,
_scope: NodeID,
/// Whether this node represents a reference in the source language.
pub is_definition: bool,
}
impl From<PopSymbolNode> for Node {
fn from(node: PopSymbolNode) -> Node {
Node::PopSymbol(node)
}
}
impl StackGraph {
/// Adds a _pop symbol_ node to the stack graph.
pub fn add_pop_symbol_node(
&mut self,
id: NodeID,
symbol: Handle<Symbol>,
is_definition: bool,
) -> Option<Handle<Node>> {
let node = PopSymbolNode {
id,
symbol,
_scope: NodeID::default(),
is_definition,
};
self.add_node(id, node.into())
}
}
impl PopSymbolNode {
pub fn display<'a>(&'a self, graph: &'a StackGraph) -> impl Display + 'a {
DisplayPopSymbolNode {
wrapped: self,
graph,
}
}
}
#[doc(hidden)]
pub struct DisplayPopSymbolNode<'a> {
wrapped: &'a PopSymbolNode,
graph: &'a StackGraph,
}
impl<'a> Display for DisplayPopSymbolNode<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
if f.alternate() {
write!(f, "[{}]", self.wrapped.id.display(self.graph))
} else {
write!(
f,
"[{} {} {}]",
self.wrapped.id.display(self.graph),
if self.wrapped.is_definition {
"definition"
} else {
"pop"
},
self.wrapped.symbol.display(self.graph),
)
}
}
}
/// Pushes a scoped symbol onto the symbol stack.
#[repr(C)]
pub struct PushScopedSymbolNode {
/// The unique identifier for this node.
pub id: NodeID,
/// The symbol to push onto the symbol stack.
pub symbol: Handle<Symbol>,
/// The exported scope node that should be attached to the scoped symbol. The node ID must
/// refer to an exported scope node.
pub scope: NodeID,
/// Whether this node represents a reference in the source language.
pub is_reference: bool,
_phantom: (),
}
impl From<PushScopedSymbolNode> for Node {
fn from(node: PushScopedSymbolNode) -> Node {
Node::PushScopedSymbol(node)
}
}