src/libs/cplusplus/FindUsages.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef CPLUSPLUS_FINDUSAGES_H
  35 #define CPLUSPLUS_FINDUSAGES_H
  36
  37 #include "LookupContext.h"
  38 #include "CppDocument.h"
  39 #include "TypeOfExpression.h"
  40 #include <ASTVisitor.h>
  41 #include <QtCore/QSet>
  42
  43 namespace CPlusPlus {
  44
  45 class CPLUSPLUS_EXPORT Usage
  46 {
  47 public:
  48     Usage()
  49         : line(0), col(0), len(0) {}
  50
  51     Usage(const QString &path, const QString &lineText, int line, int col, int len)
  52         : path(path), lineText(lineText), line(line), col(col), len(len) {}
  53
  54 public:
  55     QString path;
  56     QString lineText;
  57     int line;
  58     int col;
  59     int len;
  60 };
  61
  62 class CPLUSPLUS_EXPORT FindUsages: protected ASTVisitor
  63 {
  64 public:
  65     FindUsages(const QByteArray &originalSource, Document::Ptr doc, const Snapshot &snapshot);
  66     FindUsages(const LookupContext &context);
  67
  68     void operator()(Symbol *symbol);
  69
  70     QList<Usage> usages() const;
  71     QList<int> references() const;
  72
  73 protected:
  74     using ASTVisitor::translationUnit;
  75
  76     Scope *switchScope(Scope *scope);
  77
  78     QString matchingLine(const Token &tk) const;
  79
  80     void reportResult(unsigned tokenIndex, const Name *name, Scope *scope = 0);
  81     void reportResult(unsigned tokenIndex, const Identifier *id, Scope *scope = 0);
  82     void reportResult(unsigned tokenIndex, const QList<LookupItem> &candidates);
  83     void reportResult(unsigned tokenIndex);
  84
  85     bool checkCandidates(const QList<LookupItem> &candidates) const;
  86     void checkExpression(unsigned startToken, unsigned endToken, Scope *scope = 0);
  87
  88     static bool compareFullyQualifiedName(const QList<const Name *> &path, const QList<const Name *> &other);
  89     static bool compareName(const Name *name, const Name *other);
  90     static bool isLocalScope(Scope *scope);
  91
  92     void statement(StatementAST *ast);
  93     void expression(ExpressionAST *ast);
  94     void declaration(DeclarationAST *ast);
  95     const Name *name(NameAST *ast);
  96     void specifier(SpecifierAST *ast);
  97     void ptrOperator(PtrOperatorAST *ast);
  98     void coreDeclarator(CoreDeclaratorAST *ast);
  99     void postfixDeclarator(PostfixDeclaratorAST *ast);
 100
 101     void objCSelectorArgument(ObjCSelectorArgumentAST *ast);
 102     void attribute(AttributeAST *ast);
 103     void declarator(DeclaratorAST *ast, Scope *symbol = 0);
 104     void qtPropertyDeclarationItem(QtPropertyDeclarationItemAST *ast);
 105     void qtInterfaceName(QtInterfaceNameAST *ast);
 106     void baseSpecifier(BaseSpecifierAST *ast);
 107     void ctorInitializer(CtorInitializerAST *ast);
 108     void enumerator(EnumeratorAST *ast);
 109     void exceptionSpecification(ExceptionSpecificationAST *ast);
 110     void memInitializer(MemInitializerAST *ast);
 111     void nestedNameSpecifier(NestedNameSpecifierAST *ast);
 112     void newPlacement(NewPlacementAST *ast);
 113     void newArrayDeclarator(NewArrayDeclaratorAST *ast);
 114     void newInitializer(NewInitializerAST *ast);
 115     void newTypeId(NewTypeIdAST *ast);
 116     void cppOperator(OperatorAST *ast);
 117     void parameterDeclarationClause(ParameterDeclarationClauseAST *ast);
 118     void translationUnit(TranslationUnitAST *ast);
 119     void objCProtocolRefs(ObjCProtocolRefsAST *ast);
 120     void objCMessageArgument(ObjCMessageArgumentAST *ast);
 121     void objCTypeName(ObjCTypeNameAST *ast);
 122     void objCInstanceVariablesDeclaration(ObjCInstanceVariablesDeclarationAST *ast);
 123     void objCPropertyAttribute(ObjCPropertyAttributeAST *ast);
 124     void objCMessageArgumentDeclaration(ObjCMessageArgumentDeclarationAST *ast);
 125     void objCMethodPrototype(ObjCMethodPrototypeAST *ast);
 126     void objCSynthesizedProperty(ObjCSynthesizedPropertyAST *ast);
 127     void lambdaIntroducer(LambdaIntroducerAST *ast);
 128     void lambdaCapture(LambdaCaptureAST *ast);
 129     void capture(CaptureAST *ast);
 130     void lambdaDeclarator(LambdaDeclaratorAST *ast);
 131     void trailingReturnType(TrailingReturnTypeAST *ast);
 132
 133     // AST
 134     virtual bool visit(ObjCSelectorArgumentAST *ast);
 135     virtual bool visit(AttributeAST *ast);
 136     virtual bool visit(DeclaratorAST *ast);
 137     virtual bool visit(QtPropertyDeclarationItemAST *ast);
 138     virtual bool visit(QtInterfaceNameAST *ast);
 139     virtual bool visit(BaseSpecifierAST *ast);
 140     virtual bool visit(CtorInitializerAST *ast);
 141     virtual bool visit(EnumeratorAST *ast);
 142     virtual bool visit(ExceptionSpecificationAST *ast);
 143     virtual bool visit(MemInitializerAST *ast);
 144     virtual bool visit(NestedNameSpecifierAST *ast);
 145     virtual bool visit(NewPlacementAST *ast);
 146     virtual bool visit(NewArrayDeclaratorAST *ast);
 147     virtual bool visit(NewInitializerAST *ast);
 148     virtual bool visit(NewTypeIdAST *ast);
 149     virtual bool visit(OperatorAST *ast);
 150     virtual bool visit(ParameterDeclarationClauseAST *ast);
 151     virtual bool visit(TranslationUnitAST *ast);
 152     virtual bool visit(ObjCProtocolRefsAST *ast);
 153     virtual bool visit(ObjCMessageArgumentAST *ast);
 154     virtual bool visit(ObjCTypeNameAST *ast);
 155     virtual bool visit(ObjCInstanceVariablesDeclarationAST *ast);
 156     virtual bool visit(ObjCPropertyAttributeAST *ast);
 157     virtual bool visit(ObjCMessageArgumentDeclarationAST *ast);
 158     virtual bool visit(ObjCMethodPrototypeAST *ast);
 159     virtual bool visit(ObjCSynthesizedPropertyAST *ast);
 160     virtual bool visit(LambdaIntroducerAST *ast);
 161     virtual bool visit(LambdaCaptureAST *ast);
 162     virtual bool visit(CaptureAST *ast);
 163     virtual bool visit(LambdaDeclaratorAST *ast);
 164     virtual bool visit(TrailingReturnTypeAST *ast);
 165
 166     // StatementAST
 167     virtual bool visit(QtMemberDeclarationAST *ast);
 168     virtual bool visit(CaseStatementAST *ast);
 169     virtual bool visit(CompoundStatementAST *ast);
 170     virtual bool visit(DeclarationStatementAST *ast);
 171     virtual bool visit(DoStatementAST *ast);
 172     virtual bool visit(ExpressionOrDeclarationStatementAST *ast);
 173     virtual bool visit(ExpressionStatementAST *ast);
 174     virtual bool visit(ForeachStatementAST *ast);
 175     virtual bool visit(ForStatementAST *ast);
 176     virtual bool visit(IfStatementAST *ast);
 177     virtual bool visit(LabeledStatementAST *ast);
 178     virtual bool visit(BreakStatementAST *ast);
 179     virtual bool visit(ContinueStatementAST *ast);
 180     virtual bool visit(GotoStatementAST *ast);
 181     virtual bool visit(ReturnStatementAST *ast);
 182     virtual bool visit(SwitchStatementAST *ast);
 183     virtual bool visit(TryBlockStatementAST *ast);
 184     virtual bool visit(CatchClauseAST *ast);
 185     virtual bool visit(WhileStatementAST *ast);
 186     virtual bool visit(ObjCFastEnumerationAST *ast);
 187     virtual bool visit(ObjCSynchronizedStatementAST *ast);
 188
 189     // ExpressionAST
 190     virtual bool visit(IdExpressionAST *ast);
 191     virtual bool visit(CompoundExpressionAST *ast);
 192     virtual bool visit(CompoundLiteralAST *ast);
 193     virtual bool visit(QtMethodAST *ast);
 194     virtual bool visit(BinaryExpressionAST *ast);
 195     virtual bool visit(CastExpressionAST *ast);
 196     virtual bool visit(ConditionAST *ast);
 197     virtual bool visit(ConditionalExpressionAST *ast);
 198     virtual bool visit(CppCastExpressionAST *ast);
 199     virtual bool visit(DeleteExpressionAST *ast);
 200     virtual bool visit(ArrayInitializerAST *ast);
 201     virtual bool visit(NewExpressionAST *ast);
 202     virtual bool visit(TypeidExpressionAST *ast);
 203     virtual bool visit(TypenameCallExpressionAST *ast);
 204     virtual bool visit(TypeConstructorCallAST *ast);
 205     virtual bool visit(SizeofExpressionAST *ast);
 206     virtual bool visit(NumericLiteralAST *ast);
 207     virtual bool visit(BoolLiteralAST *ast);
 208     virtual bool visit(ThisExpressionAST *ast);
 209     virtual bool visit(NestedExpressionAST *ast);
 210     virtual bool visit(StringLiteralAST *ast);
 211     virtual bool visit(ThrowExpressionAST *ast);
 212     virtual bool visit(TypeIdAST *ast);
 213     virtual bool visit(UnaryExpressionAST *ast);
 214     virtual bool visit(ObjCMessageExpressionAST *ast);
 215     virtual bool visit(ObjCProtocolExpressionAST *ast);
 216     virtual bool visit(ObjCEncodeExpressionAST *ast);
 217     virtual bool visit(ObjCSelectorExpressionAST *ast);
 218     virtual bool visit(LambdaExpressionAST *ast);
 219     virtual bool visit(BracedInitializerAST *ast);
 220
 221     // DeclarationAST
 222     virtual bool visit(SimpleDeclarationAST *ast);
 223     virtual bool visit(EmptyDeclarationAST *ast);
 224     virtual bool visit(AccessDeclarationAST *ast);
 225     virtual bool visit(QtObjectTagAST *ast);
 226     virtual bool visit(QtPrivateSlotAST *ast);
 227     virtual bool visit(QtPropertyDeclarationAST *ast);
 228     virtual bool visit(QtEnumDeclarationAST *ast);
 229     virtual bool visit(QtFlagsDeclarationAST *ast);
 230     virtual bool visit(QtInterfacesDeclarationAST *ast);
 231     virtual bool visit(AsmDefinitionAST *ast);
 232     virtual bool visit(ExceptionDeclarationAST *ast);
 233     virtual bool visit(FunctionDefinitionAST *ast);
 234     virtual bool visit(LinkageBodyAST *ast);
 235     virtual bool visit(LinkageSpecificationAST *ast);
 236     virtual bool visit(NamespaceAST *ast);
 237     virtual bool visit(NamespaceAliasDefinitionAST *ast);
 238     virtual bool visit(ParameterDeclarationAST *ast);
 239     virtual bool visit(TemplateDeclarationAST *ast);
 240     virtual bool visit(TypenameTypeParameterAST *ast);
 241     virtual bool visit(TemplateTypeParameterAST *ast);
 242     virtual bool visit(UsingAST *ast);
 243     virtual bool visit(UsingDirectiveAST *ast);
 244     virtual bool visit(ObjCClassForwardDeclarationAST *ast);
 245     virtual bool visit(ObjCClassDeclarationAST *ast);
 246     virtual bool visit(ObjCProtocolForwardDeclarationAST *ast);
 247     virtual bool visit(ObjCProtocolDeclarationAST *ast);
 248     virtual bool visit(ObjCVisibilityDeclarationAST *ast);
 249     virtual bool visit(ObjCPropertyDeclarationAST *ast);
 250     virtual bool visit(ObjCMethodDeclarationAST *ast);
 251     virtual bool visit(ObjCSynthesizedPropertiesDeclarationAST *ast);
 252     virtual bool visit(ObjCDynamicPropertiesDeclarationAST *ast);
 253
 254     // NameAST
 255     virtual bool visit(ObjCSelectorAST *ast);
 256     virtual bool visit(QualifiedNameAST *ast);
 257     virtual bool visit(OperatorFunctionIdAST *ast);
 258     virtual bool visit(ConversionFunctionIdAST *ast);
 259     virtual bool visit(SimpleNameAST *ast);
 260     virtual bool visit(DestructorNameAST *ast);
 261     virtual bool visit(TemplateIdAST *ast);
 262
 263     // SpecifierAST
 264     virtual bool visit(SimpleSpecifierAST *ast);
 265     virtual bool visit(AttributeSpecifierAST *ast);
 266     virtual bool visit(TypeofSpecifierAST *ast);
 267     virtual bool visit(ClassSpecifierAST *ast);
 268     virtual bool visit(NamedTypeSpecifierAST *ast);
 269     virtual bool visit(ElaboratedTypeSpecifierAST *ast);
 270     virtual bool visit(EnumSpecifierAST *ast);
 271
 272     // PtrOperatorAST
 273     virtual bool visit(PointerToMemberAST *ast);
 274     virtual bool visit(PointerAST *ast);
 275     virtual bool visit(ReferenceAST *ast);
 276
 277     // PostfixAST
 278     virtual bool visit(CallAST *ast);
 279     virtual bool visit(ArrayAccessAST *ast);
 280     virtual bool visit(PostIncrDecrAST *ast);
 281     virtual bool visit(MemberAccessAST *ast);
 282
 283     // CoreDeclaratorAST
 284     virtual bool visit(DeclaratorIdAST *ast);
 285     virtual bool visit(NestedDeclaratorAST *ast);
 286
 287     // PostfixDeclaratorAST
 288     virtual bool visit(FunctionDeclaratorAST *ast);
 289     virtual bool visit(ArrayDeclaratorAST *ast);
 290
 291 private:
 292     const Identifier *_id;
 293     Symbol *_declSymbol;
 294     QList<const Name *> _declSymbolFullyQualifiedName;
 295     Document::Ptr _doc;
 296     Snapshot _snapshot;
 297     LookupContext _context;
 298     QByteArray _originalSource;
 299     QByteArray _source;
 300     QList<int> _references;
 301     QList<Usage> _usages;
 302     QSet<unsigned> _processed;
 303     TypeOfExpression typeofExpression;
 304     Scope *_currentScope;
 305 };
 306
 307 } // namespace CPlusPlus
 308
 309 #endif // CPLUSPLUS_FINDUSAGES_H
 310