#include <iomanip>
#include <fstream>
#include <map>
+#include <vector>
//LLVM Header files
#include "llvm/Support/raw_ostream.h"
{
string initialInnerState;
list<string> defferedEvents;
+ list<string> inStateEvents;
bool noTypedef;
public:
const string 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 addInStateEvent(const string &name) { inStateEvents.push_back(name); }
void setNoTypedef() { noTypedef = true;}
friend ostream& operator<<(ostream& os, const State& s);
};
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";
+ for (list<string>::const_iterator i = s.inStateEvents.begin(), e = s.inStateEvents.end(); i != e; ++i)
+ label.append("<br />").append(*i).append(" / in state");
+ 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";
f << indent_dec << "}\n";
}
};
-};
+}
class MyCXXRecordDecl : public CXXRecordDecl
bool isDerivedFrom(const char *baseStr, CXXBaseSpecifier const **Base = 0) const {
CXXBasePaths Paths(/*FindAmbiguities=*/false, /*RecordPaths=*/!!Base, /*DetectVirtual=*/false);
Paths.setOrigin(const_cast<MyCXXRecordDecl*>(this));
- if (!lookupInBases(&FindBaseClassString, const_cast<char*>(baseStr), Paths))
+ string qn(baseStr);
+ if (!lookupInBases(
+ [qn](const CXXBaseSpecifier *Specifier, CXXBasePath &Path) -> bool {
+ const RecordType *rt = Specifier->getType()->getAs<RecordType>();
+ assert(rt);
+ TagDecl *canon = rt->getDecl()->getCanonicalDecl();
+ return canon->getQualifiedNameAsString() == qn;
+ }, Paths) )
+ {
return false;
+ }
+
if (Base)
*Base = Paths.front().back().Base;
return true;
: model(model), SrcState(SrcState), EventType(EventType) {}
bool VisitMemberExpr(MemberExpr *E) {
- if (E->getMemberNameInfo().getAsString() != "transit")
+ if (E->getMemberNameInfo().getAsString() == "defer_event") {
+ CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
+
+ Model::State *s = model.findState(SrcState->getName());
+ assert(s);
+ s->addDeferredEvent(Event->getName());
+ } else if (E->getMemberNameInfo().getAsString() != "transit")
return true;
if (E->hasExplicitTemplateArgs()) {
- const Type *DstStateType = E->getExplicitTemplateArgs()[0].getArgument().getAsType().getTypePtr();
+ const Type *DstStateType = E->getTemplateArgs()[0].getArgument().getAsType().getTypePtr();
CXXRecordDecl *DstState = DstStateType->getAsCXXRecordDecl();
CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
Model::Transition *T = new Model::Transition(SrcState->getName(), DstState->getName(), Event->getName());
class Visitor : public RecursiveASTVisitor<Visitor>
{
+ struct eventModel {
+ string name;
+ SourceLocation loc;
+ eventModel(string ev, SourceLocation sourceLoc) : name(ev), loc(sourceLoc){}
+ };
+
+ struct eventHasName {
+ string eventName;
+ eventHasName(string name) : eventName(name){}
+ bool operator() (const eventModel& model) { return (eventName.compare(model.name) == 0); }
+ };
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<bool> reactMethodInReactions; // Indicates whether i-th react method is referenced from typedef reactions.
+ std::list<eventModel> unusedEvents;
public:
bool shouldVisitTemplateInstantiations() const { return true; }
Diags.getCustomDiagID(DiagnosticsEngine::Error, "Unhandled reaction type '%0'");
diag_unhandled_reaction_decl =
Diags.getCustomDiagID(DiagnosticsEngine::Error, "Unhandled reaction decl '%0'");
- diag_unhandled_reaction_decl =
+ diag_no_history =
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");
+ auto ReactRes = SrcState->lookup(DeclarationName(&II));
+ for (auto it = ReactRes.begin(), end=ReactRes.end(); it != end; ++it, ++i) {
+ if (i >= reactMethodInReactions.size() || reactMethodInReactions[i] == false) {
+ CXXMethodDecl *React = dyn_cast<CXXMethodDecl>(*it);
+ 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)) {
+ auto ReactRes = SrcState->lookup(DeclarationName(&II));
+ for (auto it = ReactRes.begin(), end=ReactRes.end(); it != end; ++it) {
+ if (CXXMethodDecl *React = dyn_cast<CXXMethodDecl>(*it)) {
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)
+ 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";
+ Diag((*it)->getSourceRange().getBegin(), diag_warning)
+ << (*it)->getDeclKindName() << "is not supported as react method";
+ i++;
}
+ return false;
}
void HandleReaction(const Type *T, const SourceLocation Loc, CXXRecordDecl *SrcState)
const Type *DstStateType = TST->getArg(1).getAsType().getTypePtr();
CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
CXXRecordDecl *DstState = DstStateType->getAsCXXRecordDecl();
+ unusedEvents.remove_if(eventHasName(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();
+ }
+ unusedEvents.remove_if(eventHasName(EventType->getAsCXXRecordDecl()->getNameAsString()));
} else if (name == "boost::statechart::deferral") {
const Type *EventType = TST->getArg(0).getAsType().getTypePtr();
CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
+ unusedEvents.remove_if(eventHasName(Event->getNameAsString()));
Model::State *s = model.findState(SrcState->getName());
assert(s);
} else if (name == "boost::mpl::list") {
for (TemplateSpecializationType::iterator Arg = TST->begin(), End = TST->end(); Arg != End; ++Arg)
HandleReaction(Arg->getAsType().getTypePtr(), Loc, SrcState);
+ } else if (name == "boost::statechart::in_state_reaction") {
+ const Type *EventType = TST->getArg(0).getAsType().getTypePtr();
+ CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
+ unusedEvents.remove_if(eventHasName(Event->getNameAsString()));
+
+ Model::State *s = model.findState(SrcState->getName());
+ assert(s);
+ s->addInStateEvent(Event->getName());
+
} else
Diag(Loc, diag_unhandled_reaction_type) << name;
} else
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<ElaboratedTypeLoc>(&T))
- return getTemplateArgLoc(ET->getNamedTypeLoc(), ArgNum);
- else if (const TemplateSpecializationTypeLoc *TST = dyn_cast<TemplateSpecializationTypeLoc>(&T)) {
- if (TST->getNumArgs() >= ArgNum+1) {
- return TST->getArgLoc(ArgNum);
+ if (const ElaboratedTypeLoc ET = T.getAs<ElaboratedTypeLoc>())
+ return getTemplateArgLoc(ET.getNamedTypeLoc(), ArgNum, ignore);
+ else if (const TemplateSpecializationTypeLoc TST = T.getAs<TemplateSpecializationTypeLoc>()) {
+ if (TST.getNumArgs() >= ArgNum+1) {
+ return TST.getArgLoc(ArgNum);
} else
- if(ArgNum!=2)
- 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(), ArgNum);
+ 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, ArgNum);
+ 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();
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());
- printf("stav %s\n", RecordDecl->getName());
Diag(RecordDecl->getLocStart(), diag_found_state) << name;
+ reactMethodInReactions.clear();
Model::State *state;
// Either we saw a reference to forward declared state
//TODO support more innitial states
TemplateArgumentLoc Loc;
if (MyCXXRecordDecl *InnerInitialState =
- static_cast<MyCXXRecordDecl*>(getTemplateArgDeclOfBase(Base, 2, Loc))) {
+ 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
- Diag(Loc.getTypeSourceInfo()->getTypeLoc().getLocStart(), diag_warning)
+ 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();
}
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);
+ auto Reactions = RecordDecl->lookup(DeclarationName(&II));
+ for (auto it = Reactions.begin(), end = Reactions.end(); it != end; ++it, typedef_num++)
+ HandleReaction(*it, RecordDecl);
if(typedef_num == 0) {
Diag(RecordDecl->getLocStart(), diag_warning)
<< RecordDecl->getName() << "state has no typedef for reactions";
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
+ Declaration->getQualifiedNameAsString() == "TimedSimpleState" ||
+ Declaration->getQualifiedNameAsString() == "boost::statechart::assynchronous_state_machine")
+ return true; // This is an "abstract class" not a real state or real state machine
MyCXXRecordDecl *RecordDecl = static_cast<MyCXXRecordDecl*>(Declaration);
const CXXBaseSpecifier *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());
+ else if (RecordDecl->isDerivedFrom("boost::statechart::event")) {
+ // Mark the event as unused until we found that somebody uses it
+ unusedEvents.push_back(eventModel(RecordDecl->getNameAsString(), RecordDecl->getLocation()));
}
return true;
}
+ void printUnusedEventDefinitions() {
+ for(list<eventModel>::iterator it = unusedEvents.begin(); it!=unusedEvents.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);
}
};
class VisualizeStatechartAction : public PluginASTAction
{
protected:
- ASTConsumer *CreateASTConsumer(CompilerInstance &CI, llvm::StringRef) {
+ std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI, llvm::StringRef) {
size_t dot = getCurrentFile().find_last_of('.');
std::string dest = getCurrentFile().substr(0, dot);
dest.append(".dot");
- return new VisualizeStatechartConsumer(&CI.getASTContext(), dest, CI.getDiagnostics());
+ return std::unique_ptr<ASTConsumer>( new VisualizeStatechartConsumer(&CI.getASTContext(), dest, CI.getDiagnostics()) );
}
bool ParseArgs(const CompilerInstance &CI,
if (args[i] == "-an-error") {
DiagnosticsEngine &D = CI.getDiagnostics();
unsigned DiagID = D.getCustomDiagID(
- DiagnosticsEngine::Error, "invalid argument '" + args[i] + "'");
+ DiagnosticsEngine::Error, "invalid argument '%0' expected '%1'");
D.Report(DiagID);
return false;
}