https://github.com/mitaki28/vscode-clang

Completion and Diagnostic for C/C++/Objective-C using Clang
https://github.com/mitaki28/vscode-clang

Last synced: 3 months ago
JSON representation

Completion and Diagnostic for C/C++/Objective-C using Clang

• Host: GitHub
• URL: https://github.com/mitaki28/vscode-clang
• Owner: mitaki28
• License: mit
• Created: 2016-01-13T10:08:31.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-04-16T23:05:33.000Z (over 1 year ago)
• Last Synced: 2024-07-31T20:27:15.242Z (6 months ago)
• Language: TypeScript
• Size: 188 KB
• Stars: 128
• Watchers: 5
• Forks: 24
• Open Issues: 61
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-vscode-cn - C/C++ Clang Command Adapter - Completion and Diagnostic for C/C++/Objective-C using Clang command. (C++)
• -awesome-vscode - C/C++ Clang Command Adapter - Completion and Diagnostic for C/C++/Objective-C using Clang command. (C++ / [Bash Debug](https://marketplace.visualstudio.com/items?itemName=rogalmic.bash-debug))
• awesome-vscode - C/C++ Clang Command Adapter - Completion and Diagnostic for C/C++/Objective-C using Clang command. (C++ / [Bash Debug](https://marketplace.visualstudio.com/items?itemName=rogalmic.bash-debug))
• awesome-vscode - C/C++ Clang Command Adapter - Completion and Diagnostic for C/C++/Objective-C using Clang command. (C++ / [Shellman](https://marketplace.visualstudio.com/items?itemName=Remisa.shellman))
• awesome-vscode-zh - C/C++ Clang Command Adapter命令适配器 - 使用Clang命令为`C/C++/Objective-C`补全和诊断. (C++ / 贡献)

README

        
# C/C++ Clang Command Adapter

Completion and Diagnostic for C/C++/Objective-C using [Clang](http://clang.llvm.org/) command.

## Important Notes

Clang project officialy starts to implement [Language Server](https://github.com/Microsoft/language-server-protocol) named _clangd_.

(https://github.com/llvm-mirror/clang-tools-extra/tree/master/clangd)

This extension was renamed to C/C++ Clang Command Adapter to avoid confusion, because this extension is unofficial and only parse output of clang command.

## Requirements

- Install [Clang](http://clang.llvm.org/)

    - For Max OS X, Clang is installed with Xcode Command Line Tools and `PATH` is configured automatically. 

- Configure the `PATH` environment variable so that you can execute `clang` command.

    - or specify `clang.executable` configuration (See the next section for detail) 

## Configuration

You can use configuration interface of Visual Studio Code. (Press `F1` and type `User Settings` or `Workspace Settings`)

### Common

- `clang.executable`: Clang command or the path to the Clang executable (default: `clang`)

- `clang.cflags`, `clang.cxxflags`, `clang.objcflags`: Compiler Options for C/C++/Objective-C

### Completion

- `clang.completion.enable`: Enable/disable completion feature (default: `true`)

- `clang.completion.maxBuffer`: Tolerable size of clang output for completion (default: `8 * 1024 * 1024` bytes)

- `clang.completion.triggerChars`: Trigger completion when the user types one of the characters (default: `[".", ":", ">"]`)

### Diagnostic

- `clang.diagnostic.enable`: Enable/disable diagnostic feature (default: `true`)

- `clang.diagnostic.maxBuffer`: Tolerable size of clang output for diagnostic. (default: `256 * 1024` bytes)

- `clang.diagnostic.delay`: The delay in millisecond after which diagnostic starts (default: `500`)

### Variables

Configurations support some variables which are available in `tasks.json`.

They can be used inside of strings (e.g. `"-I${workspaceRoot}/include"`)

- `${workspaceRoot}`

- `${cwd}`

- `${env.ENVIRONMENT_VARIABLE}`

### Note

Since version 0.2.0, `clang.diagnosticDelay`, `clang.enableCompletion`, `clang.enableDiagnostic` is deprecated. 

Please update as follows:

- `clang.enableCompletion` -> `clang.completion.enable`

- `clang.enableDiagnostic` -> `clang.diagnostic.enable` 

- `clang.diagnosticDelay` -> `clang.diagnostic.delay`

## Command

- `ClangCommandAdapter: Show Executable and Compile Options`: Showing Clang executable and compile options for the active editor.

- `ClangCommandAdapter: Trust Workspace`: Trust the current workspace. (see [#Security](#Security))

- `ClangCommandAdapter: Untrust Workspace`: Untrust the current workspace. (see [#Security](#Security))

## Security

The following settings may cause security issue, if you are opening a malicious workspece.

- `clang.executable`: Arbitrary executables specified in the workspace-level setting will be executed.

- `clang.cflags`, `clang.cxxflags`, `clang.objcflags`: Clang command is executed with artibrary options specified in the workspace-level setting.

Therefore, these workspace-level settings are disabled by default.

- To enable these workspace-level settings, please trust the workspace from dialog that appears when you open the file.

- To change trust/untrust status of the current workspace, please use `ClangCommandAdapter: Trust Workspace` or `ClangCommandAdapter: Untrust Workspace`.

## Acknowledgements

- Regexp for parsing completion results of Clang is based [autocomplete-clang](https://github.com/yasuyuky/autocomplete-clang).

## Resources

- Repository: https://github.com/mitaki28/vscode-clang

- Support: https://github.com/mitaki28/vscode-clang/issues