Skip to content
This repository has been archived by the owner on May 18, 2019. It is now read-only.

Commit

Permalink
[NF] Inherit annotations in functions.
Browse files Browse the repository at this point in the history 
- Merge comments from derived classes when instantiating functions.

Belonging to [master]:
  - #2929
  • Loading branch information
@perost @OpenModelica-Hudson
perost authored and OpenModelica-Hudson committed Feb 12, 2019
1 parent 89e4fb8 commit 19e82ea
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 20 deletions.
2 changes: 1 addition & 1 deletion 3rdParty
Submodule 3rdParty updated 9 files
+1 −1 graphstream/gs-netstream/c++/src/netstream-socket.cpp
+2,701 −5,451 lis-1.4.12/config/ltmain.sh
+1,587 −2,617 lis-1.4.12/m4/libtool.m4
+39 −108 lis-1.4.12/m4/ltoptions.m4
+7 −7 lis-1.4.12/m4/ltversion.m4
+5 −12 lis-1.4.12/m4/lt~obsolete.m4
+1 −1 metis-5.1.0/CMakeLists.txt
+0 −6 open62541/open62541.c
+0 −4 sundials/CMakeLists.txt
10 changes: 10 additions & 0 deletions Compiler/NFFrontEnd/NFClass.mo
View file
Expand Up @@ -602,6 +602,16 @@ uniontype Class
end match;
end lastBaseClass;

function getDerivedComments
input Class cls;
input output list<SCode.Comment> cmts;
algorithm
cmts := match cls
case EXPANDED_DERIVED() then InstNode.getComments(cls.baseClass, cmts);
case TYPED_DERIVED() then InstNode.getComments(cls.baseClass, cmts);
else cmts;
end match;
end getDerivedComments;
end Class;

annotation(__OpenModelica_Interface="frontend");
Expand Down
68 changes: 49 additions & 19 deletions Compiler/NFFrontEnd/NFFunction.mo
View file
Expand Up @@ -1616,9 +1616,8 @@ uniontype Function
end hasUnboxArgs;

function hasUnboxArgsAnnotation
input SCode.Element def;
output Boolean res =
SCode.hasBooleanNamedAnnotationInClass(def, "__OpenModelica_UnboxArguments");
input SCode.Comment cmt;
output Boolean res = SCode.commentHasBooleanNamedAnnotation(cmt, "__OpenModelica_UnboxArguments");
end hasUnboxArgsAnnotation;

function hasOptionalArgument
Expand Down Expand Up @@ -1856,15 +1855,15 @@ protected
end makeSlot;

function hasOMPure
input SCode.Element def;
input SCode.Comment cmt;
output Boolean res =
not SCode.hasBooleanNamedAnnotationInClass(def, "__OpenModelica_Impure");
not SCode.commentHasBooleanNamedAnnotation(cmt, "__OpenModelica_Impure");
end hasOMPure;

function hasImpure
input SCode.Element def;
input SCode.Comment cmt;
output Boolean res =
SCode.hasBooleanNamedAnnotationInClass(def, "__ModelicaAssociation_Impure");
SCode.commentHasBooleanNamedAnnotation(cmt, "__ModelicaAssociation_Impure");
end hasImpure;

function getBuiltin
Expand All @@ -1873,6 +1872,32 @@ protected
DAE.FUNCTION_BUILTIN_PTR() else DAE.FUNCTION_NOT_BUILTIN();
end getBuiltin;

function mergeFunctionAnnotations
"Merges the function's comments from inherited classes."
input list<SCode.Comment> comments;
output SCode.Comment outComment;
protected
Option<String> comment = NONE();
SCode.Mod mod = SCode.NOMOD(), mod2;
algorithm
for cmt in comments loop
if isNone(comment) then
comment := cmt.comment;
end if;

mod := match cmt
case SCode.COMMENT(annotation_ = SOME(SCode.ANNOTATION(modification = mod2)))
then SCode.mergeModifiers(mod2, mod);
else mod;
end match;
end for;

outComment := match mod
case SCode.NOMOD() then SCode.COMMENT(NONE(), comment);
else SCode.COMMENT(SOME(SCode.ANNOTATION(mod)), comment);
end match;
end mergeFunctionAnnotations;

function makeAttributes
input InstNode node;
input list<InstNode> inputs;
Expand All @@ -1884,6 +1909,8 @@ protected
SCode.Restriction res;
SCode.FunctionRestriction fres;
Boolean is_partial;
list<SCode.Comment> cmts;
SCode.Comment cmt;
algorithm
def := InstNode.definition(node);
res := SCode.getClassRestriction(def);
Expand All @@ -1893,6 +1920,9 @@ protected
SCode.Restriction.R_FUNCTION(functionRestriction = fres) := res;
is_partial := SCode.isPartial(def);

cmts := InstNode.getComments(node);
cmt := mergeFunctionAnnotations(cmts);

attr := matchcontinue fres
local
Boolean is_impure, is_om_pure, has_out_params, has_unbox_args;
Expand All @@ -1907,11 +1937,11 @@ protected
in_params := list(InstNode.name(i) for i in inputs);
out_params := list(InstNode.name(o) for o in outputs);
name := SCode.isBuiltinFunction(def, in_params, out_params);
inline_ty := InstUtil.classIsInlineFunc(def);
is_impure := is_impure or hasImpure(def);
has_unbox_args := hasUnboxArgsAnnotation(def);
inline_ty := InstUtil.commentIsInlineFunc(cmt);
is_impure := is_impure or hasImpure(cmt);
has_unbox_args := hasUnboxArgsAnnotation(cmt);
then
DAE.FUNCTION_ATTRIBUTES(inline_ty, hasOMPure(def), is_impure, is_partial,
DAE.FUNCTION_ATTRIBUTES(inline_ty, hasOMPure(cmt), is_impure, is_partial,
DAE.FUNCTION_BUILTIN(SOME(name), has_unbox_args), DAE.FP_NON_PARALLEL());

// Parallel function: there are some builtin functions.
Expand All @@ -1920,18 +1950,18 @@ protected
in_params := list(InstNode.name(i) for i in inputs);
out_params := list(InstNode.name(o) for o in outputs);
name := SCode.isBuiltinFunction(def, in_params, out_params);
inline_ty := InstUtil.classIsInlineFunc(def);
has_unbox_args := hasUnboxArgsAnnotation(def);
inline_ty := InstUtil.commentIsInlineFunc(cmt);
has_unbox_args := hasUnboxArgsAnnotation(cmt);
then
DAE.FUNCTION_ATTRIBUTES(inline_ty, hasOMPure(def), false, is_partial,
DAE.FUNCTION_ATTRIBUTES(inline_ty, hasOMPure(cmt), false, is_partial,
DAE.FUNCTION_BUILTIN(SOME(name), has_unbox_args), DAE.FP_PARALLEL_FUNCTION());

// Parallel function: non-builtin.
case SCode.FunctionRestriction.FR_PARALLEL_FUNCTION()
algorithm
inline_ty := InstUtil.classIsInlineFunc(def);
inline_ty := InstUtil.commentIsInlineFunc(cmt);
then
DAE.FUNCTION_ATTRIBUTES(inline_ty, hasOMPure(def), false, is_partial,
DAE.FUNCTION_ATTRIBUTES(inline_ty, hasOMPure(cmt), false, is_partial,
getBuiltin(def), DAE.FP_PARALLEL_FUNCTION());

// Kernel functions: never builtin and never inlined.
Expand All @@ -1942,15 +1972,15 @@ protected
// Normal function.
else
algorithm
inline_ty := InstUtil.classIsInlineFunc(def);
inline_ty := InstUtil.commentIsInlineFunc(cmt);

// In Modelica 3.2 and before, external functions with side-effects are not marked.
is_impure := SCode.isRestrictionImpure(res,
Config.languageStandardAtLeast(Config.LanguageStandard.'3.3') or
not listEmpty(outputs)) or
SCode.hasBooleanNamedAnnotationInClass(def, "__ModelicaAssociation_Impure");
SCode.commentHasBooleanNamedAnnotation(cmt, "__ModelicaAssociation_Impure");
then
DAE.FUNCTION_ATTRIBUTES(inline_ty, hasOMPure(def), is_impure, is_partial,
DAE.FUNCTION_ATTRIBUTES(inline_ty, hasOMPure(cmt), is_impure, is_partial,
getBuiltin(def), DAE.FP_NON_PARALLEL());

end matchcontinue;
Expand Down
16 changes: 16 additions & 0 deletions Compiler/NFFrontEnd/NFInstNode.mo
View file
Expand Up @@ -1509,6 +1509,22 @@ uniontype InstNode
end match;
end clone;

function getComments
input InstNode node;
input list<SCode.Comment> accumCmts = {};
output list<SCode.Comment> cmts;
algorithm
cmts := match node
local
SCode.Comment cmt;
Class cls;

case CLASS_NODE(definition = SCode.CLASS(cmt = cmt))
then cmt :: Class.getDerivedComments(Pointer.access(node.cls), accumCmts);

else accumCmts;
end match;
end getComments;
end InstNode;

annotation(__OpenModelica_Interface="frontend");
Expand Down

0 comments on commit 19e82ea

Please sign in to comment.