/*******************************************************************************
 * Copyright (c) 2009 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Zend Technologies
 *******************************************************************************/
package org.eclipse.php.internal.ui.functions;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.eclipse.dltk.ast.Modifiers;
import org.eclipse.dltk.core.IField;
import org.eclipse.dltk.core.IModelElement;
import org.eclipse.dltk.core.ModelException;

/**
 * This Node is shown in the first level of the PHP Functions view. It
 * aggregates all of the PHP constants
 * 
 * @author Eden K., 2008
 * 
 */
public class ConstantNode {

	private static final String CONSTANT_NODE_LABEL = "constants"; //$NON-NLS-1$

	public ConstantNode() {
	}

	List<IModelElement> modules = new ArrayList<>();

	public Object[] getChildren() {
		List<IField> children = new ArrayList<>();
		// only the constants should be shown under this node
		for (IModelElement element : modules) {
			if (isConstant(element)) {
				children.add((IField) element);
			}
		}
		return children.toArray(new Object[children.size()]);
	}

	public void addSourceModuleChildren(IModelElement[] externalSourceModuleChildren) {
		modules.addAll(Arrays.asList(externalSourceModuleChildren));

	}

	public String getName() {
		return CONSTANT_NODE_LABEL;
	}

	/**
	 * Gets a model element and verifies if it is a constant
	 * 
	 * @param element
	 * @return whether the element is a constant or not
	 */
	public static boolean isConstant(IModelElement element) {
		boolean isConstant = false;

		if (element.getElementType() == IModelElement.FIELD) {
			IField field = (IField) element;
			try {
				if ((field.getFlags() & Modifiers.AccConstant) != 0) {
					isConstant = true;
				}

			} catch (ModelException e) {
				isConstant = false;
			}
		}

		return isConstant;
	}
}