Add support for generating and displaying deprecated warnings

Author: delphidabbler

Diff for: Src/UMain.pas

@@ -30,9 +30,11 @@   TMain = class(TObject)
     fConfig: TConfig;     // Program configurations object
     fConsole: TConsole;   // Object used to write to console
     fSignedOn: Boolean;   // Flag shows if sign on message has been displayed
+    fWarnings: TArray<string>;  // Command line parser warnings
     procedure Configure;
     procedure SignOn;
     procedure ShowHelp;
+    procedure ShowWarnings;
     function GetInputSourceCode: string;
     procedure WriteOutput(const S: string);
   public
@@ -69,6 +71,8 @@ procedure TMain.Configure;
   Params := TParams.Create(fConfig);
   try
     Params.Parse; // parse command line, updating configuration object
+    if Params.HasWarnings then
+      fWarnings := Params.Warnings;
   finally
     FreeAndNil(Params);
   end;
@@ -107,6 +111,8 @@ procedure TMain.Execute;
     begin
       // Sign on and initialise program
       SignOn;
+      if Length(fWarnings) > 0 then
+        ShowWarnings;
       SourceCode := GetInputSourceCode;
       Renderer := TRendererFactory.CreateRenderer(SourceCode, fConfig);
       XHTML := Renderer.Render;
@@ -165,6 +171,16 @@ procedure TMain.ShowHelp;
   end;
 end;
 
+procedure TMain.ShowWarnings;
+var
+  W: string;
+resourcestring
+  sWarning = 'WARNING: %s';
+begin
+  for W in fWarnings do
+    fConsole.WriteLn(Format(sWarning, [W]));
+end;
+
 procedure TMain.SignOn;
 resourcestring
   // Sign on message format string

Diff for: Src/UParams.pas

@@ -101,6 +101,7 @@   TParams = class(TObject)
     var
       fParamQueue: TQueue<string>; // Queue of parameters to be processed
       fCmdLookup: TDictionary<string, TCommandId>;
+      fV1CommandLookup: TList<string>;
       fSwitchCmdLookup: TList<string>;
       fConfigBlacklist: TList<TCommandId>;
       fEncodingLookup: TDictionary<string, TOutputEncodingId>;
@@ -110,6 +111,7 @@   TParams = class(TObject)
       fPaddingLookup: TDictionary<string, Char>;
       fViewportLookup: TDictionary<string, TViewport>;
       fConfig: TConfig; // Reference to program's configuration object
+      fWarnings: TList<string>;
     procedure GetConfigParams;
     procedure GetCmdLineParams;
     procedure ParseCommand(const IsConfigCmd: Boolean);
@@ -123,10 +125,15 @@   TParams = class(TObject)
       UInt16;
     function GetPaddingParameter(const Cmd: TCommand): Char;
     function GetViewportParameter(const Cmd: TCommand): TViewport;
+    function GetWarnings: TArray<string>;
+    function AdjustCommandName(const Name: string; IsCfgCmd: Boolean): string;
+    function IsV1Command(const Name: string): Boolean;
   public
     constructor Create(const Config: TConfig);
     destructor Destroy; override;
     procedure Parse;
+    property Warnings: TArray<string> read GetWarnings;
+    function HasWarnings: Boolean;
   end;
 
   ///  <summary>Type of exception raised for a command related error.</summary>
@@ -166,6 +173,20 @@ implementation
 
 { TParams }
 
+function TParams.AdjustCommandName(const Name: string;
+  IsCfgCmd: Boolean): string;
+begin
+  if IsCfgCmd then
+  begin
+    if StartsStr('--', Name) then
+      Result := RightStr(Name, Length(Name) - 2)
+    else
+      Result := Name;
+  end
+  else
+    Result := Name;
+end;
+
 constructor TParams.Create(const Config: TConfig);
 begin
   Assert(Assigned(Config), 'TParams.Create: Config is nil');
@@ -231,6 +252,16 @@ constructor TParams.Create(const Config: TConfig);
     Add('-rc', siInputClipboard);
     Add('-wc', siOutputClipboard);
   end;
+  fV1CommandLookup := TList<string>.Create(
+    TTextComparer.Create
+  );
+  with fV1CommandLookup do
+  begin
+    Add('-wc');
+    Add('-rc');
+    Add('-hidecss');
+    Add('-frag');
+  end;
   // list of short form commands that are switches
   fSwitchCmdLookup := TList<string>.Create;
   with fSwitchCmdLookup do
@@ -322,17 +353,20 @@ constructor TParams.Create(const Config: TConfig);
     Add('phone', vpPhone);
     Add('tablet', vpPhone);
   end;
+  fWarnings := TList<string>.Create(TTextComparer.Create);
 end;
 
 destructor TParams.Destroy;
 begin
+  fWarnings.Free;
   fViewportLookup.Free;
   fPaddingLookup.Free;
   fVerbosityLookup.Free;
   fBooleanLookup.Free;
   fDocTypeLookup.Free;
   fEncodingLookup.Free;
   fSwitchCmdLookup.Free;
+  fV1CommandLookup.Free;
   fCmdLookup.Free;
   fParamQueue.Free;
   inherited;
@@ -467,37 +501,47 @@ function TParams.GetViewportParameter(const Cmd: TCommand): TViewport;
   Result := fViewportLookup[Param];
 end;
 
-procedure TParams.Parse;
+function TParams.GetWarnings: TArray<string>;
+var
+  Idx: Integer;
+begin
+  SetLength(Result, fWarnings.Count);
+  for Idx := 0 to Pred(fWarnings.Count) do
+    Result[Idx] := fWarnings[Idx];
+end;
 
-  procedure ParseQueue(const IsConfigCmd: Boolean; const ErrorFmtStr: string);
+function TParams.HasWarnings: Boolean;
+begin
+  Result := fWarnings.Count > 0;
+end;
 
-    function AdjustCommandName(const Name: string): string;
-    begin
-      WriteLn('DBG: ', Name);
-      if IsConfigCmd then
-      begin
-        if StartsStr('--', Name) then
-          Result := RightStr(Name, Length(Name) - 2)
-        else
-          Result := Name;
-      end
-      else
-        Result := Name;
-    end;
+function TParams.IsV1Command(const Name: string): Boolean;
+begin
+  Result := fV1CommandLookup.Contains(Name);
+end;
+
+procedure TParams.Parse;
 
+  procedure ParseQueue(const IsConfigCmd: Boolean; const ErrorFmtStr: string);
+  var
+    CmdName: string;
   begin
     try
       while fParamQueue.Count > 0 do
       begin
         if AnsiStartsStr('-', fParamQueue.Peek) then
-          ParseCommand(IsConfigCmd)
+        begin
+          CmdName := fParamQueue.Peek;
+          ParseCommand(IsConfigCmd);
+        end
         else
           ParseFileName;
       end;
     except
       on E: ECommandError do
         raise Exception.CreateFmt(
-          ErrorFmtStr, [Format(E.FormatStr, [AdjustCommandName(E.CommandName)])]
+          ErrorFmtStr,
+          [Format(E.FormatStr, [AdjustCommandName(E.CommandName, IsConfigCmd)])]
         );
       on E: Exception do
         raise Exception.CreateFmt(ErrorFmtStr, [E.Message]);
@@ -522,6 +566,9 @@ procedure TParams.ParseCommand(const IsConfigCmd: Boolean);
   sMustBeSwitch = '%s must be a switch command: append "+" or "-"';
   sBlacklisted = 'The "%s" command is not permitted in the config file.'#13#10
     + 'Please edit the file';
+  // Warnings
+  sDeprecatedCmd = '*** The "%s" command is deprecated';
+  sDepDocType = 'The "html4" parameter to the "%s" command deprecated';
 var
   Command: TCommand;
   CommandId: TCommandId;
@@ -541,11 +588,19 @@ procedure TParams.ParseCommand(const IsConfigCmd: Boolean);
 
   case CommandId of
     siInputClipboard:
+    begin
+      if IsV1Command(Command.Name) then
+        fWarnings.Add(Format(sDeprecatedCmd, [Command.Name]));
       fConfig.InputSource := isClipboard;
+    end;
     siInputStdIn:
       fConfig.InputSource := isStdIn;
     siOutputClipboard:
+    begin
+      if IsV1Command(Command.Name) then
+        fWarnings.Add(Format(sDeprecatedCmd, [Command.Name]));
       fConfig.OutputSink := osClipboard;
+    end;
     siOutputFile:
     begin
       fConfig.OutputFile := GetStringParameter(Command);
@@ -562,14 +617,30 @@ procedure TParams.ParseCommand(const IsConfigCmd: Boolean);
     siOutputDocType:
     begin
       fConfig.DocType := GetDocTypeParameter(Command);
+      if fConfig.DocType = dtHTML4 then
+        fWarnings.Add(
+          Format(sDepDocType, [AdjustCommandName(Command.Name, IsConfigCmd)])
+        );
       fParamQueue.Dequeue;
     end;
     siFragment:
+    begin
+      if IsV1Command(Command.Name) then
+        fWarnings.Add(Format(sDeprecatedCmd, [Command.Name]));
       fConfig.DocType := dtFragment;
+    end;
     siForceHideCSS:
+    begin
+      fWarnings.Add(
+        Format(sDeprecatedCmd, [AdjustCommandName(Command.Name, IsConfigCmd)])
+      );
       fConfig.HideCSS := True;
+    end;
     siHideCSS:
     begin
+      fWarnings.Add(
+        Format(sDeprecatedCmd, [AdjustCommandName(Command.Name, IsConfigCmd)])
+      );
       if Command.IsSwitch then
         fConfig.HideCSS := Command.SwitchValue
       else
@@ -597,6 +668,9 @@ procedure TParams.ParseCommand(const IsConfigCmd: Boolean);
     end;
     siLegacyCSS:
     begin
+      fWarnings.Add(
+        Format(sDeprecatedCmd, [AdjustCommandName(Command.Name, IsConfigCmd)])
+      );
       fConfig.LegacyCSSNames := GetBooleanParameter(Command);
       fParamQueue.Dequeue;
     end;