From a9c1afd5fd9d0055c849c10bea5dfe7494398cfd Mon Sep 17 00:00:00 2001 From: Andreas Rumpf Date: Fri, 3 Mar 2017 02:13:16 +0100 Subject: nimsuggest: structured error reporting; EPC mode still fails --- tools/nimsuggest/nimsuggest.nim | 55 ++++--- tools/nimsuggest/tests/tchk1.nim | 27 +++ tools/nimsuggest/tests/tcursor_at_end.nim | 12 ++ tools/nimsuggest/tests/twithin_macro_prefix.nim | 209 ++++++++++++++++++++++++ 4 files changed, 281 insertions(+), 22 deletions(-) create mode 100644 tools/nimsuggest/tests/tchk1.nim create mode 100644 tools/nimsuggest/tests/tcursor_at_end.nim create mode 100644 tools/nimsuggest/tests/twithin_macro_prefix.nim (limited to 'tools/nimsuggest') diff --git a/tools/nimsuggest/nimsuggest.nim b/tools/nimsuggest/nimsuggest.nim index 5ed66ca36..97c46625c 100644 --- a/tools/nimsuggest/nimsuggest.nim +++ b/tools/nimsuggest/nimsuggest.nim @@ -17,7 +17,7 @@ import compiler / [options, commands, modules, sem, passes, passaux, msgs, nimconf, extccomp, condsyms, sigmatch, ast, scriptconfig, - idents, modulegraphs, compilerlog, vm] + idents, modulegraphs, vm] when defined(windows): import winlean @@ -60,6 +60,20 @@ var gLogging = false gRefresh: bool + requests: Channel[string] + results: Channel[Suggest] + +proc writelnToChannel(line: string) = + results.send(Suggest(section: ideMsg, doc: line)) + +proc sugResultHook(s: Suggest) = + results.send(s) + +proc errorHook(info: TLineInfo; msg: string; sev: Severity) = + results.send(Suggest(section: ideChk, filePath: toFullPath(info), + line: toLinenumber(info), column: toColumn(info), doc: msg, + forth: $sev)) + const seps = {':', ';', ' ', '\t'} Help = "usage: sug|con|def|use|dus|chk|mod|highlight|outline|known file.nim[;dirtyfile.nim]:line:col\n" & @@ -133,9 +147,12 @@ proc symFromInfo(graph: ModuleGraph; gTrackPos: TLineInfo): PSym = proc execute(cmd: IdeCmd, file, dirtyfile: string, line, col: int; graph: ModuleGraph; cache: IdentCache) = if gLogging: - logStr("cmd: " & $cmd & ", file: " & file & ", dirtyFile: " & dirtyfile & + log("cmd: " & $cmd & ", file: " & file & ", dirtyFile: " & dirtyfile & "[" & $line & ":" & $col & "]") gIdeCmd = cmd + if cmd == ideChk: + msgs.structuredErrorHook = errorHook + msgs.writelnHook = proc (s: string) = discard if cmd == ideUse and suggestVersion != 2: graph.resetAllModules() var isKnownFile = true @@ -194,7 +211,7 @@ template sendEpc(results: typed, tdef, hook: untyped) = executeEpc(gIdeCmd, args, graph, cache) let res = sexp(results) if gLogging: - logStr($res) + log($res) returnEpc(client, uid, res) template checkSanity(client, sizeHex, size, messageBuffer: typed) = @@ -205,16 +222,12 @@ template checkSanity(client, sizeHex, size, messageBuffer: typed) = if client.recv(messageBuffer, size) != size: raise newException(ValueError, "didn't get all the bytes") -var - requests: Channel[string] - results: Channel[Suggest] - proc toStdout() {.gcsafe.} = while true: let res = results.recv() case res.section of ideNone: break - of ideChk: echo res.doc + of ideMsg: echo res.doc of ideKnown: echo res.quality == 1 else: echo res @@ -223,7 +236,7 @@ proc toSocket(stdoutSocket: Socket) {.gcsafe.} = let res = results.recv() case res.section of ideNone: break - of ideChk: stdoutSocket.send(res.doc & "\c\L") + of ideMsg: stdoutSocket.send(res.doc & "\c\L") of ideKnown: stdoutSocket.send($(res.quality == 1) & "\c\L") else: stdoutSocket.send($res & "\c\L") @@ -233,7 +246,7 @@ proc toEpc(client: Socket; uid: BiggestInt) {.gcsafe.} = let res = results.recv() case res.section of ideNone: break - of ideChk: + of ideMsg: list.add sexp(res.doc) of ideKnown: list.add sexp(res.quality == 1) @@ -241,12 +254,6 @@ proc toEpc(client: Socket; uid: BiggestInt) {.gcsafe.} = list.add sexp(res) returnEpc(client, uid, list) -proc writelnToChannel(line: string) = - results.send(Suggest(section: ideChk, doc: line)) - -proc sugResultHook(s: Suggest) = - results.send(s) - template setVerbosity(level: typed) = gVerbosity = level gNotes = NotesVerbosity[gVerbosity] @@ -353,7 +360,7 @@ proc replEpc(x: ThreadParams) {.thread.} = else: discard let cmd = $gIdeCmd & " " & args.argsToStr if gLogging: - logStr "MSG CMD: " & cmd + log "MSG CMD: " & cmd requests.send(cmd) toEpc(client, uid) of "methods": @@ -437,11 +444,11 @@ proc recompileFullProject(graph: ModuleGraph; cache: IdentCache) = proc mainThread(graph: ModuleGraph; cache: IdentCache) = if gLogging: for it in searchPaths: - logStr(it) + log(it) proc wrHook(line: string) {.closure.} = if gMode == mepc: - if gLogging: logStr(line) + if gLogging: log(line) else: writelnToChannel(line) @@ -454,7 +461,6 @@ proc mainThread(graph: ModuleGraph; cache: IdentCache) = if hasData: msgs.writelnHook = wrHook suggestionResultHook = sugResultHook - execCmd(req, graph, cache) idle = 0 else: @@ -464,6 +470,7 @@ proc mainThread(graph: ModuleGraph; cache: IdentCache) = # we use some nimsuggest activity to enable a lazy recompile: gIdeCmd = ideChk msgs.writelnHook = proc (s: string) = discard + msgs.structuredErrorHook = nil suggestionResultHook = proc (s: Suggest) = discard recompileFullProject(graph, cache) @@ -482,6 +489,10 @@ proc mainCommand(graph: ModuleGraph; cache: IdentCache) = # do not stop after the first error: msgs.gErrorMax = high(int) + # do not print errors, but log them + msgs.writelnHook = proc (s: string) = log(s) + msgs.structuredErrorHook = nil + # compile the project before showing any input so that we already # can answer questions right away: compileProject(graph, cache) @@ -559,9 +570,9 @@ proc handleCmdLine(cache: IdentCache; config: ConfigRef) = raise newException(IOError, "Cannot find Nim standard library: Nim compiler not in PATH") gPrefixDir = binaryPath.splitPath().head.parentDir() - #msgs.writelnHook = proc (line: string) = logStr(line) + #msgs.writelnHook = proc (line: string) = log(line) if gLogging: - logStr("START " & gProjectFull) + log("START " & gProjectFull) loadConfigs(DefaultConfig, cache, config) # load all config files # now process command line arguments again, because some options in the diff --git a/tools/nimsuggest/tests/tchk1.nim b/tools/nimsuggest/tests/tchk1.nim new file mode 100644 index 000000000..f9f0dc8fe --- /dev/null +++ b/tools/nimsuggest/tests/tchk1.nim @@ -0,0 +1,27 @@ +# test we get some suggestion at the end of the file + + + + + + + +type + + +template foo() = + +proc main = + +#[!]# +discard """ +$nimsuggest --tester $file +>chk $1 +chk;;skUnknown;;;;Hint;;???;;-1;;-1;;"tchk1 [Processing]";;0 +chk;;skUnknown;;;;Error;;$file;;12;;0;;"identifier expected, but found \'keyword template\'";;0 +chk;;skUnknown;;;;Error;;$file;;14;;0;;"complex statement requires indentation";;0 +chk;;skUnknown;;;;Error;;$file;;12;;0;;"implementation of \'foo\' expected";;0 +chk;;skUnknown;;;;Error;;$file;;17;;0;;"invalid indentation";;0 +chk;;skUnknown;;;;Hint;;$file;;12;;9;;"\'foo\' is declared but not used [XDeclaredButNotUsed]";;0 +chk;;skUnknown;;;;Hint;;$file;;14;;5;;"\'tchk1.main()\' is declared but not used [XDeclaredButNotUsed]";;0 +""" diff --git a/tools/nimsuggest/tests/tcursor_at_end.nim b/tools/nimsuggest/tests/tcursor_at_end.nim new file mode 100644 index 000000000..b3a0d1133 --- /dev/null +++ b/tools/nimsuggest/tests/tcursor_at_end.nim @@ -0,0 +1,12 @@ +# test we get some suggestion at the end of the file + +discard """ +$nimsuggest --tester $file +>sug $1 +sug;;skProc;;tcursor_at_end.main;;proc ();;$file;;10;;5;;"";;* +""" + + +proc main = discard + +#[!]# diff --git a/tools/nimsuggest/tests/twithin_macro_prefix.nim b/tools/nimsuggest/tests/twithin_macro_prefix.nim new file mode 100644 index 000000000..6ee9fb2dc --- /dev/null +++ b/tools/nimsuggest/tests/twithin_macro_prefix.nim @@ -0,0 +1,209 @@ + +import macros + +macro class*(head, body: untyped): untyped = + # The macro is immediate, since all its parameters are untyped. + # This means, it doesn't resolve identifiers passed to it. + + var typeName, baseName: NimNode + + # flag if object should be exported + var exported: bool + + if head.kind == nnkInfix and head[0].ident == !"of": + # `head` is expression `typeName of baseClass` + # echo head.treeRepr + # -------------------- + # Infix + # Ident !"of" + # Ident !"Animal" + # Ident !"RootObj" + typeName = head[1] + baseName = head[2] + + elif head.kind == nnkInfix and head[0].ident == !"*" and + head[2].kind == nnkPrefix and head[2][0].ident == !"of": + # `head` is expression `typeName* of baseClass` + # echo head.treeRepr + # -------------------- + # Infix + # Ident !"*" + # Ident !"Animal" + # Prefix + # Ident !"of" + # Ident !"RootObj" + typeName = head[1] + baseName = head[2][1] + exported = true + + else: + quit "Invalid node: " & head.lispRepr + + # The following prints out the AST structure: + # + # import macros + # dumptree: + # type X = ref object of Y + # z: int + # -------------------- + # StmtList + # TypeSection + # TypeDef + # Ident !"X" + # Empty + # RefTy + # ObjectTy + # Empty + # OfInherit + # Ident !"Y" + # RecList + # IdentDefs + # Ident !"z" + # Ident !"int" + # Empty + + # create a type section in the result + result = + if exported: + # mark `typeName` with an asterisk + quote do: + type `typeName`* = ref object of `baseName` + else: + quote do: + type `typeName` = ref object of `baseName` + + # echo treeRepr(body) + # -------------------- + # StmtList + # VarSection + # IdentDefs + # Ident !"name" + # Ident !"string" + # Empty + # IdentDefs + # Ident !"age" + # Ident !"int" + # Empty + # MethodDef + # Ident !"vocalize" + # Empty + # Empty + # FormalParams + # Ident !"string" + # Empty + # Empty + # StmtList + # StrLit ... + # MethodDef + # Ident !"age_human_yrs" + # Empty + # Empty + # FormalParams + # Ident !"int" + # Empty + # Empty + # StmtList + # DotExpr + # Ident !"this" + # Ident !"age" + + # var declarations will be turned into object fields + var recList = newNimNode(nnkRecList) + + # expected name of constructor + let ctorName = newIdentNode("new" & $typeName) + + # Iterate over the statements, adding `this: T` + # to the parameters of functions, unless the + # function is a constructor + for node in body.children: + case node.kind: + + of nnkMethodDef, nnkProcDef: + # check if it is the ctor proc + if node.name.kind != nnkAccQuoted and node.name.basename == ctorName: + # specify the return type of the ctor proc + node.params[0] = typeName + else: + # inject `self: T` into the arguments + node.params.insert(1, newIdentDefs(ident("self"), typeName)) + result.add(node) + + of nnkVarSection: + # variables get turned into fields of the type. + for n in node.children: + recList.add(n) + + else: + result.add(node) + + # Inspect the tree structure: + # + # echo result.treeRepr + # -------------------- + # StmtList + # TypeSection + # TypeDef + # Ident !"Animal" + # Empty + # RefTy + # ObjectTy + # Empty + # OfInherit + # Ident !"RootObj" + # Empty <= We want to replace this + # MethodDef + # ... + + result[0][0][2][0][2] = recList + + # Lets inspect the human-readable version of the output + #echo repr(result) + +# --- + +class Animal of RootObj: + var name: string + var age: int + method vocalize: string {.base.} = "..." # use `base` pragma to annonate base methods + method age_human_yrs: int {.base.} = self.age # `this` is injected + proc `$`: string = "animal:" & self.name & ":" & $self.age + +class Dog of Animal: + method vocalize: string = "woof" + method age_human_yrs: int = self.age * 7 + proc `$`: string = "dog:" & self.name & ":" & $self.age + +class Cat of Animal: + method vocalize: string = "meow" + proc `$`: string = "cat:" & self.name & ":" & $self.age + +class Rabbit of Animal: + proc newRabbit(name: string, age: int) = # the constructor doesn't need a return type + result = Rabbit(name: name, age: age) + method vocalize: string = "meep" + proc `$`: string = + self.ag#[!]# + result = "rabbit:" & self.name & ":" & $self.age + +# --- + +var animals: seq[Animal] = @[] +animals.add(Dog(name: "Sparky", age: 10)) +animals.add(Cat(name: "Mitten", age: 10)) + +for a in animals: + echo a.vocalize() + echo a.age_human_yrs() + +let r = newRabbit("Fluffy", 3) +echo r.vocalize() +echo r.age_human_yrs() +echo r + +discard """ +$nimsuggest --tester $file +>sug $1 +sug;;skField;;age;;int;;$file;;167;;6;;"";;100 +sug;;skMethod;;twithin_macro_prefix.age_human_yrs;;proc (self: Animal): int;;$file;;169;;9;;"";;100 +""" -- cgit 1.4.1-2-gfad0 GridCell.invalid race' href='/akspecs/aerc/commit/lib/ui/grid.go?h=0.1.0&id=335db0402decf1e0a3b07e7c51ab62a4f6baab50'>335db04 ^ 
8c8c21f ^


60b351b ^
















f0791d4 ^










a0c2b1c ^

5feb7de ^



a0c2b1c ^







1892d73 ^





5feb7de ^




4675648 ^

335db04 ^


1892d73 ^


60b351b ^


1892d73 ^




1892d73 ^

60b351b ^




1892d73 ^









f0791d4 ^

1892d73 ^


60b351b ^

f0791d4 ^




60b351b ^

f0791d4 ^

1892d73 ^



f0791d4 ^






60b351b ^


1892d73 ^

60b351b ^

1892d73 ^



f0791d4 ^


1892d73 ^



60b351b ^

1892d73 ^

5685a17 ^

60b351b ^




5feb7de ^

4675648 ^

60b351b ^


5feb7de ^

8c8c21f ^


60b351b ^





60b351b ^

5feb7de ^

4675648 ^

5feb7de ^

8c8c21f ^

335db04 ^

60b351b ^


8c8c21f ^


bb46b2b ^

5feb7de ^

bb46b2b ^


4675648 ^

8c8c21f ^



5feb7de ^

60b351b ^

8c8c21f ^




5feb7de ^

4675648 ^

8c8c21f ^





5feb7de ^

8c8c21f ^



335db04 ^

5685a17 ^

8c8c21f ^

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