-
+/** @file */
////////////////////////////////////////////////////////////////////////////////////////
//
// This file is part of Boost Statechart Viewer.
using namespace clang::driver;
using namespace std;
-class MyDiagnosticClient : public TextDiagnosticPrinter // Diagnostic Client
+/**
+ * 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
{
- int nwarnings;
+ int nwarnings; /** Save number of Warnings occured during diagnostic */
int nnotes;
int nignored;
int nerrors;
public:
- 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.
+ */
virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, const DiagnosticInfo &Info)
{
TextDiagnosticPrinter::HandleDiagnostic(DiagLevel, Info); // print diagnostic information using library implementation
exit(1);
}
}
-
- void print_stats() // print statistics about diagnostic
+ /**
+ * Print statistics about diagnostic.
+ */
+ void print_stats()
{
cout<<"\n--Diagnostic Info--\n";
cout<<"Number of ignored: "<<nignored<<"\n";
cout<<"Number of errors and fatal errors: "<<nerrors<<"\n";
}
- int getNbrOfWarnings() // get number of warnings
+ int getNbrOfWarnings() /** Return number of warnings */
{
return nwarnings;
}
- int getNbrOfNotes() // get number of notes
+ int getNbrOfNotes() /** Return number of notes */
{
return nnotes;
}
- int getNbrOfIgnored() // get number of ignored
+ int getNbrOfIgnored() /** Return number of ignored */
{
return nignored;
}
};
-class FindStates : public ASTConsumer // AST Consumer interface for traversing AST
+/**
+ * My ASTConsumer provides interface for traversing AST. It uses recursive traversing in namespaces.
+ */
+class FindStates : public ASTConsumer
{
- // lists for saving information about state machine
- 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()
+ list<string> getStates() /** Return list of states of the state machine. */
{
return states;
}
- list<string> getTransitions()
+ list<string> getTransitions() /** Return list of transitions. */
{
return transitions;
}
- list<string> getEvents()
+ list<string> getEvents() /** Return list of events. */
{
return events;
}
- string getStateMachine()
+ string getStateMachine() /** Return name of the state machine. */
{
return name_of_machine;
}
- string getNameOfFirstState()
+ 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
+ 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 = "";
}
-/*
- Traverse global decls using DeclGroupRef for handling all global decls.
+/**
+* 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)// traverse all top level declarations
+ virtual void HandleTopLevelDecl(DeclGroupRef DGR)
{
SourceLocation loc;
string line, output, event;
}
}
-/*
- It is used to recursive traverse decls in namespaces.
+/**
+* It is used to recursive traverse decls in Namespaces. This method do the same as HandleTopLevelDecl.
*/
- void recursive_visit(const DeclContext *declCont) //recursively visit all decls hidden inside namespaces
+ 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)
}
}
-/*
- This function works with class or struct. It splits the decl into 3 interesting parts.
- The state machine decl, state decl and event decl.
+/**
+* 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
+ 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);
}
}
-/*
- 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.
+/**
+* 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) // traverse context inside one class
+ void methods_in_class(const Decl *decl, const string state)
{
string output, line, ret, trans, event;
llvm::raw_string_ostream x(output);
const TagDecl *tagDecl = dyn_cast<TagDecl>(decl);
const DeclContext *declCont = tagDecl->castToDeclContext(tagDecl);
output="";
+ std::cout<<state<<std::endl;
for (DeclContext::decl_iterator i = declCont->decls_begin(), e = declCont->decls_end(); i != e; ++i)
{
+ i->print(x);
if (i->getKind()==26) // typedefs
{
- i->print(x);
output = x.str();
line = clean_spaces(cut_type(output));
ret = find_transitions(state,line);
output="";
}
}
- if(i->getKind()==35) method_decl(decl);// C++ method
+ if(i->getKind()==35) method_decl(*i);// C++ method
}
+
}
- void method_decl(const Decl *decl) // method decl traverse. Using Stmt
+ /**
+ * 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);
+
if(decl->hasBody())
{
decl->print(x);
- line = get_return(x.str());
- if(test_model(line,"result"))
+ line = get_return(x.str());
+ if(get_model(line)==5)
{
+ //std::cout<<"metodass"<<std::endl;
const FunctionDecl *fDecl = dyn_cast<FunctionDecl>(decl);
const ParmVarDecl *pvd = fDecl->getParamDecl(0);
- QualType qt = pvd->getOriginalType();
+ 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);
}
}
- 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
}
}
- void test_stmt(Stmt *stmt, string event) // test statement
+ 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;
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"))
+ 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;
}
};
-
+/**
+ * Main function provides all initialization before starting analysis of AST. Diagnostic Client is initialized,
+ * Command line options are processed.
+ */
int main(int argc, char **argv)
{
+ if(argc==1 || strncmp(argv[1],"-help",5)==0)
+ {
+ cout<<endl<<" Boost Statechart Viewer - help"<<endl;
+ cout<<"================================"<<endl;
+ cout<<"The program can be used almost the same way as a C compiler. You will typically need to specify locations for all header files except of the files stored in system folder(in Linux: /usr/...) using -I option. Of course you can specify the output filename (-o option). Program displays all diagnostic messages like compilers. If an error occurs the program stops."<<endl<<endl;
+ return 0;
+ }
string inputFilename = "";
string outputFilename = "graph.dot"; // initialize output Filename
DiagnosticOptions dopts;
projects / boost-statechart-viewer.git / blobdiff