Standardise and improve file encoding names

File encoding names are now determined by the encoding type and are no
longer specified by the code that displays TSaveSourceDlg dialogue
boxes. This not only standardises the encoding names but removes quite a
bit of duplication and simplifies code that saves snippets, snippet
information and units.

The system default ANSI encoding was previously displayed as "ANSI
(Default)". This has been changed to "ANSI Code Page 999", where 999 is
the default system code page for the user's locale.

Author: delphidabbler

Src/USaveInfoMgr.pas

@@ -270,18 +270,13 @@ constructor TSaveInfoMgr.InternalCreate(AView: IView);
 resourcestring
   sDefFileName = 'SnippetInfo';
   sDlgCaption = 'Save Snippet Information';
-  // descriptions of supported encodings
-  sASCIIEncoding = 'ASCII';
-  sANSIDefaultEncoding = 'ANSI (Default)';
-  sUTF8Encoding = 'UTF-8';
-  sUTF16LEEncoding = 'Unicode (Little Endian)';
-  sUTF16BEEncoding = 'Unicode (Big Endian)';
   // descriptions of supported file filter strings
   sRTFDesc = 'Rich text file';
   sTextDesc = 'Plain text file';
   sHTML5Desc = 'HTML 5 file';
   sXHTMLDesc = 'XHTML file';
   sMarkdownDesc = 'Markdown file';
+
 begin
   inherited InternalCreate;
   fView := AView;
@@ -290,45 +285,29 @@ constructor TSaveInfoMgr.InternalCreate(AView: IView);
   fSourceFileInfo.FileTypeInfo[sfRTF] := TSourceFileTypeInfo.Create(
     '.rtf',
     sRTFDesc,
-    [
-      TSourceFileEncoding.Create(etASCII, sASCIIEncoding)
-    ]
+    [etASCII]
   );
   fSourceFileInfo.FileTypeInfo[sfText] := TSourceFileTypeInfo.Create(
     '.txt',
     sTextDesc,
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding),
-      TSourceFileEncoding.Create(etUTF16LE, sUTF16LEEncoding),
-      TSourceFileEncoding.Create(etUTF16BE, sUTF16BEEncoding),
-      TSourceFileEncoding.Create(etSysDefault, sANSIDefaultEncoding)
-    ]
+    [etUTF8, etUTF16LE, etUTF16BE, etSysDefault]
   );
   fSourceFileInfo.FileTypeInfo[sfHTML5] := TSourceFileTypeInfo.Create(
     '.html',
     sHTML5Desc,
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding)
-    ]
+    [etUTF8]
   );
   fSourceFileInfo.DefaultFileName := sDefFileName;
   fSourceFileInfo.FileTypeInfo[sfXHTML] := TSourceFileTypeInfo.Create(
     '.html',
     sXHTMLDesc,
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding)
-    ]
+    [etUTF8]
   );
   fSourceFileInfo.DefaultFileName := sDefFileName;
   fSourceFileInfo.FileTypeInfo[sfMarkdown] := TSourceFileTypeInfo.Create(
     '.md',
     sMarkdownDesc,
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding),
-      TSourceFileEncoding.Create(etUTF16LE, sUTF16LEEncoding),
-      TSourceFileEncoding.Create(etUTF16BE, sUTF16BEEncoding),
-      TSourceFileEncoding.Create(etSysDefault, sANSIDefaultEncoding)
-    ]
+    [etUTF8, etUTF16LE, etUTF16BE, etSysDefault]
   );
   fSourceFileInfo.DefaultFileName := sDefFileName;
 

Src/USaveSourceDlg.pas

@@ -228,8 +228,6 @@ implementation
   sChkTruncateComment = 'Truncate comments to 1st paragraph';
   sBtnPreview = '&Preview...';
   sBtnHelp = '&Help';
-  // Default encoding name
-  sANSIEncoding = 'ANSI (Default)';
 
 
 const
@@ -483,7 +481,7 @@ procedure TSaveSourceDlg.DoTypeChange;
     fOnEncodingQuery(Self, Encodings);
   if Length(Encodings) = 0 then
     Encodings := TSourceFileEncodings.Create(
-      TSourceFileEncoding.Create(etSysDefault, sANSIEncoding)
+      TSourceFileEncoding.Create(etSysDefault)
     );
   fCmbEncoding.Clear;
   for Encoding in Encodings do

Src/USaveSourceMgr.pas

@@ -134,8 +134,8 @@ implementation
   // Delphi
   SysUtils,
   // Project
-  FmPreviewDlg, Hiliter.UFileHiliter, UIOUtils, UMessageBox, UOpenDialogHelper,
-  UPreferences;
+  FmPreviewDlg, Hiliter.UFileHiliter, UIOUtils, UMessageBox,
+  UOpenDialogHelper, UPreferences;
 
 
 { TSaveSourceMgr }
@@ -244,53 +244,33 @@ procedure TSaveSourceMgr.HiliteQueryHandler(Sender: TObject;
 end;
 
 constructor TSaveSourceMgr.InternalCreate;
-resourcestring
-  // descriptions of supported encodings
-  sANSIDefaultEncoding = 'ANSI (Default)';
-  sUTF8Encoding = 'UTF-8';
-  sUTF16LEEncoding = 'Unicode (Little Endian)';
-  sUTF16BEEncoding = 'Unicode (Big Endian)';
 begin
   inherited InternalCreate;
   fSourceFileInfo := TSourceFileInfo.Create;
   fSourceFileInfo.FileTypeInfo[sfText] := TSourceFileTypeInfo.Create(
     '.txt',
     GetFileTypeDesc(sfText),
-    [
-      TSourceFileEncoding.Create(etSysDefault, sANSIDefaultEncoding),
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding),
-      TSourceFileEncoding.Create(etUTF16LE, sUTF16LEEncoding),
-      TSourceFileEncoding.Create(etUTF16BE, sUTF16BEEncoding)
-    ]
+    [etSysDefault, etUTF8, etUTF16LE, etUTF16BE]
   );
   fSourceFileInfo.FileTypeInfo[sfPascal] := TSourceFileTypeInfo.Create(
     '.pas',
     GetFileTypeDesc(sfPascal),
-    [
-      TSourceFileEncoding.Create(etSysDefault, sANSIDefaultEncoding),
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding)
-    ]
+    [etSysDefault, etUTF8]
   );
   fSourceFileInfo.FileTypeInfo[sfHTML5] := TSourceFileTypeInfo.Create(
     '.html',
     GetFileTypeDesc(sfHTML5),
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding)
-    ]
+    [etUTF8]
   );
   fSourceFileInfo.FileTypeInfo[sfXHTML] := TSourceFileTypeInfo.Create(
     '.html',
     GetFileTypeDesc(sfXHTML),
-    [
-      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding)
-    ]
+    [etUTF8]
   );
   fSourceFileInfo.FileTypeInfo[sfRTF] := TSourceFileTypeInfo.Create(
     '.rtf',
     GetFileTypeDesc(sfRTF),
-    [
-      TSourceFileEncoding.Create(etSysDefault, sANSIDefaultEncoding)
-    ]
+    [etSysDefault]
  );
   fSourceFileInfo.DefaultFileName := GetDefaultFileName;
 

Src/USourceFileInfo.pas

@@ -46,11 +46,15 @@   TSourceFileEncoding = record
     fEncodingType: TEncodingType; // Value of EncodingType property
     fDisplayName: string;         // Value of DisplayName property
   public
-    ///  <summary>Sets values of properties.</summary>
-    constructor Create(const AEncodingType: TEncodingType;
-      const ADisplayName: string);
+    ///  <summary>Sets the value of the <c>EncodingType</c> property.</summary>
+    ///  <remarks>The <c>DisplayName</c> property is dependent on the value of
+    ///  the <c>EncodingType</c> property and so can't be set explicitly.
+    ///  </remarks>
+    constructor Create(const AEncodingType: TEncodingType);
+
     ///  <summary>Type of this encoding.</summary>
     property EncodingType: TEncodingType read fEncodingType;
+
     ///  <summary>Description of encoding for display in dialog box.</summary>
     property DisplayName: string read fDisplayName;
   end;
@@ -72,7 +76,7 @@   TSourceFileTypeInfo = record
   public
     ///  <summary>Sets values of properties.</summary>
     constructor Create(const AExtension, ADisplayName: string;
-      const AEncodings: array of TSourceFileEncoding);
+      const AEncodingTypes: array of TEncodingType);
     ///  <summary>File extension associated with this file type.</summary>
     property Extension: string read fExtension;
     ///  <summary>Name of file extension to display in save dialog box.
@@ -163,6 +167,7 @@ implementation
   // Delphi
   SysUtils, Windows {for inlining}, Character,
   // Project
+  ULocales,
   UStrUtils;
 
 
@@ -261,24 +266,54 @@ function TSourceFileInfo.SupportsFileType(const FileType: TSourceFileType):
 { TSourceFileTypeInfo }
 
 constructor TSourceFileTypeInfo.Create(const AExtension, ADisplayName: string;
-  const AEncodings: array of TSourceFileEncoding);
+  const AEncodingTypes: array of TEncodingType);
 var
   I: Integer;
 begin
   fExtension := AExtension;
   fDisplayName := ADisplayName;
-  SetLength(fEncodings, Length(AEncodings));
-  for I := 0 to Pred(Length(AEncodings)) do
-    fEncodings[I] := AEncodings[I];
+  SetLength(fEncodings, Length(AEncodingTypes));
+  for I := 0 to Pred(Length(AEncodingTypes)) do
+    fEncodings[I] := TSourceFileEncoding.Create(AEncodingTypes[I]);
 end;
 
 { TSourceFileEncoding }
 
-constructor TSourceFileEncoding.Create(const AEncodingType: TEncodingType;
-  const ADisplayName: string);
+constructor TSourceFileEncoding.Create(const AEncodingType: TEncodingType);
+resourcestring
+  // Display names associated with each TEncodingType value
+  sASCIIEncodingName = 'ASCII';
+  sISO88591Name = 'ISO-8859-1';
+  sUTF8Name = 'UTF-8';
+  sUnicodeName = 'UTF-16';
+  sUTF16BEName = 'UTF-16 Big Endian';
+  sUTF16LEName = 'UTF-16 Little Endian';
+  sWindows1252Name = 'Windows-1252';
+  sSysDefaultName = 'ANSI Code Page %d';
 begin
   fEncodingType := AEncodingType;
-  fDisplayName := ADisplayName;
+  case fEncodingType of
+    etASCII:
+      fDisplayName := sASCIIEncodingName;
+    etISO88591:
+      fDisplayName := sISO88591Name;
+    etUTF8:
+      fDisplayName := sUTF8Name;
+    etUnicode:
+      fDisplayName := sUnicodeName;
+    etUTF16BE:
+      fDisplayName := sUTF16BEName;
+    etUTF16LE:
+      fDisplayName := sUTF16LEName;
+    etWindows1252:
+      fDisplayName := sWindows1252Name;
+    etSysDefault:
+      fDisplayName := Format(sSysDefaultName, [ULocales.DefaultAnsiCodePage]);
+    else
+      fDisplayName := '';
+  end;
+  Assert(fDisplayName <> '',
+    'TSourceFileEncoding.Create: Unrecognised encoding type');
 end;
 
 end.