src/visualizer.cpp

   1 /** @file */
   2 ////////////////////////////////////////////////////////////////////////////////////////
   3 //
   4 //    This file is part of Boost Statechart Viewer.
   5 //
   6 //    Boost Statechart Viewer is free software: you can redistribute it and/or modify
   7 //    it under the terms of the GNU General Public License as published by
   8 //    the Free Software Foundation, either version 3 of the License, or
   9 //    (at your option) any later version.
  10 //
  11 //    Boost Statechart Viewer is distributed in the hope that it will be useful,
  12 //    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //    GNU General Public License for more details.
  15 //
  16 //    You should have received a copy of the GNU General Public License
  17 //    along with Boost Statechart Viewer.  If not, see <http://www.gnu.org/licenses/>.
  18 //
  19 ////////////////////////////////////////////////////////////////////////////////////////
  20
  21 //standard header files
  22 #include <iomanip>
  23 #include <fstream>
  24 #include <map>
  25 #include <vector>
  26
  27 //LLVM Header files
  28 #include "llvm/Support/raw_ostream.h"
  29 #include "llvm/Support/raw_os_ostream.h"
  30
  31 //clang header files
  32 #include "clang/AST/ASTConsumer.h"
  33 #include "clang/AST/ASTContext.h"
  34 #include "clang/AST/CXXInheritance.h"
  35 #include "clang/AST/RecursiveASTVisitor.h"
  36 #include "clang/Frontend/CompilerInstance.h"
  37 #include "clang/Frontend/FrontendPluginRegistry.h"
  38
  39 using namespace clang;
  40 using namespace std;
  41
  42 namespace Model
  43 {
  44
  45     inline int getIndentLevelIdx() {
  46         static int i = ios_base::xalloc();
  47         return i;
  48     }
  49
  50     ostream& indent(ostream& os) { os << setw(2*os.iword(getIndentLevelIdx())) << ""; return os; }
  51     ostream& indent_inc(ostream& os) { os.iword(getIndentLevelIdx())++; return os; }
  52     ostream& indent_dec(ostream& os) { os.iword(getIndentLevelIdx())--; return os; }
  53
  54     class State;
  55
  56     class Context : public map<string, State*> {
  57     public:
  58         iterator add(State *state);
  59         Context *findContext(const string &name);
  60     };
  61
  62     class State : public Context
  63     {
  64         string initialInnerState;
  65         list<string> defferedEvents;
  66         list<string> inStateEvents;
  67         bool noTypedef;
  68     public:
  69         const string name;
  70         explicit State(string name) : noTypedef(false), name(name) {}
  71         void setInitialInnerState(string name) { initialInnerState = name; }
  72         void addDeferredEvent(const string &name) { defferedEvents.push_back(name); }
  73         void addInStateEvent(const string &name) { inStateEvents.push_back(name); }
  74         void setNoTypedef() { noTypedef = true;}
  75         friend ostream& operator<<(ostream& os, const State& s);
  76     };
  77
  78
  79     Context::iterator Context::add(State *state)
  80     {
  81         pair<iterator, bool> ret =  insert(value_type(state->name, state));
  82         return ret.first;
  83     }
  84
  85     Context *Context::findContext(const string &name)
  86     {
  87         iterator i = find(name), e;
  88         if (i != end())
  89             return i->second;
  90         for (i = begin(), e = end(); i != e; ++i) {
  91             Context *c = i->second->findContext(name);
  92             if (c)
  93                 return c;
  94         }
  95         return 0;
  96     }
  97
  98     ostream& operator<<(ostream& os, const Context& c);
  99
 100     ostream& operator<<(ostream& os, const State& s)
 101     {
 102         string label = s.name;
 103         for (list<string>::const_iterator i = s.defferedEvents.begin(), e = s.defferedEvents.end(); i != e; ++i)
 104             label.append("<br />").append(*i).append(" / defer");
 105         for (list<string>::const_iterator i = s.inStateEvents.begin(), e = s.inStateEvents.end(); i != e; ++i)
 106             label.append("<br />").append(*i).append(" / in state");
 107         if (s.noTypedef) os << indent << s.name << " [label=<" << label << ">, color=\"red\"]\n";
 108         else os << indent << s.name << " [label=<" << label << ">]\n";
 109         if (s.size()) {
 110             os << indent << s.name << " -> " << s.initialInnerState << " [style = dashed]\n";
 111             os << indent << "subgraph cluster_" << s.name << " {\n" << indent_inc;
 112             os << indent << "label = \"" << s.name << "\"\n";
 113             os << indent << s.initialInnerState << " [peripheries=2]\n";
 114             os << static_cast<Context>(s);
 115             os << indent_dec << indent << "}\n";
 116         }
 117         return os;
 118     }
 119
 120
 121     ostream& operator<<(ostream& os, const Context& c)
 122     {
 123         for (Context::const_iterator i = c.begin(), e = c.end(); i != e; i++) {
 124             os << *i->second;
 125         }
 126         return os;
 127     }
 128
 129
 130     class Transition
 131     {
 132     public:
 133         const string src, dst, event;
 134         Transition(string src, string dst, string event) : src(src), dst(dst), event(event) {}
 135     };
 136
 137     ostream& operator<<(ostream& os, const Transition& t)
 138     {
 139         os << indent << t.src << " -> " << t.dst << " [label = \"" << t.event << "\"]\n";
 140         return os;
 141     }
 142
 143
 144     class Machine : public Context
 145     {
 146     protected:
 147         string initial_state;
 148     public:
 149         const string name;
 150         explicit Machine(string name) : name(name) {}
 151
 152         void setInitialState(string name) { initial_state = name; }
 153
 154         friend ostream& operator<<(ostream& os, const Machine& m);
 155     };
 156
 157     ostream& operator<<(ostream& os, const Machine& m)
 158     {
 159         os << indent << "subgraph " << m.name << " {\n" << indent_inc;
 160         os << indent << m.initial_state << " [peripheries=2]\n";
 161         os << static_cast<Context>(m);
 162         os << indent_dec << indent << "}\n";
 163         return os;
 164     }
 165
 166
 167     class Model : public map<string, Machine>
 168     {
 169         Context undefined;      // For forward-declared state classes
 170     public:
 171         list< Transition*> transitions;
 172
 173         iterator add(const Machine &m)
 174         {
 175             pair<iterator, bool> ret =  insert(value_type(m.name, m));
 176             return ret.first;
 177         }
 178
 179         void addUndefinedState(State *m)
 180         {
 181             undefined[m->name] = m;
 182         }
 183
 184
 185         Context *findContext(const string &name)
 186         {
 187             Context::iterator ci = undefined.find(name);
 188             if (ci != undefined.end())
 189                 return ci->second;
 190             iterator i = find(name), e;
 191             if (i != end())
 192                 return &i->second;
 193             for (i = begin(), e = end(); i != e; ++i) {
 194                 Context *c = i->second.findContext(name);
 195                 if (c)
 196                     return c;
 197             }
 198             return 0;
 199         }
 200
 201         State *findState(const string &name)
 202         {
 203             for (iterator i = begin(), e = end(); i != e; ++i) {
 204                 Context *c = i->second.findContext(name);
 205                 if (c)
 206                     return static_cast<State*>(c);
 207             }
 208             return 0;
 209         }
 210
 211
 212         State *removeFromUndefinedContexts(const string &name)
 213         {
 214             Context::iterator ci = undefined.find(name);
 215             if (ci == undefined.end())
 216                 return 0;
 217             undefined.erase(ci);
 218             return ci->second;
 219         }
 220
 221         void write_as_dot_file(string fn)
 222         {
 223             ofstream f(fn.c_str());
 224             f << "digraph statecharts {\n" << indent_inc;
 225             for (iterator i = begin(), e = end(); i != e; i++)
 226                 f << i->second;
 227             for (list<Transition*>::iterator t = transitions.begin(), e = transitions.end(); t != e; ++t)
 228                 f << **t;
 229             f << indent_dec << "}\n";
 230         }
 231     };
 232 }
 233
 234
 235 class MyCXXRecordDecl : public CXXRecordDecl
 236 {
 237     static bool FindBaseClassString(const CXXBaseSpecifier *Specifier,
 238                                     CXXBasePath &Path,
 239                                     void *qualName)
 240     {
 241         string qn(static_cast<const char*>(qualName));
 242         const RecordType *rt = Specifier->getType()->getAs<RecordType>();
 243         assert(rt);
 244         TagDecl *canon = rt->getDecl()->getCanonicalDecl();
 245         return canon->getQualifiedNameAsString() == qn;
 246     }
 247
 248 public:
 249     bool isDerivedFrom(const char *baseStr, CXXBaseSpecifier const **Base = 0) const {
 250         CXXBasePaths Paths(/*FindAmbiguities=*/false, /*RecordPaths=*/!!Base, /*DetectVirtual=*/false);
 251         Paths.setOrigin(const_cast<MyCXXRecordDecl*>(this));
 252     string qn(baseStr);
 253         if (!lookupInBases(
 254                 [qn](const CXXBaseSpecifier *Specifier, CXXBasePath &Path) -> bool {
 255                     const RecordType *rt = Specifier->getType()->getAs<RecordType>();
 256                     assert(rt);
 257                     TagDecl *canon = rt->getDecl()->getCanonicalDecl();
 258                     return canon->getQualifiedNameAsString() == qn;
 259                 }, Paths) )
 260     {
 261             return false;
 262     }
 263
 264         if (Base)
 265             *Base = Paths.front().back().Base;
 266         return true;
 267     }
 268 };
 269
 270 class FindTransitVisitor : public RecursiveASTVisitor<FindTransitVisitor>
 271 {
 272     Model::Model &model;
 273     const CXXRecordDecl *SrcState;
 274     const Type *EventType;
 275 public:
 276     explicit FindTransitVisitor(Model::Model &model, const CXXRecordDecl *SrcState, const Type *EventType)
 277         : model(model), SrcState(SrcState), EventType(EventType) {}
 278
 279     bool VisitMemberExpr(MemberExpr *E) {
 280         if (E->getMemberNameInfo().getAsString() == "defer_event") {
 281                 CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
 282
 283                 Model::State *s = model.findState(SrcState->getName());
 284                 assert(s);
 285                 s->addDeferredEvent(Event->getName());
 286         } else if (E->getMemberNameInfo().getAsString() != "transit")
 287             return true;
 288         if (E->hasExplicitTemplateArgs()) {
 289             const Type *DstStateType = E->getTemplateArgs()[0].getArgument().getAsType().getTypePtr();
 290             CXXRecordDecl *DstState = DstStateType->getAsCXXRecordDecl();
 291             CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
 292             Model::Transition *T = new Model::Transition(SrcState->getName(), DstState->getName(), Event->getName());
 293             model.transitions.push_back(T);
 294         }
 295         return true;
 296     }
 297 };
 298
 299 class Visitor : public RecursiveASTVisitor<Visitor>
 300 {
 301     struct eventModel {
 302         string name;
 303         SourceLocation loc;
 304         eventModel(string ev, SourceLocation sourceLoc) : name(ev), loc(sourceLoc){}
 305     };
 306
 307     struct eventHasName {
 308         string eventName;
 309         eventHasName(string name) : eventName(name){}
 310         bool operator() (const eventModel& model) { return (eventName.compare(model.name) == 0); }
 311     };
 312     ASTContext *ASTCtx;
 313     Model::Model &model;
 314     DiagnosticsEngine &Diags;
 315     unsigned diag_unhandled_reaction_type, diag_unhandled_reaction_decl,
 316         diag_found_state, diag_found_statemachine, diag_no_history, diag_missing_reaction, diag_warning;
 317     std::vector<bool> reactMethodInReactions; // Indicates whether i-th react method is referenced from typedef reactions.
 318     std::list<eventModel> unusedEvents;
 319
 320 public:
 321     bool shouldVisitTemplateInstantiations() const { return true; }
 322
 323     explicit Visitor(ASTContext *Context, Model::Model &model, DiagnosticsEngine &Diags)
 324         : ASTCtx(Context), model(model), Diags(Diags)
 325     {
 326         diag_found_statemachine =
 327             Diags.getCustomDiagID(DiagnosticsEngine::Note, "Found statemachine '%0'");
 328         diag_found_state =
 329             Diags.getCustomDiagID(DiagnosticsEngine::Note, "Found state '%0'");
 330         diag_unhandled_reaction_type =
 331             Diags.getCustomDiagID(DiagnosticsEngine::Error, "Unhandled reaction type '%0'");
 332         diag_unhandled_reaction_decl =
 333             Diags.getCustomDiagID(DiagnosticsEngine::Error, "Unhandled reaction decl '%0'");
 334         diag_no_history =
 335             Diags.getCustomDiagID(DiagnosticsEngine::Error, "History is not yet supported");
 336         diag_missing_reaction =
 337             Diags.getCustomDiagID(DiagnosticsEngine::Error, "Missing react method for event '%0'");
 338         diag_warning =
 339             Diags.getCustomDiagID(DiagnosticsEngine::Warning, "'%0' %1");
 340     }
 341
 342     DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) { return Diags.Report(Loc, DiagID); }
 343
 344     void checkAllReactMethods(const CXXRecordDecl *SrcState)
 345     {
 346         unsigned i = 0;
 347         IdentifierInfo& II = ASTCtx->Idents.get("react");
 348         auto ReactRes = SrcState->lookup(DeclarationName(&II));
 349         for (auto it = ReactRes.begin(), end=ReactRes.end(); it != end; ++it, ++i) {
 350             if (i >= reactMethodInReactions.size() || reactMethodInReactions[i] == false) {
 351                 CXXMethodDecl *React = dyn_cast<CXXMethodDecl>(*it);
 352                 Diag(React->getParamDecl(0)->getLocStart(), diag_warning)
 353                     << React->getParamDecl(0)->getType().getAsString() << " missing in typedef reactions";
 354             }
 355         }
 356     }
 357
 358     bool HandleCustomReaction(const CXXRecordDecl *SrcState, const Type *EventType)
 359     {
 360         unsigned i = 0;
 361         IdentifierInfo& II = ASTCtx->Idents.get("react");
 362         // TODO: Lookup for react even in base classes - probably by using Sema::LookupQualifiedName()
 363         auto  ReactRes = SrcState->lookup(DeclarationName(&II));
 364         for (auto it = ReactRes.begin(), end=ReactRes.end(); it != end; ++it) {
 365             if (CXXMethodDecl *React = dyn_cast<CXXMethodDecl>(*it)) {
 366                 if (React->getNumParams() >= 1) {
 367                     const ParmVarDecl *p = React->getParamDecl(0);
 368                     const Type *ParmType = p->getType().getTypePtr();
 369                     if (i == reactMethodInReactions.size()) reactMethodInReactions.push_back(false);
 370                     if (ParmType->isLValueReferenceType())
 371                         ParmType = dyn_cast<LValueReferenceType>(ParmType)->getPointeeType().getTypePtr();
 372                     if (ParmType == EventType) {
 373                         FindTransitVisitor(model, SrcState, EventType).TraverseStmt(React->getBody());
 374                         reactMethodInReactions[i] = true;
 375                         return true;
 376                     }
 377                 } else
 378                     Diag(React->getLocStart(), diag_warning)
 379                         << React << "has not a parameter";
 380             } else
 381                 Diag((*it)->getSourceRange().getBegin(), diag_warning)
 382                     << (*it)->getDeclKindName() << "is not supported as react method";
 383             i++;
 384         }
 385         return false;
 386     }
 387
 388     void HandleReaction(const Type *T, const SourceLocation Loc, CXXRecordDecl *SrcState)
 389     {
 390         // TODO: Improve Loc tracking
 391         if (const ElaboratedType *ET = dyn_cast<ElaboratedType>(T))
 392             HandleReaction(ET->getNamedType().getTypePtr(), Loc, SrcState);
 393         else if (const TemplateSpecializationType *TST = dyn_cast<TemplateSpecializationType>(T)) {
 394             string name = TST->getTemplateName().getAsTemplateDecl()->getQualifiedNameAsString();
 395             if (name == "boost::statechart::transition") {
 396                 const Type *EventType = TST->getArg(0).getAsType().getTypePtr();
 397                 const Type *DstStateType = TST->getArg(1).getAsType().getTypePtr();
 398                 CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
 399                 CXXRecordDecl *DstState = DstStateType->getAsCXXRecordDecl();
 400                 unusedEvents.remove_if(eventHasName(Event->getNameAsString()));
 401
 402                 Model::Transition *T = new Model::Transition(SrcState->getName(), DstState->getName(), Event->getName());
 403                 model.transitions.push_back(T);
 404             } else if (name == "boost::statechart::custom_reaction") {
 405                 const Type *EventType = TST->getArg(0).getAsType().getTypePtr();
 406                 if (!HandleCustomReaction(SrcState, EventType)) {
 407                     Diag(SrcState->getLocation(), diag_missing_reaction) << EventType->getAsCXXRecordDecl()->getName();
 408                 }
 409                 unusedEvents.remove_if(eventHasName(EventType->getAsCXXRecordDecl()->getNameAsString()));
 410             } else if (name == "boost::statechart::deferral") {
 411                 const Type *EventType = TST->getArg(0).getAsType().getTypePtr();
 412                 CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
 413                 unusedEvents.remove_if(eventHasName(Event->getNameAsString()));
 414
 415                 Model::State *s = model.findState(SrcState->getName());
 416                 assert(s);
 417                 s->addDeferredEvent(Event->getName());
 418             } else if (name == "boost::mpl::list") {
 419                 for (TemplateSpecializationType::iterator Arg = TST->begin(), End = TST->end(); Arg != End; ++Arg)
 420                     HandleReaction(Arg->getAsType().getTypePtr(), Loc, SrcState);
 421             } else if (name == "boost::statechart::in_state_reaction") {
 422                 const Type *EventType = TST->getArg(0).getAsType().getTypePtr();
 423                 CXXRecordDecl *Event = EventType->getAsCXXRecordDecl();
 424                 unusedEvents.remove_if(eventHasName(Event->getNameAsString()));
 425
 426                 Model::State *s = model.findState(SrcState->getName());
 427                 assert(s);
 428                 s->addInStateEvent(Event->getName());
 429
 430             } else
 431                 Diag(Loc, diag_unhandled_reaction_type) << name;
 432         } else
 433             Diag(Loc, diag_unhandled_reaction_type) << T->getTypeClassName();
 434     }
 435
 436     void HandleReaction(const NamedDecl *Decl, CXXRecordDecl *SrcState)
 437     {
 438         if (const TypedefDecl *r = dyn_cast<TypedefDecl>(Decl))
 439             HandleReaction(r->getCanonicalDecl()->getUnderlyingType().getTypePtr(),
 440                            r->getLocStart(), SrcState);
 441         else
 442             Diag(Decl->getLocation(), diag_unhandled_reaction_decl) << Decl->getDeclKindName();
 443         checkAllReactMethods(SrcState);
 444     }
 445
 446     TemplateArgumentLoc getTemplateArgLoc(const TypeLoc &T, unsigned ArgNum, bool ignore)
 447     {
 448         if (const ElaboratedTypeLoc ET = T.getAs<ElaboratedTypeLoc>())
 449             return getTemplateArgLoc(ET.getNamedTypeLoc(), ArgNum, ignore);
 450         else if (const TemplateSpecializationTypeLoc TST = T.getAs<TemplateSpecializationTypeLoc>()) {
 451             if (TST.getNumArgs() >= ArgNum+1) {
 452                 return TST.getArgLoc(ArgNum);
 453             } else
 454                 if (!ignore)
 455                     Diag(TST.getBeginLoc(), diag_warning) << TST.getType()->getTypeClassName() << "has not enough arguments" << TST.getSourceRange();
 456         } else
 457             Diag(T.getBeginLoc(), diag_warning) << T.getType()->getTypeClassName() << "type as template argument is not supported" << T.getSourceRange();
 458         return TemplateArgumentLoc();
 459     }
 460
 461     TemplateArgumentLoc getTemplateArgLocOfBase(const CXXBaseSpecifier *Base, unsigned ArgNum, bool ignore) {
 462         return getTemplateArgLoc(Base->getTypeSourceInfo()->getTypeLoc(), ArgNum, ignore);
 463     }
 464
 465     CXXRecordDecl *getTemplateArgDeclOfBase(const CXXBaseSpecifier *Base, unsigned ArgNum, TemplateArgumentLoc &Loc, bool ignore = false) {
 466         Loc = getTemplateArgLocOfBase(Base, ArgNum, ignore);
 467         switch (Loc.getArgument().getKind()) {
 468         case TemplateArgument::Type:
 469             return Loc.getTypeSourceInfo()->getType()->getAsCXXRecordDecl();
 470         case TemplateArgument::Null:
 471             // Diag() was already called
 472             break;
 473         default:
 474             Diag(Loc.getSourceRange().getBegin(), diag_warning) << Loc.getArgument().getKind() << "unsupported kind" << Loc.getSourceRange();
 475         }
 476         return 0;
 477     }
 478
 479     CXXRecordDecl *getTemplateArgDeclOfBase(const CXXBaseSpecifier *Base, unsigned ArgNum, bool ignore = false) {
 480         TemplateArgumentLoc Loc;
 481         return getTemplateArgDeclOfBase(Base, ArgNum, Loc, ignore);
 482     }
 483
 484     void handleSimpleState(CXXRecordDecl *RecordDecl, const CXXBaseSpecifier *Base)
 485     {
 486         int typedef_num = 0;
 487         string name(RecordDecl->getName()); //getQualifiedNameAsString());
 488         Diag(RecordDecl->getLocStart(), diag_found_state) << name;
 489         reactMethodInReactions.clear();
 490
 491         Model::State *state;
 492         // Either we saw a reference to forward declared state
 493         // before, or we create a new state.
 494         if (!(state = model.removeFromUndefinedContexts(name)))
 495             state = new Model::State(name);
 496
 497         CXXRecordDecl *Context = getTemplateArgDeclOfBase(Base, 1);
 498         if (Context) {
 499             Model::Context *c = model.findContext(Context->getName());
 500             if (!c) {
 501                 Model::State *s = new Model::State(Context->getName());
 502                 model.addUndefinedState(s);
 503                 c = s;
 504             }
 505             c->add(state);
 506         }
 507         //TODO support more innitial states
 508         TemplateArgumentLoc Loc;
 509         if (MyCXXRecordDecl *InnerInitialState =
 510             static_cast<MyCXXRecordDecl*>(getTemplateArgDeclOfBase(Base, 2, Loc, true))) {
 511               if (InnerInitialState->isDerivedFrom("boost::statechart::simple_state") ||
 512                 InnerInitialState->isDerivedFrom("boost::statechart::state_machine")) {
 513                   state->setInitialInnerState(InnerInitialState->getName());
 514             }
 515             else if (!InnerInitialState->getNameAsString().compare("boost::mpl::list<>"))
 516               Diag(Loc.getTypeSourceInfo()->getTypeLoc().getBeginLoc(), diag_warning)
 517                     << InnerInitialState->getName() << " as inner initial state is not supported" << Loc.getSourceRange();
 518         }
 519
 520 //          if (CXXRecordDecl *History = getTemplateArgDecl(Base->getType().getTypePtr(), 3))
 521 //              Diag(History->getLocStart(), diag_no_history);
 522
 523         IdentifierInfo& II = ASTCtx->Idents.get("reactions");
 524         // TODO: Lookup for reactions even in base classes - probably by using Sema::LookupQualifiedName()
 525         auto Reactions = RecordDecl->lookup(DeclarationName(&II));
 526         for (auto it = Reactions.begin(), end = Reactions.end(); it != end; ++it, typedef_num++)
 527             HandleReaction(*it, RecordDecl);
 528         if(typedef_num == 0) {
 529             Diag(RecordDecl->getLocStart(), diag_warning)
 530                 << RecordDecl->getName() << "state has no typedef for reactions";
 531             state->setNoTypedef();
 532         }
 533     }
 534
 535     void handleStateMachine(CXXRecordDecl *RecordDecl, const CXXBaseSpecifier *Base)
 536     {
 537         Model::Machine m(RecordDecl->getName());
 538         Diag(RecordDecl->getLocStart(), diag_found_statemachine) << m.name;
 539
 540         if (MyCXXRecordDecl *InitialState =
 541             static_cast<MyCXXRecordDecl*>(getTemplateArgDeclOfBase(Base, 1)))
 542             m.setInitialState(InitialState->getName());
 543         model.add(m);
 544     }
 545
 546     bool VisitCXXRecordDecl(CXXRecordDecl *Declaration)
 547     {
 548         if (!Declaration->isCompleteDefinition())
 549             return true;
 550         if (Declaration->getQualifiedNameAsString() == "boost::statechart::state" ||
 551             Declaration->getQualifiedNameAsString() == "TimedState" ||
 552             Declaration->getQualifiedNameAsString() == "TimedSimpleState" ||
 553             Declaration->getQualifiedNameAsString() == "boost::statechart::assynchronous_state_machine")
 554             return true; // This is an "abstract class" not a real state or real state machine
 555
 556         MyCXXRecordDecl *RecordDecl = static_cast<MyCXXRecordDecl*>(Declaration);
 557         const CXXBaseSpecifier *Base;
 558
 559         if (RecordDecl->isDerivedFrom("boost::statechart::simple_state", &Base))
 560             handleSimpleState(RecordDecl, Base);
 561         else if (RecordDecl->isDerivedFrom("boost::statechart::state_machine", &Base))
 562             handleStateMachine(RecordDecl, Base);
 563         else if (RecordDecl->isDerivedFrom("boost::statechart::event")) {
 564             // Mark the event as unused until we found that somebody uses it
 565             unusedEvents.push_back(eventModel(RecordDecl->getNameAsString(), RecordDecl->getLocation()));
 566         }
 567         return true;
 568     }
 569     void printUnusedEventDefinitions() {
 570         for(list<eventModel>::iterator it = unusedEvents.begin(); it!=unusedEvents.end(); it++)
 571             Diag((*it).loc, diag_warning)
 572                 << (*it).name << "event defined but not used in any state";
 573     }
 574 };
 575
 576
 577 class VisualizeStatechartConsumer : public clang::ASTConsumer
 578 {
 579     Model::Model model;
 580     Visitor visitor;
 581     string destFileName;
 582 public:
 583     explicit VisualizeStatechartConsumer(ASTContext *Context, std::string destFileName,
 584                                          DiagnosticsEngine &D)
 585         : visitor(Context, model, D), destFileName(destFileName) {}
 586
 587     virtual void HandleTranslationUnit(clang::ASTContext &Context) {
 588         visitor.TraverseDecl(Context.getTranslationUnitDecl());
 589         visitor.printUnusedEventDefinitions();
 590         model.write_as_dot_file(destFileName);
 591     }
 592 };
 593
 594 class VisualizeStatechartAction : public PluginASTAction
 595 {
 596 protected:
 597     std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI, llvm::StringRef) {
 598     size_t dot = getCurrentFile().find_last_of('.');
 599     std::string dest = getCurrentFile().substr(0, dot);
 600     dest.append(".dot");
 601     return std::unique_ptr<ASTConsumer>( new VisualizeStatechartConsumer(&CI.getASTContext(), dest, CI.getDiagnostics()) );
 602   }
 603
 604   bool ParseArgs(const CompilerInstance &CI,
 605                  const std::vector<std::string>& args) {
 606     for (unsigned i = 0, e = args.size(); i != e; ++i) {
 607       llvm::errs() << "Visualizer arg = " << args[i] << "\n";
 608
 609       // Example error handling.
 610       if (args[i] == "-an-error") {
 611         DiagnosticsEngine &D = CI.getDiagnostics();
 612         unsigned DiagID = D.getCustomDiagID(
 613           DiagnosticsEngine::Error, "invalid argument '%0' expected '%1'");
 614         D.Report(DiagID);
 615         return false;
 616       }
 617     }
 618     if (args.size() && args[0] == "help")
 619       PrintHelp(llvm::errs());
 620
 621     return true;
 622   }
 623   void PrintHelp(llvm::raw_ostream& ros) {
 624     ros << "Help for Visualize Statechart plugin goes here\n";
 625   }
 626
 627 };
 628
 629 static FrontendPluginRegistry::Add<VisualizeStatechartAction> X("visualize-statechart", "visualize statechart");
 630
 631 // Local Variables:
 632 // c-basic-offset: 4
 633 // End: