You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdevelop/languages/cpp/tag_creator.h

130 lines
4.1 KiB

/***************************************************************************
* Copyright (C) 2003 by Roberto Raggi *
* roberto@kdevelop.org *
* *
* This program 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 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef __tag_creator_h
#define __tag_creator_h
#include "tree_parser.h"
#include <tqstringlist.h>
#include <tqvaluestack.h>
class Catalog;
class Tag;
namespace TagUtils
{
int stringToAccess( const TQString& access );
TQString accessToString( int id );
}
class TagCreator: public TreeParser
{
public:
TagCreator( const TQString& fileName, Catalog* c );
virtual ~TagCreator();
// translation-unit
virtual void parseTranslationUnit( const ParsedFile& );
// declarations
virtual void parseDeclaration( DeclarationAST* );
virtual void parseNamespace( NamespaceAST* );
virtual void parseNamespaceAlias( NamespaceAliasAST* decl );
virtual void parseUsingDirective( UsingDirectiveAST* );
virtual void parseTypedef( TypedefAST* );
virtual void parseTemplateDeclaration( TemplateDeclarationAST* );
virtual void parseSimpleDeclaration( SimpleDeclarationAST* );
virtual void parseFunctionDefinition( FunctionDefinitionAST* );
virtual void parseLinkageBody( LinkageBodyAST* );
virtual void parseAccessDeclaration( AccessDeclarationAST* );
// type-specifier
virtual void parseClassSpecifier( ClassSpecifierAST* );
virtual void parseEnumSpecifier( EnumSpecifierAST* );
virtual void parseElaboratedTypeSpecifier( ElaboratedTypeSpecifierAST* );
virtual void parseMyDeclaration( GroupAST* funSpec, GroupAST* storageSpec, TypeSpecifierAST* typeSpec, InitDeclaratorAST* decl );
virtual void parseFunctionDeclaration( GroupAST* funSpec, GroupAST* storageSpec, TypeSpecifierAST* typeSpec, InitDeclaratorAST* decl );
virtual void parseFunctionArguments( Tag& tag, DeclaratorAST* declarator );
virtual void parseBaseClause( const TQString& className, BaseClauseAST* baseClause );
/**
call this function after the last use of a TagCreator object, to do cleanup work
*/
static void destroyDocumentation();
/**
This sets the directories, where the doxygen documentation should be searched in.
@param dirs TQStringList containing strings, which define the pathes, where documentation is searched in
*/
static void setDocumentationDirectories( const TQStringList& dirs );
private:
TQString scopeOfDeclarator( DeclaratorAST* d );
TQString typeOfDeclaration( TypeSpecifierAST* typeSpec, DeclaratorAST* declarator );
private:
void takeTemplateParams( Tag& target, TemplateDeclarationAST* ast );
void checkTemplateDeclarator( Tag& tag );
class CommentPusher {
TagCreator& m_ref;
public:
CommentPusher( TagCreator& ref, TQString comment ) : m_ref( ref ) {
m_ref.pushComment( comment );
}
~CommentPusher() {
m_ref.popComment();
}
};
TQStringList m_comments;
TQString comment() {
if( m_comments.isEmpty() ) {
return "";
} else {
return m_comments.front();
}
}
void pushComment( TQString comm ) {
m_comments.push_front( comm );
}
void popComment() {
m_comments.pop_front();
}
Catalog* m_catalog;
TQString m_fileName;
TQStringList m_currentScope;
TQValueList<TQStringList> m_imports;
TQString m_currentAccess;
bool m_inClass;
bool m_inSlots;
bool m_inSignals;
int m_anon;
TQValueStack<TemplateDeclarationAST*> m_currentTemplateDeclarator;
static class DoxyDoc* m_documentation;
private:
TagCreator( const TagCreator& source );
void operator = ( const TagCreator& source );
};
#endif // __tag_creator_h