xref: /aosp_15_r20/external/pigweed/bootstrap.bat (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1:<<"::WINDOWS_ONLY"
2@echo off
3:: Copyright 2020 The Pigweed Authors
4::
5:: Licensed under the Apache License, Version 2.0 (the "License"); you may not
6:: use this file except in compliance with the License. You may obtain a copy of
7:: the License at
8::
9::     https://www.apache.org/licenses/LICENSE-2.0
10::
11:: Unless required by applicable law or agreed to in writing, software
12:: distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13:: WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14:: License for the specific language governing permissions and limitations under
15:: the License.
16::WINDOWS_ONLY
17:; echo "ERROR: Attempting to run Windows .bat from a Unix/POSIX shell!"
18:; echo "Instead, run the following command."
19:; echo ""
20:; echo "    source ./bootstrap.sh"
21:; echo ""
22:<<"::WINDOWS_ONLY"
23
24:: Pigweed Windows environment setup.
25
26:: WARNING: Multi-line "if" statements can be dangerous!
27::
28:: Example:
29::  call do_foo
30::  if [expression] (
31::    call cmd_a
32::    set my_var = %ERRORLEVEL%
33::    call final_script --flag %my_var%
34::  )
35:: Batch evaluates these expressions in a way that will produce unexpected
36:: behavior. It appears that when each line is executed, it does not affect
37:: local context until the entire expression is complete. In this example,
38:: ERRORLEVEL does not reflect `call cmd_a`, but whatever residual state was
39:: present from `do_foo`. Similarly, in the call to `final_script`, `my_var`
40:: will NOT be valid as the variable `set` doesn't apply until the entire `if`
41:: expression completes.
42:: This script only uses multi-line if statements to `goto` after an operation.
43
44:: If PW_CHECKOUT_ROOT is set, use it. Users should not set this variable.
45:: It's used because when one batch script invokes another the Powershell magic
46:: below doesn't work. To reinforce that users should not be using
47:: PW_CHECKOUT_ROOT, it is cleared here after it is used, and other pw tools
48:: will complain if they see that variable set.
49:: TODO(mohrr) find out a way to do this without PW_CHECKOUT_ROOT.
50
51:: ~dp0 is the batchism for the directory in which a .bat file resides.
52if "%PW_CHECKOUT_ROOT%"=="" ^
53set "PW_ROOT=%~dp0." &^
54goto select_python
55
56:: Since PW_CHECKOUT_ROOT is set, use it.
57set "PW_ROOT=%PW_CHECKOUT_ROOT%"
58set "PW_CHECKOUT_ROOT="
59
60:select_python
61:: Allow forcing a specific Python version through the environment variable
62:: PW_BOOTSTRAP_PYTHON. Otherwise, use the system Python if one exists.
63if not "%PW_BOOTSTRAP_PYTHON%" == "" (
64  set "python=%PW_BOOTSTRAP_PYTHON%"
65  goto find_environment_root
66)
67
68:: Detect python installation.
69where python >NUL 2>&1
70if %ERRORLEVEL% EQU 0 (
71  set "python=python"
72  goto find_environment_root
73)
74
75echo.
76echo Error: no system Python present
77echo.
78echo   Pigweed's bootstrap process requires a local system Python.
79echo   Please install Python on your system, add it to your PATH
80echo   and re-try running bootstrap.
81goto finish
82
83
84:find_environment_root
85:: PW_ENVIRONMENT_ROOT allows developers to specify where the environment should
86:: be installed. _PW_ACTUAL_ENVIRONMENT_ROOT is where Pigweed keeps that
87:: information. This separation allows Pigweed to assume PW_ENVIRONMENT_ROOT
88:: came from the developer and not from a previous bootstrap possibly from
89:: another workspace.
90
91if "%PW_PROJECT_ROOT%"=="" set "PW_PROJECT_ROOT=%PW_ROOT%"
92
93if "%PW_ENVIRONMENT_ROOT%"=="" (
94  set "_PW_ACTUAL_ENVIRONMENT_ROOT=%PW_PROJECT_ROOT%\environment"
95) else (
96  set "_PW_ACTUAL_ENVIRONMENT_ROOT=%PW_ENVIRONMENT_ROOT%"
97)
98
99set "shell_file=%_PW_ACTUAL_ENVIRONMENT_ROOT%\activate.bat"
100
101set "_pw_start_script=%PW_ROOT%\pw_env_setup\py\pw_env_setup\windows_env_start.py"
102
103:: If PW_SKIP_BOOTSTRAP is set, only run the activation stage instead of the
104:: complete env_setup.
105if not "%PW_SKIP_BOOTSTRAP%" == "" goto skip_bootstrap
106
107:: Without the trailing slash in %PW_ROOT%/, batch combines that token with
108:: the --shell-file argument.
109call "%python%" "%PW_ROOT%\pw_env_setup\py\pw_env_setup\env_setup.py" ^
110    --pw-root "%PW_ROOT%" ^
111    --shell-file "%shell_file%" ^
112    --install-dir "%_PW_ACTUAL_ENVIRONMENT_ROOT%" ^
113    --project-root "%PW_PROJECT_ROOT%"
114goto activate_shell
115
116:skip_bootstrap
117if exist "%shell_file%" (
118  call "%python%" "%_pw_start_script%"
119) else (
120  call "%python%" "%_pw_start_script%" --no-shell-file
121  goto finish
122)
123
124:activate_shell
125if exist "%shell_file%" (
126  call "%shell_file%"
127) else (
128  echo.
129  echo  Bootstrap failed! See output above for the culprit.
130  echo.
131)
132
133:finish
134::WINDOWS_ONLY
135