Source Code Browsers?

patonw asks: "I just started working for a company as a programmer on a project with a huge existing codebase. The person hiring me half-jokingly said that it usually takes new employees two years before they understand the system. What I am looking for is not just an editor/browser but a program that displays functions and classes as connected graphs -- preferably free. I would like to view how programs are structured by function calls and class relations. I have access to several different kinds of platforms/operating systems."

What is it with slashdot-Reenginering Perl.

[Anonymous Coward]

"that everyone is asking for code analysis software these days? There was a story just a couple of days ago already."

I suspect some's trying to reengineer Slashdot's code.

Re:What is it with slashdot-Reenginering Perl.

[bitsformoney]

I suspect you suspect right.

KDevelop can help

[Zoko Siman]

If it's a c++ project KDevelop will show you a list of functions and classes and what files they're in. Things of that nature. Try it out, it's free.

Source Navigator

[IYagami]

Sponsored by RedHat:

http://sourcenav.sourceforge.net/

From the FAQ:
Source-Navigator supports C, C++, Java, Tcl, [incr Tcl], FORTRAN and COBOL, and provides and SDK so that you can write your own parsers.

Use Source-Navigator to:

* Analyze how a change will effect external source modules.
* Find every place in your code where a given function is called.
* Find each file that includes a given header file.
* Use the grep tool to search for a given string in all your source files.

Re:Source Navigator

[AiY]

sourcenav is pretty cool. I used it to learn a very complicated C++ codebase - really helped. Of course when I showed it to a someone who started recently, he asked why I just didn't use vi & tags. I didn't have good response.

Re:Source Navigator

[statusbar]

Which tags programs works with c++ effectively? Is even a subset of what sourcenav indexes available?

If there is one, I'd love to see it.

--jeff++

Please learn how to make links.

[Anonymous Coward]

Please learn how to make links.

<a href="http://sourcenav.sourceforge.net/">Source-Na vigator</a>

(without any spaces put there by Slashdot) yields: Source-Navigator [sourceforge.net]

If that's too much typing for you,

<URL:http://sourcenav.sourceforge.net/>

(without any spaces put there by Slashdot) yields: http://sourcenav.sourceforge.net/ [sourceforge.net]

Oh, and for you "Well just right-click on the text and click 'Follow Link'." people, tell me how to open a selected-text link containing extraneous Slashdot spaces

Re:Source Navigator

[hughk]

This is just a "me too", but I also found sourcenav great for getting into a big legacy C++ project. I did have stability problems but I had to run the Windows version because the AIX backend was so ancient that I couldn't build on that platform. It meant I needed frequent saves of the project but otherwise fine.

Windows specific

[alexo]

Microsoft's Visual C++ creates a "code database" containing information about functions and classes.

Version 6 had operations like "call graph" and "caller graph" that graphically showed the function calling sequence from or to a given function.

Unfortunately, Microsoft, in their infinite wisdom, decided to scrap this functionality in version 7 (a.k.a .NET).

Theoretically, since the code DB still contains the full info, an add-on could be written to support this functionality but ,as far as I know, there is

Doxygen

[Tersevs]

I havnt heard about any free source browsing programs... But I've been using Doxygen to generate HTML documentation of the source when I need to familliarize myself to new code. Definitions in the documentation will be hypertext linkes and there are class inheritance graphs generated. What's missing is really some kind of call-tree but you cant have everything. Doxygen also extract JavaDoc comments from C++ code and insert them into the HTML-documentation.

Doxygen can also generate LaTeX, and RTF files instead of HTML.

Doxygen for C++ / C etc

[ssclift]

Doxygen [doxygen.org] is a good choice for C++, C, Java, Objective-C, IDL... I used it to get into a ~50K line project a few years ago and have used it regularly whenever I'm forced to use C++... Get Graphviz [att.com] as well so Doxygen can draw pretty pictures for you.

More on Doxygen

[fm6]

Doxygen is an absolute must if you need to document C++ APIs. Used with Graphviz, you do get clickable web diagrams that are very useful for visualizing class relationships. But note that the diagrams are not publication quality, since Graphviz has only the most primitive line-drawing features.

In theory you can use Doxygen with any OO language, provided you can get a parser for that language. But I haven't heard a lot about Doxygen outside the C++ community. I imagine Java people mostly stick with JavaDoc [sun.com]

Doxygen

[DeadMeat (TM)]

Doxygen [doxygen.org] can use Graphviz [graphviz.org] to generate class and call graphs for several different languages. It helps to have Doxygen or Javadoc annotations in the code, but it's not necessary.

Unfortunately graph generation is pretty slow, but otherwise it's a fantastic tool.

Meh

[cookiepus]

If your codebase is anything like what I've been working with, there's no tools that are going to make your life easier.

If the code had decent structure, you'd not be asking this question. But it's a mess. And if you display the mess as a tree structure, it's still a mess. The value is limited.

The best thing I've done is set up etags accross the entire codebase. This way I can at least navigate code easier. But I doubt you will understand anything more from tree graphs.

Re:Meh

[_flan]

I don't think that's entirely a fair statement. I find that being able to visualize a codebase can help significantly -- even when it is a mess.

Where I work we have some home-grown (and not terribly good) tools that help us visualise a project's architecture, from both the design and the implementation point of view. For projects that are good, these two views mesh perfectly. For projects that are crap, they diverge wildly. This gives a you a good idea where a little refactoring might to a lot of good.

Literate programming

[keramida]

As an aside, back in my university days, I worked on a project where we did all of our coding in FrameMaker. This allowed us to put in pictures, colored comments -- basically anything. The build script turned the FrameMaker file into C++ source, which then got compiled. It was kind of the extreme version of self-documenting code.

This sounds a lot like a relatively old, but intriguing idea. "Literate Programming [wikipedia.org]" is exactly what you describe.

It is exciting to write heavily documented code, but I doubt

Debug

[rmull]

This is perhaps a tangential answer, but I do much better by going through the code with a debugger and watching things happen. Especially with some of the more compilacated OO stuff, and when the comments are unhelpful or wrong, it can be much more useful than reading the code.

Re:Debug

[Fizzl]

Amen.

Have you ever been porting/documenting/something someone elses Symbian C++ code? It's fricking hilarious. Symbian forces certain design principles upon you, but the design is so arcane for the small pieces of software, it makes it next to impossible to decipher someone elses Symbian code.
Especially if the previous developer has adopted the "correct" way of structuring app/ui/doc/view in different files plus followed the UI/Engine guideline too. Ofcourse you must do everything asynchronously with Activ

Re:Debug

[Bat_Masterson]

Of course, that presumes that you have a decent set of functional tests that cover the code well in order to get a good idea of what is going on. Of course, the permutations involved on a moderate to large code base could be far more than you could keep in your head...

Re:Debug

[slapout]

Assuming, of course, that they let you have a debugger, unlike my last employer...

Re:Debug

[GlassHeart]

I do much better by going through the code with a debugger and watching things happen.

That can tell you what is actually happening, but not what the original programmer wanted to happen, or why he needs it to happen.

when the comments are unhelpful or wrong, it can be much more useful than reading the code.

Not to be facetious, but how do you know it's the comments, not the code, that are wrong?

Re:Debug

[AsbestosRush]

That can tell you what is actually happening, but not what the original programmer wanted to happen, or why he needs it to happen.

Best example of the above: Mel [jargon.net].

Not to be facetious, but how do you know it's the comments, not the code, that are wrong?
Most coders update the code, not the comments. If the code works, and the comments don't corrospond, it's the comments that are borked, IMO.

Hell, I've even been guilty of this stuff on my own projects, even tho they're only simple PERL stuff. I go back 3

SHriMP/Creole, JQuery

[Earlybird]

SHriMP [thechiselgroup.org] (screenshot [thechiselgroup.org]):

• ... designed for visualizing and exploring software architecture and any other information space. SHriMP (Simple Hierarchical Multi-Perspective) is a domain-independent visualization technique designed to enhance how people browse and explore complex information spaces. Among the applications we are actively exploring is the exploration of large software programs, and the understanding of complex knowledge-bases (via the Protégé tool)."

Currently SHriMP runs both as a standalone application and, using the Creole [thechiselgroup.org] plugin, inside Eclipse [eclipse.org] to augment its existing, extensive code browsing capabilities. There's also a plugin for Protégé [stanford.edu], a Stanford project to build "an ontology editor and a knowledge-base editor" supporting new techologies such as OWL [w3.org].

While Creole is currently Java-specific, SHriMP is a generic framework for code visualization.

JQuery

[Earlybird]

I was actually going to mention JQuery [cs.ubc.ca], but changed my mind. But some people might find it useful.

Re:JQuery

[bitsformoney]

This is actually very interesting. I have thought of doing prolog-like querying on the parse tree before, but never dared to ask for it.

my favorite code bomb....

[St. Arbirix]

Doxygen [stack.nl] does exactly what you described. See item #2 in the link.

If that doesn't work look up programs that will convert to UML. Since you didn't mention it in your question I'll expand: Unified Modeling Language diagrams are a standardized means of describing the relationships between objects in classes. To any Slashdotters out there in college looking to take a software engineering course, you'll be seeing a lot of UML.

CAST

[drsDobbs]

Sometime ago I used Cast for this purpose. I think it's currently called Cast Enlighten (http://www.castsoftware.com/Products/platform/AMS /Enlighten/Features.html [castsoftware.com]. It's a big and complex (and probably costly) product, but it really does the job. It covers lots of languages and it is even able to drill down from e.g. java into Oracle stored procedures.

Roll-your-own

[Tablizer]

I tend to roll-my-own code analyzers because each system tends to have a different personality and there are different things to look for. Generally I try to parse the code and log each file, module, and subroutine into a relational database. Then I can query it later as needed. I also may log every variable and and token, filtering out common key-words. This risks over-indexing but is better than under-indexing becase extra tokens are less of a problem than non-indexed tokens. And, one can adjust the index

Re:Roll-your-own

[Anonymous Coward]

Bryce Jacobs, be quiet. I crapped out more code this morning than a broken-down obsolete relic of DOS 3.3 like you could ever comprehend in a lifetime. Blah blah blah table blah blah blah SQL blah FoxPro blah database. Prove us wrong -- put your alleged code analyzer tools on Sourceforge if they are so great, or even exist. Until then, stop trying to tell software developers how to do their jobs.

Re:Roll-your-own

[Tablizer]

Prove us wrong -- put your alleged code analyzer tools on Sourceforge if they are so great

Like I said, they tend to be language or site-specific. Making such tools generic, well-documented, and with a decent interface would greatly increase their complexity and code-size. That is the value that roll-your-own tools have over "boxed" tools: you only have to consider your cases, not all possible cases it may encounter.

For example, I don't need to have grammar parsing templates for every possible programmi

Source Insight

[murat]

We use "Source Insight" and we are very happy. ;) It's not free, though.

--...I know...

[Refrozen]

Okay, so this doesn't answer what he was looking for, but the title reminded me of Koders [koders.com]... the search engine sucks, but it's a great idea.

Source Navigator

[avdi]

I second the recommendation for Source Navigator. It's been a a great help to me in comprehending legacy codebases.

For PHP try this...

[todsandberg]

PHPXRef: PHP Cross Referencing Documentation Generator
http://phpxref.sourceforge.net/ [sourceforge.net]

lxr

[hitchhacker]

how about LXR? [sourceforge.net]

I've been using it to browse linux source code lately: here [linux.no]

from the site:
A general purpose source code indexer and cross-referencer that provides web-based browsing of source code with links to the definition and usage of any identifier. Supports multiple languages.

except for lack of syntax hilighting, it works well.

-metric

Re:lxr

[brondsem]

I've worked fairly extensively with LXR for my former employer to get it working on our large codebase. If you try it, use the CVS version, not the latest release because it has some good enhancements and fixes. Not much development happens on the project on a regular basis, though. It won't give everything the poster requested, but browsing with identifier cross-reference, and freetext searching are its two main features and it does those well.

Also, hopefully your codebase runs off some sort of revisi

It takes a *long* time to learn large systems.

[Richard Steiner]

I worked on the flight operations system for a large airline for over eight years (actually ten if you count my contractor time), and I only learned the intimate details of perhaps 20% of it bu the time I'd left.

Complex applications require a huge amount of specialized knowledge in order to understand, and most of that knowledge relates to the application or work process itself, not the technical environment...

KCachegrind...

[dmayle]

Here's one that no one else probably thought of. If the software runs on linux, load it up in valgrind with the calltree tool, use it a little, and look at the kcachegrind visualizations. It'll give you an idea of what code is actually used, and how it's interrelated.

Emacs Code Browser

[shapr]

I like Emacs Code Browser [sourceforge.net], it's fast, featureful, and it deals with a bunch of different languages, see the screenshots [sourceforge.net]
Of course, if you don't use emacs, it won't be nearly as handy.

Look on sweetcode.org

[Farq Fenderson]

I've written a few in Perl for quick breakdowns. No graphing, but the equivalent textual information. I recall seeing a few projects of a similar nature on sweetcode, with graphing (3D?) unfortunately I don't recall what they might have been called.

someone had to say it...

[loony]

find, grep and vi is all you need! :-)

Re:someone had to say it...

[ajole]

Well, maybe find, grep and emacs :)

Re:someone had to say it...

[patonw]

Funny you should say that. That's all I've been using for the past week.

Cscope

[Anonymous Coward]

I can't believe nobody has mentioned cscope [sourceforge.net] yet. We used that in the multi-million line project I worked on until a couple of years ago. My division was only responsible for a few hundred thousand lines of code with a relatively well defined interface, so we generally kept our own cscope subset (Hint: cscope has an option to cache its results, and I highly recommend doing that if your project is more than a few thousand lines). I never actually had to use cscope for the entire source tree, but it worked VERY well for my area of responsibility (several tens of thousands of lines).

In order to stick to the original question, I should also mention that most nontrivial programs end up using dynamic programming styles, and there's no way to graphically display those. I also want to point out is that no source code analyzer is going to do a even a half-assed job at figuring out dynamic relationships, so if your project contains any drivers/vtables/virtual functions, then you're basically S.O.L, and you may as well just use cscope. However, if you really insist on getting a graphical output, check out the free code graphing project [sourceforge.net]. It has a nice picture of the linux kernel [sourceforge.net].

no call graph, but immensely useful for C

[ChipMonk]

CScope, originally developed at AT&T Labs, now under the GPL and available at SourceForge. It works amazingly well on the Linux kernel. I've even tinkered around in the XFree86 code using CScope.

(Also comes with vim integration, if you're into that.)

Source Insight

[atlasheavy]

Use it, love it. The UI is rather ugly, but it is the best damned source navigation tool available for Windows today. (Link [sourceinsight.com])

Tools like this for Perl?

[harlows_monkeys]

Doxygen and Sourcenav (the main recommendations most people seem to be giving) are pretty good for the languages they support.

However, neither supports Perl. Has anyone seen a tool like this that works on Perl code?

Source Insight

[Ennuieux]

The one at is not free (my company pays for it...), but it works very, very well.

Re:Source Insight

[Ennuieux]

Duh, I mean at http://www.sourceinsight.com

Thanks Everyone

[patonw]

I'll try those programs and keep you posted.

Smalltalk

[GnuVince]

I'm surprised no one has talked about Smalltalk's integrated code browser yet. See how much languages and environments have to learn from Smalltalk?

Codeviz

[meowsqueak]

There's a nice front-end called Codeviz that 'writes' the graphs for Graphviz to render, and lets you filter symbols based on regular expressions. I find it pretty useful on C source - can't comment on other languages.

code browsing

[tiks]

i use visual slickedit & its code browser works just great for me , it uses incremental search to update the tags so it dosent takes hell of a time updating tags database, if u want 2 use a free too then use kscope which uses cscope & ctags.