+/** @file */
+////////////////////////////////////////////////////////////////////////////////////////
+//
+// This file is part of Boost Statechart Viewer.
+//
+// Boost Statechart Viewer is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Boost Statechart Viewer is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Boost Statechart Viewer. If not, see <http://www.gnu.org/licenses/>.
+//
+////////////////////////////////////////////////////////////////////////////////////////
+
//standard header files
-#include <iostream>
-#include <string>
#include <fstream>
-#include <list>
//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"
-
-//my own header files
-#include "stringoper.h"
+#include "clang/AST/CXXInheritance.h"
+#include "clang/AST/RecursiveASTVisitor.h"
+#include "clang/Frontend/CompilerInstance.h"
+#include "clang/Frontend/FrontendPluginRegistry.h"
using namespace clang;
-using namespace clang::driver;
using namespace std;
-class MyDiagnosticClient : public TextDiagnosticPrinter // My diagnostic Client
+class Statechart
{
- public:
- MyDiagnosticClient(llvm::raw_ostream &os, const DiagnosticOptions &diags, bool OwnsOutputStream = false):TextDiagnosticPrinter(os, diags, OwnsOutputStream = false){}
- virtual void HandleDiagnostic(Diagnostic::Level DiagLevel, const DiagnosticInfo &Info)
- {
- TextDiagnosticPrinter::HandleDiagnostic(DiagLevel, Info);
- if(DiagLevel > 2) // if error/fatal error stop the program
- {
- exit(1);
- }
+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";
+ f << " " << name_of_start << " [peripheries=2]\n";
+ for (string& s : states) {
+ f << " " << s << "\n";
}
+
+ for (Transition &t : transitions) {
+ f << t.src << " -> " << t.dst << " [label = \"" << t.event << "\"]\n";
+ }
+
+ f << "}";
+ }
};
-class FindStates : public ASTConsumer
+
+class MyCXXRecordDecl : public CXXRecordDecl
{
- list<string> transitions;
- list<string> events;
- string name_of_machine;
- string name_of_start;
- StringDecl sd;
- public:
- list<string> states;
-
- virtual void Initialize(ASTContext &ctx)//run after the AST is constructed before the consumer starts to work
- {
- name_of_start = "";
- name_of_machine = "";
- }
+ 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;
+ }
- virtual void HandleTopLevelDecl(DeclGroupRef DGR)// traverse all top level declarations
- {
- SourceLocation loc;
- std::string line, output;
- 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())
- {
- //cout<<decl->getKind()<<"ss\n";
- //decl->dump();
- if (const TagDecl *tagDecl = dyn_cast<TagDecl>(decl))
- {
- if(tagDecl->isStruct() || tagDecl->isClass()) //is it a struct or class
- {
- //std::cout<<namedDecl->getNameAsString()<<"\n";
- struct_class(decl);
- }
- }
- if(const NamespaceDecl *namespaceDecl = dyn_cast<NamespaceDecl>(decl))
- {
-
- DeclContext *declCont = namespaceDecl->castToDeclContext(namespaceDecl);
- //cout<<namedDecl->getNameAsString()<<" sss\n";
- recursive_visit(declCont);
-
- }
- }
- }
- }
- void recursive_visit(const DeclContext *declCont) //recursively visit all decls hidden inside namespaces
+public:
+ bool isDerivedFrom(const char *baseStr, CXXBaseSpecifier const **Base = 0) const {
+ CXXBasePaths Paths(/*FindAmbiguities=*/false, /*RecordPaths=*/!!Base, /*DetectVirtual=*/false);
+ Paths.setOrigin(const_cast<MyCXXRecordDecl*>(this));
+ if (!lookupInBases(&FindBaseClassString, const_cast<char*>(baseStr), Paths))
+ return false;
+ if (Base)
+ *Base = Paths.front().back().Base;
+ return true;
+ }
+};
+
+
+class Visitor : public RecursiveASTVisitor<Visitor>
+{
+ ASTContext *Context;
+ Statechart ≻
+ DiagnosticsEngine &Diags;
+ unsigned diag_unhandled_reaction_type, diag_unhandled_reaction_decl,
+ diag_found_state, diag_found_statemachine;
+
+public:
+ bool shouldVisitTemplateInstantiations() const { return true; }
+
+ explicit Visitor(ASTContext *Context, Statechart &sc, DiagnosticsEngine &Diags)
+ : Context(Context), sc(sc), Diags(Diags)
+ {
+ diag_found_statemachine =
+ Diags.getCustomDiagID(DiagnosticsEngine::Note, "Found statemachine '%0'");
+ diag_found_state =
+ Diags.getCustomDiagID(DiagnosticsEngine::Note, "Found state '%0'");
+ diag_unhandled_reaction_type =
+ Diags.getCustomDiagID(DiagnosticsEngine::Error, "Unhandled reaction type '%0'");
+ diag_unhandled_reaction_decl =
+ Diags.getCustomDiagID(DiagnosticsEngine::Error, "Unhandled reaction decl '%0'");
+ }
+
+ DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) { return Diags.Report(Loc, DiagID); }
+
+ void HandleReaction(const Type *T, const SourceLocation Loc, CXXRecordDecl *SrcState)
+ {
+ if (const ElaboratedType *ET = dyn_cast<ElaboratedType>(T))
+ HandleReaction(ET->getNamedType().getTypePtr(), Loc, 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()));
+ } else if (name == "boost::mpl::list") {
+ for (TemplateSpecializationType::iterator Arg = TST->begin(), End = TST->end(); Arg != End; ++Arg)
+ HandleReaction(Arg->getAsType().getTypePtr(), Loc, SrcState);
+ }
+ //->getDecl()->getQualifiedNameAsString();
+ } else
+ Diag(Loc, diag_unhandled_reaction_type) << T->getTypeClassName();
+ }
+
+ void HandleReaction(const NamedDecl *Decl, CXXRecordDecl *SrcState)
+ {
+ if (const TypedefDecl *r = dyn_cast<TypedefDecl>(Decl))
+ HandleReaction(r->getCanonicalDecl()->getUnderlyingType().getTypePtr(),
+ r->getLocStart(), SrcState);
+ else
+ Diag(Decl->getLocation(), diag_unhandled_reaction_decl) << Decl->getDeclKindName();
+ }
+
+
+ bool VisitCXXRecordDecl(CXXRecordDecl *Declaration)
+ {
+ if (!Declaration->isCompleteDefinition())
+ return true;
+
+ MyCXXRecordDecl *RecordDecl = static_cast<MyCXXRecordDecl*>(Declaration);
+ const CXXBaseSpecifier *Base;
+
+ if (RecordDecl->isDerivedFrom("boost::statechart::simple_state"))
{
- std::string line, 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())
- {
- if (const TagDecl *tagDecl = dyn_cast<TagDecl>(decl))
- {
- if(tagDecl->isStruct() || tagDecl->isClass()) //is it a structure or class
- {
- struct_class(decl);
- }
- }
- if(const NamespaceDecl *namespaceDecl = dyn_cast<NamespaceDecl>(decl))
- {
- DeclContext *declCont = namespaceDecl->castToDeclContext(namespaceDecl);
- //cout<<namedDecl->getNameAsString()<<" sss\n";
- recursive_visit(declCont);
- }
- }
- }
+ string state(RecordDecl->getName()); //getQualifiedNameAsString());
+ Diag(RecordDecl->getLocStart(), diag_found_state) << state;
+ sc.states.push_back(state);
+
+ IdentifierInfo& II = Context->Idents.get("reactions");
+ for (DeclContext::lookup_result Reactions = RecordDecl->lookup(DeclarationName(&II));
+ Reactions.first != Reactions.second; ++Reactions.first)
+ HandleReaction(*Reactions.first, RecordDecl);
}
-
- void struct_class(const Decl *decl) // works with struct or class decl
+ else if (RecordDecl->isDerivedFrom("boost::statechart::state_machine", &Base))
{
- string output, line, ret, trans;
- llvm::raw_string_ostream x(output);
- decl->print(x);
- line = sd.get_line_of_code(x.str());
- output = "";
- int pos, num;
- const TagDecl *tagDecl = dyn_cast<TagDecl>(decl);
- const NamedDecl *namedDecl = dyn_cast<NamedDecl>(decl);
- if(sd.is_derived(line))
- {
- const CXXRecordDecl *cRecDecl = dyn_cast<CXXRecordDecl>(decl);
-
-
- if(sd.find_events(cRecDecl, line))
- {
- events.push_back(namedDecl->getNameAsString());
- cout<<"New event: "<<namedDecl->getNameAsString()<<"\n";
- }
- else if(name_of_machine == "")
- {
- ret = sd.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);
- cout<<"Name of the state machine: "<<name_of_machine<<"\n";
- cout<<"Name of the first state: "<<name_of_start<<"\n";
- }
- }
- else
- {
- ret = sd.find_states(cRecDecl, line);
- if(!ret.empty())
- {
- const DeclContext *declCont = tagDecl->castToDeclContext(tagDecl);
- //states.push_back(namedDecl->getNameAsString());
- std::cout << "New state: " << namedDecl->getNameAsString() << "\n";
- states.push_back(ret);
- ret = sd.find_transitions(namedDecl->getNameAsString(), declCont);
- if(!ret.empty())
- {
- num = sd.count(ret,';');
- for(int i = 0;i<num;i++)
- {
- pos = ret.find(";");
- transitions.push_back(ret.substr(0,pos));
- ret = ret.substr(pos+1);
- }
- transitions.push_back(ret);
- }
- }
- }
+ sc.name = RecordDecl->getQualifiedNameAsString();
+ Diag(RecordDecl->getLocStart(), diag_found_statemachine) << sc.name;
+
+ if (const ElaboratedType *ET = dyn_cast<ElaboratedType>(Base->getType())) {
+ if (const TemplateSpecializationType *TST = dyn_cast<TemplateSpecializationType>(ET->getNamedType())) {
+ sc.name_of_start = TST->getArg(1).getAsType()->getAsCXXRecordDecl()->getName();
}
+ }
}
-
- void save_to_file(std::string output) // save all to the output file
+ else if (RecordDecl->isDerivedFrom("boost::statechart::event"))
{
- std::string state, str, context, ctx;
- int pos1, pos2, cnt, subs;
- std::ofstream filestr(output.c_str());
- //std::cout<<output<<"\n";
- filestr<<"digraph "<< name_of_machine<< " {\n";
- context = name_of_machine;
- for(list<std::string>::iterator i = states.begin();i!=states.end();i++) // write all states in the context of the automaton
- {
- state = *i;
- cnt = sd.count(state,',');
- if(cnt==1)
- {
- pos1 = state.find(",");
- ctx = sd.cut_namespaces(state.substr(pos1+1));
- //std::cout<<name_of_machine.length();
- if(ctx.compare(0,context.length(),context)==0)
- {
- filestr<<sd.cut_namespaces(state.substr(0,pos1))<<";\n";
- states.erase(i);
- i--;
- }
- }
- if(cnt==2)
- {
- pos1 = state.find(",");
- pos2 = state.rfind(",");
- ctx = sd.cut_namespaces(state.substr(pos1+1,pos2-pos1-1));
- //std::cout<<ctx<<" "<<context<<"\n";
- if(ctx.compare(0,context.length(),context)==0)
- {
- filestr<<sd.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 = sd.cut_namespaces(state.substr(0,pos1));
- filestr<<"label=\""<<context<<"\";\n";
- filestr<<sd.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 = sd.count(state,',');
- //std::cout<<state<<" \n";
- if(cnt==1)
- {
- pos1 = state.find(",");
- ctx = sd.cut_namespaces(state.substr(pos1+1));
-
- //std::cout<<ctx<<" "<<context<<"\n";
- if(ctx.compare(0,context.length(),context)==0)
- {
- filestr<<sd.cut_namespaces(state.substr(0,pos1))<<";\n";
- states.erase(i);
- i--;
- }
- }
- if(cnt==2)
- {
- pos1 = state.find(",");
- pos2 = state.rfind(",");
- ctx = sd.cut_namespaces(state.substr(pos1+1,pos2-pos1-1));
- if(ctx.compare(0,context.length(),context)==0)
- {
- filestr<<sd.cut_namespaces(state.substr(0,pos1))<<";\n";
- //std::cout<<ctx<<"\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<<sd.cut_namespaces(state.substr(0,pos1))<<"->";
- pos2 = state.rfind(",");
- filestr<<sd.cut_namespaces(state.substr(pos2+1));
- filestr<<"[label=\""<<sd.cut_namespaces(state.substr(pos1+1,pos2-pos1-1))<<"\"];\n";
- }
- filestr<<"}";
- filestr.close();
+ sc.events.push_back(RecordDecl->getNameAsString());
}
+ return true;
+ }
};
-int main(int argc, char **argv)
-{
- string inputFilename = "";
- string outputFilename = "graph.dot"; // initialize output Filename
- MyDiagnosticClient *mdc = new MyDiagnosticClient(llvm::errs(), * new DiagnosticOptions());
- llvm::IntrusiveRefCntPtr<DiagnosticIDs> dis(new DiagnosticIDs());
- Diagnostic diag(dis,mdc);
- FileManager fm( * new FileSystemOptions());
- SourceManager sm (diag, fm);
- HeaderSearch *headers = new HeaderSearch(fm);
-
- Driver TheDriver(LLVM_PREFIX "/bin", llvm::sys::getHostTriple(), "", false, false, diag);
- TheDriver.setCheckInputsExist(true);
- TheDriver.CCCIsCXX = 1;
- CompilerInvocation compInv;
- llvm::SmallVector<const char *, 16> Args(argv, argv + argc);
- llvm::OwningPtr<Compilation> C(TheDriver.BuildCompilation(Args.size(),
- Args.data()));
- const driver::JobList &Jobs = C->getJobs();
- const driver::Command *Cmd = cast<driver::Command>(*Jobs.begin());
- const driver::ArgStringList &CCArgs = Cmd->getArguments();
- for(unsigned i = 0; i<Args.size();i++) // find -o in ArgStringList
- {
- if(strncmp(Args[i],"-o",2)==0)
- {
- if(strlen(Args[i])>2)
- {
- string str = Args[i];
- outputFilename = str.substr(2);
- }
- else outputFilename = Args[i+1];
- break;
- }
- }
-
- CompilerInvocation::CreateFromArgs(compInv,
- const_cast<const char **>(CCArgs.data()),
- const_cast<const char **>(CCArgs.data())+CCArgs.size(),
- diag);
-
- HeaderSearchOptions hsopts = compInv.getHeaderSearchOpts();
- hsopts.ResourceDir = LLVM_PREFIX "/lib/clang/" CLANG_VERSION_STRING;
- LangOptions lang = compInv.getLangOpts();
- CompilerInvocation::setLangDefaults(lang, IK_ObjCXX);
- TargetInfo *ti = TargetInfo::CreateTargetInfo(diag, compInv.getTargetOpts());
- ApplyHeaderSearchOptions(*headers, hsopts, lang, ti->getTriple());
- FrontendOptions f = compInv.getFrontendOpts();
- inputFilename = f.Inputs[0].second;
-
- cout<<"Input filename: "<<inputFilename<<"\n"; // print Input filename
- cout<<"Output filename: "<<outputFilename<<"\n"; // print Output filename
-
-
- Preprocessor pp(diag, lang, *ti, sm, *headers);
- pp.getBuiltinInfo().InitializeBuiltins(pp.getIdentifierTable(), lang);
-
- InitializePreprocessor(pp, compInv.getPreprocessorOpts(),hsopts,f);
-
- const FileEntry *file = fm.getFile(inputFilename);
- sm.createMainFileID(file);
- IdentifierTable tab(lang);
- Builtin::Context builtins(*ti);
- FindStates c;
- ASTContext ctx(lang, sm, *ti, tab, * new SelectorTable(), builtins,0);
- 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";
- return 0;
-}
+class VisualizeStatechartConsumer : public clang::ASTConsumer
+{
+ Statechart statechart;
+ Visitor visitor;
+ string destFileName;
+public:
+ explicit VisualizeStatechartConsumer(ASTContext *Context, std::string destFileName,
+ DiagnosticsEngine &D)
+ : visitor(Context, statechart, D), destFileName(destFileName) {}
+
+ virtual void HandleTranslationUnit(clang::ASTContext &Context) {
+ visitor.TraverseDecl(Context.getTranslationUnitDecl());
+ statechart.write_dot_file(destFileName);
+ }
+};
+
+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 VisualizeStatechartConsumer(&CI.getASTContext(), dest, CI.getDiagnostics());
+ }
+
+ bool ParseArgs(const CompilerInstance &CI,
+ const std::vector<std::string>& args) {
+ for (unsigned i = 0, e = args.size(); i != e; ++i) {
+ llvm::errs() << "Visualizer arg = " << args[i] << "\n";
+
+ // Example error handling.
+ if (args[i] == "-an-error") {
+ DiagnosticsEngine &D = CI.getDiagnostics();
+ unsigned DiagID = D.getCustomDiagID(
+ DiagnosticsEngine::Error, "invalid argument '" + args[i] + "'");
+ D.Report(DiagID);
+ return false;
+ }
+ }
+ if (args.size() && args[0] == "help")
+ PrintHelp(llvm::errs());
+
+ return true;
+ }
+ void PrintHelp(llvm::raw_ostream& ros) {
+ ros << "Help for Visualize Statechart plugin goes here\n";
+ }
+
+};
+
+static FrontendPluginRegistry::Add<VisualizeStatechartAction> X("visualize-statechart", "visualize statechart");
+
+// Local Variables:
+// c-basic-offset: 4
+// End: