2018-10-30 11:35:56 +01:00
<!DOCTYPE html>
< html >
< head >
< title > TDLib build instructions< / title >
< style >
.hide { display: none; }
div.main { max-width:1200px; margin: auto; font-size: x-large; }
select.large { font-size: large; }
< / style >
< / head >
2020-11-03 15:35:12 +01:00
< body onload = "onLoad(true)" onpopstate = "onLoad(false)" >
2018-10-30 11:35:56 +01:00
< div class = "main" >
2020-11-03 15:35:12 +01:00
< div id = "languageSelectDiv" style = "text-align:center;" >
2020-10-28 21:25:57 +01:00
< p > Choose a programming language, from which you want to use TDLib:< / p >
2020-11-03 15:35:12 +01:00
< select id = "languageSelect" onchange = "onLanguageChanged(false)" autofocus class = "large" >
2020-10-28 21:25:57 +01:00
< option > Choose a programming language:< / option >
< option > Python< / option >
< option > JavaScript< / option >
< option > Go< / option >
< option > Java< / option >
< option > Kotlin< / option >
< option > C#< / option >
< option > C++< / option >
< option > Swift< / option >
< option > Objective-C< / option >
< option > Object Pascal< / option >
< option > Dart< / option >
< option > Rust< / option >
< option > Erlang< / option >
< option > PHP< / option >
< option > Lua< / option >
< option > Ruby< / option >
2020-11-18 15:38:19 +01:00
< option > Crystal< / option >
< option > Haskell< / option >
< option > Nim< / option >
2020-10-28 21:25:57 +01:00
< option > Clojure< / option >
< option > D< / option >
< option > Elixir< / option >
< option > C< / option >
< option > Other< / option >
< / select >
2018-10-30 11:35:56 +01:00
< / div >
2020-11-03 15:35:12 +01:00
< div id = "osSelectDiv" class = "hide" style = "text-align:center;" >
2018-10-30 11:35:56 +01:00
< p > Choose an operating system, on which you want to use TDLib:< / p >
< select id = "osSelect" onchange = "onOsChanged()" class = "large" >
< option > Choose an operating system:< / option >
< / select >
< p > < / p >
< / div >
2020-11-03 15:35:12 +01:00
< div id = "linuxSelectDiv" class = "hide" style = "text-align:center;" >
2020-10-28 21:25:57 +01:00
< p > Choose a Linux distro, on which you want to use TDLib:< / p >
< select id = "linuxSelect" onchange = "onOsChanged()" class = "large" >
< option > Choose a Linux distro:< / option >
< option > Alpine< / option >
2020-11-08 16:51:35 +01:00
< option > CentOS 7< / option >
< option > CentOS 8< / option >
2020-10-28 21:25:57 +01:00
< option > Debian 8< / option >
< option > Debian 9< / option >
< option > Debian 10< / option >
< option > Ubuntu 14< / option >
< option > Ubuntu 16< / option >
< option > Ubuntu 18< / option >
< option > Ubuntu 20< / option >
< option > Other< / option >
< / select >
< p > < / p >
< / div >
2018-10-30 11:35:56 +01:00
2020-11-03 15:35:12 +01:00
< div id = "buildOptionsDiv" class = "hide" style = "text-align:center;" >
2018-10-30 11:35:56 +01:00
< div id = "buildLtoDiv" class = "hide" >
< label > < input type = "checkbox" id = "buildLtoCheckbox" onchange = "onOptionsChanged()" / > Enable Link Time Optimization (requires CMake >= 3.9.0). It can significantly reduce binary size and increase performance, but sometimes it can lead to build failures.< / label >
< / div >
< div id = "buildDebugDiv" class = "hide" >
2020-11-02 18:23:10 +01:00
< label > < input type = "checkbox" id = "buildDebugCheckbox" onchange = "onOptionsChanged()" / > Build the debug binary. Debug binaries are much larger and slower than the release one.< / label >
2018-10-30 11:35:56 +01:00
< / div >
< div id = "buildInstallLocalDiv" class = "hide" >
< label > < input type = "checkbox" id = "buildInstallLocalCheckbox" onchange = "onOptionsChanged()" / > Install built TDLib to /usr/local instead of placing the files to td/tdlib.< / label >
< / div >
< p > < / p >
< div id = "buildCompilerDiv" class = "hide" >
< span > Choose which compiler you want to use to build TDLib:< / span > < br >
< label > < input type = "radio" id = "buildCompilerRadioGcc" name = "buildCompilerRadio" onchange = "onOptionsChanged()" checked / > g++< / label >
2020-11-08 19:03:23 +01:00
< label > < input type = "radio" id = "buildCompilerRadioClang" name = "buildCompilerRadio" onchange = "onOptionsChanged()" / > clang (recommended)< / label >
2018-10-30 11:35:56 +01:00
< p > < / p >
< / div >
< div id = "buildArchiverDiv" class = "hide" >
< span > Choose which archiver application you want to use for VSIX creation:< / span > < br >
< label > < input type = "radio" id = "buildArchiverRadio7Zip" name = "buildArchiverRadio" onchange = "onOptionsChanged()" checked / > 7-Zip< / label >
< label > < input type = "radio" id = "buildArchiverRadioZip" name = "buildArchiverRadio" onchange = "onOptionsChanged()" / > zip< / label >
< label > < input type = "radio" id = "buildArchiverRadioWinRar" name = "buildArchiverRadio" onchange = "onOptionsChanged()" / > WinRAR< / label >
< p > < / p >
< / div >
2018-11-07 14:25:56 +01:00
< div id = "buildShellDiv" class = "hide" >
< span > Choose which shell application you want to use for building:< / span > < br >
< label > < input type = "radio" id = "buildShellRadioPowerShell" name = "buildShellRadio" onchange = "onOptionsChanged()" checked / > PowerShell< / label >
< label > < input type = "radio" id = "buildShellRadioBash" name = "buildShellRadio" onchange = "onOptionsChanged()" / > mintty/Bash< / label >
< p > < / p >
< / div >
< div id = "buildShellBsdDiv" class = "hide" >
< span > Choose which shell application you want to use for building:< / span > < br >
< label > < input type = "radio" id = "buildShellBsdRadioCsh" name = "buildShellRadioBsd" onchange = "onOptionsChanged()" checked / > tcsh/csh< / label >
< label > < input type = "radio" id = "buildShellBsdRadioBash" name = "buildShellRadioBsd" onchange = "onOptionsChanged()" / > Bash< / label >
2018-10-30 11:35:56 +01:00
< p > < / p >
< / div >
< div id = "buildBitnessDiv" class = "hide" >
< span > Choose for which bitness you want to build TDLib:< / span > < br >
< label > < input type = "radio" id = "buildBitnessRadio32" name = "buildBitnessRadio" onchange = "onOptionsChanged()" checked / > 32< / label >
< label > < input type = "radio" id = "buildBitnessRadio64" name = "buildBitnessRadio" onchange = "onOptionsChanged()" / > 64< / label >
< p > < / p >
< / div >
< div id = "buildLowMemoryDiv" class = "hide" >
< label > < input type = "checkbox" id = "buildLowMemoryCheckbox" onchange = "onOptionsChanged()" / > < span id = "buildLowMemoryText" > Check this if you have less than 4 GB of RAM< / span > < / label >
< / div >
< div id = "buildRootDiv" class = "hide" >
< label > < input type = "checkbox" id = "buildRootCheckbox" onchange = "onOptionsChanged()" / > Build from root user (unrecommended)< / label >
< / div >
< p > < / p >
< / div >
2020-11-03 15:35:12 +01:00
< div id = "buildTextDiv" class = "hide" style = "text-align:center;" >
2018-10-30 11:35:56 +01:00
< p id = "buildText" > Hidden text< / p >
< / div >
2020-11-03 15:35:12 +01:00
< div id = "buildCommandsDiv" class = "hide" style = "text-align:left;" >
< p id = "buildCommandsHeader" style = "text-align:center;" > Here is complete instruction for TDLib binaries building:< / p >
2018-10-30 11:35:56 +01:00
< p id = "buildPre" > Hidden text< / p >
< code id = "buildCommands" > Empty commands< / code >
< / div >
< / div >
< script >
function onLoad(initial) {
var url = new URL(window.location.href);
var language = url.searchParams.get('language');
if (language === 'csharp') {
language = 'c#';
} else if (language === 'cxx') {
language = 'c++';
2020-10-28 20:44:42 +01:00
} else if (!language) {
language = '';
2018-10-30 11:35:56 +01:00
}
var language_options = document.getElementById('languageSelect').options;
for (var i = 0; i < language_options.length ; i + + ) {
2020-10-28 20:44:42 +01:00
language_options[i].selected = language_options[i].text.toLowerCase() === language.toLowerCase();
2018-10-30 11:35:56 +01:00
}
onLanguageChanged(initial || !history.state);
}
function getSupportedOs(language) {
switch (language) {
case 'Choose a programming language:':
return [];
case 'JavaScript':
2019-08-02 20:32:58 +02:00
return ['Windows (Node.js)', 'Linux (Node.js)', 'macOS (Node.js)', 'FreeBSD (Node.js)', 'OpenBSD (Node.js)', 'NetBSD (Node.js)', 'Browser'];
2018-10-30 11:35:56 +01:00
case 'Java':
2019-09-20 18:43:39 +02:00
case 'Kotlin':
2019-09-23 18:50:11 +02:00
return ['Android', 'Windows', 'Linux', 'macOS', 'FreeBSD', 'OpenBSD'];
2018-10-30 11:35:56 +01:00
case 'C#':
2019-12-12 22:27:36 +01:00
return ['Windows (through C++/CLI)', 'Universal Windows Platform (through C++/CX)', 'Windows (.NET Core)', 'Linux (.NET Core)', 'macOS (.NET Core)', 'FreeBSD (.NET Core)'];
2019-09-23 18:50:11 +02:00
case 'Dart':
return ['Android', 'iOS', 'Windows', 'Linux', 'macOS', 'tvOS', 'watchOS'];
2018-11-03 01:09:25 +01:00
case 'Swift':
case 'Objective-C':
2018-11-11 15:19:39 +01:00
return ['Windows', 'Linux', 'macOS', 'iOS', 'tvOS', 'watchOS'];
2018-10-30 11:35:56 +01:00
default:
2019-08-02 20:32:58 +02:00
return ['Windows', 'Linux', 'macOS', 'FreeBSD', 'OpenBSD', 'NetBSD'];
2018-10-30 11:35:56 +01:00
}
}
function getExampleAnchor(language) {
switch (language) {
case 'Python':
case 'JavaScript':
case 'Go':
case 'Java':
2019-09-20 18:43:39 +02:00
case 'Kotlin':
2018-11-03 01:09:25 +01:00
case 'Swift':
case 'Objective-C':
2019-09-23 18:50:11 +02:00
case 'Dart':
2018-10-30 11:35:56 +01:00
case 'Rust':
case 'Erlang':
case 'PHP':
case 'Lua':
case 'Ruby':
2020-11-18 15:38:19 +01:00
case 'Crystal':
case 'Haskell':
case 'Nim':
2019-06-18 02:08:55 +02:00
case 'Clojure':
2018-10-30 11:35:56 +01:00
case 'D':
case 'Elixir':
2019-04-25 17:56:01 +02:00
case 'C':
2018-10-30 11:35:56 +01:00
return language.toLowerCase();
2020-10-12 13:50:41 +02:00
case 'Object Pascal':
return 'object-pascal';
2018-10-30 11:35:56 +01:00
case 'C#':
return 'csharp';
case 'C++':
return 'cxx';
default:
return 'other';
}
}
function onLanguageChanged(initial) {
var language = document.getElementById('languageSelect').value;
2018-10-30 19:17:42 +01:00
2018-10-30 11:35:56 +01:00
var supported_os = getSupportedOs(language);
var os_select = document.getElementById('osSelect');
if (supported_os.length) {
document.getElementById('osSelectDiv').style.display = 'block';
} else {
2021-06-08 18:20:55 +02:00
if (history.state !== '' & & history.state !== null) {
2018-10-30 11:35:56 +01:00
history.pushState('', '', 'build.html');
}
document.getElementById('osSelectDiv').style.display = 'none';
onOsChanged();
return;
}
if (!initial & & history.state !== language) {
history.pushState(language, '', 'build.html?language=' + encodeURIComponent(language));
}
var existing_options = [];
for (var index = 1; index < os_select.length ; index + + ) {
if (!supported_os.includes(os_select.options[index].value)) {
os_select.remove(index);
index--;
} else {
existing_options.push(os_select.options[index].value);
}
}
for (os of supported_os) {
if (!existing_options.includes(os)) {
var option = document.createElement('option');
option.text = os;
os_select.add(option);
}
}
onOsChanged();
}
function getTarget(language, os) {
var supported_os = getSupportedOs(language);
if (!supported_os.includes(os)) {
return null;
}
if (os.includes('C++/CLI')) {
return 'C++/CLI';
}
if (os.includes('C++/CX')) {
return 'C++/CX';
}
if (os.includes('Browser')) {
return 'WebAssembly';
}
if (os.includes('Android')) {
return 'Android';
}
2018-11-03 01:09:25 +01:00
if (os.includes('iOS') || os.includes('tvOS') || os.includes('watchOS')) {
return 'iOS';
}
2018-10-30 11:35:56 +01:00
switch (language) {
case 'C++':
return 'tdclient';
case 'Java':
2019-09-20 18:43:39 +02:00
case 'Kotlin':
2018-10-30 11:35:56 +01:00
return 'JNI';
default:
return 'tdjson';
}
}
function getTargetName(target) {
switch (target) {
case 'tdjson':
case 'WebAssembly':
2018-11-03 01:09:25 +01:00
case 'iOS':
2018-10-30 11:35:56 +01:00
return '< a href = "https://github.com/tdlib/td#using-json" > JSON< / a > ';
case 'tdclient':
return '< a href = "https://github.com/tdlib/td#using-cxx" > a simple and convenient C++11-interface< / a > ';
case 'JNI':
case 'Android':
return '< a href = "https://github.com/tdlib/td#using-java" > native ' + target + '< / a > ';
default:
return '< a href = "https://github.com/tdlib/td#using-dotnet" > native ' + target + '< / a > ';
}
}
function onOsChanged() {
var language = document.getElementById('languageSelect').value;
var os = document.getElementById('osSelect').value;
var target = getTarget(language, os);
document.getElementById('buildTextDiv').style.display = target ? 'block' : 'none';
if (language === 'Other') {
language = 'any other programming language';
}
2019-04-25 17:56:01 +02:00
var text = 'TDLib can be used from ' + language + ' on ' + os + ' through the ' + getTargetName(target) + ' interface.< br > ' +
'See < a href = "https://github.com/tdlib/td/blob/master/example/README.md#' + getExampleAnchor(language) + '" > examples< / a > of such usage and already available third-party frameworks.< br > ';
2018-10-30 11:35:56 +01:00
if (target === 'WebAssembly') {
2019-04-30 17:02:08 +02:00
text = 'TDLib is available in a prebuilt form as an < a href = "https://www.npmjs.com/" > NPM< / a > package < a href = "https://www.npmjs.com/package/tdweb" > tdweb< / a > .< br > ' +
2020-07-27 21:12:43 +02:00
'If you want to build it manually, take a look at our < a href = "https://github.com/tdlib/td/tree/master/example/web" > example< / a > .';
2018-10-30 11:35:56 +01:00
target = '';
}
if (target === 'Android') {
2020-07-27 21:12:43 +02:00
text = 'TDLib for Android is available in a prebuilt form and can be downloaded from < a href = "https://core.telegram.org/tdlib/tdlib.zip" > there< / a > .< br > ' +
'See < a href = "https://github.com/tdlib/td/issues/77#issuecomment-640719893" > build instructions< / a > if you want to build the latest TDLib version or want to build TDLib with different interface.';
2018-10-30 11:35:56 +01:00
target = '';
}
2018-11-03 01:09:25 +01:00
if (target === 'iOS') {
target = '';
}
2018-10-30 11:35:56 +01:00
document.getElementById('buildText').innerHTML = text;
if (!target) {
2020-10-28 21:25:57 +01:00
document.getElementById('linuxSelectDiv').style.display = 'none';
2018-10-30 11:35:56 +01:00
document.getElementById('buildOptionsDiv').style.display = 'none';
document.getElementById('buildCommandsDiv').style.display = 'none';
return;
}
2020-10-28 21:25:57 +01:00
var os_linux = os.includes('Linux');
if (os_linux) {
document.getElementById('linuxSelectDiv').style.display = 'block';
var linux_distro = document.getElementById('linuxSelect').value;
if (linux_distro.includes('Choose ')) {
document.getElementById('buildTextDiv').style.display = 'none';
document.getElementById('buildOptionsDiv').style.display = 'none';
document.getElementById('buildCommandsDiv').style.display = 'none';
return;
}
} else {
document.getElementById('linuxSelectDiv').style.display = 'none';
}
2018-10-30 11:35:56 +01:00
document.getElementById('buildOptionsDiv').style.display = 'block';
onOptionsChanged();
}
function onOptionsChanged() {
var language = document.getElementById('languageSelect').value;
var os = document.getElementById('osSelect').value;
var target = getTarget(language, os);
var os_windows = os.includes('Windows');
var os_linux = os.includes('Linux');
var os_mac = os.includes('macOS');
2018-11-03 01:09:25 +01:00
var os_freebsd = os.includes('FreeBSD');
2019-08-02 04:30:31 +02:00
var os_openbsd = os.includes('OpenBSD');
2019-08-02 20:32:58 +02:00
var os_netbsd = os.includes('NetBSD');
2018-10-30 11:35:56 +01:00
var linux_distro = 'none';
if (os_linux) {
linux_distro = document.getElementById('linuxSelect').value;
}
2020-10-28 21:25:57 +01:00
document.getElementById('buildCommandsDiv').style.display = 'block';
2018-10-30 11:35:56 +01:00
2019-08-02 04:30:31 +02:00
var use_clang = os_freebsd || os_openbsd;
2020-11-08 16:51:35 +01:00
if (os_linux & & linux_distro !== 'Alpine' & & !linux_distro.includes('CentOS')) {
2018-10-30 11:35:56 +01:00
document.getElementById('buildCompilerDiv').style.display = 'block';
use_clang = document.getElementById('buildCompilerRadioClang').checked;
} else {
document.getElementById('buildCompilerDiv').style.display = 'none';
}
var low_memory = false;
2020-11-05 21:42:58 +01:00
if (os_linux || os_freebsd || os_netbsd) {
2018-10-30 11:35:56 +01:00
low_memory = document.getElementById('buildLowMemoryCheckbox').checked;
document.getElementById('buildLowMemoryText').innerHTML = 'I have less than ' + (use_clang ? '1.5' : '3.5') +' GB of RAM.' +
(low_memory ? ' Now you will need only ' + (use_clang ? '0.5' : '1') +' GB of RAM to build TDLib.' : '');
document.getElementById('buildLowMemoryDiv').style.display = 'block';
} else {
2020-11-05 21:42:58 +01:00
if (os_openbsd) {
low_memory = true;
}
2018-10-30 11:35:56 +01:00
document.getElementById('buildLowMemoryDiv').style.display = 'none';
}
var use_root = false;
2019-08-02 20:32:58 +02:00
if ((os_linux & & linux_distro !== 'Other') || os_openbsd || os_netbsd) {
2018-10-30 11:35:56 +01:00
use_root = document.getElementById('buildRootCheckbox').checked;
document.getElementById('buildRootDiv').style.display = 'block';
} else {
document.getElementById('buildRootDiv').style.display = 'none';
}
var use_powershell = false;
var use_cmd = false;
2018-11-07 14:25:56 +01:00
var use_csh = false;
2018-10-30 11:35:56 +01:00
if (os_windows) {
2018-11-07 14:25:56 +01:00
document.getElementById('buildShellDiv').style.display = 'block';
use_powershell = document.getElementById('buildShellRadioPowerShell').checked;
2018-10-30 11:35:56 +01:00
} else {
2018-11-07 14:25:56 +01:00
document.getElementById('buildShellDiv').style.display = 'none';
}
if (os_freebsd) {
document.getElementById('buildShellBsdDiv').style.display = 'block';
use_csh = document.getElementById('buildShellBsdRadioCsh').checked;
} else {
document.getElementById('buildShellBsdDiv').style.display = 'none';
2018-10-30 11:35:56 +01:00
}
var use_msvc = os_windows;
var use_vcpkg = os_windows;
var use_lto = false;
2020-07-26 20:04:41 +02:00
if (!use_msvc & & language !== 'Java' & & language !== 'Kotlin' & & (os_mac || (os_linux & & (linux_distro === 'Ubuntu 18' || linux_distro === 'Ubuntu 20' || linux_distro === 'Other')))) {
2018-10-30 11:35:56 +01:00
document.getElementById('buildLtoDiv').style.display = 'block';
use_lto = document.getElementById('buildLtoCheckbox').checked;
} else {
document.getElementById('buildLtoDiv').style.display = 'none';
}
var archiver = 'none';
if (target === 'C++/CX') {
document.getElementById('buildArchiverDiv').style.display = 'block';
if (document.getElementById('buildArchiverRadio7Zip').checked) {
archiver = '7zip';
} else if (document.getElementById('buildArchiverRadioZip').checked) {
archiver = 'zip';
} else if (document.getElementById('buildArchiverRadioWinRar').checked) {
archiver = 'WinRAR';
}
} else {
document.getElementById('buildArchiverDiv').style.display = 'none';
}
var is_debug_build = false;
if (target !== 'C++/CX' & & target !== 'C++/CLI') {
document.getElementById('buildDebugDiv').style.display = 'block';
is_debug_build = document.getElementById('buildDebugCheckbox').checked;
} else {
document.getElementById('buildDebugDiv').style.display = 'none';
}
var sudo = 'sudo ';
2019-08-02 20:32:58 +02:00
if (use_root || linux_distro.includes('Debian') || os_freebsd || os_openbsd || os_netbsd) {
2018-10-30 11:35:56 +01:00
sudo = '';
}
var build_32bit = false;
var build_64bit = false;
if (use_msvc & & target !== 'C++/CX') {
document.getElementById('buildBitnessDiv').style.display = 'block';
build_32bit = document.getElementById('buildBitnessRadio32').checked;
build_64bit = document.getElementById('buildBitnessRadio64').checked;
} else {
document.getElementById('buildBitnessDiv').style.display = 'none';
}
var local = './';
if (use_cmd) {
local = '.\\';
}
var install_dir = 'td/tdlib';
if (!os_windows) {
document.getElementById('buildInstallLocalDiv').style.display = 'block';
if (document.getElementById('buildInstallLocalCheckbox').checked) {
install_dir = '/usr/local';
}
} else {
document.getElementById('buildInstallLocalDiv').style.display = 'none';
}
var pre_text = [];
if (os_windows) {
let win10_sdk = (target === 'C++/CX' ? ' and Windows 10 SDK' : '');
2019-06-18 02:00:32 +02:00
if (target !== 'C++/CLI' & & target !== 'C++/CX') {
2020-11-02 18:23:10 +01:00
pre_text.push('Note that Windows Subsystem for Linux (WSL) and Cygwin are not Windows environments, so you need to use instructions for Linux for them instead.');
2019-06-18 02:00:32 +02:00
}
2020-11-21 12:54:35 +01:00
pre_text.push('Download and install < a href = "https://visualstudio.microsoft.com/vs/community/" > Microsoft Visual Studio< / a > . Enable C++' + win10_sdk + ' support while installing.');
2018-10-30 11:35:56 +01:00
pre_text.push('Download and install < a href = "https://cmake.org/download/" > CMake< / a > ; choose "Add CMake to the system PATH" option while installing.');
pre_text.push('Download and install < a href = "https://git-scm.com/download/win" > Git< / a > .');
pre_text.push('Download and unpack < a href = "https://windows.php.net/download#php-7.2" > PHP< / a > . Add the path to php.exe to the PATH environment variable.');
if (target === 'C++/CX') {
switch (archiver) {
case '7zip':
pre_text.push('Download and install < a href = "http://www.7-zip.org/download.html" > 7-Zip< / a > archiver. Add the path to 7z.exe to the PATH environment variable.');
break;
case 'zip':
pre_text.push('Download and install < a href = "http://gnuwin32.sourceforge.net/packages/zip.htm" > zip< / a > archiver. Add the path to zip.exe to the PATH environment variable.');
break;
case 'WinRAR':
pre_text.push('You need bought and installed < a href = "https://www.win-rar.com/start.html?&L=4" > WinRAR< / a > archiver. Add the path to WinRAR.exe to the PATH environment variable.');
break;
}
}
}
if (target === 'JNI') {
2018-11-03 01:09:25 +01:00
if (os_windows) {
pre_text.push('Download and install < a href = "https://www.oracle.com/technetwork/java/javase/downloads/index.html" > JDK< / a > .');
} else if (os_linux & & linux_distro === 'Alpine') {
2018-10-30 11:35:56 +01:00
pre_text.push('Add community repository for your Alpine version (not edge) in /etc/apk/repositories. For example, you can do it through vim, preliminary installing it via "apk add --update vim".');
}
}
if (os_linux & & linux_distro === 'Other') {
var jdk = target === 'JNI' ? ', JDK ' : '';
2020-11-08 19:03:23 +01:00
var compiler = use_clang ? 'clang >= 3.4' : 'g++ >= 4.9.2';
2019-08-23 17:34:51 +02:00
pre_text.push('Install Git, ' + compiler + ', make, CMake >= 3.0.2, OpenSSL-dev, zlib-dev, gperf, PHP' + jdk + ' using your package manager.');
2018-10-30 11:35:56 +01:00
}
2019-04-28 23:13:36 +02:00
if (os_linux & & os.includes('Node.js')) {
pre_text.push('Note that for Node.js ≤ 9.11.2 you must build TDLib with OpenSSL 1.0.* and for Node.js ≥ 10 with OpenSSL 1.1.* instead, so you may need to modify the following commands to install a proper OpenSSL version.');
}
2018-11-03 01:09:25 +01:00
if (os_freebsd) {
2020-11-02 18:23:10 +01:00
pre_text.push('Note that the following instruction is for FreeBSD 11.');
pre_text.push('Note that the following calls to < code > pkg< / code > needs to be run as < code > root< / code > .');
2018-11-03 01:09:25 +01:00
}
2019-08-02 04:30:31 +02:00
if (os_openbsd) {
2020-11-02 18:23:10 +01:00
pre_text.push('Note that the following instruction is for OpenBSD 6.7 and default KSH shell.');
2020-06-13 19:41:43 +02:00
pre_text.push('Note that building requires a lot of memory, so you may need to increase allowed per-process memory usage in /etc/login.conf or build from root.');
2019-08-02 04:30:31 +02:00
}
2019-08-02 20:32:58 +02:00
if (os_netbsd) {
2020-11-02 18:23:10 +01:00
pre_text.push('Note that the following instruction is for NetBSD 8.0 and default SH shell.');
2019-08-02 20:32:58 +02:00
}
2021-09-06 13:12:11 +02:00
if (os_mac) {
pre_text.push('Note that the following instruction will build TDLib only for the current architecture (x64 or Apple silicon).');
pre_text.push('If you want to create a universal XCFramework, take a look at our < a href = "https://github.com/tdlib/td/tree/master/example/ios" > example< / a > instead.');
}
2018-10-30 19:17:42 +01:00
2018-11-03 01:09:25 +01:00
var terminal_name = (function () {
if (os_windows) {
return use_powershell ? 'PowerShell' : 'mintty/Bash';
}
if (os_mac) {
return 'Terminal';
}
2019-08-02 04:30:31 +02:00
if (os_openbsd) {
return 'ksh';
}
2019-08-02 20:32:58 +02:00
if (os_netbsd) {
return 'sh';
}
2018-11-07 14:25:56 +01:00
if (use_csh) {
return 'tcsh/csh';
2018-11-03 01:09:25 +01:00
}
return 'Bash';
})();
2018-10-30 11:35:56 +01:00
if (os_windows) {
2020-11-02 18:23:10 +01:00
pre_text.push('Close and re-open ' + terminal_name + ' if the PATH environment variable was changed.');
2018-10-30 11:35:56 +01:00
}
pre_text.push('Run these commands in ' + terminal_name + ' to build TDLib and to install it to ' + install_dir + ':');
document.getElementById('buildPre').innerHTML = '< ul > < li > ' + pre_text.join('< / li > < li > ') + '< / li > < / ul > ';
document.getElementById('buildPre').style.display = 'block';
if (install_dir & & install_dir !== '/usr/local') {
install_dir = '../tdlib';
if (target === 'JNI' || target === 'C++/CX') {
install_dir = '../../' + install_dir;
}
}
var jni_install_dir = '';
if (target === 'JNI') {
jni_install_dir = install_dir;
install_dir = '../example/java/td';
}
2020-08-07 06:09:20 +02:00
function getClangVersionSuffix() {
switch (linux_distro) {
case 'Ubuntu 14':
return '-3.9';
case 'Ubuntu 18':
return '-6.0';
case 'Ubuntu 20':
return '-10';
default:
return ''; // use default version
}
}
2018-10-30 11:35:56 +01:00
var commands = [];
2020-11-08 16:51:35 +01:00
var php = 'php';
var cmake = 'cmake';
2018-10-30 11:35:56 +01:00
if (os_mac) {
commands.push('xcode-select --install');
2020-11-21 12:54:35 +01:00
commands.push('/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"');
2018-10-30 11:35:56 +01:00
commands.push('brew install gperf cmake openssl' + (target === 'JNI' ? ' coreutils' : ''));
if (target === 'JNI') {
2020-11-21 12:54:35 +01:00
commands.push('brew install openjdk');
2018-10-30 11:35:56 +01:00
}
} else if (os_linux & & linux_distro !== 'Other') {
switch (linux_distro) {
case 'Alpine':
commands.push(sudo + 'apk update');
commands.push(sudo + 'apk upgrade');
2020-11-11 14:38:48 +01:00
var packages = 'alpine-sdk linux-headers git zlib-dev openssl-dev gperf php cmake';
2018-10-30 11:35:56 +01:00
if (target === 'JNI') {
packages += ' openjdk8';
}
commands.push(sudo + 'apk add --update ' + packages);
break;
2020-11-08 16:51:35 +01:00
case 'CentOS 7':
case 'CentOS 8':
commands.push(sudo + 'yum update -y');
var packages = 'gcc-c++ make git zlib-devel openssl-devel php';
if (linux_distro === 'CentOS 7') {
commands.push(sudo + 'yum install -y centos-release-scl-rh epel-release');
commands.push(sudo + 'yum install -y devtoolset-9-gcc devtoolset-9-gcc-c++');
cmake = 'cmake3';
packages += ' gperf';
} else {
2021-08-12 19:42:37 +02:00
commands.push(sudo + 'dnf --enablerepo=powertools install gperf');
2020-11-08 16:51:35 +01:00
}
packages += ' ' + cmake;
if (target === 'JNI') {
packages += ' java-11-openjdk-devel';
}
commands.push(sudo + 'yum install -y ' + packages);
break;
2018-10-30 11:35:56 +01:00
case 'Debian 8':
case 'Debian 9':
2019-08-01 20:47:59 +02:00
case 'Debian 10':
2018-10-30 11:35:56 +01:00
case 'Ubuntu 14':
case 'Ubuntu 16':
case 'Ubuntu 18':
2020-07-26 20:04:41 +02:00
case 'Ubuntu 20':
2018-10-30 11:35:56 +01:00
if (linux_distro.includes('Debian') & & !use_root) {
commands.push('su -');
}
if (linux_distro === 'Ubuntu 14' & & !use_clang) {
commands.push(sudo + 'add-apt-repository ppa:ubuntu-toolchain-r/test');
}
commands.push(sudo + 'apt-get update');
commands.push(sudo + 'apt-get upgrade');
var packages = 'make git zlib1g-dev libssl-dev gperf';
if (linux_distro === 'Ubuntu 14' || linux_distro === 'Debian 8') {
2020-11-14 20:12:48 +01:00
packages += ' php5-cli';
2018-10-30 11:35:56 +01:00
} else {
2020-11-14 20:12:48 +01:00
packages += ' php-cli';
2018-10-30 11:35:56 +01:00
}
if (linux_distro === 'Ubuntu 14') {
packages += ' cmake3';
} else {
packages += ' cmake';
}
if (target === 'JNI') {
packages += ' default-jdk';
}
if (use_clang) {
2020-08-07 06:09:20 +02:00
packages += ' clang' + getClangVersionSuffix() + ' libc++-dev';
if (linux_distro === 'Debian 10' || linux_distro === 'Ubuntu 18' || linux_distro === 'Ubuntu 20') {
packages += ' libc++abi-dev';
2018-10-30 11:35:56 +01:00
}
} else {
packages += ' g++';
if (linux_distro === 'Ubuntu 14') {
packages += '-4.9';
}
}
commands.push(sudo + 'apt-get install ' + packages);
if (linux_distro.includes('Debian') & & !use_root) {
commands.push('exit');
}
break;
}
2018-11-03 01:09:25 +01:00
} else if (os_freebsd) {
commands.push(sudo + 'pkg upgrade');
2020-11-11 14:38:48 +01:00
var packages = 'git gperf php72 cmake';
2018-11-03 01:09:25 +01:00
if (target === 'JNI') {
packages += ' openjdk';
}
commands.push(sudo + 'pkg install ' + packages);
2019-08-02 04:30:31 +02:00
} else if (os_openbsd) {
if (!use_root) {
commands.push('su -');
}
var packages = 'git gperf php-7.2.10 cmake';
if (target === 'JNI') {
packages += ' jdk';
}
2020-06-12 21:08:44 +02:00
commands.push('pkg_add -z ' + packages);
2019-08-02 04:30:31 +02:00
if (!use_root) {
commands.push('exit');
}
php = "php-7.2";
2019-08-02 20:32:58 +02:00
} else if (os_netbsd) {
if (!use_root) {
commands.push('su -');
}
commands.push('export PKG_PATH=ftp://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/8.0_2019Q2/All');
var packages = 'git gperf php-7.3.6 cmake openssl gcc5-libs';
commands.push('pkg_add ' + packages);
if (!use_root) {
commands.push('exit');
}
2018-10-30 11:35:56 +01:00
}
commands.push('git clone https://github.com/tdlib/td.git');
commands.push('cd td');
2021-01-28 20:18:33 +01:00
// commands.push('git checkout v1.7.0');
2018-10-30 11:35:56 +01:00
if (use_vcpkg) {
commands.push('git clone https://github.com/Microsoft/vcpkg.git');
commands.push('cd vcpkg');
commands.push(local + 'bootstrap-vcpkg.bat');
if (target === 'C++/CX') {
2021-09-03 18:33:12 +02:00
commands.push(local + 'vcpkg.exe install gperf openssl-uwp:arm-uwp openssl-uwp:x64-uwp openssl-uwp:x86-uwp zlib:arm-uwp zlib:x64-uwp zlib:x86-uwp');
2018-10-30 11:35:56 +01:00
} else {
if (build_64bit) {
2021-09-03 18:33:12 +02:00
commands.push(local + 'vcpkg.exe install gperf openssl:x64-windows zlib:x64-windows');
2018-10-30 11:35:56 +01:00
} else {
2021-09-03 18:33:12 +02:00
commands.push(local + 'vcpkg.exe install gperf openssl:x86-windows zlib:x86-windows');
2018-10-30 11:35:56 +01:00
}
}
commands.push('cd ..');
}
function getBacicCmakeInitOptions() {
var options = [];
if (!use_msvc) {
options.push('-DCMAKE_BUILD_TYPE=' + (is_debug_build ? 'Debug' : 'Release'));
}
2019-09-07 01:14:49 +02:00
if (use_msvc) {
if (build_64bit) {
options.push('-A x64');
} else {
options.push('-A Win32');
}
2018-10-30 11:35:56 +01:00
}
2020-11-22 11:22:59 +01:00
if (target === 'JNI') {
if (os_linux & & linux_distro === 'Alpine') {
options.push('-DJAVA_HOME=/usr/lib/jvm/java-1.8-openjdk/');
}
if (os_freebsd) {
options.push('-DJAVA_HOME=/usr/local/openjdk7/');
}
if (os_mac) {
options.push('-DJAVA_HOME=/usr/local/opt/openjdk/libexec/openjdk.jdk/Contents/Home/');
}
}
2018-10-30 11:35:56 +01:00
return options;
}
if (target === 'C++/CX') {
commands.push('cd example/uwp');
var archiver_option = '';
switch (archiver) {
case 'zip':
archiver_option = ' -compress zip';
break;
case 'WinRAR':
archiver_option = ' -compress winrar';
break;
}
2019-01-08 00:05:25 +01:00
commands.push('powershell -ExecutionPolicy ByPass ' + local + 'build.ps1 -mode clean');
2018-10-30 11:35:56 +01:00
commands.push('powershell -ExecutionPolicy ByPass ' + local + 'build.ps1 -vcpkg_root ../../vcpkg' + archiver_option);
if (install_dir) {
commands.push('cp build-uwp/vsix/tdlib.vsix ' + install_dir);
}
commands.push('cd ../..');
} else {
commands.push(use_powershell ? 'Remove-Item build -Force -Recurse -ErrorAction SilentlyContinue' : 'rm -rf build');
commands.push('mkdir build');
commands.push('cd build');
cmake_init_options = getBacicCmakeInitOptions();
if (os_mac) {
cmake_init_options.push('-DOPENSSL_ROOT_DIR=/usr/local/opt/openssl/');
}
if (install_dir) {
cmake_init_options.push('-DCMAKE_INSTALL_PREFIX:PATH=' + install_dir);
}
if (target === 'JNI') {
cmake_init_options.push('-DTD_ENABLE_JNI=ON');
}
if (target === 'C++/CX' || target === 'C++/CLI') {
cmake_init_options.push('-DTD_ENABLE_DOTNET=ON');
}
if (use_lto) {
cmake_init_options.push('-DTD_ENABLE_LTO=ON');
}
if (use_vcpkg) {
cmake_init_options.push('-DCMAKE_TOOLCHAIN_FILE:FILEPATH=../vcpkg/scripts/buildsystems/vcpkg.cmake');
}
2018-10-30 19:17:42 +01:00
2018-10-30 11:35:56 +01:00
function getCmakeInitCommand(options) {
var prefix = '';
if (os_linux) {
if (use_clang) {
2020-08-07 06:09:20 +02:00
var clang_version_suffix = getClangVersionSuffix();
2020-11-08 19:03:23 +01:00
prefix = 'CXXFLAGS="-stdlib=libc++" CC=/usr/bin/clang' + clang_version_suffix + ' CXX=/usr/bin/clang++' + clang_version_suffix + ' ';
2020-08-07 06:09:20 +02:00
if (use_lto) {
options.push('-DCMAKE_AR=/usr/bin/llvm-ar' + clang_version_suffix);
options.push('-DCMAKE_NM=/usr/bin/llvm-nm' + clang_version_suffix);
options.push('-DCMAKE_OBJDUMP=/usr/bin/llvm-objdump' + clang_version_suffix);
options.push('-DCMAKE_RANLIB=/usr/bin/llvm-ranlib' + clang_version_suffix);
2018-10-30 11:35:56 +01:00
}
} else if (linux_distro === 'Ubuntu 14') {
prefix = 'CC=/usr/bin/gcc-4.9 CXX=/usr/bin/g++-4.9 ';
2020-11-08 16:51:35 +01:00
} else if (linux_distro === 'CentOS 7') {
prefix = 'CC=/opt/rh/devtoolset-9/root/usr/bin/gcc CXX=/opt/rh/devtoolset-9/root/usr/bin/g++ ';
2018-10-30 11:35:56 +01:00
}
}
2020-11-08 16:51:35 +01:00
return prefix + cmake + ' ' + options.join(' ') + ' ..';
2018-10-30 11:35:56 +01:00
}
commands.push(getCmakeInitCommand(cmake_init_options));
if (low_memory) {
2020-11-08 16:51:35 +01:00
commands.push(cmake + ' --build . --target prepare_cross_compiling');
2018-10-30 11:35:56 +01:00
commands.push('cd ..');
2019-08-02 04:30:31 +02:00
commands.push(php + ' SplitSource.php');
2018-10-30 11:35:56 +01:00
commands.push('cd build');
}
2020-11-08 16:51:35 +01:00
let build_command = cmake + ' --build .';
2018-10-30 11:35:56 +01:00
if (install_dir) {
build_command += ' --target install';
}
if (use_msvc) {
2020-10-28 20:44:42 +01:00
if (target === 'C++/CLI' || !is_debug_build) {
2018-10-30 11:35:56 +01:00
commands.push(build_command + ' --config Release');
}
2020-10-28 20:44:42 +01:00
if (target === 'C++/CLI' || is_debug_build) {
2018-10-30 11:35:56 +01:00
commands.push(build_command + ' --config Debug');
}
} else {
commands.push(build_command);
}
if (install_dir & & os_linux & & linux_distro === 'Debian 8') {
commands.push('sed -i "s/LINK_ONLY:td/LINK_ONLY:Td::td/g" ' + install_dir + '/lib/cmake/Td/TdTargets.cmake');
}
commands.push('cd ..');
if (target === 'JNI') {
commands.push('cd example/java');
commands.push(use_powershell ? 'Remove-Item build -Force -Recurse -ErrorAction SilentlyContinue' : 'rm -rf build');
commands.push('mkdir build');
commands.push('cd build');
cmake_init_options = getBacicCmakeInitOptions();
if (jni_install_dir) {
cmake_init_options.push('-DCMAKE_INSTALL_PREFIX:PATH=' + jni_install_dir);
}
if (use_vcpkg) {
cmake_init_options.push('-DCMAKE_TOOLCHAIN_FILE:FILEPATH=../../../vcpkg/scripts/buildsystems/vcpkg.cmake');
}
var is_alpine = os_linux & & linux_distro === 'Alpine';
2019-08-02 20:32:58 +02:00
var resolve_path = use_powershell ? 'Resolve-Path' : (os_mac ? 'greadlink -e' : (is_alpine || os_freebsd || os_openbsd || os_netbsd ? 'readlink -f' : 'readlink -e'));
2018-11-03 01:09:25 +01:00
var resolved_path = resolve_path + ' ../td/lib/cmake/Td';
2018-11-07 14:25:56 +01:00
if (use_csh) {
2018-11-03 01:09:25 +01:00
cmake_init_options.push('-DTd_DIR:PATH=$td_dir');
commands.push('set td_dir=`' + resolved_path + '` ; ' + getCmakeInitCommand(cmake_init_options));
} else {
cmake_init_options.push('-DTd_DIR:PATH=$(' + resolved_path + ')');
commands.push(getCmakeInitCommand(cmake_init_options));
}
2018-10-30 19:17:42 +01:00
2020-11-08 16:51:35 +01:00
build_command = cmake + ' --build .';
2018-10-30 11:35:56 +01:00
if (jni_install_dir) {
build_command += ' --target install';
}
if (use_msvc) {
build_command += (is_debug_build ? ' --config Debug' : ' --config Release');
}
commands.push(build_command);
commands.push('cd ../../..');
} else if (target === 'C++/CX' || target === 'C++/CLI') {
commands.push('git checkout td/telegram/Client.h td/telegram/Log.h td/tl/TlObject.h');
}
if (low_memory) {
2019-08-02 04:30:31 +02:00
commands.push(php + ' SplitSource.php --undo');
2018-10-30 11:35:56 +01:00
}
commands.push('cd ..');
}
2019-10-23 17:58:39 +02:00
if (jni_install_dir) {
install_dir = jni_install_dir;
}
2018-10-30 11:35:56 +01:00
if (install_dir) {
if (install_dir !== '/usr/local') {
install_dir = 'td/tdlib';
}
commands.push((use_powershell ? 'dir ' : 'ls -l ') + install_dir);
}
document.getElementById('buildCommands').innerHTML = '< ul > < li > ' + commands.join('< / li > < li > ') + '< / li > < / ul > ';
}
< / script >
< / body >
< / html >
