forks
/
dexed
mirror of https://gitlab.com/basile.b/dexed.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'gen-doc-new' into 'master' 

update doc gen system, allowing to deploy using gitlab ci

See merge request basile.b/dexed!1
This commit is contained in:
Basile.B 2020-03-04 16:06:48 +00:00
parent ce6e8bca97 1dbdb09bfa
commit 398e09e259
40 changed files with 1036 additions and 655 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -24,3 +24,4 @@ ppas.bat
.directory
lazproj/coedit
bin
public

13
.gitlab-ci.yml Normal file
View File

@ -0,0 +1,13 @@
pages:
before_script:
- apt-get update -y
- apt-get install -y pandoc
script:
- cd docs
- bash generate.sh
artifacts:
paths:
- public
only:
- master
- merge_requests

3
docs/_config.yml
View File

@ -1,3 +0,0 @@
theme: jekyll-theme-slate
kramdown:
auto_ids: true

1
docs/_includes/icurl
View File

@ -1 +0,0 @@
https://raw.githubusercontent.com/Basile-z/dexed/master/icons/

8
docs/_includes/xstyle.css
View File

@ -1,8 +0,0 @@
<style>
.tlbric {
box-sizing: content-box;
padding: 2px 2px 0 0;
margin: 0 0 0 0;
border-style: none;
}
</style>

19
docs/build.md
View File

@ -1,14 +1,9 @@
---
title: Build Dexed
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Build
#### Dexed
## Dexed
Dexed is mostly programmed in Object Pascal, using the the [Lazarus development platform](http://www.lazarus-ide.org/).
@ -37,7 +32,7 @@ You're now ready to build Dexed. This can be done in the IDE or using the _lazbu
After what Dexed should be build. The executable is output to the _bin_ folder.
#### Dastworx
## Dastworx
The background tool used by the IDE is a D program.
@ -48,13 +43,9 @@ The background tool used by the IDE is a D program.
You can also build it in dexed using the project file _dastworx.dprj_.
#### Third party tools:
## Third party tools
Additionally you'll have to build [the completion daemon **DCD**](https://github.com/dlang-community/DCD#setup) and the [D linter **Dscanner**](https://github.com/dlang-community/Dscanner#building-and-installing).
See the products documentation for more information.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

25
docs/features_dcd.md
View File

@ -1,13 +1,8 @@
---
title: D Completion Daemon
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### D Completion Daemon
The D Completion Daemon (DCD) is used to accomplish IDE-grade features such as
- completion
@ -21,7 +16,7 @@ The D Completion Daemon (DCD) is used to accomplish IDE-grade features such as
- jump to declaration
- redirection to html documentation
#### Setup
## Setup
_DCD_ is a third part software, it's bundled in the archives distributed for each new [release](https://github.com/Basile-z/dexed/releases).
However, _DCD_ may have to be build manually, for example if a new version is released while _Dexed_ development is paused for a while.
@ -30,22 +25,22 @@ Visit the product [homepage](https://github.com/dlang-community/DCD) for more in
Once DCD build or extracted from the release archive, copy the two programs (_dcd-client_ and _dcd-server_) to the folder where the Dexed executable stands.
They can be put elsewhere, as long as the target directory is a known operating system PATH.
#### Imports
## Imports
In _Dexed_, _DCD_ relies on the [compilers paths](options_compilers_paths), on the [library manager](widgets_library_manager) entries and on the project parameters. When the [_libman_](widgets_library_manager) is empty then the scope of DCD is limited to the symbols of current module, of the current project sources and of the standard library, that's why it necessary to register the development libraries used in the _libman_.
In _Dexed_, _DCD_ relies on the [compilers paths](options_compilers_paths.html), on the [library manager](widgets_library_manager.html) entries and on the project parameters. When the [_libman_](widgets_library_manager.html) is empty then the scope of DCD is limited to the symbols of current module, of the current project sources and of the standard library, that's why it necessary to register the development libraries used in the _libman_.
_DCD_ also has its own configuration system. Refer to the official [Readme](https://github.com/dlang-community/DCD#configuration-files).
#### Initialization
## Initialization
When Dexed starts and if the DCD server is not already listening then it's launched by CE.
When Dexed stops, the server is only terminated if it was not already running when starting.
If the DCD server crashes while Dexed is running then both must be restarted.
#### Usage
## Usage
- <kbd>CTRL</kbd> + <kbd>SPACE</kbd>: Calls the completion menu or completes automatically if possible. The default shortcut can be modified in the [shortcut editor](options_shortcuts_editor).
- <kbd>CTRL</kbd> + <kbd>SPACE</kbd>: Calls the completion menu or completes automatically if possible. The default shortcut can be modified in the [shortcut editor](options_shortcuts_editor.html).
- <kbd>.</kbd> invokes the completion if the editor option _autoDotDelay_ is greater than 0.
- <kbd>CTRL</kbd> + <kbd>SHIFT</kbd> + <kbd>UP</kbd>: Jumps to the declaration of the symbol located at the cursor. The default shortcut can be modified.
- <kbd>CTRL</kbd> + <kbd>LEFT MOUSE BUTTON</kbd>: ditto.
@ -57,8 +52,4 @@ If the DCD server crashes while Dexed is running then both must be restarted.
Documentation comments associated to a symbol are displayed when the cursor motion stops over a symbol.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

37
docs/features_projects.md
View File

@ -1,34 +1,29 @@
---
title: Projects
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Projects
Two project formats are supported.
For all the formats a single widget is used to display the source files list and the configurations, the [project inspector](widgets_project_inspector).
For all the formats a single widget is used to display the source files list and the configurations, the [project inspector](widgets_project_inspector.html).
Project properties are edited in specific widgets.
#### DUB
## DUB
Dexed handles [DUB](http://code.dlang.org/getting_started) projects.
DUB [JSON format](http://code.dlang.org/package-format?lang=json) format is fully supported.
DUB [SDL](http://code.dlang.org/package-format?lang=sdl) format is supported in read-only mode.
The widget used to edit the properties is the [DUB project editor](widgets_dub_project_editor).
The widget used to edit the properties is the [DUB project editor](widgets_dub_project_editor.html).
The option editor exposes a [category for DUB](options_dub_build). The options specified in this category are applied each time a project is compiled.
The option editor exposes a [category for DUB](options_dub_build.html). The options specified in this category are applied each time a project is compiled.
#### DEXED format
## DEXED format
The DEXED format (previously called _native format_ then _ce projects_) is based on DMD command line interface.
The widget used to edit the properties is the [DEXED project editor](widgets_dexed_project_editor) (the format is detailed in this page).
The widget used to edit the properties is the [DEXED project editor](widgets_dexed_project_editor.html) (the format is detailed in this page).
#### Menu reference
## Menu reference
- **"New project"**: Closes and creates a new project (either with the native format or a DUB project). A warning may be displayed if the current project is not yet saved.
- **"Open project"**: Opens a project from a dialog.
@ -36,28 +31,24 @@ The widget used to edit the properties is the [DEXED project editor](widgets_dex
- **"Close project"**: Closes the current project. A warning may be displayed if the current project is yet not saved.
- **"Save project"**: Saves the current project.
- **"Save project as"**: Saves the current project from a dialog.
- **"Add project to group"**: Adds this project to the project group. See also the page dedicated to the [project groups](widgets_project_groups).
- **"Add project to group"**: Adds this project to the project group. See also the page dedicated to the [project groups](widgets_project_groups.html).
- **"Project editor"**: Displays widget used to edit the project properties,in respect with the format (CE or DUB).
- **"Edit project file"**: Opens the project file in a new source editor. When saved from a source editor, a project file is directly reloaded.
- **"View project command line"**: Displays the list of switches and arguments, as they would be passed to the compiler (or the build tool) when compiling.
- **"View in mini explorer"**: Expands the [mini-explorer](widgets_mini_explorer) tree on the folder that contains the project file.
- **"View in mini explorer"**: Expands the [mini-explorer](widgets_mini_explorer.html) tree on the folder that contains the project file.
- **"Verify project with Dscanner"**: Performs some static checks on each source of the project and using [Dscanner](https://github.com/dlang-community/D-Scanner).
- **"Compile project"**: Compiles the project using the current configuration.
- **"Compile and run project"**: Compiles the project using the current configuration and executes the output when the binary produced is executable.
- **"Compile and run project..."**: Ditto. Before the execution of the binary an input query dialog lets you pass options to the process.
- **"Run project"**: Executes the project output when the binary produced is executable.
- **"Run project..."**: Ditto. Before the execution, an input query dialog lets you specify switches and arguments to the process.
- **"Test project"**: Only for DUB projects. Invoke `dub test` using the configuration selected in the [project inspector](widgets_project_inspector).
- **"Test project"**: Only for DUB projects. Invoke `dub test` using the configuration selected in the [project inspector](widgets_project_inspector.html).
#### Other build tools
## Other build tools
It's possible to use the [custom tools](widgets_custom_tools) to call other build tools.
It's possible to use the [custom tools](widgets_custom_tools.html) to call other build tools.
For example to call _make_, add a new tool with _make_ as _executable_ and sets the _workingDirectory_ to the folder that contains the makefile.
To specify a special target, such as _release_, add _release_ in the parameters editor.
To get _make_ output in the messages, check _popUsesPipes_ in the tool options.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

35
docs/features_runnables.md
View File

@ -1,14 +1,9 @@
---
title: Runnable modules
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Runnable modules
#### Description
## Description
Dexed is able to compile and execute the module that's currently edited even if it's not part of a project.
Such a module is called a **runnable** module.
@ -19,7 +14,7 @@ By default the binary is produced in the folder where is located the D source bu
A runnable is useful to quickly test an idea, learn how to use new libraries, or even to use modules as scripts, always without messing with the parameters that a project would require.
#### Shebang line
## Shebang line
By default runnables don't need any setting however the shebang line can be used when specific compiler options are required.
Two typical scenarios:
@ -36,20 +31,20 @@ Dexed doesn't handle the program specified after the She-Bang, which means that
In the three cases, every non white character after the She-Bang is ignored.
Options are detected right after the first non blank characters of the script line.
#### Runnable I/O handling
## Runnable I/O handling
In general the program output is redirected to the [messages](widgets_messages).
In general the program output is redirected to the [messages](widgets_messages.html).
This is true unless the _Compile file and run outside_ or the _Run compiled file outside_ actions are used.
Note that in this case the [consoleProgram global options](options_application) allows to define the terminal used.
Note that in this case the [consoleProgram global options](options_application.html) allows to define the terminal used.
When the program is not run outside, the [process input widget](widgets_process_input) is used to pass input to the runnable.
When the program is not run outside, the [process input widget](widgets_process_input.html) is used to pass input to the runnable.
#### Other
## Other
To be runnable, a module must verify:
- a `void main()` is present or the option to automatically detect the `main()` function is activated.
- the modules to import must be known, either by the [library manager](widgets_library_manager) or by the compiler configuration file.
- the modules to import must be known, either by the [library manager](widgets_library_manager.html) or by the compiler configuration file.
- _import expressions_ ( `import(file);` ) are allowed if _file_ stands in the same folder as the module being edited.
The _Compile file and run outside_ action can be used to execute in an external console.
@ -74,13 +69,13 @@ When the action _Run file unittests_ is used, **single_module** and **test_singl
The executable produced is deleted after each run unless the file has been saved explicitly out of the initial temporary folder.
Note that the action _Run file unittest_ is based on the same internal function excepted that the `-main` and `-unittest` switches are automatically added to the switch list (menu **File**, action **Set runnable switches**).
#### Options
## Options
![](img/options_runnables.png)
- **alwaysToFolder**: deprecated, checked meant **outputFolderCondition** set to [ifSaved, ifInProject], and [ifInProject] otherwise.
- **compiler**: Select the [compiler](options_compilers_paths) used to produce the runnable binary. When GDC or LDC is selected their bridges based on the DMD command line interface are used (GDMD or LDMD). This setting is also used when a DUB script is compiled (see [Run DUB single file package](menu_file)).
- **detectLibraries**: When checked the static libraries used by a runnable are detected from the [library manager](widgets_library_manager) by performing import analysis. When unchecked, all the library manager entries are passed and the compiler does the selection.
- **compiler**: Select the [compiler](options_compilers_paths.html) used to produce the runnable binary. When GDC or LDC is selected their bridges based on the DMD command line interface are used (GDMD or LDMD). This setting is also used when a DUB script is compiled (see [Run DUB single file package](menu_file.html)).
- **detectLibraries**: When checked the static libraries used by a runnable are detected from the [library manager](widgets_library_manager.html) by performing import analysis. When unchecked, all the library manager entries are passed and the compiler does the selection.
- **detectMain**: When checked the `main()` function is detected automatically and the `-main` switch is set accordingly. When not checked `-main` is never passed. This options is useful with the **Run file unittests** action because it allows to test a module that's also a valid program.
- **outputFolder**: Defines a folder where the runnable binary is output. If the value starts by a drive letter or a directory separator then the folder must exist, otherwise it's considered as a subfolder, relative to the runnable filename, which is created automatically.
- **outputFolderConditions**: Defines the conditions for which **outputFolder** is handled.
@ -89,8 +84,4 @@ Note that the action _Run file unittest_ is based on the same internal function
- **ifNotSaved**: The runnable file is not part of the project and has never been saved explicitly.
- **staticSwitches**: Defines a list of switches that are always passed to the compiler when a runnable is produced or when a module is tested.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

29
docs/features_symbolic_strings.md
View File

@ -1,20 +1,15 @@
---
title: Symbolic strings
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Symbolic strings
The symbolic strings represent variables defined by the software. They are used by several widgets:
- the [runnable modules shebang line](features_runnables).
- the [native project confirguration widget](widgets_ce_project_editor): many fields accept symbols.
- the [custom tools](widgets_custom_tools): parameters, working directory.
- the [process input](widgets_process_input): the input field can include a symbol.
- the [GDB commander](widgets_gdb_commander) custom commands.
- the [runnable modules shebang line](features_runnables.html).
- the [native project confirguration widget](widgets_ce_project_editor.html): many fields accept symbols.
- the [custom tools](widgets_custom_tools.html): parameters, working directory.
- the [process input](widgets_process_input.html): the input field can include a symbol.
- the [GDB commander](widgets_gdb_commander.html) custom commands.
Possible symbols, by context, include:
@ -22,7 +17,7 @@ Application:
- **`<AF>`**: Expanded to the application (Dexed) filename.
- **`<AP>`**: Expanded to the application (Dexed) path.
- **`<MEP>`**: Expanded to the path of the folder selected in the [mini-explorer](widgets_mini_explorer).
- **`<MEP>`**: Expanded to the path of the folder selected in the [mini-explorer](widgets_mini_explorer.html).
Environment:
@ -34,7 +29,7 @@ Current file:
- **`<CFF>`**: also _`<CurrentFileFile>`_. Expanded to the current file filename.
- **`<CFP>`**: also _`<CurrentFilePath>`_. Expanded to the current file path.
- **`<CFR>`**: also _`<CurrentFileRunnable>`_. Expanded to the runnable produced for the current file. The [OutputFolder](features_runnables) option is not handled.
- **`<CFR>`**: also _`<CurrentFileRunnable>`_. Expanded to the runnable produced for the current file. The [OutputFolder](features_runnables.html) option is not handled.
- **`<CI>`**: also _`<CurrentIdentifier>`_. Expanded to the identifier located at the caret position.
- **`<CL>`**: also _`<CurrentLine>`_. Expanded to the current line of code.
- **`<CS>`**: also _`<CurrentSelection>`_. Expanded to the current selection.
@ -49,7 +44,7 @@ Current project:
- **`<CPP>`**: also _`<CurrentProjectPath>`_. Expanded to the project path.
- **`<CPR>`**: also _`<CurrentProjectRoot>`_. Expanded to the field _RootFolder_ of a CE project (n/a if the current project is for DUB).
- **`<CPCD>`**: also _`<CurrentProjectCommonFilesDirectory>`_. Expanded to the sources common directory.
- **`<CPV>`**: also _`<CurrentProjectVersion>`_. Expanded to the value of the _version_ field of a [CE project](widgets_ce_project_editor).
- **`<CPV>`**: also _`<CurrentProjectVersion>`_. Expanded to the value of the _version_ field of a [CE project](widgets_ce_project_editor.html).
The expanded form of a symbol is never empty. When a symbol expands to nothing it's set to a pair of back quotes, e.g **\``** for a **`<CPP>`** when no project is opened.
@ -61,8 +56,4 @@ is expanded to:
`http://www.google.com/search?q="dlang.org"indexOf&btnI=Im+Feeling+Lucky` if **indexOf** is the current identifier.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

15
docs/generate.sh Normal file
View File

@ -0,0 +1,15 @@
OUTPUT_DIR="../public/"
MD_FILES=$(find *.md*);
if [ ! -d "$OUTPUT_DIR" ]; then
mkdir $OUTPUT_DIR
fi
for MD_FILE in $MD_FILES; do
OFILE=$OUTPUT_DIR$"${MD_FILE%.*}".html
pandoc -o$OFILE $MD_FILE --css=style.css --standalone --toc
done
cp -r img $OUTPUT_DIR/img/
cp -r ../icons $OUTPUT_DIR/icons/
cp -r style.css $OUTPUT_DIR/style.css

113
docs/index.md
View File

@ -1,90 +1,81 @@
---
title: index
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Dexed documentation
![](img/coedit_kde4_thumb.png)
This documentation is based on version 3.7.5.
Screenshots can be outdated but descriptions are up to date.
#### First steps
## First steps
_Install and configure Dexed._
* [Build](build.md)
* [Setup](setup.md)
* [Build](build.html)
* [Setup](setup.html)
#### Features
## Features
_General features or concepts that are not wrapped in a widget_
* [Completion deamon](features_dcd.md)
* [Projects](features_projects)
* [Runnable modules](features_runnables)
* [Symbolic strings](features_symbolic_strings)
* [Completion deamon](features_dcd.html)
* [Projects](features_projects.html)
* [Runnable modules](features_runnables.html)
* [Symbolic strings](features_symbolic_strings.html)
#### Menu reference
## Menu reference
_Description of each entry in the main menu. May redirect to a specific widget page._
* [File](menu_file)
* [Debugger](widgets_gdb_commander)
* [Project](features_projects)
* [Project groups](widgets_project_groups)
* [File](menu_file.html)
* [Debugger](widgets_gdb_commander.html)
* [Project](features_projects.html)
* [Project groups](widgets_project_groups.html)
#### Options categories
## Options categories
_Full description of Dexed options. May redirect to a specific widget page._
* [Application](options_application)
* [Code metrics](options_code_metrics)
* [Compiler paths](options_compilers_paths)
* [Debugger](widgets_gdb_commander)
* [DUB build](options_dub_build)
* [Editor](widgets_editor)
* [Editor pages](options_editor_pages)
* [Messages](widgets_messages)
* [Mini explorer](widgets_mini_explorer)
* [Profile viewer](widgets_profile_viewer)
* [Runnable modules](features_runnables)
* [Shortcuts editor](options_shortcuts_editor)
* [Static macros](widgets_editor)
* [Symbol list](widgets_symbol_list)
* [Terminal](widgets_terminal)
* [Todo list](widgets_todo_list)
* [Application](options_application.html)
* [Code metrics](options_code_metrics.html)
* [Compiler paths](options_compilers_paths.html)
* [Debugger](widgets_gdb_commander.html)
* [DUB build](options_dub_build.html)
* [Editor](widgets_editor.html)
* [Editor pages](options_editor_pages.html)
* [Messages](widgets_messages.html)
* [Mini explorer](widgets_mini_explorer.html)
* [Profile viewer](widgets_profile_viewer.html)
* [Runnable modules](features_runnables.html)
* [Shortcuts editor](options_shortcuts_editor.html)
* [Static macros](widgets_editor.html)
* [Symbol list](widgets_symbol_list.html)
* [Terminal](widgets_terminal.html)
* [Todo list](widgets_todo_list.html)
#### Widgets
## Widgets
_Description of each widget._
* [About box](widgets_about)
* [DFMT commander](widgets_dfmt_commander)
* [DEXED project editor](widgets_dexed_project_editor)
* [DUB project editor](widgets_dub_project_editor)
* [Custom tools](widgets_custom_tools)
* [Editor](widgets_editor)
* [GDB commander](widgets_gdb_commander)
* [Library manager](widgets_library_manager)
* [Mini explorer](widgets_mini_explorer)
* [Messages](widgets_messages)
* [Options editor](widgets_options_editor)
* [Profile viewer](widgets_profile_viewer)
* [Project groups](widgets_project_groups)
* [Project inspector](widgets_project_inspector)
* [Process input](widgets_process_input)
* [Search](widgets_search)
* [Symbol list](widgets_symbol_list)
* [Terminal](widgets_terminal)
* [Todo list](widgets_todo_list)
* [About box](widgets_about.html)
* [DFMT commander](widgets_dfmt_commander.html)
* [DEXED project editor](widgets_dexed_project_editor.html)
* [DUB project editor](widgets_dub_project_editor.html)
* [Custom tools](widgets_custom_tools.html)
* [Editor](widgets_editor.html)
* [GDB commander](widgets_gdb_commander.html)
* [Library manager](widgets_library_manager.html)
* [Mini explorer](widgets_mini_explorer.html)
* [Messages](widgets_messages.html)
* [Options editor](widgets_options_editor.html)
* [Profile viewer](widgets_profile_viewer.html)
* [Project groups](widgets_project_groups.html)
* [Project inspector](widgets_project_inspector.html)
* [Process input](widgets_process_input.html)
* [Search](widgets_search.html)
* [Symbol list](widgets_symbol_list.html)
* [Terminal](widgets_terminal.html)
* [Todo list](widgets_todo_list.html)
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

29
docs/menu_file.md
View File

@ -1,15 +1,10 @@
---
title: Widgets - application options
title: File menu
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### File menu - reference
- **New empty module**: Creates a new empty module.
- **New runnable module**: Creates a new module with a `main()` function. See [runnables modules](features_runnables).
- **New runnable module**: Creates a new module with a `main()` function. See [runnables modules](features_runnables.html).
- **New module from clipboard**: Creates a new module, immediatly filled with the clipboard content.
- **New DUB script**: Creates a new module with a `main()` function and an embedded DUB receipt. The module can be executed as a script with **Run DUB single file package** or **Run DUB single file package outside**.
- **Open file...**: Proposes to open a D source file from an open dialog.
@ -22,9 +17,9 @@ title: Widgets - application options
- **Save file as...**: Proposes to save the current editor from a save dialog.
- **Export html...**: Exports the current editor to a html file with html-based highlighting.
- **Add file to project**: Adds the file matching to the current editor to the current project (CE format only).
- **Compile file**: Compiles the current file. See [runnables modules](features_runnables).
- **Compile file and run**: Compiles the current file and executes it. See [runnables modules](features_runnables).
- **Compile file and run outside**: Compiles the current file and executes without redirection. See [runnables modules](features_runnables).
- **Compile file**: Compiles the current file. See [runnables modules](features_runnables.html).
- **Compile file and run**: Compiles the current file and executes it. See [runnables modules](features_runnables.html).
- **Compile file and run outside**: Compiles the current file and executes without redirection. See [runnables modules](features_runnables.html).
- **Compile file and run...**: Compiles the current file and execute with a set of options defined in a simple input-query dialog. The arguments must be separated with spaces and can include double quotes.
- **Run compiled file**: Executes the binary produced by a previous call to **Compile file**.
- **Run compiled file outside**: Executes in a console the binary produced by a previous call to **Compile file**.
@ -32,12 +27,8 @@ title: Widgets - application options
- **Set runnable switches**: Allows to modify the switches passed to DMD when compiling a runnable module. One switch by line, invalid, reserved or duplicated switches are removed, for example **-main** and **-unittest** are reserved.
- **Run DUB single file package**: Compiles and execute a DUB script.
- **Run DUB single file package outside**: Compiles and execute a DUB script in a console.
- **Verify with Dscanner**: verifies the current source with [Dscanner](https://github.com/Hackerpilot/Dscanner). Results are displayed in the [messages](widgets_messages).
- **View Halstead metrics**: Checks the halstead metrics in the source that has the focus and reports abnormal functions in the [messages](widgets_messages). [Description of the metric](options_code_metrics).
- **View in mini explorer**: expands the [mini explorer](widgets_mini_explorer) tree on the folder that contains the current file.
- **Verify with Dscanner**: verifies the current source with [Dscanner](https://github.com/Hackerpilot/Dscanner). Results are displayed in the [messages](widgets_messages.html).
- **View Halstead metrics**: Checks the halstead metrics in the source that has the focus and reports abnormal functions in the [messages](widgets_messages.html). [Description of the metric](options_code_metrics.html).
- **View in mini explorer**: expands the [mini explorer](widgets_mini_explorer.html) tree on the folder that contains the current file.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

21
docs/options_application.md
View File

@ -1,15 +1,8 @@
---
title: Widgets - application options
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
{% endraw %}
#### Application
{% include xstyle.css %}
The page exposes unsorted options. In the future some of them might be moved to their own category.
![](img/options_application.png)
@ -19,22 +12,18 @@ The page exposes unsorted options. In the future some of them might be moved to
- **autoCleanMRU**: If checked then the MRU lists wont display files that dont exist. When using a version control software or removable disk it can be preferable not to use this option.
- **autoKillProcThreshold**: When not zero this setting indicates the size of the stdandard output, in bytes, over which an inferior process gets killed automatically. By default set to 2 Mb. This is usefull for example to prevent issues when an inferior falls into an infinite loop that prints.
- **autoSaveProjectFiles**: If checked the sources are automatically saved before compilation.
- **consoleProgram**: Allows to set the terminal emulator used to execute programs. By default XTerm is used and an error can occur if it's not setup. The setting is used by the [runnable modules](features_runnables), the [custom tools](widgets_custom_tools) and the project launcher. Under Windows this option is not used.
- **consoleProgram**: Allows to set the terminal emulator used to execute programs. By default XTerm is used and an error can occur if it's not setup. The setting is used by the [runnable modules](features_runnables.html), the [custom tools](widgets_custom_tools.html) and the project launcher. Under Windows this option is not used.
- **coverModuleTests**: If checked then the coverage by the tests is measured and displayed in the messages after executing the action __File/Run file unittests__.
- **dcdPort**: Sets the port used by the [completion daemon](features_dcd) server. Under Windows `0` means the default value. Under GNU/Linux `0` means that a UNIX domain socket is used and any other number means that a TCP socket is used. This setting requires a restart.
- **dcdPort**: Sets the port used by the [completion daemon](features_dcd.html) server. Under Windows `0` means the default value. Under GNU/Linux `0` means that a UNIX domain socket is used and any other number means that a TCP socket is used. This setting requires a restart.
- **dscanUnittests**: If checked the content of the `unittest` blocks are analyzed when using the action __File/Verify with Dscanner__. Do not activate if the results of the static analysis tend to generate irrelevant messages in the tests.
- **flatLook**: Doesn't draw the buttons shape unless they're hovered by the mouse.
- **floatingWidgetOnTop**: Keeps the widgets that are not docked on top of the application window.
- **maxReventDocuments**: Sets how many entries can be stored in __File/Open recent file__.
- **maxReventDocuments**: Sets how many entries can be stored in __Project/Open recent project__.
- **maxReventProjectsGroups**: Sets how many entries can be stored in __Projects group/Open recent group__.
- **nativeProjectCompiler**: Sets [which compiler](options_compilers_paths) is used to compile a project that has the [CE format](widgets_ce_project_editor).
- **nativeProjectCompiler**: Sets [which compiler](options_compilers_paths.html) is used to compile a project that has the [CE format](widgets_ce_project_editor.html).
- **reloadLastDocuments**: Sets if the sources, the project, and the group that were opened on exit are reloaded automatically.
- **showBuildDuration**: Sets if the duration of a project build is measured.
- **splitterScrollSpeed**: Sets how fast the splitters are moved when the scroll wheel is used.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

15
docs/options_code_metrics.md
View File

@ -1,13 +1,8 @@
---
title: Options - code metrics
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Code metrics
The quality of the D code is verifiable using code metrics.
In general several metrics exist:
@ -17,7 +12,7 @@ In general several metrics exist:
Dexed implements the Halstead metric. The others may be added in a further version.
#### Halstead complexity
## Halstead complexity
The metric uses the count and the sum of the functions operands and operators to compute several indexes. Even it's clearly related to the SLOC it's more accurate. For example:
@ -63,8 +58,4 @@ Default values can be modified in the option editor:
The maximal volume of a module is not verified, simply because it's possible to have huge modules with many small functions of high quality.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

23
docs/options_compilers_paths.md
View File

@ -1,13 +1,8 @@
---
title: Options - compiler paths
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Compilers paths
The _Compilers paths_ category is used to define the paths to the compilers and to their respective versions of the standard library.
These settings are important and should be verified after the installation.
@ -17,12 +12,12 @@ These settings are important and should be verified after the installation.
Up to five D compilers can be defined.
* __DMD__: should be set to the stable DMD version. The paths are normally detected when _Dexed_ is launched for the first time.
* __GDC__: should be set to the stable GDC version. The _runtime_ and _Phobos_ sources stand in the same folder so the third field can be left empty.
* __LDC__: should be set to the stable LDC version. The _runtime_ and _Phobos_ sources stand in the same folder so the third field can be left empty.
* __GDC__: should be set to the stable GDC version.
* __LDC__: should be set to the stable LDC version.
* __User1__: can be set to any compiler, for the example the development version of DMD.
* __User2__: a second user-defined compiler.
The combo box at the top is used to select which are the paths passed to the [completion daemon](features_dcd).
The combo box at the top is used to select which are the paths passed to the [completion daemon](features_dcd.html).
If the completion daemon is launched by _Dexed_ then the change is applied directly after the validation, otherwise it has to be restarted manually.
The second combo box defines which of the 5 defined compiler matches to the _global_ alias. This way it's possible to change the compiler used in a single step, assuming that all the compilation contexts (runnable, DUB, dexed projects) are set to follow the _global_ alias.
@ -31,11 +26,7 @@ In most of the cases this is not useful but was added to make easier testing exp
In other options categories one of these compilers or _global_ can be selected.
* Category _Application_, _nativeProjectCompiler_: defines the compiler used to compile a project that has the native format.
* Category [_Runnable modules_](features_runnables), _compiler_: defines the compiler used to compile a _runnable module_ or a DUB script.
* Category [_DUB build_](options_dub_build), _compiler_: defines the compiler used to compile a project that has the DUB format.
* Category [_Runnable modules_](features_runnables.html), _compiler_: defines the compiler used to compile a _runnable module_ or a DUB script.
* Category [_DUB build_](options_dub_build.html), _compiler_: defines the compiler used to compile a project that has the DUB format.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

17
docs/options_dub_build.md
View File

@ -1,13 +1,8 @@
---
title: Options - DUB build
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
#### DUB build
This category exposes the DUB options that are passed to the build tool each time it's called.
![](img/options_dub_build.png)
@ -16,19 +11,15 @@ This category exposes the DUB options that are passed to the build tool each tim
- **autoFetch**: If checked then Dexed will try to download missing dependencies when a project or a libman entry is opened. This option is designed to provide better completion but can slow down the startup and the loading of a project.
- **autoSelectTestConfig**: When not checked the configuration used to test with DUB must be selected before executing the action _Test project_.
- **combined**: If checked, tries to build the whole project in a single compiler run.
- **compiler**: Selects [which compiler](options_compilers_paths) is used by DUB when a project is compiled. Note that the DUB scripts don't use this setting, instead the same preference set for the [runnable modules](features_runnables#options) is used.
- **compiler**: Selects [which compiler](options_compilers_paths.html) is used by DUB when a project is compiled. Note that the DUB scripts don't use this setting, instead the same preference set for the [runnable modules](features_runnables#options) is used.
- **dependenciesCheck**: Defines how DUB checks the project dependencies, typically used to avoid too much network operations.
- **forceRebuild**: Forces a full recompilation, even if DUB determines that this would not be necessary.
- **linkMode**: Specifies the way the compiler and linker are invoked.
- **other**: Displays a list that can be filled with more switches. One item per line.
- **parallel**: If checked, tries to build using several CPU.
- **showConsole**: If checked, the [consoleProgram set in the global options](options_application) is shown and used to execute DUB.
- **showConsole**: If checked, the [consoleProgram set in the global options](options_application.html) is shown and used to execute DUB.
- **verbosity**: Allows to change the verbosity of DUB. This is interesting when you suspect a bug in the build tool and don't want to leave the IDE to verify.
See also [the official DUB command line reference](http://code.dlang.org/docs/commandline) for more detailed descriptions.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

17
docs/options_editor_pages.md
View File

@ -1,13 +1,8 @@
---
title: Options - DUB build
title: Options - Editor pages
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
#### Editor pages
This category exposes the options of the page control that hosts the code editors.
![](img/options_editor_pages.png)
@ -19,12 +14,8 @@ This category exposes the options of the page control that hosts the code editor
- **pageButtons**: Defines which buttons are visible in the toolbar.
- **pagesOptions**: Miscellaneous options.
- **poPageHistory**: Means the creation order is saved and used to select a particular page when another is closed.
- **poFlatButtons**: Sets the tool bar buttons look. Normally controlled by the [application option **flatLook**](options_application).
- **poFlatButtons**: Sets the tool bar buttons look. Normally controlled by the [application option **flatLook**](options_application.html).
- **poBottomHeader**: Sets if the toolbar is displayed at the bottom.
- **previousPage**: Sets the shortcut used to select the previous page.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

19
docs/options_shortcuts_editor.md
View File

@ -1,30 +1,19 @@
---
title: Options - shortcuts
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Shortcuts editor
This category exposes all the shortcuts, sorted by category.
![](img/options_shortcuts.png)
Each item is editable.
- <img src="{%include icurl%}other/clean.png" class="tlbric"/>: Deletes the current assignation.
- <img src="{%include icurl%}other/keyboard_pencil.png" class="tlbric"/>: Displays the editor. The shortcut can also be selected in the combo menu.
- ![](icons/other/clean.png): Deletes the current assignation.
- ![](icons/other/keyboard_pencil.png): Displays the editor. The shortcut can also be selected in the combo menu.
![](img/options_shortcuts_edit.png)
After an assignation attempt and if the selected combination is already used the new shortcut is not validated and a warning is displayed.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

35
docs/setup.md
View File

@ -1,16 +1,13 @@
---
title: Setup Dexed
title: Setup dexed
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
There are four ways to get the program:
* download and run the setup program build for each release.
* download and extract the binaries build for each release.
* [build](build) the program from the sources.
* [build](build.html) the program from the sources.
* download and install the official package for a linux distribution.
In all the cases, the _DMD_ D2 compiler must setup and its location has to match to one of the directory of the PATH environment variable.
@ -20,7 +17,7 @@ Note that DMD is only required for the _ddemangle_ tool otherwise the software c
For each platform Dexed can be setup using a setup program or by extracting the binaries.
### Linux dependencies
## Linux dependencies
The software is based on the GTK2 toolkit.
The runtime libraries must be setup (libgtk2, libglib, libgdk-pixbuf2, etc; they usually comes together, libc).
@ -28,7 +25,9 @@ You must also setup some theme engines (such as Adwaita, Clearlooks, Nimbus, Ind
Windows interface is based on native win32 controls.
### Setup program
## Setup program
**Note that this section contain obsolete link and should not be follwed you put your hands on an old version of the setup program**
* Go to [the release page](https://github.com/Basile-z/dexed/releases),
* Choose the zipped setup for your platform (at the bottom of a release log, the buttons labeled `dexed.<version>.<platform>.setup.zip`).
@ -48,7 +47,9 @@ Note for the future versions:
* it's possible to uninstall from a newer setup program.
* always use the same privileges to uninstall or update as used previously.
### Binaries
## Binaries
**Note that this section contain obsolete link and should not be follwed you put your hands on an old version of the zips containing the binaries**
* Go to [the release page](https://github.com/Basile-z/dexed/releases),
* Choose the binaries for your platform (at the bottom of an entry, the buttons labeled `dexed.<version>.<platform>.zip`).
@ -64,18 +65,14 @@ the early alpha zip were all done on Windows (files attributes were lost) but it
If they are not correctly set, for each of the following file **dexed**, **dcd-client**, **dcd-server**, **dastworx**, either set the permission in the context menu (check _allow execution_ or _executable_ depending on the desktop) or `chmod +x` the file in a console.
### Linux package
## Linux package
Are provided a _deb_ package (Debian and derived Ubuntu, Mint, etc) and a _rpm_ (Fedora, openSUSE), only for x86_64 (amd64).
After the installation, you must also build [DCD](features_dcd).
After the installation, you must also build [DCD](features_dcd.html).
### First steps
## First steps
- verify the [compilers paths](options_compilers_paths).
- check the information [about the tools](widgets_about).
- verify the [compilers paths](options_compilers_paths.html).
- check the information [about the tools](widgets_about.html).
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

660
docs/style.css Normal file
View File

@ -0,0 +1,660 @@
@font-face {
font-family: octicons-link;
src: url(data:font/woff;charset=utf-8;base64,d09GRgABAAAAAAZwABAAAAAACFQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABEU0lHAAAGaAAAAAgAAAAIAAAAAUdTVUIAAAZcAAAACgAAAAoAAQAAT1MvMgAAAyQAAABJAAAAYFYEU3RjbWFwAAADcAAAAEUAAACAAJThvmN2dCAAAATkAAAABAAAAAQAAAAAZnBnbQAAA7gAAACyAAABCUM+8IhnYXNwAAAGTAAAABAAAAAQABoAI2dseWYAAAFsAAABPAAAAZwcEq9taGVhZAAAAsgAAAA0AAAANgh4a91oaGVhAAADCAAAABoAAAAkCA8DRGhtdHgAAAL8AAAADAAAAAwGAACfbG9jYQAAAsAAAAAIAAAACABiATBtYXhwAAACqAAAABgAAAAgAA8ASm5hbWUAAAToAAABQgAAAlXu73sOcG9zdAAABiwAAAAeAAAAME3QpOBwcmVwAAAEbAAAAHYAAAB/aFGpk3jaTY6xa8JAGMW/O62BDi0tJLYQincXEypYIiGJjSgHniQ6umTsUEyLm5BV6NDBP8Tpts6F0v+k/0an2i+itHDw3v2+9+DBKTzsJNnWJNTgHEy4BgG3EMI9DCEDOGEXzDADU5hBKMIgNPZqoD3SilVaXZCER3/I7AtxEJLtzzuZfI+VVkprxTlXShWKb3TBecG11rwoNlmmn1P2WYcJczl32etSpKnziC7lQyWe1smVPy/Lt7Kc+0vWY/gAgIIEqAN9we0pwKXreiMasxvabDQMM4riO+qxM2ogwDGOZTXxwxDiycQIcoYFBLj5K3EIaSctAq2kTYiw+ymhce7vwM9jSqO8JyVd5RH9gyTt2+J/yUmYlIR0s04n6+7Vm1ozezUeLEaUjhaDSuXHwVRgvLJn1tQ7xiuVv/ocTRF42mNgZGBgYGbwZOBiAAFGJBIMAAizAFoAAABiAGIAznjaY2BkYGAA4in8zwXi+W2+MjCzMIDApSwvXzC97Z4Ig8N/BxYGZgcgl52BCSQKAA3jCV8CAABfAAAAAAQAAEB42mNgZGBg4f3vACQZQABIMjKgAmYAKEgBXgAAeNpjYGY6wTiBgZWBg2kmUxoDA4MPhGZMYzBi1AHygVLYQUCaawqDA4PChxhmh/8ODDEsvAwHgMKMIDnGL0x7gJQCAwMAJd4MFwAAAHjaY2BgYGaA4DAGRgYQkAHyGMF8NgYrIM3JIAGVYYDT+AEjAwuDFpBmA9KMDEwMCh9i/v8H8sH0/4dQc1iAmAkALaUKLgAAAHjaTY9LDsIgEIbtgqHUPpDi3gPoBVyRTmTddOmqTXThEXqrob2gQ1FjwpDvfwCBdmdXC5AVKFu3e5MfNFJ29KTQT48Ob9/lqYwOGZxeUelN2U2R6+cArgtCJpauW7UQBqnFkUsjAY/kOU1cP+DAgvxwn1chZDwUbd6CFimGXwzwF6tPbFIcjEl+vvmM/byA48e6tWrKArm4ZJlCbdsrxksL1AwWn/yBSJKpYbq8AXaaTb8AAHja28jAwOC00ZrBeQNDQOWO//sdBBgYGRiYWYAEELEwMTE4uzo5Zzo5b2BxdnFOcALxNjA6b2ByTswC8jYwg0VlNuoCTWAMqNzMzsoK1rEhNqByEyerg5PMJlYuVueETKcd/89uBpnpvIEVomeHLoMsAAe1Id4AAAAAAAB42oWQT07CQBTGv0JBhagk7HQzKxca2sJCE1hDt4QF+9JOS0nbaaYDCQfwCJ7Au3AHj+LO13FMmm6cl7785vven0kBjHCBhfpYuNa5Ph1c0e2Xu3jEvWG7UdPDLZ4N92nOm+EBXuAbHmIMSRMs+4aUEd4Nd3CHD8NdvOLTsA2GL8M9PODbcL+hD7C1xoaHeLJSEao0FEW14ckxC+TU8TxvsY6X0eLPmRhry2WVioLpkrbp84LLQPGI7c6sOiUzpWIWS5GzlSgUzzLBSikOPFTOXqly7rqx0Z1Q5BAIoZBSFihQYQOOBEdkCOgXTOHA07HAGjGWiIjaPZNW13/+lm6S9FT7rLHFJ6fQbkATOG1j2OFMucKJJsxIVfQORl+9Jyda6Sl1dUYhSCm1dyClfoeDve4qMYdLEbfqHf3O/AdDumsjAAB42mNgYoAAZQYjBmyAGYQZmdhL8zLdDEydARfoAqIAAAABAAMABwAKABMAB///AA8AAQAAAAAAAAAAAAAAAAABAAAAAA==) format('woff');
}
body {
-webkit-text-size-adjust: 100%;
text-size-adjust: 100%;
color: #333;
font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
font-size: 16px;
line-height: 1.6;
word-wrap: break-word;
width: 728px;
max-width: 99%;
box-sizing: border-box;
padding: 30px 30px 8rem 30px;
margin-left: auto;
margin-right: auto;
}
body a {
background-color: transparent;
}
body a:active,
body a:hover {
outline: 0;
}
body strong {
font-weight: bold;
}
body h1 {
font-size: 2em;
margin: 0.67em 0;
}
body img {
border: 0;
}
body hr {
box-sizing: content-box;
height: 0;
}
body pre {
overflow: auto;
}
body code,
body kbd,
body pre {
font-family: monospace, monospace;
font-size: 1em;
}
body input {
color: inherit;
font: inherit;
margin: 0;
}
body html input[disabled] {
cursor: default;
}
body input {
line-height: normal;
}
body input[type="checkbox"] {
box-sizing: border-box;
padding: 0;
}
body table {
border-collapse: collapse;
border-spacing: 0;
}
body td,
body th {
padding: 0;
}
body * {
box-sizing: border-box;
}
body input {
font: 13px / 1.4 Helvetica, arial, nimbussansl, liberationsans, freesans, clean, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
}
body a {
color: #4078c0;
text-decoration: none;
}
body a:hover,
body a:active {
text-decoration: underline;
}
body hr {
height: 0;
margin: 15px 0;
overflow: hidden;
background: transparent;
border: 0;
border-bottom: 1px solid #ddd;
}
body hr:before {
display: table;
content: "";
}
body hr:after {
display: table;
clear: both;
content: "";
}
body h1,
body h2,
body h3,
body h4,
body h5,
body h6 {
margin-top: 15px;
margin-bottom: 15px;
line-height: 1.1;
}
body h1 {
font-size: 30px;
}
body h2 {
font-size: 21px;
}
body h3 {
font-size: 16px;
}
body h4 {
font-size: 14px;
}
body h5 {
font-size: 12px;
}
body h6 {
font-size: 11px;
}
body blockquote {
margin: 0;
}
body ul,
body ol {
padding: 0;
margin-top: 0;
margin-bottom: 0;
}
body ol ol,
body ul ol {
list-style-type: lower-roman;
}
body ul ul ol,
body ul ol ol,
body ol ul ol,
body ol ol ol {
list-style-type: lower-alpha;
}
body dd {
margin-left: 0;
}
body code {
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
font-size: 12px;
}
body pre {
margin-top: 0;
margin-bottom: 0;
font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
}
body .select::-ms-expand {
opacity: 0;
}
body .octicon {
font: normal normal normal 16px/1 octicons-link;
display: inline-block;
text-decoration: none;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
body .octicon-link:before {
content: '\f05c';
}
body:before {
display: table;
content: "";
}
body:after {
display: table;
clear: both;
content: "";
}
body>*:first-child {
margin-top: 0 !important;
}
body>*:last-child {
margin-bottom: 0 !important;
}
body a:not([href]) {
color: inherit;
text-decoration: none;
}
body .anchor {
display: inline-block;
padding-right: 2px;
margin-left: -18px;
}
body .anchor:focus {
outline: none;
}
body h1,
body h2,
body h3,
body h4,
body h5,
body h6 {
margin-top: 1em;
margin-bottom: 16px;
font-weight: bold;
line-height: 1.4;
}
body h1 .octicon-link,
body h2 .octicon-link,
body h3 .octicon-link,
body h4 .octicon-link,
body h5 .octicon-link,
body h6 .octicon-link {
color: #000;
vertical-align: middle;
visibility: hidden;
}
body h1:hover .anchor,
body h2:hover .anchor,
body h3:hover .anchor,
body h4:hover .anchor,
body h5:hover .anchor,
body h6:hover .anchor {
text-decoration: none;
}
body h1:hover .anchor .octicon-link,
body h2:hover .anchor .octicon-link,
body h3:hover .anchor .octicon-link,
body h4:hover .anchor .octicon-link,
body h5:hover .anchor .octicon-link,
body h6:hover .anchor .octicon-link {
visibility: visible;
}
body h1 {
padding-bottom: 0.3em;
font-size: 1.75em;
line-height: 1.2;
}
body h1 .anchor {
line-height: 1;
}
body h2 {
padding-bottom: 0.3em;
font-size: 1.5em;
line-height: 1.225;
}
body h2 .anchor {
line-height: 1;
}
body h3 {
font-size: 1.25em;
line-height: 1.43;
}
body h3 .anchor {
line-height: 1.2;
}
body h4 {
font-size: 1em;
}
body h4 .anchor {
line-height: 1.2;
}
body h5 {
font-size: 1em;
}
body h5 .anchor {
line-height: 1.1;
}
body h6 {
font-size: 1em;
color: #777;
}
body h6 .anchor {
line-height: 1.1;
}
body p,
body blockquote,
body ul,
body ol,
body dl,
body table,
body pre {
margin-top: 0;
margin-bottom: 16px;
}
body hr {
height: 4px;
padding: 0;
margin: 16px 0;
background-color: #e7e7e7;
border: 0 none;
}
body ul,
body ol {
padding-left: 2em;
}
body ul ul,
body ul ol,
body ol ol,
body ol ul {
margin-top: 0;
margin-bottom: 0;
}
body li>p {
margin-top: 16px;
}
body dl {
padding: 0;
}
body dl dt {
padding: 0;
margin-top: 16px;
font-size: 1em;
font-style: italic;
font-weight: bold;
}
body dl dd {
padding: 0 16px;
margin-bottom: 16px;
}
body blockquote {
padding: 0 15px;
color: #777;
border-left: 4px solid #ddd;
}
body blockquote>:first-child {
margin-top: 0;
}
body blockquote>:last-child {
margin-bottom: 0;
}
body table {
display: block;
width: 100%;
overflow: auto;
word-break: normal;
word-break: keep-all;
}
body table th {
font-weight: bold;
}
body table th,
body table td {
padding: 6px 13px;
border: 1px solid #ddd;
}
body table tr {
background-color: #fff;
border-top: 1px solid #ccc;
}
body table tr:nth-child(2n) {
background-color: #f8f8f8;
}
body img {
max-width: 100%;
box-sizing: content-box;
background-color: #fff;
}
body code {
padding: 0;
padding-top: 0;
padding-bottom: 0;
margin: 0;
font-size: 85%;
background-color: rgba(0,0,0,0.04);
border-radius: 3px;
}
body code:before,
body code:after {
letter-spacing: -0.2em;
content: "\00a0";
}
body pre>code {
padding: 0;
margin: 0;
font-size: 100%;
word-break: normal;
white-space: pre;
background: transparent;
border: 0;
}
body .highlight {
margin-bottom: 16px;
}
body .highlight pre,
body pre {
padding: 16px;
overflow: auto;
font-size: 85%;
line-height: 1.45;
background-color: #f7f7f7;
border-radius: 3px;
}
body .highlight pre {
margin-bottom: 0;
word-break: normal;
}
body pre {
word-wrap: normal;
}
body pre code {
display: inline;
max-width: initial;
padding: 0;
margin: 0;
overflow: initial;
line-height: inherit;
word-wrap: normal;
background-color: transparent;
border: 0;
}
body pre code:before,
body pre code:after {
content: normal;
}
body kbd {
display: inline-block;
padding: 3px 5px;
font-size: 11px;
line-height: 10px;
color: #555;
vertical-align: middle;
background-color: #fcfcfc;
border: solid 1px #ccc;
border-bottom-color: #bbb;
border-radius: 3px;
box-shadow: inset 0 -1px 0 #bbb;
}
body .pl-c {
color: #969896;
}
body .pl-c1,
body .pl-s .pl-v {
color: #0086b3;
}
body .pl-e,
body .pl-en {
color: #795da3;
}
body .pl-s .pl-s1,
body .pl-smi {
color: #333;
}
body .pl-ent {
color: #63a35c;
}
body .pl-k {
color: #a71d5d;
}
body .pl-pds,
body .pl-s,
body .pl-s .pl-pse .pl-s1,
body .pl-sr,
body .pl-sr .pl-cce,
body .pl-sr .pl-sra,
body .pl-sr .pl-sre {
color: #183691;
}
body .pl-v {
color: #ed6a43;
}
body .pl-id {
color: #b52a1d;
}
body .pl-ii {
background-color: #b52a1d;
color: #f8f8f8;
}
body .pl-sr .pl-cce {
color: #63a35c;
font-weight: bold;
}
body .pl-ml {
color: #693a17;
}
body .pl-mh,
body .pl-mh .pl-en,
body .pl-ms {
color: #1d3e81;
font-weight: bold;
}
body .pl-mq {
color: #008080;
}
body .pl-mi {
color: #333;
font-style: italic;
}
body .pl-mb {
color: #333;
font-weight: bold;
}
body .pl-md {
background-color: #ffecec;
color: #bd2c00;
}
body .pl-mi1 {
background-color: #eaffea;
color: #55a532;
}
body .pl-mdr {
color: #795da3;
font-weight: bold;
}
body .pl-mo {
color: #1d3e81;
}
body kbd {
display: inline-block;
padding: 3px 5px;
font: 11px Consolas, "Liberation Mono", Menlo, Courier, monospace;
line-height: 10px;
color: #555;
vertical-align: middle;
background-color: #fcfcfc;
border: solid 1px #ccc;
border-bottom-color: #bbb;
border-radius: 3px;
box-shadow: inset 0 -1px 0 #bbb;
}
body .task-list-item {
list-style-type: none;
}
body .task-list-item+.task-list-item {
margin-top: 3px;
}
body .task-list-item input {
margin: 0 0.35em 0.25em -1.6em;
vertical-align: middle;
}
body :checked+.radio-label {
z-index: 1;
position: relative;
border-color: #4078c0;
}

19
docs/widgets_about.md
View File

@ -1,25 +1,16 @@
---
title: About box
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
The _about box_ displays the software version and the information about the tools used in background.
![](img/about.png)
The status of each tool is indicated:
- <img src="{%include icurl%}bullet/bullet_green.png" class="tlbric"/>: The tool is well detected.
- <img src="{%include icurl%}bullet/bullet_yellow.png" class="tlbric"/>: The tool cannot be found but it's not necessary. Expect some features not to work properly even if the software is still usable.
- <img src="{%include icurl%}bullet/bullet_red.png" class="tlbric"/>: The tool cannot be found but it's necessary. The software is not usable. This happens when the tool cannot be located using the PATH variable.
- ![](icons/bullet/bullet_green.png): The tool is well detected.
- ![](icons/bullet/bullet_yellow.png): The tool cannot be found but it's not necessary. Expect some features not to work properly even if the software is still usable.
- ![](icons/bullet/bullet_red.png): The tool cannot be found but it's necessary. The software is not usable. This happens when the tool cannot be located using the PATH variable.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

39
docs/widgets_custom_tools.md
View File

@ -1,18 +1,11 @@
---
title: Widgets - custom tools
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Custom tools
This widget allows to define a set of third party applications that can be launched from Dexed.
The tools are not just applications that are launched from the software.
Since they support [symbolic strings](features_symbolic_strings) they can directly perform some actions on the current source file, in its directory, in the project directory and more.
Since they support [symbolic strings](features_symbolic_strings.html) they can directly perform some actions on the current source file, in its directory, in the project directory and more.
The tools can even be chained and piped between themselves.
A few examples:
@ -26,33 +19,29 @@ A few examples:
Toolbar:
- <img src="{%include icurl%}window/application_edit.png" class="tlbric"/>: Enables or disables edition.
- <img src="{%include icurl%}window/application_add.png" class="tlbric"/>: Adds a new tool.
- <img src="{%include icurl%}window/application_delete.png" class="tlbric"/>: Removes selected tool.
- <img src="{%include icurl%}arrow/arrow_up.png" class="tlbric"/> **/** <img src="{%include icurl%}arrow/arrow_down.png" class="tlbric"/>: Changes the position of the selected tool.
- <img src="{%include icurl%}window/application_flash.png" class="tlbric"/>: Executes the tool that's selected, according to the options it's associated to. This also works by double-clicking the tool aliases.
- <img src="{%include icurl%}window/application_double.png" class="tlbric"/>: Clones the tool that's selected.
- ![](icons/window/application_edit.png): Enables or disables edition.
- ![](icons/window/application_add.png): Adds a new tool.
- ![](icons/window/application_delete.png): Removes selected tool.
- ![](icons/arrow/arrow_up.png) **/** ![](icons/arrow/arrow_down.png): Changes the position of the selected tool.
- ![](icons/window/application_flash.png): Executes the tool that's selected, according to the options it's associated to. This also works by double-clicking the tool aliases.
- ![](icons/window/application_double.png): Clones the tool that's selected.
A tool can be selected from the left side of the widget. If selected, a property inspector displays the options that can be edited:
- **askConfirmation**: Asks for a confirmation before executing the tool.
- **autoExecuteEvents**: Defines the events for which the tool is automatically executed.
- **clearMessages**: If the tool standard output is redirected to the [messages widget](widgets_messages) then the previous messages are cleared before the execution. The output is redirected to the messages when **popUsePipes** is set and if **nextToolAlias** is empty.
- **clearMessages**: If the tool standard output is redirected to the [messages widget](widgets_messages.html) then the previous messages are cleared before the execution. The output is redirected to the messages when **popUsePipes** is set and if **nextToolAlias** is empty.
- **editorToInput**: Deprecated, see **pipeInputKind**.
- **executable**: The tool file name. If the system cannot find its path in the environment variables then it must be included. The field can include [symbolic strings](features_symbolic_strings).
- **executable**: The tool file name. If the system cannot find its path in the environment variables then it must be included. The field can include [symbolic strings](features_symbolic_strings.html).
- **nextToolAlias**: Defines the alias of another tool that will be launched after this one returns.
- **options**: Various options for the process to create. If you set **poUsesPipes** and **poStdErrToOutput** to true, then the standard output will be redirected to the message widget, category Misc.
- **outputToNext**: If **popUsePipes** is set in the options and if the next tool is defined then the next tool will see its input stream filled with the output stream.
- **parameters**: Defines the parameters, switches and options passed to the process. As usual, one item per line, no quotes. The items can contains [symbolic strings](features_symbolic_strings). The parameters can contain a special symbol, `<$1>`, which expands to the string passed to the dialog when **queryParameters** is checked.
- **parameters**: Defines the parameters, switches and options passed to the process. As usual, one item per line, no quotes. The items can contains [symbolic strings](features_symbolic_strings.html). The parameters can contain a special symbol, `<$1>`, which expands to the string passed to the dialog when **queryParameters** is checked.
- **pipeInputKind**: Defines what will be piped to the tool standard input after it's been launched (editor content, current line or selection).
- **queryParameters**: If checked then an input query dialog will be shown before executing the tool. It can be filled with more _--para --meters_.
- **shortcut**: Defines the keystroke used to launch the tool. The shortcut can also be edited in the [options editor](widgets_options_editor).
- **shortcut**: Defines the keystroke used to launch the tool. The shortcut can also be edited in the [options editor](widgets_options_editor.html).
- **showWindow**: Defines how the tool window is displayed. Set to **swoHIDE** if the tool standard output is redirected.
- **toolAlias**: The friendly name associated to the tool.
- **workingDirectory**: The directory in which the tool starts. Not to mismatch with its path. The field can contain [symbolic strings](features_symbolic_strings).
- **workingDirectory**: The directory in which the tool starts. Not to mismatch with its path. The field can contain [symbolic strings](features_symbolic_strings.html).
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

60
docs/widgets_dexed_project_editor.md
View File

@ -1,12 +1,8 @@
---
title: Widgets - DEXED project editor
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### CE project editor
The widget is used to edit the properties of a project that has the DEXED format (*.dprj extension)
It's no recommended to use this format anymore.
@ -15,36 +11,36 @@ It's no recommended to use this format anymore.
The format is modeled based on the DMD command line interface but it can be compiled with LDC or GDC too,
using the bridges that convert DMD options to LDC (LDMD) or to GDC (GDMD), which is done automatically when they are [set to compile CE the projects](options_application).
using the bridges that convert DMD options to LDC (LDMD) or to GDC (GDMD), which is done automatically when they are [set to compile CE the projects](options_application.html).
#### Toolbar
## Toolbar
- <img src="{%include icurl%}cog/cog_add.png" class="tlbric"/>: Adds a new compiler configuration. An input-query dialog allows to directly set its name.
- <img src="{%include icurl%}cog/cog_delete.png" class="tlbric"/>: Removes the current compiler configuration.
- <img src="{%include icurl%}cog/cog_go.png" class="tlbric"/>: Clones the current compiler configuration.
- <img src="{%include icurl%}link/link_break.png" class="tlbric"/> / <img src="{%include icurl%}link/link.png" class="tlbric"/>: De/activates the synchro-mode. When activated, each particular option edited will be copied to the other configurations.
- ![](icons/cog/cog_add.png): Adds a new compiler configuration. An input-query dialog allows to directly set its name.
- ![](icons/cog/cog_delete.png): Removes the current compiler configuration.
- ![](icons/cog/cog_go.png): Clones the current compiler configuration.
- ![](icons/link/link_break.png) / ![](icons/link/link.png): De/activates the synchro-mode. When activated, each particular option edited will be copied to the other configurations.
Notes:
- changing the configuration name is only possible in the section _All Categories_, field _name_.
#### General options
## General options
The general options are common to each configuration.
- **AutoSolveDependencies**: When checked, import analysis is performed on the project sources and the static libraries that are used are automatically detected.
- **ConfigurationIndex**: Selects a configuration by its index. This property exists only for the project persistence. To select a configuration, rather uses the project inspector or the combo-box at the top of the widget.
- **LibraryAliases**: Not useful when _AutoSolveDependencies_ is checked. Shows a small editor used to specify the aliases of the libraries used by the project.
One item per line. An item text must match to an entry of the [libman](widgets_library_manager). It avoids the addition of the **-I** options and the additional sources.
One item per line. An item text must match to an entry of the [libman](widgets_library_manager.html). It avoids the addition of the **-I** options and the additional sources.
When dependencies are complex, it's possible to select all the entries by setting the first line of the editor to a single asterisk `*`. Note that unless the project _binaryKind_ is set to _executable_ or _sharedlib_ the static libraries selected from this list are not linked.
- **RootFolder**: The project file is not necessarily indicating the root of the project folder. This field can be used to specify another one, either relative or absolute. This is useful to run a custom tool using the **CPR** [symbolic string](features_symbolic_strings) (e.g: git, recursive cleaning).
- **RootFolder**: The project file is not necessarily indicating the root of the project folder. This field can be used to specify another one, either relative or absolute. This is useful to run a custom tool using the **CPR** [symbolic string](features_symbolic_strings.html) (e.g: git, recursive cleaning).
- **Sources**: Shows a dialog used to edit the filenames of the project sources. Relative paths are automatically handled. Only one item must stand by line.
It's recommended to use the [project inspector](widgets_project_inspector) instead of this archaic editor. To include a folder of source it's also possible to specify a path with a asterisk in the **Paths** options, **ExtraSources** editor.
It's recommended to use the [project inspector](widgets_project_inspector.html) instead of this archaic editor. To include a folder of source it's also possible to specify a path with a asterisk in the **Paths** options, **ExtraSources** editor.
This avoids to manually remove the obsolete source or to manually add the new source files.
- **version**: Defines a string used to expand the [_CPV_ symbolic string](features_symbolic_strings).
- **version**: Defines a string used to expand the [_CPV_ symbolic string](features_symbolic_strings.html).
- **versionFile**: Defines the name of a file that contains the **version** text. This property has for effect to replace the existing **version**. The filename can be relative to the project root or absolute.
#### Message options
## Message options
Groups the options related to the messages emitted by the compiler.
These options are defined per-configuration.
@ -58,7 +54,7 @@ These options are defined per-configuration.
- **warnings**: Sets if the warnings are displayed. (**-w**)
- **warningsAsInfo**: Defines if the warnings don't prevent the project to be compiled.
#### Debugging options
## Debugging options
Groups the options related to the debugging information added to the output binary.
These options are defined per-configuration.
@ -70,7 +66,7 @@ These options are defined per-configuration.
- **debugIdentifiers**: List of debug identifiers. (for each item **-debug=item** is generated). One item per line.
- **generateMapFile**: sets if a map file is generated. (**-map**)
#### Documentation options
## Documentation options
Groups the options related to the generation of the project documentation.
These options are defined per-configuration.
@ -80,7 +76,7 @@ These options are defined per-configuration.
- **generateJSON**: Sets if the JSON documentation is generated. This field is constrained to _true_ if the JSON file name is defined. (**-X**)
- **JSONFilename**: Sets the JSON file name. (**-Xf**)
#### Output options
## Output options
Groups the options related to the code generation.
These options are defined per-configuration.
@ -97,7 +93,7 @@ These options are defined per-configuration.
- **unittest**: generates the unittest code. (**-unittest**)
- **versionIdentifiers**: list of version identifiers. One per line, the switches **-version=** are added automatically. An entry can be disabled by prefixing it with a semicolon or a pair of backslash.
#### Other Options
## Other Options
- **coverage**: Adds the code to generate coverage file after the output gets executed.
- **customOptions**: Allows to add custom options, whatever is the compiler used.
@ -116,12 +112,12 @@ Syntax for the custom / other options:
These custom switches are defined per-configuration.
#### Path options
## Path options
Groups the options defining the location of the files used or produced by the compiler.
These options are defined per-configuration.
- **exclusions**: Paths or files to exclude from the main sources. The items can contain [symbolic strings](features_symbolic_strings). The items can be global [match expressions](https://en.wikipedia.org/wiki/Glob_(programming)).
- **exclusions**: Paths or files to exclude from the main sources. The items can contain [symbolic strings](features_symbolic_strings.html). The items can be global [match expressions](https://en.wikipedia.org/wiki/Glob_(programming)).
- **extraSources**: Either _.lib_, _.a_, _.o_ and _.obj_ files or _.d_, _.di_ source files. If a path that ends with an asterisk is added (e.g: _folderA\folderB\*_) then every source files located in this folder and its sub-folders will be passed to the compiler.
- **forceExtension**: When checked, the output filename has always the right file extension. This option is useful when the _outputFilename_ contains periods but no extension (example: `-offoo.bar` under linux generates the executable `foo.bar` but under windows and if the option is set `foo.bar.exe`).
- **importModulePaths**: A list of paths where _DMD_ has to look for the libraries sources. (**-I**)
@ -129,27 +125,27 @@ These options are defined per-configuration.
- **objectDirectory**: The directory where object files (_*.o_ or _*.obj_) must be written. (**-od**)
- **outputFilename**: The output filename. The identifier should only include a period to specify a non default extension otherwise it prevents _DMD_ to add the default one. (**-of**)
#### Pre/Post build process options
## Pre/Post build process options
They define the options of two processes and a bunch of commands, respectively executed before and after the compilation.
These options are defined per-configuration.
These options are not compatible with the system of _base_ & _overridden_ configuration.
- **executable**: The executable file name. If the system cannot solve its path using the environment variables then it must be included.
It can also be represented by a [symbolic string](features_symbolic_strings).
It can also be represented by a [symbolic string](features_symbolic_strings.html).
- **options**: A set of options. Activate **poUsesPipe** and **poStdErrToOutput** if you wish to redirect the process output to the messages widget.
- **parameters**: A list of switches and arguments. As usual, one item per line, no double quotes.
- **showWindow**: Sets how the program window is displayed.
- **simpleCommands**: Additionally to the process, a list of shell commands can be specified, they are executed before the pre/post process. The commands have fixed options: always piped to the message widget, the working directory is always the project path.
The commands can contain [symbolic strings](features_symbolic_strings).
The commands can contain [symbolic strings](features_symbolic_strings.html).
The pre-build process is always executed, even if the project has no source files.
This can be used as a trick to compile from another tool.
An interesting post-build process feature is that it can be set on the executable that's just been build.
This is possible when the post compilation process _executable_ is set to the [symbolic strings](features_symbolic_strings) **`<CPO>`**, which is expanded to the name of the file produced by the compiler.
This is possible when the post compilation process _executable_ is set to the [symbolic strings](features_symbolic_strings.html) **`<CPO>`**, which is expanded to the name of the file produced by the compiler.
#### Run options
## Run options
They define the options applied when running the project output (e.g: menu **"project"**, **"compile and run"**).
The _executable_ field is not present because it relies on the project parameters (**-of** for a CE project and the combination of _targetPath_ with _targetName_ for a DUB project).
@ -158,7 +154,7 @@ If the output is piped then the [process input widget][lnk_widg_procinp] can be
These options are defined per-configuration.
These options are not compatible with the system of _base_ & _overridden_ configuration.
#### All categories
## All categories
Unfiltered options, sub categories can be expanded or collapsed.
@ -166,8 +162,4 @@ Unfiltered options, sub categories can be expanded or collapsed.
- **isBaseConfiguration**: When checked, the current configuration defines the default options of a configuration which is set as overridden.
- **isOverriddenConfiguration**: When checked, the options of the current configuration are only handled if they don't match to the base configuration or if the base configuration is not set. This system avoids to edit using the synchro-mode.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

19
docs/widgets_dfmt_commander.md
View File

@ -1,15 +1,8 @@
---
title: Widgets - DFMT commander
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### DFMT commander
The _Dfmt commander_ widget is a simple but complete interface for the D source code formater [Dfmt](https://github.com/dlang-community/dfmt).
The background tool has to be build and installed in one of the _PATH_ known by the operating system.
@ -18,14 +11,10 @@ The background tool has to be build and installed in one of the _PATH_ known by
A property inspector allows to tweak the format.
See the [official documentation](https://github.com/dlang-community/dfmt#configuration) to learn more about the options.
- <img src="{%include icurl%}other/accept.png" class="tlbric"/>: apply the formatting. The editor state is backed up before each formatting.
- <img src="{%include icurl%}other/cancel.png" class="tlbric"/>: restore the previous backup.
- ![](icons/other/accept.png): apply the formatting. The editor state is backed up before each formatting.
- ![](icons/other/cancel.png): restore the previous backup.
The formatting is applied in memory and can be undone either from the widget or from the code editor.
The changes are not physically applied until the file is explicitly saved.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

19
docs/widgets_dub_project_editor.md
View File

@ -1,15 +1,8 @@
---
title: Widgets - DUB project editor
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### DUB project editor
The DUB project editor allows to edit, add and remove properties to a a DUB project that has the [JSON format](http://code.dlang.org/package-format?lang=json).
DUB projects with the [SDL format](http://code.dlang.org/package-format?lang=sdl) are opened in read only mode.
@ -18,10 +11,10 @@ DUB projects with the [SDL format](http://code.dlang.org/package-format?lang=sdl
A property value can be modified in the field at the bottom. New values always require an extra validation.
New properties can be added or removed:
- <img src="{%include icurl%}other/textfield_add.png" class="tlbric"/>: Shows a small dialog that allows to add a new value, a new array or a new object.
- <img src="{%include icurl%}other/textfield_delete.png" class="tlbric"/>: Removes the selected property. Note that the effect is not reflected until the project is saved as a file (since Dexed does not communicate directly with DUB).
- <img src="{%include icurl%}other/copy.png" class="tlbric"/>: Duplicates the selected object. Can be used to clone a configuration or a build type.
- <img src="{%include icurl%}arrow/arrow_update.png" class="tlbric"/>: Updates the list of sources files and auto fetch dependencies if specified as an option for [DUB](options_dub_build)
- ![](icons/other/textfield_add.png): Shows a small dialog that allows to add a new value, a new array or a new object.
- ![](icons/other/textfield_delete.png): Removes the selected property. Note that the effect is not reflected until the project is saved as a file (since Dexed does not communicate directly with DUB).
- ![](icons/other/copy.png): Duplicates the selected object. Can be used to clone a configuration or a build type.
- ![](icons/arrow/arrow_update.png): Updates the list of sources files and auto fetch dependencies if specified as an option for [DUB](options_dub_build.html)
![](img/dub_add_property.png)
@ -34,8 +27,6 @@ When the second method is used the property type is selected automatically, whic
The property name is not always required. For example when when an array item is added the content of the field is ignored.
After adding a property, its value still needs to be set at the bottom of the tree.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

45
docs/widgets_editor.md
View File

@ -1,41 +1,34 @@
---
title: Widgets - Editor
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Editor
The _editor widget_ is a standard code editor, specialized for highlighting D source files.
![](img/editor_overview.png)
#### Navigation
## Navigation
In addition to the standard actions used to navigate in a source, Dexed implements several helpers:
- **Next/Previous location**: The two actions are used to jump to the locations where the caret was activated. They follow the chronology and not the line numbers. In the [shortcut editor](options_shortcuts_editor) they can be found under the names _PreviousLocation_ and _NextLocation_. The actions are also hard linked to the mouse buttons X1 and X2 and the multimedia keys usually used by web browsers to reload the next or the previous page.
- **Next/Previous changed area**: The two actions are used to jump to the locations that contain changes. They follow the line numbers. In the [shortcut editor](options_shortcuts_editor) they can be found under the names _PreviousChangedArea_ and _NextChangedArea_.
- **Next/Previous protection attribute**: This especially made to navigate in the aggregates. In the [shortcut editor](options_shortcuts_editor) they can be found under the names _PrevProtGroup_ and _NextProtGroup_.
- **Next/Previous location**: The two actions are used to jump to the locations where the caret was activated. They follow the chronology and not the line numbers. In the [shortcut editor](options_shortcuts_editor.html) they can be found under the names _PreviousLocation_ and _NextLocation_. The actions are also hard linked to the mouse buttons X1 and X2 and the multimedia keys usually used by web browsers to reload the next or the previous page.
- **Next/Previous changed area**: The two actions are used to jump to the locations that contain changes. They follow the line numbers. In the [shortcut editor](options_shortcuts_editor.html) they can be found under the names _PreviousChangedArea_ and _NextChangedArea_.
- **Next/Previous protection attribute**: This especially made to navigate in the aggregates. In the [shortcut editor](options_shortcuts_editor.html) they can be found under the names _PrevProtGroup_ and _NextProtGroup_.
#### Edition helpers
## Edition helpers
- **Upper / Lower case**: The two actions change the case of the selection.
- **Sort lines**: Shows a dialog with the options allowing to sort the selection.
- **Comment selected lines**: Comments or uncomments the current line or the selection.
- **Comment identifier**: Comments or uncomments the identifier located at the caret.
- **Invert version all none**: Changes the `version(none)` to `version(all)` and conversely.
- **Synchro-edit**: When there's a selection, click the pen icon in the gutter. This allows to rename all the identifier that are lexically equals. To rename using the semantic, see [DCD](features_dcd).
- **Synchro-edit**: When there's a selection, click the pen icon in the gutter. This allows to rename all the identifier that are lexically equals. To rename using the semantic, see [DCD](features_dcd.html).
![](img/editor_synchro_edit.png)
All these actions are assignable to a shortcut via the [shortcut editor](options_shortcuts_editor)
All these actions are assignable to a shortcut via the [shortcut editor](options_shortcuts_editor.html)
#### Automatic features
## Automatic features
Options exist to automatically close the curly brackets (`{ }`), the square brackets (`[ ]`), the double quotes (`" "`), the back-ticks (`` ` ` ``) and the single quotes (`' '`).
@ -53,7 +46,7 @@ Options for the curly brackets:
The last option is the default. Use the <kbd>CTRL</kbd> key to skip the auto closing done with <kbd>ENTER</kbd>.
#### Custom regions
## Custom regions
The custom regions are defined in single line comments.
A region starts with a comment that ends with at least three hyphens and a plus symbol.
@ -76,7 +69,7 @@ T opIndex(size_t i){}
Regions are saved and reloaded with the editor cache. They give a clear and compact view of a module.
#### Split view
## Split view
The split view allows to pin one of the document to the right of all the other documents.
@ -86,7 +79,7 @@ The document to pin can be replaced on the fly, still using the same button, and
It's useful to display a module that contains the declarations of a library binding since it's not anymore necessary to change the editor page to verify the members of an enum or the parameters of a function.
#### External Modification tracking
## External Modification tracking
When a document that's edited in Dexed is modified by another program, a _diff_ is displayed.
@ -94,15 +87,15 @@ When a document that's edited in Dexed is modified by another program, a _diff_
The dialog is guaranteed to be only displayed when the content contains changes. A simple date of modification has no effect.
#### Linting
## Linting
If activated in the options (see beyond), the source can be automatically linted, after a relative period of time, following the last keystroke.
Results are displayed in the gutter and the warning body can be consulted in the hint displayed when the mouse motin stops over the icon.
Linting requires [D-Scanner](https://github.com/dlang-community/D-Scanner) to be setup.
It's possible to use the [information box](widgets_about) to determine if Dexed can find the tool.
It's possible to use the [information box](widgets_about.html) to determine if Dexed can find the tool.
Note that linting can also be launched manually from the _File_ or the _Project_ menus.
#### Notable options
## Notable options
The editor is highly configurable.
@ -111,7 +104,7 @@ The editor is highly configurable.
The options related to the visual look are mainly located in the _highlighterDlang_ and the _highlighterGeneric_ sub categories.
The category _Highlighter presets_ can be used to customize more easily the style.
The shortcuts are editable in the [shortcut editor](options_shortcuts_editor), under the category _Code editor._
The shortcuts are editable in the [shortcut editor](options_shortcuts_editor.html), under the category _Code editor._
- **alwaysAdvancedFeatures**: When checked, auto-closing or DCD features also work on documents that don't have the _.d_ or the _.di_ extensions.
- **autoCallCompletion**: Call completion after an alphabetic character, without explicit <kbd>CTRL</kbd>+<kbd>SPACE</kbd>.
@ -136,8 +129,4 @@ The shortcuts are editable in the [shortcut editor](options_shortcuts_editor), u
- **resetFontSize**: When checked and if the font size is modified then the font size is resets in all the documents that are opened. The option can be disabled in order to keep the current zoom ratio.
- **smartDdocNewLine**: Allow the auto insertion of a leading `*` or a `+` while writing documentation comments.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>

69
docs/widgets_gdb_commander.md
View File

@ -1,68 +1,61 @@
---
title: Widgets - GDB commander
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### GDB commander
GDB commander is a GUI front-end for the [GNU debugger](https://www.sourceware.org/gdb/). It's only available under Linux.
![](img/gdb_commander.png)
It allows to debug the project output (if it's an application) but also the [runnable modules](features_runnables).
It allows to debug the project output (if it's an application) but also the [runnable modules](features_runnables.html).
#### Breakpoints
## Breakpoints
The breakpoints are handled by the editor. Click the gutter to add or to remove a breakpoint.
After a break, the following icons may be displayed in the gutter:
- <img src="{%include icurl%}other/breaks.png" class="tlbric"/>: A breakpoint is reached.
- <img src="{%include icurl%}other/camera_go.png" class="tlbric"/>: A watch point is reached. For now the only watchpoints supported are those that monitor a variable (see the toolbar description).
- <img src="{%include icurl%}other/step.png" class="tlbric"/>: The program execution stopped here for another reason. It may be caused by step by step execution or because an unexpected signal has been received.
- ![](icons/other/breaks.png): A breakpoint is reached.
- ![](icons/other/camera_go.png): A watch point is reached. For now the only watchpoints supported are those that monitor a variable (see the toolbar description).
- ![](icons/other/step.png): The program execution stopped here for another reason. It may be caused by step by step execution or because an unexpected signal has been received.
#### Target options
## Target options
This page allows to edit the options passed to the debugger target (also called _the inferior_).
![](img/gdb_commander_debugeeopts.png)
- **arguments**: Allows to set the target command line arguments. One item per line. Items can include [symbolic strings](features_symbolic_strings).
- **arguments**: Allows to set the target command line arguments. One item per line. Items can include [symbolic strings](features_symbolic_strings.html).
- **environmentPaths**: Allows to add additional folders to the PATH variable. One item per line.
- **queryArguments**: When checked and when the debugging cession starts a small input dialog is displayed. It can be used to pass more **--para --meters** to the target.
- **target**: Read-only. Indicates clearly which is the project or the runnable module that will be debugged.
- **workingDirectory**: Allows to set the target working directory. Can include [symbolic strings](features_symbolic_strings).
- **workingDirectory**: Allows to set the target working directory. Can include [symbolic strings](features_symbolic_strings.html).
#### CPU inspector
## CPU inspector
This page shows the content of the CPU registers. Each value can be modified.
Note that for now SSE registers are not supported by the inspector.
#### Toolbar
## Toolbar
- <img src="{%include icurl%}other/power.png" class="tlbric"/>: Starts debugging. By default the project output is launched. It should be compiled with the debug info generation. A context menu at the right allows to debug the [runnable](features_runnables) binary produced for the editor that has the selection.
- <img src="{%include icurl%}other/stop.png" class="tlbric"/>: Stops the debugging cession.
- <img src="{%include icurl%}other/play.png" class="tlbric"/>: Resume the debugging cession.
- <img src="{%include icurl%}other/pause.png" class="tlbric"/>: Pauses the debugging cession.
- <img src="{%include icurl%}arrow/go_down.png" class="tlbric"/>: Steps to the next instruction, including inside functions. A context menu at the right allows to define if stepping is done at the source level (line by line) or at the hardware level (instruction by instruction).
- <img src="{%include icurl%}arrow/go_jump.png" class="tlbric"/>: Steps to the next instruction, excluding functions calls. A context menu at the right allows to define if stepping is done at the source level (line by line) or at the hardware level (instruction by instruction).
- <img src="{%include icurl%}other/processor.png" class="tlbric"/>: Updates the CPU inspector.
- <img src="{%include icurl%}other/list.png" class="tlbric"/>: Updates the call stack list.
- <img src="{%include icurl%}window/watch_window.png" class="tlbric"/>: Updates the local variables list.
- <img src="{%include icurl%}other/camera_add.png" class="tlbric"/>: Allows to set or remove a watch point. When the button is clicked, a watch is added for the variable that's selected in the variables list. A context menu at the right allows to define the access for which the debugger breaks.
- <img src="{%include icurl%}other/evaluate_formula.png" class="tlbric"/>: Allows to evaluate either the variable or the dereference of the variable selected in the variable list, or a custom expression. To select the mode, use the menu attached to the right of the icon. Note that a specific shortcut allows to repeat the command when the mode is set to "Evaluate Custom Expression", so that the input dialog step is skipped.
- ![](icons/other/power.png): Starts debugging. By default the project output is launched. It should be compiled with the debug info generation. A context menu at the right allows to debug the [runnable](features_runnables.html) binary produced for the editor that has the selection.
- ![](icons/other/stop.png): Stops the debugging cession.
- ![](icons/other/play.png): Resume the debugging cession.
- ![](icons/other/pause.png): Pauses the debugging cession.
- ![](icons/arrow/go_down.png): Steps to the next instruction, including inside functions. A context menu at the right allows to define if stepping is done at the source level (line by line) or at the hardware level (instruction by instruction).
- ![](icons/arrow/go_jump.png): Steps to the next instruction, excluding functions calls. A context menu at the right allows to define if stepping is done at the source level (line by line) or at the hardware level (instruction by instruction).
- ![](icons/other/processor.png): Updates the CPU inspector.
- ![](icons/other/list.png): Updates the call stack list.
- ![](icons/window/watch_window.png): Updates the local variables list.
- ![](icons/other/camera_add.png): Allows to set or remove a watch point. When the button is clicked, a watch is added for the variable that's selected in the variables list. A context menu at the right allows to define the access for which the debugger breaks.
- ![](icons/other/evaluate_formula.png): Allows to evaluate either the variable or the dereference of the variable selected in the variable list, or a custom expression. To select the mode, use the menu attached to the right of the icon. Note that a specific shortcut allows to repeat the command when the mode is set to "Evaluate Custom Expression", so that the input dialog step is skipped.
#### Custom commands
## Custom commands
The field at the bottom allows to pass custom commands to GDB.
A custom command can include a [symbol string](features_symbolic_strings).
A custom command can include a [symbol string](features_symbolic_strings.html).
You may pass command with the standard CLI syntax (e.g _show_, _set_, etc), however since GDB is launched with the option that activates the machine interface (MI) the standard commands are not guaranteed to work properly.
The option **showRawMiOutput** must be activated in order to get the GDB answer for a custom command in the [messages](widgets_messages).
The option **showRawMiOutput** must be activated in order to get the GDB answer for a custom command in the [messages](widgets_messages.html).
Learn more about the commands and the MI syntax in [the official manual](http://sourceware.org/gdb/current/onlinedocs/gdb/).
@ -76,13 +69,13 @@ Note that even if in most of the cases the results of a custom command are displ
- Any commands that may cause an execution break is handled by the interpreter (.so library events, fork events, system calls, function finished, etc).
- Any variation of the `-stack-list-variables` has for effect to update the variable list.
#### Target input stream
## Target input stream
The field at the bottom is also used to pass new lines to the target standard input.
To differentiate a custom command from an input line, use the `>` (greater than) symbol.
The text following the symbol is written to the input stream, with an implicit new line character at the end.
#### Options
## Options
![](img/options_gdb_commander.png)
@ -100,13 +93,11 @@ The text following the symbol is written to the input stream, with an implicit n
- **ignoredSignals**: Sets the signals that won't break the execution.
- **keepRedirectedStream**: Sets if the files that contain the inferior I/O history are kept on the disk. These files stands in the target directory with the extensions _.inferiorin_ and _.inferiorout_.
- **shortcuts**: Allows to define a shortcut for each button in the toolbar.
- **showGdbOutput**: For debugging the widget. When checked the raw GDB output (before being interpreted) is displayed in [the messages](widgets_messages).
- **showOutput**: Displays the target output in [the messages](widgets_messages). May be deactivated for a GUI program.
- **showRawMiOutput**: For the custom commands or for debugging the widget. When checked the GDB output (after JSON-ization) is displayed in [the messages](widgets_messages).
- **showGdbOutput**: For debugging the widget. When checked the raw GDB output (before being interpreted) is displayed in [the messages](widgets_messages.html).
- **showOutput**: Displays the target output in [the messages](widgets_messages.html). May be deactivated for a GUI program.
- **showRawMiOutput**: For the custom commands or for debugging the widget. When checked the GDB output (after JSON-ization) is displayed in [the messages](widgets_messages.html).
- **stopAllThreadsOnBreak**: Sets if all the threads of the target are stopped when the execution breaks. Not applied until next debugging cession.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

57
docs/widgets_library_manager.md
View File

@ -1,48 +1,39 @@
---
title: Widgets - library manager
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Library manager
#### Description
The library manager (aka the _libman_) is designed to replace the _sc.ini_ or the _sc.conf_ file to manage the static libraries.
Despite of its simplistic look it's a central component of the software. The [completion](features_dcd), the [runnables](features_runnables), the CE project format strongly rely on it.
Despite of its simplistic look it's a central component of the software. The [completion](features_dcd.html), the [runnables](features_runnables.html), the CE project format strongly rely on it.
The _libman_ links the library files (_*.lib_ or _*.a_) to their D sources and are represented with a simple **alias** that is used in different part of the software.
For example, in a CE project, you don't need to specify the **-I** path nor its matching library file name, this is done automatically.
![](img/library_manager.png)
#### Import analysis
## Import analysis
Since version 3, the _libman_ also contains a database that links each item to a list of module.
This is used to automatically detect a dependency from a simple import declaration.
This features is only used for the CE project format and the [runnables](features_runnables) modules.
This features is only used for the CE project format and the [runnables](features_runnables.html) modules.
#### Toolbar
## Toolbar
- <img src="{%include icurl%}book/book_add.png" class="tlbric"/>: Adds a library item, by default its fields are initialized with _n/a_.
- <img src="{%include icurl%}book/book_delete.png" class="tlbric"/>: Removes the selected item.
- <img src="{%include icurl%}arrow/arrow_up.png" class="tlbric"/> **/** <img src="{%include icurl%}arrow/arrow_down.png" class="tlbric"/> Changes selected entry position.
- <img src="{%include icurl%}book/book_link.png" class="tlbric"/>: If the current project is a static library then the _libman_ will use its parameters to create an entry. This avoids to browse in the dialogs. Note that sometimes the sources root folder has to be adjusted.
- <img src="{%include icurl%}book/book_open.png" class="tlbric"/>: If the selected item defines a _project_ then closes current project and opens the one matching to the entry.
- <img src="{%include icurl%}other/dub.png" class="tlbric"/>: Allows to fetch the master version of a [DUB registry item](http://code.dlang.org/). See the last section.
- <img src="{%include icurl%}book/book.png" class="tlbric"/>: enable or disable the selected entry. This is mainly useful to test new DMD versions since the libraries often have to be recompiled from a version to another.
- <img src="{%include icurl%}book/book_edit.png" class="tlbric"/>: edit the item alias.
- <img src="{%include icurl%}folder/folder_brick.png" class="tlbric"/>: select the library file. In some rare case, this field can be omitted (for example if the library file is set in the _sc.ini_).
This can be skipped if the library is only a small orphan _d_ source that's not been compiled as a static library or if the entry is only used for the [DCD](features_dcd) completion.
- <img src="{%include icurl%}other/bricks.png" class="tlbric"/>: select a folder that contains several libraries files or several orphans modules.
- <img src="{%include icurl%}folder/folder_add.png" class="tlbric"/>: select the sources root folder. (the one commonly named 'import').
- <img src="{%include icurl%}other/script_bricks.png" class="tlbric"/>: set the project file that matches to the selected item.
- ![](icons/book/book_add.png) : Adds a library item, by default its fields are initialized with _n/a_.
- ![](icons/book/book_delete.png) : Removes the selected item.
- ![](icons/arrow/arrow_up.png) **/** ![](icons/arrow/arrow_down.png): Changes selected entry position.
- ![](icons/book/book_link.png) : If the current project is a static library then the _libman_ will use its parameters to create an entry. This avoids to browse in the dialogs. Note that sometimes the sources root folder has to be adjusted.
- ![](icons/book/book_open.png): If the selected item defines a _project_ then closes current project and opens the one matching to the entry.
- ![](icons/other/dub.png): Allows to fetch the master version of a [DUB registry item](http://code.dlang.org/). See the last section.
- ![](icons/book/book.png): enable or disable the selected entry. This is mainly useful to test new DMD versions since the libraries often have to be recompiled from a version to another.
- ![](icons/book/book_edit.png): edit the item alias.
- ![](icons/folder/folder_brick.png): select the library file. In some rare case, this field can be omitted (for example if the library file is set in the _sc.ini_).
This can be skipped if the library is only a small orphan _d_ source that's not been compiled as a static library or if the entry is only used for the [DCD](features_dcd.html) completion.
- ![](icons/other/bricks.png): select a folder that contains several libraries files or several orphans modules.
- ![](icons/folder/folder_add.png): select the sources root folder. (the one commonly named 'import').
- ![](icons/other/script_bricks.png): set the project file that matches to the selected item.
#### Register online DUB packages
## Register online DUB packages
When the toolbar button that displays DUB logo is clicked, a dialog is displayed. It used to select an online package that will be downloaded, compiled and automatically installed in the _libman_
@ -50,13 +41,11 @@ When the toolbar button that displays DUB logo is clicked, a dialog is displayed
The text field is used to select the name of the package to install.
- <img src="{%include icurl%}arrow/arrow_update.png" class="tlbric"/>: Update the list of the online packages.
- <img src="{%include icurl%}other/tag_purple.png" class="tlbric"/>: By the default the master version of the package is installed. When the tag button is down Dexed rather installs the package from its latest tag.
- <img src="{%include icurl%}other/accept.png" class="tlbric"/>: Closes the dialog and start downloading before installing.
- <img src="{%include icurl%}other/cancel.png" class="tlbric"/>: Cancels and does nothing.
- ![](icons/arrow/arrow_update.png): Update the list of the online packages.
- ![](icons/other/tag_purple.png): By the default the master version of the package is installed. When the tag button is down Dexed rather installs the package from its latest tag.
- ![](icons/other/accept.png): Closes the dialog and start downloading before installing.
- ![](icons/other/cancel.png): Cancels and does nothing.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

18
docs/widgets_messages.md
View File

@ -1,23 +1,17 @@
---
title: Widgets - messages
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
### Messages
#### Description
## Description
The widget displays a stream of information about the current file or about the current project.
The messages can be filtered according to their context:
- __All__: no filter.
- __Editor__: filters the messages related to the editor that has the focus (compilation, standard output of the module when executed as a [_runnable_](features_runnables)).
- __Editor__: filters the messages related to the editor that has the focus (compilation, standard output of the module when executed as a [_runnable_](features_runnables.html)).
- __Project__: filters the messages related to the current project (DMD or DUB messages, pre/post compilation process output, project execution).
- __Application__: filters the messages emitted by CE (applications warnings, application exceptions).
- __Misc__: miscellaneous messages (messages emitted by the widgets, by the custom tools when their output is redirected, [find all](widgets_search) results, etc).
- __Misc__: miscellaneous messages (messages emitted by the widgets, by the custom tools when their output is redirected, [find all](widgets_search.html) results, etc).
![](img/messages1.png)
![](img/messages2.png)
@ -32,7 +26,7 @@ The context menu contains a few useful actions, such as *copy messages*, *save m
By default only the last 500 messages are displayed, regardless of the categories.
This value and several other options can be changed in the options.
#### Options
## Options
![](img/options_messages.png)
@ -46,8 +40,6 @@ This is a recommended setting because if a run-time error happens, it will be im
- **maxMessageCount**: Allows to limit the maximum number of messages kept in the list.
- **singleMessageClick**: Allows to open the file that the message parser has found by a single click.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

28
docs/widgets_mini_explorer.md
View File

@ -1,33 +1,27 @@
---
title: Widgets - mini explorer
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Mini explorer
#### Description
## Description
The mini explorer provides basic file browsing functionality within the IDE.
![](img/mini_explorer.png)
- <img src="{%include icurl%}folder/folder_go.png" class="tlbric"/>: When clicked, allows to select a custom tree root. When using the associated drop down, allows to select a particular drive as root.
- <img src="{%include icurl%}arrow/go_previous.png" class="tlbric"/>: Got to the root parent folder.
- <img src="{%include icurl%}folder/folder_add.png" class="tlbric"/>: Adds the selected folder to the favorites.
- <img src="{%include icurl%}folder/folder_delete.png" class="tlbric"/>: Removes the selected favorite folder.
- <img src="{%include icurl%}other/flash.png" class="tlbric"/>: Open the selected folder or execute the selected file using the shell.
- <img src="{%include icurl%}other/pencil.png" class="tlbric"/>: If the selected file is a CE or a DUB project then opens it as a project otherwise opens it in a new code editor.
- ![](icons/folder/folder_go.png): When clicked, allows to select a custom tree root. When using the associated drop down, allows to select a particular drive as root.
- ![](icons/arrow/go_previous.png): Got to the root parent folder.
- ![](icons/folder/folder_add.png): Adds the selected folder to the favorites.
- ![](icons/folder/folder_delete.png): Removes the selected favorite folder.
- ![](icons/other/flash.png): Open the selected folder or execute the selected file using the shell.
- ![](icons/other/pencil.png): If the selected file is a CE or a DUB project then opens it as a project otherwise opens it in a new code editor.
- ***input field***: filter the files whose name contains the text typed.
The file list supports drag and drop.
#### Options
## Options
A few options are available in the [option editor](widgets_options_editor).
A few options are available in the [option editor](widgets_options_editor.html).
![](img/options_mini_explorer.png)
@ -35,8 +29,6 @@ A few options are available in the [option editor](widgets_options_editor).
- **doubleClick**: Defines what happens when a file is double clicked.
- **showHidden**: Sets if hidden folders and files are displayed.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

15
docs/widgets_options_editor.md
View File

@ -1,15 +1,8 @@
---
title: Widgets - options editor
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Options editor
The _Options editor_ is a special, non-dockable, widget that allows the other widgets to expose their options.
The list at the left displays the categories. A category often matches to a single widget but not only (for example the shortcuts).
@ -17,8 +10,8 @@ The list at the left displays the categories. A category often matches to a sing
The options are applied in real time but are reversible until the green checker icon is clicked.
- <img src="{%include icurl%}other/accept.png" class="tlbric"/>: Validates the modifications made to the current category, after what they can't be canceled anymore.
- <img src="{%include icurl%}other/cancel.png" class="tlbric"/>: Cancels and restores the previous state of the current category.
- ![](icons/other/accept.png): Validates the modifications made to the current category, after what they can't be canceled anymore.
- ![](icons/other/cancel.png): Cancels and restores the previous state of the current category.
The options are persistent and saved in a specific folder:
@ -29,8 +22,6 @@ The options are persistent and saved in a specific folder:
Each software component saves its own file with a self-explanatory name so it's easy to find and modify the file that matches a particular setting.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

19
docs/widgets_process_input.md
View File

@ -1,27 +1,18 @@
---
title: Widgets - process input
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Process input
The process input widget is used to pass input to the processes that are executed within Coedit.
![](img/process_input.png)
- <img src="{%include icurl%}other/pencil_go.png" class="tlbric"/>: Sends the text to the process, also works with <kbd>ENTER</kbd>.
- <img src="{%include icurl%}other/pencil_delete.png" class="tlbric"/>: Closes the process input stream.
- <img src="{%include icurl%}other/cancel.png" class="tlbric"/>: Forces the process termination.
- ![](icons/other/pencil_go.png): Sends the text to the process, also works with <kbd>ENTER</kbd>.
- ![](icons/other/pencil_delete.png): Closes the process input stream.
- ![](icons/other/cancel.png): Forces the process termination.
The input text can contain [symbolic strings](features_symbolic_strings).
The input text can contain [symbolic strings](features_symbolic_strings.html).
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

25
docs/widgets_profile_viewer.md
View File

@ -1,16 +1,9 @@
---
title: Widgets - Profile viewer
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Profile viewer
#### Description
## Description
The _profile viewer_ widget displays the results stored in the _trace.log_ file that a software compiled with DMD outputs when it's compiled with the `-profile` switch.
@ -21,22 +14,20 @@ This criterion can be selected in the combo box that's located in the toolbar.
The list displays all the results, which can be inspected more accurately after sorting a column.
#### Toolbar
## Toolbar
- <img src="{%include icurl%}other/list.png" class="tlbric"/>: Loads the _trace.log_ file located in the project output path.
- <img src="{%include icurl%}folder/folder.png" class="tlbric"/>: Proposes to open the _trace.log_ from a dialog.
- <img src="{%include icurl%}arrow/arrow_update.png" class="tlbric"/>: Reloads the current _trace.log_ or tries to load it from the current directory.
- <img src="{%include icurl%}cog/wrench.png" class="tlbric"/>: Shows the profile viewer options.
- ![](icons/other/list.png): Loads the _trace.log_ file located in the project output path.
- ![](icons/folder/folder.png): Proposes to open the _trace.log_ from a dialog.
- ![](icons/arrow/arrow_update.png): Reloads the current _trace.log_ or tries to load it from the current directory.
- ![](icons/cog/wrench.png): Shows the profile viewer options.
#### Options
## Options
- **hideAtributes**: Sets if the functions attributes are displayed.
- **hideRuntimeCalls**: When checked, all the functions starting with `core.` are excluded.
- **hideStandardLibraryCalls**: When checked, all the functions starting with `std.` are excluded.
- **otherExclusion**: Allows to define other sub-strings masks.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

35
docs/widgets_project_groups.md
View File

@ -1,23 +1,16 @@
---
title: Widgets - project groups
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Project groups
#### Description
## Description
Project groups allow to work with several projects. It's easier to activate one, to recompile it and to go back to another one.
A group can include any project whose the format is handled by Coedit (Dub JSON, Dub SDL and CE formats).
Another interesting feature is that the groups can be build by a single click, in parallel, sequentially or using wait points which are defined for each item in the group. When working with static libraries, this system allows faster builds.
Even if a group would not be used to build, for example with DUB since it manages the dependencies, it's still interesting to create the group, just to ease the selection of a project and to open more easily one of its source from the [project inspector](widgets_project_inspector).
Even if a group would not be used to build, for example with DUB since it manages the dependencies, it's still interesting to create the group, just to ease the selection of a project and to open more easily one of its source from the [project inspector](widgets_project_inspector.html).
The actions operated on the group are available from the **Projects group** menu. The widget is only used to modify the items.
@ -27,21 +20,21 @@ The groups don't affect the workflow and the feature can be totally ignored.
A project is not part of the group until it's explicitly included. The project that has this independent status is called the _Free Standing Project_ (FSP).
The FSP is actually a project, as it got handled in the previous versions.
#### Toolbar
## Toolbar
- <img src="{%include icurl%}file/document_add.png" class="tlbric"/>: Adds a new project from an open dialog.
- <img src="{%include icurl%}file/document_delete.png" class="tlbric"/>: Removes the select project from the group.
- <img src="{%include icurl%}arrow/arrow_up.png" class="tlbric"/>: Moves the selected project to the top. This modifies the order of construction.
- <img src="{%include icurl%}arrow/arrow_down.png" class="tlbric"/>: Moves the selected project to the bottom. This modifies the order of construction.
- <img src="{%include icurl%}arrow/arrow_divide.png" class="tlbric"/>: When the last icon indicates this state and if the group is build using the wait points then this project is build in a new parallel process. An async point is often used for the static libraries.
- <img src="{%include icurl%}arrow/arrow_join.png" class="tlbric"/>: When the last icon indicates this state and if the group is build using the wait points then this project is not build until the previous projects are build. A wait point is often used for the last item since the binaries produced by the other projects have to be linked in.
- ![](icons/file/document_add.png): Adds a new project from an open dialog.
- ![](icons/file/document_delete.png): Removes the select project from the group.
- ![](icons/arrow/arrow_up.png): Moves the selected project to the top. This modifies the order of construction.
- ![](icons/arrow/arrow_down.png): Moves the selected project to the bottom. This modifies the order of construction.
- ![](icons/arrow/arrow_divide.png): When the last icon indicates this state and if the group is build using the wait points then this project is build in a new parallel process. An async point is often used for the static libraries.
- ![](icons/arrow/arrow_join.png): When the last icon indicates this state and if the group is build using the wait points then this project is not build until the previous projects are build. A wait point is often used for the last item since the binaries produced by the other projects have to be linked in.
The field at the bottom indicates the status of the FSP.
- <img src="{%include icurl%}other/pencil.png" class="tlbric"/>: Activates the FSP.
- <img src="{%include icurl%}file/document_add.png" class="tlbric"/>: Adds the FSP to the group.
- ![](icons/other/pencil.png): Activates the FSP.
- ![](icons/file/document_add.png): Adds the FSP to the group.
#### Menu reference
## Menu reference
- **Activate the free standing project**: Puts the focus on the FSP.
- **New projects group**: Closes the current group and start an empty one.
@ -54,8 +47,6 @@ The field at the bottom indicates the status of the FSP.
- **Compiles projects group sequentially**: Starts compiling the group. Wait points are ignored and items are compiled one by one.
- **Compiles projects group using wait points**: Starts compiling the group. Wait points are respected.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

25
docs/widgets_project_inspector.md
View File

@ -1,39 +1,30 @@
---
title: Widgets - project inspector
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Project inspector
The project inspector is used to
- select the project configuration.
- open sources in an new editor.
- add or remove source if the active project has the [CE format](features_projects).
- add or remove source if the active project has the [CE format](features_projects.html).
![](img/project_inspector.png)
The following toolbar buttons are always available:
- <img src="{%include icurl%}arrow/arrow_update.png" class="tlbric"/>: Updates the list of sources files and auto fetch DUB dependencies when applicable.
- <img src="{%include icurl%}folder/folders_explorer.png" class="tlbric"/>: Sets if the sources are displayed in a tree rather than in a single node.
- ![](icons/arrow/arrow_update.png): Updates the list of sources files and auto fetch DUB dependencies when applicable.
- ![](icons/folder/folders_explorer.png): Sets if the sources are displayed in a tree rather than in a single node.
The following toolbar buttons are only visible for CE projects:
- <img src="{%include icurl%}file/document_add.png" class="tlbric"/>: Adds a D source to the project from a dialog. The new source is not directly opened in the editor. To add a file that is already edited, rather use **"Add file to project"** from the **File** menu.
- <img src="{%include icurl%}file/document_delete.png" class="tlbric"/>: Removes from the project the source that's selected in the tree.
- <img src="{%include icurl%}folder/folder_add.png" class="tlbric"/> Adds a folder of D source to the project from a dialog. The procedure is recursive.
- <img src="{%include icurl%}folder/folder_delete.png" class="tlbric"/> Removes from the project the sources files that stand in the same directory as the source selected in the tree.
- ![](icons/file/document_add.png): Adds a D source to the project from a dialog. The new source is not directly opened in the editor. To add a file that is already edited, rather use **"Add file to project"** from the **File** menu.
- ![](icons/file/document_delete.png): Removes from the project the source that's selected in the tree.
- ![](icons/folder/folder_add.png) Adds a folder of D source to the project from a dialog. The procedure is recursive.
- ![](icons/folder/folder_delete.png) Removes from the project the sources files that stand in the same directory as the source selected in the tree.
Note that instead of using the dialogs to add files, it's also possible to drop items from a file explorer.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

11
docs/widgets_search.md
View File

@ -1,11 +1,8 @@
---
title: Widgets - search and replace
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
The _find and replace_ widget allows to find and replace text patterns in the focused source editor.
![](img/search.png)
@ -20,7 +17,7 @@ The _find and replace_ widget allows to find and replace text patterns in the fo
- **allow regex**: When checked, the search is performed by a regex engine. Note that it doesn't mean that the pattern to find has to be a regex).
By default <kbd>CTRL</kbd> + <kbd>F</kbd> is used to pass the current identifier to the first field and <kbd>F3</kbd> to execute a search.
The _Find all_ results are displayed in the [messages widget](widgets_messages), with the context and they can be clicked.
The _Find all_ results are displayed in the [messages widget](widgets_messages.html), with the context and they can be clicked.
![](img/find_all_results.png)
@ -29,11 +26,9 @@ The scope of _Replace all_ only works in the current document or its selection,
Notes:
- To find the declaration of a symbol, <kbd>Ctrl</kbd> + <kbd>MB Left</kbd> or the [symbol list](widgets_symbol_list) are faster.
- To find the declaration of a symbol, <kbd>Ctrl</kbd> + <kbd>MB Left</kbd> or the [symbol list](widgets_symbol_list.html) are faster.
- To rename a variable or a type, local identifier renaming (<kbd>Ctrl</kbd> + <kbd>F2</kbd>) can be more accurate than _Replace all_ since the action uses the semantic.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

11
docs/widgets_symbol_list.md
View File

@ -1,13 +1,8 @@
---
title: Widgets - symbol list
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
## Symbol list
This list displays the symbols declared in the D module that has the focus (imports, classes, variables, etc).
The widget is a GUI front-end for one the [_dastworx_](https://github.com/Basile-z/dexed/tree/master/dastworx) feature.
@ -15,7 +10,7 @@ It can be used to quickly find and go to the declaration of a symbol but also as
![](img/symbol_list.png)
The way the widget refreshes the list can be tweaked in the context menu or in the [options editor](widgets_options_editor).
The way the widget refreshes the list can be tweaked in the context menu or in the [options editor](widgets_options_editor.html).
![](img/options_symbol_list.png)
@ -29,8 +24,6 @@ The way the widget refreshes the list can be tweaked in the context menu or in t
- **smartFilter**: Change the behavior of the list when the symbols are filtered.
- **sortSymbols**: If checked then the symbols are sorted alphabetically instead of following the declaration order.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

17
docs/widgets_terminal.md
View File

@ -1,16 +1,9 @@
---
title: Widgets - Terminal
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Terminal
#### Description
## Description
The _Terminal_ widget is a terminal emulator integrated in the IDE. It's only available for the linux version.
@ -26,21 +19,19 @@ Commonly used keys are:
- <kbd>CTRL</kbd>+<kbd>INS</kbd>, <kbd>CTRL</kbd>+<kbd>SHIFT</kbd>+<kbd>INS</kbd>: copy, paste.
- <kbd>￪</kbd>, <kbd>￬</kbd>: commands history.
#### Options
## Options
![](img/options_terminal.png)
- **backgroundColor**: The background color.
- **followEditors**: When checked the current directory is automatically set to the folder containing a document when it gains the focus.
- **followExplorer**: When checked the current directory is automatically set to the folder that gets selected in the [mini-explorer](widgets_mini_explorer).
- **followExplorer**: When checked the current directory is automatically set to the folder that gets selected in the [mini-explorer](widgets_mini_explorer.html).
- **followProjects**: When checked the current directory is automatically set to the folder containing a project when it gains the focus.
- **font**: Allows to customize the font name and its size. The color is not handled here.
- **foregroundColor**: The font color.
- **scrollbackLines**: The max count of previous lines that are stored.
- **selectedColor**: The bacground when some text is selected. Selected text color is then simply inverted.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}

25
docs/widgets_todo_list.md
View File

@ -1,16 +1,9 @@
---
title: Widgets - Todo list
header-includes: <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js"></script>
---
{% raw %}
<script src="//cdnjs.cloudflare.com/ajax/libs/anchor-js/4.0.0/anchor.min.js"></script>
{% endraw %}
{% include xstyle.css %}
### Todo list
#### Description
## Description
The _todo list_ widget displays the _todo comments_ located in the source files.
@ -23,10 +16,10 @@ Otherwise if a file has the focus and if it's part of the project then the whole
It's possible to display the comment that matches to a particular item with a double click.
The items cannot be edited in the widget.
- <img src="{%include icurl%}arrow/arrow_update.png" class="tlbric"/>: Refreshes the list manually.
- <img src="{%include icurl%}arrow/arrow_pen.png" class="tlbric"/>: Jump to the item declaration.
- ![](icons/arrow/arrow_update.png): Refreshes the list manually.
- ![](icons/other/pencil_go.png): Jump to the item declaration.
#### Format
## Format
The _todo comments_ must follow this format:
@ -45,7 +38,7 @@ For example
are valid _todos_.
#### Options
## Options
![](img/options_todo_list.png)
@ -53,8 +46,4 @@ are valid _todos_.
- **columns**: Selects which columns are visible. Despite of the settings a column is only displayed when at least one item uses the matching field.
- **singleClickSelect**: Defines how the mouse is used to go to the item declaration.
{% raw %}
<script>
anchors.add();
</script>
{% endraw %}
<script>anchors.add();</script>