File: HOWTO-WINDOWS.txt

package info (click to toggle)
codequery 1.0.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 17,860 kB
  • sloc: cpp: 151,420; xml: 16,576; python: 5,602; ansic: 5,487; makefile: 559; perl: 496; ruby: 209; sql: 194; sh: 106; php: 53; vhdl: 51; erlang: 47; objc: 22; lisp: 18; cobol: 18; modula3: 17; asm: 14; fortran: 12; ml: 11; tcl: 6
file content (180 lines) | stat: -rw-r--r-- 4,749 bytes parent folder | download | duplicates (2)
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

This HOWTO guide applies to Windows only


HOW TO USE CODEQUERY WITH C/C++ CODE?


1. Change directory to the base folder of your source code like this:

cd c:\projects\myproject\src


2. Create a cscope.files file with all the C/C++ source files listed
   in it. Files with inline assembly code should be excluded from
   this list. See: http://en.wikipedia.org/wiki/Inline_assembler

dir /b/a/s *.c    > cscope.files   
dir /b/a/s *.cpp >> cscope.files   
dir /b/a/s *.cxx >> cscope.files   
dir /b/a/s *.cc  >> cscope.files   
dir /b/a/s *.h   >> cscope.files   
dir /b/a/s *.hpp >> cscope.files   
dir /b/a/s *.hxx >> cscope.files   
dir /b/a/s *.hh  >> cscope.files   


3. Create a cscope database like this (add k, if you don't want standard include paths like for stdio.h):

cscope -cb

Omission of c (to use compressed cscope database) is now supported experimentally.

4. Create a ctags database like this.

ctags --fields=+i -n -L cscope.files


5. Run cqmakedb to create a CodeQuery database out of the
   cscope and ctags databases, like this:

cqmakedb -s .\myproject.db -c cscope.out -t tags -p


6. Open myproject.db using the CodeQuery GUI tool. Wild card search
   (* and ?) supported if Exact Match is switched off.
   Or use cqsearch, the CLI-version of CodeQuery (type `cqsearch -h`
   for more info).

Use cqmakedb -h to get help on cqmakedb command line arguments.
Use codequery -h to get help on codequery command line arguments.




HOW TO USE CODEQUERY WITH JAVA CODE?


1. Change directory to the base folder of your source code like this:

cd c:\projects\myproject\src


2. Create a cscope.files file with all the Java source
   files listed in it.

dir /b/a/s *.java > cscope.files 


3. Create a cscope database like this:

cscope -cb

Omission of c (to use compressed cscope database) is now supported experimentally.

4. Create a ctags database like this:

ctags --fields=+i -n -L cscope.files


5. Run cqmakedb to create a CodeQuery database out of the
   cscope and ctags databases, like this:

cqmakedb -s .\myproject.db -c cscope.out -t tags -p


6. Open myproject.db using the CodeQuery GUI tool. Wild card search
   (* and ?) supported if Exact Match is switched off.
   Or use cqsearch, the CLI-version of CodeQuery (type `cqsearch -h`
   for more info).

Use cqmakedb -h to get help on cqmakedb command line arguments.
Use codequery -h to get help on codequery command line arguments.



HOW TO USE CODEQUERY WITH PYTHON CODE?

Please install pycscope manually by following instructions on its page here:
https://github.com/portante/pycscope

1. Change directory to the base folder of your source code like this:

cd c:\projects\myproject\src


2. Create a cscope.files file with all the Python source
   files listed in it.

dir /b/a/s *.py    > cscope.files  


3. Create a cscope database like this:

pycscope -i cscope.files


4. Create a ctags database like this.

ctags --fields=+i -n -L cscope.files


5. Run cqmakedb to create a CodeQuery database out of the
   cscope and ctags databases, like this:

cqmakedb -s .\myproject.db -c cscope.out -t tags -p


6. Open myproject.db using the CodeQuery GUI tool. Wild card search
   (* and ?) supported if Exact Match is switched off.
   Or use cqsearch, the CLI-version of CodeQuery (type `cqsearch -h`
   for more info).

Use cqmakedb -h to get help on cqmakedb command line arguments.
Use codequery -h to get help on codequery command line arguments.




HOW TO USE CODEQUERY WITH RUBY, GO AND JAVASCRIPT CODE?

Please install starscope manually by following instructions on its page here:
https://github.com/eapache/starscope

1. Change directory to the base folder of your source code like this:

cd c:\projects\myproject\src


2. Create a cscope.files file with all the Ruby, Go or Javascript source
   files listed in it.

dir /b/a/s *.rb    > cscope.files  
dir /b/a/s *.go    > cscope.files 
dir /b/a/s *.js    > cscope.files 


3. Create a cscope database like this:

starscope -e cscope


4. Create a ctags database like this.

ctags --fields=+i -n -L cscope.files


5. Run cqmakedb to create a CodeQuery database out of the
   cscope and ctags databases, like this:

cqmakedb -s .\myproject.db -c cscope.out -t tags -p


6. Open myproject.db using the CodeQuery GUI tool. Wild card search
   (* and ?) supported if Exact Match is switched off.
   Or use cqsearch, the CLI-version of CodeQuery (type `cqsearch -h`
   for more info).

Use cqmakedb -h to get help on cqmakedb command line arguments.
Use codequery -h to get help on codequery command line arguments.