001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.cnd.api.model;
043:
044: import java.util.List;
045:
046: /**
047: * Represents type
048: *
049: * Comments about offsetable part and text of type objects:
050: * type has start-end around it's classifier part, while return full text,
051: * i.e int a[5],b;
052: * ^ ^
053: * | |
054: * st end
055: * for variable a getText() returns "int[5]"
056: * for variable b getText() returns "int"
057: * @author Vladimir Kvashin
058: */
059: public interface CsmType extends CsmOffsetable {
060:
061: // /**
062: // * Returns true if this type is a template instantiation
063: // */
064: // boolean isTemplateInstantiation();
065:
066: /** gets classifier this type references to */
067: CsmClassifier getClassifier();
068:
069: CharSequence getClassifierText();
070:
071: boolean isInstantiation();
072:
073: List<CsmType> getInstantiationParams();
074:
075: /** array depth, i.e. 2 for "int[][]", 1 for "int[]", 0 for "int" */
076: int getArrayDepth();
077:
078: boolean isPointer();
079:
080: /** if this is a pointer, returns the number of asterisks */
081: int getPointerDepth();
082:
083: boolean isReference();
084:
085: boolean isConst();
086:
087: // TODO: [] and * are the same?
088: // is there a connection between isPointer() and isReference()
089:
090: // TODO: how to get from CsmType (int[][]) CsmType (int[]) ?
091:
092: // TODO: how to get from CsmType (int*) CsmType (int**) ?
093:
094: /**
095: * checks wether type is reference to built-in type or not
096: * @param resolveTypeChain if true then resolve all typedefs (slow down)
097: */
098: boolean isBuiltInBased(boolean resolveTypeChain);
099:
100: /**
101: * Returns a canonical representation of this type.
102: * This canonical representation is used to form signatures
103: * and compare types with each other
104: */
105: CharSequence getCanonicalText();
106: }
|