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-2006 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: package org.netbeans.modules.php.editor.completion;
042:
043: import java.util.List;
044: import org.netbeans.modules.gsf.api.CompletionProposal;
045: import org.netbeans.modules.gsf.api.HtmlFormatter;
046: import org.netbeans.modules.php.model.ClassBody;
047: import org.netbeans.modules.php.model.ClassDefinition;
048: import org.netbeans.modules.php.model.FunctionDefinition;
049: import org.netbeans.modules.php.model.SourceElement;
050:
051: /**
052: * Implementation of the <code>CompletionResultProvider</code> for the new
053: * instruction context in the method body (i.e. body of the function defined in
054: * the body of the class).
055: *
056: * <p><b>Note that this implementation is not synchronized.</b></p>
057: *
058: * @author Victor G. Vasilyev
059: */
060: public class MethodBodyContext extends NewInstructionContext implements
061: CompletionResultProvider {
062:
063: /**
064: * Returns <code>true</code> iif the specified <code>context</code>
065: * is applicable for inserting a new instruction in the method body.
066: * E.g
067: * <p>
068: * <b><?php</b> <b>function</b> some_name($arg1, $arg2) { ...
069: * <i>Instruction</i><b>;</b>
070: * <span style="color: rgb(255, 0, 0);"><blink>|</blink></span>
071: * <i>Instruction</i><b>;</b>
072: * ... } <b>?></b>
073: * </p>
074: *
075: * @param context
076: * @return <code>true</code> iif the specified <code>context</code>
077: * is applicable.
078: */
079: @Override
080: public boolean isApplicable(CodeCompletionContext context) {
081: if (!super .isApplicable(context)) {
082: return false;
083: }
084: // check if context.getSourceElement() is a function body and
085: // its parent is a <code>ClassDefinition</code>
086: SourceElement e = context.getSourceElement();
087: if (e instanceof FunctionDefinition) {
088: SourceElement parent = e.getParent();
089: if (parent instanceof ClassBody) {
090: parent = parent.getParent();
091: if (parent instanceof ClassDefinition) {
092: //caching the ClassDefinition
093: classDefinition = (ClassDefinition) parent;
094: return true;
095: }
096: }
097: }
098: return false;
099: }
100:
101: @Override
102: public List<CompletionProposal> getProposals(
103: final CodeCompletionContext context) {
104: checkContext(context);
105: super .addStaticProposals();
106: return proposalList;
107: }
108:
109: /** Adds the proposals that are applicable to any context. */
110: @Override
111: protected void addStaticProposals() {
112: int caretOffset = getCaretOffset();
113: HtmlFormatter formater = getFormatter();
114: // TODO SpecialKeywords
115: // proposalList.add(new KeywordItem(Keywords.CLASS, caretOffset, formater));
116: }
117:
118: protected ClassDefinition getClassDefinition() {
119: return classDefinition;
120: }
121:
122: private ClassDefinition classDefinition;
123:
124: }
|