It builds upon the databases of cscope and Exuberant ctags. It can also work with Universal ctags, which is a drop-in replacement for Exuberant ctags.
The databases of cscope and ctags would be processed by the cqmakedb tool to generate the CodeQuery database file.
The CodeQuery database file can be viewed and queried using the codequery GUI tool.
NOTE: Version 0.21.0 has fixes for a major performance bug in the GUI and in the ctags file parser.
To build on Linux, please read the INSTALL-LINUX file.
On Mac, the software can be installed through Brew using brew install codequery.
Please read NEWS to find out more.
How is it different from cscope and ctags? What are the advantages?
Both cscope and ctags can do symbol lookup and identify functions, macros, classes and structs.
cscope is very C-centric, but is fuzzy enough to cover C++ and Java, but not very well for e.g. it doesn’t understand destructors and class member instantiations. It can’t provide relationships of class inheritance and membership. cscope can do “functions that call this function” and “functions called by this function”. This is a very powerful feature that makes cscope stand out among comparable tools.
ctags does many languages well and understands destructors, member instantiations, and the relationships of class membership and inheritance. From ctags, we can find out “members and methods of this class”, “class which owns this member or method”, “parent of this class”, “child of this class” etc. However, it doesn’t do “functions that call this function” or “functions called by this function”.
So both these tools have their pros and cons, but complement each other.
CodeQuery is a project that attempts to combine the features available from both cscope and ctags, provide faster database access compared to cscope (because it uses sqlite) and provides a nice GUI tool as well. Due to this faster database access, fast auto-completion of search terms and multiple complex queries to perform visualization is possible.
In addition, pycscope is used to add support for Python, in place of cscope.
What features does CodeQuery have?
Case-insensitive, partial keyword search - wildcard search supported * and ?
What types of query can I make?
How does the visualization look like?
Are other editors like vim or emacs supported?
Yes! There is a vim plugin for CodeQuery called vim-codequery by devjoe. We welcome contributors to develop plugins for other editors too.
What does it cost? How is it licensed?
It’s freeware and free open source software.
This software is licensed under the Mozilla Public License, version 2.0. See LICENSE.md or LICENSE.txt.
Files under the querylib directory are licensed under the MIT license. See QueryLib README. This is a library to query CodeQuery database files. This library is MIT-licensed, so that it may be used to create plugins for editors, IDEs and other software without license restrictions. It’s only dependency is on sqlite3.
Can I use it in a commercial environment without purchasing, for an unlimited time?
Yes. However, donations are welcomed.
It has been tested on Windows 7 64-bit, Windows XP 32-bit, Mac OS X, Ubuntu and Fedora Linux 64-bit and, Ubuntu and Fedora Linux 32-bit.
Contributions are welcomed to attempt ports to other operating systems.
Is the software available in other languages?
Yes. This applies only to the GUI tool.
Contributions are welcomed to update or provide new translations.
On Linux, tar.gz, RPM and Debian package installations will be provided here: CodeQuery@sourceforge downloads.
To build on Linux and Mac, please read the INSTALL-LINUX file.
Version 15.8a of cscope or higher, works best with CodeQuery.
On Windows: HOWTO-WINDOWS. This file is included in the EXE setup package.
How do I generate whole-program call graphs or UML class diagrams?
CodeQuery cannot do this at the moment.
To generate whole-program call graphs, please use GNU cflow or CodeViz for C and C++. For Java, there is Javashot.
To generate whole-program UML class diagrams for various object-oriented languages, please use tags2uml.
For C and C++, inline assembly code is not supported by all the tools. This mainly affects embedded software, OS and driver code.
Please exclude files with inline assembly code from the list of files (cscope.files) to be scanned.
How do I contact the authors for support, issues, bug reports, fix patches, feature requests etc.?
Please see the email address below, and also the Issues tab in GitHub.
Provide feedback, new ideas, suggestions etc. What would you like to see?
Write plugins for emacs, eclipse, Notepad++, NetBeans, Jenkins etc.
codequery is maintained by ruben2020. This page was generated by GitHub Pages.