Browse Source

* Add const to string params where possible. Fix issue #40053

Michael Van Canneyt 2 years ago
parent
commit
817ec09ec0

+ 56 - 56
packages/fcl-fpcunit/src/DUnitCompatibleInterface.inc

@@ -19,31 +19,31 @@
 {$IFDEF read_interface}
 
     class procedure Check(pValue: boolean; pMessage: string = '');
-    class procedure CheckEquals(expected, actual: extended; msg: string = ''); overload;
-    class procedure CheckEquals(expected, actual: extended; delta: extended; msg: string = ''); overload;
-    class procedure CheckEquals(expected, actual: string; msg: string = ''); overload;
-    class procedure CheckEquals(expected, actual: unicodestring; msg: string = ''); overload;
-    class procedure CheckEquals(expected, actual: integer; msg: string = ''); overload;
-    class procedure CheckEquals(expected, actual: boolean; msg: string = ''); overload;
-    class procedure CheckEquals(expected, actual: TClass; msg: string = ''); overload;
-    class procedure CheckEquals(expected, actual: int64; msg: string = ''); overload;
-    class procedure CheckEquals(expected, actual: QWord; msg: string = ''); overload;
-    class procedure CheckNotEquals(expected, actual: string; msg: string = ''); overload;
-    class procedure CheckNotEquals(expected, actual: unicodestring; msg: string = ''); overload;
-    class procedure CheckNotEquals(expected, actual: integer; msg: string = ''); overload; virtual;
-    class procedure CheckNotEquals(expected, actual: boolean; msg: string = ''); overload; virtual;
-    class procedure CheckNotEquals(expected: extended; actual: extended; delta: extended = 0; msg: string = ''); overload; virtual;
-    class procedure CheckNotEquals(expected, actual: int64; msg: string = ''); overload; virtual;
-    class procedure CheckNotEquals(expected, actual: QWord; msg: string = ''); overload; virtual;
-    class procedure CheckNull(obj: IUnknown; msg: string = ''); overload;
-    class procedure CheckNull(obj: TObject; msg: string = ''); overload;
-    class procedure CheckNotNull(obj: TObject; msg: string = ''); overload;
-    class procedure CheckNotNull(obj: IUnknown; msg: string = ''); overload; virtual;
-    class procedure CheckIs(obj :TObject; pClass: TClass; msg: string = ''); overload;
-    class procedure CheckSame(expected, actual: TObject; msg: string = ''); overload;
-    class procedure CheckTrue(condition: Boolean; msg: string = '');
-    class procedure CheckFalse(condition: Boolean; msg: string = '');
-    class procedure CheckException(AMethod: TRunMethod; AExceptionClass: ExceptClass; msg: string = '');
+    class procedure CheckEquals(expected, actual: extended; const msg: string = ''); overload;
+    class procedure CheckEquals(expected, actual: extended; delta: extended; const msg: string = ''); overload;
+    class procedure CheckEquals(expected, actual: string; const msg: string = ''); overload;
+    class procedure CheckEquals(expected, actual: unicodestring; const msg: string = ''); overload;
+    class procedure CheckEquals(expected, actual: integer; const msg: string = ''); overload;
+    class procedure CheckEquals(expected, actual: boolean; const msg: string = ''); overload;
+    class procedure CheckEquals(expected, actual: TClass; const msg: string = ''); overload;
+    class procedure CheckEquals(expected, actual: int64; const msg: string = ''); overload;
+    class procedure CheckEquals(expected, actual: QWord; const msg: string = ''); overload;
+    class procedure CheckNotEquals(expected, actual: string; const msg: string = ''); overload;
+    class procedure CheckNotEquals(expected, actual: unicodestring; const msg: string = ''); overload;
+    class procedure CheckNotEquals(expected, actual: integer; const msg: string = ''); overload; virtual;
+    class procedure CheckNotEquals(expected, actual: boolean; const msg: string = ''); overload; virtual;
+    class procedure CheckNotEquals(expected: extended; actual: extended; delta: extended = 0; const msg: string = ''); overload; virtual;
+    class procedure CheckNotEquals(expected, actual: int64; const msg: string = ''); overload; virtual;
+    class procedure CheckNotEquals(expected, actual: QWord; const msg: string = ''); overload; virtual;
+    class procedure CheckNull(obj: IUnknown; const msg: string = ''); overload;
+    class procedure CheckNull(obj: TObject; const msg: string = ''); overload;
+    class procedure CheckNotNull(obj: TObject; const msg: string = ''); overload;
+    class procedure CheckNotNull(obj: IUnknown; const msg: string = ''); overload; virtual;
+    class procedure CheckIs(obj :TObject; pClass: TClass; const msg: string = ''); overload;
+    class procedure CheckSame(expected, actual: TObject; const msg: string = ''); overload;
+    class procedure CheckTrue(condition: Boolean; const msg: string = '');
+    class procedure CheckFalse(condition: Boolean; const msg: string = '');
+    class procedure CheckException(AMethod: TRunMethod; AExceptionClass: ExceptClass; const msg: string = '');
     class function  EqualsErrorMessage(const expected, actual: string; const ErrorMsg: string): string;
     class function  NotEqualsErrorMessage(const expected, actual: string; const ErrorMsg: string): string;
 
@@ -52,14 +52,14 @@
 
     {
     *** TODO  ***
-    procedure CheckEqualsBin(expected, actual: longword; msg: string = ''; digits: integer=32); virtual;
-    procedure CheckEqualsHex(expected, actual: longword; msg: string = ''; digits: integer=8); virtual;
-    procedure CheckNotEqualsBin(expected, actual: longword; msg: string = ''; digits: integer=32); virtual;
-    procedure CheckNotEqualsHex(expected, actual: longword; msg: string = ''; digits: integer=8); virtual;
+    procedure CheckEqualsBin(expected, actual: longword; const msg: string = ''; digits: integer=32); virtual;
+    procedure CheckEqualsHex(expected, actual: longword; const msg: string = ''; digits: integer=8); virtual;
+    procedure CheckNotEqualsBin(expected, actual: longword; const msg: string = ''; digits: integer=32); virtual;
+    procedure CheckNotEqualsHex(expected, actual: longword; const msg: string = ''; digits: integer=8); virtual;
     procedure CheckNotNull(obj :IUnknown; msg :string = ''); overload; virtual;
-    procedure CheckSame(expected, actual: IUnknown; msg: string = ''); overload; virtual;
+    procedure CheckSame(expected, actual: IUnknown; const msg: string = ''); overload; virtual;
     procedure CheckException(AMethod: TTestMethod; AExceptionClass: TClass; msg :string = '');
-    procedure CheckInherits(expected, actual: TClass; msg: string = ''); overload; virtual;
+    procedure CheckInherits(expected, actual: TClass; const msg: string = ''); overload; virtual;
     }
 
 {$ENDIF read_interface}
@@ -72,54 +72,54 @@ begin
   AssertTrue(pMessage, pValue);
 end;
 
-class procedure TAssert.CheckEquals(expected, actual: extended; msg: string);
+class procedure TAssert.CheckEquals(expected, actual: extended; const msg: string);
 begin
   CheckEquals(expected, actual, 0, msg);
 end;
 
 class procedure TAssert.CheckEquals(expected, actual: extended;
-  delta: extended; msg: string);
+  delta: extended; const msg: string);
 begin
   AssertEquals(msg, expected, actual, delta);
 end;
 
-class procedure TAssert.CheckEquals(expected, actual: string; msg: string);
+class procedure TAssert.CheckEquals(expected, actual: string; const msg: string);
 begin
   AssertEquals(msg, expected, actual);
 end;
-class procedure TAssert.CheckEquals(expected, actual: unicodestring; msg: string);
+class procedure TAssert.CheckEquals(expected, actual: unicodestring; const msg: string);
 begin
   AssertEquals(msg, expected, actual);
 end;
 
-class procedure TAssert.CheckEquals(expected, actual: integer; msg: string);
+class procedure TAssert.CheckEquals(expected, actual: integer; const msg: string);
 begin
   AssertEquals(msg, expected, actual);
 end;
 
-class procedure TAssert.CheckEquals(expected, actual: boolean; msg: string);
+class procedure TAssert.CheckEquals(expected, actual: boolean; const msg: string);
 begin
   AssertEquals(msg, expected, actual);
 end;
 
-class procedure TAssert.CheckEquals(expected, actual: TClass; msg: string);
+class procedure TAssert.CheckEquals(expected, actual: TClass; const msg: string);
 begin
   AssertEquals(msg, expected, actual);
 end;
 
 class procedure TAssert.CheckEquals(expected, actual: QWord;
-  msg: string);
+  const msg: string);
 begin
   AssertEquals(msg, expected, actual);
 end;
 
 class procedure TAssert.CheckEquals(expected, actual: int64;
-  msg: string);
+  const msg: string);
 begin
   AssertEquals(msg, expected, actual);
 end;
 
-class procedure TAssert.CheckNotEquals(expected, actual: string; msg: string);
+class procedure TAssert.CheckNotEquals(expected, actual: string; const msg: string);
 begin
   if AnsiCompareStr(Expected, Actual) = 0 then
     Fail(ComparisonMsg(msg, Expected, Actual, false))
@@ -127,7 +127,7 @@ begin
     Inc(AssertCount);
 end;
 
-class procedure TAssert.CheckNotEquals(expected, actual: unicodestring; msg: string);
+class procedure TAssert.CheckNotEquals(expected, actual: unicodestring; const msg: string);
 begin
   if (Expected=Actual) then
     Fail(ComparisonMsg(msg, Expected, Actual, false))
@@ -135,7 +135,7 @@ begin
     Inc(AssertCount);
 end;
 
-class procedure TAssert.CheckNotEquals(expected, actual: integer; msg: string);
+class procedure TAssert.CheckNotEquals(expected, actual: integer; const msg: string);
 begin
   if (expected = actual) then
     Fail(ComparisonMsg(msg, IntToStr(expected), IntToStr(actual), false))
@@ -143,7 +143,7 @@ begin
     Inc(AssertCount);
 end;
 
-class procedure TAssert.CheckNotEquals(expected, actual: boolean; msg: string);
+class procedure TAssert.CheckNotEquals(expected, actual: boolean; const msg: string);
 begin
   if (expected = actual) then
     Fail(ComparisonMsg(msg, BoolToStr(expected), BoolToStr(actual), false))
@@ -152,7 +152,7 @@ begin
 end;
 
 class procedure TAssert.CheckNotEquals(expected: extended; actual: extended;
-  delta: extended; msg: string);
+  delta: extended; const msg: string);
 begin
   if (abs(expected-actual) <= delta) then
     FailNotEquals(FloatToStr(expected), FloatToStr(actual), msg, nil)
@@ -161,7 +161,7 @@ begin
 end;
 
 class procedure TAssert.CheckNotEquals(expected, actual: QWord;
-  msg: string);
+  const msg: string);
 begin
   if (expected = actual) then
     Fail(ComparisonMsg(msg, IntToStr(expected), IntToStr(actual), false))
@@ -170,7 +170,7 @@ begin
 end;
 
 class procedure TAssert.CheckNotEquals(expected, actual: int64;
-  msg: string);
+  const msg: string);
 begin
   if (expected = actual) then
     Fail(ComparisonMsg(msg, IntToStr(expected), IntToStr(actual), false))
@@ -178,27 +178,27 @@ begin
     Inc(AssertCount);
 end;
 
-class procedure TAssert.CheckNull(obj: IUnknown; msg: string);
+class procedure TAssert.CheckNull(obj: IUnknown; const msg: string);
 begin
   AssertNullIntf(msg, obj);
 end;
 
-class procedure TAssert.CheckNull(obj: TObject; msg: string);
+class procedure TAssert.CheckNull(obj: TObject; const msg: string);
 begin
   AssertNull(msg, obj);
 end;
 
-class procedure TAssert.CheckNotNull(obj: TObject; msg: string);
+class procedure TAssert.CheckNotNull(obj: TObject; const msg: string);
 begin
   AssertNotNull(msg, obj);
 end;
 
-class procedure TAssert.CheckNotNull(obj: IUnknown; msg: string);
+class procedure TAssert.CheckNotNull(obj: IUnknown; const msg: string);
 begin
   AssertNotNullIntf(msg, obj);
 end;
 
-class procedure TAssert.CheckIs(obj: TObject; pClass: TClass; msg: string);
+class procedure TAssert.CheckIs(obj: TObject; pClass: TClass; const msg: string);
 begin
   Assert(pClass <> nil);
   if obj = nil then
@@ -209,12 +209,12 @@ begin
     Inc(AssertCount);
 end;
 
-class procedure TAssert.CheckSame(expected, actual: TObject; msg: string);
+class procedure TAssert.CheckSame(expected, actual: TObject; const msg: string);
 begin
    AssertSame(msg, expected, actual);
 end;
 
-class procedure TAssert.CheckTrue(condition: Boolean; msg: string);
+class procedure TAssert.CheckTrue(condition: Boolean; const msg: string);
 begin
   if (not condition) then
     FailNotEquals(BoolToStr(true, true), BoolToStr(false, true), msg, nil)
@@ -222,7 +222,7 @@ begin
     Inc(AssertCount);
 end;
 
-class procedure TAssert.CheckFalse(condition: Boolean; msg: string);
+class procedure TAssert.CheckFalse(condition: Boolean; const msg: string);
 begin
   if (condition) then
     FailNotEquals(BoolToStr(false, true), BoolToStr(true, true), msg, nil)
@@ -231,7 +231,7 @@ begin
 end;
 
 
-class procedure TAssert.CheckException(AMethod: TRunMethod; AExceptionClass: ExceptClass; msg: string = '');
+class procedure TAssert.CheckException(AMethod: TRunMethod; AExceptionClass: ExceptClass; const msg: string = '');
 begin
   AssertException(msg, AExceptionClass, AMethod);
 end;

+ 2 - 2
packages/fcl-fpcunit/src/consoletestrunner.pas

@@ -55,7 +55,7 @@ type
     FSuite: String;
     FRunMode : TRunMode;
   protected
-    Class function StrToFormat(S: String): TFormat;
+    Class function StrToFormat(const S: String): TFormat;
     function DefaultsFileName: String;
     procedure RunSuite; virtual;
     procedure ShowTestList; virtual;
@@ -229,7 +229,7 @@ begin
   inherited Destroy;
 end;
 
-class function TTestRunner.StrToFormat(S: String): TFormat;
+class function TTestRunner.StrToFormat(const S: String): TFormat;
 
 begin
   Case lowercase(S) of

+ 2 - 2
packages/fcl-fpcunit/src/exampletests/fpcunittests.pp

@@ -112,7 +112,7 @@ type
     procedure EndTest(ATest: TTest);
     procedure StartTestSuite(ATestSuite: TTestSuite);
     procedure EndTestSuite(ATestSuite: TTestSuite);
-    procedure AddExpectedLine(ALine: string);
+    procedure AddExpectedLine(const ALine: string);
     procedure Verify(ActualList: TStrings);
   end;
 
@@ -622,7 +622,7 @@ procedure TMockListener.EndTestSuite(ATestSuite: TTestSuite);
 begin
 end;
 
-procedure TMockListener.AddExpectedLine(ALine: string);
+procedure TMockListener.AddExpectedLine(const ALine: string);
 begin
   FExpectedList.Add(ALine)
 end;

+ 4 - 4
packages/fcl-fpcunit/src/exampletests/money.pp

@@ -43,7 +43,7 @@ type
     function GetAmount: int64;
     function GetCurrencyUnit: string;
   public
-    constructor Create(aAmount: int64; aCurrencyUnit: String);
+    constructor Create(aAmount: int64; const aCurrencyUnit: String);
     function add(m: IMoney): IMoney;
     function addMoney(m: TMoney): IMoney;
     function addMoneyBag(mb: TMoneyBag): IMoney;
@@ -63,7 +63,7 @@ type
   TMoneyBag = class(TInterfacedObject, IMoney)
   private
     FMonies: TInterfaceList;
-    function FindMoney(aCurrencyUnit: string): Integer;
+    function FindMoney(const aCurrencyUnit: string): Integer;
     function Contains(m: ISingleCurrencyMoney): boolean;
   public
     constructor Create;
@@ -108,7 +108,7 @@ begin
 end;
 
 
-function TMoneyBag.FindMoney(aCurrencyUnit: string): Integer;
+function TMoneyBag.FindMoney(const aCurrencyUnit: string): Integer;
 var
   i: Integer;
 begin
@@ -318,7 +318,7 @@ begin
   Result := FAmount;
 end;
 
-constructor TMoney.Create(aAmount: int64; aCurrencyUnit: string);
+constructor TMoney.Create(aAmount: int64; const aCurrencyUnit: string);
 begin
   FAmount := aAmount;
   FCurrencyUnit := aCurrencyUnit;

+ 12 - 12
packages/fcl-fpcunit/src/fpcunit.pp

@@ -140,8 +140,8 @@ type
     class procedure AssertNull(APointer: Pointer); overload;
     class procedure AssertNotNull(const AMessage, AString: string); overload;
     class procedure AssertNotNull(const AString: string); overload;
-    class procedure AssertException(const AMessage: string; AExceptionClass: ExceptClass; AMethod: TRunMethod;AExceptionMessage : String = ''; AExceptionContext : Integer = 0; AErrorAddr : Pointer = Nil); overload;
-    class procedure AssertException(AExceptionClass: ExceptClass; AMethod: TRunMethod;AExceptionMessage : String = ''; AExceptionContext : Integer = 0); overload;
+    class procedure AssertException(const AMessage: string; AExceptionClass: ExceptClass; AMethod: TRunMethod; const AExceptionMessage : String = ''; AExceptionContext : Integer = 0; AErrorAddr : Pointer = Nil); overload;
+    class procedure AssertException(AExceptionClass: ExceptClass; AMethod: TRunMethod;const AExceptionMessage : String = ''; AExceptionContext : Integer = 0); overload;
 
     {$IFDEF DUnit}
       {$I DUnitCompatibleInterface.inc}
@@ -223,8 +223,8 @@ type
     constructor Create; virtual;
     constructor CreateWith(const ATestName: string; const ATestSuiteName: string); virtual;
     constructor CreateWithName(const AName: string); virtual;
-    procedure ExpectException(AExceptionClass: TClass; AExceptionMessage: string=''; AExceptionHelpContext: Integer=0);
-    procedure ExpectException(const Msg: String; AExceptionClass: TClass; AExceptionMessage: string=''; AExceptionHelpContext: Integer=0);
+    procedure ExpectException(AExceptionClass: TClass; const AExceptionMessage: string=''; AExceptionHelpContext: Integer=0);
+    procedure ExpectException(const Msg: String; AExceptionClass: TClass; const AExceptionMessage: string=''; AExceptionHelpContext: Integer=0);
     function CountTestCases: integer; override;
     function CreateResultAndRun: TTestResult; virtual;
     procedure Run(AResult: TTestResult); override;
@@ -261,10 +261,10 @@ type
     procedure SetEnableIgnores(Value: boolean); override;
     property OwnsTests : Boolean Read FOwnsTests Write SetOwnsTests;
   public
-    constructor Create(AClass: TClass; AName: string); reintroduce; overload; virtual;
+    constructor Create(AClass: TClass; const AName: string); reintroduce; overload; virtual;
     constructor Create(AClass: TClass); reintroduce; overload; virtual;
     constructor Create(AClassArray: Array of TClass); reintroduce; overload; virtual;
-    constructor Create(AName: string); reintroduce; overload; virtual;
+    constructor Create(const AName: string); reintroduce; overload; virtual;
     constructor Create; reintroduce; overload; virtual;
     destructor Destroy; override;
     function CountTestCases: integer; override;
@@ -938,7 +938,7 @@ end;
 
 
 class procedure TAssert.AssertException(const AMessage: string; AExceptionClass: ExceptClass;
-  AMethod: TRunMethod;AExceptionMessage : String = ''; AExceptionContext : Integer = 0; AErrorAddr : Pointer = Nil);
+  AMethod: TRunMethod;const AExceptionMessage : String = ''; AExceptionContext : Integer = 0; AErrorAddr : Pointer = Nil);
 
   Function MisMatch (AClassName : String) : String;
 
@@ -973,7 +973,7 @@ end;
 
 
 class procedure TAssert.AssertException(AExceptionClass: ExceptClass;
-  AMethod: TRunMethod;AExceptionMessage : String = ''; AExceptionContext : Integer = 0);
+  AMethod: TRunMethod;const AExceptionMessage : String = ''; AExceptionContext : Integer = 0);
 begin
   AssertException('', AExceptionClass, AMethod, AExceptionMessage, AExceptionContext, CallerAddr);
 end;
@@ -1192,7 +1192,7 @@ begin
   inherited Destroy;
 end;
 
-constructor TTestSuite.Create(AClass: TClass; AName: string);
+constructor TTestSuite.Create(AClass: TClass; const AName: string);
 begin
   Create(AClass);
   FName := AName;
@@ -1252,7 +1252,7 @@ begin
 end;
 
 
-constructor TTestSuite.Create(AName: string);
+constructor TTestSuite.Create(const AName: string);
 begin
   Create();
   FName := AName;
@@ -1372,7 +1372,7 @@ begin
 end;
 
 procedure TTestCase.ExpectException(const Msg: String;
-  AExceptionClass: TClass; AExceptionMessage: string = '';
+  AExceptionClass: TClass; const AExceptionMessage: string = '';
   AExceptionHelpContext: Integer =0 );
 begin
   FExpectedExceptionFailMessage:=Msg;
@@ -1383,7 +1383,7 @@ begin
 end;
 
 procedure TTestCase.ExpectException(AExceptionClass: TClass;
-  AExceptionMessage: string = ''; AExceptionHelpContext: Integer = 0);
+  const AExceptionMessage: string = ''; AExceptionHelpContext: Integer = 0);
 begin
   FExpectedExceptionFailMessage:='';
   FExpectedException:=AExceptionClass;

+ 8 - 8
packages/fcl-fpcunit/src/testregistry.pp

@@ -28,11 +28,11 @@ type
 
 
 procedure RegisterTest(ATestClass: TTestCaseClass); overload;
-procedure RegisterTest(ASuitePath: String; ATestClass: TTestCaseClass); overload;
-procedure RegisterTest(ASuitePath: String; ATest: TTest); overload;
+procedure RegisterTest(const ASuitePath: String; ATestClass: TTestCaseClass); overload;
+procedure RegisterTest(const ASuitePath: String; ATest: TTest); overload;
 
 procedure RegisterTests(ATests: Array of TTestCaseClass);
-procedure RegisterTests(ASuitePath: String; ATests: Array of TTestCaseClass);
+procedure RegisterTests(const ASuitePath: String; ATests: Array of TTestCaseClass);
 
 procedure RegisterTestDecorator(ADecoratorClass: TTestDecoratorClass; ATestClass: TTestCaseClass);
 
@@ -55,7 +55,7 @@ begin
   Result := FTestRegistry;
 end;
 
-procedure RegisterTestInSuite(ARootSuite: TTestSuite; APath: string; ATest: TTest);
+procedure RegisterTestInSuite(ARootSuite: TTestSuite; const APath: string; ATest: TTest);
 var
   i: Integer;
   lTargetSuite: TTestSuite;
@@ -106,7 +106,7 @@ begin
     end;
 
     RegisterTestInSuite(lTargetSuite, lPathRemainder, ATest);
-  end;  { if/else }
+  end;  { if  else }
 end;
 
 procedure RegisterTest(ATestClass: TTestCaseClass);
@@ -114,12 +114,12 @@ begin
   GetTestRegistry.AddTestSuiteFromClass(ATestClass);
 end;
 
-procedure RegisterTest(ASuitePath: String; ATestClass: TTestCaseClass);
+procedure RegisterTest(const ASuitePath: String; ATestClass: TTestCaseClass);
 begin
   RegisterTestInSuite(GetTestRegistry, ASuitePath, TTestSuite.Create(ATestClass));
 end;
 
-procedure RegisterTest(ASuitePath: String; ATest: TTest);
+procedure RegisterTest(const ASuitePath: String; ATest: TTest);
 begin
   RegisterTestInSuite(GetTestRegistry, ASuitePath, ATest);
 end;
@@ -140,7 +140,7 @@ begin
     end;
 end;
 
-procedure RegisterTests(ASuitePath: String; ATests: Array of TTestCaseClass);
+procedure RegisterTests(const ASuitePath: String; ATests: Array of TTestCaseClass);
 var
   i: integer;
 begin