aboutsummaryrefslogtreecommitdiff
path: root/src/tree
diff options
context:
space:
mode:
authorbors[bot] <bors[bot]@users.noreply.github.com>2018-01-28 07:51:49 +0000
committerbors[bot] <bors[bot]@users.noreply.github.com>2018-01-28 07:51:49 +0000
commitefadcf715862a2d96af0f57d2b53bfa325390779 (patch)
tree6e930103a8b9e74041bf0e6e9f7c7e696d481afd /src/tree
parent6d3caf58ca042cf6b5707822e51619adf511acd0 (diff)
parent50b9012e10d2fa74294547c25642b4a69fed4bda (diff)
Merge #15
15: Add minimal docs to most public symbols r=matklad a=CAD97 Also sticks a safety on some warnings that rustc provides. If you're just stubbing out a module and don't want rustc refusing to compile it because you haven't documented it yet, stick `#![allow(missing_docs)]` at the top.
Diffstat (limited to 'src/tree')
-rw-r--r--src/tree/file_builder.rs5
-rw-r--r--src/tree/mod.rs24
2 files changed, 26 insertions, 3 deletions
diff --git a/src/tree/file_builder.rs b/src/tree/file_builder.rs
index 939922cb2..738705f02 100644
--- a/src/tree/file_builder.rs
+++ b/src/tree/file_builder.rs
@@ -1,3 +1,6 @@
1// FIXME(CAD97): I don't understand this mod well enough to stub out docs for the public symbols yet
2#![allow(missing_docs)]
3
1use {SyntaxKind, TextRange, TextUnit}; 4use {SyntaxKind, TextRange, TextUnit};
2use super::{File, NodeData, NodeIdx, SyntaxErrorData}; 5use super::{File, NodeData, NodeIdx, SyntaxErrorData};
3 6
@@ -8,6 +11,7 @@ pub trait Sink {
8 fn error(&mut self) -> ErrorBuilder; 11 fn error(&mut self) -> ErrorBuilder;
9} 12}
10 13
14#[derive(Debug)]
11pub struct FileBuilder { 15pub struct FileBuilder {
12 text: String, 16 text: String,
13 nodes: Vec<NodeData>, 17 nodes: Vec<NodeData>,
@@ -139,6 +143,7 @@ fn grow(left: &mut TextRange, right: TextRange) {
139 *left = TextRange::from_to(left.start(), right.end()) 143 *left = TextRange::from_to(left.start(), right.end())
140} 144}
141 145
146#[derive(Debug)]
142pub struct ErrorBuilder<'f> { 147pub struct ErrorBuilder<'f> {
143 message: Option<String>, 148 message: Option<String>,
144 builder: &'f mut FileBuilder, 149 builder: &'f mut FileBuilder,
diff --git a/src/tree/mod.rs b/src/tree/mod.rs
index a330caf54..aaf048c73 100644
--- a/src/tree/mod.rs
+++ b/src/tree/mod.rs
@@ -7,6 +7,7 @@ use std::cmp;
7mod file_builder; 7mod file_builder;
8pub use self::file_builder::{FileBuilder, Sink}; 8pub use self::file_builder::{FileBuilder, Sink};
9 9
10/// The kind of syntax node, e.g. `IDENT`, `USE_KW`, or `STRUCT_DEF`.
10#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] 11#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
11pub struct SyntaxKind(pub(crate) u32); 12pub struct SyntaxKind(pub(crate) u32);
12 13
@@ -37,12 +38,17 @@ pub(crate) struct SyntaxInfo {
37 pub name: &'static str, 38 pub name: &'static str,
38} 39}
39 40
41/// A token of Rust source.
40#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] 42#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
41pub struct Token { 43pub struct Token {
44 /// The kind of token.
42 pub kind: SyntaxKind, 45 pub kind: SyntaxKind,
46 /// The length of the token.
43 pub len: TextUnit, 47 pub len: TextUnit,
44} 48}
45 49
50/// The contents of a Rust source file.
51#[derive(Debug)]
46pub struct File { 52pub struct File {
47 text: String, 53 text: String,
48 nodes: Vec<NodeData>, 54 nodes: Vec<NodeData>,
@@ -50,6 +56,7 @@ pub struct File {
50} 56}
51 57
52impl File { 58impl File {
59 /// The root node of this source file.
53 pub fn root<'f>(&'f self) -> Node<'f> { 60 pub fn root<'f>(&'f self) -> Node<'f> {
54 assert!(!self.nodes.is_empty()); 61 assert!(!self.nodes.is_empty());
55 Node { 62 Node {
@@ -59,6 +66,7 @@ impl File {
59 } 66 }
60} 67}
61 68
69/// A reference to a token in a Rust source file.
62#[derive(Clone, Copy)] 70#[derive(Clone, Copy)]
63pub struct Node<'f> { 71pub struct Node<'f> {
64 file: &'f File, 72 file: &'f File,
@@ -66,28 +74,34 @@ pub struct Node<'f> {
66} 74}
67 75
68impl<'f> Node<'f> { 76impl<'f> Node<'f> {
77 /// The kind of the token at this node.
69 pub fn kind(&self) -> SyntaxKind { 78 pub fn kind(&self) -> SyntaxKind {
70 self.data().kind 79 self.data().kind
71 } 80 }
72 81
82 /// The text range covered by the token at this node.
73 pub fn range(&self) -> TextRange { 83 pub fn range(&self) -> TextRange {
74 self.data().range 84 self.data().range
75 } 85 }
76 86
87 /// The text at this node.
77 pub fn text(&self) -> &'f str { 88 pub fn text(&self) -> &'f str {
78 &self.file.text.as_str()[self.range()] 89 &self.file.text.as_str()[self.range()]
79 } 90 }
80 91
92 /// The parent node to this node.
81 pub fn parent(&self) -> Option<Node<'f>> { 93 pub fn parent(&self) -> Option<Node<'f>> {
82 self.as_node(self.data().parent) 94 self.as_node(self.data().parent)
83 } 95 }
84 96
97 /// The children nodes of this node.
85 pub fn children(&self) -> Children<'f> { 98 pub fn children(&self) -> Children<'f> {
86 Children { 99 Children {
87 next: self.as_node(self.data().first_child), 100 next: self.as_node(self.data().first_child),
88 } 101 }
89 } 102 }
90 103
104 /// Any errors contained in this node.
91 pub fn errors(&self) -> SyntaxErrors<'f> { 105 pub fn errors(&self) -> SyntaxErrors<'f> {
92 let pos = self.file.errors.iter().position(|e| e.node == self.idx); 106 let pos = self.file.errors.iter().position(|e| e.node == self.idx);
93 let next = pos.map(|i| ErrorIdx(i as u32)).map(|idx| SyntaxError { 107 let next = pos.map(|i| ErrorIdx(i as u32)).map(|idx| SyntaxError {
@@ -123,7 +137,7 @@ impl<'f> cmp::PartialEq<Node<'f>> for Node<'f> {
123 137
124impl<'f> cmp::Eq for Node<'f> {} 138impl<'f> cmp::Eq for Node<'f> {}
125 139
126#[derive(Clone, Copy)] 140#[derive(Clone, Copy, Debug)]
127pub struct SyntaxError<'f> { 141pub struct SyntaxError<'f> {
128 file: &'f File, 142 file: &'f File,
129 idx: ErrorIdx, 143 idx: ErrorIdx,
@@ -162,6 +176,7 @@ impl<'f> SyntaxError<'f> {
162 } 176 }
163} 177}
164 178
179#[derive(Debug)]
165pub struct Children<'f> { 180pub struct Children<'f> {
166 next: Option<Node<'f>>, 181 next: Option<Node<'f>>,
167} 182}
@@ -176,6 +191,7 @@ impl<'f> Iterator for Children<'f> {
176 } 191 }
177} 192}
178 193
194#[derive(Debug)]
179pub struct SyntaxErrors<'f> { 195pub struct SyntaxErrors<'f> {
180 next: Option<SyntaxError<'f>>, 196 next: Option<SyntaxError<'f>>,
181} 197}
@@ -190,9 +206,10 @@ impl<'f> Iterator for SyntaxErrors<'f> {
190 } 206 }
191} 207}
192 208
193#[derive(Clone, Copy, PartialEq, Eq)] 209#[derive(Clone, Copy, Debug, PartialEq, Eq)]
194struct NodeIdx(u32); 210struct NodeIdx(u32);
195 211
212#[derive(Debug)]
196struct NodeData { 213struct NodeData {
197 kind: SyntaxKind, 214 kind: SyntaxKind,
198 range: TextRange, 215 range: TextRange,
@@ -215,9 +232,10 @@ impl ::std::ops::IndexMut<NodeIdx> for Vec<NodeData> {
215 } 232 }
216} 233}
217 234
218#[derive(Clone, Copy)] 235#[derive(Clone, Copy, Debug)]
219struct ErrorIdx(u32); 236struct ErrorIdx(u32);
220 237
238#[derive(Debug)]
221struct SyntaxErrorData { 239struct SyntaxErrorData {
222 node: NodeIdx, 240 node: NodeIdx,
223 message: String, 241 message: String,