// $Id: ParseState.java,v 1.16 2004/09/11 07:34:24 mvw Exp $
// Copyright (c) 2003-2004 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies.  This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason.  IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

// File: ParseState.java
// Classes: ParseState
// Original Author: Marcus Andersson andersson@users.sourceforge.net

package org.argouml.uml.reveng.java;

import java.util.*;

import org.argouml.model.ModelFacade;
import org.argouml.model.uml.foundation.core.CoreFactory;

/**
   The parse state keep control of data during parsing.
*/
class ParseState
{
    /** When the classifier parse is finished, these features will be
	removed from the model. */
    private Vector obsoleteFeatures;

    /** When the classifier parse is finished, these inner classes
        will be removed from the model. */
    private Vector obsoleteInnerClasses;

    /** This prefix is appended to inner classes, if any. */
    private String classnamePrefix;

    /** The available context for currentClassifier. */
    private Context context;

    /** The classifier that is parsed for the moment. */
    private Object classifier;

    /** Counter for anonymous innner classes */
    private int anonymousClassCounter;

    /** represents the source file being parsed */
    private Object component;
    /**
       Create a new parse state.

       @param model The model.
       @param javaLangPackage The default package java.lang.
     */
    public ParseState(Object model, Object javaLangPackage)
    {
	obsoleteInnerClasses = new Vector();
	classifier = null;
	context =
	    new PackageContext(new PackageContext(null, model),
				   javaLangPackage);
	anonymousClassCounter = 0;
    }

    /**
       Create a new parse state based on another parse state.

       @param previousState The base parse state.
       @param mClassifier The new classifier being parsed.
       @param currentPackage The current package being parsed.
     */
    public ParseState(ParseState previousState,
                      Object mClassifier,
                      Object currentPackage)
    {
	classnamePrefix =
	    previousState.classnamePrefix
	    + ModelFacade.getName(mClassifier)
	    + "$";
	obsoleteFeatures = new Vector(ModelFacade.getFeatures(mClassifier));
	obsoleteInnerClasses =
	    new Vector(ModelFacade.getOwnedElements(mClassifier));
	context = new OuterClassifierContext(previousState.context,
						     mClassifier,
						     currentPackage,
						     classnamePrefix);
	classifier = mClassifier;
	anonymousClassCounter = previousState.anonymousClassCounter;
    }

    /**
       Add a package to the current context.

       @param mPackage The package to add.
     */
    public void addPackageContext(Object mPackage)
    {
	context = new PackageContext(context, mPackage);
    }

    /**
       Add a classifier to the current context.

       @param mClassifier The classifier to add.
     */
    public void addClassifierContext(Object mClassifier)
    {
	context = new ClassifierContext(context, mClassifier);
    }

    /**
     * @param c the source file being parsed
     */
    public void addComponent(Object c) {
        this.component = c;
    }
    
    /**
     * @return the source file being parsed
     */
    public Object getComponent() {
        return component;
    }
    
    /**
       Get the current context.

       @return The current context.
     */
    public Context getContext()
    {
	return context;
    }

    /**
       Get the current classifier.

       @return The current classifier.
     */
    public Object getClassifier()
    {
	return classifier;
    }

    /**
       Tell the parse state that an anonymous class is being parsed.

       @return The name of the anonymous class.
     */
    public String anonymousClass()
    {
	classnamePrefix =
	    classnamePrefix.substring(0, classnamePrefix.indexOf("$") + 1);
	anonymousClassCounter++;
	return (new Integer(anonymousClassCounter)).toString();
    }

    /**
       Tell the parse state that an outer class is being parsed.
     */
    public void outerClassifier()
    {
	classnamePrefix = "";
	anonymousClassCounter = 0;
    }

    /**
       Get the current classname prefix.

       @return The current classname prefix.
     */
    public String getClassnamePrefix()
    {
	return classnamePrefix;
    }

    /**
       Tell the parse state that a classifier is an inner classifier
       to the current parsed classifier.

       @param mClassifier The inner classifier.
    */
    public void innerClassifier(Object mClassifier)
    {
	obsoleteInnerClasses.remove(mClassifier);
    }

    /**
     * Remove features no longer in the source from the current
     * classifier in the model.
     */
    public void removeObsoleteFeatures() {
    	if (obsoleteFeatures == null) {
	    return;
	}
    	for (Iterator i = obsoleteFeatures.iterator(); i.hasNext(); ) {
	    ModelFacade.removeFeature(classifier, i.next());
    	}
    }

    /**
     * Remove inner classes no longer in the source from the current
     * classifier in the model.
     */
    public void removeObsoleteInnerClasses() {
    	if (obsoleteInnerClasses == null) {
	    return;
	}
	for (Iterator i = obsoleteInnerClasses.iterator(); i.hasNext(); ) {
	    Object element = i.next();
	    if (ModelFacade.isAClassifier(element)) {
		CoreFactory.getFactory().deleteClassifier(element);
	    }
	}
    }

    /**
       Tell the parse state that a feature belongs to the current
       classifier.

       @param feature The feature.
    */
    public void feature(Object feature)
    {
	obsoleteFeatures.remove(feature);
    }

    /**
       Get a feature from the current classifier not yet modeled.

       @param name The name of the feature.
       @return The found feature, null if not found.
     */
    public Object getFeature(String name)
    {
	for (Iterator i = obsoleteFeatures.iterator(); i.hasNext(); ) {
	    Object mFeature = i.next();
	    if (name.equals(ModelFacade.getName(mFeature))) {
		return mFeature;
	    }
	}
	return null;
    }

    /**
       Get a features from the current classifier not yet modeled.

       @param name The name of the feature.
       @return The collection of found features
     */
    public Collection getFeatures(String name)
    {
    	ArrayList list = new ArrayList();
	for (Iterator i = obsoleteFeatures.iterator(); i.hasNext(); ) {
	    Object mFeature = i.next();
	    if (name.equals(ModelFacade.getName(mFeature))) {
		list.add(mFeature);
	    }
	}
	return list;
    }

    /**
       Get a method from the current classifier not yet modeled.

       @param name The name of the method.
       @return The found method, null if not found.
     */
    public Object getMethod(String name)
    {
	for (Iterator i = obsoleteFeatures.iterator(); i.hasNext(); ) {
	    Object mFeature = i.next();
	    if (ModelFacade.isAMethod(mFeature)
		&& name.equals(ModelFacade.getName(mFeature)))
	    {
		return mFeature;
	    }
	}
	return null;
    }

    /**
       Get a operation from the current classifier not yet modeled.

       @param name The name of the operation.
       @return The found operation, null if not found.
     */
    public Object getOperation(String name)
    {
	for (Iterator i = obsoleteFeatures.iterator(); i.hasNext(); ) {
	    Object mFeature = i.next();
	    if (ModelFacade.isAOperation(mFeature)
		&& name.equals(ModelFacade.getName(mFeature)))
	    {
		return mFeature;
	    }
	}
	return null;
    }
}