Add internal error messages.

maxitg · Jul 11, 2021 · 6de5e12 · 6de5e12
1 parent 1e10610
commit 6de5e12
Show file tree

Hide file tree

Showing 2 changed files with 117 additions and 6 deletions.
diff --git a/Kernel/A1$generatorSystem.m b/Kernel/A1$generatorSystem.m
@@ -9,7 +9,6 @@
 PackageScope["declareSystem"]
 PackageScope["declareSystemGenerator"]
 PackageScope["declareSystemParameter"]
-PackageScope["autoList"]
 PackageScope["initializeSystemGenerators"]
 
 (* System declaration *)
@@ -55,14 +54,14 @@
 
 declareMessage[General::unsatisfiableParameterDependencies,
                "Internal error. Parameter constraints `constraints` for `system` are not satisfyable."];
-declareMultihistoryGenerator[systemType_, _, _, _List, dependencies_] :=
+declareSystem[systemType_, _, _, _List, dependencies_] :=
   message[SetReplace,
           Failure["unsatisfiableParameterDependencies", <|"constraints" -> dependencies, "system" -> systemType|>]];
 
-declareMessage[General::invalidGeneratorDeclaration,
-               "Internal error. Multihistory generator is declared incorrectly with arguments `args`."];
-declareMultihistoryGenerator[args___] :=
-  message[SetReplace, Failure["invalidGeneratorDeclaration", <|"args" -> {args}|>]];
+declareMessage[General::invalidSystemDeclaration,
+               "Internal error. System is declared incorrectly with arguments `args`."];
+declareSystem[args___] :=
+  message[SetReplace, Failure["invalidSystemDeclaration", <|"args" -> {args}|>]];
 
 (* Generator declaration *)
 
@@ -106,6 +105,11 @@
     "\n"];
 );
 
+declareMessage[General::invalidSystemGeneratorDeclaration,
+               "Internal error. Generator is declared incorrectly with arguments `args`."];
+declareSystemGenerator[args___] :=
+  message[SetReplace, Failure["invalidSystemGeneratorDeclaration", <|"args" -> {args}|>]];
+
 (* Parameter declaration *)
 
 $parameterDefaults = <||>;
@@ -127,6 +131,11 @@
   SetUsage @ Evaluate[ToString[name] <> " " <> usage];
 );
 
+declareMessage[General::invalidSystemParameterDeclaration,
+               "Internal error. Parameter is declared incorrectly with arguments `args`."];
+declareSystemParameter[args___] :=
+  message[SetReplace, Failure["invalidSystemParameterDeclaration", <|"args" -> {args}|>]];
+
 (* Initialization *)
 
 (* It would be best to only show autocompletions for specific-system keys, but it does not seem to be possible because

diff --git a/Tests/generatorSystem.wlt b/Tests/generatorSystem.wlt
@@ -0,0 +1,102 @@
+<|
+  "generatorSystem" -> <|
+    "init" -> (
+      Attributes[Global`testUnevaluated] = Attributes[Global`testSymbolLeak] = {HoldAll};
+      Global`testUnevaluated[args___] := SetReplace`PackageScope`testUnevaluated[VerificationTest, args];
+      Global`testSymbolLeak[args___] := SetReplace`PackageScope`testSymbolLeak[VerificationTest, args];
+      Global`declareSystem = SetReplace`PackageScope`declareSystem;
+      Global`declareSystemGenerator = SetReplace`PackageScope`declareSystemGenerator;
+      Global`declareSystemParameter = SetReplace`PackageScope`declareSystemParameter;
+      Global`initializeSystemGenerators = SetReplace`PackageScope`initializeSystemGenerators;
+
+      (* Echo system *)
+
+      declareSystem[echoSystem, List, _, {}, True];
+
+      (* UnknownObject *)
+
+      declareSystemGenerator[identityGenerator, internalIdentityGenerator, <||>, Identity, "does nothing."];
+
+      Unprotect[$SetReplaceSystems];
+      Unprotect[$SetReplaceGenerators];
+      initializeSystemGenerators[];
+      Protect[$SetReplaceGenerators];
+      Protect[$SetReplaceSystems];
+    ),
+    "tests" -> {
+      (* Type and property lists *)
+      (* unknownObject is not here because there are no translations or properties defined for it, so it's invisible to
+         the type system. *)
+      VerificationTest[
+        $SetReplaceTypes, Sort @ Join[originalTypes, {"String", "Expression", "HalfInteger", "EvenInteger", "Real"}]],
+      VerificationTest[$SetReplaceProperties, Sort @ Join[originalProperties, {description, multipliedHalf}]],
+
+      VerificationTest[GraphQ @ $SetReplaceTypeGraph],
+      VerificationTest[ContainsOnly[Head /@ VertexList[$SetReplaceTypeGraph],
+                       {SetReplaceType, SetReplaceProperty, SetReplaceMethodImplementation}]],
+      VerificationTest[
+        Cases[
+          EdgeList[$SetReplaceTypeGraph],
+          Except[
+            DirectedEdge[_SetReplaceType | _SetReplaceProperty, _SetReplaceMethodImplementation] |
+              DirectedEdge[_SetReplaceMethodImplementation, _SetReplaceType | _SetReplaceProperty]]],
+        {}],
+
+      (* Type querying *)
+      VerificationTest[SetReplaceObjectType[evenInteger[4]], "EvenInteger"],
+      VerificationTest[SetReplaceObjectType[2.4], "Real"],
+      VerificationTest[SetReplaceObjectType[unknownObject[4]], "Unknown"],
+      testUnevaluated[SetReplaceObjectType[unseenObject[4]], SetReplaceObjectType::unknownObject],
+
+      VerificationTest[SetReplaceObjectQ[evenInteger[4]]],
+      VerificationTest[SetReplaceObjectQ[2.4]],
+      (* unknownObject an object because it returns a type even though it's not in $SetReplaceTypes. *)
+      VerificationTest[SetReplaceObjectQ[unknownObject[4]]],
+      VerificationTest[!SetReplaceObjectQ[unseenObject[4]]],
+
+      (* Translations *)
+      VerificationTest[
+        SetReplaceTypeConvert["Expression"] @ SetReplaceTypeConvert["String"] @ expression[4], expression[4]],
+      VerificationTest[SetReplaceTypeConvert["HalfInteger"] @ evenInteger[4], halfInteger[2]],
+      VerificationTest[SetReplaceTypeConvert["HalfInteger"] @ halfInteger[3], halfInteger[3]],
+      VerificationTest[SetReplaceTypeConvert["EvenInteger"] @ halfInteger[3], evenInteger[6]],
+
+      testUnevaluated[SetReplaceTypeConvert["Expression"] @ unknownObject[5], SetReplaceTypeConvert::unconvertibleType],
+      testUnevaluated[SetReplaceTypeConvert["Unknown"] @ expression[4], SetReplaceTypeConvert::unconvertibleType],
+      testUnevaluated[SetReplaceTypeConvert["Expression"] @ halfInteger[3], SetReplaceTypeConvert::noConversionPath],
+      testUnevaluated[SetReplaceTypeConvert["HalfInteger"] @ evenInteger[3], SetReplaceTypeConvert::notEven],
+      testUnevaluated[SetReplaceTypeConvert["EvenInteger"] @ halfInteger[a], SetReplaceTypeConvert::notAnInteger],
+
+      (* Raw Properties *)
+      VerificationTest[multipliedHalf[5] @ halfInteger[3], 15],
+      VerificationTest[multipliedHalf[5] @ evenInteger[4], 10],
+      VerificationTest[multipliedHalf[halfInteger[3], 4], 12],
+      VerificationTest[multipliedHalf[evenInteger[4], 4], 8],
+      VerificationTest[description @ evenInteger[4], "I am an integer 4."],
+      VerificationTest[description @ halfInteger[4], "I am an integer 8."],
+      VerificationTest[description[] @ halfInteger[4], "I am an integer 8."], (* Operator form with no arguments *)
+      VerificationTest[description @ 2.4, "I am a real 2.4."],
+
+      testUnevaluated[multipliedHalf[] @ halfInteger[3], multipliedHalf::invalidPropertyArgumentCount],
+      testUnevaluated[multipliedHalf[1, 2, 3] @ halfInteger[3], multipliedHalf::invalidPropertyArgumentCount],
+      testUnevaluated[multipliedHalf @ halfInteger[3], multipliedHalf::invalidPropertyArgumentCount],
+      testUnevaluated[multipliedHalf[halfInteger[3], 4, 5], multipliedHalf::invalidPropertyArgumentCount],
+      testUnevaluated[description[1] @ halfInteger[4], description::invalidPropertyArgumentCount],
+      testUnevaluated[description[halfInteger[3], 3], description::invalidPropertyArgumentCount],
+
+      testUnevaluated[multipliedHalf[4, 4, 5][], multipliedHalf::invalidPropertyOperatorArgument],
+      testUnevaluated[multipliedHalf[4, 4, 5][halfInteger[4], 2, 3], multipliedHalf::invalidPropertyOperatorArgument],
+      testUnevaluated[description[][], description::invalidPropertyOperatorArgument],
+
+      testUnevaluated[multipliedHalf[4] @ cookie, multipliedHalf::unknownObject],
+      testUnevaluated[multipliedHalf[4, 4, 5] @ cookie, multipliedHalf::unknownObject],
+      testUnevaluated[description[] @ cookie, description::unknownObject],
+      testUnevaluated[multipliedHalf[5] @ expression[3], multipliedHalf::noPropertyPath],
+      testUnevaluated[multipliedHalf[5] @ evenInteger[3], multipliedHalf::notEven],
+      testUnevaluated[multipliedHalf[evenInteger[3], 4], multipliedHalf::notEven],
+      testUnevaluated[multipliedHalf[x] @ halfInteger[3], multipliedHalf::nonIntegerFactor],
+      testUnevaluated[multipliedHalf @ cookie, {}], (* should not throw a message because it might be an operator *)
+      testUnevaluated[description @ cookie, {}]
+    }
+  |>
+|>