Support castle-pasls-paths.txt to easier add paths

Author: michaliskambi

README.md

@@ -24,6 +24,8 @@ CGE fork contributes back improvements that are not CGE-specific (see e.g. https
     - Provide custom Lazarus config location (useful if you install Lazarus by [fpcupdeluxe](https://castle-engine.io/fpcupdeluxe) but still want `pasls` to read Lazarus config -- this is optional).
     - Improve debugging by known log filename and more complete JSON logs.
 
+- We add capability to configure the LSP server using `castle-pasls-paths.txt`, see below.
+
 - We can also auto-detect _Castle Game Engine_ path in some situations:
     - If the LSP server binary is distributed in `bin` of _Castle Game Engine_.
     - Or if the environment 'CASTLE_ENGINE_PATH` is defined.
@@ -144,7 +146,7 @@ Additional keys in LSP initialization options can be used to influence the LSP s
 
     - 2: Return an error to the LSP client. Some LSP clients will just hide the error, but some (like Emacs) will show it clearly and prominently.
 
-## Extra configuration in castle-engine/pascal-language-server
+## Extra configuration in castle-engine/pascal-language-server (castle-pasls.ini)
 
 The `pasls` reads configuration file `castle-pasls.ini` in user config dir to enable some additional features.
 
@@ -194,6 +196,24 @@ option_2=-dSOME_DEFINE
 option_3=-dSOMETHING_MORE
 ```
 
+## Extra paths from `castle-pasls-paths.txt`
+
+We also read `castle-pasls-paths.txt` file in the same directory as `castle-pasls.ini`.
+
+The format of this is simpler: any line that is not empty and does not start with `#` (comment) is considered a path to add to FPC search paths. It is added as both units and include paths (causes both `-Fu` and `-Fi` for FPC).
+
+This is useful e.g. to add paths to all your custom units, that you want to be available for autocompletion. It would be also possible to do this by extending `[extra_options]` in `castle-pasls.ini`, but that's sometimes too bothersome: you need to add them twice (if you want both `-Fu` and `-Fi`) and you need to remember to keep order of `option_xxx`.
+
+Example:
+
+```
+# This is a comment, ignored.
+# Add all my custom units.
+/home/michalis/sources/my-units/
+/home/michalis/sources/more-units-and-include-files/
+/home/michalis/sources/more-units-and-include-files/subdirectory/
+```
+
 ## Roadmap
 
 ### Wishlist

server/castlelsp.pas

@@ -1,5 +1,5 @@
 {
-  Copyright 2022-2024 Michalis Kamburelis
+  Copyright 2022-2025 Michalis Kamburelis
 
   Extensions to the Pascal Language Server specific to Castle Game Engine.
   See https://github.com/michaliskambi/elisp/tree/master/lsp
@@ -26,10 +26,11 @@ interface
 uses Classes, IniFiles;
 
 var
-  UserConfig: TIniFile;
-  WorkspacePaths: TStringList; // paths to search by workspace symbols
-  WorkspaceAndEnginePaths: TStringList; // paths to search by workspace symbols in engine developer mode
-  EngineDeveloperMode: Boolean; // add engine paths to workspace symbols?
+  UserConfig: TIniFile; //< for reading ~/.config/pasls/castle-pasls.ini
+  UserConfigPaths: TStringList; //< for reading ~/.config/pasls/castle-pasls-paths.txt
+  WorkspacePaths: TStringList; //< paths to search by workspace symbols
+  WorkspaceAndEnginePaths: TStringList; //< paths to search by workspace symbols in engine developer mode
+  EngineDeveloperMode: Boolean; //< add engine paths to workspace symbols?
 
 procedure InitializeUserConfig;
 
@@ -39,6 +40,7 @@ procedure InitializeUserConfig;
   - extra CGE paths (derived from the single CGE path from castle-pasls.ini file)
   - extra CGE options (like -Mobjfpc)
   - extra free FPC options from castle-pasls.ini file
+  - extra paths from castle-pasls-paths.txt
 }
 function ExtraFpcOptions: String;
 
@@ -59,24 +61,33 @@ implementation
 
 procedure InitializeUserConfig;
 var
-  FileName: String;
+  ConfigFileName, PathsFileName: String;
 begin
   {$ifdef UNIX_WITH_USERS_UNIT}
   { Special hack for Unix + VSCode integration in https://github.com/genericptr/pasls-vscode ,
     looks like it overrides the environment and runs LSP server without $HOME defined,
     so GetAppConfigDir will not work (it will return relative path ".config/....". instead
     of proper absolute "/home/michalis/.config/....").
 
-    Emacs LSP client doesn't have this problem. }
+    Emacs LSP client doesn't have this problem.
+    
+    CGE integration on https://github.com/castle-engine/castle-engine-vscode/ 
+    also doesn't have this problem. }
   if GetEnvironmentVariable('HOME') = '' then
   begin
-    FileName := '/home/' + GetUserName(FpGetUID) + '/.config/pasls/castle-pasls.ini';
+    ConfigFileName := '/home/' + GetUserName(FpGetUID) + '/.config/pasls/castle-pasls.ini';
   end else
   {$endif}
-    FileName := IncludeTrailingPathDelimiter(GetAppConfigDir(false)) + 'castle-pasls.ini';
+    ConfigFileName := IncludeTrailingPathDelimiter(GetAppConfigDir(false)) + 'castle-pasls.ini';
 
-  //WriteLn('Reading config from ', FileName);
-  UserConfig := TIniFile.Create(FileName);
+  //WriteLn('Reading INI config from ', ConfigFileName);
+  UserConfig := TIniFile.Create(ConfigFileName);
+
+  // create UserConfigPaths
+  PathsFileName := ChangeFileExt(ConfigFileName, '-paths.txt');
+  UserConfigPaths := TStringList.Create;
+  if FileExists(PathsFileName) then
+    UserConfigPaths.LoadFromFile(PathsFileName);
 end;
 
 { Detect Castle Game Engine path using various methods.
@@ -237,6 +248,23 @@ function ExtraFpcOptions: String;
     finally FreeAndNil(CastleFpcCfg) end;
   end;
 
+  procedure AddPathsFromUserConfigPaths;
+  var
+    S, Trimmed: String;
+  begin
+    for S in UserConfigPaths do
+    begin
+      Trimmed := Trim(S);
+      // ignore empty lines and comments
+      if (Trimmed <> '') and (Trimmed[1] <> '#') then
+      begin
+        Result := Result + 
+            ' ' + QuoteFpcOption('-Fu' + Trimmed) + 
+            ' ' + QuoteFpcOption('-Fi' + Trimmed);
+      end;
+    end;
+  end;
+
 const
   { Add the same syntax options as are specified by CGE build tool in
     castle-engine/tools/build-tool/code/toolcompile.pas .
@@ -271,8 +299,9 @@ function ExtraFpcOptions: String;
     Inc(ExtraOptionIndex);
     Result := Result + ' ' + QuoteFpcOption(ExtraOption);
   end;
-end;
 
+  AddPathsFromUserConfigPaths;
+end;
 
 procedure ParseWorkspacePaths(const ProjectSearchPaths, ProjectDirectory: String);
 
@@ -337,4 +366,5 @@ finalization
   FreeAndNil(WorkspaceAndEnginePaths);
   FreeAndNil(WorkspacePaths);
   FreeAndNil(UserConfig);
+  FreeAndNil(UserConfigPaths);
 end.