X-Git-Url: http://rtime.felk.cvut.cz/gitweb/boost-statechart-viewer.git/blobdiff_plain/da912782e00ff75a8763accacc96bc9a693a20a9..a97505a0d87372e8cad600b51ff4fc4e0b86f45e:/src/visualizer.cpp diff --git a/src/visualizer.cpp b/src/visualizer.cpp index 3ca4ee4..ab4a1f4 100644 --- a/src/visualizer.cpp +++ b/src/visualizer.cpp @@ -1,470 +1,633 @@ +/** @file */ +//////////////////////////////////////////////////////////////////////////////////////// +// +// This file is part of Boost Statechart Viewer. +// +// Boost Statechart Viewer is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// Boost Statechart Viewer is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with Boost Statechart Viewer. If not, see . +// +//////////////////////////////////////////////////////////////////////////////////////// + //standard header files -#include -#include +#include #include -#include +#include +#include //LLVM Header files #include "llvm/Support/raw_ostream.h" -#include "llvm/Support/Host.h" -#include "llvm/Config/config.h" +#include "llvm/Support/raw_os_ostream.h" //clang header files -#include "clang/Frontend/TextDiagnosticPrinter.h" -#include "clang/Lex/HeaderSearch.h" -#include "clang/Basic/FileManager.h" -#include "clang/Frontend/Utils.h" -#include "clang/Basic/TargetInfo.h" -#include "clang/Lex/Preprocessor.h" -#include "clang/Frontend/CompilerInstance.h" #include "clang/AST/ASTConsumer.h" -#include "clang/Sema/Lookup.h" -#include "clang/Parse/ParseAST.h" -#include "clang/Basic/Version.h" -#include "clang/Driver/Driver.h" -#include "clang/Driver/Compilation.h" - -//my own header files -#include "stringoper.h" +#include "clang/AST/ASTContext.h" +#include "clang/AST/CXXInheritance.h" +#include "clang/AST/RecursiveASTVisitor.h" +#include "clang/Frontend/CompilerInstance.h" +#include "clang/Frontend/FrontendPluginRegistry.h" using namespace clang; -using namespace clang::driver; using namespace std; -class MyDiagnosticClient : public TextDiagnosticPrinter // My diagnostic Client +namespace Model { - public: - MyDiagnosticClient(llvm::raw_ostream &os, const DiagnosticOptions &diags, bool OwnsOutputStream = false):TextDiagnosticPrinter(os, diags, OwnsOutputStream = false){} - virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, const DiagnosticInfo &Info) - { - TextDiagnosticPrinter::HandleDiagnostic(DiagLevel, Info); // print diagnostic information - if(DiagLevel > 2) // if error/fatal error stop the program - { - exit(1); - } - } -}; -class FindStates : public ASTConsumer -{ - list transitions; - list cReactions; - list events; - string name_of_machine; - string name_of_start; - StringDecl sd; - int nbrStates; - FullSourceLoc *fsloc; - public: - list states; - - virtual void Initialize(ASTContext &ctx)//run after the AST is constructed before the consumer starts to work - { - fsloc = new FullSourceLoc(* new SourceLocation(), ctx.getSourceManager()); - name_of_start = ""; - name_of_machine = ""; - nbrStates = 0; + inline int getIndentLevelIdx() { + static int i = ios_base::xalloc(); + return i; + } + + ostream& indent(ostream& os) { os << setw(2*os.iword(getIndentLevelIdx())) << ""; return os; } + ostream& indent_inc(ostream& os) { os.iword(getIndentLevelIdx())++; return os; } + ostream& indent_dec(ostream& os) { os.iword(getIndentLevelIdx())--; return os; } + + class State; + + class Context : public map { + public: + iterator add(State *state); + Context *findContext(const string &name); + }; + + class State : public Context + { + string initialInnerState; + list defferedEvents; + list 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); + }; + + + Context::iterator Context::add(State *state) + { + pair ret = insert(value_type(state->name, state)); + return ret.first; + } + + Context *Context::findContext(const string &name) + { + iterator i = find(name), e; + if (i != end()) + return i->second; + for (i = begin(), e = end(); i != e; ++i) { + Context *c = i->second->findContext(name); + if (c) + return c; } + return 0; + } - virtual void HandleTopLevelDecl(DeclGroupRef DGR)// traverse all top level declarations - { - SourceLocation loc; - std::string line, output, event; - llvm::raw_string_ostream x(output); - for (DeclGroupRef::iterator i = DGR.begin(), e = DGR.end(); i != e; ++i) - { - const Decl *decl = *i; - loc = decl->getLocation(); - if(loc.isValid()) - { - //cout<getKind()<<"ss\n"; - if(decl->getKind()==35) - { - method_decl(decl); - } - if (const TagDecl *tagDecl = dyn_cast(decl)) - { - if(tagDecl->isStruct() || tagDecl->isClass()) //is it a struct or class - { - struct_class(decl); - } - } - if(const NamespaceDecl *namespaceDecl = dyn_cast(decl)) - { - - DeclContext *declCont = namespaceDecl->castToDeclContext(namespaceDecl); - //cout<getNameAsString()<<" sss\n"; - recursive_visit(declCont); - - } - } - output = ""; - } + ostream& operator<<(ostream& os, const Context& c); + + ostream& operator<<(ostream& os, const State& s) + { + 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"); + for (list::const_iterator i = s.inStateEvents.begin(), e = s.inStateEvents.end(); i != e; ++i) + label.append("
").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"; + os << indent << "subgraph cluster_" << s.name << " {\n" << indent_inc; + os << indent << "label = \"" << s.name << "\"\n"; + os << indent << s.initialInnerState << " [peripheries=2]\n"; + os << static_cast(s); + os << indent_dec << indent << "}\n"; } - void recursive_visit(const DeclContext *declCont) //recursively visit all decls hidden inside namespaces - { - std::string line, output, event; - llvm::raw_string_ostream x(output); - SourceLocation loc; - for (DeclContext::decl_iterator i = declCont->decls_begin(), e = declCont->decls_end(); i != e; ++i) - { - const Decl *decl = *i; - //std::cout<<"a "<getDeclKindName()<<"\n"; - loc = decl->getLocation(); - if(loc.isValid()) - { - if(decl->getKind()==35) - { - method_decl(decl); - } - else if (const TagDecl *tagDecl = dyn_cast(decl)) - { - if(tagDecl->isStruct() || tagDecl->isClass()) //is it a structure or class - { - struct_class(decl); - } - } - else if(const NamespaceDecl *namespaceDecl = dyn_cast(decl)) - { - DeclContext *declCont = namespaceDecl->castToDeclContext(namespaceDecl); - //cout<getNameAsString()<<" sss\n"; - recursive_visit(declCont); - } - } - output = ""; - } + return os; + } + + + ostream& operator<<(ostream& os, const Context& c) + { + for (Context::const_iterator i = c.begin(), e = c.end(); i != e; i++) { + os << *i->second; } - - void struct_class(const Decl *decl) // works with struct or class decl + return os; + } + + + class Transition + { + public: + const string src, dst, event; + Transition(string src, string dst, string event) : src(src), dst(dst), event(event) {} + }; + + ostream& operator<<(ostream& os, const Transition& t) + { + os << indent << t.src << " -> " << t.dst << " [label = \"" << t.event << "\"]\n"; + return os; + } + + + class Machine : public Context + { + protected: + string initial_state; + public: + const string name; + explicit Machine(string name) : name(name) {} + + void setInitialState(string name) { initial_state = name; } + + friend ostream& operator<<(ostream& os, const Machine& m); + }; + + ostream& operator<<(ostream& os, const Machine& m) + { + os << indent << "subgraph " << m.name << " {\n" << indent_inc; + os << indent << m.initial_state << " [peripheries=2]\n"; + os << static_cast(m); + os << indent_dec << indent << "}\n"; + return os; + } + + + class Model : public map + { + Context undefined; // For forward-declared state classes + public: + list< Transition*> transitions; + + iterator add(const Machine &m) { - string output, line, ret, trans, event; - llvm::raw_string_ostream x(output); - decl->print(x); - line = sd.get_line_of_code(x.str()); - output = ""; - int pos, num; - const TagDecl *tagDecl = dyn_cast(decl); - const NamedDecl *namedDecl = dyn_cast(decl); - if(sd.is_derived(line)) - { - const CXXRecordDecl *cRecDecl = dyn_cast(decl); - - if(sd.find_events(cRecDecl, line)) - { - events.push_back(namedDecl->getNameAsString()); - cout<<"New event: "<getNameAsString()<<"\n"; - } - else if(name_of_machine == "") - { - ret = sd.find_name_of_machine(cRecDecl, line); - if(!ret.empty()) - { - pos = ret.find(","); - name_of_machine = ret.substr(0,pos); - name_of_start = ret.substr(pos+1); - cout<<"Name of the state machine: "<castToDeclContext(tagDecl); - //states.push_back(namedDecl->getNameAsString()); - std::cout << "New state: " << namedDecl->getNameAsString() << "\n"; - states.push_back(ret); - output=""; - for (DeclContext::decl_iterator i = declCont->decls_begin(), e = declCont->decls_end(); i != e; ++i) - { - const Decl *decl = *i; - if (decl->getKind()==26) - { - decl->print(x); - output = x.str(); - line = sd.clean_spaces(sd.cut_type(output)); - ret = sd.find_transitions(namedDecl->getNameAsString(),line); - if(!ret.empty()) - { - num = sd.count(ret,';')+1; - for(int i = 0;igetKind()==35) method_decl(decl); - } - } - } - } + pair ret = insert(value_type(m.name, m)); + return ret.first; } - void method_decl(const Decl *decl) + + void addUndefinedState(State *m) { - string output, line, event; - llvm::raw_string_ostream x(output); - if(decl->hasBody()) - { - decl->print(x); - line = sd.get_return(x.str()); - if(sd.test_model(line,"result")) - { - const FunctionDecl *fDecl = dyn_cast(decl); - const ParmVarDecl *pvd = fDecl->getParamDecl(0); - QualType qt = pvd->getOriginalType(); - event = qt.getAsString(); - if(event[event.length()-1]=='&') event = event.substr(0,event.length()-2); - event = event.substr(event.rfind(" ")+1); - line = dyn_cast(decl)->getQualifiedNameAsString(); - line = sd.cut_namespaces(line.substr(0,line.rfind("::"))); - line.append(","); - line.append(event); - find_return_stmt(decl->getBody(),line); - for(list::iterator i = cReactions.begin();i!=cReactions.end();i++) - { - event = *i; - if(line.compare(event)==0) - { - cReactions.erase(i); - break; - } - } - } - } + undefined[m->name] = m; } - void find_return_stmt(Stmt *statemt,string event) + + + Context *findContext(const string &name) { - if(statemt->getStmtClass() == 99) test_stmt(dyn_cast(statemt)->getSubStmt(), event); - else - { - for (Stmt::child_range range = statemt->children(); range; ++range) - { - test_stmt(*range, event); - } - } + Context::iterator ci = undefined.find(name); + if (ci != undefined.end()) + return ci->second; + iterator i = find(name), e; + if (i != end()) + return &i->second; + for (i = begin(), e = end(); i != e; ++i) { + Context *c = i->second.findContext(name); + if (c) + return c; + } + return 0; } - - void test_stmt(Stmt *stmt, string event) + + State *findState(const string &name) { - const SourceManager &sman = fsloc->getManager(); - int type; - string line, param; - type = stmt->getStmtClass(); - switch(type) - { - case 8 : find_return_stmt(dyn_cast(stmt)->getBody(), event); // do - break; - case 86 : find_return_stmt(dyn_cast(stmt)->getBody(), event); // for - break; - case 88 : find_return_stmt(dyn_cast(stmt)->getThen(), event); //if then - find_return_stmt(dyn_cast(stmt)->getElse(), event); //if else - break; - case 90 : find_return_stmt(dyn_cast(stmt)->getSubStmt(), event); //label - break; - case 98 : line = sman.getCharacterData(dyn_cast(stmt)->getReturnLoc()); - line = sd.get_line_of_code(line).substr(6); - line = line.substr(0,line.find("(")); - if(sd.test_model(line,"transit")) - { - param = sd.get_params(line); - transitions.push_back(event.append(",").append(param)); - } - break; - case 99 : find_return_stmt(stmt, event); - break; - case 101 : find_return_stmt(dyn_cast(stmt)->getBody(), event); // switch - break; - case 102 : find_return_stmt(dyn_cast(stmt)->getBody(), event); // while - break; - } + for (iterator i = begin(), e = end(); i != e; ++i) { + Context *c = i->second.findContext(name); + if (c) + return static_cast(c); + } + return 0; } - void save_to_file(std::string output) // save all to the output file + + State *removeFromUndefinedContexts(const string &name) { - nbrStates = states.size(); - string state, str, context, ctx; - int pos1, pos2, cnt, subs; - ofstream filestr(output.c_str()); - //std::cout<::iterator i = states.begin();i!=states.end();i++) // write all states in the context of the automaton - { - state = *i; - cnt = sd.count(state,','); - if(cnt==1) - { - pos1 = state.find(","); - ctx = sd.cut_namespaces(state.substr(pos1+1)); - //std::cout<::iterator i = states.begin();i!=states.end();i++) - { - state = *i; - cnt = sd.count(state,','); - //std::cout<::iterator i = transitions.begin();i!=transitions.end();i++) // write all transitions - { - state = *i; - pos1 = state.find(","); - filestr<"; - pos2 = state.rfind(","); - filestr<second; } - void print_stats() // print statistics + + void write_as_dot_file(string fn) { - cout<<"\n"<<"Statistics: \n"; - cout<<"Number of states: "<second; + for (list::iterator t = transitions.begin(), e = transitions.end(); t != e; ++t) + f << **t; + f << indent_dec << "}\n"; } + }; +} + +class MyCXXRecordDecl : public CXXRecordDecl +{ + static bool FindBaseClassString(const CXXBaseSpecifier *Specifier, + CXXBasePath &Path, + void *qualName) + { + string qn(static_cast(qualName)); + const RecordType *rt = Specifier->getType()->getAs(); + assert(rt); + TagDecl *canon = rt->getDecl()->getCanonicalDecl(); + return canon->getQualifiedNameAsString() == qn; + } + +public: + bool isDerivedFrom(const char *baseStr, CXXBaseSpecifier const **Base = 0) const { + CXXBasePaths Paths(/*FindAmbiguities=*/false, /*RecordPaths=*/!!Base, /*DetectVirtual=*/false); + Paths.setOrigin(const_cast(this)); + string qn(baseStr); + if (!lookupInBases( + [qn](const CXXBaseSpecifier *Specifier, CXXBasePath &Path) -> bool { + const RecordType *rt = Specifier->getType()->getAs(); + assert(rt); + TagDecl *canon = rt->getDecl()->getCanonicalDecl(); + return canon->getQualifiedNameAsString() == qn; + }, Paths) ) + { + return false; + } + + if (Base) + *Base = Paths.front().back().Base; + return true; + } }; -int main(int argc, char **argv) -{ - string inputFilename = ""; - string outputFilename = "graph.dot"; // initialize output Filename - MyDiagnosticClient *mdc = new MyDiagnosticClient(llvm::errs(), * new DiagnosticOptions()); - llvm::IntrusiveRefCntPtr dis(new DiagnosticIDs()); - Diagnostic diag(dis,mdc); - FileManager fm( * new FileSystemOptions()); - SourceManager sm (diag, fm); - HeaderSearch *headers = new HeaderSearch(fm); - - Driver TheDriver(LLVM_PREFIX "/bin", llvm::sys::getHostTriple(), "", false, false, diag); - TheDriver.setCheckInputsExist(true); - TheDriver.CCCIsCXX = 1; - CompilerInvocation compInv; - llvm::SmallVector Args(argv, argv + argc); - llvm::OwningPtr C(TheDriver.BuildCompilation(Args.size(), - Args.data())); - const driver::JobList &Jobs = C->getJobs(); - const driver::Command *Cmd = cast(*Jobs.begin()); - const driver::ArgStringList &CCArgs = Cmd->getArguments(); - for(unsigned i = 0; i2) - { - string str = Args[i]; - outputFilename = str.substr(2); - } - else outputFilename = Args[i+1]; - break; +class FindTransitVisitor : public RecursiveASTVisitor +{ + 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() == "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->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()); + model.transitions.push_back(T); + } + return true; + } +}; + +class Visitor : public RecursiveASTVisitor +{ + 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_missing_reaction, diag_warning; + std::vector reactMethodInReactions; // Indicates whether i-th react method is referenced from typedef reactions. + std::list unusedEvents; + +public: + bool shouldVisitTemplateInstantiations() const { return true; } + + explicit Visitor(ASTContext *Context, Model::Model &model, DiagnosticsEngine &Diags) + : ASTCtx(Context), model(model), Diags(Diags) + { + diag_found_statemachine = + Diags.getCustomDiagID(DiagnosticsEngine::Note, "Found statemachine '%0'"); + diag_found_state = + Diags.getCustomDiagID(DiagnosticsEngine::Note, "Found state '%0'"); + diag_unhandled_reaction_type = + Diags.getCustomDiagID(DiagnosticsEngine::Error, "Unhandled reaction type '%0'"); + diag_unhandled_reaction_decl = + Diags.getCustomDiagID(DiagnosticsEngine::Error, "Unhandled reaction decl '%0'"); + 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 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(*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() + auto ReactRes = SrcState->lookup(DeclarationName(&II)); + for (auto it = ReactRes.begin(), end=ReactRes.end(); it != end; ++it) { + if (CXXMethodDecl *React = dyn_cast(*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(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((*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) + { + // TODO: Improve Loc tracking + if (const ElaboratedType *ET = dyn_cast(T)) + HandleReaction(ET->getNamedType().getTypePtr(), Loc, SrcState); + else if (const TemplateSpecializationType *TST = dyn_cast(T)) { + string name = TST->getTemplateName().getAsTemplateDecl()->getQualifiedNameAsString(); + if (name == "boost::statechart::transition") { + const Type *EventType = TST->getArg(0).getAsType().getTypePtr(); + 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(); + 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); + 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); + } 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 + Diag(Loc, diag_unhandled_reaction_type) << T->getTypeClassName(); + } + + void HandleReaction(const NamedDecl *Decl, CXXRecordDecl *SrcState) + { + if (const TypedefDecl *r = dyn_cast(Decl)) + HandleReaction(r->getCanonicalDecl()->getUnderlyingType().getTypePtr(), + r->getLocStart(), SrcState); + else + Diag(Decl->getLocation(), diag_unhandled_reaction_decl) << Decl->getDeclKindName(); + checkAllReactMethods(SrcState); + } + + TemplateArgumentLoc getTemplateArgLoc(const TypeLoc &T, unsigned ArgNum, bool ignore) + { + if (const ElaboratedTypeLoc ET = T.getAs()) + return getTemplateArgLoc(ET.getNamedTypeLoc(), ArgNum, ignore); + else if (const TemplateSpecializationTypeLoc TST = T.getAs()) { + 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(); } - - CompilerInvocation::CreateFromArgs(compInv, - const_cast(CCArgs.data()), - const_cast(CCArgs.data())+CCArgs.size(), - diag); - - HeaderSearchOptions hsopts = compInv.getHeaderSearchOpts(); - hsopts.ResourceDir = LLVM_PREFIX "/lib/clang/" CLANG_VERSION_STRING; - LangOptions lang = compInv.getLangOpts(); - CompilerInvocation::setLangDefaults(lang, IK_ObjCXX); - TargetInfo *ti = TargetInfo::CreateTargetInfo(diag, compInv.getTargetOpts()); - ApplyHeaderSearchOptions(*headers, hsopts, lang, ti->getTriple()); - FrontendOptions f = compInv.getFrontendOpts(); - inputFilename = f.Inputs[0].second; - - cout<<"Input filename: "<BeginSourceFile(lang, &pp);//start using diagnostic - ParseAST(pp, &c, ctx, false, false); - mdc->EndSourceFile(); //end using diagnostic - if(c.states.size()>0) c.save_to_file(outputFilename); - else cout<<"No state machine was found\n"; - c.print_stats(); return 0; -} + } + + CXXRecordDecl *getTemplateArgDeclOfBase(const CXXBaseSpecifier *Base, unsigned ArgNum, bool ignore = false) { + TemplateArgumentLoc 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 + // 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.addUndefinedState(s); + c = s; + } + c->add(state); + } + //TODO support more innitial states + TemplateArgumentLoc Loc; + if (MyCXXRecordDecl *InnerInitialState = + 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(); + } + +// 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() + 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"; + state->setNoTypedef(); + } + } + + 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(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" || + 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(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")) { + // 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::iterator it = unusedEvents.begin(); it!=unusedEvents.end(); it++) + Diag((*it).loc, diag_warning) + << (*it).name << "event defined but not used in any state"; + } +}; + + +class VisualizeStatechartConsumer : public clang::ASTConsumer +{ + Model::Model model; + Visitor visitor; + string destFileName; +public: + explicit VisualizeStatechartConsumer(ASTContext *Context, std::string destFileName, + DiagnosticsEngine &D) + : visitor(Context, model, D), destFileName(destFileName) {} + + virtual void HandleTranslationUnit(clang::ASTContext &Context) { + visitor.TraverseDecl(Context.getTranslationUnitDecl()); + visitor.printUnusedEventDefinitions(); + model.write_as_dot_file(destFileName); + } +}; + +class VisualizeStatechartAction : public PluginASTAction +{ +protected: + std::unique_ptr CreateASTConsumer(CompilerInstance &CI, llvm::StringRef) { + size_t dot = getCurrentFile().find_last_of('.'); + std::string dest = getCurrentFile().substr(0, dot); + dest.append(".dot"); + return std::unique_ptr( new VisualizeStatechartConsumer(&CI.getASTContext(), dest, CI.getDiagnostics()) ); + } + + bool ParseArgs(const CompilerInstance &CI, + const std::vector& args) { + for (unsigned i = 0, e = args.size(); i != e; ++i) { + llvm::errs() << "Visualizer arg = " << args[i] << "\n"; + + // Example error handling. + if (args[i] == "-an-error") { + DiagnosticsEngine &D = CI.getDiagnostics(); + unsigned DiagID = D.getCustomDiagID( + DiagnosticsEngine::Error, "invalid argument '%0' expected '%1'"); + D.Report(DiagID); + return false; + } + } + if (args.size() && args[0] == "help") + PrintHelp(llvm::errs()); + + return true; + } + void PrintHelp(llvm::raw_ostream& ros) { + ros << "Help for Visualize Statechart plugin goes here\n"; + } + +}; + +static FrontendPluginRegistry::Add X("visualize-statechart", "visualize statechart"); + +// Local Variables: +// c-basic-offset: 4 +// End: