-
+/** @file */
////////////////////////////////////////////////////////////////////////////////////////
//
// This file is part of Boost Statechart Viewer.
using namespace clang::driver;
using namespace std;
-class MyDiagnosticClient : public TextDiagnosticPrinter // My 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
- switch (DiagLevel)
+ 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;
exit(1);
}
}
-
+ /**
+ * Print statistics about diagnostic.
+ */
void print_stats()
{
cout<<"\n--Diagnostic Info--\n";
cout<<"Number of errors and fatal errors: "<<nerrors<<"\n";
}
- int getNbrOfWarnings()
+ int getNbrOfWarnings() /** Return number of warnings */
{
return nwarnings;
}
- int getNbrOfNotes()
+ int getNbrOfNotes() /** Return number of notes */
{
return nnotes;
}
- int getNbrOfIgnored()
+ int getNbrOfIgnored() /** Return number of ignored */
{
return nignored;
}
};
+/**
+ * My ASTConsumer provides interface for traversing AST. It uses recursive traversing in namespaces.
+ */
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()
+ list<string> getStates() /** Return list of states. */
{
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 = "";
}
- virtual void HandleTopLevelDecl(DeclGroupRef DGR)// traverse all top level declarations
+/**
+* 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)
{
SourceLocation loc;
- string line, output, event;
+ string line, output, event;
llvm::raw_string_ostream x(output);
for (DeclGroupRef::iterator i = DGR.begin(), e = DGR.end(); i != e; ++i)
{
loc = decl->getLocation();
if(loc.isValid())
{
- //cout<<decl->getKind()<<"ss\n";
if(decl->getKind()==35)
{
method_decl(decl);
{
DeclContext *declCont = namespaceDecl->castToDeclContext(namespaceDecl);
- //cout<<namedDecl->getNameAsString()<<" sss\n";
recursive_visit(declCont);
}
output = "";
}
}
- void recursive_visit(const DeclContext *declCont) //recursively visit all decls hidden inside namespaces
+
+/**
+* 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;
+ 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;
- //std::cout<<"a "<<decl->getDeclKindName()<<"\n";
loc = decl->getLocation();
if(loc.isValid())
{
}
else if(const NamespaceDecl *namespaceDecl = dyn_cast<NamespaceDecl>(decl))
{
- DeclContext *declCont = namespaceDecl->castToDeclContext(namespaceDecl);
- //cout<<namedDecl->getNameAsString()<<" sss\n";
+ DeclContext *declCont = namespaceDecl->castToDeclContext(namespaceDecl);
recursive_visit(declCont);
}
}
}
}
- void struct_class(const Decl *decl) // works with struct or class 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)
{
string output, line, ret, trans, event;
llvm::raw_string_ostream x(output);
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);
if(find_events(cRecDecl, line))
{
events.push_back(namedDecl->getNameAsString());
- cout<<"New event: "<<namedDecl->getNameAsString()<<"\n";
}
else if(name_of_machine == "")
{
pos = ret.find(",");
name_of_machine = ret.substr(0,pos);
name_of_start = ret.substr(pos+1);
- cout<<"Name of the state machine: "<<name_of_machine<<"\n";
- cout<<"Name of the first state: "<<name_of_start<<"\n";
}
}
else
{
- ret = find_states(cRecDecl, line);
+ ret = find_states(cRecDecl, line);
if(!ret.empty())
- {
- cout << "New state: " << namedDecl->getNameAsString() << "\n";
+ {
states.push_back(ret);
methods_in_class(decl,namedDecl->getNameAsString());
}
}
}
+/**
+* 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)
{
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();
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
}
}
+ /**
+ * Traverse method declaration using classes with main class Stmt.
+ */
void method_decl(const Decl *decl)
{
string output, line, event;
{
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);
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)
}
}
- void find_return_stmt(Stmt *statemt,string event)
+ 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)
+ 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;
}
};
-
+/**
+ * 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;
mdc->BeginSourceFile(lang, &pp);//start using diagnostic
ParseAST(pp, &c, ctx, false, false);
mdc->EndSourceFile(); //end using diagnostic
- IO_operations *io = new IO_operations(outputFilename, c.getStateMachine(), c.getNameOfFirstState(), c.getTransitions(), c.getStates(), c.getEvents());
+ 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();
projects / boost-statechart-viewer.git / blobdiff