Allow user to choose folder for example code

Author: ndabas

build.ps1

@@ -208,6 +208,10 @@ $ExecutionContext.InvokeCommand.ExpandString($template) | Set-Content ".\build\p
 
 exec { .\build\pandoc\pandoc.exe --from gfm --to gfm --output .\build\ReadMe.txt .\docs\tutorial.md }
 
+mkdirp .\build\pico-examples\.vscode
+Copy-Item .\packages\pico-examples\ide\vscode\*.json .\build\pico-examples\.vscode\ -Force
+exec {  tar -a -cf "build\pico-examples.zip" -C "build" "pico-examples" }
+
 $endl = '$\r$\n'
 
 function writeFile {
@@ -239,7 +243,7 @@ function writeFile {
 ; The repos need to be cloned into a dir with a fairly short name, because
 ; CMake generates build defs with long hashes in the paths. Both CMake and
 ; Ninja currently have problems working with long paths on Windows.
-!define PICO_REPOS_DIR "`$LOCALAPPDATA\$productDir"
+!define PICO_REPOS_DIR "`$DOCUMENTS\Pico-v$sdkVersion"
 !define PICO_SHORTCUTS_DIR "`$SMPROGRAMS\$product"
 !define PICO_WINTERM_DIR "`$LOCALAPPDATA\Microsoft\Windows Terminal\Fragments\$product"
 !define PICO_REG_ROOT SHELL_CONTEXT
@@ -274,6 +278,8 @@ InstallDir "`${PICO_INSTALL_DIR}"
 ; We use a version-specific key here so that multiple versions can be installed side-by-side
 InstallDirRegKey HKLM "`${PICO_REG_KEY}" "InstallPath"
 
+Var ReposDir
+
 !ifdef BUILD_UNINSTALLER
 
 OutFile "build\build-uninstaller-$suffix.exe"
@@ -298,8 +304,8 @@ Function un.onInit
   DetailPrint "Install path: `$R0"
   StrCpy `$INSTDIR `$R0
 
-  ReadRegStr `$R1 `${PICO_REG_ROOT} "`${PICO_REG_KEY}" "ReposPath"
-  DetailPrint "Repos path: `$R1"
+  ReadRegStr `$ReposDir HKCU "`${PICO_REG_KEY}" "ReposPath"
+  DetailPrint "Repos path: `$ReposDir"
 
   SetRegView $bitness
 
@@ -337,16 +343,12 @@ Section "Uninstall"
   `${GetParent} "`$INSTDIR" `$R0
   RMDir `$R0
 
-  RMDir /r /REBOOTOK "`$R1\pico-examples"
-  RMDir /r /REBOOTOK "`$R1\pico-extras"
-  RMDir /r /REBOOTOK "`$R1\pico-playground"
-  RMDir /r /REBOOTOK "`$R1\pico-project-generator"
-  RMDir /r /REBOOTOK "`$R1\pico-sdk"
-
-  RMDir /REBOOTOK "`$R1"
-  ; Remove the C:\ProgramData\Raspberry Pi directory if it is empty
-  `${GetParent} "`$R1" `$R0
-  RMDir `$R0
+  `${If} `$ReposDir != ""
+    RMDir /r /REBOOTOK "`$ReposDir\pico-examples"
+    RMDir /r /REBOOTOK "`$ReposDir\pico-extras"
+    RMDir /r /REBOOTOK "`$ReposDir\pico-playground"
+    RMDir "`$ReposDir"
+  `${EndIf}
 
   DeleteRegValue `${PICO_REG_ROOT} "Software\Kitware\CMake\Packages\pico-sdk-tools" "v$sdkVersion"
   DeleteRegKey /ifempty `${PICO_REG_ROOT} "Software\Kitware\CMake\Packages\pico-sdk-tools"
@@ -370,32 +372,41 @@ SectionEnd
 OutFile "$binfile"
 
 !define MUI_ICON "resources\raspberrypi.ico"
-
 !define MUI_ABORTWARNING
-
 !define MUI_WELCOMEPAGE_TITLE "`${TITLE}"
 
-;!define MUI_COMPONENTSPAGE_SMALLDESC
-
-!define MUI_FINISHPAGE_RUN_TEXT "Clone and build Pico repos"
-!define MUI_FINISHPAGE_RUN
-!define MUI_FINISHPAGE_RUN_FUNCTION RunBuild
-
-!define MUI_FINISHPAGE_SHOWREADME "`$INSTDIR\ReadMe.txt"
-!define MUI_FINISHPAGE_SHOWREADME_TEXT "Show ReadMe"
-
-!define MUI_FINISHPAGE_NOAUTOCLOSE
-
 !insertmacro MUI_PAGE_WELCOME
 $($componentSelection ? '!insertmacro MUI_PAGE_COMPONENTS' : '')
 !insertmacro MUI_PAGE_DIRECTORY
+!define MUI_PAGE_CUSTOMFUNCTION_LEAVE DumpLog
 !insertmacro MUI_PAGE_INSTFILES
+
+!define FINISHPAGE_RUN_FUNCTION RunBuild
+!define MUI_FINISHPAGE_SHOWREADME "`$INSTDIR\ReadMe.txt"
+!define MUI_FINISHPAGE_SHOWREADME_TEXT "Show ReadMe"
+!include "packages\pico-setup-windows\FinishPage.nsh"
 !insertmacro MUI_PAGE_FINISH
 
 !insertmacro MUI_LANGUAGE "English"
 
 Function .onInit
 
+  StrCpy `$ReposDir "`${PICO_REPOS_DIR}"
+
+  ReadRegStr `$R0 HKCU "`${PICO_REG_KEY}" "ReposPath"
+  `${If} `$R0 != ""
+    StrCpy `$ReposDir "`$R0"
+  `${EndIf}
+
+  ClearErrors
+  `${GetParameters} `$R1
+  `${GetOptions} "`$R1" "/REPOSDIR=" `$R0
+  `${IfNot} `${Errors}
+    StrCpy `$ReposDir "`$R0"
+  `${EndIf}
+
+  DetailPrint "Repos path: `$ReposDir"
+
   SetShellVarContext all
   SetRegView $bitness
 
@@ -430,10 +441,8 @@ Section
   ; Save install paths in the 32-bit registry for ease of access from NSIS (un)installers
   SetRegView 32
   WriteRegStr `${PICO_REG_ROOT} "`${PICO_REG_KEY}" "InstallPath" "`$INSTDIR"
-  WriteRegStr `${PICO_REG_ROOT} "`${PICO_REG_KEY}" "ReposPath" "`${PICO_REPOS_DIR}"
   SetRegView $bitness
 
-  CreateDirectory "`${PICO_REPOS_DIR}"
   CreateDirectory "`${PICO_SHORTCUTS_DIR}"
 
   SetOutPath `$INSTDIR\resources
@@ -510,18 +519,9 @@ SectionEnd
 
 Section "-Pico environment" SecPico
 
-  SetOutPath "`${PICO_REPOS_DIR}\pico-sdk"
+  SetOutPath "`$INSTDIR\pico-sdk"
   File /r "build\pico-sdk\*.*"
 
-  SetOutPath "`${PICO_REPOS_DIR}\pico-examples"
-  File /r "build\pico-examples\*.*"
-  SetOutPath "`${PICO_REPOS_DIR}\pico-examples\.vscode"
-  File "packages\pico-examples\ide\vscode\cmake-kits.json"
-  File "packages\pico-examples\ide\vscode\extensions.json"
-  File "packages\pico-examples\ide\vscode\launch.json"
-  File "packages\pico-examples\ide\vscode\settings.json"
-  File "packages\pico-examples\ide\vscode\tasks.json"
-
   SetOutPath "`$INSTDIR\pico-sdk-tools"
   File "build\pico-sdk-tools\mingw$bitness\*.*"
   WriteRegStr `${PICO_REG_ROOT} "Software\Kitware\CMake\Packages\pico-sdk-tools" "v$sdkVersion" "`$INSTDIR\pico-sdk-tools"
@@ -530,15 +530,15 @@ Section "-Pico environment" SecPico
   File "build\picotool-install\mingw$bitness\*.*"
 
   SetOutPath "`$INSTDIR"
+  File "build\pico-examples.zip"
   WriteINIStr "`$INSTDIR\version.ini" "pico-setup-windows" "PICO_SDK_VERSION" "$sdkVersion"
-  WriteINIStr "`$INSTDIR\version.ini" "pico-setup-windows" "PICO_REPOS_PATH" "`${PICO_REPOS_DIR}"
   WriteINIStr "`$INSTDIR\version.ini" "pico-setup-windows" "PICO_INSTALL_PATH" "`$INSTDIR"
+  WriteINIStr "`$INSTDIR\version.ini" "pico-setup-windows" "PICO_REG_KEY" "`${PICO_REG_KEY}"
   File "packages\pico-setup-windows\pico-code.ps1"
   File "packages\pico-setup-windows\pico-env.ps1"
   File "packages\pico-setup-windows\pico-env.cmd"
   File "packages\pico-setup-windows\pico-setup.cmd"
   File "build\ReadMe.txt"
-  CreateShortcut "`$INSTDIR\pico-setup.lnk" "cmd.exe" '/k call "`$INSTDIR\pico-setup.cmd" 1'
 
   File /oname=uninstall.exe "build\uninstall-$suffix.exe"
   WriteRegStr `${PICO_REG_ROOT} "`${UNINSTALL_KEY}" "DisplayName" "$product"
@@ -563,29 +563,26 @@ Section "-Pico environment" SecPico
     MessageBox MB_OK|MB_ICONEXCLAMATION "Installation of Visual Studio Code failed. Please install it manually by downloading the installer from:${endl}${endl}https://code.visualstudio.com/" /SD IDOK
   `${EndIf}
 
-  ; Set the working directory for our terminals to the repos directory
-  SetOutPath "`${PICO_REPOS_DIR}"
   `${CreateShortcutEx} "`${PICO_SHORTCUTS_DIR}\Pico - Developer Command Prompt.lnk" "`${PICO_AppUserModel_ID}!cmd" ``"cmd.exe" '/k "`$INSTDIR\pico-env.cmd"'``
   `${CreateShortcutEx} "`${PICO_SHORTCUTS_DIR}\Pico - Developer PowerShell.lnk" "`${PICO_AppUserModel_ID}!powershell" ``"powershell.exe" '-NoExit -ExecutionPolicy Bypass -File "`$INSTDIR\pico-env.ps1"'``
   `${CreateShortcutEx} "`${PICO_SHORTCUTS_DIR}\Pico - Visual Studio Code.lnk" "`${PICO_AppUserModel_ID}!code" ``"powershell.exe" '-NoProfile -WindowStyle Hidden -ExecutionPolicy Bypass -File "`$INSTDIR\pico-code.ps1"' "`$1" "" SW_SHOWMINIMIZED``
 
   SetOutPath "`${PICO_WINTERM_DIR}"
   `${WordReplace} "`$INSTDIR" "\" "\\" "+" `$7
-  `${WordReplace} "`${PICO_REPOS_DIR}" "\" "\\" "+" `$8
   $( @"
 {
   "profiles": [
     {
       "name": "Pico - Developer Command Prompt (SDK v$sdkVersion)",
       "commandline": "cmd.exe /k \"`$7\\pico-env.cmd\"",
       "icon": "`$7\\resources\\raspberrypi.ico",
-      "startingDirectory": "`$8"
+      "startingDirectory": "`$7"
     },
     {
       "name": "Pico - Developer PowerShell (SDK v$sdkVersion)",
       "commandline": "powershell.exe -NoExit -ExecutionPolicy Bypass -File \"`$7\\pico-env.ps1\"",
       "icon": "`$7\\resources\\raspberrypi.ico",
-      "startingDirectory": "`$8"
+      "startingDirectory": "`$7"
     }
   ]
 }
@@ -607,6 +604,8 @@ Function RunBuild
   ; We need to run pico-setup.cmd un-elevated, to avoid problems with builds later on.
   ; So we create a shortcut with the command line to use, and have explorer.exe launch it.
   ; http://mdb-blog.blogspot.com/2013/01/nsis-lunch-program-as-user-from-uac.html
+  SetShellVarContext current
+  CreateShortcut "`$INSTDIR\pico-setup.lnk" "cmd.exe" '/k call "`$INSTDIR\pico-setup.cmd" "`$ReposDir" 1'
   Exec '"`$WINDIR\explorer.exe" "`$INSTDIR\pico-setup.lnk"'
 
 FunctionEnd

packages/pico-setup-windows/FinishPage.nsh

@@ -0,0 +1,61 @@
+!define MUI_FINISHPAGE_NOREBOOTSUPPORT
+!define MUI_PAGE_CUSTOMFUNCTION_SHOW OnFinishPageShow
+!define MUI_PAGE_CUSTOMFUNCTION_LEAVE OnFinishPageLeave
+
+Var FinishPage.CloneCheckbox
+Var FinishPage.ReposDirTextBox
+Var FinishPage.BrowseButton
+
+Function OnFinishPageShow
+
+  ${NSD_CreateCheckbox} 120u 110u 195u 10u "Clone and build examples in this folder:"
+  Pop $FinishPage.CloneCheckbox
+  SetCtlColors $FinishPage.CloneCheckbox "${MUI_TEXTCOLOR}" "${MUI_BGCOLOR}"
+  ${NSD_SetState} $FinishPage.CloneCheckbox ${BST_CHECKED}
+  ${NSD_OnClick} $FinishPage.CloneCheckbox OnCloneCheckboxChange
+
+  ${NSD_CreateText} 120u 130u 125u 12u "$ReposDir"
+  Pop $FinishPage.ReposDirTextBox
+  SetCtlColors $FinishPage.ReposDirTextBox "${MUI_TEXTCOLOR}" "${MUI_BGCOLOR}"
+
+  ${NSD_CreateButton} 255u 128u 60u 15u "Browse..."
+  Pop $FinishPage.BrowseButton
+  ${NSD_OnClick} $FinishPage.BrowseButton OnBrowseButtonClick
+
+FunctionEnd
+
+Function OnCloneCheckboxChange
+
+  Pop $R0
+  ${NSD_GetState} $R0 $R1
+  ${If} $R1 == ${BST_CHECKED}
+    StrCpy $R2 1
+  ${Else}
+    StrCpy $R2 0
+  ${EndIf}
+  EnableWindow $FinishPage.ReposDirTextBox $R2
+  EnableWindow $FinishPage.BrowseButton $R2
+
+FunctionEnd
+
+Function OnBrowseButtonClick
+
+  Pop $R0
+  ${NSD_GetText} $FinishPage.ReposDirTextBox $R1
+  nsDialogs::SelectFolderDialog "Select example code folder" "$R1"
+  Pop $R1
+  ${If} "$R1" != "error"
+      ${NSD_SetText} $FinishPage.ReposDirTextBox "$R1"
+  ${EndIf}
+
+FunctionEnd
+
+Function OnFinishPageLeave
+
+  ${NSD_GetState} $FinishPage.CloneCheckbox $R1
+  ${If} $R1 == ${BST_CHECKED}
+    ${NSD_GetText} $FinishPage.ReposDirTextBox $ReposDir
+    Call ${FINISHPAGE_RUN_FUNCTION}
+  ${EndIf}
+
+FunctionEnd

packages/pico-setup-windows/pico-code.ps1

@@ -6,7 +6,7 @@ $ProgressPreference = 'SilentlyContinue'
 
 # On first run, open the pico-examples repo. Open a blank VS Code instance otherwise.
 $openArgs = "--disable-workspace-trust --new-window `"$env:PICO_EXAMPLES_PATH`""
-$regPath = "HKCU:\Software\Raspberry Pi\Pico SDK v$env:PICO_SDK_VERSION"
+$regPath = "HKCU:\$env:PICO_REG_KEY"
 
 if (-not (Test-Path $regPath)) {
   New-Item -Path $regPath -Force

packages/pico-setup-windows/pico-env.cmd

@@ -22,6 +22,18 @@ goto main
 
   goto :EOF
 
+:SetEnvFromRegistry
+
+  rem https://stackoverflow.com/questions/22352793/reading-a-registry-value-to-a-batch-variable-handling-spaces-in-value
+  for /f "usebackq tokens=2,*" %%h in (
+    `"reg query "HKCU\%PICO_REG_KEY%" /v "%1Path" 2>NUL | find /i "%1Path""`
+    ) do (
+    echo PICO_%1_PATH=%%i
+    set "PICO_%1_PATH=%%i"
+  )
+
+  goto :EOF
+
 :main
 
 pushd "%~dp0"
@@ -31,12 +43,22 @@ for /f "skip=1 tokens=*" %%i in (version.ini) do (
   set "%%i"
 )
 
+popd
+
 if not defined PICO_SDK_VERSION (
   echo ERROR: Unable to determine Pico SDK version.
   set /a errors += 1
 )
 
-for %%i in (sdk examples extras playground) do (
+if "%~1" neq "" (
+  reg add "HKCU\%PICO_REG_KEY%" /v ReposPath /d "%~1" /f
+)
+
+set "PICO_SDK_PATH=%PICO_INSTALL_PATH%\pico-sdk"
+
+call :SetEnvFromRegistry repos
+
+for %%i in (examples extras playground) do (
   rem Environment variables in Windows aren't case-sensitive, so we don't need
   rem to bother with uppercasing the env var name.
   if exist "%PICO_REPOS_PATH%\pico-%%i" (
@@ -45,8 +67,6 @@ for %%i in (sdk examples extras playground) do (
   )
 )
 
-popd
-
 if exist "%PICO_INSTALL_PATH%\openocd" (
   echo OPENOCD_SCRIPTS=%PICO_INSTALL_PATH%\openocd\scripts
   set "OPENOCD_SCRIPTS=%PICO_INSTALL_PATH%\openocd\scripts"

packages/pico-setup-windows/pico-setup.cmd

@@ -1,6 +1,12 @@
-set interactive=%~1
+@if not defined _echo echo off
 
-call "%~dp0pico-env.cmd" || exit /b 1
+set interactive=%~2
+
+mkdir "%~1"
+echo Copying pico-examples...
+powershell -NoProfile -ExecutionPolicy Bypass -Command "Expand-Archive """%~dp0pico-examples.zip""" -DestinationPath """%~1""" -Force" || exit /b 1
+
+call "%~dp0pico-env.cmd" "%~1" || exit /b 1
 setlocal enabledelayedexpansion
 
 rem This is mostly a port of pico-setup
@@ -12,7 +18,7 @@ set "SDK_BRANCH=master"
 
 pushd "%PICO_REPOS_PATH%"
 
-for %%i in (sdk examples extras playground project-generator) do (
+for %%i in (examples extras playground) do (
   set "DEST=%PICO_REPOS_PATH%\pico-%%i"
 
   if exist "!DEST!\.git" (