1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
|
#!/usr/bin/env python3
from tempfile import mkdtemp
import argparse
import errno
import hashlib
import multiprocessing
import os
import os.path as p
import platform
import re
import shlex
import shutil
import subprocess
import sys
import sysconfig
import tarfile
from zipfile import ZipFile
import tempfile
import urllib.request
class InstallationFailed( Exception ):
def __init__( self, message = None, exit_code = 1 ):
self.message = message
self.exit_code = exit_code
def Print( self ):
if self.message:
print( '', file = sys.stderr )
print( self.message, file = sys.stderr )
def Exit( self ):
sys.exit( self.exit_code )
IS_MSYS = 'MSYS' == os.environ.get( 'MSYSTEM' )
IS_64BIT = sys.maxsize > 2**32
PY_MAJOR, PY_MINOR = sys.version_info[ 0 : 2 ]
PY_VERSION = sys.version_info[ 0 : 3 ]
if PY_VERSION < ( 3, 8, 0 ):
sys.exit( 'ycmd requires Python >= 3.8.0; '
'your version of Python is ' + sys.version +
'\nHint: Try running python3 ' + ' '.join( sys.argv ) )
DIR_OF_THIS_SCRIPT = p.dirname( p.abspath( __file__ ) )
DIR_OF_THIRD_PARTY = p.join( DIR_OF_THIS_SCRIPT, 'third_party' )
LIBCLANG_DIR = p.join( DIR_OF_THIRD_PARTY, 'clang', 'lib' )
for folder in os.listdir( DIR_OF_THIRD_PARTY ):
abs_folder_path = p.join( DIR_OF_THIRD_PARTY, folder )
if p.isdir( abs_folder_path ) and not os.listdir( abs_folder_path ):
sys.exit(
f'ERROR: folder { folder } in { DIR_OF_THIRD_PARTY } is empty; '
'you probably forgot to run:\n'
'\tgit submodule update --init --recursive\n'
)
NO_DYNAMIC_PYTHON_ERROR = (
'ERROR: found static Python library ({library}) but a dynamic one is '
'required. You must use a Python compiled with the {flag} flag. '
'If using pyenv, you need to run the command:\n'
' export PYTHON_CONFIGURE_OPTS="{flag}"\n'
'before installing a Python version.' )
NO_PYTHON_LIBRARY_ERROR = 'ERROR: unable to find an appropriate Python library.'
NO_PYTHON_HEADERS_ERROR = 'ERROR: Python headers are missing in {include_dir}.'
# Regular expressions used to find static and dynamic Python libraries.
# Notes:
# - Python 3 library name may have an 'm' suffix on Unix platforms, for
# instance libpython3.6m.so;
# - the linker name (the soname without the version) does not always
# exist so we look for the versioned names too;
# - on Windows, the .lib extension is used instead of the .dll one. See
# https://en.wikipedia.org/wiki/Dynamic-link_library#Import_libraries
STATIC_PYTHON_LIBRARY_REGEX = '^libpython{major}\\.{minor}m?\\.a$'
DYNAMIC_PYTHON_LIBRARY_REGEX = """
^(?:
# Linux, BSD
libpython{major}\\.{minor}m?\\.so(\\.\\d+)*|
# OS X
libpython{major}\\.{minor}m?\\.dylib|
# Windows
python{major}{minor}\\.lib|
# Cygwin
libpython{major}\\.{minor}\\.dll\\.a
)$
"""
JDTLS_MILESTONE = '1.36.0'
JDTLS_BUILD_STAMP = '202405301306'
JDTLS_SHA256 = (
'028e274d06f4a61cad4ffd56f89ef414a8f65613c6d05d9467651b7fb03dae7b'
)
DEFAULT_RUST_TOOLCHAIN = 'nightly-2024-06-11'
RUST_ANALYZER_DIR = p.join( DIR_OF_THIRD_PARTY, 'rust-analyzer' )
BUILD_ERROR_MESSAGE = (
'ERROR: the build failed.\n\n'
'NOTE: it is *highly* unlikely that this is a bug but rather '
'that this is a problem with the configuration of your system '
'or a missing dependency. Please carefully read CONTRIBUTING.md '
'and if you\'re sure that it is a bug, please raise an issue on the '
'issue tracker, including the entire output of this script (with --verbose) '
'and the invocation line used to run it.' )
CLANGD_VERSION = '19.1.0'
CLANGD_BINARIES_ERROR_MESSAGE = (
'No prebuilt Clang {version} binaries for {platform}. '
'You\'ll have to compile Clangd {version} from source '
'or use your system Clangd. '
'See the YCM docs for details on how to use a custom Clangd.' )
ACCEPTABLE_MSVC_VERSIONS = [ 17, 16, 15 ]
def UseVsWhere( quiet, vswhere_args ):
if not quiet:
print( "Calling", *vswhere_args )
latest_full_v = subprocess.check_output( vswhere_args ).strip().decode()
if '.' in latest_full_v:
try:
latest_v = int( latest_full_v.split( '.' )[ 0 ] )
except ValueError:
raise ValueError( f"{ latest_full_v } is not a version number." )
if not quiet:
print( f'vswhere -latest returned version { latest_full_v }' )
if latest_v not in ACCEPTABLE_MSVC_VERSIONS:
if latest_v > 17:
if not quiet:
print( f'MSVC Version { latest_full_v } is newer than expected.' )
else:
raise ValueError(
f'vswhere returned { latest_full_v } which is unexpected.'
'Pass --msvc <version> argument.' )
return latest_v
else:
if not quiet:
print( f'vswhere returned nothing usable: "{ latest_full_v }"' )
return None
def FindLatestMSVC( quiet, preview=False ):
VSWHERE_EXE = os.path.join( os.environ[ 'ProgramFiles(x86)' ],
'Microsoft Visual Studio',
'Installer', 'vswhere.exe' )
if os.path.exists( VSWHERE_EXE ):
vswhere_args = [ VSWHERE_EXE,
'-latest', '-property', 'installationVersion' ]
if preview:
vswhere_args.append( '-prerelease' )
if msvc := UseVsWhere( quiet, vswhere_args ):
return msvc
if not quiet:
print( 'Retrying vswhere for Build Tools' )
vswhere_args += [ '-products', 'Microsoft.VisualStudio.Product.BuildTools' ]
if msvc := UseVsWhere( quiet, vswhere_args ):
return msvc
# Fall back to registry parsing, which works at least until MSVC 2019 (16)
# but is likely failing on MSVC 2022 (17)
if not quiet:
print( "vswhere method failed, falling back to searching the registry" )
import winreg
handle = winreg.ConnectRegistry( None, winreg.HKEY_LOCAL_MACHINE )
msvc = None
for i in ACCEPTABLE_MSVC_VERSIONS:
if not quiet:
print( 'Trying to find '
rf'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\{ i }.0' )
try:
winreg.OpenKey( handle, rf'SOFTWARE\Microsoft\VisualStudio\{ i }.0' )
if not quiet:
print( f"Found MSVC version { i }" )
msvc = i
break
except FileNotFoundError:
pass
return msvc
def RemoveDirectory( directory ):
try_number = 0
max_tries = 10
while try_number < max_tries:
try:
shutil.rmtree( directory )
return
except OSError:
try_number += 1
raise RuntimeError(
f'Cannot remove directory { directory } after { max_tries } tries.' )
def RemoveDirectoryIfExists( directory_path ):
if p.exists( directory_path ):
RemoveDirectory( directory_path )
def MakeCleanDirectory( directory_path ):
RemoveDirectoryIfExists( directory_path )
os.makedirs( directory_path )
def CheckFileIntegrity( file_path, check_sum ):
with open( file_path, 'rb' ) as existing_file:
existing_sha256 = hashlib.sha256( existing_file.read() ).hexdigest()
return existing_sha256 == check_sum
def DownloadFileTo( download_url, file_path ):
with urllib.request.urlopen( download_url ) as response:
with open( file_path, 'wb' ) as package_file:
package_file.write( response.read() )
def OnMac():
return platform.system() == 'Darwin'
def OnWindows():
return platform.system() == 'Windows'
def OnAArch64():
return platform.machine().lower().startswith( 'aarch64' )
def OnArm():
return platform.machine().lower().startswith( 'arm' )
def OnX86_64():
return platform.machine().lower().startswith( 'x86_64' )
def FindExecutableOrDie( executable, message ):
path = FindExecutable( executable )
if not path:
raise InstallationFailed(
f"ERROR: Unable to find executable '{ executable }'. { message }" )
return path
# On Windows, distutils.spawn.find_executable only works for .exe files
# but .bat and .cmd files are also executables, so we use our own
# implementation.
def FindExecutable( executable ):
# Executable extensions used on Windows
WIN_EXECUTABLE_EXTS = [ '.exe', '.bat', '.cmd' ]
paths = os.environ[ 'PATH' ].split( os.pathsep )
base, extension = os.path.splitext( executable )
if OnWindows() and extension.lower() not in WIN_EXECUTABLE_EXTS:
extensions = WIN_EXECUTABLE_EXTS
else:
extensions = [ '' ]
for extension in extensions:
executable_name = executable + extension
if not os.path.isfile( executable_name ):
for path in paths:
executable_path = p.join( path, executable_name )
if os.path.isfile( executable_path ):
return executable_path
else:
return executable_name
return None
def PathToFirstExistingExecutable( executable_name_list ):
for executable_name in executable_name_list:
path = FindExecutable( executable_name )
if path:
return path
return None
def NumCores():
ycm_cores = os.environ.get( 'YCM_CORES' )
if ycm_cores:
return int( ycm_cores )
try:
return multiprocessing.cpu_count()
except NotImplementedError:
return 1
def CheckCall( args, **kwargs ):
quiet = kwargs.pop( 'quiet', False )
status_message = kwargs.pop( 'status_message', None )
if quiet:
_CheckCallQuiet( args, status_message, **kwargs )
else:
_CheckCall( args, **kwargs )
def _CheckCallQuiet( args, status_message, **kwargs ):
if status_message:
print( status_message + '...', flush = True, end = '' )
with tempfile.NamedTemporaryFile() as temp_file:
_CheckCall( args, stdout=temp_file, stderr=subprocess.STDOUT, **kwargs )
if status_message:
print( "OK" )
def _CheckCall( args, **kwargs ):
exit_message = kwargs.pop( 'exit_message', None )
stdout = kwargs.get( 'stdout', None )
on_failure = kwargs.pop( 'on_failure', None )
try:
subprocess.check_call( args, **kwargs )
except subprocess.CalledProcessError as error:
if stdout is not None:
stdout.seek( 0 )
print( stdout.read().decode( 'utf-8' ) )
print( "FAILED" )
if on_failure:
on_failure( exit_message, error.returncode )
elif exit_message:
raise InstallationFailed( exit_message )
else:
raise InstallationFailed( exit_code = error.returncode )
def GetGlobalPythonPrefix():
# In a virtualenv, sys.real_prefix points to the parent Python prefix.
if hasattr( sys, 'real_prefix' ):
return sys.real_prefix
# In a pyvenv (only available on Python 3), sys.base_prefix points to the
# parent Python prefix. Outside a pyvenv, it is equal to sys.prefix.
return sys.base_prefix
def GetPossiblePythonLibraryDirectories():
prefix = GetGlobalPythonPrefix()
if OnWindows() and not IS_MSYS:
return [ p.join( prefix, 'libs' ) ]
# On pyenv and some distributions, there is no Python dynamic library in the
# directory returned by the LIBPL variable. Such library can be found in the
# "lib" or "lib64" folder of the base Python installation.
return [
sysconfig.get_config_var( 'LIBPL' ),
p.join( prefix, 'lib64' ),
p.join( prefix, 'lib/64' ),
p.join( prefix, 'lib' )
]
def FindPythonLibraries():
include_dir = sysconfig.get_config_var( 'INCLUDEPY' )
if not p.isfile( p.join( include_dir, 'Python.h' ) ):
raise InstallationFailed(
NO_PYTHON_HEADERS_ERROR.format( include_dir = include_dir ) )
library_dirs = GetPossiblePythonLibraryDirectories()
# Since ycmd is compiled as a dynamic library, we can't link it to a Python
# static library. If we try, the following error will occur on Mac:
#
# Fatal Python error: PyThreadState_Get: no current thread
#
# while the error happens during linking on Linux and looks something like:
#
# relocation R_X86_64_32 against `a local symbol' can not be used when
# making a shared object; recompile with -fPIC
#
# On Windows, the Python library is always a dynamic one (an import library to
# be exact). To obtain a dynamic library on other platforms, Python must be
# compiled with the --enable-shared flag on Linux or the --enable-framework
# flag on Mac.
#
# So we proceed like this:
# - look for a dynamic library and return its path;
# - if a static library is found instead, raise an error with instructions
# on how to build Python as a dynamic library.
# - if no libraries are found, raise a generic error.
dynamic_name = re.compile( DYNAMIC_PYTHON_LIBRARY_REGEX.format(
major = PY_MAJOR, minor = PY_MINOR ), re.X )
static_name = re.compile( STATIC_PYTHON_LIBRARY_REGEX.format(
major = PY_MAJOR, minor = PY_MINOR ), re.X )
static_libraries = []
for library_dir in library_dirs:
if not p.exists( library_dir ):
continue
# Files are sorted so that we found the non-versioned Python library before
# the versioned one.
for filename in sorted( os.listdir( library_dir ) ):
if dynamic_name.match( filename ):
return p.join( library_dir, filename ), include_dir
if static_name.match( filename ):
static_libraries.append( p.join( library_dir, filename ) )
if static_libraries and not OnWindows():
dynamic_flag = ( '--enable-framework' if OnMac() else
'--enable-shared' )
raise InstallationFailed(
NO_DYNAMIC_PYTHON_ERROR.format( library = static_libraries[ 0 ],
flag = dynamic_flag ) )
raise InstallationFailed( NO_PYTHON_LIBRARY_ERROR )
def CustomPythonCmakeArgs( args ):
# The CMake 'FindPythonLibs' Module does not work properly.
# So we are forced to do its job for it.
if not args.quiet:
print( f'Searching Python { PY_MAJOR }.{ PY_MINOR } libraries...' )
python_library, python_include = FindPythonLibraries()
if not args.quiet:
print( f'Found Python library: { python_library }' )
print( f'Found Python headers folder: { python_include }' )
return [
f'-DPython3_LIBRARY={ python_library }',
f'-DPython3_EXECUTABLE={ sys.executable }',
f'-DPython3_INCLUDE_DIR={ python_include }'
]
def GetGenerator( args ):
if args.ninja:
return 'Ninja'
if OnWindows() and not IS_MSYS:
# The architecture must be specified through the -A option for the Visual
# Studio 16 generator.
if args.msvc == 16:
return 'Visual Studio 16'
if args.msvc == 17:
return 'Visual Studio 17 2022'
return f"Visual Studio { args.msvc }{ ' Win64' if IS_64BIT else '' }"
return 'Unix Makefiles'
def ParseArguments():
parser = argparse.ArgumentParser()
parser.add_argument( '--clang-completer', action = 'store_true',
help = 'Enable C-family semantic completion engine '
'through libclang.' )
parser.add_argument( '--clangd-completer', action = 'store_true',
help = 'Enable C-family semantic completion engine '
'through clangd lsp server.(EXPERIMENTAL)' )
parser.add_argument( '--cs-completer', action = 'store_true',
help = 'Enable C# semantic completion engine.' )
parser.add_argument( '--go-completer', action = 'store_true',
help = 'Enable Go semantic completion engine.' )
parser.add_argument( '--rust-completer', action = 'store_true',
help = 'Enable Rust semantic completion engine.' )
parser.add_argument( '--rust-toolchain-version',
action = 'store',
default = DEFAULT_RUST_TOOLCHAIN,
help = 'For advanced users ***NO SUPPORT***, specify '
'the rust toolchain version to install from '
'rustup. Only the default vaule "' +
DEFAULT_RUST_TOOLCHAIN + '" is tested/'
'supported by the maintainers of YCM/ycmd' )
parser.add_argument( '--java-completer', action = 'store_true',
help = 'Enable Java semantic completion engine.' ),
parser.add_argument( '--ts-completer', action = 'store_true',
help = 'Enable JavaScript and TypeScript semantic '
'completion engine.' ),
parser.add_argument( '--system-libclang', action = 'store_true',
help = 'Use system libclang instead of downloading one '
'from llvm.org. NOT RECOMMENDED OR SUPPORTED!' )
if OnWindows():
parser.add_argument( '--msvc', type = int, choices = [ 15, 16, 17 ],
default=None,
help= 'Choose the Microsoft Visual Studio version '
'(default: %(default)s).' )
parser.add_argument( '--ninja', action = 'store_true',
help = 'Use Ninja build system.' )
parser.add_argument( '--all',
action = 'store_true',
help = 'Enable all supported completers',
dest = 'all_completers' )
parser.add_argument( '--enable-coverage',
action = 'store_true',
help = 'For developers: Enable gcov coverage for the '
'c++ module' )
parser.add_argument( '--enable-debug',
action = 'store_true',
help = 'For developers: build ycm_core library with '
'debug symbols' )
parser.add_argument( '--build-dir',
help = 'For developers: perform the build in the '
'specified directory, and do not delete the '
'build output. This is useful for incremental '
'builds, and required for coverage data' )
# Historically, "verbose" mode was the default and --quiet was added. Now,
# quiet is the default (but the argument is still allowed, to avoid breaking
# scripts), and --verbose is added to get the full output.
parser.add_argument( '--quiet',
action = 'store_true',
default = True, # This argument is deprecated
help = 'Quiet installation mode. Just print overall '
'progress and errors. This is the default, so '
'this flag is actually ignored. Ues --verbose '
'to see more output.' )
parser.add_argument( '--verbose',
action = 'store_false',
dest = 'quiet',
help = 'Verbose installation mode; prints output from '
'build operations. Useful for debugging '
'build failures.' )
parser.add_argument( '--skip-build',
action = 'store_true',
help = "Don't build ycm_core lib, just install deps" )
parser.add_argument( '--valgrind',
action = 'store_true',
help = 'For developers: '
'Run core tests inside valgrind.' )
parser.add_argument( '--clang-tidy',
action = 'store_true',
help = 'For developers: Run clang-tidy static analysis '
'on the ycm_core code itself.' )
parser.add_argument( '--core-tests', nargs = '?', const = '*',
help = 'Run core tests and optionally filter them.' )
parser.add_argument( '--cmake-path',
help = 'For developers: specify the cmake executable. '
'Useful for testing with specific versions, or '
'if the system is unable to find cmake.' )
parser.add_argument( '--force-sudo',
action = 'store_true',
help = 'Compiling with sudo causes problems. If you'
' know what you are doing, proceed.' )
parser.add_argument( '--preview-msvc',
action = 'store_true',
help = 'Allow compiling against latest MSVC Preview'
' version.' )
# These options are deprecated.
parser.add_argument( '--omnisharp-completer', action = 'store_true',
help = argparse.SUPPRESS )
parser.add_argument( '--gocode-completer', action = 'store_true',
help = argparse.SUPPRESS )
parser.add_argument( '--racer-completer', action = 'store_true',
help = argparse.SUPPRESS )
parser.add_argument( '--tern-completer', action = 'store_true',
help = argparse.SUPPRESS )
parser.add_argument( '--js-completer', action = 'store_true',
help = argparse.SUPPRESS )
parser.add_argument( '--regex', action = argparse.BooleanOptionalAction,
default = True,
help = 'Choose whether to build the regex module. '
'Defaults to True.' )
args = parser.parse_args()
# coverage is not supported for c++ on MSVC
if not OnWindows() and args.enable_coverage:
# We always want a debug build when running with coverage enabled
args.enable_debug = True
if OnWindows() and args.msvc is None:
args.msvc = FindLatestMSVC( args.quiet, args.preview_msvc )
if args.msvc is None:
raise FileNotFoundError( "Could not find a valid MSVC version." )
if args.core_tests:
os.environ[ 'YCM_TESTRUN' ] = '1'
elif os.environ.get( 'YCM_TESTRUN' ):
args.core_tests = '*'
if not args.clang_tidy and os.environ.get( 'YCM_CLANG_TIDY' ):
args.clang_tidy = True
if ( args.system_libclang and
not args.clang_completer and
not args.all_completers ):
raise InstallationFailed(
'ERROR: you can\'t pass --system-libclang without also passing '
'--clang-completer or --all as well.' )
return args
def FindCmake( args ):
cmake_exe = [ 'cmake3', 'cmake' ]
if args.cmake_path:
cmake_exe.insert( 0, args.cmake_path )
cmake = PathToFirstExistingExecutable( cmake_exe )
if cmake is None:
raise InstallationFailed(
"ERROR: Unable to find cmake executable in any of"
f" { cmake_exe }. CMake is required to build ycmd" )
return cmake
def GetCmakeCommonArgs( args ):
cmake_args = [ '-G', GetGenerator( args ) ]
# Set the architecture for the Visual Studio 16/17 generator.
if OnWindows() and args.msvc >= 16 and not args.ninja and not IS_MSYS:
arch = 'x64' if IS_64BIT else 'Win32'
cmake_args.extend( [ '-A', arch ] )
cmake_args.extend( CustomPythonCmakeArgs( args ) )
return cmake_args
def GetCmakeArgs( parsed_args ):
cmake_args = []
if parsed_args.clang_completer or parsed_args.all_completers:
cmake_args.append( '-DUSE_CLANG_COMPLETER=ON' )
if parsed_args.clang_tidy:
cmake_args.append( '-DUSE_CLANG_TIDY=ON' )
if parsed_args.system_libclang:
cmake_args.append( '-DUSE_SYSTEM_LIBCLANG=ON' )
if parsed_args.enable_debug:
cmake_args.append( '-DCMAKE_BUILD_TYPE=Debug' )
cmake_args.append( '-DUSE_DEV_FLAGS=ON' )
else:
cmake_args.append( '-DCMAKE_BUILD_TYPE=Release' )
# coverage is not supported for c++ on MSVC
if not OnWindows() and parsed_args.enable_coverage:
cmake_args.append( '-DCMAKE_CXX_FLAGS=-coverage' )
extra_cmake_args = os.environ.get( 'EXTRA_CMAKE_ARGS', '' )
# We use shlex split to properly parse quoted CMake arguments.
cmake_args.extend( shlex.split( extra_cmake_args ) )
return cmake_args
def RunYcmdTests( args, build_dir ):
tests_dir = p.join( build_dir, 'ycm', 'tests' )
new_env = os.environ.copy()
if OnWindows():
# We prepend the ycm_core and Clang third-party directories to the PATH
# instead of overwriting it so that the executable is able to find the
# Python library.
new_env[ 'PATH' ] = ( DIR_OF_THIS_SCRIPT + ';' +
LIBCLANG_DIR + ';' +
new_env[ 'PATH' ] )
else:
new_env[ 'LD_LIBRARY_PATH' ] = LIBCLANG_DIR
tests_cmd = [ p.join( tests_dir, 'ycm_core_tests' ), '--gtest_brief' ]
if args.core_tests != '*':
tests_cmd.append( f'--gtest_filter={ args.core_tests }' )
if args.valgrind:
new_env[ 'PYTHONMALLOC' ] = 'malloc'
tests_cmd = [ 'valgrind',
'--gen-suppressions=all',
'--error-exitcode=1',
'--leak-check=full',
'--show-leak-kinds=definite,indirect',
'--errors-for-leak-kinds=definite,indirect',
'--suppressions=' + p.join( DIR_OF_THIS_SCRIPT,
'valgrind.suppressions' ) ] + tests_cmd
CheckCall( tests_cmd,
env = new_env,
quiet = args.quiet,
status_message = 'Running ycmd tests' )
def RunYcmdBenchmarks( args, build_dir ):
benchmarks_dir = p.join( build_dir, 'ycm', 'benchmarks' )
new_env = os.environ.copy()
if OnWindows():
# We prepend the ycm_core and Clang third-party directories to the PATH
# instead of overwriting it so that the executable is able to find the
# Python library.
new_env[ 'PATH' ] = ( DIR_OF_THIS_SCRIPT + ';' +
LIBCLANG_DIR + ';' +
new_env[ 'PATH' ] )
else:
new_env[ 'LD_LIBRARY_PATH' ] = LIBCLANG_DIR
# Note we don't pass the quiet flag here because the output of the benchmark
# is the only useful info.
CheckCall( p.join( benchmarks_dir, 'ycm_core_benchmarks' ), env = new_env )
# On Windows, if the ycmd library is in use while building it, a LNK1104
# fatal error will occur during linking. Exit the script early with an
# error message if this is the case.
def ExitIfYcmdLibInUseOnWindows():
if not OnWindows():
return
ycmd_library = p.join( DIR_OF_THIS_SCRIPT, 'ycm_core.pyd' )
if not p.exists( ycmd_library ):
return
try:
open( p.join( ycmd_library ), 'a' ).close()
except IOError as error:
if error.errno == errno.EACCES:
raise InstallationFailed( 'ERROR: ycmd library is currently in use. '
'Stop all ycmd instances before compilation.' )
def GetCMakeBuildConfiguration( args ):
if OnWindows():
if args.enable_debug:
return [ '--config', 'Debug' ]
return [ '--config', 'Release' ]
return [ '--', '-j', str( NumCores() ) ]
def BuildYcmdLib( cmake, cmake_common_args, script_args ):
if script_args.build_dir:
build_dir = os.path.abspath( script_args.build_dir )
if not os.path.exists( build_dir ):
os.makedirs( build_dir )
else:
build_dir = mkdtemp( prefix = 'ycm_build_' )
try:
os.chdir( build_dir )
configure_command = ( [ cmake ] + cmake_common_args +
GetCmakeArgs( script_args ) )
configure_command.append( p.join( DIR_OF_THIS_SCRIPT, 'cpp' ) )
CheckCall( configure_command,
exit_message = BUILD_ERROR_MESSAGE,
quiet = script_args.quiet,
status_message = 'Generating ycmd build configuration' )
build_targets = [ 'ycm_core' ]
if script_args.core_tests:
build_targets.append( 'ycm_core_tests' )
if 'YCM_BENCHMARK' in os.environ:
build_targets.append( 'ycm_core_benchmarks' )
build_config = GetCMakeBuildConfiguration( script_args )
for target in build_targets:
build_command = ( [ cmake, '--build', '.', '--target', target ] +
build_config )
CheckCall( build_command,
exit_message = BUILD_ERROR_MESSAGE,
quiet = script_args.quiet,
status_message = f'Compiling ycmd target: { target }' )
if script_args.core_tests:
RunYcmdTests( script_args, build_dir )
if 'YCM_BENCHMARK' in os.environ:
RunYcmdBenchmarks( script_args, build_dir )
finally:
os.chdir( DIR_OF_THIS_SCRIPT )
if script_args.build_dir:
print( 'The build files are in: ' + build_dir )
else:
RemoveDirectory( build_dir )
def BuildRegexModule( script_args ):
build_dir = p.join( DIR_OF_THIRD_PARTY, 'regex-build', '3' )
lib_dir = p.join( DIR_OF_THIRD_PARTY, 'regex-build' )
try:
os.chdir( p.join( DIR_OF_THIRD_PARTY, 'mrab-regex-github' ) )
RemoveDirectoryIfExists( build_dir )
RemoveDirectoryIfExists( lib_dir )
try:
import setuptools # noqa
CheckCall( [ sys.executable,
'setup.py',
'build',
'--build-base=' + build_dir,
'--build-lib=' + lib_dir ],
exit_message = 'Failed to build regex module.',
quiet = script_args.quiet,
status_message = 'Building regex module' )
except ( ImportError, subprocess.CalledProcessError ):
print( 'Building regex module failed. Falling back to re builtin.' )
finally:
RemoveDirectoryIfExists( build_dir )
os.chdir( DIR_OF_THIS_SCRIPT )
def EnableCsCompleter( args ):
def WriteStdout( text ):
if not args.quiet:
sys.stdout.write( text )
sys.stdout.flush()
if args.quiet:
sys.stdout.write( 'Installing Omnisharp for C# support...' )
sys.stdout.flush()
build_dir = p.join( DIR_OF_THIRD_PARTY, "omnisharp-roslyn" )
try:
MkDirIfMissing( build_dir )
os.chdir( build_dir )
download_data = GetCsCompleterDataForPlatform()
version = download_data[ 'version' ]
WriteStdout( f"Installing Omnisharp { version }\n" )
CleanCsCompleter( build_dir, version )
package_path = DownloadCsCompleter( WriteStdout, download_data )
ExtractCsCompleter( WriteStdout, build_dir, package_path )
WriteStdout( "Done installing Omnisharp\n" )
if args.quiet:
print( 'OK' )
finally:
os.chdir( DIR_OF_THIS_SCRIPT )
def MkDirIfMissing( path ):
try:
os.mkdir( path )
except OSError:
pass
def CleanCsCompleter( build_dir, version ):
for file_name in os.listdir( build_dir ):
file_path = p.join( build_dir, file_name )
if file_name == version:
continue
if os.path.isfile( file_path ):
os.remove( file_path )
elif os.path.isdir( file_path ):
import shutil
shutil.rmtree( file_path )
def DownloadCsCompleter( writeStdout, download_data ):
file_name = download_data[ 'file_name' ]
download_url = download_data[ 'download_url' ]
check_sum = download_data[ 'check_sum' ]
version = download_data[ 'version' ]
MkDirIfMissing( version )
package_path = p.join( version, file_name )
if ( p.exists( package_path )
and not CheckFileIntegrity( package_path, check_sum ) ):
writeStdout( 'Cached Omnisharp file does not match checksum.\n' )
writeStdout( 'Removing...' )
os.remove( package_path )
writeStdout( 'DONE\n' )
if p.exists( package_path ):
writeStdout( f'Using cached Omnisharp: { file_name }\n' )
else:
writeStdout( f'Downloading Omnisharp from { download_url }...' )
DownloadFileTo( download_url, package_path )
writeStdout( 'DONE\n' )
return package_path
def ExtractCsCompleter( writeStdout, build_dir, package_path ):
writeStdout( f'Extracting Omnisharp to { build_dir }...' )
if OnWindows():
with ZipFile( package_path, 'r' ) as package_zip:
package_zip.extractall()
else:
with tarfile.open( package_path ) as package_tar:
package_tar.extractall()
writeStdout( 'DONE\n' )
def GetCsCompleterDataForPlatform():
####################################
# GENERATED BY update_omnisharp.py #
# DON'T MANUALLY EDIT #
####################################
DATA = {
'win32': {
'version': 'v1.37.11',
'download_url': ( 'https://github.com/OmniSharp/omnisharp-roslyn/release'
's/download/v1.37.11/omnisharp.http-win-x86.zip' ),
'file_name': 'omnisharp.http-win-x86.zip',
'check_sum': ( '461544056b144c97e8413de8c1aa1ddd9e2902f5a9f2223af8046d65'
'4d95f2a0' ),
},
'win64': {
'version': 'v1.37.11',
'download_url': ( 'https://github.com/OmniSharp/omnisharp-roslyn/release'
's/download/v1.37.11/omnisharp.http-win-x64.zip' ),
'file_name': 'omnisharp.http-win-x64.zip',
'check_sum': ( '7f6f0abfac00d028b90aaf1f56813e4fbb73d84bdf2c4704862aa976'
'1b61a59c' ),
},
'macos': {
'version': 'v1.37.11',
'download_url': ( 'https://github.com/OmniSharp/omnisharp-roslyn/release'
's/download/v1.37.11/omnisharp.http-osx.tar.gz' ),
'file_name': 'omnisharp.http-osx.tar.gz',
'check_sum': ( '84b84a8a3cb8fd3986ea795d9230457c43bf130b482fcb77fef57c67'
'e151828a' ),
},
'linux32': {
'version': 'v1.37.11',
'download_url': ( 'https://github.com/OmniSharp/omnisharp-roslyn/release'
's/download/v1.37.11/omnisharp.http-linux-x86.tar.gz' ),
'file_name': 'omnisharp.http-linux-x86.tar.gz',
'check_sum': ( 'a5ab39380a5d230c75f08bf552980cdc5bd8c31a43348acbfa66f1f4'
'6f12851f' ),
},
'linux64': {
'version': 'v1.37.11',
'download_url': ( 'https://github.com/OmniSharp/omnisharp-roslyn/release'
's/download/v1.37.11/omnisharp.http-linux-x64.tar.gz' ),
'file_name': 'omnisharp.http-linux-x64.tar.gz',
'check_sum': ( '9a6e9a246babd777229eebb57f0bee86e7ef5da271c67275eae5ed9d'
'7b0ad563' ),
},
}
if OnWindows():
return DATA[ 'win64' if IS_64BIT else 'win32' ]
else:
if OnMac():
return DATA[ 'macos' ]
return DATA[ 'linux64' if IS_64BIT else 'linux32' ]
def EnableGoCompleter( args ):
go = FindExecutableOrDie( 'go', 'go is required to build gopls.' )
new_env = os.environ.copy()
new_env[ 'GO111MODULE' ] = 'on'
new_env[ 'GOPATH' ] = p.join( DIR_OF_THIS_SCRIPT, 'third_party', 'go' )
new_env.pop( 'GOROOT', None )
new_env[ 'GOBIN' ] = p.join( new_env[ 'GOPATH' ], 'bin' )
gopls = 'golang.org/x/tools/gopls@v0.16.1'
CheckCall( [ go, 'install', gopls ],
env = new_env,
quiet = args.quiet,
status_message = 'Building gopls for go completion',
on_failure = lambda msg, code: CheckCall(
[ go, 'get', gopls ],
env = new_env,
quiet = args.quiet,
status_message = 'Trying legacy get get' ) )
def WriteToolchainVersion( version ):
path = p.join( RUST_ANALYZER_DIR, 'TOOLCHAIN_VERSION' )
with open( path, 'w' ) as f:
f.write( version )
def ReadToolchainVersion():
try:
filepath = p.join( RUST_ANALYZER_DIR, 'TOOLCHAIN_VERSION' )
with open( filepath ) as f:
return f.read().strip()
except OSError:
return None
def RustToolchainNeedsRefresh( cur, req ):
if cur == 'stable' and req == 'stable':
return True
return cur != req
def EnableRustCompleter( switches ):
cur_toolchain_version = ReadToolchainVersion()
req_toolchain_version = switches.rust_toolchain_version
if switches.quiet:
sys.stdout.write( f'Installing rust-analyzer "{ req_toolchain_version }" '
'for Rust support...' )
sys.stdout.flush()
if RustToolchainNeedsRefresh( cur_toolchain_version, req_toolchain_version ):
install_dir = mkdtemp( prefix = 'rust_install_' )
new_env = os.environ.copy()
new_env[ 'RUSTUP_HOME' ] = install_dir
rustup_init = p.join( install_dir, 'rustup-init' )
if OnWindows():
rustup_cmd = [ rustup_init ]
rustup_url = f"https://win.rustup.rs/{ 'x86_64' if IS_64BIT else 'i686' }"
else:
rustup_cmd = [ 'sh', rustup_init ]
rustup_url = 'https://sh.rustup.rs'
DownloadFileTo( rustup_url, rustup_init )
new_env[ 'CARGO_HOME' ] = install_dir
CheckCall( rustup_cmd + [ '-y',
'--default-toolchain', 'none',
'--no-modify-path' ],
env = new_env,
quiet = switches.quiet )
rustup = p.join( install_dir, 'bin', 'rustup' )
try:
CheckCall( [ rustup, 'toolchain', 'install', req_toolchain_version ],
env = new_env,
quiet = switches.quiet )
for component in [ 'rust-src',
'rust-analyzer-preview',
'rustfmt',
'clippy' ]:
CheckCall( [ rustup, 'component', 'add', component,
'--toolchain', req_toolchain_version ],
env = new_env,
quiet = switches.quiet )
toolchain_dir = subprocess.check_output(
[ rustup, 'run', req_toolchain_version, 'rustc', '--print', 'sysroot' ],
env = new_env
).rstrip().decode( 'utf8' )
if p.exists( RUST_ANALYZER_DIR ):
RemoveDirectory( RUST_ANALYZER_DIR )
os.makedirs( RUST_ANALYZER_DIR )
for folder in os.listdir( toolchain_dir ):
shutil.move( p.join( toolchain_dir, folder ), RUST_ANALYZER_DIR )
WriteToolchainVersion( req_toolchain_version )
finally:
RemoveDirectory( install_dir )
if switches.quiet:
print( 'OK' )
def EnableJavaScriptCompleter( args ):
npm = FindExecutableOrDie( 'npm', 'npm is required to set up Tern.' )
os.chdir( p.join( DIR_OF_THIS_SCRIPT, 'third_party', 'tern_runtime' ) )
CheckCall( [ npm, 'install', '--production' ],
quiet = args.quiet,
status_message = 'Setting up Tern for JavaScript completion' )
def CheckJavaVersion( required_version ):
java = FindExecutableOrDie(
'java',
f'java { required_version } is required to install JDT.LS' )
java_version = None
try:
new_env = os.environ.copy()
new_env.pop( 'JAVA_TOOL_OPTIONS', None )
new_env.pop( '_JAVA_OPTIONS', None )
java_version = int(
subprocess.check_output(
[ java, p.join( DIR_OF_THIS_SCRIPT, 'CheckJavaVersion.java' ) ],
stderr=subprocess.STDOUT,
env = new_env )
.decode( 'utf-8' )
.strip() )
except subprocess.CalledProcessError:
pass
if java_version is None or java_version < required_version:
print( f'\n\n*** WARNING ***: jdt.ls requires Java { required_version }.'
' You must set the option java_binary_path to point to a working '
f'java { required_version }.\n\n' )
def EnableJavaCompleter( switches ):
def Print( *args, **kwargs ):
if not switches.quiet:
print( *args, **kwargs )
if switches.quiet:
sys.stdout.write( 'Installing jdt.ls for Java support...' )
sys.stdout.flush()
CheckJavaVersion( 17 )
TARGET = p.join( DIR_OF_THIRD_PARTY, 'eclipse.jdt.ls', 'target', )
REPOSITORY = p.join( TARGET, 'repository' )
CACHE = p.join( TARGET, 'cache' )
JDTLS_SERVER_URL_FORMAT = ( 'https://download.eclipse.org/jdtls/milestones/'
'{jdtls_milestone}/'
'{jdtls_package_name}' )
JDTLS_PACKAGE_NAME_FORMAT = ( 'jdt-language-server-{jdtls_milestone}-'
'{jdtls_build_stamp}.tar.gz' )
package_name = JDTLS_PACKAGE_NAME_FORMAT.format(
jdtls_milestone = JDTLS_MILESTONE,
jdtls_build_stamp = JDTLS_BUILD_STAMP )
url = JDTLS_SERVER_URL_FORMAT.format(
jdtls_milestone = JDTLS_MILESTONE,
jdtls_package_name = package_name )
file_name = p.join( CACHE, package_name )
MakeCleanDirectory( REPOSITORY )
if not p.exists( CACHE ):
os.makedirs( CACHE )
elif p.exists( file_name ) and not CheckFileIntegrity( file_name,
JDTLS_SHA256 ):
Print( 'Cached tar file does not match checksum. Removing...' )
os.remove( file_name )
if p.exists( file_name ):
Print( f'Using cached jdt.ls: { file_name }' )
else:
Print( f"Downloading jdt.ls from { url }..." )
DownloadFileTo( url, file_name )
Print( f"Extracting jdt.ls to { REPOSITORY }..." )
with tarfile.open( file_name ) as package_tar:
package_tar.extractall( REPOSITORY )
Print( "Done installing jdt.ls" )
if switches.quiet:
print( 'OK' )
def EnableTypeScriptCompleter( args ):
RemoveDirectoryIfExists( p.join( DIR_OF_THIRD_PARTY, 'tsserver', 'bin' ) )
RemoveDirectoryIfExists( p.join( DIR_OF_THIRD_PARTY, 'tsserver', 'lib' ) )
npm = FindExecutableOrDie( 'npm', 'npm is required to install TSServer.' )
os.chdir( p.join( DIR_OF_THIRD_PARTY, 'tsserver' ) )
CheckCall( [ npm, 'install', '--production' ],
quiet = args.quiet,
status_message = 'Setting up TSserver for TypeScript completion' )
def GetClangdTarget():
if OnWindows():
return [
( 'clangd-{version}-win64',
'6f4a14f3f144fc39158a7088528e3c8ffa20df516404c319e42351c27dfff063' ),
( 'clangd-{version}-win32',
'4278d11bebd7c60b945c7aa7457a82e707eeb488d24acdccdc3e354b36b808be' ) ]
if OnMac():
if OnArm():
return [
( 'clangd-{version}-arm64-apple-darwin',
'b65d43dc82f47a68c8faf6d9711f54a29da9f25c39c3f138466c874359e5efe8' ) ]
return [
( 'clangd-{version}-x86_64-apple-darwin',
'f3da3d4c97d1f8526299f2c64aaa0dbdeff5daad4e07a1937ad1d81b6407d143' ) ]
if OnAArch64():
return [
( 'clangd-{version}-aarch64-linux-gnu',
'c279514021924c04b0b810bf79adb3cd5d7f061acb3c4b43e4c445671b3d2a18' ) ]
if OnArm():
return [
None, # First list index is for 64bit archives. ARMv7 is 32bit only.
( 'clangd-{version}-armv7a-linux-gnueabihf',
'f561e33a90f2053d12202d4a06477c30bf831082c01c228f1935403632bbfa81' ) ]
if OnX86_64():
return [
( 'clangd-{version}-x86_64-unknown-linux-gnu',
'93319be9a2ec662be57f7ce77463ac706ae4f559744f05f7cae4da3350a154b5' ) ]
raise InstallationFailed(
CLANGD_BINARIES_ERROR_MESSAGE.format( version = CLANGD_VERSION,
platform = 'this system' ) )
def DownloadClangd( printer ):
CLANGD_DIR = p.join( DIR_OF_THIRD_PARTY, 'clangd', )
CLANGD_CACHE_DIR = p.join( CLANGD_DIR, 'cache' )
CLANGD_OUTPUT_DIR = p.join( CLANGD_DIR, 'output' )
target = GetClangdTarget()
target_name, check_sum = target[ not IS_64BIT ]
target_name = target_name.format( version = CLANGD_VERSION )
file_name = f'{ target_name }.tar.bz2'
download_url = ( 'https://github.com/ycm-core/llvm/releases/download/'
f'{ CLANGD_VERSION }/{ file_name }' )
file_name = p.join( CLANGD_CACHE_DIR, file_name )
MakeCleanDirectory( CLANGD_OUTPUT_DIR )
if not p.exists( CLANGD_CACHE_DIR ):
os.makedirs( CLANGD_CACHE_DIR )
elif p.exists( file_name ) and not CheckFileIntegrity( file_name, check_sum ):
printer( 'Cached Clangd archive does not match checksum. Removing...' )
os.remove( file_name )
if p.exists( file_name ):
printer( f'Using cached Clangd: { file_name }' )
else:
printer( f"Downloading Clangd from { download_url }..." )
DownloadFileTo( download_url, file_name )
if not CheckFileIntegrity( file_name, check_sum ):
raise InstallationFailed(
'ERROR: downloaded Clangd archive does not match checksum.' )
printer( f"Extracting Clangd to { CLANGD_OUTPUT_DIR }..." )
with tarfile.open( file_name ) as package_tar:
package_tar.extractall( CLANGD_OUTPUT_DIR )
printer( "Done installing Clangd" )
def EnableClangdCompleter( Args ):
if Args.quiet:
sys.stdout.write( 'Setting up Clangd completer...' )
sys.stdout.flush()
def Print( msg ):
if not Args.quiet:
print( msg )
DownloadClangd( Print )
if Args.quiet:
print( 'OK' )
if not Args.quiet:
print( 'Clangd completer enabled. If you are using .ycm_extra_conf.py '
'files, make sure they use Settings() instead of the old and '
'deprecated FlagsForFile().' )
def WritePythonUsedDuringBuild():
path = p.join( DIR_OF_THIS_SCRIPT, 'PYTHON_USED_DURING_BUILDING' )
with open( path, 'w' ) as f:
f.write( sys.executable )
def BuildWatchdogModule( script_args ):
DIR_OF_WATCHDOG_DEPS = p.join( DIR_OF_THIRD_PARTY, 'watchdog_deps' )
build_dir = p.join( DIR_OF_WATCHDOG_DEPS, 'watchdog', 'build', '3' )
lib_dir = p.join( DIR_OF_WATCHDOG_DEPS, 'watchdog', 'build', 'lib3' )
try:
os.chdir( p.join( DIR_OF_WATCHDOG_DEPS, 'watchdog' ) )
RemoveDirectoryIfExists( build_dir )
RemoveDirectoryIfExists( lib_dir )
try:
import setuptools # noqa
CheckCall( [ sys.executable,
'setup.py',
'build',
'--build-base=' + build_dir,
'--build-lib=' + lib_dir ],
exit_message = 'Failed to build watchdog module.',
quiet = script_args.quiet,
status_message = 'Building watchdog module' )
except ImportError:
if OnMac():
print( 'WARNING: setuptools unavailable. Watchdog will fall back to '
'the slower kqueue filesystem event API.\n'
'To use the faster fsevents, install setuptools and '
'rerun this script.' )
os.makedirs( lib_dir )
shutil.copytree( p.join( 'src', 'watchdog' ),
p.join( lib_dir, 'watchdog' ) )
finally:
RemoveDirectoryIfExists( build_dir )
os.chdir( DIR_OF_THIS_SCRIPT )
def DoCmakeBuilds( args ):
cmake = FindCmake( args )
cmake_common_args = GetCmakeCommonArgs( args )
ExitIfYcmdLibInUseOnWindows()
BuildYcmdLib( cmake, cmake_common_args, args )
WritePythonUsedDuringBuild()
BuildWatchdogModule( args )
# NOTE: Keep BuildRegexModule() as the final step.
# If it fails, at least everything mandatory has been built.
if args.regex:
BuildRegexModule( args )
def PrintReRunMessage():
print( '',
'The installation failed; please see above for the actual error. '
'In order to get more information, please re-run the command, '
'adding the --verbose flag. If you think this is a bug and you '
'raise an issue, you MUST include the *full verbose* output.',
'',
'For example, run:' + ' '.join( shlex.quote( arg )
for arg in [ sys.executable ] +
sys.argv +
[ '--verbose' ] ),
'',
file = sys.stderr,
sep = '\n' )
def Main(): # noqa: C901
args = ParseArguments()
if not OnWindows() and os.geteuid() == 0:
if args.force_sudo:
print( 'Forcing build with root privileges. '
'If it breaks, keep the pieces.' )
else:
sys.exit( 'This script should not be run with root privileges.' )
try:
if not args.skip_build:
DoCmakeBuilds( args )
if args.cs_completer or args.omnisharp_completer or args.all_completers:
EnableCsCompleter( args )
if args.go_completer or args.gocode_completer or args.all_completers:
EnableGoCompleter( args )
if args.js_completer or args.tern_completer or args.all_completers:
EnableJavaScriptCompleter( args )
if args.rust_completer or args.racer_completer or args.all_completers:
EnableRustCompleter( args )
if args.java_completer or args.all_completers:
EnableJavaCompleter( args )
if args.ts_completer or args.all_completers:
EnableTypeScriptCompleter( args )
if args.clangd_completer or args.all_completers:
EnableClangdCompleter( args )
except InstallationFailed as e:
e.Print()
if args.quiet:
PrintReRunMessage()
e.Exit()
except Exception as e:
if args.quiet:
print( f"FAILED with exception { type( e ).__name__ }: { e }" )
PrintReRunMessage()
else:
raise
if __name__ == '__main__':
Main()
|