fortran-language-server 1.5.0

FORTRAN Language Server for the Language Server Protocol

A Fortran implementation of the Language Server Protocol using Python (2.7+ or 3.0+).

Editor extensions using this language server to provide autocomplete and other IDE-like functionality are available for Atom, Visual Studio Code, Visual Studio, (Neo)vim, and Emacs.

Language Server Features

• Document symbols (textDocument/documentSymbol)

• Auto-complete (textDocument/completion)

• Signature help (textDocument/signatureHelp)

• GoTo/Peek definition (textDocument/definition)

• Hover (textDocument/hover)

• GoTo implementation (textDocument/implementation)

• Find/Peek references (textDocument/references)

• Project-wide symbol search (workspace/symbol)

• Symbol renaming (textDocument/rename)

• Documentation parsing (Doxygen and FORD styles)

• Diagnostics (limited)

  • Multiple use of the same variable name

  • Unknown module in USE statement

  • Variable masking definition from parent scope

  • Unclosed blocks/scopes

  • Invalid scope nesting

  • Contains statement errors

Notes/Limitations:

• Signature help is not available for overloaded subroutines/functions

• Diagnostics are only updated when files are saved or opened/closed

Editor examples (Atom):

Document symbols (textDocument/documentSymbol):

Auto-complete (textDocument/completion):

Signature help (textDocument/signatureHelp):

Goto definition (textDocument/definition):

Hover (textDocument/hover):

Find references (textDocument/references):

Diagnostics:

Installation

pip install fortran-language-server

Language server settings

The following global settings can be used when launching the language server.

• --symbol_skip_mem Do not include type members in document symbol results

• --incremental_sync Use incremental document synchronization

• --autocomplete_no_prefix Do not filter autocomplete results by variable prefix

• --lowercase_intrinsics Use lowercase for intrinsics and keywords in autocomplete requests

• --use_signature_help Use signature help instead of snippets for subroutines/functions

• --variable_hover Show hover information for variables (default: subroutines/functions only)

• --preserve_keyword_order Display variable keywords information in original order (default: sort to consistent ordering)

• --debug_log Write debug information to root_dir/fortls_debug.log (requires a specified root_dir during initialization)

Debug settings:

The following settings can be used to perform standalone debug tests on the language server.

• --debug_filepath=DEBUG_FILEPATH File path for language server tests

• --debug_rootpath=DEBUG_ROOTPATH Root path for language server tests

• --debug_line=DEBUG_FILEPATH Line position for language server tests (1-indexed)

• --debug_char=DEBUG_ROOTPATH Character position for language server tests (1-indexed)

• --debug_parser Test source code parser on specified file

• --debug_diagnostics Test diagnostic notifications for specified file

• --debug_symbols Test symbol request for specified file

• --debug_workspace_symbols=QUERY_STRING Test workspace/symbol request for project-wide search

• --debug_completion Test completion request for specified file and position

• --debug_signature Test signatureHelp request for specified file and position

• --debug_definition Test definition request for specified file and position

• --debug_hover Test hover request for specified file and position

• --debug_implementation Test implementation request for specified file and position

• --debug_references Test references request for specified file and position

Configuration

Project specific settings can be specified by placing a JSON file named .fortls (example below) in the root_dir directory.

• lowercase_intrinsics Use lowercase for intrinsics and keywords in autocomplete requests (default: false)

• debug_log Write debug information to root_dir/fortls_debug.log (default: false)

Setup source file search paths:

By default all files with the suffix F,F77,F90,F95,F03,F08,FOR,FPP (case-insensitive) in the root_dir directory, specified during initialization, and all its sub-directories are parsed and included in the project.

Directories and files can be excluded from the project by specifying their paths (relative to root_dir) in the excl_paths variable in the .fortls file. Excluded directories also exclude all sub-directories. Source files with a common suffix may also be excluded using the excl_suffixes variable.

Source file directories can also be specified manually by specifying their paths (relative to root_dir) in the source_dirs variable in the .fortls file. When source_dirs is specified directories are not added recursively, so any nested sub directories must be explicitly listed. However, root_dir does not need to be specified manually as it is always included.

Note: The previous naming convention for source file directories (mod_dirs) is still supported but has been deprecated.

Preprocessor definitions:

Preprocessor definitions can be set for each project, to improve support for Fortran files using conditional compilation, using the pp_defs variable in the .fortls file. Preprocessing is performed _only_ for files where the file extension is all caps (ie. “.F90”, “.F”, etc.). Currently, support for preprocessing is limited to variables declared in the project’s .fortls file or in the source file of interest as #include files and inheritance through USE statements are yet not supported. Variable substitution is also performed within files, but is currently limited to non-recursive cases. For example, #define PP_VAR1 PP_VAR2 will cause PP_VAR1 to be replaced with the text PP_VAR2 throughout the file, not that value of PP_VAR2.

Note: The language server will only analyze code within preprocessor conditional regions if the conditional test can be evaluated by the server or if the region is the default path (ie. a bare #else region).

{
  "source_dirs": ["subdir1", "subdir2"],
  "excl_paths": ["subdir3", "subdir1/file_to_skip.F90"],
  "excl_suffixes": ["_skip.f90"],
  "pp_defs": {"HAVE_PACKAGE": ""},
  "lowercase_intrinsics": false,
  "debug_log": false
}

Bug reports

When filing bugs please provide example code to reproduce the observed issue.

License

This project is made available under the MIT License.

Support

If you really like this package you can buy me a coffee to say thanks.