#include <iomanip>
#include <fstream>
#include <map>
+#include <vector>
//LLVM Header files
#include "llvm/Support/raw_ostream.h"
class State : public Context
{
string initialInnerState;
+ list<string> 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);
};
return 0;
}
-
ostream& operator<<(ostream& os, const Context& c);
ostream& operator<<(ostream& os, const State& s)
{
- os << indent << "" << s.name << "\n";
+ string label = s.name;
+ for (list<string>::const_iterator i = s.defferedEvents.begin(), e = s.defferedEvents.end(); i != e; ++i)
+ label.append("<br />").append(*i).append(" / defer");
+ 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;
class Model : public map<string, Machine>
{
- Context unknown; // For forward-declared state classes
+ Context undefined; // For forward-declared state classes
public:
list< Transition*> transitions;
return ret.first;
}
- void addUnknownState(State *m)
+ void addUndefinedState(State *m)
{
- unknown[m->name] = m;
+ undefined[m->name] = m;
}
Context *findContext(const string &name)
{
- Context::iterator ci = unknown.find(name);
- if (ci != unknown.end())
+ Context::iterator ci = undefined.find(name);
+ if (ci != undefined.end())
return ci->second;
iterator i = find(name), e;
if (i != end())
return 0;
}
- State *removeFromUnknownContexts(const string &name)
+ State *findState(const string &name)
+ {
+ for (iterator i = begin(), e = end(); i != e; ++i) {
+ Context *c = i->second.findContext(name);
+ if (c)
+ return static_cast<State*>(c);
+ }
+ return 0;
+ }
+
+
+ State *removeFromUndefinedContexts(const string &name)
{
- Context::iterator ci = unknown.find(name);
- if (ci == unknown.end())
+ Context::iterator ci = undefined.find(name);
+ if (ci == undefined.end())
return 0;
- unknown.erase(ci);
+ undefined.erase(ci);
return ci->second;
}
}
};
+class FindTransitVisitor : public RecursiveASTVisitor<FindTransitVisitor>
+{
+ Model::Model &model;
+ const CXXRecordDecl *SrcState;
+ const Type *EventType;
+public:
+ explicit FindTransitVisitor(Model::Model &model, const CXXRecordDecl *SrcState, const Type *EventType)
+ : model(model), SrcState(SrcState), EventType(EventType) {}
+
+ bool VisitMemberExpr(MemberExpr *E) {
+ if (E->getMemberNameInfo().getAsString() != "transit")
+ return true;
+ if (E->hasExplicitTemplateArgs()) {
+ const Type *DstStateType = E->getExplicitTemplateArgs()[0].getArgument().getAsType().getTypePtr();
+ CXXRecordDecl *DstState = DstStateType->getAsCXXRecordDecl();
+ CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
+ Model::Transition *T = new Model::Transition(SrcState->getName(), DstState->getName(), Event->getName());
+ model.transitions.push_back(T);
+ }
+ return true;
+ }
+};
class Visitor : public RecursiveASTVisitor<Visitor>
{
+ 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_found_state, diag_found_statemachine, diag_no_history, diag_missing_reaction, diag_warning;
+ std::vector<bool> reactMethodInReactions; // Indicates whether i-th react method is referenced from typedef reactions.
+ std::list<eventModel> listOfDefinedEvents;
public:
bool shouldVisitTemplateInstantiations() const { return true; }
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 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<CXXMethodDecl>(*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));
+ ReactRes.first != ReactRes.second; ++ReactRes.first) {
+ if (CXXMethodDecl *React = dyn_cast<CXXMethodDecl>(*ReactRes.first)) {
+ 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<LValueReferenceType>(ParmType)->getPointeeType().getTypePtr();
+ 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)
{
// TODO: Improve Loc tracking
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();
- CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
-
- Model::Transition *T = new Model::Transition(SrcState->getName(), "\"??? custom\"", Event->getName());
- model.transitions.push_back(T);
+ 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::Transition *T = new Model::Transition(SrcState->getName(), "\"??? deferral\"", Event->getName());
- model.transitions.push_back(T);
+ Model::State *s = model.findState(SrcState->getName());
+ assert(s);
+ s->addDeferredEvent(Event->getName());
} else if (name == "boost::mpl::list") {
for (TemplateSpecializationType::iterator Arg = TST->begin(), End = TST->end(); Arg != End; ++Arg)
HandleReaction(Arg->getAsType().getTypePtr(), Loc, SrcState);
r->getLocStart(), SrcState);
else
Diag(Decl->getLocation(), diag_unhandled_reaction_decl) << Decl->getDeclKindName();
+ checkAllReactMethods(SrcState);
}
- CXXRecordDecl *getTemplateArgDecl(const Type *T, unsigned ArgNum)
+ TemplateArgumentLoc getTemplateArgLoc(const TypeLoc &T, unsigned ArgNum, bool ignore)
{
- if (const ElaboratedType *ET = dyn_cast<ElaboratedType>(T))
- return getTemplateArgDecl(ET->getNamedType().getTypePtr(), ArgNum);
- else if (const TemplateSpecializationType *TST = dyn_cast<TemplateSpecializationType>(T)) {
- if (TST->getNumArgs() >= ArgNum+1)
- return TST->getArg(ArgNum).getAsType()->getAsCXXRecordDecl();
+ if (const ElaboratedTypeLoc *ET = dyn_cast<ElaboratedTypeLoc>(&T))
+ return getTemplateArgLoc(ET->getNamedTypeLoc(), ArgNum, ignore);
+ else if (const TemplateSpecializationTypeLoc *TST = dyn_cast<TemplateSpecializationTypeLoc>(&T)) {
+ if (TST->getNumArgs() >= ArgNum+1) {
+ return TST->getArgLoc(ArgNum);
+ } else
+ 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, bool ignore) {
+ return getTemplateArgLoc(Base->getTypeSourceInfo()->getTypeLoc(), ArgNum, ignore);
+ }
+
+ 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();
+ case TemplateArgument::Null:
+ // Diag() was already called
+ break;
+ default:
+ Diag(Loc.getSourceRange().getBegin(), diag_warning) << Loc.getArgument().getKind() << "unsupported kind" << Loc.getSourceRange();
}
return 0;
}
+ CXXRecordDecl *getTemplateArgDeclOfBase(const CXXBaseSpecifier *Base, unsigned ArgNum, bool ignore = false) {
+ TemplateArgumentLoc Loc;
+ return getTemplateArgDeclOfBase(Base, ArgNum, Loc, ignore);
+ }
- bool VisitCXXRecordDecl(CXXRecordDecl *Declaration)
+ void handleSimpleState(CXXRecordDecl *RecordDecl, const CXXBaseSpecifier *Base)
{
- if (!Declaration->isCompleteDefinition())
- return true;
-
- MyCXXRecordDecl *RecordDecl = static_cast<MyCXXRecordDecl*>(Declaration);
- const CXXBaseSpecifier *Base;
-
- if (RecordDecl->isDerivedFrom("boost::statechart::simple_state", &Base))
- {
- string name(RecordDecl->getName()); //getQualifiedNameAsString());
- Diag(RecordDecl->getLocStart(), diag_found_state) << name;
-
- Model::State *state;
- // Either we saw a reference to forward declared state
- // before, or we create a new state.
- if (!(state = model.removeFromUnknownContexts(name)))
- state = new Model::State(name);
-
- CXXRecordDecl *Context = getTemplateArgDecl(Base->getType().getTypePtr(), 1);
+ 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
+ // before, or we create a new state.
+ if (!(state = model.removeFromUndefinedContexts(name)))
+ state = new Model::State(name);
+
+ CXXRecordDecl *Context = getTemplateArgDeclOfBase(Base, 1);
+ if (Context) {
Model::Context *c = model.findContext(Context->getName());
if (!c) {
Model::State *s = new Model::State(Context->getName());
- model.addUnknownState(s);
+ model.addUndefinedState(s);
c = s;
}
c->add(state);
-
- if (CXXRecordDecl *InnerInitialState = getTemplateArgDecl(Base->getType().getTypePtr(), 2))
- state->setInitialInnerState(InnerInitialState->getName());
+ }
+ //TODO support more innitial states
+ TemplateArgumentLoc Loc;
+ if (MyCXXRecordDecl *InnerInitialState =
+ static_cast<MyCXXRecordDecl*>(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();
+ }
// if (CXXRecordDecl *History = getTemplateArgDecl(Base->getType().getTypePtr(), 3))
// Diag(History->getLocStart(), diag_no_history);
- IdentifierInfo& II = ASTCtx->Idents.get("reactions");
- // TODO: Lookup for reactions even in base classes - probably by using Sema::LookupQualifiedName()
- for (DeclContext::lookup_result Reactions = RecordDecl->lookup(DeclarationName(&II));
- Reactions.first != Reactions.second; ++Reactions.first)
- HandleReaction(*Reactions.first, RecordDecl);
+ IdentifierInfo& II = ASTCtx->Idents.get("reactions");
+ // TODO: Lookup for reactions even in base classes - probably by using Sema::LookupQualifiedName()
+ for (DeclContext::lookup_result Reactions = RecordDecl->lookup(DeclarationName(&II));
+ 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();
}
- else if (RecordDecl->isDerivedFrom("boost::statechart::state_machine", &Base))
- {
- Model::Machine m(RecordDecl->getName());
- Diag(RecordDecl->getLocStart(), diag_found_statemachine) << m.name;
+ }
- if (CXXRecordDecl *InitialState = getTemplateArgDecl(Base->getType().getTypePtr(), 1))
- m.setInitialState(InitialState->getName());
- model.add(m);
- }
+ void handleStateMachine(CXXRecordDecl *RecordDecl, const CXXBaseSpecifier *Base)
+ {
+ Model::Machine m(RecordDecl->getName());
+ Diag(RecordDecl->getLocStart(), diag_found_statemachine) << m.name;
+
+ if (MyCXXRecordDecl *InitialState =
+ static_cast<MyCXXRecordDecl*>(getTemplateArgDeclOfBase(Base, 1)))
+ m.setInitialState(InitialState->getName());
+ model.add(m);
+ }
+
+ bool VisitCXXRecordDecl(CXXRecordDecl *Declaration)
+ {
+ if (!Declaration->isCompleteDefinition())
+ return true;
+ 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<MyCXXRecordDecl*>(Declaration);
+ const CXXBaseSpecifier *Base;
+
+ if (RecordDecl->isDerivedFrom("boost::statechart::simple_state", &Base))
+ handleSimpleState(RecordDecl, Base);
+ 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<eventModel>::iterator it = listOfDefinedEvents.begin(); it!=listOfDefinedEvents.end(); it++)
+ Diag((*it).loc, diag_warning)
+ << (*it).name << "event defined but not used in any state";
+ }
};
virtual void HandleTranslationUnit(clang::ASTContext &Context) {
visitor.TraverseDecl(Context.getTranslationUnitDecl());
+ visitor.printUnusedEventDefinitions();
model.write_as_dot_file(destFileName);
}
};
projects / boost-statechart-viewer.git / blobdiff