
#ifndef CLASSVISITOR_HH
#define CLASSVISITOR_HH

#include <set>
#include <string>

#include "clang/Frontend/CompilerInstance.h"
#include "clang/AST/RecursiveASTVisitor.h"
#include "ClassValues.hh"

class CommentSaver ;
class EnumValues ;
class HeaderSearchDirs ;
class PrintAttributes ;

/**

  This class is a recursive AST visitor that is called when a CXXRecordDecl node
  is found.  Inside of a CXXRecord we are only interested in 4 types of nodes, the
  CXXRecord itself, template specializations, friends, and fields.  If a field is
  found a FieldVisitor is instantiated and parsing of the field continues in the
  field visitor.

  A class visitor is usually instantiated by the top level visitor, TranslationUnitVisitor,
  or the typedef visitor, TypedefVisitor.

  @author Alexander S. Lin

  @date July 2012

 */

class CXXRecordVisitor : public clang::RecursiveASTVisitor<CXXRecordVisitor> {
    public:
        CXXRecordVisitor( clang::CompilerInstance & in_ci ,
         CommentSaver & in_cs ,
         HeaderSearchDirs & in_hsd ,
         PrintAttributes & in_pa ,
         bool in_include_virtual_base ) ;

        ~CXXRecordVisitor() ;

        /* A custom traversal that handles only the node types we are interested in. */
        bool TraverseDecl(clang::Decl *D);

        /* VisitDecl and VisitType are here for debug printing. */
        bool VisitDecl(clang::Decl *d) ;
        bool VisitType(clang::Type *t) ;

        /* These routines are called when nodes of the corresponding types are traversed */
        bool VisitCXXRecordDecl(clang::CXXRecordDecl *rec) ;
        bool VisitFriendDecl(clang::FriendDecl *fd) ;

        /** Returns the class data */
        ClassValues * get_class_data() ;

        static void addPrivateEmbeddedClass(std::string in_name) ;
        static bool isPrivateEmbeddedClass(std::string in_name) ;
    private:
        /* Save any additional #includes required by template arguments */
        void addTemplateArgumentDependencies(const clang::CXXRecordDecl *rec) ;

        /** The compiler instance. */
        clang::CompilerInstance & ci ;

        /** The header search directories */
        HeaderSearchDirs & hsd ;

        /** Holds all comments */
        CommentSaver & cs ;

        /** attributes printer */
        PrintAttributes & pa ;

        /** Holds the class information found, usually returned to caller of this visitor. */
        ClassValues cval ;

        /** Flag to specify if we should process virtual base classes. */
        bool include_virtual_base ;

        /** Flag indicating we have found a public/private/protected keyword  */
        bool access_spec_found ;

        static std::set<std::string> private_embedded_classes ;
        static std::set<std::string> friend_classes ;
} ;

#endif
