]> rtime.felk.cvut.cz Git - boost-statechart-viewer.git/blobdiff - src/visualizer.cpp
Rewrite - get all information from AST instead of manually parsing certain declarations
[boost-statechart-viewer.git] / src / visualizer.cpp
index 711261188dd91aab01cec365362c29a351481f67..20105b660e64a01594be5cb42fa64542bf902bb8 100644 (file)
 ////////////////////////////////////////////////////////////////////////////////////////
 
 //standard header files
-#include <iostream>
+#include <fstream>
 
 //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"
-
-#include "clang/Frontend/FrontendPluginRegistry.h"
 #include "clang/AST/ASTConsumer.h"
-#include "clang/AST/AST.h"
+#include "clang/AST/CXXInheritance.h"
+#include "clang/AST/RecursiveASTVisitor.h"
 #include "clang/Frontend/CompilerInstance.h"
-#include "llvm/Support/raw_ostream.h"
-
-//my own header files
-#include "iooper.h"
+#include "clang/Frontend/FrontendPluginRegistry.h"
 
 using namespace clang;
-using namespace clang::driver;
 using namespace std;
 
-/**
- * This class provides Simple diagnostic Client. It uses implementation in library for printing diagnostci information.
- * Also it counts number of warnings, errors, ... When an error occurs the program is stopped.
- */
-class MyDiagnosticClient : public TextDiagnosticPrinter
+class Statechart
 {
-       int nwarnings; /** Save number of Warnings occured during diagnostic */
-       int nnotes;
-       int nignored;
-       int nerrors;
-       public:
-   /**
-    * Initialize number of warnings, errors, ...
-    */
-   MyDiagnosticClient(llvm::raw_ostream &os, const DiagnosticOptions &diags, bool OwnsOutputStream = false):TextDiagnosticPrinter(os, diags, OwnsOutputStream = false)
-       {
-               nwarnings=0;
-               nnotes=0;
-               nignored=0;
-               nerrors = 0;
-       }
-   /**
-     * This method prints diagnostic and counts diagnostic types.
-     */
-       virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, const Diagnostic &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);
-               }
-       }
-   /**
-     * Print statistics about diagnostic.
-     */
-       void print_stats()
-       {
-               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";
-       }
-
-       int getNbrOfWarnings() /** Return number of warnings */
-       {
-               return nwarnings;
-       }
-
-       int getNbrOfNotes() /** Return number of notes */
-       {
-               return nnotes;
-       }
-
-       int getNbrOfIgnored() /** Return number of ignored */
-       {
-               return nignored;
-       }
+public:
+    class Transition
+    {
+    public:
+       string src, dst, event;
+       Transition(string src, string dst, string event) : src(src), dst(dst), event(event) {}
+    };
+    string name;
+    string name_of_start;
+    list<Transition> transitions;
+    list<string> cReactions; /** list of custom reactions. After all files are traversed this list should be empty. */
+    list<string> events;
+    list<string> states;
+
+    void write_dot_file(string fn)
+    {
+       ofstream f(fn.c_str());
+       f << "digraph " << name << " {\n";
+       for (string& s : states) {
+           f << "  " << s << "\n";
+       }
+
+       for (Transition &t : transitions) {
+           f << t.src << " -> " << t.dst << " [label = \"" << t.event << "\"]\n";
+       }
+
+       f << "}";
+    }
 };
 
-/**
- * My ASTConsumer provides interface for traversing AST. It uses recursive traversing in namespaces.
- */
-class FindStates : public ASTConsumer
-{
-       list<string> transitions;
-       list<string> cReactions; /** list of custom reactions. After all files are traversed this list should be empty. */
-       list<string> events;
-       list<string> states;
-       string name_of_machine;
-       string name_of_start;
-       string dest;
-       FullSourceLoc *fsloc; /** Full Source Location instance for holding Source Manager. */
-       public:
-
-       FindStates(string dest) : dest(dest) {}
-
-       list<string> getStates() /** Return list of states of the state machine. */
-       {
-               return states;
-       }
 
-       list<string> getTransitions() /** Return list of transitions. */
-       {
-               return transitions;
-       }
+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;
+    }
 
-       list<string> getEvents() /** Return list of events. */
-       {
-               return events;
-       }
+public:
+    bool isDerivedFrom(const char *baseStr) const {
+       CXXBasePaths Paths(/*FindAmbiguities=*/false, /*RecordPaths=*/false, /*DetectVirtual=*/false);
+       Paths.setOrigin(const_cast<MyCXXRecordDecl*>(this));
+       return lookupInBases(&FindBaseClassString, const_cast<char*>(baseStr), Paths);
+    }
+};
 
-       string getStateMachine() /** Return name of the state machine. */
-       {
-               return name_of_machine;
-       }
 
-       string getNameOfFirstState() /** Return name of start state. */
-       {
-               return name_of_start;
+class Visitor : public RecursiveASTVisitor<Visitor>
+{
+    ASTContext *Context;
+    Statechart &sc;
+public:
+    bool shouldVisitTemplateInstantiations() const { return true; }
+
+    explicit Visitor(ASTContext *Context, Statechart &sc)
+       : Context(Context), sc(sc) {}
+
+    void HandleReaction(const Type *T, CXXRecordDecl *SrcState)
+    {
+       if (const ElaboratedType *ET = dyn_cast<ElaboratedType>(T))
+           HandleReaction(ET->getNamedType().getTypePtr(), 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();
+
+               sc.transitions.push_back(Statechart::Transition(SrcState->getName(), DstState->getName(),
+                                                               Event->getName()));
+               //llvm::errs() << EventRec->getName() <<  << "\n";
+           } else if (name == "boost::mpl::list") {
+               for (TemplateSpecializationType::iterator Arg = TST->begin(), End = TST->end(); Arg != End; ++Arg)
+                   HandleReaction(Arg->getAsType().getTypePtr(), SrcState);
+           }
+           //->getDecl()->getQualifiedNameAsString();
+       } else {
+           llvm::errs() << "Unhandled reaction Type: " << T->getTypeClassName() << "\n";
+           assert(0);
        }
+    }
 
-       virtual void Initialize(ASTContext &ctx)/** Run after the AST is constructed before the consumer starts to work. So this function works like constructor. */
-       {
-               fsloc = new FullSourceLoc(* new SourceLocation(), ctx.getSourceManager());
-               name_of_start = "";
-               name_of_machine = "";
+    void HandleReaction(const NamedDecl *Decl, CXXRecordDecl *SrcState)
+    {
+       if (const TypedefDecl *r = dyn_cast<TypedefDecl>(Decl))
+           HandleReaction(r->getCanonicalDecl()->getUnderlyingType().getTypePtr(), SrcState);
+       else {
+           llvm::errs() << "Unhandled reaction Decl: " << Decl->getDeclKindName() << "\n";
+           assert(0);
        }
+    }
 
-/**
-*   Traverse global decls using DeclGroupRef for handling all global decls. But only interesting decls are processed. Interesting decls are Struct, Class, C++ methods and Namespace.
-*   When Namespace is found it recursively traverse all decls inside this Namespace using method recursive_visit.
-*/
-       virtual bool HandleTopLevelDecl(DeclGroupRef DGR)
-       {
-               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(dyn_cast<FunctionDecl>(decl))
-                               {
-                                       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 = "";
-               }
-               return true;
-       }
 
-/**
-*   It is used to recursive traverse decls in Namespaces. This method do the same as HandleTopLevelDecl.
-*/
-       void recursive_visit(const DeclContext *declCont)
-       {
-               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(dyn_cast<FunctionDecl>(decl))
-                               {
-                                       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 = "";
-               }
-       }
+    bool VisitCXXRecordDecl(CXXRecordDecl *Declaration)
+    {
+       if (!Declaration->isCompleteDefinition())
+           return true;
 
-/**
-*      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)
-       {
-               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());
-                               }
-                       }
-               }
-       }
+       MyCXXRecordDecl *StateDecl = static_cast<MyCXXRecordDecl*>(Declaration);
 
-/**
-*      This function provides traversing all methods and other context indide class. If
-*      typedef or classic method decl is found. If typedef is found then it is being testted for transitions and custom reactions.
-*/
-       void methods_in_class(const Decl *decl, const string state)
+       if (StateDecl->isDerivedFrom("boost::statechart::simple_state"))
        {
-               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="";
-               std::cout<<"Found state: "<<state<<std::endl;
-               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 (dyn_cast<FunctionDecl>(*i)) method_decl(*i);// C++ method
-               }
+           string state(StateDecl->getName()); //getQualifiedNameAsString());
+           llvm::errs() << "Found state " << state << "\n";
+           sc.states.push_back(state);
 
+           IdentifierInfo& II = Context->Idents.get("reactions");
+           for (DeclContext::lookup_result Reactions = StateDecl->lookup(DeclarationName(&II));
+                Reactions.first != Reactions.second; ++Reactions.first)
+               HandleReaction(*Reactions.first, StateDecl);
        }
-
- /**
-   * Traverse method declaration using classes with main class Stmt.
-   */
-       void method_decl(const Decl *decl)
+       else if (StateDecl->isDerivedFrom("boost::statechart::state_machine"))
        {
-               const FunctionDecl *fDecl = dyn_cast<FunctionDecl>(decl);
-               string output, line, event;
-               llvm::raw_string_ostream x(output);
-
-               if(fDecl->hasBody() && fDecl->getNumParams() > 0)
-               {
-                       decl->print(x);
-                       line = get_return(x.str());
-                       if(get_model(line)==5)
-                       {
-                               //std::cout<<"metodass"<<std::endl;
-                               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;
-                                       }
-                               }
-                       }
-               }
+           sc.name = StateDecl->getQualifiedNameAsString();
+           sc.name_of_start = "tmp"; //StateDecl->getStateMachineInitialStateAsString()
+           llvm::errs() << "Found state_machine " << sc.name << "\n";
        }
-
-       void find_return_stmt(Stmt *statemt,string event) /** Traverse all statements in function for finding all return Statements.*/
+       else if (StateDecl->isDerivedFrom("boost::statechart::event"))
        {
-               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);
-                       }
-               }
+           sc.events.push_back(StateDecl->getNameAsString());
        }
+       return true;
+    }
+};
 
-       void test_stmt(Stmt *stmt, string event) /** test statement for its kind Using number as identifier for all Statement Classes.*/
-       {
-               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(get_model(line)==6)
-                                               {
-                                                       param = get_params(line);
-                                                       transitions.push_back(event.append(",").append(param));
-                                               }
-                                               if(get_model(line) == 7)
-                                               {
-                                                       param = ",";
-                                                       transitions.push_back(param.append(event));
-                                               }
-                                               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;
-               }
-       }
 
-  virtual void HandleTranslationUnit(clang::ASTContext &Context) {
-    IO_operations io(dest, getStateMachine(), getNameOfFirstState(), getTransitions(), getStates(), getEvents());
-    io.save_to_file();
-    io.print_stats();
-  }
+class VisualizeStatechartConsumer : public clang::ASTConsumer
+{
+    Statechart statechart;
+    Visitor visitor;
+    string destFileName;
+public:
+    explicit VisualizeStatechartConsumer(ASTContext *Context, std::string destFileName)
+       : visitor(Context, statechart), destFileName(destFileName) {}
+
+    virtual void HandleTranslationUnit(clang::ASTContext &Context) {
+       visitor.TraverseDecl(Context.getTranslationUnitDecl());
+       statechart.write_dot_file(destFileName);
+    }
 };
 
-class VisualizeStatechartAction : public PluginASTAction {
+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 FindStates(dest);
+    return new VisualizeStatechartConsumer(&CI.getASTContext(), dest);
   }
 
   bool ParseArgs(const CompilerInstance &CI,
@@ -469,3 +221,7 @@ protected:
 };
 
 static FrontendPluginRegistry::Add<VisualizeStatechartAction> X("visualize-statechart", "visualize statechart");
+
+// Local Variables:
+// c-basic-offset: 4
+// End: