Best way to extract info from C files?

Best way to extract info from C files?

[Stefano Ghirlanda]

Hi all!

I'm trying to build a simple code documentation tool for org-mode, so
I'm looking for ways to get information from C files (to begin with,
ideally it will be easy to add other languages). Things like function
prototypes, struct definitions, etc. What would be the best tool for
this? My search has come up with things like lsp-mode, semantic, etags
but I have no experience with any of these. What would be easiest to
work with / setup, and have the necessary functionality? Or should I
just write my own parsing code?

More specifically, my initial goal is to be able to parse things in a
format similar naturaldocs.org, for example:

// Function: This is a brief description.
// Parameters:
// - x: The first parameter
// - y: The second parameter
// Return: A value
int my_function( int x, int y );

and transform this into something like:

* Documentation

** my_function

This is a brief description

| Parameters: |                                      |
| x                   | The first parameter       |
| y                   | The second parameter |
|----------------------------------------------------|
| Return          | A value                         |

To be improved iteratively :)

Thanks!

-- 
Stefano Ghirlanda
CTO, DataWorks - https://dataworks.consulting
Guest Professor - Stockholm University Centre for Cultural Evolution

Re: Best way to extract info from C files?

[Stefano Ghirlanda]

And I have just learned about org-ctags from another post on the
list... Would that be an option?

On Tue, Feb 13, 2024 at 7:58 AM Stefano Ghirlanda
<dr.ghirlanda@gmail.com> wrote:
>
> Hi all!
>
> I'm trying to build a simple code documentation tool for org-mode, so
> I'm looking for ways to get information from C files (to begin with,
> ideally it will be easy to add other languages). Things like function
> prototypes, struct definitions, etc. What would be the best tool for
> this? My search has come up with things like lsp-mode, semantic, etags
> but I have no experience with any of these. What would be easiest to
> work with / setup, and have the necessary functionality? Or should I
> just write my own parsing code?
>
> More specifically, my initial goal is to be able to parse things in a
> format similar naturaldocs.org, for example:
>
> // Function: This is a brief description.
> // Parameters:
> // - x: The first parameter
> // - y: The second parameter
> // Return: A value
> int my_function( int x, int y );
>
> and transform this into something like:
>
> * Documentation
>
> ** my_function
>
> This is a brief description
>
> | Parameters: |                                      |
> | x                   | The first parameter       |
> | y                   | The second parameter |
> |----------------------------------------------------|
> | Return          | A value                         |
>
> To be improved iteratively :)
>
> Thanks!
>
> --
> Stefano Ghirlanda
> CTO, DataWorks - https://dataworks.consulting
> Guest Professor - Stockholm University Centre for Cultural Evolution



-- 
Stefano Ghirlanda
CTO, DataWorks - https://dataworks.consulting
Guest Professor - Stockholm University Centre for Cultural Evolution

Re: Best way to extract info from C files?

[Jude DaShiell]

Study sed once you get a script going correctly and you pass sed several
files you'll love the speed it uses to get the work done.  While I was
working I managed to break 106 different files.  I figured with no
mistakes I could fix them in two weeks manually and no mistakes never
happens on manual jobs.  So I studied sed and threw the 106 files at sed
and sed took care of that job for me in 6 minutes and did it accurately.


--
 Jude <jdashiel at panix dot com>
 "There are four boxes to be used in defense of liberty:
 soap, ballot, jury, and ammo.
 Please use in that order."
 Ed Howdershelt 1940.

On Tue, 13 Feb 2024, Stefano Ghirlanda wrote:

> Hi all!
>
> I'm trying to build a simple code documentation tool for org-mode, so
> I'm looking for ways to get information from C files (to begin with,
> ideally it will be easy to add other languages). Things like function
> prototypes, struct definitions, etc. What would be the best tool for
> this? My search has come up with things like lsp-mode, semantic, etags
> but I have no experience with any of these. What would be easiest to
> work with / setup, and have the necessary functionality? Or should I
> just write my own parsing code?
>
> More specifically, my initial goal is to be able to parse things in a
> format similar naturaldocs.org, for example:
>
> // Function: This is a brief description.
> // Parameters:
> // - x: The first parameter
> // - y: The second parameter
> // Return: A value
> int my_function( int x, int y );
>
> and transform this into something like:
>
> * Documentation
>
> ** my_function
>
> This is a brief description
>
> | Parameters: |                                      |
> | x                   | The first parameter       |
> | y                   | The second parameter |
> |----------------------------------------------------|
> | Return          | A value                         |
>
> To be improved iteratively :)
>
> Thanks!
>
>

Re: Best way to extract info from C files?

[Ihor Radchenko]

Stefano Ghirlanda <dr.ghirlanda@gmail.com> writes:

> I'm trying to build a simple code documentation tool for org-mode, so
> I'm looking for ways to get information from C files (to begin with,
> ideally it will be easy to add other languages). Things like function
> prototypes, struct definitions, etc. What would be the best tool for
> this? My search has come up with things like lsp-mode, semantic, etags
> but I have no experience with any of these. What would be easiest to
> work with / setup, and have the necessary functionality? Or should I
> just write my own parsing code?

tree-sitter or lsp might work. Or xrefs. Or TAGS.

> More specifically, my initial goal is to be able to parse things in a
> format similar naturaldocs.org, for example:
>
> // Function: This is a brief description.
> // Parameters:
> // - x: The first parameter
> // - y: The second parameter
> // Return: A value
> int my_function( int x, int y );

This simple scenario might be parsed with custom regexps.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: Best way to extract info from C files?

[Stefano Ghirlanda]

Thanks! I'm looking into tree-sitter now just to learn how it works :)

On Tue, Feb 20, 2024 at 3:01 AM Ihor Radchenko <yantar92@posteo.net> wrote:
>
> Stefano Ghirlanda <dr.ghirlanda@gmail.com> writes:
>
> > I'm trying to build a simple code documentation tool for org-mode, so
> > I'm looking for ways to get information from C files (to begin with,
> > ideally it will be easy to add other languages). Things like function
> > prototypes, struct definitions, etc. What would be the best tool for
> > this? My search has come up with things like lsp-mode, semantic, etags
> > but I have no experience with any of these. What would be easiest to
> > work with / setup, and have the necessary functionality? Or should I
> > just write my own parsing code?
>
> tree-sitter or lsp might work. Or xrefs. Or TAGS.
>
> > More specifically, my initial goal is to be able to parse things in a
> > format similar naturaldocs.org, for example:
> >
> > // Function: This is a brief description.
> > // Parameters:
> > // - x: The first parameter
> > // - y: The second parameter
> > // Return: A value
> > int my_function( int x, int y );
>
> This simple scenario might be parsed with custom regexps.
>
> --
> Ihor Radchenko // yantar92,
> Org mode contributor,
> Learn more about Org mode at <https://orgmode.org/>.
> Support Org development at <https://liberapay.com/org-mode>,
> or support my work at <https://liberapay.com/yantar92>



-- 
Stefano Ghirlanda
CTO, DataWorks - https://dataworks.consulting
Guest Professor - Stockholm University Centre for Cultural Evolution