-
Notifications
You must be signed in to change notification settings - Fork 23
/
documentation.ts
130 lines (106 loc) · 3.48 KB
/
documentation.ts
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
import { ASTNode, ASTNodeWithChildren } from "./ast_node";
import { StructuredDocumentation } from "./implementation/meta";
export interface WithPrecedingDocs {
documentation?: string | StructuredDocumentation;
/**
* This field is used as a storage field for string,
* if string is set as value for `documentation`.
*/
docString?: string;
}
export interface WithDanglingDocs {
danglingDocumentation?: string | StructuredDocumentation;
/**
* This field is used as a storage field for string,
* if string is set as value for `danglingDocumentation`.
*/
danglingDocString?: string;
}
export function getDocumentation(
node: WithPrecedingDocs & ASTNodeWithChildren<ASTNode>
): string | StructuredDocumentation | undefined {
if (node.docString !== undefined) {
return node.docString;
}
const ownLoc = node.sourceInfo;
const children = node.children;
for (let c = 0; c < children.length; c++) {
const child = children[c];
if (child instanceof StructuredDocumentation) {
const childLoc = child.sourceInfo;
/**
* Note that preceding documentation nodes are
* EXCLUDED from source range of parent node.
*/
if (childLoc.offset <= ownLoc.offset) {
return child;
}
}
}
return undefined;
}
export function setDocumentation(
node: WithPrecedingDocs & ASTNodeWithChildren<ASTNode>,
value: string | StructuredDocumentation | undefined
): void {
const old = node.documentation;
if (value instanceof StructuredDocumentation) {
node.docString = undefined;
if (old instanceof StructuredDocumentation) {
if (value !== old) {
node.replaceChild(value, old);
}
} else {
node.insertAtBeginning(value);
}
} else {
if (old instanceof StructuredDocumentation) {
node.removeChild(old);
}
node.docString = value;
}
}
export function getDanglingDocumentation(
node: WithDanglingDocs & ASTNodeWithChildren<ASTNode>
): string | StructuredDocumentation | undefined {
if (node.danglingDocString !== undefined) {
return node.danglingDocString;
}
const ownLoc = node.sourceInfo;
const children = node.children;
for (let c = children.length - 1; c >= 0; c--) {
const child = children[c];
if (child instanceof StructuredDocumentation) {
const childLoc = child.sourceInfo;
/**
* Note that preceding documentation nodes are
* INCLUDED from source range of parent node.
*/
if (childLoc.offset > ownLoc.offset) {
return child;
}
}
}
return undefined;
}
export function setDanglingDocumentation(
node: WithDanglingDocs & ASTNodeWithChildren<ASTNode>,
value: string | StructuredDocumentation | undefined
): void {
const old = node.danglingDocumentation;
if (value instanceof StructuredDocumentation) {
node.danglingDocString = undefined;
if (old instanceof StructuredDocumentation) {
if (value !== old) {
node.replaceChild(value, old);
}
} else {
node.appendChild(value as any);
}
} else {
if (old instanceof StructuredDocumentation) {
node.removeChild(old as any);
}
node.danglingDocString = value;
}
}