-
-////////////////////////////////////////////////////////////////////////////////////////
-//
+/** @file */
+////////////////////////////////////////////////////////////////////////////////////////
+//
// This file is part of Boost Statechart Viewer.
//
// Boost Statechart Viewer is free software: you can redistribute it and/or modify
////////////////////////////////////////////////////////////////////////////////////////
//standard header files
-#include <iostream>
+#include <iomanip>
+#include <fstream>
+#include <map>
+#include <vector>
//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 "iooper.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 // Diagnostic Client
+namespace Model
{
- int nwarnings;
- int nnotes;
- int nignored;
- int nerrors;
- public:
- MyDiagnosticClient(llvm::raw_ostream &os, const DiagnosticOptions &diags, bool OwnsOutputStream = false):TextDiagnosticPrinter(os, diags, OwnsOutputStream = false)
- {
- nwarnings=0;
- nnotes=0;
- nignored=0;
- nerrors = 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<string, State*> {
+ public:
+ iterator add(State *state);
+ Context *findContext(const string &name);
+ };
+
+ class State : public Context
+ {
+ 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);
+ };
+
+
+ Context::iterator Context::add(State *state)
+ {
+ pair<iterator, bool> 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;
}
- virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, const DiagnosticInfo &Info)
- {
- TextDiagnosticPrinter::HandleDiagnostic(DiagLevel, Info); // print diagnostic information using library implementation
- switch (DiagLevel) // count number of all diagnostic information
- {
- case 0 : nignored+=1; break;
- case 1 : nnotes+=1; break;
- case 2 : nwarnings+=1; break;
- default : nerrors+=1;
- print_stats();
- exit(1);
- }
+ return 0;
+ }
+
+ ostream& operator<<(ostream& os, const Context& c);
+
+ 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");
+ 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";
+ 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<Context>(s);
+ os << indent_dec << indent << "}\n";
}
-
- void print_stats() // print statistics about diagnostic
- {
- cout<<"\n--Diagnostic Info--\n";
- cout<<"Number of ignored: "<<nignored<<"\n";
- cout<<"Number of notes: "<<nnotes<<"\n";
- cout<<"Number of warnings: "<<nwarnings<<"\n";
- cout<<"Number of errors and fatal errors: "<<nerrors<<"\n";
+ 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;
}
-
- int getNbrOfWarnings() // get number of warnings
+ 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<Context>(m);
+ os << indent_dec << indent << "}\n";
+ return os;
+ }
+
+
+ class Model : public map<string, Machine>
+ {
+ Context undefined; // For forward-declared state classes
+ public:
+ list< Transition*> transitions;
+
+ iterator add(const Machine &m)
{
- return nwarnings;
+ pair<iterator, bool> ret = insert(value_type(m.name, m));
+ return ret.first;
}
-
- int getNbrOfNotes() // get number of notes
+
+ void addUndefinedState(State *m)
{
- return nnotes;
+ undefined[m->name] = m;
}
- int getNbrOfIgnored() // get number of ignored
+
+ Context *findContext(const string &name)
{
- return nignored;
+ 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;
}
-};
-class FindStates : public ASTConsumer // AST Consumer interface for traversing AST
-{
- // lists for saving information about state machine
- list<string> transitions;
- list<string> cReactions;
- list<string> events;
- list<string> states;
- string name_of_machine;
- string name_of_start;
- FullSourceLoc *fsloc;
- public:
-
- list<string> getStates()
+ State *findState(const string &name)
{
- return states;
+ for (iterator i = begin(), e = end(); i != e; ++i) {
+ Context *c = i->second.findContext(name);
+ if (c)
+ return static_cast<State*>(c);
+ }
+ return 0;
}
-
- list<string> getTransitions()
+
+
+ State *removeFromUndefinedContexts(const string &name)
{
- return transitions;
+ Context::iterator ci = undefined.find(name);
+ if (ci == undefined.end())
+ return 0;
+ undefined.erase(ci);
+ return ci->second;
}
-
- list<string> getEvents()
+
+ void write_as_dot_file(string fn)
{
- return events;
+ ofstream f(fn.c_str());
+ f << "digraph statecharts {\n" << indent_inc;
+ for (iterator i = begin(), e = end(); i != e; i++)
+ f << i->second;
+ for (list<Transition*>::iterator t = transitions.begin(), e = transitions.end(); t != e; ++t)
+ f << **t;
+ f << indent_dec << "}\n";
}
+ };
+};
- string getStateMachine()
- {
- return name_of_machine;
+
+class MyCXXRecordDecl : public CXXRecordDecl
+{
+ static bool FindBaseClassString(const CXXBaseSpecifier *Specifier,
+ CXXBasePath &Path,
+ void *qualName)
+ {
+ string qn(static_cast<const char*>(qualName));
+ const RecordType *rt = Specifier->getType()->getAs<RecordType>();
+ 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<MyCXXRecordDecl*>(this));
+ if (!lookupInBases(&FindBaseClassString, const_cast<char*>(baseStr), Paths))
+ return false;
+ if (Base)
+ *Base = Paths.front().back().Base;
+ return true;
+ }
+};
+
+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() == "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();
+ 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;
+ }
+};
- string getNameOfFirstState()
- {
- return name_of_start;
+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_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; }
+
+ 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");
+ 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";
+ }
}
-
- 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 = "";
+ }
+
+ 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;
+ }
-/*
- Traverse global decls using DeclGroupRef for handling all global decls.
-*/
- virtual void HandleTopLevelDecl(DeclGroupRef DGR)// traverse all top level declarations
- {
- SourceLocation loc;
- 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())
- {
- if(decl->getKind()==35)
- {
- method_decl(decl);
- }
- if (const TagDecl *tagDecl = dyn_cast<TagDecl>(decl))
- {
- if(tagDecl->isStruct() || tagDecl->isClass()) //is it a struct or class
- {
- struct_class(decl);
- }
- }
- if(const NamespaceDecl *namespaceDecl = dyn_cast<NamespaceDecl>(decl))
- {
-
- DeclContext *declCont = namespaceDecl->castToDeclContext(namespaceDecl);
- recursive_visit(declCont);
-
- }
- }
- output = "";
+ void HandleReaction(const Type *T, const SourceLocation Loc, CXXRecordDecl *SrcState)
+ {
+ // TODO: Improve Loc tracking
+ if (const ElaboratedType *ET = dyn_cast<ElaboratedType>(T))
+ HandleReaction(ET->getNamedType().getTypePtr(), Loc, SrcState);
+ else if (const TemplateSpecializationType *TST = dyn_cast<TemplateSpecializationType>(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<TypedefDecl>(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 = 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;
+ }
-/*
- It is used to recursive traverse decls in namespaces.
-*/
- void recursive_visit(const DeclContext *declCont) //recursively visit all decls hidden inside namespaces
- {
- 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;
- loc = decl->getLocation();
- if(loc.isValid())
- {
- if(decl->getKind()==35)
- {
- method_decl(decl);
- }
- else if (const TagDecl *tagDecl = dyn_cast<TagDecl>(decl))
- {
- if(tagDecl->isStruct() || tagDecl->isClass()) //is it a structure or class
- {
- struct_class(decl);
- }
- }
- else if(const NamespaceDecl *namespaceDecl = dyn_cast<NamespaceDecl>(decl))
- {
- DeclContext *declCont = namespaceDecl->castToDeclContext(namespaceDecl);
- recursive_visit(declCont);
- }
- }
- output = "";
- }
+ 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);
}
-
-/*
- This function works with class or struct. It splits the decl into 3 interesting parts.
- The state machine decl, state decl and event decl.
-*/
- void struct_class(const Decl *decl) // works with struct or class decl
- {
- string output, line, ret, trans, event;
- llvm::raw_string_ostream x(output);
- decl->print(x);
- line = get_line_of_code(x.str());
- output = "";
- int pos;
- const NamedDecl *namedDecl = dyn_cast<NamedDecl>(decl);
- if(is_derived(line))
- {
- const CXXRecordDecl *cRecDecl = dyn_cast<CXXRecordDecl>(decl);
-
- if(find_events(cRecDecl, line))
- {
- events.push_back(namedDecl->getNameAsString());
- }
- else if(name_of_machine == "")
- {
- ret = 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);
- }
- }
- else
- {
- ret = find_states(cRecDecl, line);
- if(!ret.empty())
- {
- states.push_back(ret);
- methods_in_class(decl,namedDecl->getNameAsString());
- }
- }
- }
+ //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();
}
-/*
- This function provides traversing all methods and other context indide class. If
- typedef or classic method decl is found. Transitions inside it are beiing founded.
-*/
- void methods_in_class(const Decl *decl, const string state) // traverse context inside one class
- {
- string output, line, ret, trans, event;
- llvm::raw_string_ostream x(output);
- int pos, num;
- const TagDecl *tagDecl = dyn_cast<TagDecl>(decl);
- const DeclContext *declCont = tagDecl->castToDeclContext(tagDecl);
- output="";
- for (DeclContext::decl_iterator i = declCont->decls_begin(), e = declCont->decls_end(); i != e; ++i)
- {
- if (i->getKind()==26) // typedefs
- {
- i->print(x);
- output = x.str();
- line = clean_spaces(cut_type(output));
- ret = find_transitions(state,line);
- if(!ret.empty())
- {
- num = count(ret,';')+1;
- for(int i = 0;i<num;i++)
- {
- pos = ret.find(";");
- if(pos == 0)
- {
- ret = ret.substr(1);
- pos = ret.find(";");
- if(pos==-1) cReactions.push_back(ret);
- else cReactions.push_back(ret.substr(0,pos));
- num-=1;
- }
- else
- {
- if(pos==-1) transitions.push_back(ret);
- else transitions.push_back(ret.substr(0,pos));
- }
- if(i!=num-1) ret = ret.substr(pos+1);
- }
- output="";
- }
- }
- if(i->getKind()==35) method_decl(decl);// C++ method
- }
- }
+// if (CXXRecordDecl *History = getTemplateArgDecl(Base->getType().getTypePtr(), 3))
+// Diag(History->getLocStart(), diag_no_history);
- void method_decl(const Decl *decl) // method decl traverse. Using Stmt
- {
- string output, line, event;
- llvm::raw_string_ostream x(output);
- if(decl->hasBody())
- {
- decl->print(x);
- line = get_return(x.str());
- if(test_model(line,"result"))
- {
- const FunctionDecl *fDecl = dyn_cast<FunctionDecl>(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<NamedDecl>(decl)->getQualifiedNameAsString();
- line = cut_namespaces(line.substr(0,line.rfind("::")));
- line.append(",");
- line.append(event);
- find_return_stmt(decl->getBody(),line);
- for(list<string>::iterator i = cReactions.begin();i!=cReactions.end();i++) // erase info about it from list of custom reactions
- {
- event = *i;
- if(line.compare(event)==0)
- {
- cReactions.erase(i);
- break;
- }
- }
- }
- }
+ 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();
}
+ }
- void find_return_stmt(Stmt *statemt,string event) // traverse all statements in function for finding return Statement
- {
- if(statemt->getStmtClass() == 99) test_stmt(dyn_cast<CaseStmt>(statemt)->getSubStmt(), event);
- else
- {
- for (Stmt::child_range range = statemt->children(); range; ++range)
- {
- test_stmt(*range, event);
- }
- }
- }
-
- void test_stmt(Stmt *stmt, string event) // test statement
- {
- const SourceManager &sman = fsloc->getManager();
- int type;
- string line, param;
- type = stmt->getStmtClass();
- switch(type)
- {
- case 8 : find_return_stmt(dyn_cast<DoStmt>(stmt)->getBody(), event); // do
- break;
- case 86 : find_return_stmt(dyn_cast<ForStmt>(stmt)->getBody(), event); // for
- break;
- case 88 : find_return_stmt(dyn_cast<IfStmt>(stmt)->getThen(), event); //if then
- find_return_stmt(dyn_cast<IfStmt>(stmt)->getElse(), event); //if else
- break;
- case 90 : find_return_stmt(dyn_cast<LabelStmt>(stmt)->getSubStmt(), event); //label
- break;
- case 98 : line = sman.getCharacterData(dyn_cast<ReturnStmt>(stmt)->getReturnLoc());
- line = get_line_of_code(line).substr(6);
- line = line.substr(0,line.find("("));
- if(test_model(line,"transit"))
- {
- param = 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<SwitchStmt>(stmt)->getBody(), event); // switch
- break;
- case 102 : find_return_stmt(dyn_cast<WhileStmt>(stmt)->getBody(), event); // while
- break;
- }
+ 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" ||
+ 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;
+
+ 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<eventModel>::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);
+ }
};
-int main(int argc, char **argv)
-{
- string inputFilename = "";
- string outputFilename = "graph.dot"; // initialize output Filename
- DiagnosticOptions dopts;
- dopts.ShowColors=1;
- MyDiagnosticClient *mdc = new MyDiagnosticClient(llvm::errs(), dopts);
- llvm::IntrusiveRefCntPtr<DiagnosticIDs> dis(new DiagnosticIDs());
- Diagnostic diag(dis,mdc);
- FileManager fm( * new FileSystemOptions());
- SourceManager sm (diag, fm);
- HeaderSearch *headers = new HeaderSearch(fm);
-
- Driver TheDriver(LLVM_BINDIR, llvm::sys::getHostTriple(), "", false, false, diag);
- TheDriver.setCheckInputsExist(true);
- TheDriver.CCCIsCXX = 1;
- TheDriver.ResourceDir = LLVM_PREFIX "/lib/clang/" CLANG_VERSION_STRING;
-
- CompilerInvocation compInv;
- llvm::SmallVector<const char *, 16> Args(argv, argv + argc);
- llvm::OwningPtr<Compilation> C(TheDriver.BuildCompilation(Args.size(),
- Args.data()));
- const driver::JobList &Jobs = C->getJobs();
- const driver::Command *Cmd = cast<driver::Command>(*Jobs.begin());
- const driver::ArgStringList &CCArgs = Cmd->getArguments();
- for(unsigned i = 0; i<Args.size();i++) // find -o in ArgStringList
- {
- if(strncmp(Args[i],"-o",2)==0)
- {
- if(strlen(Args[i])>2)
- {
- string str = Args[i];
- outputFilename = str.substr(2);
- }
- else outputFilename = Args[i+1];
- break;
- }
- }
-
- CompilerInvocation::CreateFromArgs(compInv,
- const_cast<const char **>(CCArgs.data()),
- const_cast<const char **>(CCArgs.data())+CCArgs.size(),
- diag);
-
- HeaderSearchOptions hsopts = compInv.getHeaderSearchOpts();
- LangOptions lang = compInv.getLangOpts();
- CompilerInvocation::setLangDefaults(lang, IK_ObjCXX);
- TargetInfo *ti = TargetInfo::CreateTargetInfo(diag, compInv.getTargetOpts());
- FrontendOptions f = compInv.getFrontendOpts();
- inputFilename = f.Inputs[0].second;
-
- cout<<"Input filename: "<<inputFilename<<"\n"; // print Input filename
- cout<<"Output filename: "<<outputFilename<<"\n"; // print Output filename
-
-
- Preprocessor pp(diag, lang, *ti, sm, *headers);
- pp.getBuiltinInfo().InitializeBuiltins(pp.getIdentifierTable(), lang);
-
- InitializePreprocessor(pp, compInv.getPreprocessorOpts(),hsopts,f);
-
- const FileEntry *file = fm.getFile(inputFilename);
- sm.createMainFileID(file);
- IdentifierTable tab(lang);
- Builtin::Context builtins(*ti);
- FindStates c;
- ASTContext ctx(lang, sm, *ti, tab, * new SelectorTable(), builtins,0);
- mdc->BeginSourceFile(lang, &pp);//start using diagnostic
- ParseAST(pp, &c, ctx, false, false);
- mdc->EndSourceFile(); //end using diagnostic
- IO_operations *io = new IO_operations(outputFilename, c.getStateMachine(), c.getNameOfFirstState(), c.getTransitions(), c.getStates(), c.getEvents());
- io->save_to_file();
- io->print_stats();
- mdc->print_stats();
- return 0;
-}
+class VisualizeStatechartAction : public PluginASTAction
+{
+protected:
+ 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());
+ }
+
+ bool ParseArgs(const CompilerInstance &CI,
+ const std::vector<std::string>& 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 '" + args[i] + "'");
+ 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<VisualizeStatechartAction> X("visualize-statechart", "visualize statechart");
+
+// Local Variables:
+// c-basic-offset: 4
+// End:
projects / boost-statechart-viewer.git / blobdiff