diff options
author | hjk <[email protected]> | 2009-01-26 16:19:24 +0100 |
---|---|---|
committer | hjk <[email protected]> | 2009-01-26 16:19:24 +0100 |
commit | fe0533de2a634ca377c2d8a0073e0eb2cbf89abf (patch) | |
tree | 29d3d30e6cc5a1068a94097a5660bc4d133a205f /src/shared/cplusplus/Symbol.h | |
parent | c85ba53365d606192069a841ed806979f17d80bc (diff) |
Fixes: move all files in shared/* to src/shared/*
Diffstat (limited to 'src/shared/cplusplus/Symbol.h')
-rw-r--r-- | src/shared/cplusplus/Symbol.h | 266 |
1 files changed, 266 insertions, 0 deletions
diff --git a/src/shared/cplusplus/Symbol.h b/src/shared/cplusplus/Symbol.h new file mode 100644 index 00000000000..e9d150e8d5e --- /dev/null +++ b/src/shared/cplusplus/Symbol.h @@ -0,0 +1,266 @@ +/*************************************************************************** +** +** This file is part of Qt Creator +** +** Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies). +** +** Contact: Qt Software Information ([email protected]) +** +** +** Non-Open Source Usage +** +** Licensees may use this file in accordance with the Qt Beta Version +** License Agreement, Agreement version 2.2 provided with the Software or, +** alternatively, in accordance with the terms contained in a written +** agreement between you and Nokia. +** +** GNU General Public License Usage +** +** Alternatively, this file may be used under the terms of the GNU General +** Public License versions 2.0 or 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the packaging +** of this file. Please review the following information to ensure GNU +** General Public Licensing requirements will be met: +** +** http://www.fsf.org/licensing/licenses/info/GPLv2.html and +** http://www.gnu.org/copyleft/gpl.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt GPL Exception +** version 1.3, included in the file GPL_EXCEPTION.txt in this package. +** +***************************************************************************/ +// Copyright (c) 2008 Roberto Raggi <[email protected]> +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +// THE SOFTWARE. + +#ifndef CPLUSPLUS_SYMBOL_H +#define CPLUSPLUS_SYMBOL_H + +#include "CPlusPlusForwardDeclarations.h" + +CPLUSPLUS_BEGIN_HEADER +CPLUSPLUS_BEGIN_NAMESPACE + +class CPLUSPLUS_EXPORT Symbol +{ + Symbol(const Symbol &other); + void operator =(const Symbol &other); + +public: + /// Storage class specifier + enum Storage { + NoStorage = 0, + Friend, + Register, + Static, + Extern, + Mutable, + Typedef + }; + + /// Access specifier. + enum Visibility { + Public, + Protected, + Private + }; + +public: + /// Constructs a Symbol with the given source location, name and translation unit. + Symbol(TranslationUnit *translationUnit, unsigned sourceLocation, Name *name); + + /// Destroy this Symbol. + virtual ~Symbol(); + + /// Returns this Symbol's Control object. + Control *control() const; + + /// Returns this Symbol's source location. + unsigned sourceLocation() const; + + /// Returns this Symbol's source offset. + unsigned sourceOffset() const; + + /// Returns this Symbol's line number. + unsigned line() const; + + /// Returns this Symbol's column number. + unsigned column() const; + + /// Returns this Symbol's file name. + StringLiteral *fileId() const; + + /// Returns this Symbol's file name. + const char *fileName() const; + + /// Returns this Symbol's file name length. + unsigned fileNameLength() const; + + /// Returns this Symbol's name. + Name *name() const; + + /// Sets this Symbol's name. + void setName(Name *name); // ### dangerous + + /// Returns this Symbol's storage class specifier. + int storage() const; + + /// Sets this Symbol's storage class specifier. + void setStorage(int storage); + + /// Returns this Symbol's visibility. + int visibility() const; + + /// Sets this Symbol's visibility. + void setVisibility(int visibility); + + /// Returns this Symbol's scope. + Scope *scope() const; + + /// Returns the next chained Symbol. + Symbol *next() const; + + /// Returns true if this Symbol has friend storage specifier. + bool isFriend() const; + + /// Returns true if this Symbol has register storage specifier. + bool isRegister() const; + + /// Returns true if this Symbol has static storage specifier. + bool isStatic() const; + + /// Returns true if this Symbol has extern storage specifier. + bool isExtern() const; + + /// Returns true if this Symbol has mutable storage specifier. + bool isMutable() const; + + /// Returns true if this Symbol has typedef storage specifier. + bool isTypedef() const; + + /// Returns true if this Symbol's visibility is public. + bool isPublic() const; + + /// Returns true if this Symbol's visibility is protected. + bool isProtected() const; + + /// Returns true if this Symbol's visibility is private. + bool isPrivate() const; + + /// Returns true if this Symbol is a ScopedSymbol. + bool isScopedSymbol() const; + + /// Returns true if this Symbol is an Enum. + bool isEnum() const; + + /// Returns true if this Symbol is an Function. + bool isFunction() const; + + /// Returns true if this Symbol is a Namespace. + bool isNamespace() const; + + /// Returns true if this Symbol is a Class. + bool isClass() const; + + /// Returns true if this Symbol is a Block. + bool isBlock() const; + + /// Returns true if this Symbol is a UsingNamespaceDirective. + bool isUsingNamespaceDirective() const; + + /// Returns true if this Symbol is a UsingDeclaration. + bool isUsingDeclaration() const; + + /// Returns true if this Symbol is a Declaration. + bool isDeclaration() const; + + /// Returns true if this Symbol is an Argument. + bool isArgument() const; + + /// Returns true if this Symbol is a BaseClass. + bool isBaseClass() const; + + const ScopedSymbol *asScopedSymbol() const; + const Enum *asEnum() const; + const Function *asFunction() const; + const Namespace *asNamespace() const; + const Class *asClass() const; + const Block *asBlock() const; + const UsingNamespaceDirective *asUsingNamespaceDirective() const; + const UsingDeclaration *asUsingDeclaration() const; + const Declaration *asDeclaration() const; + const Argument *asArgument() const; + const BaseClass *asBaseClass() const; + + ScopedSymbol *asScopedSymbol(); + Enum *asEnum(); + Function *asFunction(); + Namespace *asNamespace(); + Class *asClass(); + Block *asBlock(); + UsingNamespaceDirective *asUsingNamespaceDirective(); + UsingDeclaration *asUsingDeclaration(); + Declaration *asDeclaration(); + Argument *asArgument(); + BaseClass *asBaseClass(); + + /// Returns this Symbol's type. + virtual FullySpecifiedType type() const = 0; + + /// Returns this Symbol's hash value. + unsigned hashCode() const; + + /// Returns this Symbol's index. + unsigned index() const; + + Name *identity() const; + + void setScope(Scope *scope); // ### make me private + + void visitSymbol(SymbolVisitor *visitor); + static void visitSymbol(Symbol *symbol, SymbolVisitor *visitor); + +protected: + virtual void visitSymbol0(SymbolVisitor *visitor) = 0; + + TranslationUnit *translationUnit() const; + +private: + Control *_control; + unsigned _sourceLocation; + unsigned _sourceOffset; + Name *_name; + unsigned _hashCode; + int _storage; + int _visibility; + Scope *_scope; + unsigned _index; + Symbol *_next; + + class IdentityForName; + class HashCode; + + friend class Scope; +}; + +CPLUSPLUS_END_NAMESPACE +CPLUSPLUS_END_HEADER + +#endif // CPLUSPLUS_SYMBOL_H |