X-Git-Url: http://rtime.felk.cvut.cz/gitweb/boost-statechart-viewer.git/blobdiff_plain/3b692936c580b3febd8ba854af03d9b8beb3d098..c1eec25f6f2a3af45abf1c5d07bef4ee6f64c1b6:/src/visualizer.cpp diff --git a/src/visualizer.cpp b/src/visualizer.cpp index d244a1a..102e356 100644 --- a/src/visualizer.cpp +++ b/src/visualizer.cpp @@ -22,6 +22,7 @@ #include #include #include +#include //LLVM Header files #include "llvm/Support/raw_ostream.h" @@ -62,11 +63,13 @@ namespace Model { string initialInnerState; list defferedEvents; + bool noTypedef; public: const string name; - explicit State(string name) : name(name) {} + explicit State(string name) : noTypedef(false), name(name) {} void setInitialInnerState(string name) { initialInnerState = name; } void addDeferredEvent(const string &name) { defferedEvents.push_back(name); } + void setNoTypedef() { noTypedef = true;} friend ostream& operator<<(ostream& os, const State& s); }; @@ -97,7 +100,8 @@ namespace Model string label = s.name; for (list::const_iterator i = s.defferedEvents.begin(), e = s.defferedEvents.end(); i != e; ++i) label.append("
").append(*i).append(" / defer"); - os << indent << s.name << " [label=<" << label << ">]\n"; + if (s.noTypedef) os << indent << s.name << " [label=<" << label << ">, color=\"red\"]\n"; + else os << indent << s.name << " [label=<" << label << ">]\n"; if (s.size()) { os << indent << s.name << " -> " << s.initialInnerState << " [style = dashed]\n"; os << indent << "subgraph cluster_" << s.name << " {\n" << indent_inc; @@ -274,11 +278,27 @@ public: class Visitor : public RecursiveASTVisitor { + struct eventModel { + string name; + SourceLocation loc; + eventModel(string ev, SourceLocation sourceLoc) : name(ev), loc(sourceLoc){} + }; + struct testEventModel { + string eventName; + testEventModel(string name) : eventName(name){} + bool operator() (const eventModel& model) { + if (eventName.compare(model.name) == 0) + return true; + return false; + } + }; ASTContext *ASTCtx; Model::Model &model; DiagnosticsEngine &Diags; unsigned diag_unhandled_reaction_type, diag_unhandled_reaction_decl, - diag_found_state, diag_found_statemachine, diag_no_history, diag_warning; + diag_found_state, diag_found_statemachine, diag_no_history, diag_missing_reaction, diag_warning; + std::vector reactMethodInReactions; // Indicates whether i-th react method is referenced from typedef reactions. + std::list listOfDefinedEvents; public: bool shouldVisitTemplateInstantiations() const { return true; } @@ -296,14 +316,31 @@ public: Diags.getCustomDiagID(DiagnosticsEngine::Error, "Unhandled reaction decl '%0'"); diag_unhandled_reaction_decl = Diags.getCustomDiagID(DiagnosticsEngine::Error, "History is not yet supported"); + diag_missing_reaction = + Diags.getCustomDiagID(DiagnosticsEngine::Error, "Missing react method for event '%0'"); diag_warning = Diags.getCustomDiagID(DiagnosticsEngine::Warning, "'%0' %1"); } DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) { return Diags.Report(Loc, DiagID); } - void HandleCustomReaction(const CXXRecordDecl *SrcState, const Type *EventType) + void checkAllReactMethods(const CXXRecordDecl *SrcState) + { + unsigned i = 0; + IdentifierInfo& II = ASTCtx->Idents.get("react"); + for (DeclContext::lookup_const_result ReactRes = SrcState->lookup(DeclarationName(&II)); + ReactRes.first != ReactRes.second; ++ReactRes.first, ++i) { + if (i >= reactMethodInReactions.size() || reactMethodInReactions[i] == false) { + CXXMethodDecl *React = dyn_cast(*ReactRes.first); + Diag(React->getParamDecl(0)->getLocStart(), diag_warning) + << React->getParamDecl(0)->getType().getAsString() << " missing in typedef reactions"; + } + } + } + + bool HandleCustomReaction(const CXXRecordDecl *SrcState, const Type *EventType) { + unsigned i = 0; IdentifierInfo& II = ASTCtx->Idents.get("react"); // TODO: Lookup for react even in base classes - probably by using Sema::LookupQualifiedName() for (DeclContext::lookup_const_result ReactRes = SrcState->lookup(DeclarationName(&II)); @@ -312,17 +349,23 @@ public: if (React->getNumParams() >= 1) { const ParmVarDecl *p = React->getParamDecl(0); const Type *ParmType = p->getType().getTypePtr(); + if (i == reactMethodInReactions.size()) reactMethodInReactions.push_back(false); if (ParmType->isLValueReferenceType()) ParmType = dyn_cast(ParmType)->getPointeeType().getTypePtr(); - if (ParmType == EventType) + if (ParmType == EventType) { FindTransitVisitor(model, SrcState, EventType).TraverseStmt(React->getBody()); + reactMethodInReactions[i] = true; + return true; + } } else Diag(React->getLocStart(), diag_warning) << React << "has not a parameter"; } else Diag((*ReactRes.first)->getSourceRange().getBegin(), diag_warning) << (*ReactRes.first)->getDeclKindName() << "is not supported as react method"; + i++; } + return false; } void HandleReaction(const Type *T, const SourceLocation Loc, CXXRecordDecl *SrcState) @@ -337,15 +380,20 @@ public: const Type *DstStateType = TST->getArg(1).getAsType().getTypePtr(); CXXRecordDecl *Event = EventType->getAsCXXRecordDecl(); CXXRecordDecl *DstState = DstStateType->getAsCXXRecordDecl(); + listOfDefinedEvents.remove_if(testEventModel(Event->getNameAsString())); Model::Transition *T = new Model::Transition(SrcState->getName(), DstState->getName(), Event->getName()); model.transitions.push_back(T); } else if (name == "boost::statechart::custom_reaction") { const Type *EventType = TST->getArg(0).getAsType().getTypePtr(); - HandleCustomReaction(SrcState, EventType); + if (!HandleCustomReaction(SrcState, EventType)) { + Diag(SrcState->getLocation(), diag_missing_reaction) << EventType->getAsCXXRecordDecl()->getName(); + } + listOfDefinedEvents.remove_if(testEventModel(EventType->getAsCXXRecordDecl()->getNameAsString())); } else if (name == "boost::statechart::deferral") { const Type *EventType = TST->getArg(0).getAsType().getTypePtr(); CXXRecordDecl *Event = EventType->getAsCXXRecordDecl(); + listOfDefinedEvents.remove_if(testEventModel(Event->getNameAsString())); Model::State *s = model.findState(SrcState->getName()); assert(s); @@ -366,28 +414,30 @@ public: r->getLocStart(), SrcState); else Diag(Decl->getLocation(), diag_unhandled_reaction_decl) << Decl->getDeclKindName(); + checkAllReactMethods(SrcState); } - TemplateArgumentLoc getTemplateArgLoc(const TypeLoc &T, unsigned ArgNum) + TemplateArgumentLoc getTemplateArgLoc(const TypeLoc &T, unsigned ArgNum, bool ignore) { if (const ElaboratedTypeLoc *ET = dyn_cast(&T)) - return getTemplateArgLoc(ET->getNamedTypeLoc(), ArgNum); + return getTemplateArgLoc(ET->getNamedTypeLoc(), ArgNum, ignore); else if (const TemplateSpecializationTypeLoc *TST = dyn_cast(&T)) { if (TST->getNumArgs() >= ArgNum+1) { return TST->getArgLoc(ArgNum); } else - Diag(TST->getBeginLoc(), diag_warning) << TST->getType()->getTypeClassName() << "has not enough arguments" << TST->getSourceRange(); + if (!ignore) + Diag(TST->getBeginLoc(), diag_warning) << TST->getType()->getTypeClassName() << "has not enough arguments" << TST->getSourceRange(); } else Diag(T.getBeginLoc(), diag_warning) << T.getType()->getTypeClassName() << "type as template argument is not supported" << T.getSourceRange(); return TemplateArgumentLoc(); } - TemplateArgumentLoc getTemplateArgLocOfBase(const CXXBaseSpecifier *Base, unsigned ArgNum) { - return getTemplateArgLoc(Base->getTypeSourceInfo()->getTypeLoc(), 1); + TemplateArgumentLoc getTemplateArgLocOfBase(const CXXBaseSpecifier *Base, unsigned ArgNum, bool ignore) { + return getTemplateArgLoc(Base->getTypeSourceInfo()->getTypeLoc(), ArgNum, ignore); } - CXXRecordDecl *getTemplateArgDeclOfBase(const CXXBaseSpecifier *Base, unsigned ArgNum, TemplateArgumentLoc &Loc) { - Loc = getTemplateArgLocOfBase(Base, 1); + CXXRecordDecl *getTemplateArgDeclOfBase(const CXXBaseSpecifier *Base, unsigned ArgNum, TemplateArgumentLoc &Loc, bool ignore = false) { + Loc = getTemplateArgLocOfBase(Base, ArgNum, ignore); switch (Loc.getArgument().getKind()) { case TemplateArgument::Type: return Loc.getTypeSourceInfo()->getType()->getAsCXXRecordDecl(); @@ -400,15 +450,17 @@ public: return 0; } - CXXRecordDecl *getTemplateArgDeclOfBase(const CXXBaseSpecifier *Base, unsigned ArgNum) { + CXXRecordDecl *getTemplateArgDeclOfBase(const CXXBaseSpecifier *Base, unsigned ArgNum, bool ignore = false) { TemplateArgumentLoc Loc; - return getTemplateArgDeclOfBase(Base, ArgNum, Loc); + return getTemplateArgDeclOfBase(Base, ArgNum, Loc, ignore); } void handleSimpleState(CXXRecordDecl *RecordDecl, const CXXBaseSpecifier *Base) { + int typedef_num = 0; string name(RecordDecl->getName()); //getQualifiedNameAsString()); Diag(RecordDecl->getLocStart(), diag_found_state) << name; + reactMethodInReactions.clear(); Model::State *state; // Either we saw a reference to forward declared state @@ -426,15 +478,16 @@ public: } c->add(state); } - + //TODO support more innitial states TemplateArgumentLoc Loc; if (MyCXXRecordDecl *InnerInitialState = - static_cast(getTemplateArgDeclOfBase(Base, 2, Loc))) { - if (InnerInitialState->isDerivedFrom("boost::statechart::simple_state") || - InnerInitialState->isDerivedFrom("boost::statechart::state_machine")) - state->setInitialInnerState(InnerInitialState->getName()); - else - Diag(Loc.getTypeSourceInfo()->getTypeLoc().getLocStart(), diag_warning) + static_cast(getTemplateArgDeclOfBase(Base, 2, Loc, true))) { + if (InnerInitialState->isDerivedFrom("boost::statechart::simple_state") || + InnerInitialState->isDerivedFrom("boost::statechart::state_machine")) { + state->setInitialInnerState(InnerInitialState->getName()); + } + else if (!InnerInitialState->getNameAsString().compare("boost::mpl::list<>")) + Diag(Loc.getTypeSourceInfo()->getTypeLoc().getBeginLoc(), diag_warning) << InnerInitialState->getName() << " as inner initial state is not supported" << Loc.getSourceRange(); } @@ -443,10 +496,14 @@ public: IdentifierInfo& II = ASTCtx->Idents.get("reactions"); // TODO: Lookup for reactions even in base classes - probably by using Sema::LookupQualifiedName() - // TODO: Find when state has no reactions for (DeclContext::lookup_result Reactions = RecordDecl->lookup(DeclarationName(&II)); - Reactions.first != Reactions.second; ++Reactions.first) + Reactions.first != Reactions.second; ++Reactions.first, typedef_num++) HandleReaction(*Reactions.first, RecordDecl); + if(typedef_num == 0) { + Diag(RecordDecl->getLocStart(), diag_warning) + << RecordDecl->getName() << "state has no typedef for reactions"; + state->setNoTypedef(); + } } void handleStateMachine(CXXRecordDecl *RecordDecl, const CXXBaseSpecifier *Base) @@ -464,14 +521,11 @@ public: { if (!Declaration->isCompleteDefinition()) return true; - if (Declaration->getQualifiedNameAsString() == "boost::statechart::state") - return true; // This is an "abstract class" not a real state - if (Declaration->getQualifiedNameAsString() == "TimedState") - return true; // This is an "abstract class" not a real state - if (Declaration->getQualifiedNameAsString() == "TimedSimpleState") + if (Declaration->getQualifiedNameAsString() == "boost::statechart::state" || + Declaration->getQualifiedNameAsString() == "TimedState" || + Declaration->getQualifiedNameAsString() == "TimedSimpleState") return true; // This is an "abstract class" not a real state - MyCXXRecordDecl *RecordDecl = static_cast(Declaration); const CXXBaseSpecifier *Base; @@ -480,11 +534,14 @@ public: else if (RecordDecl->isDerivedFrom("boost::statechart::state_machine", &Base)) handleStateMachine(RecordDecl, Base); else if (RecordDecl->isDerivedFrom("boost::statechart::event")) - { - //sc.events.push_back(RecordDecl->getNameAsString()); - } + listOfDefinedEvents.push_back(eventModel(RecordDecl->getNameAsString(), RecordDecl->getLocation())); return true; } + void printUnusedEventDefinitions() { + for(list::iterator it = listOfDefinedEvents.begin(); it!=listOfDefinedEvents.end(); it++) + Diag((*it).loc, diag_warning) + << (*it).name << "event defined but not used in any state"; + } }; @@ -500,6 +557,7 @@ public: virtual void HandleTranslationUnit(clang::ASTContext &Context) { visitor.TraverseDecl(Context.getTranslationUnitDecl()); + visitor.printUnusedEventDefinitions(); model.write_as_dot_file(destFileName); } };