Updated getClassInformation to get more information for OMEdit.

adeas31 · OpenModelica-Hudson · commit 2d700ff8c665 · 2015-11-26T17:41:08.000+01:00
diff --git a/Compiler/FrontEnd/ModelicaBuiltin.mo b/Compiler/FrontEnd/ModelicaBuiltin.mo
@@ -3620,6 +3620,8 @@ function getClassInformation
   output Boolean fileReadOnly;
   output Integer lineNumberStart, columnNumberStart, lineNumberEnd, columnNumberEnd;
   output String dimensions[:];
+  output Boolean isProtectedClass;
+  output Boolean isDocumentationClass;
 external "builtin";
 annotation(
   Documentation(info="<html>
diff --git a/Compiler/Script/CevalScriptBackend.mo b/Compiler/Script/CevalScriptBackend.mo
@@ -823,7 +823,8 @@ algorithm
 
     case (cache,_,"getClassInformation",_,st,_)
       then (cache,Values.TUPLE({Values.STRING(""),Values.STRING(""),Values.BOOL(false),Values.BOOL(false),Values.BOOL(false),Values.STRING(""),
-                                Values.BOOL(false),Values.INTEGER(0),Values.INTEGER(0),Values.INTEGER(0),Values.INTEGER(0),Values.ARRAY({},{0})}),st);
+                                Values.BOOL(false),Values.INTEGER(0),Values.INTEGER(0),Values.INTEGER(0),Values.INTEGER(0),Values.ARRAY({},{0}),
+                                Values.BOOL(false),Values.BOOL(false)}),st);
 
     case (cache,_,"diffModelicaFileListings",{Values.STRING(s1),Values.STRING(s2),Values.ENUM_LITERAL(name=path)},(st as GlobalScript.SYMBOLTABLE(ast = p)),_)
       algorithm
@@ -5147,17 +5148,25 @@ protected function getClassInformation
   output Values.Value res_1;
 protected
   String name,file,strPartial,strFinal,strEncapsulated,res,cmt,str_readonly,str_sline,str_scol,str_eline,str_ecol;
-  String dim_str;
-  Boolean partialPrefix,finalPrefix,encapsulatedPrefix,isReadOnly;
+  String dim_str,lastIdent;
+  Boolean partialPrefix,finalPrefix,encapsulatedPrefix,isReadOnly,isProtectedClass,isDocClass;
   Absyn.Restriction restr;
   Absyn.ClassDef cdef;
-  Absyn.Class c;
   Integer sl,sc,el,ec;
+  Absyn.Path classPath;
 algorithm
   Absyn.CLASS(name,partialPrefix,finalPrefix,encapsulatedPrefix,restr,cdef,SOURCEINFO(file,isReadOnly,sl,sc,el,ec,_)) := Interactive.getPathedClassInProgram(path, p);
   res := Dump.unparseRestrictionStr(restr);
   cmt := getClassComment(cdef);
   file := Util.testsuiteFriendly(file);
+  if Absyn.pathIsIdent(Absyn.makeNotFullyQualified(path)) then
+    isProtectedClass := false;
+  else
+    lastIdent := Absyn.pathLastIdent(Absyn.makeNotFullyQualified(path));
+    classPath := Absyn.stripLast(path);
+    isProtectedClass := Interactive.isProtectedClass(classPath, lastIdent, p);
+  end if;
+  isDocClass := Interactive.getDocumentationClassAnnotation(path, p);
   res_1 := Values.TUPLE({
     Values.STRING(res),
     Values.STRING(cmt),
@@ -5170,7 +5179,9 @@ algorithm
     Values.INTEGER(sc),
     Values.INTEGER(el),
     Values.INTEGER(ec),
-    getClassDimensions(cdef)
+    getClassDimensions(cdef),
+    Values.BOOL(isProtectedClass),
+    Values.BOOL(isDocClass)
   });
 end getClassInformation;
 
diff --git a/Compiler/Script/Interactive.mo b/Compiler/Script/Interactive.mo
@@ -11919,6 +11919,44 @@ algorithm
   end matchcontinue;
 end getAnnotationStr;
 
+public function getDocumentationClassAnnotation
+"Returns the documentation class annotation of a class.
+  This is annotated with the annotation:
+  annotation (DocumentationClass=true); in the class definition"
+  input Absyn.Path className;
+  input Absyn.Program p;
+  output Boolean isDocClass;
+algorithm
+  isDocClass := match(className,p)
+    local
+      String docStr;
+    case(_,_)
+      equation
+        docStr = getNamedAnnotation(className,p,Absyn.IDENT("DocumentationClass"),SOME("false"),getDocumentationClassAnnotationModStr);
+      then
+        stringEq(docStr, "true");
+  end match;
+end getDocumentationClassAnnotation;
+
+protected function getDocumentationClassAnnotationModStr
+"Extractor function for DocumentationClass"
+  input Option<Absyn.Modification> mod;
+  output String docStr;
+algorithm
+  docStr := matchcontinue(mod)
+    local Absyn.Exp e;
+
+    case(SOME(Absyn.CLASSMOD(eqMod = Absyn.EQMOD(exp=e))))
+      equation
+        docStr = Dump.printExpStr(e);
+      then
+        docStr;
+
+    else "false";
+
+  end matchcontinue;
+end getDocumentationClassAnnotationModStr;
+
 protected function getDefaultComponentName
 "Returns the default component name of a class.
   This is annotated with the annotation:
