Skip to content

Latest commit

 

History

History
133 lines (116 loc) · 4.24 KB

HOWTO-LINUX.md

File metadata and controls

133 lines (116 loc) · 4.24 KB
Raw

HOWTO GUIDE

This HOWTO guide applies to Linux only

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

  1. Change directory to the base folder of your source code like this:
cd ~/projects/myproject/src
  1. 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.
find . -iname "*.c"    > ./cscope.files
find . -iname "*.cpp" >> ./cscope.files
find . -iname "*.cxx" >> ./cscope.files
find . -iname "*.cc " >> ./cscope.files
find . -iname "*.h"   >> ./cscope.files
find . -iname "*.hpp" >> ./cscope.files
find . -iname "*.hxx" >> ./cscope.files
find . -iname "*.hh " >> ./cscope.files
  1. Create a cscope database like this (add k, if you don't want standard include paths like for stdio.h):
cscope -cb
  1. Create a ctags database like this.
ctags --fields=+i -n -R -L ./cscope.files
  1. 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
  1. Open myproject.db using the CodeQuery GUI tool by running the following. 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).
codequery

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

HOW TO USE CODEQUERY WITH JAVA CODE?

  1. Change directory to the base folder of your source code like this:
cd ~/projects/myproject/src
  1. Create a cscope.files file with all the Java source files listed in it.
find . -iname "*.java" > ./cscope.files
  1. Create a cscope database like this:
cscope -cbR
  1. Create a ctags database like this:
ctags --fields=+i -n -R -L ./cscope.files
  1. 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
  1. Open myproject.db using the CodeQuery GUI tool by running the following. 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).
codequery

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

HOW TO USE CODEQUERY WITH PYTHON CODE?

  1. Change directory to the base folder of your source code like this:
cd ~/projects/myproject/src
  1. Create a cscope.files file with all the Python source files listed in it.
find . -iname "*.py"    > ./cscope.files
  1. Create a cscope database like this:
pycscope -i ./cscope.files
  1. Create a ctags database like this.
ctags --fields=+i -n -R -L ./cscope.files
  1. 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
  1. Open myproject.db using the CodeQuery GUI tool by running the following. 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).
codequery

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

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

  1. Change directory to the base folder of your source code like this:
cd ~/projects/myproject/src
  1. Create a cscope.files file with all the Ruby, Go or Javascript source files listed in it.
find . -iname "*.rb"    > ./cscope.files
find . -iname "*.go"    > ./cscope.files
find . -iname "*.js"    > ./cscope.files
  1. Create a cscope database like this:
starscope -e cscope
  1. Create a ctags database like this.
ctags --fields=+i -n -R -L ./cscope.files
  1. 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
  1. Open myproject.db using the CodeQuery GUI tool by running the following. 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).
codequery

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