]> rtime.felk.cvut.cz Git - boost-statechart-viewer.git/blobdiff - src/visualizer.cpp
Add some commentaries to file.
[boost-statechart-viewer.git] / src / visualizer.cpp
index 6f8caff81a58159cb1cbdd06af61a7fdd89df6d9..df84796fd1cac954728ba07f0bcdb938164f5ffe 100644 (file)
@@ -20,9 +20,6 @@
 
 //standard header files
 #include <iostream>
-#include <string>
-#include <fstream>
-#include <list>
 
 //LLVM Header files
 #include "llvm/Support/raw_ostream.h"
 #include "clang/Driver/Compilation.h"
 
 //my own header files
-#include "stringoper.h"
+#include "iooper.h"
 
 using namespace clang;
 using namespace clang::driver;
 using namespace std;
 
-class MyDiagnosticClient : public TextDiagnosticPrinter // My diagnostic Client
+class MyDiagnosticClient : public TextDiagnosticPrinter // Diagnostic Client
 {
+       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){}
+       MyDiagnosticClient(llvm::raw_ostream &os, const DiagnosticOptions &diags, bool OwnsOutputStream = false):TextDiagnosticPrinter(os, diags, OwnsOutputStream = false)
+       {
+               nwarnings=0;
+               nnotes=0;
+               nignored=0;
+               nerrors = 0;
+       }
        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);
-               }       
+               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);
+               }
+       }
+       
+       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";
+       }
+       
+       int getNbrOfWarnings() // get number of warnings
+       {
+               return nwarnings;               
+       }
+       
+       int getNbrOfNotes() // get number of notes
+       {
+               return nnotes;          
+       }
+
+       int getNbrOfIgnored() // get number of ignored
+       {
+               return nignored;                
        }
 };
 
-class FindStates : public ASTConsumer
+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;
-       int nbrStates;
        FullSourceLoc *fsloc;
        public:
-       list<string> states;
+
+       list<string> getStates()
+       {
+               return states;
+       }
+       
+       list<string> getTransitions()
+       {
+               return transitions;
+       }
+               
+       list<string> getEvents()
+       {
+               return events;
+       }
+
+       string getStateMachine()
+       {
+               return name_of_machine;
+       }
+
+       string getNameOfFirstState()
+       {
+               return name_of_start;
+       }
        
        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;
        }
 
+/*
+       Traverse global decls using DeclGroupRef for handling all global decls.
+*/
        virtual void HandleTopLevelDecl(DeclGroupRef DGR)// traverse all top level declarations
        {
                SourceLocation loc;
@@ -96,7 +159,6 @@ class FindStates : public ASTConsumer
                        loc = decl->getLocation();
                        if(loc.isValid())
                        {
-                               //cout<<decl->getKind()<<"ss\n";
                                if(decl->getKind()==35)
                                {                                       
                                        method_decl(decl);
@@ -120,6 +182,10 @@ class FindStates : public ASTConsumer
                        output = "";
                }
        }
+
+/*
+       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;
@@ -154,6 +220,10 @@ class FindStates : public ASTConsumer
                } 
        }
                
+/*
+       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; 
@@ -162,7 +232,7 @@ class FindStates : public ASTConsumer
                line = get_line_of_code(x.str());
                output = "";
                int pos;
-               const NamedDecl *namedDecl = dyn_cast<NamedDecl>(decl);         
+               const NamedDecl *namedDecl = dyn_cast<NamedDecl>(decl);
                if(is_derived(line))
                {
                        const CXXRecordDecl *cRecDecl = dyn_cast<CXXRecordDecl>(decl);
@@ -186,7 +256,7 @@ class FindStates : public ASTConsumer
                        }
                        else
                        {
-                               ret = find_states(cRecDecl, line);      
+                               ret = find_states(cRecDecl, line); 
                                if(!ret.empty())
                                {       
                                        cout << "New state: " << namedDecl->getNameAsString() << "\n";
@@ -197,19 +267,21 @@ class FindStates : public ASTConsumer
                }
        }
 
-       void methods_in_class(const Decl *decl, const string state)
+/* 
+       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);              
-               //states.push_back(namedDecl->getNameAsString());
-               
+               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) 
+                       if (i->getKind()==26) // typedefs
                        {
                                i->print(x);
                                output = x.str();
@@ -234,17 +306,16 @@ class FindStates : public ASTConsumer
                                                        if(pos==-1) transitions.push_back(ret);
                                                        else transitions.push_back(ret.substr(0,pos));
                                                }
-                                               //cout<<ret<<"\n";
                                                if(i!=num-1) ret = ret.substr(pos+1);
                                        }
                                        output="";
                                }
                        }
-                       if(i->getKind()==35) method_decl(decl);
+                       if(i->getKind()==35) method_decl(decl);// C++ method
                }
        }
 
-       void method_decl(const Decl *decl)
+       void method_decl(const Decl *decl) // method decl traverse. Using Stmt
        {
                string output, line, event;     
                llvm::raw_string_ostream x(output);
@@ -265,7 +336,7 @@ class FindStates : public ASTConsumer
                                line.append(",");
                                line.append(event);
                                find_return_stmt(decl->getBody(),line); 
-                               for(list<string>::iterator i = cReactions.begin();i!=cReactions.end();i++)
+                               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) 
@@ -278,7 +349,7 @@ class FindStates : public ASTConsumer
                }
        }
 
-       void find_return_stmt(Stmt *statemt,string event)
+       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
@@ -290,7 +361,7 @@ class FindStates : public ASTConsumer
                }
        }
        
-       void test_stmt(Stmt *stmt, string event)
+       void test_stmt(Stmt *stmt, string event) // test statement
        {
                const SourceManager &sman = fsloc->getManager();
                int type;
@@ -322,105 +393,7 @@ class FindStates : public ASTConsumer
                                                        break;
                        case 102 :      find_return_stmt(dyn_cast<WhileStmt>(stmt)->getBody(), event); // while
                                                        break;
-                       }
-       }
-
-       void save_to_file(string output) // save all to the output file
-       {
-               nbrStates = states.size();
-               string state, str, context, ctx;
-               int pos1, pos2, cnt, subs;
-               ofstream filestr(output.c_str());
-               //std::cout<<output<<"\n";
-               filestr<<"digraph "<< name_of_machine<< " {\n";
-               context = name_of_machine;
-               for(list<string>::iterator i = states.begin();i!=states.end();i++) // write all states in the context of the automaton
-               {
-                       state = *i;
-                       cnt = count(state,',');
-                       if(cnt==1)
-                       {
-                               pos1 = state.find(",");
-                               ctx = cut_namespaces(state.substr(pos1+1));
-                               //std::cout<<name_of_machine.length();                          
-                               if(ctx.compare(0,context.length(),context)==0)
-                               {
-                                       filestr<<cut_namespaces(state.substr(0,pos1))<<";\n";
-                                       states.erase(i);
-                                       i--;
-                               }
-                       }
-                       if(cnt==2)
-                       {
-                               pos1 = state.find(",");
-                               pos2 = state.rfind(",");
-                               ctx = cut_namespaces(state.substr(pos1+1,pos2-pos1-1));
-                               //std::cout<<ctx<<" "<<context<<"\n";
-                               if(ctx.compare(0,context.length(),context)==0)
-                               {                               
-                                       filestr<<cut_namespaces(state.substr(0,pos1))<<";\n";
-                               }
-                       }
                }
-               filestr<<name_of_start<<" [peripheries=2] ;\n";
-               subs = 0;
-               while(!states.empty()) // substates ?
-               {
-                       state = states.front();
-                       filestr<<"subgraph cluster"<<subs<<" {\n";                      
-                       pos1 = state.find(",");
-                       pos2 = state.rfind(",");
-                       context = cut_namespaces(state.substr(0,pos1));
-                       filestr<<"label=\""<<context<<"\";\n";
-                       filestr<<cut_namespaces(state.substr(pos2+1))<<" [peripheries=2] ;\n";  
-                       states.pop_front();     
-                       //std::cout<<states.size();     
-                       for(list<string>::iterator i = states.begin();i!=states.end();i++)
-                       {
-                               state = *i;
-                               cnt = count(state,',');
-                               //std::cout<<state<<" \n";
-                               if(cnt==1)
-                               {
-                                       pos1 = state.find(",");
-                                       ctx = cut_namespaces(state.substr(pos1+1));
-                                       if(ctx.compare(0,context.length(),context)==0)
-                                       {
-                                               filestr<<cut_namespaces(state.substr(0,pos1))<<";\n";
-                                               states.erase(i);
-                                               i--;
-                                       }
-                               }
-                               if(cnt==2)
-                               {
-                                       pos1 = state.find(",");
-                                       pos2 = state.rfind(",");
-                                       ctx = cut_namespaces(state.substr(pos1+1,pos2-pos1-1));
-                                       if(ctx.compare(0,context.length(),context)==0) filestr<<cut_namespaces(state.substr(0,pos1))<<";\n";
-                               }
-                       }
-                       filestr<<"}\n";
-                       subs+=1;        
-               }               
-               for(list<string>::iterator i = transitions.begin();i!=transitions.end();i++) // write all transitions
-               {
-                       state = *i;
-                       pos1 = state.find(",");
-                       filestr<<cut_namespaces(state.substr(0,pos1))<<"->";
-                       pos2 = state.rfind(",");
-                       filestr<<cut_namespaces(state.substr(pos2+1));
-                       filestr<<"[label=\""<<cut_namespaces(state.substr(pos1+1,pos2-pos1-1))<<"\"];\n";
-               }               
-               filestr<<"}";
-               filestr.close();
-       }
-       void print_stats() // print statistics
-       {
-               cout<<"\n"<<"Statistics: \n";
-               cout<<"Number of states: "<<nbrStates<<"\n";
-               cout<<"Number of events: "<<events.size()<<"\n";
-               cout<<"Number of transitions: "<<transitions.size()<<"\n";
-               return;
        }
 
 };
@@ -494,8 +467,9 @@ int main(int argc, char **argv)
        mdc->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();
+       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;
 }