Rename command

.github/workflows/releaseStandalone.yml

@@ -36,7 +36,10 @@ jobs:
         draft: false
         prerelease: false
         body: |
-            Don't forget to **unblock** the zip file before extracting.  
+            > [!IMPORTANT]
+            > Don't forget to **unblock** the zip file before extracting.  
+
+            After extracting save at any location and just run `Fesh.exe` to start.
             Changes:          
             [View Changelog](https://github.com/goswinr/Fesh/blob/main/CHANGELOG.md)
             

CHANGELOG.md

@@ -12,6 +12,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - command for opening a file in VS Code
 - command for closing and deleting a file
+- command for renaming files
+### Changed
+- location of SettingsFolder
+- simplify type signature of C# style optional args in tooltips
 
 ## [0.15.0] - 2024-11-22
 ### Added

Src/Config/AutoCompleteStatistic.fs

@@ -9,7 +9,7 @@ open Fesh.Model
 type AutoCompleteStatistic  ( runContext:RunContext) =
 
     let customPriorities = [
-        // first item wil have highest priority
+        // first item will have highest priority
         "true"
         "false"
         "printfn"

Src/Config/Config.fs

@@ -3,10 +3,12 @@
 open Fesh.Model
 
 
+
+
 type Config (log:IFeshLog, startUpData:HostedStartUpData option, startupArgs:string[]) =
 
     let  runContext                 = new RunContext                  (startUpData)
-    let  settings                   = new Fittings.PersistentSettings (runContext.SettingsFileInfo,IFeshLog.printError)
+    let  settings                   = new Fittings.PersistentSettings (runContext.SettingsFileInfo, IFeshLog.printError)
     let  recentlyUsedFiles          = new RecentlyUsedFiles           (runContext)
     let  openTabs                   = new OpenTabs                    (runContext, startupArgs)
     let  defaultCode                = new DefaultCode                 (runContext)

Src/Config/FsiArguments.fs

@@ -7,25 +7,32 @@ open Fesh.Model
 
 type FsiArguments   ( runContext:RunContext) =
 
-    let filePath0 = runContext.GetPathToSaveAppData("FsiArguments .txt")
+    let filePath0 = runContext.GetPathToSaveAppData("FsiArguments.txt")
     let writer = SaveReadWriter(filePath0,IFeshLog.printError)
 
     let defaultArgs =
-        if runContext.IsHosted then
+        if runContext.IsHosted then // dec 2024, F# 9, on net48 hosted in Rhino --multiemit- is needed to enable multiple evaluations, line numbers for errors don't work though.
             [| "first arg must be there but is ignored" ; "--langversion:preview"  ; "--exec"; "--debug+"; "--debug:full" ;"--optimize+" ; "--gui+" ; "--nologo"; "--multiemit-"|]
         else // Standalone for net48 too --multiemit is always there on netCore
             [| "first arg must be there but is ignored" ; "--langversion:preview"  ; "--exec"; "--debug+"; "--debug:full" ;"--optimize+" ; "--gui+" ; "--nologo"; "--multiemit+" |]
 
+
     // Standalone with "--multiemit" to have line numbers in error messages see https://github.com/dotnet/fsharp/discussions/13293
-    // Hosted without "--multiemit", error line numbers don't work there anyway, and in addition accessing previously emited assemblies might fail with a TypeLoadException.
-    // see: https://fsharp.github.io/fsharp-compiler-docs/fsi-emit.html and https://github.com/dotnet/fsharp/blob/main/src/Compiler/Interactive/fsi.fs#L1171
+    // Hosted without "--multiemit", error line numbers don't work there anyway, and in addition accessing previously emitted assemblies might fail with a TypeLoadException.
+    // see: https://fsharp.github.io/fsharp-compiler-docs/fsi-emit.html
+    // and https://github.com/dotnet/fsharp/blob/main/src/Compiler/Interactive/fsi.fs#L1171
+    // https://github.com/dotnet/fsharp/discussions/13293
 
     // first arg is ignored: https://github.com/fsharp/FSharp.Compiler.Service/issues/420
     // and  https://github.com/fsharp/FSharp.Compiler.Service/issues/877
     // and  https://github.com/fsharp/FSharp.Compiler.Service/issues/878
 
     // use "--gui+" to enable winforms event loop ( on by default) check if fixed: https://github.com/dotnet/fsharp/issues/13473
+
     // use "--exec" instead of "--noninteractive" see https://github.com/dotnet/fsharp/blob/7b46dad60df8da830dcc398c0d4a66f6cdf75cb1/src/Compiler/Interactive/fsi.fs#L937
+    // TODO: use --noninteractive flag instead of accessing controlled execution via reflection:
+    // https://github.com/dotnet/fsharp/pull/15184
+
     // "--shadowcopyreferences" is ignored https://github.com/fsharp/FSharp.Compiler.Service/issues/292
 
     let defaultArgsText = defaultArgs|> String.concat Environment.NewLine

Src/Config/RunContext.fs

@@ -2,6 +2,9 @@
 
 open System
 open Fesh.Model
+open System.IO
+
+
 
 /// hostName: a string for the name of the hosting App (will be used for settings file name an displayed in the Title Bar.
 /// mainWindowHandle: Pointer to main window(nativeInt),
@@ -15,24 +18,59 @@ type HostedStartUpData = {
     defaultCode:option<string>
     }
 
+module Folders =
+    let appData = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData)
+
+
+    let validHost(n:string)=
+        let mutable n = n
+        for c in IO.Path.GetInvalidFileNameChars() do
+            n <- n.Replace(c, '_') // make sure host name is a valid file name
+        n
+
+
+    // restore settings files from version 0.15.0 or lower
+    let restoreSettingsFolderFromOldLocation(newFolder:string, startUpData:HostedStartUpData option) =
+        try
+        let oldPath =
+            match startUpData with
+            |None ->       IO.Path.Combine(appData, "Fesh") // Standalone
+            |Some sd ->    IO.Path.Combine(appData, "Fesh", validHost sd.hostName)
+        let oldSett = IO.Path.Combine(oldPath, "Settings.txt")
+        let newSett = IO.Path.Combine(newFolder, "Settings.txt")
+        if IO.File.Exists oldSett && not ( IO.File.Exists newSett) then
+            for f in [| "AutoCompleteStatistic.txt"
+                        "CurrentlyOpenFiles.txt"
+                        "DefaultCode.fsx"
+                        "FoldingStatus.txt"
+                        "FsiArguments.txt"
+                        "PositionedWindow.txt"
+                        "RecentlyUsedFiles.txt"
+                        "Settings.txt"
+                        |] do
+                let oldFile= IO.Path.Combine(oldPath, f)
+                let newFile = IO.Path.Combine(newFolder, f)
+                if IO.File.Exists oldFile && not (IO.File.Exists newFile) then
+                    IO.File.Move(oldFile,newFile)
+        with e ->
+            IFeshLog.log.PrintfnIOErrorMsg $"Error while trying to restore old settings file: {e}"
+
+
+open Folders
+
 /// A class to hold the current App Run context (Standalone or Hosted)
 type RunContext (startUpData:HostedStartUpData option) =
 
     let isRunningOnDotNetCore =
         Runtime.InteropServices.RuntimeInformation.FrameworkDescription.StartsWith(".NET Framework", StringComparison.OrdinalIgnoreCase) |> not
         //Type.GetType("System.Runtime.Loader.AssemblyLoadContext") <> null // https://github.com/dotnet/runtime/issues/22779#issuecomment-315527735
 
+
     let settingsFolder =
-        let appData = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData)
         let path =
             match startUpData with
-            |None ->
-                IO.Path.Combine(appData, "Fesh", "Settings", "Standalone") // Standalone
-            |Some sd ->
-                let mutable host = sd.hostName
-                for c in IO.Path.GetInvalidFileNameChars() do host <- host.Replace(c, '_') // make sure host name is a valid file name
-                IO.Path.Combine(appData,"Fesh", "Settings", host)
-
+            |None ->    IO.Path.Combine(appData, "Fesh", "Settings", "Standalone") // Standalone
+            |Some sd -> IO.Path.Combine(appData,"Fesh", "Settings", validHost sd.hostName)
         IO.Directory.CreateDirectory(path) |> ignore
         path
 
@@ -44,11 +82,14 @@ type RunContext (startUpData:HostedStartUpData option) =
         IO.Path.Combine(settingsFolder, "PositionedWindow.txt")
         |> IO.FileInfo
 
+    do
+        restoreSettingsFolderFromOldLocation(settingsFolder,startUpData)
+
     /// To get a path where to save the setting files, give file name including extension
     member this.GetPathToSaveAppData (fileNameInclExt:string) =
         IO.Path.Combine(settingsFolder, fileNameInclExt )
 
-    member this.SettingsFolder = settingsFolder
+    // member this.SettingsFolder = settingsFolder
 
     member this.SettingsFileInfo = settingsFileInfo
 

Src/Editor/Checker.fs

@@ -306,13 +306,13 @@ type Checker private ()  =
     static member GetDeclarations (posX:PositionInCodeEx, res:FullCheckResults ) =
         // IFeshLog.log.PrintfnDebugMsg "*2.0 GetCompletions for:\r\n%A" posX
         // Symbols are only for finding out if an argument is optional
-        let symUse =  res.checkRes.GetDeclarationListSymbols(
-                         Some res.parseRes  // ParsedFileResultsOpt
-                         , posX.lineIdx          // line
-                         , posX.lineToCaret  // lineText
-                         , posX.partLoName  // PartialLongName
-                         //, (fun () -> Checker.GetAllEntities(res, true)) // getAllEntities: (unit -> AssemblySymbol list) // TODO use that too like FsAutocomplete does ???
-                         )
+        // let symUse =  res.checkRes.GetDeclarationListSymbols(
+        //                  Some res.parseRes  // ParsedFileResultsOpt
+        //                  , posX.lineIdx          // line
+        //                  , posX.lineToCaret  // lineText
+        //                  , posX.partLoName  // PartialLongName
+        //                  //, (fun () -> Checker.GetAllEntities(res, true)) // getAllEntities: (unit -> AssemblySymbol list) // TODO use that too like FsAutocomplete does ???
+        //                  )
 
         // for auto completion
         let decls = res.checkRes.GetDeclarationListInfo(

Src/Editor/Completions.fs

@@ -172,7 +172,7 @@ type Completions(state: InteractionState) =
 
     let mutable willInsert = false // to track if window closed without inserting ( e.g pressing esc)
 
-    let empty = ResizeArray<string>()
+    //let empty = ResizeArray<string>()
 
     let selectedCompletionText ()=
         match win with
@@ -208,7 +208,7 @@ type Completions(state: InteractionState) =
     let getToolTip (it:DeclarationListItem) : obj =
         async{
             let ttText = it.Description
-            let structured = TypeInfo.makeFeshToolTipDataList (ttText, it.FullName, empty)
+            let structured = TypeInfo.makeFeshToolTipDataList (ttText, it.FullName)
                 // if Checker.OptArgsDict.ContainsKey it.FullName then  TypeInfo.makeFeshToolTipDataList (ttText, it.FullName, Checker.OptArgsDict.[it.FullName])
                 // else                                                 TypeInfo.makeFeshToolTipDataList (ttText, it.FullName, empty)
             do! Async.SwitchToContext Fittings.SyncWpf.context

Src/Editor/TypeInfo.fs

@@ -272,7 +272,8 @@ type TypeInfo private () =
     static let darkblue     = Brushes.DarkSlateBlue |> darker 20 |> freeze
     static let white        = Brushes.White         |> darker    5  |> freeze
 
-    static let codeRun (td:ToolTipData) (code:string) : seq<Run>=
+    // static let codeRun (td:ToolTipData) (code:string) : seq<Run> =
+    static let codeRun (code:string) : seq<Run> =
         let tx = code.TrimEnd()
         [
         new Run(" ")
@@ -319,7 +320,8 @@ type TypeInfo private () =
         n.attrs.Head.value = (match n.children.Head with Text t -> t |Node _ -> "")
         )
 
-    static let mainXmlBlock (node:XmlParser.Child, td:ToolTipData): TextBlockSelectable =
+    // static let mainXmlBlock (node:XmlParser.Child, td:ToolTipData): TextBlockSelectable =
+    static let mainXmlBlock (node:XmlParser.Child): TextBlockSelectable =
         let tb = new TextBlockSelectable()
         tb.FontSize   <- StyleState.fontSize  * 1.0
         tb.FontFamily <- StyleState.fontToolTip
@@ -352,7 +354,7 @@ type TypeInfo private () =
                         tb.Inlines.Add( new Run(fixName n.name,  Foreground = darkGray)) //FontWeight = FontWeights.Bold,     // Summary header, Parameter header ....
                         tb.Inlines.Add( new LineBreak())
                     for at in n.attrs do // there is normally just one ! like param:name, paramref:name typeparam:name
-                        tb.Inlines.AddRange( at.value |> fixTypeName|> codeRun td )
+                        tb.Inlines.AddRange( at.value |> fixTypeName|> codeRun )
                         tb.Inlines.Add( new Run(": ",  Foreground = black))
 
                     let childs = n.children  |> Array.ofList
@@ -373,8 +375,8 @@ type TypeInfo private () =
                     // e.g. for: <returns> <see langword="true" /> if <paramref name="objA" /> is the same instance as <paramref name="objB" /> or if both are null; otherwise, <see langword="false" />.</returns>
                     for at in n.attrs do
                         //printfn $"{n.name} {at.name}:{at.value }"
-                        if   at.name="cref"  then  tb.Inlines.AddRange(  at.value |> fixTypeName |>  codeRun td)
-                        else                       tb.Inlines.AddRange(  at.value                |>  codeRun td)
+                        if   at.name="cref"  then  tb.Inlines.AddRange(  at.value |> fixTypeName |>  codeRun )
+                        else                       tb.Inlines.AddRange(  at.value                |>  codeRun )
                         //tb.Inlines.Add( new Run(" "))
 
                 else
@@ -388,7 +390,7 @@ type TypeInfo private () =
 
         and addCode (this:XmlParser.Child) depth =
             match this with
-            |Text t ->  tb.Inlines.AddRange(codeRun td t) // done in codeRun:  tb.Inlines.Add(" ")
+            |Text t ->  tb.Inlines.AddRange(codeRun t) // done in codeRun:  tb.Inlines.Add(" ")
             |Node n ->  loop this n.name false Trim.No depth
 
 
@@ -469,7 +471,7 @@ type TypeInfo private () =
                     if ass <> "" then assemblies.Add(ass) |> ignore
                     //if ass.Length > 10 then assemblies.Add("\r\n" + ass) |> ignore // it may be from more than one assembly? because of type extensions?
                     //else                    assemblies.Add(ass) |> ignore
-                    subAdd <| mainXmlBlock (node, td)
+                    subAdd <| mainXmlBlock (node)
                 |Error errTxt  ->
                     subAdd<|  TextBlockSelectable(Text = errTxt, TextWrapping = TextWrapping.Wrap, FontSize = StyleState.fontSize  * 0.70 , Foreground = errMsgGray)//,FontFamily = StyleState.fontToolTip )
 
@@ -630,14 +632,15 @@ type TypeInfo private () =
 
     //static member namesOfOptionalArgs(fsu:FSharpSymbolUse) = namesOfOptnlArgs(fsu)
 
-    static member makeFeshToolTipDataList (sdtt: ToolTipText, fullName:string, optArgs:ResizeArray<string>) = makeToolTipDataList (sdtt, fullName) //, optArgs)
+    static member makeFeshToolTipDataList (sdtt: ToolTipText, fullName:string) = //, optArgs:ResizeArray<string>) =
+        makeToolTipDataList (sdtt, fullName) //, optArgs)
 
     static member getPanel  (tds:ToolTipData list, ed:ToolTipExtraData) =
         cachedToolTipData  <- tds
         cachedExtraData    <- ed
         makeToolTipPanel (tds, ed, true)
 
-    /// regenerates a view of the last created panel so it can be used again in the popout window
+    /// regenerates a view of the last created panel so it can be used again in the pop-out window
     static member getPanelCached () =
         makeToolTipPanel (cachedToolTipData, cachedExtraData, false)
 

Src/Fsi.fs

@@ -114,6 +114,8 @@ type Fsi private (config:Config) =
     // will point to the token in https://github.com/dotnet/fsharp/blob/main/src/Compiler/Interactive/ControlledExecution.fs
     let mutable fscCancellationToken : CancellationTokenSource voption = ValueNone
 
+    // TODO: use non-interactive flag instead of accessing controlled execution via reflection:
+    // https://github.com/dotnet/fsharp/pull/15184
 
     let setAControlledExecutionCancellationToken()=
         if config.RunContext.IsRunningOnDotNetCore then
@@ -132,7 +134,7 @@ type Fsi private (config:Config) =
                 with e ->
                     IFeshLog.log.PrintfnFsiErrorMsg "Getting FSI token via reflection form Fsharp.Compiler.Service failed"
 
-
+    /// returns tru if something was aborted
     let getControlledExecutionAborter(thread:Thread) : unit -> bool =
         if config.RunContext.IsRunningOnDotNetCore then
             match sessionOpt with
@@ -162,7 +164,9 @@ type Fsi private (config:Config) =
             fun () ->
                 #if NETFRAMEWORK
                     thread.Abort()
-                    true
+                    match state with
+                    | Ready | Initializing | NotLoaded -> false
+                    | Compiling | Evaluating ->  true
                 #else
                     ignore thread // to avoid warning when NETFRAMEWORK is not defined
                     false

Src/Views/Commands.fs

@@ -65,8 +65,9 @@ type Commands (grid:TabsAndLog, statusBar:FeshStatusBar)  =
     member val OpenInVSCode      = {name= "Open in VS Code"           ;gesture= "Ctrl + Shift + O" ;cmd= mkCmdSimple (fun _ -> tabs.OpenInVSCode())                           ;tip="Saves changes and opens the current script file in VS Code. You can change the file there. Fesh wil prompt you to load changes back."  }
     member val OpenTemplateFile  = {name= "Edit Template File"        ;gesture= ""               ;cmd= mkCmdSimple (fun _ -> tabs.AddFile(config.DefaultCode.FileInfo,true)|> ignore)     ;tip="Opens the template file that is used when creating a New File ( Ctrl + N)." }
     member val Save              = {name= "Save"                      ;gesture= "Ctrl + S"       ;cmd= mkCmdSimple (fun _ -> tabs.Save(tabs.Current) |> ignore )              ;tip="Saves the file. Shows a dialog only if the open file does not exist anymore." }
-    member val Export            = {name= "Export"                    ;gesture= ""               ;cmd= mkCmdSimple (fun _ -> tabs.Export(tabs.Current) |> ignore)             ;tip="Shows a dialog to export the file at a new path or name. But keeps the file open at previous location." }
-    member val SaveAs            = {name= "Save As"                   ;gesture= "Ctrl + Alt + S" ;cmd= mkCmdSimple (fun _ -> tabs.SaveAs(tabs.Current) |> ignore)             ;tip="Shows a dialog to save the file at a new path or name." }
+    member val Rename            = {name= "Rename/Move"               ;gesture= ""               ;cmd= mkCmdSimple (fun _ -> tabs.Rename(tabs.Current) |> ignore)             ;tip="Shows a dialog to Rename and/or Move the file." }
+    member val Export            = {name= "Duplicate/Export"          ;gesture= ""               ;cmd= mkCmdSimple (fun _ -> tabs.Export(tabs.Current) |> ignore)             ;tip="Shows a dialog to duplicate the file at a new path or name. But keeps the file open at previous location." }
+    member val SaveAs            = {name= "Save As"                   ;gesture= "Ctrl + Alt + S" ;cmd= mkCmdSimple (fun _ -> tabs.SaveAs(tabs.Current) |> ignore)             ;tip="Shows a dialog to save the file at a new path or name.(Keeping the old file at the current name and location.)" }
     member val SaveIncrementing  = {name= "Save Incrementing"         ;gesture= ""               ;cmd= mkCmdSimple (fun _ -> tabs.SaveIncremental(tabs.Current) |> ignore)    ;tip="Saves with increased last character of filename.\r\nCan be alphabetic or numeric ( e.g.  d->e or 5->6).\r\nDoes not overwrite any existing file."}
     member val SaveAll           = {name= "Save All"                  ;gesture= "Ctrl + Shift + S";cmd=mkCmdSimple (fun _ -> for t in tabs.AllTabs do tabs.Save(t) |> ignore) ;tip="Saves all tabs. Shows a dialog only if the open file does not exist on disk." }
     member val Close             = {name= "Close File"                ;gesture= "Ctrl + F4"      ;cmd= mkCmdSimple (fun _ -> tabs.CloseTab(tabs.Current))                     ;tip="Closes the current tab, if there is only one tab then the default tab will be shown."}