Changeset 198 for trunk/Forms/UFormCheck.pas

Timestamp:

Aug 23, 2018, 3:38:32 PM (6 years ago)

Author:

chronos

Message:

• Added: Configurable case sensitivity for comparison in Document check.
• Modified: Show Document check report as ListView. Show message type in separate column.

File:

• trunk/Forms/UFormCheck.pas (modified) (21 diffs)

trunk/Forms/UFormCheck.pas

@@ -7 +7 @@
 uses
   Classes, SysUtils, FileUtil, Forms, Controls, Graphics, Dialogs, StdCtrls,
-  ExtCtrls, ComCtrls, UAcronym, URegistry, Registry, UCommon;
+  ExtCtrls, ComCtrls, Menus, UAcronym, URegistry, Registry, UCommon, fgl;
 
 type
+  TReportType = (rtNone, rtNote, rtWarning, rtError);
+
+  TReportItem = class
+    Message: string;
+    Position: TPoint;
+    Kind: TReportType;
+  end;
+
+  { TReportItems }
+
+  TReportItems = class(TFPGObjectList<TReportItem>)
+    function AddNew(Message: string; Position: TPoint;
+      Kind: TReportType = rtNone): TReportItem;
+  end;
 
   { TFormCheck }
@@ -18 +32 @@
     ButtonAcronymsSummary: TButton;
     ButtonCheck: TButton;
+    CheckBoxCaseSensitive: TCheckBox;
     EditSummaryStart: TEdit;
     EditSummaryEnd: TEdit;
@@ -26 +41 @@
     LabelAcronymCountContent: TLabel;
     LabelAcronymCountSummary: TLabel;
+    ListViewReport: TListView;
     MemoDocument: TMemo;
-    MemoReport: TMemo;
+    MenuItemGoTo: TMenuItem;
     OpenDialog1: TOpenDialog;
     PageControl1: TPageControl;
     Panel1: TPanel;
     Panel2: TPanel;
+    PopupMenuReport: TPopupMenu;
     Splitter1: TSplitter;
     TabSheetSource: TTabSheet;
@@ -43 +60 @@
     procedure FormDestroy(Sender: TObject);
     procedure FormShow(Sender: TObject);
+    procedure ListViewReportData(Sender: TObject; Item: TListItem);
+    procedure MenuItemGoToClick(Sender: TObject);
   private
     AcronymDbSummary: TAcronymDb;
@@ -61 +80 @@
     procedure ReportDifferencies;
     function WordContainsLetters(Text, Letters: string): Boolean;
+    function StringEqual(Text1, Text2: string): Boolean;
+    procedure ReloadReport;
   public
+    ReportItems: TReportItems;
     procedure UpdateInterface;
     procedure LoadConfig;
@@ -70 +92 @@
   FormCheck: TFormCheck;
 
+const
+  ReportTypeString: array[TReportType] of string = ('', 'Note', 'Warning', 'Error');
+
 
 implementation
@@ -81 +106 @@
   SAcronymCountContent = 'Content acronym count:';
   SAcronymCountSummary = 'Summary acronym count:';
-  SDuplicateAcronymContent = 'Warning: Duplicate acronym %s with "%s" in document body.';
-  SDuplicateAcronymSummary = 'Warning: Duplicate acronym %s with "%s" in acronym summary.';
-  SMissingAcronymContent = 'Warning: Document body acronym %s with meaning "%s" missing from acronym summary.';
-  SMissingAcronymSummary = 'Warning: Summary acronym %s with meaning "%s" missing from document body.';
-  SAcronymContentMultipleMeanings = 'Warning: Content acronym %s has multiple meanings: %s.';
-  SAcronymSummaryMultipleMeanings = 'Warning: Summary acronym %s has multiple meanings: %s.';
-  SAcronymWithDifferentMeaning = 'Warning: Acronym %s has different meaning for content "%s" and for summary "%s".';
-  SAcronymWithDifferentMeaningCount = 'Warning: Acronym %s has different meaning count for content (%d) and for summary (%d).';
-  SPluralAcronym = 'Note: Acronym %s is defined as plural in document body.';
-  SPluralAcronymUsed = 'Note: Acronym %s is used as plural in document body.';
+  SDuplicateAcronymContent = 'Duplicate acronym %s with "%s" in document body.';
+  SDuplicateAcronymSummary = 'Duplicate acronym %s with "%s" in acronym summary.';
+  SMissingAcronymContent = 'Document body acronym %s with meaning "%s" missing from acronym summary.';
+  SMissingAcronymSummary = 'Summary acronym %s with meaning "%s" missing from document body.';
+  SAcronymContentMultipleMeanings = 'Content acronym %s has multiple meanings: %s.';
+  SAcronymSummaryMultipleMeanings = 'Summary acronym %s has multiple meanings: %s.';
+  SAcronymWithDifferentMeaning = 'Acronym %s has different meaning for content "%s" and for summary "%s".';
+  SAcronymWithDifferentMeaningCount = 'Acronym %s has different meaning count for content (%d) and for summary (%d).';
+  SPluralAcronym = 'Acronym %s is defined as plural in document body.';
+  SPluralAcronymUsed = 'Acronym %s is used as plural in document body.';
   SSummaryAcronyms = 'Summary acronyms';
   SContentAcronyms = 'Content acronyms';
@@ -98 +123 @@
   MinAcronymLength = 2;
 
+{ TReportItems }
+
+function TReportItems.AddNew(Message: string; Position: TPoint;
+  Kind: TReportType = rtNone): TReportItem;
+begin
+  Result := TReportItem.Create;
+  Result.Message := Message;
+  Result.Position := Position;
+  Result.Kind := Kind;
+  Add(Result);
+end;
+
 { TFormCheck }
 
 procedure TFormCheck.ButtonCheckClick(Sender: TObject);
 begin
-  MemoReport.Lines.Clear;
+  ReportItems.Clear;
+  UpdateInterface;
   FindInSummary;
   FindInContent;
   ReportDifferencies;
   UpdateInterface;
+  ReloadReport;
   TabSheetReport.Show;
 end;
@@ -132 +171 @@
   Core.CoolTranslator1.TranslateComponentRecursive(Self);
   Core.ThemeManager.UseTheme(Self);
+  ReportItems := TReportItems.Create;
 end;
 
 procedure TFormCheck.FormDestroy(Sender: TObject);
 begin
+  ReportItems.Free;
   AcronymDbSummary.Free;
   AcronymDbContent.Free;
@@ -142 +183 @@
 procedure TFormCheck.FormShow(Sender: TObject);
 begin
+  PageControl1.TabIndex := 0;
   Core.PersistentForm1.Load(Self);
-  if FileExists(LastDocumentFileName) then MemoDocument.Lines.LoadFromFile(LastDocumentFileName);
+  if FileExists(LastDocumentFileName) then
+    MemoDocument.Lines.LoadFromFile(LastDocumentFileName);
   UpdateInterface;
+end;
+
+procedure TFormCheck.ListViewReportData(Sender: TObject; Item: TListItem);
+begin
+  if Item.Index < ReportItems.Count then
+    with ReportItems[Item.Index] do begin
+      if Position <> Point(0, 0) then
+        Item.Caption := IntToStr(Position.X) + ', ' + IntToStr(Position.Y)
+        else Item.Caption := '';
+      Item.Data := ReportItems[Item.Index];
+      Item.SubItems.Add(ReportTypeString[Kind]);
+      Item.SubItems.Add(Message);
+    end;
+end;
+
+procedure TFormCheck.MenuItemGoToClick(Sender: TObject);
+begin
+  if Assigned(ListViewReport.Selected) then
+  with TReportItem(ListViewReport.Selected.Data) do
+  if Position <> Point(0, 0) then begin
+    MemoDocument.CaretPos := Position;
+    TabSheetSource.Show;
+  end;
 end;
 
@@ -214 +280 @@
               Meaning := Trim(Copy(Line, Pos(' ', Line) + 1, Length(Line)));
               if Assigned(AcronymDbSummary.SearchAcronym(Acronym, Meaning)) then
-                MemoReport.Lines.Add(Format(SDuplicateAcronymSummary, [Acronym, Meaning]))
+                ReportItems.AddNew(Format(SDuplicateAcronymSummary, [Acronym, Meaning]), Point(0, I), rtWarning)
                 else AcronymDbSummary.AddAcronym(Acronym, Meaning);
             end;
@@ -295 +361 @@
           AllowedSideChar(AcronymCharBefore, AcronymCharAfter) then begin
             // If plural acronym then try to remove ending 's' character from the meaning
-            if Plural then MemoReport.Lines.Add(Format(SPluralAcronymUsed, [Acronym]));
+            if Plural then ReportItems.AddNew(Format(SPluralAcronymUsed, [Acronym]), Point(0, 0), rtNote);
 
             Acro := AcronymDbContent.Acronyms.SearchByName(Acronym);
             if not Assigned(Acro) then begin
-              MemoReport.Lines.Add(Format(SAcronymUsedBeforeDefined, [Acronym]));
+              ReportItems.AddNew(Format(SAcronymUsedBeforeDefined, [Acronym]), Point(0, 0), rtNote);
               AcronymDbContent.AddAcronym(Acronym, '');
             end;
@@ -323 +389 @@
           if HasMeaning1 or HasMeaning2 then begin
             // If plural acronym then try to remove ending 's' character from the meaning
-            if Plural then MemoReport.Lines.Add(Format(SPluralAcronym, [Acronym]));
+            if Plural then ReportItems.AddNew(Format(SPluralAcronym, [Acronym]), Point(0, 0));
             if Plural and (Length(Meaning) >= 1) and (Meaning[Length(Meaning)] = 's') then begin
               Meaning := Copy(Meaning, 1, Length(Meaning) - 1);
             end;
             if Assigned(AcronymDbContent.SearchAcronym(Acronym, Meaning)) then
-              MemoReport.Lines.Add(Format(SDuplicateAcronymContent, [Acronym, Meaning]))
+              ReportItems.AddNew(Format(SDuplicateAcronymContent, [Acronym, Meaning]), Point(0, 0), rtWarning)
               else AcronymDbContent.AddAcronym(Acronym, Meaning);
           end;
@@ -511 +577 @@
     Acronym := TAcronym(AcronymDbContent.Acronyms[I]);
     if Acronym.Meanings.Count > 1 then
-      MemoReport.Lines.Add(Format(SAcronymContentMultipleMeanings, [Acronym.Name, Acronym.Meanings.GetNames]));
+      ReportItems.AddNew(Format(SAcronymContentMultipleMeanings, [Acronym.Name,
+        Acronym.Meanings.GetNames]), Point(0, 0), rtWarning);
     Acronym2 := AcronymDbSummary.Acronyms.SearchByName(Acronym.Name);
     if not Assigned(Acronym2) then
@@ -517 +584 @@
       Meaning := TAcronymMeaning(Acronym.Meanings[J]);
       if not Assigned(AcronymDbSummary.SearchAcronym(Acronym.Name, Meaning.Name, [sfCaseInsensitive])) then
-        MemoReport.Lines.Add(Format(SMissingAcronymContent, [Acronym.Name, Meaning.Name]));
+        ReportItems.AddNew(Format(SMissingAcronymContent, [Acronym.Name, Meaning.Name]), Point(0, 0), rtWarning);
     end;
   end;
@@ -525 +592 @@
     Acronym := TAcronym(AcronymDbSummary.Acronyms[I]);
     if Acronym.Meanings.Count > 1 then
-      MemoReport.Lines.Add(Format(SAcronymSummaryMultipleMeanings, [Acronym.Name, Acronym.Meanings.GetNames]));
+      ReportItems.AddNew(Format(SAcronymSummaryMultipleMeanings, [Acronym.Name, Acronym.Meanings.GetNames]), Point(0, 0), rtWarning);
     Acronym2 := AcronymDbContent.Acronyms.SearchByName(Acronym.Name);
     if not Assigned(Acronym2) then
@@ -531 +598 @@
       Meaning := TAcronymMeaning(Acronym.Meanings[J]);
       if not Assigned(AcronymDbContent.SearchAcronym(Acronym.Name, Meaning.Name, [sfCaseInsensitive])) then
-        MemoReport.Lines.Add(Format(SMissingAcronymSummary, [Acronym.Name, Meaning.Name]));
+        ReportItems.AddNew(Format(SMissingAcronymSummary, [Acronym.Name, Meaning.Name]), Point(0, 0), rtWarning);
     end;
   end;
@@ -543 +610 @@
         Meaning := TAcronymMeaning(Acronym.Meanings[0]);
         Meaning2 := TAcronymMeaning(Acronym2.Meanings[0]);
-        if Meaning.Name <> Meaning2.Name then
-          MemoReport.Lines.Add(Format(SAcronymWithDifferentMeaning, [Acronym.Name, Meaning.Name, Meaning2.Name]));
+        if not StringEqual(Meaning.Name, Meaning2.Name) then
+          ReportItems.AddNew(Format(SAcronymWithDifferentMeaning, [Acronym.Name, Meaning2.Name, Meaning.Name]), Point(0, 0), rtWarning);
       end else
-        MemoReport.Lines.Add(Format(SAcronymWithDifferentMeaningCount, [Acronym.Name, Acronym.Meanings.Count, Acronym2.Meanings.Count]));
+        ReportItems.AddNew(Format(SAcronymWithDifferentMeaningCount, [Acronym.Name, Acronym2.Meanings.Count, Acronym.Meanings.Count]), Point(0, 0), rtWarning);
     end;
   end;
@@ -568 +635 @@
 end;
 
+function TFormCheck.StringEqual(Text1, Text2: string): Boolean;
+begin
+  if CheckBoxCaseSensitive.Checked then Result := Text1 = Text2
+    else Result := LowerCase(Text1) = LowerCase(Text2);
+end;
+
+procedure TFormCheck.ReloadReport;
+begin
+  ListViewReport.Items.Count := ReportItems.Count;
+  ListViewReport.Refresh;
+end;
+
 procedure TFormCheck.UpdateInterface;
 begin
@@ -582 +661 @@
     EditSummaryStart.Text := ReadStringWithDefault('SummaryStart', 'ACRONYMS AND ABBREVIATIONS');
     EditSummaryEnd.Text := ReadStringWithDefault('SummaryEnd', 'Appendix');
-    LastDocumentFileName := ReadStringWithDefault('LastDocumentFileName', '')
+    LastDocumentFileName := ReadStringWithDefault('LastDocumentFileName', '');
+    CheckBoxCaseSensitive.Checked := ReadBoolWithDefault('CaseSensitiveComparison', False);
   finally
     Free;
@@ -597 +677 @@
     WriteString('SummaryEnd', EditSummaryEnd.Text);
     WriteString('LastDocumentFileName', LastDocumentFileName);
+    WriteBool('CaseSensitiveComparison', CheckBoxCaseSensitive.Checked);
   finally
     Free;