src/shared/cplusplus/Scope.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 // Copyright (c) 2008 Roberto Raggi <roberto.raggi@gmail.com>
  34 //
  35 // Permission is hereby granted, free of charge, to any person obtaining a copy
  36 // of this software and associated documentation files (the "Software"), to deal
  37 // in the Software without restriction, including without limitation the rights
  38 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  39 // copies of the Software, and to permit persons to whom the Software is
  40 // furnished to do so, subject to the following conditions:
  41 //
  42 // The above copyright notice and this permission notice shall be included in
  43 // all copies or substantial portions of the Software.
  44 //
  45 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  46 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  47 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  48 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  49 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  50 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  51 // THE SOFTWARE.
  52
  53 #ifndef CPLUSPLUS_SCOPE_H
  54 #define CPLUSPLUS_SCOPE_H
  55
  56 #include "CPlusPlusForwardDeclarations.h"
  57 #include "Symbol.h"
  58 #include "Names.h"
  59
  60 namespace CPlusPlus {
  61
  62 class CPLUSPLUS_EXPORT Scope: public Symbol
  63 {
  64 public:
  65     Scope(TranslationUnit *translationUnit, unsigned sourceLocation, const Name *name);
  66     virtual ~Scope();
  67
  68     /// Adds a Symbol to this Scope.
  69     void addMember(Symbol *symbol);
  70
  71     /// Returns true if this Scope is empty; otherwise returns false.
  72     bool isEmpty() const;
  73
  74     /// Returns the number of symbols is in the scope.
  75     unsigned memberCount() const;
  76
  77     /// Returns the Symbol at the given position.
  78     Symbol *memberAt(unsigned index) const;
  79
  80     typedef Symbol **iterator;
  81
  82     /// Returns the first Symbol in the scope.
  83     iterator firstMember() const;
  84
  85     /// Returns the last Symbol in the scope.
  86     iterator lastMember() const;
  87
  88     Symbol *find(const Identifier *id) const;
  89     Symbol *find(OperatorNameId::Kind operatorId) const;
  90
  91     /// Set the start offset of the scope
  92     unsigned startOffset() const;
  93     void setStartOffset(unsigned offset);
  94
  95     /// Set the end offset of the scope
  96     unsigned endOffset() const;
  97     void setEndOffset(unsigned offset);
  98
  99     virtual const Scope *asScope() const
 100     { return this; }
 101
 102     virtual Scope *asScope()
 103     { return this; }
 104
 105 private:
 106     SymbolTable *_members;
 107     unsigned _startOffset;
 108     unsigned _endOffset;
 109 };
 110
 111 } // end of namespace CPlusPlus
 112
 113
 114 #endif // CPLUSPLUS_SCOPE_H