fork of https://github.com/sourcegraph/zoekt
Support for --_interactive mode of universal-ctags.
For running the tests, a universal-ctags version of
5d82ee6e92ee9cdda5cc9dcee91646dd678b4b42 or newer is needed.
Change-Id: I9aa13237d1045e5169a49bd76aab9a398c4a0c36
author
Han-Wen Nienhuys
date
(Jun 21, 2017, 10:22 AM +0200)
commit
12718f13
12718f1388ce2cbf007856552b5c677aa628dc1c
parent
35edf407
35edf407baadd34c76c3531124084f6938282353
+256
-4
3 changed files
ctags
+161
ctags/json.go
+161
ctags/json.go
···
1
1
+
// Copyright 2017 Google Inc. All rights reserved.
2
2
+
//
3
3
+
// Licensed under the Apache License, Version 2.0 (the "License");
4
4
+
// you may not use this file except in compliance with the License.
5
5
+
// You may obtain a copy of the License at
6
6
+
//
7
7
+
// http://www.apache.org/licenses/LICENSE-2.0
8
8
+
//
9
9
+
// Unless required by applicable law or agreed to in writing, software
10
10
+
// distributed under the License is distributed on an "AS IS" BASIS,
11
11
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
12
+
// See the License for the specific language governing permissions and
13
13
+
// limitations under the License.
14
14
+
15
15
+
package ctags
16
16
+
17
17
+
import (
18
18
+
"bufio"
19
19
+
"encoding/json"
20
20
+
"io"
21
21
+
"os"
22
22
+
"os/exec"
23
23
+
"runtime"
24
24
+
"sync"
25
25
+
)
26
26
+
27
27
+
type ctagsProcess struct {
28
28
+
cmd *exec.Cmd
29
29
+
in io.WriteCloser
30
30
+
out *bufio.Scanner
31
31
+
outPipe io.ReadCloser
32
32
+
33
33
+
procErrMu sync.Mutex
34
34
+
procErr error
35
35
+
}
36
36
+
37
37
+
var bin = "universal-ctags"
38
38
+
39
39
+
func newProcess() (*ctagsProcess, error) {
40
40
+
opt := "default"
41
41
+
if runtime.GOOS == "linux" {
42
42
+
opt = "sandbox"
43
43
+
}
44
44
+
45
45
+
cmd := exec.Command(bin, "--_interactive="+opt, "--fields=*")
46
46
+
in, err := cmd.StdinPipe()
47
47
+
if err != nil {
48
48
+
return nil, err
49
49
+
}
50
50
+
51
51
+
out, err := cmd.StdoutPipe()
52
52
+
if err != nil {
53
53
+
in.Close()
54
54
+
return nil, err
55
55
+
}
56
56
+
cmd.Stderr = os.Stderr
57
57
+
proc := ctagsProcess{
58
58
+
cmd: cmd,
59
59
+
in: in,
60
60
+
out: bufio.NewScanner(out),
61
61
+
outPipe: out,
62
62
+
}
63
63
+
64
64
+
if err := cmd.Start(); err != nil {
65
65
+
return nil, err
66
66
+
}
67
67
+
68
68
+
var init reply
69
69
+
if err := proc.read(&init); err != nil {
70
70
+
return nil, err
71
71
+
}
72
72
+
73
73
+
return &proc, nil
74
74
+
}
75
75
+
76
76
+
func (p *ctagsProcess) Close() {
77
77
+
p.cmd.Process.Kill()
78
78
+
p.outPipe.Close()
79
79
+
p.in.Close()
80
80
+
}
81
81
+
82
82
+
func (p *ctagsProcess) read(rep *reply) error {
83
83
+
if !p.out.Scan() {
84
84
+
// capture exit error.
85
85
+
err := p.cmd.Wait()
86
86
+
p.outPipe.Close()
87
87
+
p.in.Close()
88
88
+
return err
89
89
+
}
90
90
+
return json.Unmarshal(p.out.Bytes(), rep)
91
91
+
}
92
92
+
93
93
+
func (p *ctagsProcess) post(req *request, content []byte) error {
94
94
+
body, err := json.Marshal(req)
95
95
+
if err != nil {
96
96
+
return err
97
97
+
}
98
98
+
body = append(body, '\n')
99
99
+
if _, err = p.in.Write(body); err != nil {
100
100
+
return err
101
101
+
}
102
102
+
_, err = p.in.Write(content)
103
103
+
104
104
+
return err
105
105
+
}
106
106
+
107
107
+
type request struct {
108
108
+
Command string `json:"command"`
109
109
+
Filename string `json:"filename"`
110
110
+
Size int `json:"size"`
111
111
+
}
112
112
+
113
113
+
type reply struct {
114
114
+
// Init
115
115
+
Typ string `json:"_type"`
116
116
+
Name string `json:"name"`
117
117
+
Version string `json:"version"`
118
118
+
119
119
+
// completed
120
120
+
Command string `json:"command"`
121
121
+
122
122
+
Path string `json:"path"`
123
123
+
Pattern string `json:"pattern"`
124
124
+
Language string `json:"language"`
125
125
+
Line int `json:"line"`
126
126
+
Kind string `json:"kind"`
127
127
+
}
128
128
+
129
129
+
func (p *ctagsProcess) Process(name string, content []byte) ([]*Entry, error) {
130
130
+
req := request{
131
131
+
Command: "generate-tags",
132
132
+
Size: len(content),
133
133
+
Filename: name,
134
134
+
}
135
135
+
136
136
+
if err := p.post(&req, content); err != nil {
137
137
+
return nil, err
138
138
+
}
139
139
+
140
140
+
var es []*Entry
141
141
+
for {
142
142
+
var rep reply
143
143
+
if err := p.read(&rep); err != nil {
144
144
+
return nil, err
145
145
+
}
146
146
+
if rep.Typ == "completed" {
147
147
+
break
148
148
+
}
149
149
+
150
150
+
e := Entry{
151
151
+
Sym: rep.Name,
152
152
+
Path: rep.Path,
153
153
+
Line: rep.Line,
154
154
+
Kind: rep.Kind,
155
155
+
}
156
156
+
157
157
+
es = append(es, &e)
158
158
+
}
159
159
+
160
160
+
return es, nil
161
161
+
}
+94
ctags/json_test.go
+94
ctags/json_test.go
···
1
1
+
// Copyright 2017 Google Inc. All rights reserved.
2
2
+
//
3
3
+
// Licensed under the Apache License, Version 2.0 (the "License");
4
4
+
// you may not use this file except in compliance with the License.
5
5
+
// You may obtain a copy of the License at
6
6
+
//
7
7
+
// http://www.apache.org/licenses/LICENSE-2.0
8
8
+
//
9
9
+
// Unless required by applicable law or agreed to in writing, software
10
10
+
// distributed under the License is distributed on an "AS IS" BASIS,
11
11
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
12
+
// See the License for the specific language governing permissions and
13
13
+
// limitations under the License.
14
14
+
15
15
+
package ctags
16
16
+
17
17
+
import (
18
18
+
"reflect"
19
19
+
"testing"
20
20
+
)
21
21
+
22
22
+
func TestJSON(t *testing.T) {
23
23
+
p, err := newProcess()
24
24
+
if err != nil {
25
25
+
t.Fatal("newProcess", err)
26
26
+
}
27
27
+
28
28
+
defer p.Close()
29
29
+
30
30
+
java := `
31
31
+
package io.zoekt;
32
32
+
import java.util.concurrent.Future;
33
33
+
class Back implements Future extends Frob {
34
34
+
public static int BLA = 1;
35
35
+
public int member;
36
36
+
public Back() {
37
37
+
member = 2;
38
38
+
}
39
39
+
public int method() {
40
40
+
member++;
41
41
+
}
42
42
+
}
43
43
+
`
44
44
+
name := "io/zoekt/Back.java"
45
45
+
got, err := p.Process(name, []byte(java))
46
46
+
if err != nil {
47
47
+
t.Errorf("Process: %v", err)
48
48
+
}
49
49
+
50
50
+
want := []*Entry{
51
51
+
{
52
52
+
Sym: "io.zoekt",
53
53
+
Kind: "package",
54
54
+
Path: "io/zoekt/Back.java",
55
55
+
Line: 2,
56
56
+
},
57
57
+
{
58
58
+
Sym: "Back",
59
59
+
Path: "io/zoekt/Back.java",
60
60
+
Line: 4,
61
61
+
Kind: "class",
62
62
+
},
63
63
+
64
64
+
{
65
65
+
Sym: "BLA",
66
66
+
Path: "io/zoekt/Back.java",
67
67
+
Line: 5,
68
68
+
Kind: "field",
69
69
+
},
70
70
+
{
71
71
+
Sym: "member",
72
72
+
Path: "io/zoekt/Back.java",
73
73
+
Line: 6,
74
74
+
Kind: "field",
75
75
+
},
76
76
+
{
77
77
+
Sym: "Back",
78
78
+
Path: "io/zoekt/Back.java",
79
79
+
Line: 7,
80
80
+
Kind: "method",
81
81
+
},
82
82
+
{
83
83
+
Sym: "method",
84
84
+
Path: "io/zoekt/Back.java",
85
85
+
Line: 10, Kind: "method",
86
86
+
},
87
87
+
}
88
88
+
89
89
+
for i := range want {
90
90
+
if !reflect.DeepEqual(got[i], want[i]) {
91
91
+
t.Fatalf("got %#v, want %#v", got[i], want[i])
92
92
+
}
93
93
+
}
94
94
+
}