Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agvxov/csope
Fork of Cscope version 15.9, with various improvements, because cscope is good and shall not be forgotten. While the original's mainentence seems abandoned and as far as I can tell you need a PhD in autoconf to compile the latest version, Csope is alive and well.
https://github.com/agvxov/csope
cscope ncurses ncurses-tui tui
Last synced: 3 months ago
JSON representation
Fork of Cscope version 15.9, with various improvements, because cscope is good and shall not be forgotten. While the original's mainentence seems abandoned and as far as I can tell you need a PhD in autoconf to compile the latest version, Csope is alive and well.
- Host: GitHub
- URL: https://github.com/agvxov/csope
- Owner: agvxov
- Created: 2023-08-07T10:28:55.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-24T22:56:58.000Z (3 months ago)
- Last Synced: 2024-10-26T11:15:29.773Z (3 months ago)
- Topics: cscope, ncurses, ncurses-tui, tui
- Language: C
- Homepage:
- Size: 2.76 MB
- Stars: 30
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-tuis - csope
README
# Csope
> C source code browser.
> Fork of Cscope version 15.9, with various improvements.
Because cscope is good and shall not be forgotten.
While the original's mainentence seems abandoned and as far as I can tell you need a PhD in autoconf to compile the latest version,
Csope is alive and well.
# Demo
# Before/After
## After
## Before
# Features
#### Search for
+ symbol
+ global definition
+ assignments to specified symbol
+ functions called by specified function
+ functions calling specified function
+ text string
+ egrep pattern
+ file
+ files #including specified file
#### ...and open with your editor.
#### Batch change search results **interactively**.
#### Save/load/pipe results.
#### It fully supports:
+ C
+ Lex
+ Yacc
#### Partially supports
+ C++
+ Java
# Interface
<-- Tab -->
+--Version-----------------Case--+ +--------------------------------+
A |+--------------+---------------+| |+------------------------------+|
| || Input Window | Result window || || ||
| |+--------------+ || ? || ||
|| Mode Window | || ----> || Help ||
% || | || <---- || ||
|| | || ... || ||
| || | || || ||
| || | || || ||
V |+--------------+---------------+| |+------------------------------+|
+---------------------Tool Tips--+ +--------------------------------+
# Usacases
Csope shines at exploring stranger and obsecure code bases due to its TUI.
It sometimes gets mislabeled as a code navigation tool, but the original documentation describes it best as a "code browsing tool".
Many tools can jump you to a definition or grep for patterns,
but Csope is unqie in that it allows for those and many other functionalities while providing you with a very comprehansible list of all results,
ready to fire up your editor at just the spot.
An example of its excelence is this project. The Cscope codebase used to be a total mess,
fixing it would have been a lost cause, if not for Cscope itself. Well, Csope now.
# Improvements/Changes
## User side
+ Renamed the program, because "cscope" is annoying to type
+ Improved tui
+ GNU Readline/History integration
## To the code
+ Nuked autoconf, replaced with single Makefile
+ Reorganized the control flow
+ Encapsulated changes to the TUI into display.c
+ Encapsulated searching into find.c
+ Removed "scanner.l" which seems to be an anchient version (and redundant copy) of "fscanner.l" forgotten by all
+ Removed macro hell put in place to allow compiling on a dead badger
+ Use stdbool instead of YES/NO macros
+ Saved kilobytes by stripping trailing whitespace
+ ...and much more
# Installation
You will have to compile from source.
After you made sure you have the following installed:
ncurses
GNU Readline
GNU History (should come with Readline)
Lex (or GNU Flex)
Yacc (or GNU Bison)
Just run:
make
This will yield the executable "csope", which you are free to do whatever with.
Hint:
cp csope /usr/bin/
# Quick start
Start browsing your project by running csope over it's source dir.
csope -s source/
# Configuration
## Readline
The readline integratoin should be complete -please let us know if not-, except for your prompt being used, which could easily break the TUIs display.
The rl_readline_name variable will be set to "Csope", so you may have conditional configurations in your .inputrc with the following format:
$if Csope
#
$endif
## Colors
All can be configured sucklessly under "config/colors.h". Hopefully the comments are self evident.
# Future features / contributor wishlist
+ providing support for other languages by integrating new lexers (e.g. ctag's)