dfc5b329af
- Improved the vcpkg path checking mechanism to include additional common installation locations and check for global installations. - Added support for manifest mode by detecting the presence of a vcpkg.json file, allowing automatic dependency management. - Enhanced output messages to provide clearer feedback on vcpkg usage and installation status, improving user experience.
410 lines
17 KiB
PowerShell
410 lines
17 KiB
PowerShell
# Configure Visual Studio project files for YAZE
|
|
# This script configures CMake build system to work with existing Visual Studio project files
|
|
|
|
param(
|
|
[string]$Configuration = "Debug",
|
|
[string]$Architecture = "x64",
|
|
[switch]$Clean = $false,
|
|
[switch]$UseVcpkg = $false,
|
|
[switch]$Help = $false
|
|
)
|
|
|
|
# Show help if requested
|
|
if ($Help) {
|
|
Write-Host "Usage: .\generate-vs-projects.ps1 [options]"
|
|
Write-Host ""
|
|
Write-Host "Options:"
|
|
Write-Host " -Configuration <config> Build configuration (Debug, Release, RelWithDebInfo, MinSizeRel)"
|
|
Write-Host " -Architecture <arch> Target architecture (x64, x86, ARM64)"
|
|
Write-Host " -Clean Clean build directory before configuring"
|
|
Write-Host " -UseVcpkg Use vcpkg for dependency management"
|
|
Write-Host " -Help Show this help message"
|
|
Write-Host ""
|
|
Write-Host "Examples:"
|
|
Write-Host " .\generate-vs-projects.ps1 # Default: Debug x64"
|
|
Write-Host " .\generate-vs-projects.ps1 -Configuration Release -Architecture x86"
|
|
Write-Host " .\generate-vs-projects.ps1 -Clean -UseVcpkg"
|
|
Write-Host ""
|
|
Write-Host "Note: This script configures CMake to work with existing YAZE.sln and YAZE.vcxproj files"
|
|
exit 0
|
|
}
|
|
|
|
# Validate architecture parameter
|
|
$ValidArchitectures = @("x64", "x86", "ARM64")
|
|
if ($Architecture -notin $ValidArchitectures) {
|
|
Write-Host "Invalid architecture: $Architecture" -ForegroundColor Red
|
|
Write-Host "Valid architectures: $($ValidArchitectures -join ', ')" -ForegroundColor Yellow
|
|
exit 1
|
|
}
|
|
|
|
Write-Host "Generating Visual Studio project files for YAZE..." -ForegroundColor Green
|
|
|
|
# Check if we're on Windows
|
|
if ($env:OS -ne "Windows_NT") {
|
|
Write-Host "This script is designed for Windows. Use CMake presets on other platforms." -ForegroundColor Yellow
|
|
Write-Host "Available presets:" -ForegroundColor Cyan
|
|
Write-Host " - windows-debug" -ForegroundColor Gray
|
|
Write-Host " - windows-release" -ForegroundColor Gray
|
|
Write-Host " - windows-dev" -ForegroundColor Gray
|
|
exit 1
|
|
}
|
|
|
|
# Check if CMake is available
|
|
$cmakePath = Get-Command cmake -ErrorAction SilentlyContinue
|
|
if (-not $cmakePath) {
|
|
# Try common CMake installation paths
|
|
$commonPaths = @(
|
|
"C:\Program Files\CMake\bin\cmake.exe",
|
|
"C:\Program Files (x86)\CMake\bin\cmake.exe",
|
|
"C:\cmake\bin\cmake.exe"
|
|
)
|
|
|
|
foreach ($path in $commonPaths) {
|
|
if (Test-Path $path) {
|
|
Write-Host "Found CMake at: $path" -ForegroundColor Green
|
|
$env:Path += ";$(Split-Path $path)"
|
|
$cmakePath = Get-Command cmake -ErrorAction SilentlyContinue
|
|
if ($cmakePath) {
|
|
break
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (-not $cmakePath) {
|
|
Write-Host "CMake not found in PATH. Attempting to install..." -ForegroundColor Yellow
|
|
|
|
# Try to install CMake via Chocolatey
|
|
if (Get-Command choco -ErrorAction SilentlyContinue) {
|
|
Write-Host "Installing CMake via Chocolatey..." -ForegroundColor Yellow
|
|
choco install -y cmake
|
|
if ($LASTEXITCODE -eq 0) {
|
|
Write-Host "CMake installed successfully" -ForegroundColor Green
|
|
# Refresh PATH
|
|
$env:Path = [System.Environment]::GetEnvironmentVariable("Path", "Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path", "User")
|
|
} else {
|
|
Write-Host "Failed to install CMake via Chocolatey" -ForegroundColor Red
|
|
}
|
|
} else {
|
|
Write-Host "Chocolatey not found. Please install CMake manually:" -ForegroundColor Red
|
|
Write-Host "1. Download from: https://cmake.org/download/" -ForegroundColor Yellow
|
|
Write-Host "2. Or install Chocolatey first: https://chocolatey.org/install" -ForegroundColor Yellow
|
|
Write-Host "3. Then run: choco install cmake" -ForegroundColor Yellow
|
|
exit 1
|
|
}
|
|
|
|
# Check again after installation
|
|
$cmakePath = Get-Command cmake -ErrorAction SilentlyContinue
|
|
if (-not $cmakePath) {
|
|
Write-Host "CMake still not found after installation. Please restart your terminal or add CMake to PATH manually." -ForegroundColor Red
|
|
exit 1
|
|
}
|
|
}
|
|
|
|
Write-Host "CMake found: $($cmakePath.Source)" -ForegroundColor Green
|
|
|
|
# Check if Visual Studio is available
|
|
$vsWhere = Get-Command "C:\Program Files (x86)\Microsoft Visual Studio\Installer\vswhere.exe" -ErrorAction SilentlyContinue
|
|
if (-not $vsWhere) {
|
|
$vsWhere = Get-Command vswhere -ErrorAction SilentlyContinue
|
|
}
|
|
|
|
if ($vsWhere) {
|
|
$vsInstallPath = & $vsWhere.Source -latest -products * -requires Microsoft.VisualStudio.Component.VC.Tools.x86.x64 -property installationPath
|
|
if ($vsInstallPath) {
|
|
Write-Host "Visual Studio found at: $vsInstallPath" -ForegroundColor Green
|
|
} else {
|
|
Write-Host "Visual Studio 2022 not found. Please install Visual Studio 2022 with C++ workload." -ForegroundColor Yellow
|
|
}
|
|
} else {
|
|
Write-Host "vswhere not found. Assuming Visual Studio is available." -ForegroundColor Yellow
|
|
}
|
|
|
|
# Set up paths
|
|
$SourceDir = Split-Path -Parent $PSScriptRoot
|
|
$BuildDir = Join-Path $SourceDir "build-vs"
|
|
|
|
Write-Host "Source directory: $SourceDir" -ForegroundColor Cyan
|
|
Write-Host "Build directory: $BuildDir" -ForegroundColor Cyan
|
|
|
|
# Clean build directory if requested
|
|
if ($Clean -and (Test-Path $BuildDir)) {
|
|
Write-Host "Cleaning build directory..." -ForegroundColor Yellow
|
|
Remove-Item -Recurse -Force $BuildDir
|
|
}
|
|
|
|
# Create build directory
|
|
if (-not (Test-Path $BuildDir)) {
|
|
New-Item -ItemType Directory -Path $BuildDir | Out-Null
|
|
}
|
|
|
|
# Check if vcpkg is available and properly configured
|
|
$VcpkgPath = Join-Path $SourceDir "vcpkg\scripts\buildsystems\vcpkg.cmake"
|
|
$VcpkgInstalled = Join-Path $SourceDir "vcpkg\installed"
|
|
|
|
# Check for vcpkg in common locations (including global installations)
|
|
$VcpkgPaths = @(
|
|
(Join-Path $SourceDir "vcpkg\scripts\buildsystems\vcpkg.cmake"),
|
|
"$env:VCPKG_ROOT\scripts\buildsystems\vcpkg.cmake",
|
|
"$env:ProgramFiles\vcpkg\scripts\buildsystems\vcpkg.cmake",
|
|
"$env:ProgramFiles(x86)\vcpkg\scripts\buildsystems\vcpkg.cmake",
|
|
"$env:LOCALAPPDATA\vcpkg\scripts\buildsystems\vcpkg.cmake"
|
|
)
|
|
|
|
# Also check if vcpkg is available in PATH (for global installations)
|
|
$VcpkgExe = Get-Command vcpkg -ErrorAction SilentlyContinue
|
|
|
|
$UseVcpkg = $false
|
|
foreach ($path in $VcpkgPaths) {
|
|
if (Test-Path $path) {
|
|
$VcpkgPath = $path
|
|
$UseVcpkg = $true
|
|
break
|
|
}
|
|
}
|
|
|
|
# If no local vcpkg found but vcpkg.exe is in PATH, check for manifest mode
|
|
if (-not $UseVcpkg -and $VcpkgExe) {
|
|
# Check if we have a vcpkg.json manifest file (indicates manifest mode)
|
|
$VcpkgManifest = Join-Path $SourceDir "vcpkg.json"
|
|
if (Test-Path $VcpkgManifest) {
|
|
Write-Host "Found vcpkg.json manifest file, using vcpkg in manifest mode" -ForegroundColor Green
|
|
$UseVcpkg = $true
|
|
# For manifest mode, we don't need to specify the toolchain file explicitly
|
|
# CMake will automatically detect and use vcpkg
|
|
}
|
|
}
|
|
|
|
if ($UseVcpkg) {
|
|
# Check if we're using manifest mode
|
|
$VcpkgManifest = Join-Path $SourceDir "vcpkg.json"
|
|
if (Test-Path $VcpkgManifest) {
|
|
Write-Host "Using vcpkg in manifest mode" -ForegroundColor Green
|
|
Write-Host "vcpkg will automatically install dependencies from vcpkg.json" -ForegroundColor Green
|
|
|
|
# Check if vcpkg is available in PATH
|
|
if ($VcpkgExe) {
|
|
Write-Host "vcpkg executable found: $($VcpkgExe.Source)" -ForegroundColor Green
|
|
} else {
|
|
Write-Host "vcpkg not found in PATH. Please ensure vcpkg is installed and available." -ForegroundColor Yellow
|
|
Write-Host "You can install vcpkg from: https://github.com/Microsoft/vcpkg" -ForegroundColor Yellow
|
|
}
|
|
} else {
|
|
Write-Host "Using vcpkg toolchain: $VcpkgPath" -ForegroundColor Green
|
|
|
|
# Check if vcpkg is properly installed with required packages
|
|
if (Test-Path $VcpkgInstalled) {
|
|
Write-Host "vcpkg packages directory found: $VcpkgInstalled" -ForegroundColor Green
|
|
} else {
|
|
Write-Host "vcpkg packages not installed. Installing dependencies..." -ForegroundColor Yellow
|
|
|
|
# Try to install vcpkg dependencies
|
|
$VcpkgExe = Join-Path (Split-Path $VcpkgPath -Parent -Parent) "vcpkg.exe"
|
|
if (Test-Path $VcpkgExe) {
|
|
Write-Host "Installing vcpkg dependencies..." -ForegroundColor Yellow
|
|
& $VcpkgExe install --triplet $Architecture-windows
|
|
if ($LASTEXITCODE -ne 0) {
|
|
Write-Host "Failed to install vcpkg dependencies" -ForegroundColor Red
|
|
Write-Host "Please run: vcpkg install --triplet $Architecture-windows" -ForegroundColor Yellow
|
|
}
|
|
} else {
|
|
Write-Host "vcpkg.exe not found. Please install dependencies manually." -ForegroundColor Yellow
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
Write-Host "vcpkg not found, using system libraries" -ForegroundColor Yellow
|
|
Write-Host "Note: This may cause missing dependency issues. Consider installing vcpkg." -ForegroundColor Yellow
|
|
}
|
|
|
|
# Determine generator and architecture
|
|
$Generator = "Visual Studio 17 2022"
|
|
$ArchFlag = if ($Architecture -eq "x64") { "-A x64" } else { "-A Win32" }
|
|
|
|
# Build CMake command
|
|
$CmakeArgs = @(
|
|
"-B", $BuildDir,
|
|
"-G", "`"$Generator`"",
|
|
$ArchFlag,
|
|
"-DCMAKE_BUILD_TYPE=$Configuration",
|
|
"-DCMAKE_POLICY_VERSION_MINIMUM=3.5",
|
|
"-DCMAKE_POLICY_VERSION_MAXIMUM=3.28",
|
|
"-DCMAKE_WARN_DEPRECATED=OFF",
|
|
"-DABSL_PROPAGATE_CXX_STD=ON",
|
|
"-DTHREADS_PREFER_PTHREAD_FLAG=OFF",
|
|
"-DYAZE_BUILD_TESTS=ON",
|
|
"-DYAZE_BUILD_APP=ON",
|
|
"-DYAZE_BUILD_LIB=ON",
|
|
"-DYAZE_BUILD_EMU=ON",
|
|
"-DYAZE_BUILD_Z3ED=ON",
|
|
"-DYAZE_ENABLE_ROM_TESTS=OFF",
|
|
"-DYAZE_ENABLE_EXPERIMENTAL_TESTS=ON",
|
|
"-DYAZE_ENABLE_UI_TESTS=ON",
|
|
"-DYAZE_INSTALL_LIB=OFF",
|
|
"-DCMAKE_EXPORT_COMPILE_COMMANDS=ON",
|
|
"-DCMAKE_VERBOSE_MAKEFILE=ON"
|
|
)
|
|
|
|
if ($UseVcpkg) {
|
|
# Check if we're using manifest mode (vcpkg.json present)
|
|
$VcpkgManifest = Join-Path $SourceDir "vcpkg.json"
|
|
if (Test-Path $VcpkgManifest) {
|
|
# Manifest mode - CMake will automatically detect vcpkg
|
|
Write-Host "Using vcpkg in manifest mode" -ForegroundColor Green
|
|
$CmakeArgs += @(
|
|
"-DVCPKG_TARGET_TRIPLET=$Architecture-windows",
|
|
"-DVCPKG_MANIFEST_MODE=ON"
|
|
)
|
|
} else {
|
|
# Classic mode - specify toolchain file
|
|
Write-Host "Using vcpkg in classic mode with toolchain: $VcpkgPath" -ForegroundColor Green
|
|
$CmakeArgs += @(
|
|
"-DCMAKE_TOOLCHAIN_FILE=`"$VcpkgPath`"",
|
|
"-DVCPKG_TARGET_TRIPLET=$Architecture-windows"
|
|
)
|
|
}
|
|
}
|
|
|
|
# Configure CMake to generate Visual Studio project files
|
|
Write-Host "Configuring CMake to generate Visual Studio project files..." -ForegroundColor Yellow
|
|
Write-Host "Command: cmake $($CmakeArgs -join ' ')" -ForegroundColor Gray
|
|
|
|
& cmake @CmakeArgs $SourceDir
|
|
|
|
if ($LASTEXITCODE -ne 0) {
|
|
Write-Host "CMake configuration failed!" -ForegroundColor Red
|
|
exit 1
|
|
}
|
|
|
|
# Check if CMake generated the solution file in the build directory
|
|
$GeneratedSolutionFile = Join-Path $BuildDir "YAZE.sln"
|
|
if (Test-Path $GeneratedSolutionFile) {
|
|
Write-Host "✅ CMake generated Visual Studio solution: $GeneratedSolutionFile" -ForegroundColor Green
|
|
|
|
# Copy the generated solution to the source directory for convenience
|
|
$SourceSolutionFile = Join-Path $SourceDir "YAZE.sln"
|
|
Copy-Item $GeneratedSolutionFile $SourceSolutionFile -Force
|
|
Write-Host "✅ Copied solution file to project root: $SourceSolutionFile" -ForegroundColor Green
|
|
|
|
# Verify the solution file is properly structured
|
|
$SolutionContent = Get-Content $GeneratedSolutionFile -Raw
|
|
if ($SolutionContent -match "YAZE\.vcxproj") {
|
|
Write-Host "✅ Solution file references YAZE.vcxproj correctly" -ForegroundColor Green
|
|
|
|
# Check if project configurations are set up
|
|
if ($SolutionContent -match "ProjectConfigurationPlatforms") {
|
|
Write-Host "✅ Project configurations are properly set up" -ForegroundColor Green
|
|
} else {
|
|
Write-Host "⚠️ Warning: Project configurations may not be set up" -ForegroundColor Yellow
|
|
}
|
|
} else {
|
|
Write-Host "❌ Solution file does not reference YAZE.vcxproj" -ForegroundColor Red
|
|
Write-Host "Please check CMake configuration" -ForegroundColor Yellow
|
|
}
|
|
|
|
# Check if the project file exists and has proper include paths
|
|
$ProjectFile = Join-Path $BuildDir "YAZE.vcxproj"
|
|
if (Test-Path $ProjectFile) {
|
|
Write-Host "✅ Project file generated: $ProjectFile" -ForegroundColor Green
|
|
|
|
# Check for common include paths in the project file
|
|
$ProjectContent = Get-Content $ProjectFile -Raw
|
|
$IncludePaths = @(
|
|
"src/lib/",
|
|
"src/app/",
|
|
"src/lib/asar/src",
|
|
"src/lib/imgui",
|
|
"incl/"
|
|
)
|
|
|
|
$MissingIncludes = @()
|
|
foreach ($include in $IncludePaths) {
|
|
if ($ProjectContent -notmatch [regex]::Escape($include)) {
|
|
$MissingIncludes += $include
|
|
}
|
|
}
|
|
|
|
if ($MissingIncludes.Count -eq 0) {
|
|
Write-Host "✅ All required include paths found in project file" -ForegroundColor Green
|
|
} else {
|
|
Write-Host "⚠️ Warning: Missing include paths in project file:" -ForegroundColor Yellow
|
|
foreach ($missing in $MissingIncludes) {
|
|
Write-Host " - $missing" -ForegroundColor Yellow
|
|
}
|
|
}
|
|
|
|
# Check for SDL2 include paths
|
|
if ($ProjectContent -match "SDL2" -or $ProjectContent -match "sdl2") {
|
|
Write-Host "✅ SDL2 include paths found in project file" -ForegroundColor Green
|
|
} else {
|
|
Write-Host "⚠️ Warning: SDL2 include paths not found in project file" -ForegroundColor Yellow
|
|
}
|
|
} else {
|
|
Write-Host "❌ Project file not found: $ProjectFile" -ForegroundColor Red
|
|
}
|
|
|
|
# Open solution in Visual Studio if available
|
|
if (Get-Command "devenv" -ErrorAction SilentlyContinue) {
|
|
Write-Host "Opening solution in Visual Studio..." -ForegroundColor Yellow
|
|
& devenv $SourceSolutionFile
|
|
} elseif (Get-Command "code" -ErrorAction SilentlyContinue) {
|
|
Write-Host "Opening solution in VS Code..." -ForegroundColor Yellow
|
|
& code $SourceSolutionFile
|
|
} else {
|
|
Write-Host "Visual Studio solution ready: $SourceSolutionFile" -ForegroundColor Cyan
|
|
}
|
|
} else {
|
|
Write-Host "❌ CMake failed to generate solution file: $GeneratedSolutionFile" -ForegroundColor Red
|
|
Write-Host "Please check CMake configuration and dependencies" -ForegroundColor Yellow
|
|
exit 1
|
|
}
|
|
|
|
# Test build to verify the project can compile
|
|
Write-Host ""
|
|
Write-Host "Testing build to verify project configuration..." -ForegroundColor Yellow
|
|
|
|
$TestBuildArgs = @(
|
|
"--build", $BuildDir,
|
|
"--config", $Configuration,
|
|
"--target", "yaze"
|
|
)
|
|
|
|
Write-Host "Running test build: cmake $($TestBuildArgs -join ' ')" -ForegroundColor Gray
|
|
& cmake @TestBuildArgs
|
|
|
|
if ($LASTEXITCODE -eq 0) {
|
|
Write-Host "✅ Test build successful! Project is properly configured." -ForegroundColor Green
|
|
} else {
|
|
Write-Host "❌ Test build failed. There may be configuration issues." -ForegroundColor Red
|
|
Write-Host "Please check the build output above for specific errors." -ForegroundColor Yellow
|
|
Write-Host "Common issues:" -ForegroundColor Yellow
|
|
Write-Host " - Missing vcpkg dependencies" -ForegroundColor Gray
|
|
Write-Host " - Incorrect include paths" -ForegroundColor Gray
|
|
Write-Host " - Missing library dependencies" -ForegroundColor Gray
|
|
}
|
|
|
|
Write-Host ""
|
|
Write-Host "🎉 Visual Studio project configuration complete!" -ForegroundColor Green
|
|
Write-Host ""
|
|
Write-Host "Next steps:" -ForegroundColor Cyan
|
|
Write-Host "1. Open YAZE.sln in Visual Studio" -ForegroundColor White
|
|
Write-Host "2. Select configuration: $Configuration" -ForegroundColor White
|
|
Write-Host "3. Select platform: $Architecture" -ForegroundColor White
|
|
Write-Host "4. Build the solution (Ctrl+Shift+B)" -ForegroundColor White
|
|
Write-Host ""
|
|
Write-Host "Available configurations:" -ForegroundColor Cyan
|
|
Write-Host " - Debug (with debugging symbols)" -ForegroundColor Gray
|
|
Write-Host " - Release (optimized)" -ForegroundColor Gray
|
|
Write-Host " - RelWithDebInfo (optimized with debug info)" -ForegroundColor Gray
|
|
Write-Host " - MinSizeRel (minimum size)" -ForegroundColor Gray
|
|
Write-Host ""
|
|
Write-Host "Available architectures:" -ForegroundColor Cyan
|
|
Write-Host " - x64 (64-bit Intel/AMD)" -ForegroundColor Gray
|
|
Write-Host " - x86 (32-bit Intel/AMD)" -ForegroundColor Gray
|
|
Write-Host " - ARM64 (64-bit ARM)" -ForegroundColor Gray
|
|
Write-Host ""
|
|
Write-Host "Troubleshooting:" -ForegroundColor Cyan
|
|
Write-Host " - If you get missing include errors, ensure vcpkg is properly installed" -ForegroundColor Gray
|
|
Write-Host " - Run: vcpkg install --triplet $Architecture-windows" -ForegroundColor Gray
|
|
Write-Host " - Check that all dependencies are available in your environment" -ForegroundColor Gray
|