Merge branch 'feature/162-save-snippet-info-as-plain-text' into develop

Fixes #162

Author: delphidabbler

Src/USaveInfoMgr.pas

@@ -16,34 +16,94 @@ interface
 
 uses
   // Project
+  UBaseObjects,
   UEncodings,
+  USaveSourceDlg,
+  USourceFileInfo,
   UView;
 
 
 type
-  ///  <summary>Method-only record that saves information about a snippet to
-  ///  file in rich text format. The snippet is obtained from a view. Only
-  ///  snippet views are supported.</summary>
-  TSaveInfoMgr = record
+  ///  <summary>Class that saves information about a snippet to file a user
+  ///  specified format. The snippet is obtained from a view. Only snippet views
+  ///  are supported.</summary>
+  TSaveInfoMgr = class(TNoPublicConstructObject)
   strict private
-    ///  <summary>Attempts to name of the file to be written from the user.
-    ///  </summary>
-    ///  <param name="AFileName"><c>string</c> [out] Set to the name of the file
-    ///  entered by the user. Undefined if the user cancelled.</param>
-    ///  <returns><c>Boolean</c>. <c>True</c> if the user entered and accepted a
-    ///  file name of <c>False</c> if the user cancelled.</returns>
-    class function TryGetFileNameFromUser(out AFileName: string): Boolean;
-      static;
+    var
+      fView: IView;
+      fSaveDlg: TSaveSourceDlg;
+      fSourceFileInfo: TSourceFileInfo;
+
     ///  <summary>Returns encoded data containing a RTF representation of
     ///  information about the snippet represented by the given view.</summary>
-    class function GenerateRichText(View: IView): TEncodedData; static;
+    class function GenerateRichText(View: IView; const AUseHiliting: Boolean):
+      TEncodedData; static;
+
+    ///  <summary>Returns encoded data containing a plain text representation of
+    ///  information about the snippet represented by the given view.</summary>
+    function GeneratePlainText: TEncodedData;
+
+    ///  <summary>Returns type of file selected in the associated save dialogue
+    ///  box.</summary>
+    function SelectedFileType: TSourceFileType;
+
+    ///  <summary>Handles the custom save dialogue's <c>OnPreview</c> event.
+    ///  Displays the required snippet information, appropriately formatted, in
+    ///  a preview dialogues box.</summary>
+    ///  <param name="Sender"><c>TObject</c> [in] Reference to the object that
+    ///  triggered the event.</param>
+    procedure PreviewHandler(Sender: TObject);
+
+    ///  <summary>Handles the custom save dialogue's <c>OnHiliteQuery</c> event.
+    ///  Determines whether syntax highlighting is supported for the source code
+    ///  section of the required snippet information..</summary>
+    ///  <param name="Sender"><c>TObject</c> [in] Reference to the object that
+    ///  triggered the event.</param>
+    ///  <param name="CanHilite"><c>Boolean</c> [in/out] Set to <c>False</c>
+    ///  when called. Should be set to <c>True</c> iff highlighting is
+    ///  supported.</param>
+    procedure HighlightQueryHandler(Sender: TObject; var CanHilite: Boolean);
+
+    ///  <summary>Handles the custom save dialogue's <c>OnEncodingQuery</c>
+    ///  event.</summary>
+    ///  <param name="Sender"><c>TObject</c> [in] Reference to the object that
+    ///  triggered the event.</param>
+    ///  <param name="Encodings"><c>TSourceFileEncodings</c> [in/out] Called
+    ///  with an empty array which the event handler must be set to contain the
+    ///  encodings supported by the currently selected file type.</param>
+    procedure EncodingQueryHandler(Sender: TObject;
+      var Encodings: TSourceFileEncodings);
+
+    ///  <summary>Generates the required snippet information in the requested
+    ///  format.</summary>
+    ///  <param name="FileType"><c>TSourceFileType</c> [in] Type of file to be
+    ///  generated.</param>
+    ///  <returns><c>TEncodedData</c>. The formatted snippet information, syntax
+    ///  highlighted if required.</returns>
+    function GenerateOutput(const FileType: TSourceFileType): TEncodedData;
+
+    ///  <summary>Displays the save dialogue box and creates required type of
+    ///  snippet information file if the user OKs.</summary>
+    procedure DoExecute;
+
+  strict protected
+
+    ///  <summary>Internal constructor. Initialises managed save source dialogue
+    ///  box and records information about supported file types.</summary>
+    constructor InternalCreate(AView: IView);
+
   public
+
+    ///  <summary>Object descructor. Tears down object.</summary>
+    destructor Destroy; override;
+
     ///  <summary>Saves information about the snippet referenced by the a given
     ///  view to file.</summary>
     ///  <remarks>The view must be a snippet view.</remarks>
     class procedure Execute(View: IView); static;
-    ///  <summary>Checks if a given view can be saved to the clipboard. Returns
-    ///  True only if the view represents a snippet.</summary>
+
+    ///  <summary>Checks if the given view can be saved to file. Returns
+    ///  <c>True</c> if the view represents a snippet.</summary>
     class function CanHandleView(View: IView): Boolean; static;
 
   end;
@@ -55,13 +115,17 @@ implementation
   SysUtils,
   Dialogs,
   // Project
+  FmPreviewDlg,
   Hiliter.UAttrs,
+  Hiliter.UFileHiliter,
   Hiliter.UGlobals,
   UIOUtils,
   UOpenDialogHelper,
+  UPreferences,
   URTFSnippetDoc,
   URTFUtils,
-  USaveDialogEx;
+  USourceGen,
+  UTextSnippetDoc;
 
 { TSaveInfoMgr }
 
@@ -70,27 +134,101 @@ class function TSaveInfoMgr.CanHandleView(View: IView): Boolean;
   Result := Supports(View, ISnippetView);
 end;
 
+destructor TSaveInfoMgr.Destroy;
+begin
+  fSourceFileInfo.Free;
+  fSaveDlg.Free;
+  inherited;
+end;
+
+procedure TSaveInfoMgr.DoExecute;
+var
+  Encoding: TEncoding;        // encoding to use for output file
+  FileContent: string;        // output file content before encoding
+  FileType: TSourceFileType;  // type of source file
+begin
+  // Set up dialog box
+  fSaveDlg.Filter := fSourceFileInfo.FilterString;
+  fSaveDlg.FilterIndex := FilterDescToIndex(
+    fSaveDlg.Filter,
+    fSourceFileInfo.FileTypeInfo[Preferences.SourceDefaultFileType].DisplayName,
+    1
+  );
+  fSaveDlg.FileName := fSourceFileInfo.DefaultFileName;
+  // Display dialog box and save file if user OKs
+  if fSaveDlg.Execute then
+  begin
+    FileType := SelectedFileType;
+    FileContent := GenerateOutput(FileType).ToString;
+    Encoding := TEncodingHelper.GetEncoding(fSaveDlg.SelectedEncoding);
+    try
+      FileContent := GenerateOutput(FileType).ToString;
+      TFileIO.WriteAllText(fSaveDlg.FileName, FileContent, Encoding, True);
+    finally
+      TEncodingHelper.FreeEncoding(Encoding);
+    end;
+  end;
+end;
+
+procedure TSaveInfoMgr.EncodingQueryHandler(Sender: TObject;
+  var Encodings: TSourceFileEncodings);
+begin
+  Encodings := fSourceFileInfo.FileTypeInfo[SelectedFileType].Encodings;
+end;
+
 class procedure TSaveInfoMgr.Execute(View: IView);
 var
-  FileName: string;
-  RTFMarkup: TRTFMarkup;
+  Instance: TSaveInfoMgr;
 begin
   Assert(Assigned(View), 'TSaveInfoMgr.Execute: View is nil');
   Assert(CanHandleView(View), 'TSaveInfoMgr.Execute: View not supported');
-  if not TryGetFileNameFromUser(FileName) then
-    Exit;
-  RTFMarkup := TRTFMarkup.Create(GenerateRichText(View));
-  TFileIO.WriteAllBytes(FileName, RTFMarkup.ToBytes);
+
+  Instance := TSaveInfoMgr.InternalCreate(View);
+  try
+    Instance.DoExecute;
+  finally
+    Instance.Free;
+  end;
 end;
 
-class function TSaveInfoMgr.GenerateRichText(View: IView): TEncodedData;
+function TSaveInfoMgr.GenerateOutput(const FileType: TSourceFileType):
+  TEncodedData;
+var
+  UseHiliting: Boolean;
+begin
+  UseHiliting := fSaveDlg.UseSyntaxHiliting and
+    TFileHiliter.IsHilitingSupported(FileType);
+  case FileType of
+    sfRTF: Result := GenerateRichText(fView, UseHiliting);
+    sfText: Result := GeneratePlainText;
+  end;
+end;
+
+function TSaveInfoMgr.GeneratePlainText: TEncodedData;
+var
+  Doc: TTextSnippetDoc;        // object that generates RTF document
+  HiliteAttrs: IHiliteAttrs;  // syntax highlighter formatting attributes
+begin
+  Assert(Supports(fView, ISnippetView),
+    ClassName + '.GeneratePlainText: View is not a snippet view');
+  HiliteAttrs := THiliteAttrsFactory.CreateNulAttrs;
+  Doc := TTextSnippetDoc.Create;
+  try
+    Result := Doc.Generate((fView as ISnippetView).Snippet);
+  finally
+    Doc.Free;
+  end;
+end;
+
+class function TSaveInfoMgr.GenerateRichText(View: IView;
+  const AUseHiliting: Boolean): TEncodedData;
 var
   Doc: TRTFSnippetDoc;        // object that generates RTF document
   HiliteAttrs: IHiliteAttrs;  // syntax highlighter formatting attributes
 begin
   Assert(Supports(View, ISnippetView),
     'TSaveInfoMgr.GenerateRichText: View is not a snippet view');
-  if (View as ISnippetView).Snippet.HiliteSource then
+  if (View as ISnippetView).Snippet.HiliteSource and AUseHiliting then
     HiliteAttrs := THiliteAttrsFactory.CreateUserAttrs
   else
     HiliteAttrs := THiliteAttrsFactory.CreateNulAttrs;
@@ -105,28 +243,103 @@ class function TSaveInfoMgr.GenerateRichText(View: IView): TEncodedData;
   end;
 end;
 
-class function TSaveInfoMgr.TryGetFileNameFromUser(
-  out AFileName: string): Boolean;
-var
-  Dlg: TSaveDialogEx;
+procedure TSaveInfoMgr.HighlightQueryHandler(Sender: TObject;
+  var CanHilite: Boolean);
+begin
+  CanHilite := TFileHiliter.IsHilitingSupported(SelectedFileType);
+end;
+
+constructor TSaveInfoMgr.InternalCreate(AView: IView);
+const
+  DlgHelpKeyword = 'SnippetInfoFileDlg';
 resourcestring
-  sCaption = 'Save Snippet Information';     // dialogue box caption
-  sFilter = 'Rich Text File (*.rtf)|*.rtf|'  // file filter
-    + 'All files (*.*)|*.*';
+  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';
 begin
-  Dlg := TSaveDialogEx.Create(nil);
-  try
-    Dlg.Title := sCaption;
-    Dlg.Options := [ofShowHelp, ofNoTestFileCreate, ofEnableSizing];
-    Dlg.Filter := sFilter;
-    Dlg.FilterIndex := 1;
-    Dlg.HelpKeyword := 'SnippetInfoFileDlg';
-    Result := Dlg.Execute;
-    if Result then
-      AFileName := FileOpenFileNameWithExt(Dlg)
-  finally
-    Dlg.Free;
+  inherited InternalCreate;
+  fView := AView;
+  fSourceFileInfo := TSourceFileInfo.Create;
+  // RTF and plain text files supported at present
+  fSourceFileInfo.FileTypeInfo[sfRTF] := TSourceFileTypeInfo.Create(
+    '.rtf',
+    sRTFDesc,
+    [
+      TSourceFileEncoding.Create(etASCII, sASCIIEncoding)
+    ]
+  );
+  fSourceFileInfo.FileTypeInfo[sfText] := TSourceFileTypeInfo.Create(
+    '.txt',
+    sTextDesc,
+    [
+      TSourceFileEncoding.Create(etUTF8, sUTF8Encoding),
+      TSourceFileEncoding.Create(etUTF16LE, sUTF16LEEncoding),
+      TSourceFileEncoding.Create(etUTF16BE, sUTF16BEEncoding),
+      TSourceFileEncoding.Create(etSysDefault, sANSIDefaultEncoding)
+    ]
+  );
+  fSourceFileInfo.DefaultFileName := sDefFileName;
+
+  fSaveDlg := TSaveSourceDlg.Create(nil);
+  fSaveDlg.Title := sDlgCaption;
+  fSaveDlg.HelpKeyword := DlgHelpKeyword;
+  fSaveDlg.CommentStyle := TCommentStyle.csNone;
+  fSaveDlg.EnableCommentStyles := False;
+  fSaveDlg.TruncateComments := Preferences.TruncateSourceComments;
+  fSaveDlg.UseSyntaxHiliting := Preferences.SourceSyntaxHilited;
+  fSaveDlg.OnPreview := PreviewHandler;
+  fSaveDlg.OnHiliteQuery := HighlightQueryHandler;
+  fSaveDlg.OnEncodingQuery := EncodingQueryHandler;
+end;
+
+procedure TSaveInfoMgr.PreviewHandler(Sender: TObject);
+resourcestring
+  sDocTitle = '"%0:s" snippet';
+var
+  // Type of snippet information document to preview: this is not always the
+  // same as the selected file type, because preview dialogue box doesn't
+  // support some types & we have to use an alternate.
+  PreviewFileType: TSourceFileType;
+  // Type of preview document supported by preview dialogue box
+  PreviewDocType: TPreviewDocType;
+begin
+  case SelectedFileType of
+    sfRTF:
+    begin
+      PreviewDocType := dtRTF;
+      PreviewFileType := sfRTF;
+    end;
+    sfText:
+    begin
+      PreviewDocType := dtPlainText;
+      PreviewFileType := sfText;
+    end;
+    else
+      raise Exception.Create(
+        ClassName + '.PreviewHandler: unsupported file type'
+      );
   end;
+  // Display preview dialog box. We use save dialog as owner to ensure preview
+  // dialog box is aligned over save dialog box
+  TPreviewDlg.Execute(
+    fSaveDlg,
+    GenerateOutput(PreviewFileType),
+    PreviewDocType,
+    Format(sDocTitle, [fView.Description])
+  );
+end;
+
+function TSaveInfoMgr.SelectedFileType: TSourceFileType;
+begin
+  Result := fSourceFileInfo.FileTypeFromFilterIdx(fSaveDlg.FilterIndex);
 end;
 
 end.