Improve getAllSubtypeOf API (#13889)

- Return an empty list if the class being searched for does not exist.
- Rename `AllLoadedClasses` used as default value by some APIs to
  `__OpenModelica_AllLoadedClasses` to reduce the risk of name conflicts.
- Use the top scope as scope in NFApi.frontEndLookup when searching all
  loaded classes instead of failing.

Author: perost

OMCompiler/Compiler/Script/Interactive.mo

@@ -3537,6 +3537,7 @@ end removeExtendsModifiersInElement;
 public function mkFullyQual
   input GraphicEnvCache env;
   input Absyn.Path ipath;
+  input Boolean failOnError = false;
   output FCore.Cache ocache;
   output Absyn.Path opath;
 protected
@@ -3546,7 +3547,7 @@ algorithm
   if Flags.isSet(Flags.NF_API) then
     ocache := cacheFromGraphicEnvCache(env);
     (program, cpath) := cacheProgramAndPath(env);
-    opath := NFApi.mkFullyQual(program, cpath, ipath);
+    opath := NFApi.mkFullyQual(program, cpath, ipath, failOnError);
   else
     (ocache, opath) := Inst.makeFullyQualified(cacheFromGraphicEnvCache(env), envFromGraphicEnvCache(env), ipath);
   end if;

OMCompiler/Compiler/Script/InteractiveUtil.mo

@@ -2364,6 +2364,7 @@ end getElementAttributeValues;
 public function qualifyPath
   input GraphicEnvCache inEnv;
   input Absyn.Path inPath;
+  input Boolean failOnError = false;
   output Absyn.Path outPath;
 protected
   String n;
@@ -2378,12 +2379,16 @@ algorithm
       algorithm
         try
           if Flags.isSet(Flags.NF_API) then
-            (_, outPath) := Interactive.mkFullyQual(inEnv, inPath);
+            (_, outPath) := Interactive.mkFullyQual(inEnv, inPath, failOnError);
           else
             outPath := qualifyType(Interactive.envFromGraphicEnvCache(inEnv), inPath);
           end if;
         else
-          outPath := inPath;
+          if failOnError then
+            fail();
+          else
+            outPath := inPath;
+          end if;
         end try;
       then
         outPath;
@@ -3864,9 +3869,10 @@ algorithm
 
   try
     genv := createEnvironment(inProgram, NONE(), inParentClass);
-    fqpath := qualifyPath(genv, inClass);
+    fqpath := qualifyPath(genv, inClass, failOnError = true);
   else
-    fqpath := inClass;
+    paths := {};
+    return;
   end try;
 
   paths := {};

OMCompiler/Compiler/Script/NFApi.mo

@@ -395,6 +395,7 @@ function mkFullyQual
   input Absyn.Program absynProgram;
   input Absyn.Path classPath;
   input Absyn.Path pathToQualify;
+  input Boolean failOnError = false;
   output Absyn.Path qualPath = pathToQualify;
 protected
   InstNode top, expanded_cls, cls;
@@ -442,15 +443,19 @@ algorithm
     FlagsUtil.set(Flags.SCODE_INST, b);
     FlagsUtil.set(Flags.NF_SCALARIZE, s);
   else
-    // do not fail, just return the Absyn path
-    qualPath := pathToQualify;
-
     if not Flags.isSet(Flags.NF_API_NOISE) then
       ErrorExt.rollBack("NFApi.mkFullyQual");
     end if;
 
     FlagsUtil.set(Flags.SCODE_INST, b);
     FlagsUtil.set(Flags.NF_SCALARIZE, s);
+
+    if failOnError then
+      fail();
+    else
+      // do not fail, just return the Absyn path
+      qualPath := pathToQualify;
+    end if;
   end try;
 
   if Flags.isSet(Flags.EXEC_STAT) then
@@ -712,10 +717,15 @@ algorithm
   name := AbsynUtil.pathString(classPath);
 
   (program, top) := mkTop(absynProgram, name);
-  cls := Inst.lookupRootClass(classPath, top, FAST_CONTEXT);
 
-  // Expand the class.
-  expanded_cls := NFInst.expand(cls, FAST_CONTEXT);
+  if AbsynUtil.pathEqual(classPath, Absyn.IDENT("AllLoadedClasses")) then
+    expanded_cls := top;
+  else
+    cls := Inst.lookupRootClass(classPath, top, FAST_CONTEXT);
+
+    // Expand the class.
+    expanded_cls := NFInst.expand(cls, FAST_CONTEXT);
+  end if;
 
   if Flags.isSet(Flags.EXEC_STAT) then
     execStat("NFApi.frontEndLookup_dispatch("+ name +")");

OMCompiler/Compiler/Stubs/NFApi.mo

@@ -57,6 +57,7 @@ function mkFullyQual
   input Absyn.Program absynProgram;
   input Absyn.Path classPath;
   input Absyn.Path pathToQualify;
+  input Boolean failOnError = false;
   output Absyn.Path qualPath = pathToQualify;
 end mkFullyQual;
 

testsuite/openmodelica/interactive-API/GetAllSubtypeOf4.mos

@@ -0,0 +1,24 @@
+// name: GetAllSubtypeOf4
+// keywords:
+// status: correct
+// cflags: -d=newInst
+//
+// Tests the getAllSubtypeOf API function.
+//
+
+loadString("
+  model M1 = Base;
+
+  model M
+    M1 m1;
+  end M;
+");
+
+getAllSubtypeOf(Base, M, false, false, false);
+getErrorString();
+
+// Result:
+// true
+// {}
+// ""
+// endResult

testsuite/openmodelica/interactive-API/Makefile

@@ -48,6 +48,7 @@ ForStatement8.mos \
 GetAllSubtypeOf1.mos \
 GetAllSubtypeOf2.mos \
 GetAllSubtypeOf3.mos \
+GetAllSubtypeOf4.mos \
 getClassComment.mos \
 getClassNames.mos \
 getCommandLineOptions.mos \