""" Shader language server using shader-language-server (antaalt/shader-sense). Supports HLSL, GLSL, and WGSL shader file formats. """ import logging import os import shutil from typing import Any from overrides import override from solidlsp.ls import ( LanguageServerDependencyProvider, LanguageServerDependencyProviderSinglePath, SolidLanguageServer, ) from solidlsp.ls_config import LanguageServerConfig from solidlsp.settings import SolidLSPSettings from .common import RuntimeDependency, RuntimeDependencyCollection log = logging.getLogger(__name__) _GITHUB_RELEASE_BASE = "https://github.com/antaalt/shader-sense/releases/download" _HLSL_ALLOWED_HOSTS = ("github.com", "release-assets.githubusercontent.com", "objects.githubusercontent.com") # Version pinning convention (see eclipse_jdtls.py for the full spec): # _INITIAL_* — frozen forever; legacy unversioned install dir is reserved for it. # _DEFAULT_* — bumped on upgrades; goes into a versioned subdir. _INITIAL_VERSION = "1.3.1" _INITIAL_HLSL_SHA256_BY_ASSET = { "shader-language-server-x86_64-pc-windows-msvc.zip": "49081c5547ddde1b8b3b17295282a80ddacbca1d6f5dcd834e2788c02bafa997", "shader-language-server-x86_64-unknown-linux-gnu.zip": "61710df7ca17a2d063b598936c57c56c49fbf837707a1aa886f9b0193a35be3c", "shader-language-server-aarch64-pc-windows-msvc.zip": "a3b3799affe2cad27652e788376b46fe76e1a6c2ce45946a486dcb26c9091412", } _DEFAULT_VERSION = "1.3.1" _DEFAULT_HLSL_SHA256_BY_ASSET = { "shader-language-server-x86_64-pc-windows-msvc.zip": "49081c5547ddde1b8b3b17295282a80ddacbca1d6f5dcd834e2788c02bafa997", "shader-language-server-x86_64-unknown-linux-gnu.zip": "61710df7ca17a2d063b598936c57c56c49fbf837707a1aa886f9b0193a35be3c", "shader-language-server-aarch64-pc-windows-msvc.zip": "a3b3799affe2cad27652e788376b46fe76e1a6c2ce45946a486dcb26c9091412", } def _hlsl_sha(version: str, asset_name: str) -> str | None: if version == _INITIAL_VERSION: return _INITIAL_HLSL_SHA256_BY_ASSET.get(asset_name) if version == _DEFAULT_VERSION: return _DEFAULT_HLSL_SHA256_BY_ASSET.get(asset_name) return None class HlslLanguageServer(SolidLanguageServer): """ Shader language server using shader-language-server. Supports .hlsl, .hlsli, .fx, .fxh, .cginc, .compute, .shader, .glsl, .vert, .frag, .geom, .tesc, .tese, .comp, .wgsl files. You can pass the following entries in ``ls_specific_settings["hlsl"]``: - version: Override the pinned shader-language-server version downloaded or built by Serena (default: the bundled Serena version). """ def __init__(self, config: LanguageServerConfig, repository_root_path: str, solidlsp_settings: SolidLSPSettings) -> None: super().__init__(config, repository_root_path, None, "hlsl", solidlsp_settings) @override def _create_dependency_provider(self) -> LanguageServerDependencyProvider: return self.DependencyProvider(self._custom_settings, self._ls_resources_dir) class DependencyProvider(LanguageServerDependencyProviderSinglePath): def _get_or_install_core_dependency(self) -> str: # 1. Check PATH for system-installed binary system_binary = shutil.which("shader-language-server") if system_binary: log.info(f"Using system-installed shader-language-server at {system_binary}") return system_binary # 2. Try to download pre-built binary from GitHub releases version = self._custom_settings.get("version", _DEFAULT_VERSION) tag = f"v{version}" base_url = f"{_GITHUB_RELEASE_BASE}/{tag}" # macOS has no pre-built binaries; build from source via cargo install cargo_install_cmd = ["cargo", "install", "shader_language_server", "--version", version, "--locked", "--root", "."] deps = RuntimeDependencyCollection( [ RuntimeDependency( id="shader-language-server", description="shader-language-server for Windows (x64)", url=f"{base_url}/shader-language-server-x86_64-pc-windows-msvc.zip", platform_id="win-x64", archive_type="zip", binary_name="shader-language-server.exe", sha256=_hlsl_sha(version, "shader-language-server-x86_64-pc-windows-msvc.zip"), allowed_hosts=_HLSL_ALLOWED_HOSTS, ), RuntimeDependency( id="shader-language-server", description="shader-language-server for Linux (x64)", url=f"{base_url}/shader-language-server-x86_64-unknown-linux-gnu.zip", platform_id="linux-x64", archive_type="zip", binary_name="shader-language-server", sha256=_hlsl_sha(version, "shader-language-server-x86_64-unknown-linux-gnu.zip"), allowed_hosts=_HLSL_ALLOWED_HOSTS, ), RuntimeDependency( id="shader-language-server", description="shader-language-server for Windows (ARM64)", url=f"{base_url}/shader-language-server-aarch64-pc-windows-msvc.zip", platform_id="win-arm64", archive_type="zip", binary_name="shader-language-server.exe", sha256=_hlsl_sha(version, "shader-language-server-aarch64-pc-windows-msvc.zip"), allowed_hosts=_HLSL_ALLOWED_HOSTS, ), RuntimeDependency( id="shader-language-server", description="shader-language-server for macOS (x64) - built from source", command=cargo_install_cmd, platform_id="osx-x64", binary_name="bin/shader-language-server", ), RuntimeDependency( id="shader-language-server", description="shader-language-server for macOS (ARM64) - built from source", command=cargo_install_cmd, platform_id="osx-arm64", binary_name="bin/shader-language-server", ), ] ) try: dep = deps.get_single_dep_for_current_platform() except RuntimeError: dep = None if dep is None: raise FileNotFoundError( "shader-language-server is not installed and no auto-install is available for your platform.\n" "Please install it using one of the following methods:\n" " cargo: cargo install shader_language_server --locked\n" " GitHub: Download from https://github.com/antaalt/shader-sense/releases\n" "On macOS, install the Rust toolchain (https://rustup.rs) and Serena will build from source automatically.\n" "See https://github.com/antaalt/shader-sense for more details." ) # legacy unversioned dir reserved for INITIAL; every other version goes into a versioned subdir ls_dirname = "shader-language-server" if version == _INITIAL_VERSION else f"shader-language-server-{version}" install_dir = os.path.join(self._ls_resources_dir, ls_dirname) executable_path = deps.binary_path(install_dir) if not os.path.exists(executable_path): log.info(f"shader-language-server not found. Downloading from {dep.url}") _ = deps.install(install_dir) if not os.path.exists(executable_path): raise FileNotFoundError(f"shader-language-server not found at {executable_path}") os.chmod(executable_path, 0o755) return executable_path def _create_launch_command(self, core_path: str) -> list[str]: return [core_path, "--stdio"] def _create_base_initialize_params(self) -> dict: initialize_params = { "locale": "en", "capabilities": { "textDocument": { "synchronization": {"didSave": True, "dynamicRegistration": True}, "completion": { "dynamicRegistration": True, "completionItem": {"snippetSupport": True}, }, "definition": {"dynamicRegistration": True}, "hover": { "dynamicRegistration": True, "contentFormat": ["markdown", "plaintext"], }, "signatureHelp": { "dynamicRegistration": True, "signatureInformation": { "parameterInformation": {"labelOffsetSupport": True}, }, }, "documentSymbol": { "dynamicRegistration": True, "hierarchicalDocumentSymbolSupport": True, "symbolKind": {"valueSet": list(range(1, 27))}, }, "formatting": {"dynamicRegistration": True}, "publishDiagnostics": {"relatedInformation": True}, }, "workspace": { "workspaceFolders": True, "didChangeConfiguration": {"dynamicRegistration": True}, "configuration": True, }, }, } return initialize_params @override def _start_server(self) -> None: def do_nothing(params: Any) -> None: return def on_log_message(params: Any) -> None: message = params.get("message", "") if isinstance(params, dict) else str(params) log.info(f"shader-language-server: {message}") def on_configuration_request(params: Any) -> list[dict]: """Respond to workspace/configuration requests. shader-language-server requests config with section 'shader-validator'. Return empty config to use defaults. """ items = params.get("items", []) if isinstance(params, dict) else [] return [{}] * len(items) self.server.on_request("client/registerCapability", do_nothing) self.server.on_request("workspace/configuration", on_configuration_request) self.server.on_notification("$/progress", do_nothing) self.server.on_notification("textDocument/publishDiagnostics", do_nothing) self.server.on_notification("window/logMessage", on_log_message) log.info("Starting shader-language-server process") self.server.start() initialize_params = self._create_initialize_params() log.info("Sending initialize request") init_response = self.server.send.initialize(initialize_params) capabilities = init_response.get("capabilities", {}) log.info(f"Initialize response capabilities: {list(capabilities.keys())}") assert "textDocumentSync" in capabilities, "shader-language-server must support textDocumentSync" if "documentSymbolProvider" not in capabilities: log.warning("shader-language-server does not advertise documentSymbolProvider") if "definitionProvider" not in capabilities: log.warning("shader-language-server does not advertise definitionProvider") self.server.notify.initialized({}) @override def is_ignored_dirname(self, dirname: str) -> bool: """Ignore Unity-specific directories that contain no user-authored shaders.""" return super().is_ignored_dirname(dirname) or dirname in {"Library", "Temp", "Logs", "obj", "Packages"}