GitHub - am0d/rust-find: html source code browser generator for rust,+search tool based on libsyntax.possible code for IDE component? Sample of HTML output:-

This repository has been archived by the owner on Nov 14, 2021. It is now read-only.

am0d / rust-find Public archive

forked from dobkeratops/rustfind

Notifications You must be signed in to change notification settings
Fork 0
Star 3

html source code browser generator for rust,+search tool based on libsyntax.possible code for IDE component? Sample of HTML output:-

dobkeratops.github.io/rftest/librustc/rustc.rs.html#176

LGPL-2.1 license

3 stars 9 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 227 Commits
resources/css		resources/css
scripts		scripts
unfold		unfold
.gitignore		.gitignore
.travis.yml		.travis.yml
LICENSE.TXT		LICENSE.TXT
Makefile		Makefile
README		README
astdump.rs		astdump.rs
codemaput.rs		codemaput.rs
crosscratemap.rs		crosscratemap.rs
find_ast_node.rs		find_ast_node.rs
htmlwriter.rs		htmlwriter.rs
ioutil.rs		ioutil.rs
jumptodefmap.rs		jumptodefmap.rs
rf_ast_ut.rs		rf_ast_ut.rs
rf_common.rs		rf_common.rs
rfindctx.rs		rfindctx.rs
rfserver.rs		rfserver.rs
rsfind.rs		rsfind.rs
rust2html.rs		rust2html.rs
rustfind.rs		rustfind.rs
stuff.rs		stuff.rs
test_input.rs		test_input.rs
test_input0.rs		test_input0.rs
test_input2.rs		test_input2.rs
text_formatting.rs		text_formatting.rs
timer.rs		timer.rs
unfold.c		unfold.c
util.rs		util.rs

Repository files navigation

Uses rust libsyntax to find symbol definitions
and generates  HTML view of source with links
finds struct-defs, functions, methods, fields
writes ast node def info into '.rfx' files in plaintext.

"make" to compile and run test program
"make rustsrc" to generate HTML source for the main rust source tree at $(RUST_PATH)/src
./rustfind -h to display options

./rustfind cratename.rs sourcefile.rs:line:col
   ... compiles 'cratename.rs',then shows the
   location&definition referenced by sourcefile:line:col

./rustfind -j cratename.rs -- dump spans & node definition links as JSON

./rustfind -w cratename.rs -- creates HTML view of sourcecode


roadmap
[1] a commandline tool rustfind sourcefile.rs:LINE:COLUMN: --> definition.rs:LINE:col
(to add add hoc navigation tools eg gedit external tools)
  [.1] CTAGS generation  ??
  [.1] interactive commandline tool (enter src/location/symbol-> dump location)
  [.2] possibly queries like "list all the functions that use this type, list all the impls' for this type.."
  [.3] links to Rustdoc ?

[2] JSON / or other dump
.. are there any formats IDE's read for their indexers?

[3] options to dump/pretty print more context for the definitoon
  
[4] an html hyperlinked source generator, like woboq?
   ... + popup type annotaions?
   

[5] use components for IDE integration?

Notes on sourcecode:-
--------------------
-find_ast_node contains the node scanning
-borrows code from rustdoc_ng
-there might be a fair amoount of repition with the compiler internals eg ast node wrappers,
this can be cleaned up..
-a lot here would factor out if ctxt had a node_id:span map

Other:-
-------
improved syntax highlighting rust.lang & required styles (for gtksourceview) included in scripts

more ideas

can ctags actually deal with overloaded symbols?
could we write out an intermediate that editors can read for fast jump-to-def, with some dynamic context .. 


.rfx format:
------------
libname node_id source-file-name line col length  kind [identifier]
jdef nodeid libname def_node_id