vscode-cdecl's Introduction

vscode-cdecl

An extension to help you make sense of C gibberish, based off of the logic behind the excellent https://cdecl.org/.

Bug reports/suggestions/feedback welcome!

Features

Explain a C/C++ declaration or cast in plain English
Generate a C/C++ declaration or cast from plain English

See help.md or run the cdecl: Help command to learn more.

Known issues

C++-specific syntax might not be handled correctly. See #1

Release Notes

1.0.0

Initial release.

Hacking

All of the core logic is based off of a program called cdecl, which has existed in one form or another for over 30 years. The version included in this extension is available at wasabifan/cdecl-blocks-js which is a lightly-modified fork of ridiculousfish/cdecl-blocks. The modifications included are to enable cdecl to be compiled into JavaScript using Emscripten for hosting within the extension. The "binary" cdecl engine is checked into this repo as out/cdecl.js and should not be modified manually.

Build and debug tasks will be picked up automatically after opening the repo in VSCode. You will need to run npm install once before building.

vscode-cdecl's People

Contributors

Stargazers

Watchers

vscode-cdecl's Issues

Handle the C++ flag

Currently the C++ flag is never passed to cdecl, but in practice that's probably not the best approach. I need to figure out whether always passing the flag would cause any issues.

Add gifs to the README

Everyone loves gifs.

Screenshots are OK too.

Add styling to "help"

The rendered HTML lacks any CSS/styling, making code blocks pretty ugly. It would be good to add some basic styles. It might be easiest to override marked's code block logic to add inline styling, or alternately I might be able to add a CSS stylesheet.

Recommend Projects