Add new Markdown source file type.

delphidabbler · delphidabbler · commit 61d53b29802e · 2025-04-28T13:21:46.000+01:00
Added sfMarkdown element to TSourceFileType enumerated type.

The new sfMarkdown element broke TSaveSnippetMgr.GetFileTypeDesc and
TSaveUnitMgr.GetFileTypeDesc which assumed that all TSourceFileType
values were supported, and so don't check for any file type that may not
be supported. To enable such checks to be made a new
TSourceFileInfo.SupportsFileType method was added to check if a file
type is supported.

Updated the Code Formatting tab of the Preferences dialogue box with the
options to set Markdown as the default source file type.
diff --git a/Src/FrSourcePrefs.pas b/Src/FrSourcePrefs.pas
@@ -127,12 +127,14 @@ implementation
   sRTFFileDesc = 'Rich text';
   sPascalFileDesc = 'Pascal';
   sTextFileDesc = 'Plain text';
+  sMarkdownFileDesc = 'Markdown';
 
 
 const
   // Maps source code file types to descriptions
   cFileDescs: array[TSourceFileType] of string = (
-    sTextFileDesc, sPascalFileDesc, sHTML5FileDesc, sXHTMLFileDesc, sRTFFileDesc
+    sTextFileDesc, sPascalFileDesc, sHTML5FileDesc, sXHTMLFileDesc,
+    sRTFFileDesc, sMarkdownFileDesc
   );
 
 
diff --git a/Src/USaveSnippetMgr.pas b/Src/USaveSnippetMgr.pas
@@ -171,9 +171,12 @@ function TSaveSnippetMgr.GetFileTypeDesc(
   const FileType: TSourceFileType): string;
 const
   Descriptions: array[TSourceFileType] of string = (
-    sTxtExtDesc, sIncExtDesc, sHtml5ExtDesc, sXHtmExtDesc, sRtfExtDesc
+    sTxtExtDesc, sIncExtDesc, sHtml5ExtDesc, sXHtmExtDesc, sRtfExtDesc,
+    '' {Markdown not supported}
   );
 begin
+  Assert(FileType <> sfMarkdown,
+    ClassName + '.GetFileTypeDesc: Markdown not supported');
   Result := Descriptions[FileType];
 end;
 
diff --git a/Src/USaveSourceMgr.pas b/Src/USaveSourceMgr.pas
@@ -181,11 +181,14 @@ procedure TSaveSourceMgr.DoExecute;
 begin
   // Set up dialog box
   fSaveDlg.Filter := fSourceFileInfo.FilterString;
-  fSaveDlg.FilterIndex := FilterDescToIndex(
-    fSaveDlg.Filter,
-    fSourceFileInfo.FileTypeInfo[Preferences.SourceDefaultFileType].DisplayName,
-    1
-  );
+  if fSourceFileInfo.SupportsFileType(Preferences.SourceDefaultFileType) then
+    fSaveDlg.FilterIndex := FilterDescToIndex(
+      fSaveDlg.Filter,
+      fSourceFileInfo.FileTypeInfo[Preferences.SourceDefaultFileType].DisplayName,
+      1
+    )
+  else
+    fSaveDlg.FilterIndex := 1;
   fSaveDlg.FileName := fSourceFileInfo.DefaultFileName;
   // Display dialog box and save file if user OKs
   if fSaveDlg.Execute then
@@ -317,7 +320,8 @@ procedure TSaveSourceMgr.PreviewHandler(Sender: TObject);
     dtPlainText,  // sfPascal
     dtHTML,       // sfHTML5
     dtHTML,       // sfXHTML
-    dtRTF         // sfRTF
+    dtRTF,        // sfRTF
+    dtPlainText   // sfMarkdown
   );
   PreviewFileTypeMap: array[TPreviewDocType] of TSourceFileType = (
     sfText,       // dtPlainText
diff --git a/Src/USaveUnitMgr.pas b/Src/USaveUnitMgr.pas
@@ -242,9 +242,12 @@ function TSaveUnitMgr.GetDocTitle: string;
 function TSaveUnitMgr.GetFileTypeDesc(const FileType: TSourceFileType): string;
 const
   Descriptions: array[TSourceFileType] of string = (
-    sTextDesc, sPascalDesc, sHTML5Desc, sXHTMLDesc, sRTFDesc
+    sTextDesc, sPascalDesc, sHTML5Desc, sXHTMLDesc, sRTFDesc,
+    '' {Markdown not supported}
   );
 begin
+  Assert(FileType <> sfMarkdown,
+    ClassName + '.GetFileTypeDesc: Markdown not supported');
   Result := Descriptions[FileType];
 end;
 
diff --git a/Src/USourceFileInfo.pas b/Src/USourceFileInfo.pas
@@ -32,7 +32,8 @@ interface
     sfPascal,   // pascal files (either .pas for units or .inc for include files
     sfHTML5,    // HTML 5 files
     sfXHTML,    // XHTML files
-    sfRTF       // rich text files
+    sfRTF,      // rich text files
+    sfMarkdown  // Markdown files
   );
 
 type
@@ -132,13 +133,21 @@   TSourceFileInfo = class(TObject)
     ///  given one-based index within the current filter string.</summary>
     function FileTypeFromFilterIdx(const Idx: Integer): TSourceFileType;
 
+    ///  <summary>Checks if a file type is supported.</summary>
+    ///  <param name="FileType"><c>TSourceFileType</c> [in] File type to check.
+    ///  </param>
+    ///  <returns><c>Boolean</c>. <c>True</c> if file type is supported,
+    ///  <c>False</c> if not.</returns>
+    function SupportsFileType(const FileType: TSourceFileType): Boolean;
+
     ///  <summary>Information about each supported file type that is of use to
     ///  save source dialog boxes.</summary>
     ///  <exception>A <c>EListError</c> exception is raised if no information
     ///  relating to <c>FileType</c> has been stored in this property.
     ///  </exception>
     property FileTypeInfo[const FileType: TSourceFileType]: TSourceFileTypeInfo
       read GetFileTypeInfo write SetFileTypeInfo;
+
     ///  <summary>Default source code file name.</summary>
     ///  <remarks>Must be a valid Pascal identifier. Invalid characters are
     ///  replaced by underscores.</remarks>
@@ -243,6 +252,12 @@ procedure TSourceFileInfo.SetFileTypeInfo(const FileType: TSourceFileType;
   GenerateFilterInfo;
 end;
 
+function TSourceFileInfo.SupportsFileType(const FileType: TSourceFileType):
+  Boolean;
+begin
+  Result := fFileTypeInfo.ContainsKey(FileType);
+end;
+
 { TSourceFileTypeInfo }
 
 constructor TSourceFileTypeInfo.Create(const AExtension, ADisplayName: string;
