Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/alefragnani/vscode-language-pascal

Pascal language extension for Visual Studio Code
https://github.com/alefragnani/vscode-language-pascal

delphi freepascal pascal visual-studio-code vscode vscode-extension

Last synced: about 1 month ago
JSON representation

Pascal language extension for Visual Studio Code

Host: GitHub
URL: https://github.com/alefragnani/vscode-language-pascal
Owner: alefragnani
License: mit
Created: 2015-09-12T16:24:40.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2023-12-28T23:10:57.000Z (6 months ago)
Last Synced: 2024-01-09T01:15:09.114Z (5 months ago)
Topics: delphi, freepascal, pascal, visual-studio-code, vscode, vscode-extension
Language: TypeScript
Homepage:
Size: 1.29 MB
Stars: 192
Watchers: 23
Forks: 43
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Lists

awesome-pascal - Pascal - pascal-formatter). Open source extensions created for Visual Studio Code that add Pascal support. (Plugins for other IDE's)

README

[![](https://vsmarketplacebadges.dev/version-short/alefragnani.pascal.svg)](https://marketplace.visualstudio.com/items?itemName=alefragnani.pascal)
[![](https://vsmarketplacebadges.dev/downloads-short/alefragnani.pascal.svg)](https://marketplace.visualstudio.com/items?itemName=alefragnani.pascal)
[![](https://vsmarketplacebadges.dev/rating-short/alefragnani.pascal.svg)](https://marketplace.visualstudio.com/items?itemName=alefragnani.pascal)

# What's new in Pascal 9.6

* Adds **Web** support
* Adds **Getting Started / Walkthrough**
* Adds **Virtual Workspaces** support
* Adds **Workspace Trust** support

## Support

**Pascal** is an open source extension created for **Visual Studio Code**. While being free and open source, if you find it useful, please consider supporting it

# Pascal

It adds support for the **Pascal** language and its dialects like **Delphi** and **FreePascal**.

Here are some of the features that **Pascal** provides:

* **Syntax highlighting** for files, forms and projects
* A huge set of **Snippets**
* Source code **navigation**

# Features

## Coding with style

### Syntax Highlighting

**Pascal** supports full syntax highlighting for **Delphi** and **FreePascal**

![syntax](images/vscode-pascal-syntax.png)

### Snippets

Almost 40 snippets are available

![snippets](images/vscode-pascal-snippets.png)

### Format Code

Check out [Pascal Formatter](https://github.com/alefragnani/vscode-pascal-formatter#features) documentation.

## Code Navigation

Navigate to any language element (methods, attributes, classes, interfaces, and so on) inside Pascal files. It supports native VS Code commands like:

* Go to Symbol
* Go to Definition
* Peek Definition
* Find All References

> It uses GNU Global, a source code tagging system, which means that it has some limitations if you compare with an AST parsing.

### Installing and Configuring GNU Global

1. You have to install 4 tools:

* GNU Global 6.5 or higher (http://www.gnu.org/software/global/global.html)
* Exuberant Tags 5.5 or higher (http://ctags.sourceforge.net/)
* Python 2.7 or higher (https://www.python.org/)
* Python Pygments (via `pip install Pygments`)

2. Update your `%PATH%` Environment Variable (_System_)

Let's say you extract GNU Global and CTags in `C:\gnu` folder. The two new entries in `%PATH%` should be:

* GNU Global: `C:\gnu\glo653wb\bin`
* Excuberant Tags: `C:\gnu\ctags58\ctags58`

Also make sure Python is in `%PATH%`

3. Create 2 new Environment Variables (_System_)

GNU Global uses CTags + Python Pygments as plugin in order to recognizes Pascal source code, so you have to configure them.

* `GTAGSCONF`: `C:\gnu\glo653wb\share\gtags\gtags.conf`
* `GTAGSLABEL`: `pygments`

![py-envvar](images/vscode-pascal-py-envvar.png)

> **NOTE:** For now, it was tested only on Windows, but since these tools are multiplatform (in fact, it comes from Unix), it should work on Linux and Mac.

# Available commands

## Code Navigation

To enable **Code Navigation**, the extension depends on **GNU Global and Exuberant Tags** and for that, you must run `gtags` on the Root folder, so the tags are created. In order to make life easier, two commands where added:

* **Pascal: Generate Tags**: Use this to _create_ or _reset_ the tags in the current project. You just have to do it once.
* **Pascal: Update Tags**: Use this to _update_ the tags for current project. You should use this command to _update the references_ when any source code is updated.

### Available Settings

Controls how the code navigation should work. Specially useful if you work with huge projects

* `workspace`: Full featured code navigation
* `file`: Limited to `Go to Symbol in File` command

```json
"pascal.codeNavigation": "workspace"
```

* Controls if the extension should automatically generate tags in projects opened for the first time

```json
"pascal.tags.autoGenerate": true
```

> For huge projects, its recommended to use:

```json
"pascal.codeNavigation": "file",
"pascal.tags.autoGenerate": false
```

# Task Build

Use this **Task Examples**, so you can:

* Compile **Delphi** and **FreePascal** projects:
* Navigate to _Errors/Warnings/Hints_, using the native _View / Errors and Warnings_ command

![compile](images/vscode-pascal-compile.png)

### Building Tasks

If you want to build tasks _(Task: Run Task Build)_ you can use the snippets below.

#### Delphi

Update two tags:

* `DCC32.EXE_PATH`: The compiler location
* `YOUR_DELPHI_PROJECT.DPR`: The project being built.

```
"version": "2.0.0",
"tasks": [
{
"label": "Pascal",
"type": "shell",
"windows": {
"command": "DCC32.EXE_PATH"
},
"linux": {
"command": "FPC_BIN_PATH"
},
"presentation": {
"reveal": "always",
"panel": "new"
},
"args": [
{
"value": ""YOUR_DELPHI_PROJECT.DPR"",
"quoting": "escape"
}
],
"problemMatcher": {
"owner": "external",
"pattern": {
"regexp": "^(.*.(pas|dpr|dpk))\\((\\d+)\\)\\s(Fatal|Error|Warning|Hint):(.*)",
"file": 1,
"location": 3,
"message": 5
}
},
"group": {
"kind": "build",
"isDefault": true
}
}
]
```

#### FreePascal

Update two tags:

* `FPC_BIN_PATH`: The full compiler location. If its `PATH` is already in _Environment Variables_, simply use `FPC_BIN` filename
* `YOUR_FREEPASCAL_PROJECT_OR_FILE`: The project/file being built.

```

{
"version": "2.0.0",
"tasks": [
{
"label": "Pascal",
"type": "shell",
"windows": {
"command": "FPC_BIN_PATH"
},
"linux": {
"command": "FPC_BIN_PATH"
},
"presentation": {
"reveal": "always",
"panel": "new"
},
"args": [
{
"value": "YOUR_FREEPASCAL_PROJECT_OR_FILE",
"quoting": "escape"
}
],
"problemMatcher": {
"owner": "external",
"pattern": {
"regexp": "^([\\w]+\\.(p|pp|pas))\\((\\d+)\\,(\\d+)\\)\\s(Fatal|Error|Warning|Note):(.*)",
"file": 1,
"line": 3,
"column": 4,
"message": 6
}
},
"group": {
"kind": "build",
"isDefault": true
}
}
]
}
```

# License