yourabi / deheader Goto Github PK

fix: maybe freopen stdin from file?

Some common headers will be automatically pulled into a project indirectly via other headers, for example errno. Yet, it is good form to explicitly include such headers when making direct use of their symbols.

The current deheader algorithm relies on accidents of indirect inclusion when deciding whether to include a header or not. But a more accurate algorithm would involve scanning for the use of exported symbols.

It would be nice to be able to 'pip install deheader'

Hi,

A common pattern in C/C++ is to define function signatures in a separate .h[pp] file, and then include the signatures into the implementation .c[pp] file. Would be helpful for deheader to account for this common practice.

There may not necessarily be any symbols reused from such a header. Some headers may consist chiefly of a header guard macro and a docstring comment. Yet even so, the implementation conventionally needs to include this header.

Most of the time, the header serves simply to export the implemented functions into a reusable API. The header contains no additional information, but rather acts like a checksum in terms of making sure the function signatures are correct. Although deheader currently treats these headers as removable, in fact, their removal could break the API for downstream users.

For example, drop the file extension from the header basename. Drop the file extension from the implementation basename. If the two match, then it is very likely safe for deheader to ignore this.