]> rtime.felk.cvut.cz Git - boost-statechart-viewer.git/blobdiff - src/visualizer.cpp
Create dir for MSVC version source files. Update commentaries at source files.
[boost-statechart-viewer.git] / src / visualizer.cpp
index 4616906dcd355af36f57a9f7f797d38d0654b748..475682ba96e5544a3971fe61442537bf5d507819 100644 (file)
@@ -1,4 +1,4 @@
-/** @file */
+/** @file */ 
 ////////////////////////////////////////////////////////////////////////////////////////  
 //    
 //    This file is part of Boost Statechart Viewer.
@@ -54,27 +54,24 @@ using namespace std;
  */
 class MyDiagnosticClient : public TextDiagnosticPrinter
 {
-        /**
-          * Variables for saving numbers of warnings, errors, ...
-          */
-       int nwarnings;
+       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)
+   /**
+    * 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.
-         */
+   /**
+     * This method prints diagnostic and counts diagnostic types.
+     */
        virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, const DiagnosticInfo &Info)
        {
                TextDiagnosticPrinter::HandleDiagnostic(DiagLevel, Info); // print diagnostic information using library implementation
@@ -88,10 +85,10 @@ class MyDiagnosticClient : public TextDiagnosticPrinter
                                                 exit(1);
                }
        }
-        /**
-         * Print statistics about diagnostic
-         */
-        void print_stats()
+   /**
+     * Print statistics about diagnostic.
+     */
+       void print_stats()
        {
                cout<<"\n--Diagnostic Info--\n";
                cout<<"Number of ignored: "<<nignored<<"\n";
@@ -100,17 +97,17 @@ class MyDiagnosticClient : public TextDiagnosticPrinter
                cout<<"Number of errors and fatal errors: "<<nerrors<<"\n";
        }
        
-        int getNbrOfWarnings() /** Return number of warnings */
+       int getNbrOfWarnings() /** Return number of warnings */
        {
                return nwarnings;               
        }
        
-        int getNbrOfNotes() /** Return number of notes */
+       int getNbrOfNotes() /** Return number of notes */
        {
                return nnotes;          
        }
 
-        int getNbrOfIgnored() /** Return number of ignored */
+       int getNbrOfIgnored() /** Return number of ignored */
        {
                return nignored;                
        }
@@ -121,41 +118,41 @@ class MyDiagnosticClient : public TextDiagnosticPrinter
  */
 class FindStates : public ASTConsumer
 {
-       list<string> transitions;
-       list<string> cReactions;
+       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;
-       FullSourceLoc *fsloc;
+       FullSourceLoc *fsloc; /** Full Source Location instance for holding Source Manager. */
        public:
 
-        list<string> getStates() /** Return list of states. */
+       list<string> getStates() /** Return list of states. */
        {
                return states;
        }
        
-        list<string> getTransitions() /** Return list of transitions. */
+       list<string> getTransitions() /** Return list of transitions. */
        {
                return transitions;
        }
                
-        list<string> getEvents() /** Return list of events. */
+       list<string> getEvents() /** Return list of events. */
        {
                return events;
        }
 
-        string getStateMachine() /** Return name of the state machine. */
+       string getStateMachine() /** Return name of the state machine. */
        {
                return name_of_machine;
        }
 
-        string getNameOfFirstState() /** Return name of start state. */
+       string getNameOfFirstState() /** Return name of start state. */
        {
                return name_of_start;
        }
        
-        virtual void Initialize(ASTContext &ctx)/** Run after the AST is constructed before the consumer starts to work. So this function works like constructor. */
+       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 = "";
@@ -163,10 +160,10 @@ class FindStates : public ASTConsumer
        }
 
 /**
-*   Traverse global decls using DeclGroupRef for handling all global decls. But only interesting decls are processed. Interesting decls are Struct, Class, Method and Namespace.
+*   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 void HandleTopLevelDecl(DeclGroupRef DGR)
+       virtual void HandleTopLevelDecl(DeclGroupRef DGR)
        {
                SourceLocation loc;
                string line, output, event;
@@ -203,9 +200,9 @@ class FindStates : public ASTConsumer
 /**
 *   It is used to recursive traverse decls in Namespaces. This method do the same as HandleTopLevelDecl.
 */
-        void recursive_visit(const DeclContext *declCont)
+       void recursive_visit(const DeclContext *declCont)
        {
-                string line, output, event;
+               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)
@@ -239,7 +236,7 @@ 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)
+       void struct_class(const Decl *decl)
        {
                string output, line, ret, trans, event; 
                llvm::raw_string_ostream x(output);
@@ -280,9 +277,9 @@ class FindStates : public ASTConsumer
 
 /**
 *      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.
+*      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)
+       void methods_in_class(const Decl *decl, const string state)
        {
                string output, line, ret, trans, event; 
                llvm::raw_string_ostream x(output);
@@ -326,10 +323,10 @@ class FindStates : public ASTConsumer
                }
        }
 
       /**
-         * Traverse Method declaration using classes Stmt.
-         */
-        void method_decl(const Decl *decl)
+ /**
+   * Traverse method declaration using classes with main class Stmt.
+   */
+       void method_decl(const Decl *decl)
        {
                string output, line, event;     
                llvm::raw_string_ostream x(output);
@@ -363,7 +360,7 @@ class FindStates : public ASTConsumer
                }
        }
 
-        void find_return_stmt(Stmt *statemt,string event) /** Traverse all statements in function for finding return Statement*/
+       void find_return_stmt(Stmt *statemt,string event) /** Traverse all statements in function for finding all return Statements.*/
        {
                if(statemt->getStmtClass() == 99) test_stmt(dyn_cast<CaseStmt>(statemt)->getSubStmt(), event);
                else
@@ -375,7 +372,7 @@ class FindStates : public ASTConsumer
                }
        }
        
-        void test_stmt(Stmt *stmt, string event) /** test statement for its kind*/
+       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;