[ { "path": ".coveragerc", "content": "[run]\nplugins = covimerage\n\n[report]\nomit =\n */tests/*\n */test/*\n */third_party/*\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false\ncontact_links:\n - name: Questions and support\n url: 'https://github.com/ycm-core/YouCompleteMe/tree/master?tab=readme-ov-file#help-advice-support'\n about: Please ask and answer questions here.\n" }, { "path": ".github/ISSUE_TEMPLATE/issue.md", "content": "---\n\nname: Issue\nabout: Report a bug or suggest an enhancement\n\n---\n\n# Issue Prelude\n\n**Please complete these steps and check these boxes (by putting an `x` inside\nthe brackets) _before_ filing your issue:**\n\n- [ ] I have read and understood YCM's [CONTRIBUTING][cont] document.\n- [ ] I have read and understood YCM's [CODE_OF_CONDUCT][code] document.\n- [ ] I have read and understood YCM's [README][readme], **especially the\n [Frequently Asked Questions][faq] section.**\n- [ ] I have searched YCM's issue tracker to find issues similar to the one I'm\n about to report and couldn't find an answer to my problem. ([Example Google\n search.][search])\n- [ ] If filing a bug report, I have included the output of `vim --version`.\n- [ ] If filing a bug report, I have included the output of `:YcmDebugInfo`.\n- [ ] If filing a bug report, I have attached the contents of the logfiles using\n the `:YcmToggleLogs` command.\n- [ ] If filing a bug report, I have included which OS (including specific OS\n version) I am using.\n- [ ] If filing a bug report, I have included a minimal test case that reproduces\n my issue, using `vim -Nu /path/to/YCM/vimrc_ycm_minimal`, including what I\n expected to happen and what actually happened.\n- [ ] If filing a installation failure report, I have included the entire output\n of `install.py` (or `cmake`/`make`/`ninja`) including its invocation\n- [ ] **I understand this is an open-source project staffed by volunteers and\n that any help I receive is a selfless, heartfelt _gift_ of their free time. I\n know I am not entitled to anything and will be polite and courteous.**\n- [ ] **I understand my issue may be closed if it becomes obvious I didn't\n actually perform all of these steps.**\n\nThank you for adhering to this process! It ensures your issue is resolved\nquickly and that neither your nor our time is needlessly wasted.\n\n# Issue Details\n\n> Provide a clear description of the problem, including the following key\n> questions:\n\n* What did you do?\n\n> Include steps to reproduce here.\n\n1. `vim -Nu /path/to/YCM/ycm_vimrc_minimal`\n2. `:edit test.py`\n3. Enter insert mode and type `.....`\n\n> Include description of a minimal test case, including any actual code required\n> to reproduce the issue.\n\n> If you made changes to `vimrc_ycm_minimal`, pase them here:\n\n```\n\n```\n\n* What did you expect to happen?\n\n> Include description of the expected behaviour.\n\n* What actually happened?\n\n> Include description of the observed behaviour, including actual output,\n> screenshots, etc.\n\n# Diagnostic data\n\n## Output of `vim --version`\n\n```\nPaste output here\n```\n\n## Output of `YcmDebugInfo`\n\n```\nPaste output here\n```\n\n## Output of `YcmDiags`\n\n```\nPaste output here\n```\n\n## Output of `git rev-parse HEAD` in YouCompleteMe installation directory\n\n```\npaste output here\n```\n\n## Contents of YCM, ycmd and completion engine logfiles\n\n> Reproduce the issue with `vim -Nu /path/to/YCM/vimrc_ycm_minimal`, which\n> enabled debug logging and other useful diagnostics. Include a link to a\n> [gist][] containing all of the log files listed by `:YcmToggleLogs`.\n\n## OS version, distribution, etc.\n\n> Include system information here.\n\n## Output of build/install commands\n\n> Include link to a [gist][] containing the invocation and entire output of\n> `install.py` if reporting an installation issue.\n\n[cont]: https://github.com/ycm-core/YouCompleteMe/blob/master/CONTRIBUTING.md\n[code]: https://github.com/ycm-core/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md\n[readme]: https://github.com/ycm-core/YouCompleteMe/blob/master/README.md\n[faq]: https://github.com/ycm-core/YouCompleteMe/wiki/FAQ\n[search]: https://www.google.com/search?q=site%3Ahttps%3A%2F%2Fgithub.com%2Fycm-core%2FYouCompleteMe%2Fissues%20python%20mac\n[gist]: https://gist.github.com/\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "# PR Prelude\n\nThank you for working on YCM! :)\n\n**Please complete these steps and check these boxes (by putting an `x` inside\nthe brackets) _before_ filing your PR:**\n\n- [ ] I have read and understood YCM's [CONTRIBUTING][cont] document.\n- [ ] I have read and understood YCM's [CODE_OF_CONDUCT][code] document.\n- [ ] I have included tests for the changes in my PR. If not, I have included a\n rationale for why I haven't.\n- [ ] **I understand my PR may be closed if it becomes obvious I didn't\n actually perform all of these steps.**\n\n# Why this change is necessary and useful\n\n[Please explain **in detail** why the changes in this PR are needed.]\n\n[cont]: https://github.com/ycm-core/YouCompleteMe/blob/master/CONTRIBUTING.md\n[code]: https://github.com/ycm-core/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\n\non:\n workflow_dispatch:\n pull_request:\n push:\n branches:\n - master\n\njobs:\n python-tests:\n strategy:\n fail-fast: false\n matrix:\n runs-on: [ ubuntu-24.04, macos-14 ]\n python-arch: [ 'x64' ]\n include:\n - runs-on: macos-14\n python-arch: 'arm64'\n exclude:\n - runs-on: macos-14\n python-arch: \"x64\"\n env:\n COVERAGE: true\n name: \"${{ matrix.runs-on }} - Python 3.12 ${{ matrix.python-arch }}\"\n runs-on: ${{ matrix.runs-on }}\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: recursive\n fetch-depth: 0\n - name: Install Python\n uses: actions/setup-python@v5\n with:\n python-version: \"3.12\"\n architecture: ${{ matrix.python-arch }}\n - name: Run pip\n run: python3 -m pip install -r python/test_requirements.txt\n - name: Run tests\n run: python3 run_tests.py --quiet python/ycm/tests\n - name: summarise coverage\n run: coverage xml\n - name: Upload coverage data\n uses: codecov/codecov-action@v4\n with:\n name: \"${{ runner.os }}-3.12-${{ matrix.python-arch }}\"\n token: ${{ secrets.CODECOV_TOKEN }}\n\n vim-tests:\n strategy:\n fail-fast: false\n matrix:\n vim: [ 'new', 'old' ]\n arch: [ 'x86_64' ]\n runs-on: ubuntu-24.04\n container: 'youcompleteme/ycm-vim-${{ matrix.arch }}-py3:test'\n env:\n COVERAGE: true\n YCM_TEST_STDOUT: true\n name: \"Vim tests - ${{ matrix.vim }}\"\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: recursive\n fetch-depth: 0\n - name: Install dependencies\n run: sudo -H pip3 install --break-system-packages -r python/test_requirements.txt\n - name: Install Java\n uses: actions/setup-java@v4\n with:\n java-version: 21\n distribution: 'temurin'\n - name: Build ycmd\n run: python3 ./install.py --force-sudo --ts-completer --clangd-completer --java-completer\n - name: Run tests in old vim\n # System vim should be oldest supported.\n if: matrix.vim == 'old'\n run: ./test/run_vim_tests --vim /usr/bin/vim\n - name: Run tests in new vim\n if: matrix.vim == 'new'\n run: ./test/run_vim_tests\n - name: Combine and summarise coverage\n run: coverage combine && coverage xml\n - name: Upload coverage data\n uses: codecov/codecov-action@v4\n with:\n name: \"vim-tests-${{ matrix.vim }}\"\n token: ${{ secrets.CODECOV_TOKEN }}\n" }, { "path": ".github/workflows/lock_old_issues.yaml", "content": "name: \"Lock Old Issues\"\n\non:\n schedule:\n - cron: '0 0 * * *'\n workflow_dispatch:\n\njobs:\n lock:\n runs-on: ubuntu-latest\n steps:\n - uses: dessant/lock-threads@v2\n with:\n github-token: ${{ github.token }}\n issue-lock-inactive-days: '60'\n # issue-exclude-created-before: ''\n # issue-exclude-labels: ''\n # issue-lock-labels: ''\n # issue-lock-comment: ''\n # issue-lock-reason: 'resolved'\n # pr-lock-inactive-days: '365'\n # pr-exclude-created-before: ''\n # pr-exclude-labels: ''\n # pr-lock-labels: ''\n # pr-lock-comment: ''\n # pr-lock-reason: 'resolved'\n process-only: 'issues'\n" }, { "path": ".github/workflows/update_vim_docs.yaml", "content": "name: \"Update vim docs\"\n\non:\n push:\n branches:\n - master\n paths:\n - 'README.md'\n workflow_dispatch:\n\njobs:\n update-vim-docs:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v2\n - name: 'Update local repo'\n run: './update-vim-docs'\n - name: 'Check diffs'\n run: 'git diff'\n - name: 'Create pull request'\n uses: peter-evans/create-pull-request@v4\n id: cpr\n with:\n token: ${{ secrets.VIMSPECTOR_UPDATE_BOT_PAT }}\n push-to-fork: VimspectorUpdateBot/YouCompleteMe\n commit-message: \"Update vim docs\"\n branch: 'auto/update-vim-docs'\n delete-branch: true\n title: \"[Auto] Update vim docs\"\n body: \"Update the vim docs after recent changes\"\n labels: \"auto\"\n - name: Check outputs\n run: |\n echo \"Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}\"\n echo \"Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}\"\n" }, { "path": ".gitignore", "content": "# 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*.lai\n*.la\n*.a\n\n# Python\n*.py[cod]\n\n# Installer logs\npip-log.txt\n\n# Unit test / coverage reports\n.coverage\ncover/\n.tox\nnosetests.xml\n.noseids\n\n#Translations\n*.mo\n\n#Mr Developer\n.mr.developer.cfg\n\n# custom\nycm_core_tests\n\n# When we use the bcp tool to copy over the parts of boost we care about, it\n# also copies some cruft files we don't need; this ignores them\ncpp/BoostParts/libs/*/build\ncpp/BoostParts/libs/*/test\n\n# These folders in cpp/llvm contain lots of upstream cruft we don't care\n# about and would rather not have in our tree...\ncpp/llvm/docs/*\ncpp/llvm/tools/clang/www/*\n\n# ... but excluding these LLVMBuild.txt files breaks the build so we need to\n# explicitely include them\n!LLVMBuild.txt\n\n# Exclude auto generated vim doc tags.\ndoc/tags\n\n# Coverage files\n.coverage\n.coverage.*\ncoverage.xml\n.readme.utf-8.add.spl\n" }, { "path": ".gitmodules", "content": "[submodule \"third_party/ycmd\"]\n\tpath = third_party/ycmd\n\turl = https://github.com/ycm-core/ycmd\n" }, { "path": ".mergify.yml", "content": "# https://blog.mergify.com/strict-mode-deprecation/\nqueue_rules:\n - name: duplicated default from Automatic merge on Azure Pipelines and Reviewable\n successes\n queue_conditions:\n - base=master\n - \"#approved-reviews-by>=2\"\n - status-success=ubuntu-24.04 - Python 3.9 x64\n - status-success=macos-14 - Python 3.9 arm64\n # - status-success=windows-2019 - Python 3.9 x64\n # - status-success=windows-2019 - Python 3.9 x86\n - status-success=Vim tests - new\n - status-success=Vim tests - old\n - status-success=code-review/reviewable\n merge_conditions:\n - status-success=ubuntu-24.04 - Python 3.9 x64\n - status-success=macos-14 - Python 3.9 arm64\n - status-success=windows-2019 - Python 3.9 x64\n - status-success=windows-2019 - Python 3.9 x86\n - status-success=Vim tests - new\n - status-success=Vim tests - old\n merge_method: merge\n - name: duplicated default from Manual merge on Azure Pipelines and Maintainer Override\n queue_conditions:\n - base=master\n - status-success=ubuntu-24.04 - Python 3.9 x64\n - status-success=macos-14 - Python 3.9 arm64\n - status-success=windows-2019 - Python 3.9 x64\n - status-success=windows-2019 - Python 3.9 x86\n - status-success=Vim tests - new\n - status-success=Vim tests - old\n - \"#approved-reviews-by>=1\"\n - \"#changes-requested-reviews-by=0\"\n - label=\"Ship It!\"\n merge_conditions:\n - status-success=ubuntu-24.04 - Python 3.9 x64\n - status-success=macos-14 - Python 3.9 arm64\n - status-success=windows-2019 - Python 3.9 x64\n - status-success=windows-2019 - Python 3.9 x86\n - status-success=Vim tests - new\n - status-success=Vim tests - old\n merge_method: merge\n - name: duplicated default from Manual merge on Pipelines and Maintainer Override\n from owner PR\n queue_conditions:\n - base=master\n - author=puremourning\n - status-success=ubuntu-24.04 - Python 3.9 x64\n - status-success=macos-14 - Python 3.9 arm64\n - status-success=windows-2019 - Python 3.9 x64\n - status-success=windows-2019 - Python 3.9 x86\n - status-success=Vim tests - new\n - status-success=Vim tests - old\n - \"#changes-requested-reviews-by=0\"\n - label=\"Ship It!\"\n merge_conditions:\n - status-success=ubuntu-24.04 - Python 3.9 x64\n - status-success=macos-14 - Python 3.9 arm64\n - status-success=windows-2019 - Python 3.9 x64\n - status-success=windows-2019 - Python 3.9 x86\n - status-success=Vim tests - new\n - status-success=Vim tests - old\n merge_method: merge\n - name: duplicated default from Merge auto pr when approved\n queue_conditions:\n - author=VimspectorUpdateBot\n - label=auto\n - base=master\n - status-success=code-review/reviewable\n - \"#approved-reviews-by>=1\"\n - \"#changes-requested-reviews-by=0\"\n merge_conditions:\n - status-success=ubuntu-24.04 - Python 3.9 x64\n - status-success=macos-14 - Python 3.9 arm64\n - status-success=windows-2019 - Python 3.9 x64\n - status-success=windows-2019 - Python 3.9 x86\n - status-success=Vim tests - new\n - status-success=Vim tests - old\n merge_method: merge\n\npull_request_rules:\n - name: Automatic merge on Azure Pipelines and Reviewable successes\n conditions:\n - base=master\n - \"#approved-reviews-by>=2\"\n - status-success=ubuntu-24.04 - Python 3.9 x64\n - status-success=macos-14 - Python 3.9 arm64\n # - status-success=windows-2019 - Python 3.9 x64\n # - status-success=windows-2019 - Python 3.9 x86\n - status-success=Vim tests - new\n - status-success=Vim tests - old\n - status-success=code-review/reviewable\n actions: &merge-actions\n comment:\n message: Thanks for sending a PR!\n\n - name: Manual merge on Azure Pipelines and Maintainer Override\n conditions:\n - base=master\n - status-success=ubuntu-24.04 - Python 3.9 x64\n - status-success=macos-14 - Python 3.9 arm64\n # - status-success=windows-2019 - Python 3.9 x64\n # - status-success=windows-2019 - Python 3.9 x86\n - status-success=Vim tests - new\n - status-success=Vim tests - old\n\n - \"#approved-reviews-by>=1\"\n - \"#changes-requested-reviews-by=0\"\n\n - label=\"Ship It!\"\n actions:\n <<: *merge-actions\n - name: Manual merge on Pipelines and Maintainer Override from owner PR\n conditions:\n - base=master\n - author=puremourning\n - status-success=ubuntu-24.04 - Python 3.9 x64\n - status-success=macos-14 - Python 3.9 arm64\n # - status-success=windows-2019 - Python 3.9 x64\n # - status-success=windows-2019 - Python 3.9 x86\n - status-success=Vim tests - new\n - status-success=Vim tests - old\n\n - \"#changes-requested-reviews-by=0\"\n - label=\"Ship It!\"\n actions:\n <<: *merge-actions\n - name: Merge auto pr when approved\n conditions:\n - author=VimspectorUpdateBot\n - label=auto\n - base=master\n # Review\n - status-success=code-review/reviewable\n - \"#approved-reviews-by>=1\"\n - \"#changes-requested-reviews-by=0\"\n actions:\n <<: *merge-actions\n - name: Automatic merge on Azure Pipelines and Reviewable successes + Manual merge\n on Azure Pipelines and Maintainer Override + Manual merge on Pipelines and Maintainer\n Override from owner PR + Merge auto pr when approved\n conditions: []\n actions:\n queue:\n" }, { "path": ".readme.utf-8.add", "content": "AST\nAutocommands\nCMake\nCUDA\nCompleters\nCtags\nCtrl\nCursorHold\nDoxygen\nEclim\nEclim's\nFixIt\nFreenode\nGitter\nGoTo\nGopls\nHomebrew\nHomebrew\nICCF\nJDK\nJSON\nKotlin\nLLVM\nLSP\nLTS\nListToggle\nMSVC\nMacVim\nNeovim\nOmniSharp\nOmnisharp\nSyntastic\nTSServer\nTypeScript\nUltiSnips\nVimScript\nVimspector\nVundle\nWB\nYCM\nYCM's\nYcmCompleter\nYouCompleteMe\nasciicast\nasync\nautocommand\nclangd\nclangd's\nclasspath\ncoc\ncompiledb\ncompleteopt\ncompleters\nconf\nconfig\nconfiguration\ncsharp\nctags\ndocstrings\necho'd\nfilepath\nfilesystem\nfiletype\nfiletypes\nfreenode\nglobbing\ngopls\ngradle\ngvim\njavadoc\njdt\njs\nkeypress\nlagginess\nlibclang\nlightline\nlsp\nmacOS\nmd\nnpm\nomnicomplete\nomnicompletion\nomnifunc\nomnifuncs\nonType\npopup\nprecompiled\npy\nquickfix\nrealtime\nrls\nstatusline\nsys\ntoolchain\nunicode\nunsetting\nv3\nvimrc\nwhitelist\nwhitelisted\nwhitespace\nxbuild\nxml\nycm\nycmd\nycmd's\n" }, { "path": ".vimspector.json", "content": "{\n \"$schema\": \"https://puremourning.github.io/vimspector/schema/vimspector.schema.json\",\n \"configurations\": {\n \"Python: Attach To Vim\": {\n \"variables\": {\n \"port\": \"5678\",\n \"host\": \"localhost\"\n },\n \"adapter\": \"multi-session\",\n \"configuration\": {\n \"request\": \"attach\"\n }\n },\n \"python - launch pytest\": {\n \"adapter\": \"debugpy\",\n \"variables\": [\n {\n \"python\": {\n \"shell\": \"/bin/bash -c 'if [ -z \\\"${dollar}VIRTUAL_ENV\\\" ]; then echo $$(which python3); else echo \\\"${dollar}VIRTUAL_ENV/bin/python\\\"; fi'\"\n }\n },\n {\n \"python_path\": {\n \"shell\": [\n \"${python}\",\n \"${workspaceRoot}/run_tests.py\",\n \"--dump-path\"\n ]\n }\n }\n ],\n \"configuration\": {\n \"name\": \"Python run test\",\n \"type\": \"debugpy\",\n \"request\": \"launch\",\n\n \"cwd\": \"${workspaceRoot}\",\n \"stopOnEntry\": false,\n \"console\": \"integratedTerminal\",\n \"justMyCode\": true,\n \"logToFile\": true,\n \"showReturnValue\": true,\n\n \"debugOptions\": [],\n\n \"module\": \"unittest\",\n \"python\": \"${python}\",\n \"args\": [\n \"-v\",\n \"${Test}\"\n ],\n \"env\": {\n \"PYTHONPATH\": \"${python_path}\",\n \"LD_LIBRARY_PATH\": \"${workspaceRoot}/third_party/ycmd/third_party/clang/lib\",\n \"YCM_TEST_NO_RETRY\": \"1\"\n }\n }\n }\n }\n}\n" }, { "path": ".ycm_extra_conf.py", "content": "# This file is NOT licensed under the GPLv3, which is the license for the rest\n# of YouCompleteMe.\n#\n# Here's the license text for this file:\n#\n# This is free and unencumbered software released into the public domain.\n#\n# Anyone is free to copy, modify, publish, use, compile, sell, or\n# distribute this software, either in source code form or as a compiled\n# binary, for any purpose, commercial or non-commercial, and by any\n# means.\n#\n# In jurisdictions that recognize copyright laws, the author or authors\n# of this software dedicate any and all copyright interest in the\n# software to the public domain. We make this dedication for the benefit\n# of the public at large and to the detriment of our heirs and\n# successors. We intend this dedication to be an overt act of\n# relinquishment in perpetuity of all present and future rights to this\n# software under copyright law.\n#\n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\n# IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR\n# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\n# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\n# OTHER DEALINGS IN THE SOFTWARE.\n#\n# For more information, please refer to \n\nimport os.path as p\nimport subprocess\n\nDIR_OF_THIS_SCRIPT = p.abspath( p.dirname( __file__ ) )\nDIR_OF_THIRD_PARTY = p.join( DIR_OF_THIS_SCRIPT, 'third_party' )\n\n\ndef GetStandardLibraryIndexInSysPath( sys_path ):\n for index, path in enumerate( sys_path ):\n if p.isfile( p.join( path, 'os.py' ) ):\n return index\n raise RuntimeError( 'Could not find standard library path in Python path.' )\n\n\ndef PythonSysPath( **kwargs ):\n sys_path = kwargs[ 'sys_path' ]\n\n dependencies = [ p.join( DIR_OF_THIS_SCRIPT, 'python' ),\n p.join( DIR_OF_THIRD_PARTY, 'requests-futures' ),\n p.join( DIR_OF_THIRD_PARTY, 'ycmd' ),\n p.join( DIR_OF_THIRD_PARTY, 'requests_deps', 'idna' ),\n p.join( DIR_OF_THIRD_PARTY, 'requests_deps', 'chardet' ),\n p.join( DIR_OF_THIRD_PARTY,\n 'requests_deps',\n 'urllib3',\n 'src' ),\n p.join( DIR_OF_THIRD_PARTY, 'requests_deps', 'certifi' ),\n p.join( DIR_OF_THIRD_PARTY, 'requests_deps', 'requests' ) ]\n\n # The concurrent.futures module is part of the standard library on Python 3.\n interpreter_path = kwargs[ 'interpreter_path' ]\n major_version = int( subprocess.check_output( [\n interpreter_path, '-c', 'import sys; print( sys.version_info[ 0 ] )' ]\n ).rstrip().decode( 'utf8' ) )\n if major_version == 2:\n dependencies.append( p.join( DIR_OF_THIRD_PARTY, 'pythonfutures' ) )\n\n sys_path[ 0:0 ] = dependencies\n sys_path.insert( GetStandardLibraryIndexInSysPath( sys_path ) + 1,\n p.join( DIR_OF_THIRD_PARTY, 'python-future', 'src' ) )\n\n return sys_path\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "We, the maintainers, pledge to treat all contributors with respect and require that contributors reciprocate.\n\nThe maintainers will not tolerate unwelcome, impolite, abusive or unprofessional behaviour.\n\nAt the discretion of the maintainers, users who persist in behaving in a way that is unwelcome may be subject to a ban.\n\nThis applies to all interactions related to this project and any associated projects.\n" }, { "path": "CONTRIBUTING.md", "content": "Writing issue reports\n=====================\n\n### Bugs and features only\n\nFirst things first: **the issue tracker is NOT for tech support**. It is for\nreporting bugs and requesting features. If your issue amounts to \"I can't get\nYCM to work on my machine\" and the reason why is obviously related to your\nmachine configuration and the problem would not be resolved with _reasonable_\nchanges to the YCM codebase, then the issue is likely to be closed.\n\n### Where to go for help\n\n**A good place to ask questions is the [Gitter room][gitter] or the\n[ycm-users][] Google group**. Rule of thumb: if you're not sure whether your\nproblem is a real bug, ask on the room or the group. \n\nDon't go to `#vim` on freenode for support. See the \n[readme][help-advice-support] for further help.\n\n### Installation problem - read the docs\n\n**YCM compiles just fine**; [the build bots say so][build-bots]. If the bots are\ngreen and YCM doesn't compile on your machine, then _your machine is the root\ncause_. Now read the first paragraph again.\n\nRealize that quite literally _thousands_ of people have gotten YCM to work\nsuccessfully so if you can't, it's probably because you have a peculiar\nsystem/Vim configuration or you didn't go through the docs carefully enough.\nIt's very unlikely to be caused by an actual bug in YCM because someone would\nhave already found it and reported it.\n\nThis leads us to point #2: **make sure you have checked the docs before\nreporting an issue**. The docs are extensive and cover a ton of things; there's\nalso an FAQ at the bottom that quite possibly addresses your problem.\n\nFor installation problems, make sure that any issue report includes the entire\noutput of any build or installation commands, including **the command used to\nrun them**.\n\nFor common issues such as \"the ycmd server SHUT DOWN\", please check the GitHub\nWiki.\n\n### Other problems - check the issue tracker\n\nFurther, **search the issue tracker for similar issues** before creating a new\none. There's no point in duplication; if an existing issue addresses your\nproblem, please comment there instead of creating a duplicate. However, if the\nissue you found is **closed as resolved** (e.g. with a PR or the original user's\nproblem was resolved), raise a **new issue**, because you've found a new\nproblem. Reference the original issue if you think that's useful information.\n\nPlease note: Closed issues which have been inactive for 60 days will be locked,\nthis helps to keep discussions focussed. If you believe you are still\nexperiencing an issue which has been closed, please raise a new issue,\ncompleting the issue template.\n\nIf you do find a similar _open_ issue, **don't just post 'me too' or similar**\nresponses. This almost never helps resolve the issue, and just causes noise for\nthe maintainers. Only post if it will aid the maintainers in solving the issue;\nif there are existing diagnostics requested in the thread, perform\nthem and post the results.\n\nWhen replying, follow the instructions for getting the required diagnostics for\nposting a new issue (see below), and add them to your response. This is likely\nto help the maintainers find a fix for you, rather than have them spend time\nrequesting them again. To be clear, the maintainers *always* need the\ndiagnostics (debug info, log files, versions, etc.) even for responses on\nexisting issues.\n\nYou should also **search the archives of the [ycm-users][] mailing list**.\n\n### Check your YCM version\n\nLastly, **make sure you are running the latest version of YCM**. The issue you\nhave encountered may have already been fixed. **Don't forget to recompile\nycm_core.so too** (usually by just running `install.py` again).\n\n## Creating an issue \n\nOK, so we've reached this far. You need to create an issue. First realize that\nthe time it takes to fix your issue is a multiple of how long it takes the\ndeveloper to reproduce it. The easier it is to reproduce, the quicker it'll be\nfixed.\n\nHere are the things you should do when creating an issue:\n\n1. Most importantly, **read and complete the issue template**. The maintainers\n rely on the style and structure of the issue template to quickly resolve your\n issue. If you don't complete it in full, then the maintainers may elect to\n ignore or simply close your issue. This isn't personal, it's just that they\n are busy too.\n2. **Check that your issue reproduces with a minimal configuration**. Run `vim\n -Nu /path/to/YCM/vimrc_ycm_minimal` and reproduce this issue. If it doesn't\n repro, then copy your ycm-specific settings into this file and try again. If\n it still doesn't repro, the issue is likely with another plugin.\n3. **Write a step-by-step procedure that when performed repeatedly reproduces\n your issue.** If we can't reproduce the issue, then we can't fix it. It's\n that simple.\n4. Explain **what you expected to happen**, and **what actually happened**.\n This helps us understand if it is a bug, or just a misunderstanding of the\n behavior.\n5. Add the output of [the `:YcmDebugInfo` command][ycm-debug-info-command]. Make\n sure that when you run this, your cursor is in the file that is experiencing\n the issue.\n6. Reproduce your issue using `vim -Nu /path/to/YCM/vimrc_ycm_minimal` \n and attach the contents of the logfiles. Use [the\n `:YcmToggleLogs` command][ycm-toggle-logs-command] to directly open them in\n Vim.\n7. **Create a test case for your issue**. This is critical. Don't talk about how\n \"when I have X in my file\" or similar, _create a file with X in it_ and put\n the contents inside code blocks in your issue description. Try to make this\n test file _as small as possible_. Don't just paste a huge, 500 line source\n file you were editing and present that as a test. _Minimize_ the file so that\n the problem is reproduced with the smallest possible amount of test data.\n8. **Include your OS and OS version.**\n9. **Include the output of `vim --version`.**\n\n\nCreating good pull requests\n===========================\n\n1. **Follow the code style of the existing codebase.**\n - The Python code **DOES NOT** follow PEP 8. This is not an oversight, this\n is by choice. You can dislike this as much as you want, but you still need\n to follow the existing style. Look at other Python files to see what the\n style is.\n - The C++ code has an automated formatter (`style_format.sh` that runs\n `astyle`) but it's not perfect. Again, look at the other C++ files and\n match the code style you see.\n - Same thing for VimScript. Match the style of the existing code.\n\n2. **Your code needs to be well written and easy to maintain**. This is of the\n _utmost_ importance. Other people will have to maintain your code so don't\n just throw stuff against the wall until things kinda work.\n\n3. **Split your pull request into several smaller ones if possible.** This\n makes it easier to review your changes, which means they will be merged\n faster.\n\n4. **Write tests for your code**. If you're changing the VimScript code then\n you don't have to since it's hard to test that code. This is also why you\n should strive to implement your change in Python if at all possible (and if\n it makes sense to do so). Python is also _much_ faster than VimScript.\n\n5. **Explain in detail why your pull request makes sense.** Ask yourself, would\n this feature be helpful to others? Not just a few people, but a lot of YCM’s\n users? See, good features are useful to many. If your feature is only useful\n to you and _maybe_ a couple of others, then that’s not a good feature.\n There is such a thing as “feature overload”. When software accumulates so\n many features of which most are only useful to a handful, then that software\n has become “bloated”. We don’t want that.\n\n Requests for features that are obscure or are helpful to but a few, or are\n not part of YCM's \"vision\" will be rejected. Yes, even if you provide a\n patch that completely implements it.\n\n Please include details on exactly what you would like to see, and why. The\n why is important - it's not always clear why a feature is really useful. And\n sometimes what you want can be done in a different way if the reason for the\n change is known. _What goal is your change trying to accomplish?_\n\n\n[build-bots]: https://dev.azure.com/YouCompleteMe/YCM/_build/latest?definitionId=1&branchName=master\n[ycm-users]: https://groups.google.com/forum/?hl=en#!forum/ycm-users\n[gitter]: https://gitter.im/Valloric/YouCompleteMe\n[help-advice-support]: https://github.com/ycm-core/YouCompleteMe#help-advice-support\n[ycm-debug-info-command]: https://github.com/ycm-core/YouCompleteMe#the-ycmdebuginfo-command\n[ycm-toggle-logs-command]: https://github.com/ycm-core/YouCompleteMe#the-ycmtogglelogs-command\n" }, { "path": "COPYING.txt", "content": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU General Public License is a free, copyleft license for\nsoftware and other kinds of works.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nthe GNU General Public License is intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users. We, the Free Software Foundation, use the\nGNU General Public License for most of our software; it applies also to\nany other work released this way by its authors. You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n To protect your rights, we need to prevent others from denying you\nthese rights or asking you to surrender the rights. Therefore, you have\ncertain responsibilities if you distribute copies of the software, or if\nyou modify it: responsibilities to respect the freedom of others.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must pass on to the recipients the same\nfreedoms that you received. You must make sure that they, too, receive\nor can get the source code. And you must show them these terms so they\nknow their rights.\n\n Developers that use the GNU GPL protect your rights with two steps:\n(1) assert copyright on the software, and (2) offer you this License\ngiving you legal permission to copy, distribute and/or modify it.\n\n For the developers' and authors' protection, the GPL clearly explains\nthat there is no warranty for this free software. For both users' and\nauthors' sake, the GPL requires that modified versions be marked as\nchanged, so that their problems will not be attributed erroneously to\nauthors of previous versions.\n\n Some devices are designed to deny users access to install or run\nmodified versions of the software inside them, although the manufacturer\ncan do so. This is fundamentally incompatible with the aim of\nprotecting users' freedom to change the software. The systematic\npattern of such abuse occurs in the area of products for individuals to\nuse, which is precisely where it is most unacceptable. Therefore, we\nhave designed this version of the GPL to prohibit the practice for those\nproducts. If such problems arise substantially in other domains, we\nstand ready to extend this provision to those domains in future versions\nof the GPL, as needed to protect the freedom of users.\n\n Finally, every program is threatened constantly by software patents.\nStates should not allow patents to restrict development and use of\nsoftware on general-purpose computers, but in those that do, we wish to\navoid the special danger that patents applied to a free program could\nmake it effectively proprietary. To prevent this, the GPL assures that\npatents cannot be used to render the program non-free.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Use with the GNU Affero General Public License.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU Affero General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the special requirements of the GNU Affero General Public License,\nsection 13, concerning interaction through a network will apply to the\ncombination as such.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If the program does terminal interaction, make it output a short\nnotice like this when it starts in an interactive mode:\n\n Copyright (C) \n This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\n This is free software, and you are welcome to redistribute it\n under certain conditions; type `show c' for details.\n\nThe hypothetical commands `show w' and `show c' should show the appropriate\nparts of the General Public License. Of course, your program's commands\nmight be different; for a GUI interface, you would use an \"about box\".\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU GPL, see\n.\n\n The GNU General Public License does not permit incorporating your program\ninto proprietary programs. If your program is a subroutine library, you\nmay consider it more useful to permit linking proprietary applications with\nthe library. If this is what you want to do, use the GNU Lesser General\nPublic License instead of this License. But first, please read\n.\n" }, { "path": "README.md", "content": "YouCompleteMe: a code-completion engine for Vim\n===============================================\n\n[![Gitter room](https://img.shields.io/gitter/room/Valloric/YouCompleteMe.svg)](https://gitter.im/Valloric/YouCompleteMe)\n[![Build status](https://dev.azure.com/YouCompleteMe/YCM/_apis/build/status/ycm-core.YouCompleteMe?branchName=master)](https://dev.azure.com/YouCompleteMe/YCM/_build?definitionId=3&branchName=master)\n[![Coverage status](https://img.shields.io/codecov/c/github/ycm-core/YouCompleteMe/master.svg)](https://codecov.io/gh/ycm-core/YouCompleteMe)\n\nHelp, Advice, Support\n---------------------\n\nLooking for help, advice, or support? Having problems getting YCM to work?\n\nFirst carefully read the [installation instructions](#installation) for your OS.\nWe recommend you use the supplied `install.py` - the \"full\" installation guide\nis for rare, advanced use cases and most users should use `install.py`.\n\nIf the server isn't starting and you're getting a \"YouCompleteMe unavailable\"\nerror, check the [Troubleshooting][wiki-troubleshooting] guide.\n\nNext, check the [User Guide](#user-guide) section on the semantic completer that\nyou are using. For C/C++/Objective-C/Objective-C++/CUDA, you _must_ read [this\nsection](#c-family-semantic-completion).\n\nFinally, check the [FAQ][wiki-faq].\n\nIf, after reading the installation and user guides, and checking the FAQ, you're\nstill having trouble, check the [contacts](#contact) section below for how to\nget in touch.\n\nPlease do **NOT** go to #vim on Freenode for support. Please contact the\nYouCompleteMe maintainers directly using the [contact details](#contact) below.\n\n# Vundle\n\nPlease note that the below instructions suggest using Vundle. Currently there\nare problems with Vundle, so here are some [alternative instructions](https://github.com/ycm-core/YouCompleteMe/issues/4134#issuecomment-1446235584) using Vim packages.\n\nContents\n--------\n\n- [Intro](#intro)\n- [Installation](#installation)\n - [Requirements](#requirements)\n - [macOS](#macos)\n - [Linux 64-bit](#linux-64-bit)\n - [Windows](#windows)\n - [Full Installation Guide](#full-installation-guide)\n- [Quick Feature Summary](#quick-feature-summary)\n- [User Guide](#user-guide)\n - [General Usage](#general-usage)\n - [Client-Server Architecture](#client-server-architecture)\n - [Completion String Ranking](#completion-string-ranking)\n - [General Semantic Completion](#general-semantic-completion)\n - [Signature Help](#signature-help)\n - [Semantic Highlighting](#semantic-highlighting)\n - [Inlay Hints](#inlay-hints)\n - [C-family Semantic Completion](#c-family-semantic-completion)\n - [Java Semantic Completion](#java-semantic-completion)\n - [C# Semantic Completion](#c-semantic-completion)\n - [Python Semantic Completion](#python-semantic-completion)\n - [Rust Semantic Completion](#rust-semantic-completion)\n - [Go Semantic Completion](#go-semantic-completion)\n - [JavaScript and TypeScript Semantic Completion](#javascript-and-typescript-semantic-completion)\n - [Semantic Completion for Other Languages](#semantic-completion-for-other-languages)\n - [LSP Configuration](#lsp-configuration)\n - [Writing New Semantic Completers](#writing-new-semantic-completers)\n - [Diagnostic Display](#diagnostic-display)\n - [Diagnostic Highlighting Groups](#diagnostic-highlighting-groups)\n - [Symbol Search](#symbol-search)\n - [Type/Call Hierarchy](#typecall-hierarchy)\n- [Commands](#commands)\n - [YcmCompleter subcommands](#ycmcompleter-subcommands)\n - [GoTo Commands](#goto-commands)\n - [Semantic Information Commands](#semantic-information-commands)\n - [Refactoring Commands](#refactoring-commands)\n - [Miscellaneous Commands](#miscellaneous-commands)\n- [Functions](#functions)\n- [Autocommands](#autocommands)\n- [Options](#options)\n- [FAQ](#faq)\n- [Contributor Code of Conduct](#contributor-code-of-conduct)\n- [Contact](#contact)\n- [License](#license)\n- [Sponsorship](#sponsorship)\n\n\nIntro\n-----\n\nYouCompleteMe is a fast, as-you-type, fuzzy-search code completion,\ncomprehension and refactoring engine for [Vim][].\n\nIt has several completion engines built-in and supports any protocol-compliant\nLanguage Server, so can work with practically any language. YouCompleteMe\ncontains:\n\n- an identifier-based engine that works with every programming language,\n- a powerful [clangd][]-based engine that provides native semantic code\n completion for C/C++/Objective-C/Objective-C++/CUDA (from now on referred to\n as \"the C-family languages\"),\n- a [Jedi][]-based completion engine for Python 2 and 3,\n- an [OmniSharp-Roslyn][]-based completion engine for C#,\n- a [Gopls][]-based completion engine for Go,\n- a [TSServer][]-based completion engine for JavaScript and TypeScript,\n- a [rust-analyzer][]-based completion engine for Rust,\n- a [jdt.ls][]-based completion engine for Java.\n- a [generic Language Server Protocol implementation for any language](#plugging-an-arbitrary-lsp-server)\n- and an omnifunc-based completer that uses data from Vim's omnicomplete system\n to provide semantic completions for many other languages (Ruby, PHP, etc.).\n\n![YouCompleteMe GIF completion demo](https://i.imgur.com/0OP4ood.gif)\n\nHere's an explanation of what happened in the last GIF demo above.\n\nFirst, realize that **no keyboard shortcuts had to be pressed** to get the list\nof completion candidates at any point in the demo. The user just types and the\nsuggestions pop up by themselves. If the user doesn't find the completion\nsuggestions relevant and/or just wants to type, they can do so; the completion\nengine will not interfere.\n\nWhen the user sees a useful completion string being offered, they press the TAB\nkey to accept it. This inserts the completion string. Repeated presses of the\nTAB key cycle through the offered completions.\n\nIf the offered completions are not relevant enough, the user can continue typing\nto further filter out unwanted completions.\n\nA critical thing to notice is that the completion **filtering is NOT based on\nthe input being a string prefix of the completion** (but that works too). The\ninput needs to be a _[subsequence][] match_ of a completion. This is a fancy way\nof saying that any input characters need to be present in a completion string in\nthe order in which they appear in the input. So `abc` is a subsequence of\n`xaybgc`, but not of `xbyxaxxc`. After the filter, a complicated sorting system\nranks the completion strings so that the most relevant ones rise to the top of\nthe menu (so you usually need to press TAB just once).\n\n**All of the above works with any programming language** because of the\nidentifier-based completion engine. It collects all of the identifiers in the\ncurrent file and other files you visit (and your tags files) and searches them\nwhen you type (identifiers are put into per-filetype groups).\n\nThe demo also shows the semantic engine in use. When the user presses `.`, `->`\nor `::` while typing in insert mode (for C++; different triggers are used for\nother languages), the semantic engine is triggered (it can also be triggered\nwith a keyboard shortcut; see the rest of the docs).\n\nThe last thing that you can see in the demo is YCM's diagnostic display features\n(the little red X that shows up in the left gutter; inspired by [Syntastic][])\nif you are editing a C-family file. As the completer engine compiles your file\nand detects warnings or errors, they will be presented in various ways. You\ndon't need to save your file or press any keyboard shortcut to trigger this, it\n\"just happens\" in the background.\n\n**And that's not all...**\n\nYCM might be the only Vim completion engine with the correct Unicode support.\nThough we do assume UTF-8 everywhere.\n\n![YouCompleteMe GIF unicode demo](https://user-images.githubusercontent.com/10026824/34471853-af9cf32a-ef53-11e7-8229-de534058ddc4.gif)\n\nYCM also provides [semantic IDE-like features](#quick-feature-summary) in a\nnumber of languages, including:\n\n- displaying signature help (argument hints) when entering the arguments to a\n function call (Vim only)\n- [finding declarations, definitions, usages](#goto-commands), etc.\n of identifiers, and an [interactive symbol finder](#symbol-search)\n- [displaying type information](#the-gettype-subcommand) for classes,\n variables, functions etc.,\n- displaying documentation for methods, members, etc. in the [preview\n window](#the-getdoc-subcommand), or in a\n [popup next to the cursor](#the-gycm_auto_hover-option) (Vim only)\n- [fixing common coding errors](#the-fixit-subcommand), like missing\n semi-colons, typos, etc.,\n- [semantic renaming](#the-refactorrename-subcommand) of variables across files,\n- formatting code,\n- removing unused imports, sorting imports, etc.\n\nFor example, here's a demo of signature help:\n\n![Signature Help Early Demo](https://user-images.githubusercontent.com/10584846/58738348-5060da80-83fd-11e9-9537-d07fdbf4554c.gif)\n\nBelow we can see YCM being able to do a few things:\n\n- Retrieve references across files\n- Go to declaration/definition\n- Expand `auto` in C++\n- Fix some common errors, and provide refactorings, with `FixIt`\n- Not shown in the GIF are `GoToImplementation` and `GoToType`\n for servers that support it.\n\n![YouCompleteMe GIF subcommands demo](https://i.imgur.com/nmUUbdl.gif)\n\nAnd here's some documentation being shown in a hover popup, automatically and\nmanually:\n\n![hover demo](https://user-images.githubusercontent.com/10584846/80312146-91af6500-87db-11ea-996b-7396f3134d1f.gif)\n\nFeatures vary by file type, so make sure to check out the [file type feature\nsummary](#quick-feature-summary) and the\n[full list of completer subcommands](#ycmcompleter-subcommands) to\nfind out what's available for your favourite languages.\n\nYou'll also find that YCM has filepath completers (try typing `./` in a file)\nand a completer that integrates with [UltiSnips][].\n\nInstallation\n------------\n\n### Requirements\n\n| Runtime | Min Version | Recommended Version (full support) | Python |\n|---------|-------------|------------------------------------|--------|\n| Vim | 9.1.0016 | 9.1.0016 | 3.12 |\n| Neovim | 0.5 | Vim 9.1.0016 | 3.12 |\n\n#### Supported Vim Versions\n\nOur policy is to support the Vim version that's in the latest LTS of Ubuntu.\n\nVim must have a [working Python 3 runtime](#supported-python-runtime).\n\nFor Neovim users, our policy is to require the latest released version.\nCurrently, Neovim 0.5.0 is required. Please note that some features are not\navailable in Neovim, and Neovim is not officially supported.\n\n#### Supported Python runtime\n\nYCM has two components: A server and a client. Both the server and client\nrequire Python 3.12 or later 3.x release. \n\nFor the Vim client, Vim must be, compiled with `--enable-shared` (or\n`--enable-framework` on macOS). You can check if this is working with `:py3\nimport sys; print( sys.version)`. It should say something like `3.12.0 (...)`.\n\nFor Neovim, you must have a python 3.12 runtime and the Neovim python\nextensions. See Neovim's `:help provider-python` for how to set that up.\n\nFor the server, you must run the `install.py` script with a python 3.12 (or\nlater) runtime. Anaconda etc. are not supported. YCM will remember the runtime\nyou used to run `install.py` and will use that when launching the server, so if\nyou usually use anaconda, then make sure to use the full path to a real cpython3,\ne.g. `/usr/bin/python3 install.py --all` etc.\n\nOur policy is to support the python3 version that's available in the latest\nUbuntu LTS (similar to our Vim version policy). We don't increase the Python\nruntime version without a reason, though. Typically, we do this when the current\npython version we're using goes out of support. At that time we will typically\npick a version that will be supported for a number of years.\n\n#### Supported Compilers\n\nIn order to provide the best possible performance and stability, ycmd has\nupdated its code to C++17. This requires a version bump of the minimum\nsupported compilers. The new requirements are:\n\n| Compiler | Current Min |\n|----------|----------------|\n| GCC | 8 |\n| Clang | 7 |\n| MSVC | 15.7 (VS 2017) |\n\nYCM requires CMake 3.13 or greater. If your CMake is too old, you may be able to\nsimply `pip install --user cmake` to get a really new version.\n\n#### Individual completer requirements\n\nWhen enabling language support for a particular language, there may be runtime\nrequirements, such as needing a very recent Java Development Kit for Java\nsupport. In general, YCM is not in control of the required versions for the\ndownstream compilers, though we do our best to signal where we know them.\n\n### macOS\n\n#### Quick start, installing all completers\n\n- Install YCM plugin via [Vundle][]\n- Install CMake, MacVim and Python 3; Note that the pre-installed *macOS system*\n Vim is not supported (due to it having broken Python integration).\n\n```\n$ brew install cmake python go nodejs\n```\n\n- Install mono from [Mono Project](mono-install-macos) (NOTE: on Intel Macs you\n can also `brew install mono`. On arm Macs, you may require Rosetta)\n\n- For Java support you must install a JDK, one way to do this is with Homebrew:\n\n```\n$ brew install java\n$ sudo ln -sfn $(brew --prefix java)/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk\n```\n\n- Pre-installed macOS *system* Vim does not support Python 3. So you need to\n install either a Vim that supports Python 3 OR [MacVim][] with\n [Homebrew][brew]:\n\n - Option 1: Installing a Vim that supports Python 3\n \n ```\n brew install vim\n ```\n\n - Option 2: Installing [MacVim][]\n \n ```\n brew install macvim\n ```\n\n- Compile YCM.\n\n - For Intel and arm64 Macs, the bundled libclang/clangd work:\n\n ```\n cd ~/.vim/bundle/YouCompleteMe\n python3 install.py --all\n ```\n\n - If you have troubles with finding system frameworks or C++ standard library,\n try using the homebrew llvm:\n\n ```\n brew install llvm\n cd ~/.vim/bundle/YouCompleteMe\n python3 install.py --system-libclang --all\n ```\n\n And edit your vimrc to add the following line to use the Homebrew llvm's\n clangd:\n\n ```viml\n \" Use homebrew's clangd\n let g:ycm_clangd_binary_path = trim(system('brew --prefix llvm')).'/bin/clangd'\n ```\n\n\n- For using an arbitrary LSP server, check [the relevant\n section](#plugging-an-arbitrary-lsp-server)\n\n#### Explanation for the quick start\n\nThese instructions (using `install.py`) are the quickest way to install\nYouCompleteMe, however they may not work for everyone. If the following\ninstructions don't work for you, check out the [full installation\nguide](#full-installation-guide).\n\nA supported Vim version with Python 3 is required. [MacVim][] is a good option,\neven if you only use the terminal. YCM won't work with the pre-installed Vim\nfrom Apple as its Python support is broken. If you don't already use a Vim\nthat supports Python 3 or [MacVim][], install it with [Homebrew][brew]. Install\nCMake as well:\n\n brew install vim cmake \n \n OR\n\n brew install macvim cmake\n\nInstall YouCompleteMe with [Vundle][].\n\n**Remember:** YCM is a plugin with a compiled component. If you **update** YCM\nusing Vundle and the `ycm_core` library APIs have changed (happens\nrarely), YCM will notify you to recompile it. You should then rerun the install\nprocess.\n\n**NOTE:** If you want C-family completion, you MUST have the latest Xcode\ninstalled along with the latest Command Line Tools (they are installed\nautomatically when you run `clang` for the first time, or manually by running\n`xcode-select --install`)\n\nCompiling YCM **with** semantic support for C-family languages through\n**clangd**:\n\n```\ncd ~/.vim/bundle/YouCompleteMe\n./install.py --clangd-completer\n```\n\nCompiling YCM **without** semantic support for C-family languages:\n\n```\ncd ~/.vim/bundle/YouCompleteMe\n./install.py\n```\n\n\nThe following additional language support options are available:\n\n- C# support: install by downloading the [Mono macOS package][mono-install-macos]\n and add `--cs-completer` when calling `install.py`.\n- Go support: install [Go][go-install] and add `--go-completer` when calling\n `install.py`.\n- JavaScript and TypeScript support: install [Node.js 18+ and npm][npm-install] and\n add `--ts-completer` when calling `install.py`.\n- Rust support: add `--rust-completer` when calling `install.py`.\n- Java support: install [JDK 17][jdk-install] and add\n `--java-completer` when calling `install.py`.\n\nTo simply compile with everything enabled, there's a `--all` flag. So, to\ninstall with all language features, ensure `xbuild`, `go`, `node` and `npm`\ntools are installed and in your `PATH`, then simply run:\n\n```\ncd ~/.vim/bundle/YouCompleteMe\n./install.py --all\n```\n\nThat's it. You're done. Refer to the _User Guide_ section on how to use YCM.\nDon't forget that if you want the C-family semantic completion engine to work,\nyou will need to provide the compilation flags for your project to YCM. It's all\nin the User Guide.\n\nYCM comes with sane defaults for its options, but you still may want to take a\nlook at what's available for configuration. There are a few interesting options\nthat are conservatively turned off by default that you may want to turn on.\n\n### Linux 64-bit\n\nThe following assume you're using Ubuntu 24.04.\n\n#### Quick start, installing all completers\n\n- Install YCM plugin via [Vundle][]\n- Install CMake, Vim and Python\n\n```\napt install build-essential cmake vim-nox python3-dev\n```\n\n- Install mono-complete, go, node, java, and npm\n\n```\napt install mono-complete golang nodejs openjdk-17-jdk openjdk-17-jre npm\n```\n\n- Compile YCM\n\n```\ncd ~/.vim/bundle/YouCompleteMe\npython3 install.py --all\n```\n\n- For plugging an arbitrary LSP server, check [the relevant section](#plugging-an-arbitrary-lsp-server)\n\n#### Explanation for the quick start\n\nThese instructions (using `install.py`) are the quickest way to install\nYouCompleteMe, however they may not work for everyone. If the following\ninstructions don't work for you, check out the [full installation\nguide](#full-installation-guide).\n\nMake sure you have a supported version of Vim with Python 3 support and a\nsupported compiler. The latest LTS of Ubuntu is the minimum platform for simple\ninstallation. For earlier releases or other distributions, you may have to do\nsome work to acquire the dependencies.\n\nIf your Vim version is too old, you may need to [compile Vim from\nsource][vim-build] (don't worry, it's easy).\n\nInstall YouCompleteMe with [Vundle][].\n\n**Remember:** YCM is a plugin with a compiled component. If you **update** YCM\nusing Vundle and the `ycm_core` library APIs have changed (which happens rarely), YCM\nwill notify you to recompile it. You should then rerun the installation process.\n\nInstall development tools, CMake, and Python headers:\n\n- Fedora-like distributions:\n\n```\nsudo dnf install cmake gcc-c++ make python3-devel\n```\n\n- Ubuntu LTS:\n\n```\nsudo apt install build-essential cmake3 python3-dev\n```\n\nCompiling YCM **with** semantic support for C-family languages through\n**clangd**:\n\n```\ncd ~/.vim/bundle/YouCompleteMe\npython3 install.py --clangd-completer\n```\n\nCompiling YCM **without** semantic support for C-family languages:\n\n```\ncd ~/.vim/bundle/YouCompleteMe\npython3 install.py\n```\n\nThe following additional language support options are available:\n\n- C# support: install [Mono][mono-install-linux] and add `--cs-completer`\n when calling `install.py`.\n- Go support: install [Go][go-install] and add `--go-completer` when calling\n `install.py`.\n- JavaScript and TypeScript support: install [Node.js 18+ and npm][npm-install] and\n add `--ts-completer` when calling `install.py`.\n- Rust support: add `--rust-completer` when calling `install.py`.\n- Java support: install [JDK 17][jdk-install] and add\n `--java-completer` when calling `install.py`.\n\nTo simply compile with everything enabled, there's a `--all` flag. So, to\ninstall with all language features, ensure `xbuild`, `go`, `node`, and `npm`\ntools are installed and in your `PATH`, then simply run:\n\n```\ncd ~/.vim/bundle/YouCompleteMe\npython3 install.py --all\n```\n\nThat's it. You're done. Refer to the _User Guide_ section on how to use YCM.\nDon't forget that if you want the C-family semantic completion engine to work,\nyou will need to provide the compilation flags for your project to YCM. It's all\nin the User Guide.\n\nYCM comes with sane defaults for its options, but you still may want to take a\nlook at what's available for configuration. There are a few interesting options\nthat are conservatively turned off by default that you may want to turn on.\n\n### Windows\n\n***NOTE***: Windows support is *deprecated* and *unmaintained*. We will do our\nbest to keep it working, but we no longer test it in CI and there is a high\nlikelihood of breakages.\n\n#### Quick start, installing all completers\n\n- Install YCM plugin via [Vundle][]\n- Install [Visual Studio Build Tools 2019][visual-studio-download]\n- Install CMake, Vim and Python\n- Install go, node and npm\n- Compile YCM\n\n```\ncd YouCompleteMe\npython3 install.py --all\n```\n\n- Add `set encoding=utf-8` to your [vimrc][]\n- For plugging an arbitrary LSP server, check [the relevant section](#plugging-an-arbitrary-lsp-server)\n\n#### Explanation for the quick start\n\nThese instructions (using `install.py`) are the quickest way to install\nYouCompleteMe, however they may not work for everyone. If the following\ninstructions don't work for you, check out the [full installation\nguide](#full-installation-guide).\n\n**Important:** we assume that you are using the `cmd.exe` command prompt and\nthat you know how to add an executable to the PATH environment variable.\n\nMake sure you have a supported Vim version with Python 3 support. You\ncan check the version and which Python is supported by typing `:version` inside\nVim. Look at the features included: `+python3/dyn` for Python 3.\nTake note of the Vim architecture, i.e. 32 or\n64-bit. It will be important when choosing the Python installer. We recommend\nusing a 64-bit client. [Daily updated installers of 32-bit and 64-bit Vim with\nPython 3 support][vim-win-download] are available.\n\nAdd the following line to your [vimrc][] if not already present.:\n\n```viml\nset encoding=utf-8\n```\n\nThis option is required by YCM. Note that it does not prevent you from editing a\nfile in another encoding than UTF-8. You can do that by specifying [the `++enc`\nargument][++enc] to the `:e` command.\n\nInstall YouCompleteMe with [Vundle][].\n\n**Remember:** YCM is a plugin with a compiled component. If you **update** YCM\nusing Vundle and the `ycm_core` library APIs have changed (happens\nrarely), YCM will notify you to recompile it. You should then rerun the install\nprocess.\n\nDownload and install the following software:\n\n- [Python 3][python-win-download]. Be sure to pick the version\n corresponding to your Vim architecture. It is _Windows x86_ for a 32-bit Vim\n and _Windows x86-64_ for a 64-bit Vim. We recommend installing Python 3.\n Additionally, the version of Python you install must match up exactly with\n the version of Python that Vim is looking for. Type `:version` and look at the\n bottom of the page at the list of compiler flags. Look for flags that look\n similar to `-DDYNAMIC_PYTHON3_DLL=\\\"python36.dll\\\"`. This indicates\n that Vim is looking for Python 3.6. You'll need one or the other installed,\n matching the version number exactly.\n- [CMake][cmake-download]. Add CMake executable to the PATH environment\n variable.\n- [Build Tools for Visual Studio 2019][visual-studio-download]. During setup,\n select _C++ build tools_ in _Workloads_.\n\nCompiling YCM **with** semantic support for C-family languages through\n**clangd**:\n\n```\ncd %USERPROFILE%/vimfiles/bundle/YouCompleteMe\npython install.py --clangd-completer\n```\n\nCompiling YCM **without** semantic support for C-family languages:\n\n```\ncd %USERPROFILE%/vimfiles/bundle/YouCompleteMe\npython install.py\n```\n\nThe following additional language support options are available:\n\n- C# support: add `--cs-completer` when calling `install.py`.\n Be sure that [the build utility `msbuild` is in your PATH][add-msbuild-to-path].\n- Go support: install [Go][go-install] and add `--go-completer` when calling\n `install.py`.\n- JavaScript and TypeScript support: install [Node.js 18+ and npm][npm-install] and\n add `--ts-completer` when calling `install.py`.\n- Rust support: add `--rust-completer` when calling `install.py`.\n- Java support: install [JDK 17][jdk-install] and add\n `--java-completer` when calling `install.py`.\n\nTo simply compile with everything enabled, there's a `--all` flag. So, to\ninstall with all language features, ensure `msbuild`, `go`, `node` and `npm`\ntools are installed and in your `PATH`, then simply run:\n\n```\ncd %USERPROFILE%/vimfiles/bundle/YouCompleteMe\npython install.py --all\n```\n\nYou can specify the Microsoft Visual C++ (MSVC) version using the `--msvc`\noption. YCM officially supports MSVC 15 (2017), MSVC 16 (Visual Studio 2019) \nand MSVC 17 (Visual Studio 17 2022).\n\nThat's it. You're done. Refer to the _User Guide_ section on how to use YCM.\nDon't forget that if you want the C-family semantic completion engine to work,\nyou will need to provide the compilation flags for your project to YCM. It's all\nin the User Guide.\n\nYCM comes with sane defaults for its options, but you still may want to take a\nlook at what's available for configuration. There are a few interesting options\nthat are conservatively turned off by default that you may want to turn on.\n\n### Full Installation Guide\n\nThe [full installation guide][wiki-full-install] has been moved to the wiki.\n\nQuick Feature Summary\n-----\n\n### General (all languages)\n\n* Super-fast identifier completer including tags files and syntax elements\n* Intelligent suggestion ranking and filtering\n* File and path suggestions\n* Suggestions from Vim's omnifunc\n* UltiSnips snippet suggestions\n\n### C-family languages (C, C++, Objective C, Objective C++, CUDA)\n\n* Semantic auto-completion with automatic fixes\n* Signature help\n* Real-time diagnostic display\n* Go to include/declaration/definition (`GoTo`, etc.)\n* Go to alternate file (e.g. associated header `GoToAlternateFile`)\n* Find Symbol (`GoToSymbol`), with interactive search\n* Document outline (`GoToDocumentOutline`), with interactive search\n* View documentation comments for identifiers (`GetDoc`)\n* Type information for identifiers (`GetType`)\n* Automatically fix certain errors (`FixIt`)\n* Perform refactoring (`FixIt`)\n* Reference finding (`GoToReferences`)\n* Renaming symbols (`RefactorRename `)\n* Code formatting (`Format`)\n* Semantic highlighting\n* Inlay hints\n* Type hierarchy\n* Call hierarchy\n\n### C♯\n\n* Semantic auto-completion\n* Signature help\n* Real-time diagnostic display\n* Go to declaration/definition (`GoTo`, etc.)\n* Go to implementation (`GoToImplementation`)\n* Find Symbol (`GoToSymbol`), with interactive search\n* View documentation comments for identifiers (`GetDoc`)\n* Type information for identifiers (`GetType`)\n* Automatically fix certain errors (`FixIt`)\n* Perform refactoring (`FixIt`)\n* Management of OmniSharp-Roslyn server instance\n* Renaming symbols (`RefactorRename `)\n* Code formatting (`Format`)\n\n### Python\n\n* Semantic auto-completion\n* Signature help\n* Go to definition (`GoTo`)\n* Find Symbol (`GoToSymbol`), with interactive search\n* Reference finding (`GoToReferences`)\n* View documentation comments for identifiers (`GetDoc`)\n* Type information for identifiers (`GetType`)\n* Renaming symbols (`RefactorRename `)\n\n### Go\n\n* Semantic auto-completion\n* Signature help\n* Real-time diagnostic display\n* Go to declaration/definition (`GoTo`, etc.)\n* Go to type definition (`GoToType`)\n* Go to implementation (`GoToImplementation`)\n* Document outline (`GoToDocumentOutline`), with interactive search\n* Automatically fix certain errors (`FixIt`)\n* Perform refactoring (`FixIt`)\n* View documentation comments for identifiers (`GetDoc`)\n* Type information for identifiers (`GetType`)\n* Code formatting (`Format`)\n* Management of `gopls` server instance\n* Inlay hints\n* Call hierarchy\n\n### JavaScript and TypeScript\n\n* Semantic auto-completion with automatic import insertion\n* Signature help\n* Real-time diagnostic display\n* Go to definition (`GoTo`, `GoToDefinition`, and `GoToDeclaration` are\n identical)\n* Go to type definition (`GoToType`)\n* Go to implementation (`GoToImplementation`)\n* Find Symbol (`GoToSymbol`), with interactive search\n* Reference finding (`GoToReferences`)\n* View documentation comments for identifiers (`GetDoc`)\n* Type information for identifiers (`GetType`)\n* Automatically fix certain errors and perform refactoring (`FixIt`)\n* Perform refactoring (`FixIt`)\n* Renaming symbols (`RefactorRename `)\n* Code formatting (`Format`)\n* Organize imports (`OrganizeImports`)\n* Management of `TSServer` server instance\n* Inlay hints\n* Call hierarchy\n\n### Rust\n\n* Semantic auto-completion\n* Real-time diagnostic display\n* Go to declaration/definition (`GoTo`, etc.)\n* Go to implementation (`GoToImplementation`)\n* Reference finding (`GoToReferences`)\n* Document outline (`GoToDocumentOutline`), with interactive search\n* View documentation comments for identifiers (`GetDoc`)\n* Automatically fix certain errors (`FixIt`)\n* Perform refactoring (`FixIt`)\n* Type information for identifiers (`GetType`)\n* Renaming symbols (`RefactorRename `)\n* Code formatting (`Format`)\n* Management of `rust-analyzer` server instance\n* Semantic highlighting\n* Inlay hints\n* Call hierarchy\n\n### Java\n\n* Semantic auto-completion with automatic import insertion\n* Signature help\n* Real-time diagnostic display\n* Go to definition (`GoTo`, `GoToDefinition`, and `GoToDeclaration` are\n identical)\n* Go to type definition (`GoToType`)\n* Go to implementation (`GoToImplementation`)\n* Find Symbol (`GoToSymbol`), with interactive search\n* Reference finding (`GoToReferences`)\n* Document outline (`GoToDocumentOutline`), with interactive search\n* View documentation comments for identifiers (`GetDoc`)\n* Type information for identifiers (`GetType`)\n* Automatically fix certain errors including code generation (`FixIt`)\n* Renaming symbols (`RefactorRename `)\n* Code formatting (`Format`)\n* Organize imports (`OrganizeImports`)\n* Detection of Java projects\n* Execute custom server command (`ExecuteCommand `)\n* Management of `jdt.ls` server instance\n* Semantic highlighting\n* Inlay hints\n* Type hierarchy\n* Call hierarchy\n\nUser Guide\n----------\n\n### General Usage\n\nIf the offered completions are too broad, keep typing characters; YCM will\ncontinue refining the offered completions based on your input.\n\nFiltering is \"smart-case\" and \"smart-[diacritic][]\" sensitive; if you are\ntyping only lowercase letters, then it's case-insensitive. If your input\ncontains uppercase letters, then the uppercase letters in your query must\nmatch uppercase letters in the completion strings (the lowercase letters still\nmatch both). On top of that, a letter with no diacritic marks will match that\nletter with or without marks:\n\n\n\n\n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n\n\n
matchesfoofôofOofÔo
foo✔️✔️✔️✔️
fôo❌✔️❌✔️
fOo❌❌✔️✔️
fÔo❌❌❌✔️
\n\nUse the TAB key to accept a completion and continue pressing TAB to cycle\nthrough the completions. Use Shift-TAB to cycle backward. Note that if you're\nusing console Vim (that is, not gvim or MacVim) then it's likely that the\nShift-TAB binding will not work because the console will not pass it to Vim.\nYou can remap the keys; see the [Options](#options) section below.\n\nKnowing a little bit about how YCM works internally will prevent confusion. YCM\nhas several completion engines: an identifier-based completer that collects all\nof the identifiers in the current file and other files you visit (and your tags\nfiles) and searches them when you type (identifiers are put into per-filetype\ngroups).\n\nThere are also several semantic engines in YCM. There are libclang-based and\nclangd-based completers that provide semantic completion for C-family languages.\nThere's a Jedi-based completer for semantic completion for Python. There's also\nan omnifunc-based completer that uses data from Vim's omnicomplete system to\nprovide semantic completions when no native completer exists for that language\nin YCM.\n\nThere are also other completion engines, like the UltiSnips completer and the\nfilepath completer.\n\nYCM automatically detects which completion engine would be the best in any\nsituation. On occasion, it queries several of them at once, merges the\noutputs and presents the results to you.\n\n### Client-Server Architecture\n\nYCM has a client-server architecture; the Vim part of YCM is only a thin client\nthat talks to the [ycmd HTTP+JSON server][ycmd] that has the vast majority of\nYCM logic and functionality. The server is started and stopped automatically as\nyou start and stop Vim.\n\n### Completion String Ranking\n\nThe subsequence filter removes any completions that do not match the input, but\nthen the sorting system kicks in. It's actually very complicated and uses lots\nof factors, but suffice it to say that \"word boundary\" (WB) subsequence\ncharacter matches are \"worth\" more than non-WB matches. In effect, this means\nthat given an input of \"gua\", the completion \"getUserAccount\" would be ranked higher\nin the list than the \"Fooguxa\" completion (both of which are subsequence\nmatches). Word-boundary characters are all capital characters, characters\npreceded by an underscore, and the first letter character in the completion\nstring.\n\n### Signature Help\n\nValid signatures are displayed in a second popup menu and the current signature\nis highlighted along with the current argument.\n\nSignature help is triggered in insert mode automatically when\n`g:ycm_auto_trigger` is enabled and is not supported when it is not enabled.\n\nThe signatures popup is hidden when there are no matching signatures or when you\nleave insert mode. If you want to manually control when it is visible, you can\nmap something to `YCMToggleSignatureHelp` (see below).\n\nFor more details on this feature and a few demos, check out the\n[PR that proposed it][signature-help-pr].\n\n#### Dismiss signature help\n\nThe signature help popup sometimes gets in the way. You can toggle its\nvisibility with a mapping. YCM provides the \"Plug\" mapping\n`(YCMToggleSignatureHelp)` for this.\n\nFor example, to hide/show the signature help popup by pressing Ctrl+l in insert\nmode: `imap (YCMToggleSignatureHelp)`.\n\n_NOTE_: No default mapping is provided because insert mappings are very\ndifficult to create without breaking or overriding some existing functionality.\nCtrl-l is not a suggestion, just an example.\n\n### Semantic highlighting\n\nSemantic highlighting is the process where the buffer text is coloured according\nto the underlying semantic type of the word, rather than classic syntax\nhighlighting based on regular expressions. This can be powerful additional data\nthat we can process very quickly.\n\nThis feature is only supported in Vim.\n\nFor example, here is a function with classic highlighting:\n\n![highliting-classic](https://user-images.githubusercontent.com/10584846/173137003-a265e8b0-84db-4993-98f0-03ee81b9de94.png)\n\nAnd here is the same function with semantic highlighting:\n\n![highliting-semantic](https://user-images.githubusercontent.com/10584846/173137012-7547de0b-145f-45fa-ace3-18943acd2141.png)\n\nAs you can see, the function calls, macros, etc. are correctly identified. \n\nThis can be enabled globally with `let g:ycm_enable_semantic_highlighting=1` or\nper buffer, by setting `b:ycm_enable_semantic_highlighting`.\n\n#### Customising the highlight groups\n\nYCM uses text properties (see `:help text-prop-intro`) for semantic\nhighlighting. In order to customise the coloring, you can define the text\nproperties that are used.\n\nIf you define a text property named `YCM_HL_`, then it will be used\nin place of the defaults. The `` is defined as the Language Server\nProtocol semantic token type, defined in the [LSP Spec](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_semanticTokens).\n\nSome servers also use custom values. In this case, YCM prints a warning\nincluding the token type name that you can customise.\n\nFor example, to render `parameter` tokens using the `Normal` highlight group,\nyou can do this:\n\n```viml\ncall prop_type_add( 'YCM_HL_parameter', { 'highlight': 'Normal' } )\n```\n\nMore generally, this pattern can be useful for customising the groups:\n\n```viml\nlet MY_YCM_HIGHLIGHT_GROUP = {\n \\ 'typeParameter': 'PreProc',\n \\ 'parameter': 'Normal',\n \\ 'variable': 'Normal',\n \\ 'property': 'Normal',\n \\ 'enumMember': 'Normal',\n \\ 'event': 'Special',\n \\ 'member': 'Normal',\n \\ 'method': 'Normal',\n \\ 'class': 'Special',\n \\ 'namespace': 'Special',\n \\ }\n\nfor tokenType in keys( MY_YCM_HIGHLIGHT_GROUP )\n call prop_type_add( 'YCM_HL_' . tokenType,\n \\ { 'highlight': MY_YCM_HIGHLIGHT_GROUP[ tokenType ] } )\nendfor\n```\n\n## Inlay hints\n\n**NOTE**: Highly experimental feature, requiring Vim 9.0.214 or later (not\nsupported in NeoVim).\n\nWhen `g:ycm_enable_inlay_hints` (globally) or `b:ycm_enable_inlay_hints` (for a\nspecific buffer) is set to `1`, then YCM will insert inlay hints as supported by\nthe language semantic engine.\n\nAn inlay hint is text that is rendered on the screen that is not part of the buffer and\nis often used to mark up the type or name of arguments, parameters, etc. which\nhelp the developer understand the semantics of the code.\n\nHere are some examples:\n\n* C\n\n![c-inlay](https://user-images.githubusercontent.com/10584846/185708054-68074fc0-e50c-4a65-887c-da6f372b8982.png)\n\n* TypeScript\n\n![ts-inlay](https://user-images.githubusercontent.com/10584846/185708156-b52970ce-005f-4f0b-97e7-bdf8feeefedc.png)\n\n* Go\n\n![go-inlay](https://user-images.githubusercontent.com/10584846/185708242-e42dab6f-1847-46f1-8585-2d9f2c8a76dc.png)\n\n### Highlight groups\n\nBy default, YCM renders the inlay hints with the `NonText` highlight group. To\noverride this, define the `YcmInlayHint` highlight yourself, e.g. in your\n`.vimrc`:\n\n```viml\nhi link YcmInlayHint Comment\n```\n\nSimilar to semantic highlighting above, you can override specific highlighting\nfor different inlay hint types by defining text properties named after the kind\nof inlay hint, for example:\n\n```viml\ncall prop_type_add( 'YCM_INLAY_Type', #{ highlight: 'Comment' } )\n```\n\nThe list of inlay hint kinds can be found in `python/ycm/inlay_hints.py`\n\n### Options\n\n* `g:ycm_enable_inlay_hints` or `b:ycm_enable_inlay_hints` - enable/disable\n globally or for local buffer\n* `g:ycm_clear_inlay_hints_in_insert_mode` - set to `1` to remove all inlay\n hints when entering insert mode and reinstate them when leaving insert mode\n\n### Toggling\n\nInlay hints can add a lot of text to the screen and may be distracting. You can\ntoggle them on/off instantly, by mapping something to\n`(YCMToggleInlayHints)`, for example:\n\n```viml\nnnoremap h (YCMToggleInlayHints)\n```\n\nNo default mapping is provided for this due to the personal nature of mappings.\n\n### General Semantic Completion\n\nYou can use Ctrl+Space to trigger the completion suggestions anywhere, even\nwithout a string prefix. This is useful to see which top-level functions are\navailable for use.\n\n### C-family Semantic Completion\n\n**NOTE:** YCM originally used the `libclang` based engine for C-family, but\nusers should migrate to clangd, as it provides more features and better\nperformance. Users who rely on `override_filename` in their `.ycm_extra_conf.py`\nwill need to stay on the old `libclang` engine. Instructions on how to stay on\nthe old engine are available on [the wiki][libclang-instructions].\n\nSome of the features of clangd:\n\n- **Project wide indexing**: Clangd has both dynamic and static index support.\n The dynamic index stores up-to-date symbols coming from any files you are\n currently editing, whereas static index contains project-wide symbol\n information. This symbol information is used for code completion and code\n navigation. Whereas libclang is limited to the current translation unit(TU).\n- **Code navigation**: Clangd provides all the GoTo requests libclang provides and it\n improves those using the above-mentioned index information to contain\n project-wide information rather than just the current TU.\n- **Rename**: Clangd can perform semantic rename operations on the current\n file, whereas libclang doesn't support such functionality.\n- **Code Completion**: Clangd can perform code completions at a lower latency\n than libclang; also, it has information about all the symbols in your\n project so it can suggest items outside your current TU and also provides\n proper `#include` insertions for those items.\n- **Signature help**: Clangd provides signature help so that you can see the\n names and types of arguments when calling functions.\n- **Format Code**: Clangd provides code formatting either for the selected\n lines or the whole file, whereas libclang doesn't have such functionality.\n- **Performance**: Clangd has faster re-parse and code completion times\n compared to libclang.\n\n#### Installation\n\nOn supported architectures, the `install.py` script will download a suitable\nclangd (`--clangd-completer`) or libclang (`--clang-completer`) for you.\nSupported architectures are:\n\n* Linux glibc >= 2.39 (Intel, armv7-a, aarch64) - built on ubuntu 24.04\n* MacOS >=10.15 (Intel, arm64)\n - For Intel, compatibility per clang.llvm.org downloads\n - For arm64, macOS 10.15+\n* Windows (Intel) - compatibility per clang.llvm.org downloads\n\n***clangd***:\n\nTypically, clangd is installed by the YCM installer (either with `--all` or with\n`--clangd-completer`). This downloads a pre-built `clangd` binary for your\narchitecture. If your OS or architecture is not supported or is too old, you can\ninstall a compatible `clangd` and use [`g:ycm_clangd_binary_path`]() to point to\nit.\n\n***libclang***:\n\n`libclang` can be enabled also with `--all` or `--clang-completer`. As with\n`clangd`, YCM will try and download a version of `libclang` that is suitable for\nyour environment, but again if your environment can't be supported, you can\nbuild or acquire `libclang` for yourself and specify it when building, as:\n\n```\n$ EXTRA_CMAKE_ARGS='-DPATH_TO_LLVM_ROOT=/path/to/your/llvm' ./install.py --clang-completer --system-libclang\n```\n\nPlease note that if using custom `clangd` or `libclang` it _must_ match the\nversion that YCM requires. Currently YCM requires ***clang 17.0.1***.\n\n#### Compile flags\n\nIn order to perform semantic analysis such as code completion, `GoTo`, and\ndiagnostics, YouCompleteMe uses `clangd`, which makes use of\nclang compiler, sometimes also referred to as LLVM. Like any compiler,\nclang also requires a set of compile flags in order to parse your code. Simply\nput: If clang can't parse your code, YouCompleteMe can't provide semantic\nanalysis.\n\nThere are 2 methods that can be used to provide compile flags to clang:\n\n#### Option 1: Use a [compilation database][compdb]\n\nThe easiest way to get YCM to compile your code is to use a compilation\ndatabase. A compilation database is usually generated by your build system\n(e.g. `CMake`) and contains the compiler invocation for each compilation unit in\nyour project.\n\nFor information on how to generate a compilation database, see the [clang\ndocumentation][compdb]. In short:\n\n- If using CMake, add `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` when configuring (or\n add `set( CMAKE_EXPORT_COMPILE_COMMANDS ON )` to `CMakeLists.txt`) and copy or\n symlink the generated database to the root of your project.\n- If using Ninja, check out the `compdb` tool (`-t compdb`) in its\n [docs][ninja-compdb].\n- If using GNU make, check out [compiledb][] or [Bear][].\n- For other build systems, check out\n [`.ycm_extra_conf.py`](#option-2-provide-the-flags-manually) below.\n\nIf no [`.ycm_extra_conf.py`](#option-2-provide-the-flags-manually) is found,\nYouCompleteMe automatically tries to load a compilation database if there is\none.\n\nYCM looks for a file named `compile_commands.json` in the directory of the\nopened file or in any directory above it in the hierarchy (recursively); when\nthe file is found before a local `.ycm_extra_conf.py`, YouCompleteMe stops\nsearching the directories and lets clangd take over and handle the flags.\n\n#### Option 2: Provide the flags manually\n\nIf you don't have a compilation database or aren't able to generate one,\nyou have to tell YouCompleteMe how to compile your code some other way.\n\nEvery C-family project is different. It is not possible for YCM to guess what\ncompiler flags to supply for your project. Fortunately, YCM provides a mechanism\nfor you to generate the flags for a particular file with _arbitrary complexity_.\nThis is achieved by requiring you to provide a Python module that implements a\ntrivial function that, given the file name as an argument, returns a list of\ncompiler flags to use to compile that file.\n\nYCM looks for a `.ycm_extra_conf.py` file in the directory of the opened file or\nin any directory above it in the hierarchy (recursively); when the file is\nfound, it is loaded (only once!) as a Python module. YCM calls a `Settings`\nmethod in that module which should provide it with the information necessary to\ncompile the current file. You can also provide a path to a global configuration\nfile with the\n[`g:ycm_global_ycm_extra_conf`](#the-gycm_global_ycm_extra_conf-option) option,\nwhich will be used as a fallback. To prevent the execution of malicious code\nfrom a file you didn't write YCM will ask you once per `.ycm_extra_conf.py` if\nit is safe to load. This can be disabled and you can white-/blacklist files. See\nthe [`g:ycm_confirm_extra_conf`](#the-gycm_confirm_extra_conf-option) and\n[`g:ycm_extra_conf_globlist`](#the-gycm_extra_conf_globlist-option) options\nrespectively.\n\nThis system was designed this way so that the user can perform any arbitrary\nsequence of operations to produce a list of compilation flags YCM should hand\nto Clang.\n\n**NOTE**: It is highly recommended to include `-x ` flag to libclang.\nThis is so that the correct language is detected, particularly for header files.\nCommon values are `-x c` for C, `-x c++` for C++, `-x objc` for Objective-C, and\n`-x cuda` for CUDA.\n\nTo give you an impression, if your C++ project is trivial, and your usual\ncompilation command is: `g++ -Wall -Wextra -Werror -o FILE.o FILE.cc`, then the\nfollowing `.ycm_extra_conf.py` is enough to get semantic analysis from\nYouCompleteMe:\n\n```python\ndef Settings( **kwargs ):\n return {\n 'flags': [ '-x', 'c++', '-Wall', '-Wextra', '-Werror' ],\n }\n```\n\nAs you can see from the trivial example, YCM calls the `Settings` method which\nreturns a dictionary with a single element `'flags'`. This element is a `list`\nof compiler flags to pass to libclang for the current file. The absolute path of\nthat file is accessible under the `filename` key of the `kwargs` dictionary.\nThat's it! This is actually enough for most projects, but for complex projects\nit is not uncommon to integrate directly with an existing build system using the\nfull power of the Python language.\n\nFor a more elaborate example,\n[see ycmd's own `.ycm_extra_conf.py`][ycmd_flags_example]. You should be able to\nuse it _as a starting point_. **Don't** just copy/paste that file somewhere and\nexpect things to magically work; **your project needs different flags**. Hint:\njust replace the strings in the `flags` variable with compilation flags\nnecessary for your project. That should be enough for 99% of projects.\n\nYou could also consider using [YCM-Generator][ygen] to generate the\n`ycm_extra_conf.py` file.\n\n#### Errors during compilation\n\nIf Clang encounters errors when compiling the header files that your file\nincludes, then it's probably going to take a long time to get completions. When\nthe completion menu finally appears, it's going to have a large number of\nunrelated completion strings (type/function names that are not actually\nmembers). This is because Clang fails to build a precompiled preamble for your\nfile if there are any errors in the included headers and that preamble is key to\ngetting fast completions.\n\nCall the `:YcmDiags` command to see if any errors or warnings were detected in\nyour file.\n\n### Java Semantic Completion\n\n#### Java Quick Start\n\n1. Ensure that you have enabled the Java completer. See the\n [installation guide](#installation) for details.\n\n2. Create a project file (gradle or maven) file in the root directory of your\n Java project, by following the instructions below.\n\n3. (Optional) [Configure the LSP server](#lsp-configuration). The [jdt.ls\n configuration options][jdtls-preferences] can be found in their codebase.\n\n4. If you previously used Eclim or Syntastic for Java, disable them for Java.\n\n5. Edit a Java file from your project.\n\n#### Java Project Files\n\nIn order to provide semantic analysis, the Java completion engine requires\nknowledge of your project structure. In particular, it needs to know the class\npath to use, when compiling your code. Fortunately [jdt.ls][]\nsupports [eclipse project files][eclipse-project],\n[maven projects][mvn-project] and [gradle projects][gradle-project].\n\n**NOTE:** Our recommendation is to use either Maven or Gradle projects.\n\n#### Diagnostic display - Syntastic\n\nThe native support for Java includes YCM's native real-time diagnostics display.\nThis can conflict with other diagnostics plugins like Syntastic, so when\nenabling Java support, please **manually disable Syntastic Java diagnostics**.\n\nAdd the following to your `vimrc`:\n\n```viml\nlet g:syntastic_java_checkers = []\n```\n\n#### Diagnostic display - Eclim\n\nThe native support for Java includes YCM's native real-time diagnostics display.\nThis can conflict with other diagnostics plugins like Eclim, so when enabling\nJava support, please **manually disable Eclim Java diagnostics**.\n\nAdd the following to your `vimrc`:\n\n```viml\nlet g:EclimFileTypeValidate = 0\n```\n\n**NOTE**: We recommend disabling Eclim entirely when editing Java with YCM's\nnative Java support. This can be done temporarily with `:EclimDisable`.\n\n#### Eclipse Projects\n\nEclipse-style projects require two files: [.project][eclipse-dot-project] and\n[.classpath][eclipse-dot-classpath].\n\nIf your project already has these files due to previously being set up within\nEclipse, then no setup is required. [jdt.ls][] should load the project just\nfine (it's basically eclipse after all).\n\nHowever, if not, it is possible (easy in fact) to craft them manually, though it\nis not recommended. You're better off using Gradle or Maven (see below).\n\n[A simple eclipse style project example][ycmd-eclipse-project] can be found in\nthe ycmd test directory. Normally all that is required is to copy these files to\nthe root of your project and to edit the `.classpath` to add additional\nlibraries, such as:\n\n```xml\n \n \n```\n\nIt may also be necessary to change the directory in which your source files are\nlocated (paths are relative to the .project file itself):\n\n```xml\n \n```\n\n**NOTE**: The eclipse project and classpath files are not a public interface\nand it is highly recommended to use Maven or Gradle project definitions if you\ndon't already use Eclipse to manage your projects.\n\n#### Maven Projects\n\nMaven needs a file named [pom.xml][mvn-project] in the root of the project.\nOnce again a simple [pom.xml][ycmd-mvn-pom-xml] can be found in the ycmd source.\n\nThe format of [pom.xml][mvn-project] files is way beyond the scope of this\ndocument, but we do recommend using the various tools that can generate them for\nyou, if you're not familiar with them already.\n\n#### Gradle Projects\n\nGradle projects require a [build.gradle][gradle-project]. Again, there is a\n[trivial example in ycmd's tests][ycmd-gradle-project].\n\nThe format of [build.gradle][gradle-project] files are way beyond the scope of\nthis document, but we do recommend using the various tools that can generate\nthem for you if you're not familiar with them already.\n\nSome users have experienced issues with their jdt.ls when using the Groovy\nlanguage for their build.gradle. As such, try using\n[Kotlin](https://github.com/ycm-core/lsp-examples#kotlin) instead.\n\n#### Troubleshooting\n\nIf you're not getting completions or diagnostics, check the server health:\n\n* The Java completion engine takes a while to start up and parse your project.\n You should be able to see its progress in the command line, and\n `:YcmDebugInfo`. Ensure that the following lines are present:\n\n```\n-- jdt.ls Java Language Server running\n-- jdt.ls Java Language Server Startup Status: Ready\n```\n\n* If the above lines don't appear after a few minutes, check the jdt.ls and ycmd\n log files using [`:YcmToggleLogs` ](#the-ycmtogglelogs-command). The jdt.ls\n log file is called `.log` (for some reason).\n\nIf you get a message about \"classpath is incomplete\", then make sure you have\ncorrectly configured the [project files](#java-project-files).\n\nIf you get messages about unresolved imports, then make sure you have\ncorrectly configured the [project files](#java-project-files), in particular\ncheck that the classpath is set correctly.\n\n### C# Semantic Completion\n\nYCM relies on [OmniSharp-Roslyn][] to provide completion and code navigation.\nOmniSharp-Roslyn needs a solution file for a C# project and there are two ways\nof letting YCM know about your solution files.\n\n#### Automatically discovered solution files\n\nYCM will scan all parent directories of the file currently being edited and look\nfor a file with `.sln` extension.\n\n#### Manually specified solution files\n\nIf YCM loads `.ycm_extra_conf.py` which contains `CSharpSolutionFile` function,\nYCM will try to use that to determine the solution file. This is useful when one\nwants to override the default behaviour and specify a solution file that is not\nin any of the parent directories of the currently edited file. Example:\n\n```python\ndef CSharpSolutionFile( filepath ):\n # `filepath` is the path of the file user is editing\n return '/path/to/solution/file' # Can be relative to the `.ycm_extra_conf.py`\n```\n\nIf the path returned by `CSharpSolutionFile` is not an actual file, YCM will\nfall back to the other way of finding the file.\n\n#### Use with .NET 6.0 and .NET SDKs\n\nYCM ships with older version of OmniSharp-Roslyn based on Mono runtime.\nIt is possible to use it with .NET 6.0 and newer, but it requires manual setup.\n\n1. Download NET 6.0 version of the OmniSharp server for your system from\n[releases](https://github.com/OmniSharp/omnisharp-roslyn/releases/)\n1. Set `g:ycm_roslyn_binary_path` to the unpacked executable `OmniSharp`\n1. Create a solution file if one doesn't already exist, it is currently required\nby YCM for internal bookkeeping\n 1. Run `dotnet new sln` at the root of your project\n 1. Run `dotnet sln add ...`\n for all of your projects\n1. Run `:YcmRestartServer`\n\n### Python Semantic Completion\n\nYCM relies on the [Jedi][] engine to provide completion and code navigation. By\ndefault, it will pick the version of Python running the [ycmd server][ycmd] and\nuse its `sys.path`. While this is fine for simple projects, this needs to be\nconfigurable when working with virtual environments or in a project with\nthird-party packages. The next sections explain how to do that.\n\n#### Working with virtual environments\n\nA common practice when working on a Python project is to install its\ndependencies in a virtual environment and develop the project inside that\nenvironment. To support this, YCM needs to know the interpreter path of the\nvirtual environment. You can specify it by creating a `.ycm_extra_conf.py` file\nat the root of your project with the following contents:\n\n```python\ndef Settings( **kwargs ):\n return {\n 'interpreter_path': '/path/to/virtual/environment/python'\n }\n```\n\nHere, `/path/to/virtual/environment/python` is the path to the Python used\nby the virtual environment you are working in. Typically, the executable can be\nfound in the `Scripts` folder of the virtual environment directory on Windows\nand in the `bin` folder on other platforms.\n\nIf you don't like having to create a `.ycm_extra_conf.py` file at the root of\nyour project and would prefer to specify the interpreter path with a Vim option,\nread the [Configuring through Vim options](#configuring-through-vim-options)\nsection.\n\n#### Working with third-party packages\n\nAnother common practice is to put the dependencies directly into the project and\nadd their paths to `sys.path` at runtime in order to import them. YCM needs to\nbe told about this path manipulation to support those dependencies. This can be\ndone by creating a `.ycm_extra_conf.py` file at the root of the project. This\nfile must define a `Settings( **kwargs )` function returning a dictionary with\nthe list of paths to prepend to `sys.path` under the `sys_path` key. For\ninstance, the following `.ycm_extra_conf.py` adds the paths\n`/path/to/some/third_party/package` and `/path/to/another/third_party/package`\nat the start of `sys.path`:\n\n```python\ndef Settings( **kwargs ):\n return {\n 'sys_path': [\n '/path/to/some/third_party/package',\n '/path/to/another/third_party/package'\n ]\n }\n```\n\nIf you would rather prepend paths to `sys.path` with a Vim option, read the\n[Configuring through Vim options](#configuring-through-vim-options) section.\n\nIf you need further control on how to add paths to `sys.path`, you should define\nthe `PythonSysPath( **kwargs )` function in the `.ycm_extra_conf.py` file. Its\nkeyword arguments are `sys_path` which contains the default `sys.path`, and\n`interpreter_path` which is the path to the Python interpreter. Here's a trivial\nexample that inserts the `/path/to/third_party/package` path at the second\nposition of `sys.path`:\n\n```python\ndef PythonSysPath( **kwargs ):\n sys_path = kwargs[ 'sys_path' ]\n sys_path.insert( 1, '/path/to/third_party/package' )\n return sys_path\n```\n\nA more advanced example can be found in [YCM's own\n`.ycm_extra_conf.py`][ycm_flags_example].\n\n#### Configuring through Vim options\n\nYou may find it inconvenient to have to create a `.ycm_extra_conf.py` file at the\nroot of each one of your projects in order to set the path to the Python\ninterpreter and/or add paths to `sys.path` and would prefer to be able to\nconfigure those through Vim options. Don't worry, this is possible by using the\n[`g:ycm_extra_conf_vim_data`](#the-gycm_extra_conf_vim_data-option) option and\ncreating a global extra configuration file. Let's take an example. Suppose that\nyou want to set the interpreter path with the `g:ycm_python_interpreter_path`\noption and prepend paths to `sys.path` with the `g:ycm_python_sys_path` option.\nSuppose also that you want to name the global extra configuration file\n`global_extra_conf.py` and that you want to put it in your HOME folder. You\nshould then add the following lines to your vimrc:\n\n```viml\nlet g:ycm_python_interpreter_path = ''\nlet g:ycm_python_sys_path = []\nlet g:ycm_extra_conf_vim_data = [\n \\ 'g:ycm_python_interpreter_path',\n \\ 'g:ycm_python_sys_path'\n \\]\nlet g:ycm_global_ycm_extra_conf = '~/global_extra_conf.py'\n```\n\nThen, create the `~/global_extra_conf.py` file with the following contents:\n\n```python\ndef Settings( **kwargs ):\n client_data = kwargs[ 'client_data' ]\n return {\n 'interpreter_path': client_data[ 'g:ycm_python_interpreter_path' ],\n 'sys_path': client_data[ 'g:ycm_python_sys_path' ]\n }\n```\n\nThat's it. You are done. Note that you don't need to restart the server when\nsetting one of the options. YCM will automatically pick the new values.\n\n### Rust Semantic Completion\n\nYCM uses [rust-analyzer][] for Rust semantic completion.\n\nNOTE: Previously, YCM used [rls][] for rust completion. This is no longer\nsupported, as the Rust community has decided on [rust-analyzer][] as the future\nof Rust tooling.\n\nCompletions and GoTo commands within the current crate and its dependencies\nshould work out of the box with no additional configuration (provided that you\nbuilt YCM with the `--rust-completer` flag; see the [*Installation*\nsection](#installation) for details). The install script takes care of\ninstalling [the Rust source code][rust-src], so no configuration is necessary.\n\n`rust-analyzer` supports a myriad of options. These are configured using [LSP\nconfiguration](#lsp-configuration), and are [documented here](https://rust-analyzer.github.io/manual.html#configuration]).\n\n### Go Semantic Completion\n\nCompletions and GoTo commands should work out of the box (provided that you\nbuilt YCM with the `--go-completer` flag; see the [*Installation*\nsection](#installation) for details). The server only works for projects with\nthe \"canonical\" layout.\n\n`gopls` also has a load of [documented options](https://github.com/golang/tools/blob/master/gopls/doc/settings.md).\n\nYou can set these in your `.ycm_extra_conf.py`. For example, to set the build tags:\n\n```python\ndef Settings( **kwargs ):\n if kwargs[ 'language' ] == 'go':\n return {\n 'ls': {\n 'build.buildFlags': [ '-tags=debug' ] }\n }\n }\n```\n\n### JavaScript and TypeScript Semantic Completion\n\n**NOTE:** YCM originally used the [Tern][] engine for JavaScript but due to\n[Tern][] not being maintained anymore by its main author and the [TSServer][]\nengine offering more features, YCM is moving to [TSServer][]. This won't affect\nyou if you were already using [Tern][] but you are encouraged to do the switch\nby deleting the `third_party/ycmd/third_party/tern_runtime/node_modules`\ndirectory in YCM folder. If you are a new user but still want to use [Tern][],\nyou should pass the `--js-completer` option to the `install.py` script during\ninstallation. Further instructions on how to set up YCM with [Tern][] are\navailable on [the wiki][tern-instructions].\n\nAll JavaScript and TypeScript features are provided by the [TSServer][] engine,\nwhich is included in the TypeScript SDK. To enable these features, install\n[Node.js 18+ and npm][npm-install] and call the `install.py` script with the\n`--ts-completer` flag.\n\n[TSServer][] relies on [the `jsconfig.json` file][jsconfig.json] for JavaScript\nand [the `tsconfig.json` file][tsconfig.json] for TypeScript to analyze your\nproject. Ensure the file exists at the root of your project.\n\nTo get diagnostics in JavaScript, set the `checkJs` option to `true` in your\n`jsconfig.json` file:\n\n```json\n{\n \"compilerOptions\": {\n \"checkJs\": true\n }\n}\n```\n\n### Semantic Completion for Other Languages\n\nC-family, C#, Go, Java, Python, Rust, and JavaScript/TypeScript languages are\nsupported natively by YouCompleteMe using the [Clang][], [OmniSharp-Roslyn][],\n[Gopls][], [jdt.ls][], [Jedi][], [rust-analyzer][], and [TSServer][] engines,\nrespectively. Check the [installation](#installation) section for instructions\nto enable these features if desired.\n\n#### Plugging an arbitrary LSP server\n\nSimilar to other LSP clients, YCM can use an arbitrary LSP server with the help\nof [`g:ycm_language_server`](#the-gycm_language_server-option) option. An\nexample of a value of this option would be:\n\n```viml\nlet g:ycm_language_server = \n \\ [ \n \\ {\n \\ 'name': 'yaml',\n \\ 'cmdline': [ '/path/to/yaml/server/yaml-language-server', '--stdio' ],\n \\ 'filetypes': [ 'yaml' ]\n \\ },\n \\ {\n \\ 'name': 'csharp',\n \\ 'cmdline': [ 'OmniSharp', '-lsp' ],\n \\ 'filetypes': [ 'csharp' ],\n \\ 'project_root_files': [ '*.csproj', '*.sln' ]\n \\ },\n \\ {\n \\ 'name': 'godot',\n \\ 'filetypes': [ 'gdscript' ],\n \\ 'port': 6008,\n \\ 'project_root_files': [ 'project.godot' ]\n \\ }\n \\ ]\n```\n\nEach dictionary contains the following keys: `name`, `cmdline`, `port`,\n`filetypes`, `capabilities`, `project_root_files`, `additional_workspace_dirs`,\n`triggerCharacters`, and `settings`. The full description of each key can be\nfound in the [ycmd][language_server-configuration] repository.\n\nSee [the LSP Examples](https://github.com/ycm-core/lsp-examples) project for more\nexamples of configuring the likes of PHP, Ruby, Kotlin, and D.\n\n#### LSP Configuration\n\nMany LSP servers allow some level of user configuration. YCM enables this with\nthe help of `.ycm_extra_conf.py` files. Here's an example of jdt.ls user\nexamples of configuring the likes of PHP, Ruby, Kotlin, D, and many, many more.\n\n```python\ndef Settings( **kwargs ):\n if kwargs[ 'language' ] == 'java':\n return {\n 'ls': {\n 'java.format.onType.enabled': True\n }\n }\n```\n\nThe `ls` key tells YCM that the dictionary should be passed to the LSP server.\nFor each of the LSP server's configuration, you should look up the respective\nserver's documentation.\n\nSome servers request settings from arbitrary 'sections' of configuration. There\nis no concept of configuration sections in Vim, so you can specify an additional\n`config_sections` dictionary which maps section to a dictionary of config\nrequired by the server. For example:\n\n```python\ndef Settings( **kwargs ):\n if kwargs[ 'language' ] == 'java':\n return {\n 'ls': {\n 'java.format.onType.enabled': True\n },\n 'config_sections': {\n 'some section': {\n 'some option': 'some value'\n }\n }\n```\n\nThe sections and options/values are completely server-specific and rarely well\ndocumented.\n\n#### Using `omnifunc` for semantic completion\n\nYCM will use your `omnifunc` (see `:h omnifunc` in Vim) as a source for semantic\ncompletions if it does not have a native semantic completion engine for your\nfile's filetype. Vim comes with rudimentary omnifuncs for various languages like\nRuby, PHP, etc. It depends on the language.\n\nYou can get a stellar omnifunc for Ruby with [Eclim][]. Just make sure you have\nthe _latest_ Eclim installed and configured (this means Eclim `>= 2.2.*` and\nEclipse `>= 4.2.*`).\n\nAfter installing Eclim remember to create a new Eclipse project within your\napplication by typing `:ProjectCreate -n ruby` inside Vim\nand don't forget to have `let g:EclimCompletionMethod = 'omnifunc'` in your\nvimrc. This will make YCM and Eclim play nice; YCM will use Eclim's omnifuncs as\nthe data source for semantic completions and provide the auto-triggering and\nsubsequence-based matching (and other YCM features) on top of it.\n\n### Writing New Semantic Completers\n\nYou have two options here: writing an `omnifunc` for Vim's omnicomplete system\nthat YCM will then use through its omni-completer, or a custom completer for YCM\nusing the [Completer API][completer-api].\n\nHere are the differences between the two approaches:\n\n- You have to use VimScript to write the omnifunc, but get to use Python to\n write for the Completer API; this by itself should make you want to use the\n API.\n- The Completer API is a _much_ more powerful way to integrate with YCM and it\n provides a wider set of features. For instance, you can make your Completer\n query your semantic back-end in an asynchronous fashion, thus not blocking\n Vim's GUI thread while your completion system is processing stuff. This is\n impossible with VimScript. All of YCM's completers use the Completer API.\n- Performance with the Completer API is better since Python executes faster than\n VimScript.\n\nIf you want to use the `omnifunc` system, see the relevant Vim docs with `:h\ncomplete-functions`. For the Completer API, see [the API docs][completer-api].\n\nIf you want to upstream your completer into YCM's source, you should use the\nCompleter API.\n\n### Diagnostic Display\n\nYCM will display diagnostic notifications for the C-family, C#, Go, Java,\nJavaScript, Rust, and TypeScript languages. Since YCM continuously recompiles\nyour file as you type, you'll get notified of errors and warnings in your file\nas fast as possible.\n\nHere are the various pieces of the diagnostic UI:\n\n- Icons show up in the Vim gutter on lines that have a diagnostic.\n- Regions of text related to diagnostics are highlighted (by default, a red\n wavy underline in `gvim` and a red background in `vim`).\n- Moving the cursor to a line with a diagnostic echoes the diagnostic text.\n- Vim's location list is automatically populated with diagnostic data (off by\n default, see options).\n\nThe new diagnostics (if any) will be displayed the next time you press any key\non the keyboard. So if you stop typing and just wait for the new diagnostics to\ncome in, that _will not work_. You need to press some key for the GUI to update.\n\nHaving to press a key to get the updates is unfortunate, but cannot be changed\ndue to the way Vim internals operate; there is no way that a background task can\nupdate Vim's GUI after it has finished running. You _have to_ press a key. This\nwill make YCM check for any pending diagnostics updates.\n\nYou _can_ force a full, blocking compilation cycle with the\n`:YcmForceCompileAndDiagnostics` command (you may want to map that command to a\nkey; try putting `nnoremap :YcmForceCompileAndDiagnostics` in your\nvimrc). Calling this command will force YCM to immediately recompile your file\nand display any new diagnostics it encounters. Do note that recompilation with\nthis command may take a while and during this time the Vim GUI _will_ be\nblocked.\n\nYCM will display a short diagnostic message when you move your cursor to the\nline with the error. You can get a detailed diagnostic message with the\n`d` key mapping (can be changed in the options) YCM provides when your\ncursor is on the line with the diagnostic.\n\nYou can also see the full diagnostic message for all the diagnostics in the\ncurrent file in Vim's `locationlist`, which can be opened with the `:lopen` and\n`:lclose` commands (make sure you have set `let\ng:ycm_always_populate_location_list = 1` in your vimrc). A good way to toggle\nthe display of the `locationlist` with a single key mapping is provided by\nanother (very small) Vim plugin called [ListToggle][] (which also makes it\npossible to change the height of the `locationlist` window), also written by\nyours truly.\n\n#### Diagnostic Highlighting Groups\n\nYou can change the styling for the highlighting groups YCM uses. For the signs\nin the Vim gutter, the relevant groups are:\n\n- `YcmErrorSign`, which falls back to group `SyntasticErrorSign` and then\n `error` if they exist\n- `YcmWarningSign`, which falls back to group `SyntasticWarningSign` and then\n `todo` if they exist\n\nYou can also style the line that has the warning/error with these groups:\n\n- `YcmErrorLine`, which falls back to group `SyntasticErrorLine` if it exists\n- `YcmWarningLine`, which falls back to group `SyntasticWarningLine` if it\n exists\n\nFinally, you can also style the popup for the detailed diagnostics (it is shown\nif `g:ycm_show_detailed_diag_in_popup` is set) using the group `YcmErrorPopup`,\nwhich falls back to `ErrorMsg`.\n\nNote that the line highlighting groups only work when the\n[`g:ycm_enable_diagnostic_signs`](#the-gycm_enable_diagnostic_signs-option)\noption is set. If you want highlighted lines but no signs in the Vim gutter,\nset the `signcolumn` option to `no` in your vimrc:\n\n```viml\nset signcolumn=no\n```\n\nThe syntax groups used to highlight regions of text with errors/warnings:\n- `YcmErrorSection`, which falls back to group `SyntasticError` if it exists and\n then `SpellBad`\n- `YcmWarningSection`, which falls back to group `SyntasticWarning` if it exists\n and then `SpellCap`\n\nHere's how you'd change the style for a group:\n\n```viml\nhighlight YcmErrorLine guibg=#3f0000\n```\n\n### Symbol Search\n\n***This feature requires Vim and is not supported in Neovim***\n\nYCM provides a way to search for and jump to a symbol in the current project or\ndocument when using supported languages.\n\nYou can search for symbols in the current workspace when the `GoToSymbol`\nrequest is supported and the current document when `GoToDocumentOutline` is\nsupported.\n\nHere's a quick demo: \n\n[![asciicast](https://asciinema.org/a/4JmYLAaz5hOHbZDD0hbsQpY8C.svg)](https://asciinema.org/a/4JmYLAaz5hOHbZDD0hbsQpY8C)\n\nAs you can see, you can type and YCM filters down the list as you type. The\ncurrent set of matches are displayed in a popup window in the centre of the\nscreen and you can select an entry with the keyboard, to jump to that position.\nAny matches are then added to the quickfix list.\n\nTo enable:\n\n* `nmap (YCMFindSymbolInWorkspace)`\n* `nmap (YCMFindSymbolInDocument)`\n\ne.g.\n\n* `nmap yfw (YCMFindSymbolInWorkspace)`\n* `nmap yfd (YCMFindSymbolInDocument)`\n\nWhen searching, YCM opens a prompt buffer at the top of the screen for the\ninput and puts you in insert mode. This means that you can hit `` to go\ninto normal mode and use any other input commands that are supported in prompt\nbuffers. As you type characters, the search is updated.\n\nInitially, results are queried from all open filetypes. You can hit `` to\nswitch to just the current filetype while the popup is open.\n\nWhile the popup is open, the following keys are intercepted:\n\n* ``, ``, ``, `` - select the next item\n* ``, ``, ``, `` - select the previous item\n* ``, `` - jump up one screenful of items \n* ``, `` - jump down one screenful of items\n* ``, `` - jump to first item\n* ``, `` - jump to last item\n* `` - jump to the selected item\n* `` cancel/dismiss the popup\n* `` - toggle results from all file types or just the current filetype\n\nThe search is also cancelled if you leave the prompt buffer window at any time,\nso you can use window commands `...` for example.\n\n#### Closing the popup\n\n***NOTE***: Pressing `` does not close the popup - you must use `Ctrl-c`\nfor that, or use a window command (e.g. `j`) or the mouse to leave the\nprompt buffer window.\n\n### Type/Call Hierarchy\n\n***This feature requires Vim and is not supported in Neovim***\n\n**NOTE**: This feature is highly experimental and offered in the hope that it is\nuseful. Please help us by reporting issues and offering feedback.\n\nYCM provides a way to view and navigate hierarchies. The following hierarchies\nare supported:\n\n* Type hierachy `(YCMTypeHierarchy)`: Display subtypes and supertypes\n of the symbol under cursor. Expand down to subtypes and up to supertypes.\n* Call hierarchy `(YCMCallHierarchy)`: Display callees and callers of\n the symbol under cursor. Expand down to callers and up to callees.\n\nTake a look at this [![asciicast](https://asciinema.org/a/659925.svg)](https://asciinema.org/a/659925)\nfor brief demo.\n\nHierarchy UI can be initiated by mapping something to the indicated plug\nmappings, for example:\n\n```viml\nnmap yth (YCMTypeHierarchy)\nnmap ych (YCMCallHierarchy)\n```\n\nThis opens a \"modal\" popup showing the current element in the hierarchy tree.\nThe current tree root is aligned to the left and child and parent nodes are\nexpanded to the right. Expand the tree \"down\" with `` and \"up\" with ``.\n\nThe \"root\" of the tree can be re-focused to the selected item with\n`` and further `` will show the parents of the selected item. This\ncan take a little getting used to, but it's particularly important with multiple\ninheritance where a \"child\" of the current root may actually have other,\ninvisible, parent links. `` on that row will show these by setting the\ndisplay root to the selected item.\n\nWhen the hierarchy is displayed, the following keys are intercepted:\n\n* ``: Drill into the hierarchy at the selected item: expand and show\n children of the selected item.\n* ``: Show parents of the selected item. When applied to sub-types, this\n will re-root the tree at that type, so that all parent types (are displayed).\n Similar for callers.\n* ``: Jump to the symbol currently selected.\n* ``, ``, ``, `j`: Select the next item\n* ``, ``, ``, `k`; Select the previous item\n* Any other key: closes the popup without jumping to any location\n\n**Note:** you might think the call hierarchy tree is inverted, but we think\nthis way round is more intuitive because this is the typical way that call\nstacks are displayed (with the current function at the top, and its callers\nbelow). \n\nCommands\n--------\n\n### The `:YcmRestartServer` command\n\nIf the [ycmd completion server][ycmd] suddenly stops for some reason, you can\nrestart it with this command.\n\n### The `:YcmForceCompileAndDiagnostics` command\n\nCalling this command will force YCM to immediately recompile your file\nand display any new diagnostics it encounters. Do note that recompilation with\nthis command may take a while and during this time the Vim GUI _will_ be\nblocked.\n\nYou may want to map this command to a key; try putting `nnoremap \n:YcmForceCompileAndDiagnostics` in your vimrc.\n\n### The `:YcmDiags` command\n\nCalling this command will fill Vim's `locationlist` with errors or warnings if\nany were detected in your file and then open it. If a given error or warning can\nbe fixed by a call to `:YcmCompleter FixIt`, then ` (FixIt available)` is\nappended to the error or warning text. See the `FixIt` completer subcommand for\nmore information.\n\n**NOTE:** The absence of ` (FixIt available)` does not strictly imply a fix-it\nis not available as not all completers are able to provide this indication. For\nexample, the c-sharp completer provides many fix-its but does not add this\nadditional indication.\n\nThe `g:ycm_open_loclist_on_ycm_diags` option can be used to prevent the location\nlist from opening, but still have it filled with new diagnostic data. See the\n_Options_ section for details.\n\n### The `:YcmShowDetailedDiagnostic` command\n\nThis command shows the full diagnostic text when the user's cursor is on the\nline with the diagnostic.\n\nAn options argument can be passed. If the argument is `popup` the diagnostic\ntext will be displayed in a popup at the cursor position.\n\nIf you prefer the detailed diagnostic to always be shown in a popup, then\n`let g:ycm_show_detailed_diag_in_popup=1`.\n\n### The `:YcmDebugInfo` command\n\nThis will print out various debug information for the current file. Useful to\nsee what compile commands will be used for the file if you're using the semantic\ncompletion engine.\n\n### The `:YcmToggleLogs` command\n\nThis command presents the list of logfiles created by YCM, the [ycmd\nserver][ycmd], and the semantic engine server for the current filetype, if any.\nOne of these logfiles can be opened in the editor (or closed if already open) by\nentering the corresponding number or by clicking on it with the mouse.\nAdditionally, this command can take the logfile names as arguments. Use the\n`` key (or any other key defined by the `wildchar` option) to complete the\narguments or to cycle through them (depending on the value of the `wildmode`\noption). Each logfile given as an argument is directly opened (or closed if\nalready open) in the editor. Only for debugging purposes.\n\n### The `:YcmCompleter` command\n\nThis command gives access to a number of additional [IDE-like\nfeatures](#quick-feature-summary) in YCM, for things like semantic GoTo, type\ninformation, FixIt, and refactoring.\n\nThis command accepts a range that can either be specified through a selection in\none of Vim's visual modes (see `:h visual-use`) or on the command line. For\ninstance, `:2,5YcmCompleter` will apply the command from line 2 to line 5. This\nis useful for [the `Format` subcommand](#the-format-subcommand).\n\nCall `YcmCompleter` without further arguments for a list of the commands you can\ncall for the current completer.\n\nSee the [file type feature summary](#quick-feature-summary) for an overview of\nthe features available for each file type. See the _YcmCompleter subcommands_\nsection for more information on the available subcommands and their usage.\n\nSome commands, like `Format` accept a range, like `:%YcmCompleter Format`.\n\nSome commands like `GetDoc` and the various `GoTo` commands respect modifiers,\nlike `:rightbelow YcmCompleter GetDoc`, `:vertical YcmCompleter GoTo`.\n\nYcmCompleter Subcommands\n------------------------\n\n**NOTE:** See the docs for the `YcmCompleter` command before tackling this\nsection.\n\nThe invoked subcommand is automatically routed to the currently active semantic\ncompleter, so `:YcmCompleter GoToDefinition` will invoke the `GoToDefinition`\nsubcommand on the Python semantic completer if the currently active file is a\nPython one and on the Clang completer if the currently active file is a C-family\nlanguage one.\n\nYou may also want to map the subcommands to something less verbose; for\ninstance, `nnoremap jd :YcmCompleter GoTo`\nmaps the `jd` sequence to the longer subcommand invocation.\n\n### GoTo Commands\n\nThese commands are useful for jumping around and exploring code. When moving\nthe cursor, the subcommands add entries to Vim's `jumplist` so you can use\n`CTRL-O` to jump back to where you were before invoking the command (and\n`CTRL-I` to jump forward; see `:h jumplist` for details). If there is more\nthan one destination, the quickfix list (see `:h quickfix`) is populated with\nthe available locations and opened to the full width at the bottom of the screen.\nYou can change this behavior by using [the `YcmQuickFixOpened`\nautocommand](#the-ycmquickfixopened-autocommand).\n\n#### The `GoToInclude` subcommand\n\nLooks up the current line for a header and jumps to it.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda`\n\n#### The `GoToAlternateFile` subcommand\n\nJump to the associated file, as defined by the language server. Typically this\nwill jump you to the associated header file for a C or C++ translation unit.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda` (clangd only)\n\n#### The `GoToDeclaration` subcommand\n\nLooks up the symbol under the cursor and jumps to its declaration.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript,\npython, rust, typescript`\n\n#### The `GoToDefinition` subcommand\n\nLooks up the symbol under the cursor and jumps to its definition.\n\n**NOTE:** For C-family languages **this only works in certain situations**,\nnamely when the definition of the symbol is in the current translation unit. A\ntranslation unit consists of the file you are editing and all the files you are\nincluding with `#include` directives (directly or indirectly) in that file.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript,\npython, rust, typescript`\n\n#### The `GoTo` subcommand\n\nThis command tries to perform the \"most sensible\" GoTo operation it can.\nCurrently, this means that it tries to look up the symbol under the cursor and\njumps to its definition if possible; if the definition is not accessible from\nthe current translation unit, jumps to the symbol's declaration. For\nC-family languages, it first tries to look up the current line for a header and\njump to it. For C#, implementations are also considered and preferred.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript,\npython, rust, typescript`\n\n#### The `GoToImprecise` subcommand\n\nWARNING: This command trades correctness for speed!\n\nSame as the `GoTo` command except that it doesn't recompile the file with\nlibclang before looking up nodes in the AST. This can be very useful when you're\nediting files that take time to compile but you know that you haven't made any\nchanges since the last parse that would lead to incorrect jumps. When you're\njust browsing around your codebase, this command can spare you quite a bit of\nlatency.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda`\n\n#### The `GoToSymbol ` subcommand\n\nFinds the definition of all symbols matching a specified string. Note that this\ndoes not use any sort of smart/fuzzy matching. However, an [interactive symbol\nsearch](#symbol-search) is also available.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, cs, java, javascript, python, typescript`\n\n#### The `GoToReferences` subcommand\n\nThis command attempts to find all of the references within the project to the\nidentifier under the cursor and populates the quickfix list with those\nlocations.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, java, javascript, python, typescript, rust`\n\n#### The `GoToImplementation` subcommand\n\nLooks up the symbol under the cursor and jumps to its implementation (i.e.\nnon-interface). If there are multiple implementations, instead provides a list\nof implementations to choose from.\n\nSupported in filetypes: `cs, go, java, rust, typescript, javascript`\n\n#### The `GoToImplementationElseDeclaration` subcommand\n\nLooks up the symbol under the cursor and jumps to its implementation if one,\nelse jump to its declaration. If there are multiple implementations, instead\nprovides a list of implementations to choose from.\n\nSupported in filetypes: `cs`\n\n#### The `GoToType` subcommand\n\nLooks up the symbol under the cursor and jumps to the definition of its type\ne.g. if the symbol is an object, go to the definition of its class.\n\nSupported in filetypes: `go, java, javascript, typescript`\n\n#### The `GoToDocumentOutline` subcommand\n\nProvides a list of symbols in the current document, in the quickfix list. See also\n[interactive symbol search](#symbol-search).\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, go, java, rust`\n\n#### The `GoToCallers` and `GoToCallees` subcommands\n\nNote: A much more powerful call and type hierarchy can be viewd interactively.\nSee [interactive type and call hierarchy](#interactive-type-and-call-hierarchy).\n\nPopulate the quickfix list with the callers, or callees respectively, of the\nfunction associated with the current cursor position. The semantics of this\ndiffer depending on the filetype and language server.\n\nOnly supported for LSP servers that provide the `callHierarchyProvider`\ncapability.\n\n### Semantic Information Commands\n\nThese commands are useful for finding static information about the code, such\nas the types of variables, viewing declarations, and documentation strings.\n\n#### The `GetType` subcommand\n\nEchos the type of the variable or method under the cursor, and where it differs,\nthe derived type.\n\nFor example:\n\n```c++\n std::string s;\n```\n\nInvoking this command on `s` returns `std::string => std::basic_string`\n\n**NOTE:** Causes re-parsing of the current translation unit.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, java, javascript,\ngo, python, typescript, rust`\n\n#### The `GetTypeImprecise` subcommand\n\nWARNING: This command trades correctness for speed!\n\nSame as the `GetType` command except that it doesn't recompile the file with\nlibclang before looking up nodes in the AST. This can be very useful when you're\nediting files that take time to compile but you know that you haven't made any\nchanges since the last parse that would lead to incorrect type. When you're\njust browsing around your codebase, this command can spare you quite a bit of\nlatency.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda`\n\n#### The `GetParent` subcommand\n\nEchos the semantic parent of the point under the cursor.\n\nThe semantic parent is the item that semantically contains the given position.\n\nFor example:\n\n```c++\nclass C {\n void f();\n};\n\nvoid C::f() {\n\n}\n```\n\nIn the out-of-line definition of `C::f`, the semantic parent is the class `C`,\nof which this function is a member.\n\nIn the example above, both declarations of `C::f` have `C` as their semantic\ncontext, while the lexical context of the first `C::f` is `C` and the lexical\ncontext of the second `C::f` is the translation unit.\n\nFor global declarations, the semantic parent is the translation unit.\n\n**NOTE:** Causes re-parsing of the current translation unit.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda`\n\n#### The `GetDoc` subcommand\n\nDisplays the preview window populated with quick info about the identifier\nunder the cursor. Depending on the file type, this includes things like:\n\n* The type or declaration of identifier,\n* Doxygen/javadoc comments,\n* Python docstrings,\n* etc.\n\nThe documentation is opened in the preview window, and options like\n`previewheight` are respected. If you would like to customise the height and\nposition of this window, we suggest a custom command that:\n\n* Sets `previewheight` temporarily\n* Runs the `GetDoc` command with supplied modifiers\n* Restores `previewheight`.\n\nFor example:\n\n```viml\ncommand -count ShowDocWithSize\n \\ let g:ph=&previewheight \n \\ set previewheight=\n \\ YcmCompleter GetDoc\n \\ let &previewheight=g:ph\n```\n\nYou can then use something like `:botright vertical 80ShowDocWithSize`. Here's an\nexample of that: https://asciinema.org/a/hE6Pi1gU6omBShwFna8iwGEe9\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript,\npython, typescript, rust`\n\n#### The `GetDocImprecise` subcommand\n\nWARNING: This command trades correctness for speed!\n\nSame as the `GetDoc` command except that it doesn't recompile the file with\nlibclang before looking up nodes in the AST. This can be very useful when you're\nediting files that take long to compile but you know that you haven't made any\nchanges since the last parse that would lead to incorrect docs. When you're\njust browsing around your codebase, this command can spare you quite a bit of\nlatency.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda`\n\n### Refactoring Commands\n\nThese commands make changes to your source code in order to perform refactoring\nor code correction. YouCompleteMe does not perform any action which cannot be\nundone, and never saves or writes files to the disk.\n\n#### The `FixIt` subcommand\n\nWhere available, attempts to make changes to the buffer to correct diagnostics,\nor perform refactoring, on the current line or selection. Where multiple\nsuggestions are available (such as when there are multiple ways to resolve a\ngiven warning, or where multiple diagnostics are reported for the current line,\nor multiple refactoring tweaks are available), the options are presented and\none can be selected.\n\nCompleters that provide diagnostics may also provide trivial modifications to\nthe source in order to correct the diagnostic. Examples include syntax errors\nsuch as missing trailing semi-colons, spurious characters, or other errors which\nthe semantic engine can deterministically suggest corrections. A small demo\npresenting how diagnostics can be fixed with clangd:\n\n![YcmCompleter-FixIt-OnDiagnostic](https://user-images.githubusercontent.com/17928698/206855014-9131a49b-87e8-4ed4-8d91-f2fe7808a0b9.gif)\n\nCompleters (LSPs) may also provide refactoring tweaks, which may be available\neven when no diagnostic is presented for the current line. These include\nfunction extraction, variable extraction, `switch` population, constructor\ngeneration, ... The tweaks work for a selection as well. Consult your LSP for\navailable refactorings. A demonstration of refactoring capabilities with clangd:\n\n![YouCompleter-FixIt-Refactoring](https://user-images.githubusercontent.com/17928698/206855713-3588c8de-d0f5-4725-b65e-bc51110252cc.gif)\n\nIf no fix-it is available for the current line, or there is no diagnostic on the\ncurrent line, this command has no effect on the current buffer. If any\nmodifications are made, the number of changes made to the buffer is echo'd and\nthe user may use the editor's undo command to revert.\n\nWhen a diagnostic is available, and `g:ycm_echo_current_diagnostic` is enabled,\nthen the text ` (FixIt)` is appended to the echo'd diagnostic when the\ncompleter is able to add this indication. The text ` (FixIt available)` is\nalso appended to the diagnostic text in the output of the `:YcmDiags` command\nfor any diagnostics with available fix-its (where the completer can provide this\nindication).\n\n**NOTE:** Causes re-parsing of the current translation unit.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript,\nrust, typescript`\n\n#### The `RefactorRename ` subcommand\n\nIn supported file types, this command attempts to perform a semantic rename of\nthe identifier under the cursor. This includes renaming declarations,\ndefinitions, and usages of the identifier, or any other language-appropriate\naction. The specific behavior is defined by the semantic engine in use.\n\nSimilar to `FixIt`, this command applies automatic modifications to your source\nfiles. Rename operations may involve changes to multiple files, which may or may\nnot be open in Vim buffers at the time. YouCompleteMe handles all of this for\nyou. The behavior is described in [the following section](#multi-file-refactor).\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, java, javascript, python, typescript, rust, cs`\n\n#### Python refactorings\n\nThe following additional commands are supported for Python:\n\n* `RefactorInline`\n* `RefactorExtractVariable`\n* `RefactorExtractFunction`\n\nSee the [jedi docs][jedi-refactor-doc] for what they do.\n\nSupported in filetypes: `python`\n\n#### Multi-file Refactor\n\nWhen a Refactor or FixIt command touches multiple files, YouCompleteMe attempts\nto apply those modifications to any existing open, visible buffer in the current\ntab. If no such buffer can be found, YouCompleteMe opens the file in a new\nsmall horizontal split at the top of the current window, applies the change,\nand then *hides* the window. **NOTE:** The buffer remains open, and must be\nmanually saved. A confirmation dialog is opened prior to doing this to remind\nyou that this is about to happen.\n\nOnce the modifications have been made, the quickfix list (see `:help quickfix`)\nis populated with the locations of all modifications. This can be used to review\nall automatic changes made by using `:copen`. Typically, use the `CTRL-W\n` combination to open the selected file in a new split. It is possible to\ncustomize how the quickfix window is opened by using [the `YcmQuickFixOpened`\nautocommand](#the-ycmquickfixopened-autocommand).\n\nThe buffers are *not* saved automatically. That is, you must save the modified\nbuffers manually after reviewing the changes from the quickfix list. Changes\ncan be undone using Vim's powerful undo features (see `:help undo`). Note\nthat Vim's undo is per-buffer, so to undo all changes, the undo commands must\nbe applied in each modified buffer separately.\n\n**NOTE:** While applying modifications, Vim may find files that are already\nopen and have a swap file. The command is aborted if you select Abort or Quit in\nany such prompts. This leaves the Refactor operation partially complete and must\nbe manually corrected using Vim's undo features. The quickfix list is *not*\npopulated in this case. Inspect `:buffers` or equivalent (see `:help buffers`)\nto see the buffers that were opened by the command.\n\n#### The `Format` subcommand\n\nThis command formats the whole buffer or some part of it according to the value\nof the Vim options `shiftwidth` and `expandtab` (see `:h 'sw'` and `:h et`\nrespectively). To format a specific part of your document, you can either select\nit in one of Vim's visual modes (see `:h visual-use`) and run the command or\ndirectly enter the range on the command line, e.g. `:2,5YcmCompleter Format` to\nformat it from line 2 to line 5.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, java, javascript, go, typescript, rust, cs`\n\n#### The `OrganizeImports` subcommand\n\nThis command removes unused imports and sorts imports in the current file. It\ncan also group imports from the same module in TypeScript and resolve imports\nin Java.\n\nSupported in filetypes: `java, javascript, typescript`\n\n### Miscellaneous Commands\n\nThese commands are for general administration, rather than IDE-like features.\nThey cover things like the semantic engine server instance and compilation\nflags.\n\n#### The `ExecuteCommand ` subcommand\n\nSome LSP completers (currently only Java completers) support executing\nserver-specific commands. Consult the [jdt.ls][] documentation to find out\nwhat commands are supported and which arguments are expected.\n\nThe support for `ExecuteCommand` was implemented to support plugins like\n[Vimspector][] to debug java, but isn't limited to that specific use case.\n\n#### The `RestartServer` subcommand\n\nRestarts the downstream semantic engine server for those semantic engines that\nwork as separate servers that YCM talks to.\n\nSupported in filetypes: `c, cpp, objc, objcpp, cuda, cs, go, java, javascript, rust, typescript`\n\n#### The `ReloadSolution` subcommand\n\nInstruct the Omnisharp-Roslyn server to clear its cache and reload all files\nfrom the disk. This is useful when files are added, removed, or renamed in the\nsolution, files are changed outside of Vim, or whenever Omnisharp-Roslyn cache\nis out-of-sync.\n\nSupported in filetypes: `cs`\n\nFunctions\n--------\n\n### The `youcompleteme#GetErrorCount` function\n\nGet the number of YCM Diagnostic errors. If no errors are present, this function\nreturns 0.\n\nFor example:\n\n```viml\n call youcompleteme#GetErrorCount()\n```\n\nBoth this function and `youcompleteme#GetWarningCount` can be useful when\nintegrating YCM with other Vim plugins. For example, a [lightline][] user could\nadd a diagnostics section to their statusline which would display the number of\nerrors and warnings.\n\n### The `youcompleteme#GetWarningCount` function\n\nGet the number of YCM Diagnostic warnings. If no warnings are present, this\nfunction returns 0.\n\nFor example:\n\n```viml\n call youcompleteme#GetWarningCount()\n```\n\n### The `youcompleteme#GetCommandResponse( ... )` function\n\nRun a [completer subcommand](#ycmcompleter-subcommands) and return the result as\na string. This can be useful for example to display the `GetDoc` output in a\npopup window, e.g.:\n\n```viml\nlet s:ycm_hover_popup = -1\nfunction s:Hover()\n let response = youcompleteme#GetCommandResponse( 'GetDoc' )\n if response == ''\n return\n endif\n\n call popup_hide( s:ycm_hover_popup )\n let s:ycm_hover_popup = popup_atcursor( balloon_split( response ), {} )\nendfunction\n\n\" CursorHold triggers in normal mode after a delay\nautocmd CursorHold * call s:Hover()\n\" Or, if you prefer, a mapping:\nnnoremap D :call Hover()\n```\n\n**NOTE**: This is only an example, for real hover support, see\n[`g:ycm_auto_hover`](#the-gycm_auto_hover-option).\n\nIf the completer subcommand result is not a string (for example, it's a FixIt or\na Location), or if the completer subcommand raises an error, an empty string is\nreturned, so that calling code does not have to check for complex error\nconditions.\n\nThe arguments to the function are the same as the arguments to the\n`:YcmCompleter` ex command, e.g. the name of the subcommand, followed by any\nadditional subcommand arguments. As with the `YcmCompleter` command, if the\nfirst argument is `ft=` the request is targeted at the specified\nfiletype completer. This is an advanced usage and not necessary in most cases.\n\nNOTE: The request is run synchronously and blocks Vim until the response is\nreceived, so we do not recommend running this as part of an autocommand that\ntriggers frequently.\n\n### The `youcompleteme#GetCommandResponseAsync( callback, ... )` function\n\nThis works exactly like `youcompleteme#GetCommandResponse`, except that instead\nof returning the result, you supply a `callback` argument. This argument must be\na `FuncRef` to a function taking a single argument `response`. This callback\nwill be called with the command response at some point later, or immediately.\n\nAs with `youcompleteme#GetCommandResponse()`, this function will call the\ncallback with `''` (an empty string) if the request is not sent, or if there was\nsome sort of error.\n\nHere's an example that's similar to the one above:\n\n```viml\n\nlet s:ycm_hover_popup = -1\nfunction! s:ShowDataPopup( response ) abort\n if response == ''\n return\n endif\n\n call popup_hide( s:ycm_hover_popup )\n let s:ycm_hover_popup = popup_atcursor( balloon_split( response ), {} )\nendfunction\n\nfunction! s:GetData() abort\n call youcompleteme#GetCommandResponseAsync(\n \\ function( 's:ShowDataPopup' ),\n \\ 'GetDoc' )\nendfunction\n\nautocommand CursorHold * call s:GetData()\n```\n\nAgain, see [`g:ycm_auto_hover`](#the-gycm_auto_hover-option) for proper hover\nsupport.\n\n**NOTE**: The callback may be called immediately, in the stack frame that called\nthis function.\n\n**NOTE**: Only one command request can be outstanding at once. Attempting to\nrequest a second response while the first is outstanding will result in the\nsecond callback being immediately called with `''`.\n\nAutocommands\n------------\n\n### The `YcmLocationOpened` autocommand\n\nThis `User` autocommand is fired when YCM opens the location list window in\nresponse to the `YcmDiags` command. By default, the location list window is\nopened to the bottom of the current window and its height is set to fit all\nentries. This behavior can be overridden by using the `YcmLocationOpened`\nautocommand which is triggered while the cursor is in the location list window.\nFor instance:\n\n```viml\nfunction! s:CustomizeYcmLocationWindow()\n \" Move the window to the top of the screen.\n wincmd K\n \" Set the window height to 5.\n 5wincmd _\n \" Switch back to the working window.\n wincmd p\nendfunction\n\nautocmd User YcmLocationOpened call s:CustomizeYcmLocationWindow()\n```\n\n### The `YcmQuickFixOpened` autocommand\n\nThis `User` autocommand is fired when YCM opens the quickfix window in response\nto the `GoTo*` and `RefactorRename` subcommands. By default, the quickfix window\nis opened to full width at the bottom of the screen and its height is set to fit\nall entries. This behavior can be overridden by using the `YcmQuickFixOpened`\nautocommand which is triggered while the cursor is in the quickfix window. For\ninstance:\n\n```viml\nfunction! s:CustomizeYcmQuickFixWindow()\n \" Move the window to the top of the screen.\n wincmd K\n \" Set the window height to 5.\n 5wincmd _\nendfunction\n\nautocmd User YcmQuickFixOpened call s:CustomizeYcmQuickFixWindow()\n```\n\nOptions\n-------\n\nAll options have reasonable defaults so if the plug-in works after installation\nyou don't need to change any options. These options can be configured in your\n[vimrc script][vimrc] by including a line like this:\n\n```viml\nlet g:ycm_min_num_of_chars_for_completion = 1\n```\n\nNote that after changing an option in your [vimrc script][vimrc] you have to\nrestart [ycmd][] with the `:YcmRestartServer` command for the changes to take\neffect.\n\n### The `g:ycm_min_num_of_chars_for_completion` option\n\nThis option controls the number of characters the user needs to type before\nidentifier-based completion suggestions are triggered. For example, if the\noption is set to `2`, then when the user types a second alphanumeric character\nafter a whitespace character, completion suggestions will be triggered. This\noption is NOT used for semantic completion.\n\nSetting this option to a high number like `99` effectively turns off the\nidentifier completion engine and just leaves the semantic engine.\n\nDefault: `2`\n\n```viml\nlet g:ycm_min_num_of_chars_for_completion = 2\n```\n\n### The `g:ycm_min_num_identifier_candidate_chars` option\n\nThis option controls the minimum number of characters that a completion\ncandidate coming from the identifier completer must have to be shown in the\npopup menu.\n\nA special value of `0` means there is no limit.\n\n**NOTE:** This option only applies to the identifier completer; it has no effect\non the various semantic completers.\n\nDefault: `0`\n\n```viml\nlet g:ycm_min_num_identifier_candidate_chars = 0\n```\n\n### The `g:ycm_max_num_candidates` option\n\nThis option controls the maximum number of semantic completion suggestions shown\nin the completion menu. This only applies to suggestions from semantic\ncompletion engines; see [the `g:ycm_max_identifier_candidates`\noption](#the-gycm_max_num_identifier_candidates-option) to limit the number of\nsuggestions from the identifier-based engine.\n\nA special value of `0` means there is no limit.\n\n**NOTE:** Setting this option to `0` or to a value greater than `100` is not\nrecommended as it will slow down completion when there is a very large number\nof suggestions.\n\nDefault: `50`\n\n```viml\nlet g:ycm_max_num_candidates = 50\n```\n\n### The `g:ycm_max_num_candidates_to_detail` option\n\nSome completion engines require completion candidates to be 'resolved' in order\nto get detailed info such as inline documentation, method signatures, etc. This\ninformation is displayed by YCM in the preview window, or if `completeopt`\ncontains `popup`, in the info popup next to the completion menu.\n\nBy default, if the info popup is in use, and there are more than 10 candidates,\nYCM will defer resolving candidates until they are selected in the completion\nmenu. Otherwise, YCM must resolve the details upfront, which can be costly.\n\nIf neither `popup` nor `preview` are in `completeopt`, YCM disables resolving\naltogether as the information would not be displayed.\n\nThis setting can be used to override these defaults and controls the number of\ncompletion candidates that should be resolved upfront. Typically users do not\nneed to change this, as YCM will work out an appropriate value based on your\n`completeopt` and `g:ycm_add_preview_to_completeopt` settings. However, you may\noverride this calculation by setting this value to a number:\n\n* `-1` - Resolve all candidates upfront\n* `0` - Never resolve any candidates upfront.\n* `> 0` - Resolve up to this many candidates upfront. If the number of\n candidates is greater than this value, no candidates are resolved.\n\nIn the latter two cases, if `completeopt` contains `popup`, then candidates are\nresolved on demand asynchronously.\n\nDefault:\n\n* `0` if neither `popup` nor `preview` are in `completeopt`.\n* `10` if `popup` is in completeopt.\n* `-1` if `preview` is in completeopt.\n\nExample:\n\n```viml\nlet g:ycm_max_num_candidates_to_detail = 0\n```\n\n### The `g:ycm_max_num_identifier_candidates` option\n\nThis option controls the maximum number of completion suggestions from the\nidentifier-based engine shown in the completion menu.\n\nA special value of `0` means there is no limit.\n\n**NOTE:** Setting this option to `0` or to a value greater than `100` is not\nrecommended as it will slow down completion when there is a very large number\nof suggestions.\n\nDefault: `10`\n\n```viml\nlet g:ycm_max_num_identifier_candidates = 10\n```\n\n### The `g:ycm_auto_trigger` option\n\nWhen set to `0`, this option turns off YCM's identifier completer (the\nas-you-type popup) _and_ the semantic triggers (the popup you'd get after typing\n`.` or `->` in say C++). You can still force semantic completion with the\n`` shortcut.\n\nIf you want to just turn off the identifier completer but keep the semantic\ntriggers, you should set `g:ycm_min_num_of_chars_for_completion` to a high\nnumber like `99`.\n\nWhen `g:ycm_auto_trigger` is `0`, YCM sets the `completefunc`, so that you can\nmanually trigger normal completion using `C-x C-u`.\n\nIf you want to map something else to trigger completion, such as `C-d`,\nthen you can map it to `(YCMComplete)`. For example:\n\n```viml\nlet g:ycm_auto_trigger = 0\nimap (YCMComplete)\n```\n\nNOTE: It's not possible to map one of the keys in\n`g:ycm_key_list_select_completion` (or similar) to `(YCMComplete)`. In\npractice that means that you can't use `` for this.\n\nDefault: `1`\n\n```viml\nlet g:ycm_auto_trigger = 1\n```\n\n### The `g:ycm_filetype_whitelist` option\n\nThis option controls for which Vim filetypes (see `:h filetype`) should YCM be\nturned on. The option value should be a Vim dictionary with keys being filetype\nstrings (like `python`, `cpp`, etc.) and values being unimportant (the\ndictionary is used like a hash set, meaning that only the keys matter).\n\nThe `*` key is special and matches all filetypes. By default, the whitelist\ncontains only this `*` key.\n\nYCM also has a `g:ycm_filetype_blacklist` option that lists filetypes for which\nYCM shouldn't be turned on. YCM will work only in filetypes that both the\nwhitelist and the blacklist allow (the blacklist \"allows\" a filetype by _not_\nhaving it as a key).\n\nFor example, let's assume you want YCM to work in files with the `cpp` filetype.\nThe filetype should then be present in the whitelist either directly (`cpp` key\nin the whitelist) or indirectly through the special `*` key. It should _not_ be\npresent in the blacklist.\n\nFiletypes that are blocked by either of the lists will be completely ignored\nby YCM, meaning that neither the identifier-based completion engine nor the\nsemantic engine will operate in them.\n\nYou can get the filetype of the current file in Vim with `:set ft?`.\n\nDefault: `{'*': 1}`\n\n```viml\nlet g:ycm_filetype_whitelist = {'*': 1}\n```\n\n** Completion in buffers with no filetype **\n\nThere is one exception to the above rule. YCM supports completion in buffers\nwith no filetype set, but this must be _explicitly_ whitelisted. To identify\nbuffers with no filetype, we use the `ycm_nofiletype` pseudo-filetype. To enable\ncompletion in buffers with no filetype, set:\n\n```viml\nlet g:ycm_filetype_whitelist = {\n \\ '*': 1,\n \\ 'ycm_nofiletype': 1\n \\ }\n```\n\n### The `g:ycm_filetype_blacklist` option\n\nThis option controls for which Vim filetypes (see `:h filetype`) should YCM be\nturned off. The option value should be a Vim dictionary with keys being filetype\nstrings (like `python`, `cpp`, etc.) and values being unimportant (the\ndictionary is used like a hash set, meaning that only the keys matter).\n\nSee the `g:ycm_filetype_whitelist` option for more details on how this works.\n\nDefault: `[see next line]`\n\n```viml\nlet g:ycm_filetype_blacklist = {\n \\ 'tagbar': 1,\n \\ 'notes': 1,\n \\ 'markdown': 1,\n \\ 'netrw': 1,\n \\ 'unite': 1,\n \\ 'text': 1,\n \\ 'vimwiki': 1,\n \\ 'pandoc': 1,\n \\ 'infolog': 1,\n \\ 'leaderf': 1,\n \\ 'mail': 1\n \\}\n```\n\nIn addition, `ycm_nofiletype` (representing buffers with no filetype set)\nis blacklisted if `ycm_nofiletype` is not _explicitly_ whitelisted (using\n`g:ycm_filetype_whitelist`).\n\n### The `g:ycm_filetype_specific_completion_to_disable` option\n\nThis option controls for which Vim filetypes (see `:h filetype`) should the YCM\nsemantic completion engine be turned off. The option value should be a Vim\ndictionary with keys being filetype strings (like `python`, `cpp`, etc.) and\nvalues being unimportant (the dictionary is used like a hash set, meaning that\nonly the keys matter). The listed filetypes will be ignored by the YCM semantic\ncompletion engine, but the identifier-based completion engine will still trigger\nin files of those filetypes.\n\nNote that even if semantic completion is not turned off for a specific filetype,\nyou will not get semantic completion if the semantic engine does not support\nthat filetype.\n\nYou can get the filetype of the current file in Vim with `:set ft?`.\n\nDefault: `[see next line]`\n\n```viml\nlet g:ycm_filetype_specific_completion_to_disable = {\n \\ 'gitcommit': 1\n \\}\n```\n\n### The `g:ycm_filepath_blacklist` option\n\nThis option controls for which Vim filetypes (see `:h filetype`) should filepath\ncompletion be disabled. The option value should be a Vim dictionary with keys\nbeing filetype strings (like `python`, `cpp`, etc.) and values being unimportant\n(the dictionary is used like a hash set, meaning that only the keys matter).\n\nThe `*` key is special and matches all filetypes. Use this key if you want to\ncompletely disable filepath completion:\n\n```viml\nlet g:ycm_filepath_blacklist = {'*': 1}\n```\n\nYou can get the filetype of the current file in Vim with `:set ft?`.\n\nDefault: `[see next line]`\n\n```viml\nlet g:ycm_filepath_blacklist = {\n \\ 'html': 1,\n \\ 'jsx': 1,\n \\ 'xml': 1,\n \\}\n```\n\n### The `g:ycm_show_diagnostics_ui` option\n\nWhen set, this option turns on YCM's diagnostic display features. See the\n_Diagnostic display_ section in the _User Manual_ for more details.\n\nSpecific parts of the diagnostics UI (like the gutter signs, text highlighting,\ndiagnostic echo, and auto location list population) can be individually turned on\nor off. See the other options below for details.\n\nNote that YCM's diagnostics UI is only supported for C-family languages.\n\nWhen set, this option also makes YCM remove all Syntastic checkers set for the\n`c`, `cpp`, `objc`, `objcpp`, and `cuda` filetypes since this would conflict\nwith YCM's own diagnostics UI.\n\nIf you're using YCM's identifier completer in C-family languages but cannot use\nthe clang-based semantic completer for those languages _and_ want to use the GCC\nSyntastic checkers, unset this option.\n\nDefault: `1`\n\n```viml\nlet g:ycm_show_diagnostics_ui = 1\n```\n\n### The `g:ycm_error_symbol` option\n\nYCM will use the value of this option as the symbol for errors in the Vim\ngutter.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the `g:syntastic_error_symbol` option\nbefore using this option's default.\n\nDefault: `>>`\n\n```viml\nlet g:ycm_error_symbol = '>>'\n```\n\n### The `g:ycm_warning_symbol` option\n\nYCM will use the value of this option as the symbol for warnings in the Vim\ngutter.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the `g:syntastic_warning_symbol` option\nbefore using this option's default.\n\nDefault: `>>`\n\n```viml\nlet g:ycm_warning_symbol = '>>'\n```\n\n### The `g:ycm_enable_diagnostic_signs` option\n\nWhen this option is set, YCM will put icons in Vim's gutter on lines that have a\ndiagnostic set. Turning this off will also turn off the `YcmErrorLine` and\n`YcmWarningLine` highlighting.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the `g:syntastic_enable_signs` option\nbefore using this option's default.\n\nDefault: `1`\n\n```viml\nlet g:ycm_enable_diagnostic_signs = 1\n```\n\n### The `g:ycm_enable_diagnostic_highlighting` option\n\nWhen this option is set, YCM will highlight regions of text that are related to\nthe diagnostic that is present on a line, if any.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the `g:syntastic_enable_highlighting`\noption before using this option's default.\n\nDefault: `1`\n\n```viml\nlet g:ycm_enable_diagnostic_highlighting = 1\n```\n\n### The `g:ycm_echo_current_diagnostic` option\n\nWhen this option is set to 1, YCM will echo the text of the diagnostic present\non the current line when you move your cursor to that line. If a `FixIt` is\navailable for the current diagnostic, then ` (FixIt)` is appended.\n\nIf you have a Vim that supports virtual text, you can set this option\nto the string `virtual-text`, and the diagnostic will be displayed inline with\nthe text, right aligned in the window and wrapping to the next line if there is\nnot enough space, for example:\n\n![Virtual text diagnostic demo][diagnostic-echo-virtual-text1]\n\n![Virtual text diagnostic demo][diagnostic-echo-virtual-text2]\n\n**NOTE**: It's _strongly_ recommended to also set\n`g:ycm_update_diagnostics_in_insert_mode` to `0` when using `virtual-text` for\ndiagnostics. This is due to the increased amount of distraction provided by\ndrawing diagnostics next to your input position.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the `g:syntastic_echo_current_error`\noption before using this option's default.\n\nDefault: `1`\n\nValid values:\n\n* `0` - disabled\n* `1` - echo diagnostic to the command area\n* `'virtual-text'` - display the dignostic to the right of the line in the\n window using virtual text\n\n```viml\nlet g:ycm_echo_current_diagnostic = 1\n\" Or, when you have Vim supporting virtual text\nlet g:ycm_echo_current_diagnostic = 'virtual-text'\n```\n\n### The `g:ycm_auto_hover` option\n\nThis option controls whether or not YCM shows documentation in a popup at the\ncursor location after a short delay. Only supported in Vim.\n\nWhen this option is set to `'CursorHold'`, the popup is displayed on the\n`CursorHold` autocommand. See `:help CursorHold` for the details, but this means\nthat it is displayed after `updatetime` milliseconds. When set to an empty\nstring, the popup is not automatically displayed.\n\nIn addition to this setting, there is the `(YCMHover)` mapping, which can\nbe used to manually trigger or hide the popup (it works like a toggle).\nFor example:\n\n```viml\nnmap D (YCMHover)\n```\n\nAfter dismissing the popup with this mapping, it will not be automatically\ntriggered again until the cursor is moved (i.e. `CursorMoved` autocommand).\n\nThe displayed documentation depends on what the completer for the current\nlanguage supports. It's selected heuristically in this order of preference:\n\n1. `GetHover` with `markdown` syntax\n2. `GetDoc` with no syntax\n3. `GetType` with the syntax of the current file. \n\nYou can customise this by manually setting up `b:ycm_hover` to your liking. This\nbuffer-local variable can be set to a dictionary with the following keys:\n\n* `command`: The YCM completer subcommand which should be run on hover\n* `syntax`: The syntax to use (as in `set syntax=`) in the popup window for\n highlighting.\n* `popup_params`: The params passed to a popup window which gets opened.\n\nFor example, to use C/C++ syntax highlighting in the popup for C-family\nlanguages, add something like this to your vimrc:\n\n```viml\naugroup MyYCMCustom\n autocmd!\n autocmd FileType c,cpp let b:ycm_hover = {\n \\ 'command': 'GetDoc',\n \\ 'syntax': &filetype\n \\ }\naugroup END\n```\n\nYou can also modify the opened popup with `popup_params` key.\nFor example, you can limit the popup's maximum width and add a border to it:\n\n```viml\naugroup MyYCMCustom\n autocmd!\n autocmd FileType c,cpp let b:ycm_hover = {\n \\ 'command': 'GetDoc',\n \\ 'syntax': &filetype\n \\ 'popup_params': {\n \\ 'maxwidth': 80,\n \\ 'border': [],\n \\ 'borderchars': ['─', '│', '─', '│', '┌', '┐', '┘', '└'],\n \\ },\n \\ }\naugroup END\n```\nSee `:help popup_create-arguments` for the list of available popup window options.\n\nDefault: `'CursorHold'`\n\n### The `g:ycm_filter_diagnostics` option\n\nThis option controls which diagnostics will be rendered by YCM. This option\nholds a dictionary of key-values, where the keys are Vim's filetype strings\ndelimited by commas and values are dictionaries describing the filter.\n\nA filter is a dictionary of key-values, where the keys are the type of filter,\nand the value is a list of arguments to that filter. In the case of just a\nsingle item in the list, you may omit the brackets and just provide the argument\ndirectly. If any filter matches a diagnostic, it will be dropped and YCM will\nnot render it.\n\nThe following filter types are supported:\n\n- \"regex\": Accepts a string [regular expression][python-re]. This type matches\nwhen the regex (treated as case-insensitive) is found anywhere in the diagnostic\ntext (`re.search`, not `re.match`)\n- \"level\": Accepts a string level, either \"warning\" or \"error.\" This type\nmatches when the diagnostic has the same level, that is,\nspecifying `level: \"error\"` will remove **all** errors from the diagnostics.\n\n**NOTE:** The regex syntax is **NOT** Vim's, it's [Python's][python-re].\n\nDefault: `{}`\n\nThe following example will do, for Java filetype only:\n- Remove **all** error level diagnostics, and,\n- Also remove anything that contains `taco`\n\n```viml\nlet g:ycm_filter_diagnostics = {\n \\ \"java\": {\n \\ \"regex\": [ \"ta.+co\", ... ],\n \\ \"level\": \"error\",\n \\ ...\n \\ }\n \\ }\n```\n\n### The `g:ycm_always_populate_location_list` option\n\nWhen this option is set, YCM will populate the location list automatically every\ntime it gets new diagnostic data. This option is off by default so as not to\ninterfere with other data you might have placed in the location list.\n\nSee `:help location-list` in Vim to learn more about the location list.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the\n`g:syntastic_always_populate_loc_list` option before using this option's\ndefault.\n\nNote: if YCM's errors aren't visible, it might be that YCM is updating an older location list. See `:help :lhistory` and `:lolder`.\n\nDefault: `0`\n\n```viml\nlet g:ycm_always_populate_location_list = 0\n```\n\n### The `g:ycm_open_loclist_on_ycm_diags` option\n\nWhen this option is set, `:YcmDiags` will automatically open the location list\nafter forcing a compilation and filling the list with diagnostic data.\n\nSee `:help location-list` in Vim to learn more about the location list.\n\nDefault: `1`\n\n```viml\nlet g:ycm_open_loclist_on_ycm_diags = 1\n```\n\n### The `g:ycm_complete_in_comments` option\n\nWhen this option is set to `1`, YCM will show the completion menu even when\ntyping inside comments.\n\nDefault: `0`\n\n```viml\nlet g:ycm_complete_in_comments = 0\n```\n\n### The `g:ycm_complete_in_strings` option\n\nWhen this option is set to `1`, YCM will show the completion menu even when\ntyping inside strings.\n\nNote that this is turned on by default so that you can use the filename\ncompletion inside strings. This is very useful for instance in C-family files\nwhere typing `#include \"` will trigger the start of filename completion. If you\nturn off this option, you will turn off filename completion in such situations\nas well.\n\nDefault: `1`\n\n```viml\nlet g:ycm_complete_in_strings = 1\n```\n\n### The `g:ycm_collect_identifiers_from_comments_and_strings` option\n\nWhen this option is set to `1`, YCM's identifier completer will also collect\nidentifiers from strings and comments. Otherwise, the text in comments and\nstrings will be ignored.\n\nDefault: `0`\n\n```viml\nlet g:ycm_collect_identifiers_from_comments_and_strings = 0\n```\n\n### The `g:ycm_collect_identifiers_from_tags_files` option\n\nWhen this option is set to `1`, YCM's identifier completer will also collect\nidentifiers from tags files. The list of tags files to examine is retrieved from\nthe `tagfiles()` Vim function which examines the `tags` Vim option. See `:h\n'tags'` for details.\n\nYCM will re-index your tags files if it detects that they have been modified.\n\nThe only supported tag format is the [Exuberant Ctags format][ctags-format]. The\nformat from \"plain\" ctags is NOT supported. Ctags needs to be called with the\n`--fields=+l` option (that's a lowercase `L`, not a one) because YCM needs the\n`language:` field in the tags output.\n\nSee the _FAQ_ for pointers if YCM does not appear to read your tag files.\n\nThis option is off by default because it makes Vim slower if your tags are on a\nnetwork directory.\n\nDefault: `0`\n\n```viml\nlet g:ycm_collect_identifiers_from_tags_files = 0\n```\n\n### The `g:ycm_seed_identifiers_with_syntax` option\n\nWhen this option is set to `1`, YCM's identifier completer will seed its\nidentifier database with the keywords of the programming language you're\nwriting.\n\nSince the keywords are extracted from the Vim syntax file for the filetype, all\nkeywords may not be collected, depending on how the syntax file was written.\nUsually at least 95% of the keywords are successfully extracted.\n\nDefault: `0`\n\n```viml\nlet g:ycm_seed_identifiers_with_syntax = 0\n```\n\n### The `g:ycm_extra_conf_vim_data` option\n\nIf you're using semantic completion for C-family files, this option might come\nhandy; it's a way of sending data from Vim to your `Settings` function in\nyour `.ycm_extra_conf.py` file.\n\nThis option is supposed to be a list of VimScript expression strings that are\nevaluated for every request to the [ycmd server][ycmd] and then passed to your\n`Settings` function as a `client_data` keyword argument.\n\nFor instance, if you set this option to `['v:version']`, your `Settings`\nfunction will be called like this:\n\n```python\n# The '801' value is of course contingent on Vim 8.1; in 8.0 it would be '800'\nSettings( ..., client_data = { 'v:version': 801 } )\n```\n\nSo the `client_data` parameter is a dictionary mapping Vim expression strings to\ntheir values at the time of the request.\n\nThe correct way to define parameters for your `Settings` function:\n\n```python\ndef Settings( **kwargs ):\n```\n\nYou can then get to `client_data` with `kwargs['client_data']`.\n\nDefault: `[]`\n\n```viml\nlet g:ycm_extra_conf_vim_data = []\n```\n\n### The `g:ycm_server_python_interpreter` option\n\nYCM will by default search for an appropriate Python interpreter on your system.\nYou can use this option to override that behavior and force the use of a\nspecific interpreter of your choosing.\n\n**NOTE:** This interpreter is only used for the [ycmd server][ycmd]. The YCM\nclient running inside Vim always uses the Python interpreter that's embedded\ninside Vim.\n\nDefault: `''`\n\n```viml\nlet g:ycm_server_python_interpreter = ''\n```\n\n### The `g:ycm_keep_logfiles` option\n\nWhen this option is set to `1`, YCM and the [ycmd completion server][ycmd] will\nkeep the logfiles around after shutting down (they are deleted on shutdown by\ndefault).\n\nTo see where the log files are, call `:YcmDebugInfo`.\n\nDefault: `0`\n\n```viml\nlet g:ycm_keep_logfiles = 0\n```\n\n### The `g:ycm_log_level` option\n\nThe logging level that YCM and the [ycmd completion server][ycmd] use. Valid\nvalues are the following, from most verbose to least verbose:\n- `debug`\n- `info`\n- `warning`\n- `error`\n- `critical`\n\nNote that `debug` is _very_ verbose.\n\nDefault: `info`\n\n```viml\nlet g:ycm_log_level = 'info'\n```\n\n### The `g:ycm_auto_start_csharp_server` option\n\nWhen set to `1`, the OmniSharp-Roslyn server will be automatically started\n(once per Vim session) when you open a C# file.\n\nDefault: `1`\n\n```viml\nlet g:ycm_auto_start_csharp_server = 1\n```\n\n### The `g:ycm_auto_stop_csharp_server` option\n\nWhen set to `1`, the OmniSharp-Roslyn server will be automatically stopped upon\nclosing Vim.\n\nDefault: `1`\n\n```viml\nlet g:ycm_auto_stop_csharp_server = 1\n```\n\n### The `g:ycm_csharp_server_port` option\n\nWhen g:ycm_auto_start_csharp_server is set to `1`, specifies the port for\nthe OmniSharp-Roslyn server to listen on. When set to `0` uses an unused port provided\nby the OS.\n\nDefault: `0`\n\n```viml\nlet g:ycm_csharp_server_port = 0\n```\n\n### The `g:ycm_csharp_insert_namespace_expr` option\n\nBy default, when YCM inserts a namespace, it will insert the `using` statement\nunder the nearest `using` statement. You may prefer that the `using` statement is\ninserted somewhere, for example, to preserve sorting. If so, you can set this\noption to override this behavior.\n\nWhen this option is set, instead of inserting the `using` statement itself, YCM\nwill set the global variable `g:ycm_namespace_to_insert` to the namespace to\ninsert, and then evaluate this option's value as an expression. The option's\nexpression is responsible for inserting the namespace - the default insertion\nwill not occur.\n\nDefault: ''\n\n```viml\nlet g:ycm_csharp_insert_namespace_expr = ''\n```\n\n### The `g:ycm_add_preview_to_completeopt` option\n\nWhen this option is set to `1`, YCM will add the `preview` string to Vim's\n`completeopt` option (see `:h completeopt`). If your `completeopt` option\nalready has `preview` set, there will be no effect. Alternatively, when set to\n`popup` and your version of Vim supports popup windows (see `:help popup`), the\n`popup` string will be used instead. You can see the current state of your\n`completeopt` setting with `:set completeopt?` (yes, the question mark is\nimportant).\n\nWhen `preview` is present in `completeopt`, YCM will use the `preview` window at\nthe top of the file to store detailed information about the current completion\ncandidate (but only if the candidate came from the semantic engine). For\ninstance, it would show the full function prototype and all the function\noverloads in the window if the current completion is a function name.\n\nWhen `popup` is present in `completeopt`, YCM will instead use a `popup`\nwindow to the side of the completion popup for storing detailed information\nabout the current completion candidate. In addition, YCM may truncate the\ndetailed completion information in order to give the popup sufficient room\nto display that detailed information.\n\nDefault: `0`\n\n```viml\nlet g:ycm_add_preview_to_completeopt = 0\n```\n\n### The `g:ycm_autoclose_preview_window_after_completion` option\n\nWhen this option is set to `1`, YCM will auto-close the `preview` window after\nthe user accepts the offered completion string. If there is no `preview` window\ntriggered because there is no `preview` string in `completeopt`, this option is\nirrelevant. See the `g:ycm_add_preview_to_completeopt` option for more details.\n\nDefault: `0`\n\n```viml\nlet g:ycm_autoclose_preview_window_after_completion = 0\n```\n\n### The `g:ycm_autoclose_preview_window_after_insertion` option\n\nWhen this option is set to `1`, YCM will auto-close the `preview` window after\nthe user leaves insert mode. This option is irrelevant if\n`g:ycm_autoclose_preview_window_after_completion` is set or if no `preview`\nwindow is triggered. See the `g:ycm_add_preview_to_completeopt` option for more\ndetails.\n\nDefault: `0`\n\n```viml\nlet g:ycm_autoclose_preview_window_after_insertion = 0\n```\n\n### The `g:ycm_max_diagnostics_to_display` option\n\nThis option controls the maximum number of diagnostics shown to the user when\nerrors or warnings are detected in the file. This option is only relevant for\nthe C-family, C#, Java, JavaScript, and TypeScript languages.\n\nA special value of `0` means there is no limit.\n\nDefault: `30`\n\n```viml\nlet g:ycm_max_diagnostics_to_display = 30\n```\n\n### The `g:ycm_key_list_select_completion` option\n\nThis option controls the key mappings used to select the first completion\nstring. Invoking any of them repeatedly cycles forward through the completion\nlist.\n\nSome users like adding `` to this list.\n\nDefault: `['', '']`\n\n```viml\nlet g:ycm_key_list_select_completion = ['', '']\n```\n\n### The `g:ycm_key_list_previous_completion` option\n\nThis option controls the key mappings used to select the previous completion\nstring. Invoking any of them repeatedly cycles backward through the completion\nlist.\n\nNote that one of the defaults is `` which means Shift-TAB. That mapping\nwill probably only work in GUI Vim (Gvim or MacVim) and not in plain console Vim\nbecause the terminal usually does not forward modifier key combinations to Vim.\n\nDefault: `['', '']`\n\n```viml\nlet g:ycm_key_list_previous_completion = ['', '']\n```\n\n### The `g:ycm_key_list_stop_completion` option\n\nThis option controls the key mappings used to close the completion menu. This is\nuseful when the menu is blocking the view, when you need to insert the ``\ncharacter, or when you want to expand a snippet from [UltiSnips][] and navigate\nthrough it.\n\nDefault: `['']`\n\n```viml\nlet g:ycm_key_list_stop_completion = ['']\n```\n\n### The `g:ycm_key_invoke_completion` option\n\nThis option controls the key mapping used to invoke the completion menu for\nsemantic completion. By default, semantic completion is triggered automatically\nafter typing characters appropriate for the language, such as `.`, `->`, `::`,\netc. in insert mode (if semantic completion support has been compiled in). This\nkey mapping can be used to trigger semantic completion anywhere. Useful for\nsearching for top-level functions and classes.\n\nConsole Vim (not Gvim or MacVim) passes `` to Vim when the user types\n`` so YCM will make sure that `` is used in the map command when\nyou're editing in console Vim, and `` in GUI Vim. This means that you\ncan just press `` in both the console and GUI Vim and YCM will do the right\nthing.\n\nSetting this option to an empty string will make sure no mapping is created.\n\nDefault: ``\n\n```viml\nlet g:ycm_key_invoke_completion = ''\n```\n\n### The `g:ycm_key_detailed_diagnostics` option\n\nThis option controls the key mapping used to show the full diagnostic text when\nthe user's cursor is on the line with the diagnostic. It basically calls\n`:YcmShowDetailedDiagnostic`.\n\nSetting this option to an empty string will make sure no mapping is created.\n\nIf you prefer the detailed diagnostic to be shown in a popup, then\n`let g:ycm_show_detailed_diag_in_popup=1`.\n\nDefault: `d`\n\n```viml\nlet g:ycm_key_detailed_diagnostics = 'd'\n```\n\n### The `g:ycm_show_detailed_diag_in_popup` option\n\nMakes `:YcmShowDetailedDiagnostic` always show in a popup rather than echoing to\nthe command line.\n\nDefault: 0\n\n```viml\nlet g:ycm_show_detailed_diag_in_popup = 0\n```\n\n### The `g:ycm_global_ycm_extra_conf` option\n\nNormally, YCM searches for a `.ycm_extra_conf.py` file for compilation flags\n(see the User Guide for more details on how this works). This option specifies\na fallback path to a config file which is used if no `.ycm_extra_conf.py` is\nfound.\n\nYou can place such a global file anywhere in your filesystem.\n\nDefault: `''`\n\n```viml\nlet g:ycm_global_ycm_extra_conf = ''\n```\n\n### The `g:ycm_confirm_extra_conf` option\n\nWhen this option is set to `1` YCM will ask once per `.ycm_extra_conf.py` file\nif it is safe to be loaded. This is to prevent the execution of malicious code\nfrom a `.ycm_extra_conf.py` file you didn't write.\n\nTo selectively get YCM to ask/not ask about loading certain `.ycm_extra_conf.py`\nfiles, see the `g:ycm_extra_conf_globlist` option.\n\nDefault: `1`\n\n```viml\nlet g:ycm_confirm_extra_conf = 1\n```\n\n### The `g:ycm_extra_conf_globlist` option\n\nThis option is a list that may contain several globbing patterns. If a pattern\nstarts with a `!` all `.ycm_extra_conf.py` files matching that pattern will be\nblacklisted, that is they won't be loaded and no confirmation dialog will be\nshown. If a pattern does not start with a `!` all files matching that pattern\nwill be whitelisted. Note that this option is not used when confirmation is\ndisabled using `g:ycm_confirm_extra_conf` and that items earlier in the list\nwill take precedence over the later ones.\n\nRules:\n\n* `*` matches everything\n* `?` matches any single character\n* `[seq]` matches any character in seq\n* `[!seq]` matches any char not in seq\n\nExample:\n\n```viml\nlet g:ycm_extra_conf_globlist = ['~/dev/*','!~/*']\n```\n\n* The first rule will match everything contained in the `~/dev` directory so\n `.ycm_extra_conf.py` files from there will be loaded.\n* The second rule will match everything in the home directory so a\n `.ycm_extra_conf.py` file from there won't be loaded.\n* As the first rule takes precedence everything in the home directory excluding\n the `~/dev` directory will be blacklisted.\n\n**NOTE:** The glob pattern is first expanded with Python's\n`os.path.expanduser()` and then resolved with `os.path.abspath()` before being\nmatched against the filename.\n\nDefault: `[]`\n\n```viml\nlet g:ycm_extra_conf_globlist = []\n```\n\n### The `g:ycm_filepath_completion_use_working_dir` option\n\nBy default, YCM's filepath completion will interpret relative paths like `../`\nas being relative to the folder of the file of the currently active buffer.\nSetting this option will force YCM to always interpret relative paths as being\nrelative to Vim's current working directory.\n\nDefault: `0`\n\n```viml\nlet g:ycm_filepath_completion_use_working_dir = 0\n```\n\n### The `g:ycm_semantic_triggers` option\n\nThis option controls the character-based triggers for the various semantic\ncompletion engines. The option holds a dictionary of key-values, where the keys\nare Vim's filetype strings delimited by commas and values are lists of strings,\nwhere the strings are the triggers.\n\nSetting key-value pairs on the dictionary _adds_ semantic triggers to the\ninternal default set (listed below). You cannot remove the default triggers,\nonly add new ones.\n\nA \"trigger\" is a sequence of one or more characters that trigger semantic\ncompletion when typed. For instance, C++ (`cpp` filetype) has `.` listed as a\ntrigger. So when the user types `foo.`, the semantic engine will trigger and\nserve `foo`'s list of member functions and variables. Since C++ also has `->`\nlisted as a trigger, the same thing would happen when the user typed `foo->`.\n\nIt's also possible to use a regular expression as a trigger. You have to prefix\nyour trigger with `re!` to signify it's a regex trigger. For instance,\n`re!\\w+\\.` would only trigger after the `\\w+\\.` regex matches.\n\n**NOTE:** The regex syntax is **NOT** Vim's, it's [Python's][python-re].\n\nDefault: `[see next line]`\n\n```viml\nlet g:ycm_semantic_triggers = {\n \\ 'c': ['->', '.'],\n \\ 'objc': ['->', '.', 're!\\[[_a-zA-Z]+\\w*\\s', 're!^\\s*[^\\W\\d]\\w*\\s',\n \\ 're!\\[.*\\]\\s'],\n \\ 'ocaml': ['.', '#'],\n \\ 'cpp,cuda,objcpp': ['->', '.', '::'],\n \\ 'perl': ['->'],\n \\ 'php': ['->', '::'],\n \\ 'cs,d,elixir,go,groovy,java,javascript,julia,perl6,python,scala,typescript,vb': ['.'],\n \\ 'ruby,rust': ['.', '::'],\n \\ 'lua': ['.', ':'],\n \\ 'erlang': [':'],\n \\ }\n```\n\n### The `g:ycm_cache_omnifunc` option\n\nSome omnicompletion engines do not work well with the YCM cache—in particular,\nthey might not produce all possible results for a given prefix. By unsetting\nthis option you can ensure that the omnicompletion engine is re-queried on every\nkeypress. That will ensure all completions will be presented but might cause\nstuttering and lag if the omnifunc is slow.\n\nDefault: `1`\n\n```viml\nlet g:ycm_cache_omnifunc = 1\n```\n\n### The `g:ycm_use_ultisnips_completer` option\n\nBy default, YCM will query the UltiSnips plugin for possible completions of\nsnippet triggers. This option can turn that behavior off.\n\nDefault: `1`\n\n```viml\nlet g:ycm_use_ultisnips_completer = 1\n```\n\n### The `g:ycm_goto_buffer_command` option\n\nDefines where `GoTo*` commands result should be opened. Can take one of the\nfollowing values: `'same-buffer'`, `'split'`, or `'split-or-existing-window'`.\nIf this option is set to the `'same-buffer'` but current buffer can not be\nswitched (when buffer is modified and `nohidden` option is set), then result\nwill be opened in a split. When the option is set to\n`'split-or-existing-window'`, if the result is already open in a window of the\ncurrent tab page (or any tab pages with the `:tab` modifier; see below), it will\njump to that window. Otherwise, the result will be opened in a split as if the\noption was set to `'split'`.\n\nTo customize the way a new window is split, prefix the `GoTo*` command with one\nof the following modifiers: `:aboveleft`, `:belowright`, `:botright`,\n`:leftabove`, `:rightbelow`, `:topleft`, and `:vertical`. For instance, to\nsplit vertically to the right of the current window, run the command:\n\n```viml\n:rightbelow vertical YcmCompleter GoTo\n```\n\nTo open in a new tab page, use the `:tab` modifier with the `'split'` or\n`'split-or-existing-window'` options e.g.:\n\n```viml\n:tab YcmCompleter GoTo\n```\n\nDefault: `'same-buffer'`\n\n```viml\nlet g:ycm_goto_buffer_command = 'same-buffer'\n```\n\n### The `g:ycm_disable_for_files_larger_than_kb` option\n\nDefines the max size (in Kb) for a file to be considered for completion. If this\noption is set to 0 then no check is made on the size of the file you're opening.\n\nDefault: 1000\n\n```viml\nlet g:ycm_disable_for_files_larger_than_kb = 1000\n```\n\n### The `g:ycm_use_clangd` option\n\nThis option controls whether **clangd** should be used as a completion engine for\nC-family languages. Can take one of the following values: `1`, `0`, with\nmeanings:\n\n- `1`: YCM will use clangd if clangd binary exists in third party or it was\nprovided with `ycm_clangd_binary_path` option.\n- `0`: YCM will never use clangd completer.\n\nDefault: `1`\n\n```viml\nlet g:ycm_use_clangd = 1\n```\n\n### The `g:ycm_clangd_binary_path` option\n\nWhen `ycm_use_clangd` option is set to `1`, this option sets the path to\n**clangd** binary.\n\nDefault: `''`\n\n```viml\nlet g:ycm_clangd_binary_path = ''\n```\n\n### The `g:ycm_clangd_args` option\n\nThis option controls the command line arguments passed to the clangd binary. It\nappends new options and overrides the existing ones.\n\nDefault: `[]`\n\n```viml\nlet g:ycm_clangd_args = []\n```\n\n### The `g:ycm_clangd_uses_ycmd_caching` option\n\nThis option controls which ranking and filtering algorithm to use for completion\nitems. It can take values:\n\n- `1`: Uses ycmd's caching and filtering logic.\n- `0`: Uses clangd's caching and filtering logic.\n\nDefault: `1`\n\n```viml\nlet g:ycm_clangd_uses_ycmd_caching = 1\n```\n\n### The `g:ycm_language_server` option\n\nThis option lets YCM use an arbitrary Language Server Protocol (LSP) server, not\nunlike many other completion systems. The officially supported completers are\nfavoured over custom LSP ones, so overriding an existing completer means first\nmaking sure YCM won't choose that existing completer in the first place.\n\nA simple working example of this option can be found in the section called\n[\"Semantic Completion for Other Languages\"](#semantic-completion-for-other-languages).\n\nMany working examples can be found in the YCM [lsp-examples][] repository.\n\nDefault: `[]`\n\n```viml\nlet g:ycm_language_server = []\n```\n\n### The `g:ycm_disable_signature_help` option\n\nThis option allows you to disable all signature help for all completion engines.\nThere is no way to disable it per-completer.\n\nDefault: `0`\n\n```viml\n\" Disable signature help\nlet g:ycm_disable_signature_help = 1\n```\n\n### The `g:ycm_signature_help_disable_syntax` option\n\nSet this to 1 to disable syntax highlighting in the signature help popup. Thiis\ncan help if your colourscheme doesn't work well with the default highliting and\ninverse video.\n\nDefault: `0`\n\n```viml\n\" Disable signature help syntax highliting\nlet g:ycm_signature_help_disable_syntax = 1\n```\n\n### The `g:ycm_gopls_binary_path` option\n\nIn case the system-wide `gopls` binary is newer than the bundled one, setting\nthis option to the path of the system-wide `gopls` would make YCM use that one\ninstead.\n\nIf the path is just `gopls`, YCM will search in `$PATH`.\n\n\n### The `g:ycm_gopls_args` option\n\nSimilar to [the `g:ycm_clangd_args`](#the-gycm-clangd-args), this option allows\npassing additional flags to the `gopls` command line.\n\nDefault: `[]`\n\n```viml\nlet g:ycm_gopls_args = []\n```\n\n\n### The `g:ycm_rls_binary_path` and `g:ycm_rustc_binary_path` options\n\nYCM no longer uses RLS for rust, and these options are therefore no longer\nsupported.\n\nTo use a custom rust-analyzer, see `g:ycm_rust_toolchain_root`.\n\n### The `g:ycm_rust_toolchain_root` option\n\nOptionally specify the path to a custom rust toolchain including at least a\nsupported version of `rust-analyzer`.\n\n\n### The `g:ycm_tsserver_binary_path` option\n\nSimilar to [the `gopls` path](#the-gycm-gopls-binaty-path), this option\ntells YCM where is the TSServer executable located.\n\n### The `g:ycm_roslyn_binary_path` option\n\nSimilar to [the `gopls` path](#the-gycm-gopls-binaty-path), this option\ntells YCM where is the Omnisharp-Roslyn executable located.\n\n### The `g:ycm_update_diagnostics_in_insert_mode` option\n\nWith async diagnostics, LSP servers might send new diagnostics mid-typing.\nIf seeing these new diagnostics while typing is not desired, this option can\nbe set to 0.\n\nWhen this option is set to `0`, diagnostic signs, virtual text, and highlights\nare cleared when entering insert mode and replaced when leaving insert mode.\nThis reduces visual noise while editing.\n\nIn addition, this option is recommended when `g:ycm_echo_current_diagnostic` is\nset to `virtual-text` as it prevents updating the virtual text while you are\ntyping.\n\nDefault: `1`\n\n```viml\nlet g:ycm_update_diagnostics_in_insert_mode = 1\n```\n\nFAQ\n---\n\nThe FAQ section has been moved to the [wiki][wiki-faq].\n\nContributor Code of Conduct\n---------------------------\n\nPlease note that this project is released with a [Contributor Code of\nConduct][ccoc]. By participating in this project you agree to abide by its\nterms.\n\n\nContact\n-------\n\nIf you have questions about the plugin or need help, please join the [Gitter\nroom][gitter] or use the [ycm-users][] mailing list.\n\nIf you have bug reports or feature suggestions, please use the [issue\ntracker][tracker]. Before you do, please carefully read\n[CONTRIBUTING.md][contributing-md] as this asks for important diagnostics which\nthe team will use to help get you going.\n\nThe latest version of the plugin is available at\n.\n\nThe author's homepage is .\n\nPlease do **NOT** go to #vim, Reddit, or Stack Overflow for support. Please\ncontact the YouCompleteMe maintainers directly using the [contact\ndetails](#contact).\n\nLicense\n-------\n\nThis software is licensed under the [GPL v3 license][gpl].\n© 2015-2018 YouCompleteMe contributors\n\nSponsorship\n-----------\n\nIf you like YCM so much that you're willing to part with your hard-earned cash, please consider donating to one of the following charities, which are meaningful to the current maintainers (in no particular order):\n\n* [Hector's Greyhound Rescue](https://www.hectorsgreyhoundrescue.org)\n* [Be Humane](https://www.budihuman.rs/en)\n* [Cancer Research UK](https://www.cancerresearchuk.org)\n* [ICCF Holland](https://iccf.nl)\n* Any charity of your choosing.\n\nPlease note: The YCM maintainers do not specifically endorse nor necessarily have any relationship with the above charities. Disclosure: It is noted that one key maintainer is a family with Trustees of Greyhound Rescue Wales.\n\n\n[ycmd]: https://github.com/ycm-core/ycmd\n[Clang]: https://clang.llvm.org/\n[vundle]: https://github.com/VundleVim/Vundle.vim#about\n[brew]: https://brew.sh\n[cmake-download]: https://cmake.org/download/\n[macvim]: https://macvim-dev.github.io/macvim/\n[vimrc]: https://vimhelp.appspot.com/starting.txt.html#vimrc\n[gpl]: https://www.gnu.org/copyleft/gpl.html\n[vim]: https://www.vim.org/\n[syntastic]: https://github.com/scrooloose/syntastic\n[lightline]: https://github.com/itchyny/lightline.vim\n[ycm_flags_example]: https://github.com/ycm-core/YouCompleteMe/blob/master/.ycm_extra_conf.py\n[ycmd_flags_example]: https://raw.githubusercontent.com/ycm-core/ycmd/66030cd94299114ae316796f3cad181cac8a007c/.ycm_extra_conf.py\n[compdb]: https://clang.llvm.org/docs/JSONCompilationDatabase.html\n[subsequence]: https://en.wikipedia.org/wiki/Subsequence\n[listtoggle]: https://github.com/Valloric/ListToggle\n[vim-build]: https://github.com/ycm-core/YouCompleteMe/wiki/Building-Vim-from-source\n[tracker]: https://github.com/ycm-core/YouCompleteMe/issues?state=open\n[completer-api]: https://github.com/ycm-core/ycmd/blob/master/ycmd/completers/completer.py\n[eclim]: http://eclim.org/\n[jedi]: https://github.com/davidhalter/jedi\n[ultisnips]: https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt\n[ctags-format]: http://ctags.sourceforge.net/FORMAT\n[ycm-users]: https://groups.google.com/forum/?hl=en#!forum/ycm-users\n[omnisharp-roslyn]: https://github.com/OmniSharp/omnisharp-roslyn\n[python-re]: https://docs.python.org/2/library/re.html#regular-expression-syntax\n[Bear]: https://github.com/rizsotto/Bear\n[ygen]: https://github.com/rdnetto/YCM-Generator\n[Gopls]: https://github.com/golang/go/wiki/gopls\n[gopls-preferences]: https://github.com/golang/tools/blob/master/internal/lsp/server.go\n[TSServer]: https://github.com/Microsoft/TypeScript/tree/master/src/server\n[jsconfig.json]: https://code.visualstudio.com/docs/languages/jsconfig\n[tsconfig.json]: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html\n[vim-win-download]: https://github.com/vim/vim-win32-installer/releases\n[python-win-download]: https://www.python.org/downloads/windows/\n[visual-studio-download]: https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16\n[mono-install-macos]: https://www.mono-project.com/download/stable/\n[mono-install-linux]: https://www.mono-project.com/download/stable/#download-lin\n[go-install]: https://golang.org/doc/install\n[npm-install]: https://docs.npmjs.com/getting-started/installing-node#1-install-nodejs--npm\n[tern-instructions]: https://github.com/ycm-core/YouCompleteMe/wiki/JavaScript-Semantic-Completion-through-Tern\n[libclang-instructions]: https://github.com/ycm-core/YouCompleteMe/wiki/C-family-Semantic-Completion-through-libclang\n[Tern]: https://ternjs.net\n[rls]: https://github.com/rust-lang/rls\n[rust-analyzer]: https://rust-analyzer.github.io\n[rust-src]: https://www.rust-lang.org/downloads.html\n[add-msbuild-to-path]: https://stackoverflow.com/questions/6319274/how-do-i-run-msbuild-from-the-command-line-using-windows-sdk-7-1\n[ccoc]: https://github.com/ycm-core/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md\n[gitter]: https://gitter.im/Valloric/YouCompleteMe\n[ninja-compdb]: https://ninja-build.org/manual.html\n[++enc]: http://vimdoc.sourceforge.net/htmldoc/editing.html#++enc\n[contributing-md]: https://github.com/ycm-core/YouCompleteMe/blob/master/CONTRIBUTING.md\n[jdt.ls]: https://github.com/eclipse/eclipse.jdt.ls\n[jdk-install]: https://adoptium.net/en-GB/temurin/releases\n[mvn-project]: https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html\n[eclipse-project]: https://help.eclipse.org/oxygen/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fproject_description_file.html\n[gradle-project]: https://docs.gradle.org/current/userguide/tutorial_java_projects.html\n[eclipse-dot-project]: https://help.eclipse.org/oxygen/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fproject_description_file.html\n[eclipse-dot-classpath]: https://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.jdt.doc.isv%2Freference%2Fapi%2Forg%2Feclipse%2Fjdt%2Fcore%2FIClasspathEntry.html\n[ycmd-eclipse-project]: https://github.com/ycm-core/ycmd/tree/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_eclipse_project\n[ycmd-mvn-pom-xml]: https://github.com/ycm-core/ycmd/blob/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_maven_project/pom.xml\n[ycmd-gradle-project]: https://github.com/ycm-core/ycmd/tree/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_gradle_project\n[jdtls-preferences]: https://github.com/eclipse/eclipse.jdt.ls/blob/master/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/preferences/Preferences.java\n[diacritic]: https://www.unicode.org/glossary/#diacritic\n[clangd]: https://clang.llvm.org/extra/clangd.html\n[vimspector]: https://github.com/puremourning/vimspector\n[compiledb]: https://pypi.org/project/compiledb/\n[signature-help-pr]: https://github.com/ycm-core/ycmd/pull/1255\n[wiki-faq]: https://github.com/ycm-core/YouCompleteMe/wiki/FAQ\n[wiki-full-install]: https://github.com/ycm-core/YouCompleteMe/wiki/Full-Installation-Guide\n[wiki-troubleshooting]: https://github.com/ycm-core/YouCompleteMe/wiki/Troubleshooting-steps-for-ycmd-server-SHUT-DOWN\n[lsp-examples]: https://github.com/ycm-core/lsp-examples\n[language_server-configuration]: https://github.com/ycm-core/ycmd#language_server-configuration\n[diagnostic-echo-virtual-text1]: https://user-images.githubusercontent.com/10584846/185707973-39703699-0263-47d3-82ac-639d52259bea.png\n[diagnostic-echo-virtual-text2]: https://user-images.githubusercontent.com/10584846/185707993-14ff5fd7-c082-4e5a-b825-f1364e619b6a.png\n[jedi-refactor-doc]: https://jedi.readthedocs.io/en/latest/docs/api.html#jedi.Script.extract_variable\n" }, { "path": "autoload/youcompleteme/filetypes.vim", "content": "\" Copyright (C) 2011-2018 YouCompleteMe contributors\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free software: you can redistribute it and/or modify\n\" it under the terms of the GNU General Public License as published by\n\" the Free Software Foundation, either version 3 of the License, or\n\" (at your option) any later version.\n\"\n\" YouCompleteMe is distributed in the hope that it will be useful,\n\" but WITHOUT ANY WARRANTY; without even the implied warranty of\n\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\" GNU General Public License for more details.\n\"\n\" You should have received a copy of the GNU General Public License\n\" along with YouCompleteMe. If not, see .\n\n\nfunction! s:HasAnyKey( dict, keys ) abort\n for key in a:keys\n if has_key( a:dict, key )\n return 1\n endif\n endfor\n return 0\nendfunction\n\nfunction! youcompleteme#filetypes#AllowedForFiletype( filetype ) abort\n let whitelist_allows = type( g:ycm_filetype_whitelist ) != v:t_dict ||\n \\ has_key( g:ycm_filetype_whitelist, '*' ) ||\n \\ s:HasAnyKey( g:ycm_filetype_whitelist, split( a:filetype, '\\.' ) )\n let blacklist_allows = type( g:ycm_filetype_blacklist ) != v:t_dict ||\n \\ !s:HasAnyKey( g:ycm_filetype_blacklist, split( a:filetype, '\\.' ) )\n\n return whitelist_allows && blacklist_allows\nendfunction\n" }, { "path": "autoload/youcompleteme/finder.vim", "content": "\" Copyright (C) 2021 YouCompleteMe contributors\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free software: you can redistribute it and/or modify\n\" it under the terms of the GNU General Public License as published by\n\" the Free Software Foundation, either version 3 of the License, or\n\" (at your option) any later version.\n\"\n\" YouCompleteMe is distributed in the hope that it will be useful,\n\" but WITHOUT ANY WARRANTY; without even the implied warranty of\n\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\" GNU General Public License for more details.\n\"\n\" You should have received a copy of the GNU General Public License\n\" along with YouCompleteMe. If not, see .\n\n\" This is basic vim plugin boilerplate\nlet s:save_cpo = &cpoptions\nset cpoptions&vim\n\nscriptencoding utf-8\n\n\"\n\" Explanation for how this module works:\n\"\n\" The entry point is youcompleteme#finder#FindSymbol, which takes a scope\n\" argument:\n\"\n\" * 'document' scope - search document symbols - GoToDocumentOutline\n\" * 'workspace' scope - search workspace symbols - GoToSymbol\n\"\n\" In general, the approach is:\n\" - create a prompt buffer, and display it to use for input of a query\n\" - open up a popup to display the results in the middle of the screen\n\" - as the query changes, re-query the server to get the newly filtered results\n\" - as the server returns results, update the contents of the results-popup\n\" - use a popup-filter to implement some interractivity with the results, such\n\" as down/up, and select item\n\" - when an item is selected, open its buffer in the window that was current\n\" when the search started and jump to the selected item.\n\" - then populate the quickfix list with any matching results and close the\n\" popup and prompt buffer.\n\"\n\" However, there is an important wrinke/distinction that leads to the code being\n\" a little more complicated than that: the 'search' mechanism for workspace and\n\" document symbols is different.\n\"\n\" The reaosn for this differece is what the servers provide in response to the 2\n\" requests:\n\"\n\" * 'document' scope - we use ycmd's filtering and sorting.\n\" GoToDocumentOutline (LSP documentSymbol) request does not take any filter\n\" argument. It returns all symbols in the current document. Therefore, we use\n\" ycmd's filter_and_sort_candidates endpoint to use our own fuzzy search on\n\" the results. This is a _great_ experience, it's _super_ fast and familar to\n\" YCM users.\n\" * 'workspace' scope - we have to rely on the downstream server's filtering and\n\" sorting.\n\" GoToSymbol (LSP workspaceSymbol) request takes a query parameter to search\n\" with. While the LSP spec states that an empty query means 'return\n\" everything', no servers actually implement that, so we have to pass our\n\" query down to the server.\n\"\n\" The result of this is that while a lot of the code is shared, there are\n\" slightly different steps involved in the process:\n\"\n\" * for 'document' requests, as soon as the popup is opened, we issue a\n\" GoToDocumentOutline request, storing the results as `raw_results`, then\n\" then immediately start filtering it with filter_and_sort_candidates, storing\n\" the filtered results in `results`\n\" * for 'workspace' requests, as soon as the popup is opened, we issue a\n\" GoToSymbol request with an empty query. This usually returns nothing, but if\n\" any servers return anything then it would be stored in 'results'. As the\n\" user types, we repeat the GoToSymbol request and update the 'results'\n\"\n\" In order to simplify the re-query code, we put the function used to filter\n\" results in the state variable as 'query_func'.\n\"\n\" As the expereince of completely different filtering and sorting for workspace\n\" vs document is so jarring, by default we actually pass all restuls from\n\" 'workspace' search through filter_and_sort_candidates too. This isn't perfect\n\" because it breaks the mental model when the server's filtering is dumb, but it\n\" at least means that sorting is consistent. This can be disabled by setting\n\" g:ycm_refilter_workspace_symbols to 0.\n\"\n\" The key functions are:\n\"\n\" - FindSymbol - initiate the request - open the popup/prompt buffer, set up\n\" the state object to defaults and initiate the first request\n\" (RequestDocumentSymbols for 'documnt' and SearchWorkspace for 'workspace' )\n\"\n\" - RequestDocumentSymbols - perform the GoToDocumentOutline request and store\n\" the results in 'raw_results'\n\"\n\" - SearchDocument - perform filter_and_sort_candidates request on the\n\" 'raw_results', and store the results in 'results', then call\n\" \"HandleSymbolSearchResults\"\n\"\n\" - SearchWorkspace - perform GoToSymbol request for all open filetypes,\n\" and store the results in 'raw_results' as a dict mapping\n\" filetype->results. Merge the results in to 'results', then call\n\" \"HandleSymbolSearchResults\"\n\"\n\" - HandleSymbolSearchResults - redraw the popup with the 'results'\n\"\n\" - HandleKeyPress - handle a keypress while the popup is visible, intercepts\n\" things to handle interractivity\n\"\n\" - PopupClosed - callback when the popup is closed. This openes the result in\n\" the original window.\n\"\n\" The other functions are utility for the most part and handle things like\n\" TextChangedI event, starting/stopping drawing the spinner and such.\n\nlet s:icon_spinner = [ '/', '-', '\\', '|', '/', '-', '\\', '|' ]\nlet s:icon_done = 'X'\nlet s:spinner_delay = 100\nlet s:prompt = 'Find Symbol: '\nlet s:find_symbol_status = {}\n\n\" Entry point {{{\n\nfunction! youcompleteme#finder#FindSymbol( scope ) abort\n if !py3eval( 'vimsupport.VimSupportsPopupWindows()' )\n echo 'Sorry, this feature is not supported in your editor'\n return\n endif\n\n call youcompleteme#symbol#InitSymbolProperties()\n\n let s:find_symbol_status = {\n \\ 'selected': -1,\n \\ 'query': '',\n \\ 'results': [],\n \\ 'raw_results': v:none,\n \\ 'all_filetypes': v:true,\n \\ 'pending': [],\n \\ 'winid': win_getid(),\n \\ 'bufnr': bufnr(),\n \\ 'prompt_bufnr': -1,\n \\ 'prompt_winid': -1,\n \\ 'filter': v:none,\n \\ 'id': v:none,\n \\ 'cursorline_match': v:none,\n \\ 'spinner': 0,\n \\ 'spinner_timer': -1,\n \\ }\n\n let opts = {\n \\ 'padding': [ 1, 2, 1, 2 ],\n \\ 'wrap': 0,\n \\ 'minwidth': &columns / 3 * 2,\n \\ 'minheight': &lines / 3 * 2,\n \\ 'maxwidth': &columns / 3 * 2,\n \\ 'maxheight': &lines / 3 * 2,\n \\ 'line': &lines / 6,\n \\ 'col': &columns / 6,\n \\ 'pos': 'topleft',\n \\ 'drag': 1,\n \\ 'resize': 1,\n \\ 'close': 'button',\n \\ 'border': [],\n \\ 'callback': function( 's:PopupClosed' ),\n \\ 'filter': function( 's:HandleKeyPress' ),\n \\ 'highlight': 'Normal',\n \\ }\n\n if &ambiwidth ==# 'single' && &encoding ==? 'utf-8'\n let opts[ 'borderchars' ] = [ '─', '│', '─', '│', '╭', '╮', '┛', '╰' ]\n endif\n\n if a:scope ==# 'document'\n let s:find_symbol_status.query_func = function( 's:SearchDocument' )\n else\n let s:find_symbol_status.query_func = function( 's:SearchWorkspace' )\n endif\n\n let s:find_symbol_status.id = popup_create( 'Type to query for stuff', opts )\n\n \" Kick off the request now\n if a:scope ==# 'document'\n call s:RequestDocumentSymbols()\n else\n call s:SearchWorkspace( '', v:true )\n endif\n\n let bufnr = bufadd( '_ycm_filter_' )\n silent call bufload( bufnr )\n silent topleft 1split _ycm_filter_\n \" Disable ycm/completion in this buffer\n call setbufvar( bufnr, 'ycm_largefile', 1 )\n\n let s:find_symbol_status.prompt_bufnr = bufnr\n let s:find_symbol_status.prompt_winid = win_getid()\n\n setlocal buftype=prompt noswapfile modifiable nomodified noreadonly\n setlocal nobuflisted bufhidden=delete textwidth=0\n call prompt_setprompt( bufnr(), s:prompt )\n augroup YCMPromptFindSymbol\n autocmd!\n autocmd TextChanged,TextChangedI call s:OnQueryTextChanged()\n autocmd WinLeave call s:Cancel()\n autocmd CmdLineEnter call s:Cancel()\n augroup END\n startinsert\nendfunction\n\nfunction! s:OnQueryTextChanged() abort\n if s:find_symbol_status.id < 0\n return\n endif\n\n let bufnr = s:find_symbol_status.prompt_bufnr\n let query = getbufline( bufnr, '$' )[ 0 ]\n let s:find_symbol_status.query = query[ len( s:prompt ) : ]\n\n \" really, re-query if we can\n call s:RequeryFinderPopup( v:true )\n\n call win_execute( s:find_symbol_status.prompt_winid, 'setlocal nomodified' )\nendfunction\n\n\nfunction! s:Cancel() abort\n if s:find_symbol_status.id < 0\n return\n endif\n\n call popup_close( s:find_symbol_status.id, -1 )\nendfunction\n\" }}}\n\n\" Popup and keyboard events {{{\n\nfunction! s:HandleKeyPress( id, key ) abort\n let redraw = 0\n let handled = 0\n let requery = 0\n\n \" The input for the search/query is taken from the prompt buffer and the\n \" TextChangedI event\n if a:key ==# \"\\\" ||\n \\ a:key ==# \"\\\" ||\n \\ a:key ==# \"\\\" ||\n \\ a:key ==# \"\\\"\n let s:find_symbol_status.selected += 1\n \" wrap\n if s:find_symbol_status.selected >= len( s:find_symbol_status.results )\n let s:find_symbol_status.selected = 0\n endif\n let redraw = 1\n let handled = 1\n elseif a:key ==# \"\\\" ||\n \\ a:key ==# \"\\\" ||\n \\ a:key ==# \"\\\" ||\n \\ a:key ==# \"\\\"\n let s:find_symbol_status.selected -= 1\n \" wrap\n if s:find_symbol_status.selected < 0\n let s:find_symbol_status.selected =\n \\ len( s:find_symbol_status.results ) - 1\n endif\n let redraw = 1\n let handled = 1\n elseif a:key ==# \"\\\" || a:key ==# \"\\\"\n let s:find_symbol_status.selected +=\n \\ popup_getpos( s:find_symbol_status.id ).core_height\n \" Don't wrap\n if s:find_symbol_status.selected >= len( s:find_symbol_status.results )\n let s:find_symbol_status.selected =\n \\ len( s:find_symbol_status.results ) - 1\n endif\n let redraw = 1\n let handled = 1\n elseif a:key ==# \"\\\" || a:key ==# \"\\\"\n let s:find_symbol_status.selected -=\n \\ popup_getpos( s:find_symbol_status.id ).core_height\n \" Don't wrap\n if s:find_symbol_status.selected < 0\n let s:find_symbol_status.selected = 0\n endif\n let redraw = 1\n let handled = 1\n elseif a:key ==# \"\\\"\n call popup_close( a:id, -1 )\n let handled = 1\n elseif a:key ==# \"\\\"\n if s:find_symbol_status.selected >= 0\n call popup_close( a:id, s:find_symbol_status.selected )\n let handled = 1\n endif\n elseif a:key ==# \"\\\" || a:key ==# \"\\\"\n let s:find_symbol_status.selected = 0\n let redraw = 1\n let handled = 1\n elseif a:key ==# \"\\\" || a:key ==# \"\\\"\n let s:find_symbol_status.selected = len( s:find_symbol_status.results ) - 1\n let redraw = 1\n let handled = 1\n elseif a:key ==# \"\\\"\n \" TOggle filetypes?\n let s:find_symbol_status.all_filetypes = !s:find_symbol_status.all_filetypes\n let redraw = 0\n let requery = 1\n let handled = 1\n endif\n\n if requery\n call s:RequeryFinderPopup( v:true )\n elseif redraw\n call s:RedrawFinderPopup()\n endif\n\n return handled\nendfunction\n\n\n\" Handle the popup closing: jump to the selected item\nfunction! s:PopupClosed( id, selected ) abort\n stopinsert\n call win_gotoid( s:find_symbol_status.prompt_winid )\n silent bwipe!\n\n \" Return to original window\n call win_gotoid( s:find_symbol_status.winid )\n\n if a:selected >= 0\n let selected = s:find_symbol_status.results[ a:selected ]\n\n py3 vimsupport.JumpToLocation(\n \\ filename = vimsupport.ToUnicode( vim.eval( 'selected.filepath' ) ),\n \\ line = int( vim.eval( 'selected.line_num' ) ),\n \\ column = int( vim.eval( 'selected.column_num' ) ),\n \\ modifiers = '',\n \\ command = 'same-buffer'\n \\ )\n\n if len( s:find_symbol_status.results ) > 1\n \" Also, populate the quickfix list\n py3 vimsupport.SetQuickFixList(\n \\ [ vimsupport.BuildQfListItem( x ) for x in\n \\ vim.eval( 's:find_symbol_status.results' ) ] )\n\n\n \" Emulate :echo, to avoid a redraw getting rid of the message.\n let txt = 'Added ' . len( getqflist() ) . ' entries to quickfix list.'\n call popup_notification(\n \\ txt,\n \\ {\n \\ 'line': 1,\n \\ 'col': &columns - len( txt ),\n \\ 'padding': [ 0, 0, 0, 0 ],\n \\ 'border': [ 0, 0, 0, 0 ],\n \\ 'highlight': 'PMenu'\n \\ } )\n\n \" But don't open it, as this could take up valuable actual screen space\n \" py3 vimsupport.OpenQuickFixList()\n endif\n endif\n\n\n call s:EndRequest()\n let s:find_symbol_status.id = -1\nendfunction\n\n\"}}}\n\n\" Results handling and re-query {{{\n\n\" Render a set of results returned from the filter/search function\nfunction! s:HandleSymbolSearchResults( results ) abort\n let s:find_symbol_status.results = []\n\n if s:find_symbol_status.id < 0\n \" Popup was closed, ignore this event\n return\n endif\n\n let s:find_symbol_status.results = a:results\n call s:RedrawFinderPopup()\n\n \" Re-query but no change in the query text\n call s:RequeryFinderPopup( v:false )\nendfunction\n\n\n\" Set the popup text\nfunction! s:RedrawFinderPopup() abort\n \" Clamp selected. If there are any results, the first one is selected by\n \" default\n let s:find_symbol_status.selected = max( [\n \\ s:find_symbol_status.selected,\n \\ len( s:find_symbol_status.results ) > 0 ? 0 : -1\n \\ ] )\n let s:find_symbol_status.selected = min( [\n \\ s:find_symbol_status.selected,\n \\ len( s:find_symbol_status.results ) - 1\n \\ ] )\n\n if empty( s:find_symbol_status.results )\n call popup_settext( s:find_symbol_status.id, 'No results' )\n let s:find_symbol_status.selected = -1\n else\n let popup_width = popup_getpos( s:find_symbol_status.id ).core_width\n\n let buffer = []\n\n let len_filetype = 0\n\n for result in s:find_symbol_status.results\n let len_filetype = max( [ len_filetype, len( result[ 'filetype' ] ) ] )\n endfor\n\n if len_filetype > 0\n let filetype_sep = ' '\n else\n let filetype_sep = ''\n endif\n\n let available_width = popup_width - len_filetype - len( filetype_sep )\n\n for result in s:find_symbol_status.results\n \" Calculate the text to use. Try and include the full path and line\n \" number, (right aligned), but truncate if there isn't space for the\n \" description and the file path. Include at least 8 spaces between them\n \" (if there's room).\n if result->has_key( 'extra_data' )\n let kind = result[ 'extra_data' ][ 'kind' ]\n let name = result[ 'extra_data' ][ 'name' ]\n let desc = kind .. ': ' .. name\n let prop = youcompleteme#symbol#GetPropForSymbolKind( kind )\n let props = [\n \\ { 'col': 1,\n \\ 'length': len( kind ) + 2,\n \\ 'type': 'YCM-symbol-Normal' },\n \\ { 'col': len( kind ) + 3,\n \\ 'length': len( name ),\n \\ 'type': prop },\n \\ ]\n elseif result->has_key( 'description' )\n let desc = result[ 'description' ]\n let props = [\n \\ { 'col': 1, 'length': len( desc ), 'type': 'YCM-symbol-Normal' },\n \\ ]\n else\n let desc = 'Invalid entry: ' . string( result )\n let props = []\n endif\n\n let line_num = result[ 'line_num' ]\n let path = fnamemodify( result[ 'filepath' ], ':.' )\n \\ .. ':'\n \\ .. line_num\n let path_includes_line = 1\n\n let spaces = available_width - strdisplaywidth( desc ) - strdisplaywidth( path )\n let spacing = 4\n if spaces < spacing\n let spaces = spacing\n let space_for_path = available_width - spacing - len( desc )\n let path_includes_line = space_for_path - 3 > len( line_num ) + 1\n if space_for_path > 3\n let path = '...' . strpart( path, len( path ) - space_for_path + 3 )\n elseif space_for_path <= 0\n let path = ''\n else\n let path_includes_line = 0\n let path = '...'\n endif\n endif\n\n let line = desc\n \\ .. repeat( ' ', spaces )\n \\ .. path\n \\ .. filetype_sep\n \\ .. result[ 'filetype' ]\n\n if len( path ) > 0\n if path_includes_line\n let props += [\n \\ { 'col': len( desc ) + spaces + 1,\n \\ 'length': len( path ) - len( line_num ),\n \\ 'type': 'YCM-symbol-file' },\n \\ { 'col': len( desc ) + spaces + 1 + len( path ) - len( line_num ),\n \\ 'length': len( line_num ),\n \\ 'type': 'YCM-symbol-line-num' },\n \\ ]\n else\n let props += [\n \\ { 'col': len( desc ) + spaces + 1,\n \\ 'length': len( path ),\n \\ 'type': 'YCM-symbol-file' },\n \\ ]\n endif\n endif\n\n if len_filetype > 0\n let props += [\n \\ { 'col': popup_width - len_filetype + len( filetype_sep ),\n \\ 'length': len_filetype,\n \\ 'type': 'YCM-symbol-filetype' },\n \\ ]\n endif\n\n call add( buffer, { 'text': line, 'props': props } )\n endfor\n\n call popup_settext( s:find_symbol_status.id, buffer )\n endif\n\n if s:find_symbol_status.selected > -1\n \" Move the cursor so that cursorline highlights the selected item. Also\n \" scroll the window if the selected item is not in view. To make scrolling\n \" feel natural we position the current line a the bottom of the window if\n \" the new current line is below the current viewport, and at the top if the\n \" new current line is above the viewport.\n let new_line = s:find_symbol_status.selected + 1\n let pos = popup_getpos( s:find_symbol_status.id )\n\n call win_execute( s:find_symbol_status.id,\n \\ 'call cursor( [' . string( new_line ) . ', 1] )' )\n\n if new_line < pos.firstline\n \" New line is above the viewport, scroll so that this line is at the top\n \" of the window.\n call win_execute( s:find_symbol_status.id, \"normal z\\\" )\n elseif new_line >= ( pos.firstline + pos.core_height )\n \" New line is below the viewport, scroll so that this line is at the\n \" bottom of the window.\n call win_execute( s:find_symbol_status.id, ':normal z-' )\n endif\n \" Otherwise, new item is already displayed - don't scroll the window.\n\n if !getwinvar( s:find_symbol_status.id, '&cursorline' )\n call win_execute( s:find_symbol_status.id,\n \\ 'set cursorline cursorlineopt&' )\n endif\n else\n call win_execute( s:find_symbol_status.id, 'set nocursorline' )\n endif\n\nendfunction\n\nfunction! s:SetTitle() abort\n if s:find_symbol_status.spinner_timer > -1\n let status = s:icon_spinner[ s:find_symbol_status.spinner ]\n else\n let status = s:icon_done\n endif\n\n call popup_setoptions( s:find_symbol_status.id, {\n \\ 'title': ' [' . status . '] Search for symbol: '\n \\ . s:find_symbol_status.query . ' '\n \\ } )\nendfunction\n\n\n\n\" Re-query or re-filter by calling the filter function\nfunction! s:RequeryFinderPopup( new_query ) abort\n \" Update the title even if we delay the query, as this makes the UI feel\n \" snappy\n call s:SetTitle()\n\n call win_execute( s:find_symbol_status.winid,\n \\ 'call s:find_symbol_status.query_func('\n \\ . 's:find_symbol_status.query,'\n \\ . 'a:new_query )' )\nendfunction\n\nfunction! s:ParseGoToResponse( filetype, results ) abort\n if type( a:results ) == v:t_none || empty( a:results )\n let results = []\n elseif type( a:results ) != v:t_list\n if type( a:results ) == v:t_dict && has_key( a:results, 'error' )\n let results = []\n else\n let results = [ a:results ]\n endif\n else\n let results = a:results\n endif\n\n call map( results, { _, r -> extend( r, {\n \\ 'key': r->get( 'extra_data', {} )->get( 'name', r[ 'description' ] ),\n \\ 'filetype': a:filetype\n \\ } ) } )\n return results\nendfunction\n\n\" }}}\n\n\" Spinner {{{\n\nfunction! s:StartRequest() abort\n call s:EndRequest()\n\n let s:find_symbol_status.spinner = 0\n let s:find_symbol_status.spinner_timer = timer_start( s:spinner_delay,\n \\ function( 's:TickSpinner' ) )\n\n call s:SetTitle()\nendfunction\n\nfunction! s:EndRequest() abort\n call timer_stop( s:find_symbol_status.spinner_timer )\n\n let s:find_symbol_status.spinner_timer = -1\n\n call s:SetTitle()\nendfunction\n\nfunction! s:TickSpinner( timer_id ) abort\n let s:find_symbol_status.spinner = ( s:find_symbol_status.spinner + 1 ) %\n \\ len( s:icon_spinner )\n\n let s:find_symbol_status.spinner_timer = timer_start( s:spinner_delay,\n \\ function( 's:TickSpinner' ) )\n\n call s:SetTitle()\nendfunction\n\n\" }}}\n\n\" Workspace search {{{\n\nfunction! s:SearchWorkspace( query, new_query ) abort\n\n if a:new_query\n if s:find_symbol_status.raw_results is# v:none\n let raw_results = {}\n else\n let raw_results = copy( s:find_symbol_status.raw_results )\n endif\n\n let s:find_symbol_status.raw_results = {}\n \" FIXME: We might still get results for any pending results. There is no\n \" cancellation mechanism implemented for the async request!\n let s:find_symbol_status.pending = []\n\n if s:find_symbol_status.all_filetypes\n let ft_buffer_map = py3eval( 'vimsupport.AllOpenedFiletypes()' )\n else\n let current_filetypes = py3eval( 'vimsupport.CurrentFiletypes()' )\n let ft_buffer_map = {}\n for ft in current_filetypes\n let ft_buffer_map[ ft ] = [ bufnr() ]\n endfor\n endif\n\n for ft in keys( ft_buffer_map )\n if !youcompleteme#filetypes#AllowedForFiletype( ft )\n continue\n endif\n\n let s:find_symbol_status.raw_results[ ft ] = v:none\n if has_key( raw_results, ft ) && raw_results[ ft ] is# v:none\n call add( s:find_symbol_status.pending,\n \\ [ ft, ft_buffer_map[ ft ][ 0 ] ] )\n else\n call youcompleteme#GetRawCommandResponseAsync(\n \\ function( 's:HandleWorkspaceSymbols', [ ft ] ),\n \\ 'GoToSymbol',\n \\ '--bufnr=' . ft_buffer_map[ ft ][ 0 ],\n \\ 'ft=' . ft,\n \\ a:query )\n endif\n endfor\n\n if !empty( s:find_symbol_status.raw_results )\n \" We sent some requests\n call s:StartRequest()\n endif\n else\n \" Just requery those completer filetypes that we're not currently waiting\n \" for\n for [ ft, bufnr ] in copy( s:find_symbol_status.pending )\n if s:find_symbol_status.raw_results[ ft ] isnot# v:none\n call filter( s:find_symbol_status.pending, { v -> v !=# ft } )\n let s:find_symbol_status.raw_results[ ft ] = v:none\n call youcompleteme#GetRawCommandResponseAsync(\n \\ function( 's:HandleWorkspaceSymbols', [ ft ] ),\n \\ 'GoToSymbol',\n \\ '--bufnr=' . bufnr,\n \\ 'ft=' . ft,\n \\ a:query )\n endif\n endfor\n endif\nendfunction\n\n\nfunction! s:HandleWorkspaceSymbols( filetype, results ) abort\n\n let s:find_symbol_status.raw_results[ a:filetype ] =\n \\ s:ParseGoToResponse( a:filetype, a:results )\n\n \" Collate the results from each filetype\n let results = []\n let waiting = 0\n for ft in keys( s:find_symbol_status.raw_results )\n if s:find_symbol_status.raw_results[ ft ] is v:none\n let waiting = 1\n continue\n endif\n\n call extend( results, s:find_symbol_status.raw_results[ ft ] )\n endfor\n\n let query = s:find_symbol_status.query\n\n if g:ycm_refilter_workspace_symbols && !empty( results )\n \" This is kinda wonky, but seems to work well enough.\n \"\n \" We get the server to give us a result set, then use our own\n \" filter_and_sort_candidates on the result set filtered by the server\n \"\n \" The reason for this is:\n \" - server filterins will differ by server and this leads to horrible wonky\n \" user experience\n \" - ycmd filter is consistent, even if not perfect\n \" - servers are supposed to return _all_ symbols if we request a query of\n \" \"\" but not all servers actually do\n \"\n \" So as a compromise we let the server filter the results, then we\n \" _refilter_ and sort them using ycmd's method. This provides consistency\n \" with the filtering and sorting on the completion popup menu, with the\n \" disadvantage of additional latency.\n \"\n \" We're not currently sure this is going to be perfecct, so we have a hidden\n \" option to disable this re-filter/sort.\n \"\n let results = py3eval(\n \\ 'ycm_state.FilterAndSortItems( vim.eval( \"results\" ),'\n \\ . ' \"key\",'\n \\ . ' vim.eval( \"query\" ) )' )\n endif\n\n if !waiting\n call s:EndRequest()\n endif\n eval s:HandleSymbolSearchResults( results )\nendfunction\n\n\" }}}\n\n\" Document Search {{{\n\nfunction! s:SearchDocument( query, new_query ) abort\n if !a:new_query\n return\n endif\n\n if type( s:find_symbol_status.raw_results ) == v:t_none\n call popup_settext( s:find_symbol_status.id,\n \\ 'No symbols found in document' )\n return\n endif\n\n \" No spinner, because this is actually a synchronous call\n\n \" Call filter_and_sort_candidates on the results (synchronously)\n let response = py3eval(\n \\ 'ycm_state.FilterAndSortItems( '\n \\ . ' vim.eval( \"s:find_symbol_status.raw_results\" ),'\n \\ . ' \"key\",'\n \\ . ' vim.eval( \"a:query\" ) )' )\n\n eval s:HandleSymbolSearchResults( response )\nendfunction\n\n\nfunction! s:RequestDocumentSymbols()\n call s:StartRequest()\n call youcompleteme#GetRawCommandResponseAsync(\n \\ function( 's:HandleDocumentSymbols' ),\n \\ 'GoToDocumentOutline' )\nendfunction\n\n\nfunction! s:HandleDocumentSymbols( results ) abort\n call s:EndRequest()\n let s:find_symbol_status.raw_results = s:ParseGoToResponse( '', a:results )\n call s:SearchDocument( '', v:true )\nendfunction\n\n\" }}}\n\n\" Utility for testing {{{\n\nfunction! youcompleteme#finder#GetState() abort\n return s:find_symbol_status\nendfunction\n\n\" }}}\n\n\" This is basic vim plugin boilerplate\nlet &cpoptions = s:save_cpo\nunlet s:save_cpo\n\n\" vim: foldmethod=marker\n" }, { "path": "autoload/youcompleteme/hierarchy.vim", "content": "\" Copyright (C) 2021 YouCompleteMe contributors\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free software: you can redistribute it and/or modify\n\" it under the terms of the GNU General Public License as published by\n\" the Free Software Foundation, either version 3 of the License, or\n\" (at your option) any later version.\n\"\n\" YouCompleteMe is distributed in the hope that it will be useful,\n\" but WITHOUT ANY WARRANTY; without even the implied warranty of\n\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\" GNU General Public License for more details.\n\"\n\" You should have received a copy of the GNU General Public License\n\" along with YouCompleteMe. If not, see .\n\n\" This is basic vim plugin boilerplate\nlet s:save_cpo = &cpoptions\nset cpoptions&vim\n\nscriptencoding utf-8\n\nlet s:popup_id = -1\nlet s:lines_and_handles = v:null\n\" 1-based index of the selected item in the popup\n\" -1 means none set\n\" 0 means nothing, (Invalid)\nlet s:select = -1\nlet s:kind = ''\n\nlet s:ingored_keys = [\n \\ \"\\\",\n \\ \"\\\",\n \\ ]\n\nfunction! youcompleteme#hierarchy#StartRequest( kind )\n if !py3eval( 'vimsupport.VimSupportsPopupWindows()' )\n echo 'Sorry, this feature is not supported in your editor'\n return\n endif\n\n call youcompleteme#symbol#InitSymbolProperties()\n py3 ycm_state.ResetCurrentHierarchy()\n py3 from ycm.client.command_request import GetRawCommandResponse\n if a:kind == 'call'\n let lines_and_handles = py3eval(\n \\ 'ycm_state.InitializeCurrentHierarchy( GetRawCommandResponse( ' .\n \\ '[ \"CallHierarchy\" ], False ), ' .\n \\ 'vim.eval( \"a:kind\" ) )' )\n else\n let lines_and_handles = py3eval( \n \\ 'ycm_state.InitializeCurrentHierarchy( GetRawCommandResponse( ' .\n \\ '[ \"TypeHierarchy\" ], False ), ' .\n \\ 'vim.eval( \"a:kind\" ) )' )\n endif\n if len( lines_and_handles )\n let s:lines_and_handles = lines_and_handles\n let s:kind = a:kind\n let s:select = 1\n call s:SetUpMenu()\n endif\nendfunction\n\nfunction! s:MenuFilter( winid, key )\n if a:key == \"\\\"\n \" Root changes if we're showing super-tree of a sub-tree of the root\n \" (indicated by the handle being positive)\n let will_change_root = s:lines_and_handles[ s:select - 1 ][ 1 ] > 0\n call popup_close(\n \\ s:popup_id,\n \\ [ s:select - 1, 'resolve_up', will_change_root ] )\n return 1\n endif\n if a:key == \"\\\"\n \" Root changes if we're showing sub-tree of a super-tree of the root\n \" (indicated by the handle being negative)\n let will_change_root = s:lines_and_handles[ s:select - 1 ][ 1 ] < 0\n call popup_close(\n \\ s:popup_id,\n \\ [ s:select - 1, 'resolve_down', will_change_root ] )\n return 1\n endif\n if a:key == \"\\\"\n call popup_close( s:popup_id, [ s:select - 1, 'jump', v:none ] )\n return 1\n endif\n if a:key == \"\\\" || a:key == \"\\\" || a:key == \"\\\" || a:key == \"k\"\n let s:select -= 1\n if s:select < 1\n let s:select = 1\n endif\n call win_execute( s:popup_id,\n \\ 'call cursor( [' . string( s:select ) . ', 1 ] )' )\n call win_execute( s:popup_id,\n \\ 'set cursorline cursorlineopt&' )\n return 1\n endif\n if a:key == \"\\\" || a:key == \"\\\" || a:key == \"\\\" || a:key == \"j\"\n let s:select += 1\n if s:select > len( s:lines_and_handles )\n let s:select = len( s:lines_and_handles )\n endif\n call win_execute( s:popup_id,\n \\ 'call cursor( [' . string( s:select ) . ', 1 ] )' )\n call win_execute( s:popup_id,\n \\ 'set cursorline cursorlineopt&' )\n return 1\n endif\n if index( s:ingored_keys, a:key ) >= 0\n return 0\n endif\n \" Close the popup on any other key press\n call popup_close( s:popup_id, [ s:select - 1, 'cancel', v:none ] )\n if a:key == \"\\\" || a:key == \"\\\"\n return 1\n endif\n return 0\nendfunction\n\nfunction! s:MenuCallback( winid, result )\n let operation = a:result[ 1 ]\n let selection = a:result[ 0 ]\n if operation == 'resolve_down'\n call s:ResolveItem( selection, 'down', a:result[ 2 ] )\n elseif operation == 'resolve_up'\n call s:ResolveItem( selection, 'up', a:result[ 2 ] )\n else\n if operation == 'jump'\n let handle = s:lines_and_handles[ selection ][ 1 ]\n py3 ycm_state.JumpToHierarchyItem( vimsupport.GetIntValue( \"handle\" ) )\n endif\n py3 ycm_state.ResetCurrentHierarchy()\n let s:kind = ''\n let s:select = 1\n endif\nendfunction\n\nfunction! s:SetUpMenu()\n let opts = #{\n \\ filter: funcref( 's:MenuFilter' ),\n \\ callback: funcref( 's:MenuCallback' ),\n \\ wrap: 0,\n \\ minwidth: &columns * 90/100,\n \\ maxwidth: &columns * 90/100,\n \\ maxheight: &lines * 75/100,\n \\ scrollbar: 1,\n \\ padding: [ 0, 0, 0, 0 ],\n \\ highlight: 'Normal',\n \\ border: [],\n \\ }\n if &ambiwidth ==# 'single' && &encoding ==? 'utf-8'\n let opts[ 'borderchars' ] = [ '─', '│', '─', '│', '╭', '╮', '╯', '╰' ]\n endif\n\n let s:popup_id = popup_create( [], opts )\n let menu_lines = []\n let popup_width = popup_getpos( s:popup_id ).core_width\n let tabstop = popup_width / 3\n for [ item, handle ] in s:lines_and_handles\n let indent = repeat( ' ', item.indent )\n let name = indent\n \\ .. item.icon\n \\ .. item.kind\n \\ .. ': ' .. item.symbol\n \" -2 because:\n \" 0-based index\n \" 1 for the tab character\n let trunc_name = name[ : tabstop - 2 ]\n let props = []\n let name_pfx_len = len( indent ) + len( item.icon ) + len( item.kind ) + 2\n if len( trunc_name ) > name_pfx_len\n let props += [\n \\ {\n \\ 'col': name_pfx_len + 1,\n \\ 'length': len( trunc_name ) - name_pfx_len,\n \\ 'type': youcompleteme#symbol#GetPropForSymbolKind( item.kind ),\n \\ }\n \\ ]\n endif\n\n let file_name = item.filepath .. ':' .. item.line_num\n let trunc_path = file_name[ : tabstop - 2 ]\n if len(trunc_path) > 0\n let props += [\n \\ {\n \\ 'col': len(trunc_name) + 2,\n \\ 'length': min( [ len(trunc_path), len( item.filepath ) ] ),\n \\ 'type': 'YCM-symbol-file'\n \\ }\n \\ ]\n if len(trunc_path) > len(item.filepath) + 1\n let props += [\n \\ {\n \\ 'col': len(trunc_name) + 2 + len(item.filepath) + 1,\n \\ 'length': min( [ len(trunc_path), len( item.line_num ) ] ),\n \\ 'type': 'YCM-symbol-line-num'\n \\ }\n \\ ]\n endif\n endif\n\n let trunc_desc = item.description[ : tabstop - 2 ]\n\n let line = trunc_name\n \\ . \"\\t\"\n \\ .. trunc_path\n \\ . \"\\t\"\n \\ .. trunc_desc\n call add( menu_lines, { 'text': line, 'props': props } )\n endfor\n call win_execute( s:popup_id,\n \\ 'setlocal tabstop=' . tabstop )\n call popup_settext( s:popup_id, menu_lines )\n call win_execute( s:popup_id,\n \\ 'call cursor( [' . string( s:select ) . ', 1 ] )' )\n call win_execute( s:popup_id,\n \\ 'set cursorline cursorlineopt&' )\nendfunction\n\nfunction! s:ResolveItem( choice, direction, will_change_root )\n let handle = s:lines_and_handles[ a:choice ][ 1 ]\n if py3eval(\n \\ 'ycm_state.ShouldResolveItem( vimsupport.GetIntValue( \"handle\" ), vim.eval( \"a:direction\" ) )' )\n let lines_and_handles_with_offset = py3eval(\n \\ 'ycm_state.UpdateCurrentHierarchy( ' .\n \\ 'vimsupport.GetIntValue( \"handle\" ), ' .\n \\ 'vim.eval( \"a:direction\" ) )' )\n let s:lines_and_handles = lines_and_handles_with_offset[ 0 ]\n if a:will_change_root\n \" When re-rooting the tree, put the cursor on the new \"root\" item, as this\n \" helps with orientation. This behaviour is consistent with an expansion\n \" where we _don't_ re-root the tree, so feels more natural than anything\n \" else.\n \" The new root is the element with indent of 0.\n \" let s:select = 1 + indexof( s:lines_and_handles,\n \" \\ { i, v -> v[0].indent == 0 } )\n let s:select = 1\n for item in s:lines_and_handles\n if item[0].indent == 0\n break\n endif\n let s:select += 1\n endfor\n else\n let s:select += lines_and_handles_with_offset[ 1 ]\n endif\n endif\n call s:SetUpMenu()\nendfunction\n" }, { "path": "autoload/youcompleteme/symbol.vim", "content": "\" Copyright (C) 2024 YouCompleteMe contributors\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free software: you can redistribute it and/or modify\n\" it under the terms of the GNU General Public License as published by\n\" the Free Software Foundation, either version 3 of the License, or\n\" (at your option) any later version.\n\"\n\" YouCompleteMe is distributed in the hope that it will be useful,\n\" but WITHOUT ANY WARRANTY; without even the implied warranty of\n\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\" GNU General Public License for more details.\n\"\n\" You should have received a copy of the GNU General Public License\n\" along with YouCompleteMe. If not, see .\n\n\nlet s:highlight_group_for_symbol_kind = {\n \\ 'Array': 'Identifier',\n \\ 'Boolean': 'Boolean',\n \\ 'Class': 'Structure',\n \\ 'Constant': 'Constant',\n \\ 'Constructor': 'Function',\n \\ 'Enum': 'Structure',\n \\ 'EnumMember': 'Identifier',\n \\ 'Event': 'Identifier',\n \\ 'Field': 'Identifier',\n \\ 'Function': 'Function',\n \\ 'Interface': 'Structure',\n \\ 'Key': 'Identifier',\n \\ 'Method': 'Function',\n \\ 'Module': 'Include',\n \\ 'Namespace': 'Type',\n \\ 'Null': 'Keyword',\n \\ 'Number': 'Number',\n \\ 'Object': 'Structure',\n \\ 'Operator': 'Operator',\n \\ 'Package': 'Include',\n \\ 'Property': 'Identifier',\n \\ 'String': 'String',\n \\ 'Struct': 'Structure',\n \\ 'TypeParameter': 'Typedef',\n \\ 'Variable': 'Identifier',\n \\ }\nlet s:initialized_text_properties = v:false\n\nfunction! youcompleteme#symbol#InitSymbolProperties() abort\n if !s:initialized_text_properties\n call prop_type_add( 'YCM-symbol-Normal', { 'highlight': 'Normal' } )\n for k in keys( s:highlight_group_for_symbol_kind )\n call prop_type_add(\n \\ 'YCM-symbol-' . k,\n \\ { 'highlight': s:highlight_group_for_symbol_kind[ k ] } )\n endfor\n call prop_type_add( 'YCM-symbol-file', { 'highlight': 'Comment' } )\n call prop_type_add( 'YCM-symbol-filetype', { 'highlight': 'Special' } )\n call prop_type_add( 'YCM-symbol-line-num', { 'highlight': 'Number' } )\n let s:initialized_text_properties = v:true\n endif\nendfunction\n\nfunction! youcompleteme#symbol#GetPropForSymbolKind( kind ) abort\n if s:highlight_group_for_symbol_kind->has_key( a:kind )\n return 'YCM-symbol-' . a:kind\n endif\n\n return 'YCM-symbol-Normal'\nendfunction\n\n\n" }, { "path": "autoload/youcompleteme.vim", "content": "\" Copyright (C) 2011-2018 YouCompleteMe contributors\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free software: you can redistribute it and/or modify\n\" it under the terms of the GNU General Public License as published by\n\" the Free Software Foundation, either version 3 of the License, or\n\" (at your option) any later version.\n\"\n\" YouCompleteMe is distributed in the hope that it will be useful,\n\" but WITHOUT ANY WARRANTY; without even the implied warranty of\n\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\" GNU General Public License for more details.\n\"\n\" You should have received a copy of the GNU General Public License\n\" along with YouCompleteMe. If not, see .\n\n\" This is basic vim plugin boilerplate\nlet s:save_cpo = &cpo\nset cpo&vim\n\n\" NOTE: Neovim reports v:version as 800, which is garbage. For some features\n\" that are supported by our minimum Vim version, we have to guard them against\n\" neovim, which doesn't implement them.\nlet s:is_neovim = has( 'nvim' )\n\n\" Only useful in neovim, for handling text properties... I mean extmarks.\nlet g:ycm_neovim_ns_id = s:is_neovim ? nvim_create_namespace( 'ycm_id' ) : -1\n\n\" This needs to be called outside of a function\nlet s:script_folder_path = escape( expand( ':p:h' ), '\\' )\nlet s:force_semantic = 0\nlet s:force_manual = 0\nlet s:completion_stopped = 0\n\" These two variables are initialized in youcompleteme#Enable.\nlet s:default_completion = {}\nlet s:completion = s:default_completion\nlet s:default_signature_help = {}\nlet s:signature_help = s:default_completion\nlet s:previous_allowed_buffer_number = 0\nlet s:pollers = {\n \\ 'completion': {\n \\ 'id': -1,\n \\ 'wait_milliseconds': 10,\n \\ },\n \\ 'signature_help': {\n \\ 'id': -1,\n \\ 'wait_milliseconds': 10,\n \\ },\n \\ 'file_parse_response': {\n \\ 'id': -1,\n \\ 'wait_milliseconds': 100,\n \\ },\n \\ 'server_ready': {\n \\ 'id': -1,\n \\ 'wait_milliseconds': 100,\n \\ },\n \\ 'receive_messages': {\n \\ 'id': -1,\n \\ 'wait_milliseconds': 100,\n \\ },\n \\ 'command': {\n \\ 'id': -1,\n \\ 'wait_milliseconds': 100,\n \\ 'requests': {},\n \\ },\n \\ 'semantic_highlighting': {\n \\ 'id': -1,\n \\ 'wait_milliseconds': 100,\n \\ },\n \\ 'inlay_hints': {\n \\ 'id': -1,\n \\ 'wait_milliseconds': 100,\n \\ },\n \\ }\nlet s:buftype_blacklist = {\n \\ 'help': 1,\n \\ 'terminal': 1,\n \\ 'quickfix': 1,\n \\ 'popup': 1,\n \\ 'nofile': 1,\n \\ }\nlet s:last_char_inserted_by_user = v:true\nlet s:enable_hover = 0\nlet s:cursorhold_popup = -1\nlet s:enable_inlay_hints = 0\n\nlet s:force_preview_popup = 0\n\nlet s:RESOLVE_NONE = 0\nlet s:RESOLVE_UP_FRONT = 1\nlet s:RESOLVE_ON_DEMAND = 2\nlet s:resolve_completions = s:RESOLVE_NONE\n\nfunction! s:StartMessagePoll()\n if s:pollers.receive_messages.id < 0\n let s:pollers.receive_messages.id = timer_start(\n \\ s:pollers.receive_messages.wait_milliseconds,\n \\ function( 's:ReceiveMessages' ) )\n endif\nendfunction\n\n\nfunction! s:ReceiveMessages( timer_id )\n let poll_again = v:false\n if s:AllowedToCompleteInCurrentBuffer()\n let poll_again = py3eval( 'ycm_state.OnPeriodicTick()' )\n endif\n\n if poll_again\n let s:pollers.receive_messages.id = timer_start(\n \\ s:pollers.receive_messages.wait_milliseconds,\n \\ function( 's:ReceiveMessages' ) )\n else\n \" Don't poll again until we open another buffer\n let s:pollers.receive_messages.id = -1\n endif\nendfunction\n\n\nfunction! s:SetUpOptions()\n call s:SetUpCommands()\n call s:SetUpCpoptions()\n call s:SetUpCompleteopt()\n call s:SetUpKeyMappings()\n\n if g:ycm_show_diagnostics_ui\n call s:TurnOffSyntasticForCFamily()\n endif\n\n call s:SetUpSigns()\n call s:SetUpSyntaxHighlighting()\nendfunction\n\n\nfunction! youcompleteme#Enable()\n call s:SetUpBackwardsCompatibility()\n\n let completeopt = split( &completeopt, ',' )\n\n \" Will we add 'popup' to the 'completeopt' (later)\n let s:force_preview_popup =\n \\ type( g:ycm_add_preview_to_completeopt ) == v:t_string &&\n \\ g:ycm_add_preview_to_completeopt ==# 'popup' &&\n \\ !s:is_neovim\n\n \" Will we add 'preview' to the 'completeopt' (later)\n let force_preview =\n \\ type( g:ycm_add_preview_to_completeopt ) != v:t_string &&\n \\ g:ycm_add_preview_to_completeopt\n\n \" Will we be using the preview popup ? That is either the user set it in their\n \" completeopt or we're going to add it later.\n let use_preview_popup =\n \\ s:force_preview_popup ||\n \\ index( completeopt, 'popup' ) >= 0\n\n \" We should only ask the server to resolve completion items upfront if we're\n \" going to display them - that is either:\n \" - popup is (or will be) in completeopt\n \" - preview is (or will be) in completeopt, or\n let require_resolve =\n \\ use_preview_popup ||\n \\ force_preview ||\n \\ index( completeopt, 'preview' ) >= 0\n\n if use_preview_popup && exists( '*popup_findinfo' )\n \" If the preview popup is going to be used, and on-demand resolve can be\n \" supported, enable it.\n let s:resolve_completions = s:RESOLVE_ON_DEMAND\n elseif require_resolve\n \" The preview window or info popup is enabled - request the server\n \" pre-resolves completion items\n let s:resolve_completions = s:RESOLVE_UP_FRONT\n else\n \" Otherwise, there's no point in resolving completions - they'll never be\n \" displayed.\n endif\n\n if !s:SetUpPython()\n return\n endif\n\n call s:SetUpOptions()\n\n py3 ycm_semantic_highlighting.Initialise()\n let s:enable_inlay_hints = py3eval( 'ycm_inlay_hints.Initialise()' ) ? 1 : 0\n\n call youcompleteme#EnableCursorMovedAutocommands()\n augroup youcompleteme\n autocmd!\n \" Note that these events will NOT trigger for the file vim is started with;\n \" so if you do \"vim foo.cc\", these events will not trigger when that buffer\n \" is read. This is because youcompleteme#Enable() is called on VimEnter and\n \" that happens *after* FileType has already triggered for the initial file.\n \" We don't parse the buffer on the BufRead event since it would only be\n \" useful if the buffer filetype is set (we ignore the buffer if there is no\n \" filetype) and if so, the FileType event has triggered before and thus the\n \" buffer is already parsed.\n autocmd BufWritePost,FileWritePost * call s:OnFileSave()\n autocmd FileType * call s:OnFileTypeSet()\n autocmd BufEnter,CmdwinEnter,WinEnter * call s:OnBufferEnter()\n autocmd BufUnload * call s:OnBufferUnload()\n autocmd InsertLeave * call s:OnInsertLeave()\n autocmd VimLeave * call s:OnVimLeave()\n autocmd CompleteDone * call s:OnCompleteDone()\n autocmd CompleteChanged * call s:OnCompleteChanged()\n augroup END\n\n \" The FileType event is not triggered for the first loaded file. We wait until\n \" the server is ready to manually run the s:OnFileTypeSet function.\n let s:pollers.server_ready.id = timer_start(\n \\ s:pollers.server_ready.wait_milliseconds,\n \\ function( 's:PollServerReady' ) )\n\n let s:default_completion = py3eval( 'vimsupport.NO_COMPLETIONS' )\n let s:completion = s:default_completion\n\n if s:PropertyTypeNotDefined( 'YCM-signature-help-current-argument' )\n hi default YCMInverse term=reverse cterm=reverse gui=reverse\n call prop_type_add( 'YCM-signature-help-current-argument', {\n \\ 'highlight': 'YCMInverse',\n \\ 'combine': 1,\n \\ 'priority': 50,\n \\ } )\n endif\n\n nnoremap (YCMFindSymbolInWorkspace)\n \\ :call youcompleteme#finder#FindSymbol( 'workspace' )\n nnoremap (YCMFindSymbolInDocument)\n \\ :call youcompleteme#finder#FindSymbol( 'document' )\nendfunction\n\n\nfunction! youcompleteme#EnableCursorMovedAutocommands()\n augroup ycmcompletemecursormove\n autocmd!\n autocmd CursorMoved * call s:OnCursorMovedNormalMode()\n autocmd CursorMovedI * let s:current_cursor_position = getpos( '.' )\n autocmd InsertEnter * call s:OnInsertEnter()\n autocmd TextChanged * call s:OnTextChangedNormalMode()\n autocmd TextChangedI * call s:OnTextChangedInsertMode( v:false )\n autocmd TextChangedP * call s:OnTextChangedInsertMode( v:true )\n autocmd InsertCharPre * call s:OnInsertChar()\n if exists( '##WinScrolled' )\n autocmd WinScrolled * call s:OnWinScrolled()\n endif\n augroup END\nendfunction\n\n\nfunction! youcompleteme#DisableCursorMovedAutocommands()\n autocmd! ycmcompletemecursormove\nendfunction\n\n\nfunction! youcompleteme#GetErrorCount()\n return py3eval( 'ycm_state.GetErrorCount()' )\nendfunction\n\n\nfunction! youcompleteme#GetWarningCount()\n return py3eval( 'ycm_state.GetWarningCount()' )\nendfunction\n\n\nfunction! s:SetUpPython() abort\n py3 << EOF\nimport os.path as p\nimport sys\nimport traceback\nimport vim\n\nroot_folder = p.normpath( p.join( vim.eval( 's:script_folder_path' ), '..' ) )\nthird_party_folder = p.join( root_folder, 'third_party' )\n\n# Add dependencies to Python path.\nsys.path[ 0:0 ] = [ p.join( root_folder, 'python' ),\n p.join( third_party_folder, 'ycmd' ) ]\n\n# We enclose this code in a try/except block to avoid backtraces in Vim.\ntry:\n # Import the modules used in this file.\n from ycm import base, vimsupport, youcompleteme\n from ycm import semantic_highlighting as ycm_semantic_highlighting\n from ycm import inlay_hints as ycm_inlay_hints\n\n if 'ycm_state' in globals():\n # If re-initializing, pretend that we shut down\n ycm_state.OnVimLeave()\n del ycm_state\n\n # If we're able to resolve completion details asynchronously, set the option\n # which enables this in the server.\n if int( vim.eval( 's:resolve_completions == s:RESOLVE_ON_DEMAND' ) ):\n # resolve a small number upfront, the rest on demand\n default_options = {\n 'max_num_candidates_to_detail': 10\n }\n elif int( vim.eval( 's:resolve_completions == s:RESOLVE_NONE' ) ):\n # don't resolve any\n default_options = {\n 'max_num_candidates_to_detail': 0\n }\n else:\n # i.e. s:resolve_completions == s:RESOLVE_UP_FRONT\n # The server will decide - i.e. resolve everything upfront\n default_options = {}\n\n ycm_state = youcompleteme.YouCompleteMe( default_options )\nexcept Exception as error:\n # We don't use PostVimMessage or EchoText from the vimsupport module because\n # importing this module may fail.\n vim.command( 'redraw | echohl WarningMsg' )\n for line in traceback.format_exc().splitlines():\n vim.command( \"echom '{0}'\".format( line.replace( \"'\", \"''\" ) ) )\n\n vim.command( \"echo 'YouCompleteMe unavailable: {0}'\"\n .format( str( error ).replace( \"'\", \"''\" ) ) )\n vim.command( 'echohl None' )\n vim.command( 'return 0' )\nelse:\n vim.command( 'return 1' )\nEOF\nendfunction\n\n\nfunction! s:SetUpKeyMappings()\n \" The g:ycm_key_select_completion and g:ycm_key_previous_completion used to\n \" exist and are now here purely for the sake of backwards compatibility; we\n \" don't want to break users if we can avoid it.\n\n if exists('g:ycm_key_select_completion') &&\n \\ index(g:ycm_key_list_select_completion,\n \\ g:ycm_key_select_completion) == -1\n call add(g:ycm_key_list_select_completion, g:ycm_key_select_completion)\n endif\n\n if exists('g:ycm_key_previous_completion') &&\n \\ index(g:ycm_key_list_previous_completion,\n \\ g:ycm_key_previous_completion) == -1\n call add(g:ycm_key_list_previous_completion, g:ycm_key_previous_completion)\n endif\n\n for key in g:ycm_key_list_select_completion\n \" With this command, when the completion window is visible, the tab key\n \" (default) will select the next candidate in the window. In vim, this also\n \" changes the typed-in text to that of the candidate completion.\n exe 'inoremap ' . key . ' pumvisible() ? \"\\\" : \"\\' . key .'\"'\n endfor\n\n for key in g:ycm_key_list_previous_completion\n \" This selects the previous candidate for shift-tab (default)\n exe 'inoremap ' . key . ' pumvisible() ? \"\\\" : \"\\' . key .'\"'\n endfor\n\n for key in g:ycm_key_list_stop_completion\n \" When selecting a candidate and closing the completion menu with the \n \" key, the menu will automatically be reopened because of the TextChangedI\n \" event. We define a command to prevent that.\n exe 'inoremap ' . key . ' StopCompletion( \"\\' . key . '\" )'\n endfor\n\n if !empty( g:ycm_key_invoke_completion )\n let invoke_key = g:ycm_key_invoke_completion\n\n \" Inside the console, is passed as to Vim\n if invoke_key ==# ''\n imap \n endif\n\n silent! exe 'inoremap ' . invoke_key .\n \\ ' =RequestSemanticCompletion()'\n endif\n\n if !empty( g:ycm_key_detailed_diagnostics )\n silent! exe 'nnoremap ' . g:ycm_key_detailed_diagnostics .\n \\ ' :YcmShowDetailedDiagnostic'\n endif\nendfunction\n\n\nfunction! s:SetUpSigns()\n \" We try to ensure backwards compatibility with Syntastic if the user has\n \" already defined styling for Syntastic highlight groups.\n\n if !hlexists( 'YcmErrorSign' )\n if hlexists( 'SyntasticErrorSign')\n highlight default link YcmErrorSign SyntasticErrorSign\n else\n highlight default link YcmErrorSign error\n endif\n endif\n\n if !hlexists( 'YcmWarningSign' )\n if hlexists( 'SyntasticWarningSign')\n highlight default link YcmWarningSign SyntasticWarningSign\n else\n highlight default link YcmWarningSign todo\n endif\n endif\n\n if !hlexists( 'YcmErrorLine' )\n highlight default link YcmErrorLine SyntasticErrorLine\n endif\n\n if !hlexists( 'YcmWarningLine' )\n highlight default link YcmWarningLine SyntasticWarningLine\n endif\n\n call sign_define( [\n \\ { 'name': 'YcmError',\n \\ 'text': g:ycm_error_symbol,\n \\ 'texthl': 'YcmErrorSign',\n \\ 'linehl': 'YcmErrorLine',\n \\ 'group': 'ycm_signs' },\n \\ { 'name': 'YcmWarning',\n \\ 'text': g:ycm_warning_symbol,\n \\ 'texthl': 'YcmWarningSign',\n \\ 'linehl': 'YcmWarningLine',\n \\ 'group': 'ycm_signs' }\n \\ ] )\n\nendfunction\n\n\nfunction! s:SetUpSyntaxHighlighting()\n \" We try to ensure backwards compatibility with Syntastic if the user has\n \" already defined styling for Syntastic highlight groups.\n\n if !hlexists( 'YcmErrorSection' )\n if hlexists( 'SyntasticError' )\n highlight default link YcmErrorSection SyntasticError\n else\n highlight default link YcmErrorSection SpellBad\n endif\n endif\n if s:PropertyTypeNotDefined( 'YcmErrorProperty' )\n call prop_type_add( 'YcmErrorProperty', {\n \\ 'highlight': 'YcmErrorSection',\n \\ 'priority': 30,\n \\ 'combine': 0,\n \\ 'override': 1 } )\n endif\n\n \" Used for virtual text\n if !hlexists( 'YcmInvisible' )\n highlight default link YcmInvisible Normal\n endif\n if !hlexists( 'YcmInlayHint' )\n highlight default link YcmInlayHint NonText\n endif\n if !hlexists( 'YcmErrorText' )\n if exists( '*hlget' )\n let YcmErrorText = hlget( 'SpellBad', v:true )[ 0 ]\n let YcmErrorText.name = 'YcmErrorText'\n let YcmErrorText.cterm = {}\n let YcmErrorText.gui = {}\n let YcmErrorText.term = {}\n call hlset( [ YcmErrorText ] )\n else\n \" approximation\n hi default link YcmErrorText WarningMsg\n endif\n endif\n if !hlexists( 'YcmWarningText' )\n if exists( '*hlget' )\n let YcmWarningText = hlget( 'SpellCap', v:true )[ 0 ]\n let YcmWarningText.name = 'YcmWarningText'\n let YcmWarningText.cterm = {}\n let YcmWarningText.gui = {}\n let YcmWarningText.term = {}\n call hlset( [ YcmWarningText] )\n else\n \" Lame approximation\n hi default link YcmWarningText Conceal\n endif\n endif\n\n if s:PropertyTypeNotDefined( 'YcmVirtDiagError' )\n call prop_type_add( 'YcmVirtDiagError', {\n \\ 'highlight': 'YcmErrorText',\n \\ 'priority': 20,\n \\ 'combine': 0 } )\n endif\n if s:PropertyTypeNotDefined( 'YcmVirtDiagWarning' )\n call prop_type_add( 'YcmVirtDiagWarning', {\n \\ 'highlight': 'YcmWarningText',\n \\ 'priority': 19,\n \\ 'combine': 0 } )\n endif\n\n\n if s:PropertyTypeNotDefined( 'YcmVirtDiagPadding' )\n call prop_type_add( 'YcmVirtDiagPadding', {\n \\ 'highlight': 'YcmInvisible',\n \\ 'priority': 100,\n \\ 'combine': 1 } )\n endif\n\n if !hlexists( 'YcmWarningSection' )\n if hlexists( 'SyntasticWarning' )\n highlight default link YcmWarningSection SyntasticWarning\n else\n highlight default link YcmWarningSection SpellCap\n endif\n endif\n if s:PropertyTypeNotDefined( 'YcmWarningProperty' )\n call prop_type_add( 'YcmWarningProperty', {\n \\ 'highlight': 'YcmWarningSection',\n \\ 'priority': 29,\n \\ 'combine': 0,\n \\ 'override': 1 } )\n endif\n\n if !hlexists( 'YcmErrorPopup' )\n highlight default link YcmErrorPopup ErrorMsg\n endif\nendfunction\n\n\nfunction! s:SetUpBackwardsCompatibility()\n let complete_in_comments_and_strings =\n \\ get( g:, 'ycm_complete_in_comments_and_strings', 0 )\n\n if complete_in_comments_and_strings\n let g:ycm_complete_in_strings = 1\n let g:ycm_complete_in_comments = 1\n endif\n\n \" ycm_filetypes_to_completely_ignore is the old name for fileype_blacklist\n if has_key( g:, 'ycm_filetypes_to_completely_ignore' )\n let g:filetype_blacklist = g:ycm_filetypes_to_completely_ignore\n endif\nendfunction\n\n\n\" Needed so that YCM is used instead of Syntastic\nfunction! s:TurnOffSyntasticForCFamily()\n let g:syntastic_cpp_checkers = []\n let g:syntastic_c_checkers = []\n let g:syntastic_objc_checkers = []\n let g:syntastic_objcpp_checkers = []\n let g:syntastic_cuda_checkers = []\nendfunction\n\n\nfunction! s:DisableOnLargeFile( buffer )\n if exists( 'b:ycm_largefile' )\n return b:ycm_largefile\n endif\n\n let threshold = g:ycm_disable_for_files_larger_than_kb * 1024\n let b:ycm_largefile =\n \\ threshold > 0 && getfsize( expand( a:buffer ) ) > threshold\n if b:ycm_largefile\n py3 vimsupport.PostVimMessage( 'YouCompleteMe is disabled in this buffer;' +\n \\ ' the file exceeded the max size (see YCM options).' )\n endif\n return b:ycm_largefile\nendfunction\n\nfunction! s:PropertyTypeNotDefined( type )\n return exists( '*prop_type_add' ) &&\n \\ index( prop_type_list(), a:type ) == -1\nendfunction\n\nfunction! s:AllowedToCompleteInBuffer( buffer )\n let buftype = getbufvar( a:buffer, '&buftype' )\n\n if has_key( s:buftype_blacklist, buftype )\n return 0\n endif\n\n let filetype = getbufvar( a:buffer, '&filetype' )\n if empty( filetype )\n let filetype = 'ycm_nofiletype'\n endif\n\n let allowed = youcompleteme#filetypes#AllowedForFiletype( filetype )\n\n if !allowed || s:DisableOnLargeFile( a:buffer )\n return 0\n endif\n\n let s:previous_allowed_buffer_number = bufnr( a:buffer )\n return allowed\nendfunction\n\n\nfunction! s:AllowedToCompleteInCurrentBuffer()\n return s:AllowedToCompleteInBuffer( '%' )\nendfunction\n\n\nfunction! s:VisitedBufferRequiresReparse()\n if bufnr( '%' ) ==# s:previous_allowed_buffer_number\n return 0\n endif\n\n return s:AllowedToCompleteInCurrentBuffer()\nendfunction\n\n\nfunction! s:SetUpCpoptions()\n \" Without this flag in cpoptions, critical YCM mappings do not work. There's\n \" no way to not have this and have YCM working, so force the flag.\n set cpoptions+=B\n\n \" This prevents the display of \"Pattern not found\" & similar messages during\n \" completion.\n set shortmess+=c\nendfunction\n\n\nfunction! s:SetUpCompleteopt()\n \" Some plugins (I'm looking at you, vim-notes) change completeopt by for\n \" instance adding 'longest'. This breaks YCM. So we force our settings.\n \" There's no two ways about this: if you want to use YCM then you have to\n \" have these completeopt settings, otherwise YCM won't work at all.\n\n \" We need menuone in completeopt, otherwise when there's only one candidate\n \" for completion, the menu doesn't show up.\n set completeopt-=menu\n set completeopt+=menuone\n\n \" This is unnecessary with our features. People use this option to insert\n \" the common prefix of all the matches and then add more differentiating chars\n \" so that they can select a more specific match. With our features, they\n \" don't need to insert the prefix; they just type the differentiating chars.\n \" Also, having this option set breaks the plugin.\n set completeopt-=longest\n\n if s:resolve_completions == s:RESOLVE_ON_DEMAND\n set completeopt+=popuphidden\n endif\n\n if s:force_preview_popup\n set completeopt+=popup\n elseif g:ycm_add_preview_to_completeopt\n set completeopt+=preview\n endif\nendfunction\n\n\nfunction! s:EnableCompletingInCurrentBuffer()\n if !g:ycm_auto_trigger\n call s:SetCompleteFunc()\n endif\n let b:ycm_completing = 1\nendfunction\n\n\nfunction s:StopPoller( poller ) abort\n call timer_stop( a:poller.id )\n let a:poller.id = -1\nendfunction\n\n\nfunction! s:OnVimLeave()\n \" Workaround a NeoVim issue - not shutting down timers correctly\n \" https://github.com/neovim/neovim/issues/6840\n for poller in values( s:pollers )\n call s:StopPoller( poller )\n endfor\n py3 ycm_state.OnVimLeave()\nendfunction\n\n\nfunction! s:OnCompleteDone()\n if !s:AllowedToCompleteInCurrentBuffer()\n return\n endif\n\n let s:last_char_inserted_by_user = v:false\n\n py3 ycm_state.OnCompleteDone()\n call s:UpdateSignatureHelp()\nendfunction\n\n\nfunction! s:OnCompleteChanged()\n if !s:AllowedToCompleteInCurrentBuffer()\n return\n endif\n\n if ! empty( v:event.completed_item )\n let s:last_char_inserted_by_user = v:false\n call s:ResolveCompletionItem( v:event.completed_item )\n endif\n\n call s:UpdateSignatureHelp()\nendfunction\n\n\nfunction! s:ResolveCompletionItem( item )\n if s:resolve_completions != s:RESOLVE_ON_DEMAND\n return\n endif\n\n let complete_mode = complete_info( [ 'mode' ] ).mode\n if complete_mode !=# 'eval' && complete_mode !=# 'function'\n return\n endif\n\n if py3eval( 'ycm_state.ResolveCompletionItem( vim.eval( \"a:item\" ) )' )\n call s:StopPoller( s:pollers.completion )\n call timer_start( 0, function( 's:PollResolve', [ a:item ] ) )\n else\n call s:ShowInfoPopup( a:item )\n endif\nendfunction\n\n\nfunction! s:EnableAutoHover()\n if g:ycm_auto_hover ==# 'CursorHold' && s:enable_hover\n augroup YcmBufHover\n autocmd! * \n autocmd CursorHold call s:Hover()\n if exists( '##WinResized' )\n autocmd WinResized call popup_close( s:cursorhold_popup )\n endif\n if exists( '##WinScrolled' )\n autocmd WinScrolled call popup_close( s:cursorhold_popup )\n endif\n augroup END\n endif\nendfunction\n\n\nfunction! s:DisableAutoHover()\n augroup YcmBufHover\n autocmd! * \n augroup END\nendfunction\n\n\nfunction! s:OnFileTypeSet()\n \" The contents of the command-line window are empty when the filetype is set\n \" for the first time. Users should never change its filetype so we only rely\n \" on the CmdwinEnter event for that window.\n if !empty( getcmdwintype() )\n return\n endif\n\n if !s:AllowedToCompleteInCurrentBuffer()\n return\n endif\n\n call s:SetUpCompleteopt()\n call s:EnableCompletingInCurrentBuffer()\n call s:StartMessagePoll()\n call s:EnableAutoHover()\n\n py3 ycm_state.OnFileTypeSet()\n call s:OnFileReadyToParse( 1 )\nendfunction\n\n\nfunction! s:OnFileSave()\n let buffer_number = str2nr( expand( '' ) )\n if !s:AllowedToCompleteInBuffer( buffer_number )\n return\n endif\n py3 ycm_state.OnFileSave( vimsupport.GetIntValue( 'buffer_number' ) )\nendfunction\n\n\nfunction! s:AbortAutohoverRequest() abort\n if g:ycm_auto_hover ==# 'CursorHold' && s:enable_hover\n let requests = copy( s:pollers.command.requests )\n for request_id in keys( requests )\n let request = requests[ request_id ]\n if request.origin == 'autohover'\n call remove( s:pollers.command.requests, request_id )\n py3 ycm_state.FlushCommandRequest( int( vim.eval( \"request_id\" ) ) )\n call request.callback( '' )\n endif\n endfor\n endif\nendfunction\n\n\nfunction! s:OnBufferEnter()\n call s:StartMessagePoll()\n if !s:VisitedBufferRequiresReparse()\n return\n endif\n\n call s:AbortAutohoverRequest()\n\n call s:SetUpCompleteopt()\n call s:EnableCompletingInCurrentBuffer()\n\n py3 ycm_state.UpdateMatches()\n py3 ycm_state.OnBufferVisit()\n \" Last parse may be outdated because of changes from other buffers. Force a\n \" new parse.\n call s:OnFileReadyToParse( 1 )\nendfunction\n\n\nfunction! s:OnBufferUnload()\n \" Expanding returns the unloaded buffer number as a string but we want\n \" it as a true number for the getbufvar function.\n let buffer_number = str2nr( expand( '' ) )\n if !s:AllowedToCompleteInBuffer( buffer_number )\n return\n endif\n\n py3 ycm_state.OnBufferUnload( vimsupport.GetIntValue( 'buffer_number' ) )\nendfunction\n\n\nfunction! s:PollServerReady( timer_id )\n if !py3eval( 'ycm_state.IsServerAlive()' )\n py3 ycm_state.NotifyUserIfServerCrashed()\n \" Server crashed. Don't poll it again.\n return\n endif\n\n if !py3eval( 'ycm_state.CheckIfServerIsReady()' )\n let s:pollers.server_ready.id = timer_start(\n \\ s:pollers.server_ready.wait_milliseconds,\n \\ function( 's:PollServerReady' ) )\n return\n endif\n\n call s:OnFileTypeSet()\nendfunction\n\n\nfunction! s:OnFileReadyToParse( ... )\n \" Accepts an optional parameter that is either 0 or 1. If 1, send a\n \" FileReadyToParse event notification, whether the buffer has changed or not;\n \" effectively forcing a parse of the buffer. Default is 0.\n let force_parsing = a:0 > 0 && a:1\n\n \" We only want to send a new FileReadyToParse event notification if the buffer\n \" has changed since the last time we sent one, or if forced.\n if force_parsing || py3eval( \"ycm_state.NeedsReparse()\" )\n \" We switched buffers or something, so clear.\n \" FIXME: sig help should be buffer local?\n call s:ClearSignatureHelp()\n py3 ycm_state.OnFileReadyToParse()\n\n call s:StopPoller( s:pollers.file_parse_response )\n let s:pollers.file_parse_response.id = timer_start(\n \\ s:pollers.file_parse_response.wait_milliseconds,\n \\ function( 's:PollFileParseResponse' ) )\n\n call s:UpdateSemanticHighlighting( bufnr(), 1, 0 )\n call s:UpdateInlayHints( bufnr(), 1, 0 )\n\n endif\nendfunction\n\nfunction! s:UpdateSemanticHighlighting( bufnr, force, redraw_anyway ) abort\n call s:StopPoller( s:pollers.semantic_highlighting )\n if !s:is_neovim &&\n \\ get( b:, 'ycm_enable_semantic_highlighting',\n \\ get( g:, 'ycm_enable_semantic_highlighting', 0 ) )\n\n if py3eval(\n \\ 'ycm_state.Buffer( int( vim.eval( \"a:bufnr\" ) ) ).'\n \\ . 'semantic_highlighting.Request( '\n \\ . ' force=int( vim.eval( \"a:force\" ) ) )' )\n let s:pollers.semantic_highlighting.id = timer_start(\n \\ s:pollers.semantic_highlighting.wait_milliseconds,\n \\ function( 's:PollSemanticHighlighting', [ a:bufnr ] ) )\n elseif a:redraw_anyway\n py3 ycm_state.Buffer(\n \\ int( vim.eval( \"a:bufnr\" ) ) ).semantic_highlighting.Refresh()\n endif\n endif\nendfunction\n\n\nfunction s:ShouldUseInlayHintsNow( bufnr )\n return s:enable_inlay_hints &&\n \\ getbufvar( a:bufnr, 'ycm_enable_inlay_hints',\n \\ get( g:, 'ycm_enable_inlay_hints', 0 ) )\nendfunction\n\nfunction! s:UpdateInlayHints( bufnr, force, redraw_anyway ) abort\n call s:StopPoller( s:pollers.inlay_hints )\n\n if s:ShouldUseInlayHintsNow( a:bufnr )\n if py3eval(\n \\ 'ycm_state.Buffer( int( vim.eval( \"a:bufnr\" ) ) ).'\n \\ . 'inlay_hints.Request( force=int( vim.eval( \"a:force\" ) ) )' )\n let s:pollers.inlay_hints.id = timer_start(\n \\ s:pollers.inlay_hints.wait_milliseconds,\n \\ function( 's:PollInlayHints', [ a:bufnr ] ) )\n elseif a:redraw_anyway\n py3 ycm_state.Buffer( int( vim.eval( \"a:bufnr\" ) ) ).inlay_hints.Refresh()\n endif\n\n endif\nendfunction\n\n\nfunction! s:PollFileParseResponse( ... )\n if !py3eval( \"ycm_state.FileParseRequestReady()\" )\n let s:pollers.file_parse_response.id = timer_start(\n \\ s:pollers.file_parse_response.wait_milliseconds,\n \\ function( 's:PollFileParseResponse' ) )\n return\n endif\n\n py3 ycm_state.HandleFileParseRequest()\n if py3eval( \"ycm_state.ShouldResendFileParseRequest()\" )\n call s:OnFileReadyToParse( 1 )\n endif\nendfunction\n\n\nfunction! s:PollSemanticHighlighting( bufnr, ... ) abort\n return s:PollScrollable( a:bufnr, 'semantic_highlighting' )\nendfunction\n\n\nfunction! s:PollInlayHints( bufnr, ... ) abort\n return s:PollScrollable( a:bufnr, 'inlay_hints' )\nendfunction\n\n\nfunction! s:PollScrollable( bufnr, scrollable, ... ) abort\n if !py3eval(\n \\ 'ycm_state.Buffer( int( vim.eval( \"a:bufnr\" ) ) )'\n \\ . '.' . a:scrollable . '.Ready()' )\n let s:pollers[a:scrollable].id = timer_start(\n \\ s:pollers[a:scrollable].wait_milliseconds,\n \\ function( 's:PollScrollable', [ a:bufnr, a:scrollable ] ) )\n elseif ! py3eval(\n \\ 'ycm_state.Buffer( int( vim.eval( \"a:bufnr\" ) ) )'\n \\ . '.' . a:scrollable . '.Update()' )\n let s:pollers[ a:scrollable ].id = timer_start(\n \\ s:pollers[ a:scrollable ].wait_milliseconds,\n \\ function( 's:PollScrollable', [ a:bufnr, a:scrollable ] ) )\n endif\nendfunction\n\n\n\nfunction! s:SendKeys( keys )\n \" By default keys are added to the end of the typeahead buffer. If there are\n \" already keys in the buffer, they will be processed first and may change\n \" the state that our keys combination was sent for (e.g. in\n \" normal mode instead of insert mode or outside of completion mode).\n \" We avoid that by inserting the keys at the start of the typeahead buffer\n \" with the 'i' option. Also, we don't want the keys to be remapped to\n \" something else so we add the 'n' option.\n call feedkeys( a:keys, 'in' )\nendfunction\n\n\nfunction! s:CloseCompletionMenu()\n if pumvisible()\n call s:SendKeys( \"\\\" )\n endif\nendfunction\n\n\nfunction! s:OnInsertChar()\n if !s:AllowedToCompleteInCurrentBuffer()\n return\n endif\n\n let s:last_char_inserted_by_user = v:true\nendfunction\n\n\nfunction! s:StopCompletion( key )\n call s:StopPoller( s:pollers.completion )\n\n call s:ClearSignatureHelp()\n\n if pumvisible()\n let s:completion_stopped = 1\n return \"\\\"\n endif\n return a:key\nendfunction\n\n\nfunction! s:OnCursorMovedNormalMode()\n if !s:AllowedToCompleteInCurrentBuffer()\n return\n endif\n\n call s:AbortAutohoverRequest()\n\n py3 ycm_state.OnCursorMoved()\nendfunction\n\n\nfunction! s:OnWinScrolled()\n if !s:AllowedToCompleteInCurrentBuffer()\n return\n endif\n let bufnr = winbufnr( expand( '' ) )\n call s:UpdateSemanticHighlighting( bufnr, 0, 0 )\n call s:UpdateInlayHints( bufnr, 0, 0 )\nendfunction\n\n\nfunction! s:OnTextChangedNormalMode()\n if !s:AllowedToCompleteInCurrentBuffer()\n return\n endif\n\n call s:OnFileReadyToParse()\nendfunction\n\n\nfunction! s:OnTextChangedInsertMode( popup_is_visible )\n if !s:AllowedToCompleteInCurrentBuffer()\n return\n endif\n\n if a:popup_is_visible && !s:last_char_inserted_by_user\n \" If the last \"input\" wasn't from a user typing (i.e. didn't come from\n \" InsertCharPre, then ignore this change in the text. This prevents ctrl-n\n \" or tab from causing us to re-filter the list based on the now-selected\n \" item.\n return\n endif\n\n let s:current_cursor_position = getpos( '.' )\n if s:completion_stopped\n let s:completion_stopped = 0\n let s:completion = s:default_completion\n return\n endif\n\n call s:IdentifierFinishedOperations()\n\n \" We have to make sure we correctly leave semantic mode even when the user\n \" inserts something like a \"operator[]\" candidate string which fails\n \" CurrentIdentifierFinished check.\n if s:force_semantic && !py3eval( 'base.LastEnteredCharIsIdentifierChar()' )\n let s:force_semantic = 0\n let s:force_manual = 0\n endif\n\n if get( b:, 'ycm_completing' ) &&\n \\ ( g:ycm_auto_trigger || s:force_semantic || s:force_manual ) &&\n \\ !s:InsideCommentOrStringAndShouldStop() &&\n \\ !s:OnBlankLine()\n call s:RequestCompletion()\n call s:RequestSignatureHelp()\n endif\n\n py3 ycm_state.OnCursorMoved()\n\n if g:ycm_autoclose_preview_window_after_completion\n call s:ClosePreviewWindowIfNeeded()\n endif\nendfunction\n\n\nfunction! s:OnInsertEnter() abort\n let s:current_cursor_position = getpos( '.' )\n py3 ycm_state.OnInsertEnter()\n if s:ShouldUseInlayHintsNow( bufnr() ) &&\n \\ get(g:, 'ycm_clear_inlay_hints_in_insert_mode' )\n py3 ycm_state.CurrentBuffer().inlay_hints.Clear()\n endif\nendfunction\n\nfunction! s:OnInsertLeave()\n if !s:AllowedToCompleteInCurrentBuffer()\n return\n endif\n\n let s:last_char_inserted_by_user = v:false\n\n call s:StopPoller( s:pollers.completion )\n let s:force_semantic = 0\n let s:force_manual = 0\n let s:completion = s:default_completion\n\n call s:OnFileReadyToParse()\n py3 ycm_state.OnInsertLeave()\n if g:ycm_autoclose_preview_window_after_completion ||\n \\ g:ycm_autoclose_preview_window_after_insertion\n call s:ClosePreviewWindowIfNeeded()\n endif\n\n call s:ClearSignatureHelp()\n if s:ShouldUseInlayHintsNow( bufnr() )\n \\ && get( g:, 'ycm_clear_inlay_hints_in_insert_mode' )\n \" We cleared inlay hints on insert enter\n py3 ycm_state.CurrentBuffer().inlay_hints.Refresh()\n endif\nendfunction\n\n\nfunction! s:ClosePreviewWindowIfNeeded()\n let current_buffer_name = bufname('')\n\n \" We don't want to try to close the preview window in special buffers like\n \" \"[Command Line]\"; if we do, Vim goes bonkers. Special buffers always start\n \" with '['.\n if current_buffer_name[ 0 ] == '['\n return\n endif\n\n \" This command does the actual closing of the preview window. If no preview\n \" window is shown, nothing happens.\n pclose\nendfunction\n\n\nfunction! s:IdentifierFinishedOperations()\n if !py3eval( 'base.CurrentIdentifierFinished()' )\n return\n endif\n py3 ycm_state.OnCurrentIdentifierFinished()\n let s:force_semantic = 0\n let s:force_manual = 0\n let s:completion = s:default_completion\nendfunction\n\n\n\" Returns 1 when inside comment and 2 when inside string\nfunction! s:InsideCommentOrString()\n \" Has to be col('.') -1 because col('.') doesn't exist at this point. We are\n \" in insert mode when this func is called.\n let syntax_group = synIDattr(\n \\ synIDtrans( synID( line( '.' ), col( '.' ) - 1, 1 ) ), 'name')\n\n if stridx(syntax_group, 'Comment') > -1\n return 1\n endif\n\n if stridx(syntax_group, 'String') > -1\n return 2\n endif\n\n return 0\nendfunction\n\n\nfunction! s:InsideCommentOrStringAndShouldStop()\n let retval = s:InsideCommentOrString()\n let inside_comment = retval == 1\n let inside_string = retval == 2\n\n if inside_comment && g:ycm_complete_in_comments ||\n \\ inside_string && g:ycm_complete_in_strings\n return 0\n endif\n\n return retval\nendfunction\n\n\nfunction! s:OnBlankLine()\n return py3eval( 'not vim.current.line or vim.current.line.isspace()' )\nendfunction\n\n\nfunction! s:RequestCompletion()\n call s:StopPoller( s:pollers.completion )\n\n py3 ycm_state.SendCompletionRequest(\n \\ vimsupport.GetBoolValue( 's:force_semantic' ) )\n\n if py3eval( 'ycm_state.CompletionRequestReady()' )\n \" We can't call complete() synchronously in the TextChangedI/TextChangedP\n \" autocommands (it's designed to be used async only completion). The result\n \" (somewhat oddly) is that the completion menu is shown, but ctrl-n doesn't\n \" actually select anything.\n \" When the request is satisfied synchronously (e.g. the omnicompleter), we\n \" must return to the main loop before triggering completion, so we use a 0ms\n \" timer for that.\n let s:pollers.completion.id = timer_start( 0,\n \\ function( 's:PollCompletion' ) )\n else\n \" Otherwise, use our usual poll timeout\n call s:PollCompletion()\n endif\nendfunction\n\nfunction! s:ManuallyRequestCompletion() abort\n \" Since this function is called in a mapping through the expression register\n \" =, its return value is inserted (see :h c_CTRL-R_=). We don't want to\n \" insert anything so we return an empty string.\n\n if !s:AllowedToCompleteInCurrentBuffer()\n return ''\n endif\n\n if get( b:, 'ycm_completing' )\n let s:force_manual = 0\n call s:RequestCompletion()\n call s:RequestSignatureHelp()\n endif\n\n return ''\nendfunction\n\nfunction! s:SetCompleteFunc()\n let &completefunc = 'youcompleteme#CompleteFunc'\nendfunction\n\nfunction! youcompleteme#CompleteFunc( findstart, base ) abort\n call s:ManuallyRequestCompletion()\n \" Cancel, but silently stay in completion mode.\n return -2\nendfunction\n\ninoremap (YCMComplete) =ManuallyRequestCompletion()\n\nfunction! s:RequestSemanticCompletion() abort\n if !s:AllowedToCompleteInCurrentBuffer()\n return ''\n endif\n\n if get( b:, 'ycm_completing' )\n let s:force_semantic = 1\n let s:current_cursor_position = getpos( '.' )\n call s:StopPoller( s:pollers.completion )\n py3 ycm_state.SendCompletionRequest( True )\n\n if py3eval( 'ycm_state.CompletionRequestReady()' )\n \" We can't call complete() synchronously in the TextChangedI/TextChangedP\n \" autocommands (it's designed to be used async only completion). The\n \" result (somewhat oddly) is that the completion menu is shown, but ctrl-n\n \" doesn't actually select anything. When the request is satisfied\n \" synchronously (e.g. the omnicompleter), we must return to the main loop\n \" before triggering completion, so we use a 0ms timer for that.\n let s:pollers.completion.id = timer_start(\n \\ 0,\n \\ function( 's:PollCompletion' ) )\n else\n \" Otherwise, use our usual poll timeout\n call s:PollCompletion()\n endif\n endif\n\n \" Since this function is called in a mapping through the expression register\n \" =, its return value is inserted (see :h c_CTRL-R_=). We don't want to\n \" insert anything so we return an empty string.\n return ''\nendfunction\n\n\nfunction! s:PollCompletion( ... )\n if !py3eval( 'ycm_state.CompletionRequestReady()' )\n let s:pollers.completion.id = timer_start(\n \\ s:pollers.completion.wait_milliseconds,\n \\ function( 's:PollCompletion' ) )\n return\n endif\n\n let s:completion = py3eval( 'ycm_state.GetCompletionResponse()' )\n if s:current_cursor_position == getpos( '.' )\n call s:Complete()\n endif\nendfunction\n\n\nfunction! s:PollResolve( item, ... )\n if !py3eval( 'ycm_state.CompletionRequestReady()' )\n let s:pollers.completion.id = timer_start(\n \\ s:pollers.completion.wait_milliseconds,\n \\ function( 's:PollResolve', [ a:item ] ) )\n return\n endif\n\n \" Note we re-use the 'completion' request for resolves. This prevents us\n \" sending a completion request and a resolve request at the same time, as\n \" resolve requests re-use the request data from the last completion request\n \" and it must not change.\n \" We also re-use the poller, so that any new completion request effectively\n \" cancels this poller.\n let completion_item =\n \\ py3eval( 'ycm_state.GetCompletionResponse()[ \"completion\" ]' )\n if empty( completion_item ) || empty( completion_item.info )\n return\n endif\n\n call s:ShowInfoPopup( completion_item )\nendfunction\n\nfunction! s:ShowInfoPopup( completion_item )\n let id = popup_findinfo()\n if id\n call popup_settext( id, split( a:completion_item.info, '\\n' ) )\n call popup_show( id )\n endif\nendfunction\n\n\nfunction! s:ShouldUseSignatureHelp()\n return py3eval( 'vimsupport.VimSupportsPopupWindows()' )\nendfunction\n\n\nfunction! s:RequestSignatureHelp()\n if !s:ShouldUseSignatureHelp()\n return\n endif\n\n call s:StopPoller( s:pollers.signature_help )\n\n if py3eval( 'ycm_state.SendSignatureHelpRequest()' )\n call s:PollSignatureHelp()\n endif\nendfunction\n\n\nfunction! s:PollSignatureHelp( ... )\n if !s:ShouldUseSignatureHelp()\n return\n endif\n\n if a:0 == 0 && s:pollers.signature_help.id >= 0\n \" OK this is a bug. We have tried to poll for a response while the timer is\n \" already running. Just return and wait for the timer to fire.\n return\n endif\n\n if !py3eval( 'ycm_state.SignatureHelpRequestReady()' )\n let s:pollers.signature_help.id = timer_start(\n \\ s:pollers.signature_help.wait_milliseconds,\n \\ function( 's:PollSignatureHelp' ) )\n return\n endif\n\n let s:signature_help = py3eval( 'ycm_state.GetSignatureHelpResponse()' )\n call s:UpdateSignatureHelp()\nendfunction\n\nfunction! s:Complete()\n \" It's possible for us to be called (by our timer) when we're not _strictly_\n \" in insert mode. This can happen when mode is temporarily switched, e.g.\n \" due to Ctrl-r or Ctrl-o or a timer or something. If we're not in insert\n \" mode _now_ do nothing (FIXME: or should we queue a timer ?)\n if count( [ 'i', 'R' ], mode() ) == 0\n return\n endif\n\n if s:completion.line != line( '.' )\n \" Given\n \" scb: column where the completion starts before auto-wrapping\n \" cb: cursor column before auto-wrapping\n \" sca: column where the completion starts after auto-wrapping\n \" ca: cursor column after auto-wrapping\n \" we have\n \" ca - sca = cb - scb\n \" sca = scb + ca - cb\n let s:completion.completion_start_column +=\n \\ col( '.' ) - s:completion.column\n endif\n if len( s:completion.completions )\n let old_completeopt = &completeopt\n setlocal completeopt+=noselect\n call complete( s:completion.completion_start_column,\n \\ s:completion.completions )\n let &completeopt = old_completeopt\n elseif pumvisible()\n call s:CloseCompletionMenu()\n endif\nendfunction\n\nfunction! s:UpdateSignatureHelp()\n if !s:ShouldUseSignatureHelp()\n return\n endif\n\n call py3eval(\n \\ 'ycm_state.UpdateSignatureHelp( vim.eval( \"s:signature_help\" ) )' )\nendfunction\n\n\nfunction! s:ClearSignatureHelp()\n if !s:ShouldUseSignatureHelp()\n return\n endif\n\n call s:StopPoller( s:pollers.signature_help )\n let s:signature_help = s:default_signature_help\n call py3eval( 'ycm_state.ClearSignatureHelp()' )\nendfunction\n\n\nfunction! youcompleteme#ServerPid()\n return py3eval( 'ycm_state.ServerPid()' )\nendfunction\n\n\nfunction! s:SetUpCommands()\n command! YcmRestartServer call s:RestartServer()\n command! YcmDebugInfo call s:DebugInfo()\n command! -nargs=* -complete=custom,youcompleteme#LogsComplete -count=0\n \\ YcmToggleLogs call s:ToggleLogs( ,\n \\ ,\n \\ )\n command! -nargs=* -complete=custom,youcompleteme#SubCommandsComplete -range\n \\ YcmCompleter call s:CompleterCommand(,\n \\ ,\n \\ ,\n \\ ,\n \\ )\n command! YcmDiags call s:ShowDiagnostics()\n command! -nargs=? YcmShowDetailedDiagnostic\n \\ call s:ShowDetailedDiagnostic( )\n command! YcmForceCompileAndDiagnostics call s:ForceCompileAndDiagnostics()\nendfunction\n\n\nfunction! s:RestartServer()\n call s:SetUpOptions()\n\n py3 ycm_state.RestartServer()\n\n call s:StopPoller( s:pollers.receive_messages )\n call s:StopPoller( s:pollers.command )\n call s:ClearSignatureHelp()\n\n call s:StopPoller( s:pollers.server_ready )\n let s:pollers.server_ready.id = timer_start(\n \\ s:pollers.server_ready.wait_milliseconds,\n \\ function( 's:PollServerReady' ) )\nendfunction\n\n\nfunction! s:DebugInfo()\n echom \"Printing YouCompleteMe debug information...\"\n let debug_info = py3eval( 'ycm_state.DebugInfo()' )\n echom '-- Resolve completions:'\n \\ ( s:resolve_completions == s:RESOLVE_ON_DEMAND ? 'On demand' :\n \\ s:resolve_completions == s:RESOLVE_UP_FRONT ? 'Up front' :\n \\ 'Never' )\n for line in split( debug_info, \"\\n\" )\n echom '-- ' . line\n endfor\nendfunction\n\n\nfunction! s:ToggleLogs( count, ... )\n py3 ycm_state.ToggleLogs( vimsupport.GetIntValue( 'a:count' ),\n \\ *vim.eval( 'a:000' ) )\nendfunction\n\n\nfunction! youcompleteme#LogsComplete( arglead, cmdline, cursorpos )\n return join( py3eval( 'list( ycm_state.GetLogfiles() )' ), \"\\n\" )\nendfunction\n\n\nfunction! youcompleteme#GetCommandResponse( ... ) abort\n if !s:AllowedToCompleteInCurrentBuffer()\n return ''\n endif\n\n if !get( b:, 'ycm_completing' )\n return ''\n endif\n\n return py3eval( 'ycm_state.GetCommandResponse( vim.eval( \"a:000\" ) )' )\nendfunction\n\n\nfunction! s:GetCommandResponseAsyncImpl( callback, origin, ... ) abort\n let request_id = py3eval(\n \\ 'ycm_state.SendCommandRequestAsync( vim.eval( \"a:000\" ) )' )\n\n let s:pollers.command.requests[ request_id ] = {\n \\ 'response_func': 'StringResponse',\n \\ 'origin': a:origin,\n \\ 'callback': a:callback\n \\ }\n if s:pollers.command.id == -1\n let s:pollers.command.id = timer_start( s:pollers.command.wait_milliseconds,\n \\ function( 's:PollCommands' ) )\n endif\nendfunction\n\n\nfunction! youcompleteme#GetCommandResponseAsync( callback, ... ) abort\n if !s:AllowedToCompleteInCurrentBuffer()\n eval a:callback( '' )\n return\n endif\n\n if !get( b:, 'ycm_completing' )\n eval a:callback( '' )\n return\n endif\n\n call s:GetCommandResponseAsyncImpl( callback, 'extern', a:000 )\nendfunction\n\n\nfunction! youcompleteme#GetRawCommandResponseAsync( callback, ... ) abort\n if !s:AllowedToCompleteInCurrentBuffer()\n eval a:callback( { 'error': 'ycm not allowed in buffer' } )\n return\n endif\n\n if !get( b:, 'ycm_completing' )\n eval a:callback( { 'error': 'ycm disabled in buffer' } )\n return\n endif\n\n let request_id = py3eval(\n \\ 'ycm_state.SendCommandRequestAsync( vim.eval( \"a:000\" ) )' )\n\n let s:pollers.command.requests[ request_id ] = {\n \\ 'response_func': 'Response',\n \\ 'origin': 'extern_raw',\n \\ 'callback': a:callback\n \\ }\n if s:pollers.command.id == -1\n let s:pollers.command.id = timer_start( s:pollers.command.wait_milliseconds,\n \\ function( 's:PollCommands' ) )\n endif\nendfunction\n\n\nfunction! s:PollCommands( timer_id ) abort\n \" Clear the timer id before calling the callback, as the callback might fire\n \" more requests\n call s:StopPoller( s:pollers.command )\n\n \" Must copy the requests because this loop is likely to modify it\n let requests = copy( s:pollers.command.requests )\n let poll_again = 0\n for request_id in keys( requests )\n let request = requests[ request_id ]\n if py3eval( 'ycm_state.GetCommandRequest( int( vim.eval( \"request_id\" ) ) )'\n \\ . 'is None' )\n \" Possible in case of race conditions and things like RestartServer\n \" But particularly in the tests\n let result = v:none\n elseif !py3eval( 'ycm_state.GetCommandRequest( '\n \\ . 'int( vim.eval( \"request_id\" ) ) ).Done()' )\n \" Not ready yet, poll again and skip this one for now\n let poll_again = 1\n continue\n else\n let result = py3eval( 'ycm_state.GetCommandRequest( '\n \\ . 'int( vim.eval( \"request_id\" ) ) ).'\n \\ . request.response_func\n \\ . '()' )\n endif\n\n \" This request is done\n call remove( s:pollers.command.requests, request_id )\n py3 ycm_state.FlushCommandRequest( int( vim.eval( \"request_id\" ) ) )\n call request[ 'callback' ]( result )\n endfor\n\n if poll_again && s:pollers.command.id == -1\n let s:pollers.command.id = timer_start( s:pollers.command.wait_milliseconds,\n \\ function( 's:PollCommands' ) )\n endif\nendfunction\n\n\nfunction! s:CompleterCommand( mods, count, line1, line2, ... )\n py3 ycm_state.SendCommandRequest(\n \\ vim.eval( 'a:000' ),\n \\ vim.eval( 'a:mods' ),\n \\ vimsupport.GetBoolValue( 'a:count != -1' ),\n \\ vimsupport.GetIntValue( 'a:line1' ),\n \\ vimsupport.GetIntValue( 'a:line2' ) )\nendfunction\n\n\nfunction! youcompleteme#SubCommandsComplete( arglead, cmdline, cursorpos )\n return join( py3eval( 'ycm_state.GetDefinedSubcommands()' ), \"\\n\" )\nendfunction\n\n\nfunction! youcompleteme#GetDefinedSubcommands()\n if !s:AllowedToCompleteInCurrentBuffer()\n return []\n endif\n\n if !exists( 'b:ycm_completing' )\n return []\n endif\n\n return py3eval( 'ycm_state.GetDefinedSubcommands()' )\nendfunction\n\n\nfunction! youcompleteme#OpenGoToList()\n py3 vimsupport.PostVimMessage(\n \\ \"'WARNING: youcompleteme#OpenGoToList function is deprecated. \" .\n \\ \"Do NOT use it.'\" )\n py3 vimsupport.OpenQuickFixList( True, True )\nendfunction\n\n\nfunction! s:ShowDiagnostics()\n py3 ycm_state.ShowDiagnostics()\nendfunction\n\n\nfunction! s:ShowDetailedDiagnostic( ... )\n if ( a:0 && a:1 == 'popup' )\n \\ || get( g:, 'ycm_show_detailed_diag_in_popup', 0 )\n py3 ycm_state.ShowDetailedDiagnostic( True )\n else\n py3 ycm_state.ShowDetailedDiagnostic( False )\n endif\nendfunction\n\n\nfunction! s:ForceCompileAndDiagnostics()\n py3 ycm_state.ForceCompileAndDiagnostics()\nendfunction\n\n\nif exists( '*popup_atcursor' )\n function s:Hover()\n if !py3eval( 'ycm_state.NativeFiletypeCompletionUsable()' )\n \" Cancel the autocommand if it happens to have been set\n call s:DisableAutoHover()\n return\n endif\n\n if !has_key( b:, 'ycm_hover' )\n let cmds = youcompleteme#GetDefinedSubcommands()\n if index( cmds, 'GetHover' ) >= 0\n let b:ycm_hover = {\n \\ 'command': 'GetHover',\n \\ 'syntax': 'markdown',\n \\ }\n elseif index( cmds, 'GetDoc' ) >= 0\n let b:ycm_hover = {\n \\ 'command': 'GetDoc',\n \\ 'syntax': '',\n \\ }\n elseif index( cmds, 'GetType' ) >= 0\n let b:ycm_hover = {\n \\ 'command': 'GetType',\n \\ 'syntax': &syntax,\n \\ }\n else\n let b:ycm_hover = {}\n endif\n endif\n\n if empty( b:ycm_hover )\n return\n endif\n\n if empty( popup_getpos( s:cursorhold_popup ) )\n call s:GetCommandResponseAsyncImpl(\n \\ function( 's:ShowHoverResult' ),\n \\ 'autohover',\n \\ b:ycm_hover.command )\n endif\n endfunction\n\n\n function! s:ShowHoverResult( response )\n call popup_hide( s:cursorhold_popup )\n\n if empty( a:response ) || !exists( 'b:ycm_hover' )\n return\n endif\n\n \" Try to position the popup at the cursor, but avoid wrapping. If the\n \" longest line is > screen width (&columns), then we just have to wrap, and\n \" place the popup at the leftmost column.\n \"\n \" Find the longest line (FIXME: probably doesn't work well for multi-byte)\n let lines = split( a:response, \"\\n\" )\n let len = max( map( copy( lines ), \"len( v:val )\" ) )\n\n let wrap = 0\n let col = 'cursor'\n\n \" max width is screen columns minus x padding (2)\n if len >= (&columns - 2)\n \" There's at least one line > our max - enable word wrap and draw the\n \" popup at the leftmost column\n let col = 1\n let wrap = 1\n endif\n\n let popup_params = {\n \\ 'col': col,\n \\ 'wrap': wrap,\n \\ 'padding': [ 0, 1, 0, 1 ],\n \\ 'moved': 'word',\n \\ 'maxwidth': &columns,\n \\ 'close': 'click',\n \\ 'fixed': 0,\n \\ }\n\n if has_key( b:ycm_hover, 'popup_params' )\n let popup_params = extend( copy( popup_params ),\n \\ b:ycm_hover.popup_params )\n endif\n\n let s:cursorhold_popup = popup_atcursor( lines, popup_params )\n call setbufvar( winbufnr( s:cursorhold_popup ),\n \\ '&syntax',\n \\ b:ycm_hover.syntax )\n endfunction\n\n\n function! s:ToggleHover()\n let pos = popup_getpos( s:cursorhold_popup )\n if !empty( pos ) && pos.visible\n call popup_hide( s:cursorhold_popup )\n let s:cursorhold_popup = -1\n\n \" Disable the auto-trigger until the next cursor movement.\n call s:DisableAutoHover()\n augroup YCMHover\n autocmd! CursorMoved \n autocmd CursorMoved call s:EnableAutoHover()\n augroup END\n else\n call s:Hover()\n endif\n endfunction\n\n let s:enable_hover = 1\n nnoremap (YCMHover) :call ToggleHover()\nelse\n \" Don't break people's mappings if this feature is disabled, just do nothing.\n nnoremap (YCMHover) \nendif\n\nfunction! youcompleteme#Test_GetPollers()\n return s:pollers\nendfunction\n\nfunction! s:ToggleSignatureHelp()\n call py3eval( 'ycm_state.ToggleSignatureHelp()' )\n \" Because we do this in a insert-mode mapping, we return empty string to\n \" insert/type nothing\n return ''\nendfunction\n\nsilent! inoremap (YCMToggleSignatureHelp)\n \\ =ToggleSignatureHelp()\n\nfunction! s:ToggleInlayHints()\n let b:ycm_enable_inlay_hints =\n \\ !get( b:,\n \\ 'ycm_enable_inlay_hints',\n \\ get( g:, 'ycm_enable_inlay_hints' ) )\n\n if !b:ycm_enable_inlay_hints && s:enable_inlay_hints\n py3 ycm_state.CurrentBuffer().inlay_hints.Clear()\n else\n call s:UpdateInlayHints( bufnr(), 0, 1 )\n endif\nendfunction\n\nsilent! nnoremap (YCMToggleInlayHints)\n \\ call ToggleInlayHints()\n\nsilent! nnoremap (YCMTypeHierarchy)\n \\ call youcompleteme#hierarchy#StartRequest( 'type' )\nsilent! nnoremap (YCMCallHierarchy)\n \\ call youcompleteme#hierarchy#StartRequest( 'call' )\n\n\" This is basic vim plugin boilerplate\nlet &cpo = s:save_cpo\nunlet s:save_cpo\n" }, { "path": "codecov.yml", "content": "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 # Learn more at https://codecov.io/docs#yaml_default_commit_status\n project: true\n patch: true\n changes: true\n\n # We don't want statistics for the tests themselves.\n ignore:\n - .*/tests/.*\n\ncomment:\n layout: \"header, diff, changes, uncovered\"\n behavior: default # update if exists else create new\n" }, { "path": "doc/youcompleteme.txt", "content": "*youcompleteme* YouCompleteMe: a code-completion engine for Vim\n\n===============================================================================\nContents ~\n\n 1. Introduction |youcompleteme-introduction|\n 1. Help, Advice, Support |youcompleteme-help-advice-support|\n 2. Vundle |youcompleteme-vundle|\n 1. Contents |youcompleteme-contents|\n 2. Intro |youcompleteme-intro|\n 3. Installation |youcompleteme-installation|\n 1. Requirements |youcompleteme-requirements|\n 1. Supported Vim Versions |youcompleteme-supported-vim-versions|\n 2. Supported Python runtime |youcompleteme-supported-python-runtime|\n 3. Supported Compilers |youcompleteme-supported-compilers|\n 4. Individual completer requirements |youcompleteme-individual-completer-requirements|\n 2. macOS |youcompleteme-macos|\n 1. Quick start, installing all completers |youcompleteme-quick-start-installing-all-completers|\n 2. Explanation for the quick start |youcompleteme-explanation-for-quick-start|\n 3. Linux 64-bit |youcompleteme-linux-64-bit|\n 1. Quick start, installing all completers\n 2. Explanation for the quick start\n 4. Windows |youcompleteme-windows|\n 1. Quick start, installing all completers\n 2. Explanation for the quick start\n 5. Full Installation Guide |youcompleteme-full-installation-guide|\n 4. Quick Feature Summary |youcompleteme-quick-feature-summary|\n 1. General (all languages) |youcompleteme-general|\n 2. C-family languages (C, C++, Objective C, Objective C++, CUDA) |youcompleteme-c-family-languages|\n 3. C♯ |youcompleteme-c|\n 4. Python |youcompleteme-python|\n 5. Go |youcompleteme-go|\n 6. JavaScript and TypeScript |youcompleteme-javascript-typescript|\n 7. Rust |youcompleteme-rust|\n 8. Java |youcompleteme-java|\n 5. User Guide |youcompleteme-user-guide|\n 1. General Usage |youcompleteme-general-usage|\n 2. Client-Server Architecture |youcompleteme-client-server-architecture|\n 3. Completion String Ranking |youcompleteme-completion-string-ranking|\n 4. Signature Help |youcompleteme-signature-help|\n 1. Dismiss signature help |youcompleteme-dismiss-signature-help|\n 5. Semantic highlighting |youcompleteme-semantic-highlighting|\n 1. Customising the highlight groups |youcompleteme-customising-highlight-groups|\n 6. Inlay hints |youcompleteme-inlay-hints|\n 1. Highlight groups |youcompleteme-highlight-groups|\n 2. Options |youcompleteme-options|\n 3. Toggling |youcompleteme-toggling|\n 4. General Semantic Completion |youcompleteme-general-semantic-completion|\n 5. C-family Semantic Completion |youcompleteme-c-family-semantic-completion|\n 1. Installation\n 2. Compile flags |youcompleteme-compile-flags|\n 3. Option 1: Use a compilation database [53] |youcompleteme-option-1-use-compilation-database-53|\n 4. Option 2: Provide the flags manually |youcompleteme-option-2-provide-flags-manually|\n 5. Errors during compilation |youcompleteme-errors-during-compilation|\n 6. Java Semantic Completion |youcompleteme-java-semantic-completion|\n 1. Java Quick Start |youcompleteme-java-quick-start|\n 2. Java Project Files |youcompleteme-java-project-files|\n 3. Diagnostic display - Syntastic |youcompleteme-diagnostic-display-syntastic|\n 4. Diagnostic display - Eclim |youcompleteme-diagnostic-display-eclim|\n 5. Eclipse Projects |youcompleteme-eclipse-projects|\n 6. Maven Projects |youcompleteme-maven-projects|\n 7. Gradle Projects |youcompleteme-gradle-projects|\n 8. Troubleshooting |youcompleteme-troubleshooting|\n 7. C# Semantic Completion |youcompleteme-c-semantic-completion|\n 1. Automatically discovered solution files |youcompleteme-automatically-discovered-solution-files|\n 2. Manually specified solution files |youcompleteme-manually-specified-solution-files|\n 3. Use with .NET 6.0 and .NET SDKs |youcompleteme-use-with-.net-6.0-.net-sdks|\n 8. Python Semantic Completion |youcompleteme-python-semantic-completion|\n 1. Working with virtual environments |youcompleteme-working-with-virtual-environments|\n 2. Working with third-party packages |youcompleteme-working-with-third-party-packages|\n 3. Configuring through Vim options |youcompleteme-configuring-through-vim-options|\n 9. Rust Semantic Completion |youcompleteme-rust-semantic-completion|\n 10. Go Semantic Completion |youcompleteme-go-semantic-completion|\n 11. JavaScript and TypeScript Semantic Completion |youcompleteme-javascript-typescript-semantic-completion|\n 12. Semantic Completion for Other Languages |youcompleteme-semantic-completion-for-other-languages|\n 1. Plugging an arbitrary LSP server |youcompleteme-plugging-an-arbitrary-lsp-server|\n 2. LSP Configuration |youcompleteme-lsp-configuration|\n 3. Using 'omnifunc' for semantic completion |youcompleteme-using-omnifunc-for-semantic-completion|\n 13. Writing New Semantic Completers |youcompleteme-writing-new-semantic-completers|\n 14. Diagnostic Display |youcompleteme-diagnostic-display|\n 1. Diagnostic Highlighting Groups |youcompleteme-diagnostic-highlighting-groups|\n 15. Symbol Search |youcompleteme-symbol-search|\n 1. Closing the popup |youcompleteme-closing-popup|\n 16. Type/Call Hierarchy |youcompleteme-type-call-hierarchy|\n 7. Commands |youcompleteme-commands|\n 1. The |:YcmRestartServer| command\n 2. The |:YcmForceCompileAndDiagnostics| command\n 3. The |:YcmDiags| command\n 4. The |:YcmShowDetailedDiagnostic| command\n 5. The |:YcmDebugInfo| command\n 6. The |:YcmToggleLogs| command\n 7. The |:YcmCompleter| command\n 8. YcmCompleter Subcommands |youcompleteme-ycmcompleter-subcommands|\n 1. GoTo Commands |youcompleteme-goto-commands|\n 1. The |GoToInclude| subcommand\n 2. The |GoToAlternateFile| subcommand\n 3. The |GoToDeclaration| subcommand\n 4. The |GoToDefinition| subcommand\n 5. The |GoTo| subcommand\n 6. The |GoToImprecise| subcommand\n 7. The 'GoToSymbol ' subcommand |GoToSymbol-symbol-query|\n 8. The |GoToReferences| subcommand\n 9. The |GoToImplementation| subcommand\n 10. The |GoToImplementationElseDeclaration| subcommand\n 11. The |GoToType| subcommand\n 12. The |GoToDocumentOutline| subcommand\n 13. The |GoToCallers| and 'GoToCallees' subcommands\n 2. Semantic Information Commands |youcompleteme-semantic-information-commands|\n 1. The |GetType| subcommand\n 2. The |GetTypeImprecise| subcommand\n 3. The |GetParent| subcommand\n 4. The |GetDoc| subcommand\n 5. The |GetDocImprecise| subcommand\n 3. Refactoring Commands |youcompleteme-refactoring-commands|\n 1. The |FixIt| subcommand\n 2. The 'RefactorRename ' subcommand |RefactorRename-new-name|\n 3. Python refactorings |youcompleteme-python-refactorings|\n 4. Multi-file Refactor |youcompleteme-multi-file-refactor|\n 5. The |Format| subcommand\n 6. The |OrganizeImports| subcommand\n 4. Miscellaneous Commands |youcompleteme-miscellaneous-commands|\n 1. The 'ExecuteCommand ' subcommand |ExecuteCommand-args|\n 2. The |RestartServer| subcommand\n 3. The |ReloadSolution| subcommand\n 9. Functions |youcompleteme-functions|\n 1. The |youcompleteme#GetErrorCount| function\n 2. The |youcompleteme#GetWarningCount| function\n 3. The 'youcompleteme#GetCommandResponse( ... )' function |youcompleteme#GetCommandResponse()|\n 4. The 'youcompleteme#GetCommandResponseAsync( callback, ... )' function |youcompleteme#GetCommandResponseAsync()|\n 10. Autocommands |youcompleteme-autocommands|\n 1. The |YcmLocationOpened| autocommand\n 2. The |YcmQuickFixOpened| autocommand\n 11. Options\n 1. The |g:ycm_min_num_of_chars_for_completion| option\n 2. The |g:ycm_min_num_identifier_candidate_chars| option\n 3. The |g:ycm_max_num_candidates| option\n 4. The |g:ycm_max_num_candidates_to_detail| option\n 5. The |g:ycm_max_num_identifier_candidates| option\n 6. The |g:ycm_auto_trigger| option\n 7. The |g:ycm_filetype_whitelist| option\n 8. The |g:ycm_filetype_blacklist| option\n 9. The |g:ycm_filetype_specific_completion_to_disable| option\n 10. The |g:ycm_filepath_blacklist| option\n 11. The |g:ycm_show_diagnostics_ui| option\n 12. The |g:ycm_error_symbol| option\n 13. The |g:ycm_warning_symbol| option\n 14. The |g:ycm_enable_diagnostic_signs| option\n 15. The |g:ycm_enable_diagnostic_highlighting| option\n 16. The |g:ycm_echo_current_diagnostic| option\n 17. The |g:ycm_auto_hover| option\n 18. The |g:ycm_filter_diagnostics| option\n 19. The |g:ycm_always_populate_location_list| option\n 20. The |g:ycm_open_loclist_on_ycm_diags| option\n 21. The |g:ycm_complete_in_comments| option\n 22. The |g:ycm_complete_in_strings| option\n 23. The |g:ycm_collect_identifiers_from_comments_and_strings| option\n 24. The |g:ycm_collect_identifiers_from_tags_files| option\n 25. The |g:ycm_seed_identifiers_with_syntax| option\n 26. The |g:ycm_extra_conf_vim_data| option\n 27. The |g:ycm_server_python_interpreter| option\n 28. The |g:ycm_keep_logfiles| option\n 29. The |g:ycm_log_level| option\n 30. The |g:ycm_auto_start_csharp_server| option\n 31. The |g:ycm_auto_stop_csharp_server| option\n 32. The |g:ycm_csharp_server_port| option\n 33. The |g:ycm_csharp_insert_namespace_expr| option\n 34. The |g:ycm_add_preview_to_completeopt| option\n 35. The |g:ycm_autoclose_preview_window_after_completion| option\n 36. The |g:ycm_autoclose_preview_window_after_insertion| option\n 37. The |g:ycm_max_diagnostics_to_display| option\n 38. The |g:ycm_key_list_select_completion| option\n 39. The |g:ycm_key_list_previous_completion| option\n 40. The |g:ycm_key_list_stop_completion| option\n 41. The |g:ycm_key_invoke_completion| option\n 42. The |g:ycm_key_detailed_diagnostics| option\n 43. The |g:ycm_show_detailed_diag_in_popup| option\n 44. The |g:ycm_global_ycm_extra_conf| option\n 45. The |g:ycm_confirm_extra_conf| option\n 46. The |g:ycm_extra_conf_globlist| option\n 47. The |g:ycm_filepath_completion_use_working_dir| option\n 48. The |g:ycm_semantic_triggers| option\n 49. The |g:ycm_cache_omnifunc| option\n 50. The |g:ycm_use_ultisnips_completer| option\n 51. The |g:ycm_goto_buffer_command| option\n 52. The |g:ycm_disable_for_files_larger_than_kb| option\n 53. The |g:ycm_use_clangd| option\n 54. The |g:ycm_clangd_binary_path| option\n 55. The |g:ycm_clangd_args| option\n 56. The |g:ycm_clangd_uses_ycmd_caching| option\n 57. The |g:ycm_language_server| option\n 58. The |g:ycm_disable_signature_help| option\n 59. The |g:ycm_signature_help_disable_syntax| option\n 60. The |g:ycm_gopls_binary_path| option\n 61. The |g:ycm_gopls_args| option\n 62. The |g:ycm_rls_binary_path| and 'g:ycm_rustc_binary_path' options\n 63. The |g:ycm_rust_toolchain_root| option\n 64. The |g:ycm_tsserver_binary_path| option\n 65. The |g:ycm_roslyn_binary_path| option\n 66. The |g:ycm_update_diagnostics_in_insert_mode| option\n 12. FAQ |youcompleteme-faq|\n 13. Contributor Code of Conduct |youcompleteme-contributor-code-of-conduct|\n 14. Contact |youcompleteme-contact|\n 15. License |youcompleteme-license|\n 16. Sponsorship |youcompleteme-sponsorship|\n 3. References |youcompleteme-references|\n\n===============================================================================\n *youcompleteme-introduction*\nIntroduction ~\n\nImage: Gitter room [1] Image: Build status [3] Image: Coverage status [5]\n\n-------------------------------------------------------------------------------\n *youcompleteme-help-advice-support*\nHelp, Advice, Support ~\n\nLooking for help, advice, or support? Having problems getting YCM to work?\n\nFirst carefully read the installation instructions for your OS. We recommend\nyou use the supplied 'install.py' - the \"full\" installation guide is for rare,\nadvanced use cases and most users should use 'install.py'.\n\nIf the server isn't starting and you're getting a \"YouCompleteMe unavailable\"\nerror, check the Troubleshooting [7] guide.\n\nNext, check the User Guide section on the semantic completer that you are\nusing. For C/C++/Objective-C/Objective-C++/CUDA, you _must_ read this section.\n\nFinally, check the FAQ [8].\n\nIf, after reading the installation and user guides, and checking the FAQ,\nyou're still having trouble, check the contacts section below for how to get in\ntouch.\n\nPlease do **NOT** go to #vim on Freenode for support. Please contact the\nYouCompleteMe maintainers directly using the contact details below.\n\n===============================================================================\n *youcompleteme-vundle*\nVundle ~\n\nPlease note that the below instructions suggest using Vundle. Currently there\nare problems with Vundle, so here are some alternative instructions [9] using\nVim packages.\n\n-------------------------------------------------------------------------------\n *youcompleteme-contents*\nContents ~\n\n- Intro\n- Installation\n\n - Requirements\n - macOS\n - Linux 64-bit\n - Windows\n - Full Installation Guide\n\n- Quick Feature Summary\n- User Guide\n\n - General Usage\n - Client-Server Architecture\n - Completion String Ranking\n - General Semantic Completion\n - Signature Help\n - Semantic Highlighting\n - Inlay Hints\n - C-family Semantic Completion\n - Java Semantic Completion\n - C# Semantic Completion\n - Python Semantic Completion\n - Rust Semantic Completion\n - Go Semantic Completion\n - JavaScript and TypeScript Semantic Completion\n - Semantic Completion for Other Languages\n - LSP Configuration\n - Writing New Semantic Completers\n - Diagnostic Display\n\n - Diagnostic Highlighting Groups\n\n - Symbol Search\n - Type/Call Hierarchy\n\n- Commands\n\n - YcmCompleter subcommands\n\n - GoTo Commands\n - Semantic Information Commands\n - Refactoring Commands\n - Miscellaneous Commands\n\n- Functions\n- Autocommands\n- Options\n- FAQ\n- Contributor Code of Conduct\n- Contact\n- License\n- Sponsorship\n\n-------------------------------------------------------------------------------\n *youcompleteme-intro*\nIntro ~\n\nYouCompleteMe is a fast, as-you-type, fuzzy-search code completion,\ncomprehension and refactoring engine for Vim [10].\n\nIt has several completion engines built-in and supports any protocol-compliant\nLanguage Server, so can work with practically any language. YouCompleteMe\ncontains:\n\n- an identifier-based engine that works with every programming language,\n- a powerful clangd [11]-based engine that provides native semantic code\n completion for C/C++/Objective-C/Objective-C++/CUDA (from now on referred\n to as \"the C-family languages\"),\n- a Jedi [12]-based completion engine for Python 2 and 3,\n- an OmniSharp-Roslyn [13]-based completion engine for C#,\n- a Gopls [14]-based completion engine for Go,\n- a TSServer [15]-based completion engine for JavaScript and TypeScript,\n- a rust-analyzer [16]-based completion engine for Rust,\n- a jdt.ls [17]-based completion engine for Java.\n- a generic Language Server Protocol implementation for any language\n- and an omnifunc-based completer that uses data from Vim's omnicomplete\n system to provide semantic completions for many other languages (Ruby, PHP,\n etc.).\n\n Image: YouCompleteMe GIF completion demo (see reference [18])\n\nHere's an explanation of what happened in the last GIF demo above.\n\nFirst, realize that **no keyboard shortcuts had to be pressed** to get the list\nof completion candidates at any point in the demo. The user just types and the\nsuggestions pop up by themselves. If the user doesn't find the completion\nsuggestions relevant and/or just wants to type, they can do so; the completion\nengine will not interfere.\n\nWhen the user sees a useful completion string being offered, they press the TAB\nkey to accept it. This inserts the completion string. Repeated presses of the\nTAB key cycle through the offered completions.\n\nIf the offered completions are not relevant enough, the user can continue\ntyping to further filter out unwanted completions.\n\nA critical thing to notice is that the completion **filtering is NOT based on\nthe input being a string prefix of the completion** (but that works too). The\ninput needs to be a _subsequence [19] match_ of a completion. This is a fancy\nway of saying that any input characters need to be present in a completion\nstring in the order in which they appear in the input. So 'abc' is a\nsubsequence of 'xaybgc', but not of 'xbyxaxxc'. After the filter, a complicated\nsorting system ranks the completion strings so that the most relevant ones rise\nto the top of the menu (so you usually need to press TAB just once).\n\n**All of the above works with any programming language** because of the\nidentifier-based completion engine. It collects all of the identifiers in the\ncurrent file and other files you visit (and your tags files) and searches them\nwhen you type (identifiers are put into per-filetype groups).\n\nThe demo also shows the semantic engine in use. When the user presses '.', '->'\nor '::' while typing in insert mode (for C++; different triggers are used for\nother languages), the semantic engine is triggered (it can also be triggered\nwith a keyboard shortcut; see the rest of the docs).\n\nThe last thing that you can see in the demo is YCM's diagnostic display\nfeatures (the little red X that shows up in the left gutter; inspired by\nSyntastic [20]) if you are editing a C-family file. As the completer engine\ncompiles your file and detects warnings or errors, they will be presented in\nvarious ways. You don't need to save your file or press any keyboard shortcut\nto trigger this, it \"just happens\" in the background.\n\n**And that's not all...**\n\nYCM might be the only Vim completion engine with the correct Unicode support.\nThough we do assume UTF-8 everywhere.\n\n Image: YouCompleteMe GIF unicode demo (see reference [21])\n\nYCM also provides semantic IDE-like features in a number of languages,\nincluding:\n\n- displaying signature help (argument hints) when entering the arguments to a\n function call (Vim only)\n- finding declarations, definitions, usages, etc. of identifiers, and an\n interactive symbol finder\n- displaying type information for classes, variables, functions etc.,\n- displaying documentation for methods, members, etc. in the preview window,\n or in a popup next to the cursor (Vim only)\n- fixing common coding errors, like missing semi-colons, typos, etc.,\n- semantic renaming of variables across files,\n- formatting code,\n- removing unused imports, sorting imports, etc.\n\nFor example, here's a demo of signature help:\n\n Image: Signature Help Early Demo (see reference [22])\n\nBelow we can see YCM being able to do a few things:\n\n- Retrieve references across files\n- Go to declaration/definition\n- Expand 'auto' in C++\n- Fix some common errors, and provide refactorings, with |FixIt|\n- Not shown in the GIF are |GoToImplementation| and |GoToType| for servers\n that support it.\n\n Image: YouCompleteMe GIF subcommands demo (see reference [23])\n\nAnd here's some documentation being shown in a hover popup, automatically and\nmanually:\n\n Image: hover demo (see reference [24])\n\nFeatures vary by file type, so make sure to check out the file type feature\nsummary and the full list of completer subcommands to find out what's available\nfor your favourite languages.\n\nYou'll also find that YCM has filepath completers (try typing './' in a file)\nand a completer that integrates with UltiSnips [25].\n\n-------------------------------------------------------------------------------\n *youcompleteme-installation*\nInstallation ~\n\n-------------------------------------------------------------------------------\n *youcompleteme-requirements*\nRequirements ~\n\n===============================================================================\n| _Runtime_ | _Min Version_ | _Recommended Version (full support)_ | _Python_ |\n===============================================================================\n| Vim | 9.1.0016 | 9.1.0016 | 3.12 |\n-------------------------------------------------------------------------------\n| Neovim | 0.5 | Vim 9.1.0016 | 3.12 |\n-------------------------------------------------------------------------------\n\n\n-------------------------------------------------------------------------------\n *youcompleteme-supported-vim-versions*\nSupported Vim Versions ~\n\nOur policy is to support the Vim version that's in the latest LTS of Ubuntu.\n\nVim must have a working Python 3 runtime.\n\nFor Neovim users, our policy is to require the latest released version.\nCurrently, Neovim 0.5.0 is required. Please note that some features are not\navailable in Neovim, and Neovim is not officially supported.\n\n-------------------------------------------------------------------------------\n *youcompleteme-supported-python-runtime*\nSupported Python runtime ~\n\nYCM has two components: A server and a client. Both the server and client\nrequire Python 3.12 or later 3.x release.\n\nFor the Vim client, Vim must be, compiled with '--enable-shared' (or\n'--enable-framework' on macOS). You can check if this is working with ':py3\nimport sys; print( sys.version)'. It should say something like '3.12.0 (...)'.\n\nFor Neovim, you must have a python 3.12 runtime and the Neovim python\nextensions. See Neovim's ':help provider-python' for how to set that up.\n\nFor the server, you must run the 'install.py' script with a python 3.12 (or\nlater) runtime. Anaconda etc. are not supported. YCM will remember the runtime\nyou used to run 'install.py' and will use that when launching the server, so if\nyou usually use anaconda, then make sure to use the full path to a real\ncpython3, e.g. '/usr/bin/python3 install.py --all' etc.\n\nOur policy is to support the python3 version that's available in the latest\nUbuntu LTS (similar to our Vim version policy). We don't increase the Python\nruntime version without a reason, though. Typically, we do this when the\ncurrent python version we're using goes out of support. At that time we will\ntypically pick a version that will be supported for a number of years.\n\n-------------------------------------------------------------------------------\n *youcompleteme-supported-compilers*\nSupported Compilers ~\n\nIn order to provide the best possible performance and stability, ycmd has\nupdated its code to C++17. This requires a version bump of the minimum\nsupported compilers. The new requirements are:\n\n===============================\n| _Compiler_ | _Current Min_ |\n===============================\n| GCC | 8 |\n-------------------------------\n| Clang | 7 |\n-------------------------------\n| MSVC | 15.7 (VS 2017) |\n-------------------------------\n\n\nYCM requires CMake 3.13 or greater. If your CMake is too old, you may be able\nto simply 'pip install --user cmake' to get a really new version.\n\n-------------------------------------------------------------------------------\n *youcompleteme-individual-completer-requirements*\nIndividual completer requirements ~\n\nWhen enabling language support for a particular language, there may be runtime\nrequirements, such as needing a very recent Java Development Kit for Java\nsupport. In general, YCM is not in control of the required versions for the\ndownstream compilers, though we do our best to signal where we know them.\n\n-------------------------------------------------------------------------------\n *youcompleteme-macos*\nmacOS ~\n\n-------------------------------------------------------------------------------\n *youcompleteme-quick-start-installing-all-completers*\nQuick start, installing all completers ~\n\n- Install YCM plugin via Vundle [26]\n- Install CMake, MacVim and Python 3; Note that the pre-installed _macOS\n system_ Vim is not supported (due to it having broken Python integration).\n>\n $ brew install cmake python go nodejs\n<\n- Install mono from Mono Project [27] (NOTE: on Intel Macs you can also 'brew\n install mono'. On arm Macs, you may require Rosetta)\n\n- For Java support you must install a JDK, one way to do this is with\n Homebrew:\n>\n $ brew install java\n $ sudo ln -sfn $(brew --prefix java)/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk\n<\n- Pre-installed macOS _system_ Vim does not support Python 3. So you need to\n install either a Vim that supports Python 3 OR MacVim [28] with Homebrew\n [29]:\n\n- Option 1: Installing a Vim that supports Python 3\n>\n brew install vim\n<\n- Option 2: Installing MacVim [28]\n>\n brew install macvim\n<\n- Compile YCM.\n\n- For Intel and arm64 Macs, the bundled libclang/clangd work:\n>\n cd ~/.vim/bundle/YouCompleteMe\n python3 install.py --all\n<\n- If you have troubles with finding system frameworks or C++ standard\n library, try using the homebrew llvm:\n>\n brew install llvm\n cd ~/.vim/bundle/YouCompleteMe\n python3 install.py --system-libclang --all\n<\n And edit your vimrc to add the following line to use the Homebrew llvm's\n clangd:\n>\n \" Use homebrew's clangd\n let g:ycm_clangd_binary_path = trim(system('brew --prefix llvm')).'/bin/clangd'\n<\n- For using an arbitrary LSP server, check the relevant section\n\n-------------------------------------------------------------------------------\n *youcompleteme-explanation-for-quick-start*\nExplanation for the quick start ~\n\nThese instructions (using 'install.py') are the quickest way to install\nYouCompleteMe, however they may not work for everyone. If the following\ninstructions don't work for you, check out the full installation guide.\n\nA supported Vim version with Python 3 is required. MacVim [28] is a good\noption, even if you only use the terminal. YCM won't work with the\npre-installed Vim from Apple as its Python support is broken. If you don't\nalready use a Vim that supports Python 3 or MacVim [28], install it with\nHomebrew [29]. Install CMake as well:\n>\n brew install vim cmake\n<\nOR\n>\n brew install macvim cmake\n<\nInstall YouCompleteMe with Vundle [26].\n\n**Remember:** YCM is a plugin with a compiled component. If you **update** YCM\nusing Vundle and the 'ycm_core' library APIs have changed (happens rarely), YCM\nwill notify you to recompile it. You should then rerun the install process.\n\n**NOTE:** If you want C-family completion, you MUST have the latest Xcode\ninstalled along with the latest Command Line Tools (they are installed\nautomatically when you run 'clang' for the first time, or manually by running\n'xcode-select --install')\n\nCompiling YCM **with** semantic support for C-family languages through\n**clangd**:\n>\n cd ~/.vim/bundle/YouCompleteMe\n ./install.py --clangd-completer\n<\nCompiling YCM **without** semantic support for C-family languages:\n>\n cd ~/.vim/bundle/YouCompleteMe\n ./install.py\n<\nThe following additional language support options are available:\n\n- C# support: install by downloading the Mono macOS package [30] and add\n '--cs-completer' when calling 'install.py'.\n\n- Go support: install Go [31] and add '--go-completer' when calling\n 'install.py'.\n\n- JavaScript and TypeScript support: install Node.js 18+ and npm [32] and add\n '--ts-completer' when calling 'install.py'.\n\n- Rust support: add '--rust-completer' when calling 'install.py'.\n\n- Java support: install JDK 17 [33] and add '--java-completer' when calling\n 'install.py'.\n\nTo simply compile with everything enabled, there's a '--all' flag. So, to\ninstall with all language features, ensure 'xbuild', 'go', 'node' and 'npm'\ntools are installed and in your 'PATH', then simply run:\n>\n cd ~/.vim/bundle/YouCompleteMe\n ./install.py --all\n<\nThat's it. You're done. Refer to the _User Guide_ section on how to use YCM.\nDon't forget that if you want the C-family semantic completion engine to work,\nyou will need to provide the compilation flags for your project to YCM. It's\nall in the User Guide.\n\nYCM comes with sane defaults for its options, but you still may want to take a\nlook at what's available for configuration. There are a few interesting options\nthat are conservatively turned off by default that you may want to turn on.\n\n-------------------------------------------------------------------------------\n *youcompleteme-linux-64-bit*\nLinux 64-bit ~\n\nThe following assume you're using Ubuntu 24.04.\n\n-------------------------------------------------------------------------------\nQuick start, installing all completers ~\n\n- Install YCM plugin via Vundle [26]\n- Install CMake, Vim and Python\n>\n apt install build-essential cmake vim-nox python3-dev\n<\n- Install mono-complete, go, node, java, and npm\n>\n apt install mono-complete golang nodejs openjdk-17-jdk openjdk-17-jre npm\n<\n- Compile YCM\n>\n cd ~/.vim/bundle/YouCompleteMe\n python3 install.py --all\n<\n- For plugging an arbitrary LSP server, check the relevant section\n\n-------------------------------------------------------------------------------\nExplanation for the quick start ~\n\nThese instructions (using 'install.py') are the quickest way to install\nYouCompleteMe, however they may not work for everyone. If the following\ninstructions don't work for you, check out the full installation guide.\n\nMake sure you have a supported version of Vim with Python 3 support and a\nsupported compiler. The latest LTS of Ubuntu is the minimum platform for simple\ninstallation. For earlier releases or other distributions, you may have to do\nsome work to acquire the dependencies.\n\nIf your Vim version is too old, you may need to compile Vim from source [34]\n(don't worry, it's easy).\n\nInstall YouCompleteMe with Vundle [26].\n\n**Remember:** YCM is a plugin with a compiled component. If you **update** YCM\nusing Vundle and the 'ycm_core' library APIs have changed (which happens\nrarely), YCM will notify you to recompile it. You should then rerun the\ninstallation process.\n\nInstall development tools, CMake, and Python headers:\n\n- Fedora-like distributions:\n>\n sudo dnf install cmake gcc-c++ make python3-devel\n<\n- Ubuntu LTS:\n>\n sudo apt install build-essential cmake3 python3-dev\n<\nCompiling YCM **with** semantic support for C-family languages through\n**clangd**:\n>\n cd ~/.vim/bundle/YouCompleteMe\n python3 install.py --clangd-completer\n<\nCompiling YCM **without** semantic support for C-family languages:\n>\n cd ~/.vim/bundle/YouCompleteMe\n python3 install.py\n<\nThe following additional language support options are available:\n\n- C# support: install Mono [35] and add '--cs-completer' when calling\n 'install.py'.\n\n- Go support: install Go [31] and add '--go-completer' when calling\n 'install.py'.\n\n- JavaScript and TypeScript support: install Node.js 18+ and npm [32] and add\n '--ts-completer' when calling 'install.py'.\n\n- Rust support: add '--rust-completer' when calling 'install.py'.\n\n- Java support: install JDK 17 [33] and add '--java-completer' when calling\n 'install.py'.\n\nTo simply compile with everything enabled, there's a '--all' flag. So, to\ninstall with all language features, ensure 'xbuild', 'go', 'node', and 'npm'\ntools are installed and in your 'PATH', then simply run:\n>\n cd ~/.vim/bundle/YouCompleteMe\n python3 install.py --all\n<\nThat's it. You're done. Refer to the _User Guide_ section on how to use YCM.\nDon't forget that if you want the C-family semantic completion engine to work,\nyou will need to provide the compilation flags for your project to YCM. It's\nall in the User Guide.\n\nYCM comes with sane defaults for its options, but you still may want to take a\nlook at what's available for configuration. There are a few interesting options\nthat are conservatively turned off by default that you may want to turn on.\n\n-------------------------------------------------------------------------------\n *youcompleteme-windows*\nWindows ~\n\n**_NOTE_**: Windows support is _deprecated_ and _unmaintained_. We will do our\nbest to keep it working, but we no longer test it in CI and there is a high\nlikelihood of breakages.\n\n-------------------------------------------------------------------------------\nQuick start, installing all completers ~\n\n- Install YCM plugin via Vundle [26]\n- Install Visual Studio Build Tools 2019 [36]\n- Install CMake, Vim and Python\n- Install go, node and npm\n- Compile YCM\n>\n cd YouCompleteMe\n python3 install.py --all\n<\n- Add 'set encoding=utf-8' to your vimrc [37]\n- For plugging an arbitrary LSP server, check the relevant section\n\n-------------------------------------------------------------------------------\nExplanation for the quick start ~\n\nThese instructions (using 'install.py') are the quickest way to install\nYouCompleteMe, however they may not work for everyone. If the following\ninstructions don't work for you, check out the full installation guide.\n\n**Important:** we assume that you are using the 'cmd.exe' command prompt and\nthat you know how to add an executable to the PATH environment variable.\n\nMake sure you have a supported Vim version with Python 3 support. You can check\nthe version and which Python is supported by typing ':version' inside Vim. Look\nat the features included: '+python3/dyn' for Python 3. Take note of the Vim\narchitecture, i.e. 32 or 64-bit. It will be important when choosing the Python\ninstaller. We recommend using a 64-bit client. Daily updated installers of\n32-bit and 64-bit Vim with Python 3 support [38] are available.\n\nAdd the following line to your vimrc [37] if not already present.:\n>\n set encoding=utf-8\n<\nThis option is required by YCM. Note that it does not prevent you from editing\na file in another encoding than UTF-8. You can do that by specifying the\n'|++enc|' argument to the ':e' command.\n\nInstall YouCompleteMe with Vundle [26].\n\n**Remember:** YCM is a plugin with a compiled component. If you **update** YCM\nusing Vundle and the 'ycm_core' library APIs have changed (happens rarely), YCM\nwill notify you to recompile it. You should then rerun the install process.\n\nDownload and install the following software:\n\n- Python 3 [39]. Be sure to pick the version corresponding to your Vim\n architecture. It is _Windows x86_ for a 32-bit Vim and _Windows x86-64_ for\n a 64-bit Vim. We recommend installing Python 3. Additionally, the version\n of Python you install must match up exactly with the version of Python that\n Vim is looking for. Type ':version' and look at the bottom of the page at\n the list of compiler flags. Look for flags that look similar to\n '-DDYNAMIC_PYTHON3_DLL=\\\"python36.dll\\\"'. This indicates that Vim is\n looking for Python 3.6. You'll need one or the other installed, matching\n the version number exactly.\n\n- CMake [40]. Add CMake executable to the PATH environment variable.\n\n- Build Tools for Visual Studio 2019 [36]. During setup, select _C++ build\n tools_ in _Workloads_.\n\nCompiling YCM **with** semantic support for C-family languages through\n**clangd**:\n>\n cd %USERPROFILE%/vimfiles/bundle/YouCompleteMe\n python install.py --clangd-completer\n<\nCompiling YCM **without** semantic support for C-family languages:\n>\n cd %USERPROFILE%/vimfiles/bundle/YouCompleteMe\n python install.py\n<\nThe following additional language support options are available:\n\n- C# support: add '--cs-completer' when calling 'install.py'. Be sure that\n the build utility 'msbuild' is in your PATH [41].\n\n- Go support: install Go [31] and add '--go-completer' when calling\n 'install.py'.\n\n- JavaScript and TypeScript support: install Node.js 18+ and npm [32] and add\n '--ts-completer' when calling 'install.py'.\n\n- Rust support: add '--rust-completer' when calling 'install.py'.\n\n- Java support: install JDK 17 [33] and add '--java-completer' when calling\n 'install.py'.\n\nTo simply compile with everything enabled, there's a '--all' flag. So, to\ninstall with all language features, ensure 'msbuild', 'go', 'node' and 'npm'\ntools are installed and in your 'PATH', then simply run:\n>\n cd %USERPROFILE%/vimfiles/bundle/YouCompleteMe\n python install.py --all\n<\nYou can specify the Microsoft Visual C++ (MSVC) version using the '--msvc'\noption. YCM officially supports MSVC 15 (2017), MSVC 16 (Visual Studio 2019)\nand MSVC 17 (Visual Studio 17 2022).\n\nThat's it. You're done. Refer to the _User Guide_ section on how to use YCM.\nDon't forget that if you want the C-family semantic completion engine to work,\nyou will need to provide the compilation flags for your project to YCM. It's\nall in the User Guide.\n\nYCM comes with sane defaults for its options, but you still may want to take a\nlook at what's available for configuration. There are a few interesting options\nthat are conservatively turned off by default that you may want to turn on.\n\n-------------------------------------------------------------------------------\n *youcompleteme-full-installation-guide*\nFull Installation Guide ~\n\nThe full installation guide [42] has been moved to the wiki.\n\n-------------------------------------------------------------------------------\n *youcompleteme-quick-feature-summary*\nQuick Feature Summary ~\n\n-------------------------------------------------------------------------------\n *youcompleteme-general*\nGeneral (all languages) ~\n\n- Super-fast identifier completer including tags files and syntax elements\n- Intelligent suggestion ranking and filtering\n- File and path suggestions\n- Suggestions from Vim's omnifunc\n- UltiSnips snippet suggestions\n\n-------------------------------------------------------------------------------\n *youcompleteme-c-family-languages*\nC-family languages (C, C++, Objective C, Objective C++, CUDA) ~\n\n- Semantic auto-completion with automatic fixes\n- Signature help\n- Real-time diagnostic display\n- Go to include/declaration/definition (|GoTo|, etc.)\n- Go to alternate file (e.g. associated header |GoToAlternateFile|)\n- Find Symbol ('GoToSymbol'), with interactive search\n- Document outline (|GoToDocumentOutline|), with interactive search\n- View documentation comments for identifiers (|GetDoc|)\n- Type information for identifiers (|GetType|)\n- Automatically fix certain errors (|FixIt|)\n- Perform refactoring (|FixIt|)\n- Reference finding (|GoToReferences|)\n- Renaming symbols ('RefactorRename ')\n- Code formatting (|Format|)\n- Semantic highlighting\n- Inlay hints\n- Type hierarchy\n- Call hierarchy\n\n-------------------------------------------------------------------------------\n *youcompleteme-c*\nC♯ ~\n\n- Semantic auto-completion\n- Signature help\n- Real-time diagnostic display\n- Go to declaration/definition (|GoTo|, etc.)\n- Go to implementation (|GoToImplementation|)\n- Find Symbol ('GoToSymbol'), with interactive search\n- View documentation comments for identifiers (|GetDoc|)\n- Type information for identifiers (|GetType|)\n- Automatically fix certain errors (|FixIt|)\n- Perform refactoring (|FixIt|)\n- Management of OmniSharp-Roslyn server instance\n- Renaming symbols ('RefactorRename ')\n- Code formatting (|Format|)\n\n-------------------------------------------------------------------------------\n *youcompleteme-python*\nPython ~\n\n- Semantic auto-completion\n- Signature help\n- Go to definition (|GoTo|)\n- Find Symbol ('GoToSymbol'), with interactive search\n- Reference finding (|GoToReferences|)\n- View documentation comments for identifiers (|GetDoc|)\n- Type information for identifiers (|GetType|)\n- Renaming symbols ('RefactorRename ')\n\n-------------------------------------------------------------------------------\n *youcompleteme-go*\nGo ~\n\n- Semantic auto-completion\n- Signature help\n- Real-time diagnostic display\n- Go to declaration/definition (|GoTo|, etc.)\n- Go to type definition (|GoToType|)\n- Go to implementation (|GoToImplementation|)\n- Document outline (|GoToDocumentOutline|), with interactive search\n- Automatically fix certain errors (|FixIt|)\n- Perform refactoring (|FixIt|)\n- View documentation comments for identifiers (|GetDoc|)\n- Type information for identifiers (|GetType|)\n- Code formatting (|Format|)\n- Management of 'gopls' server instance\n- Inlay hints\n- Call hierarchy\n\n-------------------------------------------------------------------------------\n *youcompleteme-javascript-typescript*\nJavaScript and TypeScript ~\n\n- Semantic auto-completion with automatic import insertion\n- Signature help\n- Real-time diagnostic display\n- Go to definition (|GoTo|, |GoToDefinition|, and |GoToDeclaration| are\n identical)\n- Go to type definition (|GoToType|)\n- Go to implementation (|GoToImplementation|)\n- Find Symbol ('GoToSymbol'), with interactive search\n- Reference finding (|GoToReferences|)\n- View documentation comments for identifiers (|GetDoc|)\n- Type information for identifiers (|GetType|)\n- Automatically fix certain errors and perform refactoring (|FixIt|)\n- Perform refactoring (|FixIt|)\n- Renaming symbols ('RefactorRename ')\n- Code formatting (|Format|)\n- Organize imports (|OrganizeImports|)\n- Management of 'TSServer' server instance\n- Inlay hints\n- Call hierarchy\n\n-------------------------------------------------------------------------------\n *youcompleteme-rust*\nRust ~\n\n- Semantic auto-completion\n- Real-time diagnostic display\n- Go to declaration/definition (|GoTo|, etc.)\n- Go to implementation (|GoToImplementation|)\n- Reference finding (|GoToReferences|)\n- Document outline (|GoToDocumentOutline|), with interactive search\n- View documentation comments for identifiers (|GetDoc|)\n- Automatically fix certain errors (|FixIt|)\n- Perform refactoring (|FixIt|)\n- Type information for identifiers (|GetType|)\n- Renaming symbols ('RefactorRename ')\n- Code formatting (|Format|)\n- Management of 'rust-analyzer' server instance\n- Semantic highlighting\n- Inlay hints\n- Call hierarchy\n\n-------------------------------------------------------------------------------\n *youcompleteme-java*\nJava ~\n\n- Semantic auto-completion with automatic import insertion\n- Signature help\n- Real-time diagnostic display\n- Go to definition (|GoTo|, |GoToDefinition|, and |GoToDeclaration| are\n identical)\n- Go to type definition (|GoToType|)\n- Go to implementation (|GoToImplementation|)\n- Find Symbol ('GoToSymbol'), with interactive search\n- Reference finding (|GoToReferences|)\n- Document outline (|GoToDocumentOutline|), with interactive search\n- View documentation comments for identifiers (|GetDoc|)\n- Type information for identifiers (|GetType|)\n- Automatically fix certain errors including code generation (|FixIt|)\n- Renaming symbols ('RefactorRename ')\n- Code formatting (|Format|)\n- Organize imports (|OrganizeImports|)\n- Detection of Java projects\n- Execute custom server command ('ExecuteCommand ')\n- Management of 'jdt.ls' server instance\n- Semantic highlighting\n- Inlay hints\n- Type hierarchy\n- Call hierarchy\n\n-------------------------------------------------------------------------------\n *youcompleteme-user-guide*\nUser Guide ~\n\n-------------------------------------------------------------------------------\n *youcompleteme-general-usage*\nGeneral Usage ~\n\nIf the offered completions are too broad, keep typing characters; YCM will\ncontinue refining the offered completions based on your input.\n\nFiltering is \"smart-case\" and \"smart-diacritic [43]\" sensitive; if you are\ntyping only lowercase letters, then it's case-insensitive. If your input\ncontains uppercase letters, then the uppercase letters in your query must match\nuppercase letters in the completion strings (the lowercase letters still match\nboth). On top of that, a letter with no diacritic marks will match that letter\nwith or without marks:\n\n---------------------------------------------\n| _matches_ | _foo_ | _fôo_ | _fOo_ | _fÔo_ |\n---------------------------------------------\n| _foo_ | ✔️ | ✔️ | ✔️ | ✔️ |\n---------------------------------------------\n| _fôo_ | ❌ | ✔️ | ❌ | ✔️ |\n---------------------------------------------\n| _fOo_ | ❌ | ❌ | ✔️ | ✔️ |\n---------------------------------------------\n| _fÔo_ | ❌ | ❌ | ❌ | ✔️ |\n---------------------------------------------\n\n\nUse the TAB key to accept a completion and continue pressing TAB to cycle\nthrough the completions. Use Shift-TAB to cycle backward. Note that if you're\nusing console Vim (that is, not gvim or MacVim) then it's likely that the\nShift-TAB binding will not work because the console will not pass it to Vim.\nYou can remap the keys; see the Options section below.\n\nKnowing a little bit about how YCM works internally will prevent confusion. YCM\nhas several completion engines: an identifier-based completer that collects all\nof the identifiers in the current file and other files you visit (and your tags\nfiles) and searches them when you type (identifiers are put into per-filetype\ngroups).\n\nThere are also several semantic engines in YCM. There are libclang-based and\nclangd-based completers that provide semantic completion for C-family\nlanguages. There's a Jedi-based completer for semantic completion for Python.\nThere's also an omnifunc-based completer that uses data from Vim's omnicomplete\nsystem to provide semantic completions when no native completer exists for that\nlanguage in YCM.\n\nThere are also other completion engines, like the UltiSnips completer and the\nfilepath completer.\n\nYCM automatically detects which completion engine would be the best in any\nsituation. On occasion, it queries several of them at once, merges the outputs\nand presents the results to you.\n\n-------------------------------------------------------------------------------\n *youcompleteme-client-server-architecture*\nClient-Server Architecture ~\n\nYCM has a client-server architecture; the Vim part of YCM is only a thin client\nthat talks to the ycmd HTTP+JSON server [44] that has the vast majority of YCM\nlogic and functionality. The server is started and stopped automatically as you\nstart and stop Vim.\n\n-------------------------------------------------------------------------------\n *youcompleteme-completion-string-ranking*\nCompletion String Ranking ~\n\nThe subsequence filter removes any completions that do not match the input, but\nthen the sorting system kicks in. It's actually very complicated and uses lots\nof factors, but suffice it to say that \"word boundary\" (WB) subsequence\ncharacter matches are \"worth\" more than non-WB matches. In effect, this means\nthat given an input of \"gua\", the completion \"getUserAccount\" would be ranked\nhigher in the list than the \"Fooguxa\" completion (both of which are subsequence\nmatches). Word-boundary characters are all capital characters, characters\npreceded by an underscore, and the first letter character in the completion\nstring.\n\n-------------------------------------------------------------------------------\n *youcompleteme-signature-help*\nSignature Help ~\n\nValid signatures are displayed in a second popup menu and the current signature\nis highlighted along with the current argument.\n\nSignature help is triggered in insert mode automatically when\n|g:ycm_auto_trigger| is enabled and is not supported when it is not enabled.\n\nThe signatures popup is hidden when there are no matching signatures or when\nyou leave insert mode. If you want to manually control when it is visible, you\ncan map something to 'YCMToggleSignatureHelp' (see below).\n\nFor more details on this feature and a few demos, check out the PR that\nproposed it [45].\n\n-------------------------------------------------------------------------------\n *youcompleteme-dismiss-signature-help*\nDismiss signature help ~\n\nThe signature help popup sometimes gets in the way. You can toggle its\nvisibility with a mapping. YCM provides the \"Plug\" mapping\n'(YCMToggleSignatureHelp)' for this.\n\nFor example, to hide/show the signature help popup by pressing Ctrl+l in insert\nmode: 'imap (YCMToggleSignatureHelp)'.\n\n_NOTE_: No default mapping is provided because insert mappings are very\ndifficult to create without breaking or overriding some existing functionality.\nCtrl-l is not a suggestion, just an example.\n\n-------------------------------------------------------------------------------\n *youcompleteme-semantic-highlighting*\nSemantic highlighting ~\n\nSemantic highlighting is the process where the buffer text is coloured\naccording to the underlying semantic type of the word, rather than classic\nsyntax highlighting based on regular expressions. This can be powerful\nadditional data that we can process very quickly.\n\nThis feature is only supported in Vim.\n\nFor example, here is a function with classic highlighting:\n\n Image: highliting-classic (see reference [46])\n\nAnd here is the same function with semantic highlighting:\n\n Image: highliting-semantic (see reference [47])\n\nAs you can see, the function calls, macros, etc. are correctly identified.\n\nThis can be enabled globally with 'let g:ycm_enable_semantic_highlighting=1' or\nper buffer, by setting 'b:ycm_enable_semantic_highlighting'.\n\n-------------------------------------------------------------------------------\n *youcompleteme-customising-highlight-groups*\nCustomising the highlight groups ~\n\nYCM uses text properties (see ':help text-prop-intro') for semantic\nhighlighting. In order to customise the coloring, you can define the text\nproperties that are used.\n\nIf you define a text property named 'YCM_HL_', then it will be used\nin place of the defaults. The '' is defined as the Language Server\nProtocol semantic token type, defined in the LSP Spec [48].\n\nSome servers also use custom values. In this case, YCM prints a warning\nincluding the token type name that you can customise.\n\nFor example, to render 'parameter' tokens using the 'Normal' highlight group,\nyou can do this:\n>\n call prop_type_add( 'YCM_HL_parameter', { 'highlight': 'Normal' } )\n<\nMore generally, this pattern can be useful for customising the groups:\n>\n let MY_YCM_HIGHLIGHT_GROUP = {\n \\ 'typeParameter': 'PreProc',\n \\ 'parameter': 'Normal',\n \\ 'variable': 'Normal',\n \\ 'property': 'Normal',\n \\ 'enumMember': 'Normal',\n \\ 'event': 'Special',\n \\ 'member': 'Normal',\n \\ 'method': 'Normal',\n \\ 'class': 'Special',\n \\ 'namespace': 'Special',\n \\ }\n \n for tokenType in keys( MY_YCM_HIGHLIGHT_GROUP )\n call prop_type_add( 'YCM_HL_' . tokenType,\n \\ { 'highlight': MY_YCM_HIGHLIGHT_GROUP[ tokenType ] } )\n endfor\n<\n-------------------------------------------------------------------------------\n *youcompleteme-inlay-hints*\nInlay hints ~\n\n**NOTE**: Highly experimental feature, requiring Vim 9.0.214 or later (not\nsupported in NeoVim).\n\nWhen 'g:ycm_enable_inlay_hints' (globally) or 'b:ycm_enable_inlay_hints' (for a\nspecific buffer) is set to '1', then YCM will insert inlay hints as supported\nby the language semantic engine.\n\nAn inlay hint is text that is rendered on the screen that is not part of the\nbuffer and is often used to mark up the type or name of arguments, parameters,\netc. which help the developer understand the semantics of the code.\n\nHere are some examples:\n\n- C\n\n Image: c-inlay (see reference [49])\n\n- TypeScript\n\n Image: ts-inlay (see reference [50])\n\n- Go\n\n Image: go-inlay (see reference [51])\n\n-------------------------------------------------------------------------------\n *youcompleteme-highlight-groups*\nHighlight groups ~\n\nBy default, YCM renders the inlay hints with the 'NonText' highlight group. To\noverride this, define the 'YcmInlayHint' highlight yourself, e.g. in your\n'.vimrc':\n>\n hi link YcmInlayHint Comment\n<\nSimilar to semantic highlighting above, you can override specific highlighting\nfor different inlay hint types by defining text properties named after the kind\nof inlay hint, for example:\n>\n call prop_type_add( 'YCM_INLAY_Type', #{ highlight: 'Comment' } )\n<\nThe list of inlay hint kinds can be found in 'python/ycm/inlay_hints.py'\n\n-------------------------------------------------------------------------------\n *youcompleteme-options*\nOptions ~\n\n- 'g:ycm_enable_inlay_hints' or 'b:ycm_enable_inlay_hints' - enable/disable\n globally or for local buffer\n\n- 'g:ycm_clear_inlay_hints_in_insert_mode' - set to '1' to remove all inlay\n hints when entering insert mode and reinstate them when leaving insert mode\n\n-------------------------------------------------------------------------------\n *youcompleteme-toggling*\nToggling ~\n\nInlay hints can add a lot of text to the screen and may be distracting. You can\ntoggle them on/off instantly, by mapping something to\n'(YCMToggleInlayHints)', for example:\n>\n nnoremap h (YCMToggleInlayHints)\n<\nNo default mapping is provided for this due to the personal nature of mappings.\n\n-------------------------------------------------------------------------------\n *youcompleteme-general-semantic-completion*\nGeneral Semantic Completion ~\n\nYou can use Ctrl+Space to trigger the completion suggestions anywhere, even\nwithout a string prefix. This is useful to see which top-level functions are\navailable for use.\n\n-------------------------------------------------------------------------------\n *youcompleteme-c-family-semantic-completion*\nC-family Semantic Completion ~\n\n**NOTE:** YCM originally used the 'libclang' based engine for C-family, but\nusers should migrate to clangd, as it provides more features and better\nperformance. Users who rely on 'override_filename' in their\n'.ycm_extra_conf.py' will need to stay on the old 'libclang' engine.\nInstructions on how to stay on the old engine are available on the wiki [52].\n\nSome of the features of clangd:\n\n- **Project wide indexing**: Clangd has both dynamic and static index\n support. The dynamic index stores up-to-date symbols coming from any files\n you are currently editing, whereas static index contains project-wide\n symbol information. This symbol information is used for code completion and\n code navigation. Whereas libclang is limited to the current translation\n unit(TU).\n\n- **Code navigation**: Clangd provides all the GoTo requests libclang\n provides and it improves those using the above-mentioned index information\n to contain project-wide information rather than just the current TU.\n\n- **Rename**: Clangd can perform semantic rename operations on the current\n file, whereas libclang doesn't support such functionality.\n\n- **Code Completion**: Clangd can perform code completions at a lower latency\n than libclang; also, it has information about all the symbols in your\n project so it can suggest items outside your current TU and also provides\n proper '#include' insertions for those items.\n\n- **Signature help**: Clangd provides signature help so that you can see the\n names and types of arguments when calling functions.\n\n- **Format Code**: Clangd provides code formatting either for the selected\n lines or the whole file, whereas libclang doesn't have such functionality.\n\n- **Performance**: Clangd has faster re-parse and code completion times\n compared to libclang.\n\n-------------------------------------------------------------------------------\nInstallation ~\n\nOn supported architectures, the 'install.py' script will download a suitable\nclangd ('--clangd-completer') or libclang ('--clang-completer') for you.\nSupported architectures are:\n\n- Linux glibc >= 2.39 (Intel, armv7-a, aarch64) - built on ubuntu 24.04\n- MacOS >=10.15 (Intel, arm64)\n- For Intel, compatibility per clang.llvm.org downloads\n- For arm64, macOS 10.15+\n- Windows (Intel) - compatibility per clang.llvm.org downloads\n\n**_clangd_**:\n\nTypically, clangd is installed by the YCM installer (either with '--all' or\nwith '--clangd-completer'). This downloads a pre-built 'clangd' binary for your\narchitecture. If your OS or architecture is not supported or is too old, you\ncan install a compatible 'clangd' and use |g:ycm_clangd_binary_path| to point\nto it.\n\n**_libclang_**:\n\n'libclang' can be enabled also with '--all' or '--clang-completer'. As with\n'clangd', YCM will try and download a version of 'libclang' that is suitable\nfor your environment, but again if your environment can't be supported, you can\nbuild or acquire 'libclang' for yourself and specify it when building, as:\n>\n $ EXTRA_CMAKE_ARGS='-DPATH_TO_LLVM_ROOT=/path/to/your/llvm' ./install.py --clang-completer --system-libclang\n<\nPlease note that if using custom 'clangd' or 'libclang' it _must_ match the\nversion that YCM requires. Currently YCM requires **_clang 17.0.1_**.\n\n-------------------------------------------------------------------------------\n *youcompleteme-compile-flags*\nCompile flags ~\n\nIn order to perform semantic analysis such as code completion, |GoTo|, and\ndiagnostics, YouCompleteMe uses 'clangd', which makes use of clang compiler,\nsometimes also referred to as LLVM. Like any compiler, clang also requires a\nset of compile flags in order to parse your code. Simply put: If clang can't\nparse your code, YouCompleteMe can't provide semantic analysis.\n\nThere are 2 methods that can be used to provide compile flags to clang:\n\n-------------------------------------------------------------------------------\n *youcompleteme-option-1-use-compilation-database-53*\nOption 1: Use a compilation database [53] ~\n\nThe easiest way to get YCM to compile your code is to use a compilation\ndatabase. A compilation database is usually generated by your build system\n(e.g. 'CMake') and contains the compiler invocation for each compilation unit\nin your project.\n\nFor information on how to generate a compilation database, see the clang\ndocumentation [53]. In short:\n\n- If using CMake, add '-DCMAKE_EXPORT_COMPILE_COMMANDS=ON' when configuring\n (or add 'set( CMAKE_EXPORT_COMPILE_COMMANDS ON )' to 'CMakeLists.txt') and\n copy or symlink the generated database to the root of your project.\n- If using Ninja, check out the 'compdb' tool ('-t compdb') in its docs [54].\n- If using GNU make, check out compiledb [55] or Bear [56].\n- For other build systems, check out '.ycm_extra_conf.py' below.\n\nIf no '.ycm_extra_conf.py' is found, YouCompleteMe automatically tries to load\na compilation database if there is one.\n\nYCM looks for a file named 'compile_commands.json' in the directory of the\nopened file or in any directory above it in the hierarchy (recursively); when\nthe file is found before a local '.ycm_extra_conf.py', YouCompleteMe stops\nsearching the directories and lets clangd take over and handle the flags.\n\n-------------------------------------------------------------------------------\n *youcompleteme-option-2-provide-flags-manually*\nOption 2: Provide the flags manually ~\n\nIf you don't have a compilation database or aren't able to generate one, you\nhave to tell YouCompleteMe how to compile your code some other way.\n\nEvery C-family project is different. It is not possible for YCM to guess what\ncompiler flags to supply for your project. Fortunately, YCM provides a\nmechanism for you to generate the flags for a particular file with _arbitrary\ncomplexity_. This is achieved by requiring you to provide a Python module that\nimplements a trivial function that, given the file name as an argument, returns\na list of compiler flags to use to compile that file.\n\nYCM looks for a '.ycm_extra_conf.py' file in the directory of the opened file\nor in any directory above it in the hierarchy (recursively); when the file is\nfound, it is loaded (only once!) as a Python module. YCM calls a 'Settings'\nmethod in that module which should provide it with the information necessary to\ncompile the current file. You can also provide a path to a global configuration\nfile with the |g:ycm_global_ycm_extra_conf| option, which will be used as a\nfallback. To prevent the execution of malicious code from a file you didn't\nwrite YCM will ask you once per '.ycm_extra_conf.py' if it is safe to load.\nThis can be disabled and you can white-/blacklist files. See the\n|g:ycm_confirm_extra_conf| and |g:ycm_extra_conf_globlist| options\nrespectively.\n\nThis system was designed this way so that the user can perform any arbitrary\nsequence of operations to produce a list of compilation flags YCM should hand\nto Clang.\n\n**NOTE**: It is highly recommended to include '-x ' flag to libclang.\nThis is so that the correct language is detected, particularly for header\nfiles. Common values are '-x c' for C, '-x c++' for C++, '-x objc' for\nObjective-C, and '-x cuda' for CUDA.\n\nTo give you an impression, if your C++ project is trivial, and your usual\ncompilation command is: 'g++ -Wall -Wextra -Werror -o FILE.o FILE.cc', then the\nfollowing '.ycm_extra_conf.py' is enough to get semantic analysis from\nYouCompleteMe:\n>\n def Settings( **kwargs ):\n return {\n 'flags': [ '-x', 'c++', '-Wall', '-Wextra', '-Werror' ],\n }\n<\nAs you can see from the trivial example, YCM calls the 'Settings' method which\nreturns a dictionary with a single element \"'flags'\". This element is a 'list'\nof compiler flags to pass to libclang for the current file. The absolute path\nof that file is accessible under the 'filename' key of the 'kwargs' dictionary.\nThat's it! This is actually enough for most projects, but for complex projects\nit is not uncommon to integrate directly with an existing build system using\nthe full power of the Python language.\n\nFor a more elaborate example, see ycmd's own '.ycm_extra_conf.py' [57]. You\nshould be able to use it _as a starting point_. **Don't** just copy/paste that\nfile somewhere and expect things to magically work; **your project needs\ndifferent flags**. Hint: just replace the strings in the 'flags' variable with\ncompilation flags necessary for your project. That should be enough for 99% of\nprojects.\n\nYou could also consider using YCM-Generator [58] to generate the\n'ycm_extra_conf.py' file.\n\n-------------------------------------------------------------------------------\n *youcompleteme-errors-during-compilation*\nErrors during compilation ~\n\nIf Clang encounters errors when compiling the header files that your file\nincludes, then it's probably going to take a long time to get completions. When\nthe completion menu finally appears, it's going to have a large number of\nunrelated completion strings (type/function names that are not actually\nmembers). This is because Clang fails to build a precompiled preamble for your\nfile if there are any errors in the included headers and that preamble is key\nto getting fast completions.\n\nCall the |:YcmDiags| command to see if any errors or warnings were detected in\nyour file.\n\n-------------------------------------------------------------------------------\n *youcompleteme-java-semantic-completion*\nJava Semantic Completion ~\n\n-------------------------------------------------------------------------------\n *youcompleteme-java-quick-start*\nJava Quick Start ~\n\n1. Ensure that you have enabled the Java completer. See the installation\n guide for details.\n\n2. Create a project file (gradle or maven) file in the root directory of\n your Java project, by following the instructions below.\n\n3. (Optional) Configure the LSP server. The jdt.ls configuration options\n [59] can be found in their codebase.\n\n4. If you previously used Eclim or Syntastic for Java, disable them for\n Java.\n\n5. Edit a Java file from your project.\n\n-------------------------------------------------------------------------------\n *youcompleteme-java-project-files*\nJava Project Files ~\n\nIn order to provide semantic analysis, the Java completion engine requires\nknowledge of your project structure. In particular, it needs to know the class\npath to use, when compiling your code. Fortunately jdt.ls [17] supports eclipse\nproject files [60], maven projects [61] and gradle projects [62].\n\n**NOTE:** Our recommendation is to use either Maven or Gradle projects.\n\n-------------------------------------------------------------------------------\n *youcompleteme-diagnostic-display-syntastic*\nDiagnostic display - Syntastic ~\n\nThe native support for Java includes YCM's native real-time diagnostics\ndisplay. This can conflict with other diagnostics plugins like Syntastic, so\nwhen enabling Java support, please **manually disable Syntastic Java\ndiagnostics**.\n\nAdd the following to your 'vimrc':\n>\n let g:syntastic_java_checkers = []\n<\n-------------------------------------------------------------------------------\n *youcompleteme-diagnostic-display-eclim*\nDiagnostic display - Eclim ~\n\nThe native support for Java includes YCM's native real-time diagnostics\ndisplay. This can conflict with other diagnostics plugins like Eclim, so when\nenabling Java support, please **manually disable Eclim Java diagnostics**.\n\nAdd the following to your 'vimrc':\n>\n let g:EclimFileTypeValidate = 0\n<\n**NOTE**: We recommend disabling Eclim entirely when editing Java with YCM's\nnative Java support. This can be done temporarily with ':EclimDisable'.\n\n-------------------------------------------------------------------------------\n *youcompleteme-eclipse-projects*\nEclipse Projects ~\n\nEclipse-style projects require two files: .project [60] and .classpath [63].\n\nIf your project already has these files due to previously being set up within\nEclipse, then no setup is required. jdt.ls [17] should load the project just\nfine (it's basically eclipse after all).\n\nHowever, if not, it is possible (easy in fact) to craft them manually, though\nit is not recommended. You're better off using Gradle or Maven (see below).\n\nA simple eclipse style project example [64] can be found in the ycmd test\ndirectory. Normally all that is required is to copy these files to the root of\nyour project and to edit the '.classpath' to add additional libraries, such as:\n>\n \n \n<\nIt may also be necessary to change the directory in which your source files are\nlocated (paths are relative to the .project file itself):\n>\n \n<\n**NOTE**: The eclipse project and classpath files are not a public interface\nand it is highly recommended to use Maven or Gradle project definitions if you\ndon't already use Eclipse to manage your projects.\n\n-------------------------------------------------------------------------------\n *youcompleteme-maven-projects*\nMaven Projects ~\n\nMaven needs a file named pom.xml [61] in the root of the project. Once again a\nsimple pom.xml [65] can be found in the ycmd source.\n\nThe format of pom.xml [61] files is way beyond the scope of this document, but\nwe do recommend using the various tools that can generate them for you, if\nyou're not familiar with them already.\n\n-------------------------------------------------------------------------------\n *youcompleteme-gradle-projects*\nGradle Projects ~\n\nGradle projects require a build.gradle [62]. Again, there is a trivial example\nin ycmd's tests [66].\n\nThe format of build.gradle [62] files are way beyond the scope of this\ndocument, but we do recommend using the various tools that can generate them\nfor you if you're not familiar with them already.\n\nSome users have experienced issues with their jdt.ls when using the Groovy\nlanguage for their build.gradle. As such, try using Kotlin [67] instead.\n\n-------------------------------------------------------------------------------\n *youcompleteme-troubleshooting*\nTroubleshooting ~\n\nIf you're not getting completions or diagnostics, check the server health:\n\n- The Java completion engine takes a while to start up and parse your\n project. You should be able to see its progress in the command line, and\n |:YcmDebugInfo|. Ensure that the following lines are present:\n>\n -- jdt.ls Java Language Server running\n -- jdt.ls Java Language Server Startup Status: Ready\n<\n- If the above lines don't appear after a few minutes, check the jdt.ls and\n ycmd log files using |:YcmToggleLogs|. The jdt.ls log file is called '.log'\n (for some reason).\n\nIf you get a message about \"classpath is incomplete\", then make sure you have\ncorrectly configured the project files.\n\nIf you get messages about unresolved imports, then make sure you have correctly\nconfigured the project files, in particular check that the classpath is set\ncorrectly.\n\n-------------------------------------------------------------------------------\n *youcompleteme-c-semantic-completion*\nC# Semantic Completion ~\n\nYCM relies on OmniSharp-Roslyn [13] to provide completion and code navigation.\nOmniSharp-Roslyn needs a solution file for a C# project and there are two ways\nof letting YCM know about your solution files.\n\n-------------------------------------------------------------------------------\n *youcompleteme-automatically-discovered-solution-files*\nAutomatically discovered solution files ~\n\nYCM will scan all parent directories of the file currently being edited and\nlook for a file with '.sln' extension.\n\n-------------------------------------------------------------------------------\n *youcompleteme-manually-specified-solution-files*\nManually specified solution files ~\n\nIf YCM loads '.ycm_extra_conf.py' which contains 'CSharpSolutionFile' function,\nYCM will try to use that to determine the solution file. This is useful when\none wants to override the default behaviour and specify a solution file that is\nnot in any of the parent directories of the currently edited file. Example:\n>\n def CSharpSolutionFile( filepath ):\n # `filepath` is the path of the file user is editing\n return '/path/to/solution/file' # Can be relative to the `.ycm_extra_conf.py`\n<\nIf the path returned by 'CSharpSolutionFile' is not an actual file, YCM will\nfall back to the other way of finding the file.\n\n-------------------------------------------------------------------------------\n *youcompleteme-use-with-.net-6.0-.net-sdks*\nUse with .NET 6.0 and .NET SDKs ~\n\nYCM ships with older version of OmniSharp-Roslyn based on Mono runtime. It is\npossible to use it with .NET 6.0 and newer, but it requires manual setup.\n\n1. Download NET 6.0 version of the OmniSharp server for your system from\n releases [68]\n\n2. Set |g:ycm_roslyn_binary_path| to the unpacked executable 'OmniSharp'\n\n3. Create a solution file if one doesn't already exist, it is currently\n required by YCM for internal bookkeeping\n\n 1. Run 'dotnet new sln' at the root of your project\n 2. Run 'dotnet sln add ...' for\n all of your projects\n\n4. Run |:YcmRestartServer|\n\n-------------------------------------------------------------------------------\n *youcompleteme-python-semantic-completion*\nPython Semantic Completion ~\n\nYCM relies on the Jedi [12] engine to provide completion and code navigation.\nBy default, it will pick the version of Python running the ycmd server [44] and\nuse its 'sys.path'. While this is fine for simple projects, this needs to be\nconfigurable when working with virtual environments or in a project with\nthird-party packages. The next sections explain how to do that.\n\n-------------------------------------------------------------------------------\n *youcompleteme-working-with-virtual-environments*\nWorking with virtual environments ~\n\nA common practice when working on a Python project is to install its\ndependencies in a virtual environment and develop the project inside that\nenvironment. To support this, YCM needs to know the interpreter path of the\nvirtual environment. You can specify it by creating a '.ycm_extra_conf.py' file\nat the root of your project with the following contents:\n>\n def Settings( **kwargs ):\n return {\n 'interpreter_path': '/path/to/virtual/environment/python'\n }\n<\nHere, '/path/to/virtual/environment/python' is the path to the Python used by\nthe virtual environment you are working in. Typically, the executable can be\nfound in the 'Scripts' folder of the virtual environment directory on Windows\nand in the 'bin' folder on other platforms.\n\nIf you don't like having to create a '.ycm_extra_conf.py' file at the root of\nyour project and would prefer to specify the interpreter path with a Vim\noption, read the Configuring through Vim options section.\n\n-------------------------------------------------------------------------------\n *youcompleteme-working-with-third-party-packages*\nWorking with third-party packages ~\n\nAnother common practice is to put the dependencies directly into the project\nand add their paths to 'sys.path' at runtime in order to import them. YCM needs\nto be told about this path manipulation to support those dependencies. This can\nbe done by creating a '.ycm_extra_conf.py' file at the root of the project.\nThis file must define a 'Settings( **kwargs )' function returning a dictionary\nwith the list of paths to prepend to 'sys.path' under the 'sys_path' key. For\ninstance, the following '.ycm_extra_conf.py' adds the paths\n'/path/to/some/third_party/package' and '/path/to/another/third_party/package'\nat the start of 'sys.path':\n>\n def Settings( **kwargs ):\n return {\n 'sys_path': [\n '/path/to/some/third_party/package',\n '/path/to/another/third_party/package'\n ]\n }\n<\nIf you would rather prepend paths to 'sys.path' with a Vim option, read the\nConfiguring through Vim options section.\n\nIf you need further control on how to add paths to 'sys.path', you should\ndefine the 'PythonSysPath( **kwargs )' function in the '.ycm_extra_conf.py'\nfile. Its keyword arguments are 'sys_path' which contains the default\n'sys.path', and 'interpreter_path' which is the path to the Python interpreter.\nHere's a trivial example that inserts the '/path/to/third_party/package' path\nat the second position of 'sys.path':\n>\n def PythonSysPath( **kwargs ):\n sys_path = kwargs[ 'sys_path' ]\n sys_path.insert( 1, '/path/to/third_party/package' )\n return sys_path\n<\nA more advanced example can be found in YCM's own '.ycm_extra_conf.py' [69].\n\n-------------------------------------------------------------------------------\n *youcompleteme-configuring-through-vim-options*\nConfiguring through Vim options ~\n\nYou may find it inconvenient to have to create a '.ycm_extra_conf.py' file at\nthe root of each one of your projects in order to set the path to the Python\ninterpreter and/or add paths to 'sys.path' and would prefer to be able to\nconfigure those through Vim options. Don't worry, this is possible by using the\n|g:ycm_extra_conf_vim_data| option and creating a global extra configuration\nfile. Let's take an example. Suppose that you want to set the interpreter path\nwith the 'g:ycm_python_interpreter_path' option and prepend paths to 'sys.path'\nwith the 'g:ycm_python_sys_path' option. Suppose also that you want to name the\nglobal extra configuration file 'global_extra_conf.py' and that you want to put\nit in your HOME folder. You should then add the following lines to your vimrc:\n>\n let g:ycm_python_interpreter_path = ''\n let g:ycm_python_sys_path = []\n let g:ycm_extra_conf_vim_data = [\n \\ 'g:ycm_python_interpreter_path',\n \\ 'g:ycm_python_sys_path'\n \\]\n let g:ycm_global_ycm_extra_conf = '~/global_extra_conf.py'\n<\nThen, create the '~/global_extra_conf.py' file with the following contents:\n>\n def Settings( **kwargs ):\n client_data = kwargs[ 'client_data' ]\n return {\n 'interpreter_path': client_data[ 'g:ycm_python_interpreter_path' ],\n 'sys_path': client_data[ 'g:ycm_python_sys_path' ]\n }\n<\nThat's it. You are done. Note that you don't need to restart the server when\nsetting one of the options. YCM will automatically pick the new values.\n\n-------------------------------------------------------------------------------\n *youcompleteme-rust-semantic-completion*\nRust Semantic Completion ~\n\nYCM uses rust-analyzer [16] for Rust semantic completion.\n\nNOTE: Previously, YCM used rls [70] for rust completion. This is no longer\nsupported, as the Rust community has decided on rust-analyzer [16] as the\nfuture of Rust tooling.\n\nCompletions and GoTo commands within the current crate and its dependencies\nshould work out of the box with no additional configuration (provided that you\nbuilt YCM with the '--rust-completer' flag; see the _Installation_ section for\ndetails). The install script takes care of installing the Rust source code\n[71], so no configuration is necessary.\n\n'rust-analyzer' supports a myriad of options. These are configured using LSP\nconfiguration, and are documented here [72].\n\n-------------------------------------------------------------------------------\n *youcompleteme-go-semantic-completion*\nGo Semantic Completion ~\n\nCompletions and GoTo commands should work out of the box (provided that you\nbuilt YCM with the '--go-completer' flag; see the _Installation_ section for\ndetails). The server only works for projects with the \"canonical\" layout.\n\n'gopls' also has a load of documented options [73].\n\nYou can set these in your '.ycm_extra_conf.py'. For example, to set the build\ntags:\n>\n def Settings( **kwargs ):\n if kwargs[ 'language' ] == 'go':\n return {\n 'ls': {\n 'build.buildFlags': [ '-tags=debug' ] }\n }\n }\n<\n-------------------------------------------------------------------------------\n *youcompleteme-javascript-typescript-semantic-completion*\nJavaScript and TypeScript Semantic Completion ~\n\n**NOTE:** YCM originally used the Tern [74] engine for JavaScript but due to\nTern [74] not being maintained anymore by its main author and the TSServer [15]\nengine offering more features, YCM is moving to TSServer [15]. This won't\naffect you if you were already using Tern [74] but you are encouraged to do the\nswitch by deleting the 'third_party/ycmd/third_party/tern_runtime/node_modules'\ndirectory in YCM folder. If you are a new user but still want to use Tern [74],\nyou should pass the '--js-completer' option to the 'install.py' script during\ninstallation. Further instructions on how to set up YCM with Tern [74] are\navailable on the wiki [75].\n\nAll JavaScript and TypeScript features are provided by the TSServer [15]\nengine, which is included in the TypeScript SDK. To enable these features,\ninstall Node.js 18+ and npm [32] and call the 'install.py' script with the\n'--ts-completer' flag.\n\nTSServer [15] relies on the 'jsconfig.json' file [76] for JavaScript and the\n'tsconfig.json' file [77] for TypeScript to analyze your project. Ensure the\nfile exists at the root of your project.\n\nTo get diagnostics in JavaScript, set the 'checkJs' option to 'true' in your\n'jsconfig.json' file:\n>\n {\n \"compilerOptions\": {\n \"checkJs\": true\n }\n }\n<\n-------------------------------------------------------------------------------\n *youcompleteme-semantic-completion-for-other-languages*\nSemantic Completion for Other Languages ~\n\nC-family, C#, Go, Java, Python, Rust, and JavaScript/TypeScript languages are\nsupported natively by YouCompleteMe using the Clang [78], OmniSharp-Roslyn\n[13], Gopls [14], jdt.ls [17], Jedi [12], rust-analyzer [16], and TSServer [15]\nengines, respectively. Check the installation section for instructions to\nenable these features if desired.\n\n-------------------------------------------------------------------------------\n *youcompleteme-plugging-an-arbitrary-lsp-server*\nPlugging an arbitrary LSP server ~\n\nSimilar to other LSP clients, YCM can use an arbitrary LSP server with the help\nof |g:ycm_language_server| option. An example of a value of this option would\nbe:\n>\n let g:ycm_language_server = \n \\ [ \n \\ {\n \\ 'name': 'yaml',\n \\ 'cmdline': [ '/path/to/yaml/server/yaml-language-server', '--stdio' ],\n \\ 'filetypes': [ 'yaml' ]\n \\ },\n \\ {\n \\ 'name': 'csharp',\n \\ 'cmdline': [ 'OmniSharp', '-lsp' ],\n \\ 'filetypes': [ 'csharp' ],\n \\ 'project_root_files': [ '*.csproj', '*.sln' ]\n \\ },\n \\ {\n \\ 'name': 'godot',\n \\ 'filetypes': [ 'gdscript' ],\n \\ 'port': 6008,\n \\ 'project_root_files': [ 'project.godot' ]\n \\ }\n \\ ]\n<\nEach dictionary contains the following keys: 'name', 'cmdline', 'port',\n'filetypes', 'capabilities', 'project_root_files', 'additional_workspace_dirs',\n'triggerCharacters', and 'settings'. The full description of each key can be\nfound in the ycmd [79] repository.\n\nSee the LSP Examples [80] project for more examples of configuring the likes of\nPHP, Ruby, Kotlin, and D.\n\n-------------------------------------------------------------------------------\n *youcompleteme-lsp-configuration*\nLSP Configuration ~\n\nMany LSP servers allow some level of user configuration. YCM enables this with\nthe help of '.ycm_extra_conf.py' files. Here's an example of jdt.ls user\nexamples of configuring the likes of PHP, Ruby, Kotlin, D, and many, many more.\n>\n def Settings( **kwargs ):\n if kwargs[ 'language' ] == 'java':\n return {\n 'ls': {\n 'java.format.onType.enabled': True\n }\n }\n<\nThe 'ls' key tells YCM that the dictionary should be passed to the LSP server.\nFor each of the LSP server's configuration, you should look up the respective\nserver's documentation.\n\nSome servers request settings from arbitrary 'sections' of configuration. There\nis no concept of configuration sections in Vim, so you can specify an\nadditional 'config_sections' dictionary which maps section to a dictionary of\nconfig required by the server. For example:\n>\n def Settings( **kwargs ):\n if kwargs[ 'language' ] == 'java':\n return {\n 'ls': {\n 'java.format.onType.enabled': True\n },\n 'config_sections': {\n 'some section': {\n 'some option': 'some value'\n }\n }\n<\nThe sections and options/values are completely server-specific and rarely well\ndocumented.\n\n-------------------------------------------------------------------------------\n *youcompleteme-using-omnifunc-for-semantic-completion*\nUsing 'omnifunc' for semantic completion ~\n\nYCM will use your 'omnifunc' (see ':h omnifunc' in Vim) as a source for\nsemantic completions if it does not have a native semantic completion engine\nfor your file's filetype. Vim comes with rudimentary omnifuncs for various\nlanguages like Ruby, PHP, etc. It depends on the language.\n\nYou can get a stellar omnifunc for Ruby with Eclim [81]. Just make sure you\nhave the _latest_ Eclim installed and configured (this means Eclim '>= 2.2.*'\nand Eclipse '>= 4.2.*').\n\nAfter installing Eclim remember to create a new Eclipse project within your\napplication by typing ':ProjectCreate -n ruby' inside\nVim and don't forget to have \"let g:EclimCompletionMethod = 'omnifunc'\" in your\nvimrc. This will make YCM and Eclim play nice; YCM will use Eclim's omnifuncs\nas the data source for semantic completions and provide the auto-triggering and\nsubsequence-based matching (and other YCM features) on top of it.\n\n-------------------------------------------------------------------------------\n *youcompleteme-writing-new-semantic-completers*\nWriting New Semantic Completers ~\n\nYou have two options here: writing an 'omnifunc' for Vim's omnicomplete system\nthat YCM will then use through its omni-completer, or a custom completer for\nYCM using the Completer API [82].\n\nHere are the differences between the two approaches:\n\n- You have to use VimScript to write the omnifunc, but get to use Python to\n write for the Completer API; this by itself should make you want to use the\n API.\n\n- The Completer API is a _much_ more powerful way to integrate with YCM and\n it provides a wider set of features. For instance, you can make your\n Completer query your semantic back-end in an asynchronous fashion, thus not\n blocking Vim's GUI thread while your completion system is processing stuff.\n This is impossible with VimScript. All of YCM's completers use the\n Completer API.\n\n- Performance with the Completer API is better since Python executes faster\n than VimScript.\n\nIf you want to use the 'omnifunc' system, see the relevant Vim docs with ':h\ncomplete-functions'. For the Completer API, see the API docs [82].\n\nIf you want to upstream your completer into YCM's source, you should use the\nCompleter API.\n\n-------------------------------------------------------------------------------\n *youcompleteme-diagnostic-display*\nDiagnostic Display ~\n\nYCM will display diagnostic notifications for the C-family, C#, Go, Java,\nJavaScript, Rust, and TypeScript languages. Since YCM continuously recompiles\nyour file as you type, you'll get notified of errors and warnings in your file\nas fast as possible.\n\nHere are the various pieces of the diagnostic UI:\n\n- Icons show up in the Vim gutter on lines that have a diagnostic.\n- Regions of text related to diagnostics are highlighted (by default, a red\n wavy underline in 'gvim' and a red background in 'vim').\n- Moving the cursor to a line with a diagnostic echoes the diagnostic text.\n- Vim's location list is automatically populated with diagnostic data (off by\n default, see options).\n\nThe new diagnostics (if any) will be displayed the next time you press any key\non the keyboard. So if you stop typing and just wait for the new diagnostics to\ncome in, that _will not work_. You need to press some key for the GUI to\nupdate.\n\nHaving to press a key to get the updates is unfortunate, but cannot be changed\ndue to the way Vim internals operate; there is no way that a background task\ncan update Vim's GUI after it has finished running. You _have to_ press a key.\nThis will make YCM check for any pending diagnostics updates.\n\nYou _can_ force a full, blocking compilation cycle with the\n|:YcmForceCompileAndDiagnostics| command (you may want to map that command to a\nkey; try putting 'nnoremap :YcmForceCompileAndDiagnostics' in your\nvimrc). Calling this command will force YCM to immediately recompile your file\nand display any new diagnostics it encounters. Do note that recompilation with\nthis command may take a while and during this time the Vim GUI _will_ be\nblocked.\n\nYCM will display a short diagnostic message when you move your cursor to the\nline with the error. You can get a detailed diagnostic message with the\n'd' key mapping (can be changed in the options) YCM provides when your\ncursor is on the line with the diagnostic.\n\nYou can also see the full diagnostic message for all the diagnostics in the\ncurrent file in Vim's 'locationlist', which can be opened with the ':lopen' and\n':lclose' commands (make sure you have set 'let\ng:ycm_always_populate_location_list = 1' in your vimrc). A good way to toggle\nthe display of the 'locationlist' with a single key mapping is provided by\nanother (very small) Vim plugin called ListToggle [83] (which also makes it\npossible to change the height of the 'locationlist' window), also written by\nyours truly.\n\n-------------------------------------------------------------------------------\n *youcompleteme-diagnostic-highlighting-groups*\nDiagnostic Highlighting Groups ~\n\nYou can change the styling for the highlighting groups YCM uses. For the signs\nin the Vim gutter, the relevant groups are:\n\n- 'YcmErrorSign', which falls back to group 'SyntasticErrorSign' and then\n 'error' if they exist\n\n- 'YcmWarningSign', which falls back to group 'SyntasticWarningSign' and then\n 'todo' if they exist\n\nYou can also style the line that has the warning/error with these groups:\n\n- 'YcmErrorLine', which falls back to group 'SyntasticErrorLine' if it exists\n- 'YcmWarningLine', which falls back to group 'SyntasticWarningLine' if it\n exists\n\nFinally, you can also style the popup for the detailed diagnostics (it is shown\nif |g:ycm_show_detailed_diag_in_popup| is set) using the group 'YcmErrorPopup',\nwhich falls back to 'ErrorMsg'.\n\nNote that the line highlighting groups only work when the\n|g:ycm_enable_diagnostic_signs| option is set. If you want highlighted lines\nbut no signs in the Vim gutter, set the 'signcolumn' option to 'no' in your\nvimrc:\n>\n set signcolumn=no\n<\nThe syntax groups used to highlight regions of text with errors/warnings: -\n'YcmErrorSection', which falls back to group 'SyntasticError' if it exists and\nthen 'SpellBad' - 'YcmWarningSection', which falls back to group\n'SyntasticWarning' if it exists and then 'SpellCap'\n\nHere's how you'd change the style for a group:\n>\n highlight YcmErrorLine guibg=#3f0000\n<\n-------------------------------------------------------------------------------\n *youcompleteme-symbol-search*\nSymbol Search ~\n\n**_This feature requires Vim and is not supported in Neovim_**\n\nYCM provides a way to search for and jump to a symbol in the current project or\ndocument when using supported languages.\n\nYou can search for symbols in the current workspace when the 'GoToSymbol'\nrequest is supported and the current document when |GoToDocumentOutline| is\nsupported.\n\nHere's a quick demo:\n\n Image: asciicast [84]\n\nAs you can see, you can type and YCM filters down the list as you type. The\ncurrent set of matches are displayed in a popup window in the centre of the\nscreen and you can select an entry with the keyboard, to jump to that position.\nAny matches are then added to the quickfix list.\n\nTo enable:\n\n- 'nmap (YCMFindSymbolInWorkspace)'\n- 'nmap (YCMFindSymbolInDocument)'\n\ne.g.\n\n- 'nmap yfw (YCMFindSymbolInWorkspace)'\n- 'nmap yfd (YCMFindSymbolInDocument)'\n\nWhen searching, YCM opens a prompt buffer at the top of the screen for the\ninput and puts you in insert mode. This means that you can hit '' to go\ninto normal mode and use any other input commands that are supported in prompt\nbuffers. As you type characters, the search is updated.\n\nInitially, results are queried from all open filetypes. You can hit '' to\nswitch to just the current filetype while the popup is open.\n\nWhile the popup is open, the following keys are intercepted:\n\n- '', '', '', '' - select the next item\n- '', '', '', '' - select the previous item\n- '', '' - jump up one screenful of items\n- '', '' - jump down one screenful of items\n- '', '' - jump to first item\n- '', '' - jump to last item\n- '' - jump to the selected item\n- '' cancel/dismiss the popup\n- '' - toggle results from all file types or just the current filetype\n\nThe search is also cancelled if you leave the prompt buffer window at any time,\nso you can use window commands '...' for example.\n\n-------------------------------------------------------------------------------\n *youcompleteme-closing-popup*\nClosing the popup ~\n\n**_NOTE_**: Pressing '' does not close the popup - you must use 'Ctrl-c'\nfor that, or use a window command (e.g. 'j') or the mouse to leave the\nprompt buffer window.\n\n-------------------------------------------------------------------------------\n *youcompleteme-type-call-hierarchy*\nType/Call Hierarchy ~\n\n**_This feature requires Vim and is not supported in Neovim_**\n\n**NOTE**: This feature is highly experimental and offered in the hope that it\nis useful. Please help us by reporting issues and offering feedback.\n\nYCM provides a way to view and navigate hierarchies. The following hierarchies\nare supported:\n\n- Type hierachy '(YCMTypeHierarchy)': Display subtypes and supertypes\n of the symbol under cursor. Expand down to subtypes and up to supertypes.\n\n- Call hierarchy '(YCMCallHierarchy)': Display callees and callers of\n the symbol under cursor. Expand down to callers and up to callees.\n\nTake a look at this Image: asciicast [86] for brief demo.\n\nHierarchy UI can be initiated by mapping something to the indicated plug\nmappings, for example:\n>\n nmap yth (YCMTypeHierarchy)\n nmap ych (YCMCallHierarchy)\n<\nThis opens a \"modal\" popup showing the current element in the hierarchy tree.\nThe current tree root is aligned to the left and child and parent nodes are\nexpanded to the right. Expand the tree \"down\" with '' and \"up\" with\n''.\n\nThe \"root\" of the tree can be re-focused to the selected item with ''\nand further '' will show the parents of the selected item. This can take\na little getting used to, but it's particularly important with multiple\ninheritance where a \"child\" of the current root may actually have other,\ninvisible, parent links. '' on that row will show these by setting the\ndisplay root to the selected item.\n\nWhen the hierarchy is displayed, the following keys are intercepted:\n\n- '': Drill into the hierarchy at the selected item: expand and show\n children of the selected item.\n- '': Show parents of the selected item. When applied to sub-types,\n this will re-root the tree at that type, so that all parent types (are\n displayed). Similar for callers.\n- '': Jump to the symbol currently selected.\n- '', '', '', 'j': Select the next item\n- '', '', '', 'k'; Select the previous item\n- Any other key: closes the popup without jumping to any location\n\n**Note:** you might think the call hierarchy tree is inverted, but we think\nthis way round is more intuitive because this is the typical way that call\nstacks are displayed (with the current function at the top, and its callers\nbelow).\n\n-------------------------------------------------------------------------------\n *youcompleteme-commands*\nCommands ~\n\n-------------------------------------------------------------------------------\nThe *:YcmRestartServer* command\n\nIf the ycmd completion server [44] suddenly stops for some reason, you can\nrestart it with this command.\n\n-------------------------------------------------------------------------------\nThe *:YcmForceCompileAndDiagnostics* command\n\nCalling this command will force YCM to immediately recompile your file and\ndisplay any new diagnostics it encounters. Do note that recompilation with this\ncommand may take a while and during this time the Vim GUI _will_ be blocked.\n\nYou may want to map this command to a key; try putting 'nnoremap \n:YcmForceCompileAndDiagnostics' in your vimrc.\n\n-------------------------------------------------------------------------------\nThe *:YcmDiags* command\n\nCalling this command will fill Vim's 'locationlist' with errors or warnings if\nany were detected in your file and then open it. If a given error or warning\ncan be fixed by a call to ':YcmCompleter FixIt', then '(FixIt available)' is\nappended to the error or warning text. See the |FixIt| completer subcommand for\nmore information.\n\n**NOTE:** The absence of '(FixIt available)' does not strictly imply a fix-it\nis not available as not all completers are able to provide this indication. For\nexample, the c-sharp completer provides many fix-its but does not add this\nadditional indication.\n\nThe |g:ycm_open_loclist_on_ycm_diags| option can be used to prevent the\nlocation list from opening, but still have it filled with new diagnostic data.\nSee the _Options_ section for details.\n\n-------------------------------------------------------------------------------\nThe *:YcmShowDetailedDiagnostic* command\n\nThis command shows the full diagnostic text when the user's cursor is on the\nline with the diagnostic.\n\nAn options argument can be passed. If the argument is 'popup' the diagnostic\ntext will be displayed in a popup at the cursor position.\n\nIf you prefer the detailed diagnostic to always be shown in a popup, then 'let\ng:ycm_show_detailed_diag_in_popup=1'.\n\n-------------------------------------------------------------------------------\nThe *:YcmDebugInfo* command\n\nThis will print out various debug information for the current file. Useful to\nsee what compile commands will be used for the file if you're using the\nsemantic completion engine.\n\n-------------------------------------------------------------------------------\nThe *:YcmToggleLogs* command\n\nThis command presents the list of logfiles created by YCM, the ycmd server\n[44], and the semantic engine server for the current filetype, if any. One of\nthese logfiles can be opened in the editor (or closed if already open) by\nentering the corresponding number or by clicking on it with the mouse.\nAdditionally, this command can take the logfile names as arguments. Use the\n'' key (or any other key defined by the 'wildchar' option) to complete the\narguments or to cycle through them (depending on the value of the 'wildmode'\noption). Each logfile given as an argument is directly opened (or closed if\nalready open) in the editor. Only for debugging purposes.\n\n-------------------------------------------------------------------------------\nThe *:YcmCompleter* command\n\nThis command gives access to a number of additional IDE-like features in YCM,\nfor things like semantic GoTo, type information, FixIt, and refactoring.\n\nThis command accepts a range that can either be specified through a selection\nin one of Vim's visual modes (see ':h visual-use') or on the command line. For\ninstance, ':2,5YcmCompleter' will apply the command from line 2 to line 5. This\nis useful for the |Format| subcommand.\n\nCall 'YcmCompleter' without further arguments for a list of the commands you\ncan call for the current completer.\n\nSee the file type feature summary for an overview of the features available for\neach file type. See the _YcmCompleter subcommands_ section for more information\non the available subcommands and their usage.\n\nSome commands, like |Format| accept a range, like ':%YcmCompleter Format'.\n\nSome commands like |GetDoc| and the various |GoTo| commands respect modifiers,\nlike ':rightbelow YcmCompleter GetDoc', ':vertical YcmCompleter GoTo'.\n\n-------------------------------------------------------------------------------\n *youcompleteme-ycmcompleter-subcommands*\nYcmCompleter Subcommands ~\n\n**NOTE:** See the docs for the 'YcmCompleter' command before tackling this\nsection.\n\nThe invoked subcommand is automatically routed to the currently active semantic\ncompleter, so ':YcmCompleter GoToDefinition' will invoke the |GoToDefinition|\nsubcommand on the Python semantic completer if the currently active file is a\nPython one and on the Clang completer if the currently active file is a\nC-family language one.\n\nYou may also want to map the subcommands to something less verbose; for\ninstance, 'nnoremap jd :YcmCompleter GoTo' maps the 'jd'\nsequence to the longer subcommand invocation.\n\n-------------------------------------------------------------------------------\n *youcompleteme-goto-commands*\nGoTo Commands ~\n\nThese commands are useful for jumping around and exploring code. When moving\nthe cursor, the subcommands add entries to Vim's 'jumplist' so you can use\n'CTRL-O' to jump back to where you were before invoking the command (and\n'CTRL-I' to jump forward; see ':h jumplist' for details). If there is more than\none destination, the quickfix list (see ':h quickfix') is populated with the\navailable locations and opened to the full width at the bottom of the screen.\nYou can change this behavior by using the |YcmQuickFixOpened| autocommand.\n\n-------------------------------------------------------------------------------\nThe *GoToInclude* subcommand\n\nLooks up the current line for a header and jumps to it.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda'\n\n-------------------------------------------------------------------------------\nThe *GoToAlternateFile* subcommand\n\nJump to the associated file, as defined by the language server. Typically this\nwill jump you to the associated header file for a C or C++ translation unit.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda' (clangd only)\n\n-------------------------------------------------------------------------------\nThe *GoToDeclaration* subcommand\n\nLooks up the symbol under the cursor and jumps to its declaration.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, cs, go, java, javascript,\npython, rust, typescript'\n\n-------------------------------------------------------------------------------\nThe *GoToDefinition* subcommand\n\nLooks up the symbol under the cursor and jumps to its definition.\n\n**NOTE:** For C-family languages **this only works in certain situations**,\nnamely when the definition of the symbol is in the current translation unit. A\ntranslation unit consists of the file you are editing and all the files you are\nincluding with '#include' directives (directly or indirectly) in that file.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, cs, go, java, javascript,\npython, rust, typescript'\n\n-------------------------------------------------------------------------------\nThe *GoTo* subcommand\n\nThis command tries to perform the \"most sensible\" GoTo operation it can.\nCurrently, this means that it tries to look up the symbol under the cursor and\njumps to its definition if possible; if the definition is not accessible from\nthe current translation unit, jumps to the symbol's declaration. For C-family\nlanguages, it first tries to look up the current line for a header and jump to\nit. For C#, implementations are also considered and preferred.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, cs, go, java, javascript,\npython, rust, typescript'\n\n-------------------------------------------------------------------------------\nThe *GoToImprecise* subcommand\n\nWARNING: This command trades correctness for speed!\n\nSame as the |GoTo| command except that it doesn't recompile the file with\nlibclang before looking up nodes in the AST. This can be very useful when\nyou're editing files that take time to compile but you know that you haven't\nmade any changes since the last parse that would lead to incorrect jumps. When\nyou're just browsing around your codebase, this command can spare you quite a\nbit of latency.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda'\n\n-------------------------------------------------------------------------------\n *GoToSymbol-symbol-query*\nThe 'GoToSymbol ' subcommand ~\n\nFinds the definition of all symbols matching a specified string. Note that this\ndoes not use any sort of smart/fuzzy matching. However, an interactive symbol\nsearch is also available.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, cs, java, javascript,\npython, typescript'\n\n-------------------------------------------------------------------------------\nThe *GoToReferences* subcommand\n\nThis command attempts to find all of the references within the project to the\nidentifier under the cursor and populates the quickfix list with those\nlocations.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, java, javascript, python,\ntypescript, rust'\n\n-------------------------------------------------------------------------------\nThe *GoToImplementation* subcommand\n\nLooks up the symbol under the cursor and jumps to its implementation (i.e.\nnon-interface). If there are multiple implementations, instead provides a list\nof implementations to choose from.\n\nSupported in filetypes: 'cs, go, java, rust, typescript, javascript'\n\n-------------------------------------------------------------------------------\nThe *GoToImplementationElseDeclaration* subcommand\n\nLooks up the symbol under the cursor and jumps to its implementation if one,\nelse jump to its declaration. If there are multiple implementations, instead\nprovides a list of implementations to choose from.\n\nSupported in filetypes: 'cs'\n\n-------------------------------------------------------------------------------\nThe *GoToType* subcommand\n\nLooks up the symbol under the cursor and jumps to the definition of its type\ne.g. if the symbol is an object, go to the definition of its class.\n\nSupported in filetypes: 'go, java, javascript, typescript'\n\n-------------------------------------------------------------------------------\nThe *GoToDocumentOutline* subcommand\n\nProvides a list of symbols in the current document, in the quickfix list. See\nalso interactive symbol search.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, go, java, rust'\n\n-------------------------------------------------------------------------------\nThe *GoToCallers* and 'GoToCallees' subcommands\n\nNote: A much more powerful call and type hierarchy can be viewd interactively.\nSee interactive type and call hierarchy.\n\nPopulate the quickfix list with the callers, or callees respectively, of the\nfunction associated with the current cursor position. The semantics of this\ndiffer depending on the filetype and language server.\n\nOnly supported for LSP servers that provide the 'callHierarchyProvider'\ncapability.\n\n-------------------------------------------------------------------------------\n *youcompleteme-semantic-information-commands*\nSemantic Information Commands ~\n\nThese commands are useful for finding static information about the code, such\nas the types of variables, viewing declarations, and documentation strings.\n\n-------------------------------------------------------------------------------\nThe *GetType* subcommand\n\nEchos the type of the variable or method under the cursor, and where it\ndiffers, the derived type.\n\nFor example:\n>\n std::string s;\n<\nInvoking this command on 's' returns 'std::string => std::basic_string'\n\n**NOTE:** Causes re-parsing of the current translation unit.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, java, javascript, go,\npython, typescript, rust'\n\n-------------------------------------------------------------------------------\nThe *GetTypeImprecise* subcommand\n\nWARNING: This command trades correctness for speed!\n\nSame as the |GetType| command except that it doesn't recompile the file with\nlibclang before looking up nodes in the AST. This can be very useful when\nyou're editing files that take time to compile but you know that you haven't\nmade any changes since the last parse that would lead to incorrect type. When\nyou're just browsing around your codebase, this command can spare you quite a\nbit of latency.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda'\n\n-------------------------------------------------------------------------------\nThe *GetParent* subcommand\n\nEchos the semantic parent of the point under the cursor.\n\nThe semantic parent is the item that semantically contains the given position.\n\nFor example:\n>\n class C {\n void f();\n };\n \n void C::f() {\n \n }\n<\nIn the out-of-line definition of 'C::f', the semantic parent is the class 'C',\nof which this function is a member.\n\nIn the example above, both declarations of 'C::f' have 'C' as their semantic\ncontext, while the lexical context of the first 'C::f' is 'C' and the lexical\ncontext of the second 'C::f' is the translation unit.\n\nFor global declarations, the semantic parent is the translation unit.\n\n**NOTE:** Causes re-parsing of the current translation unit.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda'\n\n-------------------------------------------------------------------------------\nThe *GetDoc* subcommand\n\nDisplays the preview window populated with quick info about the identifier\nunder the cursor. Depending on the file type, this includes things like:\n\n- The type or declaration of identifier,\n- Doxygen/javadoc comments,\n- Python docstrings,\n- etc.\n\nThe documentation is opened in the preview window, and options like\n'previewheight' are respected. If you would like to customise the height and\nposition of this window, we suggest a custom command that:\n\n- Sets 'previewheight' temporarily\n- Runs the |GetDoc| command with supplied modifiers\n- Restores 'previewheight'.\n\nFor example:\n>\n command -count ShowDocWithSize\n \\ let g:ph=&previewheight \n \\ set previewheight=\n \\ YcmCompleter GetDoc\n \\ let &previewheight=g:ph\n<\nYou can then use something like ':botright vertical 80ShowDocWithSize'. Here's\nan example of that: https://asciinema.org/a/hE6Pi1gU6omBShwFna8iwGEe9\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, cs, go, java, javascript,\npython, typescript, rust'\n\n-------------------------------------------------------------------------------\nThe *GetDocImprecise* subcommand\n\nWARNING: This command trades correctness for speed!\n\nSame as the |GetDoc| command except that it doesn't recompile the file with\nlibclang before looking up nodes in the AST. This can be very useful when\nyou're editing files that take long to compile but you know that you haven't\nmade any changes since the last parse that would lead to incorrect docs. When\nyou're just browsing around your codebase, this command can spare you quite a\nbit of latency.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda'\n\n-------------------------------------------------------------------------------\n *youcompleteme-refactoring-commands*\nRefactoring Commands ~\n\nThese commands make changes to your source code in order to perform refactoring\nor code correction. YouCompleteMe does not perform any action which cannot be\nundone, and never saves or writes files to the disk.\n\n-------------------------------------------------------------------------------\nThe *FixIt* subcommand\n\nWhere available, attempts to make changes to the buffer to correct diagnostics,\nor perform refactoring, on the current line or selection. Where multiple\nsuggestions are available (such as when there are multiple ways to resolve a\ngiven warning, or where multiple diagnostics are reported for the current line,\nor multiple refactoring tweaks are available), the options are presented and\none can be selected.\n\nCompleters that provide diagnostics may also provide trivial modifications to\nthe source in order to correct the diagnostic. Examples include syntax errors\nsuch as missing trailing semi-colons, spurious characters, or other errors\nwhich the semantic engine can deterministically suggest corrections. A small\ndemo presenting how diagnostics can be fixed with clangd:\n\n Image: YcmCompleter-FixIt-OnDiagnostic (see reference [88])\n\nCompleters (LSPs) may also provide refactoring tweaks, which may be available\neven when no diagnostic is presented for the current line. These include\nfunction extraction, variable extraction, 'switch' population, constructor\ngeneration, ... The tweaks work for a selection as well. Consult your LSP for\navailable refactorings. A demonstration of refactoring capabilities with\nclangd:\n\n Image: YouCompleter-FixIt-Refactoring (see reference [89])\n\nIf no fix-it is available for the current line, or there is no diagnostic on\nthe current line, this command has no effect on the current buffer. If any\nmodifications are made, the number of changes made to the buffer is echo'd and\nthe user may use the editor's undo command to revert.\n\nWhen a diagnostic is available, and |g:ycm_echo_current_diagnostic| is enabled,\nthen the text '(FixIt)' is appended to the echo'd diagnostic when the completer\nis able to add this indication. The text '(FixIt available)' is also appended\nto the diagnostic text in the output of the |:YcmDiags| command for any\ndiagnostics with available fix-its (where the completer can provide this\nindication).\n\n**NOTE:** Causes re-parsing of the current translation unit.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, cs, go, java, javascript,\nrust, typescript'\n\n-------------------------------------------------------------------------------\n *RefactorRename-new-name*\nThe 'RefactorRename ' subcommand ~\n\nIn supported file types, this command attempts to perform a semantic rename of\nthe identifier under the cursor. This includes renaming declarations,\ndefinitions, and usages of the identifier, or any other language-appropriate\naction. The specific behavior is defined by the semantic engine in use.\n\nSimilar to |FixIt|, this command applies automatic modifications to your source\nfiles. Rename operations may involve changes to multiple files, which may or\nmay not be open in Vim buffers at the time. YouCompleteMe handles all of this\nfor you. The behavior is described in the following section.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, java, javascript, python,\ntypescript, rust, cs'\n\n-------------------------------------------------------------------------------\n *youcompleteme-python-refactorings*\nPython refactorings ~\n\nThe following additional commands are supported for Python:\n\n- 'RefactorInline'\n- 'RefactorExtractVariable'\n- 'RefactorExtractFunction'\n\nSee the jedi docs [90] for what they do.\n\nSupported in filetypes: 'python'\n\n-------------------------------------------------------------------------------\n *youcompleteme-multi-file-refactor*\nMulti-file Refactor ~\n\nWhen a Refactor or FixIt command touches multiple files, YouCompleteMe attempts\nto apply those modifications to any existing open, visible buffer in the\ncurrent tab. If no such buffer can be found, YouCompleteMe opens the file in a\nnew small horizontal split at the top of the current window, applies the\nchange, and then _hides_ the window. **NOTE:** The buffer remains open, and\nmust be manually saved. A confirmation dialog is opened prior to doing this to\nremind you that this is about to happen.\n\nOnce the modifications have been made, the quickfix list (see ':help quickfix')\nis populated with the locations of all modifications. This can be used to\nreview all automatic changes made by using ':copen'. Typically, use the 'CTRL-W\n' combination to open the selected file in a new split. It is possible\nto customize how the quickfix window is opened by using the |YcmQuickFixOpened|\nautocommand.\n\nThe buffers are _not_ saved automatically. That is, you must save the modified\nbuffers manually after reviewing the changes from the quickfix list. Changes\ncan be undone using Vim's powerful undo features (see ':help undo'). Note that\nVim's undo is per-buffer, so to undo all changes, the undo commands must be\napplied in each modified buffer separately.\n\n**NOTE:** While applying modifications, Vim may find files that are already\nopen and have a swap file. The command is aborted if you select Abort or Quit\nin any such prompts. This leaves the Refactor operation partially complete and\nmust be manually corrected using Vim's undo features. The quickfix list is\n_not_ populated in this case. Inspect ':buffers' or equivalent (see ':help\nbuffers') to see the buffers that were opened by the command.\n\n-------------------------------------------------------------------------------\nThe *Format* subcommand\n\nThis command formats the whole buffer or some part of it according to the value\nof the Vim options 'shiftwidth' and 'expandtab' (see \":h 'sw'\" and ':h et'\nrespectively). To format a specific part of your document, you can either\nselect it in one of Vim's visual modes (see ':h visual-use') and run the\ncommand or directly enter the range on the command line, e.g. ':2,5YcmCompleter\nFormat' to format it from line 2 to line 5.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, java, javascript, go,\ntypescript, rust, cs'\n\n-------------------------------------------------------------------------------\nThe *OrganizeImports* subcommand\n\nThis command removes unused imports and sorts imports in the current file. It\ncan also group imports from the same module in TypeScript and resolve imports\nin Java.\n\nSupported in filetypes: 'java, javascript, typescript'\n\n-------------------------------------------------------------------------------\n *youcompleteme-miscellaneous-commands*\nMiscellaneous Commands ~\n\nThese commands are for general administration, rather than IDE-like features.\nThey cover things like the semantic engine server instance and compilation\nflags.\n\n-------------------------------------------------------------------------------\n *ExecuteCommand-args*\nThe 'ExecuteCommand ' subcommand ~\n\nSome LSP completers (currently only Java completers) support executing\nserver-specific commands. Consult the jdt.ls [17] documentation to find out\nwhat commands are supported and which arguments are expected.\n\nThe support for 'ExecuteCommand' was implemented to support plugins like\nVimspector [91] to debug java, but isn't limited to that specific use case.\n\n-------------------------------------------------------------------------------\nThe *RestartServer* subcommand\n\nRestarts the downstream semantic engine server for those semantic engines that\nwork as separate servers that YCM talks to.\n\nSupported in filetypes: 'c, cpp, objc, objcpp, cuda, cs, go, java, javascript,\nrust, typescript'\n\n-------------------------------------------------------------------------------\nThe *ReloadSolution* subcommand\n\nInstruct the Omnisharp-Roslyn server to clear its cache and reload all files\nfrom the disk. This is useful when files are added, removed, or renamed in the\nsolution, files are changed outside of Vim, or whenever Omnisharp-Roslyn cache\nis out-of-sync.\n\nSupported in filetypes: 'cs'\n\n-------------------------------------------------------------------------------\n *youcompleteme-functions*\nFunctions ~\n\n-------------------------------------------------------------------------------\nThe *youcompleteme#GetErrorCount* function\n\nGet the number of YCM Diagnostic errors. If no errors are present, this\nfunction returns 0.\n\nFor example:\n>\n call youcompleteme#GetErrorCount()\n<\nBoth this function and |youcompleteme#GetWarningCount| can be useful when\nintegrating YCM with other Vim plugins. For example, a lightline [92] user\ncould add a diagnostics section to their statusline which would display the\nnumber of errors and warnings.\n\n-------------------------------------------------------------------------------\nThe *youcompleteme#GetWarningCount* function\n\nGet the number of YCM Diagnostic warnings. If no warnings are present, this\nfunction returns 0.\n\nFor example:\n>\n call youcompleteme#GetWarningCount()\n<\n-------------------------------------------------------------------------------\n *youcompleteme#GetCommandResponse()*\nThe 'youcompleteme#GetCommandResponse( ... )' function ~\n\nRun a completer subcommand and return the result as a string. This can be\nuseful for example to display the |GetDoc| output in a popup window, e.g.:\n>\n let s:ycm_hover_popup = -1\n function s:Hover()\n let response = youcompleteme#GetCommandResponse( 'GetDoc' )\n if response == ''\n return\n endif\n \n call popup_hide( s:ycm_hover_popup )\n let s:ycm_hover_popup = popup_atcursor( balloon_split( response ), {} )\n endfunction\n \n \" CursorHold triggers in normal mode after a delay\n autocmd CursorHold * call s:Hover()\n \" Or, if you prefer, a mapping:\n nnoremap D :call Hover()\n<\n**NOTE**: This is only an example, for real hover support, see\n|g:ycm_auto_hover|.\n\nIf the completer subcommand result is not a string (for example, it's a FixIt\nor a Location), or if the completer subcommand raises an error, an empty string\nis returned, so that calling code does not have to check for complex error\nconditions.\n\nThe arguments to the function are the same as the arguments to the\n|:YcmCompleter| ex command, e.g. the name of the subcommand, followed by any\nadditional subcommand arguments. As with the 'YcmCompleter' command, if the\nfirst argument is 'ft=' the request is targeted at the specified\nfiletype completer. This is an advanced usage and not necessary in most cases.\n\nNOTE: The request is run synchronously and blocks Vim until the response is\nreceived, so we do not recommend running this as part of an autocommand that\ntriggers frequently.\n\n-------------------------------------------------------------------------------\n *youcompleteme#GetCommandResponseAsync()*\nThe 'youcompleteme#GetCommandResponseAsync( callback, ... )' function ~\n\nThis works exactly like 'youcompleteme#GetCommandResponse', except that instead\nof returning the result, you supply a 'callback' argument. This argument must\nbe a 'FuncRef' to a function taking a single argument 'response'. This callback\nwill be called with the command response at some point later, or immediately.\n\nAs with |youcompleteme#GetCommandResponse()|, this function will call the\ncallback with \"''\" (an empty string) if the request is not sent, or if there\nwas some sort of error.\n\nHere's an example that's similar to the one above:\n>\n let s:ycm_hover_popup = -1\n function! s:ShowDataPopup( response ) abort\n if response == ''\n return\n endif\n \n call popup_hide( s:ycm_hover_popup )\n let s:ycm_hover_popup = popup_atcursor( balloon_split( response ), {} )\n endfunction\n \n function! s:GetData() abort\n call youcompleteme#GetCommandResponseAsync(\n \\ function( 's:ShowDataPopup' ),\n \\ 'GetDoc' )\n endfunction\n \n autocommand CursorHold * call s:GetData()\n<\nAgain, see |g:ycm_auto_hover| for proper hover support.\n\n**NOTE**: The callback may be called immediately, in the stack frame that\ncalled this function.\n\n**NOTE**: Only one command request can be outstanding at once. Attempting to\nrequest a second response while the first is outstanding will result in the\nsecond callback being immediately called with \"''\".\n\n-------------------------------------------------------------------------------\n *youcompleteme-autocommands*\nAutocommands ~\n\n-------------------------------------------------------------------------------\nThe *YcmLocationOpened* autocommand\n\nThis 'User' autocommand is fired when YCM opens the location list window in\nresponse to the 'YcmDiags' command. By default, the location list window is\nopened to the bottom of the current window and its height is set to fit all\nentries. This behavior can be overridden by using the |YcmLocationOpened|\nautocommand which is triggered while the cursor is in the location list window.\nFor instance:\n>\n function! s:CustomizeYcmLocationWindow()\n \" Move the window to the top of the screen.\n wincmd K\n \" Set the window height to 5.\n 5wincmd _\n \" Switch back to the working window.\n wincmd p\n endfunction\n \n autocmd User YcmLocationOpened call s:CustomizeYcmLocationWindow()\n<\n-------------------------------------------------------------------------------\nThe *YcmQuickFixOpened* autocommand\n\nThis 'User' autocommand is fired when YCM opens the quickfix window in response\nto the 'GoTo*' and 'RefactorRename' subcommands. By default, the quickfix\nwindow is opened to full width at the bottom of the screen and its height is\nset to fit all entries. This behavior can be overridden by using the\n|YcmQuickFixOpened| autocommand which is triggered while the cursor is in the\nquickfix window. For instance:\n>\n function! s:CustomizeYcmQuickFixWindow()\n \" Move the window to the top of the screen.\n wincmd K\n \" Set the window height to 5.\n 5wincmd _\n endfunction\n \n autocmd User YcmQuickFixOpened call s:CustomizeYcmQuickFixWindow()\n<\n-------------------------------------------------------------------------------\nOptions ~\n\nAll options have reasonable defaults so if the plug-in works after installation\nyou don't need to change any options. These options can be configured in your\nvimrc script [37] by including a line like this:\n>\n let g:ycm_min_num_of_chars_for_completion = 1\n<\nNote that after changing an option in your vimrc script [37] you have to\nrestart ycmd [44] with the |:YcmRestartServer| command for the changes to take\neffect.\n\n-------------------------------------------------------------------------------\nThe *g:ycm_min_num_of_chars_for_completion* option\n\nThis option controls the number of characters the user needs to type before\nidentifier-based completion suggestions are triggered. For example, if the\noption is set to '2', then when the user types a second alphanumeric character\nafter a whitespace character, completion suggestions will be triggered. This\noption is NOT used for semantic completion.\n\nSetting this option to a high number like '99' effectively turns off the\nidentifier completion engine and just leaves the semantic engine.\n\nDefault: '2'\n>\n let g:ycm_min_num_of_chars_for_completion = 2\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_min_num_identifier_candidate_chars* option\n\nThis option controls the minimum number of characters that a completion\ncandidate coming from the identifier completer must have to be shown in the\npopup menu.\n\nA special value of '0' means there is no limit.\n\n**NOTE:** This option only applies to the identifier completer; it has no\neffect on the various semantic completers.\n\nDefault: '0'\n>\n let g:ycm_min_num_identifier_candidate_chars = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_max_num_candidates* option\n\nThis option controls the maximum number of semantic completion suggestions\nshown in the completion menu. This only applies to suggestions from semantic\ncompletion engines; see the 'g:ycm_max_identifier_candidates' option to limit\nthe number of suggestions from the identifier-based engine.\n\nA special value of '0' means there is no limit.\n\n**NOTE:** Setting this option to '0' or to a value greater than '100' is not\nrecommended as it will slow down completion when there is a very large number\nof suggestions.\n\nDefault: '50'\n>\n let g:ycm_max_num_candidates = 50\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_max_num_candidates_to_detail* option\n\nSome completion engines require completion candidates to be 'resolved' in order\nto get detailed info such as inline documentation, method signatures, etc. This\ninformation is displayed by YCM in the preview window, or if 'completeopt'\ncontains 'popup', in the info popup next to the completion menu.\n\nBy default, if the info popup is in use, and there are more than 10 candidates,\nYCM will defer resolving candidates until they are selected in the completion\nmenu. Otherwise, YCM must resolve the details upfront, which can be costly.\n\nIf neither 'popup' nor 'preview' are in 'completeopt', YCM disables resolving\naltogether as the information would not be displayed.\n\nThis setting can be used to override these defaults and controls the number of\ncompletion candidates that should be resolved upfront. Typically users do not\nneed to change this, as YCM will work out an appropriate value based on your\n'completeopt' and |g:ycm_add_preview_to_completeopt| settings. However, you may\noverride this calculation by setting this value to a number:\n\n- '-1' - Resolve all candidates upfront\n- '0' - Never resolve any candidates upfront.\n- '> 0' - Resolve up to this many candidates upfront. If the number of\n candidates is greater than this value, no candidates are resolved.\n\nIn the latter two cases, if 'completeopt' contains 'popup', then candidates are\nresolved on demand asynchronously.\n\nDefault:\n\n- '0' if neither 'popup' nor 'preview' are in 'completeopt'.\n- '10' if 'popup' is in completeopt.\n- '-1' if 'preview' is in completeopt.\n\nExample:\n>\n let g:ycm_max_num_candidates_to_detail = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_max_num_identifier_candidates* option\n\nThis option controls the maximum number of completion suggestions from the\nidentifier-based engine shown in the completion menu.\n\nA special value of '0' means there is no limit.\n\n**NOTE:** Setting this option to '0' or to a value greater than '100' is not\nrecommended as it will slow down completion when there is a very large number\nof suggestions.\n\nDefault: '10'\n>\n let g:ycm_max_num_identifier_candidates = 10\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_auto_trigger* option\n\nWhen set to '0', this option turns off YCM's identifier completer (the\nas-you-type popup) _and_ the semantic triggers (the popup you'd get after\ntyping '.' or '->' in say C++). You can still force semantic completion with\nthe '' shortcut.\n\nIf you want to just turn off the identifier completer but keep the semantic\ntriggers, you should set |g:ycm_min_num_of_chars_for_completion| to a high\nnumber like '99'.\n\nWhen |g:ycm_auto_trigger| is '0', YCM sets the 'completefunc', so that you can\nmanually trigger normal completion using 'C-x C-u'.\n\nIf you want to map something else to trigger completion, such as 'C-d', then\nyou can map it to '(YCMComplete)'. For example:\n>\n let g:ycm_auto_trigger = 0\n imap (YCMComplete)\n<\nNOTE: It's not possible to map one of the keys in\n|g:ycm_key_list_select_completion| (or similar) to '(YCMComplete)'. In\npractice that means that you can't use '' for this.\n\nDefault: '1'\n>\n let g:ycm_auto_trigger = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_filetype_whitelist* option\n\nThis option controls for which Vim filetypes (see ':h filetype') should YCM be\nturned on. The option value should be a Vim dictionary with keys being filetype\nstrings (like 'python', 'cpp', etc.) and values being unimportant (the\ndictionary is used like a hash set, meaning that only the keys matter).\n\nThe '*' key is special and matches all filetypes. By default, the whitelist\ncontains only this '*' key.\n\nYCM also has a |g:ycm_filetype_blacklist| option that lists filetypes for which\nYCM shouldn't be turned on. YCM will work only in filetypes that both the\nwhitelist and the blacklist allow (the blacklist \"allows\" a filetype by _not_\nhaving it as a key).\n\nFor example, let's assume you want YCM to work in files with the 'cpp'\nfiletype. The filetype should then be present in the whitelist either directly\n('cpp' key in the whitelist) or indirectly through the special '*' key. It\nshould _not_ be present in the blacklist.\n\nFiletypes that are blocked by either of the lists will be completely ignored by\nYCM, meaning that neither the identifier-based completion engine nor the\nsemantic engine will operate in them.\n\nYou can get the filetype of the current file in Vim with ':set ft?'.\n\nDefault: \"{'*': 1}\"\n>\n let g:ycm_filetype_whitelist = {'*': 1}\n<\n** Completion in buffers with no filetype **\n\nThere is one exception to the above rule. YCM supports completion in buffers\nwith no filetype set, but this must be _explicitly_ whitelisted. To identify\nbuffers with no filetype, we use the 'ycm_nofiletype' pseudo-filetype. To\nenable completion in buffers with no filetype, set:\n>\n let g:ycm_filetype_whitelist = {\n \\ '*': 1,\n \\ 'ycm_nofiletype': 1\n \\ }\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_filetype_blacklist* option\n\nThis option controls for which Vim filetypes (see ':h filetype') should YCM be\nturned off. The option value should be a Vim dictionary with keys being\nfiletype strings (like 'python', 'cpp', etc.) and values being unimportant (the\ndictionary is used like a hash set, meaning that only the keys matter).\n\nSee the |g:ycm_filetype_whitelist| option for more details on how this works.\n\nDefault: '[see next line]'\n>\n let g:ycm_filetype_blacklist = {\n \\ 'tagbar': 1,\n \\ 'notes': 1,\n \\ 'markdown': 1,\n \\ 'netrw': 1,\n \\ 'unite': 1,\n \\ 'text': 1,\n \\ 'vimwiki': 1,\n \\ 'pandoc': 1,\n \\ 'infolog': 1,\n \\ 'leaderf': 1,\n \\ 'mail': 1\n \\}\n<\nIn addition, 'ycm_nofiletype' (representing buffers with no filetype set) is\nblacklisted if 'ycm_nofiletype' is not _explicitly_ whitelisted (using\n|g:ycm_filetype_whitelist|).\n\n-------------------------------------------------------------------------------\nThe *g:ycm_filetype_specific_completion_to_disable* option\n\nThis option controls for which Vim filetypes (see ':h filetype') should the YCM\nsemantic completion engine be turned off. The option value should be a Vim\ndictionary with keys being filetype strings (like 'python', 'cpp', etc.) and\nvalues being unimportant (the dictionary is used like a hash set, meaning that\nonly the keys matter). The listed filetypes will be ignored by the YCM semantic\ncompletion engine, but the identifier-based completion engine will still\ntrigger in files of those filetypes.\n\nNote that even if semantic completion is not turned off for a specific\nfiletype, you will not get semantic completion if the semantic engine does not\nsupport that filetype.\n\nYou can get the filetype of the current file in Vim with ':set ft?'.\n\nDefault: '[see next line]'\n>\n let g:ycm_filetype_specific_completion_to_disable = {\n \\ 'gitcommit': 1\n \\}\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_filepath_blacklist* option\n\nThis option controls for which Vim filetypes (see ':h filetype') should\nfilepath completion be disabled. The option value should be a Vim dictionary\nwith keys being filetype strings (like 'python', 'cpp', etc.) and values being\nunimportant (the dictionary is used like a hash set, meaning that only the keys\nmatter).\n\nThe '*' key is special and matches all filetypes. Use this key if you want to\ncompletely disable filepath completion:\n>\n let g:ycm_filepath_blacklist = {'*': 1}\n<\nYou can get the filetype of the current file in Vim with ':set ft?'.\n\nDefault: '[see next line]'\n>\n let g:ycm_filepath_blacklist = {\n \\ 'html': 1,\n \\ 'jsx': 1,\n \\ 'xml': 1,\n \\}\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_show_diagnostics_ui* option\n\nWhen set, this option turns on YCM's diagnostic display features. See the\n_Diagnostic display_ section in the _User Manual_ for more details.\n\nSpecific parts of the diagnostics UI (like the gutter signs, text highlighting,\ndiagnostic echo, and auto location list population) can be individually turned\non or off. See the other options below for details.\n\nNote that YCM's diagnostics UI is only supported for C-family languages.\n\nWhen set, this option also makes YCM remove all Syntastic checkers set for the\n'c', 'cpp', 'objc', 'objcpp', and 'cuda' filetypes since this would conflict\nwith YCM's own diagnostics UI.\n\nIf you're using YCM's identifier completer in C-family languages but cannot use\nthe clang-based semantic completer for those languages _and_ want to use the\nGCC Syntastic checkers, unset this option.\n\nDefault: '1'\n>\n let g:ycm_show_diagnostics_ui = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_error_symbol* option\n\nYCM will use the value of this option as the symbol for errors in the Vim\ngutter.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the 'g:syntastic_error_symbol' option\nbefore using this option's default.\n\nDefault: '>>'\n>\n let g:ycm_error_symbol = '>>'\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_warning_symbol* option\n\nYCM will use the value of this option as the symbol for warnings in the Vim\ngutter.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the 'g:syntastic_warning_symbol' option\nbefore using this option's default.\n\nDefault: '>>'\n>\n let g:ycm_warning_symbol = '>>'\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_enable_diagnostic_signs* option\n\nWhen this option is set, YCM will put icons in Vim's gutter on lines that have\na diagnostic set. Turning this off will also turn off the 'YcmErrorLine' and\n'YcmWarningLine' highlighting.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the 'g:syntastic_enable_signs' option\nbefore using this option's default.\n\nDefault: '1'\n>\n let g:ycm_enable_diagnostic_signs = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_enable_diagnostic_highlighting* option\n\nWhen this option is set, YCM will highlight regions of text that are related to\nthe diagnostic that is present on a line, if any.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the 'g:syntastic_enable_highlighting'\noption before using this option's default.\n\nDefault: '1'\n>\n let g:ycm_enable_diagnostic_highlighting = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_echo_current_diagnostic* option\n\nWhen this option is set to 1, YCM will echo the text of the diagnostic present\non the current line when you move your cursor to that line. If a |FixIt| is\navailable for the current diagnostic, then '(FixIt)' is appended.\n\nIf you have a Vim that supports virtual text, you can set this option to the\nstring 'virtual-text', and the diagnostic will be displayed inline with the\ntext, right aligned in the window and wrapping to the next line if there is not\nenough space, for example:\n\n Image: Virtual text diagnostic demo (see reference [93])\n\n Image: Virtual text diagnostic demo (see reference [94])\n\n**NOTE**: It's _strongly_ recommended to also set\n|g:ycm_update_diagnostics_in_insert_mode| to '0' when using 'virtual-text' for\ndiagnostics. This is due to the increased amount of distraction provided by\ndrawing diagnostics next to your input position.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the 'g:syntastic_echo_current_error'\noption before using this option's default.\n\nDefault: '1'\n\nValid values:\n\n- '0' - disabled\n- '1' - echo diagnostic to the command area\n- \"'virtual-text'\" - display the dignostic to the right of the line in the\n window using virtual text\n>\n let g:ycm_echo_current_diagnostic = 1\n \" Or, when you have Vim supporting virtual text\n let g:ycm_echo_current_diagnostic = 'virtual-text'\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_auto_hover* option\n\nThis option controls whether or not YCM shows documentation in a popup at the\ncursor location after a short delay. Only supported in Vim.\n\nWhen this option is set to \"'CursorHold'\", the popup is displayed on the\n'CursorHold' autocommand. See ':help CursorHold' for the details, but this\nmeans that it is displayed after 'updatetime' milliseconds. When set to an\nempty string, the popup is not automatically displayed.\n\nIn addition to this setting, there is the '(YCMHover)' mapping, which can\nbe used to manually trigger or hide the popup (it works like a toggle). For\nexample:\n>\n nmap D (YCMHover)\n<\nAfter dismissing the popup with this mapping, it will not be automatically\ntriggered again until the cursor is moved (i.e. 'CursorMoved' autocommand).\n\nThe displayed documentation depends on what the completer for the current\nlanguage supports. It's selected heuristically in this order of preference:\n\n1. 'GetHover' with 'markdown' syntax\n2. |GetDoc| with no syntax\n3. |GetType| with the syntax of the current file.\n\nYou can customise this by manually setting up 'b:ycm_hover' to your liking.\nThis buffer-local variable can be set to a dictionary with the following keys:\n\n- 'command': The YCM completer subcommand which should be run on hover\n- 'syntax': The syntax to use (as in 'set syntax=') in the popup window for\n highlighting.\n- 'popup_params': The params passed to a popup window which gets opened.\n\nFor example, to use C/C++ syntax highlighting in the popup for C-family\nlanguages, add something like this to your vimrc:\n>\n augroup MyYCMCustom\n autocmd!\n autocmd FileType c,cpp let b:ycm_hover = {\n \\ 'command': 'GetDoc',\n \\ 'syntax': &filetype\n \\ }\n augroup END\n<\nYou can also modify the opened popup with 'popup_params' key. For example, you\ncan limit the popup's maximum width and add a border to it:\n\n\n>\n augroup MyYCMCustom\n autocmd!\n autocmd FileType c,cpp let b:ycm_hover = {\n \\ 'command': 'GetDoc',\n \\ 'syntax': &filetype\n \\ 'popup_params': {\n \\ 'maxwidth': 80,\n \\ 'border': [],\n \\ 'borderchars': ['─', '│', '─', '│', '┌', '┐', '┘', '└'],\n \\ },\n \\ }\n augroup END\n<\nSee ':help popup_create-arguments' for the list of available popup window\noptions.\n\nDefault: \"'CursorHold'\"\n\n-------------------------------------------------------------------------------\nThe *g:ycm_filter_diagnostics* option\n\nThis option controls which diagnostics will be rendered by YCM. This option\nholds a dictionary of key-values, where the keys are Vim's filetype strings\ndelimited by commas and values are dictionaries describing the filter.\n\nA filter is a dictionary of key-values, where the keys are the type of filter,\nand the value is a list of arguments to that filter. In the case of just a\nsingle item in the list, you may omit the brackets and just provide the\nargument directly. If any filter matches a diagnostic, it will be dropped and\nYCM will not render it.\n\nThe following filter types are supported:\n\n- \"regex\": Accepts a string regular expression [95]. This type matches when\n the regex (treated as case-insensitive) is found anywhere in the diagnostic\n text ('re.search', not 're.match')\n\n- \"level\": Accepts a string level, either \"warning\" or \"error.\" This type\n matches when the diagnostic has the same level, that is, specifying 'level:\n \"error\"' will remove **all** errors from the diagnostics.\n\n**NOTE:** The regex syntax is **NOT** Vim's, it's Python's [95].\n\nDefault: '{}'\n\nThe following example will do, for Java filetype only: - Remove **all** error\nlevel diagnostics, and, - Also remove anything that contains 'taco'\n>\n let g:ycm_filter_diagnostics = {\n \\ \"java\": {\n \\ \"regex\": [ \"ta.+co\", ... ],\n \\ \"level\": \"error\",\n \\ ...\n \\ }\n \\ }\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_always_populate_location_list* option\n\nWhen this option is set, YCM will populate the location list automatically\nevery time it gets new diagnostic data. This option is off by default so as not\nto interfere with other data you might have placed in the location list.\n\nSee ':help location-list' in Vim to learn more about the location list.\n\nThis option is part of the Syntastic compatibility layer; if the option is not\nset, YCM will fall back to the value of the\n'g:syntastic_always_populate_loc_list' option before using this option's\ndefault.\n\nNote: if YCM's errors aren't visible, it might be that YCM is updating an older\nlocation list. See ':help :lhistory' and ':lolder'.\n\nDefault: '0'\n>\n let g:ycm_always_populate_location_list = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_open_loclist_on_ycm_diags* option\n\nWhen this option is set, |:YcmDiags| will automatically open the location list\nafter forcing a compilation and filling the list with diagnostic data.\n\nSee ':help location-list' in Vim to learn more about the location list.\n\nDefault: '1'\n>\n let g:ycm_open_loclist_on_ycm_diags = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_complete_in_comments* option\n\nWhen this option is set to '1', YCM will show the completion menu even when\ntyping inside comments.\n\nDefault: '0'\n>\n let g:ycm_complete_in_comments = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_complete_in_strings* option\n\nWhen this option is set to '1', YCM will show the completion menu even when\ntyping inside strings.\n\nNote that this is turned on by default so that you can use the filename\ncompletion inside strings. This is very useful for instance in C-family files\nwhere typing '#include \"' will trigger the start of filename completion. If you\nturn off this option, you will turn off filename completion in such situations\nas well.\n\nDefault: '1'\n>\n let g:ycm_complete_in_strings = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_collect_identifiers_from_comments_and_strings* option\n\nWhen this option is set to '1', YCM's identifier completer will also collect\nidentifiers from strings and comments. Otherwise, the text in comments and\nstrings will be ignored.\n\nDefault: '0'\n>\n let g:ycm_collect_identifiers_from_comments_and_strings = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_collect_identifiers_from_tags_files* option\n\nWhen this option is set to '1', YCM's identifier completer will also collect\nidentifiers from tags files. The list of tags files to examine is retrieved\nfrom the 'tagfiles()' Vim function which examines the 'tags' Vim option. See\n\":h 'tags'\" for details.\n\nYCM will re-index your tags files if it detects that they have been modified.\n\nThe only supported tag format is the Exuberant Ctags format [96]. The format\nfrom \"plain\" ctags is NOT supported. Ctags needs to be called with the\n'--fields=+l' option (that's a lowercase 'L', not a one) because YCM needs the\n'language:' field in the tags output.\n\nSee the _FAQ_ for pointers if YCM does not appear to read your tag files.\n\nThis option is off by default because it makes Vim slower if your tags are on a\nnetwork directory.\n\nDefault: '0'\n>\n let g:ycm_collect_identifiers_from_tags_files = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_seed_identifiers_with_syntax* option\n\nWhen this option is set to '1', YCM's identifier completer will seed its\nidentifier database with the keywords of the programming language you're\nwriting.\n\nSince the keywords are extracted from the Vim syntax file for the filetype, all\nkeywords may not be collected, depending on how the syntax file was written.\nUsually at least 95% of the keywords are successfully extracted.\n\nDefault: '0'\n>\n let g:ycm_seed_identifiers_with_syntax = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_extra_conf_vim_data* option\n\nIf you're using semantic completion for C-family files, this option might come\nhandy; it's a way of sending data from Vim to your 'Settings' function in your\n'.ycm_extra_conf.py' file.\n\nThis option is supposed to be a list of VimScript expression strings that are\nevaluated for every request to the ycmd server [44] and then passed to your\n'Settings' function as a 'client_data' keyword argument.\n\nFor instance, if you set this option to \"['v:version']\", your 'Settings'\nfunction will be called like this:\n>\n # The '801' value is of course contingent on Vim 8.1; in 8.0 it would be '800'\n Settings( ..., client_data = { 'v:version': 801 } )\n<\nSo the 'client_data' parameter is a dictionary mapping Vim expression strings\nto their values at the time of the request.\n\nThe correct way to define parameters for your 'Settings' function:\n>\n def Settings( **kwargs ):\n<\nYou can then get to 'client_data' with \"kwargs['client_data']\".\n\nDefault: '[]'\n>\n let g:ycm_extra_conf_vim_data = []\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_server_python_interpreter* option\n\nYCM will by default search for an appropriate Python interpreter on your\nsystem. You can use this option to override that behavior and force the use of\na specific interpreter of your choosing.\n\n**NOTE:** This interpreter is only used for the ycmd server [44]. The YCM\nclient running inside Vim always uses the Python interpreter that's embedded\ninside Vim.\n\nDefault: \"''\"\n>\n let g:ycm_server_python_interpreter = ''\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_keep_logfiles* option\n\nWhen this option is set to '1', YCM and the ycmd completion server [44] will\nkeep the logfiles around after shutting down (they are deleted on shutdown by\ndefault).\n\nTo see where the log files are, call |:YcmDebugInfo|.\n\nDefault: '0'\n>\n let g:ycm_keep_logfiles = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_log_level* option\n\nThe logging level that YCM and the ycmd completion server [44] use. Valid\nvalues are the following, from most verbose to least verbose: - 'debug' -\n'info' - 'warning' - 'error' - 'critical'\n\nNote that 'debug' is _very_ verbose.\n\nDefault: 'info'\n>\n let g:ycm_log_level = 'info'\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_auto_start_csharp_server* option\n\nWhen set to '1', the OmniSharp-Roslyn server will be automatically started\n(once per Vim session) when you open a C# file.\n\nDefault: '1'\n>\n let g:ycm_auto_start_csharp_server = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_auto_stop_csharp_server* option\n\nWhen set to '1', the OmniSharp-Roslyn server will be automatically stopped upon\nclosing Vim.\n\nDefault: '1'\n>\n let g:ycm_auto_stop_csharp_server = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_csharp_server_port* option\n\nWhen g:ycm_auto_start_csharp_server is set to '1', specifies the port for the\nOmniSharp-Roslyn server to listen on. When set to '0' uses an unused port\nprovided by the OS.\n\nDefault: '0'\n>\n let g:ycm_csharp_server_port = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_csharp_insert_namespace_expr* option\n\nBy default, when YCM inserts a namespace, it will insert the 'using' statement\nunder the nearest 'using' statement. You may prefer that the 'using' statement\nis inserted somewhere, for example, to preserve sorting. If so, you can set\nthis option to override this behavior.\n\nWhen this option is set, instead of inserting the 'using' statement itself, YCM\nwill set the global variable 'g:ycm_namespace_to_insert' to the namespace to\ninsert, and then evaluate this option's value as an expression. The option's\nexpression is responsible for inserting the namespace - the default insertion\nwill not occur.\n\nDefault: ''\n>\n let g:ycm_csharp_insert_namespace_expr = ''\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_add_preview_to_completeopt* option\n\nWhen this option is set to '1', YCM will add the 'preview' string to Vim's\n'completeopt' option (see ':h completeopt'). If your 'completeopt' option\nalready has 'preview' set, there will be no effect. Alternatively, when set to\n'popup' and your version of Vim supports popup windows (see ':help popup'), the\n'popup' string will be used instead. You can see the current state of your\n'completeopt' setting with ':set completeopt?' (yes, the question mark is\nimportant).\n\nWhen 'preview' is present in 'completeopt', YCM will use the 'preview' window\nat the top of the file to store detailed information about the current\ncompletion candidate (but only if the candidate came from the semantic engine).\nFor instance, it would show the full function prototype and all the function\noverloads in the window if the current completion is a function name.\n\nWhen 'popup' is present in 'completeopt', YCM will instead use a 'popup' window\nto the side of the completion popup for storing detailed information about the\ncurrent completion candidate. In addition, YCM may truncate the detailed\ncompletion information in order to give the popup sufficient room to display\nthat detailed information.\n\nDefault: '0'\n>\n let g:ycm_add_preview_to_completeopt = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_autoclose_preview_window_after_completion* option\n\nWhen this option is set to '1', YCM will auto-close the 'preview' window after\nthe user accepts the offered completion string. If there is no 'preview' window\ntriggered because there is no 'preview' string in 'completeopt', this option is\nirrelevant. See the |g:ycm_add_preview_to_completeopt| option for more details.\n\nDefault: '0'\n>\n let g:ycm_autoclose_preview_window_after_completion = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_autoclose_preview_window_after_insertion* option\n\nWhen this option is set to '1', YCM will auto-close the 'preview' window after\nthe user leaves insert mode. This option is irrelevant if\n|g:ycm_autoclose_preview_window_after_completion| is set or if no 'preview'\nwindow is triggered. See the |g:ycm_add_preview_to_completeopt| option for more\ndetails.\n\nDefault: '0'\n>\n let g:ycm_autoclose_preview_window_after_insertion = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_max_diagnostics_to_display* option\n\nThis option controls the maximum number of diagnostics shown to the user when\nerrors or warnings are detected in the file. This option is only relevant for\nthe C-family, C#, Java, JavaScript, and TypeScript languages.\n\nA special value of '0' means there is no limit.\n\nDefault: '30'\n>\n let g:ycm_max_diagnostics_to_display = 30\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_key_list_select_completion* option\n\nThis option controls the key mappings used to select the first completion\nstring. Invoking any of them repeatedly cycles forward through the completion\nlist.\n\nSome users like adding '' to this list.\n\nDefault: \"['', '']\"\n>\n let g:ycm_key_list_select_completion = ['', '']\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_key_list_previous_completion* option\n\nThis option controls the key mappings used to select the previous completion\nstring. Invoking any of them repeatedly cycles backward through the completion\nlist.\n\nNote that one of the defaults is '' which means Shift-TAB. That mapping\nwill probably only work in GUI Vim (Gvim or MacVim) and not in plain console\nVim because the terminal usually does not forward modifier key combinations to\nVim.\n\nDefault: \"['', '']\"\n>\n let g:ycm_key_list_previous_completion = ['', '']\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_key_list_stop_completion* option\n\nThis option controls the key mappings used to close the completion menu. This\nis useful when the menu is blocking the view, when you need to insert the\n'' character, or when you want to expand a snippet from UltiSnips [25] and\nnavigate through it.\n\nDefault: \"['']\"\n>\n let g:ycm_key_list_stop_completion = ['']\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_key_invoke_completion* option\n\nThis option controls the key mapping used to invoke the completion menu for\nsemantic completion. By default, semantic completion is triggered automatically\nafter typing characters appropriate for the language, such as '.', '->', '::',\netc. in insert mode (if semantic completion support has been compiled in). This\nkey mapping can be used to trigger semantic completion anywhere. Useful for\nsearching for top-level functions and classes.\n\nConsole Vim (not Gvim or MacVim) passes '' to Vim when the user types\n'' so YCM will make sure that '' is used in the map command when\nyou're editing in console Vim, and '' in GUI Vim. This means that you\ncan just press '' in both the console and GUI Vim and YCM will do the\nright thing.\n\nSetting this option to an empty string will make sure no mapping is created.\n\nDefault: ''\n>\n let g:ycm_key_invoke_completion = ''\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_key_detailed_diagnostics* option\n\nThis option controls the key mapping used to show the full diagnostic text when\nthe user's cursor is on the line with the diagnostic. It basically calls\n|:YcmShowDetailedDiagnostic|.\n\nSetting this option to an empty string will make sure no mapping is created.\n\nIf you prefer the detailed diagnostic to be shown in a popup, then 'let\ng:ycm_show_detailed_diag_in_popup=1'.\n\nDefault: 'd'\n>\n let g:ycm_key_detailed_diagnostics = 'd'\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_show_detailed_diag_in_popup* option\n\nMakes |:YcmShowDetailedDiagnostic| always show in a popup rather than echoing\nto the command line.\n\nDefault: 0\n>\n let g:ycm_show_detailed_diag_in_popup = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_global_ycm_extra_conf* option\n\nNormally, YCM searches for a '.ycm_extra_conf.py' file for compilation flags\n(see the User Guide for more details on how this works). This option specifies\na fallback path to a config file which is used if no '.ycm_extra_conf.py' is\nfound.\n\nYou can place such a global file anywhere in your filesystem.\n\nDefault: \"''\"\n>\n let g:ycm_global_ycm_extra_conf = ''\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_confirm_extra_conf* option\n\nWhen this option is set to '1' YCM will ask once per '.ycm_extra_conf.py' file\nif it is safe to be loaded. This is to prevent the execution of malicious code\nfrom a '.ycm_extra_conf.py' file you didn't write.\n\nTo selectively get YCM to ask/not ask about loading certain\n'.ycm_extra_conf.py' files, see the |g:ycm_extra_conf_globlist| option.\n\nDefault: '1'\n>\n let g:ycm_confirm_extra_conf = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_extra_conf_globlist* option\n\nThis option is a list that may contain several globbing patterns. If a pattern\nstarts with a '!' all '.ycm_extra_conf.py' files matching that pattern will be\nblacklisted, that is they won't be loaded and no confirmation dialog will be\nshown. If a pattern does not start with a '!' all files matching that pattern\nwill be whitelisted. Note that this option is not used when confirmation is\ndisabled using |g:ycm_confirm_extra_conf| and that items earlier in the list\nwill take precedence over the later ones.\n\nRules:\n\n- '*' matches everything\n- '?' matches any single character\n- '[seq]' matches any character in seq\n- '[!seq]' matches any char not in seq\n\nExample:\n>\n let g:ycm_extra_conf_globlist = ['~/dev/*','!~/*']\n<\n- The first rule will match everything contained in the '~/dev' directory so\n '.ycm_extra_conf.py' files from there will be loaded.\n\n- The second rule will match everything in the home directory so a\n '.ycm_extra_conf.py' file from there won't be loaded.\n\n- As the first rule takes precedence everything in the home directory\n excluding the '~/dev' directory will be blacklisted.\n\n**NOTE:** The glob pattern is first expanded with Python's\n'os.path.expanduser()' and then resolved with 'os.path.abspath()' before being\nmatched against the filename.\n\nDefault: '[]'\n>\n let g:ycm_extra_conf_globlist = []\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_filepath_completion_use_working_dir* option\n\nBy default, YCM's filepath completion will interpret relative paths like '../'\nas being relative to the folder of the file of the currently active buffer.\nSetting this option will force YCM to always interpret relative paths as being\nrelative to Vim's current working directory.\n\nDefault: '0'\n>\n let g:ycm_filepath_completion_use_working_dir = 0\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_semantic_triggers* option\n\nThis option controls the character-based triggers for the various semantic\ncompletion engines. The option holds a dictionary of key-values, where the keys\nare Vim's filetype strings delimited by commas and values are lists of strings,\nwhere the strings are the triggers.\n\nSetting key-value pairs on the dictionary _adds_ semantic triggers to the\ninternal default set (listed below). You cannot remove the default triggers,\nonly add new ones.\n\nA \"trigger\" is a sequence of one or more characters that trigger semantic\ncompletion when typed. For instance, C++ ('cpp' filetype) has '.' listed as a\ntrigger. So when the user types 'foo.', the semantic engine will trigger and\nserve 'foo''s list of member functions and variables. Since C++ also has '->'\nlisted as a trigger, the same thing would happen when the user typed 'foo->'.\n\nIt's also possible to use a regular expression as a trigger. You have to prefix\nyour trigger with 're!' to signify it's a regex trigger. For instance,\n're!\\w+\\.' would only trigger after the '\\w+\\.' regex matches.\n\n**NOTE:** The regex syntax is **NOT** Vim's, it's Python's [95].\n\nDefault: '[see next line]'\n>\n let g:ycm_semantic_triggers = {\n \\ 'c': ['->', '.'],\n \\ 'objc': ['->', '.', 're!\\[[_a-zA-Z]+\\w*\\s', 're!^\\s*[^\\W\\d]\\w*\\s',\n \\ 're!\\[.*\\]\\s'],\n \\ 'ocaml': ['.', '#'],\n \\ 'cpp,cuda,objcpp': ['->', '.', '::'],\n \\ 'perl': ['->'],\n \\ 'php': ['->', '::'],\n \\ 'cs,d,elixir,go,groovy,java,javascript,julia,perl6,python,scala,typescript,vb': ['.'],\n \\ 'ruby,rust': ['.', '::'],\n \\ 'lua': ['.', ':'],\n \\ 'erlang': [':'],\n \\ }\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_cache_omnifunc* option\n\nSome omnicompletion engines do not work well with the YCM cache—in particular,\nthey might not produce all possible results for a given prefix. By unsetting\nthis option you can ensure that the omnicompletion engine is re-queried on\nevery keypress. That will ensure all completions will be presented but might\ncause stuttering and lag if the omnifunc is slow.\n\nDefault: '1'\n>\n let g:ycm_cache_omnifunc = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_use_ultisnips_completer* option\n\nBy default, YCM will query the UltiSnips plugin for possible completions of\nsnippet triggers. This option can turn that behavior off.\n\nDefault: '1'\n>\n let g:ycm_use_ultisnips_completer = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_goto_buffer_command* option\n\nDefines where 'GoTo*' commands result should be opened. Can take one of the\nfollowing values: \"'same-buffer'\", \"'split'\", or \"'split-or-existing-window'\".\nIf this option is set to the \"'same-buffer'\" but current buffer can not be\nswitched (when buffer is modified and 'nohidden' option is set), then result\nwill be opened in a split. When the option is set to\n\"'split-or-existing-window'\", if the result is already open in a window of the\ncurrent tab page (or any tab pages with the ':tab' modifier; see below), it\nwill jump to that window. Otherwise, the result will be opened in a split as if\nthe option was set to \"'split'\".\n\nTo customize the way a new window is split, prefix the 'GoTo*' command with one\nof the following modifiers: ':aboveleft', ':belowright', ':botright',\n':leftabove', ':rightbelow', ':topleft', and ':vertical'. For instance, to\nsplit vertically to the right of the current window, run the command:\n>\n :rightbelow vertical YcmCompleter GoTo\n<\nTo open in a new tab page, use the ':tab' modifier with the \"'split'\" or\n\"'split-or-existing-window'\" options e.g.:\n>\n :tab YcmCompleter GoTo\n<\nDefault: \"'same-buffer'\"\n>\n let g:ycm_goto_buffer_command = 'same-buffer'\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_disable_for_files_larger_than_kb* option\n\nDefines the max size (in Kb) for a file to be considered for completion. If\nthis option is set to 0 then no check is made on the size of the file you're\nopening.\n\nDefault: 1000\n>\n let g:ycm_disable_for_files_larger_than_kb = 1000\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_use_clangd* option\n\nThis option controls whether **clangd** should be used as a completion engine\nfor C-family languages. Can take one of the following values: '1', '0', with\nmeanings:\n\n- '1': YCM will use clangd if clangd binary exists in third party or it was\n provided with 'ycm_clangd_binary_path' option.\n- '0': YCM will never use clangd completer.\n\nDefault: '1'\n>\n let g:ycm_use_clangd = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_clangd_binary_path* option\n\nWhen 'ycm_use_clangd' option is set to '1', this option sets the path to\n**clangd** binary.\n\nDefault: \"''\"\n>\n let g:ycm_clangd_binary_path = ''\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_clangd_args* option\n\nThis option controls the command line arguments passed to the clangd binary. It\nappends new options and overrides the existing ones.\n\nDefault: '[]'\n>\n let g:ycm_clangd_args = []\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_clangd_uses_ycmd_caching* option\n\nThis option controls which ranking and filtering algorithm to use for\ncompletion items. It can take values:\n\n- '1': Uses ycmd's caching and filtering logic.\n- '0': Uses clangd's caching and filtering logic.\n\nDefault: '1'\n>\n let g:ycm_clangd_uses_ycmd_caching = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_language_server* option\n\nThis option lets YCM use an arbitrary Language Server Protocol (LSP) server,\nnot unlike many other completion systems. The officially supported completers\nare favoured over custom LSP ones, so overriding an existing completer means\nfirst making sure YCM won't choose that existing completer in the first place.\n\nA simple working example of this option can be found in the section called\n\"Semantic Completion for Other Languages\".\n\nMany working examples can be found in the YCM lsp-examples [80] repository.\n\nDefault: '[]'\n>\n let g:ycm_language_server = []\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_disable_signature_help* option\n\nThis option allows you to disable all signature help for all completion\nengines. There is no way to disable it per-completer.\n\nDefault: '0'\n>\n \" Disable signature help\n let g:ycm_disable_signature_help = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_signature_help_disable_syntax* option\n\nSet this to 1 to disable syntax highlighting in the signature help popup. Thiis\ncan help if your colourscheme doesn't work well with the default highliting and\ninverse video.\n\nDefault: '0'\n>\n \" Disable signature help syntax highliting\n let g:ycm_signature_help_disable_syntax = 1\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_gopls_binary_path* option\n\nIn case the system-wide 'gopls' binary is newer than the bundled one, setting\nthis option to the path of the system-wide 'gopls' would make YCM use that one\ninstead.\n\nIf the path is just 'gopls', YCM will search in '$PATH'.\n\n-------------------------------------------------------------------------------\nThe *g:ycm_gopls_args* option\n\nSimilar to the |g:ycm_clangd_args|, this option allows passing additional flags\nto the 'gopls' command line.\n\nDefault: '[]'\n>\n let g:ycm_gopls_args = []\n<\n-------------------------------------------------------------------------------\nThe *g:ycm_rls_binary_path* and 'g:ycm_rustc_binary_path' options\n\nYCM no longer uses RLS for rust, and these options are therefore no longer\nsupported.\n\nTo use a custom rust-analyzer, see |g:ycm_rust_toolchain_root|.\n\n-------------------------------------------------------------------------------\nThe *g:ycm_rust_toolchain_root* option\n\nOptionally specify the path to a custom rust toolchain including at least a\nsupported version of 'rust-analyzer'.\n\n-------------------------------------------------------------------------------\nThe *g:ycm_tsserver_binary_path* option\n\nSimilar to the 'gopls' path, this option tells YCM where is the TSServer\nexecutable located.\n\n-------------------------------------------------------------------------------\nThe *g:ycm_roslyn_binary_path* option\n\nSimilar to the 'gopls' path, this option tells YCM where is the\nOmnisharp-Roslyn executable located.\n\n-------------------------------------------------------------------------------\nThe *g:ycm_update_diagnostics_in_insert_mode* option\n\nWith async diagnostics, LSP servers might send new diagnostics mid-typing. If\nseeing these new diagnostics while typing is not desired, this option can be\nset to 0.\n\nWhen this option is set to '0', diagnostic signs, virtual text, and highlights\nare cleared when entering insert mode and replaced when leaving insert mode.\nThis reduces visual noise while editing.\n\nIn addition, this option is recommended when |g:ycm_echo_current_diagnostic| is\nset to 'virtual-text' as it prevents updating the virtual text while you are\ntyping.\n\nDefault: '1'\n>\n let g:ycm_update_diagnostics_in_insert_mode = 1\n<\n-------------------------------------------------------------------------------\n *youcompleteme-faq*\nFAQ ~\n\nThe FAQ section has been moved to the wiki [8].\n\n-------------------------------------------------------------------------------\n *youcompleteme-contributor-code-of-conduct*\nContributor Code of Conduct ~\n\nPlease note that this project is released with a Contributor Code of Conduct\n[97]. By participating in this project you agree to abide by its terms.\n\n-------------------------------------------------------------------------------\n *youcompleteme-contact*\nContact ~\n\nIf you have questions about the plugin or need help, please join the Gitter\nroom [1] or use the ycm-users [98] mailing list.\n\nIf you have bug reports or feature suggestions, please use the issue tracker\n[99]. Before you do, please carefully read CONTRIBUTING.md [100] as this asks\nfor important diagnostics which the team will use to help get you going.\n\nThe latest version of the plugin is available at\nhttps://ycm-core.github.io/YouCompleteMe/.\n\nThe author's homepage is https://val.markovic.io.\n\nPlease do **NOT** go to #vim, Reddit, or Stack Overflow for support. Please\ncontact the YouCompleteMe maintainers directly using the contact details.\n\n-------------------------------------------------------------------------------\n *youcompleteme-license*\nLicense ~\n\nThis software is licensed under the GPL v3 license [101]. © 2015-2018\nYouCompleteMe contributors\n\n-------------------------------------------------------------------------------\n *youcompleteme-sponsorship*\nSponsorship ~\n\nIf you like YCM so much that you're willing to part with your hard-earned cash,\nplease consider donating to one of the following charities, which are\nmeaningful to the current maintainers (in no particular order):\n\n- Hector's Greyhound Rescue [102]\n- Be Humane [103]\n- Cancer Research UK [104]\n- ICCF Holland [105]\n- Any charity of your choosing.\n\nPlease note: The YCM maintainers do not specifically endorse nor necessarily\nhave any relationship with the above charities. Disclosure: It is noted that\none key maintainer is a family with Trustees of Greyhound Rescue Wales.\n\n===============================================================================\n *youcompleteme-references*\nReferences ~\n\n[1] https://gitter.im/Valloric/YouCompleteMe\n[2] https://img.shields.io/gitter/room/Valloric/YouCompleteMe.svg\n[3] https://dev.azure.com/YouCompleteMe/YCM/_build?definitionId=3&branchName=master\n[4] https://dev.azure.com/YouCompleteMe/YCM/_apis/build/status/ycm-core.YouCompleteMe?branchName=master\n[5] https://codecov.io/gh/ycm-core/YouCompleteMe\n[6] https://img.shields.io/codecov/c/github/ycm-core/YouCompleteMe/master.svg\n[7] https://github.com/ycm-core/YouCompleteMe/wiki/Troubleshooting-steps-for-ycmd-server-SHUT-DOWN\n[8] https://github.com/ycm-core/YouCompleteMe/wiki/FAQ\n[9] https://github.com/ycm-core/YouCompleteMe/issues/4134#issuecomment-1446235584\n[10] https://www.vim.org/\n[11] https://clang.llvm.org/extra/clangd.html\n[12] https://github.com/davidhalter/jedi\n[13] https://github.com/OmniSharp/omnisharp-roslyn\n[14] https://github.com/golang/go/wiki/gopls\n[15] https://github.com/Microsoft/TypeScript/tree/master/src/server\n[16] https://rust-analyzer.github.io\n[17] https://github.com/eclipse/eclipse.jdt.ls\n[18] https://i.imgur.com/0OP4ood.gif\n[19] https://en.wikipedia.org/wiki/Subsequence\n[20] https://github.com/scrooloose/syntastic\n[21] https://user-images.githubusercontent.com/10026824/34471853-af9cf32a-ef53-11e7-8229-de534058ddc4.gif\n[22] https://user-images.githubusercontent.com/10584846/58738348-5060da80-83fd-11e9-9537-d07fdbf4554c.gif\n[23] https://i.imgur.com/nmUUbdl.gif\n[24] https://user-images.githubusercontent.com/10584846/80312146-91af6500-87db-11ea-996b-7396f3134d1f.gif\n[25] https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt\n[26] https://github.com/VundleVim/Vundle.vim#about\n[27] mono-install-macos\n[28] https://macvim-dev.github.io/macvim/\n[29] https://brew.sh\n[30] https://www.mono-project.com/download/stable/\n[31] https://golang.org/doc/install\n[32] https://docs.npmjs.com/getting-started/installing-node#1-install-nodejs--npm\n[33] https://adoptium.net/en-GB/temurin/releases\n[34] https://github.com/ycm-core/YouCompleteMe/wiki/Building-Vim-from-source\n[35] https://www.mono-project.com/download/stable/#download-lin\n[36] https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16\n[37] https://vimhelp.appspot.com/starting.txt.html#vimrc\n[38] https://github.com/vim/vim-win32-installer/releases\n[39] https://www.python.org/downloads/windows/\n[40] https://cmake.org/download/\n[41] https://stackoverflow.com/questions/6319274/how-do-i-run-msbuild-from-the-command-line-using-windows-sdk-7-1\n[42] https://github.com/ycm-core/YouCompleteMe/wiki/Full-Installation-Guide\n[43] https://www.unicode.org/glossary/#diacritic\n[44] https://github.com/ycm-core/ycmd\n[45] https://github.com/ycm-core/ycmd/pull/1255\n[46] https://user-images.githubusercontent.com/10584846/173137003-a265e8b0-84db-4993-98f0-03ee81b9de94.png\n[47] https://user-images.githubusercontent.com/10584846/173137012-7547de0b-145f-45fa-ace3-18943acd2141.png\n[48] https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_semanticTokens\n[49] https://user-images.githubusercontent.com/10584846/185708054-68074fc0-e50c-4a65-887c-da6f372b8982.png\n[50] https://user-images.githubusercontent.com/10584846/185708156-b52970ce-005f-4f0b-97e7-bdf8feeefedc.png\n[51] https://user-images.githubusercontent.com/10584846/185708242-e42dab6f-1847-46f1-8585-2d9f2c8a76dc.png\n[52] https://github.com/ycm-core/YouCompleteMe/wiki/C-family-Semantic-Completion-through-libclang\n[53] https://clang.llvm.org/docs/JSONCompilationDatabase.html\n[54] https://ninja-build.org/manual.html\n[55] https://pypi.org/project/compiledb/\n[56] https://github.com/rizsotto/Bear\n[57] https://raw.githubusercontent.com/ycm-core/ycmd/66030cd94299114ae316796f3cad181cac8a007c/.ycm_extra_conf.py\n[58] https://github.com/rdnetto/YCM-Generator\n[59] https://github.com/eclipse/eclipse.jdt.ls/blob/master/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/preferences/Preferences.java\n[60] https://help.eclipse.org/oxygen/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fproject_description_file.html\n[61] https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html\n[62] https://docs.gradle.org/current/userguide/tutorial_java_projects.html\n[63] https://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.jdt.doc.isv%2Freference%2Fapi%2Forg%2Feclipse%2Fjdt%2Fcore%2FIClasspathEntry.html\n[64] https://github.com/ycm-core/ycmd/tree/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_eclipse_project\n[65] https://github.com/ycm-core/ycmd/blob/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_maven_project/pom.xml\n[66] https://github.com/ycm-core/ycmd/tree/3602f38ef7a762fc765afd75e562aec9a134711e/ycmd/tests/java/testdata/simple_gradle_project\n[67] https://github.com/ycm-core/lsp-examples#kotlin\n[68] https://github.com/OmniSharp/omnisharp-roslyn/releases/\n[69] https://github.com/ycm-core/YouCompleteMe/blob/master/.ycm_extra_conf.py\n[70] https://github.com/rust-lang/rls\n[71] https://www.rust-lang.org/downloads.html\n[72] https://rust-analyzer.github.io/manual.html#configuration]\n[73] https://github.com/golang/tools/blob/master/gopls/doc/settings.md\n[74] https://ternjs.net\n[75] https://github.com/ycm-core/YouCompleteMe/wiki/JavaScript-Semantic-Completion-through-Tern\n[76] https://code.visualstudio.com/docs/languages/jsconfig\n[77] https://www.typescriptlang.org/docs/handbook/tsconfig-json.html\n[78] https://clang.llvm.org/\n[79] https://github.com/ycm-core/ycmd#language_server-configuration\n[80] https://github.com/ycm-core/lsp-examples\n[81] http://eclim.org/\n[82] https://github.com/ycm-core/ycmd/blob/master/ycmd/completers/completer.py\n[83] https://github.com/Valloric/ListToggle\n[84] https://asciinema.org/a/4JmYLAaz5hOHbZDD0hbsQpY8C\n[85] https://asciinema.org/a/4JmYLAaz5hOHbZDD0hbsQpY8C.svg\n[86] https://asciinema.org/a/659925\n[87] https://asciinema.org/a/659925.svg\n[88] https://user-images.githubusercontent.com/17928698/206855014-9131a49b-87e8-4ed4-8d91-f2fe7808a0b9.gif\n[89] https://user-images.githubusercontent.com/17928698/206855713-3588c8de-d0f5-4725-b65e-bc51110252cc.gif\n[90] https://jedi.readthedocs.io/en/latest/docs/api.html#jedi.Script.extract_variable\n[91] https://github.com/puremourning/vimspector\n[92] https://github.com/itchyny/lightline.vim\n[93] https://user-images.githubusercontent.com/10584846/185707973-39703699-0263-47d3-82ac-639d52259bea.png\n[94] https://user-images.githubusercontent.com/10584846/185707993-14ff5fd7-c082-4e5a-b825-f1364e619b6a.png\n[95] https://docs.python.org/2/library/re.html#regular-expression-syntax\n[96] http://ctags.sourceforge.net/FORMAT\n[97] https://github.com/ycm-core/YouCompleteMe/blob/master/CODE_OF_CONDUCT.md\n[98] https://groups.google.com/forum/?hl=en#!forum/ycm-users\n[99] https://github.com/ycm-core/YouCompleteMe/issues?state=open\n[100] https://github.com/ycm-core/YouCompleteMe/blob/master/CONTRIBUTING.md\n[101] https://www.gnu.org/copyleft/gpl.html\n[102] https://www.hectorsgreyhoundrescue.org\n[103] https://www.budihuman.rs/en\n[104] https://www.cancerresearchuk.org\n[105] https://iccf.nl\n\nvim: ft=help\n" }, { "path": "install.py", "content": "#!/usr/bin/env python3\n\nfrom __future__ import print_function\nfrom __future__ import division\nfrom __future__ import unicode_literals\nfrom __future__ import absolute_import\n\nimport os\nimport subprocess\nimport sys\nimport os.path as p\nimport glob\n\nversion = sys.version_info[ 0 : 3 ]\nif version < ( 3, 12, 0 ):\n sys.exit( 'YouCompleteMe requires Python >= 3.12.0; '\n 'your version of Python is ' + sys.version )\n\nDIR_OF_THIS_SCRIPT = p.dirname( p.abspath( __file__ ) )\nDIR_OF_OLD_LIBS = p.join( DIR_OF_THIS_SCRIPT, 'python' )\n\n\ndef CheckCall( args, **kwargs ):\n try:\n subprocess.check_call( args, **kwargs )\n except subprocess.CalledProcessError as error:\n sys.exit( error.returncode )\n\n\ndef Main():\n build_file = p.join( DIR_OF_THIS_SCRIPT, 'third_party', 'ycmd', 'build.py' )\n\n if not p.isfile( build_file ):\n sys.exit(\n 'File {0} does not exist; you probably forgot to run:\\n'\n '\\tgit submodule update --init --recursive\\n'.format( build_file ) )\n\n CheckCall( [ sys.executable, build_file ] + sys.argv[ 1: ] )\n\n # Remove old YCM libs if present so that YCM can start.\n old_libs = (\n glob.glob( p.join( DIR_OF_OLD_LIBS, '*ycm_core.*' ) ) +\n glob.glob( p.join( DIR_OF_OLD_LIBS, '*ycm_client_support.*' ) ) +\n glob.glob( p.join( DIR_OF_OLD_LIBS, '*clang*.*' ) ) )\n for lib in old_libs:\n os.remove( lib )\n\n\nif __name__ == \"__main__\":\n Main()\n" }, { "path": "install.sh", "content": "#!/bin/sh\n\necho \"WARNING: this script is deprecated. Use the install.py script instead.\" 1>&2\n\n\nSCRIPT_DIR=$(dirname $0 || exit $?)\n\npython3 \"$SCRIPT_DIR/install.py\" \"$@\" || exit $?\n" }, { "path": "plugin/youcompleteme.vim", "content": "\" Copyright (C) 2011, 2012 Google Inc.\n\"\n\" This file is part of YouCompleteMe.\n\"\n\" YouCompleteMe is free software: you can redistribute it and/or modify\n\" it under the terms of the GNU General Public License as published by\n\" the Free Software Foundation, either version 3 of the License, or\n\" (at your option) any later version.\n\"\n\" YouCompleteMe is distributed in the hope that it will be useful,\n\" but WITHOUT ANY WARRANTY; without even the implied warranty of\n\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n\" GNU General Public License for more details.\n\"\n\" You should have received a copy of the GNU General Public License\n\" along with YouCompleteMe. If not, see .\n\n\" This is basic vim plugin boilerplate\nlet s:save_cpo = &cpo\nset cpo&vim\n\nfunction! s:restore_cpo()\n let &cpo = s:save_cpo\n unlet s:save_cpo\nendfunction\n\n\" NOTE: The minimum supported version is 8.2.3995, but neovim always reports as\n\" v:version 800, but will largely work.\nlet s:is_neovim = has( 'nvim' )\n\nif exists( \"g:loaded_youcompleteme\" )\n call s:restore_cpo()\n finish\nelseif ( v:version < 901 || (v:version == 901 && !has( 'patch0016' )) ) &&\n \\ !s:is_neovim\n echohl WarningMsg |\n \\ echomsg \"YouCompleteMe unavailable: requires Vim 9.1.0016+.\" |\n \\ echohl None\n call s:restore_cpo()\n finish\nelseif !has( 'timers' )\n echohl WarningMsg |\n \\ echomsg \"YouCompleteMe unavailable: requires Vim compiled with \" .\n \\ \"the timers feature.\" |\n \\ echohl None\n call s:restore_cpo()\n finish\nelseif !has( 'python3_compiled' )\n echohl WarningMsg |\n \\ echomsg \"YouCompleteMe unavailable: requires Vim compiled with \" .\n \\ \"Python (3.12.0+) support.\" |\n \\ echohl None\n call s:restore_cpo()\n finish\n\" These calls try to load the Python 3 libraries when Vim is\n\" compiled dynamically against them. Since only one can be loaded at a time on\n\" some platforms, we first check if Python 3 is available.\nelseif !has( 'python3' )\n echohl WarningMsg |\n \\ echomsg \"YouCompleteMe unavailable: unable to load Python.\" |\n \\ echohl None\n call s:restore_cpo()\n finish\nelseif &encoding !~? 'utf-\\?8'\n echohl WarningMsg |\n \\ echomsg \"YouCompleteMe unavailable: requires UTF-8 encoding. \" .\n \\ \"Put the line 'set encoding=utf-8' in your vimrc.\" |\n \\ echohl None\n call s:restore_cpo()\n finish\nendif\n\nlet g:loaded_youcompleteme = 1\n\n\"\n\" List of YCM options.\n\"\nlet g:ycm_filetype_whitelist =\n \\ get( g:, 'ycm_filetype_whitelist', { \"*\": 1 } )\n\nlet g:ycm_filetype_blacklist =\n \\ get( g:, 'ycm_filetype_blacklist', {\n \\ 'tagbar': 1,\n \\ 'notes': 1,\n \\ 'markdown': 1,\n \\ 'netrw': 1,\n \\ 'unite': 1,\n \\ 'text': 1,\n \\ 'vimwiki': 1,\n \\ 'pandoc': 1,\n \\ 'infolog': 1,\n \\ 'leaderf': 1,\n \\ 'mail': 1\n \\ } )\n\n\" Blacklist empty buffers unless explicity whitelisted; workaround for\n\" https://github.com/ycm-core/YouCompleteMe/issues/3781\nif !has_key( g:ycm_filetype_whitelist, 'ycm_nofiletype' )\n let g:ycm_filetype_blacklist.ycm_nofiletype = 1\nendif\n\nlet g:ycm_open_loclist_on_ycm_diags =\n \\ get( g:, 'ycm_open_loclist_on_ycm_diags', 1 )\n\nlet g:ycm_add_preview_to_completeopt =\n \\ get( g:, 'ycm_add_preview_to_completeopt', 0 )\n\nlet g:ycm_autoclose_preview_window_after_completion =\n \\ get( g:, 'ycm_autoclose_preview_window_after_completion', 0 )\n\nlet g:ycm_autoclose_preview_window_after_insertion =\n \\ get( g:, 'ycm_autoclose_preview_window_after_insertion', 0 )\n\nlet g:ycm_key_list_select_completion =\n \\ get( g:, 'ycm_key_list_select_completion', ['', ''] )\n\nlet g:ycm_key_list_previous_completion =\n \\ get( g:, 'ycm_key_list_previous_completion', ['', ''] )\n\nlet g:ycm_key_list_stop_completion =\n \\ get( g:, 'ycm_key_list_stop_completion', [''] )\n\nlet g:ycm_key_invoke_completion =\n \\ get( g:, 'ycm_key_invoke_completion', '' )\n\nlet g:ycm_key_detailed_diagnostics =\n \\ get( g:, 'ycm_key_detailed_diagnostics', 'd' )\n\nlet g:ycm_cache_omnifunc =\n \\ get( g:, 'ycm_cache_omnifunc', 1 )\n\nlet g:ycm_log_level =\n \\ get( g:, 'ycm_log_level',\n \\ get( g:, 'ycm_server_log_level', 'info' ) )\n\nlet g:ycm_keep_logfiles =\n \\ get( g:, 'ycm_keep_logfiles',\n \\ get( g:, 'ycm_server_keep_logfiles', 0 ) )\n\nlet g:ycm_extra_conf_vim_data =\n \\ get( g:, 'ycm_extra_conf_vim_data', [] )\n\nlet g:ycm_server_python_interpreter =\n \\ get( g:, 'ycm_server_python_interpreter',\n \\ get( g:, 'ycm_path_to_python_interpreter', '' ) )\n\nlet g:ycm_show_diagnostics_ui =\n \\ get( g:, 'ycm_show_diagnostics_ui', 1 )\n\nlet g:ycm_enable_diagnostic_signs =\n \\ get( g:, 'ycm_enable_diagnostic_signs',\n \\ get( g:, 'syntastic_enable_signs', 1 ) )\n\nlet g:ycm_enable_diagnostic_highlighting =\n \\ get( g:, 'ycm_enable_diagnostic_highlighting',\n \\ get( g:, 'syntastic_enable_highlighting', 1 ) )\n\nlet g:ycm_echo_current_diagnostic =\n \\ get( g:, 'ycm_echo_current_diagnostic',\n \\ get( g:, 'syntastic_echo_current_error', 1 ) )\n\nlet g:ycm_filter_diagnostics =\n \\ get( g:, 'ycm_filter_diagnostics', {} )\n\nlet g:ycm_always_populate_location_list =\n \\ get( g:, 'ycm_always_populate_location_list',\n \\ get( g:, 'syntastic_always_populate_loc_list', 0 ) )\n\nlet g:ycm_error_symbol =\n \\ get( g:, 'ycm_error_symbol',\n \\ get( g:, 'syntastic_error_symbol', '>>' ) )\n\nlet g:ycm_warning_symbol =\n \\ get( g:, 'ycm_warning_symbol',\n \\ get( g:, 'syntastic_warning_symbol', '>>' ) )\n\nlet g:ycm_complete_in_comments =\n \\ get( g:, 'ycm_complete_in_comments', 0 )\n\nlet g:ycm_complete_in_strings =\n \\ get( g:, 'ycm_complete_in_strings', 1 )\n\nlet g:ycm_collect_identifiers_from_tags_files =\n \\ get( g:, 'ycm_collect_identifiers_from_tags_files', 0 )\n\nlet g:ycm_seed_identifiers_with_syntax =\n \\ get( g:, 'ycm_seed_identifiers_with_syntax', 0 )\n\nlet g:ycm_goto_buffer_command =\n \\ get( g:, 'ycm_goto_buffer_command', 'same-buffer' )\n\nlet g:ycm_disable_for_files_larger_than_kb =\n \\ get( g:, 'ycm_disable_for_files_larger_than_kb', 1000 )\n\nlet g:ycm_auto_hover =\n \\ get( g:, 'ycm_auto_hover', 'CursorHold' )\n\nlet g:ycm_update_diagnostics_in_insert_mode =\n \\ get( g:, 'ycm_update_diagnostics_in_insert_mode', 1 )\n\n\"\n\" List of ycmd options.\n\"\nlet g:ycm_filepath_completion_use_working_dir =\n \\ get( g:, 'ycm_filepath_completion_use_working_dir', 0 )\n\nlet g:ycm_auto_trigger =\n \\ get( g:, 'ycm_auto_trigger', 1 )\n\nlet g:ycm_min_num_of_chars_for_completion =\n \\ get( g:, 'ycm_min_num_of_chars_for_completion', 2 )\n\nlet g:ycm_min_identifier_candidate_chars =\n \\ get( g:, 'ycm_min_num_identifier_candidate_chars', 0 )\n\nlet g:ycm_semantic_triggers =\n \\ get( g:, 'ycm_semantic_triggers', {} )\n\nlet g:ycm_filetype_specific_completion_to_disable =\n \\ get( g:, 'ycm_filetype_specific_completion_to_disable',\n \\ { 'gitcommit': 1 } )\n\nlet g:ycm_collect_identifiers_from_comments_and_strings =\n \\ get( g:, 'ycm_collect_identifiers_from_comments_and_strings', 0 )\n\nlet g:ycm_max_num_identifier_candidates =\n \\ get( g:, 'ycm_max_num_identifier_candidates', 10 )\n\nlet g:ycm_max_num_candidates =\n \\ get( g:, 'ycm_max_num_candidates', 50 )\n\nlet g:ycm_extra_conf_globlist =\n \\ get( g:, 'ycm_extra_conf_globlist', [] )\n\nlet g:ycm_global_ycm_extra_conf =\n \\ get( g:, 'ycm_global_ycm_extra_conf', '' )\n\nlet g:ycm_confirm_extra_conf =\n \\ get( g:, 'ycm_confirm_extra_conf', 1 )\n\nlet g:ycm_max_diagnostics_to_display =\n \\ get( g:, 'ycm_max_diagnostics_to_display', 30 )\n\nlet g:ycm_filepath_blacklist =\n \\ get( g:, 'ycm_filepath_blacklist', {\n \\ 'html': 1,\n \\ 'jsx': 1,\n \\ 'xml': 1\n \\ } )\n\nlet g:ycm_auto_start_csharp_server =\n \\ get( g:, 'ycm_auto_start_csharp_server', 1 )\n\nlet g:ycm_auto_stop_csharp_server =\n \\ get( g:, 'ycm_auto_stop_csharp_server', 1 )\n\nlet g:ycm_use_ultisnips_completer =\n \\ get( g:, 'ycm_use_ultisnips_completer', 1 )\n\nlet g:ycm_csharp_server_port =\n \\ get( g:, 'ycm_csharp_server_port', 0 )\n\nlet g:ycm_use_clangd =\n \\ get( g:, 'ycm_use_clangd', 1 )\n\nlet g:ycm_clangd_binary_path =\n \\ get( g:, 'ycm_clangd_binary_path', '' )\n\nlet g:ycm_clangd_args =\n \\ get( g:, 'ycm_clangd_args', [] )\n\nlet g:ycm_clangd_uses_ycmd_caching =\n \\ get( g:, 'ycm_clangd_uses_ycmd_caching', 1 )\n\n\" These options are not documented.\nlet g:ycm_java_jdtls_extension_path =\n \\ get( g:, 'ycm_java_jdtls_extension_path', [] )\n\nlet g:ycm_java_jdtls_use_clean_workspace =\n \\ get( g:, 'ycm_java_jdtls_use_clean_workspace', 1 )\n\nlet g:ycm_java_jdtls_workspace_root_path =\n \\ get( g:, 'ycm_java_jdtls_workspace_root_path', '' )\n\n\" This option is deprecated.\nlet g:ycm_python_binary_path =\n \\ get( g:, 'ycm_python_binary_path', '' )\n\nlet g:ycm_refilter_workspace_symbols =\n \\ get( g:, 'ycm_refilter_workspace_symbols', 1 )\n\nif has( 'vim_starting' ) \" Loading at startup.\n \" We defer loading until after VimEnter to allow the gui to fork (see\n \" `:h gui-fork`) and avoid a deadlock situation, as explained here:\n \" https://github.com/Valloric/YouCompleteMe/pull/2473#issuecomment-267716136\n augroup youcompletemeStart\n autocmd!\n autocmd VimEnter * call youcompleteme#Enable()\n augroup END\nelse \" Manual loading with :packadd.\n call youcompleteme#Enable()\nendif\n\n\" This is basic vim plugin boilerplate\ncall s:restore_cpo()\n" }, { "path": "print_todos.sh", "content": "#!/bin/bash\nag \\\n--ignore gmock \\\n--ignore jedi/ \\\n--ignore OmniSharpServer \\\n--ignore testdata \\\nTODO \\\nthird_party/ycmd/cpp/ycm python autoload plugin\n" }, { "path": "python/test_requirements.txt", "content": "flake8 >= 3.0.0\nflake8-comprehensions >= 1.4.1\nflake8-ycm >= 0.1.0\nPyHamcrest >= 1.10.1\n# Use the updated fork\ngit+https://github.com/bstaletic/covimerage\n" }, { "path": "python/ycm/__init__.py", "content": "" }, { "path": "python/ycm/base.py", "content": "# Copyright (C) 2011, 2012 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport os\nimport json\n\nfrom ycm import vimsupport, paths\nfrom ycmd import identifier_utils\n\nYCM_VAR_PREFIX = 'ycm_'\n\n\ndef GetUserOptions( default_options = {} ):\n \"\"\"Builds a dictionary mapping YCM Vim user options to values. Option names\n don't have the 'ycm_' prefix.\"\"\"\n\n user_options = {}\n\n # First load the default settings from ycmd. We do this to ensure that any\n # client-side code that assumes all options are loaded (such as the\n # omnicompleter) don't have to constantly check for values being present, and\n # so that we don't jave to dulicate the list of server settings in\n # youcomplete.vim\n defaults_file = os.path.join( paths.DIR_OF_YCMD,\n 'ycmd',\n 'default_settings.json' )\n if os.path.exists( defaults_file ):\n with open( defaults_file ) as defaults_file_handle:\n user_options = json.load( defaults_file_handle )\n\n # Override the server defaults with any client-generated defaults\n user_options.update( default_options )\n\n # Finally, override with any user-specified values in the g: dict\n\n # We only evaluate the keys of the vim globals and not the whole dictionary\n # to avoid unicode issues.\n # See https://github.com/Valloric/YouCompleteMe/pull/2151 for details.\n keys = vimsupport.GetVimGlobalsKeys()\n for key in keys:\n if not key.startswith( YCM_VAR_PREFIX ):\n continue\n new_key = key[ len( YCM_VAR_PREFIX ): ]\n new_value = vimsupport.VimExpressionToPythonType( 'g:' + key )\n user_options[ new_key ] = new_value\n\n return user_options\n\n\ndef CurrentIdentifierFinished():\n line, current_column = vimsupport.CurrentLineContentsAndCodepointColumn()\n previous_char_index = current_column - 1\n if previous_char_index < 0:\n return True\n filetype = vimsupport.CurrentFiletypes()[ 0 ]\n regex = identifier_utils.IdentifierRegexForFiletype( filetype )\n\n for match in regex.finditer( line ):\n if match.end() == previous_char_index:\n return True\n # If the whole line is whitespace, that means the user probably finished an\n # identifier on the previous line.\n return line[ : current_column ].isspace()\n\n\ndef LastEnteredCharIsIdentifierChar():\n line, current_column = vimsupport.CurrentLineContentsAndCodepointColumn()\n if current_column - 1 < 0:\n return False\n filetype = vimsupport.CurrentFiletypes()[ 0 ]\n return (\n identifier_utils.StartOfLongestIdentifierEndingAtIndex(\n line, current_column, filetype ) != current_column )\n\n\ndef AdjustCandidateInsertionText( candidates ):\n \"\"\"This function adjusts the candidate insertion text to take into account the\n text that's currently in front of the cursor.\n\n For instance ('|' represents the cursor):\n 1. Buffer state: 'foo.|bar'\n 2. A completion candidate of 'zoobar' is shown and the user selects it.\n 3. Buffer state: 'foo.zoobar|bar' instead of 'foo.zoo|bar' which is what the\n user wanted.\n\n This function changes candidates to resolve that issue.\n\n It could be argued that the user actually wants the final buffer state to be\n 'foo.zoobar|' (the cursor at the end), but that would be much more difficult\n to implement and is probably not worth doing.\n \"\"\"\n\n def NewCandidateInsertionText( to_insert, text_after_cursor ):\n overlap_len = OverlapLength( to_insert, text_after_cursor )\n if overlap_len:\n return to_insert[ :-overlap_len ]\n return to_insert\n\n text_after_cursor = vimsupport.TextAfterCursor()\n if not text_after_cursor:\n return candidates\n\n new_candidates = []\n for candidate in candidates:\n new_candidate = candidate.copy()\n\n if not new_candidate.get( 'abbr' ):\n new_candidate[ 'abbr' ] = new_candidate[ 'word' ]\n\n new_candidate[ 'word' ] = NewCandidateInsertionText(\n new_candidate[ 'word' ],\n text_after_cursor )\n\n new_candidates.append( new_candidate )\n return new_candidates\n\n\ndef OverlapLength( left_string, right_string ):\n \"\"\"Returns the length of the overlap between two strings.\n Example: \"foo baro\" and \"baro zoo\" -> 4\n \"\"\"\n left_string_length = len( left_string )\n right_string_length = len( right_string )\n\n if not left_string_length or not right_string_length:\n return 0\n\n # Truncate the longer string.\n if left_string_length > right_string_length:\n left_string = left_string[ -right_string_length: ]\n elif left_string_length < right_string_length:\n right_string = right_string[ :left_string_length ]\n\n if left_string == right_string:\n return min( left_string_length, right_string_length )\n\n # Start by looking for a single character match\n # and increase length until no match is found.\n best = 0\n length = 1\n while True:\n pattern = left_string[ -length: ]\n found = right_string.find( pattern )\n if found < 0:\n return best\n length += found\n if left_string[ -length: ] == right_string[ :length ]:\n best = length\n length += 1\n" }, { "path": "python/ycm/buffer.py", "content": "# Copyright (C) 2016, Davit Samvelyan\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm import vimsupport\nfrom ycm.client.event_notification import EventNotification\nfrom ycm.diagnostic_interface import DiagnosticInterface\nfrom ycm.semantic_highlighting import SemanticHighlighting\nfrom ycm.inlay_hints import InlayHints\n\n\n# Emulates Vim buffer\n# Used to store buffer related information like diagnostics, latest parse\n# request. Stores buffer change tick at the parse request moment, allowing\n# to effectively determine whether reparse is needed for the buffer.\nclass Buffer:\n\n def __init__( self, bufnr, user_options, filetypes ):\n self._number = bufnr\n self._parse_tick = 0\n self._handled_tick = 0\n self._parse_request = None\n self._should_resend = False\n self._diag_interface = DiagnosticInterface( bufnr, user_options )\n self._open_loclist_on_ycm_diags = user_options[\n 'open_loclist_on_ycm_diags' ]\n self.semantic_highlighting = SemanticHighlighting( bufnr )\n self.inlay_hints = InlayHints( bufnr )\n self.UpdateFromFileTypes( filetypes )\n\n\n def FileParseRequestReady( self, block = False ):\n return ( bool( self._parse_request ) and\n ( block or self._parse_request.Done() ) )\n\n\n def SendParseRequest( self, extra_data ):\n # Don't send a parse request if one is in progress\n if self._parse_request is not None and not self._parse_request.Done():\n self._should_resend = True\n return\n\n self._should_resend = False\n\n self._parse_request = EventNotification( 'FileReadyToParse',\n extra_data = extra_data )\n self._parse_request.Start()\n # Decrement handled tick to ensure correct handling when we are forcing\n # reparse on buffer visit and changed tick remains the same.\n self._handled_tick -= 1\n self._parse_tick = self._ChangedTick()\n\n\n def ParseRequestPending( self ):\n return bool( self._parse_request ) and not self._parse_request.Done()\n\n\n def NeedsReparse( self ):\n return self._parse_tick != self._ChangedTick()\n\n\n def ShouldResendParseRequest( self ):\n return ( self._should_resend\n or ( bool( self._parse_request )\n and self._parse_request.ShouldResend() ) )\n\n\n def UpdateDiagnostics( self, force = False ):\n if force or not self._async_diags:\n self.UpdateWithNewDiagnostics( self._parse_request.Response(), False )\n else:\n # We need to call the response method, because it might throw an exception\n # or require extra config confirmation, even if we don't actually use the\n # diagnostics.\n self._parse_request.Response()\n\n\n def UpdateWithNewDiagnostics( self, diagnostics, async_message ):\n self._async_diags = async_message\n self._diag_interface.UpdateWithNewDiagnostics(\n diagnostics,\n not self._async_diags and self._open_loclist_on_ycm_diags )\n\n\n def UpdateMatches( self ):\n self._diag_interface.UpdateMatches()\n\n\n def PopulateLocationList( self, open_on_edit = False ):\n return self._diag_interface.PopulateLocationList( open_on_edit )\n\n\n def GetResponse( self ):\n return self._parse_request.Response()\n\n\n def IsResponseHandled( self ):\n return self._handled_tick == self._parse_tick\n\n\n def MarkResponseHandled( self ):\n self._handled_tick = self._parse_tick\n\n\n def OnCursorMoved( self ):\n self._diag_interface.OnCursorMoved()\n\n\n def GetErrorCount( self ):\n return self._diag_interface.GetErrorCount()\n\n\n def GetWarningCount( self ):\n return self._diag_interface.GetWarningCount()\n\n\n def RefreshDiagnosticsUI( self ):\n return self._diag_interface.RefreshDiagnosticsUI()\n\n\n def ClearDiagnosticsUI( self ):\n return self._diag_interface.ClearDiagnosticsUI()\n\n\n def DiagnosticsForLine( self, line_number ):\n return self._diag_interface.DiagnosticsForLine( line_number )\n\n\n def UpdateFromFileTypes( self, filetypes ):\n self._filetypes = filetypes\n # We will set this to true if we ever receive any diagnostics asyncronously.\n self._async_diags = False\n\n\n def _ChangedTick( self ):\n return vimsupport.GetBufferChangedTick( self._number )\n\n\nclass BufferDict( dict ):\n\n def __init__( self, user_options ):\n self._user_options = user_options\n\n\n def __missing__( self, key ):\n # Python does not allow to return assignment operation result directly\n new_value = self[ key ] = Buffer(\n key,\n self._user_options,\n vimsupport.GetBufferFiletypes( key ) )\n\n return new_value\n" }, { "path": "python/ycm/client/__init__.py", "content": "" }, { "path": "python/ycm/client/base_request.py", "content": "# Copyright (C) 2013-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport logging\nimport json\nimport vim\nfrom base64 import b64decode, b64encode\nfrom hmac import compare_digest\nfrom urllib.parse import urljoin, urlparse, urlencode\nfrom urllib.request import Request, urlopen\nfrom urllib.error import URLError, HTTPError\nfrom ycm import vimsupport\nfrom ycmd.utils import ToBytes, GetCurrentDirectory, ToUnicode\nfrom ycmd.hmac_utils import CreateRequestHmac, CreateHmac\nfrom ycmd.responses import ServerError, UnknownExtraConf\n\nHTTP_SERVER_ERROR = 500\n\n_HEADERS = { 'content-type': 'application/json' }\n_CONNECT_TIMEOUT_SEC = 0.01\n# Setting this to None seems to screw up the Requests/urllib3 libs.\n_READ_TIMEOUT_SEC = 30\n_HMAC_HEADER = 'x-ycm-hmac'\n_logger = logging.getLogger( __name__ )\n\n\nclass BaseRequest:\n\n def __init__( self ):\n self._should_resend = False\n\n\n def Start( self ):\n pass\n\n\n def Done( self ):\n return True\n\n\n def Response( self ):\n return {}\n\n\n def ShouldResend( self ):\n return self._should_resend\n\n\n def HandleFuture( self,\n future,\n display_message = True,\n truncate_message = False ):\n \"\"\"Get the server response from a |future| object and catch any exception\n while doing so. If an exception is raised because of a unknown\n .ycm_extra_conf.py file, load the file or ignore it after asking the user.\n An identical request should be sent again to the server. For other\n exceptions, log the exception and display its message to the user on the Vim\n status line. Unset the |display_message| parameter to hide the message from\n the user. Set the |truncate_message| parameter to avoid hit-enter prompts\n from this message.\"\"\"\n try:\n try:\n return _JsonFromFuture( future )\n except UnknownExtraConf as e:\n if vimsupport.Confirm( str( e ) ):\n _LoadExtraConfFile( e.extra_conf_file )\n else:\n _IgnoreExtraConfFile( e.extra_conf_file )\n self._should_resend = True\n except URLError as e:\n # We don't display this exception to the user since it is likely to happen\n # for each subsequent request (typically if the server crashed) and we\n # don't want to spam the user with it.\n _logger.error( e )\n\n except Exception as e:\n _logger.exception( 'Error while handling server response' )\n if display_message:\n DisplayServerException( e, truncate_message )\n\n return None\n\n\n # This method blocks\n # |timeout| is num seconds to tolerate no response from server before giving\n # up; see Requests docs for details (we just pass the param along).\n # See the HandleFuture method for the |display_message| and |truncate_message|\n # parameters.\n def GetDataFromHandler( self,\n handler,\n timeout = _READ_TIMEOUT_SEC,\n display_message = True,\n truncate_message = False,\n payload = None ):\n return self.HandleFuture(\n self.GetDataFromHandlerAsync( handler, timeout, payload ),\n display_message,\n truncate_message )\n\n\n def GetDataFromHandlerAsync( self,\n handler,\n timeout = _READ_TIMEOUT_SEC,\n payload = None ):\n return BaseRequest._TalkToHandlerAsync(\n '', handler, 'GET', timeout, payload )\n\n\n # This is the blocking version of the method. See below for async.\n # |timeout| is num seconds to tolerate no response from server before giving\n # up; see Requests docs for details (we just pass the param along).\n # See the HandleFuture method for the |display_message| and |truncate_message|\n # parameters.\n def PostDataToHandler( self,\n data,\n handler,\n timeout = _READ_TIMEOUT_SEC,\n display_message = True,\n truncate_message = False ):\n return self.HandleFuture(\n BaseRequest.PostDataToHandlerAsync( data, handler, timeout ),\n display_message,\n truncate_message )\n\n\n # This returns a future! Use HandleFuture to get the value.\n # |timeout| is num seconds to tolerate no response from server before giving\n # up; see Requests docs for details (we just pass the param along).\n @staticmethod\n def PostDataToHandlerAsync( data, handler, timeout = _READ_TIMEOUT_SEC ):\n return BaseRequest._TalkToHandlerAsync( data, handler, 'POST', timeout )\n\n\n # This returns a future! Use HandleFuture to get the value.\n # |method| is either 'POST' or 'GET'.\n # |timeout| is num seconds to tolerate no response from server before giving\n # up; see Requests docs for details (we just pass the param along).\n @staticmethod\n def _TalkToHandlerAsync( data,\n handler,\n method,\n timeout = _READ_TIMEOUT_SEC,\n payload = None ):\n def _MakeRequest( data, handler, method, timeout, payload ):\n request_uri = _BuildUri( handler )\n\n if method == 'POST':\n sent_data = _ToUtf8Json( data )\n headers = BaseRequest._ExtraHeaders( method,\n request_uri,\n sent_data )\n _logger.debug( 'POST %s\\n%s\\n%s', request_uri, headers, sent_data )\n else:\n headers = BaseRequest._ExtraHeaders( method, request_uri )\n if payload:\n request_uri += ToBytes( f'?{ urlencode( payload ) }' )\n\n _logger.debug( 'GET %s (%s)\\n%s', request_uri, payload, headers )\n return urlopen(\n Request(\n ToUnicode( request_uri ),\n data = sent_data if data else None,\n headers = headers,\n method = method ),\n timeout = max( _CONNECT_TIMEOUT_SEC, timeout ) )\n\n\n return BaseRequest.Executor().submit(\n _MakeRequest,\n data,\n handler,\n method,\n timeout,\n payload )\n\n\n @staticmethod\n def _ExtraHeaders( method, request_uri, request_body = None ):\n if not request_body:\n request_body = bytes( b'' )\n headers = dict( _HEADERS )\n headers[ _HMAC_HEADER ] = b64encode(\n CreateRequestHmac( ToBytes( method ),\n ToBytes( urlparse( request_uri ).path ),\n request_body,\n BaseRequest.hmac_secret ) )\n return headers\n\n\n # This method exists to avoid importing the requests module at startup;\n # reducing loading time since this module is slow to import.\n @classmethod\n def Executor( cls ):\n try:\n return cls.executor\n except AttributeError:\n from ycm.unsafe_thread_pool_executor import UnsafeThreadPoolExecutor\n cls.executor = UnsafeThreadPoolExecutor( max_workers = 30 )\n return cls.executor\n\n\n server_location = ''\n hmac_secret = ''\n\n\ndef BuildRequestData( buffer_number = None ):\n \"\"\"Build request for the current buffer or the buffer with number\n |buffer_number| if specified.\"\"\"\n working_dir = GetCurrentDirectory()\n current_buffer = vim.current.buffer\n\n if buffer_number and current_buffer.number != buffer_number:\n # Cursor position is irrelevant when filepath is not the current buffer.\n buffer_object = vim.buffers[ buffer_number ]\n filepath = vimsupport.GetBufferFilepath( buffer_object )\n return {\n 'filepath': filepath,\n 'line_num': 1,\n 'column_num': 1,\n 'working_dir': working_dir,\n 'file_data': vimsupport.GetUnsavedAndSpecifiedBufferData( buffer_object,\n filepath )\n }\n\n current_filepath = vimsupport.GetBufferFilepath( current_buffer )\n line, column = vimsupport.CurrentLineAndColumn()\n\n return {\n 'filepath': current_filepath,\n 'line_num': line + 1,\n 'column_num': column + 1,\n 'working_dir': working_dir,\n 'file_data': vimsupport.GetUnsavedAndSpecifiedBufferData( current_buffer,\n current_filepath )\n }\n\n\ndef BuildRequestDataForLocation( file : str, line : int, column : int ):\n buffer_number = vimsupport.GetBufferNumberForFilename(\n file,\n create_buffer_if_needed = True )\n try:\n vim.eval( f'bufload( \"{ file }\" )' )\n except vim.error as e:\n if 'E325' not in str( e ):\n raise\n buffer = vim.buffers[ buffer_number ]\n file_data = vimsupport.GetUnsavedAndSpecifiedBufferData( buffer, file )\n return {\n 'filepath': file,\n 'line_num': line,\n 'column_num': column,\n 'working_dir': GetCurrentDirectory(),\n 'file_data': file_data\n }\n\n\ndef _JsonFromFuture( future ):\n try:\n response = future.result()\n response_text = response.read()\n _ValidateResponseObject( response, response_text )\n response.close()\n\n if response_text:\n return json.loads( response_text )\n return None\n except HTTPError as response:\n if response.code == HTTP_SERVER_ERROR:\n response_text = response.read()\n response.close()\n if response_text:\n raise MakeServerException( json.loads( response_text ) )\n else:\n return None\n raise\n\n\ndef _LoadExtraConfFile( filepath ):\n BaseRequest().PostDataToHandler( { 'filepath': filepath },\n 'load_extra_conf_file' )\n\n\ndef _IgnoreExtraConfFile( filepath ):\n BaseRequest().PostDataToHandler( { 'filepath': filepath },\n 'ignore_extra_conf_file' )\n\n\ndef DisplayServerException( exception, truncate_message = False ):\n serialized_exception = str( exception )\n\n # We ignore the exception about the file already being parsed since it comes\n # up often and isn't something that's actionable by the user.\n if 'already being parsed' in serialized_exception:\n return\n vimsupport.PostVimMessage( serialized_exception, truncate = truncate_message )\n\n\ndef _ToUtf8Json( data ):\n return ToBytes( json.dumps( data ) if data else None )\n\n\ndef _ValidateResponseObject( response, response_text ):\n if not response_text:\n return\n our_hmac = CreateHmac( response_text, BaseRequest.hmac_secret )\n their_hmac = ToBytes( b64decode( response.headers[ _HMAC_HEADER ] ) )\n if not compare_digest( our_hmac, their_hmac ):\n raise RuntimeError( 'Received invalid HMAC for response!' )\n\n\ndef _BuildUri( handler ):\n return ToBytes( urljoin( BaseRequest.server_location, handler ) )\n\n\ndef MakeServerException( data ):\n _logger.debug( 'Server exception: %s', data )\n if data[ 'exception' ][ 'TYPE' ] == UnknownExtraConf.__name__:\n return UnknownExtraConf( data[ 'exception' ][ 'extra_conf_file' ] )\n\n return ServerError( f'{ data[ \"exception\" ][ \"TYPE\" ] }: '\n f'{ data[ \"message\" ] }' )\n" }, { "path": "python/ycm/client/command_request.py", "content": "# Copyright (C) 2013 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.client.base_request import ( BaseRequest,\n BuildRequestData,\n BuildRequestDataForLocation )\nfrom ycm import vimsupport\n\nDEFAULT_BUFFER_COMMAND = 'same-buffer'\n\n\ndef _EnsureBackwardsCompatibility( arguments ):\n if arguments and arguments[ 0 ] == 'GoToDefinitionElseDeclaration':\n arguments[ 0 ] = 'GoTo'\n return arguments\n\n\nclass CommandRequest( BaseRequest ):\n def __init__( self,\n arguments,\n extra_data = None,\n silent = False,\n location = None ):\n super( CommandRequest, self ).__init__()\n self._arguments = _EnsureBackwardsCompatibility( arguments )\n self._command = arguments and arguments[ 0 ]\n self._extra_data = extra_data\n self._response = None\n self._request_data = None\n self._response_future = None\n self._silent = silent\n self._bufnr = extra_data.pop( 'bufnr', None ) if extra_data else None\n self._location = location\n\n\n def Start( self ):\n if self._location is not None:\n self._request_data = BuildRequestDataForLocation( *self._location )\n elif self._bufnr is not None:\n self._request_data = BuildRequestData( self._bufnr )\n else:\n self._request_data = BuildRequestData()\n\n if self._extra_data:\n self._request_data.update( self._extra_data )\n self._request_data.update( {\n 'command_arguments': self._arguments\n } )\n self._response_future = self.PostDataToHandlerAsync(\n self._request_data,\n 'run_completer_command' )\n\n\n def Done( self ):\n return bool( self._response_future ) and self._response_future.done()\n\n\n def Response( self ):\n if self._response is None and self._response_future is not None:\n # Block\n self._response = self.HandleFuture( self._response_future,\n display_message = not self._silent )\n\n return self._response\n\n\n def RunPostCommandActionsIfNeeded( self,\n modifiers,\n buffer_command = DEFAULT_BUFFER_COMMAND ):\n\n # This is a blocking call if not Done()\n self.Response()\n\n if self._response is None:\n # An exception was raised and handled.\n return\n\n # If not a dictionary or a list, the response is necessarily a\n # scalar: boolean, number, string, etc. In this case, we print\n # it to the user.\n if not isinstance( self._response, ( dict, list ) ):\n return self._HandleBasicResponse()\n\n if 'fixits' in self._response:\n return self._HandleFixitResponse()\n\n if 'message' in self._response:\n return self._HandleMessageResponse()\n\n if 'detailed_info' in self._response:\n return self._HandleDetailedInfoResponse( modifiers )\n\n # The only other type of response we understand is GoTo, and that is the\n # only one that we can't detect just by inspecting the response (it should\n # either be a single location or a list)\n return self._HandleGotoResponse( buffer_command, modifiers )\n\n\n def StringResponse( self ):\n # Retuns a supporable public API version of the response. The reason this\n # exists is that the ycmd API here is wonky as it originally only supported\n # text-responses and now has things like fixits and such.\n #\n # The supportable public API is basically any text-only response. All other\n # response types are returned as empty strings\n\n # This is a blocking call if not Done()\n self.Response()\n\n # Completer threw an error ?\n if self._response is None:\n return \"\"\n\n # If not a dictionary or a list, the response is necessarily a\n # scalar: boolean, number, string, etc. In this case, we print\n # it to the user.\n if not isinstance( self._response, ( dict, list ) ):\n return str( self._response )\n\n if 'message' in self._response:\n return self._response[ 'message' ]\n\n if 'detailed_info' in self._response:\n return self._response[ 'detailed_info' ]\n\n # The only other type of response we understand is 'fixits' and GoTo. We\n # don't provide string versions of them.\n return \"\"\n\n\n def _HandleGotoResponse( self, buffer_command, modifiers ):\n if isinstance( self._response, list ):\n vimsupport.SetQuickFixList(\n [ vimsupport.BuildQfListItem( x ) for x in self._response ] )\n vimsupport.OpenQuickFixList( focus = True, autoclose = True )\n elif self._response.get( 'file_only' ):\n vimsupport.JumpToLocation( self._response[ 'filepath' ],\n None,\n None,\n modifiers,\n buffer_command )\n else:\n vimsupport.JumpToLocation( self._response[ 'filepath' ],\n self._response[ 'line_num' ],\n self._response[ 'column_num' ],\n modifiers,\n buffer_command )\n\n\n def _HandleFixitResponse( self ):\n if not len( self._response[ 'fixits' ] ):\n vimsupport.PostVimMessage( 'No fixits found for current line',\n warning = False )\n else:\n try:\n fixit_index = 0\n\n # If there is more than one fixit, we need to ask the user which one\n # should be applied.\n #\n # If there's only one, triggered by the FixIt subcommand (as opposed to\n # `RefactorRename`, for example) and whose `kind` is not `quicfix`, we\n # still need to as the user for confirmation.\n fixits = self._response[ 'fixits' ]\n if ( len( fixits ) > 1 or\n ( len( fixits ) == 1 and\n self._command == 'FixIt' and\n fixits[ 0 ].get( 'kind' ) != 'quickfix' ) ):\n fixit_index = vimsupport.SelectFromList(\n \"FixIt suggestion(s) available at this location. \"\n \"Which one would you like to apply?\",\n [ fixit[ 'text' ] for fixit in fixits ] )\n chosen_fixit = fixits[ fixit_index ]\n if chosen_fixit[ 'resolve' ]:\n self._request_data.update( { 'fixit': chosen_fixit } )\n response = self.PostDataToHandler( self._request_data,\n 'resolve_fixit' )\n if response is None:\n return\n fixits = response[ 'fixits' ]\n assert len( fixits ) == 1\n chosen_fixit = fixits[ 0 ]\n\n vimsupport.ReplaceChunks(\n chosen_fixit[ 'chunks' ],\n silent = self._command == 'Format' )\n except RuntimeError as e:\n vimsupport.PostVimMessage( str( e ) )\n\n\n def _HandleBasicResponse( self ):\n vimsupport.PostVimMessage( self._response, warning = False )\n\n\n def _HandleMessageResponse( self ):\n vimsupport.PostVimMessage( self._response[ 'message' ], warning = False )\n\n\n def _HandleDetailedInfoResponse( self, modifiers ):\n vimsupport.WriteToPreviewWindow( self._response[ 'detailed_info' ],\n modifiers )\n\n\ndef SendCommandRequestAsync( arguments,\n extra_data = None,\n silent = True,\n location = None ):\n request = CommandRequest( arguments,\n extra_data = extra_data,\n silent = silent,\n location = location )\n request.Start()\n # Don't block\n return request\n\n\ndef SendCommandRequest( arguments,\n modifiers,\n buffer_command = DEFAULT_BUFFER_COMMAND,\n extra_data = None,\n skip_post_command_action = False ):\n request = SendCommandRequestAsync( arguments,\n extra_data = extra_data,\n silent = False )\n # Block here to get the response\n if not skip_post_command_action:\n request.RunPostCommandActionsIfNeeded( modifiers, buffer_command )\n return request.Response()\n\n\ndef GetCommandResponse( arguments, extra_data = None ):\n request = SendCommandRequestAsync( arguments,\n extra_data = extra_data,\n silent = True )\n # Block here to get the response\n return request.StringResponse()\n\n\ndef GetRawCommandResponse( arguments, silent, location = None ):\n request = SendCommandRequestAsync( arguments,\n extra_data = None,\n silent = silent,\n location = location )\n return request.Response()\n" }, { "path": "python/ycm/client/completer_available_request.py", "content": "# Copyright (C) 2013 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.client.base_request import BaseRequest, BuildRequestData\n\n\nclass CompleterAvailableRequest( BaseRequest ):\n def __init__( self, filetypes ):\n super( CompleterAvailableRequest, self ).__init__()\n self.filetypes = filetypes\n self._response = None\n\n\n def Start( self ):\n request_data = BuildRequestData()\n request_data.update( { 'filetypes': self.filetypes } )\n self._response = self.PostDataToHandler( request_data,\n 'semantic_completion_available' )\n\n\n def Response( self ):\n return self._response\n\n\ndef SendCompleterAvailableRequest( filetypes ):\n request = CompleterAvailableRequest( filetypes )\n # This is a blocking call.\n request.Start()\n return request.Response()\n" }, { "path": "python/ycm/client/completion_request.py", "content": "# Copyright (C) 2013-2019 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport json\nimport logging\nfrom ycmd.utils import ToUnicode\nfrom ycm.client.base_request import ( BaseRequest,\n DisplayServerException,\n MakeServerException )\nfrom ycm import vimsupport, base\nfrom ycm.vimsupport import NO_COMPLETIONS\n\n_logger = logging.getLogger( __name__ )\n\n\nclass CompletionRequest( BaseRequest ):\n def __init__( self, request_data ):\n super().__init__()\n self.request_data = request_data\n self._response_future = None\n\n\n def Start( self ):\n self._response_future = self.PostDataToHandlerAsync( self.request_data,\n 'completions' )\n\n\n def Done( self ):\n return bool( self._response_future ) and self._response_future.done()\n\n\n def _RawResponse( self ):\n if not self._response_future:\n return NO_COMPLETIONS\n\n response = self.HandleFuture( self._response_future,\n truncate_message = True )\n if not response:\n return NO_COMPLETIONS\n\n # Vim may not be able to convert the 'errors' entry to its internal format\n # so we remove it from the response.\n errors = response.pop( 'errors', [] )\n for e in errors:\n exception = MakeServerException( e )\n _logger.error( exception )\n DisplayServerException( exception, truncate_message = True )\n\n response[ 'line' ] = self.request_data[ 'line_num' ]\n response[ 'column' ] = self.request_data[ 'column_num' ]\n return response\n\n\n def Response( self ):\n response = self._RawResponse()\n response[ 'completions' ] = _ConvertCompletionDatasToVimDatas(\n response[ 'completions' ] )\n # FIXME: Do we really need to do this AdjustCandidateInsertionText ? I feel\n # like Vim should do that for us\n response[ 'completions' ] = base.AdjustCandidateInsertionText(\n response[ 'completions' ] )\n return response\n\n\n def OnCompleteDone( self ):\n if not self.Done():\n return\n\n if 'cs' in vimsupport.CurrentFiletypes():\n self._OnCompleteDone_Csharp()\n else:\n self._OnCompleteDone_FixIt()\n\n\n def _GetExtraDataUserMayHaveCompleted( self ):\n completed_item = vimsupport.GetVariableValue( 'v:completed_item' )\n\n # If Vim supports user_data (8.0.1493 or later), we actually know the\n # _exact_ element that was selected, having put its extra_data in the\n # user_data field. Otherwise, we have to guess by matching the values in the\n # completed item and the list of completions. Sometimes this returns\n # multiple possibilities, which is essentially unresolvable.\n if 'user_data' not in completed_item:\n completions = self._RawResponse()[ 'completions' ]\n return _FilterToMatchingCompletions( completed_item, completions )\n\n if completed_item[ 'user_data' ]:\n return [ json.loads( completed_item[ 'user_data' ] ) ]\n\n return []\n\n\n def _OnCompleteDone_Csharp( self ):\n extra_datas = self._GetExtraDataUserMayHaveCompleted()\n namespaces = [ _GetRequiredNamespaceImport( c ) for c in extra_datas ]\n namespaces = [ n for n in namespaces if n ]\n if not namespaces:\n return\n\n if len( namespaces ) > 1:\n choices = [ f\"{ i + 1 } { n }\" for i, n in enumerate( namespaces ) ]\n choice = vimsupport.PresentDialog( \"Insert which namespace:\", choices )\n if choice < 0:\n return\n namespace = namespaces[ choice ]\n else:\n namespace = namespaces[ 0 ]\n\n vimsupport.InsertNamespace( namespace )\n\n\n def _OnCompleteDone_FixIt( self ):\n extra_datas = self._GetExtraDataUserMayHaveCompleted()\n fixit_completions = [ _GetFixItCompletion( c ) for c in extra_datas ]\n fixit_completions = [ f for f in fixit_completions if f ]\n if not fixit_completions:\n return\n\n # If we have user_data in completions (8.0.1493 or later), then we would\n # only ever return max. 1 completion here. However, if we had to guess, it\n # is possible that we matched multiple completion items (e.g. for overloads,\n # or similar classes in multiple packages). In any case, rather than\n # prompting the user and disturbing her workflow, we just apply the first\n # one. This might be wrong, but the solution is to use a (very) new version\n # of Vim which supports user_data on completion items\n fixit_completion = fixit_completions[ 0 ]\n\n for fixit in fixit_completion:\n vimsupport.ReplaceChunks( fixit[ 'chunks' ], silent=True )\n\n\ndef _GetRequiredNamespaceImport( extra_data ):\n return extra_data.get( 'required_namespace_import' )\n\n\ndef _GetFixItCompletion( extra_data ):\n return extra_data.get( 'fixits' )\n\n\ndef _FilterToMatchingCompletions( completed_item, completions ):\n \"\"\"Filter to completions matching the item Vim said was completed\"\"\"\n match_keys = [ 'word', 'abbr', 'menu', 'info' ]\n matched_completions = []\n for completion in completions:\n item = ConvertCompletionDataToVimData( completion )\n\n def matcher( key ):\n return ( ToUnicode( completed_item.get( key, \"\" ) ) ==\n ToUnicode( item.get( key, \"\" ) ) )\n\n if all( matcher( i ) for i in match_keys ):\n matched_completions.append( completion.get( 'extra_data', {} ) )\n return matched_completions\n\n\ndef _GetCompletionInfoField( completion_data ):\n info = completion_data.get( 'detailed_info', '' )\n\n if 'extra_data' in completion_data:\n docstring = completion_data[ 'extra_data' ].get( 'doc_string', '' )\n if docstring:\n if info:\n info += '\\n' + docstring\n else:\n info = docstring\n\n # This field may contain null characters e.g. \\x00 in Python docstrings. Vim\n # cannot evaluate such characters so they are removed.\n return info.replace( '\\x00', '' )\n\n\ndef ConvertCompletionDataToVimData( completion_data ):\n # See :h complete-items for a description of the dictionary fields.\n extra_menu_info = completion_data.get( 'extra_menu_info', '' )\n preview_info = _GetCompletionInfoField( completion_data )\n\n # When we are using a popup for the preview_info, it needs to fit on the\n # screen alongside the extra_menu_info. Let's use some heuristics. If the\n # length of the extra_menu_info is more than, say, 1/3 of screen, truncate it\n # and stick it in the preview_info.\n if vimsupport.UsingPreviewPopup():\n max_width = max( int( vimsupport.DisplayWidth() / 3 ), 3 )\n extra_menu_info_width = vimsupport.DisplayWidthOfString( extra_menu_info )\n if extra_menu_info_width > max_width:\n if not preview_info.startswith( extra_menu_info ):\n preview_info = extra_menu_info + '\\n\\n' + preview_info\n extra_menu_info = extra_menu_info[ : ( max_width - 3 ) ] + '...'\n\n return {\n 'word' : completion_data[ 'insertion_text' ],\n 'abbr' : completion_data.get( 'menu_text', '' ),\n 'menu' : extra_menu_info,\n 'info' : preview_info,\n 'kind' : ToUnicode( completion_data.get( 'kind', '' ) )[ :1 ].lower(),\n # Disable Vim filtering.\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n # We store the completion item extra_data as a string in the completion\n # user_data. This allows us to identify the _exact_ item that was completed\n # in the CompleteDone handler, by inspecting this item from v:completed_item\n #\n # We convert to string because completion user data items must be strings.\n #\n # Note: Not all versions of Vim support this (added in 8.0.1483), but adding\n # the item to the dictionary is harmless in earlier Vims.\n # Note: Since 8.2.0084 we don't need to use json.dumps() here.\n 'user_data': json.dumps( completion_data.get( 'extra_data', {} ) )\n }\n\n\ndef _ConvertCompletionDatasToVimDatas( response_data ):\n return [ ConvertCompletionDataToVimData( x ) for x in response_data ]\n" }, { "path": "python/ycm/client/debug_info_request.py", "content": "# Copyright (C) 2016-2017 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.client.base_request import BaseRequest, BuildRequestData\n\n\nclass DebugInfoRequest( BaseRequest ):\n def __init__( self, extra_data = None ):\n super( DebugInfoRequest, self ).__init__()\n self._extra_data = extra_data\n self._response = None\n\n\n def Start( self ):\n request_data = BuildRequestData()\n if self._extra_data:\n request_data.update( self._extra_data )\n self._response = self.PostDataToHandler( request_data,\n 'debug_info',\n display_message = False )\n\n\n def Response( self ):\n return self._response\n\n\ndef FormatDebugInfoResponse( response ):\n if not response:\n return 'Server errored, no debug info from server\\n'\n message = _FormatYcmdDebugInfo( response )\n completer = response[ 'completer' ]\n if completer:\n message += _FormatCompleterDebugInfo( completer )\n return message\n\n\ndef _FormatYcmdDebugInfo( ycmd ):\n python = ycmd[ 'python' ]\n clang = ycmd[ 'clang' ]\n message = (\n f'Server Python interpreter: { python[ \"executable\" ] }\\n'\n f'Server Python version: { python[ \"version\" ] }\\n'\n f'Server has Clang support compiled in: { clang[ \"has_support\" ] }\\n'\n f'Clang version: { clang[ \"version\" ] }\\n' )\n extra_conf = ycmd[ 'extra_conf' ]\n extra_conf_path = extra_conf[ 'path' ]\n if not extra_conf_path:\n message += 'No extra configuration file found\\n'\n elif not extra_conf[ 'is_loaded' ]:\n message += ( 'Extra configuration file found but not loaded\\n'\n f'Extra configuration path: { extra_conf_path }\\n' )\n else:\n message += ( 'Extra configuration file found and loaded\\n'\n f'Extra configuration path: { extra_conf_path }\\n' )\n return message\n\n\ndef _FormatCompleterDebugInfo( completer ):\n message = f'{ completer[ \"name\" ] } completer debug information:\\n'\n for server in completer[ 'servers' ]:\n name = server[ 'name' ]\n if server[ 'is_running' ]:\n address = server[ 'address' ]\n port = server[ 'port' ]\n if address and port:\n message += f' { name } running at: http://{ address }:{ port }\\n'\n else:\n message += f' { name } running\\n'\n message += f' { name } process ID: { server[ \"pid\" ] }\\n'\n else:\n message += f' { name } not running\\n'\n message += f' { name } executable: { server[ \"executable\" ] }\\n'\n logfiles = server[ 'logfiles' ]\n if logfiles:\n message += f' { name } logfiles:\\n'\n for logfile in logfiles:\n message += f' { logfile }\\n'\n else:\n message += ' No logfiles available\\n'\n if 'extras' in server:\n for extra in server[ 'extras' ]:\n message += f' { name } { extra[ \"key\" ] }: { extra[ \"value\" ] }\\n'\n for item in completer[ 'items' ]:\n message += f' { item[ \"key\" ].capitalize() }: { item[ \"value\" ] }\\n'\n return message\n\n\ndef SendDebugInfoRequest( extra_data = None ):\n request = DebugInfoRequest( extra_data )\n # This is a blocking call.\n request.Start()\n return request.Response()\n" }, { "path": "python/ycm/client/event_notification.py", "content": "# Copyright (C) 2013-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.client.base_request import BaseRequest, BuildRequestData\n\n\nclass EventNotification( BaseRequest ):\n def __init__( self, event_name, buffer_number = None, extra_data = None ):\n super( EventNotification, self ).__init__()\n self._event_name = event_name\n self._buffer_number = buffer_number\n self._extra_data = extra_data\n self._response_future = None\n self._cached_response = None\n\n\n def Start( self ):\n request_data = BuildRequestData( self._buffer_number )\n if self._extra_data:\n request_data.update( self._extra_data )\n request_data[ 'event_name' ] = self._event_name\n\n self._response_future = self.PostDataToHandlerAsync( request_data,\n 'event_notification' )\n\n\n def Done( self ):\n return bool( self._response_future ) and self._response_future.done()\n\n\n def Response( self ):\n if self._cached_response:\n return self._cached_response\n\n if not self._response_future or self._event_name != 'FileReadyToParse':\n return []\n\n self._cached_response = self.HandleFuture( self._response_future,\n truncate_message = True )\n\n return self._cached_response if self._cached_response else []\n\n\ndef SendEventNotificationAsync( event_name,\n buffer_number = None,\n extra_data = None ):\n event = EventNotification( event_name, buffer_number, extra_data )\n event.Start()\n" }, { "path": "python/ycm/client/inlay_hints_request.py", "content": "# Copyright (C) 2022, YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\n\nimport logging\nfrom ycm.client.base_request import ( BaseRequest, DisplayServerException,\n MakeServerException )\n\n_logger = logging.getLogger( __name__ )\n\n\n# FIXME: This is copy/pasta from SemanticTokensRequest - abstract a\n# SimpleAsyncRequest base that does all of this generically\nclass InlayHintsRequest( BaseRequest ):\n def __init__( self, request_data ):\n super().__init__()\n self.request_data = request_data\n self._response_future = None\n\n\n def Start( self ):\n self._response_future = self.PostDataToHandlerAsync( self.request_data,\n 'inlay_hints' )\n\n def Done( self ):\n return bool( self._response_future ) and self._response_future.done()\n\n\n def Reset( self ):\n self._response_future = None\n\n def Response( self ):\n if not self._response_future:\n return []\n\n response = self.HandleFuture( self._response_future,\n truncate_message = True )\n\n if not response:\n return []\n\n # Vim may not be able to convert the 'errors' entry to its internal format\n # so we remove it from the response.\n errors = response.pop( 'errors', [] )\n for e in errors:\n exception = MakeServerException( e )\n _logger.error( exception )\n DisplayServerException( exception, truncate_message = True )\n\n return response.get( 'inlay_hints' ) or []\n" }, { "path": "python/ycm/client/messages_request.py", "content": "# Copyright (C) 2017 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.client.base_request import BaseRequest, BuildRequestData\nfrom ycm.vimsupport import PostVimMessage\n\nimport logging\n\n_logger = logging.getLogger( __name__ )\n\n# Looooong poll\nTIMEOUT_SECONDS = 60\n\n\nclass MessagesPoll( BaseRequest ):\n def __init__( self, buff ):\n super( MessagesPoll, self ).__init__()\n self._request_data = BuildRequestData( buff.number )\n self._response_future = None\n\n\n def _SendRequest( self ):\n self._response_future = self.PostDataToHandlerAsync(\n self._request_data,\n 'receive_messages',\n timeout = TIMEOUT_SECONDS )\n return\n\n\n def Poll( self, diagnostics_handler ):\n \"\"\"This should be called regularly to check for new messages in this buffer.\n Returns True if Poll should be called again in a while. Returns False when\n the completer or server indicated that further polling should not be done\n for the requested file.\"\"\"\n\n if self._response_future is None:\n # First poll\n self._SendRequest()\n return True\n\n if not self._response_future.done():\n # Nothing yet...\n return True\n\n response = self.HandleFuture( self._response_future,\n display_message = False )\n if response is None:\n # Server returned an exception.\n return False\n\n poll_again = _HandlePollResponse( response, diagnostics_handler )\n if poll_again:\n self._SendRequest()\n return True\n\n return False\n\n\ndef _HandlePollResponse( response, diagnostics_handler ):\n if isinstance( response, list ):\n for notification in response:\n if 'message' in notification:\n PostVimMessage( notification[ 'message' ],\n warning = False,\n truncate = True )\n elif 'diagnostics' in notification:\n diagnostics_handler.UpdateWithNewDiagnosticsForFile(\n notification[ 'filepath' ],\n notification[ 'diagnostics' ] )\n elif response is False:\n # Don't keep polling for this file\n return False\n # else any truthy response means \"nothing to see here; poll again in a\n # while\"\n\n # Start the next poll (only if the last poll didn't raise an exception)\n return True\n" }, { "path": "python/ycm/client/omni_completion_request.py", "content": "# Copyright (C) 2013 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.client.completion_request import CompletionRequest\n\n\nclass OmniCompletionRequest( CompletionRequest ):\n def __init__( self, omni_completer, request_data ):\n super( OmniCompletionRequest, self ).__init__( request_data )\n self._omni_completer = omni_completer\n\n\n def Start( self ):\n self._results = self._omni_completer.ComputeCandidates( self.request_data )\n\n\n def Done( self ):\n return True\n\n\n def Response( self ):\n return {\n 'line': self.request_data[ 'line_num' ],\n 'column': self.request_data[ 'column_num' ],\n 'completion_start_column': self.request_data[ 'start_column' ],\n 'completions': self._results\n }\n\n\n def OnCompleteDone( self ):\n pass\n" }, { "path": "python/ycm/client/resolve_completion_request.py", "content": "# Copyright (C) 2020 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.client.base_request import ( BaseRequest,\n DisplayServerException,\n MakeServerException )\nfrom ycm.client.completion_request import ( CompletionRequest,\n ConvertCompletionDataToVimData )\n\nimport logging\nimport json\n_logger = logging.getLogger( __name__ )\n\n\nclass ResolveCompletionRequest( BaseRequest ):\n def __init__( self,\n completion_request: CompletionRequest,\n request_data ):\n super().__init__()\n self.request_data = request_data\n self.completion_request = completion_request\n\n def Start( self ):\n self._response_future = self.PostDataToHandlerAsync( self.request_data,\n 'resolve_completion' )\n\n def Done( self ):\n return bool( self._response_future ) and self._response_future.done()\n\n\n def OnCompleteDone( self ):\n # This is required to be compatible with the \"CompletionRequest\" API. We're\n # not really a CompletionRequest, but we are mutually exclusive with\n # completion requests, so we implement this API by delegating to the\n # original completion request, which contains all of the code for actually\n # handling things like automatic imports etc.\n self.completion_request.OnCompleteDone()\n\n\n def Response( self ):\n response = self.HandleFuture( self._response_future,\n truncate_message = True,\n display_message = True )\n\n if not response or not response[ 'completion' ]:\n return { 'completion': [] }\n\n # Vim may not be able to convert the 'errors' entry to its internal format\n # so we remove it from the response.\n errors = response.pop( 'errors', [] )\n for e in errors:\n exception = MakeServerException( e )\n _logger.error( exception )\n DisplayServerException( exception, truncate_message = True )\n\n response[ 'completion' ] = ConvertCompletionDataToVimData(\n response[ 'completion' ] )\n return response\n\n\ndef ResolveCompletionItem( completion_request, item ):\n if not completion_request.Done():\n return None\n try:\n completion_extra_data = json.loads( item[ 'user_data' ] )\n except KeyError:\n return None\n except ( TypeError, json.JSONDecodeError ):\n # Can happen with the omni completer\n return None\n\n request_data = completion_request.request_data\n try:\n # Note: We mutate the request_data inside the original completion request\n # and pass it into the new request object. this is just a big efficiency\n # saving. The request_data for a Done() request is almost certainly no\n # longer needed.\n request_data[ 'resolve' ] = completion_extra_data[ 'resolve' ]\n except KeyError:\n return None\n\n resolve_request = ResolveCompletionRequest( completion_request, request_data )\n resolve_request.Start()\n return resolve_request\n" }, { "path": "python/ycm/client/semantic_tokens_request.py", "content": "# Copyright (C) 2020, YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\n\nimport logging\nfrom ycm.client.base_request import ( BaseRequest, DisplayServerException,\n MakeServerException )\n\n_logger = logging.getLogger( __name__ )\n\n\n# FIXME: This is copy/pasta from SignatureHelpRequest - abstract a\n# SimpleAsyncRequest base that does all of this generically\nclass SemanticTokensRequest( BaseRequest ):\n def __init__( self, request_data ):\n super().__init__()\n self.request_data = request_data\n self._response_future = None\n\n\n def Start( self ):\n self._response_future = self.PostDataToHandlerAsync( self.request_data,\n 'semantic_tokens' )\n\n def Done( self ):\n return bool( self._response_future ) and self._response_future.done()\n\n\n def Reset( self ):\n self._response_future = None\n\n def Response( self ):\n if not self._response_future:\n return {}\n\n response = self.HandleFuture( self._response_future,\n truncate_message = True )\n\n if not response:\n return {}\n\n # Vim may not be able to convert the 'errors' entry to its internal format\n # so we remove it from the response.\n errors = response.pop( 'errors', [] )\n for e in errors:\n exception = MakeServerException( e )\n _logger.error( exception )\n DisplayServerException( exception, truncate_message = True )\n\n return response.get( 'semantic_tokens' ) or {}\n" }, { "path": "python/ycm/client/shutdown_request.py", "content": "# Copyright (C) 2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.client.base_request import BaseRequest\n\nTIMEOUT_SECONDS = 0.1\n\n\nclass ShutdownRequest( BaseRequest ):\n def __init__( self ):\n super( ShutdownRequest, self ).__init__()\n\n\n def Start( self ):\n self.PostDataToHandler( {},\n 'shutdown',\n TIMEOUT_SECONDS,\n display_message = False )\n\n\ndef SendShutdownRequest():\n request = ShutdownRequest()\n # This is a blocking call.\n request.Start()\n" }, { "path": "python/ycm/client/signature_help_request.py", "content": "# Copyright (C) 2019 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport logging\nfrom ycm.client.base_request import ( BaseRequest, DisplayServerException,\n MakeServerException )\n\n_logger = logging.getLogger( __name__ )\n\n\nclass SigHelpAvailableByFileType( dict ):\n def __missing__( self, filetype ):\n request = SignatureHelpAvailableRequest( filetype )\n self[ filetype ] = request\n return request\n\n\nclass SignatureHelpRequest( BaseRequest ):\n def __init__( self, request_data ):\n super( SignatureHelpRequest, self ).__init__()\n self.request_data = request_data\n self._response_future = None\n self._response = None\n\n\n def Start( self ):\n self._response_future = self.PostDataToHandlerAsync( self.request_data,\n 'signature_help' )\n\n\n def Done( self ):\n return bool( self._response_future ) and self._response_future.done()\n\n\n def Reset( self ):\n self._response_future = None\n\n\n def Response( self ):\n if self._response is None:\n self._response = self._Response()\n return self._response\n\n\n def _Response( self ):\n if not self._response_future:\n return {}\n\n response = self.HandleFuture( self._response_future,\n truncate_message = True )\n if not response:\n return {}\n\n # Vim may not be able to convert the 'errors' entry to its internal format\n # so we remove it from the response.\n errors = response.pop( 'errors', [] )\n for e in errors:\n exception = MakeServerException( e )\n _logger.error( exception )\n DisplayServerException( exception, truncate_message = True )\n\n return response.get( 'signature_help' ) or {}\n\n\nclass SignatureHelpAvailableRequest( BaseRequest ):\n def __init__( self, filetype ):\n super( SignatureHelpAvailableRequest, self ).__init__()\n self._response_future = None\n self.Start( filetype )\n\n\n def Done( self ):\n return bool( self._response_future ) and self._response_future.done()\n\n\n def Response( self ):\n if not self._response_future:\n return None\n\n response = self.HandleFuture( self._response_future,\n truncate_message = True )\n\n if not response:\n return None\n\n return response[ 'available' ]\n\n\n def Start( self, filetype ):\n self._response_future = self.GetDataFromHandlerAsync(\n 'signature_help_available',\n payload = { 'subserver': filetype } )\n" }, { "path": "python/ycm/client/ycmd_keepalive.py", "content": "# Copyright (C) 2013 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport time\nfrom threading import Thread\nfrom ycm.client.base_request import BaseRequest\n\n\n# This class can be used to keep the ycmd server alive for the duration of the\n# life of the client. By default, ycmd shuts down if it doesn't see a request in\n# a while.\nclass YcmdKeepalive:\n def __init__( self, ping_interval_seconds = 60 * 10 ):\n self._keepalive_thread = Thread( target = self._ThreadMain )\n self._keepalive_thread.daemon = True\n self._ping_interval_seconds = ping_interval_seconds\n\n\n def Start( self ):\n self._keepalive_thread.start()\n\n\n def _ThreadMain( self ):\n while True:\n time.sleep( self._ping_interval_seconds )\n\n BaseRequest().GetDataFromHandler( 'healthy', display_message = False )\n" }, { "path": "python/ycm/diagnostic_filter.py", "content": "# Copyright (C) 2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport re\n\n\nclass DiagnosticFilter:\n def __init__( self, config_or_filters ):\n self._filters : list = config_or_filters\n\n\n def IsAllowed( self, diagnostic ):\n return not any( filterMatches( diagnostic )\n for filterMatches in self._filters )\n\n\n @staticmethod\n def CreateFromOptions( user_options ):\n all_filters = user_options[ 'filter_diagnostics' ]\n compiled_by_type = {}\n for type_spec, filter_value in all_filters.items():\n filetypes = type_spec.split( ',' )\n for filetype in filetypes:\n compiled_by_type[ filetype ] = _CompileFilters( filter_value )\n\n return _MasterDiagnosticFilter( compiled_by_type )\n\n\nclass _MasterDiagnosticFilter:\n\n def __init__( self, all_filters ):\n self._all_filters = all_filters\n self._cache = {}\n\n\n def SubsetForTypes( self, filetypes ):\n # check cache\n cache_key = ','.join( filetypes )\n cached = self._cache.get( cache_key )\n if cached is not None:\n return cached\n\n # build a new DiagnosticFilter merging all filters\n # for the provided filetypes\n spec = []\n for filetype in filetypes:\n type_specific = self._all_filters.get( filetype, [] )\n spec.extend( type_specific )\n\n new_filter = DiagnosticFilter( spec )\n self._cache[ cache_key ] = new_filter\n return new_filter\n\n\ndef _ListOf( config_entry ):\n if isinstance( config_entry, list ):\n return config_entry\n\n return [ config_entry ]\n\n\ndef CompileRegex( raw_regex ):\n pattern = re.compile( raw_regex, re.IGNORECASE )\n\n def FilterRegex( diagnostic ):\n return pattern.search( diagnostic[ 'text' ] ) is not None\n\n return FilterRegex\n\n\ndef CompileLevel( level ):\n # valid kinds are WARNING and ERROR;\n # expected input levels are `warning` and `error`\n # NOTE: we don't validate the input...\n expected_kind = level.upper()\n\n def FilterLevel( diagnostic ):\n return diagnostic[ 'kind' ] == expected_kind\n\n return FilterLevel\n\n\nFILTER_COMPILERS = { 'regex' : CompileRegex,\n 'level' : CompileLevel }\n\n\ndef _CompileFilters( config ):\n \"\"\"Given a filter config dictionary, return a list of compiled filters\"\"\"\n filters = []\n\n for filter_type, filter_pattern in config.items():\n compiler = FILTER_COMPILERS.get( filter_type )\n\n if compiler is not None:\n for filter_config in _ListOf( filter_pattern ):\n compiledFilter = compiler( filter_config )\n filters.append( compiledFilter )\n\n return filters\n" }, { "path": "python/ycm/diagnostic_interface.py", "content": "# Copyright (C) 2013-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom collections import defaultdict\nfrom ycm import vimsupport\nfrom ycm.diagnostic_filter import DiagnosticFilter, CompileLevel\nfrom ycm import text_properties as tp\nimport vim\nYCM_VIM_PROPERTY_ID = 1\n\n\nclass DiagnosticInterface:\n def __init__( self, bufnr, user_options ):\n self._bufnr = bufnr\n self._user_options = user_options\n self._diagnostics = []\n self._diag_filter = DiagnosticFilter.CreateFromOptions( user_options )\n # Line and column numbers are 1-based\n self._line_to_diags = defaultdict( list )\n self._previous_diag_line_number = -1\n self._diag_message_needs_clearing = False\n\n\n def ShouldUpdateDiagnosticsUINow( self ):\n return ( self._user_options[ 'update_diagnostics_in_insert_mode' ] or\n 'i' not in vim.eval( 'mode()' ) )\n\n\n def OnCursorMoved( self ):\n if self._user_options[ 'echo_current_diagnostic' ]:\n line, _ = vimsupport.CurrentLineAndColumn()\n line += 1 # Convert to 1-based\n if not self.ShouldUpdateDiagnosticsUINow():\n # Clear any previously echo'd diagnostic in insert mode\n self._EchoDiagnosticText( line, None, None )\n elif line != self._previous_diag_line_number:\n self._EchoDiagnosticForLine( line )\n\n\n def GetErrorCount( self ):\n return self._DiagnosticsCount( _DiagnosticIsError )\n\n\n def GetWarningCount( self ):\n return self._DiagnosticsCount( _DiagnosticIsWarning )\n\n\n def PopulateLocationList( self, open_on_edit = False ):\n # Do nothing if loc list is already populated by diag_interface\n if not self._user_options[ 'always_populate_location_list' ]:\n self._UpdateLocationLists( open_on_edit )\n return bool( self._diagnostics )\n\n\n def UpdateWithNewDiagnostics( self, diags, open_on_edit = False ):\n self._diagnostics = [ _NormalizeDiagnostic( x ) for x in\n self._ApplyDiagnosticFilter( diags ) ]\n self._ConvertDiagListToDict()\n\n if self.ShouldUpdateDiagnosticsUINow():\n self.RefreshDiagnosticsUI( open_on_edit )\n\n\n def RefreshDiagnosticsUI( self, open_on_edit = False ):\n if self._user_options[ 'echo_current_diagnostic' ]:\n self._EchoDiagnostic()\n\n if self._user_options[ 'enable_diagnostic_signs' ]:\n self._UpdateSigns()\n\n self.UpdateMatches()\n\n if self._user_options[ 'always_populate_location_list' ]:\n self._UpdateLocationLists( open_on_edit )\n\n\n def ClearDiagnosticsUI( self ):\n if self._user_options[ 'echo_current_diagnostic' ]:\n self._ClearCurrentDiagnostic()\n\n if self._user_options[ 'enable_diagnostic_signs' ]:\n self._ClearSigns()\n\n self._ClearMatches()\n\n\n def DiagnosticsForLine( self, line_number ):\n return self._line_to_diags[ line_number ]\n\n\n def _ApplyDiagnosticFilter( self, diags ):\n filetypes = vimsupport.GetBufferFiletypes( self._bufnr )\n diag_filter = self._diag_filter.SubsetForTypes( filetypes )\n return filter( diag_filter.IsAllowed, diags )\n\n\n def _EchoDiagnostic( self ):\n line, _ = vimsupport.CurrentLineAndColumn()\n line += 1 # Convert to 1-based\n self._EchoDiagnosticForLine( line )\n\n\n def _EchoDiagnosticForLine( self, line_num ):\n self._previous_diag_line_number = line_num\n\n diags = self._line_to_diags[ line_num ]\n text = None\n first_diag = None\n if diags:\n first_diag = diags[ 0 ]\n text = first_diag[ 'text' ]\n if first_diag.get( 'fixit_available', False ):\n text += ' (FixIt)'\n\n self._EchoDiagnosticText( line_num, first_diag, text )\n\n\n def _ClearCurrentDiagnostic( self, will_be_replaced=False ):\n if not self._diag_message_needs_clearing:\n return\n\n if ( not vimsupport.VimIsNeovim() and\n self._user_options[ 'echo_current_diagnostic' ] == 'virtual-text' ):\n tp.ClearTextProperties( self._bufnr,\n prop_types = [ 'YcmVirtDiagPadding',\n 'YcmVirtDiagError',\n 'YcmVirtDiagWarning' ] )\n else:\n if not will_be_replaced:\n vimsupport.PostVimMessage( '', warning = False )\n\n self._diag_message_needs_clearing = False\n\n\n def _EchoDiagnosticText( self, line_num, first_diag, text ):\n self._ClearCurrentDiagnostic( bool( text ) )\n\n if ( not vimsupport.VimIsNeovim() and\n self._user_options[ 'echo_current_diagnostic' ] == 'virtual-text' ):\n if not text:\n return\n\n def MakeVritualTextProperty( prop_type, text, position='after' ):\n vimsupport.AddTextProperty( self._bufnr,\n line_num,\n 0,\n prop_type,\n {\n 'text': text,\n 'text_align': position,\n 'text_wrap': 'wrap'\n } )\n\n if vim.options[ 'ambiwidth' ] != 'double':\n marker = '⚠'\n else:\n marker = '>'\n\n MakeVritualTextProperty(\n 'YcmVirtDiagPadding',\n ' ' * vim.buffers[ self._bufnr ].options[ 'shiftwidth' ] ),\n MakeVritualTextProperty(\n 'YcmVirtDiagError' if _DiagnosticIsError( first_diag )\n else 'YcmVirtDiagWarning',\n marker + ' ' + [ line for line in text.splitlines() if line ][ 0 ] )\n else:\n if not text:\n # We already cleared it\n return\n\n vimsupport.PostVimMessage( text, warning = False, truncate = True )\n\n self._diag_message_needs_clearing = True\n\n\n def _DiagnosticsCount( self, predicate ):\n count = 0\n for diags in self._line_to_diags.values():\n count += sum( 1 for d in diags if predicate( d ) )\n return count\n\n\n def _UpdateLocationLists( self, open_on_edit = False ):\n vimsupport.SetLocationListsForBuffer(\n self._bufnr,\n vimsupport.ConvertDiagnosticsToQfList( self._diagnostics ),\n open_on_edit )\n\n\n def _ClearMatches( self ):\n props_to_remove = vimsupport.GetTextProperties( self._bufnr )\n for prop in props_to_remove:\n vimsupport.RemoveDiagnosticProperty( self._bufnr, prop )\n\n\n def UpdateMatches( self ):\n if not self._user_options[ 'enable_diagnostic_highlighting' ]:\n return\n\n props_to_remove = vimsupport.GetTextProperties( self._bufnr )\n for diags in self._line_to_diags.values():\n # Insert squiggles in reverse order so that errors overlap warnings.\n for diag in reversed( diags ):\n for line, column, name, extras in _ConvertDiagnosticToTextProperties(\n self._bufnr,\n diag ):\n global YCM_VIM_PROPERTY_ID\n\n # Note the following .remove() works because the __eq__ on\n # DiagnosticProperty does not actually check the IDs match...\n diag_prop = vimsupport.DiagnosticProperty(\n YCM_VIM_PROPERTY_ID,\n name,\n line,\n column,\n extras[ 'end_col' ] - column if 'end_col' in extras else column )\n try:\n props_to_remove.remove( diag_prop )\n except ValueError:\n extras.update( {\n 'id': YCM_VIM_PROPERTY_ID\n } )\n vimsupport.AddTextProperty( self._bufnr,\n line,\n column,\n name,\n extras )\n YCM_VIM_PROPERTY_ID += 1\n for prop in props_to_remove:\n vimsupport.RemoveDiagnosticProperty( self._bufnr, prop )\n\n\n def _ClearSigns( self ):\n signs_to_unplace = vimsupport.GetSignsInBuffer( self._bufnr )\n vim.eval( f'sign_unplacelist( { signs_to_unplace } )' )\n\n\n def _UpdateSigns( self ):\n signs_to_unplace = vimsupport.GetSignsInBuffer( self._bufnr )\n signs_to_place = []\n for line, diags in self._line_to_diags.items():\n if not diags:\n continue\n\n # We always go for the first diagnostic on the line because diagnostics\n # are sorted by errors in priority and Vim can only display one sign by\n # line.\n name = 'YcmError' if _DiagnosticIsError( diags[ 0 ] ) else 'YcmWarning'\n sign = {\n 'lnum': line,\n 'name': name,\n 'buffer': self._bufnr,\n 'group': 'ycm_signs'\n }\n try:\n signs_to_unplace.remove( sign )\n except ValueError:\n signs_to_place.append( sign )\n vim.eval( f'sign_placelist( { signs_to_place } )' )\n vim.eval( f'sign_unplacelist( { signs_to_unplace } )' )\n\n\n def _ConvertDiagListToDict( self ):\n self._line_to_diags = defaultdict( list )\n for diag in self._diagnostics:\n location_extent = diag[ 'location_extent' ]\n start = location_extent[ 'start' ]\n end = location_extent[ 'end' ]\n bufnr = vimsupport.GetBufferNumberForFilename( start[ 'filepath' ] )\n if bufnr == self._bufnr:\n for line_number in range( start[ 'line_num' ], end[ 'line_num' ] + 1 ):\n self._line_to_diags[ line_number ].append( diag )\n\n for diags in self._line_to_diags.values():\n # We also want errors to be listed before warnings so that errors aren't\n # hidden by the warnings; Vim won't place a sign over an existing one.\n diags.sort( key = lambda diag: ( diag[ 'kind' ],\n diag[ 'location' ][ 'column_num' ] ) )\n\n\n_DiagnosticIsError = CompileLevel( 'error' )\n_DiagnosticIsWarning = CompileLevel( 'warning' )\n\n\ndef _NormalizeDiagnostic( diag ):\n def ClampToOne( value ):\n return value if value > 0 else 1\n\n location = diag[ 'location' ]\n location[ 'column_num' ] = ClampToOne( location[ 'column_num' ] )\n location[ 'line_num' ] = ClampToOne( location[ 'line_num' ] )\n return diag\n\n\ndef _ConvertDiagnosticToTextProperties( bufnr, diagnostic ):\n properties = []\n\n name = ( 'YcmErrorProperty' if _DiagnosticIsError( diagnostic ) else\n 'YcmWarningProperty' )\n if vimsupport.VimIsNeovim():\n name = name.replace( 'Property', 'Section' )\n\n location_extent = diagnostic[ 'location_extent' ]\n if location_extent[ 'start' ][ 'line_num' ] <= 0:\n location = diagnostic[ 'location' ]\n line, column = vimsupport.LineAndColumnNumbersClamped(\n bufnr,\n location[ 'line_num' ],\n location[ 'column_num' ]\n )\n properties.append( ( line, column, name, {} ) )\n else:\n start_line, start_column = vimsupport.LineAndColumnNumbersClamped(\n bufnr,\n location_extent[ 'start' ][ 'line_num' ],\n location_extent[ 'start' ][ 'column_num' ]\n )\n end_line, end_column = vimsupport.LineAndColumnNumbersClamped(\n bufnr,\n location_extent[ 'end' ][ 'line_num' ],\n location_extent[ 'end' ][ 'column_num' ]\n )\n properties.append( (\n start_line,\n start_column,\n name,\n { 'end_lnum': end_line,\n 'end_col': end_column } ) )\n\n for diagnostic_range in diagnostic[ 'ranges' ]:\n if ( diagnostic_range[ 'start' ][ 'line_num' ] == 0 or\n diagnostic_range[ 'end' ][ 'line_num' ] == 0 ):\n continue\n start_line, start_column = vimsupport.LineAndColumnNumbersClamped(\n bufnr,\n diagnostic_range[ 'start' ][ 'line_num' ],\n diagnostic_range[ 'start' ][ 'column_num' ]\n )\n end_line, end_column = vimsupport.LineAndColumnNumbersClamped(\n bufnr,\n diagnostic_range[ 'end' ][ 'line_num' ],\n diagnostic_range[ 'end' ][ 'column_num' ]\n )\n\n if not _IsValidRange( start_line, start_column, end_line, end_column ):\n continue\n\n properties.append( (\n start_line,\n start_column,\n name,\n { 'end_lnum': end_line,\n 'end_col': end_column } ) )\n\n return properties\n\n\ndef _IsValidRange( start_line, start_column, end_line, end_column ):\n # End line before start line - invalid\n if start_line > end_line:\n return False\n\n # End line after start line - valid\n if start_line < end_line:\n return True\n\n # Same line, start colum after end column - invalid\n if start_column > end_column:\n return False\n\n # Same line, start column before or equal to end column - valid\n return True\n" }, { "path": "python/ycm/hierarchy_tree.py", "content": "# Copyright (C) 2024 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom typing import Optional, List\nfrom ycm import vimsupport\nimport os\n\n\nclass HierarchyNode:\n def __init__( self, data, distance : int ):\n self._references : Optional[ List[ int ] ] = None\n self._data = data\n self._distance_from_root = distance\n\n\n def ToRootLocation( self, subindex : int ):\n location = self._data.get( 'root_location' )\n if location:\n file = location[ 'filepath' ]\n line = location[ 'line_num' ]\n column = location[ 'column_num' ]\n return file, line, column\n else:\n return self.ToLocation( subindex )\n\n\n def ToLocation( self, subindex : int ):\n location = self._data[ 'locations' ][ subindex ]\n line = location[ 'line_num' ]\n column = location[ 'column_num' ]\n file = location[ 'filepath' ]\n return file, line, column\n\n\nMAX_HANDLES_PER_INDEX = 1000000\n\n\ndef handle_to_index( handle : int ):\n return abs( handle ) // MAX_HANDLES_PER_INDEX\n\n\ndef handle_to_location_index( handle : int ):\n return abs( handle ) % MAX_HANDLES_PER_INDEX\n\n\ndef make_handle( index : int, location_index : int ):\n return index * MAX_HANDLES_PER_INDEX + location_index\n\n\nclass HierarchyTree:\n def __init__( self ):\n self._up_nodes : List[ HierarchyNode ] = []\n self._down_nodes : List[ HierarchyNode ] = []\n self._kind : str = ''\n\n def SetRootNode( self, items, kind : str ):\n if items:\n assert len( items ) == 1\n self._root_node_indices = [ 0 ]\n self._down_nodes.append( HierarchyNode( items[ 0 ], 0 ) )\n self._up_nodes.append( HierarchyNode( items[ 0 ], 0 ) )\n self._kind = kind\n return self.HierarchyToLines()\n return []\n\n\n def UpdateHierarchy( self, handle : int, items, direction : str ):\n current_index = handle_to_index( handle )\n nodes = self._down_nodes if direction == 'down' else self._up_nodes\n if items:\n nodes.extend( [\n HierarchyNode( item,\n nodes[ current_index ]._distance_from_root + 1 )\n for item in items ] )\n nodes[ current_index ]._references = list(\n range( len( nodes ) - len( items ), len( nodes ) ) )\n else:\n nodes[ current_index ]._references = []\n\n\n def Reset( self ):\n self._down_nodes = []\n self._up_nodes = []\n self._kind = ''\n\n\n def _HierarchyToLinesHelper( self, refs, use_down_nodes ):\n partial_result = []\n nodes = self._down_nodes if use_down_nodes else self._up_nodes\n for index in refs:\n next_node = nodes[ index ]\n indent = 2 * next_node._distance_from_root\n if index == 0:\n can_expand = ( self._down_nodes[ 0 ]._references is None or\n self._up_nodes[ 0 ]._references is None )\n else:\n can_expand = next_node._references is None\n symbol = '+' if can_expand else '-'\n name = next_node._data[ 'name' ]\n kind = next_node._data[ 'kind' ]\n if use_down_nodes:\n partial_result.extend( [\n (\n {\n 'indent': indent,\n 'icon': symbol,\n 'symbol': name,\n 'kind': kind,\n 'filepath': os.path.split( l[ 'filepath' ] )[ 1 ],\n 'line_num': str( l[ 'line_num' ] ),\n 'description': l.get( 'description', '' ).strip(),\n },\n make_handle( index, location_index )\n )\n for location_index, l in enumerate( next_node._data[ 'locations' ] )\n ] )\n else:\n partial_result.extend( [\n (\n {\n 'indent': indent,\n 'icon': symbol,\n 'symbol': name,\n 'kind': kind,\n 'filepath': os.path.split( l[ 'filepath' ] )[ 1 ],\n 'line_num': str( l[ 'line_num' ] ),\n 'description': l.get( 'description', '' ).strip(),\n },\n make_handle( index, location_index ) * -1\n )\n for location_index, l in enumerate( next_node._data[ 'locations' ] )\n ] )\n if next_node._references:\n partial_result.extend(\n self._HierarchyToLinesHelper(\n next_node._references, use_down_nodes ) )\n return partial_result\n\n def HierarchyToLines( self ):\n down_lines = self._HierarchyToLinesHelper( [ 0 ], True )\n up_lines = self._HierarchyToLinesHelper( [ 0 ], False )\n up_lines.reverse()\n return up_lines + down_lines[ 1: ]\n\n\n def JumpToItem( self, handle : int, command ):\n node_index = handle_to_index( handle )\n location_index = handle_to_location_index( handle )\n if handle >= 0:\n node = self._down_nodes[ node_index ]\n else:\n node = self._up_nodes[ node_index ]\n file, line, column = node.ToLocation( location_index )\n vimsupport.JumpToLocation( file, line, column, '', command )\n\n\n def ShouldResolveItem( self, handle : int, direction : str ):\n node_index = handle_to_index( handle )\n if ( ( handle >= 0 and direction == 'down' ) or\n ( handle <= 0 and direction == 'up' ) ):\n if direction == 'down':\n node = self._down_nodes[ node_index ]\n else:\n node = self._up_nodes[ node_index ]\n return node._references is None\n return True\n\n\n def ResolveArguments( self, handle : int, direction : str ):\n node_index = handle_to_index( handle )\n if self._kind == 'call':\n direction = 'outgoing' if direction == 'up' else 'incoming'\n else:\n direction = 'supertypes' if direction == 'up' else 'subtypes'\n if handle >= 0:\n node = self._down_nodes[ node_index ]\n else:\n node = self._up_nodes[ node_index ]\n return [\n f'Resolve{ self._kind.title() }HierarchyItem',\n node._data,\n direction\n ]\n\n\n def HandleToRootLocation( self, handle : int ):\n node_index = handle_to_index( handle )\n\n if handle >= 0:\n node = self._down_nodes[ node_index ]\n else:\n node = self._up_nodes[ node_index ]\n\n location_index = handle_to_location_index( handle )\n return node.ToRootLocation( location_index )\n\n\n def UpdateChangesRoot( self, handle : int, direction : str ):\n return ( ( handle < 0 and direction == 'down' ) or\n ( handle > 0 and direction == 'up' ) )\n" }, { "path": "python/ycm/inlay_hints.py", "content": "# Copyright (C) 2022, YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\n\nfrom ycm.client.inlay_hints_request import InlayHintsRequest\nfrom ycm.client.base_request import BuildRequestData\nfrom ycm import vimsupport\nfrom ycm import text_properties as tp\nfrom ycm import scrolling_range as sr\n\n\nHIGHLIGHT_GROUP = {\n 'Type': 'YcmInlayHint',\n 'Parameter': 'YcmInlayHint',\n 'Enum': 'YcmInlayHint',\n}\nREPORTED_MISSING_TYPES = set()\n\n\ndef Initialise():\n if vimsupport.VimIsNeovim():\n return False\n\n props = tp.GetTextPropertyTypes()\n if 'YCM_INLAY_UNKNOWN' not in props:\n tp.AddTextPropertyType( 'YCM_INLAY_UNKNOWN',\n highlight = 'YcmInlayHint',\n start_incl = 1 )\n if 'YCM_INLAY_PADDING' not in props:\n tp.AddTextPropertyType( 'YCM_INLAY_PADDING',\n highlight = 'YcmInvisible',\n start_incl = 1 )\n\n for token_type, group in HIGHLIGHT_GROUP.items():\n prop = f'YCM_INLAY_{ token_type }'\n if prop not in props and vimsupport.GetIntValue(\n f\"hlexists( '{ vimsupport.EscapeForVim( group ) }' )\" ):\n tp.AddTextPropertyType( prop,\n highlight = group,\n start_incl = 1 )\n\n return True\n\n\nclass InlayHints( sr.ScrollingBufferRange ):\n \"\"\"Stores the inlay hints state for a Vim buffer\"\"\"\n\n\n def _NewRequest( self, request_range ):\n request_data = BuildRequestData( self._bufnr )\n request_data[ 'range' ] = request_range\n return InlayHintsRequest( request_data )\n\n\n def Clear( self ):\n types = [ 'YCM_INLAY_UNKNOWN', 'YCM_INLAY_PADDING' ] + [\n f'YCM_INLAY_{ prop_type }' for prop_type in HIGHLIGHT_GROUP.keys()\n ]\n\n tp.ClearTextProperties( self._bufnr, prop_types = types )\n\n\n def _Draw( self ):\n self.Clear()\n\n for inlay_hint in self._latest_response:\n if 'kind' not in inlay_hint:\n prop_type = 'YCM_INLAY_UNKNOWN'\n elif inlay_hint[ 'kind' ] not in HIGHLIGHT_GROUP:\n prop_type = 'YCM_INLAY_UNKNOWN'\n else:\n prop_type = 'YCM_INLAY_' + inlay_hint[ 'kind' ]\n\n self.GrowRangeIfNeeded( {\n 'start': inlay_hint[ 'position' ],\n 'end': {\n 'line_num': inlay_hint[ 'position' ][ 'line_num' ],\n 'column_num': inlay_hint[ 'position' ][ 'column_num' ] + len(\n inlay_hint[ 'label' ] )\n }\n } )\n\n if inlay_hint.get( 'paddingLeft', False ):\n tp.AddTextProperty( self._bufnr,\n None,\n 'YCM_INLAY_PADDING',\n {\n 'start': inlay_hint[ 'position' ],\n },\n {\n 'text': ' '\n } )\n\n tp.AddTextProperty( self._bufnr,\n None,\n prop_type,\n {\n 'start': inlay_hint[ 'position' ],\n },\n {\n 'text': inlay_hint[ 'label' ]\n } )\n\n if inlay_hint.get( 'paddingRight', False ):\n tp.AddTextProperty( self._bufnr,\n None,\n 'YCM_INLAY_PADDING',\n {\n 'start': inlay_hint[ 'position' ],\n },\n {\n 'text': ' '\n } )\n" }, { "path": "python/ycm/omni_completer.py", "content": "# Copyright (C) 2011-2019 ycmd contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport vim\nfrom ycm import vimsupport\nfrom ycmd import utils\nfrom ycmd.completers.completer import Completer\nfrom ycm.client.base_request import BaseRequest\n\nOMNIFUNC_RETURNED_BAD_VALUE = 'Omnifunc returned bad value to YCM!'\nOMNIFUNC_NOT_LIST = ( 'Omnifunc did not return a list or a dict with a \"words\" '\n ' list when expected.' )\n\n\nclass OmniCompleter( Completer ):\n def __init__( self, user_options ):\n super( OmniCompleter, self ).__init__( user_options )\n self._omnifunc = None\n\n\n def SupportedFiletypes( self ):\n return []\n\n\n def ShouldUseCache( self ):\n return bool( self.user_options[ 'cache_omnifunc' ] )\n\n\n def ShouldUseNow( self, request_data ):\n self._omnifunc = utils.ToUnicode( vim.eval( '&omnifunc' ) )\n if not self._omnifunc:\n return False\n if self.ShouldUseCache():\n return super( OmniCompleter, self ).ShouldUseNow( request_data )\n return self.ShouldUseNowInner( request_data )\n\n\n def ShouldUseNowInner( self, request_data ):\n if request_data[ 'force_semantic' ]:\n return True\n disabled_filetypes = self.user_options[\n 'filetype_specific_completion_to_disable' ]\n if not vimsupport.CurrentFiletypesEnabled( disabled_filetypes ):\n return False\n return super( OmniCompleter, self ).ShouldUseNowInner( request_data )\n\n\n def ComputeCandidates( self, request_data ):\n if self.ShouldUseCache():\n return super( OmniCompleter, self ).ComputeCandidates( request_data )\n if self.ShouldUseNowInner( request_data ):\n return self.ComputeCandidatesInner( request_data )\n return []\n\n\n def ComputeCandidatesInner( self, request_data ):\n if not self._omnifunc:\n return []\n\n # Calling directly the omnifunc may move the cursor position. This is the\n # case with the default Vim omnifunc for C-family languages\n # (ccomplete#Complete) which calls searchdecl to find a declaration. This\n # function is supposed to move the cursor to the found declaration but it\n # doesn't when called through the omni completion mapping (CTRL-X CTRL-O).\n # So, we restore the cursor position after the omnifunc calls.\n line, column = vimsupport.CurrentLineAndColumn()\n\n try:\n start_column = vimsupport.GetIntValue( self._omnifunc + '(1,\"\")' )\n\n # Vim only stops completion if the value returned by the omnifunc is -3 or\n # -2. In other cases, if the value is negative or greater than the current\n # column, the start column is set to the current column; otherwise, the\n # value is used as the start column.\n if start_column in ( -3, -2 ):\n return []\n if start_column < 0 or start_column > column:\n start_column = column\n\n # Use the start column calculated by the omnifunc, rather than our own\n # interpretation. This is important for certain languages where our\n # identifier detection is either incorrect or not compatible with the\n # behaviour of the omnifunc. Note: do this before calling the omnifunc\n # because it affects the value returned by 'query'.\n request_data[ 'start_column' ] = start_column + 1\n\n # Vim internally moves the cursor to the start column before calling again\n # the omnifunc. Some omnifuncs like the one defined by the\n # LanguageClient-neovim plugin depend on this behavior to compute the list\n # of candidates.\n vimsupport.SetCurrentLineAndColumn( line, start_column )\n\n omnifunc_call = [ self._omnifunc,\n \"(0,'\",\n vimsupport.EscapeForVim( request_data[ 'query' ] ),\n \"')\" ]\n items = vim.eval( ''.join( omnifunc_call ) )\n\n if isinstance( items, dict ) and 'words' in items:\n items = items[ 'words' ]\n\n if not hasattr( items, '__iter__' ):\n raise TypeError( OMNIFUNC_NOT_LIST )\n\n # Vim allows each item of the list to be either a string or a dictionary\n # but ycmd only supports lists where items are all strings or all\n # dictionaries. Convert all strings into dictionaries.\n for index, item in enumerate( items ):\n # Set the 'equal' field to 1 to disable Vim filtering.\n if not isinstance( item, dict ):\n items[ index ] = {\n 'word': item,\n 'equal': 1\n }\n else:\n item[ 'equal' ] = 1\n\n return items\n\n except ( TypeError, ValueError, vim.error ) as error:\n vimsupport.PostVimMessage(\n OMNIFUNC_RETURNED_BAD_VALUE + ' ' + str( error ) )\n return []\n\n finally:\n vimsupport.SetCurrentLineAndColumn( line, column )\n\n\n def FilterAndSortCandidatesInner( self, candidates, sort_property, query ):\n request_data = {\n 'candidates': candidates,\n 'sort_property': sort_property,\n 'query': query\n }\n\n response = BaseRequest().PostDataToHandler( request_data,\n 'filter_and_sort_candidates' )\n return response if response is not None else []\n" }, { "path": "python/ycm/paths.py", "content": "# Copyright (C) 2015-2017 YouCompleteMe contributors.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport os\nimport sys\nimport vim\nimport re\n\n# Can't import these from setup.py because it makes nosetests go crazy.\nDIR_OF_CURRENT_SCRIPT = os.path.dirname( os.path.abspath( __file__ ) )\nDIR_OF_YCMD = os.path.join( DIR_OF_CURRENT_SCRIPT, '..', '..', 'third_party',\n 'ycmd' )\nWIN_PYTHON_PATH = os.path.join( sys.exec_prefix, 'python.exe' )\nPYTHON_BINARY_REGEX = re.compile(\n r'python(3(\\.[6-9])?)?(.exe)?$', re.IGNORECASE )\n\n\n# Not caching the result of this function; users shouldn't have to restart Vim\n# after running the install script or setting the\n# `g:ycm_server_python_interpreter` option.\ndef PathToPythonInterpreter():\n # Not calling the Python interpreter to check its version as it significantly\n # impacts startup time.\n from ycmd import utils\n\n python_interpreter = vim.eval( 'g:ycm_server_python_interpreter' )\n if python_interpreter:\n python_interpreter = utils.FindExecutable( python_interpreter )\n if python_interpreter:\n return python_interpreter\n\n raise RuntimeError( \"Path in 'g:ycm_server_python_interpreter' option \"\n \"does not point to a valid Python 3.6+.\" )\n\n python_interpreter = _PathToPythonUsedDuringBuild()\n if python_interpreter and utils.GetExecutable( python_interpreter ):\n return python_interpreter\n\n # On UNIX platforms, we use sys.executable as the Python interpreter path.\n # We cannot use sys.executable on Windows because for unknown reasons, it\n # returns the Vim executable. Instead, we use sys.exec_prefix to deduce the\n # interpreter path.\n python_interpreter = ( WIN_PYTHON_PATH if utils.OnWindows() else\n sys.executable )\n if _EndsWithPython( python_interpreter ):\n return python_interpreter\n\n python_interpreter = utils.PathToFirstExistingExecutable( [ 'python3',\n 'python' ] )\n if python_interpreter:\n return python_interpreter\n\n raise RuntimeError( \"Cannot find Python 3.6+. \"\n \"Set the 'g:ycm_server_python_interpreter' option \"\n \"to a Python interpreter path.\" )\n\n\ndef _PathToPythonUsedDuringBuild():\n from ycmd import utils\n\n try:\n filepath = os.path.join( DIR_OF_YCMD, 'PYTHON_USED_DURING_BUILDING' )\n return utils.ReadFile( filepath ).strip()\n except OSError:\n return None\n\n\ndef _EndsWithPython( path ):\n \"\"\"Check if given path ends with a python 3.6+ name.\"\"\"\n return path and PYTHON_BINARY_REGEX.search( path ) is not None\n\n\ndef PathToServerScript():\n return os.path.join( DIR_OF_YCMD, 'ycmd' )\n" }, { "path": "python/ycm/scrolling_range.py", "content": "# Copyright (C) 2023, YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport abc\n\nfrom ycm import vimsupport\n\n\nclass ScrollingBufferRange( object ):\n \"\"\"Abstraction used by inlay hints and semantic tokens to only request visible\n ranges\"\"\"\n\n # FIXME: Send a request per-disjoint range for this buffer rather than the\n # maximal range. then collaate the results when all responses are returned\n def __init__( self, bufnr ):\n self._bufnr = bufnr\n self._tick = -1\n self._request = None\n self._last_requested_range = None\n\n\n def Ready( self ):\n return self._request is not None and self._request.Done()\n\n\n def Request( self, force=False ):\n if self._request and not self.Ready():\n return True\n\n # Check to see if the buffer ranges would actually change anything visible.\n # This avoids a round-trip for every single line scroll event\n if ( not force and\n self._tick == vimsupport.GetBufferChangedTick( self._bufnr ) and\n vimsupport.VisibleRangeOfBufferOverlaps(\n self._bufnr,\n self._last_requested_range ) ):\n return False # don't poll\n\n # FIXME: This call is duplicated in the call to VisibleRangeOfBufferOverlaps\n # - remove the expansion param\n # - look up the actual visible range, then call this function\n # - if not overlapping, do the factor expansion and request\n self._last_requested_range = vimsupport.RangeVisibleInBuffer( self._bufnr )\n # If this is false, either the self._bufnr is not a valid buffer number or\n # the buffer is not visible in any window.\n # Since this is called asynchronously, a user may bwipeout a buffer with\n # self._bufnr number between polls.\n if self._last_requested_range is None:\n return False\n\n self._tick = vimsupport.GetBufferChangedTick( self._bufnr )\n\n # We'll never use the last response again, so clear it\n self._latest_response = None\n self._request = self._NewRequest( self._last_requested_range )\n self._request.Start()\n return True\n\n\n def Update( self ):\n if not self._request:\n # Nothing to update\n return True\n\n assert self.Ready()\n\n # We're ready to use this response. Clear the request (to avoid repeatedly\n # re-polling).\n self._latest_response = self._request.Response()\n self._request = None\n\n if self._tick != vimsupport.GetBufferChangedTick( self._bufnr ):\n # Buffer has changed, we should ignore the data and retry\n self.Request( force=True )\n return False # poll again\n\n self._Draw()\n\n # No need to re-poll\n return True\n\n\n def Refresh( self ):\n if self._tick != vimsupport.GetBufferChangedTick( self._bufnr ):\n # stale data\n return\n\n if self._request is not None:\n # request in progress; we''l handle refreshing when it's done.\n return\n\n self._Draw()\n\n\n def GrowRangeIfNeeded( self, rng ):\n \"\"\"When processing results, we may receive a wider range than requested. In\n that case, grow our 'last requested' range to minimise requesting more\n frequently than we need to.\"\"\"\n # Note: references (pointers) so no need to re-assign\n rmin = self._last_requested_range[ 'start' ]\n rmax = self._last_requested_range[ 'end' ]\n\n start = rng[ 'start' ]\n end = rng[ 'end' ]\n\n if rmin[ 'line_num' ] is None or start[ 'line_num' ] < rmin[ 'line_num' ]:\n rmin[ 'line_num' ] = start[ 'line_num' ]\n rmin[ 'column_num' ] = start[ 'column_num' ]\n elif start[ 'line_num' ] == rmin[ 'line_num' ]:\n rmin[ 'column_num' ] = min( start[ 'column_num' ],\n rmin[ 'column_num' ] )\n\n if rmax[ 'line_num' ] is None or end[ 'line_num' ] > rmax[ 'line_num' ]:\n rmax[ 'line_num' ] = end[ 'line_num' ]\n rmax[ 'column_num' ] = end[ 'column_num' ]\n elif end[ 'line_num' ] == rmax[ 'line_num' ]:\n rmax[ 'column_num' ] = max( end[ 'column_num' ], rmax[ 'column_num' ] )\n\n\n # API; just implement the following, using self._bufnr and\n # self._latest_response as required\n\n @abc.abstractmethod\n def _NewRequest( self, request_range ):\n # prepare a new request_data and return it\n pass\n\n\n @abc.abstractmethod\n def _Draw( self ):\n # actuall paint the properties\n pass\n" }, { "path": "python/ycm/semantic_highlighting.py", "content": "# Copyright (C) 2020, YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\n\nfrom ycm.client.semantic_tokens_request import SemanticTokensRequest\nfrom ycm.client.base_request import BuildRequestData\nfrom ycm import vimsupport\nfrom ycm import text_properties as tp\nfrom ycm import scrolling_range as sr\n\nimport vim\n\n\nHIGHLIGHT_GROUP = {\n 'namespace': 'Type',\n 'type': 'Type',\n 'class': 'Structure',\n 'enum': 'Structure',\n 'interface': 'Structure',\n 'struct': 'Structure',\n 'typeParameter': 'Identifier',\n 'parameter': 'Identifier',\n 'variable': 'Identifier',\n 'property': 'Identifier',\n 'enumMember': 'Identifier',\n 'enumConstant': 'Constant',\n 'event': 'Identifier',\n 'function': 'Function',\n 'member': 'Identifier',\n 'macro': 'Macro',\n 'method': 'Function',\n 'keyword': 'Keyword',\n 'modifier': 'Keyword',\n 'comment': 'Comment',\n 'string': 'String',\n 'number': 'Number',\n 'regexp': 'String',\n 'operator': 'Operator',\n 'decorator': 'Special',\n 'unknown': 'Normal',\n\n # These are not part of the spec, but are used by clangd\n 'bracket': 'Normal',\n 'concept': 'Type',\n # These are not part of the spec, but are used by jdt.ls\n 'annotation': 'Macro',\n}\nREPORTED_MISSING_TYPES = set()\n\n\ndef Initialise():\n if vimsupport.VimIsNeovim():\n return\n\n props = tp.GetTextPropertyTypes()\n if 'YCM_HL_UNKNOWN' not in props:\n tp.AddTextPropertyType( 'YCM_HL_UNKNOWN',\n highlight = 'WarningMsg',\n priority = 0 )\n\n for token_type, group in HIGHLIGHT_GROUP.items():\n prop = f'YCM_HL_{ token_type }'\n if prop not in props and vimsupport.GetIntValue(\n f\"hlexists( '{ vimsupport.EscapeForVim( group ) }' )\" ):\n tp.AddTextPropertyType( prop,\n highlight = group,\n priority = 0 )\n\n\n# \"arbitrary\" base id\nNEXT_TEXT_PROP_ID = 70784\n\n\ndef NextPropID():\n global NEXT_TEXT_PROP_ID\n try:\n return NEXT_TEXT_PROP_ID\n finally:\n NEXT_TEXT_PROP_ID += 1\n\n\n\nclass SemanticHighlighting( sr.ScrollingBufferRange ):\n \"\"\"Stores the semantic highlighting state for a Vim buffer\"\"\"\n\n def __init__( self, bufnr ):\n self._prop_id = NextPropID()\n super().__init__( bufnr )\n\n\n def _NewRequest( self, request_range ):\n request: dict = BuildRequestData( self._bufnr )\n request[ 'range' ] = request_range\n return SemanticTokensRequest( request )\n\n\n def _Draw( self ):\n # We requested a snapshot\n tokens = self._latest_response.get( 'tokens', [] )\n\n prev_prop_id = self._prop_id\n self._prop_id = NextPropID()\n\n for token in tokens:\n prop_type = f\"YCM_HL_{ token[ 'type' ] }\"\n rng = token[ 'range' ]\n self.GrowRangeIfNeeded( rng )\n\n try:\n tp.AddTextProperty( self._bufnr, self._prop_id, prop_type, rng )\n except vim.error as e:\n if 'E971:' in str( e ): # Text property doesn't exist\n if token[ 'type' ] not in REPORTED_MISSING_TYPES:\n REPORTED_MISSING_TYPES.add( token[ 'type' ] )\n vimsupport.PostVimMessage(\n f\"Token type { token[ 'type' ] } not supported. \"\n f\"Define property type { prop_type }. \"\n f\"See :help youcompleteme-customising-highlight-groups\" )\n else:\n raise e\n\n tp.ClearTextProperties( self._bufnr, prop_id = prev_prop_id )\n" }, { "path": "python/ycm/signature_help.py", "content": "# Copyright (C) 2011-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport vim\nimport json\nfrom ycm import vimsupport\nfrom ycmd import utils\nfrom ycm.vimsupport import memoize, GetIntValue\n\n\nclass SignatureHelpState:\n ACTIVE = 'ACTIVE'\n INACTIVE = 'INACTIVE'\n ACTIVE_SUPPRESSED = 'ACTIVE_SUPPRESSED'\n\n def __init__( self,\n popup_win_id = None,\n state = INACTIVE ):\n self.popup_win_id = popup_win_id\n self.state = state\n self.anchor = None\n\n\n def ToggleVisibility( self ):\n if self.state == 'ACTIVE':\n self.state = 'ACTIVE_SUPPRESSED'\n vim.eval( f'popup_hide( { self.popup_win_id } )' )\n elif self.state == 'ACTIVE_SUPPRESSED':\n self.state = 'ACTIVE'\n vim.eval( f'popup_show( { self.popup_win_id } )' )\n\n\n def IsActive( self ):\n if self.state in ( 'ACTIVE', 'ACTIVE_SUPPRESSED' ):\n return 'ACTIVE'\n return 'INACTIVE'\n\n\ndef _MakeSignatureHelpBuffer( signature_info ):\n active_parameter = int( signature_info.get( 'activeParameter', 0 ) )\n\n lines = []\n signatures = ( signature_info.get( 'signatures' ) or [] )\n\n for sig_index, signature in enumerate( signatures ):\n props = []\n\n sig_label = signature[ 'label' ]\n parameters = ( signature.get( 'parameters' ) or [] )\n for param_index, parameter in enumerate( parameters ):\n param_label = parameter[ 'label' ]\n begin = int( param_label[ 0 ] )\n end = int( param_label[ 1 ] )\n if param_index == active_parameter:\n props.append( {\n 'col': begin + 1, # 1-based\n 'length': end - begin,\n 'type': 'YCM-signature-help-current-argument'\n } )\n\n lines.append( {\n 'text': sig_label,\n 'props': props\n } )\n\n return lines\n\n\n@memoize()\ndef ShouldUseSignatureHelp():\n return ( vimsupport.VimHasFunctions( 'screenpos', 'pum_getpos' ) and\n vimsupport.VimSupportsPopupWindows() )\n\n\ndef UpdateSignatureHelp( state, signature_info ): # noqa\n if not ShouldUseSignatureHelp():\n return state\n\n signatures = signature_info.get( 'signatures' ) or []\n\n if not signatures:\n if state.popup_win_id:\n # TODO/FIXME: Should we use popup_hide() instead ?\n vim.eval( f\"popup_close( { state.popup_win_id } )\" )\n return SignatureHelpState( None, SignatureHelpState.INACTIVE )\n\n if state.state == SignatureHelpState.INACTIVE:\n state.anchor = vimsupport.CurrentLineAndColumn()\n\n state.state = SignatureHelpState.ACTIVE\n\n # Generate the buffer as a list of lines\n buf_lines = _MakeSignatureHelpBuffer( signature_info )\n screen_pos = vimsupport.ScreenPositionForLineColumnInWindow(\n vim.current.window,\n state.anchor[ 0 ] + 1, # anchor 0-based\n state.anchor[ 1 ] + 1 ) # anchor 0-based\n\n # Simulate 'flip' at the screen boundaries by using screenpos and hiding the\n # signature help menu if it overlaps the completion popup (pum).\n #\n # FIXME: revert to cursor-relative positioning and the 'flip' option when that\n # is implemented (if that is indeed better).\n\n # By default display above the anchor\n line = int( screen_pos[ 'row' ] ) - 1 # -1 to display above the cur line\n pos = \"botleft\"\n\n cursor_line = vimsupport.CurrentLineAndColumn()[ 0 ] + 1\n if int( screen_pos[ 'row' ] ) <= len( buf_lines ):\n # No room at the top, display below\n line = int( screen_pos[ 'row' ] ) + 1\n pos = \"topleft\"\n\n # Don't allow the popup to overlap the cursor\n if ( pos == 'topleft' and\n line < cursor_line and\n line + len( buf_lines ) >= cursor_line ):\n line = 0\n\n # Don't allow the popup to overlap the pum\n if line > 0 and GetIntValue( 'pumvisible()' ):\n pum_line = GetIntValue( 'pum_getpos().row' ) + 1\n if pos == 'botleft' and pum_line <= line:\n line = 0\n elif ( pos == 'topleft' and\n pum_line >= line and\n pum_line < ( line + len( buf_lines ) ) ):\n line = 0\n\n if line <= 0:\n # Nowhere to put it so hide it\n if state.popup_win_id:\n # TODO/FIXME: Should we use popup_hide() instead ?\n vim.eval( f\"popup_close( { state.popup_win_id } )\" )\n return SignatureHelpState( None, SignatureHelpState.INACTIVE )\n\n if int( screen_pos[ 'curscol' ] ) <= 1:\n col = 1\n else:\n # -1 for padding,\n # -1 for the trigger character inserted (the anchor is set _after_ the\n # character is inserted, so we remove it).\n # FIXME: multi-byte characters would be wrong. Need to set anchor before\n # inserting the char ?\n col = int( screen_pos[ 'curscol' ] ) - 2\n\n # Vim stops shifting the popup to the left if we turn on soft-wrapping.\n # Instead, we want to first shift the popup to the left and then\n # and then turn on wrapping.\n max_line_length = max( len( item[ 'text' ] ) for item in buf_lines )\n vim_width = vimsupport.GetIntValue( '&columns' )\n line_available = vim_width - max( col, 1 )\n if max_line_length > line_available:\n col = vim_width - max_line_length\n\n if col <= 0:\n col = 1\n\n options = {\n \"line\": line,\n \"col\": col,\n \"pos\": pos,\n \"wrap\": 0,\n # NOTE: We *dont'* use \"cursorline\" here - that actually uses PMenuSel,\n # which is just too invasive for us (it's more selected item than actual\n # cursorline. So instead, we manually set 'cursorline' in the popup window\n # and enable syntax based on the current file syntax)\n \"flip\": 1,\n \"fixed\": 1,\n \"padding\": [ 0, 1, 0, 1 ], # Pad 1 char in X axis to match completion menu\n \"hidden\": int( state.state == SignatureHelpState.ACTIVE_SUPPRESSED )\n }\n\n if not state.popup_win_id:\n state.popup_win_id = GetIntValue(\n f'popup_create( { json.dumps( buf_lines ) }, '\n f'{ json.dumps( options ) } )' )\n else:\n vim.eval( f'popup_settext( { state.popup_win_id }, '\n f'{ json.dumps( buf_lines ) } )' )\n\n # Should do nothing if already visible\n vim.eval( f'popup_move( { state.popup_win_id }, { json.dumps( options ) } )' )\n if state.state == SignatureHelpState.ACTIVE:\n vim.eval( f'popup_show( { state.popup_win_id } )' )\n\n if vim.vars.get( 'ycm_signature_help_disable_syntax', False ):\n syntax = ''\n else:\n syntax = utils.ToUnicode( vim.current.buffer.options[ 'syntax' ] )\n\n active_signature = int( signature_info.get( 'activeSignature', 0 ) )\n vim.eval( f\"win_execute( { state.popup_win_id }, \"\n f\"'set syntax={ syntax } cursorline wrap | \"\n f\"call cursor( [ { active_signature + 1 }, 1 ] )' )\" )\n\n return state\n" }, { "path": "python/ycm/syntax_parse.py", "content": "# Copyright (C) 2013 Google Inc.\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport re\nfrom ycm import vimsupport\n\nSYNTAX_GROUP_REGEX = re.compile(\n r\"\"\"^\n (?P\\w+)\n \\s+\n xxx\n \\s+\n (?P.+?)\n $\"\"\",\n re.VERBOSE )\n\nKEYWORD_REGEX = re.compile( r'^(\\w+),?$' )\n\nSYNTAX_ARGUMENT_REGEX = re.compile(\n r\"^\\w+=.*$\" )\n\nSYNTAX_REGION_ARGUMENT_REGEX = re.compile(\n r\"^(?:matchgroup|start)=.*$\" )\n\n# See \":h syn-nextgroup\".\nSYNTAX_NEXTGROUP_ARGUMENTS = {\n 'skipwhite',\n 'skipnl',\n 'skipempty'\n}\n\n# These are the parent groups from which we want to extract keywords.\nROOT_GROUPS = {\n 'Boolean',\n 'Identifier',\n 'Statement',\n 'PreProc',\n 'Type'\n}\n\n\nclass SyntaxGroup:\n def __init__( self, name, lines = None ):\n self.name = name\n self.lines = lines if lines else []\n self.children = []\n\n\ndef SyntaxKeywordsForCurrentBuffer():\n syntax_output = vimsupport.CaptureVimCommand( 'syntax list' )\n return _KeywordsFromSyntaxListOutput( syntax_output )\n\n\ndef _KeywordsFromSyntaxListOutput( syntax_output ):\n group_name_to_group = _SyntaxGroupsFromOutput( syntax_output )\n _ConnectGroupChildren( group_name_to_group )\n\n groups_with_keywords = []\n for root_group in ROOT_GROUPS:\n groups_with_keywords.extend(\n _GetAllDescendentats( group_name_to_group[ root_group ] ) )\n\n keywords = []\n for group in groups_with_keywords:\n keywords.extend( _ExtractKeywordsFromGroup( group ) )\n return set( keywords )\n\n\ndef _SyntaxGroupsFromOutput( syntax_output ):\n group_name_to_group = _CreateInitialGroupMap()\n lines = syntax_output.split( '\\n' )\n looking_for_group = True\n\n current_group = None\n for line in lines:\n if not line:\n continue\n\n match = SYNTAX_GROUP_REGEX.search( line )\n if match:\n if looking_for_group:\n looking_for_group = False\n else:\n group_name_to_group[ current_group.name ] = current_group\n\n current_group = SyntaxGroup( match.group( 'group_name' ),\n [ match.group( 'content' ).strip() ] )\n else:\n if looking_for_group:\n continue\n\n if line[ 0 ] == ' ' or line[ 0 ] == '\\t':\n current_group.lines.append( line.strip() )\n\n if current_group:\n group_name_to_group[ current_group.name ] = current_group\n return group_name_to_group\n\n\ndef _CreateInitialGroupMap():\n def AddToGroupMap( name, parent ):\n new_group = SyntaxGroup( name )\n group_name_to_group[ name ] = new_group\n parent.children.append( new_group )\n\n identifier_group = SyntaxGroup( 'Identifier' )\n statement_group = SyntaxGroup( 'Statement' )\n type_group = SyntaxGroup( 'Type' )\n preproc_group = SyntaxGroup( 'PreProc' )\n\n # See \":h group-name\" for details on how the initial group hierarchy is built.\n group_name_to_group = {\n 'Boolean': SyntaxGroup( 'Boolean' ),\n 'Identifier': identifier_group,\n 'Statement': statement_group,\n 'PreProc': preproc_group,\n 'Type': type_group\n }\n\n AddToGroupMap( 'Function', identifier_group )\n\n AddToGroupMap( 'Conditional', statement_group )\n AddToGroupMap( 'Repeat' , statement_group )\n AddToGroupMap( 'Label' , statement_group )\n AddToGroupMap( 'Operator' , statement_group )\n AddToGroupMap( 'Keyword' , statement_group )\n AddToGroupMap( 'Exception' , statement_group )\n\n AddToGroupMap( 'StorageClass', type_group )\n AddToGroupMap( 'Structure' , type_group )\n AddToGroupMap( 'Typedef' , type_group )\n\n AddToGroupMap( 'Include' , preproc_group )\n AddToGroupMap( 'Define' , preproc_group )\n AddToGroupMap( 'Macro' , preproc_group )\n AddToGroupMap( 'PreCondit', preproc_group )\n\n return group_name_to_group\n\n\ndef _ConnectGroupChildren( group_name_to_group ):\n def GetParentNames( group ):\n links_to = 'links to '\n parent_names = []\n for line in group.lines:\n if line.startswith( links_to ):\n parent_names.append( line[ len( links_to ): ] )\n return parent_names\n\n for group in group_name_to_group.values():\n parent_names = GetParentNames( group )\n\n for parent_name in parent_names:\n try:\n parent_group = group_name_to_group[ parent_name ]\n except KeyError:\n continue\n parent_group.children.append( group )\n\n\ndef _GetAllDescendentats( root_group ):\n descendants = []\n for child in root_group.children:\n descendants.append( child )\n descendants.extend( _GetAllDescendentats( child ) )\n return descendants\n\n\ndef _ExtractKeywordsFromLine( line ):\n if line.startswith( 'links to ' ):\n return []\n\n # Ignore \"syntax match\" lines (see \":h syn-match\").\n if line.startswith( 'match ' ):\n return []\n\n words = line.split()\n if not words:\n return []\n\n # Ignore \"syntax region\" lines (see \":h syn-region\"). They always start\n # with matchgroup= or start= in the syntax list.\n if SYNTAX_REGION_ARGUMENT_REGEX.match( words[ 0 ] ):\n return []\n\n # Ignore \"nextgroup=\" argument in first position and the arguments\n # \"skipwhite\", \"skipnl\", and \"skipempty\" that immediately come after.\n nextgroup_at_start = False\n if words[ 0 ].startswith( 'nextgroup=' ):\n nextgroup_at_start = True\n words = words[ 1: ]\n\n # Ignore \"contained\" argument in first position.\n if words[ 0 ] == 'contained':\n words = words[ 1: ]\n\n keywords = []\n for word in words:\n if nextgroup_at_start and word in SYNTAX_NEXTGROUP_ARGUMENTS:\n continue\n\n nextgroup_at_start = False\n\n keyword_matched = KEYWORD_REGEX.match( word )\n if keyword_matched:\n keywords.append( keyword_matched.group( 1 ) )\n return keywords\n\n\ndef _ExtractKeywordsFromGroup( group ):\n keywords = []\n for line in group.lines:\n keywords.extend( _ExtractKeywordsFromLine( line ) )\n return keywords\n" }, { "path": "python/ycm/tests/__init__.py", "content": "# Copyright (C) 2016-2020 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport os\nfrom ycm.tests.test_utils import MockVimModule\nMockVimModule()\n\nimport contextlib\nimport functools\nimport time\nfrom urllib.error import HTTPError, URLError\n\nfrom ycm.client.base_request import BaseRequest\nfrom ycm.tests import test_utils\nfrom ycm.youcompleteme import YouCompleteMe\nfrom ycmd.utils import CloseStandardStreams, WaitUntilProcessIsTerminated\n\n\ndef PathToTestFile( *args ):\n dir_of_current_script = os.path.dirname( os.path.abspath( __file__ ) )\n return os.path.join( dir_of_current_script, 'testdata', *args )\n\n\n# The default options which are required for a working YouCompleteMe object.\nDEFAULT_CLIENT_OPTIONS = {\n # YCM options\n 'g:ycm_log_level': 'info',\n 'g:ycm_keep_logfiles': 0,\n 'g:ycm_extra_conf_vim_data': [],\n 'g:ycm_server_python_interpreter': '',\n 'g:ycm_show_diagnostics_ui': 1,\n 'g:ycm_enable_diagnostic_signs': 1,\n 'g:ycm_enable_diagnostic_highlighting': 0,\n 'g:ycm_echo_current_diagnostic': 1,\n 'g:ycm_filter_diagnostics': {},\n 'g:ycm_always_populate_location_list': 0,\n 'g:ycm_open_loclist_on_ycm_diags': 1,\n 'g:ycm_collect_identifiers_from_tags_files': 0,\n 'g:ycm_seed_identifiers_with_syntax': 0,\n 'g:ycm_goto_buffer_command': 'same-buffer',\n 'g:ycm_update_diagnostics_in_insert_mode': 1,\n # ycmd options\n 'g:ycm_auto_trigger': 1,\n 'g:ycm_min_num_of_chars_for_completion': 2,\n 'g:ycm_semantic_triggers': {},\n 'g:ycm_filetype_specific_completion_to_disable': { 'gitcommit': 1 },\n 'g:ycm_max_num_candidates': 50,\n 'g:ycm_max_diagnostics_to_display': 30,\n 'g:ycm_disable_signature_help': 0,\n}\n\n\n@contextlib.contextmanager\ndef UserOptions( options ):\n old_vim_options = test_utils.VIM_OPTIONS.copy()\n test_utils.VIM_OPTIONS.update( DEFAULT_CLIENT_OPTIONS )\n test_utils.VIM_OPTIONS.update( options )\n try:\n yield\n finally:\n test_utils.VIM_OPTIONS = old_vim_options\n\n\ndef _IsReady():\n return BaseRequest().GetDataFromHandler( 'ready' )\n\n\ndef WaitUntilReady( timeout = 5 ):\n expiration = time.time() + timeout\n while True:\n try:\n if time.time() > expiration:\n raise RuntimeError( 'Waited for the server to be ready '\n f'for { timeout } seconds, aborting.' )\n if _IsReady():\n return\n except ( URLError, HTTPError ):\n pass\n finally:\n time.sleep( 0.1 )\n\n\ndef StopServer( ycm ):\n try:\n ycm.OnVimLeave()\n WaitUntilProcessIsTerminated( ycm._server_popen )\n CloseStandardStreams( ycm._server_popen )\n except Exception:\n pass\n\n\ndef YouCompleteMeInstance( custom_options = {} ):\n \"\"\"Defines a decorator function for tests that passes a unique YouCompleteMe\n instance as a parameter. This instance is initialized with the default options\n `DEFAULT_CLIENT_OPTIONS`. Use the optional parameter |custom_options| to give\n additional options and/or override the already existing ones.\n\n Example usage:\n\n from ycm.tests import YouCompleteMeInstance\n\n @YouCompleteMeInstance( { 'log_level': 'debug',\n 'keep_logfiles': 1 } )\n def Debug_test( ycm ):\n ...\n \"\"\"\n def Decorator( test ):\n @functools.wraps( test )\n def Wrapper( test_case_instance, *args, **kwargs ):\n with UserOptions( custom_options ):\n ycm = YouCompleteMe()\n WaitUntilReady()\n ycm.CheckIfServerIsReady()\n try:\n test_utils.VIM_PROPS_FOR_BUFFER.clear()\n return test( test_case_instance, ycm, *args, **kwargs )\n finally:\n StopServer( ycm )\n return Wrapper\n return Decorator\n\n\n@contextlib.contextmanager\ndef youcompleteme_instance( custom_options = {} ):\n \"\"\"Defines a context manager to be used in case a shared YCM state\n between subtests is to be avoided, as could be the case with completion\n caching.\"\"\"\n with UserOptions( custom_options ):\n ycm = YouCompleteMe()\n WaitUntilReady()\n try:\n test_utils.VIM_PROPS_FOR_BUFFER.clear()\n yield ycm\n finally:\n StopServer( ycm )\n" }, { "path": "python/ycm/tests/base_test.py", "content": "# Copyright (C) 2013 Google Inc.\n# 2020 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport contextlib\nfrom hamcrest import assert_that, equal_to\nfrom unittest import TestCase\nfrom unittest.mock import patch\n\nfrom ycm.tests.test_utils import MockVimModule\nvim_mock = MockVimModule()\nfrom ycm import base\n\n\n@contextlib.contextmanager\ndef MockCurrentFiletypes( filetypes = [ '' ] ):\n with patch( 'ycm.vimsupport.CurrentFiletypes', return_value = filetypes ):\n yield\n\n\n@contextlib.contextmanager\ndef MockCurrentColumnAndLineContents( column, line_contents ):\n with patch( 'ycm.vimsupport.CurrentColumn', return_value = column ):\n with patch( 'ycm.vimsupport.CurrentLineContents',\n return_value = line_contents ):\n yield\n\n\n@contextlib.contextmanager\ndef MockTextAfterCursor( text ):\n with patch( 'ycm.vimsupport.TextAfterCursor', return_value = text ):\n yield\n\n\nclass BaseTest( TestCase ):\n def test_AdjustCandidateInsertionText_Basic( self ):\n with MockTextAfterCursor( 'bar' ):\n assert_that( [ { 'word': 'foo', 'abbr': 'foobar' } ],\n equal_to( base.AdjustCandidateInsertionText( [\n { 'word': 'foobar', 'abbr': '' } ] ) ) )\n\n\n def test_AdjustCandidateInsertionText_ParenInTextAfterCursor( self ):\n with MockTextAfterCursor( 'bar(zoo' ):\n assert_that( [ { 'word': 'foo', 'abbr': 'foobar' } ],\n equal_to( base.AdjustCandidateInsertionText( [\n { 'word': 'foobar', 'abbr': '' } ] ) ) )\n\n\n def test_AdjustCandidateInsertionText_PlusInTextAfterCursor( self ):\n with MockTextAfterCursor( 'bar+zoo' ):\n assert_that( [ { 'word': 'foo', 'abbr': 'foobar' } ],\n equal_to( base.AdjustCandidateInsertionText( [\n { 'word': 'foobar', 'abbr': '' } ] ) ) )\n\n\n def test_AdjustCandidateInsertionText_WhitespaceInTextAfterCursor( self ):\n with MockTextAfterCursor( 'bar zoo' ):\n assert_that( [ { 'word': 'foo', 'abbr': 'foobar' } ],\n equal_to( base.AdjustCandidateInsertionText( [\n { 'word': 'foobar', 'abbr': '' } ] ) ) )\n\n\n def test_AdjustCandidateInsertionText_MoreThanWordMatchingAfterCursor( self ):\n with MockTextAfterCursor( 'bar.h' ):\n assert_that( [ { 'word': 'foo', 'abbr': 'foobar.h' } ],\n equal_to( base.AdjustCandidateInsertionText( [\n { 'word': 'foobar.h', 'abbr': '' } ] ) ) )\n\n with MockTextAfterCursor( 'bar(zoo' ):\n assert_that( [ { 'word': 'foo', 'abbr': 'foobar(zoo' } ],\n equal_to( base.AdjustCandidateInsertionText( [\n { 'word': 'foobar(zoo', 'abbr': '' } ] ) ) )\n\n\n def test_AdjustCandidateInsertionText_NotSuffix( self ):\n with MockTextAfterCursor( 'bar' ):\n assert_that( [ { 'word': 'foofoo', 'abbr': 'foofoo' } ],\n equal_to( base.AdjustCandidateInsertionText( [\n { 'word': 'foofoo', 'abbr': '' } ] ) ) )\n\n\n def test_AdjustCandidateInsertionText_NothingAfterCursor( self ):\n with MockTextAfterCursor( '' ):\n assert_that( [ { 'word': 'foofoo', 'abbr': '' },\n { 'word': 'zobar', 'abbr': '' } ],\n equal_to( base.AdjustCandidateInsertionText( [\n { 'word': 'foofoo', 'abbr': '' },\n { 'word': 'zobar', 'abbr': '' } ] ) ) )\n\n\n def test_AdjustCandidateInsertionText_MultipleStrings( self ):\n with MockTextAfterCursor( 'bar' ):\n assert_that( [ { 'word': 'foo', 'abbr': 'foobar' },\n { 'word': 'zo', 'abbr': 'zobar' },\n { 'word': 'q', 'abbr': 'qbar' },\n { 'word': '', 'abbr': 'bar' }, ],\n equal_to( base.AdjustCandidateInsertionText( [\n { 'word': 'foobar', 'abbr': '' },\n { 'word': 'zobar', 'abbr': '' },\n { 'word': 'qbar', 'abbr': '' },\n { 'word': 'bar', 'abbr': '' } ] ) ) )\n\n\n def test_AdjustCandidateInsertionText_DontTouchAbbr( self ):\n with MockTextAfterCursor( 'bar' ):\n assert_that( [ { 'word': 'foo', 'abbr': '1234' } ],\n equal_to( base.AdjustCandidateInsertionText( [\n { 'word': 'foobar', 'abbr': '1234' } ] ) ) )\n\n\n def test_AdjustCandidateInsertionText_NoAbbr( self ):\n with MockTextAfterCursor( 'bar' ):\n assert_that( [ { 'word': 'foo', 'abbr': 'foobar' } ],\n equal_to( base.AdjustCandidateInsertionText( [\n { 'word': 'foobar' } ] ) ) )\n\n\n def test_OverlapLength_Basic( self ):\n assert_that( 3, equal_to( base.OverlapLength( 'foo bar', 'bar zoo' ) ) )\n assert_that( 3, equal_to( base.OverlapLength( 'foobar', 'barzoo' ) ) )\n\n\n def test_OverlapLength_BasicWithUnicode( self ):\n assert_that( 3, equal_to( base.OverlapLength( 'bar fäö', 'fäö bar' ) ) )\n assert_that( 3, equal_to( base.OverlapLength( 'zoofäö', 'fäözoo' ) ) )\n\n\n def test_OverlapLength_OneCharOverlap( self ):\n assert_that( 1, equal_to( base.OverlapLength( 'foo b', 'b zoo' ) ) )\n\n\n def test_OverlapLength_SameStrings( self ):\n assert_that( 6, equal_to( base.OverlapLength( 'foobar', 'foobar' ) ) )\n\n\n def test_OverlapLength_Substring( self ):\n assert_that( 6, equal_to( base.OverlapLength( 'foobar', 'foobarzoo' ) ) )\n assert_that( 6, equal_to( base.OverlapLength( 'zoofoobar', 'foobar' ) ) )\n\n\n def test_OverlapLength_LongestOverlap( self ):\n assert_that( 7, equal_to( base.OverlapLength( 'bar foo foo',\n 'foo foo bar' ) ) )\n\n\n def test_OverlapLength_EmptyInput( self ):\n assert_that( 0, equal_to( base.OverlapLength( '', 'goobar' ) ) )\n assert_that( 0, equal_to( base.OverlapLength( 'foobar', '' ) ) )\n assert_that( 0, equal_to( base.OverlapLength( '', '' ) ) )\n\n\n def test_OverlapLength_NoOverlap( self ):\n assert_that( 0, equal_to( base.OverlapLength( 'foobar', 'goobar' ) ) )\n assert_that( 0, equal_to( base.OverlapLength( 'foobar', '(^($@#$#@' ) ) )\n assert_that( 0, equal_to( base.OverlapLength( 'foo bar zoo',\n 'foo zoo bar' ) ) )\n\n\n def test_LastEnteredCharIsIdentifierChar_Basic( self ):\n with MockCurrentFiletypes():\n with MockCurrentColumnAndLineContents( 3, 'abc' ):\n assert_that( base.LastEnteredCharIsIdentifierChar() )\n\n with MockCurrentColumnAndLineContents( 2, 'abc' ):\n assert_that( base.LastEnteredCharIsIdentifierChar() )\n\n with MockCurrentColumnAndLineContents( 1, 'abc' ):\n assert_that( base.LastEnteredCharIsIdentifierChar() )\n\n\n def test_LastEnteredCharIsIdentifierChar_FiletypeHtml( self ):\n with MockCurrentFiletypes( [ 'html' ] ):\n with MockCurrentColumnAndLineContents( 3, 'ab-' ):\n assert_that( base.LastEnteredCharIsIdentifierChar() )\n\n\n def test_LastEnteredCharIsIdentifierChar_ColumnIsZero( self ):\n with MockCurrentColumnAndLineContents( 0, 'abc' ):\n assert_that( not base.LastEnteredCharIsIdentifierChar() )\n\n\n def test_LastEnteredCharIsIdentifierChar_LineEmpty( self ):\n with MockCurrentFiletypes():\n with MockCurrentColumnAndLineContents( 3, '' ):\n assert_that( not base.LastEnteredCharIsIdentifierChar() )\n\n with MockCurrentColumnAndLineContents( 0, '' ):\n assert_that( not base.LastEnteredCharIsIdentifierChar() )\n\n\n def test_LastEnteredCharIsIdentifierChar_NotIdentChar( self ):\n with MockCurrentFiletypes():\n with MockCurrentColumnAndLineContents( 3, 'ab;' ):\n assert_that( not base.LastEnteredCharIsIdentifierChar() )\n\n with MockCurrentColumnAndLineContents( 1, ';' ):\n assert_that( not base.LastEnteredCharIsIdentifierChar() )\n\n with MockCurrentColumnAndLineContents( 3, 'ab-' ):\n assert_that( not base.LastEnteredCharIsIdentifierChar() )\n\n\n def test_LastEnteredCharIsIdentifierChar_Unicode( self ):\n with MockCurrentFiletypes():\n # CurrentColumn returns a byte offset and character ø is 2 bytes length.\n with MockCurrentColumnAndLineContents( 5, 'føo(' ):\n assert_that( not base.LastEnteredCharIsIdentifierChar() )\n\n with MockCurrentColumnAndLineContents( 4, 'føo(' ):\n assert_that( base.LastEnteredCharIsIdentifierChar() )\n\n with MockCurrentColumnAndLineContents( 3, 'føo(' ):\n assert_that( base.LastEnteredCharIsIdentifierChar() )\n\n with MockCurrentColumnAndLineContents( 1, 'føo(' ):\n assert_that( base.LastEnteredCharIsIdentifierChar() )\n\n\n def test_CurrentIdentifierFinished_Basic( self ):\n with MockCurrentFiletypes():\n with MockCurrentColumnAndLineContents( 3, 'ab;' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 2, 'ab;' ):\n assert_that( not base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 1, 'ab;' ):\n assert_that( not base.CurrentIdentifierFinished() )\n\n\n def test_CurrentIdentifierFinished_NothingBeforeColumn( self ):\n with MockCurrentColumnAndLineContents( 0, 'ab;' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 0, '' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n\n def test_CurrentIdentifierFinished_InvalidColumn( self ):\n with MockCurrentFiletypes():\n with MockCurrentColumnAndLineContents( 5, '' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 5, 'abc' ):\n assert_that( not base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 4, 'ab;' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n\n def test_CurrentIdentifierFinished_InMiddleOfLine( self ):\n with MockCurrentFiletypes():\n with MockCurrentColumnAndLineContents( 4, 'bar.zoo' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 4, 'bar(zoo' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 4, 'bar-zoo' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n\n def test_CurrentIdentifierFinished_Html( self ):\n with MockCurrentFiletypes( [ 'html' ] ):\n with MockCurrentColumnAndLineContents( 4, 'bar-zoo' ):\n assert_that( not base.CurrentIdentifierFinished() )\n\n\n def test_CurrentIdentifierFinished_WhitespaceOnly( self ):\n with MockCurrentFiletypes():\n with MockCurrentColumnAndLineContents( 1, '\\n' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 3, '\\n ' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 3, '\\t\\t\\t\\t' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n\n def test_CurrentIdentifierFinished_Unicode( self ):\n with MockCurrentFiletypes():\n # CurrentColumn returns a byte offset and character ø is 2 bytes length.\n with MockCurrentColumnAndLineContents( 6, 'føo ' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 5, 'føo ' ):\n assert_that( base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 4, 'føo ' ):\n assert_that( not base.CurrentIdentifierFinished() )\n\n with MockCurrentColumnAndLineContents( 3, 'føo ' ):\n assert_that( not base.CurrentIdentifierFinished() )\n" }, { "path": "python/ycm/tests/client/__init__.py", "content": "" }, { "path": "python/ycm/tests/client/base_request_test.py", "content": "# Copyright (C) 2017-2018 YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.tests.test_utils import MockVimBuffers, MockVimModule, VimBuffer\nMockVimModule()\n\nfrom hamcrest import assert_that, has_entry\nfrom unittest import TestCase\nfrom unittest.mock import patch\nfrom ycm.client.base_request import BuildRequestData\n\n\nclass BaseRequestTest( TestCase ):\n @patch( 'ycm.client.base_request.GetCurrentDirectory',\n return_value = '/some/dir' )\n def test_BuildRequestData_AddWorkingDir( self, *args ):\n current_buffer = VimBuffer( 'foo' )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n assert_that( BuildRequestData(), has_entry( 'working_dir', '/some/dir' ) )\n\n\n @patch( 'ycm.client.base_request.GetCurrentDirectory',\n return_value = '/some/dir' )\n def test_BuildRequestData_AddWorkingDirWithFileName( self, *args ):\n current_buffer = VimBuffer( 'foo' )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n assert_that( BuildRequestData( current_buffer.number ),\n has_entry( 'working_dir', '/some/dir' ) )\n" }, { "path": "python/ycm/tests/client/command_request_test.py", "content": "# Copyright (C) 2016 YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.tests.test_utils import ExtendedMock, MockVimModule\nMockVimModule()\n\nimport json\nfrom hamcrest import assert_that\nfrom unittest import TestCase\nfrom unittest.mock import patch, call\nfrom ycm.client.command_request import CommandRequest\n\n\ndef GoToTest( command, response ):\n with patch( 'ycm.vimsupport.JumpToLocation' ) as jump_to_location:\n request = CommandRequest( [ command ] )\n request._response = response\n request.RunPostCommandActionsIfNeeded( 'rightbelow' )\n jump_to_location.assert_called_with(\n response[ 'filepath' ],\n response[ 'line_num' ],\n response[ 'column_num' ],\n 'rightbelow',\n 'same-buffer' )\n\n\ndef GoToListTest( command, response ):\n # Note: the detail of these called are tested by\n # GoToResponse_QuickFix_test, so here we just check that the right call is\n # made\n with patch( 'ycm.vimsupport.SetQuickFixList' ) as set_qf_list:\n with patch( 'ycm.vimsupport.OpenQuickFixList' ) as open_qf_list:\n request = CommandRequest( [ command ] )\n request._response = response\n request.RunPostCommandActionsIfNeeded( 'tab' )\n assert_that( set_qf_list.called )\n assert_that( open_qf_list.called )\n\n\nBASIC_GOTO = {\n 'filepath': 'test',\n 'line_num': 10,\n 'column_num': 100,\n}\n\n\nBASIC_FIXIT = {\n 'fixits': [ {\n 'resolve': False,\n 'chunks': [ {\n 'dummy chunk contents': True\n } ]\n } ]\n}\nBASIC_FIXIT_CHUNKS = BASIC_FIXIT[ 'fixits' ][ 0 ][ 'chunks' ]\n\nMULTI_FIXIT = {\n 'fixits': [ {\n 'text': 'first',\n 'resolve': False,\n 'chunks': [ {\n 'dummy chunk contents': True\n } ]\n }, {\n 'text': 'second',\n 'resolve': False,\n 'chunks': [ {\n 'dummy chunk contents': False\n } ]\n } ]\n}\nMULTI_FIXIT_FIRST_CHUNKS = MULTI_FIXIT[ 'fixits' ][ 0 ][ 'chunks' ]\nMULTI_FIXIT_SECOND_CHUNKS = MULTI_FIXIT[ 'fixits' ][ 1 ][ 'chunks' ]\n\n\nclass GoToResponse_QuickFixTest( TestCase ):\n \"\"\"This class tests the generation of QuickFix lists for GoTo responses which\n return multiple locations, such as the Python completer and JavaScript\n completer. It mostly proves that we use 1-based indexing for the column\n number.\"\"\"\n\n def setUp( self ):\n self._request = CommandRequest( [ 'GoToTest' ] )\n\n\n def tearDown( self ):\n self._request = None\n\n\n def test_GoTo_EmptyList( self ):\n self._CheckGoToList( [], [] )\n\n\n def test_GoTo_SingleItem_List( self ):\n self._CheckGoToList( [ {\n 'filepath': 'dummy_file',\n 'line_num': 10,\n 'column_num': 1,\n 'description': 'this is some text',\n } ], [ {\n 'filename': 'dummy_file',\n 'text': 'this is some text',\n 'lnum': 10,\n 'col': 1\n } ] )\n\n\n def test_GoTo_MultiItem_List( self ):\n self._CheckGoToList( [ {\n 'filepath': 'dummy_file',\n 'line_num': 10,\n 'column_num': 1,\n 'description': 'this is some other text',\n }, {\n 'filepath': 'dummy_file2',\n 'line_num': 1,\n 'column_num': 21,\n 'description': 'this is some text',\n } ], [ {\n 'filename': 'dummy_file',\n 'text': 'this is some other text',\n 'lnum': 10,\n 'col': 1\n }, {\n 'filename': 'dummy_file2',\n 'text': 'this is some text',\n 'lnum': 1,\n 'col': 21\n } ] )\n\n\n @patch( 'ycm.vimsupport.VariableExists', return_value = True )\n @patch( 'ycm.vimsupport.SetFittingHeightForCurrentWindow' )\n @patch( 'vim.command', new_callable = ExtendedMock )\n @patch( 'vim.eval', new_callable = ExtendedMock )\n def _CheckGoToList( self,\n completer_response,\n expected_qf_list,\n vim_eval,\n vim_command,\n set_fitting_height,\n variable_exists ):\n self._request._response = completer_response\n\n self._request.RunPostCommandActionsIfNeeded( 'aboveleft' )\n\n vim_eval.assert_has_exact_calls( [\n call( f'setqflist( { json.dumps( expected_qf_list ) } )' )\n ] )\n vim_command.assert_has_exact_calls( [\n call( 'botright copen' ),\n call( 'augroup ycmquickfix' ),\n call( 'autocmd! * ' ),\n call( 'autocmd WinLeave '\n 'if bufnr( \"%\" ) == expand( \"\" ) | q | endif '\n '| autocmd! ycmquickfix' ),\n call( 'augroup END' ),\n call( 'doautocmd User YcmQuickFixOpened' )\n ] )\n set_fitting_height.assert_called_once_with()\n\n\nclass Response_Detection_Test( TestCase ):\n\n def test_BasicResponse( self ):\n def _BasicResponseTest( command, response ):\n with patch( 'vim.command' ) as vim_command:\n request = CommandRequest( [ command ] )\n request._response = response\n request.RunPostCommandActionsIfNeeded( 'belowright' )\n vim_command.assert_called_with( f\"echo '{ response }'\" )\n\n for command, response in [\n [ 'AnythingYouLike', True ],\n [ 'GoToEvenWorks', 10 ],\n [ 'FixItWorks', 'String!' ],\n [ 'and8434fd andy garbag!', 10.3 ],\n ]:\n with self.subTest( command = command, response = response ):\n _BasicResponseTest( command, response )\n\n def test_FixIt_Response_Empty( self ):\n # Ensures we recognise and handle fixit responses which indicate that there\n # are no fixits available\n def EmptyFixItTest( command ):\n with patch( 'ycm.vimsupport.ReplaceChunks' ) as replace_chunks:\n with patch( 'ycm.vimsupport.PostVimMessage' ) as post_vim_message:\n request = CommandRequest( [ command ] )\n request._response = {\n 'fixits': []\n }\n request.RunPostCommandActionsIfNeeded( 'botright' )\n\n post_vim_message.assert_called_with(\n 'No fixits found for current line', warning = False )\n replace_chunks.assert_not_called()\n\n for command in [ 'FixIt', 'Refactor', 'GoToHell', 'any_old_garbade!!!21' ]:\n with self.subTest( command = command ):\n EmptyFixItTest( command )\n\n\n\n def test_FixIt_Response( self ):\n # Ensures we recognise and handle fixit responses with some dummy chunk data\n def FixItTest( command, response, chunks, selection, silent ):\n with patch( 'ycm.vimsupport.ReplaceChunks' ) as replace_chunks:\n with patch( 'ycm.vimsupport.PostVimMessage' ) as post_vim_message:\n with patch( 'ycm.vimsupport.SelectFromList',\n return_value = selection ):\n request = CommandRequest( [ command ] )\n request._response = response\n request.RunPostCommandActionsIfNeeded( 'leftabove' )\n\n replace_chunks.assert_called_with( chunks, silent = silent )\n post_vim_message.assert_not_called()\n\n\n for command, response, chunks, selection, silent in [\n [ 'AnythingYouLike',\n BASIC_FIXIT, BASIC_FIXIT_CHUNKS, 0, False ],\n [ 'GoToEvenWorks',\n BASIC_FIXIT, BASIC_FIXIT_CHUNKS, 0, False ],\n [ 'FixItWorks',\n BASIC_FIXIT, BASIC_FIXIT_CHUNKS, 0, False ],\n [ 'and8434fd andy garbag!',\n BASIC_FIXIT, BASIC_FIXIT_CHUNKS, 0, False ],\n [ 'Format',\n BASIC_FIXIT, BASIC_FIXIT_CHUNKS, 0, True ],\n [ 'select from multiple 1',\n MULTI_FIXIT, MULTI_FIXIT_FIRST_CHUNKS, 0, False ],\n [ 'select from multiple 2',\n MULTI_FIXIT, MULTI_FIXIT_SECOND_CHUNKS, 1, False ],\n ]:\n with self.subTest( command = command,\n response = response,\n chunks = chunks,\n selection = selection,\n silent = silent ):\n FixItTest( command, response, chunks, selection, silent )\n\n\n def test_Message_Response( self ):\n # Ensures we correctly recognise and handle responses with a message to show\n # to the user\n\n def MessageTest( command, message ):\n with patch( 'ycm.vimsupport.PostVimMessage' ) as post_vim_message:\n request = CommandRequest( [ command ] )\n request._response = { 'message': message }\n request.RunPostCommandActionsIfNeeded( 'rightbelow' )\n post_vim_message.assert_called_with( message, warning = False )\n\n for command, message in [\n [ '___________', 'This is a message' ],\n [ '', 'this is also a message' ],\n [ 'GetType', 'std::string' ],\n ]:\n with self.subTest( command = command, message = message ):\n MessageTest( command, message )\n\n\n def test_Detailed_Info( self ):\n # Ensures we correctly detect and handle detailed_info responses which are\n # used to display information in the preview window\n\n def DetailedInfoTest( command, info ):\n with patch( 'ycm.vimsupport.WriteToPreviewWindow' ) as write_to_preview:\n request = CommandRequest( [ command ] )\n request._response = { 'detailed_info': info }\n request.RunPostCommandActionsIfNeeded( 'topleft' )\n write_to_preview.assert_called_with( info, 'topleft' )\n\n for command, info in [\n [ '___________', 'This is a message' ],\n [ '', 'this is also a message' ],\n [ 'GetDoc', 'std::string\\netc\\netc' ],\n ]:\n with self.subTest( command = command, info = info ):\n DetailedInfoTest( command, info )\n\n\n def test_GoTo_Single( self ):\n for test, command, response in [\n [ GoToTest, 'AnythingYouLike', BASIC_GOTO ],\n [ GoToTest, 'GoTo', BASIC_GOTO ],\n [ GoToTest, 'FindAThing', BASIC_GOTO ],\n [ GoToTest, 'FixItGoto', BASIC_GOTO ],\n [ GoToListTest, 'AnythingYouLike', [ BASIC_GOTO ] ],\n [ GoToListTest, 'GoTo', [] ],\n [ GoToListTest, 'FixItGoto', [ BASIC_GOTO, BASIC_GOTO ] ],\n ]:\n with self.subTest( test = test, command = command, response = response ):\n test( command, response )\n" }, { "path": "python/ycm/tests/client/completion_request_test.py", "content": "# Copyright (C) 2015-2019 YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nimport json\nfrom hamcrest import assert_that, equal_to\nfrom unittest import TestCase\nfrom ycm.tests import UserOptions\nfrom ycm.tests.test_utils import MockVimModule\nvim_mock = MockVimModule()\n\nfrom ycm.client import completion_request\n\n\nclass ConvertCompletionResponseToVimDatasTest( TestCase ):\n \"\"\" This class tests the\n completion_request.ConvertCompletionResponseToVimDatas method \"\"\"\n\n def _Check( self, completion_data, expected_vim_data ):\n vim_data = completion_request.ConvertCompletionDataToVimData(\n completion_data )\n\n try:\n assert_that( vim_data, equal_to( expected_vim_data ) )\n except Exception:\n print( \"Expected:\\n\"\n f\"'{ expected_vim_data }'\\n\"\n \"when parsing:\\n'\"\n f\"{ completion_data }'\\n\"\n \"But found:\\n\"\n f\"'{ vim_data }'\" )\n raise\n\n\n def test_AllFields( self ):\n extra_data = {\n 'doc_string': 'DOC STRING',\n }\n self._Check( {\n 'insertion_text': 'INSERTION TEXT',\n 'menu_text': 'MENU TEXT',\n 'extra_menu_info': 'EXTRA MENU INFO',\n 'kind': 'K',\n 'detailed_info': 'DETAILED INFO',\n 'extra_data': extra_data,\n }, {\n 'word' : 'INSERTION TEXT',\n 'abbr' : 'MENU TEXT',\n 'menu' : 'EXTRA MENU INFO',\n 'kind' : 'k',\n 'info' : 'DETAILED INFO\\nDOC STRING',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': json.dumps( extra_data ),\n } )\n\n\n def test_OnlyInsertionTextField( self ):\n self._Check( {\n 'insertion_text': 'INSERTION TEXT'\n }, {\n 'word' : 'INSERTION TEXT',\n 'abbr' : '',\n 'menu' : '',\n 'kind' : '',\n 'info' : '',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': '{}',\n } )\n\n\n def test_JustDetailedInfo( self ):\n self._Check( {\n 'insertion_text': 'INSERTION TEXT',\n 'menu_text': 'MENU TEXT',\n 'extra_menu_info': 'EXTRA MENU INFO',\n 'kind': 'K',\n 'detailed_info': 'DETAILED INFO',\n }, {\n 'word' : 'INSERTION TEXT',\n 'abbr' : 'MENU TEXT',\n 'menu' : 'EXTRA MENU INFO',\n 'kind' : 'k',\n 'info' : 'DETAILED INFO',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': '{}',\n } )\n\n\n def test_JustDocString( self ):\n extra_data = {\n 'doc_string': 'DOC STRING',\n }\n self._Check( {\n 'insertion_text': 'INSERTION TEXT',\n 'menu_text': 'MENU TEXT',\n 'extra_menu_info': 'EXTRA MENU INFO',\n 'kind': 'K',\n 'extra_data': extra_data,\n }, {\n 'word' : 'INSERTION TEXT',\n 'abbr' : 'MENU TEXT',\n 'menu' : 'EXTRA MENU INFO',\n 'kind' : 'k',\n 'info' : 'DOC STRING',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': json.dumps( extra_data ),\n } )\n\n\n def test_ExtraInfoNoDocString( self ):\n self._Check( {\n 'insertion_text': 'INSERTION TEXT',\n 'menu_text': 'MENU TEXT',\n 'extra_menu_info': 'EXTRA MENU INFO',\n 'kind': 'K',\n 'extra_data': {\n },\n }, {\n 'word' : 'INSERTION TEXT',\n 'abbr' : 'MENU TEXT',\n 'menu' : 'EXTRA MENU INFO',\n 'kind' : 'k',\n 'info' : '',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': '{}',\n } )\n\n\n def test_NullCharactersInExtraInfoAndDocString( self ):\n extra_data = {\n 'doc_string': 'DOC\\x00STRING'\n }\n self._Check( {\n 'insertion_text': 'INSERTION TEXT',\n 'menu_text': 'MENU TEXT',\n 'extra_menu_info': 'EXTRA MENU INFO',\n 'kind': 'K',\n 'detailed_info': 'DETAILED\\x00INFO',\n 'extra_data': extra_data,\n }, {\n 'word' : 'INSERTION TEXT',\n 'abbr' : 'MENU TEXT',\n 'menu' : 'EXTRA MENU INFO',\n 'kind' : 'k',\n 'info' : 'DETAILEDINFO\\nDOCSTRING',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': json.dumps( extra_data ),\n } )\n\n\n def test_ExtraInfoNoDocStringWithDetailedInfo( self ):\n self._Check( {\n 'insertion_text': 'INSERTION TEXT',\n 'menu_text': 'MENU TEXT',\n 'extra_menu_info': 'EXTRA MENU INFO',\n 'kind': 'K',\n 'detailed_info': 'DETAILED INFO',\n 'extra_data': {\n },\n }, {\n 'word' : 'INSERTION TEXT',\n 'abbr' : 'MENU TEXT',\n 'menu' : 'EXTRA MENU INFO',\n 'kind' : 'k',\n 'info' : 'DETAILED INFO',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': '{}',\n } )\n\n\n def test_EmptyInsertionText( self ):\n extra_data = {\n 'doc_string': 'DOC STRING',\n }\n self._Check( {\n 'insertion_text': '',\n 'menu_text': 'MENU TEXT',\n 'extra_menu_info': 'EXTRA MENU INFO',\n 'kind': 'K',\n 'detailed_info': 'DETAILED INFO',\n 'extra_data': extra_data,\n }, {\n 'word' : '',\n 'abbr' : 'MENU TEXT',\n 'menu' : 'EXTRA MENU INFO',\n 'kind' : 'k',\n 'info' : 'DETAILED INFO\\nDOC STRING',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': json.dumps( extra_data ),\n } )\n\n\n def test_TruncateForPopup( self, *args ):\n with UserOptions( { '&columns': 60, '&completeopt': b'popup,menuone' } ):\n extra_data = {\n 'doc_string': 'DOC STRING',\n }\n self._Check( {\n 'insertion_text': '',\n 'menu_text': 'MENU TEXT',\n 'extra_menu_info': 'ESPECIALLY LONG EXTRA MENU INFO LOREM IPSUM DOLOR',\n 'kind': 'K',\n 'detailed_info': 'DETAILED INFO',\n 'extra_data': extra_data,\n }, {\n 'word' : '',\n 'abbr' : 'MENU TEXT',\n 'menu' : 'ESPECIALLY LONG E...',\n 'kind' : 'k',\n 'info' : 'ESPECIALLY LONG EXTRA MENU INFO LOREM IPSUM DOLOR\\n\\n' +\n 'DETAILED INFO\\nDOC STRING',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': json.dumps( extra_data ),\n } )\n\n\n def test_OnlyTruncateForPopupIfNecessary( self, *args ):\n with UserOptions( { '&columns': 60, '&completeopt': b'popup,menuone' } ):\n extra_data = {\n 'doc_string': 'DOC STRING',\n }\n self._Check( {\n 'insertion_text': '',\n 'menu_text': 'MENU TEXT',\n 'extra_menu_info': 'EXTRA MENU INFO',\n 'kind': 'K',\n 'detailed_info': 'DETAILED INFO',\n 'extra_data': extra_data,\n }, {\n 'word' : '',\n 'abbr' : 'MENU TEXT',\n 'menu' : 'EXTRA MENU INFO',\n 'kind' : 'k',\n 'info' : 'DETAILED INFO\\nDOC STRING',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': json.dumps( extra_data ),\n } )\n\n\n def test_DontTruncateIfNotPopup( self, *args ):\n with UserOptions( { '&columns': 60, '&completeopt': b'preview,menuone' } ):\n extra_data = {\n 'doc_string': 'DOC STRING',\n }\n self._Check( {\n 'insertion_text': '',\n 'menu_text': 'MENU TEXT',\n 'extra_menu_info': 'ESPECIALLY LONG EXTRA MENU INFO LOREM IPSUM DOLOR',\n 'kind': 'K',\n 'detailed_info': 'DETAILED INFO',\n 'extra_data': extra_data,\n }, {\n 'word' : '',\n 'abbr' : 'MENU TEXT',\n 'menu' : 'ESPECIALLY LONG EXTRA MENU INFO LOREM IPSUM DOLOR',\n 'kind' : 'k',\n 'info' : 'DETAILED INFO\\nDOC STRING',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': json.dumps( extra_data ),\n } )\n\n\n def test_TruncateForPopupWithoutDuplication( self, *args ):\n with UserOptions( { '&columns': 60, '&completeopt': b'popup,menuone' } ):\n extra_data = {\n 'doc_string': 'DOC STRING',\n }\n self._Check( {\n 'insertion_text': '',\n 'menu_text': 'MENU TEXT',\n 'extra_menu_info': 'ESPECIALLY LONG METHOD SIGNATURE LOREM IPSUM',\n 'kind': 'K',\n 'detailed_info': 'ESPECIALLY LONG METHOD SIGNATURE LOREM IPSUM',\n 'extra_data': extra_data,\n }, {\n 'word' : '',\n 'abbr' : 'MENU TEXT',\n 'menu' : 'ESPECIALLY LONG M...',\n 'kind' : 'k',\n 'info' : 'ESPECIALLY LONG METHOD SIGNATURE LOREM IPSUM\\n' +\n 'DOC STRING',\n 'equal' : 1,\n 'dup' : 1,\n 'empty' : 1,\n 'user_data': json.dumps( extra_data ),\n } )\n" }, { "path": "python/ycm/tests/client/debug_info_request_test.py", "content": "# Copyright (C) 2017 YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom copy import deepcopy\nfrom hamcrest import assert_that, contains_string, equal_to\nfrom unittest import TestCase\n\nfrom ycm.client.debug_info_request import FormatDebugInfoResponse\n\n\nGENERIC_RESPONSE = {\n 'clang': {\n 'has_support': True,\n 'version': 'Clang version'\n },\n 'completer': {\n 'items': [\n {\n 'key': 'key',\n 'value': 'value'\n }\n ],\n 'name': 'Completer name',\n 'servers': [\n {\n 'address': '127.0.0.1',\n 'executable': '/path/to/executable',\n 'extras': [\n {\n 'key': 'key',\n 'value': 'value'\n }\n ],\n 'is_running': True,\n 'logfiles': [\n '/path/to/stdout/logfile',\n '/path/to/stderr/logfile'\n ],\n 'name': 'Server name',\n 'pid': 12345,\n 'port': 1234\n }\n ]\n },\n 'extra_conf': {\n 'is_loaded': False,\n 'path': '/path/to/extra/conf'\n },\n 'python': {\n 'executable': '/path/to/python/interpreter',\n 'version': 'Python version'\n }\n}\n\n\nclass DebugInfoRequestTest( TestCase ):\n def test_FormatDebugInfoResponse_NoResponse( self ):\n assert_that(\n FormatDebugInfoResponse( None ),\n equal_to( 'Server errored, no debug info from server\\n' )\n )\n\n\n def test_FormatDebugInfoResponse_NoExtraConf( self ):\n response = deepcopy( GENERIC_RESPONSE )\n response[ 'extra_conf' ].update( {\n 'is_loaded': False,\n 'path': None\n } )\n assert_that(\n FormatDebugInfoResponse( response ),\n contains_string(\n 'No extra configuration file found\\n'\n )\n )\n\n\n def test_FormatDebugInfoResponse_ExtraConfFoundButNotLoaded( self ):\n response = deepcopy( GENERIC_RESPONSE )\n response[ 'extra_conf' ].update( {\n 'is_loaded': False,\n 'path': '/path/to/extra/conf'\n } )\n assert_that(\n FormatDebugInfoResponse( response ),\n contains_string(\n 'Extra configuration file found but not loaded\\n'\n 'Extra configuration path: /path/to/extra/conf\\n'\n )\n )\n\n\n def test_FormatDebugInfoResponse_ExtraConfFoundAndLoaded( self ):\n response = deepcopy( GENERIC_RESPONSE )\n response[ 'extra_conf' ].update( {\n 'is_loaded': True,\n 'path': '/path/to/extra/conf'\n } )\n assert_that(\n FormatDebugInfoResponse( response ),\n contains_string(\n 'Extra configuration file found and loaded\\n'\n 'Extra configuration path: /path/to/extra/conf\\n'\n )\n )\n\n\n def test_FormatDebugInfoResponse_Completer_ServerRunningWithHost( self ):\n response = deepcopy( GENERIC_RESPONSE )\n assert_that(\n FormatDebugInfoResponse( response ),\n contains_string(\n 'Completer name completer debug information:\\n'\n ' Server name running at: http://127.0.0.1:1234\\n'\n ' Server name process ID: 12345\\n'\n ' Server name executable: /path/to/executable\\n'\n ' Server name logfiles:\\n'\n ' /path/to/stdout/logfile\\n'\n ' /path/to/stderr/logfile\\n'\n ' Server name key: value\\n'\n ' Key: value\\n'\n )\n )\n\n\n def test_FormatDebugInfoResponse_Completer_ServerRunningWithoutHost( self ):\n response = deepcopy( GENERIC_RESPONSE )\n response[ 'completer' ][ 'servers' ][ 0 ].update( {\n 'address': None,\n 'port': None\n } )\n assert_that(\n FormatDebugInfoResponse( response ),\n contains_string(\n 'Completer name completer debug information:\\n'\n ' Server name running\\n'\n ' Server name process ID: 12345\\n'\n ' Server name executable: /path/to/executable\\n'\n ' Server name logfiles:\\n'\n ' /path/to/stdout/logfile\\n'\n ' /path/to/stderr/logfile\\n'\n ' Server name key: value\\n'\n ' Key: value\\n'\n )\n )\n\n\n def test_FormatDebugInfoResponse_Completer_ServerNotRunningWithNoLogfiles(\n self ):\n response = deepcopy( GENERIC_RESPONSE )\n response[ 'completer' ][ 'servers' ][ 0 ].update( {\n 'is_running': False,\n 'logfiles': []\n } )\n assert_that(\n FormatDebugInfoResponse( response ),\n contains_string(\n 'Completer name completer debug information:\\n'\n ' Server name not running\\n'\n ' Server name executable: /path/to/executable\\n'\n ' No logfiles available\\n'\n ' Server name key: value\\n'\n ' Key: value\\n'\n )\n )\n" }, { "path": "python/ycm/tests/client/messages_request_test.py", "content": "# Copyright (C) 2017 YouCompleteMe Contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.tests.test_utils import MockVimModule\nMockVimModule()\n\nfrom hamcrest import assert_that, equal_to\nfrom unittest import TestCase\nfrom unittest.mock import patch, call\n\nfrom ycm.client.messages_request import _HandlePollResponse\nfrom ycm.tests.test_utils import ExtendedMock\n\n\nclass MessagesRequestTest( TestCase ):\n def test_HandlePollResponse_NoMessages( self ):\n assert_that( _HandlePollResponse( True, None ), equal_to( True ) )\n\n # Other non-False responses mean the same thing\n assert_that( _HandlePollResponse( '', None ), equal_to( True ) )\n assert_that( _HandlePollResponse( 1, None ), equal_to( True ) )\n assert_that( _HandlePollResponse( {}, None ), equal_to( True ) )\n\n\n def test_HandlePollResponse_PollingNotSupported( self ):\n assert_that( _HandlePollResponse( False, None ), equal_to( False ) )\n\n # 0 is not False\n assert_that( _HandlePollResponse( 0, None ), equal_to( True ) )\n\n\n @patch( 'ycm.client.messages_request.PostVimMessage',\n new_callable = ExtendedMock )\n def test_HandlePollResponse_SingleMessage( self, post_vim_message ):\n assert_that( _HandlePollResponse( [ { 'message': 'this is a message' } ] ,\n None ),\n equal_to( True ) )\n\n post_vim_message.assert_has_exact_calls( [\n call( 'this is a message', warning=False, truncate=True )\n ] )\n\n\n @patch( 'ycm.client.messages_request.PostVimMessage',\n new_callable = ExtendedMock )\n def test_HandlePollResponse_MultipleMessages( self, post_vim_message ):\n assert_that( _HandlePollResponse( [ { 'message': 'this is a message' },\n { 'message': 'this is another one' } ] ,\n None ),\n equal_to( True ) )\n\n post_vim_message.assert_has_exact_calls( [\n call( 'this is a message', warning=False, truncate=True ),\n call( 'this is another one', warning=False, truncate=True )\n ] )\n\n\n def test_HandlePollResponse_SingleDiagnostic( self ):\n diagnostics_handler = ExtendedMock()\n messages = [\n { 'filepath': 'foo', 'diagnostics': [ 'PLACEHOLDER' ] },\n ]\n assert_that( _HandlePollResponse( messages, diagnostics_handler ),\n equal_to( True ) )\n diagnostics_handler.UpdateWithNewDiagnosticsForFile.assert_has_exact_calls(\n [\n call( 'foo', [ 'PLACEHOLDER' ] )\n ] )\n\n\n def test_HandlePollResponse_MultipleDiagnostics( self ):\n diagnostics_handler = ExtendedMock()\n messages = [\n { 'filepath': 'foo', 'diagnostics': [ 'PLACEHOLDER1' ] },\n { 'filepath': 'bar', 'diagnostics': [ 'PLACEHOLDER2' ] },\n { 'filepath': 'baz', 'diagnostics': [ 'PLACEHOLDER3' ] },\n { 'filepath': 'foo', 'diagnostics': [ 'PLACEHOLDER4' ] },\n ]\n assert_that( _HandlePollResponse( messages, diagnostics_handler ),\n equal_to( True ) )\n diagnostics_handler.UpdateWithNewDiagnosticsForFile.assert_has_exact_calls(\n [\n call( 'foo', [ 'PLACEHOLDER1' ] ),\n call( 'bar', [ 'PLACEHOLDER2' ] ),\n call( 'baz', [ 'PLACEHOLDER3' ] ),\n call( 'foo', [ 'PLACEHOLDER4' ] )\n ] )\n\n\n @patch( 'ycm.client.messages_request.PostVimMessage',\n new_callable = ExtendedMock )\n def test_HandlePollResponse_MultipleMessagesAndDiagnostics(\n self, post_vim_message ):\n diagnostics_handler = ExtendedMock()\n messages = [\n { 'filepath': 'foo', 'diagnostics': [ 'PLACEHOLDER1' ] },\n { 'message': 'On the first day of Christmas, my VimScript gave to me' },\n { 'filepath': 'bar', 'diagnostics': [ 'PLACEHOLDER2' ] },\n { 'message': 'A test file in a Command-T' },\n { 'filepath': 'baz', 'diagnostics': [ 'PLACEHOLDER3' ] },\n { 'message': 'On the second day of Christmas, my VimScript gave to me' },\n { 'filepath': 'foo', 'diagnostics': [ 'PLACEHOLDER4' ] },\n { 'message': 'Two popup menus, and a test file in a Command-T' },\n ]\n assert_that( _HandlePollResponse( messages, diagnostics_handler ),\n equal_to( True ) )\n diagnostics_handler.UpdateWithNewDiagnosticsForFile.assert_has_exact_calls(\n [\n call( 'foo', [ 'PLACEHOLDER1' ] ),\n call( 'bar', [ 'PLACEHOLDER2' ] ),\n call( 'baz', [ 'PLACEHOLDER3' ] ),\n call( 'foo', [ 'PLACEHOLDER4' ] )\n ] )\n\n post_vim_message.assert_has_exact_calls( [\n call( 'On the first day of Christmas, my VimScript gave to me',\n warning=False,\n truncate=True ),\n call( 'A test file in a Command-T', warning=False, truncate=True ),\n call( 'On the second day of Christmas, my VimScript gave to me',\n warning=False,\n truncate=True ),\n call( 'Two popup menus, and a test file in a Command-T',\n warning=False,\n truncate=True ),\n ] )\n" }, { "path": "python/ycm/tests/client/omni_completion_request_test.py", "content": "# Copyright (C) 2020 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom unittest import TestCase\nfrom unittest.mock import MagicMock\nfrom hamcrest import assert_that, has_entries\n\nfrom ycm.client.omni_completion_request import OmniCompletionRequest\n\n\ndef BuildOmnicompletionRequest( results, start_column = 1 ):\n omni_completer = MagicMock()\n omni_completer.ComputeCandidates = MagicMock( return_value = results )\n\n request_data = {\n 'line_num': 1,\n 'column_num': 1,\n 'start_column': start_column\n }\n request = OmniCompletionRequest( omni_completer, request_data )\n request.Start()\n\n return request\n\n\nclass OmniCompletionRequestTest( TestCase ):\n def test_Done_AlwaysTrue( self ):\n request = BuildOmnicompletionRequest( [] )\n\n assert_that( request.Done() )\n\n\n def test_Response_FromOmniCompleter( self ):\n results = [ { \"word\": \"test\" } ]\n request = BuildOmnicompletionRequest( results )\n\n assert_that( request.Response(), has_entries( {\n 'line': 1,\n 'column': 1,\n 'completion_start_column': 1,\n 'completions': results\n } ) )\n" }, { "path": "python/ycm/tests/command_test.py", "content": "# Copyright (C) 2016-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.tests.test_utils import MockVimModule, MockVimBuffers, VimBuffer\nMockVimModule()\n\nfrom hamcrest import assert_that, contains_exactly, has_entries\nfrom unittest.mock import patch\nfrom unittest import TestCase\n\nfrom ycm.tests import YouCompleteMeInstance\n\n\nclass CommandTest( TestCase ):\n @YouCompleteMeInstance( { 'g:ycm_extra_conf_vim_data': [ 'tempname()' ] } )\n def test_SendCommandRequest_ExtraConfVimData_Works( self, ycm ):\n current_buffer = VimBuffer( 'buffer' )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n with patch( 'ycm.youcompleteme.SendCommandRequest' ) as send_request:\n ycm.SendCommandRequest( [ 'GoTo' ], 'aboveleft', False, 1, 1 )\n assert_that(\n # Positional arguments passed to SendCommandRequest.\n send_request.call_args[ 0 ],\n contains_exactly(\n contains_exactly( 'GoTo' ),\n 'aboveleft',\n 'same-buffer',\n has_entries( {\n 'options': has_entries( {\n 'tab_size': 2,\n 'insert_spaces': True,\n } ),\n 'extra_conf_data': has_entries( {\n 'tempname()': '_TEMP_FILE_'\n } ),\n } ),\n )\n )\n\n\n @YouCompleteMeInstance( {\n 'g:ycm_extra_conf_vim_data': [ 'undefined_value' ] } )\n def test_SendCommandRequest_ExtraConfData_UndefinedValue( self, ycm ):\n current_buffer = VimBuffer( 'buffer' )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n with patch( 'ycm.youcompleteme.SendCommandRequest' ) as send_request:\n ycm.SendCommandRequest( [ 'GoTo' ], 'belowright', False, 1, 1 )\n assert_that(\n # Positional arguments passed to SendCommandRequest.\n send_request.call_args[ 0 ],\n contains_exactly(\n contains_exactly( 'GoTo' ),\n 'belowright',\n 'same-buffer',\n has_entries( {\n 'options': has_entries( {\n 'tab_size': 2,\n 'insert_spaces': True,\n } )\n } ),\n )\n )\n\n\n @YouCompleteMeInstance()\n def test_SendCommandRequest_BuildRange_NoVisualMarks( self, ycm, *args ):\n current_buffer = VimBuffer( 'buffer', contents = [ 'first line',\n 'second line' ] )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n with patch( 'ycm.youcompleteme.SendCommandRequest' ) as send_request:\n ycm.SendCommandRequest( [ 'GoTo' ], '', True, 1, 2 )\n send_request.assert_called_once_with(\n [ 'GoTo' ],\n '',\n 'same-buffer',\n {\n 'options': {\n 'tab_size': 2,\n 'insert_spaces': True\n },\n 'range': {\n 'start': {\n 'line_num': 1,\n 'column_num': 1\n },\n 'end': {\n 'line_num': 2,\n 'column_num': 12\n }\n }\n },\n )\n\n\n @YouCompleteMeInstance()\n def test_SendCommandRequest_BuildRange_VisualMarks( self, ycm, *args ):\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'first line',\n 'second line' ],\n visual_start = [ 1, 4 ],\n visual_end = [ 2, 8 ] )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n with patch( 'ycm.youcompleteme.SendCommandRequest' ) as send_request:\n ycm.SendCommandRequest( [ 'GoTo' ], 'tab', True, 1, 2 )\n send_request.assert_called_once_with(\n [ 'GoTo' ],\n 'tab',\n 'same-buffer',\n {\n 'options': {\n 'tab_size': 2,\n 'insert_spaces': True\n },\n 'range': {\n 'start': {\n 'line_num': 1,\n 'column_num': 5\n },\n 'end': {\n 'line_num': 2,\n 'column_num': 9\n }\n }\n },\n )\n\n\n @YouCompleteMeInstance()\n def test_SendCommandRequest_IgnoreFileTypeOption( self, ycm, *args ):\n current_buffer = VimBuffer( 'buffer' )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n expected_args = (\n [ 'GoTo' ],\n '',\n 'same-buffer',\n {\n 'completer_target': 'python',\n 'options': {\n 'tab_size': 2,\n 'insert_spaces': True\n },\n },\n )\n\n with patch( 'ycm.youcompleteme.SendCommandRequest' ) as send_request:\n ycm.SendCommandRequest( [ 'ft=python', 'GoTo' ], '', False, 1, 1 )\n send_request.assert_called_once_with( *expected_args )\n\n with patch( 'ycm.youcompleteme.SendCommandRequest' ) as send_request:\n ycm.SendCommandRequest( [ 'GoTo', 'ft=python' ], '', False, 1, 1 )\n send_request.assert_called_once_with( *expected_args )\n" }, { "path": "python/ycm/tests/completion_test.py", "content": "# Copyright (C) 2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.tests.test_utils import ( CurrentWorkingDirectory, ExtendedMock,\n MockVimModule, MockVimBuffers, VimBuffer )\nMockVimModule()\n\nimport contextlib\nfrom hamcrest import ( assert_that,\n contains_exactly,\n empty,\n equal_to,\n has_entries )\nfrom unittest import TestCase\nfrom unittest.mock import call, MagicMock, patch\n\nfrom ycm.tests import PathToTestFile, YouCompleteMeInstance\nfrom ycmd.responses import ServerError\n\nimport json\n\n\n@contextlib.contextmanager\ndef MockCompletionRequest( response_method ):\n \"\"\"Mock out the CompletionRequest, replacing the response handler\n JsonFromFuture with the |response_method| parameter.\"\"\"\n\n # We don't want the requests to actually be sent to the server, just have it\n # return success.\n with patch( 'ycm.client.completer_available_request.'\n 'CompleterAvailableRequest.PostDataToHandler',\n return_value = True ):\n with patch( 'ycm.client.completion_request.CompletionRequest.'\n 'PostDataToHandlerAsync',\n return_value = MagicMock( return_value=True ) ):\n\n # We set up a fake response.\n with patch( 'ycm.client.base_request._JsonFromFuture',\n side_effect = response_method ):\n yield\n\n\n@contextlib.contextmanager\ndef MockResolveRequest( response_method ):\n \"\"\"Mock out the CompletionRequest, replacing the response handler\n JsonFromFuture with the |response_method| parameter.\"\"\"\n\n with patch( 'ycm.client.resolve_completion_request.ResolveCompletionRequest.'\n 'PostDataToHandlerAsync',\n return_value = MagicMock( return_value=True ) ):\n\n # We set up a fake response.\n with patch( 'ycm.client.base_request._JsonFromFuture',\n side_effect = response_method ):\n yield\n\n\nclass CompletionTest( TestCase ):\n @YouCompleteMeInstance()\n def test_SendCompletionRequest_UnicodeWorkingDirectory( self, ycm ):\n unicode_dir = PathToTestFile( 'uni¢od€' )\n current_buffer = VimBuffer( PathToTestFile( 'uni¢𐍈d€', 'current_buffer' ) )\n\n def ServerResponse( *args ):\n return { 'completions': [], 'completion_start_column': 1 }\n\n with CurrentWorkingDirectory( unicode_dir ):\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n with MockCompletionRequest( ServerResponse ):\n ycm.SendCompletionRequest()\n assert_that( ycm.CompletionRequestReady() )\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': empty(),\n 'completion_start_column': 1\n } )\n )\n\n\n @YouCompleteMeInstance()\n @patch( 'ycm.vimsupport.PostVimMessage', new_callable = ExtendedMock )\n def test_SendCompletionRequest_ResponseContainingError(\n self, ycm, post_vim_message ):\n current_buffer = VimBuffer( 'buffer' )\n\n def ServerResponse( *args ):\n return {\n 'completions': [ {\n 'insertion_text': 'insertion_text',\n 'menu_text': 'menu_text',\n 'extra_menu_info': 'extra_menu_info',\n 'detailed_info': 'detailed_info',\n 'kind': 'kind',\n 'extra_data': {\n 'doc_string': 'doc_string'\n }\n } ],\n 'completion_start_column': 3,\n 'errors': [ {\n 'exception': {\n 'TYPE': 'Exception'\n },\n 'message': 'message',\n 'traceback': 'traceback'\n } ]\n }\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n with MockCompletionRequest( ServerResponse ):\n ycm.SendCompletionRequest()\n assert_that( ycm.CompletionRequestReady() )\n response = ycm.GetCompletionResponse()\n post_vim_message.assert_has_exact_calls( [\n call( 'Exception: message', truncate = True )\n ] )\n assert_that(\n response,\n has_entries( {\n 'completions': contains_exactly( has_entries( {\n 'word': 'insertion_text',\n 'abbr': 'menu_text',\n 'menu': 'extra_menu_info',\n 'info': 'detailed_info\\ndoc_string',\n 'kind': 'k',\n 'dup': 1,\n 'empty': 1\n } ) ),\n 'completion_start_column': 3\n } )\n )\n\n\n @YouCompleteMeInstance()\n @patch( 'ycm.client.base_request._logger', autospec = True )\n @patch( 'ycm.vimsupport.PostVimMessage', new_callable = ExtendedMock )\n def test_SendCompletionRequest_ErrorFromServer( self,\n ycm,\n post_vim_message,\n logger ):\n current_buffer = VimBuffer( 'buffer' )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n with MockCompletionRequest( ServerError( 'Server error' ) ):\n ycm.SendCompletionRequest()\n assert_that( ycm.CompletionRequestReady() )\n response = ycm.GetCompletionResponse()\n logger.exception.assert_called_with( 'Error while handling server '\n 'response' )\n post_vim_message.assert_has_exact_calls( [\n call( 'Server error', truncate = True )\n ] )\n assert_that(\n response,\n has_entries( {\n 'completions': empty(),\n 'completion_start_column': -1\n } )\n )\n\n\n\n @YouCompleteMeInstance()\n @patch( 'ycm.client.base_request._logger', autospec = True )\n @patch( 'ycm.vimsupport.PostVimMessage', new_callable = ExtendedMock )\n def test_ResolveCompletionRequest_Resolves( self,\n ycm,\n post_vim_message,\n logger ):\n\n def CompletionResponse( *args ):\n return {\n 'completions': [ {\n 'insertion_text': 'insertion_text',\n 'menu_text': 'menu_text',\n 'extra_menu_info': 'extra_menu_info',\n 'detailed_info': 'detailed_info',\n 'kind': 'kind',\n 'extra_data': {\n 'doc_string': 'doc_string',\n 'resolve': 10\n }\n } ],\n 'completion_start_column': 3,\n 'errors': []\n }\n\n def ResolveResponse( *args ):\n return {\n 'completion': {\n 'insertion_text': 'insertion_text',\n 'menu_text': 'menu_text',\n 'extra_menu_info': 'extra_menu_info',\n 'detailed_info': 'detailed_info',\n 'kind': 'kind',\n 'extra_data': {\n 'doc_string': 'doc_string with more info'\n }\n },\n 'errors': []\n }\n\n current_buffer = VimBuffer( 'buffer' )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n with MockCompletionRequest( CompletionResponse ):\n ycm.SendCompletionRequest()\n assert_that( ycm.CompletionRequestReady() )\n response = ycm.GetCompletionResponse()\n\n post_vim_message.assert_not_called()\n assert_that(\n response,\n has_entries( {\n 'completions': contains_exactly( has_entries( {\n 'word': 'insertion_text',\n 'abbr': 'menu_text',\n 'menu': 'extra_menu_info',\n 'info': 'detailed_info\\ndoc_string',\n 'kind': 'k',\n 'dup': 1,\n 'empty': 1\n } ) ),\n 'completion_start_column': 3\n } )\n )\n\n item = response[ 'completions' ][ 0 ]\n assert_that( json.loads( item[ 'user_data' ] ),\n has_entries( { 'resolve': 10 } ) )\n\n with MockResolveRequest( ResolveResponse ):\n assert_that( ycm.ResolveCompletionItem( item ), equal_to( True ) )\n assert_that( ycm.CompletionRequestReady() )\n response = ycm.GetCompletionResponse()\n post_vim_message.assert_not_called()\n\n assert_that(\n response,\n has_entries( {\n 'completion': has_entries( {\n 'word': 'insertion_text',\n 'abbr': 'menu_text',\n 'menu': 'extra_menu_info',\n 'info': 'detailed_info\\ndoc_string with more info',\n 'kind': 'k',\n 'dup': 1,\n 'empty': 1\n } )\n } )\n )\n\n item = response[ 'completion' ]\n\n with MockResolveRequest( ServerError( 'must not be called' ) ):\n assert_that( ycm.ResolveCompletionItem( item ), equal_to( False ) )\n post_vim_message.assert_not_called()\n\n\n @YouCompleteMeInstance()\n @patch( 'ycm.client.base_request._logger', autospec = True )\n @patch( 'ycm.vimsupport.PostVimMessage', new_callable = ExtendedMock )\n def test_ResolveCompletionRequest_ResponseContainsErrors( self,\n ycm,\n post_vim_message,\n logger ):\n\n def CompletionResponse( *args ):\n return {\n 'completions': [ {\n 'insertion_text': 'insertion_text',\n 'menu_text': 'menu_text',\n 'extra_menu_info': 'extra_menu_info',\n 'detailed_info': 'detailed_info',\n 'kind': 'kind',\n 'extra_data': {\n 'doc_string': 'doc_string',\n 'resolve': 10\n }\n } ],\n 'completion_start_column': 3,\n 'errors': []\n }\n\n def ResolveResponse( *args ):\n return {\n 'completion': {\n 'insertion_text': 'insertion_text',\n 'menu_text': 'menu_text',\n 'extra_menu_info': 'extra_menu_info',\n 'detailed_info': 'detailed_info',\n 'kind': 'kind',\n 'extra_data': {\n 'doc_string': 'doc_string with more info'\n }\n },\n 'errors': [ {\n 'exception': {\n 'TYPE': 'Exception'\n },\n 'message': 'message',\n 'traceback': 'traceback'\n } ]\n }\n\n current_buffer = VimBuffer( 'buffer' )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n with MockCompletionRequest( CompletionResponse ):\n ycm.SendCompletionRequest()\n assert_that( ycm.CompletionRequestReady() )\n response = ycm.GetCompletionResponse()\n\n post_vim_message.assert_not_called()\n assert_that(\n response,\n has_entries( {\n 'completions': contains_exactly( has_entries( {\n 'word': 'insertion_text',\n 'abbr': 'menu_text',\n 'menu': 'extra_menu_info',\n 'info': 'detailed_info\\ndoc_string',\n 'kind': 'k',\n 'dup': 1,\n 'empty': 1\n } ) ),\n 'completion_start_column': 3\n } )\n )\n\n item = response[ 'completions' ][ 0 ]\n assert_that( json.loads( item[ 'user_data' ] ),\n has_entries( { 'resolve': 10 } ) )\n\n with MockResolveRequest( ResolveResponse ):\n assert_that( ycm.ResolveCompletionItem( item ), equal_to( True ) )\n assert_that( ycm.CompletionRequestReady() )\n response = ycm.GetCompletionResponse()\n\n post_vim_message.assert_has_exact_calls( [\n call( 'Exception: message', truncate = True )\n ] )\n assert_that(\n response,\n has_entries( {\n 'completion': has_entries( {\n 'word': 'insertion_text',\n 'abbr': 'menu_text',\n 'menu': 'extra_menu_info',\n 'info': 'detailed_info\\ndoc_string with more info',\n 'kind': 'k',\n 'dup': 1,\n 'empty': 1\n } )\n } )\n )\n\n\n @YouCompleteMeInstance()\n @patch( 'ycm.vimsupport.PostVimMessage', new_callable = ExtendedMock )\n def test_ResolveCompletionItem_NoUserData( self, ycm, post_vim_message ):\n def CompletionResponse( *args ):\n return {\n 'completions': [ {\n 'insertion_text': 'insertion_text',\n 'menu_text': 'menu_text',\n 'extra_menu_info': 'extra_menu_info',\n 'detailed_info': 'detailed_info',\n 'kind': 'kind'\n } ],\n 'completion_start_column': 3,\n 'errors': []\n }\n\n current_buffer = VimBuffer( 'buffer' )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n with MockCompletionRequest( CompletionResponse ):\n ycm.SendCompletionRequest()\n assert_that( ycm.CompletionRequestReady() )\n response = ycm.GetCompletionResponse()\n\n post_vim_message.assert_not_called()\n assert_that(\n response,\n has_entries( {\n 'completions': contains_exactly( has_entries( {\n 'word': 'insertion_text',\n 'abbr': 'menu_text',\n 'menu': 'extra_menu_info',\n 'info': 'detailed_info',\n 'kind': 'k',\n 'dup': 1,\n 'empty': 1\n } ) ),\n 'completion_start_column': 3\n } )\n )\n\n item = response[ 'completions' ][ 0 ]\n item.pop( 'user_data' )\n\n with MockResolveRequest( ServerError( 'must not be called' ) ):\n assert_that( ycm.ResolveCompletionItem( item ), equal_to( False ) )\n post_vim_message.assert_not_called()\n\n\n @YouCompleteMeInstance()\n def test_ResolveCompletionItem_NoRequest( self, ycm ):\n assert_that( ycm.GetCurrentCompletionRequest(), equal_to( None ) )\n assert_that( ycm.ResolveCompletionItem( {} ), equal_to( False ) )\n\n\n @YouCompleteMeInstance()\n @patch( 'ycm.client.base_request._logger', autospec = True )\n @patch( 'ycm.vimsupport.PostVimMessage', new_callable = ExtendedMock )\n def test_ResolveCompletionRequest_ServerError(\n self, ycm, post_vim_message, logger ):\n\n def ServerResponse( *args ):\n return {\n 'completions': [ {\n 'insertion_text': 'insertion_text',\n 'menu_text': 'menu_text',\n 'extra_menu_info': 'extra_menu_info',\n 'detailed_info': 'detailed_info',\n 'kind': 'kind',\n 'extra_data': {\n 'doc_string': 'doc_string',\n 'resolve': 10\n }\n } ],\n 'completion_start_column': 3,\n 'errors': []\n }\n\n current_buffer = VimBuffer( 'buffer' )\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n with MockCompletionRequest( ServerResponse ):\n ycm.SendCompletionRequest()\n assert_that( ycm.CompletionRequestReady() )\n response = ycm.GetCompletionResponse()\n\n post_vim_message.assert_not_called()\n assert_that(\n response,\n has_entries( {\n 'completions': contains_exactly( has_entries( {\n 'word': 'insertion_text',\n 'abbr': 'menu_text',\n 'menu': 'extra_menu_info',\n 'info': 'detailed_info\\ndoc_string',\n 'kind': 'k',\n 'dup': 1,\n 'empty': 1\n } ) ),\n 'completion_start_column': 3\n } )\n )\n\n item = response[ 'completions' ][ 0 ]\n assert_that( json.loads( item[ 'user_data' ] ),\n has_entries( { 'resolve': 10 } ) )\n\n with MockResolveRequest( ServerError( 'Server error' ) ):\n ycm.ResolveCompletionItem( item )\n assert_that( ycm.CompletionRequestReady() )\n response = ycm.GetCompletionResponse()\n\n logger.exception.assert_called_with( 'Error while handling server '\n 'response' )\n post_vim_message.assert_has_exact_calls( [\n call( 'Server error', truncate = True )\n ] )\n" }, { "path": "python/ycm/tests/diagnostic_filter_test.py", "content": "# Copyright (C) 2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.tests.test_utils import MockVimModule\nMockVimModule()\n\nfrom hamcrest import assert_that, equal_to\nfrom unittest import TestCase\nfrom ycm.diagnostic_filter import DiagnosticFilter\n\n\ndef _assert_accept_equals( filter, text_or_obj, expected ):\n if not isinstance( text_or_obj, dict ):\n text_or_obj = { 'text': text_or_obj }\n\n assert_that( filter.IsAllowed( text_or_obj ), equal_to( expected ) )\n\n\ndef _assert_accepts( filter, text ):\n _assert_accept_equals( filter, text, True )\n\n\ndef _assert_rejects( filter, text ):\n _assert_accept_equals( filter, text, False )\n\n\ndef _JavaFilter( config ):\n return { 'filter_diagnostics' : { 'java': config } }\n\n\ndef _CreateFilterForTypes( opts, types ):\n return DiagnosticFilter.CreateFromOptions( opts ).SubsetForTypes( types )\n\n\nclass DiagnosticFilterTest( TestCase ):\n def test_RegexFilter( self ):\n opts = _JavaFilter( { 'regex' : 'taco' } )\n f = _CreateFilterForTypes( opts, [ 'java' ] )\n\n _assert_rejects( f, 'This is a Taco' )\n _assert_accepts( f, 'This is a Burrito' )\n\n\n def test_RegexSingleList( self ):\n opts = _JavaFilter( { 'regex' : [ 'taco' ] } )\n f = _CreateFilterForTypes( opts, [ 'java' ] )\n\n _assert_rejects( f, 'This is a Taco' )\n _assert_accepts( f, 'This is a Burrito' )\n\n\n def test_RegexMultiList( self ):\n opts = _JavaFilter( { 'regex' : [ 'taco', 'burrito' ] } )\n f = _CreateFilterForTypes( opts, [ 'java' ] )\n\n _assert_rejects( f, 'This is a Taco' )\n _assert_rejects( f, 'This is a Burrito' )\n\n\n def test_RegexNotFiltered( self ):\n opts = _JavaFilter( { 'regex' : 'taco' } )\n f = _CreateFilterForTypes( opts, [ 'cs' ] )\n\n _assert_accepts( f, 'This is a Taco' )\n _assert_accepts( f, 'This is a Burrito' )\n\n\n def test_LevelWarnings( self ):\n opts = _JavaFilter( { 'level' : 'warning' } )\n f = _CreateFilterForTypes( opts, [ 'java' ] )\n\n _assert_rejects( f, { 'text' : 'This is an unimportant taco',\n 'kind' : 'WARNING' } )\n _assert_accepts( f, { 'text' : 'This taco will be shown',\n 'kind' : 'ERROR' } )\n\n\n def test_LevelErrors( self ):\n opts = _JavaFilter( { 'level' : 'error' } )\n f = _CreateFilterForTypes( opts, [ 'java' ] )\n\n _assert_accepts( f, { 'text' : 'This is an IMPORTANT taco',\n 'kind' : 'WARNING' } )\n _assert_rejects( f, { 'text' : 'This taco will NOT be shown',\n 'kind' : 'ERROR' } )\n\n\n def test_MultipleFilterTypesTypeTest( self ):\n\n opts = _JavaFilter( { 'regex' : '.*taco.*',\n 'level' : 'warning' } )\n f = _CreateFilterForTypes( opts, [ 'java' ] )\n\n _assert_rejects( f, { 'text' : 'This is an unimportant taco',\n 'kind' : 'WARNING' } )\n _assert_rejects( f, { 'text' : 'This taco will NOT be shown',\n 'kind' : 'ERROR' } )\n _assert_accepts( f, { 'text' : 'This burrito WILL be shown',\n 'kind' : 'ERROR' } )\n\n\n def test_MergeMultipleFiletypes( self ):\n\n opts = { 'filter_diagnostics' : {\n 'java' : { 'regex' : '.*taco.*' },\n 'xml' : { 'regex' : '.*burrito.*' } } }\n\n f = _CreateFilterForTypes( opts, [ 'java', 'xml' ] )\n\n _assert_rejects( f, 'This is a Taco' )\n _assert_rejects( f, 'This is a Burrito' )\n _assert_accepts( f, 'This is some Nachos' )\n\n\n def test_CommaSeparatedFiletypes( self ):\n\n opts = { 'filter_diagnostics' : {\n 'java,c,cs' : { 'regex' : '.*taco.*' } } }\n\n f = _CreateFilterForTypes( opts, [ 'cs' ] )\n\n _assert_rejects( f, 'This is a Taco' )\n _assert_accepts( f, 'This is a Burrito' )\n" }, { "path": "python/ycm/tests/diagnostic_interface_test.py", "content": "# Copyright (C) 2015-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\nfrom ycm import diagnostic_interface\nfrom ycm.tests.test_utils import VimBuffer, MockVimModule, MockVimBuffers\nfrom hamcrest import ( assert_that,\n contains_exactly,\n equal_to,\n has_entries,\n has_item )\nfrom unittest import TestCase\nMockVimModule()\n\n\ndef SimpleDiagnosticToJson( start_line, start_col, end_line, end_col ):\n return {\n 'kind': 'ERROR',\n 'location': { 'line_num': start_line, 'column_num': start_col },\n 'location_extent': {\n 'start': {\n 'line_num': start_line,\n 'column_num': start_col\n },\n 'end': {\n 'line_num': end_line,\n 'column_num': end_col\n }\n },\n 'ranges': [\n {\n 'start': {\n 'line_num': start_line,\n 'column_num': start_col\n },\n 'end': {\n 'line_num': end_line,\n 'column_num': end_col\n }\n }\n ]\n }\n\n\ndef SimpleDiagnosticToJsonWithInvalidLineNum( start_line, start_col,\n end_line, end_col ):\n return {\n 'kind': 'ERROR',\n 'location': { 'line_num': start_line, 'column_num': start_col },\n 'location_extent': {\n 'start': {\n 'line_num': start_line,\n 'column_num': start_col\n },\n 'end': {\n 'line_num': end_line,\n 'column_num': end_col\n }\n },\n 'ranges': [\n {\n 'start': {\n 'line_num': 0,\n 'column_num': 0\n },\n 'end': {\n 'line_num': 0,\n 'column_num': 0\n }\n },\n {\n 'start': {\n 'line_num': start_line,\n 'column_num': start_col\n },\n 'end': {\n 'line_num': end_line,\n 'column_num': end_col\n }\n }\n ]\n }\n\n\ndef YcmTextPropertyTupleMatcher( start_line, start_col, end_line, end_col ):\n return has_item( contains_exactly(\n start_line,\n start_col,\n 'YcmErrorProperty',\n has_entries( { 'end_col': end_col, 'end_lnum': end_line } ) ) )\n\n\nclass DiagnosticInterfaceTest( TestCase ):\n def test_ConvertDiagnosticToTextProperties( self ):\n for diag, contents, result in [\n # Error in middle of the line\n [\n SimpleDiagnosticToJson( 1, 16, 1, 23 ),\n [ 'Highlight this error please' ],\n YcmTextPropertyTupleMatcher( 1, 16, 1, 23 )\n ],\n # Error at the end of the line\n [\n SimpleDiagnosticToJson( 1, 16, 1, 21 ),\n [ 'Highlight this warning' ],\n YcmTextPropertyTupleMatcher( 1, 16, 1, 21 )\n ],\n [\n SimpleDiagnosticToJson( 1, 16, 1, 19 ),\n [ 'Highlight unicøde' ],\n YcmTextPropertyTupleMatcher( 1, 16, 1, 19 )\n ],\n # Non-positive position\n [\n SimpleDiagnosticToJson( 0, 0, 0, 0 ),\n [ 'Some contents' ],\n {}\n ],\n [\n SimpleDiagnosticToJson( -1, -2, -3, -4 ),\n [ 'Some contents' ],\n YcmTextPropertyTupleMatcher( 1, 1, 1, 1 )\n ],\n ]:\n with self.subTest( diag = diag, contents = contents, result = result ):\n current_buffer = VimBuffer( 'foo', number = 1, contents = [ '' ] )\n target_buffer = VimBuffer( 'bar', number = 2, contents = contents )\n\n with MockVimBuffers( [ current_buffer, target_buffer ],\n [ current_buffer, target_buffer ] ):\n actual = diagnostic_interface._ConvertDiagnosticToTextProperties(\n target_buffer.number,\n diag )\n print( actual )\n assert_that( actual, result )\n\n def test_ConvertDiagnosticWithInvalidLineNum( self ):\n for diag, contents, result in [\n # Error in middle of the line\n [\n SimpleDiagnosticToJsonWithInvalidLineNum( 1, 16, 1, 23 ),\n [ 'Highlight this error please' ],\n YcmTextPropertyTupleMatcher( 1, 16, 1, 23 )\n ],\n # Error at the end of the line\n [\n SimpleDiagnosticToJsonWithInvalidLineNum( 1, 16, 1, 21 ),\n [ 'Highlight this warning' ],\n YcmTextPropertyTupleMatcher( 1, 16, 1, 21 )\n ],\n [\n SimpleDiagnosticToJsonWithInvalidLineNum( 1, 16, 1, 19 ),\n [ 'Highlight unicøde' ],\n YcmTextPropertyTupleMatcher( 1, 16, 1, 19 )\n ],\n ]:\n with self.subTest( diag = diag, contents = contents, result = result ):\n current_buffer = VimBuffer( 'foo', number = 1, contents = [ '' ] )\n target_buffer = VimBuffer( 'bar', number = 2, contents = contents )\n\n with MockVimBuffers( [ current_buffer, target_buffer ],\n [ current_buffer, target_buffer ] ):\n actual = diagnostic_interface._ConvertDiagnosticToTextProperties(\n target_buffer.number,\n diag )\n print( actual )\n assert_that( actual, result )\n\n\n def test_IsValidRange( self ):\n for start_line, start_col, end_line, end_col, expect in (\n ( 1, 1, 1, 1, True ),\n ( 1, 1, 0, 0, False ),\n ( 1, 1, 2, 1, True ),\n ( 1, 2, 2, 1, True ),\n ( 2, 1, 1, 1, False ),\n ( 2, 2, 2, 1, False ),\n ):\n with self.subTest( start=( start_line, start_col ),\n end=( end_line, end_col ),\n expect = expect ):\n assert_that( diagnostic_interface._IsValidRange( start_line,\n start_col,\n end_line,\n end_col ),\n equal_to( expect ) )\n" }, { "path": "python/ycm/tests/event_notification_test.py", "content": "# Copyright (C) 2015-2018 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.tests.test_utils import ( CurrentWorkingDirectory, ExtendedMock,\n MockVimBuffers, MockVimModule, VimBuffer,\n VimSign )\nMockVimModule()\n\nimport contextlib\nimport os\n\nfrom ycm.tests import ( PathToTestFile, test_utils, YouCompleteMeInstance,\n WaitUntilReady )\nfrom ycmd.responses import ( BuildDiagnosticData, Diagnostic, Location, Range,\n UnknownExtraConf, ServerError )\n\nfrom hamcrest import ( assert_that, contains_exactly, empty, equal_to,\n has_entries, has_entry, has_item, has_items, has_key,\n is_not )\nfrom unittest import TestCase\nfrom unittest.mock import call, MagicMock, patch\n\n\ndef PresentDialog_Confirm_Call( message ):\n \"\"\"Return a mock.call object for a call to vimsupport.PresentDialog, as called\n why vimsupport.Confirm with the supplied confirmation message\"\"\"\n return call( message, [ 'Ok', 'Cancel' ] )\n\n\n@contextlib.contextmanager\ndef MockArbitraryBuffer( filetype ):\n \"\"\"Used via the with statement, set up a single buffer with an arbitrary name\n and no contents. Its filetype is set to the supplied filetype.\"\"\"\n\n # Arbitrary, but valid, single buffer open.\n current_buffer = VimBuffer( os.path.realpath( 'TEST_BUFFER' ),\n filetype = filetype )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n yield\n\n\n@contextlib.contextmanager\ndef MockEventNotification( response_method, native_filetype_completer = True ):\n \"\"\"Mock out the EventNotification client request object, replacing the\n Response handler's JsonFromFuture with the supplied |response_method|.\n Additionally mock out YouCompleteMe's FiletypeCompleterExistsForFiletype\n method to return the supplied |native_filetype_completer| parameter, rather\n than querying the server\"\"\"\n\n # We don't want the event to actually be sent to the server, just have it\n # return success\n with patch( 'ycm.client.event_notification.EventNotification.'\n 'PostDataToHandlerAsync',\n return_value = MagicMock( return_value=True ) ):\n\n # We set up a fake a Response (as called by EventNotification.Response)\n # which calls the supplied callback method. Generally this callback just\n # raises an apropriate exception, otherwise it would have to return a mock\n # future object.\n with patch( 'ycm.client.base_request._JsonFromFuture',\n side_effect = response_method ):\n\n # Filetype available information comes from the server, so rather than\n # relying on that request, we mock out the check. The caller decides if\n # filetype completion is available\n with patch(\n 'ycm.youcompleteme.YouCompleteMe.FiletypeCompleterExistsForFiletype',\n return_value = native_filetype_completer ):\n\n yield\n\n\ndef _Check_FileReadyToParse_Diagnostic_Error( ycm ):\n # Tests Vim sign placement and error/warning count python API\n # when one error is returned.\n def DiagnosticResponse( *args ):\n start = Location( 1, 2, 'TEST_BUFFER' )\n end = Location( 1, 4, 'TEST_BUFFER' )\n extent = Range( start, end )\n diagnostic = Diagnostic( [], start, extent, 'expected ;', 'ERROR' )\n return [ BuildDiagnosticData( diagnostic ) ]\n\n with MockArbitraryBuffer( 'cpp' ):\n with MockEventNotification( DiagnosticResponse ):\n ycm.OnFileReadyToParse()\n assert_that( ycm.FileParseRequestReady() )\n ycm.HandleFileParseRequest()\n assert_that(\n test_utils.VIM_SIGNS,\n contains_exactly(\n VimSign( 1, 'YcmError', 1 )\n )\n )\n assert_that( ycm.GetErrorCount(), equal_to( 1 ) )\n assert_that( ycm.GetWarningCount(), equal_to( 0 ) )\n\n # Consequent calls to HandleFileParseRequest shouldn't mess with\n # existing diagnostics, when there is no new parse request.\n ycm.HandleFileParseRequest()\n assert_that(\n test_utils.VIM_SIGNS,\n contains_exactly(\n VimSign( 1, 'YcmError', 1 )\n )\n )\n assert_that( ycm.GetErrorCount(), equal_to( 1 ) )\n assert_that( ycm.GetWarningCount(), equal_to( 0 ) )\n\n assert_that( not ycm.ShouldResendFileParseRequest() )\n\n # New identical requests should result in the same diagnostics.\n ycm.OnFileReadyToParse()\n assert_that( ycm.FileParseRequestReady() )\n ycm.HandleFileParseRequest()\n assert_that(\n test_utils.VIM_SIGNS,\n contains_exactly(\n VimSign( 1, 'YcmError', 1 )\n )\n )\n assert_that( ycm.GetErrorCount(), equal_to( 1 ) )\n assert_that( ycm.GetWarningCount(), equal_to( 0 ) )\n\n assert_that( not ycm.ShouldResendFileParseRequest() )\n\n\ndef _Check_FileReadyToParse_Diagnostic_Warning( ycm ):\n # Tests Vim sign placement/unplacement and error/warning count python API\n # when one warning is returned.\n # Should be called after _Check_FileReadyToParse_Diagnostic_Error\n def DiagnosticResponse( *args ):\n start = Location( 2, 2, 'TEST_BUFFER' )\n end = Location( 2, 4, 'TEST_BUFFER' )\n extent = Range( start, end )\n diagnostic = Diagnostic( [], start, extent, 'cast', 'WARNING' )\n return [ BuildDiagnosticData( diagnostic ) ]\n\n with MockArbitraryBuffer( 'cpp' ):\n with MockEventNotification( DiagnosticResponse ):\n ycm.OnFileReadyToParse()\n assert_that( ycm.FileParseRequestReady() )\n ycm.HandleFileParseRequest()\n assert_that(\n test_utils.VIM_SIGNS,\n contains_exactly(\n VimSign( 2, 'YcmWarning', 1 )\n )\n )\n assert_that( ycm.GetErrorCount(), equal_to( 0 ) )\n assert_that( ycm.GetWarningCount(), equal_to( 1 ) )\n\n # Consequent calls to HandleFileParseRequest shouldn't mess with\n # existing diagnostics, when there is no new parse request.\n ycm.HandleFileParseRequest()\n assert_that(\n test_utils.VIM_SIGNS,\n contains_exactly(\n VimSign( 2, 'YcmWarning', 1 )\n )\n )\n assert_that( ycm.GetErrorCount(), equal_to( 0 ) )\n assert_that( ycm.GetWarningCount(), equal_to( 1 ) )\n\n assert_that( not ycm.ShouldResendFileParseRequest() )\n\n\ndef _Check_FileReadyToParse_Diagnostic_Clean( ycm ):\n # Tests Vim sign unplacement and error/warning count python API\n # when there are no errors/warnings left.\n # Should be called after _Check_FileReadyToParse_Diagnostic_Warning\n with MockArbitraryBuffer( 'cpp' ):\n with MockEventNotification( MagicMock( return_value = [] ) ):\n ycm.OnFileReadyToParse()\n ycm.HandleFileParseRequest()\n assert_that(\n test_utils.VIM_SIGNS,\n empty()\n )\n assert_that( ycm.GetErrorCount(), equal_to( 0 ) )\n assert_that( ycm.GetWarningCount(), equal_to( 0 ) )\n assert_that( not ycm.ShouldResendFileParseRequest() )\n\n\nclass EventNotificationTest( TestCase ):\n @patch( 'ycm.vimsupport.PostVimMessage', new_callable = ExtendedMock )\n @YouCompleteMeInstance()\n def test_EventNotification_FileReadyToParse_NonDiagnostic_Error(\n self, ycm, post_vim_message ):\n\n # This test validates the behaviour of YouCompleteMe.HandleFileParseRequest\n # in combination with YouCompleteMe.OnFileReadyToParse when the completer\n # raises an exception handling FileReadyToParse event notification\n ERROR_TEXT = 'Some completer response text'\n\n def ErrorResponse( *args ):\n raise ServerError( ERROR_TEXT )\n\n with MockArbitraryBuffer( 'some_filetype' ):\n with MockEventNotification( ErrorResponse ):\n ycm.OnFileReadyToParse()\n assert_that( ycm.FileParseRequestReady() )\n ycm.HandleFileParseRequest()\n\n # The first call raises a warning\n post_vim_message.assert_has_exact_calls( [\n call( ERROR_TEXT, truncate = True )\n ] )\n\n # Subsequent calls don't re-raise the warning\n ycm.HandleFileParseRequest()\n post_vim_message.assert_has_exact_calls( [\n call( ERROR_TEXT, truncate = True )\n ] )\n\n assert_that( not ycm.ShouldResendFileParseRequest() )\n\n # But it does if a subsequent event raises again\n ycm.OnFileReadyToParse()\n assert_that( ycm.FileParseRequestReady() )\n ycm.HandleFileParseRequest()\n post_vim_message.assert_has_exact_calls( [\n call( ERROR_TEXT, truncate = True ),\n call( ERROR_TEXT, truncate = True )\n ] )\n\n assert_that( not ycm.ShouldResendFileParseRequest() )\n\n\n @YouCompleteMeInstance()\n def test_EventNotification_FileReadyToParse_NonDiagnostic_Error_NonNative(\n self, ycm ):\n\n test_utils.VIM_MATCHES = []\n test_utils.VIM_SIGNS = []\n\n with MockArbitraryBuffer( 'some_filetype' ):\n with MockEventNotification( None, False ):\n ycm.OnFileReadyToParse()\n ycm.HandleFileParseRequest()\n assert_that( test_utils.VIM_MATCHES, empty() )\n assert_that( test_utils.VIM_SIGNS, empty() )\n assert_that( not ycm.ShouldResendFileParseRequest() )\n\n\n @YouCompleteMeInstance()\n def test_EventNotification_FileReadyToParse_NonDiagnostic_ConfirmExtraConf(\n self, ycm ):\n\n # This test validates the behaviour of YouCompleteMe.HandleFileParseRequest\n # in combination with YouCompleteMe.OnFileReadyToParse when the completer\n # raises the (special) UnknownExtraConf exception\n FILE_NAME = 'a_file'\n MESSAGE = ( 'Found ' + FILE_NAME + '. Load? \\n\\n(Question can be '\n 'turned off with options, see YCM docs)' )\n\n def UnknownExtraConfResponse( *args ):\n raise UnknownExtraConf( FILE_NAME )\n\n with patch( 'ycm.client.base_request.BaseRequest.PostDataToHandler',\n new_callable = ExtendedMock ) as post_data_to_handler:\n with MockArbitraryBuffer( 'some_filetype' ):\n with MockEventNotification( UnknownExtraConfResponse ):\n\n # When the user accepts the extra conf, we load it\n with patch( 'ycm.vimsupport.PresentDialog',\n return_value = 0,\n new_callable = ExtendedMock ) as present_dialog:\n ycm.OnFileReadyToParse()\n assert_that( ycm.FileParseRequestReady() )\n ycm.HandleFileParseRequest()\n\n present_dialog.assert_has_exact_calls( [\n PresentDialog_Confirm_Call( MESSAGE ),\n ] )\n post_data_to_handler.assert_has_exact_calls( [\n call( { 'filepath': FILE_NAME }, 'load_extra_conf_file' )\n ] )\n\n # Subsequent calls don't re-raise the warning\n ycm.HandleFileParseRequest()\n\n present_dialog.assert_has_exact_calls( [\n PresentDialog_Confirm_Call( MESSAGE )\n ] )\n post_data_to_handler.assert_has_exact_calls( [\n call( { 'filepath': FILE_NAME }, 'load_extra_conf_file' )\n ] )\n\n assert_that( ycm.ShouldResendFileParseRequest() )\n\n # But it does if a subsequent event raises again\n ycm.OnFileReadyToParse()\n assert_that( ycm.FileParseRequestReady() )\n ycm.HandleFileParseRequest()\n\n present_dialog.assert_has_exact_calls( [\n PresentDialog_Confirm_Call( MESSAGE ),\n PresentDialog_Confirm_Call( MESSAGE ),\n ] )\n post_data_to_handler.assert_has_exact_calls( [\n call( { 'filepath': FILE_NAME }, 'load_extra_conf_file' ),\n call( { 'filepath': FILE_NAME }, 'load_extra_conf_file' )\n ] )\n\n assert_that( ycm.ShouldResendFileParseRequest() )\n\n post_data_to_handler.reset_mock()\n\n # When the user rejects the extra conf, we reject it\n with patch( 'ycm.vimsupport.PresentDialog',\n return_value = 1,\n new_callable = ExtendedMock ) as present_dialog:\n ycm.OnFileReadyToParse()\n assert_that( ycm.FileParseRequestReady() )\n ycm.HandleFileParseRequest()\n\n present_dialog.assert_has_exact_calls( [\n PresentDialog_Confirm_Call( MESSAGE ),\n ] )\n post_data_to_handler.assert_has_exact_calls( [\n call( { 'filepath': FILE_NAME }, 'ignore_extra_conf_file' )\n ] )\n\n # Subsequent calls don't re-raise the warning\n ycm.HandleFileParseRequest()\n\n present_dialog.assert_has_exact_calls( [\n PresentDialog_Confirm_Call( MESSAGE )\n ] )\n post_data_to_handler.assert_has_exact_calls( [\n call( { 'filepath': FILE_NAME }, 'ignore_extra_conf_file' )\n ] )\n\n assert_that( ycm.ShouldResendFileParseRequest() )\n\n # But it does if a subsequent event raises again\n ycm.OnFileReadyToParse()\n assert_that( ycm.FileParseRequestReady() )\n ycm.HandleFileParseRequest()\n\n present_dialog.assert_has_exact_calls( [\n PresentDialog_Confirm_Call( MESSAGE ),\n PresentDialog_Confirm_Call( MESSAGE ),\n ] )\n post_data_to_handler.assert_has_exact_calls( [\n call( { 'filepath': FILE_NAME }, 'ignore_extra_conf_file' ),\n call( { 'filepath': FILE_NAME }, 'ignore_extra_conf_file' )\n ] )\n\n assert_that( ycm.ShouldResendFileParseRequest() )\n\n\n @YouCompleteMeInstance()\n def test_EventNotification_FileReadyToParse_Diagnostic_Error_Native(\n self, ycm ):\n test_utils.VIM_SIGNS = []\n\n _Check_FileReadyToParse_Diagnostic_Error( ycm )\n _Check_FileReadyToParse_Diagnostic_Warning( ycm )\n _Check_FileReadyToParse_Diagnostic_Clean( ycm )\n\n\n @patch( 'ycm.youcompleteme.YouCompleteMe._AddUltiSnipsDataIfNeeded' )\n @YouCompleteMeInstance( { 'g:ycm_collect_identifiers_from_tags_files': 1 } )\n def test_EventNotification_FileReadyToParse_TagFiles_UnicodeWorkingDirectory(\n self, ycm, *args ):\n unicode_dir = PathToTestFile( 'uni¢od€' )\n current_buffer_file = PathToTestFile( 'uni¢𐍈d€', 'current_buffer' )\n current_buffer = VimBuffer( name = current_buffer_file,\n contents = [ 'current_buffer_contents' ],\n filetype = 'some_filetype' )\n\n with patch( 'ycm.client.event_notification.EventNotification.'\n 'PostDataToHandlerAsync' ) as post_data_to_handler_async:\n with CurrentWorkingDirectory( unicode_dir ):\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 5 ) ):\n ycm.OnFileReadyToParse()\n\n assert_that(\n # Positional arguments passed to PostDataToHandlerAsync.\n post_data_to_handler_async.call_args[ 0 ],\n contains_exactly(\n has_entries( {\n 'filepath': current_buffer_file,\n 'line_num': 1,\n 'column_num': 6,\n 'file_data': has_entries( {\n current_buffer_file: has_entries( {\n 'contents': 'current_buffer_contents\\n',\n 'filetypes': [ 'some_filetype' ]\n } )\n } ),\n 'event_name': 'FileReadyToParse',\n 'tag_files': has_item( PathToTestFile( 'uni¢od€', 'tags' ) )\n } ),\n 'event_notification'\n )\n )\n\n\n @patch( 'ycm.youcompleteme.YouCompleteMe._AddUltiSnipsDataIfNeeded' )\n @YouCompleteMeInstance()\n def test_EventNotification_BufferVisit_BuildRequestForCurrentAndUnsavedBuffers( # noqa\n self, ycm, *args ):\n\n current_buffer_file = os.path.realpath( 'current_buffer' )\n current_buffer = VimBuffer( name = current_buffer_file,\n number = 1,\n contents = [ 'current_buffer_contents' ],\n filetype = 'some_filetype',\n modified = False )\n modified_buffer_file = os.path.realpath( 'modified_buffer' )\n modified_buffer = VimBuffer( name = modified_buffer_file,\n number = 2,\n contents = [ 'modified_buffer_contents' ],\n filetype = 'some_filetype',\n modified = True )\n\n unmodified_buffer_file = os.path.realpath( 'unmodified_buffer' )\n unmodified_buffer = VimBuffer( name = unmodified_buffer_file,\n number = 3,\n contents = [ 'unmodified_buffer_contents' ],\n filetype = 'some_filetype',\n modified = False )\n\n with patch( 'ycm.client.event_notification.EventNotification.'\n 'PostDataToHandlerAsync' ) as post_data_to_handler_async:\n with MockVimBuffers( [ current_buffer,\n modified_buffer,\n unmodified_buffer ],\n [ current_buffer ],\n ( 1, 5 ) ):\n ycm.OnBufferVisit()\n\n assert_that(\n # Positional arguments passed to PostDataToHandlerAsync.\n post_data_to_handler_async.call_args[ 0 ],\n contains_exactly(\n has_entries( {\n 'filepath': current_buffer_file,\n 'line_num': 1,\n 'column_num': 6,\n 'file_data': has_entries( {\n current_buffer_file: has_entries( {\n 'contents': 'current_buffer_contents\\n',\n 'filetypes': [ 'some_filetype' ]\n } ),\n modified_buffer_file: has_entries( {\n 'contents': 'modified_buffer_contents\\n',\n 'filetypes': [ 'some_filetype' ]\n } )\n } ),\n 'event_name': 'BufferVisit'\n } ),\n 'event_notification'\n )\n )\n\n\n @YouCompleteMeInstance()\n def test_EventNotification_BufferUnload_BuildRequestForDeletedAndUnsavedBuffers( # noqa\n self, ycm ):\n current_buffer_file = os.path.realpath( 'current_βuffer' )\n current_buffer = VimBuffer( name = current_buffer_file,\n number = 1,\n contents = [ 'current_buffer_contents' ],\n filetype = 'some_filetype',\n modified = True )\n\n deleted_buffer_file = os.path.realpath( 'deleted_βuffer' )\n deleted_buffer = VimBuffer( name = deleted_buffer_file,\n number = 2,\n contents = [ 'deleted_buffer_contents' ],\n filetype = 'some_filetype',\n modified = False )\n\n with patch( 'ycm.client.event_notification.EventNotification.'\n 'PostDataToHandlerAsync' ) as post_data_to_handler_async:\n with MockVimBuffers( [ current_buffer, deleted_buffer ],\n [ current_buffer ] ):\n ycm.OnBufferUnload( deleted_buffer.number )\n\n assert_that(\n # Positional arguments passed to PostDataToHandlerAsync.\n post_data_to_handler_async.call_args[ 0 ],\n contains_exactly(\n has_entries( {\n 'filepath': deleted_buffer_file,\n 'line_num': 1,\n 'column_num': 1,\n 'file_data': has_entries( {\n current_buffer_file: has_entries( {\n 'contents': 'current_buffer_contents\\n',\n 'filetypes': [ 'some_filetype' ]\n } ),\n deleted_buffer_file: has_entries( {\n 'contents': 'deleted_buffer_contents\\n',\n 'filetypes': [ 'some_filetype' ]\n } )\n } ),\n 'event_name': 'BufferUnload'\n } ),\n 'event_notification'\n )\n )\n\n\n @patch( 'ycm.vimsupport.CaptureVimCommand', return_value = \"\"\"\nfooGroup xxx foo bar\n links to Statement\"\"\" )\n @YouCompleteMeInstance( { 'g:ycm_seed_identifiers_with_syntax': 1 } )\n def test_EventNotification_FileReadyToParse_SyntaxKeywords_SeedWithCache(\n self, ycm, *args ):\n\n current_buffer = VimBuffer( name = 'current_buffer',\n filetype = 'some_filetype' )\n\n with patch( 'ycm.client.event_notification.EventNotification.'\n 'PostDataToHandlerAsync' ) as post_data_to_handler_async:\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n ycm.OnFileReadyToParse()\n assert_that(\n # Positional arguments passed to PostDataToHandlerAsync.\n post_data_to_handler_async.call_args[ 0 ],\n contains_exactly(\n has_entry( 'syntax_keywords', has_items( 'foo', 'bar' ) ),\n 'event_notification'\n )\n )\n\n # Do not send again syntax keywords in subsequent requests.\n ycm.OnFileReadyToParse()\n assert_that(\n # Positional arguments passed to PostDataToHandlerAsync.\n post_data_to_handler_async.call_args[ 0 ],\n contains_exactly(\n is_not( has_key( 'syntax_keywords' ) ),\n 'event_notification'\n )\n )\n\n\n @patch( 'ycm.vimsupport.CaptureVimCommand', return_value = \"\"\"\nfooGroup xxx foo bar\n links to Statement\"\"\" )\n @YouCompleteMeInstance( { 'g:ycm_seed_identifiers_with_syntax': 1 } )\n def test_EventNotification_FileReadyToParse_SyntaxKeywords_ClearCacheIfRestart( # noqa\n self, ycm, *args ):\n\n current_buffer = VimBuffer( name = 'current_buffer',\n filetype = 'some_filetype' )\n\n with patch( 'ycm.client.event_notification.EventNotification.'\n 'PostDataToHandlerAsync' ) as post_data_to_handler_async:\n with MockVimBuffers( [ current_buffer ], [ current_buffer ] ):\n ycm.OnFileReadyToParse()\n assert_that(\n # Positional arguments passed to PostDataToHandlerAsync.\n post_data_to_handler_async.call_args[ 0 ],\n contains_exactly(\n has_entry( 'syntax_keywords', has_items( 'foo', 'bar' ) ),\n 'event_notification'\n )\n )\n\n # Send again the syntax keywords after restarting the server.\n ycm.RestartServer()\n WaitUntilReady()\n ycm.OnFileReadyToParse()\n assert_that(\n # Positional arguments passed to PostDataToHandlerAsync.\n post_data_to_handler_async.call_args[ 0 ],\n contains_exactly(\n has_entry( 'syntax_keywords', has_items( 'foo', 'bar' ) ),\n 'event_notification'\n )\n )\n" }, { "path": "python/ycm/tests/mock_utils.py", "content": "# Copyright (C) 2017 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\nimport json\nfrom unittest import mock\nHTTP_OK = 200\n\n\nclass FakeResponse:\n \"\"\"A fake version of a requests response object, just about suitable for\n mocking a server response. Not usually used directly. See\n MockServerResponse* methods\"\"\"\n def __init__( self, response, exception ):\n self._json = response\n self._exception = exception\n self.code = HTTP_OK\n\n\n def read( self ):\n if self._exception:\n raise self._exception\n return json.dumps( self._json ).encode( 'utf-8' )\n\n\n def close( self ):\n pass\n\n\nclass FakeFuture:\n \"\"\"A fake version of a future response object, just about suitable for\n mocking a server response as generated by PostDataToHandlerAsync.\n Not usually used directly. See MockAsyncServerResponse* methods\"\"\"\n def __init__( self, done, response = None, exception = None ):\n self._done = done\n\n if not done:\n self._result = None\n else:\n self._result = FakeResponse( response, exception )\n\n\n def done( self ):\n return self._done\n\n\n def result( self ):\n return self._result\n\n\ndef MockAsyncServerResponseDone( response ):\n \"\"\"Return a MessagePoll containing a fake future object that is complete with\n the supplied response message. Suitable for mocking a response future within\n a client request. For example:\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 1 ) ) as v:\n mock_response = MockAsyncServerResponseDone( response )\n with patch.dict( ycm._message_poll_requests, {} ):\n ycm._message_poll_requests[ filetype ] = MessagesPoll( v.current.buffer )\n ycm._message_poll_requests[ filetype ]._response_future = mock_response\n # Needed to keep a reference to the mocked dictionary\n mock_future = ycm._message_poll_requests[ filetype ]._response_future\n ycm.OnPeriodicTick() # Uses ycm._message_poll_requests[ filetype ] ...\n \"\"\"\n return mock.MagicMock( wraps = FakeFuture( True, response ) )\n\n\ndef MockAsyncServerResponseInProgress():\n \"\"\"Return a fake future object that is incomplete. Suitable for mocking a\n response future within a client request. For example:\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 1 ) ) as v:\n mock_response = MockAsyncServerResponseInProgress()\n with patch.dict( ycm._message_poll_requests, {} ):\n ycm._message_poll_requests[ filetype ] = MessagesPoll( v.current.buffer )\n ycm._message_poll_requests[ filetype ]._response_future = mock_response\n # Needed to keep a reference to the mocked dictionary\n mock_future = ycm._message_poll_requests[ filetype ]._response_future\n ycm.OnPeriodicTick() # Uses ycm._message_poll_requests[ filetype ] ...\n \"\"\"\n return mock.MagicMock( wraps = FakeFuture( False ) )\n\n\ndef MockAsyncServerResponseException( exception ):\n \"\"\"Return a fake future object that is complete, but raises an exception.\n Suitable for mocking a response future within a client request. For example:\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 1 ) ) as v:\n mock_response = MockAsyncServerResponseException( exception )\n with patch.dict( ycm._message_poll_requests, {} ):\n ycm._message_poll_requests[ filetype ] = MessagesPoll( v.current.buffer )\n ycm._message_poll_requests[ filetype ]._response_future = mock_response\n # Needed to keep a reference to the mocked dictionary\n mock_future = ycm._message_poll_requests[ filetype ]._response_future\n ycm.OnPeriodicTick() # Uses ycm._message_poll_requests[ filetype ] ...\n \"\"\"\n return mock.MagicMock( wraps = FakeFuture( True, None, exception ) )\n\n\n# TODO: In future, implement MockServerResponse and MockServerResponseException\n# for synchronous cases when such test cases are needed.\n" }, { "path": "python/ycm/tests/omni_completer_test.py", "content": "# encoding: utf-8\n#\n# Copyright (C) 2016-2019 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom hamcrest import assert_that, contains_exactly, empty, has_entries\nfrom unittest import TestCase\n\nfrom ycm.tests.test_utils import MockVimBuffers, MockVimModule, VimBuffer\nMockVimModule()\n\nfrom ycm import vimsupport\nfrom ycm.tests import YouCompleteMeInstance, youcompleteme_instance\n\nFILETYPE = 'ycmtest'\nTRIGGERS = {\n 'ycmtest': [ '.' ]\n}\n\n\ndef StartColumnCompliance( ycm,\n omnifunc_start_column,\n ycm_completions,\n ycm_start_column ):\n def Omnifunc( findstart, base ):\n if findstart:\n return omnifunc_start_column\n return [ 'foo' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'fo' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 2 ) ):\n ycm.SendCompletionRequest( force_semantic = True )\n r = ycm.GetCompletionResponse()\n assert_that(\n r,\n has_entries( {\n 'completions': ycm_completions,\n 'completion_start_column': ycm_start_column\n } )\n )\n\n\nclass OmniCompleterTest( TestCase ):\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_Cache_List( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return [ 'a', 'b', 'cdef' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 5 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [\n { 'word': 'a', 'equal': 1 },\n { 'word': 'b', 'equal': 1 },\n { 'word': 'cdef', 'equal': 1 }\n ],\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_Cache_ListFilter( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return [ 'a', 'b', 'cdef' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.t' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 6 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': empty(),\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_NoCache_List( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return [ 'a', 'b', 'cdef' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 5 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [\n { 'word': 'a', 'equal': 1 },\n { 'word': 'b', 'equal': 1 },\n { 'word': 'cdef', 'equal': 1 }\n ],\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_NoCache_ListFilter( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return [ 'a', 'b', 'cdef' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.t' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 6 ) ):\n ycm.SendCompletionRequest()\n # Actual result is that the results are not filtered, as we expect the\n # omnifunc or vim itself to do this filtering.\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [\n { 'word': 'a', 'equal': 1 },\n { 'word': 'b', 'equal': 1 },\n { 'word': 'cdef', 'equal': 1 }\n ],\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_NoCache_UseFindStart( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 0\n return [ 'a', 'b', 'cdef' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.t' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 6 ) ):\n ycm.SendCompletionRequest()\n # Actual result is that the results are not filtered, as we expect the\n # omnifunc or vim itself to do this filtering.\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [\n { 'word': 'a', 'equal': 1 },\n { 'word': 'b', 'equal': 1 },\n { 'word': 'cdef', 'equal': 1 }\n ],\n 'completion_start_column': 1\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_Cache_UseFindStart( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 0\n return [ 'a', 'b', 'cdef' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.t' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 6 ) ):\n ycm.SendCompletionRequest()\n # There are no results because the query 'test.t' doesn't match any\n # candidate (and cache_omnifunc=1, so we FilterAndSortCandidates).\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': empty(),\n 'completion_start_column': 1\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_Cache_Object( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return { 'words': [ 'a', 'b', 'CDtEF' ] }\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.t' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 6 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [ { 'word': 'CDtEF', 'equal': 1 } ],\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_Cache_ObjectList( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return [\n {\n 'word': 'a',\n 'abbr': 'ABBR',\n 'menu': 'MENU',\n 'info': 'INFO',\n 'kind': 'K'\n },\n {\n 'word': 'test',\n 'abbr': 'ABBRTEST',\n 'menu': 'MENUTEST',\n 'info': 'INFOTEST',\n 'kind': 'T'\n }\n ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.tt' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 7 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': contains_exactly( {\n 'word' : 'test',\n 'abbr' : 'ABBRTEST',\n 'menu' : 'MENUTEST',\n 'info' : 'INFOTEST',\n 'kind' : 'T',\n 'equal': 1\n } ),\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_NoCache_ObjectList( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return [\n {\n 'word': 'a',\n 'abbr': 'ABBR',\n 'menu': 'MENU',\n 'info': 'INFO',\n 'kind': 'K'\n },\n {\n 'word': 'test',\n 'abbr': 'ABBRTEST',\n 'menu': 'MENUTEST',\n 'info': 'INFOTEST',\n 'kind': 'T'\n }\n ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.tt' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 7 ) ):\n ycm.SendCompletionRequest()\n # We don't filter the result - we expect the omnifunc to do that\n # based on the query we supplied (Note: that means no fuzzy matching!).\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [ {\n 'word' : 'a',\n 'abbr' : 'ABBR',\n 'menu' : 'MENU',\n 'info' : 'INFO',\n 'kind' : 'K',\n 'equal': 1\n }, {\n 'word' : 'test',\n 'abbr' : 'ABBRTEST',\n 'menu' : 'MENUTEST',\n 'info' : 'INFOTEST',\n 'kind' : 'T',\n 'equal': 1\n } ],\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_Cache_ObjectListObject( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return { 'words': [\n {\n 'word': 'a',\n 'abbr': 'ABBR',\n 'menu': 'MENU',\n 'info': 'INFO',\n 'kind': 'K'\n },\n {\n 'word': 'test',\n 'abbr': 'ABBRTEST',\n 'menu': 'MENUTEST',\n 'info': 'INFOTEST',\n 'kind': 'T'\n }\n ] }\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.tt' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 7 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [ {\n 'word' : 'test',\n 'abbr' : 'ABBRTEST',\n 'menu' : 'MENUTEST',\n 'info' : 'INFOTEST',\n 'kind' : 'T',\n 'equal': 1\n } ],\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_NoCache_ObjectListObject( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return { 'words': [\n {\n 'word': 'a',\n 'abbr': 'ABBR',\n 'menu': 'MENU',\n 'info': 'INFO',\n 'kind': 'K'\n },\n {\n 'word': 'test',\n 'abbr': 'ABBRTEST',\n 'menu': 'MENUTEST',\n 'info': 'INFOTEST',\n 'kind': 'T'\n }\n ] }\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.tt' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 7 ) ):\n ycm.SendCompletionRequest()\n # No FilterAndSortCandidates for cache_omnifunc=0 (we expect the omnifunc\n # to do the filtering?)\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [ {\n 'word' : 'a',\n 'abbr' : 'ABBR',\n 'menu' : 'MENU',\n 'info' : 'INFO',\n 'kind' : 'K',\n 'equal': 1\n }, {\n 'word' : 'test',\n 'abbr' : 'ABBRTEST',\n 'menu' : 'MENUTEST',\n 'info' : 'INFOTEST',\n 'kind' : 'T',\n 'equal': 1\n } ],\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_Cache_List_Unicode( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 12\n return [ '†est', 'å_unicode_identifier', 'πππππππ yummy πie' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ '†åsty_π.' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 12 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [\n { 'word': 'å_unicode_identifier', 'equal': 1 },\n { 'word': 'πππππππ yummy πie', 'equal': 1 },\n { 'word': '†est', 'equal': 1 }\n ],\n 'completion_start_column': 13\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_NoCache_List_Unicode( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 12\n return [ '†est', 'å_unicode_identifier', 'πππππππ yummy πie' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ '†åsty_π.' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 12 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [\n { 'word': '†est', 'equal': 1 },\n { 'word': 'å_unicode_identifier', 'equal': 1 },\n { 'word': 'πππππππ yummy πie', 'equal': 1 }\n ],\n 'completion_start_column': 13\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_Cache_List_Filter_Unicode( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 12\n return [ '†est', 'å_unicode_identifier', 'πππππππ yummy πie' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ '†åsty_π.ππ' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 17 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [ { 'word': 'πππππππ yummy πie', 'equal': 1 } ],\n 'completion_start_column': 13\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_NoCache_List_Filter_Unicode(\n self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 12\n return [ 'πππππππ yummy πie' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ '†åsty_π.ππ' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 17 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [ { 'word': 'πππππππ yummy πie', 'equal': 1 } ],\n 'completion_start_column': 13\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_Cache_ObjectList_Unicode( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 12\n return [\n {\n 'word': 'ålpha∫et',\n 'abbr': 'å∫∫®',\n 'menu': 'µ´~¨á',\n 'info': '^~fo',\n 'kind': '˚'\n },\n {\n 'word': 'π†´ß†π',\n 'abbr': 'ÅııÂʉÍÊ',\n 'menu': '˜‰ˆËʉÍÊ',\n 'info': 'ȈÏØʉÍÊ',\n 'kind': 'Ê'\n }\n ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ '†åsty_π.ππ' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 17 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [ {\n 'word' : 'π†´ß†π',\n 'abbr' : 'ÅııÂʉÍÊ',\n 'menu' : '˜‰ˆËʉÍÊ',\n 'info' : 'ȈÏØʉÍÊ',\n 'kind' : 'Ê',\n 'equal': 1\n } ],\n 'completion_start_column': 13\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_Cache_ObjectListObject_Unicode(\n self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 12\n return {\n 'words': [\n {\n 'word': 'ålpha∫et',\n 'abbr': 'å∫∫®',\n 'menu': 'µ´~¨á',\n 'info': '^~fo',\n 'kind': '˚'\n },\n {\n 'word': 'π†´ß†π',\n 'abbr': 'ÅııÂʉÍÊ',\n 'menu': '˜‰ˆËʉÍÊ',\n 'info': 'ȈÏØʉÍÊ',\n 'kind': 'Ê'\n },\n {\n 'word': 'test',\n 'abbr': 'ÅııÂʉÍÊ',\n 'menu': '˜‰ˆËʉÍÊ',\n 'info': 'ȈÏØʉÍÊ',\n 'kind': 'Ê'\n }\n ]\n }\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ '†åsty_π.t' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 13 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': contains_exactly( {\n 'word' : 'test',\n 'abbr' : 'ÅııÂʉÍÊ',\n 'menu' : '˜‰ˆËʉÍÊ',\n 'info' : 'ȈÏØʉÍÊ',\n 'kind' : 'Ê',\n 'equal': 1\n }, {\n 'word' : 'ålpha∫et',\n 'abbr' : 'å∫∫®',\n 'menu' : 'µ´~¨á',\n 'info' : '^~fo',\n 'kind' : '˚',\n 'equal': 1\n } ),\n 'completion_start_column': 13\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_RestoreCursorPositionAfterOmnifuncCall(\n self, ycm ):\n\n # This omnifunc moves the cursor to the test definition like\n # ccomplete#Complete would.\n def Omnifunc( findstart, base ):\n vimsupport.SetCurrentLineAndColumn( 0, 0 )\n if findstart:\n return 5\n return [ 'length' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'String test',\n '',\n 'test.' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 3, 5 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n vimsupport.CurrentLineAndColumn(),\n contains_exactly( 2, 5 )\n )\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [ { 'word': 'length', 'equal': 1 } ],\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_MoveCursorPositionAtStartColumn(\n self, ycm ):\n # This omnifunc relies on the cursor being moved at the start column when\n # called the second time like LanguageClient#complete from the\n # LanguageClient-neovim plugin.\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n if vimsupport.CurrentColumn() == 5:\n return [ 'length' ]\n return []\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'String test',\n '',\n 'test.le' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 3, 7 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n vimsupport.CurrentLineAndColumn(),\n contains_exactly( 2, 7 )\n )\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [ { 'word': 'length', 'equal': 1 } ],\n 'completion_start_column': 6\n } )\n )\n\n\n def test_OmniCompleter_GetCompletions_StartColumnCompliance( self ):\n for omnifunc_start_column, ycm_completions, ycm_start_column in [\n [ -4, [ { 'word': 'foo', 'equal': 1 } ], 3 ],\n [ -3, [], 1 ],\n [ -2, [], 1 ],\n [ -1, [ { 'word': 'foo', 'equal': 1 } ], 3 ],\n [ 0, [ { 'word': 'foo', 'equal': 1 } ], 1 ],\n [ 1, [ { 'word': 'foo', 'equal': 1 } ], 2 ],\n [ 2, [ { 'word': 'foo', 'equal': 1 } ], 3 ],\n [ 3, [ { 'word': 'foo', 'equal': 1 } ], 3 ]\n ]:\n with youcompleteme_instance( { 'g:ycm_cache_omnifunc': 1 } ) as ycm:\n with self.subTest( omnifunc_start_column = omnifunc_start_column,\n ycm_completions = ycm_completions,\n ycm_start_column = ycm_start_column ):\n StartColumnCompliance( ycm,\n omnifunc_start_column,\n ycm_completions,\n ycm_start_column )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_NoCache_NoSemanticTrigger( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 0\n return [ 'test' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'te' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 3 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': empty(),\n 'completion_start_column': 1\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_NoCache_ForceSemantic( self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 0\n return [ 'test' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'te' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 3 ) ):\n ycm.SendCompletionRequest( force_semantic = True )\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [ { 'word': 'test', 'equal': 1 } ],\n 'completion_start_column': 1\n } )\n )\n\n\n @YouCompleteMeInstance( { 'g:ycm_cache_omnifunc': 1,\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_ConvertStringsToDictionaries(\n self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return [\n { 'word': 'a' },\n 'b'\n ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 7 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [\n { 'word': 'a', 'equal': 1 },\n { 'word': 'b', 'equal': 1 }\n ],\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( {\n 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_filetype_specific_completion_to_disable': { FILETYPE: 1 },\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_FiletypeDisabled_SemanticTrigger(\n self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return [ 'a', 'b', 'cdef' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 6 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': empty(),\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( {\n 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_filetype_specific_completion_to_disable': { '*': 1 },\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_AllFiletypesDisabled_SemanticTrigger(\n self, ycm ):\n\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return [ 'a', 'b', 'cdef' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 6 ) ):\n ycm.SendCompletionRequest()\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': empty(),\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( {\n 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_filetype_specific_completion_to_disable': { FILETYPE: 1 },\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_FiletypeDisabled_ForceSemantic(\n self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return [ 'a', 'b', 'cdef' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 6 ) ):\n ycm.SendCompletionRequest( force_semantic = True )\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [\n { 'word': 'a', 'equal': 1 },\n { 'word': 'b', 'equal': 1 },\n { 'word': 'cdef', 'equal': 1 }\n ],\n 'completion_start_column': 6\n } )\n )\n\n\n @YouCompleteMeInstance( {\n 'g:ycm_cache_omnifunc': 0,\n 'g:ycm_filetype_specific_completion_to_disable': { '*': 1 },\n 'g:ycm_semantic_triggers': TRIGGERS } )\n def test_OmniCompleter_GetCompletions_AllFiletypesDisabled_ForceSemantic(\n self, ycm ):\n def Omnifunc( findstart, base ):\n if findstart:\n return 5\n return [ 'a', 'b', 'cdef' ]\n\n current_buffer = VimBuffer( 'buffer',\n contents = [ 'test.' ],\n filetype = FILETYPE,\n omnifunc = Omnifunc )\n\n with MockVimBuffers( [ current_buffer ], [ current_buffer ], ( 1, 6 ) ):\n ycm.SendCompletionRequest( force_semantic = True )\n assert_that(\n ycm.GetCompletionResponse(),\n has_entries( {\n 'completions': [\n { 'word': 'a', 'equal': 1 },\n { 'word': 'b', 'equal': 1 },\n { 'word': 'cdef', 'equal': 1 }\n ],\n 'completion_start_column': 6\n } )\n )\n" }, { "path": "python/ycm/tests/paths_test.py", "content": "# Copyright (C) 2016-2017 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.tests.test_utils import MockVimModule\nMockVimModule()\n\nfrom hamcrest import assert_that\nfrom unittest import TestCase\nfrom ycm.paths import _EndsWithPython\n\n\ndef EndsWithPython_Good( path ):\n assert_that( _EndsWithPython( path ),\n f'Path { path } does not end with a Python name.' )\n\n\ndef EndsWithPython_Bad( path ):\n assert_that( not _EndsWithPython( path ),\n f'Path { path } does end with a Python name.' )\n\n\nclass PathTest( TestCase ):\n def test_EndsWithPython_Python3Paths( self ):\n for path in [\n 'python3',\n '/usr/bin/python3.6',\n '/home/user/.pyenv/shims/python3.6',\n r'C:\\Python36\\python.exe'\n ]:\n with self.subTest( path = path ):\n EndsWithPython_Good( path )\n\n\n def test_EndsWithPython_BadPaths( self ):\n for path in [\n None,\n '',\n '/opt/local/bin/vim',\n r'C:\\Program Files\\Vim\\vim74\\gvim.exe',\n '/usr/bin/python2.7',\n '/home/user/.pyenv/shims/python3.2',\n ]:\n with self.subTest( path = path ):\n EndsWithPython_Bad( path )\n" }, { "path": "python/ycm/tests/postcomplete_test.py", "content": "# encoding: utf-8\n#\n# Copyright (C) 2015-2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.tests.test_utils import MockVimModule\nMockVimModule()\n\nimport contextlib\nimport json\nfrom hamcrest import assert_that, contains_exactly, empty, equal_to, none\nfrom unittest import TestCase\nfrom unittest.mock import MagicMock, DEFAULT, patch\n\nfrom ycm import vimsupport\nfrom ycmd.utils import ToBytes\nfrom ycm.client.completion_request import ( CompletionRequest,\n _FilterToMatchingCompletions,\n _GetRequiredNamespaceImport )\nfrom ycm.client.omni_completion_request import OmniCompletionRequest\n\n\ndef CompleteItemIs( word, abbr = None, menu = None,\n info = None, kind = None, **kwargs ):\n item = {\n 'word': ToBytes( word ),\n 'abbr': ToBytes( abbr ),\n 'menu': ToBytes( menu ),\n 'info': ToBytes( info ),\n 'kind': ToBytes( kind ),\n }\n item.update( **kwargs )\n return item\n\n\ndef GetVariableValue_CompleteItemIs( word, abbr = None, menu = None,\n info = None, kind = None, **kwargs ):\n def Result( variable ):\n if variable == 'v:completed_item':\n return CompleteItemIs( word, abbr, menu, info, kind, **kwargs )\n return DEFAULT\n return MagicMock( side_effect = Result )\n\n\ndef BuildCompletion( insertion_text = 'Test',\n menu_text = None,\n extra_menu_info = None,\n detailed_info = None,\n kind = None,\n extra_data = None ):\n completion = {\n 'insertion_text': insertion_text\n }\n\n if extra_menu_info:\n completion[ 'extra_menu_info' ] = extra_menu_info\n if menu_text:\n completion[ 'menu_text' ] = menu_text\n if detailed_info:\n completion[ 'detailed_info' ] = detailed_info\n if kind:\n completion[ 'kind' ] = kind\n if extra_data:\n completion[ 'extra_data' ] = extra_data\n return completion\n\n\ndef BuildCompletionNamespace( namespace = None,\n insertion_text = 'Test',\n menu_text = None,\n extra_menu_info = None,\n detailed_info = None,\n kind = None ):\n return BuildCompletion( insertion_text = insertion_text,\n menu_text = menu_text,\n extra_menu_info = extra_menu_info,\n detailed_info = detailed_info,\n kind = kind,\n extra_data = {\n 'required_namespace_import': namespace\n } )\n\n\ndef BuildCompletionFixIt( fixits,\n insertion_text = 'Test',\n menu_text = None,\n extra_menu_info = None,\n detailed_info = None,\n kind = None ):\n return BuildCompletion( insertion_text = insertion_text,\n menu_text = menu_text,\n extra_menu_info = extra_menu_info,\n detailed_info = detailed_info,\n kind = kind,\n extra_data = {\n 'fixits': fixits,\n } )\n\n\n@contextlib.contextmanager\ndef _SetupForCsharpCompletionDone( completions ):\n with patch( 'ycm.vimsupport.InsertNamespace' ):\n with _SetUpCompleteDone( completions ) as request:\n yield request\n\n\n@contextlib.contextmanager\ndef _SetUpCompleteDone( completions ):\n with patch( 'ycm.vimsupport.TextBeforeCursor', return_value = ' Test' ):\n request = CompletionRequest( None )\n request.Done = MagicMock( return_value = True )\n request._RawResponse = MagicMock( return_value = {\n 'completions': completions\n } )\n yield request\n\n\nclass PostcompleteTest( TestCase ):\n @patch( 'ycm.vimsupport.CurrentFiletypes', return_value = [ 'ycmtest' ] )\n def test_OnCompleteDone_DefaultFixIt( self, *args ):\n request = CompletionRequest( None )\n request.Done = MagicMock( return_value = True )\n request._OnCompleteDone_Csharp = MagicMock()\n request._OnCompleteDone_FixIt = MagicMock()\n request.OnCompleteDone()\n request._OnCompleteDone_Csharp.assert_not_called()\n request._OnCompleteDone_FixIt.assert_called_once_with()\n\n\n @patch( 'ycm.vimsupport.CurrentFiletypes', return_value = [ 'cs' ] )\n def test_OnCompleteDone_CsharpFixIt( self, *args ):\n request = CompletionRequest( None )\n request.Done = MagicMock( return_value = True )\n request._OnCompleteDone_Csharp = MagicMock()\n request._OnCompleteDone_FixIt = MagicMock()\n request.OnCompleteDone()\n request._OnCompleteDone_Csharp.assert_called_once_with()\n request._OnCompleteDone_FixIt.assert_not_called()\n\n\n @patch( 'ycm.vimsupport.CurrentFiletypes', return_value = [ 'ycmtest' ] )\n def test_OnCompleteDone_NoFixItIfNotDone( self, *args ):\n request = CompletionRequest( None )\n request.Done = MagicMock( return_value = False )\n request._OnCompleteDone_Csharp = MagicMock()\n request._OnCompleteDone_FixIt = MagicMock()\n request.OnCompleteDone()\n request._OnCompleteDone_Csharp.assert_not_called()\n request._OnCompleteDone_FixIt.assert_not_called()\n\n\n @patch( 'ycm.vimsupport.CurrentFiletypes', return_value = [ 'ycmtest' ] )\n def test_OnCompleteDone_NoFixItForOmnifunc( self, *args ):\n request = OmniCompletionRequest( 'omnifunc', None )\n request.Done = MagicMock( return_value = True )\n request._OnCompleteDone_Csharp = MagicMock()\n request._OnCompleteDone_FixIt = MagicMock()\n request.OnCompleteDone()\n request._OnCompleteDone_Csharp.assert_not_called()\n request._OnCompleteDone_FixIt.assert_not_called()\n\n\n def test_FilterToCompletedCompletions_MatchIsReturned( self ):\n completions = [ BuildCompletion( insertion_text = 'Test' ) ]\n result = _FilterToMatchingCompletions( CompleteItemIs( 'Test' ),\n completions )\n assert_that( list( result ), contains_exactly( {} ) )\n\n\n def test_FilterToCompletedCompletions_ShortTextDoesntRaise( self ):\n completions = [ BuildCompletion( insertion_text = 'AAA' ) ]\n result = _FilterToMatchingCompletions( CompleteItemIs( 'A' ), completions )\n assert_that( list( result ), empty() )\n\n\n def test_FilterToCompletedCompletions_ExactMatchIsReturned( self ):\n completions = [ BuildCompletion( insertion_text = 'Test' ) ]\n result = _FilterToMatchingCompletions( CompleteItemIs( 'Test' ),\n completions )\n assert_that( list( result ), contains_exactly( {} ) )\n\n\n def test_FilterToCompletedCompletions_NonMatchIsntReturned( self ):\n completions = [ BuildCompletion( insertion_text = 'A' ) ]\n result = _FilterToMatchingCompletions( CompleteItemIs( ' Quote' ),\n completions )\n assert_that( list( result ), empty() )\n\n\n def test_FilterToCompletedCompletions_Unicode( self ):\n completions = [ BuildCompletion( insertion_text = '†es†' ) ]\n result = _FilterToMatchingCompletions( CompleteItemIs( '†es†' ),\n completions )\n assert_that( list( result ), contains_exactly( {} ) )\n\n\n def test_GetRequiredNamespaceImport_ReturnNoneForNoExtraData( self ):\n assert_that( _GetRequiredNamespaceImport( {} ), none() )\n\n\n def test_GetRequiredNamespaceImport_ReturnNamespaceFromExtraData( self ):\n namespace = 'A_NAMESPACE'\n assert_that( _GetRequiredNamespaceImport(\n BuildCompletionNamespace( namespace )[ 'extra_data' ] ),\n equal_to( namespace ) )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( 'Te' ) )\n def test_GetExtraDataUserMayHaveCompleted_ReturnEmptyIfPendingMatches(\n *args ):\n completions = [ BuildCompletionNamespace( None ) ]\n with _SetupForCsharpCompletionDone( completions ) as request:\n assert_that( request._GetExtraDataUserMayHaveCompleted(), empty() )\n\n\n def test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfExactMatches(\n self, *args ):\n info = [ 'NS', 'Test', 'Abbr', 'Menu', 'Info', 'Kind' ]\n completions = [ BuildCompletionNamespace( *info ) ]\n with _SetupForCsharpCompletionDone( completions ) as request:\n with patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( *info[ 1: ] ) ):\n assert_that( request._GetExtraDataUserMayHaveCompleted(),\n contains_exactly( completions[ 0 ][ 'extra_data' ] ) )\n\n\n def test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfExactMatchesEvenIfPartial( self ): # noqa\n info = [ 'NS', 'Test', 'Abbr', 'Menu', 'Info', 'Kind' ]\n completions = [ BuildCompletionNamespace( *info ),\n BuildCompletion( insertion_text = 'TestTest' ) ]\n with _SetupForCsharpCompletionDone( completions ) as request:\n with patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( *info[ 1: ] ) ):\n assert_that( request._GetExtraDataUserMayHaveCompleted(),\n contains_exactly( completions[ 0 ][ 'extra_data' ] ) )\n\n\n def test_GetExtraDataUserMayHaveCompleted_DontReturnMatchIfNoExactMatchesAndPartial( self ): # noqa\n info = [ 'NS', 'Test', 'Abbr', 'Menu', 'Info', 'Kind' ]\n completions = [ BuildCompletion( insertion_text = info[ 0 ] ),\n BuildCompletion( insertion_text = 'TestTest' ) ]\n with _SetupForCsharpCompletionDone( completions ) as request:\n with patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( *info[ 1: ] ) ):\n assert_that( request._GetExtraDataUserMayHaveCompleted(), empty() )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( 'Test' ) )\n def test_GetExtraDataUserMayHaveCompleted_ReturnMatchIfMatches( self, *args ):\n completions = [ BuildCompletionNamespace( None ) ]\n with _SetupForCsharpCompletionDone( completions ) as request:\n assert_that( request._GetExtraDataUserMayHaveCompleted(),\n contains_exactly( completions[ 0 ][ 'extra_data' ] ) )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs(\n 'Test',\n user_data=json.dumps( {\n 'required_namespace_import': 'namespace1' } ) ) )\n def test_GetExtraDataUserMayHaveCompleted_UseUserData0( self, *args ):\n # Identical completions but we specify the first one via user_data.\n completions = [\n BuildCompletionNamespace( 'namespace1' ),\n BuildCompletionNamespace( 'namespace2' )\n ]\n\n with _SetupForCsharpCompletionDone( completions ) as request:\n assert_that(\n request._GetExtraDataUserMayHaveCompleted(),\n contains_exactly(\n BuildCompletionNamespace( 'namespace1' )[ 'extra_data' ] ) )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs(\n 'Test',\n user_data=json.dumps( {\n 'required_namespace_import': 'namespace2' } ) ) )\n def test_GetExtraDataUserMayHaveCompleted_UseUserData1( self, *args ):\n # Identical completions but we specify the second one via user_data.\n completions = [\n BuildCompletionNamespace( 'namespace1' ),\n BuildCompletionNamespace( 'namespace2' )\n ]\n\n with _SetupForCsharpCompletionDone( completions ) as request:\n assert_that(\n request._GetExtraDataUserMayHaveCompleted(),\n contains_exactly(\n BuildCompletionNamespace( 'namespace2' )[ 'extra_data' ] ) )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( 'Test', user_data='' ) )\n def test_GetExtraDataUserMayHaveCompleted_EmptyUserData( self, *args ):\n # Identical completions but none is selected.\n completions = [\n BuildCompletionNamespace( 'namespace1' ),\n BuildCompletionNamespace( 'namespace2' )\n ]\n\n with _SetupForCsharpCompletionDone( completions ) as request:\n assert_that( request._GetExtraDataUserMayHaveCompleted(), empty() )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( 'Test' ) )\n def test_PostCompleteCsharp_EmptyDoesntInsertNamespace( self, *args ):\n with _SetupForCsharpCompletionDone( [] ) as request:\n request._OnCompleteDone_Csharp()\n assert_that( not vimsupport.InsertNamespace.called )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( 'Test' ) )\n def test_PostCompleteCsharp_ExistingWithoutNamespaceDoesntInsertNamespace(\n self, *args ):\n completions = [ BuildCompletionNamespace( None ) ]\n with _SetupForCsharpCompletionDone( completions ) as request:\n request._OnCompleteDone_Csharp()\n assert_that( not vimsupport.InsertNamespace.called )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( 'Test' ) )\n def test_PostCompleteCsharp_ValueDoesInsertNamespace( self, *args ):\n namespace = 'A_NAMESPACE'\n completions = [ BuildCompletionNamespace( namespace ) ]\n with _SetupForCsharpCompletionDone( completions ) as request:\n request._OnCompleteDone_Csharp()\n vimsupport.InsertNamespace.assert_called_once_with( namespace )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( 'Test' ) )\n @patch( 'ycm.vimsupport.PresentDialog', return_value = 1 )\n def test_PostCompleteCsharp_InsertSecondNamespaceIfSelected( self, *args ):\n namespace = 'A_NAMESPACE'\n namespace2 = 'ANOTHER_NAMESPACE'\n completions = [\n BuildCompletionNamespace( namespace ),\n BuildCompletionNamespace( namespace2 ),\n ]\n with _SetupForCsharpCompletionDone( completions ) as request:\n request._OnCompleteDone_Csharp()\n vimsupport.InsertNamespace.assert_called_once_with( namespace2 )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( 'Test' ) )\n @patch( 'ycm.vimsupport.ReplaceChunks' )\n def test_PostCompleteFixIt_ApplyFixIt_NoFixIts( self, replace_chunks, *args ):\n completions = [\n BuildCompletionFixIt( [] )\n ]\n with _SetUpCompleteDone( completions ) as request:\n request._OnCompleteDone_FixIt()\n replace_chunks.assert_not_called()\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( 'Test' ) )\n @patch( 'ycm.vimsupport.ReplaceChunks' )\n def test_PostCompleteFixIt_ApplyFixIt_EmptyFixIt(\n self, replace_chunks, *args ):\n completions = [\n BuildCompletionFixIt( [ { 'chunks': [] } ] )\n ]\n with _SetUpCompleteDone( completions ) as request:\n request._OnCompleteDone_FixIt()\n replace_chunks.assert_called_once_with( [], silent = True )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( 'Test' ) )\n @patch( 'ycm.vimsupport.ReplaceChunks' )\n def test_PostCompleteFixIt_ApplyFixIt_NoFixIt( self, replace_chunks, *args ):\n completions = [\n BuildCompletion()\n ]\n with _SetUpCompleteDone( completions ) as request:\n request._OnCompleteDone_FixIt()\n replace_chunks.assert_not_called()\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs( 'Test' ) )\n @patch( 'ycm.vimsupport.ReplaceChunks' )\n def test_PostCompleteFixIt_ApplyFixIt_PickFirst(\n self, replace_chunks, *args ):\n completions = [\n BuildCompletionFixIt( [ { 'chunks': 'one' } ] ),\n BuildCompletionFixIt( [ { 'chunks': 'two' } ] ),\n ]\n with _SetUpCompleteDone( completions ) as request:\n request._OnCompleteDone_FixIt()\n replace_chunks.assert_called_once_with( 'one', silent = True )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs(\n 'Test',\n user_data=json.dumps( { 'fixits': [ { 'chunks': 'one' } ] } ) ) )\n @patch( 'ycm.vimsupport.ReplaceChunks' )\n def test_PostCompleteFixIt_ApplyFixIt_PickFirstUserData( self,\n replace_chunks,\n *args ):\n completions = [\n BuildCompletionFixIt( [ { 'chunks': 'one' } ] ),\n BuildCompletionFixIt( [ { 'chunks': 'two' } ] ),\n ]\n with _SetUpCompleteDone( completions ) as request:\n request._OnCompleteDone_FixIt()\n replace_chunks.assert_called_once_with( 'one', silent = True )\n\n\n @patch( 'ycm.vimsupport.GetVariableValue',\n GetVariableValue_CompleteItemIs(\n 'Test',\n user_data=json.dumps( { 'fixits': [ { 'chunks': 'two' } ] } ) ) )\n @patch( 'ycm.vimsupport.ReplaceChunks' )\n def test_PostCompleteFixIt_ApplyFixIt_PickSecond(\n self, replace_chunks, *args ):\n completions = [\n BuildCompletionFixIt( [ { 'chunks': 'one' } ] ),\n BuildCompletionFixIt( [ { 'chunks': 'two' } ] ),\n ]\n with _SetUpCompleteDone( completions ) as request:\n request._OnCompleteDone_FixIt()\n replace_chunks.assert_called_once_with( 'two', silent = True )\n" }, { "path": "python/ycm/tests/signature_help_test.py", "content": "# Copyright (C) 2019 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom hamcrest import ( assert_that,\n empty )\nfrom unittest import TestCase\nfrom ycm import signature_help as sh\n\n\nclass SignatureHelpTest( TestCase ):\n def test_MakeSignatureHelpBuffer_Empty( self ):\n assert_that( sh._MakeSignatureHelpBuffer( {} ), empty() )\n assert_that( sh._MakeSignatureHelpBuffer( {\n 'activeSignature': 0,\n 'activeParameter': 0,\n 'signatures': []\n } ), empty() )\n assert_that( sh._MakeSignatureHelpBuffer( {\n 'activeSignature': 0,\n 'activeParameter': 0,\n } ), empty() )\n assert_that( sh._MakeSignatureHelpBuffer( {\n 'signatures': []\n } ), empty() )\n" }, { "path": "python/ycm/tests/syntax_parse_test.py", "content": "# Copyright (C) 2013 Google Inc.\n# 2016 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom ycm.tests.test_utils import MockVimModule\nMockVimModule()\n\nimport os\nfrom hamcrest import assert_that, contains_inanyorder, has_item, has_items\nfrom unittest import TestCase\nfrom ycm import syntax_parse\nfrom ycmd.utils import ReadFile\n\n\ndef ContentsOfTestFile( test_file ):\n dir_of_script = os.path.dirname( os.path.abspath( __file__ ) )\n full_path_to_test_file = os.path.join( dir_of_script, 'testdata', test_file )\n return ReadFile( full_path_to_test_file )\n\n\nclass SyntaxTest( TestCase ):\n def test_KeywordsFromSyntaxListOutput_PythonSyntax( self ):\n expected_keywords = ( 'bytearray', 'IndexError', 'all', 'help', 'vars',\n 'SyntaxError', 'global', 'elif', 'unicode', 'sorted', 'memoryview',\n 'isinstance', 'except', 'nonlocal', 'NameError', 'finally',\n 'BytesWarning', 'dict', 'IOError', 'pass', 'oct', 'bin', 'SystemExit',\n 'return', 'StandardError', 'format', 'TabError', 'break', 'next',\n 'not', 'UnicodeDecodeError', 'False', 'RuntimeWarning', 'list', 'iter',\n 'try', 'reload', 'Warning', 'round', 'dir', 'cmp', 'set', 'bytes',\n 'UnicodeTranslateError', 'intern', 'issubclass', 'yield', 'Ellipsis',\n 'hash', 'locals', 'BufferError', 'slice', 'for', 'FloatingPointError',\n 'sum', 'VMSError', 'getattr', 'abs', 'print', 'import', 'True',\n 'FutureWarning', 'ImportWarning', 'None', 'EOFError', 'len',\n 'frozenset', 'ord', 'super', 'raise', 'TypeError', 'KeyboardInterrupt',\n 'UserWarning', 'filter', 'range', 'staticmethod', 'SystemError', 'or',\n 'BaseException', 'pow', 'RuntimeError', 'float', 'MemoryError',\n 'StopIteration', 'globals', 'divmod', 'enumerate', 'apply',\n 'LookupError', 'open', 'basestring', 'from', 'UnicodeError', 'zip',\n 'hex', 'long', 'IndentationError', 'int', 'chr', '__import__', 'type',\n 'Exception', 'continue', 'tuple', 'reduce', 'reversed', 'else',\n 'assert', 'UnicodeEncodeError', 'input', 'with', 'hasattr', 'delattr',\n 'setattr', 'raw_input', 'PendingDeprecationWarning', 'compile',\n 'ArithmeticError', 'while', 'del', 'str', 'property', 'def', 'and',\n 'GeneratorExit', 'ImportError', 'xrange', 'is', 'EnvironmentError',\n 'KeyError', 'coerce', 'SyntaxWarning', 'file', 'in', 'unichr', 'ascii',\n 'any', 'as', 'if', 'OSError', 'DeprecationWarning', 'min',\n 'UnicodeWarning', 'execfile', 'id', 'complex', 'bool', 'ValueError',\n 'NotImplemented', 'map', 'exec', 'buffer', 'max', 'class', 'object',\n 'repr', 'callable', 'ZeroDivisionError', 'eval', '__debug__',\n 'ReferenceError', 'AssertionError', 'classmethod', 'UnboundLocalError',\n 'NotImplementedError', 'lambda', 'AttributeError', 'OverflowError',\n 'WindowsError' )\n\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput(\n ContentsOfTestFile( 'python_syntax' ) ),\n contains_inanyorder( *expected_keywords ) )\n\n\n def test_KeywordsFromSyntaxListOutput_CppSyntax( self ):\n expected_keywords = (\n 'int_fast32_t', 'FILE', 'size_t', 'bitor', 'typedef', 'const', 'struct',\n 'uint8_t', 'fpos_t', 'thread_local', 'unsigned', 'uint_least16_t', 'do',\n 'intptr_t', 'uint_least64_t', 'return', 'auto', 'void', '_Complex',\n 'break', '_Alignof', 'not', 'using', '_Static_assert', '_Thread_local',\n 'public', 'uint_fast16_t', 'this', 'continue', 'char32_t', 'int16_t',\n 'intmax_t', 'static', 'clock_t', 'sizeof', 'int_fast64_t', 'mbstate_t',\n 'try', 'xor', 'uint_fast32_t', 'int_least8_t', 'div_t', 'volatile',\n 'template', 'char16_t', 'new', 'ldiv_t', 'int_least16_t', 'va_list',\n 'uint_least8_t', 'goto', 'noreturn', 'enum', 'static_assert', 'bitand',\n 'compl', 'imaginary', 'jmp_buf', 'throw', 'asm', 'ptrdiff_t', 'uint16_t',\n 'or', 'uint_fast8_t', '_Bool', 'int32_t', 'float', 'private', 'restrict',\n 'wint_t', 'operator', 'not_eq', '_Imaginary', 'alignas', 'union', 'long',\n 'uint_least32_t', 'int_least64_t', 'friend', 'uintptr_t', 'int8_t',\n 'else', 'export', 'int_fast8_t', 'catch', 'true', 'case', 'default',\n 'double', '_Noreturn', 'signed', 'typename', 'while', 'protected',\n 'wchar_t', 'wctrans_t', 'uint64_t', 'delete', 'and', 'register', 'false',\n 'int', 'uintmax_t', 'off_t', 'char', 'int64_t', 'int_fast16_t', 'DIR',\n '_Atomic', 'time_t', 'xor_eq', 'namespace', 'virtual', 'complex', 'bool',\n 'mutable', 'if', 'int_least32_t', 'sig_atomic_t', 'and_eq', 'ssize_t',\n 'alignof', '_Alignas', '_Generic', 'extern', 'class', 'typeid', 'short',\n 'for', 'uint_fast64_t', 'wctype_t', 'explicit', 'or_eq', 'switch',\n 'uint32_t', 'inline' )\n\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput(\n ContentsOfTestFile( 'cpp_syntax' ) ),\n contains_inanyorder( *expected_keywords ) )\n\n\n def test_KeywordsFromSyntaxListOutput_JavaSyntax( self ):\n expected_keywords = (\n 'code', 'text', 'cols', 'datetime', 'disabled', 'shape', 'codetype',\n 'alt', 'compact', 'style', 'valuetype', 'short', 'finally', 'continue',\n 'extends', 'valign', 'bordercolor', 'do', 'return', 'rel', 'rules',\n 'void', 'nohref', 'abbr', 'background', 'scrolling', 'instanceof',\n 'name', 'summary', 'try', 'default', 'noshade', 'coords', 'dir', 'frame',\n 'usemap', 'ismap', 'static', 'hspace', 'vlink', 'for', 'selected', 'rev',\n 'vspace', 'content', 'method', 'version', 'volatile', 'above', 'new',\n 'charoff', 'public', 'alink', 'enum', 'codebase', 'if', 'noresize',\n 'interface', 'checked', 'byte', 'super', 'throw', 'src', 'language',\n 'package', 'standby', 'script', 'longdesc', 'maxlength', 'cellpadding',\n 'throws', 'tabindex', 'color', 'colspan', 'accesskey', 'float', 'while',\n 'private', 'height', 'boolean', 'wrap', 'prompt', 'nowrap', 'size',\n 'rows', 'span', 'clip', 'bgcolor', 'top', 'long', 'start', 'scope',\n 'scheme', 'type', 'final', 'lang', 'visibility', 'else', 'assert',\n 'transient', 'link', 'catch', 'true', 'serializable', 'target', 'lowsrc',\n 'this', 'double', 'align', 'value', 'cite', 'headers', 'below',\n 'protected', 'declare', 'classid', 'defer', 'false', 'synchronized',\n 'int', 'abstract', 'accept', 'hreflang', 'char', 'border', 'id',\n 'native', 'rowspan', 'charset', 'archive', 'strictfp', 'readonly',\n 'axis', 'cellspacing', 'profile', 'multiple', 'object', 'action',\n 'pagex', 'pagey', 'marginheight', 'data', 'class', 'frameborder',\n 'enctype', 'implements', 'break', 'gutter', 'url', 'clear', 'face',\n 'switch', 'marginwidth', 'width', 'left' )\n\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput(\n ContentsOfTestFile( 'java_syntax' ) ),\n contains_inanyorder( *expected_keywords ) )\n\n\n def test_KeywordsFromSyntaxListOutput_PhpSyntax_ContainsFunctions( self ):\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput(\n ContentsOfTestFile( 'php_syntax' ) ),\n has_items( 'array_change_key_case' ) )\n\n\n def test_KeywordsFromSyntaxListOutput_PhpSyntax_ContainsPreProc( self ):\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput(\n ContentsOfTestFile( 'php_syntax' ) ),\n has_items( 'skip', 'function' ) )\n\n\n def test_KeywordsFromSyntaxListOutput_Basic( self ):\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput( \"\"\"\nfoogroup xxx foo bar\n zoo goo\n links to Statement\"\"\" ),\n contains_inanyorder( 'foo', 'bar', 'zoo', 'goo' ) )\n\n\n def test_KeywordsFromSyntaxListOutput_Function( self ):\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput( \"\"\"\nfoogroup xxx foo bar\n zoo goo\n links to Function\"\"\" ),\n contains_inanyorder( 'foo', 'bar', 'zoo', 'goo' ) )\n\n\n def test_KeywordsFromSyntaxListOutput_ContainedArgAllowed( self ):\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput( \"\"\"\nphpFunctions xxx contained gzclose yaz_syntax html_entity_decode fbsql_read_blob png2wbmp mssql_init cpdf_set_title gztell fbsql_insert_id empty cpdf_restore mysql_field_type closelog swftext ldap_search curl_errno gmp_div_r mssql_data_seek getmyinode printer_draw_pie mcve_initconn ncurses_getmaxyx defined\n contained replace_child has_attributes specified insertdocument assign node_name hwstat addshape get_attribute_node html_dump_mem userlist\n links to Function\"\"\" ), # noqa\n has_items( 'gzclose', 'userlist', 'ldap_search' ) )\n\n\n def test_KeywordsFromSyntaxListOutput_JunkIgnored( self ):\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput( \"\"\"\n--- Syntax items ---\nfoogroup xxx foo bar\n zoo goo\n links to Statement\nSpell cluster=NONE\nNoSpell cluster=NONE\"\"\" ),\n contains_inanyorder( 'foo', 'bar', 'zoo', 'goo' ) )\n\n\n def test_KeywordsFromSyntaxListOutput_MultipleStatementGroups( self ):\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput( \"\"\"\nfoogroup xxx foo bar\n links to Statement\nbargroup xxx zoo goo\n links to Statement\"\"\" ),\n contains_inanyorder( 'foo', 'bar', 'zoo', 'goo' ) )\n\n\n def test_KeywordsFromSyntaxListOutput_StatementAndTypeGroups( self ):\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput( \"\"\"\nfoogroup xxx foo bar\n links to Statement\nbargroup xxx zoo goo\n links to Type\"\"\" ),\n contains_inanyorder( 'foo', 'bar', 'zoo', 'goo' ) )\n\n\n def test_KeywordsFromSyntaxListOutput_StatementHierarchy( self ):\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput( \"\"\"\nbaa xxx foo bar\n links to Foo\nFoo xxx zoo goo\n links to Bar\nBar xxx qux moo\n links to Statement\"\"\" ),\n contains_inanyorder( 'foo', 'bar', 'zoo',\n 'goo', 'qux', 'moo' ) )\n\n\n def test_KeywordsFromSyntaxListOutput_TypeHierarchy( self ):\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput( \"\"\"\nbaa xxx foo bar\n links to Foo\nFoo xxx zoo goo\n links to Bar\nBar xxx qux moo\n links to Type\"\"\" ),\n contains_inanyorder( 'foo', 'bar', 'zoo',\n 'goo', 'qux', 'moo' ) )\n\n\n def test_KeywordsFromSyntaxListOutput_StatementAndTypeHierarchy( self ):\n assert_that( syntax_parse._KeywordsFromSyntaxListOutput( \"\"\"\ntBaa xxx foo bar\n links to tFoo\ntFoo xxx zoo goo\n links to tBar\ntBar xxx qux moo\n links to Type\nsBaa xxx na bar\n links to sFoo\nsFoo xxx zoo nb\n links to sBar\nsBar xxx qux nc\n links to Statement\"\"\" ),\n contains_inanyorder( 'foo', 'bar', 'zoo', 'goo', 'qux', 'moo',\n 'na', 'nb', 'nc' ) )\n\n\n def test_SyntaxGroupsFromOutput_Basic( self ):\n assert_that( syntax_parse._SyntaxGroupsFromOutput( \"\"\"\nfoogroup xxx foo bar\n zoo goo\n links to Statement\"\"\" ),\n has_item( 'foogroup' ) )\n\n\n def test_ExtractKeywordsFromGroup_Basic( self ):\n assert_that( syntax_parse._ExtractKeywordsFromGroup(\n syntax_parse.SyntaxGroup( '', [\n 'foo bar',\n 'zoo goo',\n ] ) ),\n contains_inanyorder( 'foo', 'bar', 'zoo', 'goo' ) )\n\n\n def test_ExtractKeywordsFromGroup_Commas( self ):\n assert_that( syntax_parse._ExtractKeywordsFromGroup(\n syntax_parse.SyntaxGroup( '', [\n 'foo, bar,',\n 'zoo goo',\n ] ) ),\n contains_inanyorder( 'foo', 'bar', 'zoo', 'goo' ) )\n\n\n def test_ExtractKeywordsFromGroup_WithLinksTo( self ):\n assert_that( syntax_parse._ExtractKeywordsFromGroup(\n syntax_parse.SyntaxGroup( '', [\n 'foo bar',\n 'zoo goo',\n 'links to Statement'\n ] ) ),\n contains_inanyorder( 'foo', 'bar', 'zoo', 'goo' ) )\n\n\n def test_ExtractKeywordsFromGroup_KeywordStarts( self ):\n assert_that( syntax_parse._ExtractKeywordsFromGroup(\n syntax_parse.SyntaxGroup( '', [\n 'foo bar',\n 'contained boo baa',\n 'zoo goo',\n ] ) ),\n contains_inanyorder( 'foo', 'bar', 'boo',\n 'baa', 'zoo', 'goo' ) )\n\n\n def test_ExtractKeywordsFromGroup_KeywordMiddle( self ):\n assert_that( syntax_parse._ExtractKeywordsFromGroup(\n syntax_parse.SyntaxGroup( '', [\n 'foo contained bar',\n 'zoo goo'\n ] ) ),\n contains_inanyorder( 'foo', 'contained',\n 'bar', 'zoo', 'goo' ) )\n\n\n def test_ExtractKeywordsFromGroup_KeywordAssign( self ):\n assert_that( syntax_parse._ExtractKeywordsFromGroup(\n syntax_parse.SyntaxGroup( '', [\n 'nextgroup=zoo skipwhite foo bar',\n 'zoo goo',\n ] ) ),\n contains_inanyorder( 'foo', 'bar', 'zoo', 'goo' ) )\n\n\n def test_ExtractKeywordsFromGroup_KeywordAssignAndMiddle( self ):\n assert_that( syntax_parse._ExtractKeywordsFromGroup(\n syntax_parse.SyntaxGroup( '', [\n 'nextgroup=zoo foo skipnl bar',\n 'zoo goo',\n ] ) ),\n contains_inanyorder( 'foo', 'skipnl', 'bar', 'zoo', 'goo' ) )\n\n\n def test_ExtractKeywordsFromGroup_KeywordWithoutNextgroup( self ):\n assert_that( syntax_parse._ExtractKeywordsFromGroup(\n syntax_parse.SyntaxGroup( '', [\n 'skipempty foo bar',\n 'zoo goo',\n ] ) ),\n contains_inanyorder( 'skipempty', 'foo',\n 'bar', 'zoo', 'goo' ) )\n\n\n def test_ExtractKeywordsFromGroup_ContainedSyntaxArgAllowed( self ):\n assert_that( syntax_parse._ExtractKeywordsFromGroup(\n syntax_parse.SyntaxGroup( '', [\n 'contained foo zoq',\n 'contained bar goo',\n 'far'\n ] ) ),\n contains_inanyorder( 'foo', 'zoq', 'bar', 'goo', 'far' ) )\n" }, { "path": "python/ycm/tests/test_utils.py", "content": "# Copyright (C) 2011-2019 YouCompleteMe contributors\n#\n# This file is part of YouCompleteMe.\n#\n# YouCompleteMe is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# YouCompleteMe is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with YouCompleteMe. If not, see .\n\nfrom collections import defaultdict, namedtuple\nfrom unittest.mock import DEFAULT, MagicMock, patch\nfrom unittest import skip\nfrom hamcrest import ( assert_that,\n contains_exactly,\n contains_inanyorder,\n equal_to )\nimport contextlib\nimport functools\nimport json\nimport os\nimport re\nimport sys\n\nfrom unittest import skipIf\n\nfrom ycmd.utils import GetCurrentDirectory, OnMac, OnWindows, ToUnicode\n\n\nBUFNR_REGEX = re.compile(\n '^bufnr\\\\( \\'(?P.+)\\'(, ([01]))? \\\\)$' )\nBUFWINNR_REGEX = re.compile( '^bufwinnr\\\\( (?P[0-9]+) \\\\)$' )\nBWIPEOUT_REGEX = re.compile(\n '^(?:silent! )bwipeout!? (?P[0-9]+)$' )\nGETBUFVAR_REGEX = re.compile(\n '^getbufvar\\\\((?P[0-9]+), \"(?P