Showing preview only (1,520K chars total). Download the full file or copy to clipboard to get everything.
Repository: ycm-core/YouCompleteMe
Branch: master
Commit: 6a52780a22df
Files: 141
Total size: 1.4 MB
Directory structure:
gitextract_tkvf_s5t/
├── .coveragerc
├── .github/
│ ├── ISSUE_TEMPLATE/
│ │ ├── config.yml
│ │ └── issue.md
│ ├── PULL_REQUEST_TEMPLATE.md
│ └── workflows/
│ ├── ci.yml
│ ├── lock_old_issues.yaml
│ └── update_vim_docs.yaml
├── .gitignore
├── .gitmodules
├── .mergify.yml
├── .readme.utf-8.add
├── .vimspector.json
├── .ycm_extra_conf.py
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── COPYING.txt
├── README.md
├── autoload/
│ ├── youcompleteme/
│ │ ├── filetypes.vim
│ │ ├── finder.vim
│ │ ├── hierarchy.vim
│ │ └── symbol.vim
│ └── youcompleteme.vim
├── codecov.yml
├── doc/
│ └── youcompleteme.txt
├── install.py
├── install.sh
├── plugin/
│ └── youcompleteme.vim
├── print_todos.sh
├── python/
│ ├── test_requirements.txt
│ └── ycm/
│ ├── __init__.py
│ ├── base.py
│ ├── buffer.py
│ ├── client/
│ │ ├── __init__.py
│ │ ├── base_request.py
│ │ ├── command_request.py
│ │ ├── completer_available_request.py
│ │ ├── completion_request.py
│ │ ├── debug_info_request.py
│ │ ├── event_notification.py
│ │ ├── inlay_hints_request.py
│ │ ├── messages_request.py
│ │ ├── omni_completion_request.py
│ │ ├── resolve_completion_request.py
│ │ ├── semantic_tokens_request.py
│ │ ├── shutdown_request.py
│ │ ├── signature_help_request.py
│ │ └── ycmd_keepalive.py
│ ├── diagnostic_filter.py
│ ├── diagnostic_interface.py
│ ├── hierarchy_tree.py
│ ├── inlay_hints.py
│ ├── omni_completer.py
│ ├── paths.py
│ ├── scrolling_range.py
│ ├── semantic_highlighting.py
│ ├── signature_help.py
│ ├── syntax_parse.py
│ ├── tests/
│ │ ├── __init__.py
│ │ ├── base_test.py
│ │ ├── client/
│ │ │ ├── __init__.py
│ │ │ ├── base_request_test.py
│ │ │ ├── command_request_test.py
│ │ │ ├── completion_request_test.py
│ │ │ ├── debug_info_request_test.py
│ │ │ ├── messages_request_test.py
│ │ │ └── omni_completion_request_test.py
│ │ ├── command_test.py
│ │ ├── completion_test.py
│ │ ├── diagnostic_filter_test.py
│ │ ├── diagnostic_interface_test.py
│ │ ├── event_notification_test.py
│ │ ├── mock_utils.py
│ │ ├── omni_completer_test.py
│ │ ├── paths_test.py
│ │ ├── postcomplete_test.py
│ │ ├── signature_help_test.py
│ │ ├── syntax_parse_test.py
│ │ ├── test_utils.py
│ │ ├── testdata/
│ │ │ ├── .ycm_extra_conf.py
│ │ │ ├── cpp_syntax
│ │ │ ├── java_syntax
│ │ │ ├── php_syntax
│ │ │ ├── python_syntax
│ │ │ └── uni¢od€/
│ │ │ └── tags
│ │ ├── vimsupport_test.py
│ │ └── youcompleteme_test.py
│ ├── text_properties.py
│ ├── unsafe_thread_pool_executor.py
│ ├── vimsupport.py
│ └── youcompleteme.py
├── run_tests.py
├── test/
│ ├── .gitignore
│ ├── .vimspector.json
│ ├── Makefile
│ ├── README.md
│ ├── commands.test.vim
│ ├── completion.common.vim
│ ├── completion.test.vim
│ ├── completion_info.test.vim
│ ├── completion_noresolve.test.vim
│ ├── diagnostics.test.vim
│ ├── docker/
│ │ ├── ci/
│ │ │ ├── image/
│ │ │ │ └── Dockerfile
│ │ │ ├── push
│ │ │ └── rebuild
│ │ ├── manual/
│ │ │ ├── image/
│ │ │ │ ├── .vim/
│ │ │ │ │ └── vimrc
│ │ │ │ └── Dockerfile
│ │ │ ├── push
│ │ │ ├── rebuild
│ │ │ └── run
│ │ └── rebuild_all
│ ├── filesize.test.vim
│ ├── finder.test.vim
│ ├── fixit.test.vim
│ ├── hierarchies.test.vim
│ ├── hover.test.vim
│ ├── lib/
│ │ ├── autoload/
│ │ │ └── youcompleteme/
│ │ │ └── test/
│ │ │ ├── commands.vim
│ │ │ ├── popup.vim
│ │ │ └── setup.vim
│ │ ├── plugin/
│ │ │ ├── completion.vim
│ │ │ ├── shared.vim
│ │ │ └── util.vim
│ │ └── run_test.vim
│ ├── run_vim_tests
│ ├── signature_help.test.vim
│ ├── testdata/
│ │ ├── cpp/
│ │ │ ├── auto_include.cc
│ │ │ ├── auto_include.h
│ │ │ ├── auto_include_workaround.cc
│ │ │ ├── complete_with_sig_help.cc
│ │ │ ├── completion.cc
│ │ │ ├── finder_test.cc
│ │ │ ├── fixit.cpp
│ │ │ └── hierarchies.cc
│ │ ├── diagnostics/
│ │ │ ├── foo.cpp
│ │ │ └── foo.xml
│ │ ├── python/
│ │ │ ├── doc.py
│ │ │ └── test.py
│ │ └── vim/
│ │ └── mixed_filetype.vim
│ └── vimrc
├── tox.ini
├── update-vim-docs
└── vimrc_ycm_minimal
================================================
FILE CONTENTS
================================================
================================================
FILE: .coveragerc
================================================
[run]
plugins = covimerage
[report]
omit =
*/tests/*
*/test/*
*/third_party/*
================================================
FILE: .github/ISSUE_TEMPLATE/config.yml
================================================
blank_issues_enabled: false
contact_links:
- name: Questions and support
url: 'https://github.com/ycm-core/YouCompleteMe/tree/master?tab=readme-ov-file#help-advice-support'
about: Please ask and answer questions here.
================================================
FILE: .github/ISSUE_TEMPLATE/issue.md
================================================
---
name: Issue
about: Report a bug or suggest an enhancement
---
# Issue Prelude
**Please complete these steps and check these boxes (by putting an `x` inside
the brackets) _before_ filing your issue:**
- [ ] I have read and understood YCM's [CONTRIBUTING][cont] document.
- [ ] I have read and understood YCM's [CODE_OF_CONDUCT][code] document.
- [ ] I have read and understood YCM's [README][readme], **especially the
[Frequently Asked Questions][faq] section.**
- [ ] I have searched YCM's issue tracker to find issues similar to the one I'm
about to report and couldn't find an answer to my problem. ([Example Google
search.][search])
- [ ] If filing a bug report, I have included the output of `vim --version`.
- [ ] If filing a bug report, I have included the output of `:YcmDebugInfo`.
- [ ] If filing a bug report, I have attached the contents of the logfiles using
the `:YcmToggleLogs` command.
- [ ] If filing a bug report, I have included which OS (including specific OS
version) I am using.
- [ ] If filing a bug report, I have included a minimal test case that reproduces
my issue, using `vim -Nu /path/to/YCM/vimrc_ycm_minimal`, including what I
expected to happen and what actually happened.
- [ ] If filing a installation failure report, I have included the entire output
of `install.py` (or `cmake`/`make`/`ninja`) including its invocation
- [ ] **I understand this is an open-source project staffed by volunteers and
that any help I receive is a selfless, heartfelt _gift_ of their free time. I
know I am not entitled to anything and will be polite and courteous.**
- [ ] **I understand my issue may be closed if it becomes obvious I didn't
actually perform all of these steps.**
Thank you for adhering to this process! It ensures your issue is resolved
quickly and that neither your nor our time is needlessly wasted.
# Issue Details
> Provide a clear description of the problem, including the following key
> questions:
* What did you do?
> Include steps to reproduce here.
1. `vim -Nu /path/to/YCM/ycm_vimrc_minimal`
2. `:edit test.py`
3. Enter insert mode and type `.....`
> Include description of a minimal test case, including any actual code required
> to reproduce the issue.
> If you made changes to `vimrc_ycm_minimal`, pase them here:
```
<contents of ycm_vimrc_minimal>
```
* What did you expect to happen?
> Include description of the expected behaviour.
* What actually happened?
> Include description of the observed behaviour, including actual output,
> screenshots, etc.
# Diagnostic data
## Output of `vim --version`
```
Paste output here
```
## Output of `YcmDebugInfo`
```
Paste output here
```
## Output of `YcmDiags`
```
Paste output here
```
## Output of `git rev-parse HEAD` in YouCompleteMe installation directory
```
paste output here
```
## Contents of YCM, ycmd and completion engine logfiles
> Reproduce the issue with `vim -Nu /path/to/YCM/vimrc_ycm_minimal`, which
> enabled debug logging and other useful diagnostics. Include a link to a
> [gist][] containing all of the log files listed by `:YcmToggleLogs`.
## OS version, distribution, etc.
> Include system information here.
## Output of build/install commands
> Include link to a [gist][] containing the invocation and entire output of
> `install.py` if reporting an installation issue.
[cont]: https://github.com/ycm-core/YouCompleteMe/blob/master/CONTRIBUTING.md
[code]: https://github.com/ycm-core/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md
[readme]: https://github.com/ycm-core/YouCompleteMe/blob/master/README.md
[faq]: https://github.com/ycm-core/YouCompleteMe/wiki/FAQ
[search]: https://www.google.com/search?q=site%3Ahttps%3A%2F%2Fgithub.com%2Fycm-core%2FYouCompleteMe%2Fissues%20python%20mac
[gist]: https://gist.github.com/
================================================
FILE: .github/PULL_REQUEST_TEMPLATE.md
================================================
# PR Prelude
Thank you for working on YCM! :)
**Please complete these steps and check these boxes (by putting an `x` inside
the brackets) _before_ filing your PR:**
- [ ] I have read and understood YCM's [CONTRIBUTING][cont] document.
- [ ] I have read and understood YCM's [CODE_OF_CONDUCT][code] document.
- [ ] I have included tests for the changes in my PR. If not, I have included a
rationale for why I haven't.
- [ ] **I understand my PR may be closed if it becomes obvious I didn't
actually perform all of these steps.**
# Why this change is necessary and useful
[Please explain **in detail** why the changes in this PR are needed.]
[cont]: https://github.com/ycm-core/YouCompleteMe/blob/master/CONTRIBUTING.md
[code]: https://github.com/ycm-core/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md
================================================
FILE: .github/workflows/ci.yml
================================================
name: CI
on:
workflow_dispatch:
pull_request:
push:
branches:
- master
jobs:
python-tests:
strategy:
fail-fast: false
matrix:
runs-on: [ ubuntu-24.04, macos-14 ]
python-arch: [ 'x64' ]
include:
- runs-on: macos-14
python-arch: 'arm64'
exclude:
- runs-on: macos-14
python-arch: "x64"
env:
COVERAGE: true
name: "${{ matrix.runs-on }} - Python 3.12 ${{ matrix.python-arch }}"
runs-on: ${{ matrix.runs-on }}
steps:
- uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0
- name: Install Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
architecture: ${{ matrix.python-arch }}
- name: Run pip
run: python3 -m pip install -r python/test_requirements.txt
- name: Run tests
run: python3 run_tests.py --quiet python/ycm/tests
- name: summarise coverage
run: coverage xml
- name: Upload coverage data
uses: codecov/codecov-action@v4
with:
name: "${{ runner.os }}-3.12-${{ matrix.python-arch }}"
token: ${{ secrets.CODECOV_TOKEN }}
vim-tests:
strategy:
fail-fast: false
matrix:
vim: [ 'new', 'old' ]
arch: [ 'x86_64' ]
runs-on: ubuntu-24.04
container: 'youcompleteme/ycm-vim-${{ matrix.arch }}-py3:test'
env:
COVERAGE: true
YCM_TEST_STDOUT: true
name: "Vim tests - ${{ matrix.vim }}"
steps:
- uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0
- name: Install dependencies
run: sudo -H pip3 install --break-system-packages -r python/test_requirements.txt
- name: Install Java
uses: actions/setup-java@v4
with:
java-version: 21
distribution: 'temurin'
- name: Build ycmd
run: python3 ./install.py --force-sudo --ts-completer --clangd-completer --java-completer
- name: Run tests in old vim
# System vim should be oldest supported.
if: matrix.vim == 'old'
run: ./test/run_vim_tests --vim /usr/bin/vim
- name: Run tests in new vim
if: matrix.vim == 'new'
run: ./test/run_vim_tests
- name: Combine and summarise coverage
run: coverage combine && coverage xml
- name: Upload coverage data
uses: codecov/codecov-action@v4
with:
name: "vim-tests-${{ matrix.vim }}"
token: ${{ secrets.CODECOV_TOKEN }}
================================================
FILE: .github/workflows/lock_old_issues.yaml
================================================
name: "Lock Old Issues"
on:
schedule:
- cron: '0 0 * * *'
workflow_dispatch:
jobs:
lock:
runs-on: ubuntu-latest
steps:
- uses: dessant/lock-threads@v2
with:
github-token: ${{ github.token }}
issue-lock-inactive-days: '60'
# issue-exclude-created-before: ''
# issue-exclude-labels: ''
# issue-lock-labels: ''
# issue-lock-comment: ''
# issue-lock-reason: 'resolved'
# pr-lock-inactive-days: '365'
# pr-exclude-created-before: ''
# pr-exclude-labels: ''
# pr-lock-labels: ''
# pr-lock-comment: ''
# pr-lock-reason: 'resolved'
process-only: 'issues'
================================================
FILE: .github/workflows/update_vim_docs.yaml
================================================
name: "Update vim docs"
on:
push:
branches:
- master
paths:
- 'README.md'
workflow_dispatch:
jobs:
update-vim-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: 'Update local repo'
run: './update-vim-docs'
- name: 'Check diffs'
run: 'git diff'
- name: 'Create pull request'
uses: peter-evans/create-pull-request@v4
id: cpr
with:
token: ${{ secrets.VIMSPECTOR_UPDATE_BOT_PAT }}
push-to-fork: VimspectorUpdateBot/YouCompleteMe
commit-message: "Update vim docs"
branch: 'auto/update-vim-docs'
delete-branch: true
title: "[Auto] Update vim docs"
body: "Update the vim docs after recent changes"
labels: "auto"
- name: Check outputs
run: |
echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
================================================
FILE: .gitignore
================================================
# Compiled Object files
*.slo
*.lo
*.o
# Compiled Dynamic libraries
*.dll
*.so
*.dylib
# Compiled Static libraries
*.lai
*.la
*.a
# Python
*.py[cod]
# Installer logs
pip-log.txt
# Unit test / coverage reports
.coverage
cover/
.tox
nosetests.xml
.noseids
#Translations
*.mo
#Mr Developer
.mr.developer.cfg
# custom
ycm_core_tests
# When we use the bcp tool to copy over the parts of boost we care about, it
# also copies some cruft files we don't need; this ignores them
cpp/BoostParts/libs/*/build
cpp/BoostParts/libs/*/test
# These folders in cpp/llvm contain lots of upstream cruft we don't care
# about and would rather not have in our tree...
cpp/llvm/docs/*
cpp/llvm/tools/clang/www/*
# ... but excluding these LLVMBuild.txt files breaks the build so we need to
# explicitely include them
!LLVMBuild.txt
# Exclude auto generated vim doc tags.
doc/tags
# Coverage files
.coverage
.coverage.*
coverage.xml
.readme.utf-8.add.spl
================================================
FILE: .gitmodules
================================================
[submodule "third_party/ycmd"]
path = third_party/ycmd
url = https://github.com/ycm-core/ycmd
================================================
FILE: .mergify.yml
================================================
# https://blog.mergify.com/strict-mode-deprecation/
queue_rules:
- name: duplicated default from Automatic merge on Azure Pipelines and Reviewable
successes
queue_conditions:
- base=master
- "#approved-reviews-by>=2"
- status-success=ubuntu-24.04 - Python 3.9 x64
- status-success=macos-14 - Python 3.9 arm64
# - status-success=windows-2019 - Python 3.9 x64
# - status-success=windows-2019 - Python 3.9 x86
- status-success=Vim tests - new
- status-success=Vim tests - old
- status-success=code-review/reviewable
merge_conditions:
- status-success=ubuntu-24.04 - Python 3.9 x64
- status-success=macos-14 - Python 3.9 arm64
- status-success=windows-2019 - Python 3.9 x64
- status-success=windows-2019 - Python 3.9 x86
- status-success=Vim tests - new
- status-success=Vim tests - old
merge_method: merge
- name: duplicated default from Manual merge on Azure Pipelines and Maintainer Override
queue_conditions:
- base=master
- status-success=ubuntu-24.04 - Python 3.9 x64
- status-success=macos-14 - Python 3.9 arm64
- status-success=windows-2019 - Python 3.9 x64
- status-success=windows-2019 - Python 3.9 x86
- status-success=Vim tests - new
- status-success=Vim tests - old
- "#approved-reviews-by>=1"
- "#changes-requested-reviews-by=0"
- label="Ship It!"
merge_conditions:
- status-success=ubuntu-24.04 - Python 3.9 x64
- status-success=macos-14 - Python 3.9 arm64
- status-success=windows-2019 - Python 3.9 x64
- status-success=windows-2019 - Python 3.9 x86
- status-success=Vim tests - new
- status-success=Vim tests - old
merge_method: merge
- name: duplicated default from Manual merge on Pipelines and Maintainer Override
from owner PR
queue_conditions:
- base=master
- author=puremourning
- status-success=ubuntu-24.04 - Python 3.9 x64
- status-success=macos-14 - Python 3.9 arm64
- status-success=windows-2019 - Python 3.9 x64
- status-success=windows-2019 - Python 3.9 x86
- status-success=Vim tests - new
- status-success=Vim tests - old
- "#changes-requested-reviews-by=0"
- label="Ship It!"
merge_conditions:
- status-success=ubuntu-24.04 - Python 3.9 x64
- status-success=macos-14 - Python 3.9 arm64
- status-success=windows-2019 - Python 3.9 x64
- status-success=windows-2019 - Python 3.9 x86
- status-success=Vim tests - new
- status-success=Vim tests - old
merge_method: merge
- name: duplicated default from Merge auto pr when approved
queue_conditions:
- author=VimspectorUpdateBot
- label=auto
- base=master
- status-success=code-review/reviewable
- "#approved-reviews-by>=1"
- "#changes-requested-reviews-by=0"
merge_conditions:
- status-success=ubuntu-24.04 - Python 3.9 x64
- status-success=macos-14 - Python 3.9 arm64
- status-success=windows-2019 - Python 3.9 x64
- status-success=windows-2019 - Python 3.9 x86
- status-success=Vim tests - new
- status-success=Vim tests - old
merge_method: merge
pull_request_rules:
- name: Automatic merge on Azure Pipelines and Reviewable successes
conditions:
- base=master
- "#approved-reviews-by>=2"
- status-success=ubuntu-24.04 - Python 3.9 x64
- status-success=macos-14 - Python 3.9 arm64
# - status-success=windows-2019 - Python 3.9 x64
# - status-success=windows-2019 - Python 3.9 x86
- status-success=Vim tests - new
- status-success=Vim tests - old
- status-success=code-review/reviewable
actions: &merge-actions
comment:
message: Thanks for sending a PR!
- name: Manual merge on Azure Pipelines and Maintainer Override
conditions:
- base=master
- status-success=ubuntu-24.04 - Python 3.9 x64
- status-success=macos-14 - Python 3.9 arm64
# - status-success=windows-2019 - Python 3.9 x64
# - status-success=windows-2019 - Python 3.9 x86
- status-success=Vim tests - new
- status-success=Vim tests - old
- "#approved-reviews-by>=1"
- "#changes-requested-reviews-by=0"
- label="Ship It!"
actions:
<<: *merge-actions
- name: Manual merge on Pipelines and Maintainer Override from owner PR
conditions:
- base=master
- author=puremourning
- status-success=ubuntu-24.04 - Python 3.9 x64
- status-success=macos-14 - Python 3.9 arm64
# - status-success=windows-2019 - Python 3.9 x64
# - status-success=windows-2019 - Python 3.9 x86
- status-success=Vim tests - new
- status-success=Vim tests - old
- "#changes-requested-reviews-by=0"
- label="Ship It!"
actions:
<<: *merge-actions
- name: Merge auto pr when approved
conditions:
- author=VimspectorUpdateBot
- label=auto
- base=master
# Review
- status-success=code-review/reviewable
- "#approved-reviews-by>=1"
- "#changes-requested-reviews-by=0"
actions:
<<: *merge-actions
- name: Automatic merge on Azure Pipelines and Reviewable successes + Manual merge
on Azure Pipelines and Maintainer Override + Manual merge on Pipelines and Maintainer
Override from owner PR + Merge auto pr when approved
conditions: []
actions:
queue:
================================================
FILE: .readme.utf-8.add
================================================
AST
Autocommands
CMake
CUDA
Completers
Ctags
Ctrl
CursorHold
Doxygen
Eclim
Eclim's
FixIt
Freenode
Gitter
GoTo
Gopls
Homebrew
Homebrew
ICCF
JDK
JSON
Kotlin
LLVM
LSP
LTS
ListToggle
MSVC
MacVim
Neovim
OmniSharp
Omnisharp
Syntastic
TSServer
TypeScript
UltiSnips
VimScript
Vimspector
Vundle
WB
YCM
YCM's
YcmCompleter
YouCompleteMe
asciicast
async
autocommand
clangd
clangd's
classpath
coc
compiledb
completeopt
completers
conf
config
configuration
csharp
ctags
docstrings
echo'd
filepath
filesystem
filetype
filetypes
freenode
globbing
gopls
gradle
gvim
javadoc
jdt
js
keypress
lagginess
libclang
lightline
lsp
macOS
md
npm
omnicomplete
omnicompletion
omnifunc
omnifuncs
onType
popup
precompiled
py
quickfix
realtime
rls
statusline
sys
toolchain
unicode
unsetting
v3
vimrc
whitelist
whitelisted
whitespace
xbuild
xml
ycm
ycmd
ycmd's
================================================
FILE: .vimspector.json
================================================
{
"$schema": "https://puremourning.github.io/vimspector/schema/vimspector.schema.json",
"configurations": {
"Python: Attach To Vim": {
"variables": {
"port": "5678",
"host": "localhost"
},
"adapter": "multi-session",
"configuration": {
"request": "attach"
}
},
"python - launch pytest": {
"adapter": "debugpy",
"variables": [
{
"python": {
"shell": "/bin/bash -c 'if [ -z \"${dollar}VIRTUAL_ENV\" ]; then echo $$(which python3); else echo \"${dollar}VIRTUAL_ENV/bin/python\"; fi'"
}
},
{
"python_path": {
"shell": [
"${python}",
"${workspaceRoot}/run_tests.py",
"--dump-path"
]
}
}
],
"configuration": {
"name": "Python run test",
"type": "debugpy",
"request": "launch",
"cwd": "${workspaceRoot}",
"stopOnEntry": false,
"console": "integratedTerminal",
"justMyCode": true,
"logToFile": true,
"showReturnValue": true,
"debugOptions": [],
"module": "unittest",
"python": "${python}",
"args": [
"-v",
"${Test}"
],
"env": {
"PYTHONPATH": "${python_path}",
"LD_LIBRARY_PATH": "${workspaceRoot}/third_party/ycmd/third_party/clang/lib",
"YCM_TEST_NO_RETRY": "1"
}
}
}
}
}
================================================
FILE: .ycm_extra_conf.py
================================================
# This file is NOT licensed under the GPLv3, which is the license for the rest
# of YouCompleteMe.
#
# Here's the license text for this file:
#
# This is free and unencumbered software released into the public domain.
#
# Anyone is free to copy, modify, publish, use, compile, sell, or
# distribute this software, either in source code form or as a compiled
# binary, for any purpose, commercial or non-commercial, and by any
# means.
#
# In jurisdictions that recognize copyright laws, the author or authors
# of this software dedicate any and all copyright interest in the
# software to the public domain. We make this dedication for the benefit
# of the public at large and to the detriment of our heirs and
# successors. We intend this dedication to be an overt act of
# relinquishment in perpetuity of all present and future rights to this
# software under copyright law.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# For more information, please refer to <http://unlicense.org/>
import os.path as p
import subprocess
DIR_OF_THIS_SCRIPT = p.abspath( p.dirname( __file__ ) )
DIR_OF_THIRD_PARTY = p.join( DIR_OF_THIS_SCRIPT, 'third_party' )
def GetStandardLibraryIndexInSysPath( sys_path ):
for index, path in enumerate( sys_path ):
if p.isfile( p.join( path, 'os.py' ) ):
return index
raise RuntimeError( 'Could not find standard library path in Python path.' )
def PythonSysPath( **kwargs ):
sys_path = kwargs[ 'sys_path' ]
dependencies = [ p.join( DIR_OF_THIS_SCRIPT, 'python' ),
p.join( DIR_OF_THIRD_PARTY, 'requests-futures' ),
p.join( DIR_OF_THIRD_PARTY, 'ycmd' ),
p.join( DIR_OF_THIRD_PARTY, 'requests_deps', 'idna' ),
p.join( DIR_OF_THIRD_PARTY, 'requests_deps', 'chardet' ),
p.join( DIR_OF_THIRD_PARTY,
'requests_deps',
'urllib3',
'src' ),
p.join( DIR_OF_THIRD_PARTY, 'requests_deps', 'certifi' ),
p.join( DIR_OF_THIRD_PARTY, 'requests_deps', 'requests' ) ]
# The concurrent.futures module is part of the standard library on Python 3.
interpreter_path = kwargs[ 'interpreter_path' ]
major_version = int( subprocess.check_output( [
interpreter_path, '-c', 'import sys; print( sys.version_info[ 0 ] )' ]
).rstrip().decode( 'utf8' ) )
if major_version == 2:
dependencies.append( p.join( DIR_OF_THIRD_PARTY, 'pythonfutures' ) )
sys_path[ 0:0 ] = dependencies
sys_path.insert( GetStandardLibraryIndexInSysPath( sys_path ) + 1,
p.join( DIR_OF_THIRD_PARTY, 'python-future', 'src' ) )
return sys_path
================================================
FILE: CODE_OF_CONDUCT.md
================================================
We, the maintainers, pledge to treat all contributors with respect and require that contributors reciprocate.
The maintainers will not tolerate unwelcome, impolite, abusive or unprofessional behaviour.
At the discretion of the maintainers, users who persist in behaving in a way that is unwelcome may be subject to a ban.
This applies to all interactions related to this project and any associated projects.
================================================
FILE: CONTRIBUTING.md
================================================
Writing issue reports
=====================
### Bugs and features only
First things first: **the issue tracker is NOT for tech support**. It is for
reporting bugs and requesting features. If your issue amounts to "I can't get
YCM to work on my machine" and the reason why is obviously related to your
machine configuration and the problem would not be resolved with _reasonable_
changes to the YCM codebase, then the issue is likely to be closed.
### Where to go for help
**A good place to ask questions is the [Gitter room][gitter] or the
[ycm-users][] Google group**. Rule of thumb: if you're not sure whether your
problem is a real bug, ask on the room or the group.
Don't go to `#vim` on freenode for support. See the
[readme][help-advice-support] for further help.
### Installation problem - read the docs
**YCM compiles just fine**; [the build bots say so][build-bots]. If the bots are
green and YCM doesn't compile on your machine, then _your machine is the root
cause_. Now read the first paragraph again.
Realize that quite literally _thousands_ of people have gotten YCM to work
successfully so if you can't, it's probably because you have a peculiar
system/Vim configuration or you didn't go through the docs carefully enough.
It's very unlikely to be caused by an actual bug in YCM because someone would
have already found it and reported it.
This leads us to point #2: **make sure you have checked the docs before
reporting an issue**. The docs are extensive and cover a ton of things; there's
also an FAQ at the bottom that quite possibly addresses your problem.
For installation problems, make sure that any issue report includes the entire
output of any build or installation commands, including **the command used to
run them**.
For common issues such as "the ycmd server SHUT DOWN", please check the GitHub
Wiki.
### Other problems - check the issue tracker
Further, **search the issue tracker for similar issues** before creating a new
one. There's no point in duplication; if an existing issue addresses your
problem, please comment there instead of creating a duplicate. However, if the
issue you found is **closed as resolved** (e.g. with a PR or the original user's
problem was resolved), raise a **new issue**, because you've found a new
problem. Reference the original issue if you think that's useful information.
Please note: Closed issues which have been inactive for 60 days will be locked,
this helps to keep discussions focussed. If you believe you are still
experiencing an issue which has been closed, please raise a new issue,
completing the issue template.
If you do find a similar _open_ issue, **don't just post 'me too' or similar**
responses. This almost never helps resolve the issue, and just causes noise for
the maintainers. Only post if it will aid the maintainers in solving the issue;
if there are existing diagnostics requested in the thread, perform
them and post the results.
When replying, follow the instructions for getting the required diagnostics for
posting a new issue (see below), and add them to your response. This is likely
to help the maintainers find a fix for you, rather than have them spend time
requesting them again. To be clear, the maintainers *always* need the
diagnostics (debug info, log files, versions, etc.) even for responses on
existing issues.
You should also **search the archives of the [ycm-users][] mailing list**.
### Check your YCM version
Lastly, **make sure you are running the latest version of YCM**. The issue you
have encountered may have already been fixed. **Don't forget to recompile
ycm_core.so too** (usually by just running `install.py` again).
## Creating an issue
OK, so we've reached this far. You need to create an issue. First realize that
the time it takes to fix your issue is a multiple of how long it takes the
developer to reproduce it. The easier it is to reproduce, the quicker it'll be
fixed.
Here are the things you should do when creating an issue:
1. Most importantly, **read and complete the issue template**. The maintainers
rely on the style and structure of the issue template to quickly resolve your
issue. If you don't complete it in full, then the maintainers may elect to
ignore or simply close your issue. This isn't personal, it's just that they
are busy too.
2. **Check that your issue reproduces with a minimal configuration**. Run `vim
-Nu /path/to/YCM/vimrc_ycm_minimal` and reproduce this issue. If it doesn't
repro, then copy your ycm-specific settings into this file and try again. If
it still doesn't repro, the issue is likely with another plugin.
3. **Write a step-by-step procedure that when performed repeatedly reproduces
your issue.** If we can't reproduce the issue, then we can't fix it. It's
that simple.
4. Explain **what you expected to happen**, and **what actually happened**.
This helps us understand if it is a bug, or just a misunderstanding of the
behavior.
5. Add the output of [the `:YcmDebugInfo` command][ycm-debug-info-command]. Make
sure that when you run this, your cursor is in the file that is experiencing
the issue.
6. Reproduce your issue using `vim -Nu /path/to/YCM/vimrc_ycm_minimal`
and attach the contents of the logfiles. Use [the
`:YcmToggleLogs` command][ycm-toggle-logs-command] to directly open them in
Vim.
7. **Create a test case for your issue**. This is critical. Don't talk about how
"when I have X in my file" or similar, _create a file with X in it_ and put
the contents inside code blocks in your issue description. Try to make this
test file _as small as possible_. Don't just paste a huge, 500 line source
file you were editing and present that as a test. _Minimize_ the file so that
the problem is reproduced with the smallest possible amount of test data.
8. **Include your OS and OS version.**
9. **Include the output of `vim --version`.**
Creating good pull requests
===========================
1. **Follow the code style of the existing codebase.**
- The Python code **DOES NOT** follow PEP 8. This is not an oversight, this
is by choice. You can dislike this as much as you want, but you still need
to follow the existing style. Look at other Python files to see what the
style is.
- The C++ code has an automated formatter (`style_format.sh` that runs
`astyle`) but it's not perfect. Again, look at the other C++ files and
match the code style you see.
- Same thing for VimScript. Match the style of the existing code.
2. **Your code needs to be well written and easy to maintain**. This is of the
_utmost_ importance. Other people will have to maintain your code so don't
just throw stuff against the wall until things kinda work.
3. **Split your pull request into several smaller ones if possible.** This
makes it easier to review your changes, which means they will be merged
faster.
4. **Write tests for your code**. If you're changing the VimScript code then
you don't have to since it's hard to test that code. This is also why you
should strive to implement your change in Python if at all possible (and if
it makes sense to do so). Python is also _much_ faster than VimScript.
5. **Explain in detail why your pull request makes sense.** Ask yourself, would
this feature be helpful to others? Not just a few people, but a lot of YCM’s
users? See, good features are useful to many. If your feature is only useful
to you and _maybe_ a couple of others, then that’s not a good feature.
There is such a thing as “feature overload”. When software accumulates so
many features of which most are only useful to a handful, then that software
has become “bloated”. We don’t want that.
Requests for features that are obscure or are helpful to but a few, or are
not part of YCM's "vision" will be rejected. Yes, even if you provide a
patch that completely implements it.
Please include details on exactly what you would like to see, and why. The
why is important - it's not always clear why a feature is really useful. And
sometimes what you want can be done in a different way if the reason for the
change is known. _What goal is your change trying to accomplish?_
[build-bots]: https://dev.azure.com/YouCompleteMe/YCM/_build/latest?definitionId=1&branchName=master
[ycm-users]: https://groups.google.com/forum/?hl=en#!forum/ycm-users
[gitter]: https://gitter.im/Valloric/YouCompleteMe
[help-advice-support]: https://github.com/ycm-core/YouCompleteMe#help-advice-support
[ycm-debug-info-command]: https://github.com/ycm-core/YouCompleteMe#the-ycmdebuginfo-command
[ycm-toggle-logs-command]: https://github.com/ycm-core/YouCompleteMe#the-ycmtogglelogs-command
================================================
FILE: COPYING.txt
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
================================================
FILE: README.md
================================================
YouCompleteMe: a code-completion engine for Vim
===============================================
[](https://gitter.im/Valloric/YouCompleteMe)
[](https://dev.azure.com/YouCompleteMe/YCM/_build?definitionId=3&branchName=master)
[](https://codecov.io/gh/ycm-core/YouCompleteMe)
Help, Advice, Support
---------------------
Looking for help, advice, or support? Having problems getting YCM to work?
First carefully read the [installation instructions](#installation) for your OS.
We recommend you use the supplied `install.py` - the "full" installation guide
is for rare, advanced use cases and most users should use `install.py`.
If the server isn't starting and you're getting a "YouCompleteMe unavailable"
error, check the [Troubleshooting][wiki-troubleshooting] guide.
Next, check the [User Guide](#user-guide) section on the semantic completer that
you are using. For C/C++/Objective-C/Objective-C++/CUDA, you _must_ read [this
section](#c-family-semantic-completion).
Finally, check the [FAQ][wiki-faq].
If, after reading the installation and user guides, and checking the FAQ, you're
still having trouble, check the [contacts](#contact) section below for how to
get in touch.
Please do **NOT** go to #vim on Freenode for support. Please contact the
YouCompleteMe maintainers directly using the [contact details](#contact) below.
# Vundle
Please note that the below instructions suggest using Vundle. Currently there
are problems with Vundle, so here are some [alternative instructions](https://github.com/ycm-core/YouCompleteMe/issues/4134#issuecomment-1446235584) using Vim packages.
Contents
--------
- [Intro](#intro)
- [Installation](#installation)
- [Requirements](#requirements)
- [macOS](#macos)
- [Linux 64-bit](#linux-64-bit)
- [Windows](#windows)
- [Full Installation Guide](#full-installation-guide)
- [Quick Feature Summary](#quick-feature-summary)
- [User Guide](#user-guide)
- [General Usage](#general-usage)
- [Client-Server Architecture](#client-server-architecture)
- [Completion String Ranking](#completion-string-ranking)
- [General Semantic Completion](#general-semantic-completion)
- [Signature Help](#signature-help)
- [Semantic Highlighting](#semantic-highlighting)
- [Inlay Hints](#inlay-hints)
- [C-family Semantic Completion](#c-family-semantic-completion)
- [Java Semantic Completion](#java-semantic-completion)
- [C# Semantic Completion](#c-semantic-completion)
- [Python Semantic Completion](#python-semantic-completion)
- [Rust Semantic Completion](#rust-semantic-completion)
- [Go Semantic Completion](#go-semantic-completion)
- [JavaScript and TypeScript Semantic Completion](#javascript-and-typescript-semantic-completion)
- [Semantic Completion for Other Languages](#semantic-completion-for-other-languages)
- [LSP Configuration](#lsp-configuration)
- [Writing New Semantic Completers](#writing-new-semantic-completers)
- [Diagnostic Display](#diagnostic-display)
- [Diagnostic Highlighting Groups](#diagnostic-highlighting-groups)
- [Symbol Search](#symbol-search)
- [Type/Call Hierarchy](#typecall-hierarchy)
- [Commands](#commands)
- [YcmCompleter subcommands](#ycmcompleter-subcommands)
- [GoTo Commands](#goto-commands)
- [Semantic Information Commands](#semantic-information-commands)
- [Refactoring Commands](#refactoring-commands)
- [Miscellaneous Commands](#miscellaneous-commands)
- [Functions](#functions)
- [Autocommands](#autocommands)
- [Options](#options)
- [FAQ](#faq)
- [Contributor Code of Conduct](#contributor-code-of-conduct)
- [Contact](#contact)
- [License](#license)
- [Sponsorship](#sponsorship)
Intro
-----
YouCompleteMe is a fast, as-you-type, fuzzy-search code completion,
comprehension and refactoring engine for [Vim][].
It has several completion engines built-in and supports any protocol-compliant
Language Server, so can work with practically any language. YouCompleteMe
contains:
- an identifier-based engine that works with every programming language,
- a powerful [clangd][]-based engine that provides native semantic code
completion for C/C++/Objective-C/Objective-C++/CUDA (from now on referred to
as "the C-family languages"),
- a [Jedi][]-based completion engine for Python 2 and 3,
- an [OmniSharp-Roslyn][]-based completion engine for C#,
- a [Gopls][]-based completion engine for Go,
- a [TSServer][]-based completion engine for JavaScript and TypeScript,
- a [rust-analyzer][]-based completion engine for Rust,
- a [jdt.ls][]-based completion engine for Java.
- a [generic Language Server Protocol implementation for any language](#plugging-an-arbitrary-lsp-server)
- and an omnifunc-based completer that uses data from Vim's omnicomplete system
to provide semantic completions for many other languages (Ruby, PHP, etc.).
Here's an explanation of what happened in the last GIF demo above.
First, realize that **no keyboard shortcuts had to be pressed** to get the list
of completion candidates at any point in the demo. The user just types and the
suggestions pop up by themselves. If the user doesn't find the completion
suggestions relevant and/or just wants to type, they can do so; the completion
engine will not interfere.
When the user sees a useful completion string being offered, they press the TAB
key to accept it. This inserts the completion string. Repeated presses of the
TAB key cycle through the offered completions.
If the offered completions are not relevant enough, the user can continue typing
to further filter out unwanted completions.
A critical thing to notice is that the completion **filtering is NOT based on
the input being a string prefix of the completion** (but that works too). The
input needs to be a _[subsequence][] match_ of a completion. This is a fancy way
of saying that any input characters need to be present in a completion string in
the order in which they appear in the input. So `abc` is a subsequence of
`xaybgc`, but not of `xbyxaxxc`. After the filter, a complicated sorting system
ranks the completion strings so that the most relevant ones rise to the top of
the menu (so you usually need to press TAB just once).
**All of the above works with any programming language** because of the
identifier-based completion engine. It collects all of the identifiers in the
current file and other files you visit (and your tags files) and searches them
when you type (identifiers are put into per-filetype groups).
The demo also shows the semantic engine in use. When the user presses `.`, `->`
or `::` while typing in insert mode (for C++; different triggers are used for
other languages), the semantic engine is triggered (it can also be triggered
with a keyboard shortcut; see the rest of the docs).
The last thing that you can see in the demo is YCM's diagnostic display features
(the little red X that shows up in the left gutter; inspired by [Syntastic][])
if you are editing a C-family file. As the completer engine compiles your file
and detects warnings or errors, they will be presented in various ways. You
don't need to save your file or press any keyboard shortcut to trigger this, it
"just happens" in the background.
**And that's not all...**
YCM might be the only Vim completion engine with the correct Unicode support.
Though we do assume UTF-8 everywhere.
YCM also provides [semantic IDE-like features](#quick-feature-summary) in a
number of languages, including:
- displaying signature help (argument hints) when entering the arguments to a
function call (Vim only)
- [finding declarations, definitions, usages](#goto-commands), etc.
of identifiers, and an [interactive symbol finder](#symbol-search)
- [displaying type information](#the-gettype-subcommand) for classes,
variables, functions etc.,
- displaying documentation for methods, members, etc. in the [preview
window](#the-getdoc-subcommand), or in a
[popup next to the cursor](#the-gycm_auto_hover-option) (Vim only)
- [fixing common coding errors](#the-fixit-subcommand), like missing
semi-colons, typos, etc.,
- [semantic renaming](#the-refactorrename-subcommand) of variables across files,
- formatting code,
- removing unused imports, sorting imports, etc.
For example, here's a demo of signature help:
Below we can see YCM being able to do a few things:
- Retrieve references across files
- Go to declaration/definition
- Expand `auto` in C++
- Fix some common errors, and provide refactorings, with `FixIt`
- Not shown in the GIF are `GoToImplementation` and `GoToType`
for servers that support it.
And here's some documentation being shown in a hover popup, automatically and
manually:
Features vary by file type, so make sure to check out the [file type feature
summary](#quick-feature-summary) and the
[full list of completer subcommands](#ycmcompleter-subcommands) to
find out what's available for your favourite languages.
You'll also find that YCM has filepath completers (try typing `./` in a file)
and a completer that integrates with [UltiSnips][].
Installation
------------
### Requirements
| Runtime | Min Version | Recommended Version (full support) | Python |
|---------|-------------|------------------------------------|--------|
| Vim | 9.1.0016 | 9.1.0016 | 3.12 |
| Neovim | 0.5 | Vim 9.1.0016 | 3.12 |
#### Supported Vim Versions
Our policy is to support the Vim version that's in the latest LTS of Ubuntu.
Vim must have a [working Python 3 runtime](#supported-python-runtime).
For Neovim users, our policy is to require the latest released version.
Currently, Neovim 0.5.0 is required. Please note that some features are not
available in Neovim, and Neovim is not officially supported.
#### Supported Python runtime
YCM has two components: A server and a client. Both the server and client
require Python 3.12 or later 3.x release.
For the Vim client, Vim must be, compiled with `--enable-shared` (or
`--enable-framework` on macOS). You can check if this is working with `:py3
import sys; print( sys.version)`. It should say something like `3.12.0 (...)`.
For Neovim, you must have a python 3.12 runtime and the Neovim python
extensions. See Neovim's `:help provider-python` for how to set that up.
For the server, you must run the `install.py` script with a python 3.12 (or
later) runtime. Anaconda etc. are not supported. YCM will remember the runtime
you used to run `install.py` and will use that when launching the server, so if
you usually use anaconda, then make sure to use the full path to a real cpython3,
e.g. `/usr/bin/python3 install.py --all` etc.
Our policy is to support the python3 version that's available in the latest
Ubuntu LTS (similar to our Vim version policy). We don't increase the Python
runtime version without a reason, though. Typically, we do this when the current
python version we're using goes out of support. At that time we will typically
pick a version that will be supported for a number of years.
#### Supported Compilers
In order to provide the best possible performance and stability, ycmd has
updated its code to C++17. This requires a version bump of the minimum
supported compilers. The new requirements are:
| Compiler | Current Min |
|----------|----------------|
| GCC | 8 |
| Clang | 7 |
| MSVC | 15.7 (VS 2017) |
YCM requires CMake 3.13 or greater. If your CMake is too old, you may be able to
simply `pip install --user cmake` to get a really new version.
#### Individual completer requirements
When enabling language support for a particular language, there may be runtime
requirements, such as needing a very recent Java Development Kit for Java
support. In general, YCM is not in control of the required versions for the
downstream compilers, though we do our best to signal where we know them.
### macOS
#### Quick start, installing all completers
- Install YCM plugin via [Vundle][]
- Install CMake, MacVim and Python 3; Note that the pre-installed *macOS system*
Vim is not supported (due to it having broken Python integration).
```
$ brew install cmake python go nodejs
```
- Install mono from [Mono Project](mono-install-macos) (NOTE: on Intel Macs you
can also `brew install mono`. On arm Macs, you may require Rosetta)
- For Java support you must install a JDK, one way to do this is with Homebrew:
```
$ brew install java
$ sudo ln -sfn $(brew --prefix java)/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk
```
- Pre-installed macOS *system* Vim does not support Python 3. So you need to
install either a Vim that supports Python 3 OR [MacVim][] with
[Homebrew][brew]:
- Option 1: Installing a Vim that supports Python 3
```
brew install vim
```
- Option 2: Installing [MacVim][]
```
brew install macvim
```
- Compile YCM.
- For Intel and arm64 Macs, the bundled libclang/clangd work:
```
cd ~/.vim/bundle/YouCompleteMe
python3 install.py --all
```
- If you have troubles with finding system frameworks or C++ standard library,
try using the homebrew llvm:
```
brew install llvm
cd ~/.vim/bundle/YouCompleteMe
python3 install.py --system-libclang --all
```
And edit your vimrc to add the following line to use the Homebrew llvm's
clangd:
```viml
" Use homebrew's clangd
let g:ycm_clangd_binary_path = trim(system('brew --prefix llvm')).'/bin/clangd'
```
- For using an arbitrary LSP server, check [the relevant
section](#plugging-an-arbitrary-lsp-server)
#### Explanation for the quick start
These instructions (using `install.py`) are the quickest way to install
YouCompleteMe, however they may not work for everyone. If the following
instructions don't work for you, check out the [full installation
guide](#full-installation-guide).
A supported Vim version with Python 3 is required. [MacVim][] is a good option,
even if you only use the terminal. YCM won't work with the pre-installed Vim
from Apple as its Python support is broken. If you don't already use a Vim
that supports Python 3 or [MacVim][], install it with [Homebrew][brew]. Install
CMake as well:
brew install vim cmake
OR
brew install macvim cmake
Install YouCompleteMe with [Vundle][].
**Remember:** YCM is a plugin with a compiled component. If you **update** YCM
using Vundle and the `ycm_core` library APIs have changed (happens
rarely), YCM will notify you to recompile it. You should then rerun the install
process.
**NOTE:** If you want C-family completion, you MUST have the latest Xcode
installed along with the latest Command Line Tools (they are installed
automatically when you run `clang` for the first time, or manually by running
`xcode-select --install`)
Compiling YCM **with** semantic support for C-family languages through
**clangd**:
```
cd ~/.vim/bundle/YouCompleteMe
./install.py --clangd-completer
```
Compiling YCM **without** semantic support for C-family languages:
```
cd ~/.vim/bundle/YouCompleteMe
./install.py
```
The following additional language support options are available:
- C# support: install by downloading the [Mono macOS package][mono-install-macos]
and add `--cs-completer` when calling `install.py`.
- Go support: install [Go][go-install] and add `--go-completer` when calling
`install.py`.
- JavaScript and TypeScript support: install [Node.js 18+ and npm][npm-install] and
add `--ts-completer` when calling `install.py`.
- Rust support: add `--rust-completer` when calling `install.py`.
- Java support: install [JDK 17][jdk-install] and add
`--java-completer` when calling `install.py`.
To simply compile with everything enabled, there's a `--all` flag. So, to
install with all language features, ensure `xbuild`, `go`, `node` and `npm`
tools are installed and in your `PATH`, then simply run:
```
cd ~/.vim/bundle/YouCompleteMe
./install.py --all
```
That's it. You're done. Refer to the _User Guide_ section on how to use YCM.
Don't forget that if you want the C-family semantic completion engine to work,
you will need to provide the compilation flags for your project to YCM. It's all
in the User Guide.
YCM comes with sane defaults for its options, but you still may want to take a
look at what's available for configuration. There are a few interesting options
that are conservatively turned off by default that you may want to turn on.
### Linux 64-bit
The following assume you're using Ubuntu 24.04.
#### Quick start, installing all completers
- Install YCM plugin via [Vundle][]
- Install CMake, Vim and Python
```
apt install build-essential cmake vim-nox python3-dev
```
- Install mono-complete, go, node, java, and npm
```
apt install mono-complete golang nodejs openjdk-17-jdk openjdk-17-jre npm
```
- Compile YCM
```
cd ~/.vim/bundle/YouCompleteMe
python3 install.py --all
```
- For plugging an arbitrary LSP server, check [the relevant section](#plugging-an-arbitrary-lsp-server)
#### Explanation for the quick start
These instructions (using `install.py`) are the quickest way to install
YouCompleteMe, however they may not work for everyone. If the following
instructions don't work for you, check out the [full installation
guide](#full-installation-guide).
Make sure you have a supported version of Vim with Python 3 support and a
supported compiler. The latest LTS of Ubuntu is the minimum platform for simple
installation. For earlier releases or other distributions, you may have to do
some work to acquire the dependencies.
If your Vim version is too old, you may need to [compile Vim from
source][vim-build] (don't worry, it's easy).
Install YouCompleteMe with [Vundle][].
**Remember:** YCM is a plugin with a compiled component. If you **update** YCM
using Vundle and the `ycm_core` library APIs have changed (which happens rarely), YCM
will notify you to recompile it. You should then rerun the installation process.
Install development tools, CMake, and Python headers:
- Fedora-like distributions:
```
sudo dnf install cmake gcc-c++ make python3-devel
```
- Ubuntu LTS:
```
sudo apt install build-essential cmake3 python3-dev
```
Compiling YCM **with** semantic support for C-family languages through
**clangd**:
```
cd ~/.vim/bundle/YouCompleteMe
python3 install.py --clangd-completer
```
Compiling YCM **without** semantic support for C-family languages:
```
cd ~/.vim/bundle/YouCompleteMe
python3 install.py
```
The following additional language support options are available:
- C# support: install [Mono][mono-install-linux] and add `--cs-completer`
when calling `install.py`.
- Go support: install [Go][go-install] and add `--go-completer` when calling
`install.py`.
- JavaScript and TypeScript support: install [Node.js 18+ and npm][npm-install] and
add `--ts-completer` when calling `install.py`.
- Rust support: add `--rust-completer` when calling `install.py`.
- Java support: install [JDK 17][jdk-install] and add
`--java-completer` when calling `install.py`.
To simply compile with everything enabled, there's a `--all` flag. So, to
install with all language features, ensure `xbuild`, `go`, `node`, and `npm`
tools are installed and in your `PATH`, then simply run:
```
cd ~/.vim/bundle/YouCompleteMe
python3 install.py --all
```
That's it. You're done. Refer to the _User Guide_ section on how to use YCM.
Don't forget that if you want the C-family semantic completion engine to work,
you will need to provide the compilation flags for your project to YCM. It's all
in the User Guide.
YCM comes with sane defaults for its options, but you still may want to take a
look at what's available for configuration. There are a few interesting options
that are conservatively turned off by default that you may want to turn on.
### Windows
***NOTE***: Windows support is *deprecated* and *unmaintained*. We will do our
best to keep it working, but we no longer test it in CI and there is a high
likelihood of breakages.
#### Quick start, installing all completers
- Install YCM plugin via [Vundle][]
- Install [Visual Studio Build Tools 2019][visual-studio-download]
- Install CMake, Vim and Python
- Install go, node and npm
- Compile YCM
```
cd YouCompleteMe
python3 install.py --all
```
- Add `set encoding=utf-8` to your [vimrc][]
- For plugging an arbitrary LSP server, check [the relevant section](#plugging-an-arbitrary-lsp-server)
#### Explanation for the quick start
These instructions (using `install.py`) are the quickest way to install
YouCompleteMe, however they may not work for everyone. If the following
instructions don't work for you, check out the [full installation
guide](#full-installation-guide).
**Important:** we assume that you are using the `cmd.exe` command prompt and
that you know how to add an executable to the PATH environment variable.
Make sure you have a supported Vim version with Python 3 support. You
can check the version and which Python is supported by typing `:version` inside
Vim. Look at the features included: `+python3/dyn` for Python 3.
Take note of the Vim architecture, i.e. 32 or
64-bit. It will be important when choosing the Python installer. We recommend
using a 64-bit client. [Daily updated installers of 32-bit and 64-bit Vim with
Python 3 support][vim-win-download] are available.
Add the following line to your [vimrc][] if not already present.:
```viml
set encoding=utf-8
```
This option is required by YCM. Note that it does not prevent you from editing a
file in another encoding than UTF-8. You can do that by specifying [the `++enc`
argument][++enc] to the `:e` command.
Install YouCompleteMe with [Vundle][].
**Remember:** YCM is a plugin with a compiled component. If you **update** YCM
using Vundle and the `ycm_core` library APIs have changed (happens
rarely), YCM will notify you to recompile it. You should then rerun the install
process.
Download and install the following software:
- [Python 3][python-win-download]. Be sure to pick the version
corresponding to your Vim architecture. It is _Windows x86_ for a 32-bit Vim
and _Windows x86-64_ for a 64-bit Vim. We recommend installing Python 3.
Additionally, the version of Python you install must match up exactly with
the version of Python that Vim is looking for. Type `:version` and look at the
bottom of the page at the list of compiler flags. Look for flags that look
similar to `-DDYNAMIC_PYTHON3_DLL=\"python36.dll\"`. This indicates
that Vim is looking for Python 3.6. You'll need one or the other installed,
matching the version number exactly.
- [CMake][cmake-download]. Add CMake executable to the PATH environment
variable.
- [Build Tools for Visual Studio 2019][visual-studio-download]. During setup,
select _C++ build tools_ in _Workloads_.
Compiling YCM **with** semantic support for C-family languages through
**clangd**:
```
cd %USERPROFILE%/vimfiles/bundle/YouCompleteMe
python install.py --clangd-completer
```
Compiling YCM **without** semantic support for C-family languages:
```
cd %USERPROFILE%/vimfiles/bundle/YouCompleteMe
python install.py
```
The following additional language support options are available:
- C# support: add `--cs-completer` when calling `install.py`.
Be sure that [the build utility `msbuild` is in your PATH][add-msbuild-to-path].
- Go support: install [Go][go-install] and add `--go-completer` when calling
`install.py`.
- JavaScript and TypeScript support: install [Node.js 18+ and npm][npm-install] and
add `--ts-completer` when calling `install.py`.
- Rust support: add `--rust-completer` when calling `install.py`.
- Java support: install [JDK 17][jdk-install] and add
`--java-completer` when calling `install.py`.
To simply compile with everything enabled, there's a `--all` flag. So, to
install with all language features, ensure `msbuild`, `go`, `node` and `npm`
tools are installed and in your `PATH`, then simply run:
```
cd %USERPROFILE%/vimfiles/bundle/YouCompleteMe
python install.py --all
```
You can specify the Microsoft Visual C++ (MSVC) version using the `--msvc`
option. YCM officially supports MSVC 15 (2017), MSVC 16 (Visual Studio 2019)
and MSVC 17 (Visual Studio 17 2022).
That's it. You're done. Refer to the _User Guide_ section on how to use YCM.
Don't forget that if you want the C-family semantic completion engine to work,
you will need to provide the compilation flags for your project to YCM. It's all
in the User Guide.
YCM comes with sane defaults for its options, but you still may want to take a
look at what's available for configuration. There are a few interesting options
that are conservatively turned off by default that you may want to turn on.
### Full Installation Guide
The [full installation guide][wiki-full-install] has been moved to the wiki.
Quick Feature Summary
-----
### General (all languages)
* Super-fast identifier completer including tags files and syntax elements
* Intelligent suggestion ranking and filtering
* File and path suggestions
* Suggestions from Vim's omnifunc
* UltiSnips snippet suggestions
### C-family languages (C, C++, Objective C, Objective C++, CUDA)
* Semantic auto-completion with automatic fixes
* Signature help
* Real-time diagnostic display
* Go to include/declaration/definition (`GoTo`, etc.)
* Go to alternate file (e.g. associated header `GoToAlternateFile`)
* Find Symbol (`GoToSymbol`), with interactive search
* Document outline (`GoToDocumentOutline`), with interactive search
* View documentation comments for identifiers (`GetDoc`)
* Type information for identifiers (`GetType`)
* Automatically fix certain errors (`FixIt`)
* Perform refactoring (`FixIt`)
* Reference finding (`GoToReferences`)
* Renaming symbols (`RefactorRename <new name>`)
* Code formatting (`Format`)
* Semantic highlighting
* Inlay hints
* Type hierarchy
* Call hierarchy
### C♯
* Semantic auto-completion
* Signature help
* Real-time diagnostic display
* Go to declaration/definition (`GoTo`, etc.)
* Go to implementation (`GoToImplementation`)
* Find Symbol (`GoToSymbol`), with interactive search
* View documentation comments for identifiers (`GetDoc`)
* Type information for identifiers (`GetType`)
* Automatically fix certain errors (`FixIt`)
* Perform refactoring (`FixIt`)
* Management of OmniSharp-Roslyn server instance
* Renaming symbols (`RefactorRename <new name>`)
* Code formatting (`Format`)
### Python
* Semantic auto-completion
* Signature help
* Go to definition (`GoTo`)
* Find Symbol (`GoToSymbol`), with interactive search
* Reference finding (`GoToReferences`)
* View documentation comments for identifiers (`GetDoc`)
* Type information for identifiers (`GetType`)
* Renaming symbols (`RefactorRename <new name>`)
### Go
* Semantic auto-completion
* Signature help
* Real-time diagnostic display
* Go to declaration/definition (`GoTo`, etc.)
* Go to type definition (`GoToType`)
* Go to implementation (`GoToImplementation`)
* Document outline (`GoToDocumentOutline`), with interactive search
* Automatically fix certain errors (`FixIt`)
* Perform refactoring (`FixIt`)
* View documentation comments for identifiers (`GetDoc`)
* Type information for identifiers (`GetType`)
* Code formatting (`Format`)
* Management of `gopls` server instance
* Inlay hints
* Call hierarchy
### JavaScript and TypeScript
* Semantic auto-completion with automatic import insertion
* Signature help
* Real-time diagnostic display
* Go to definition (`GoTo`, `GoToDefinition`, and `GoToDeclaration` are
identical)
* Go to type definition (`GoToType`)
* Go to implementation (`GoToImplementation`)
* Find Symbol (`GoToSymbol`), with interactive search
* Reference finding (`GoToReferences`)
* View documentation comments for identifiers (`GetDoc`)
* Type information for identifiers (`GetType`)
* Automatically fix certain errors and perform refactoring (`FixIt`)
* Perform refactoring (`FixIt`)
* Renaming symbols (`RefactorRename <new name>`)
* Code formatting (`Format`)
* Organize imports (`OrganizeImports`)
* Management of `TSServer` server instance
* Inlay hints
* Call hierarchy
### Rust
* Semantic auto-completion
* Real-time diagnostic display
* Go to declaration/definition (`GoTo`, etc.)
* Go to implementation (`GoToImplementation`)
* Reference finding (`GoToReferences`)
* Document outline (`GoToDocumentOutline`), with interactive search
* View documentation comments for identifiers (`GetDoc`)
* Automatically fix certain errors (`FixIt`)
* Perform refactoring (`FixIt`)
* Type information for identifiers (`GetType`)
* Renaming symbols (`RefactorRename <new name>`)
* Code formatting (`Format`)
* Management of `rust-analyzer` server instance
* Semantic highlighting
* Inlay hints
* Call hierarchy
### Java
* Semantic auto-completion with automatic import insertion
* Signature help
* Real-time diagnostic display
* Go to definition (`GoTo`, `GoToDefinition`, and `GoToDeclaration` are
identical)
* Go to type definition (`GoToType`)
* Go to implementation (`GoToImplementation`)
* Find Symbol (`GoToSymbol`), with interactive search
* Reference finding (`GoToReferences`)
* Document outline (`GoToDocumentOutline`), with interactive search
* View documentation comments for identifiers (`GetDoc`)
* Type information for identifiers (`GetType`)
* Automatically fix certain errors including code generation (`FixIt`)
* Renaming symbols (`RefactorRename <new name>`)
* Code formatting (`Format`)
* Organize imports (`OrganizeImports`)
* Detection of Java projects
* Execute custom server command (`ExecuteCommand <args>`)
* Management of `jdt.ls` server instance
* Semantic highlighting
* Inlay hints
* Type hierarchy
* Call hierarchy
User Guide
----------
### General Usage
If the offered completions are too broad, keep typing characters; YCM will
continue refining the offered completions based on your input.
Filtering is "smart-case" and "smart-[diacritic][]" sensitive; if you are
typing only lowercase letters, then it's case-insensitive. If your input
contains uppercase letters, then the uppercase letters in your query must
match uppercase letters in the completion strings (the lowercase letters still
match both). On top of that, a letter with no diacritic marks will match that
letter with or without marks:
<table>
<tbody>
<tr>
<th>matches</th>
<th>foo</th>
<th>fôo</th>
<th>fOo</th>
<th>fÔo</th>
</tr>
<tr>
<th>foo</th>
<td>✔️</td>
<td>✔️</td>
<td>✔️</td>
<td>✔️</td>
</tr>
<tr>
<th>fôo</th>
<td>❌</td>
<td>✔️</td>
<td>❌</td>
<td>✔️</td>
</tr>
<tr>
<th>fOo</th>
<td>❌</td>
<td>❌</td>
<td>✔️</td>
<td>✔️</td>
</tr>
<tr>
<th>fÔo</th>
<td>❌</td>
<td>❌</td>
<td>❌</td>
<td>✔️</td>
</tr>
</tbody>
</table>
Use the TAB key to accept a completion and continue pressing TAB to cycle
through the completions. Use Shift-TAB to cycle backward. Note that if you're
using console Vim (that is, not gvim or MacVim) then it's likely that the
Shift-TAB binding will not work because the console will not pass it to Vim.
You can remap the keys; see the [Options](#options) section below.
Knowing a little bit about how YCM works internally will prevent confusion. YCM
has several completion engines: an identifier-based completer that collects all
of the identifiers in the current file and other files you visit (and your tags
files) and searches them when you type (identifiers are put into per-filetype
groups).
There are also several semantic engines in YCM. There are libclang-based and
clangd-based completers that provide semantic completion for C-family languages.
There's a Jedi-based completer for semantic completion for Python. There's also
an omnifunc-based completer that uses data from Vim's omnicomplete system to
provide semantic completions when no native completer exists for that language
in YCM.
There are also other completion engines, like the UltiSnips completer and the
filepath completer.
YCM automatically detects which completion engine would be the best in any
situation. On occasion, it queries several of them at once, merges the
outputs and presents the results to you.
### Client-Server Architecture
YCM has a client-server architecture; the Vim part of YCM is only a thin client
that talks to the [ycmd HTTP+JSON server][ycmd] that has the vast majority of
YCM logic and functionality. The server is started and stopped automatically as
you start and stop Vim.
### Completion String Ranking
The subsequence filter removes any completions that do not match the input, but
then the sorting system kicks in. It's actually very complicated and uses lots
of factors, but suffice it to say that "word boundary" (WB) subsequence
character matches are "worth" more than non-WB matches. In effect, this means
that given an input of "gua", the completion "getUserAccount" would be ranked higher
in the list than the "Fooguxa" completion (both of which are subsequence
matches). Word-boundary characters are all capital characters, characters
preceded by an underscore, and the first letter character in the completion
string.
### Signature Help
Valid signatures are displayed in a second popup menu and the current signature
is highlighted along with the current argument.
Signature help is triggered in insert mode automatically when
`g:ycm_auto_trigger` is enabled and is not supported when it is not enabled.
The signatures popup is hidden when there are no matching signatures or when you
leave insert mode. If you want to manually control when it is visible, you can
map something to `<plug>YCMToggleSignatureHelp` (see below).
For more details on this feature and a few demos, check out the
[PR that proposed it][signature-help-pr].
#### Dismiss signature help
The signature help popup sometimes gets in the way. You can toggle its
visibility with a mapping. YCM provides the "Plug" mapping
`<Plug>(YCMToggleSignatureHelp)` for this.
For example, to hide/show the signature help popup by pressing Ctrl+l in insert
mode: `imap <silent> <C-l> <Plug>(YCMToggleSignatureHelp)`.
_NOTE_: No default mapping is provided because insert mappings are very
difficult to create without breaking or overriding some existing functionality.
Ctrl-l is not a suggestion, just an example.
### Semantic highlighting
Semantic highlighting is the process where the buffer text is coloured according
to the underlying semantic type of the word, rather than classic syntax
highlighting based on regular expressions. This can be powerful additional data
that we can process very quickly.
This feature is only supported in Vim.
For example, here is a function with classic highlighting:
And here is the same function with semantic highlighting:
As you can see, the function calls, macros, etc. are correctly identified.
This can be enabled globally with `let g:ycm_enable_semantic_highlighting=1` or
per buffer, by setting `b:ycm_enable_semantic_highlighting`.
#### Customising the highlight groups
YCM uses text properties (see `:help text-prop-intro`) for semantic
highlighting. In order to customise the coloring, you can define the text
properties that are used.
If you define a text property named `YCM_HL_<token type>`, then it will be used
in place of the defaults. The `<token type>` is defined as the Language Server
Protocol semantic token type, defined in the [LSP Spec](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_semanticTokens).
Some servers also use custom values. In this case, YCM prints a warning
including the token type name that you can customise.
For example, to render `parameter` tokens using the `Normal` highlight group,
you can do this:
```viml
call prop_type_add( 'YCM_HL_parameter', { 'highlight': 'Normal' } )
```
More generally, this pattern can be useful for customising the groups:
```viml
let MY_YCM_HIGHLIGHT_GROUP = {
\ 'typeParameter': 'PreProc',
\ 'parameter': 'Normal',
\ 'variable': 'Normal',
\ 'property': 'Normal',
\ 'enumMember': 'Normal',
\ 'event': 'Special',
\ 'member': 'Normal',
\ 'method': 'Normal',
\ 'class': 'Special',
\ 'namespace': 'Special',
\ }
for tokenType in keys( MY_YCM_HIGHLIGHT_GROUP )
call prop_type_add( 'YCM_HL_' . tokenType,
\ { 'highlight': MY_YCM_HIGHLIGHT_GROUP[ tokenType ] } )
endfor
```
## Inlay hints
**NOTE**: Highly experimental feature, requiring Vim 9.0.214 or later (not
supported in NeoVim).
When `g:ycm_enable_inlay_hints` (globally) or `b:ycm_enable_inlay_hints` (for a
specific buffer) is set to `1`, then YCM will insert inlay hints as supported by
the language semantic engine.
An inlay hint is text that is rendered on the screen that is not part of the buffer and
is often used to mark up the type or name of arguments, parameters, etc. which
help the developer understand the semantics of the code.
Here are some examples:
* C
* TypeScript
* Go
### Highlight groups
By default, YCM renders the inlay hints with the `NonText` highlight group. To
override this, define the `YcmInlayHint` highlight yourself, e.g. in your
`.vimrc`:
```viml
hi link YcmInlayHint Comment
```
Similar to semantic highlighting above, you can override specific highlighting
for different inlay hint types by defining text properties named after the kind
of inlay hint, for example:
```viml
call prop_type_add( 'YCM_INLAY_Type', #{ highlight: 'Comment' } )
```
The list of inlay hint kinds can be found in `python/ycm/inlay_hints.py`
### Options
* `g:ycm_enable_inlay_hints` or `b:ycm_enable_inlay_hints` - enable/disable
globally or for local buffer
* `g:ycm_clear_inlay_hints_in_insert_mode` - set to `1` to remove all inlay
hints when entering insert mode and reinstate them when leaving insert mode
### Toggling
Inlay hints can add a lot of text to the screen and may be distracting. You can
toggle them on/off instantly, by mapping something to
`<Plug>(YCMToggleInlayHints)`, for example:
```viml
nnoremap <silent> <localleader>h <Plug>(YCMToggleInlayHints)
```
No default mapping is provided for this due to the personal nature of mappings.
### General Semantic Completion
You can use Ctrl+Space to trigger the completion suggestions anywhere, even
without a string prefix. This is useful to see which top-level functions are
available for use.
### C-family Semantic Completion
**NOTE:** YCM originally used the `libclang` based engine for C-family, but
users should migrate to clangd, as it provides more features and better
performance. Users who rely on `override_filename` in their `.ycm_extra_conf.py`
will need to stay on the old `libclang` engine. Instructions on how to stay on
the old engine are available on [the wiki][libclang-instructions].
Some of the features of clangd:
- **Project wide indexing**: Clangd has both dynamic and static index support.
The dynamic index stores up-to-date symbols coming from any files you are
currently editing, whereas static index contains project-wide symbol
information. This symbol information is used for code completion and code
navigation. Whereas libclang is limited to the current translation unit(TU).
- **Code navigation**: Clangd provides all the GoTo requests libclang provides and it
improves those using the above-mentioned index information to contain
project-wide information rather than just the current TU.
- **Rename**: Clangd can perform semantic rename operations on the current
file, whereas libclang doesn't support such functionality.
- **Code Completion**: Clangd can perform code completions at a lower latency
than libclang; also, it has information about all the symbols in your
project so it can suggest items outside your current TU and also provides
proper `#include` insertions for those items.
- **Signature help**: Clangd provides signature help so that you can see the
names and types of arguments when calling functions.
- **Format Code**: Clangd provides code formatting either for the selected
lines or the whole file, whereas libclang doesn't have such functionality.
- **Performance**: Clangd has faster re-parse and code completion times
compared to libclang.
#### Installation
On supported architectures, the `install.py` script will download a suitable
clangd (`--clangd-completer`) or libclang (`--clang-completer`) for you.
Supported architectures are:
* Linux glibc >= 2.39 (Intel, armv7-a, aarch64) - built on ubuntu 24.04
* MacOS >=10.15 (Intel, arm64)
- For Intel, compatibility per clang.llvm.org downloads
- For arm64, macOS 10.15+
* Windows (Intel) - compatibility per clang.llvm.org downloads
***clangd***:
Typically, clangd is installed by the YCM installer (either with `--all` or with
`--clangd-completer`). This downloads a pre-built `clangd` binary for your
architecture. If your OS or architecture is not supported or is too old, you can
install a compatible `clangd` and use [`g:ycm_clangd_binary_path`]() to point to
it.
***libclang***:
`libclang` can be enabled also with `--all` or `--clang-completer`. As with
`clangd`, YCM will try and download a version of `libclang` that is suitable for
your environment, but again if your environment can't be supported, you can
build or acquire `libclang` for yourself and specify it when building, as:
```
$ EXTRA_CMAKE_ARGS='-DPATH_TO_LLVM_ROOT=/path/to/your/llvm' ./install.py --clang-completer --system-libclang
```
Please note that if using custom `clangd` or `libclang` it _must_ match the
version that YCM requires. Currently YCM requires ***clang 17.0.1***.
#### Compile flags
In order to perform semantic analysis such as code completion, `GoTo`, and
diagnostics, YouCompleteMe uses `clangd`, which makes use of
clang compiler, sometimes also referred to as LLVM. Like any compiler,
clang also requires a set of compile flags in order to parse your code. Simply
put: If clang can't parse your code, YouCompleteMe can't provide semantic
analysis.
There are 2 methods that can be used to provide compile flags to clang:
#### Option 1: Use a [compilation database][compdb]
The easiest way to get YCM to compile your code is to use a compilation
database. A compilation database is usually generated by your build system
(e.g. `CMake`) and contains the compiler invocation for each compilation unit in
your project.
For information on how to generate a compilation database, see the [clang
documentation][compdb]. In short:
- If using CMake, add `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` when configuring (or
add `set( CMAKE_EXPORT_COMPILE_COMMANDS ON )` to `CMakeLists.txt`) and copy or
symlink the generated database to the root of your project.
- If using Ninja, check out the `compdb` tool (`-t compdb`) in its
[docs][ninja-compdb].
- If using GNU make, check out [compiledb][] or [Bear][].
- For other build systems, check out
[`.ycm_extra_conf.py`](#option-2-provide-the-flags-manually) below.
If no [`.ycm_extra_conf.py`](#option-2-provide-the-flags-manually) is found,
YouCompleteMe automatically tries to load a compilation database if there is
one.
YCM looks for a file named `compile_commands.json` in the directory of the
opened file or in any directory above it in the hierarchy (recursively); when
the file is found before a local `.ycm_extra_conf.py`, YouCompleteMe stops
searching the directories and lets clangd take over and handle the flags.
#### Option 2: Provide the flags manually
If you don't have a compilation database or aren't able to generate one,
you have to tell YouCompleteMe how to compile your code some other way.
Every C-family project is different. It is not possible for YCM to guess what
compiler flags to supply for your project. Fortunately, YCM provides a mechanism
for you to generate the flags for a particular file with _arbitrary complexity_.
This is achieved by requiring you to provide a Python module that implements a
trivial function that, given the file name as an argument, returns a list of
compiler flags to use to compile that file.
YCM looks for a `.ycm_extra_conf.py` file in the directory of the opened file or
in any directory above it in the hierarchy (recursively); when the file is
found, it is loaded (only once!) as a Python module. YCM calls a `Settings`
method in that module which should provide it with the information necessary to
compile the current file. You can also provide a path to a global configuration
file with the
[`g:ycm_global_ycm_extra_conf`](#the-gycm_global_ycm_extra_conf-option) option,
which will be used as a fallback. To prevent the execution of malicious code
from a file you didn't write YCM will ask you once per `.ycm_extra_conf.py` if
it is safe to load. This can be disabled and you can white-/blacklist files. See
the [`g:ycm_confirm_extra_conf`](#the-gycm_confirm_extra_conf-option) and
[`g:ycm_extra_conf_globlist`](#the-gycm_extra_conf_globlist-option) options
respectively.
This system was designed this way so that the user can perform any arbitrary
sequence of operations to produce a list of compilation flags YCM should hand
to Clang.
**NOTE**: It is highly recommended to include `-x <language>` flag to libclang.
This is so that the correct language is detected, particularly for header files.
Common values are `-x c` for C, `-x c++` for C++, `-x objc` for Objective-C, and
`-x cuda` for CUDA.
To give you an impression, if your C++ project is trivial, and your usual
compilation command is: `g++ -Wall -Wextra -Werror -o FILE.o FILE.cc`, then the
following `.ycm_extra_conf.py` is enough to get semantic analysis from
YouCompleteMe:
```python
def Settings( **kwargs ):
return {
'flags': [ '-x', 'c++', '-Wall', '-Wextra', '-Werror' ],
}
```
As you can see from the trivial example, YCM calls the `Settings` method which
returns a dictionary with a single element `'flags'`. This element is a `list`
of compiler flags to pass to libclang for the current file. The absolute path of
that file is accessible under the `filename` key of the `kwargs` dictionary.
That's it! This is actually enough for most projects, but for complex projects
it is not uncommon to integrate directly with an existing build system using the
full power of the Python language.
For a more elaborate example,
[see ycmd's own `.ycm_extra_conf.py`][ycmd_flags_example]. You should be able to
use it _as a starting point_. **Don't** just copy/paste that file somewhere and
expect things to magically work; **your project needs different flags**. Hint:
just replace the strings in the `flags` variable with compilation flags
necessary for your project. That should be enough for 99% of projects.
You could also consider using [YCM-Generator][ygen] to generate the
`ycm_extra_conf.py` file.
#### Errors during compilation
If Clang encounters errors when compiling the header files that your file
includes, then it's probably going to take a long time to get completions. When
the completion menu finally appears, it's going to have a large number of
unrelated completion strings (type/function names that are not actually
members). This is because Clang fails to build a precompiled preamble for your
file if there are any errors in the included headers and that preamble is key to
getting fast completions.
Call the `:YcmDiags` command to see if any errors or warnings were detected in
your file.
### Java Semantic Completion
#### Java Quick Start
1. Ensure that you have enabled the Java completer. See the
[installation guide](#installation) for details.
2. Create a project file (gradle or maven) file in the root directory of your
Java project, by following the instructions below.
3. (Optional) [Configure the LSP server](#lsp-configuration). The [jdt.ls
configuration options][jdtls-preferences] can be found in their codebase.
4. If you previously used Eclim or Syntastic for Java, disable them for Java.
5. Edit a Java file from your project.
#### Java Project Files
In order to provide semantic analysis, the Java completion engine requires
knowledge of your project structure. In particular, it needs to know the class
path to use, when compiling your code. Fortunately [jdt.ls][]
supports [eclipse project files][eclipse-project],
[maven projects][mvn-project] and [gradle projects][gradle-project].
**NOTE:** Our recommendation is to use either Maven or Gradle projects.
#### Diagnostic display - Syntastic
The native support for Java includes YCM's native real-time diagnostics display.
This can conflict with other diagnostics plugins like Syntastic, so when
enabling Java support, please **manually disable Syntastic Java diagnostics**.
Add the following to your `vimrc`:
```viml
let g:syntastic_java_checkers = []
```
#### Diagnostic display - Eclim
The native support for Java includes YCM's native real-time diagnostics display.
This can conflict with other diagnostics plugins like Eclim, so when enabling
Java support, please **manually disable Eclim Java diagnostics**.
Add the following to your `vimrc`:
```viml
let g:EclimFileTypeValidate = 0
```
**NOTE**: We recommend disabling Eclim entirely when editing Java with YCM's
native Java support. This can be done temporarily with `:EclimDisable`.
#### Eclipse Projects
Eclipse-style projects require two files: [.project][eclipse-dot-project] and
[.classpath][eclipse-dot-classpath].
If your project already has these files due to previously being set up within
Eclipse, then no setup is required. [jdt.ls][] should load the project just
fine (it's basically eclipse after all).
However, if not, it is possible (easy in fact) to craft them manually, though it
is not recommended. You're better off using Gradle or Maven (see below).
[A simple eclipse style project example][ycmd-eclipse-project] can be found in
the ycmd test directory. Normally all that is required is to copy these files to
the root of your project and to edit the `.classpath` to add additional
libraries, such as:
```xml
<classpathentry kind="lib" path="/path/to/external/jar" />
<classpathentry kind="lib" path="/path/to/external/java/source" />
```
It may also be necessary to change the directory in which your source files are
located (paths are relative to the .project file itself):
```xml
<classpathentry kind="src" output="target/classes" path="path/to/src/" />
```
**NOTE**: The eclipse project and classpath files are not a public interface
and it is highly recommended to use Maven or Gradle project definitions if you
don't already use Eclipse to manage your projects.
#### Maven Projects
Maven needs a file named [pom.xml][mvn-project] in the root of the project.
Once again a simple [pom.xml][ycmd-mvn-pom-xml] can be found in the ycmd source.
The format of [pom.xml][mvn-project] files is way beyond the scope of this
document, but we do recommend using the various tools that can generate them for
you, if you're not familiar with them already.
#### Gradle Projects
Gradle projects require a [build.gradle][gradle-project]. Again, there is a
[trivial example in ycmd's tests][ycmd-gradle-project].
The format of [build.gradle][gradle-project] files are way beyond the scope of
this document, but we do recommend using the various tools that can generate
them for you if you're not familiar with them already.
Some users have experienced issues with their jdt.ls when using the Groovy
language for their build.gradle. As such, try using
[Kotlin](https://github.com/ycm-core/lsp-examples#kotlin) instead.
#### Troubleshooting
If you're not getting completions or diagnostics, check the server health:
* The Java completion engine takes a while to start up and parse your project.
You should be able to see its progress in the command line, and
`:YcmDebugInfo`. Ensure that the following lines are present:
```
-- jdt.ls Java Language Server running
-- jdt.ls Java Language Server Startup Status: Ready
```
* If the above lines don't appear after a few minutes, check the jdt.ls and ycmd
log files using [`:YcmToggleLogs` ](#the-ycmtogglelogs-command). The jdt.ls
log file is called `.log` (for some reason).
If you get a message about "classpath is incomplete", then make sure you have
correctly configured the [project files](#java-project-files).
If you get messages about unresolved imports, then make sure you have
correctly configured the [project files](#java-project-files), in particular
check that the classpath is set correctly.
### C# Semantic Completion
YCM relies on [OmniSharp-Roslyn][] to provide completion and code navigation.
OmniSharp-Roslyn needs a solution file for a C# project and there are two ways
of letting YCM know about your solution files.
#### Automatically discovered solution files
YCM will scan all parent directories of the file currently being edited and look
for a file with `.sln` extension.
#### Manually specified solution files
If YCM loads `.ycm_extra_conf.py` which contains `CSharpSolutionFile` function,
YCM will try to use that to determine the solution file. This is useful when one
wants to override the default behaviour and specify a solution file that is not
in any of the parent directories of the currently edited file. Example:
```python
def CSharpSolutionFile( filepath ):
# `filepath` is the path of the file user is editing
return '/path/to/solution/file' # Can be relative to the `.ycm_extra_conf.py`
```
If the path returned by `CSharpSolutionFile` is not an actual file, YCM will
fall back to the other way of finding the file.
#### Use with .NET 6.0 and .NET SDKs
YCM ships with older version of OmniSharp-Roslyn based on Mono runtime.
It is possible to use it with .NET 6.0 and newer, but it requires manual setup.
1. Download NET 6.0 version of the OmniSharp server for your system from
[releases](https://github.com/OmniSharp/omnisharp-roslyn/releases/)
1. Set `g:ycm_roslyn_binary_path` to the unpacked executable `OmniSharp`
1. Create a solution file if one doesn't already exist, it is currently required
by YCM for internal bookkeeping
1. Run `dotnet new sln` at the root of your project
1. Run `dotnet sln add <project1.csproj> <project2.csproj> ...`
for all of your projects
1. Run `:YcmRestartServer`
### Python Semantic Completion
YCM relies on the [Jedi][] engine to provide completion and code navigation. By
default, it will pick the version of Python running the [ycmd server][ycmd] and
use its `sys.path`. While this is fine for simple projects, this needs to be
configurable when working with virtual environments or in a project with
third-party packages. The next sections explain how to do that.
#### Working with virtual environments
A common practice when working on a Python project is to install its
dependencies in a virtual environment and develop the project inside that
environment. To support this, YCM needs to know the interpreter path of the
virtual environment. You can specify it by creating a `.ycm_extra_conf.py` file
at the root of your project with the following contents:
```python
def Settings( **kwargs ):
return {
'interpreter_path': '/path/to/virtual/environment/python'
}
```
Here, `/path/to/virtual/environment/python` is the path to the Python used
by the virtual environment you are working in. Typically, the executable can be
found in the `Scripts` folder of the virtual environment directory on Windows
and in the `bin` folder on other platforms.
If you don't like having to create a `.ycm_extra_conf.py` file at the root of
your project and would prefer to specify the interpreter path with a Vim option,
read the [Configuring through Vim options](#configuring-through-vim-options)
section.
#### Working with third-party packages
Another common practice is to put the dependencies directly into the project and
add their paths to `sys.path` at runtime in order to import them. YCM needs to
be told about this path manipulation to support those dependencies. This can be
done by creating a `.ycm_extra_conf.py` file at the root of the project. This
file must define a `Settings( **kwargs )` function returning a dictionary with
the list of paths to prepend to `sys.path` under the `sys_path` key. For
instance, the following `.ycm_extra_conf.py` adds the paths
`/path/to/some/third_party/package` and `/path/to/another/third_party/package`
at the start of `sys.path`:
```python
def Settings( **kwargs ):
return {
'sys_path': [
'/path/to/some/third_party/package',
'/path/to/another/third_party/package'
]
}
```
If you would rather prepend paths to `sys.path` with a Vim option, read the
[Configuring through Vim options](#configuring-through-vim-options) section.
If you need further control on how to add paths to `sys.path`, you should define
the `PythonSysPath( **kwargs )` function in the `.ycm_extra_conf.py` file. Its
keyword arguments are `sys_path` which contains the default `sys.path`, and
`interpreter_path` which is the path to the Python interpreter. Here's a trivial
example that inserts the `/path/to/third_party/package` path at the second
position of `sys.path`:
```python
def PythonSysPath( **kwargs ):
sys_path = kwargs[ 'sys_path' ]
sys_path.insert( 1, '/path/to/third_party/package' )
return sys_path
```
A more advanced example can be found in [YCM's own
`.ycm_extra_conf.py`][ycm_flags_example].
#### Configuring through Vim options
You may find it inconvenient to have to create a `.ycm_extra_conf.py` file at the
root of each one of your projects in order to set the path to the Python
interpreter and/or add paths to `sys.path` and would prefer to be able to
configure those through Vim options. Don't worry, this is possible by using the
[`g:ycm_extra_conf_vim_data`](#the-gycm_extra_conf_vim_data-option) option and
creating a global extra configuration file. Let's take an example. Suppose that
you want to set the interpreter path with the `g:ycm_python_interpreter_path`
option and prepend paths to `sys.path` with the `g:ycm_python_sys_path` option.
Suppose also that you want to name the global extra configuration file
`global_extra_conf.py` and that you want to put it in your HOME folder. You
should then add the following lines to your vimrc:
```viml
let g:ycm_python_interpreter_path = ''
let g:ycm_python_sys_path = []
let g:ycm_extra_conf_vim_data = [
\ 'g:ycm_python_interpreter_path',
\ 'g:ycm_python_sys_path'
\]
let g:ycm_global_ycm_extra_conf = '~/global_extra_conf.py'
```
Then, create the `~/global_extra_conf.py` file with the following contents:
```python
def Settings( **kwargs ):
client_data = kwargs[ 'client_data' ]
return {
'interpreter_path': client_data[ 'g:ycm_python_interpreter_path' ],
'sys_path': client_data[ 'g:ycm_python_sys_path' ]
}
```
That's it. You are done. Note that you don't need to restart the server when
setting one of the options. YCM will automatically pick the new values.
### Rust Semantic Completion
YCM uses [rust-analyzer][] for Rust semantic completion.
NOTE: Previously, YCM used [rls][] for rust completion. This is no longer
supported, as the Rust community has decided on [rust-analyzer][] as the future
of Rust tooling.
Completions and GoTo commands within the current crate and its dependencies
should work out of the box with no additional configuration (provided that you
built YCM with the `--rust-completer` flag; see the [*Installation*
section](#installation) for details). The install script takes care of
installing [the Rust source code][rust-src], so no configuration is necessary.
`rust-analyzer` supports a myriad of options. These are configured using [LSP
configuration](#lsp-configuration), and are [documented here](https://rust-analyzer.github.io/manual.html#configuration]).
### Go Semantic Completion
Completions and GoTo commands should work out of the box (provided that you
built YCM with the `--go-completer` flag; see the [*Installation*
section](#installation) for details). The server only works for projects with
the "canonical" layout.
`gopls` also has a load of [documented options](https://github.com/golang/tools/blob/master/gopls/doc/settings.md).
You can set these in your `.ycm_extra_conf.py`. For example, to set the build tags:
```python
def Settings( **kwargs ):
if kwargs[ 'language' ] == 'go':
return {
'ls': {
'build.buildFlags': [ '-tags=debug' ] }
}
}
```
### JavaScript and TypeScript Semantic Completion
**NOTE:** YCM originally used the [Tern][] engine for JavaScript but due to
[Tern][] not being maintained anymore by its main author and the [TSServer][]
engine offering more features, YCM is moving to [TSServer][]. This won't affect
you if you were already using [Tern][] but you are encouraged to do the switch
by deleting the `third_party/ycmd/third_party/tern_runtime/node_modules`
directory in YCM folder. If you are a new user but still want to use [Tern][],
you should pass the `--js-completer` option to the `install.py` script during
installation. Further instructions on how to set up YCM with [Tern][] are
available on [the wiki][tern-instructions].
All JavaScript and TypeScript features are provided by the [TSServer][] engine,
which is included in the TypeScript SDK. To enable these features, install
[Node.js 18+ and npm][npm-install] and call the `install.py` script with the
`--ts-completer` flag.
[TSServer][] relies on [the `jsconfig.json` file][jsconfig.json] for JavaScript
and [the `tsconfig.json` file][tsconfig.json] for TypeScript to analyze your
project. Ensure the file exists at the root of your project.
To get diagnostics in JavaScript, set the `checkJs` option to `true` in your
`jsconfig.json` file:
```json
{
"compilerOptions": {
"checkJs": true
}
}
```
### Semantic Completion for Other Languages
C-family, C#, Go, Java, Python, Rust, and JavaScript/TypeScript languages are
supported natively by YouCompleteMe using the [Clang][], [OmniSharp-Roslyn][],
[Gopls][], [jdt.ls][], [Jedi][], [rust-analyzer][], and [TSServer][] engines,
respectively. Check the [installation](#installation) section for instructions
to enable these features if desired.
#### Plugging an arbitrary LSP server
Similar to other LSP clients, YCM can use an arbitrary LSP server with the help
of [`g:ycm_language_server`](#the-gycm_language_server-option) option. An
example of a value of this option would be:
```viml
let g:ycm_language_server =
\ [
\ {
\ 'name': 'yaml',
\ 'cmdline': [ '/path/to/yaml/server/yaml-language-server', '--stdio' ],
\ 'filetypes': [ 'yaml' ]
\ },
\ {
\ 'name': 'csharp',
\ 'cmdline': [ 'OmniSharp', '-lsp' ],
\ 'filetypes': [ 'csharp' ],
\ 'project_root_files': [ '*.csproj', '*.sln' ]
\ },
\ {
\ 'name': 'godot',
\ 'filetypes': [ 'gdscript' ],
\ 'port': 6008,
\ 'project_root_files': [ 'project.godot' ]
\ }
\ ]
```
Each dictionary contains the following keys: `name`, `cmdline`, `port`,
`filetypes`, `capabilities`, `project_root_files`, `additional_workspace_dirs`,
`triggerCharacters`, and `settings`. The full description of each key can be
found in the [ycmd][language_server-configuration] repository.
See [the LSP Examples](https://github.com/ycm-core/lsp-examples) project for more
examples of configuring the likes of PHP, Ruby, Kotlin, and D.
#### LSP Configuration
Many LSP servers allow some level of user configuration. YCM enables this with
the help of `.ycm_extra_conf.py` files. Here's an example of jdt.ls user
examples of configuring the likes of PHP, Ruby, Kotlin, D, and many, many more.
```python
def Settings( **kwargs ):
if kwargs[ 'language' ] == 'java':
return {
'ls': {
'java.format.onType.enabled': True
}
}
```
The `ls` key tells YCM that the dictionary should be passed to the LSP server.
For each of the LSP server's configuration, you should look up the respective
server's documentation.
Some servers request settings from arbitrary 'sections' of configuration. There
is no concept of configuration sections in Vim, so you can specify an additional
`config_sections` dictionary which maps section to a dictionary of config
required by the server. For example:
```python
def Settings( **kwargs ):
if kwargs[ 'language' ] == 'java':
return {
'ls': {
'java.format.onType.enabled': True
},
'config_sections': {
'some section': {
'some option': 'some value'
}
}
```
The sections and options/values are completely server-specific and rarely well
documented.
#### Using `omnifunc` for semantic completion
YCM will use your `omnifunc` (see `:h omnifunc` in Vim) as a source for semantic
completions if it does not have a native semantic completion engine for your
file's filetype. Vim comes with rudimentary omnifuncs for various languages like
Ruby, PHP, etc. It depends on the language.
You can get a stellar omnifunc for Ruby with [Eclim][]. Just make sure you have
the _latest_ Eclim installed and configured (this means Eclim `>= 2.2.*` and
Eclipse `>= 4.2.*`).
After installing Eclim remember to create a new Eclipse project within your
application by typing `:ProjectCreate <path-to-your-project> -n ruby` inside Vim
and don't forget to have `let g:EclimCompletionMethod = 'omnifunc'` in your
vimrc. This will make YCM and Eclim play nice; YCM will use Eclim's omnifuncs as
the data source for semantic completions and provide the auto-triggering and
subsequence-based matching (and other YCM features) on top of it.
### Writing New Semantic Completers
You have two options here: writing an `omnifunc` for Vim's omnicomplete system
that YCM will then use through its omni-completer, or a custom completer for YCM
using the [Completer API][completer-api].
Here are the differences between the two approaches:
- You have to use VimScript to write the omnifunc, but get to use Python to
write for the Completer API; this by itself should make you want to use the
API.
- The Completer API is a _much_ more powerful way to integrate with YCM and it
provides a wider set of features. For instance, you can make your Completer
query your semantic back-end in an asynchronous fashion, thus not blocking
Vim's GUI thread while your completion system is processing stuff. This is
impossible with VimScript. All of YCM's completers use the Completer API.
- Performance with the Completer API is better since Python executes faster than
VimScript.
If you want to use the `omnifunc` system, see the relevant Vim docs with `:h
complete-functions`. For the Completer API, see [the API docs][completer-api].
If you want to upstream your completer into YCM's source, you should use the
Completer API.
### Diagnostic Display
YCM will display diagnostic notifications for the C-family, C#, Go, Java,
JavaScript, Rust, and TypeScript languages. Since YCM continuously recompiles
your file as you type, you'll get notified of errors and warnings in your file
as fast as possible.
Here are the various pieces of the diagnostic UI:
- Icons show up in the Vim gutter on lines that have a diagnostic.
- Regions of text related to diagnostics are highlighted (by default, a red
wavy underline in `gvim` and a red background in `vim`).
- Moving the cursor to a line with a diagnostic echoes the diagnostic text.
- Vim's location list is automatically populated with diagnostic data (off by
default, see options).
The new diagnostics (if any) will be displayed the next time you press any key
on the keyboard. So if you stop typing and just wait for the new diagnostics to
come in, that _will not work_. You need to press some key for the GUI to update.
Having to press a key to get the updates is unfortunate, but cannot be changed
due to the way Vim internals operate; there is no way that a background task can
update Vim's GUI after it has finished running. You _have to_ press a key. This
will make YCM check for any pending diagnostics updates.
You _can_ force a full, blocking compilation cycle with the
`:YcmForceCompileAndDiagnostics` command (you may want to map that command to a
key; try putting `nnoremap <F5> :YcmForceCompileAndDiagnostics<CR>` in your
vimrc). Calling this command will force YCM to immediately recompile your file
and display any new diagnostics it encounters. Do note that recompilation with
this command may take a while and during this time the Vim GUI _will_ be
blocked.
YCM will display a short diagnostic message when you move your cursor to the
line with the error. You can get a detailed diagnostic message with the
`<leader>d` key mapping (can be changed in the options) YCM provides when your
cursor is on the line with the diagnostic.
You can also see the full diagnostic message for all the diagnostics in the
current file in Vim's `locationlist`, which can be opened with the `:lopen` and
`:lclose` commands (make sure you have set `let
g:ycm_always_populate_location_list = 1` in your vimrc). A good way to toggle
the display of the `locationlist` with a single key mapping is provided by
another (very small) Vim plugin called [ListToggle][] (which also makes it
possible to change the height of the `locationlist` window), also written by
yours truly.
#### Diagnostic Highlighting Groups
You can change the styling for the highlighting groups YCM uses. For the signs
in the Vim gutter, the relevant groups are:
- `YcmErrorSign`, which falls back to group `SyntasticErrorSign` and then
`error` if they exist
- `YcmWarningSign`, which falls back to group `SyntasticWarningSign` and then
`todo` if they exist
You can also style the line that has the warning/error with these groups:
- `YcmErrorLine`, which falls back to group `SyntasticErrorLine` if it exists
- `YcmWarningLine`, which falls back to group `SyntasticWarningLine` if it
exists
Finally, you can also style the popup for the detailed diagnostics (it is shown
if `g:ycm_show_detailed_diag_in_popup` is set) using the group `YcmErrorPopup`,
which falls back to `ErrorMsg`.
Note that the line highlighting groups only work when the
[`g:ycm_enable_diagnostic_signs`](#the-gycm_enable_diagnostic_signs-option)
option is set. If you want highlighted lines but no signs in the Vim gutter,
set the `signcolumn` option to `no` in your vimrc:
```viml
set signcolumn=no
```
The syntax groups used to highlight regions of text with errors/warnings:
- `YcmErrorSection`, which falls back to group `SyntasticError` if it exists and
then `SpellBad`
- `YcmWarningSection`, which falls back to group `SyntasticWarning` if it exists
and then `SpellCap`
Here's how you'd change the style for a group:
```viml
highlight YcmErrorLine guibg=#3f0000
```
### Symbol Search
***This feature requires Vim and is not supported in Neovim***
YCM provides a way to search for and jump to a symbol in the current project or
document when using supported languages.
You can search for symbols in the current workspace when the `GoToSymbol`
request is supported and the current document when `GoToDocumentOutline` is
supported.
Here's a quick demo:
[](https://asciinema.org/a/4JmYLAaz5hOHbZDD0hbsQpY8C)
As you can see, you can type and YCM filters down the list as you type. The
current set of matches are displayed in a popup window in the centre of the
screen and you can select an entry with the keyboard, to jump to that position.
Any matches are then added to the quickfix list.
To enable:
* `nmap <something> <Plug>(YCMFindSymbolInWorkspace)`
* `nmap <something> <Plug>(YCMFindSymbolInDocument)`
e.g.
* `nmap <leader>yfw <Plug>(YCMFindSymbolInWorkspace)`
* `nmap <leader>yfd <Plug>(YCMFindSymbolInDocument)`
When searching, YCM opens a prompt buffer at the top of the screen for the
input and puts you in insert mode. This means that you can hit `<Esc>` to go
into normal mode and use any other input commands that are supported in prompt
buffers. As you type characters, the search is updated.
Initially, results are queried from all open filetypes. You can hit `<C-f>` to
switch to just the current filetype while the popup is open.
While the popup is open, the following keys are intercepted:
* `<C-j>`, `<Down>`, `<C-n>`, `<Tab>` - select the next item
* `<C-k>`, `<Up>`, `<C-p>`, `<S-Tab>` - select the previous item
* `<PageUp>`, `<kPageUp>` - jump up one screenful of items
* `<PageDown>`, `<kPageDown>` - jump down one screenful of items
* `<Home>`, `<kHome>` - jump to first item
* `<End>`, `<kEnd>` - jump to last item
* `<CR>` - jump to the selected item
* `<C-c>` cancel/dismiss the popup
* `<C-f>` - toggle results from all file types or just the current filetype
The search is also cancelled if you leave the prompt buffer window at any time,
so you can use window commands `<C-w>...` for example.
#### Closing the popup
***NOTE***: Pressing `<Esc>` does not close the popup - you must use `Ctrl-c`
for that, or use a window command (e.g. `<Ctrl-w>j`) or the mouse to leave the
prompt buffer window.
### Type/Call Hierarchy
***This feature requires Vim and is not supported in Neovim***
**NOTE**: This feature is highly experimental and offered in the hope that it is
useful. Please help us by reporting issues and offering feedback.
YCM provides a way to view and navigate hierarchies. The following hierarchies
are supported:
* Type hierachy `<Plug>(YCMTypeHierarchy)`: Display subtypes and supertypes
of the symbol under cursor. Expand down to subtypes and up to supertypes.
* Call hierarchy `<Plug>(YCMCallHierarchy)`: Display callees and callers of
the symbol under cursor. Expand down to callers and up to callees.
Take a look at this [](https://asciinema.org/a/659925)
for brief demo.
Hierarchy UI can be initiated by mapping something to the indicated plug
mappings, for example:
```viml
nmap <leader>yth <Plug>(YCMTypeHierarchy)
nmap <leader>ych <Plug>(YCMCallHierarchy)
```
This opens a "modal" popup showing the current element in the hierarchy tree.
The current tree root is aligned to the left and child and parent nodes are
expanded to the right. Expand the tree "down" with `<Tab>` and "up" with `<S-Tab>`.
The "root" of the tree can be re-focused to the selected item with
`<S-Tab>` and further `<S-Tab>` will show the parents of the selected item. This
can take a little getting used to, but it's particularly important with multiple
inheritance where a "child" of the current root may actually have other,
invisible, parent links. `<S-Tab>` on that row will show these by setting the
display root to the selected item.
When the hierarchy is displayed, the following keys are intercepted:
* `<Tab>`: Drill into the hierarchy at the selected item: expand and show
children of the selected item.
* `<S-Tab>`: Show parents of the selected item. When applied to sub-types, this
will re-root the tree at that type, so that all parent types (are displayed).
Similar for callers.
* `<CR>`: Jump to the symbol currently selected.
* `<Down>`, `<C-n>`, `<C-j>`, `j`: Select the next item
* `<Up>`, `<C-p>`, `<C-k>`, `k`; Select the previous item
* Any other key: closes the popup without jumping to any location
**Note:** you might think the call hierarchy tree is inverted, but we think
this way round is more intuitive because this is the typical way that call
stacks are displayed (with the current function at the top, and its callers
below).
Commands
--------
### The `:YcmRestartServer` command
If the [ycmd completion server][ycmd] suddenly stops for some reason, you can
restart it with this command.
### The `:YcmForceCompileAndDiagnostics` command
Calling this command will force YCM to immediately recompile your file
and display any new diagnostics it encounters. Do note that recompilation with
this command may take a while and during this time the Vim GUI _will_ be
blocked.
You may want to map this command to a key; try putting `nnoremap <F5>
:YcmForceCompileAndDiagnostics<CR>` in your vimrc.
### The `:YcmDiags` command
Calling this command will fill Vim's `locationlist` with errors or warnings if
any were detected in your file and then open it. If a given error or warning can
be fixed by a call to `:YcmCompleter FixIt`, then ` (FixIt available)` is
appended to the error or warning text. See the `FixIt` completer subcommand for
more information.
**NOTE:** The absence of ` (FixIt available)` does not strictly imply a fix-it
is not available as not all completers are able to provide this indication. For
example, the c-sharp completer provides many fix-its but does not add this
additional indication.
The `g:ycm_open_loclist_on_ycm_diags` option can be used to prevent the location
list from opening, but still have it filled with new diagnostic data. See the
_Options_ section for details.
### The `:YcmShowDetailedDiagnostic` command
This command shows the full diagnostic text when the user's cursor is on the
line with the diagnostic.
An options argument can be passed. If the argument is `popup` the diagnostic
text will be displayed in a popup at the cursor position.
If you prefer the detailed diagnostic to always be shown in a popup, then
`let g:ycm_show_detailed_diag_in_popup=1`.
### The `:YcmDebugInfo` command
This will print out various debug information for the current file. Useful to
see what compile commands will be used for the file if you're using the semantic
completion engine.
### The `:YcmToggleLogs` command
This command presents the list of logfiles created by YCM, the [ycmd
server][ycmd], and the semantic engine server for the current filetype, if any.
One of these logfiles can be opened in the editor (or closed if already open) by
entering the corresponding number or by clicking on it with the mouse.
Additionally, this command can take the logfile names as arguments. Use the
`<TAB>` key (or any other key defined by the `wildchar` option) to complete the
arguments or to cycle through them (depending on the value of the `wildmode`
option). Each logfile given as an argument is directly opened (or closed if
already open) in the editor. Only for debugging purposes.
### The `:YcmCompleter` command
This command gives access to a number of additional [IDE-like
features](#quick-feature-summary) in YCM, for things like semantic GoTo, type
information, FixIt, and refactoring.
This command accepts a range that can either be specified through a selection in
one of Vim's visual modes (see `:h visual-use`) or on the command line. For
instance, `:2,5YcmCompleter` will apply the command from line 2 to line 5. This
is useful for [the `Format` subcommand](#the-format-subcommand).
Call `YcmCompleter` without further arguments for a list of the commands you can
call for the current completer.
See the [file type feature summary](#quick-feature-summary) for an overview of
the features available for each file type. See the _YcmCompleter subcommands_
section for more information on the available subcommands and their usage.
Some commands, like `Format` accept a range, like `:%YcmCompleter Format`.
Some commands like `GetDoc` and the various `GoTo` commands respect modifiers,
like `:rightbelow YcmCompleter GetDoc`, `:vertical YcmCompleter GoTo`.
YcmCompleter Subcommands
------------------------
**NOTE:** See the docs for the `YcmCompleter` command before tackling this
section.
The invoked subcommand is automatically routed to the currently active semantic
completer, so `:YcmCompleter GoToDefinition` will invoke the `GoToDefinition`
subcommand on the Python semantic completer if the currently active file is a
Python one and on the Clang completer if the currently active file is a C-family
language one.
You may also want to map the subcommands to something less verbose; for
instance, `nnoremap <leader>jd :YcmCompleter GoTo<CR>`
maps the `<leader>jd` sequence to the longer subcommand invocation.
### GoTo Commands
These commands are useful for jumping around and exploring code. When moving
the cursor, the subcommands add entries to Vim's `jumplist` so you can use
`CTRL-O` to jump back to where you were before invoking the command (and
`CTRL-I` to jump forward; see `:h jumplist` for details). If there is more
than one destination, the quickfix list (see `:h quickfix`) is populated with
the available locations and opened to the full width at the bottom of the screen.
You can change this behavior by using [the `YcmQuickFixOpened`
autocommand](#the-ycmquickfixopened-autocommand).
#### The `GoToInclude` subcommand
Looks up the current line for a header and jumps to it.
Supported in filetypes: `c, cpp, objc, objcpp, cuda`
#### The `GoToAlternateFile` subcommand
Jump to the associated file, as defined by the language server. Typically this
will jump you to the associated header file for a C or C++ translation unit.
Supported in filetypes: `c, cpp, objc, objcpp, cuda` (clangd only)
#### The `GoToDeclaration` subcommand
Looks up the symbol under the cursor and jumps to its declaration.
Supported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript,
python, rust, typescript`
#### The `GoToDefinition` subcommand
Looks up the symbol under the cursor and jumps to its definition.
**NOTE:** For C-family languages **this only works in certain situations**,
namely when the definition of the symbol is in the current translation unit. A
translation unit consists of the file you are editing and all the files you are
including with `#include` directives (directly or indirectly) in that file.
Supported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript,
python, rust, typescript`
#### The `GoTo` subcommand
This command tries to perform the "most sensible" GoTo operation it can.
Currently, this means that it tries to look up the symbol under the cursor and
jumps to its definition if possible; if the definition is not accessible from
the current translation unit, jumps to the symbol's declaration. For
C-family languages, it first tries to look up the current line for a header and
jump to it. For C#, implementations are also considered and preferred.
Supported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript,
python, rust, typescript`
#### The `GoToImprecise` subcommand
WARNING: This command trades correctness for speed!
Same as the `GoTo` command except that it doesn't recompile the file with
libclang before looking up nodes in the AST. This can be very useful when you're
editing files that take time to compile but you know that you haven't made any
changes since the last parse that would lead to incorrect jumps. When you're
just browsing around your codebase, this command can spare you quite a bit of
latency.
Supported in filetypes: `c, cpp, objc, objcpp, cuda`
#### The `GoToSymbol <symbol query>` subcommand
Finds the definition of all symbols matching a specified string. Note that this
does not use any sort of smart/fuzzy matching. However, an [interactive symbol
search](#symbol-search) is also available.
Supported in filetypes: `c, cpp, objc, objcpp, cuda, cs, java, javascript, python, typescript`
#### The `GoToReferences` subcommand
This command attempts to find all of the references within the project to the
identifier under the cursor and populates the quickfix list with those
locations.
Supported in filetypes: `c, cpp, objc, objcpp, cuda, java, javascript, python, typescript, rust`
#### The `GoToImplementation` subcommand
Looks up the symbol under the cursor and jumps to its implementation (i.e.
non-interface). If there are multiple implementations, instead provides a list
of implementations to choose from.
Supported in filetypes: `cs, go, java, rust, typescript, javascript`
#### The `GoToImplementationElseDeclaration` subcommand
Looks up the symbol under the cursor and jumps to its implementation if one,
else jump to its declaration. If there are multiple implementations, instead
provides a list of implementations to choose from.
Supported in filetypes: `cs`
#### The `GoToType` subcommand
Looks up the symbol under the cursor and jumps to the definition of its type
e.g. if the symbol is an object, go to the definition of its class.
Supported in filetypes: `go, java, javascript, typescript`
#### The `GoToDocumentOutline` subcommand
Provides a list of symbols in the current document, in the quickfix list. See also
[interactive symbol search](#symbol-search).
Supported in filetypes: `c, cpp, objc, objcpp, cuda, go, java, rust`
#### The `GoToCallers` and `GoToCallees` subcommands
Note: A much more powerful call and type hierarchy can be viewd interactively.
See [interactive type and call hierarchy](#interactive-type-and-call-hierarchy).
Populate the quickfix list with the callers, or callees respectively, of the
function associated with the current cursor position. The semantics of this
differ depending on the filetype and language server.
Only supported for LSP servers that provide the `callHierarchyProvider`
capability.
### Semantic Information Commands
These commands are useful for finding static information about the code, such
as the types of variables, viewing declarations, and documentation strings.
#### The `GetType` subcommand
Echos the type of the variable or method under the cursor, and where it differs,
the derived type.
For example:
```c++
std::string s;
```
Invoking this command on `s` returns `std::string => std::basic_string<char>`
**NOTE:** Causes re-parsing of the current translation unit.
Supported in filetypes: `c, cpp, objc, objcpp, cuda, java, javascript,
go, python, typescript, rust`
#### The `GetTypeImprecise` subcommand
WARNING: This command trades correctness for speed!
Same as the `GetType` command except that it doesn't recompile the file with
libclang before looking up nodes in the AST. This can be very useful when you're
editing files that take time to compile but you know that you haven't made any
changes since the last parse that would lead to incorrect type. When you're
just browsing around your codebase, this command can spare you quite a bit of
latency.
Supported in filetypes: `c, cpp, objc, objcpp, cuda`
#### The `GetParent` subcommand
Echos the semantic parent of the point under the cursor.
The semantic parent is the item that semantically contains the given position.
For example:
```c++
class C {
void f();
};
void C::f() {
}
```
In the out-of-line definition of `C::f`, the semantic parent is the class `C`,
of which this function is a member.
In the example above, both declarations of `C::f` have `C` as their semantic
context, while the lexical context of the first `C::f` is `C` and the lexical
context of the second `C::f` is the translation unit.
For global declarations, the semantic parent is the translation unit.
**NOTE:** Causes re-parsing of the current translation unit.
Supported in filetypes: `c, cpp, objc, objcpp, cuda`
#### The `GetDoc` subcommand
Displays the preview window populated with quick info about the identifier
under the cursor. Depending on the file type, this includes things like:
* The type or declaration of identifier,
* Doxygen/javadoc comments,
* Python docstrings,
* etc.
The documentation is opened in the preview window, and options like
`previewheight` are respected. If you would like to customise the height and
position of this window, we suggest a custom command that:
* Sets `previewheight` temporarily
* Runs the `GetDoc` command with supplied modifiers
* Restores `previewheight`.
For example:
```viml
command -count ShowDocWithSize
\ let g:ph=&previewheight
\ <bar> set previewheight=<count>
\ <bar> <mods> YcmCompleter GetDoc
\ <bar> let &previewheight=g:ph
```
You can then use something like `:botright vertical 80ShowDocWithSize`. Here's an
example of that: https://asciinema.org/a/hE6Pi1gU6omBShwFna8iwGEe9
Supported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript,
python, typescript, rust`
#### The `GetDocImprecise` subcommand
WARNING: This command trades correctness for speed!
Same as the `GetDoc` command except that it doesn't recompile the file with
libclang before looking up nodes in the AST. This can be very useful when you're
editing files that take long to compile but you know that you haven't made any
changes since the last parse that would lead to incorrect docs. When you're
just browsing around your codebase, this command can spare you quite a bit of
latency.
Supported in filetypes: `c, cpp, objc, objcpp, cuda`
### Refactoring Commands
These commands make changes to your source code in order to perform refactoring
or code correction. YouCompleteMe does not perform any action which cannot be
undone, and never saves or writes files to the disk.
#### The `FixIt` subcommand
Where available, attempts to make changes to the buffer to correct diagnostics,
or perform refactoring, on the current line or selection. Where multiple
suggestions are available (such as when there are multiple ways to resolve a
given warning, or where multiple diagnostics are reported for the current line,
or multiple refactoring tweaks are available), the options are presented and
one can be selected.
Completers that provide diagnostics may also provide trivial modifications to
the source in order to correct the diagnostic. Examples include syntax errors
such as missing trailing semi-colons, spurious characters, or other errors which
the semantic engine can deterministically suggest corrections. A small demo
presenting how diagnostics can be fixed with clangd:
Completers (LSPs) may also provide refactoring tweaks, which may be available
even when no diagnostic is presented for the current line. These include
function extraction, variable extraction, `switch` population, constructor
generation, ... The tweaks work for a selection as well. Consult your LSP for
available refactorings. A demonstration of refactoring capabilities with clangd:
If no fix-it is available for the current line, or there is no diagnostic on the
current line, this command has no effect on the current buffer. If any
modifications are made, the number of changes made to the buffer is echo'd and
the user may use the editor's undo command to revert.
When a diagnostic is available, and `g:ycm_echo_current_diagnostic` is enabled,
then the text ` (FixIt)` is appended to the echo'd diagnostic when the
completer is able to add this indication. The text ` (FixIt available)` is
also appended to the diagnostic text in the output of the `:YcmDiags` command
for any diagnostics with available fix-its (where the completer can provide this
indication).
**NOTE:** Causes re-parsing of the current translation unit.
Supported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript,
rust, typescript`
#### The `RefactorRename <new name>` subcommand
In supported file types, this command attempts to perform a semantic rename of
the identifier under the cursor. This includes renaming declarations,
definitions, and usages of the identifier, or any other language-appropriate
action. The specific behavior is defined by the semantic engine in use.
Similar to `FixIt`, this command applies automatic modifications to your source
files. Rename operations may involve changes to multiple files, which may or may
not be open in Vim buffers at the time. YouCompleteMe handles all of this for
you. The behavior is described in [the following section](#multi-file-refactor).
Supported in filetypes: `c, cpp, objc, objcpp, cuda, java, javascript, python, typescript, rust, cs`
#### Python refactorings
The following additional commands are supported for Python:
* `RefactorInline`
* `RefactorExtractVariable`
* `RefactorExtractFunction`
See the [jedi docs][jedi-refactor-doc] for what they do.
Supported in filetypes: `python`
#### Multi-file Refactor
When a Refactor or FixIt command touches multiple files, YouCompleteMe attempts
to apply those modifications to any existing open, visible buffer in the current
tab. If no such buffer can be found, YouCompleteMe opens the file in a new
small horizontal split at the top of the current window, applies the change,
and then *hides* the window. **NOTE:** The buffer remains open, and must be
manually saved. A confirmation dialog is opened prior to doing this to remind
you that this is about to happen.
Once the modifications have been made, the quickfix list (see `:help quickfix`)
is populated with the locations of all modifications. This can be used to review
all automatic changes made by using `:copen`. Typically, use the `CTRL-W
<enter>` combination to open the selected file in a new split. It is possible to
customize how the quickfix window is opened by using [the `YcmQuickFixOpened`
autocommand](#the-ycmquickfixopened-autocommand).
The buffers are *not* saved automatically. That is, you must save the modified
buffers manually after reviewing the changes from the quickfix list. Changes
can be undone using Vim's powerful undo features (see `:help undo`). Note
that Vim's undo is per-buffer, so to undo all changes, the undo commands must
be applied in each modified buffer separately.
**NOTE:** While applying modifications, Vim may find files that are already
open and have a swap file. The command is aborted if you select Abort or Quit in
any such prompts. This leaves the Refactor operation partially complete and must
be manually corrected using Vim's undo features. The quickfix list is *not*
populated in this case. Inspect `:buffers` or equivalent (see `:help buffers`)
to see the buffers that were opened by the command.
#### The `Format` subcommand
This command formats the whole buffer or some part of it according to the value
of the Vim options `shiftwidth` and `expandtab` (see `:h 'sw'` and `:h et`
respectively). To format a specific part of your document, you can either select
it in one of Vim's visual modes (see `:h visual-use`) and run the command or
directly enter the range on the command line, e.g. `:2,5YcmCompleter Format` to
format it from line 2 to line 5.
Supported in filetypes: `c, cpp, objc, objcpp, cuda, java, javascript, go, typescript, rust, cs`
#### The `OrganizeImports` subcommand
This command removes unused imports and sorts imports in the current file. It
can also group imports from the same module in TypeScript and resolve imports
in Java.
Supported in filetypes: `java, javascript, typescript`
### Miscellaneous Commands
These commands are for general administration, rather than IDE-like features.
They cover things like the semantic engine server instance and compilation
flags.
#### The `ExecuteCommand <args>` subcommand
Some LSP completers (currently only Java completers) support executing
server-specific commands. Consult the [jdt.ls][] documentation to find out
what commands are supported and which arguments are expected.
The support for `ExecuteCommand` was implemented to support plugins like
[Vimspector][] to debug java, but isn't limited to that specific use case.
#### The `RestartServer` subcommand
Restarts the downstream semantic engine server for those semantic engines that
work as separate servers that YCM talks to.
Supported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript, rust, typescript`
#### The `ReloadSolution` subcommand
Instruct the Omnisharp-Roslyn server to clear its cache and reload all files
from the disk. This is useful when files are added, removed, or renamed in the
solution, files are changed outside of Vim, or whenever Omnisharp-Roslyn cache
is out-of-sync.
Supported in filetypes: `cs`
Functions
--------
### The `youcompleteme#GetErrorCount` function
Get the number of YCM Diagnostic errors. If no errors are present, this function
returns 0.
For example:
```viml
call youcompleteme#GetErrorCount()
```
Both this function and `youcompleteme#GetWarningCount` can be useful when
integrating YCM with other Vim plugins. For example, a [lightline][] user could
add a diagnostics section to their statusline which would display the number of
errors and warnings.
### The `youcompleteme#GetWarningCount` function
Get the number of YCM Diagnostic warnings. If no warnings are present, this
function returns 0.
For example:
```viml
call youcompleteme#GetWarningCount()
```
### The `youcompleteme#GetCommandResponse( ... )` function
Run a [completer subcommand](#ycmcompleter-subcommands) and return the result as
a string. This can be useful for example to display the `GetDoc` output in a
popup window, e.g.:
```viml
let s:ycm_hover_popup = -1
function s:Hover()
let response = youcompleteme#GetCommandResponse( 'GetDoc' )
if response == ''
return
endif
call popup_hide( s:ycm_hover_popup )
let s:ycm_hover_popup = popup_atcursor( balloon_split( response ), {} )
endfunction
" CursorHold triggers in normal mode after a delay
autocmd CursorHold * call s:Hover()
" Or, if you prefer, a mapping:
nnoremap <silent> <leader>D :call <SID>Hover()<CR>
```
**NOTE**: This is only an example, for real hover support, see
[`g:ycm_auto_hover`](#the-gycm_auto_hover-option).
If the completer subcommand result is not a string (for example, it's a FixIt or
a Location), or if the completer subcommand raises an error, an empty string is
returned, so that calling code does not have to check for complex error
conditions.
The arguments to the function are the same as the arguments to the
`:YcmCompleter` ex command, e.g. the name of the subcommand, followed by any
additional subcommand arguments. As with the `YcmCompleter` command, if the
first argument is `ft=<filetype>` the request is targeted at the specified
filetype completer. This is an advanced usage and not necessary in most cases.
NOTE: The request is run synchronously and blocks Vim until the response is
received, so we do not recommend running this as part of an autocommand that
triggers frequently.
### The `youcompleteme#GetCommandResponseAsync( callback, ... )` function
This works exactly like `youcompleteme#GetCommandResponse`, except that instead
of returning the result, you supply a `callback` argument. This argument must be
a `FuncRef` to a function taking a single argument `response`. This callback
will be called with the command response at some point later, or immediately.
As with `youcompleteme#GetCommandResponse()`, this function will call the
callback with `''` (an empty string) if the request is not sent, or if there was
some sort of error.
Here's an example that's similar to the one above:
```viml
let s:ycm_hover_popup = -1
function! s:ShowDataPopup( response ) abort
if response == ''
return
endif
call popup_hide( s:ycm_hover_popup )
let s:ycm_hover_popup = popup_atcursor( balloon_split( response ), {} )
endfunction
function! s:GetData() abort
call youcompleteme#GetCommandResponseAsync(
\ function( 's:ShowDataPopup' ),
\ 'GetDoc' )
endfunction
autocommand CursorHold * call s:GetData()
```
Again, see [`g:ycm_auto_hover`](#the-gycm_auto_hover-option) for proper hover
support.
**NOTE**: The callback may be called immediately, in the stack frame that called
this function.
**NOTE**: Only one command request can be outstanding at once. Attempting to
request a second response while the first is outstanding will result in the
second callback being immediately called with `''`.
Autocommands
------------
### The `YcmLocationOpened` autocommand
This `User` autocommand is fired when YCM opens the location list window in
response to the `YcmDiags` command. By default, the location list window is
opened to the bottom of the current window and its height is set to fit all
entries. This behavior can be overridden by using the `YcmLocationOpened`
autocommand which is triggered while the cursor is in the location list window.
For instance:
```viml
function! s:CustomizeYcmLocationWindow()
" Move the window to the top of the screen.
wincmd K
" Set the window height to 5.
5wincmd _
" Switch back to the working window.
wincmd p
endfunction
autocmd User YcmLocationOpened call s:CustomizeYcmLocationWindow()
```
### The `YcmQuickFixOpened` autocommand
This `User` autocommand is fired when YCM opens the quickfix window in response
to the `GoTo*` and `RefactorRename` subcommands. By default, the quickfix window
is opened to full width at the bottom of the screen and its height is set to fit
all entries. This behavior can be overridden by using the `YcmQuickFixOpened`
autocommand which is triggered while the cursor is in the quickfix window. For
instance:
```viml
function! s:CustomizeYcmQuickFixWindow()
" Move the window to the top of the screen.
wincmd K
" Set the window height to 5.
5wincmd _
endfunction
autocmd User YcmQuickFixOpened call s:CustomizeYcmQuickFixWindow()
```
Options
-------
All options have reasonable defaults so if the plug-in works after installation
you don't need to change any options. These options can be configured in your
[vimrc script][vimrc] by including a line like this:
```viml
let g:ycm_min_num_of_chars_for_completion = 1
```
Note that after changing an option in your [vimrc script][vimrc] you have to
restart [ycmd][] with the `:YcmRestartServer` command for the changes to take
effect.
### The `g:ycm_min_num_of_chars_for_completion` option
This option controls the number of characters the user needs to type before
identifier-based completion suggestions are triggered. For example, if the
option is set to `2`, then when the user types a second alphanumeric character
after a whitespace character, completion suggestions will be triggered. This
option is NOT used for semantic completion.
Setting this option to a high number like `99` effectively turns off the
identifier completion engine and just leaves the semantic engine.
Default: `2`
```viml
let g:ycm_min_num_of_chars_for_completion = 2
```
### The `g:ycm_min_num_identifier_candidate_chars` option
This option controls the minimum number of characters that a completion
candidate coming from the identifier completer must have to be shown in the
popup menu.
A special value of `0` means there is no limit.
**NOTE:** This option only applies to the identifier completer; it has no effect
on the various semantic completers.
Default: `0`
```viml
let g:ycm_min_num_identifier_candidate_chars = 0
```
### The `g:ycm_max_num_candidates` option
This option controls the maximum number of semantic completion suggestions shown
in the completion menu. This only applies to suggestions from semantic
completion engines; see [the `g:ycm_max_identifier_candidates`
option](#the-gycm_max_num_identifier_candidates-option) to limit the number of
suggestions from the identifier-based engine.
A special value of `0` means there is no limit.
**NOTE:** Setting this option to `0` or to a value greater than `100` is not
recommended as it will slow down completion when there is a very large number
of suggestions.
Default: `50`
```viml
let g:ycm_max_num_candidates = 50
```
### The `g:ycm_max_num_candidates_to_detail` option
Some completion engines require completion candidates to be 'resolved' in order
to get detailed info such as inline documentation, method signatures, etc. This
information is displayed by YCM in the preview window, or if `completeopt`
contains `popup`, in the info popup next to the completion menu.
By default, if the info popup is in use, and there are more than 10 candidates,
YCM will defer resolving candidates until they are selected in the completion
menu. Otherwise, YCM must resolve the details upfront, which can be costly.
If neither `popup` nor `preview` are in `completeopt`, YCM disables resolving
altogether as the information would not be displayed.
This setting can be used to override these defaults and controls the number of
completion candidates that should be resolved upfront. Typically users do not
need to change this, as YCM will work out an appropriate value based on your
`completeopt` and `g:ycm_add_preview_to_completeopt` settings. However, you may
override this calculation by setting this value to a number:
* `-1` - Resolve all candidates upfront
* `0` - Never resolve any candidates upfront.
* `> 0` - Resolve up to this many candidates upfront. If the number of
candidates is greater than this value, no candidates are resolved.
In the latter two cases, if `completeopt` contains `popup`, then candidates are
resolved on demand asynchronously.
Default:
* `0` if neither `popup` nor `preview` are in `completeopt`.
* `10` if `popup` is in completeopt.
* `-1` if `preview` is in completeopt.
Example:
```viml
let g:ycm_max_num_candidates_to_detail = 0
```
### The `g:ycm_max_num_identifier_candidates` option
This option controls the maximum number of completion suggestions from the
identifier-based engine shown in the completion menu.
A special value of `0` means there is no limit.
**NOTE:** Setting this option to `0` or to a value greater than `100` is not
recommended as it will slow down completion when there is a very large number
of suggestions.
Default: `10`
```viml
let g:ycm_max_num_identifier_candidates = 10
```
### The `g:ycm_auto_trigger` option
When set to `0`, this option turns off YCM's identifier completer (the
as-you-type popup) _and_ the semantic triggers (the popup you'd get after typing
`.` or `->` in say C++). You can still force semantic completion with the
`<C-Space>` shortcut.
If you want to just turn off the identifier completer but keep the semantic
triggers, you should set `g:ycm_min_num_of_chars_for_completion` to a high
number like `99`.
When `g:ycm_auto_trigger` is `0`, YCM sets the `completefunc`, so that you can
manually trigger normal completion using `C-x C-u`.
If you want to map something else to trigger completion, such as `C-d`,
then you can map it to `<plug>(YCMComplete)`. For example:
```viml
let g:ycm_auto_trigger = 0
imap <c-d> <plug>(YCMComplete)
```
NOTE: It's not possible to map one of the keys in
`g:ycm_key_list_select_completion` (or similar) to `<plug>(YCMComplete)`. In
practice that means that you can't use `<Tab>` for this.
Default: `1`
```viml
let g:ycm_auto_trigger = 1
```
### The `g:ycm_filetype_whitelist` option
This option controls for which Vim filetypes (see `:h filetype`) should YCM be
turned on. The option value should be a Vim dictionary with keys being filetype
strings (like `python`, `cpp`, etc.) and values being unimportant (the
dictionary is used like a hash set, meaning that only the keys matter).
The `*` key is special and matches all filetypes. By default, the whitelist
contains only this `*` key.
YCM also has a `g:ycm_filetype_blacklist` option that lists filetypes for which
YCM shouldn't be turned on. YCM will work only in filetypes that both the
whitelist and the blacklist allow (the blacklist "allows" a filetype by _not_
having it as a key).
For example, let's assume you want YCM to work in files with the `cpp` filetype.
The filetype should then be present in the whitelist either directly (`cpp` key
in the whitelist) or indirectly through the special `*` key. It should _not_ be
present in the blacklist.
Filetypes that are blocked by either of the lists will be completely ignored
by YCM, meaning that neither the identifier-based completion engine nor the
semantic engine will operate in them.
You can get the filetype of the current file in Vim with `:set ft?`.
Default: `{'*': 1}`
```viml
let g:ycm_filetype_whitelist = {'*': 1}
```
** Completion in buffers with no filetype **
There is one exception to the above rule. YCM supports completion in buffers
with no filetype set, but this must be _explicitly_ whitelisted. To identify
buffers with no filetype, we use the `ycm_nofiletype` pseudo-filetype. To enable
completion in buffers with no filetype, set:
```viml
let g:ycm_filetype_whitelist = {
\ '*': 1,
\ 'ycm_nofiletype': 1
\ }
```
### The `g:ycm_filetype_blacklist` option
This option controls for which Vim filetypes (see `:h filetype`) should YCM be
turned off. The option value should be a Vim dictionary with keys being filetype
strings (like `python`, `cpp`, etc.) and values being unimportant (the
dictionary is used like a hash set, meaning that only the keys matter).
See the `g:ycm_filetype_whitelist` option for more details on how this works.
Default: `[see next line]`
```viml
let g:ycm_filetype_blacklist = {
\ 'tagbar': 1,
\ 'notes': 1,
\ 'markdown': 1,
\ 'netrw': 1,
\ 'unite': 1,
\ 'text': 1,
\ 'vimwiki': 1,
\ 'pandoc': 1,
\ 'infolog': 1,
\ 'leaderf': 1,
\ 'mail': 1
\}
```
In addition, `ycm_nofiletype` (representing buffers with no filetype set)
is blacklisted if `ycm_nofiletype` is not _explicitly_ whitelisted (using
`g:ycm_filetype_whitelist`).
### The `g:ycm_filetype_specific_completion_to_disable` option
This option controls for which Vim filetypes (see `:h filetype`) should the YCM
semantic completion engine be turned off. The option value should be a Vim
dictionary with keys being filetype strings (like `python`, `cpp`, etc.) and
values being unimportant (the dictionary is used like a hash set, meaning that
only the keys matter). The listed filetypes will be ignored by the YCM semantic
completion engine, but the identifier-based completion engine will still trigger
in files of those filetypes.
Note that even if semantic completion is not turned off for a specific filetype,
you will not get semantic completion if the semantic engine does not support
that filetype.
You can get the filetype of the current file in Vim with `:set ft?`.
Default: `[see next line]`
```viml
let g:ycm_filetype_specific_completion_to_disable = {
\ 'gitcommit': 1
\}
```
### The `g:ycm_filepath_blacklist` option
This option controls for which Vim filetypes (see `:h filetype`) should filepath
completion be disabled. The option value should be a Vim dictionary with keys
being filetype strings (like `python`, `cpp`, etc.) and values being unimportant
(the dictionary is used like a hash set, meaning that only the keys matter).
The `*` key is special and matches all filetypes. Use this key if you want to
completely disable filepath completion:
```viml
let g:ycm_filepath_blacklist = {'*': 1}
```
You can get the filetype of the current file in Vim with `:set ft?`.
Default: `[see next line]`
```viml
let g:ycm_filepath_blacklist = {
\ 'html': 1,
\ 'jsx': 1,
\ 'xml': 1,
\}
```
### The `g:ycm_show_diagnostics_ui` option
When set, this option turns on YCM's diagnostic display features. See the
_Diagnostic display_ section in the _User Manual_ for more details.
Specific parts of the diagnostics UI (like the gutter signs, text highlighting,
diagnostic echo, and auto location list population) can be individually turned on
or off. See the other options below for details.
Note that YCM's diagnostics UI is only supported for C-family languages.
When set, this option also makes YCM remove all Syntastic checkers set for the
`c`, `cpp`, `objc`, `objcpp`, and `cuda` filetypes since this would conflict
with YCM's own diagnostics UI.
If you're using YCM's identifier completer in C-family languages but cannot use
the clang-based semantic completer for those languages _and_ want to use the GCC
Syntastic checkers, unset this option.
Default: `1`
```viml
let g:ycm_show_diagnostics_ui = 1
```
### The `g:ycm_error_symbol` option
YCM will use the value of this option as the symbol for errors in the Vim
gutter.
This option is part of the Syntastic compatibility layer; if the option is not
set, YCM will fall back to the value of the `g:syntastic_error_symbol` option
before using this option's default.
Default: `>>`
```viml
let g:ycm_error_symbol = '>>'
```
### The `g:ycm_warning_symbol` option
YCM will use the value of this option as the symbol for warnings in the Vim
gutter.
This option is part of the Syntastic compatibility layer; if the option is not
set, YCM will fall back to the value of the `g:syntastic_warning_symbol` option
before using this option's default.
Default: `>>`
```viml
let g:ycm_warning_symbol = '>>'
```
### The `g:ycm_enable_diagnostic_signs` option
When this option is set, YCM will put icons in Vim's gutter on lines that have a
diagnostic set. Turning this off will also turn off the `YcmErrorLine` and
`YcmWarningLine` highlighting.
This option is part of the Syntastic compatibility layer; if the option is not
set, YCM will fall back to the value of the `g:syntastic_enable_signs` option
before using this option's default.
Default: `1`
```viml
let g:ycm_enable_diagnostic_signs = 1
```
### The `g:ycm_enable_diagnostic_highlighting` option
When this option is set, YCM will highlight regions of text that are related to
the diagnostic that is present on a line, if any.
This option is part of the Syntastic compatibility layer; if the option is not
set, YCM will fall back to the value of the `g:syntastic_enable_highlighting`
option before using this option's default.
Default: `1`
```viml
let g:ycm_enable_diagnostic_highlighting = 1
```
### The `g:ycm_echo_current_diagnostic` option
When this option is set to 1, YCM will echo the text of the diagnostic present
on the current line when you move your cursor to that line. If a `FixIt` is
available for the current diagnostic, then ` (FixIt)` is appended.
If you have a Vim that supports virtual text, you can set this option
to the string `virtual-text`, and the diagnostic will be displayed inline with
the text, right aligned in the window and wrapping to the next line if there is
not enough space, for example:
![Virtual text diagnostic demo][diagnostic-echo-virtual-text1]
![Virtual text diagnostic demo][diagnostic-echo-virtual-text2]
**NOTE**: It's _strongly_ recommended to also set
`g:ycm_update_diagnostics_in_insert_mode` to `0` when using `virtual-text` for
diagnostics. This is due to the increased amount of distraction provided by
drawing diagnostics next to your input position.
This option is part of the Syntastic compatibility layer; if the option is not
set, YCM will fall back to the value of the `g:syntastic_echo_current_error`
option before using this option's default.
Default: `1`
Valid values:
* `0` - disabled
* `1` - echo diagnostic to the command area
* `'virtual-text'` - display the dignostic to the right of the line in the
window using virtual text
```viml
let g:ycm_echo_current_diagnostic = 1
" Or, when you have Vim supporting virtual text
let g:ycm_echo_current_diagnostic = 'virtual-text'
```
### The `g:ycm_auto_hover` option
This option controls whether or not YCM shows documentation in a popup at the
cursor location after a short delay. Only supported in Vim.
When this option is set to `'CursorHold'`, the popup is displayed on the
`CursorHold` autocommand. See `:help CursorHold` for the details, but this means
that it is displayed after `updatetime` milliseconds. When set to an empty
string, the popup is not automatically displayed.
In addition to this setting, there is the `<plug>(YCMHover)` mapping, which can
be used to manually trigger or hide the popup (it works like a toggle).
For example:
```viml
nmap <leader>D <plug>(YCMHover)
```
After dismissing the popup with this mapping, it will not be automatically
triggered again until the cursor is moved (i.e. `CursorMoved` autocommand).
The displayed documentation depends on what the completer for the current
language supports. It's selected heuristically in this order of preference:
1. `GetHover` with `markdown` syntax
2. `GetDoc` with no syntax
3. `GetType` with the syntax of the current file.
You can customise this by manually setting up `b:ycm_hover` to your liking. This
buffer-local variable can be set to a dictionary with the following keys:
* `command`: The YCM completer subcommand which should be run on hover
* `syntax`: The syntax to use (as in `set syntax=`) in the popup window for
highlighting.
* `popup_params`: The params passed to a popup window which gets opened.
For example, to use C/C++ syntax highlighting in the popup for C-family
languages, add something like this to your vimrc:
```viml
augroup MyYCMCustom
autocmd!
autocmd FileType c,cpp let b:ycm_hover = {
\ 'command': 'GetDoc',
\ 'syntax': &filetype
\ }
augroup END
```
You can also modify the opened popup with `popup_params` key.
For example, you can limit the popup's maximum width and add a border to it:
```viml
augroup MyYCMCustom
autocmd!
autocmd FileType c,cpp let b:ycm_hover = {
\ 'command': 'GetDoc',
\ 'syntax': &filetype
\ 'popup_params': {
\ 'maxwidth': 80,
\ 'border': [],
\ 'borderchars': ['─', '│', '─', '│', '┌', '┐', '┘', '└'],
\ },
\ }
augroup END
```
See `:help popup_create-arguments` for the list of available popup window options.
Default: `'CursorHold'`
### The `g:ycm_filter_diagnostics` option
This option controls which diagnostics will be rendered by YCM. This option
holds a dictionary of key-values, where the keys are Vim's filetype strings
delimited by commas and values are dictionaries describing the filter.
A filter is a dictionary of key-values, where the keys are the type of filter,
and the value is a list of arguments to that filter. In the case of just a
single item in the list, you may omit the brackets and just provide the argument
directly. If any filter matches a diagnostic, it will be dropped and YCM will
not render it.
The following filter types are supported:
- "regex": Accepts a string [regular expression][python-re]. This type matches
when the regex (treated as case-insensitive) is found anywhere in the diagnostic
text (`re.search`, not `re.match`)
- "level": Accepts a string level, either "warning" or "error." This type
matches when the diagnostic has the same level, that is,
specifying `level: "error"` will remove **all** errors from the diagnostics.
**NOTE:** The regex syntax is **NOT** Vim's, it's [Python's][python-re].
Default: `{}`
The following example will do, for Java filetype only:
- Remove **all** error level diagnostics, and,
- Also remove anything that contains `ta<something>co`
```viml
let g:ycm_filter_diagnostics = {
\ "java": {
\ "regex": [ "ta.+co", ... ],
\ "level": "error",
\ ...
\ }
\ }
```
### The `g:ycm_always_populate_location_list` option
When this option is set, YCM will populate the location list automatically every
time it gets new diagnostic data. This option is off by default so as not to
interfere with other data you might have placed in the location list.
See `:help location-list` in Vim to learn more about the location list.
This option is part of the Syntastic compatibility layer; if the option is not
set, YCM will fall back to the value of the
`g:syntastic_always_populate_loc_list` option before using this option's
default.
Note: if YCM's errors aren't visible, it might be that YCM is updating an older location list. See `:help :lhistory` and `:lolder`.
Default: `0`
```viml
let g:ycm_always_populate_location_list = 0
```
### The `g:ycm_open_loclist_on_ycm_diags` option
When this option is set, `:YcmDiags` will automatically open the location list
after forcing a compilation and filling the list with diagnostic data.
See `:help location-list` in Vim to learn more about the location list.
Default: `1`
```viml
let g:ycm_open_loclist_on_ycm_diags = 1
```
### The `g:ycm_complete_in_comments` option
When this option is set to `1`, YCM will show the completion menu even when
typing inside comments.
Default: `0`
```viml
let g:ycm_complete_in_comments = 0
```
### The `g:ycm_complete_in_strings` option
When this option is set to `1`, YCM will show the completion menu even when
typing inside strings.
Note that this is turned on by default so that you can use the filename
completion inside strings. This is very useful for instance in C-family files
where typing `#include "` will trigger the start of filename completion. If you
turn off this option, you will turn off filename completion in such situations
as well.
Default: `1`
```viml
let g:ycm_complete_in_strings = 1
```
### The `g:ycm_collect_identifiers_from_comments_and_strings` option
When this option is set to `1`, YCM's identifier completer will also collect
identifiers from strings and comments. Otherwise, the text in comments and
strings will be ignored.
Default: `0`
```viml
let g:ycm_collect_identifiers_from_comments_and_strings = 0
```
### The `g:ycm_collect_identifiers_from_tags_files` option
When this option is set to `1`, YCM's identifier completer will also collect
identifiers from tags files. The list of tags files to examine is retrieved from
the `tagfiles()` Vim function which examines the `tags` Vim option. See `:h
'tags'` for details.
YCM will re-index your tags files if it detects that they have been modified.
The only supported tag format is the [Exuberant Ctags format][ctags-format]. The
format from "plain" ctags is NOT supported. Ctags needs to be called with the
`--fields=+l` option (that's a lowercase `L`, not a one) because YCM needs the
`language:<lang>` field in the tags output.
See the _FAQ_ for pointers if YCM does not appear to read your tag files.
This option is off by default because it makes Vim slower if your tags are on a
network directory.
Default: `0`
```viml
let g:ycm_collect_identifiers_from_tags_files = 0
```
### The `g:ycm_seed_identifiers_with_syntax` option
When this option is set to `1`, YCM's identifier completer will seed its
identifier database with the keywords of the programming language you're
writing.
Since the keywords are extracted from the Vim syntax file for the filetype, all
keywords may not be collected, depending on how the syntax file was written.
Usually at least 95% of the keywords are successfully extracted.
Default: `0`
```viml
let g:ycm_seed_identifiers_with_syntax = 0
```
### The `g:ycm_extra_conf_vim_data` option
If you're using semantic completion for C-family files, this option might come
handy; it's a way of sending data from Vim to your `Settings` function in
your `.ycm_extra_conf.py` file.
This option is supposed to be a list of VimScript expression strings that are
evaluated for every request to the [ycmd server][ycmd] and then passed to your
`Settings` function as a `client_data` keyword argument.
For instance, if you set this option to `['v:version']`, your `Settings`
function will be called like this:
```python
# The '801' value is of course contingent on Vim 8.1; in 8.0 it would be '800'
Settings( ..., client_data = { 'v:version': 801 } )
```
So the `client_data` parameter is a dictionary mapping Vim expression strings to
their values at the time of the request.
The correct way to define parameters for your `Settings` function:
```python
def Settings( **kwargs ):
```
You can then get to `client_data` with `kwargs['client_data']`.
Default: `[]`
```viml
let g:ycm_extra_conf_vim_data = []
```
### The `g:ycm_server_python_interpreter` option
YCM will by default search for an appropriate Python interpreter on your system.
You can use this option to override that behavior and force the use of a
specific interpreter of your choosing.
**NOTE:** This interpreter is only used for the [ycmd server][ycmd]. The YCM
client running inside Vim always uses the Python interpreter that's embedded
inside Vim.
Default: `''`
```viml
let g:ycm_server_python_interpreter = ''
```
### The `g:ycm_keep_logfiles` option
When this option is set to `1`, YCM and the [ycmd completion server][ycmd] will
keep the logfiles around after shutting down (they are deleted on shutdown by
default).
To see where the log files are, call `:YcmDebugInfo`.
Default: `0`
```viml
let g:ycm_keep_logfiles = 0
```
### The `g:ycm_log_level` option
The logging level that YCM and the [ycmd completion server][ycmd] use. Valid
values are the following, from most verbose to least verbose:
- `debug`
- `info`
- `warning`
- `error`
- `critical`
Note that `debug` is _very_ verbose.
Default: `info`
```viml
let g:ycm_log_level = 'info'
```
### The `g:ycm_auto_start_csharp_server` option
When set to `1`, the OmniSharp-Roslyn server will be automatically started
(once per Vim session) when you open a C# file.
Default: `1`
```viml
let g:ycm_auto_start_csharp_server = 1
```
### The `g:ycm_auto_stop_csharp_server` option
When set to `1`, the OmniSharp-Roslyn server will be automatically stopped upon
closing Vim.
Default: `1`
```viml
let g:ycm_auto_stop_csharp_server = 1
```
### The `g:ycm_csharp_server_port` option
When g:ycm_auto_start_csharp_server is set to `1`, specifies the port for
the OmniSharp-Roslyn server to listen on. When set to `0` uses an unused port provided
by the OS.
Default: `0`
```viml
let g:ycm_csharp_server_port = 0
```
### The `g:ycm_csharp_insert_namespace_expr` option
By default, when YCM inserts a namespace, it will insert the `using` statement
under the nearest `using` statement. You may prefer that the `using` statement is
inserted somewhere, for example, to preserve sorting. If so, you can set this
option to override this behavior.
When this option is set, instead of inserting the `using` statement itself, YCM
will set the global variable `g:ycm_namespace_to_insert` to the namespace to
insert, and then evaluate this option's value as an expression. The option's
expression is responsible for inserting the namespace - the default insertion
will not occur.
Default: ''
```viml
let g:ycm_csharp_insert_namespace_expr = ''
```
### The `g:ycm_add_preview_to_completeopt` option
When this option is set to `1`, YCM will add the `preview` string to Vim's
`completeopt` option (see `:h completeopt`). If your `completeopt` option
already has `preview` set, there will be no effect. Alternatively, when set to
`popup` and your version of Vim supports popup windows (see `:help popup`), the
`popup` string will be used instead. You can see the current state of your
`completeopt` setting with `:set completeopt?` (yes, the question mark is
important).
When `preview` is present in `completeopt`, YCM will use the `preview` window at
the top of the file to store detailed information about the current completion
candidate (but only if the candidate came from the semantic engine). For
instance, it would show the full function prototype and all the function
overloads in the window if the current completion is a function name.
When `popup` is present in `completeopt`, YCM will instead use a `popup`
window to the side of the completion popup for storing detailed information
about the current completion candidate. In addition, YCM may truncate the
detailed completion information in order to give the popup sufficient room
to display that detailed information.
Default: `0`
```viml
let g:ycm_add_preview_to_completeopt = 0
```
### The `g:ycm_autoclose_preview_window_after_completion` option
When this option is set to `1`, YCM will auto-close the `preview` window after
the user accepts the offered completion string. If there is no `preview` window
triggered because there is no `preview` string in `completeopt`, this option is
irrelevant. See the `g:ycm_add_preview_to_completeopt` option for more details.
Default: `0`
```viml
let g:ycm_autoclose_preview_window_after_completion = 0
```
### The `g:ycm_autoclose_preview_window_after_insertion` option
When this option is set to `1`, YCM will auto-close the `preview` window after
the user leaves insert mode. This option is irrelevant if
`g:ycm_autoclose_preview_window_after_completion` is set or if no `preview`
window is triggered. See the `g:ycm_add_preview_to_completeopt` option for more
details.
Default: `0`
```viml
let g:ycm_autoclose_preview_window_after_insertion = 0
```
### The `g:ycm_max_diagnostics_to_display` option
This option controls the maximum number of diagnostics shown to the user when
errors or warnings are detected in the file. This option is only relevant for
the C-family, C#, Java, JavaScript, and TypeScript languages.
A special value of `0` means there is no limit.
Default: `30`
```viml
let g:ycm_max_diagnostics_to_display = 30
```
### The `g:ycm_key_list_select_completion` option
This option controls the key mappings used to select the first completion
string. Invoking any of them repeatedly cycles forward through the completion
list.
Some users like adding `<Enter>` to this list.
Default: `['<TAB>', '<Down>']`
```viml
let g:ycm_key_list_select_completion = ['<TAB>', '<Down>']
```
### The `g:ycm_key_list_previous_completion` option
This option controls the key mappings used to select the previous completion
string. Invoking any of them repeatedly cycles backward through the completion
list.
Note that one of the defaults is `<S-TAB>` which means Shift-TAB. That mapping
will probably only work in GUI Vim (Gvim or MacVim) and not in plain console Vim
because the terminal usually does not forward modifier key combinations to Vim.
Default: `['<S-TAB>', '<Up>']`
```viml
let g:ycm_key_list_previous_completion = ['<S-TAB>', '<Up>']
```
### The `g:ycm_key_list_stop_completion` option
This option controls the key mappings used to close the completion menu. This is
useful when the menu is blocking the view, when you need to insert the `<TAB>`
character, or when you want to expand a snippet from [UltiSnips][] and navigate
through it.
Default: `['<C-y>']`
```viml
let g:ycm_key_list_stop_completion = ['<C-y>']
```
### The `g:ycm_key_invoke_completion` option
This option controls the key mapping used to invoke the completion menu for
semantic completion. By default, semantic completion is triggered automatically
after typing characters appropriate for the language, such as `.`, `->`, `::`,
etc. in insert mode (if semantic completion support has been compiled in). This
key mapping can be used to trigger semantic completion anywhere. Useful for
searching for top-level functions and classes.
Console Vim (not Gvim or MacVim) passes `<Nul>` to Vim when the user types
`<C-Space>` so YCM will make sure that `<Nul>` is used in the map command when
you're editing in console Vim, and `<C-Space>` in GUI Vim. This means that you
can just press `<C-Space>` in both the console and GUI Vim and YCM will do the right
thing.
Setting this option to an empty string will make sure no mapping is created.
Default: `<C-Space>`
```viml
let g:ycm_key_invoke_completion = '<C-Space>'
```
### The `g:ycm_key_detailed_diagnostics` option
This option controls the key mapping used to show the full diagnostic text when
the user's cursor is on the line with the diagnostic. It basically calls
`:YcmShowDetailedDiagnostic`.
Setting this option to an empty string will make sure no mapping is created.
If you prefer the detailed diagnostic to be shown in a popup,
gitextract_tkvf_s5t/ ├── .coveragerc ├── .github/ │ ├── ISSUE_TEMPLATE/ │ │ ├── config.yml │ │ └── issue.md │ ├── PULL_REQUEST_TEMPLATE.md │ └── workflows/ │ ├── ci.yml │ ├── lock_old_issues.yaml │ └── update_vim_docs.yaml ├── .gitignore ├── .gitmodules ├── .mergify.yml ├── .readme.utf-8.add ├── .vimspector.json ├── .ycm_extra_conf.py ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── COPYING.txt ├── README.md ├── autoload/ │ ├── youcompleteme/ │ │ ├── filetypes.vim │ │ ├── finder.vim │ │ ├── hierarchy.vim │ │ └── symbol.vim │ └── youcompleteme.vim ├── codecov.yml ├── doc/ │ └── youcompleteme.txt ├── install.py ├── install.sh ├── plugin/ │ └── youcompleteme.vim ├── print_todos.sh ├── python/ │ ├── test_requirements.txt │ └── ycm/ │ ├── __init__.py │ ├── base.py │ ├── buffer.py │ ├── client/ │ │ ├── __init__.py │ │ ├── base_request.py │ │ ├── command_request.py │ │ ├── completer_available_request.py │ │ ├── completion_request.py │ │ ├── debug_info_request.py │ │ ├── event_notification.py │ │ ├── inlay_hints_request.py │ │ ├── messages_request.py │ │ ├── omni_completion_request.py │ │ ├── resolve_completion_request.py │ │ ├── semantic_tokens_request.py │ │ ├── shutdown_request.py │ │ ├── signature_help_request.py │ │ └── ycmd_keepalive.py │ ├── diagnostic_filter.py │ ├── diagnostic_interface.py │ ├── hierarchy_tree.py │ ├── inlay_hints.py │ ├── omni_completer.py │ ├── paths.py │ ├── scrolling_range.py │ ├── semantic_highlighting.py │ ├── signature_help.py │ ├── syntax_parse.py │ ├── tests/ │ │ ├── __init__.py │ │ ├── base_test.py │ │ ├── client/ │ │ │ ├── __init__.py │ │ │ ├── base_request_test.py │ │ │ ├── command_request_test.py │ │ │ ├── completion_request_test.py │ │ │ ├── debug_info_request_test.py │ │ │ ├── messages_request_test.py │ │ │ └── omni_completion_request_test.py │ │ ├── command_test.py │ │ ├── completion_test.py │ │ ├── diagnostic_filter_test.py │ │ ├── diagnostic_interface_test.py │ │ ├── event_notification_test.py │ │ ├── mock_utils.py │ │ ├── omni_completer_test.py │ │ ├── paths_test.py │ │ ├── postcomplete_test.py │ │ ├── signature_help_test.py │ │ ├── syntax_parse_test.py │ │ ├── test_utils.py │ │ ├── testdata/ │ │ │ ├── .ycm_extra_conf.py │ │ │ ├── cpp_syntax │ │ │ ├── java_syntax │ │ │ ├── php_syntax │ │ │ ├── python_syntax │ │ │ └── uni¢od€/ │ │ │ └── tags │ │ ├── vimsupport_test.py │ │ └── youcompleteme_test.py │ ├── text_properties.py │ ├── unsafe_thread_pool_executor.py │ ├── vimsupport.py │ └── youcompleteme.py ├── run_tests.py ├── test/ │ ├── .gitignore │ ├── .vimspector.json │ ├── Makefile │ ├── README.md │ ├── commands.test.vim │ ├── completion.common.vim │ ├── completion.test.vim │ ├── completion_info.test.vim │ ├── completion_noresolve.test.vim │ ├── diagnostics.test.vim │ ├── docker/ │ │ ├── ci/ │ │ │ ├── image/ │ │ │ │ └── Dockerfile │ │ │ ├── push │ │ │ └── rebuild │ │ ├── manual/ │ │ │ ├── image/ │ │ │ │ ├── .vim/ │ │ │ │ │ └── vimrc │ │ │ │ └── Dockerfile │ │ │ ├── push │ │ │ ├── rebuild │ │ │ └── run │ │ └── rebuild_all │ ├── filesize.test.vim │ ├── finder.test.vim │ ├── fixit.test.vim │ ├── hierarchies.test.vim │ ├── hover.test.vim │ ├── lib/ │ │ ├── autoload/ │ │ │ └── youcompleteme/ │ │ │ └── test/ │ │ │ ├── commands.vim │ │ │ ├── popup.vim │ │ │ └── setup.vim │ │ ├── plugin/ │ │ │ ├── completion.vim │ │ │ ├── shared.vim │ │ │ └── util.vim │ │ └── run_test.vim │ ├── run_vim_tests │ ├── signature_help.test.vim │ ├── testdata/ │ │ ├── cpp/ │ │ │ ├── auto_include.cc │ │ │ ├── auto_include.h │ │ │ ├── auto_include_workaround.cc │ │ │ ├── complete_with_sig_help.cc │ │ │ ├── completion.cc │ │ │ ├── finder_test.cc │ │ │ ├── fixit.cpp │ │ │ └── hierarchies.cc │ │ ├── diagnostics/ │ │ │ ├── foo.cpp │ │ │ └── foo.xml │ │ ├── python/ │ │ │ ├── doc.py │ │ │ └── test.py │ │ └── vim/ │ │ └── mixed_filetype.vim │ └── vimrc ├── tox.ini ├── update-vim-docs └── vimrc_ycm_minimal
SYMBOL INDEX (954 symbols across 65 files)
FILE: .ycm_extra_conf.py
function GetStandardLibraryIndexInSysPath (line 38) | def GetStandardLibraryIndexInSysPath( sys_path ):
function PythonSysPath (line 45) | def PythonSysPath( **kwargs ):
FILE: install.py
function CheckCall (line 23) | def CheckCall( args, **kwargs ):
function Main (line 30) | def Main():
FILE: python/ycm/base.py
function GetUserOptions (line 27) | def GetUserOptions( default_options = {} ):
function CurrentIdentifierFinished (line 64) | def CurrentIdentifierFinished():
function LastEnteredCharIsIdentifierChar (line 80) | def LastEnteredCharIsIdentifierChar():
function AdjustCandidateInsertionText (line 90) | def AdjustCandidateInsertionText( candidates ):
function OverlapLength (line 132) | def OverlapLength( left_string, right_string ):
FILE: python/ycm/buffer.py
class Buffer (line 29) | class Buffer:
method __init__ (line 31) | def __init__( self, bufnr, user_options, filetypes ):
method FileParseRequestReady (line 45) | def FileParseRequestReady( self, block = False ):
method SendParseRequest (line 50) | def SendParseRequest( self, extra_data ):
method ParseRequestPending (line 67) | def ParseRequestPending( self ):
method NeedsReparse (line 71) | def NeedsReparse( self ):
method ShouldResendParseRequest (line 75) | def ShouldResendParseRequest( self ):
method UpdateDiagnostics (line 81) | def UpdateDiagnostics( self, force = False ):
method UpdateWithNewDiagnostics (line 91) | def UpdateWithNewDiagnostics( self, diagnostics, async_message ):
method UpdateMatches (line 98) | def UpdateMatches( self ):
method PopulateLocationList (line 102) | def PopulateLocationList( self, open_on_edit = False ):
method GetResponse (line 106) | def GetResponse( self ):
method IsResponseHandled (line 110) | def IsResponseHandled( self ):
method MarkResponseHandled (line 114) | def MarkResponseHandled( self ):
method OnCursorMoved (line 118) | def OnCursorMoved( self ):
method GetErrorCount (line 122) | def GetErrorCount( self ):
method GetWarningCount (line 126) | def GetWarningCount( self ):
method RefreshDiagnosticsUI (line 130) | def RefreshDiagnosticsUI( self ):
method ClearDiagnosticsUI (line 134) | def ClearDiagnosticsUI( self ):
method DiagnosticsForLine (line 138) | def DiagnosticsForLine( self, line_number ):
method UpdateFromFileTypes (line 142) | def UpdateFromFileTypes( self, filetypes ):
method _ChangedTick (line 148) | def _ChangedTick( self ):
class BufferDict (line 152) | class BufferDict( dict ):
method __init__ (line 154) | def __init__( self, user_options ):
method __missing__ (line 158) | def __missing__( self, key ):
FILE: python/ycm/client/base_request.py
class BaseRequest (line 41) | class BaseRequest:
method __init__ (line 43) | def __init__( self ):
method Start (line 47) | def Start( self ):
method Done (line 51) | def Done( self ):
method Response (line 55) | def Response( self ):
method ShouldResend (line 59) | def ShouldResend( self ):
method HandleFuture (line 63) | def HandleFuture( self,
method GetDataFromHandler (line 103) | def GetDataFromHandler( self,
method GetDataFromHandlerAsync (line 115) | def GetDataFromHandlerAsync( self,
method PostDataToHandler (line 128) | def PostDataToHandler( self,
method PostDataToHandlerAsync (line 144) | def PostDataToHandlerAsync( data, handler, timeout = _READ_TIMEOUT_SEC ):
method _TalkToHandlerAsync (line 153) | def _TalkToHandlerAsync( data,
method _ExtraHeaders (line 192) | def _ExtraHeaders( method, request_uri, request_body = None ):
method Executor (line 207) | def Executor( cls ):
function BuildRequestData (line 220) | def BuildRequestData( buffer_number = None ):
function BuildRequestDataForLocation (line 252) | def BuildRequestDataForLocation( file : str, line : int, column : int ):
function _JsonFromFuture (line 272) | def _JsonFromFuture( future ):
function _LoadExtraConfFile (line 293) | def _LoadExtraConfFile( filepath ):
function _IgnoreExtraConfFile (line 298) | def _IgnoreExtraConfFile( filepath ):
function DisplayServerException (line 303) | def DisplayServerException( exception, truncate_message = False ):
function _ToUtf8Json (line 313) | def _ToUtf8Json( data ):
function _ValidateResponseObject (line 317) | def _ValidateResponseObject( response, response_text ):
function _BuildUri (line 326) | def _BuildUri( handler ):
function MakeServerException (line 330) | def MakeServerException( data ):
FILE: python/ycm/client/command_request.py
function _EnsureBackwardsCompatibility (line 26) | def _EnsureBackwardsCompatibility( arguments ):
class CommandRequest (line 32) | class CommandRequest( BaseRequest ):
method __init__ (line 33) | def __init__( self,
method Start (line 50) | def Start( self ):
method Done (line 68) | def Done( self ):
method Response (line 72) | def Response( self ):
method RunPostCommandActionsIfNeeded (line 81) | def RunPostCommandActionsIfNeeded( self,
method StringResponse (line 113) | def StringResponse( self ):
method _HandleGotoResponse (line 145) | def _HandleGotoResponse( self, buffer_command, modifiers ):
method _HandleFixitResponse (line 164) | def _HandleFixitResponse( self ):
method _HandleBasicResponse (line 205) | def _HandleBasicResponse( self ):
method _HandleMessageResponse (line 209) | def _HandleMessageResponse( self ):
method _HandleDetailedInfoResponse (line 213) | def _HandleDetailedInfoResponse( self, modifiers ):
function SendCommandRequestAsync (line 218) | def SendCommandRequestAsync( arguments,
function SendCommandRequest (line 231) | def SendCommandRequest( arguments,
function GetCommandResponse (line 245) | def GetCommandResponse( arguments, extra_data = None ):
function GetRawCommandResponse (line 253) | def GetRawCommandResponse( arguments, silent, location = None ):
FILE: python/ycm/client/completer_available_request.py
class CompleterAvailableRequest (line 21) | class CompleterAvailableRequest( BaseRequest ):
method __init__ (line 22) | def __init__( self, filetypes ):
method Start (line 28) | def Start( self ):
method Response (line 35) | def Response( self ):
function SendCompleterAvailableRequest (line 39) | def SendCompleterAvailableRequest( filetypes ):
FILE: python/ycm/client/completion_request.py
class CompletionRequest (line 30) | class CompletionRequest( BaseRequest ):
method __init__ (line 31) | def __init__( self, request_data ):
method Start (line 37) | def Start( self ):
method Done (line 42) | def Done( self ):
method _RawResponse (line 46) | def _RawResponse( self ):
method Response (line 68) | def Response( self ):
method OnCompleteDone (line 79) | def OnCompleteDone( self ):
method _GetExtraDataUserMayHaveCompleted (line 89) | def _GetExtraDataUserMayHaveCompleted( self ):
method _OnCompleteDone_Csharp (line 107) | def _OnCompleteDone_Csharp( self ):
method _OnCompleteDone_FixIt (line 126) | def _OnCompleteDone_FixIt( self ):
function _GetRequiredNamespaceImport (line 146) | def _GetRequiredNamespaceImport( extra_data ):
function _GetFixItCompletion (line 150) | def _GetFixItCompletion( extra_data ):
function _FilterToMatchingCompletions (line 154) | def _FilterToMatchingCompletions( completed_item, completions ):
function _GetCompletionInfoField (line 170) | def _GetCompletionInfoField( completion_data ):
function ConvertCompletionDataToVimData (line 186) | def ConvertCompletionDataToVimData( completion_data ):
function _ConvertCompletionDatasToVimDatas (line 226) | def _ConvertCompletionDatasToVimDatas( response_data ):
FILE: python/ycm/client/debug_info_request.py
class DebugInfoRequest (line 21) | class DebugInfoRequest( BaseRequest ):
method __init__ (line 22) | def __init__( self, extra_data = None ):
method Start (line 28) | def Start( self ):
method Response (line 37) | def Response( self ):
function FormatDebugInfoResponse (line 41) | def FormatDebugInfoResponse( response ):
function _FormatYcmdDebugInfo (line 51) | def _FormatYcmdDebugInfo( ycmd ):
function _FormatCompleterDebugInfo (line 72) | def _FormatCompleterDebugInfo( completer ):
function SendDebugInfoRequest (line 102) | def SendDebugInfoRequest( extra_data = None ):
FILE: python/ycm/client/event_notification.py
class EventNotification (line 21) | class EventNotification( BaseRequest ):
method __init__ (line 22) | def __init__( self, event_name, buffer_number = None, extra_data = Non...
method Start (line 31) | def Start( self ):
method Done (line 41) | def Done( self ):
method Response (line 45) | def Response( self ):
function SendEventNotificationAsync (line 58) | def SendEventNotificationAsync( event_name,
FILE: python/ycm/client/inlay_hints_request.py
class InlayHintsRequest (line 28) | class InlayHintsRequest( BaseRequest ):
method __init__ (line 29) | def __init__( self, request_data ):
method Start (line 35) | def Start( self ):
method Done (line 39) | def Done( self ):
method Reset (line 43) | def Reset( self ):
method Response (line 46) | def Response( self ):
FILE: python/ycm/client/messages_request.py
class MessagesPoll (line 29) | class MessagesPoll( BaseRequest ):
method __init__ (line 30) | def __init__( self, buff ):
method _SendRequest (line 36) | def _SendRequest( self ):
method Poll (line 44) | def Poll( self, diagnostics_handler ):
function _HandlePollResponse (line 73) | def _HandlePollResponse( response, diagnostics_handler ):
FILE: python/ycm/client/omni_completion_request.py
class OmniCompletionRequest (line 21) | class OmniCompletionRequest( CompletionRequest ):
method __init__ (line 22) | def __init__( self, omni_completer, request_data ):
method Start (line 27) | def Start( self ):
method Done (line 31) | def Done( self ):
method Response (line 35) | def Response( self ):
method OnCompleteDone (line 44) | def OnCompleteDone( self ):
FILE: python/ycm/client/resolve_completion_request.py
class ResolveCompletionRequest (line 29) | class ResolveCompletionRequest( BaseRequest ):
method __init__ (line 30) | def __init__( self,
method Start (line 37) | def Start( self ):
method Done (line 41) | def Done( self ):
method OnCompleteDone (line 45) | def OnCompleteDone( self ):
method Response (line 54) | def Response( self ):
function ResolveCompletionItem (line 75) | def ResolveCompletionItem( completion_request, item ):
FILE: python/ycm/client/semantic_tokens_request.py
class SemanticTokensRequest (line 28) | class SemanticTokensRequest( BaseRequest ):
method __init__ (line 29) | def __init__( self, request_data ):
method Start (line 35) | def Start( self ):
method Done (line 39) | def Done( self ):
method Reset (line 43) | def Reset( self ):
method Response (line 46) | def Response( self ):
FILE: python/ycm/client/shutdown_request.py
class ShutdownRequest (line 23) | class ShutdownRequest( BaseRequest ):
method __init__ (line 24) | def __init__( self ):
method Start (line 28) | def Start( self ):
function SendShutdownRequest (line 35) | def SendShutdownRequest():
FILE: python/ycm/client/signature_help_request.py
class SigHelpAvailableByFileType (line 25) | class SigHelpAvailableByFileType( dict ):
method __missing__ (line 26) | def __missing__( self, filetype ):
class SignatureHelpRequest (line 32) | class SignatureHelpRequest( BaseRequest ):
method __init__ (line 33) | def __init__( self, request_data ):
method Start (line 40) | def Start( self ):
method Done (line 45) | def Done( self ):
method Reset (line 49) | def Reset( self ):
method Response (line 53) | def Response( self ):
method _Response (line 59) | def _Response( self ):
class SignatureHelpAvailableRequest (line 79) | class SignatureHelpAvailableRequest( BaseRequest ):
method __init__ (line 80) | def __init__( self, filetype ):
method Done (line 86) | def Done( self ):
method Response (line 90) | def Response( self ):
method Start (line 103) | def Start( self, filetype ):
FILE: python/ycm/client/ycmd_keepalive.py
class YcmdKeepalive (line 26) | class YcmdKeepalive:
method __init__ (line 27) | def __init__( self, ping_interval_seconds = 60 * 10 ):
method Start (line 33) | def Start( self ):
method _ThreadMain (line 37) | def _ThreadMain( self ):
FILE: python/ycm/diagnostic_filter.py
class DiagnosticFilter (line 21) | class DiagnosticFilter:
method __init__ (line 22) | def __init__( self, config_or_filters ):
method IsAllowed (line 26) | def IsAllowed( self, diagnostic ):
method CreateFromOptions (line 32) | def CreateFromOptions( user_options ):
class _MasterDiagnosticFilter (line 43) | class _MasterDiagnosticFilter:
method __init__ (line 45) | def __init__( self, all_filters ):
method SubsetForTypes (line 50) | def SubsetForTypes( self, filetypes ):
function _ListOf (line 69) | def _ListOf( config_entry ):
function CompileRegex (line 76) | def CompileRegex( raw_regex ):
function CompileLevel (line 85) | def CompileLevel( level ):
function _CompileFilters (line 101) | def _CompileFilters( config ):
FILE: python/ycm/diagnostic_interface.py
class DiagnosticInterface (line 26) | class DiagnosticInterface:
method __init__ (line 27) | def __init__( self, bufnr, user_options ):
method ShouldUpdateDiagnosticsUINow (line 38) | def ShouldUpdateDiagnosticsUINow( self ):
method OnCursorMoved (line 43) | def OnCursorMoved( self ):
method GetErrorCount (line 54) | def GetErrorCount( self ):
method GetWarningCount (line 58) | def GetWarningCount( self ):
method PopulateLocationList (line 62) | def PopulateLocationList( self, open_on_edit = False ):
method UpdateWithNewDiagnostics (line 69) | def UpdateWithNewDiagnostics( self, diags, open_on_edit = False ):
method RefreshDiagnosticsUI (line 78) | def RefreshDiagnosticsUI( self, open_on_edit = False ):
method ClearDiagnosticsUI (line 91) | def ClearDiagnosticsUI( self ):
method DiagnosticsForLine (line 101) | def DiagnosticsForLine( self, line_number ):
method _ApplyDiagnosticFilter (line 105) | def _ApplyDiagnosticFilter( self, diags ):
method _EchoDiagnostic (line 111) | def _EchoDiagnostic( self ):
method _EchoDiagnosticForLine (line 117) | def _EchoDiagnosticForLine( self, line_num ):
method _ClearCurrentDiagnostic (line 132) | def _ClearCurrentDiagnostic( self, will_be_replaced=False ):
method _EchoDiagnosticText (line 149) | def _EchoDiagnosticText( self, line_num, first_diag, text ):
method _DiagnosticsCount (line 190) | def _DiagnosticsCount( self, predicate ):
method _UpdateLocationLists (line 197) | def _UpdateLocationLists( self, open_on_edit = False ):
method _ClearMatches (line 204) | def _ClearMatches( self ):
method UpdateMatches (line 210) | def UpdateMatches( self ):
method _ClearSigns (line 247) | def _ClearSigns( self ):
method _UpdateSigns (line 252) | def _UpdateSigns( self ):
method _ConvertDiagListToDict (line 277) | def _ConvertDiagListToDict( self ):
function _NormalizeDiagnostic (line 299) | def _NormalizeDiagnostic( diag ):
function _ConvertDiagnosticToTextProperties (line 309) | def _ConvertDiagnosticToTextProperties( bufnr, diagnostic ):
function _IsValidRange (line 372) | def _IsValidRange( start_line, start_column, end_line, end_column ):
FILE: python/ycm/hierarchy_tree.py
class HierarchyNode (line 23) | class HierarchyNode:
method __init__ (line 24) | def __init__( self, data, distance : int ):
method ToRootLocation (line 30) | def ToRootLocation( self, subindex : int ):
method ToLocation (line 41) | def ToLocation( self, subindex : int ):
function handle_to_index (line 52) | def handle_to_index( handle : int ):
function handle_to_location_index (line 56) | def handle_to_location_index( handle : int ):
function make_handle (line 60) | def make_handle( index : int, location_index : int ):
class HierarchyTree (line 64) | class HierarchyTree:
method __init__ (line 65) | def __init__( self ):
method SetRootNode (line 70) | def SetRootNode( self, items, kind : str ):
method UpdateHierarchy (line 81) | def UpdateHierarchy( self, handle : int, items, direction : str ):
method Reset (line 95) | def Reset( self ):
method _HierarchyToLinesHelper (line 101) | def _HierarchyToLinesHelper( self, refs, use_down_nodes ):
method HierarchyToLines (line 153) | def HierarchyToLines( self ):
method JumpToItem (line 160) | def JumpToItem( self, handle : int, command ):
method ShouldResolveItem (line 171) | def ShouldResolveItem( self, handle : int, direction : str ):
method ResolveArguments (line 183) | def ResolveArguments( self, handle : int, direction : str ):
method HandleToRootLocation (line 200) | def HandleToRootLocation( self, handle : int ):
method UpdateChangesRoot (line 212) | def UpdateChangesRoot( self, handle : int, direction : str ):
FILE: python/ycm/inlay_hints.py
function Initialise (line 34) | def Initialise():
class InlayHints (line 59) | class InlayHints( sr.ScrollingBufferRange ):
method _NewRequest (line 63) | def _NewRequest( self, request_range ):
method Clear (line 69) | def Clear( self ):
method _Draw (line 77) | def _Draw( self ):
FILE: python/ycm/omni_completer.py
class OmniCompleter (line 29) | class OmniCompleter( Completer ):
method __init__ (line 30) | def __init__( self, user_options ):
method SupportedFiletypes (line 35) | def SupportedFiletypes( self ):
method ShouldUseCache (line 39) | def ShouldUseCache( self ):
method ShouldUseNow (line 43) | def ShouldUseNow( self, request_data ):
method ShouldUseNowInner (line 52) | def ShouldUseNowInner( self, request_data ):
method ComputeCandidates (line 62) | def ComputeCandidates( self, request_data ):
method ComputeCandidatesInner (line 70) | def ComputeCandidatesInner( self, request_data ):
method FilterAndSortCandidatesInner (line 143) | def FilterAndSortCandidatesInner( self, candidates, sort_property, que...
FILE: python/ycm/paths.py
function PathToPythonInterpreter (line 35) | def PathToPythonInterpreter():
function _PathToPythonUsedDuringBuild (line 72) | def _PathToPythonUsedDuringBuild():
function _EndsWithPython (line 82) | def _EndsWithPython( path ):
function PathToServerScript (line 87) | def PathToServerScript():
FILE: python/ycm/scrolling_range.py
class ScrollingBufferRange (line 23) | class ScrollingBufferRange( object ):
method __init__ (line 29) | def __init__( self, bufnr ):
method Ready (line 36) | def Ready( self ):
method Request (line 40) | def Request( self, force=False ):
method Update (line 74) | def Update( self ):
method Refresh (line 97) | def Refresh( self ):
method GrowRangeIfNeeded (line 109) | def GrowRangeIfNeeded( self, rng ):
method _NewRequest (line 138) | def _NewRequest( self, request_range ):
method _Draw (line 144) | def _Draw( self ):
FILE: python/ycm/semantic_highlighting.py
function Initialise (line 65) | def Initialise():
function NextPropID (line 88) | def NextPropID():
class SemanticHighlighting (line 97) | class SemanticHighlighting( sr.ScrollingBufferRange ):
method __init__ (line 100) | def __init__( self, bufnr ):
method _NewRequest (line 105) | def _NewRequest( self, request_range ):
method _Draw (line 111) | def _Draw( self ):
FILE: python/ycm/signature_help.py
class SignatureHelpState (line 25) | class SignatureHelpState:
method __init__ (line 30) | def __init__( self,
method ToggleVisibility (line 38) | def ToggleVisibility( self ):
method IsActive (line 47) | def IsActive( self ):
function _MakeSignatureHelpBuffer (line 53) | def _MakeSignatureHelpBuffer( signature_info ):
function ShouldUseSignatureHelp (line 84) | def ShouldUseSignatureHelp():
function UpdateSignatureHelp (line 89) | def UpdateSignatureHelp( state, signature_info ): # noqa
FILE: python/ycm/syntax_parse.py
class SyntaxGroup (line 56) | class SyntaxGroup:
method __init__ (line 57) | def __init__( self, name, lines = None ):
function SyntaxKeywordsForCurrentBuffer (line 63) | def SyntaxKeywordsForCurrentBuffer():
function _KeywordsFromSyntaxListOutput (line 68) | def _KeywordsFromSyntaxListOutput( syntax_output ):
function _SyntaxGroupsFromOutput (line 83) | def _SyntaxGroupsFromOutput( syntax_output ):
function _CreateInitialGroupMap (line 114) | def _CreateInitialGroupMap():
function _ConnectGroupChildren (line 155) | def _ConnectGroupChildren( group_name_to_group ):
function _GetAllDescendentats (line 175) | def _GetAllDescendentats( root_group ):
function _ExtractKeywordsFromLine (line 183) | def _ExtractKeywordsFromLine( line ):
function _ExtractKeywordsFromGroup (line 224) | def _ExtractKeywordsFromGroup( group ):
FILE: python/ycm/tests/__init__.py
function PathToTestFile (line 33) | def PathToTestFile( *args ):
function UserOptions (line 68) | def UserOptions( options ):
function _IsReady (line 78) | def _IsReady():
function WaitUntilReady (line 82) | def WaitUntilReady( timeout = 5 ):
function StopServer (line 97) | def StopServer( ycm ):
function YouCompleteMeInstance (line 106) | def YouCompleteMeInstance( custom_options = {} ):
function youcompleteme_instance (line 138) | def youcompleteme_instance( custom_options = {} ):
FILE: python/ycm/tests/base_test.py
function MockCurrentFiletypes (line 30) | def MockCurrentFiletypes( filetypes = [ '' ] ):
function MockCurrentColumnAndLineContents (line 36) | def MockCurrentColumnAndLineContents( column, line_contents ):
function MockTextAfterCursor (line 44) | def MockTextAfterCursor( text ):
class BaseTest (line 49) | class BaseTest( TestCase ):
method test_AdjustCandidateInsertionText_Basic (line 50) | def test_AdjustCandidateInsertionText_Basic( self ):
method test_AdjustCandidateInsertionText_ParenInTextAfterCursor (line 57) | def test_AdjustCandidateInsertionText_ParenInTextAfterCursor( self ):
method test_AdjustCandidateInsertionText_PlusInTextAfterCursor (line 64) | def test_AdjustCandidateInsertionText_PlusInTextAfterCursor( self ):
method test_AdjustCandidateInsertionText_WhitespaceInTextAfterCursor (line 71) | def test_AdjustCandidateInsertionText_WhitespaceInTextAfterCursor( sel...
method test_AdjustCandidateInsertionText_MoreThanWordMatchingAfterCursor (line 78) | def test_AdjustCandidateInsertionText_MoreThanWordMatchingAfterCursor(...
method test_AdjustCandidateInsertionText_NotSuffix (line 90) | def test_AdjustCandidateInsertionText_NotSuffix( self ):
method test_AdjustCandidateInsertionText_NothingAfterCursor (line 97) | def test_AdjustCandidateInsertionText_NothingAfterCursor( self ):
method test_AdjustCandidateInsertionText_MultipleStrings (line 106) | def test_AdjustCandidateInsertionText_MultipleStrings( self ):
method test_AdjustCandidateInsertionText_DontTouchAbbr (line 119) | def test_AdjustCandidateInsertionText_DontTouchAbbr( self ):
method test_AdjustCandidateInsertionText_NoAbbr (line 126) | def test_AdjustCandidateInsertionText_NoAbbr( self ):
method test_OverlapLength_Basic (line 133) | def test_OverlapLength_Basic( self ):
method test_OverlapLength_BasicWithUnicode (line 138) | def test_OverlapLength_BasicWithUnicode( self ):
method test_OverlapLength_OneCharOverlap (line 143) | def test_OverlapLength_OneCharOverlap( self ):
method test_OverlapLength_SameStrings (line 147) | def test_OverlapLength_SameStrings( self ):
method test_OverlapLength_Substring (line 151) | def test_OverlapLength_Substring( self ):
method test_OverlapLength_LongestOverlap (line 156) | def test_OverlapLength_LongestOverlap( self ):
method test_OverlapLength_EmptyInput (line 161) | def test_OverlapLength_EmptyInput( self ):
method test_OverlapLength_NoOverlap (line 167) | def test_OverlapLength_NoOverlap( self ):
method test_LastEnteredCharIsIdentifierChar_Basic (line 174) | def test_LastEnteredCharIsIdentifierChar_Basic( self ):
method test_LastEnteredCharIsIdentifierChar_FiletypeHtml (line 186) | def test_LastEnteredCharIsIdentifierChar_FiletypeHtml( self ):
method test_LastEnteredCharIsIdentifierChar_ColumnIsZero (line 192) | def test_LastEnteredCharIsIdentifierChar_ColumnIsZero( self ):
method test_LastEnteredCharIsIdentifierChar_LineEmpty (line 197) | def test_LastEnteredCharIsIdentifierChar_LineEmpty( self ):
method test_LastEnteredCharIsIdentifierChar_NotIdentChar (line 206) | def test_LastEnteredCharIsIdentifierChar_NotIdentChar( self ):
method test_LastEnteredCharIsIdentifierChar_Unicode (line 218) | def test_LastEnteredCharIsIdentifierChar_Unicode( self ):
method test_CurrentIdentifierFinished_Basic (line 234) | def test_CurrentIdentifierFinished_Basic( self ):
method test_CurrentIdentifierFinished_NothingBeforeColumn (line 246) | def test_CurrentIdentifierFinished_NothingBeforeColumn( self ):
method test_CurrentIdentifierFinished_InvalidColumn (line 254) | def test_CurrentIdentifierFinished_InvalidColumn( self ):
method test_CurrentIdentifierFinished_InMiddleOfLine (line 266) | def test_CurrentIdentifierFinished_InMiddleOfLine( self ):
method test_CurrentIdentifierFinished_Html (line 278) | def test_CurrentIdentifierFinished_Html( self ):
method test_CurrentIdentifierFinished_WhitespaceOnly (line 284) | def test_CurrentIdentifierFinished_WhitespaceOnly( self ):
method test_CurrentIdentifierFinished_Unicode (line 296) | def test_CurrentIdentifierFinished_Unicode( self ):
FILE: python/ycm/tests/client/base_request_test.py
class BaseRequestTest (line 27) | class BaseRequestTest( TestCase ):
method test_BuildRequestData_AddWorkingDir (line 30) | def test_BuildRequestData_AddWorkingDir( self, *args ):
method test_BuildRequestData_AddWorkingDirWithFileName (line 38) | def test_BuildRequestData_AddWorkingDirWithFileName( self, *args ):
FILE: python/ycm/tests/client/command_request_test.py
function GoToTest (line 28) | def GoToTest( command, response ):
function GoToListTest (line 41) | def GoToListTest( command, response ):
class GoToResponse_QuickFixTest (line 90) | class GoToResponse_QuickFixTest( TestCase ):
method setUp (line 96) | def setUp( self ):
method tearDown (line 100) | def tearDown( self ):
method test_GoTo_EmptyList (line 104) | def test_GoTo_EmptyList( self ):
method test_GoTo_SingleItem_List (line 108) | def test_GoTo_SingleItem_List( self ):
method test_GoTo_MultiItem_List (line 122) | def test_GoTo_MultiItem_List( self ):
method _CheckGoToList (line 150) | def _CheckGoToList( self,
class Response_Detection_Test (line 177) | class Response_Detection_Test( TestCase ):
method test_BasicResponse (line 179) | def test_BasicResponse( self ):
method test_FixIt_Response_Empty (line 196) | def test_FixIt_Response_Empty( self ):
method test_FixIt_Response (line 218) | def test_FixIt_Response( self ):
method test_Message_Response (line 257) | def test_Message_Response( self ):
method test_Detailed_Info (line 277) | def test_Detailed_Info( self ):
method test_GoTo_Single (line 297) | def test_GoTo_Single( self ):
FILE: python/ycm/tests/client/completion_request_test.py
class ConvertCompletionResponseToVimDatasTest (line 28) | class ConvertCompletionResponseToVimDatasTest( TestCase ):
method _Check (line 32) | def _Check( self, completion_data, expected_vim_data ):
method test_AllFields (line 48) | def test_AllFields( self ):
method test_OnlyInsertionTextField (line 72) | def test_OnlyInsertionTextField( self ):
method test_JustDetailedInfo (line 88) | def test_JustDetailedInfo( self ):
method test_JustDocString (line 108) | def test_JustDocString( self ):
method test_ExtraInfoNoDocString (line 131) | def test_ExtraInfoNoDocString( self ):
method test_NullCharactersInExtraInfoAndDocString (line 152) | def test_NullCharactersInExtraInfoAndDocString( self ):
method test_ExtraInfoNoDocStringWithDetailedInfo (line 176) | def test_ExtraInfoNoDocStringWithDetailedInfo( self ):
method test_EmptyInsertionText (line 198) | def test_EmptyInsertionText( self ):
method test_TruncateForPopup (line 222) | def test_TruncateForPopup( self, *args ):
method test_OnlyTruncateForPopupIfNecessary (line 248) | def test_OnlyTruncateForPopupIfNecessary( self, *args ):
method test_DontTruncateIfNotPopup (line 273) | def test_DontTruncateIfNotPopup( self, *args ):
method test_TruncateForPopupWithoutDuplication (line 298) | def test_TruncateForPopupWithoutDuplication( self, *args ):
FILE: python/ycm/tests/client/debug_info_request_test.py
class DebugInfoRequestTest (line 70) | class DebugInfoRequestTest( TestCase ):
method test_FormatDebugInfoResponse_NoResponse (line 71) | def test_FormatDebugInfoResponse_NoResponse( self ):
method test_FormatDebugInfoResponse_NoExtraConf (line 78) | def test_FormatDebugInfoResponse_NoExtraConf( self ):
method test_FormatDebugInfoResponse_ExtraConfFoundButNotLoaded (line 92) | def test_FormatDebugInfoResponse_ExtraConfFoundButNotLoaded( self ):
method test_FormatDebugInfoResponse_ExtraConfFoundAndLoaded (line 107) | def test_FormatDebugInfoResponse_ExtraConfFoundAndLoaded( self ):
method test_FormatDebugInfoResponse_Completer_ServerRunningWithHost (line 122) | def test_FormatDebugInfoResponse_Completer_ServerRunningWithHost( self ):
method test_FormatDebugInfoResponse_Completer_ServerRunningWithoutHost (line 140) | def test_FormatDebugInfoResponse_Completer_ServerRunningWithoutHost( s...
method test_FormatDebugInfoResponse_Completer_ServerNotRunningWithNoLogfiles (line 162) | def test_FormatDebugInfoResponse_Completer_ServerNotRunningWithNoLogfi...
FILE: python/ycm/tests/client/messages_request_test.py
class MessagesRequestTest (line 29) | class MessagesRequestTest( TestCase ):
method test_HandlePollResponse_NoMessages (line 30) | def test_HandlePollResponse_NoMessages( self ):
method test_HandlePollResponse_PollingNotSupported (line 39) | def test_HandlePollResponse_PollingNotSupported( self ):
method test_HandlePollResponse_SingleMessage (line 48) | def test_HandlePollResponse_SingleMessage( self, post_vim_message ):
method test_HandlePollResponse_MultipleMessages (line 60) | def test_HandlePollResponse_MultipleMessages( self, post_vim_message ):
method test_HandlePollResponse_SingleDiagnostic (line 72) | def test_HandlePollResponse_SingleDiagnostic( self ):
method test_HandlePollResponse_MultipleDiagnostics (line 85) | def test_HandlePollResponse_MultipleDiagnostics( self ):
method test_HandlePollResponse_MultipleMessagesAndDiagnostics (line 106) | def test_HandlePollResponse_MultipleMessagesAndDiagnostics(
FILE: python/ycm/tests/client/omni_completion_request_test.py
function BuildOmnicompletionRequest (line 25) | def BuildOmnicompletionRequest( results, start_column = 1 ):
class OmniCompletionRequestTest (line 40) | class OmniCompletionRequestTest( TestCase ):
method test_Done_AlwaysTrue (line 41) | def test_Done_AlwaysTrue( self ):
method test_Response_FromOmniCompleter (line 47) | def test_Response_FromOmniCompleter( self ):
FILE: python/ycm/tests/command_test.py
class CommandTest (line 28) | class CommandTest( TestCase ):
method test_SendCommandRequest_ExtraConfVimData_Works (line 30) | def test_SendCommandRequest_ExtraConfVimData_Works( self, ycm ):
method test_SendCommandRequest_ExtraConfData_UndefinedValue (line 57) | def test_SendCommandRequest_ExtraConfData_UndefinedValue( self, ycm ):
method test_SendCommandRequest_BuildRange_NoVisualMarks (line 80) | def test_SendCommandRequest_BuildRange_NoVisualMarks( self, ycm, *args ):
method test_SendCommandRequest_BuildRange_VisualMarks (line 110) | def test_SendCommandRequest_BuildRange_VisualMarks( self, ycm, *args ):
method test_SendCommandRequest_IgnoreFileTypeOption (line 143) | def test_SendCommandRequest_IgnoreFileTypeOption( self, ycm, *args ):
FILE: python/ycm/tests/completion_test.py
function MockCompletionRequest (line 38) | def MockCompletionRequest( response_method ):
function MockResolveRequest (line 58) | def MockResolveRequest( response_method ):
class CompletionTest (line 72) | class CompletionTest( TestCase ):
method test_SendCompletionRequest_UnicodeWorkingDirectory (line 74) | def test_SendCompletionRequest_UnicodeWorkingDirectory( self, ycm ):
method test_SendCompletionRequest_ResponseContainingError (line 97) | def test_SendCompletionRequest_ResponseContainingError(
method test_SendCompletionRequest_ErrorFromServer (line 151) | def test_SendCompletionRequest_ErrorFromServer( self,
method test_ResolveCompletionRequest_Resolves (line 179) | def test_ResolveCompletionRequest_Resolves( self,
method test_ResolveCompletionRequest_ResponseContainsErrors (line 275) | def test_ResolveCompletionRequest_ResponseContainsErrors( self,
method test_ResolveCompletionItem_NoUserData (line 372) | def test_ResolveCompletionItem_NoUserData( self, ycm, post_vim_message ):
method test_ResolveCompletionItem_NoRequest (line 419) | def test_ResolveCompletionItem_NoRequest( self, ycm ):
method test_ResolveCompletionRequest_ServerError (line 427) | def test_ResolveCompletionRequest_ServerError(
FILE: python/ycm/tests/diagnostic_filter_test.py
function _assert_accept_equals (line 26) | def _assert_accept_equals( filter, text_or_obj, expected ):
function _assert_accepts (line 33) | def _assert_accepts( filter, text ):
function _assert_rejects (line 37) | def _assert_rejects( filter, text ):
function _JavaFilter (line 41) | def _JavaFilter( config ):
function _CreateFilterForTypes (line 45) | def _CreateFilterForTypes( opts, types ):
class DiagnosticFilterTest (line 49) | class DiagnosticFilterTest( TestCase ):
method test_RegexFilter (line 50) | def test_RegexFilter( self ):
method test_RegexSingleList (line 58) | def test_RegexSingleList( self ):
method test_RegexMultiList (line 66) | def test_RegexMultiList( self ):
method test_RegexNotFiltered (line 74) | def test_RegexNotFiltered( self ):
method test_LevelWarnings (line 82) | def test_LevelWarnings( self ):
method test_LevelErrors (line 92) | def test_LevelErrors( self ):
method test_MultipleFilterTypesTypeTest (line 102) | def test_MultipleFilterTypesTypeTest( self ):
method test_MergeMultipleFiletypes (line 116) | def test_MergeMultipleFiletypes( self ):
method test_CommaSeparatedFiletypes (line 129) | def test_CommaSeparatedFiletypes( self ):
FILE: python/ycm/tests/diagnostic_interface_test.py
function SimpleDiagnosticToJson (line 28) | def SimpleDiagnosticToJson( start_line, start_col, end_line, end_col ):
function SimpleDiagnosticToJsonWithInvalidLineNum (line 57) | def SimpleDiagnosticToJsonWithInvalidLineNum( start_line, start_col,
function YcmTextPropertyTupleMatcher (line 97) | def YcmTextPropertyTupleMatcher( start_line, start_col, end_line, end_co...
class DiagnosticInterfaceTest (line 105) | class DiagnosticInterfaceTest( TestCase ):
method test_ConvertDiagnosticToTextProperties (line 106) | def test_ConvertDiagnosticToTextProperties( self ):
method test_ConvertDiagnosticWithInvalidLineNum (line 149) | def test_ConvertDiagnosticWithInvalidLineNum( self ):
method test_IsValidRange (line 182) | def test_IsValidRange( self ):
FILE: python/ycm/tests/event_notification_test.py
function PresentDialog_Confirm_Call (line 38) | def PresentDialog_Confirm_Call( message ):
function MockArbitraryBuffer (line 45) | def MockArbitraryBuffer( filetype ):
function MockEventNotification (line 58) | def MockEventNotification( response_method, native_filetype_completer = ...
function _Check_FileReadyToParse_Diagnostic_Error (line 88) | def _Check_FileReadyToParse_Diagnostic_Error( ycm ):
function _Check_FileReadyToParse_Diagnostic_Warning (line 142) | def _Check_FileReadyToParse_Diagnostic_Warning( ycm ):
function _Check_FileReadyToParse_Diagnostic_Clean (line 182) | def _Check_FileReadyToParse_Diagnostic_Clean( ycm ):
class EventNotificationTest (line 199) | class EventNotificationTest( TestCase ):
method test_EventNotification_FileReadyToParse_NonDiagnostic_Error (line 202) | def test_EventNotification_FileReadyToParse_NonDiagnostic_Error(
method test_EventNotification_FileReadyToParse_NonDiagnostic_Error_NonNative (line 245) | def test_EventNotification_FileReadyToParse_NonDiagnostic_Error_NonNat...
method test_EventNotification_FileReadyToParse_NonDiagnostic_ConfirmExtraConf (line 261) | def test_EventNotification_FileReadyToParse_NonDiagnostic_ConfirmExtra...
method test_EventNotification_FileReadyToParse_Diagnostic_Error_Native (line 369) | def test_EventNotification_FileReadyToParse_Diagnostic_Error_Native(
method test_EventNotification_FileReadyToParse_TagFiles_UnicodeWorkingDirectory (line 380) | def test_EventNotification_FileReadyToParse_TagFiles_UnicodeWorkingDir...
method test_EventNotification_BufferVisit_BuildRequestForCurrentAndUnsavedBuffers (line 418) | def test_EventNotification_BufferVisit_BuildRequestForCurrentAndUnsave...
method test_EventNotification_BufferUnload_BuildRequestForDeletedAndUnsavedBuffers (line 476) | def test_EventNotification_BufferUnload_BuildRequestForDeletedAndUnsav...
method test_EventNotification_FileReadyToParse_SyntaxKeywords_SeedWithCache (line 527) | def test_EventNotification_FileReadyToParse_SyntaxKeywords_SeedWithCache(
method test_EventNotification_FileReadyToParse_SyntaxKeywords_ClearCacheIfRestart (line 562) | def test_EventNotification_FileReadyToParse_SyntaxKeywords_ClearCacheI...
FILE: python/ycm/tests/mock_utils.py
class FakeResponse (line 22) | class FakeResponse:
method __init__ (line 26) | def __init__( self, response, exception ):
method read (line 32) | def read( self ):
method close (line 38) | def close( self ):
class FakeFuture (line 42) | class FakeFuture:
method __init__ (line 46) | def __init__( self, done, response = None, exception = None ):
method done (line 55) | def done( self ):
method result (line 59) | def result( self ):
function MockAsyncServerResponseDone (line 63) | def MockAsyncServerResponseDone( response ):
function MockAsyncServerResponseInProgress (line 80) | def MockAsyncServerResponseInProgress():
function MockAsyncServerResponseException (line 96) | def MockAsyncServerResponseException( exception ):
FILE: python/ycm/tests/omni_completer_test.py
function StartColumnCompliance (line 35) | def StartColumnCompliance( ycm,
class OmniCompleterTest (line 61) | class OmniCompleterTest( TestCase ):
method test_OmniCompleter_GetCompletions_Cache_List (line 64) | def test_OmniCompleter_GetCompletions_Cache_List( self, ycm ):
method test_OmniCompleter_GetCompletions_Cache_ListFilter (line 92) | def test_OmniCompleter_GetCompletions_Cache_ListFilter( self, ycm ):
method test_OmniCompleter_GetCompletions_NoCache_List (line 116) | def test_OmniCompleter_GetCompletions_NoCache_List( self, ycm ):
method test_OmniCompleter_GetCompletions_NoCache_ListFilter (line 144) | def test_OmniCompleter_GetCompletions_NoCache_ListFilter( self, ycm ):
method test_OmniCompleter_GetCompletions_NoCache_UseFindStart (line 174) | def test_OmniCompleter_GetCompletions_NoCache_UseFindStart( self, ycm ):
method test_OmniCompleter_GetCompletions_Cache_UseFindStart (line 204) | def test_OmniCompleter_GetCompletions_Cache_UseFindStart( self, ycm ):
method test_OmniCompleter_GetCompletions_Cache_Object (line 230) | def test_OmniCompleter_GetCompletions_Cache_Object( self, ycm ):
method test_OmniCompleter_GetCompletions_Cache_ObjectList (line 254) | def test_OmniCompleter_GetCompletions_Cache_ObjectList( self, ycm ):
method test_OmniCompleter_GetCompletions_NoCache_ObjectList (line 300) | def test_OmniCompleter_GetCompletions_NoCache_ObjectList( self, ycm ):
method test_OmniCompleter_GetCompletions_Cache_ObjectListObject (line 355) | def test_OmniCompleter_GetCompletions_Cache_ObjectListObject( self, yc...
method test_OmniCompleter_GetCompletions_NoCache_ObjectListObject (line 401) | def test_OmniCompleter_GetCompletions_NoCache_ObjectListObject( self, ...
method test_OmniCompleter_GetCompletions_Cache_List_Unicode (line 456) | def test_OmniCompleter_GetCompletions_Cache_List_Unicode( self, ycm ):
method test_OmniCompleter_GetCompletions_NoCache_List_Unicode (line 484) | def test_OmniCompleter_GetCompletions_NoCache_List_Unicode( self, ycm ):
method test_OmniCompleter_GetCompletions_Cache_List_Filter_Unicode (line 512) | def test_OmniCompleter_GetCompletions_Cache_List_Filter_Unicode( self,...
method test_OmniCompleter_GetCompletions_NoCache_List_Filter_Unicode (line 536) | def test_OmniCompleter_GetCompletions_NoCache_List_Filter_Unicode(
method test_OmniCompleter_GetCompletions_Cache_ObjectList_Unicode (line 561) | def test_OmniCompleter_GetCompletions_Cache_ObjectList_Unicode( self, ...
method test_OmniCompleter_GetCompletions_Cache_ObjectListObject_Unicode (line 607) | def test_OmniCompleter_GetCompletions_Cache_ObjectListObject_Unicode(
method test_OmniCompleter_GetCompletions_RestoreCursorPositionAfterOmnifuncCall (line 670) | def test_OmniCompleter_GetCompletions_RestoreCursorPositionAfterOmnifu...
method test_OmniCompleter_GetCompletions_MoveCursorPositionAtStartColumn (line 705) | def test_OmniCompleter_GetCompletions_MoveCursorPositionAtStartColumn(
method test_OmniCompleter_GetCompletions_StartColumnCompliance (line 739) | def test_OmniCompleter_GetCompletions_StartColumnCompliance( self ):
method test_OmniCompleter_GetCompletions_NoCache_NoSemanticTrigger (line 762) | def test_OmniCompleter_GetCompletions_NoCache_NoSemanticTrigger( self,...
method test_OmniCompleter_GetCompletions_NoCache_ForceSemantic (line 786) | def test_OmniCompleter_GetCompletions_NoCache_ForceSemantic( self, ycm ):
method test_OmniCompleter_GetCompletions_ConvertStringsToDictionaries (line 810) | def test_OmniCompleter_GetCompletions_ConvertStringsToDictionaries(
method test_OmniCompleter_GetCompletions_FiletypeDisabled_SemanticTrigger (line 843) | def test_OmniCompleter_GetCompletions_FiletypeDisabled_SemanticTrigger(
method test_OmniCompleter_GetCompletions_AllFiletypesDisabled_SemanticTrigger (line 870) | def test_OmniCompleter_GetCompletions_AllFiletypesDisabled_SemanticTri...
method test_OmniCompleter_GetCompletions_FiletypeDisabled_ForceSemantic (line 898) | def test_OmniCompleter_GetCompletions_FiletypeDisabled_ForceSemantic(
method test_OmniCompleter_GetCompletions_AllFiletypesDisabled_ForceSemantic (line 929) | def test_OmniCompleter_GetCompletions_AllFiletypesDisabled_ForceSemantic(
FILE: python/ycm/tests/paths_test.py
function EndsWithPython_Good (line 26) | def EndsWithPython_Good( path ):
function EndsWithPython_Bad (line 31) | def EndsWithPython_Bad( path ):
class PathTest (line 36) | class PathTest( TestCase ):
method test_EndsWithPython_Python3Paths (line 37) | def test_EndsWithPython_Python3Paths( self ):
method test_EndsWithPython_BadPaths (line 48) | def test_EndsWithPython_BadPaths( self ):
FILE: python/ycm/tests/postcomplete_test.py
function CompleteItemIs (line 37) | def CompleteItemIs( word, abbr = None, menu = None,
function GetVariableValue_CompleteItemIs (line 50) | def GetVariableValue_CompleteItemIs( word, abbr = None, menu = None,
function BuildCompletion (line 59) | def BuildCompletion( insertion_text = 'Test',
function BuildCompletionNamespace (line 82) | def BuildCompletionNamespace( namespace = None,
function BuildCompletionFixIt (line 98) | def BuildCompletionFixIt( fixits,
function _SetupForCsharpCompletionDone (line 115) | def _SetupForCsharpCompletionDone( completions ):
function _SetUpCompleteDone (line 122) | def _SetUpCompleteDone( completions ):
class PostcompleteTest (line 132) | class PostcompleteTest( TestCase ):
method test_OnCompleteDone_DefaultFixIt (line 134) | def test_OnCompleteDone_DefaultFixIt( self, *args ):
method test_OnCompleteDone_CsharpFixIt (line 145) | def test_OnCompleteDone_CsharpFixIt( self, *args ):
method test_OnCompleteDone_NoFixItIfNotDone (line 156) | def test_OnCompleteDone_NoFixItIfNotDone( self, *args ):
method test_OnCompleteDone_NoFixItForOmnifunc (line 167) | def test_OnCompleteDone_NoFixItForOmnifunc( self, *args ):
method test_FilterToCompletedCompletions_MatchIsReturned (line 177) | def test_FilterToCompletedCompletions_MatchIsReturned( self ):
method test_FilterToCompletedCompletions_ShortTextDoesntRaise (line 184) | def test_FilterToCompletedCompletions_ShortTextDoesntRaise( self ):
method test_FilterToCompletedCompletions_ExactMatchIsReturned (line 190) | def test_FilterToCompletedCompletions_ExactMatchIsReturned( self ):
method test_FilterToCompletedCompletions_NonMatchIsntReturned (line 197) | def test_FilterToCompletedCompletions_NonMatchIsntReturned( self ):
method test_FilterToCompletedCompletions_Unicode (line 204) | def test_FilterToCompletedCompletions_Unicode( self ):
method test_GetRequiredNamespaceImport_ReturnNoneForNoExtraData (line 211) | def test_GetRequiredNamespaceImport_ReturnNoneForNoExtraData( self ):
method test_GetRequiredNamespaceImport_ReturnNamespaceFromExtraData (line 215) | def test_GetRequiredNamespaceImport_ReturnNamespaceFromExtraData( self ):
method test_GetExtraDataUserMayHaveCompleted_ReturnEmptyIfPendingMatches (line 224) | def test_GetExtraDataUserMayHaveCompleted_ReturnEmptyIfPendingMatches(
method test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfExactMatches (line 231) | def test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfExactMatches(
method test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfExactMatchesEvenIfPartial (line 242) | def test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfExactMatchesEve...
method test_GetExtraDataUserMayHaveCompleted_DontReturnMatchIfNoExactMatchesAndPartial (line 253) | def test_GetExtraDataUserMayHaveCompleted_DontReturnMatchIfNoExactMatc...
method test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfMatches (line 265) | def test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfMatches( self, ...
method test_GetExtraDataUserMayHaveCompleted_UseUserData0 (line 277) | def test_GetExtraDataUserMayHaveCompleted_UseUserData0( self, *args ):
method test_GetExtraDataUserMayHaveCompleted_UseUserData1 (line 296) | def test_GetExtraDataUserMayHaveCompleted_UseUserData1( self, *args ):
method test_GetExtraDataUserMayHaveCompleted_EmptyUserData (line 312) | def test_GetExtraDataUserMayHaveCompleted_EmptyUserData( self, *args ):
method test_PostCompleteCsharp_EmptyDoesntInsertNamespace (line 325) | def test_PostCompleteCsharp_EmptyDoesntInsertNamespace( self, *args ):
method test_PostCompleteCsharp_ExistingWithoutNamespaceDoesntInsertNamespace (line 333) | def test_PostCompleteCsharp_ExistingWithoutNamespaceDoesntInsertNamesp...
method test_PostCompleteCsharp_ValueDoesInsertNamespace (line 343) | def test_PostCompleteCsharp_ValueDoesInsertNamespace( self, *args ):
method test_PostCompleteCsharp_InsertSecondNamespaceIfSelected (line 354) | def test_PostCompleteCsharp_InsertSecondNamespaceIfSelected( self, *ar...
method test_PostCompleteFixIt_ApplyFixIt_NoFixIts (line 369) | def test_PostCompleteFixIt_ApplyFixIt_NoFixIts( self, replace_chunks, ...
method test_PostCompleteFixIt_ApplyFixIt_EmptyFixIt (line 381) | def test_PostCompleteFixIt_ApplyFixIt_EmptyFixIt(
method test_PostCompleteFixIt_ApplyFixIt_NoFixIt (line 394) | def test_PostCompleteFixIt_ApplyFixIt_NoFixIt( self, replace_chunks, *...
method test_PostCompleteFixIt_ApplyFixIt_PickFirst (line 406) | def test_PostCompleteFixIt_ApplyFixIt_PickFirst(
method test_PostCompleteFixIt_ApplyFixIt_PickFirstUserData (line 422) | def test_PostCompleteFixIt_ApplyFixIt_PickFirstUserData( self,
method test_PostCompleteFixIt_ApplyFixIt_PickSecond (line 439) | def test_PostCompleteFixIt_ApplyFixIt_PickSecond(
FILE: python/ycm/tests/signature_help_test.py
class SignatureHelpTest (line 24) | class SignatureHelpTest( TestCase ):
method test_MakeSignatureHelpBuffer_Empty (line 25) | def test_MakeSignatureHelpBuffer_Empty( self ):
FILE: python/ycm/tests/syntax_parse_test.py
function ContentsOfTestFile (line 29) | def ContentsOfTestFile( test_file ):
class SyntaxTest (line 35) | class SyntaxTest( TestCase ):
method test_KeywordsFromSyntaxListOutput_PythonSyntax (line 36) | def test_KeywordsFromSyntaxListOutput_PythonSyntax( self ):
method test_KeywordsFromSyntaxListOutput_CppSyntax (line 73) | def test_KeywordsFromSyntaxListOutput_CppSyntax( self ):
method test_KeywordsFromSyntaxListOutput_JavaSyntax (line 103) | def test_KeywordsFromSyntaxListOutput_JavaSyntax( self ):
method test_KeywordsFromSyntaxListOutput_PhpSyntax_ContainsFunctions (line 134) | def test_KeywordsFromSyntaxListOutput_PhpSyntax_ContainsFunctions( sel...
method test_KeywordsFromSyntaxListOutput_PhpSyntax_ContainsPreProc (line 140) | def test_KeywordsFromSyntaxListOutput_PhpSyntax_ContainsPreProc( self ):
method test_KeywordsFromSyntaxListOutput_Basic (line 146) | def test_KeywordsFromSyntaxListOutput_Basic( self ):
method test_KeywordsFromSyntaxListOutput_Function (line 154) | def test_KeywordsFromSyntaxListOutput_Function( self ):
method test_KeywordsFromSyntaxListOutput_ContainedArgAllowed (line 162) | def test_KeywordsFromSyntaxListOutput_ContainedArgAllowed( self ):
method test_KeywordsFromSyntaxListOutput_JunkIgnored (line 170) | def test_KeywordsFromSyntaxListOutput_JunkIgnored( self ):
method test_KeywordsFromSyntaxListOutput_MultipleStatementGroups (line 181) | def test_KeywordsFromSyntaxListOutput_MultipleStatementGroups( self ):
method test_KeywordsFromSyntaxListOutput_StatementAndTypeGroups (line 190) | def test_KeywordsFromSyntaxListOutput_StatementAndTypeGroups( self ):
method test_KeywordsFromSyntaxListOutput_StatementHierarchy (line 199) | def test_KeywordsFromSyntaxListOutput_StatementHierarchy( self ):
method test_KeywordsFromSyntaxListOutput_TypeHierarchy (line 211) | def test_KeywordsFromSyntaxListOutput_TypeHierarchy( self ):
method test_KeywordsFromSyntaxListOutput_StatementAndTypeHierarchy (line 223) | def test_KeywordsFromSyntaxListOutput_StatementAndTypeHierarchy( self ):
method test_SyntaxGroupsFromOutput_Basic (line 241) | def test_SyntaxGroupsFromOutput_Basic( self ):
method test_ExtractKeywordsFromGroup_Basic (line 249) | def test_ExtractKeywordsFromGroup_Basic( self ):
method test_ExtractKeywordsFromGroup_Commas (line 258) | def test_ExtractKeywordsFromGroup_Commas( self ):
method test_ExtractKeywordsFromGroup_WithLinksTo (line 267) | def test_ExtractKeywordsFromGroup_WithLinksTo( self ):
method test_ExtractKeywordsFromGroup_KeywordStarts (line 277) | def test_ExtractKeywordsFromGroup_KeywordStarts( self ):
method test_ExtractKeywordsFromGroup_KeywordMiddle (line 288) | def test_ExtractKeywordsFromGroup_KeywordMiddle( self ):
method test_ExtractKeywordsFromGroup_KeywordAssign (line 298) | def test_ExtractKeywordsFromGroup_KeywordAssign( self ):
method test_ExtractKeywordsFromGroup_KeywordAssignAndMiddle (line 307) | def test_ExtractKeywordsFromGroup_KeywordAssignAndMiddle( self ):
method test_ExtractKeywordsFromGroup_KeywordWithoutNextgroup (line 316) | def test_ExtractKeywordsFromGroup_KeywordWithoutNextgroup( self ):
method test_ExtractKeywordsFromGroup_ContainedSyntaxArgAllowed (line 326) | def test_ExtractKeywordsFromGroup_ContainedSyntaxArgAllowed( self ):
FILE: python/ycm/tests/test_utils.py
function CurrentWorkingDirectory (line 116) | def CurrentWorkingDirectory( path ):
function _MockGetBufferNumber (line 125) | def _MockGetBufferNumber( buffer_filename ):
function _MockGetBufferWindowNumber (line 132) | def _MockGetBufferWindowNumber( buffer_number ):
function _MockGetBufferVariable (line 139) | def _MockGetBufferVariable( buffer_number, option ):
function _MockVimBufferEval (line 154) | def _MockVimBufferEval( value ):
function _MockVimWindowEval (line 189) | def _MockVimWindowEval( value ):
function _MockVimOptionsEval (line 197) | def _MockVimOptionsEval( value ):
function _MockVimFunctionsEval (line 217) | def _MockVimFunctionsEval( value ):
function _MockVimPropEval (line 258) | def _MockVimPropEval( value ):
function _MockVimVersionEval (line 295) | def _MockVimVersionEval( value ):
function _MockVimEval (line 310) | def _MockVimEval( value ): # noqa
function _MockWipeoutBuffer (line 352) | def _MockWipeoutBuffer( buffer_number ):
function _MockVimCommand (line 360) | def _MockVimCommand( command ):
function _MockVimOptions (line 390) | def _MockVimOptions( option ):
class VimBuffer (line 398) | class VimBuffer:
method __init__ (line 417) | def __init__( self, name,
method __getitem__ (line 445) | def __getitem__( self, index ):
method __len__ (line 450) | def __len__( self ):
method __setitem__ (line 454) | def __setitem__( self, key, value ):
method GetLines (line 458) | def GetLines( self ):
method mark (line 463) | def mark( self, name ):
method __repr__ (line 471) | def __repr__( self ):
class VimBuffers (line 475) | class VimBuffers:
method __init__ (line 478) | def __init__( self, buffers ):
method __getitem__ (line 483) | def __getitem__( self, number ):
method __iter__ (line 491) | def __iter__( self ):
method pop (line 496) | def pop( self, index ):
class VimTabpages (line 500) | class VimTabpages:
method __init__ (line 501) | def __init__( self, *args ):
method __getitem__ (line 507) | def __getitem__( self, number ):
method __iter__ (line 515) | def __iter__( self ):
class VimWindow (line 520) | class VimWindow:
method __init__ (line 527) | def __init__( self, tabpage, number, buffer_object, cursor = None ):
method __repr__ (line 536) | def __repr__( self ):
class VimTabpage (line 542) | class VimTabpage:
method __init__ (line 545) | def __init__( self, number, buffers, cursor ):
method __getitem__ (line 558) | def __getitem__( self, number ):
method __iter__ (line 566) | def __iter__( self ):
class VimCurrent (line 571) | class VimCurrent:
method __init__ (line 575) | def __init__( self, current_window ):
class VimProp (line 582) | class VimProp:
method __init__ (line 584) | def __init__( self,
method __eq__ (line 599) | def __eq__( self, other ):
method __repr__ (line 607) | def __repr__( self ):
method __getitem__ (line 615) | def __getitem__( self, key ):
method get (line 628) | def get( self, key, default = None ):
class VimSign (line 633) | class VimSign:
method __init__ (line 635) | def __init__( self, line, name, bufnr ):
method __eq__ (line 641) | def __eq__( self, other ):
method __repr__ (line 649) | def __repr__( self ):
method __getitem__ (line 654) | def __getitem__( self, key ):
function MockVimBuffers (line 660) | def MockVimBuffers( buffers, window_buffers, cursor_position = ( 1, 1 ) ):
function MockVimModule (line 683) | def MockVimModule():
class VimError (line 715) | class VimError( Exception ):
method __init__ (line 717) | def __init__( self, code ):
method __str__ (line 721) | def __str__( self ):
class ExtendedMock (line 725) | class ExtendedMock( MagicMock ):
method assert_has_exact_calls (line 736) | def assert_has_exact_calls( self, calls, any_order = False ):
function ExpectedFailure (line 742) | def ExpectedFailure( reason, *exception_matchers ):
FILE: python/ycm/tests/testdata/.ycm_extra_conf.py
function FlagsForFile (line 1) | def FlagsForFile( filename, **kwargs ):
FILE: python/ycm/tests/vimsupport_test.py
function AssertBuffersAreEqualAsBytes (line 33) | def AssertBuffersAreEqualAsBytes( result_buffer, expected_buffer ):
function _BuildChunk (line 39) | def _BuildChunk( start_line,
function _BuildLocations (line 61) | def _BuildLocations( start_line, start_column, end_line, end_column ):
class VimsupportTest (line 71) | class VimsupportTest( TestCase ):
method test_SetLocationListsForBuffer_Current (line 74) | def test_SetLocationListsForBuffer_Current( self, vim_eval, *args ):
method test_SetLocationListsForBuffer_NotCurrent (line 96) | def test_SetLocationListsForBuffer_NotCurrent( self, vim_eval ):
method test_SetLocationListsForBuffer_NotVisible (line 114) | def test_SetLocationListsForBuffer_NotVisible( self, vim_eval ):
method test_SetLocationListsForBuffer_MultipleWindows (line 133) | def test_SetLocationListsForBuffer_MultipleWindows( self, vim_eval, *a...
method test_SetLocationList (line 157) | def test_SetLocationList( self, vim_eval, *args ):
method test_SetLocationList_NotCurrent (line 180) | def test_SetLocationList_NotCurrent( self, vim_eval, *args ):
method test_OpenLocationList (line 209) | def test_OpenLocationList(
method test_SetFittingHeightForCurrentWindow_LineWrapOn (line 228) | def test_SetFittingHeightForCurrentWindow_LineWrapOn(
method test_SetFittingHeightForCurrentWindow_NoResize (line 242) | def test_SetFittingHeightForCurrentWindow_NoResize(
method test_SetFittingHeightForCurrentWindow_LineWrapOff (line 257) | def test_SetFittingHeightForCurrentWindow_LineWrapOff(
method test_ReplaceChunk_SingleLine_Repl_1 (line 271) | def test_ReplaceChunk_SingleLine_Repl_1( self ):
method test_ReplaceChunk_SingleLine_Repl_2 (line 294) | def test_ReplaceChunk_SingleLine_Repl_2( self ):
method test_ReplaceChunk_SingleLine_Repl_3 (line 304) | def test_ReplaceChunk_SingleLine_Repl_3( self ):
method test_ReplaceChunk_SingleLine_Add_1 (line 314) | def test_ReplaceChunk_SingleLine_Add_1( self ):
method test_ReplaceChunk_SingleLine_Add_2 (line 324) | def test_ReplaceChunk_SingleLine_Add_2( self ):
method test_ReplaceChunk_SingleLine_Add_3 (line 334) | def test_ReplaceChunk_SingleLine_Add_3( self ):
method test_ReplaceChunk_SingleLine_Del_1 (line 344) | def test_ReplaceChunk_SingleLine_Del_1( self ):
method test_ReplaceChunk_SingleLine_Del_2 (line 354) | def test_ReplaceChunk_SingleLine_Del_2( self ):
method test_ReplaceChunk_SingleLine_Del_3 (line 364) | def test_ReplaceChunk_SingleLine_Del_3( self ):
method test_ReplaceChunk_SingleLine_Unicode_ReplaceUnicodeChars (line 374) | def test_ReplaceChunk_SingleLine_Unicode_ReplaceUnicodeChars( self ):
method test_ReplaceChunk_SingleLine_Unicode_ReplaceAfterUnicode (line 386) | def test_ReplaceChunk_SingleLine_Unicode_ReplaceAfterUnicode( self ):
method test_ReplaceChunk_SingleLine_Unicode_Grown (line 398) | def test_ReplaceChunk_SingleLine_Unicode_Grown( self ):
method test_ReplaceChunk_RemoveSingleLine (line 408) | def test_ReplaceChunk_RemoveSingleLine( self ):
method test_ReplaceChunk_SingleToMultipleLines (line 420) | def test_ReplaceChunk_SingleToMultipleLines( self ):
method test_ReplaceChunk_SingleToMultipleLines2 (line 442) | def test_ReplaceChunk_SingleToMultipleLines2( self ):
method test_ReplaceChunk_SingleToMultipleLines3 (line 457) | def test_ReplaceChunk_SingleToMultipleLines3( self ):
method test_ReplaceChunk_SingleToMultipleLinesReplace (line 472) | def test_ReplaceChunk_SingleToMultipleLinesReplace( self ):
method test_ReplaceChunk_SingleToMultipleLinesReplace_2 (line 487) | def test_ReplaceChunk_SingleToMultipleLinesReplace_2( self ):
method test_ReplaceChunk_MultipleLinesToSingleLine (line 510) | def test_ReplaceChunk_MultipleLinesToSingleLine( self ):
method test_ReplaceChunk_MultipleLinesToSameMultipleLines (line 541) | def test_ReplaceChunk_MultipleLinesToSameMultipleLines( self ):
method test_ReplaceChunk_MultipleLinesToMoreMultipleLines (line 556) | def test_ReplaceChunk_MultipleLinesToMoreMultipleLines( self ):
method test_ReplaceChunk_MultipleLinesToLessMultipleLines (line 572) | def test_ReplaceChunk_MultipleLinesToLessMultipleLines( self ):
method test_ReplaceChunk_MultipleLinesToEvenLessMultipleLines (line 586) | def test_ReplaceChunk_MultipleLinesToEvenLessMultipleLines( self ):
method test_ReplaceChunk_SpanBufferEdge (line 599) | def test_ReplaceChunk_SpanBufferEdge( self ):
method test_ReplaceChunk_DeleteTextInLine (line 612) | def test_ReplaceChunk_DeleteTextInLine( self ):
method test_ReplaceChunk_AddTextInLine (line 624) | def test_ReplaceChunk_AddTextInLine( self ):
method test_ReplaceChunk_ReplaceTextInLine (line 637) | def test_ReplaceChunk_ReplaceTextInLine( self ):
method test_ReplaceChunk_NewlineChunk (line 650) | def test_ReplaceChunk_NewlineChunk( self ):
method test_ReplaceChunk_BeyondEndOfFile (line 661) | def test_ReplaceChunk_BeyondEndOfFile( self ):
method test_ReplaceChunk_CursorPosition (line 671) | def test_ReplaceChunk_CursorPosition( self ):
method test_ReplaceChunksInBuffer_SortedChunks (line 685) | def test_ReplaceChunksInBuffer_SortedChunks( self ):
method test_ReplaceChunksInBuffer_UnsortedChunks (line 698) | def test_ReplaceChunksInBuffer_UnsortedChunks( self ):
method test_ReplaceChunksInBuffer_LineOverlappingChunks (line 711) | def test_ReplaceChunksInBuffer_LineOverlappingChunks( self ):
method test_ReplaceChunksInBuffer_OutdentChunks (line 731) | def test_ReplaceChunksInBuffer_OutdentChunks( self ):
method test_ReplaceChunksInBuffer_OneLineIndentingChunks (line 749) | def test_ReplaceChunksInBuffer_OneLineIndentingChunks( self ):
method test_ReplaceChunksInBuffer_SameLocation (line 769) | def test_ReplaceChunksInBuffer_SameLocation( self ):
method test_ReplaceChunks_SingleFile_Open (line 795) | def test_ReplaceChunks_SingleFile_Open( self,
method test_ReplaceChunks_SingleFile_NotOpen (line 881) | def test_ReplaceChunks_SingleFile_NotOpen( self,
method test_ReplaceChunks_SingleFile_NotOpen_Silent (line 991) | def test_ReplaceChunks_SingleFile_NotOpen_Silent(
method test_ReplaceChunks_User_Declines_To_Open_File (line 1091) | def test_ReplaceChunks_User_Declines_To_Open_File(
method test_ReplaceChunks_User_Aborts_Opening_File (line 1174) | def test_ReplaceChunks_User_Aborts_Opening_File(
method test_ReplaceChunks_MultiFile_Open (line 1263) | def test_ReplaceChunks_MultiFile_Open( self,
method test_WriteToPreviewWindow (line 1375) | def test_WriteToPreviewWindow( self, vim_current, vim_command ):
method test_WriteToPreviewWindow_Mods (line 1403) | def test_WriteToPreviewWindow_Mods( self, vim_current, vim_command ):
method test_WriteToPreviewWindow_MultiLine (line 1431) | def test_WriteToPreviewWindow_MultiLine( self, vim_current ):
method test_WriteToPreviewWindow_JumpFail (line 1441) | def test_WriteToPreviewWindow_JumpFail( self, vim_current, vim_command ):
method test_WriteToPreviewWindow_JumpFail_MultiLine (line 1460) | def test_WriteToPreviewWindow_JumpFail_MultiLine(
method test_BufferIsVisibleForFilename (line 1480) | def test_BufferIsVisibleForFilename( self ):
method test_CloseBuffersForFilename (line 1493) | def test_CloseBuffersForFilename( self ):
method test_OpenFilename (line 1506) | def test_OpenFilename( self, vim_current, vim_command ):
method test_GetUnsavedAndSpecifiedBufferData_EncodedUnicodeCharsInBuffers (line 1534) | def test_GetUnsavedAndSpecifiedBufferData_EncodedUnicodeCharsInBuffers(
method test_GetBufferFilepath_NoBufferName_UnicodeWorkingDirectory (line 1547) | def test_GetBufferFilepath_NoBufferName_UnicodeWorkingDirectory( self ):
method test_TextBeforeCursor_EncodedUnicode (line 1559) | def test_TextBeforeCursor_EncodedUnicode( *args ):
method test_TextAfterCursor_EncodedUnicode (line 1567) | def test_TextAfterCursor_EncodedUnicode( *args ):
method test_CurrentLineContents_EncodedUnicode (line 1572) | def test_CurrentLineContents_EncodedUnicode( *args ):
method test_VimExpressionToPythonType_IntAsUnicode (line 1577) | def test_VimExpressionToPythonType_IntAsUnicode( *args ):
method test_VimExpressionToPythonType_IntAsBytes (line 1583) | def test_VimExpressionToPythonType_IntAsBytes( *args ):
method test_VimExpressionToPythonType_StringAsUnicode (line 1589) | def test_VimExpressionToPythonType_StringAsUnicode( *args ):
method test_VimExpressionToPythonType_StringAsBytes (line 1595) | def test_VimExpressionToPythonType_StringAsBytes( *args ):
method test_VimExpressionToPythonType_ListPassthrough (line 1601) | def test_VimExpressionToPythonType_ListPassthrough( *args ):
method test_VimExpressionToPythonType_ObjectPassthrough (line 1607) | def test_VimExpressionToPythonType_ObjectPassthrough( *args ):
method test_VimExpressionToPythonType_GeneratorPassthrough (line 1613) | def test_VimExpressionToPythonType_GeneratorPassthrough( *args ):
method test_SelectFromList_LastItem (line 1621) | def test_SelectFromList_LastItem( self, vim_eval ):
method test_SelectFromList_FirstItem (line 1635) | def test_SelectFromList_FirstItem( self, vim_eval ):
method test_SelectFromList_OutOfRange (line 1647) | def test_SelectFromList_OutOfRange( self, vim_eval ):
method test_SelectFromList_SelectPrompt (line 1654) | def test_SelectFromList_SelectPrompt( self, vim_eval ):
method test_SelectFromList_Negative (line 1661) | def test_SelectFromList_Negative( self, vim_eval ):
method test_Filetypes_IntegerFiletype (line 1667) | def test_Filetypes_IntegerFiletype( self ):
method test_InsertNamespace_insert (line 1680) | def test_InsertNamespace_insert( self, vim_current, *args ):
method test_InsertNamespace_append (line 1701) | def test_InsertNamespace_append( self, vim_current, *args ):
method test_JumpToLocation_SameFile_SameBuffer_NoSwapFile (line 1724) | def test_JumpToLocation_SameFile_SameBuffer_NoSwapFile( self, vim_comm...
method test_JumpToLocation_DifferentFile_SameBuffer_Unmodified (line 1742) | def test_JumpToLocation_DifferentFile_SameBuffer_Unmodified(
method test_JumpToLocation_SameFile_NoLineCol (line 1764) | def test_JumpToLocation_SameFile_NoLineCol( self, vim_command ):
method test_JumpToLocation_SameFile_NoLine (line 1783) | def test_JumpToLocation_SameFile_NoLine( self, vim_command ):
method test_JumpToLocation_SameFile_NoCol (line 1802) | def test_JumpToLocation_SameFile_NoCol( self, vim_command ):
method test_JumpToLocation_DifferentFile_NoLineCol (line 1821) | def test_JumpToLocation_DifferentFile_NoLineCol( self, vim_command ):
method test_JumpToLocation_DifferentFile_NoLine (line 1841) | def test_JumpToLocation_DifferentFile_NoLine( self, vim_command ):
method test_JumpToLocation_DifferentFile_NoCol (line 1861) | def test_JumpToLocation_DifferentFile_NoCol( self, vim_command ):
method test_JumpToLocation_DifferentFile_SameBuffer_Modified_CannotHide (line 1882) | def test_JumpToLocation_DifferentFile_SameBuffer_Modified_CannotHide(
method test_JumpToLocation_DifferentFile_SameBuffer_Modified_CanHide (line 1901) | def test_JumpToLocation_DifferentFile_SameBuffer_Modified_CanHide(
method test_JumpToLocation_DifferentFile_SameBuffer_SwapFile_Unexpected (line 1921) | def test_JumpToLocation_DifferentFile_SameBuffer_SwapFile_Unexpected(
method test_JumpToLocation_DifferentFile_SameBuffer_SwapFile_Quit (line 1940) | def test_JumpToLocation_DifferentFile_SameBuffer_SwapFile_Quit(
method test_JumpToLocation_DifferentFile_SameBuffer_SwapFile_Abort (line 1957) | def test_JumpToLocation_DifferentFile_SameBuffer_SwapFile_Abort(
method test_JumpToLocation_DifferentFile_Split_CurrentTab_NotAlreadyOpened (line 1972) | def test_JumpToLocation_DifferentFile_Split_CurrentTab_NotAlreadyOpened(
method test_JumpToLocation_DifferentFile_Split_CurrentTab_AlreadyOpened (line 1998) | def test_JumpToLocation_DifferentFile_Split_CurrentTab_AlreadyOpened(
method test_JumpToLocation_DifferentFile_Split_CurrentTab_AlreadyOpened_Case (line 2028) | def test_JumpToLocation_DifferentFile_Split_CurrentTab_AlreadyOpened_C...
method test_JumpToLocation_DifferentFile_Split_AllTabs_NotAlreadyOpened (line 2057) | def test_JumpToLocation_DifferentFile_Split_AllTabs_NotAlreadyOpened(
method test_JumpToLocation_DifferentFile_Split_AllTabs_AlreadyOpened (line 2079) | def test_JumpToLocation_DifferentFile_Split_AllTabs_AlreadyOpened(
method test_JumpToLocation_DifferentFile_NewOrExistingTab_NotAlreadyOpened (line 2107) | def test_JumpToLocation_DifferentFile_NewOrExistingTab_NotAlreadyOpened(
method test_JumpToLocation_DifferentFile_NewOrExistingTab_AlreadyOpened (line 2129) | def test_JumpToLocation_DifferentFile_NewOrExistingTab_AlreadyOpened(
method test_VimVersionAtLeast (line 2157) | def test_VimVersionAtLeast( self ):
FILE: python/ycm/tests/youcompleteme_test.py
function RunNotifyUserIfServerCrashed (line 52) | def RunNotifyUserIfServerCrashed( ycm, post_vim_message, test ):
function YouCompleteMe_UpdateDiagnosticInterface (line 67) | def YouCompleteMe_UpdateDiagnosticInterface( ycm, post_vim_message, *arg...
class YouCompleteMeTest (line 223) | class YouCompleteMeTest( TestCase ):
method test_YouCompleteMe_YcmCoreNotImported (line 225) | def test_YouCompleteMe_YcmCoreNotImported( self, ycm ):
method test_YouCompleteMe_InvalidPythonInterpreterPath (line 230) | def test_YouCompleteMe_InvalidPythonInterpreterPath( self, post_vim_me...
method test_YouCompleteMe_NoPythonInterpreterFound (line 260) | def test_YouCompleteMe_NoPythonInterpreterFound(
method test_YouCompleteMe_NotifyUserIfServerCrashed_UnexpectedCore (line 290) | def test_YouCompleteMe_NotifyUserIfServerCrashed_UnexpectedCore(
method test_YouCompleteMe_NotifyUserIfServerCrashed_MissingCore (line 304) | def test_YouCompleteMe_NotifyUserIfServerCrashed_MissingCore(
method test_YouCompleteMe_NotifyUserIfServerCrashed_OutdatedCore (line 317) | def test_YouCompleteMe_NotifyUserIfServerCrashed_OutdatedCore(
method test_YouCompleteMe_NotifyUserIfServerCrashed_UnexpectedExitCode (line 330) | def test_YouCompleteMe_NotifyUserIfServerCrashed_UnexpectedExitCode(
method test_YouCompleteMe_DebugInfo_ServerRunning (line 344) | def test_YouCompleteMe_DebugInfo_ServerRunning( self, ycm, *args ):
method test_YouCompleteMe_DebugInfo_ServerNotRunning (line 373) | def test_YouCompleteMe_DebugInfo_ServerNotRunning( self, ycm, *args ):
method test_YouCompleteMe_OnVimLeave_RemoveClientLogfileByDefault (line 392) | def test_YouCompleteMe_OnVimLeave_RemoveClientLogfileByDefault( self, ...
method test_YouCompleteMe_OnVimLeave_KeepClientLogfile (line 402) | def test_YouCompleteMe_OnVimLeave_KeepClientLogfile( self, ycm ):
method test_YouCompleteMe_ToggleLogs_WithParameters (line 415) | def test_YouCompleteMe_ToggleLogs_WithParameters(
method test_YouCompleteMe_ToggleLogs_WithoutParameters_SelectLogfileNotAlreadyOpen (line 442) | def test_YouCompleteMe_ToggleLogs_WithoutParameters_SelectLogfileNotAl...
method test_YouCompleteMe_ToggleLogs_WithoutParameters_SelectLogfileAlreadyOpen (line 464) | def test_YouCompleteMe_ToggleLogs_WithoutParameters_SelectLogfileAlrea...
method test_YouCompleteMe_ToggleLogs_WithoutParameters_NoSelection (line 480) | def test_YouCompleteMe_ToggleLogs_WithoutParameters_NoSelection(
method test_YouCompleteMe_GetDefinedSubcommands_ListFromServer (line 495) | def test_YouCompleteMe_GetDefinedSubcommands_ListFromServer( self, ycm ):
method test_YouCompleteMe_GetDefinedSubcommands_ErrorFromServer (line 512) | def test_YouCompleteMe_GetDefinedSubcommands_ErrorFromServer(
method test_YouCompleteMe_ShowDetailedDiagnostic_MessageFromServer (line 530) | def test_YouCompleteMe_ShowDetailedDiagnostic_MessageFromServer(
method test_YouCompleteMe_ShowDetailedDiagnostic_Exception (line 546) | def test_YouCompleteMe_ShowDetailedDiagnostic_Exception(
method test_YouCompleteMe_ShowDiagnostics_FiletypeNotSupported (line 562) | def test_YouCompleteMe_ShowDiagnostics_FiletypeNotSupported(
method test_YouCompleteMe_ShowDiagnostics_NoDiagnosticsDetected (line 580) | def test_YouCompleteMe_ShowDiagnostics_NoDiagnosticsDetected(
method test_YouCompleteMe_ShowDiagnostics_DiagnosticsFound_DoNotOpenLocationList (line 613) | def test_YouCompleteMe_ShowDiagnostics_DiagnosticsFound_DoNotOpenLocat...
method test_YouCompleteMe_ShowDiagnostics_DiagnosticsFound_OpenLocationList (line 672) | def test_YouCompleteMe_ShowDiagnostics_DiagnosticsFound_OpenLocationList(
method test_YouCompleteMe_UpdateDiagnosticInterface_OldVim (line 735) | def test_YouCompleteMe_UpdateDiagnosticInterface_OldVim(
method test_YouCompleteMe_UpdateDiagnosticInterface_NewVim (line 749) | def test_YouCompleteMe_UpdateDiagnosticInterface_NewVim(
method test_YouCompleteMe_UpdateMatches_ClearDiagnosticMatchesInNewBuffer (line 755) | def test_YouCompleteMe_UpdateMatches_ClearDiagnosticMatchesInNewBuffer(
method test_YouCompleteMe_AsyncDiagnosticUpdate_UserDisabled (line 782) | def test_YouCompleteMe_AsyncDiagnosticUpdate_UserDisabled(
method test_YouCompleteMe_AsyncDiagnosticUpdate_SingleFile (line 842) | def test_YouCompleteMe_AsyncDiagnosticUpdate_SingleFile(
method test_YouCompleteMe_AsyncDiagnosticUpdate_PerFile (line 1005) | def test_YouCompleteMe_AsyncDiagnosticUpdate_PerFile(
method test_YouCompleteMe_OnPeriodicTick_ServerNotRunning (line 1190) | def test_YouCompleteMe_OnPeriodicTick_ServerNotRunning( self, ycm ):
method test_YouCompleteMe_OnPeriodicTick_ServerNotReady (line 1196) | def test_YouCompleteMe_OnPeriodicTick_ServerNotReady( self, ycm ):
method test_YouCompleteMe_OnPeriodicTick_DontRetry (line 1208) | def test_YouCompleteMe_OnPeriodicTick_DontRetry(
method test_YouCompleteMe_OnPeriodicTick_Exception (line 1268) | def test_YouCompleteMe_OnPeriodicTick_Exception(
method test_YouCompleteMe_OnPeriodicTick_ValidResponse (line 1311) | def test_YouCompleteMe_OnPeriodicTick_ValidResponse(
method test_YouCompleteMe_OnCompleteDone_CompletionRequest (line 1348) | def test_YouCompleteMe_OnCompleteDone_CompletionRequest(
method test_YouCompleteMe_OnCompleteDone_NoCompletionRequest (line 1359) | def test_YouCompleteMe_OnCompleteDone_NoCompletionRequest(
method test_YouCompleteMe_ShouldResendFileParseRequest_NoParseRequest (line 1366) | def test_YouCompleteMe_ShouldResendFileParseRequest_NoParseRequest(
FILE: python/ycm/text_properties.py
function AddTextPropertyType (line 31) | def AddTextPropertyType( name, **kwargs ):
function GetTextPropertyTypes (line 46) | def GetTextPropertyTypes( *args, **kwargs ):
function AddTextProperty (line 50) | def AddTextProperty( bufnr,
function ClearTextProperties (line 73) | def ClearTextProperties(
FILE: python/ycm/unsafe_thread_pool_executor.py
class _WorkItem (line 30) | class _WorkItem:
method __init__ (line 31) | def __init__( self, future, fn, args, kwargs ):
method run (line 37) | def run( self ):
function _worker (line 50) | def _worker( executor_reference, work_queue ):
class UnsafeThreadPoolExecutor (line 74) | class UnsafeThreadPoolExecutor( _base.Executor ):
method __init__ (line 75) | def __init__( self, max_workers ):
method submit (line 88) | def submit( self, fn, *args, **kwargs ):
method _adjust_thread_count (line 101) | def _adjust_thread_count( self ):
method shutdown (line 116) | def shutdown( self, wait=True ):
FILE: python/ycm/vimsupport.py
function CurrentLineAndColumn (line 64) | def CurrentLineAndColumn():
function SetCurrentLineAndColumn (line 73) | def SetCurrentLineAndColumn( line, column ):
function CurrentColumn (line 79) | def CurrentColumn():
function CurrentLineContents (line 92) | def CurrentLineContents():
function CurrentLineContentsAndCodepointColumn (line 96) | def CurrentLineContentsAndCodepointColumn():
function TextAfterCursor (line 107) | def TextAfterCursor():
function TextBeforeCursor (line 112) | def TextBeforeCursor():
function BufferModified (line 117) | def BufferModified( buffer_object ):
function GetBufferData (line 121) | def GetBufferData( buffer_object ):
function GetUnsavedAndSpecifiedBufferData (line 129) | def GetUnsavedAndSpecifiedBufferData( included_buffer, included_filepath ):
function GetBufferNumberForFilename (line 148) | def GetBufferNumberForFilename( filename, create_buffer_if_needed = Fals...
function GetCurrentBufferFilepath (line 155) | def GetCurrentBufferFilepath():
function BufferIsVisible (line 159) | def BufferIsVisible( buffer_number ):
function GetBufferFilepath (line 166) | def GetBufferFilepath( buffer_object ):
function GetCurrentBufferNumber (line 176) | def GetCurrentBufferNumber():
function GetBufferChangedTick (line 180) | def GetBufferChangedTick( bufnr ):
function RangeVisibleInBuffer (line 192) | def RangeVisibleInBuffer( bufnr, grow_factor=0.5 ):
function VisibleRangeOfBufferOverlaps (line 244) | def VisibleRangeOfBufferOverlaps( bufnr, expanded_range ):
function CaptureVimCommand (line 257) | def CaptureVimCommand( command ):
function GetSignsInBuffer (line 261) | def GetSignsInBuffer( buffer_number ):
class DiagnosticProperty (line 267) | class DiagnosticProperty( namedtuple( 'DiagnosticProperty', [ 'id',
method __eq__ (line 272) | def __eq__( self, other ):
function GetTextPropertyForDiag (line 279) | def GetTextPropertyForDiag( buffer_number, line_number, diag ):
function GetTextProperties (line 316) | def GetTextProperties( buffer_number ):
function AddTextProperty (line 347) | def AddTextProperty( buffer_number,
function RemoveDiagnosticProperty (line 376) | def RemoveDiagnosticProperty( buffer_number: int, prop: DiagnosticProper...
function RemoveTextProperty (line 383) | def RemoveTextProperty( buffer_number, line_num, prop_id, prop_type ):
function LineAndColumnNumbersClamped (line 401) | def LineAndColumnNumbersClamped( bufnr, line_num, column_num ):
function SetLocationList (line 410) | def SetLocationList( diagnostics ):
function GetWindowsForBufferNumber (line 415) | def GetWindowsForBufferNumber( buffer_number ):
function SetLocationListsForBuffer (line 422) | def SetLocationListsForBuffer( buffer_number,
function SetLocationListForWindow (line 431) | def SetLocationListForWindow( window,
function OpenLocationList (line 478) | def OpenLocationList( focus = False, autoclose = False ):
function SetQuickFixList (line 499) | def SetQuickFixList( quickfix_list ):
function OpenQuickFixList (line 505) | def OpenQuickFixList( focus = False, autoclose = False ):
function ComputeFittingHeightForCurrentWindow (line 524) | def ComputeFittingHeightForCurrentWindow():
function SetFittingHeightForCurrentWindow (line 536) | def SetFittingHeightForCurrentWindow():
function ConvertDiagnosticsToQfList (line 543) | def ConvertDiagnosticsToQfList( diagnostics ):
function GetVimGlobalsKeys (line 576) | def GetVimGlobalsKeys():
function VimExpressionToPythonType (line 580) | def VimExpressionToPythonType( vim_expression ):
function HiddenEnabled (line 597) | def HiddenEnabled( buffer_object ):
function BufferIsUsable (line 603) | def BufferIsUsable( buffer_object ):
function EscapeFilepathForVimCommand (line 607) | def EscapeFilepathForVimCommand( filepath ):
function ComparePaths (line 611) | def ComparePaths( path1, path2 ):
function TryJumpLocationInTab (line 623) | def TryJumpLocationInTab( tab, filename, line, column ):
function TryJumpLocationInTabs (line 641) | def TryJumpLocationInTabs( filename, line, column ):
function GetVimCommand (line 650) | def GetVimCommand( user_command, default = 'edit' ):
function JumpToFile (line 657) | def JumpToFile( filename, command, modifiers ):
function JumpToLocation (line 679) | def JumpToLocation( filename, line, column, modifiers, command ):
function NumLinesInBuffer (line 717) | def NumLinesInBuffer( buffer_object ):
function PostVimMessage (line 725) | def PostVimMessage( message, warning = True, truncate = False ):
function PresentDialog (line 767) | def PresentDialog( message, choices, default_choice_index = 0 ):
function Confirm (line 801) | def Confirm( message ):
function SelectFromList (line 807) | def SelectFromList( prompt, items ):
function EscapeForVim (line 859) | def EscapeForVim( text ):
function AllOpenedFiletypes (line 863) | def AllOpenedFiletypes():
function CurrentFiletypes (line 873) | def CurrentFiletypes():
function CurrentFiletypesEnabled (line 880) | def CurrentFiletypesEnabled( disabled_filetypes ):
function GetBufferFiletypes (line 889) | def GetBufferFiletypes( bufnr ):
function FiletypesForBuffer (line 897) | def FiletypesForBuffer( buffer_object ):
function VariableExists (line 910) | def VariableExists( variable ):
function SetVariableValue (line 914) | def SetVariableValue( variable, value ):
function GetVariableValue (line 918) | def GetVariableValue( variable ):
function GetBoolValue (line 922) | def GetBoolValue( variable ):
function GetIntValue (line 926) | def GetIntValue( variable ):
function _SortChunksByFile (line 930) | def _SortChunksByFile( chunks ):
function _GetNumNonVisibleFiles (line 944) | def _GetNumNonVisibleFiles( file_list ):
function _OpenFileInSplitIfNeeded (line 952) | def _OpenFileInSplitIfNeeded( filepath ):
function ReplaceChunks (line 1005) | def ReplaceChunks( chunks, silent=False ):
function ReplaceChunksInBuffer (line 1066) | def ReplaceChunksInBuffer( chunks, vim_buffer ):
function SplitLines (line 1094) | def SplitLines( contents ):
function ReplaceChunk (line 1119) | def ReplaceChunk( start, end, replacement_text, vim_buffer ):
function InsertNamespace (line 1175) | def InsertNamespace( namespace ):
function SearchInCurrentBuffer (line 1195) | def SearchInCurrentBuffer( pattern ):
function LineTextInCurrentBuffer (line 1201) | def LineTextInCurrentBuffer( line_number ):
function ClosePreviewWindow (line 1206) | def ClosePreviewWindow():
function JumpToPreviewWindow (line 1211) | def JumpToPreviewWindow():
function JumpToPreviousWindow (line 1218) | def JumpToPreviousWindow():
function JumpToTab (line 1223) | def JumpToTab( tab_number ):
function OpenFileInPreviewWindow (line 1228) | def OpenFileInPreviewWindow( filename, modifiers ):
function WriteToPreviewWindow (line 1235) | def WriteToPreviewWindow( message, modifiers ):
function BufferIsVisibleForFilename (line 1277) | def BufferIsVisibleForFilename( filename ):
function CloseBuffersForFilename (line 1283) | def CloseBuffersForFilename( filename ):
function OpenFilename (line 1295) | def OpenFilename( filename, options = {} ):
function _SetUpLoadedBuffer (line 1363) | def _SetUpLoadedBuffer( command, filename, fix, position, watch ):
function BuildRange (line 1381) | def BuildRange( start_line, end_line ):
function VimVersionAtLeast (line 1410) | def VimVersionAtLeast( version_string ):
function AutoCloseOnCurrentBuffer (line 1422) | def AutoCloseOnCurrentBuffer( name ):
function VimIsNeovim (line 1434) | def VimIsNeovim():
function VimSupportsPopupWindows (line 1439) | def VimSupportsPopupWindows():
function VimHasFunction (line 1450) | def VimHasFunction( func ):
function VimHasFunctions (line 1454) | def VimHasFunctions( *functions ):
function WinIDForWindow (line 1458) | def WinIDForWindow( window ):
function ScreenPositionForLineColumnInWindow (line 1463) | def ScreenPositionForLineColumnInWindow( window, line, column ):
function UsingPreviewPopup (line 1469) | def UsingPreviewPopup():
function DisplayWidth (line 1473) | def DisplayWidth():
function DisplayWidthOfString (line 1477) | def DisplayWidthOfString( s ):
function BuildQfListItem (line 1481) | def BuildQfListItem( goto_data_item ):
FILE: python/ycm/youcompleteme.py
function PatchNoProxy (line 52) | def PatchNoProxy():
class YouCompleteMe (line 101) | class YouCompleteMe:
method __init__ (line 102) | def __init__( self, default_options = {} ):
method InitializeCurrentHierarchy (line 116) | def InitializeCurrentHierarchy( self, items, kind ):
method UpdateCurrentHierarchy (line 120) | def UpdateCurrentHierarchy( self, handle : int, direction : str ):
method _ResolveHierarchyItem (line 146) | def _ResolveHierarchyItem( self, handle : int, direction : str ):
method ShouldResolveItem (line 153) | def ShouldResolveItem( self, handle : int, direction : str ):
method ResetCurrentHierarchy (line 157) | def ResetCurrentHierarchy( self ):
method JumpToHierarchyItem (line 161) | def JumpToHierarchyItem( self, handle ):
method _SetUpServer (line 167) | def _SetUpServer( self ):
method _SetUpLogging (line 235) | def _SetUpLogging( self ):
method _SetLogLevel (line 267) | def _SetLogLevel( self ):
method IsServerAlive (line 275) | def IsServerAlive( self ):
method CheckIfServerIsReady (line 280) | def CheckIfServerIsReady( self ):
method IsServerReady (line 287) | def IsServerReady( self ):
method NotifyUserIfServerCrashed (line 291) | def NotifyUserIfServerCrashed( self ):
method ServerPid (line 320) | def ServerPid( self ):
method _ShutdownServer (line 326) | def _ShutdownServer( self ):
method RestartServer (line 330) | def RestartServer( self ):
method SendCompletionRequest (line 336) | def SendCompletionRequest( self, force_semantic = False ):
method CompletionRequestReady (line 353) | def CompletionRequestReady( self ):
method GetCompletionResponse (line 358) | def GetCompletionResponse( self ):
method SignatureHelpAvailableRequestComplete (line 362) | def SignatureHelpAvailableRequestComplete( self, filetype, send_new=Tr...
method SendSignatureHelpRequest (line 372) | def SendSignatureHelpRequest( self ):
method SignatureHelpRequestReady (line 409) | def SignatureHelpRequestReady( self ):
method GetSignatureHelpResponse (line 414) | def GetSignatureHelpResponse( self ):
method ClearSignatureHelp (line 418) | def ClearSignatureHelp( self ):
method UpdateSignatureHelp (line 424) | def UpdateSignatureHelp( self, signature_info ):
method _GetCommandRequestArguments (line 430) | def _GetCommandRequestArguments( self,
method SendCommandRequest (line 461) | def SendCommandRequest( self,
method GetCommandResponse (line 479) | def GetCommandResponse( self, arguments ):
method SendCommandRequestAsync (line 488) | def SendCommandRequestAsync( self,
method GetCommandRequest (line 508) | def GetCommandRequest( self, request_id ):
method FlushCommandRequest (line 512) | def FlushCommandRequest( self, request_id ):
method GetDefinedSubcommands (line 516) | def GetDefinedSubcommands( self ):
method GetCurrentCompletionRequest (line 523) | def GetCurrentCompletionRequest( self ):
method GetOmniCompleter (line 527) | def GetOmniCompleter( self ):
method FiletypeCompleterExistsForFiletype (line 531) | def FiletypeCompleterExistsForFiletype( self, filetype ):
method NativeFiletypeCompletionAvailable (line 545) | def NativeFiletypeCompletionAvailable( self ):
method NativeFiletypeCompletionUsable (line 550) | def NativeFiletypeCompletionUsable( self ):
method NeedsReparse (line 557) | def NeedsReparse( self ):
method UpdateWithNewDiagnosticsForFile (line 561) | def UpdateWithNewDiagnosticsForFile( self, filepath, diagnostics ):
method OnPeriodicTick (line 595) | def OnPeriodicTick( self ):
method OnFileReadyToParse (line 616) | def OnFileReadyToParse( self ):
method OnFileSave (line 632) | def OnFileSave( self, saved_buffer_number ):
method OnBufferUnload (line 636) | def OnBufferUnload( self, deleted_buffer_number ):
method UpdateMatches (line 640) | def UpdateMatches( self ):
method OnFileTypeSet (line 644) | def OnFileTypeSet( self ):
method OnBufferVisit (line 651) | def OnBufferVisit( self ):
method CurrentBuffer (line 662) | def CurrentBuffer( self ):
method Buffer (line 666) | def Buffer( self, bufnr ):
method OnInsertEnter (line 670) | def OnInsertEnter( self ):
method OnInsertLeave (line 675) | def OnInsertLeave( self ):
method OnCursorMoved (line 684) | def OnCursorMoved( self ):
method _CleanLogfile (line 688) | def _CleanLogfile( self ):
method OnVimLeave (line 695) | def OnVimLeave( self ):
method OnCurrentIdentifierFinished (line 700) | def OnCurrentIdentifierFinished( self ):
method OnCompleteDone (line 704) | def OnCompleteDone( self ):
method ResolveCompletionItem (line 710) | def ResolveCompletionItem( self, item ):
method GetErrorCount (line 734) | def GetErrorCount( self ):
method GetWarningCount (line 738) | def GetWarningCount( self ):
method _PopulateLocationListWithLatestDiagnostics (line 742) | def _PopulateLocationListWithLatestDiagnostics( self ):
method FileParseRequestReady (line 747) | def FileParseRequestReady( self ):
method HandleFileParseRequest (line 753) | def HandleFileParseRequest( self, block = False ):
method ShouldResendFileParseRequest (line 789) | def ShouldResendFileParseRequest( self ):
method DebugInfo (line 793) | def DebugInfo( self ):
method GetLogfiles (line 816) | def GetLogfiles( self ):
method _OpenLogfile (line 836) | def _OpenLogfile( self, size, mods, logfile ):
method _CloseLogfile (line 855) | def _CloseLogfile( self, logfile ):
method ToggleLogs (line 859) | def ToggleLogs( self, size, mods, *filenames ):
method ShowDetailedDiagnostic (line 891) | def ShowDetailedDiagnostic( self, message_in_popup ):
method ForceCompileAndDiagnostics (line 937) | def ForceCompileAndDiagnostics( self ):
method ShowDiagnostics (line 952) | def ShowDiagnostics( self ):
method FilterAndSortItems (line 965) | def FilterAndSortItems( self,
method ToggleSignatureHelp (line 978) | def ToggleSignatureHelp( self ):
method _AddSyntaxDataIfNeeded (line 982) | def _AddSyntaxDataIfNeeded( self, extra_data ):
method _AddTagsFilesIfNeeded (line 995) | def _AddTagsFilesIfNeeded( self, extra_data ):
method _AddExtraConfDataIfNeeded (line 1007) | def _AddExtraConfDataIfNeeded( self, extra_data ):
method _AddUltiSnipsDataIfNeeded (line 1027) | def _AddUltiSnipsDataIfNeeded( self, extra_data ):
FILE: run_tests.py
function RunFlake8 (line 30) | def RunFlake8():
function ParseArguments (line 41) | def ParseArguments():
function BuildYcmdLibs (line 61) | def BuildYcmdLibs( args ):
function UnittestTests (line 70) | def UnittestTests( parsed_args, extra_unittest_args ):
function Main (line 102) | def Main():
FILE: test/testdata/cpp/auto_include.cc
function main (line 1) | int main()
FILE: test/testdata/cpp/auto_include.h
type Thing (line 3) | struct Thing
FILE: test/testdata/cpp/auto_include_workaround.cc
function do_another_thing (line 3) | void do_another_thing()
function do_a_thing (line 7) | void do_a_thing( Thing t )
FILE: test/testdata/cpp/complete_with_sig_help.cc
type Test (line 3) | struct Test
function main (line 8) | int main() {
FILE: test/testdata/cpp/completion.cc
type PointInTime (line 2) | struct PointInTime
type Line (line 9) | struct Line
type PointInTimeLine (line 15) | struct PointInTimeLine
function what_is_the (line 21) | static void what_is_the( PointInTimeLine* p )
function draw_a (line 27) | static void draw_a( Line l )
FILE: test/testdata/cpp/finder_test.cc
type Test (line 3) | struct Test
function main (line 8) | int main() {
FILE: test/testdata/cpp/fixit.cpp
function main (line 2) | int main() {
FILE: test/testdata/cpp/hierarchies.cc
function g (line 3) | int g() {
function h (line 7) | int h() {
type B0 (line 12) | struct B0 {}
type B1 (line 13) | struct B1 : B0 {}
type D0 (line 15) | struct D0 : B0 {}
type D1 (line 16) | struct D1 : B0, B1 {}
FILE: test/testdata/python/doc.py
function Test_OneLine (line 2) | def Test_OneLine():
function Test_MultiLine (line 6) | def Test_MultiLine():
function Main (line 11) | def Main():
function Really_Long_Method (line 16) | def Really_Long_Method( which, has, some, param, that, take, the, whole,...
function Really_Long_Method_2 (line 22) | def Really_Long_Method_2():
function Moan (line 36) | def Moan():
Condensed preview — 141 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (1,553K chars).
[
{
"path": ".coveragerc",
"chars": 91,
"preview": "[run]\nplugins = covimerage\n\n[report]\nomit =\n */tests/*\n */test/*\n */third_party/*\n"
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"chars": 228,
"preview": "blank_issues_enabled: false\ncontact_links:\n - name: Questions and support\n url: 'https://github.com/ycm-core/YouComp"
},
{
"path": ".github/ISSUE_TEMPLATE/issue.md",
"chars": 3798,
"preview": "---\n\nname: Issue\nabout: Report a bug or suggest an enhancement\n\n---\n\n# Issue Prelude\n\n**Please complete these steps and "
},
{
"path": ".github/PULL_REQUEST_TEMPLATE.md",
"chars": 809,
"preview": "# PR Prelude\n\nThank you for working on YCM! :)\n\n**Please complete these steps and check these boxes (by putting an `x` i"
},
{
"path": ".github/workflows/ci.yml",
"chars": 2512,
"preview": "name: CI\n\non:\n workflow_dispatch:\n pull_request:\n push:\n branches:\n - master\n\njobs:\n python-tests:\n strat"
},
{
"path": ".github/workflows/lock_old_issues.yaml",
"chars": 721,
"preview": "name: \"Lock Old Issues\"\n\non:\n schedule:\n - cron: '0 0 * * *'\n workflow_dispatch:\n\njobs:\n lock:\n runs-on: ubuntu"
},
{
"path": ".github/workflows/update_vim_docs.yaml",
"chars": 1012,
"preview": "name: \"Update vim docs\"\n\non:\n push:\n branches:\n - master\n paths:\n - 'README.md'\n workflow_dispatch:\n\nj"
},
{
"path": ".gitignore",
"chars": 944,
"preview": "# Compiled Object files\n*.slo\n*.lo\n*.o\n\n# Compiled Dynamic libraries\n*.dll\n*.so\n*.dylib\n\n# Compiled Static libraries\n*.l"
},
{
"path": ".gitmodules",
"chars": 96,
"preview": "[submodule \"third_party/ycmd\"]\n\tpath = third_party/ycmd\n\turl = https://github.com/ycm-core/ycmd\n"
},
{
"path": ".mergify.yml",
"chars": 5485,
"preview": "# https://blog.mergify.com/strict-mode-deprecation/\nqueue_rules:\n - name: duplicated default from Automatic merge on Az"
},
{
"path": ".readme.utf-8.add",
"chars": 828,
"preview": "AST\nAutocommands\nCMake\nCUDA\nCompleters\nCtags\nCtrl\nCursorHold\nDoxygen\nEclim\nEclim's\nFixIt\nFreenode\nGitter\nGoTo\nGopls\nHome"
},
{
"path": ".vimspector.json",
"chars": 1502,
"preview": "{\n \"$schema\": \"https://puremourning.github.io/vimspector/schema/vimspector.schema.json\",\n \"configurations\": {\n \"Pyt"
},
{
"path": ".ycm_extra_conf.py",
"chars": 3104,
"preview": "# This file is NOT licensed under the GPLv3, which is the license for the rest\n# of YouCompleteMe.\n#\n# Here's the licens"
},
{
"path": "CODE_OF_CONDUCT.md",
"chars": 411,
"preview": "We, the maintainers, pledge to treat all contributors with respect and require that contributors reciprocate.\n\nThe maint"
},
{
"path": "CONTRIBUTING.md",
"chars": 8770,
"preview": "Writing issue reports\n=====================\n\n### Bugs and features only\n\nFirst things first: **the issue tracker is NOT "
},
{
"path": "COPYING.txt",
"chars": 35147,
"preview": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free "
},
{
"path": "README.md",
"chars": 151327,
"preview": "YouCompleteMe: a code-completion engine for Vim\n===============================================\n\n[![Gitter room](https:/"
},
{
"path": "autoload/youcompleteme/filetypes.vim",
"chars": 1369,
"preview": "\" Copyright (C) 2011-2018 YouCompleteMe contributors\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free s"
},
{
"path": "autoload/youcompleteme/finder.vim",
"chars": 26282,
"preview": "\" Copyright (C) 2021 YouCompleteMe contributors\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free softwa"
},
{
"path": "autoload/youcompleteme/hierarchy.vim",
"chars": 8387,
"preview": "\" Copyright (C) 2021 YouCompleteMe contributors\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free softwa"
},
{
"path": "autoload/youcompleteme/symbol.vim",
"chars": 2472,
"preview": "\" Copyright (C) 2024 YouCompleteMe contributors\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free softwa"
},
{
"path": "autoload/youcompleteme.vim",
"chars": 53717,
"preview": "\" Copyright (C) 2011-2018 YouCompleteMe contributors\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free s"
},
{
"path": "codecov.yml",
"chars": 432,
"preview": "codecov:\n notify:\n require_ci_to_pass: yes\n\ncoverage:\n precision: 2\n round: down\n range: 70...100\n\n status:\n "
},
{
"path": "doc/youcompleteme.txt",
"chars": 182578,
"preview": "*youcompleteme* YouCompleteMe: a code-completion engine for Vim\n\n======================================================"
},
{
"path": "install.py",
"chars": 1391,
"preview": "#!/usr/bin/env python3\n\nfrom __future__ import print_function\nfrom __future__ import division\nfrom __future__ import uni"
},
{
"path": "install.sh",
"chars": 182,
"preview": "#!/bin/sh\n\necho \"WARNING: this script is deprecated. Use the install.py script instead.\" 1>&2\n\n\nSCRIPT_DIR=$(dirname $0 "
},
{
"path": "plugin/youcompleteme.vim",
"chars": 9520,
"preview": "\" Copyright (C) 2011, 2012 Google Inc.\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free software: you "
},
{
"path": "print_todos.sh",
"chars": 153,
"preview": "#!/bin/bash\nag \\\n--ignore gmock \\\n--ignore jedi/ \\\n--ignore OmniSharpServer \\\n--ignore testdata \\\nTODO \\\nthird_party/ycm"
},
{
"path": "python/test_requirements.txt",
"chars": 192,
"preview": "flake8 >= 3.0.0\nflake8-comprehensions >= 1.4.1\nflake8-ycm >= 0.1.0\nPyHamcrest >= 1."
},
{
"path": "python/ycm/__init__.py",
"chars": 0,
"preview": ""
},
{
"path": "python/ycm/base.py",
"chars": 5606,
"preview": "# Copyright (C) 2011, 2012 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you "
},
{
"path": "python/ycm/buffer.py",
"chars": 5163,
"preview": "# Copyright (C) 2016, Davit Samvelyan\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you ca"
},
{
"path": "python/ycm/client/__init__.py",
"chars": 0,
"preview": ""
},
{
"path": "python/ycm/client/base_request.py",
"chars": 11461,
"preview": "# Copyright (C) 2013-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/client/command_request.py",
"chars": 9355,
"preview": "# Copyright (C) 2013 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can re"
},
{
"path": "python/ycm/client/completer_available_request.py",
"chars": 1464,
"preview": "# Copyright (C) 2013 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can re"
},
{
"path": "python/ycm/client/completion_request.py",
"chars": 8476,
"preview": "# Copyright (C) 2013-2019 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/client/debug_info_request.py",
"chars": 3773,
"preview": "# Copyright (C) 2016-2017 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/client/event_notification.py",
"chars": 2226,
"preview": "# Copyright (C) 2013-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/client/inlay_hints_request.py",
"chars": 2151,
"preview": "# Copyright (C) 2022, YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softw"
},
{
"path": "python/ycm/client/messages_request.py",
"chars": 2901,
"preview": "# Copyright (C) 2017 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/client/omni_completion_request.py",
"chars": 1418,
"preview": "# Copyright (C) 2013 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can re"
},
{
"path": "python/ycm/client/resolve_completion_request.py",
"chars": 3675,
"preview": "# Copyright (C) 2020 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/client/semantic_tokens_request.py",
"chars": 2162,
"preview": "# Copyright (C) 2020, YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softw"
},
{
"path": "python/ycm/client/shutdown_request.py",
"chars": 1209,
"preview": "# Copyright (C) 2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/client/signature_help_request.py",
"chars": 3141,
"preview": "# Copyright (C) 2019 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/client/ycmd_keepalive.py",
"chars": 1445,
"preview": "# Copyright (C) 2013 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can re"
},
{
"path": "python/ycm/diagnostic_filter.py",
"chars": 3185,
"preview": "# Copyright (C) 2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softw"
},
{
"path": "python/ycm/diagnostic_interface.py",
"chars": 12806,
"preview": "# Copyright (C) 2013-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/hierarchy_tree.py",
"chars": 6843,
"preview": "# Copyright (C) 2024 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/inlay_hints.py",
"chars": 4208,
"preview": "# Copyright (C) 2022, YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softw"
},
{
"path": "python/ycm/omni_completer.py",
"chars": 5705,
"preview": "# Copyright (C) 2011-2019 ycmd contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: "
},
{
"path": "python/ycm/paths.py",
"chars": 3317,
"preview": "# Copyright (C) 2015-2017 YouCompleteMe contributors.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free "
},
{
"path": "python/ycm/scrolling_range.py",
"chars": 4879,
"preview": "# Copyright (C) 2023, YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softw"
},
{
"path": "python/ycm/semantic_highlighting.py",
"chars": 3982,
"preview": "# Copyright (C) 2020, YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softw"
},
{
"path": "python/ycm/signature_help.py",
"chars": 7097,
"preview": "# Copyright (C) 2011-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/syntax_parse.py",
"chars": 6371,
"preview": "# Copyright (C) 2013 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can re"
},
{
"path": "python/ycm/tests/__init__.py",
"chars": 4670,
"preview": "# Copyright (C) 2016-2020 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/tests/base_test.py",
"chars": 12182,
"preview": "# Copyright (C) 2013 Google Inc.\n# 2020 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe."
},
{
"path": "python/ycm/tests/client/__init__.py",
"chars": 0,
"preview": ""
},
{
"path": "python/ycm/tests/client/base_request_test.py",
"chars": 1760,
"preview": "# Copyright (C) 2017-2018 YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/tests/client/command_request_test.py",
"chars": 10655,
"preview": "# Copyright (C) 2016 YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/tests/client/completion_request_test.py",
"chars": 9479,
"preview": "# Copyright (C) 2015-2019 YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/tests/client/debug_info_request_test.py",
"chars": 5100,
"preview": "# Copyright (C) 2017 YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/tests/client/messages_request_test.py",
"chars": 5563,
"preview": "# Copyright (C) 2017 YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/tests/client/omni_completion_request_test.py",
"chars": 1743,
"preview": "# Copyright (C) 2020 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/tests/command_test.py",
"chars": 5746,
"preview": "# Copyright (C) 2016-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/tests/completion_test.py",
"chars": 16473,
"preview": "# Copyright (C) 2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/tests/diagnostic_filter_test.py",
"chars": 4364,
"preview": "# Copyright (C) 2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softw"
},
{
"path": "python/ycm/tests/diagnostic_interface_test.py",
"chars": 6282,
"preview": "# Copyright (C) 2015-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/tests/event_notification_test.py",
"chars": 23087,
"preview": "# Copyright (C) 2015-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/tests/mock_utils.py",
"chars": 4448,
"preview": "# Copyright (C) 2017 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/tests/omni_completer_test.py",
"chars": 30939,
"preview": "# encoding: utf-8\n#\n# Copyright (C) 2016-2019 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# You"
},
{
"path": "python/ycm/tests/paths_test.py",
"chars": 1791,
"preview": "# Copyright (C) 2016-2017 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/tests/postcomplete_test.py",
"chars": 17818,
"preview": "# encoding: utf-8\n#\n# Copyright (C) 2015-2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# You"
},
{
"path": "python/ycm/tests/signature_help_test.py",
"chars": 1372,
"preview": "# Copyright (C) 2019 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softwa"
},
{
"path": "python/ycm/tests/syntax_parse_test.py",
"chars": 15195,
"preview": "# Copyright (C) 2013 Google Inc.\n# 2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe."
},
{
"path": "python/ycm/tests/test_utils.py",
"chars": 24374,
"preview": "# Copyright (C) 2011-2019 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/tests/testdata/.ycm_extra_conf.py",
"chars": 158,
"preview": "def FlagsForFile( filename, **kwargs ):\n temp_dir = kwargs[ 'client_data' ][ 'tempname()' ]\n\n return {\n 'flags': [ "
},
{
"path": "python/ycm/tests/testdata/cpp_syntax",
"chars": 13958,
"preview": "--- Syntax items ---\ncCustomFunc xxx match /\\w\\+\\s*\\((\\)\\@=/\n links to Function\ncCustomClass xxx "
},
{
"path": "python/ycm/tests/testdata/java_syntax",
"chars": 16040,
"preview": "--- Syntax items ---\nhtmlValue xxx match /=[\\t ]*[^'\" \\t>][^ \\t>]*/hs=s+1 contained contains=javaScriptExpression,"
},
{
"path": "python/ycm/tests/testdata/php_syntax",
"chars": 224308,
"preview": "\n\n--- Syntax items ---\nhtmlValue xxx match /=[\\t ]*[^'\" \\t>][^ \\t>]*/hs=s+1 contained contains=javaScriptExpressio"
},
{
"path": "python/ycm/tests/testdata/python_syntax",
"chars": 4440,
"preview": "--- Syntax items ---\ncCustomFunc xxx match /\\w\\+\\s*\\((\\)\\@=/\n links to Function\ncCustomClass xxx "
},
{
"path": "python/ycm/tests/testdata/uni¢od€/tags",
"chars": 0,
"preview": ""
},
{
"path": "python/ycm/tests/vimsupport_test.py",
"chars": 80613,
"preview": "# Copyright (C) 2015-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/tests/youcompleteme_test.py",
"chars": 48739,
"preview": "# Copyright (C) 2016-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/text_properties.py",
"chars": 3184,
"preview": "# Copyright (C) 2020, YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free softw"
},
{
"path": "python/ycm/unsafe_thread_pool_executor.py",
"chars": 3781,
"preview": "# Copyright 2009 Brian Quinlan. All Rights Reserved.\n# Licensed to PSF under a Contributor Agreement.\n#\n# Copyright (C"
},
{
"path": "python/ycm/vimsupport.py",
"chars": 55215,
"preview": "# Copyright (C) 2011-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "python/ycm/youcompleteme.py",
"chars": 36674,
"preview": "# Copyright (C) 2011-2024 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free s"
},
{
"path": "run_tests.py",
"chars": 3761,
"preview": "#!/usr/bin/env python3\n\nimport argparse\nimport glob\nimport os\nimport os.path as p\nimport subprocess\nimport sys\n\nDIR_OF_T"
},
{
"path": "test/.gitignore",
"chars": 77,
"preview": "Xtest*\ndebuglog\nmessages\ntest.log\n*.res\n*.log\n.coverage.*\n.vim_profile\nlogs/\n"
},
{
"path": "test/.vimspector.json",
"chars": 451,
"preview": "{\n \"$schema\": \"https://puremourning.github.io/vimspector/schema/vimspector.schema.json\",\n \"configurations\": {\n \"Run"
},
{
"path": "test/Makefile",
"chars": 184,
"preview": ".phony: test clean\n\ntest:\n\t./run_vim_tests ${TEST}\n\nclean:\n\trm -f *.log\n\trm -f *.res\n\trm -f debuglog\n\trm -f messages\n\trm"
},
{
"path": "test/README.md",
"chars": 10821,
"preview": "# Quick Start\n\n## Running the tests in docker\n\nTo run the tests in the almost exactly the same environment as CI, use do"
},
{
"path": "test/commands.test.vim",
"chars": 3817,
"preview": "function! SetUp()\n let g:ycm_use_clangd = 1\n let g:ycm_keep_logfiles = 1\n let g:ycm_log_level = 'DEBUG'\n call youcom"
},
{
"path": "test/completion.common.vim",
"chars": 16695,
"preview": "scriptencoding utf-8\n\nfunction! Test_Compl_After_Trigger()\n call youcompleteme#test#setup#OpenFile(\n \\ '/third_p"
},
{
"path": "test/completion.test.vim",
"chars": 935,
"preview": "function! SetUp()\n let g:ycm_use_clangd = 1\n let g:ycm_confirm_extra_conf = 0\n let g:ycm_auto_trigger = 1\n let g:ycm"
},
{
"path": "test/completion_info.test.vim",
"chars": 8305,
"preview": "function! s:AssertInfoPopupNotVisible()\n call WaitForAssert( {-> assert_true(\n \\ popup_findinfo() == 0 ||\n "
},
{
"path": "test/completion_noresolve.test.vim",
"chars": 905,
"preview": "function! SetUp()\n let g:ycm_use_clangd = 1\n let g:ycm_confirm_extra_conf = 0\n let g:ycm_auto_trigger = 1\n let g:ycm"
},
{
"path": "test/diagnostics.test.vim",
"chars": 15035,
"preview": "function! SetUp()\n let g:ycm_use_clangd = 1\n let g:ycm_confirm_extra_conf = 0\n let g:ycm_auto_trigger = 1\n let g:ycm"
},
{
"path": "test/docker/ci/image/Dockerfile",
"chars": 1519,
"preview": "FROM ubuntu:24.04\n\nENV DEBIAN_FRONTEND=noninteractive\nENV LC_ALL C.UTF-8\n\nARG VIM_VERSION=v9.1.0016\nARG YCM_VIM_PYTHON=p"
},
{
"path": "test/docker/ci/push",
"chars": 98,
"preview": "#!/usr/bin/env bash\n\nset -e\n\nARCH=$(uname -m)\n\ndocker push youcompleteme/ycm-vim-${ARCH}-py3:test\n"
},
{
"path": "test/docker/ci/rebuild",
"chars": 270,
"preview": "#!/usr/bin/env bash\n\nset -e\n\nif [ \"$1\" = \"--continue\" ]; then\n OPTS=\"\"\nelse\n OPTS=\"--no-cache\"\nfi\n\nARCH=$(uname -m)\n\nd"
},
{
"path": "test/docker/manual/image/.vim/vimrc",
"chars": 80,
"preview": "runtime defaults.vim\nset rtp+=/home/dev/YouCompleteMe\nfiletype plugin indent on\n"
},
{
"path": "test/docker/manual/image/Dockerfile",
"chars": 570,
"preview": "ARG YCM_PYTHON=py3\nARG ARCH=x86_64\n\nFROM youcompleteme/ycm-vim-${ARCH}-${YCM_PYTHON}:test\n\nRUN apt-get update && \\\n apt"
},
{
"path": "test/docker/manual/push",
"chars": 100,
"preview": "#!/usr/bin/env bash\n\nset -e\n\nARCH=$(uname -m)\n\ndocker push youcompleteme/ycm-vim-${ARCH}-py3:manual\n"
},
{
"path": "test/docker/manual/rebuild",
"chars": 312,
"preview": "#!/usr/bin/env bash\n\nset -e\n\nif [ \"$1\" = \"--continue\" ]; then\n OPTS=\"\"\nelse\n OPTS=\"--no-cache\"\nfi\n\nARCH=$(uname -m)\n\nd"
},
{
"path": "test/docker/manual/run",
"chars": 252,
"preview": "#!/usr/bin/env bash\n\nARCH=$(uname -m)\nCONTAINER=youcompleteme/ycm-vim-${ARCH}-py3:manual\n\npushd $(dirname $0)\n docker r"
},
{
"path": "test/docker/rebuild_all",
"chars": 119,
"preview": "#!/usr/bin/env bash\n\nset -e\n\nfor d in ci manual; do\n pushd $(dirname $0)/$d\n ./rebuild \"$@\"\n ./push\n popd\ndone\n"
},
{
"path": "test/filesize.test.vim",
"chars": 1163,
"preview": "function! SetUp()\n let g:ycm_use_clangd = 1\n let g:ycm_confirm_extra_conf = 0\n let g:ycm_auto_trigger = 1\n let g:ycm"
},
{
"path": "test/finder.test.vim",
"chars": 28202,
"preview": "function! SetUp()\n let g:ycm_use_clangd = 1\n let g:ycm_enable_semantic_highlighting = 1\n call youcompleteme#test#setu"
},
{
"path": "test/fixit.test.vim",
"chars": 1827,
"preview": "function! SetUp()\n let g:ycm_confirm_extra_conf = 0\n let g:ycm_auto_trigger = 1\n let g:ycm_keep_logfiles = 1\n let g:"
},
{
"path": "test/hierarchies.test.vim",
"chars": 9676,
"preview": "function! SetUp()\n let g:ycm_auto_hover = 1\n let g:ycm_auto_trigger = 1\n let g:ycm_keep_logfiles = 1\n let g:ycm_log_"
},
{
"path": "test/hover.test.vim",
"chars": 15049,
"preview": "function! s:CheckNoCommandRequest()\n return youcompleteme#test#commands#CheckNoCommandRequest()\nendfunction\n\nfunction! "
},
{
"path": "test/lib/autoload/youcompleteme/test/commands.vim",
"chars": 526,
"preview": "function! youcompleteme#test#commands#CheckNoCommandRequest() abort\n call WaitForAssert( { ->\n \\ assert_true( py"
},
{
"path": "test/lib/autoload/youcompleteme/test/popup.vim",
"chars": 1901,
"preview": "function! youcompleteme#test#popup#CheckPopupPosition( winid, pos )\n redraw\n let actual_pos = popup_getpos( a:winid )\n"
},
{
"path": "test/lib/autoload/youcompleteme/test/setup.vim",
"chars": 2784,
"preview": "\nfunction! youcompleteme#test#setup#SetUp() abort\n if exists ( 'g:loaded_youcompleteme' )\n unlet g:loaded_youcomplet"
},
{
"path": "test/lib/plugin/completion.vim",
"chars": 2475,
"preview": "function! CheckCompletionItemsContainsExactly( expected_props, ... )\n let prop = 'abbr'\n if a:0 > 0\n let prop = a:1"
},
{
"path": "test/lib/plugin/shared.vim",
"chars": 2508,
"preview": "\n\" Functions shared by several tests.\n\n\" Only load this script once.\nif exists('*WaitFor')\n finish\nendif\n\n\" Run skip th"
},
{
"path": "test/lib/plugin/util.vim",
"chars": 3075,
"preview": "function! CheckCurrentLine( expected_value )\n return assert_equal( a:expected_value, getline( '.' ) )\nendfunction\n\nfunc"
},
{
"path": "test/lib/run_test.vim",
"chars": 10641,
"preview": "\" This script is sourced while editing the .vim file with the tests.\n\" When the script is successful the .res file will "
},
{
"path": "test/run_vim_tests",
"chars": 1876,
"preview": "#!/usr/bin/env bash\n\nif [ \"$1\" == \"--help\" ]; then\n echo \"$(basename $0) <optional list of tests in form file:func>\"\n "
},
{
"path": "test/signature_help.test.vim",
"chars": 27653,
"preview": "let s:timer_interval = 2000\n\nfunction! s:WaitForSigHelpAvailable( filetype )\n let tries = 0\n call WaitFor( {-> s:_Chec"
},
{
"path": "test/testdata/cpp/auto_include.cc",
"chars": 16,
"preview": "int main()\n{\n\n}\n"
},
{
"path": "test/testdata/cpp/auto_include.h",
"chars": 90,
"preview": "#pragma once\n\nstruct Thing\n{\n};\n\nvoid do_a_thing( Thing thing );\nvoid do_another_thing();\n"
},
{
"path": "test/testdata/cpp/auto_include_workaround.cc",
"chars": 87,
"preview": "#include \"auto_include.h\"\n\nvoid do_another_thing()\n{\n}\n\nvoid do_a_thing( Thing t )\n{\n}\n"
},
{
"path": "test/testdata/cpp/complete_with_sig_help.cc",
"chars": 108,
"preview": "#include <stdio.h>\n\nstruct Test\n{\n int this_is_a_thing; int that_is_a_thing;\n};\n\nint main() {\n Test t;\n\n}\n"
},
{
"path": "test/testdata/cpp/completion.cc",
"chars": 507,
"preview": "\nstruct PointInTime\n{\n int point_before_time;\n double age_of_universe;\n char lifetime; // nobody will live > 128 year"
},
{
"path": "test/testdata/cpp/finder_test.cc",
"chars": 113,
"preview": "#include <stdio.h>\n\nstruct Test\n{\n int x_this_is_a_thing; int x_that_is_a_thing;\n};\n\nint main() {\n Test t;\n\n}\n\n"
},
{
"path": "test/testdata/cpp/fixit.cpp",
"chars": 52,
"preview": "#include <stdio.h>\nint main() {\n printf(\"%s\",1);\n}\n"
},
{
"path": "test/testdata/cpp/hierarchies.cc",
"chars": 171,
"preview": "int f();\n\nint g() {\n return f() + f();\n}\n\nint h() {\n int x = g();\n return f() + x;\n}\n\nstruct B0 {};\nstruct B1 :"
},
{
"path": "test/testdata/diagnostics/foo.cpp",
"chars": 4,
"preview": "xxx\n"
},
{
"path": "test/testdata/diagnostics/foo.xml",
"chars": 5,
"preview": "blah\n"
},
{
"path": "test/testdata/python/doc.py",
"chars": 1830,
"preview": "# Comment\ndef Test_OneLine():\n \"\"\"This is the one line output.\"\"\"\n pass\n\ndef Test_MultiLine():\n \"\"\"This is the one li"
},
{
"path": "test/testdata/python/test.py",
"chars": 55,
"preview": "import os; os.path.join( os.path.dirname( __file__ ) )\n"
},
{
"path": "test/testdata/vim/mixed_filetype.vim",
"chars": 64,
"preview": "pyx << EOF\nimport os\nos.path.abspath(\nEOF\n\n\" vim: ft=vim.python\n"
},
{
"path": "test/vimrc",
"chars": 357,
"preview": "runtime defaults.vim\nlet g:ycm_test_plugin_dir = expand( '<sfile>:p:h:h' )\nset mouse=a\nset lines=30\nset columns=80\nset s"
},
{
"path": "tox.ini",
"chars": 174,
"preview": "[flake8]\nignore = E111,E114,E121,E125,E126,E127,E128,E129,E131,E133,E201,E202,E203,E221,E222,E241,E251,E261,E301,E303,E4"
},
{
"path": "update-vim-docs",
"chars": 518,
"preview": "#!/usr/bin/env bash\n\nset -e\nset -x\n\ntmpdir=$(mktemp -d)\npython3 -m venv ${tmpdir}/env\nsource ${tmpdir}/env/bin/activate\n"
},
{
"path": "vimrc_ycm_minimal",
"chars": 590,
"preview": "\" windows default encoding is not supported\nset encoding=utf-8\n\n\" If you using neovim and python isn't loading, copy you"
}
]
About this extraction
This page contains the full source code of the ycm-core/YouCompleteMe GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 141 files (1.4 MB), approximately 380.8k tokens, and a symbol index with 954 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.