/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package com.sun.tools.example.debug.bdi;

import java.util.*;

import com.sun.jdi.*;

import com.sun.jdi.request.EventRequest;

abstract public class EventRequestSpec {

    static final int STATUS_UNRESOLVED = 1;

    static final int STATUS_RESOLVED = 2;

    static final int STATUS_ERROR = 3;

    static final Object specPropertyKey = "spec";

    final EventRequestSpecList specs;

    final ReferenceTypeSpec refSpec;

    EventRequest request = null;

    int status = STATUS_UNRESOLVED;

    EventRequestSpec(EventRequestSpecList specs, ReferenceTypeSpec refSpec) {

        this.specs = specs;

        this.refSpec = refSpec;

    }

    void setRequest(EventRequest request) {

        this.request = request;

        request.putProperty(specPropertyKey, this);

        request.enable();

    }

    /**

     * The 'refType' is known to match.

     */

    abstract void resolve(ReferenceType refType) throws Exception;

    abstract void notifySet(SpecListener listener, SpecEvent evt);

    abstract void notifyDeferred(SpecListener listener, SpecEvent evt);

    abstract void notifyResolved(SpecListener listener, SpecEvent evt);

    abstract void notifyDeleted(SpecListener listener, SpecEvent evt);

    abstract void notifyError(SpecListener listener, SpecErrorEvent evt);

    /**

     * The 'refType' is known to match.

     */

    void resolveNotify(ReferenceType refType) {

        try {

            resolve(refType);

            status = STATUS_RESOLVED;

            specs.notifyResolved(this);

        } catch(Exception exc) {

            status = STATUS_ERROR;

            specs.notifyError(this, exc);

        }

    }

    /**

     * See if 'refType' matches and resolve.

     */

    void attemptResolve(ReferenceType refType) {

        if (!isResolved() && refSpec.matches(refType)) {

            resolveNotify(refType);

        }

    }

    void attemptImmediateResolve(VirtualMachine vm) {

        // try to resolve immediately

        for (ReferenceType refType : vm.allClasses()) {

            if (refSpec.matches(refType)) {

                try {

                    resolve(refType);

                    status = STATUS_RESOLVED;

                    specs.notifySet(this);

                } catch(Exception exc) {

                    status = STATUS_ERROR;

                    specs.notifyError(this, exc);

                }

                return;

            }

        }

        specs.notifyDeferred(this);

    }

    public EventRequest getEventRequest() {

        return request;

    }

    /**

     * @return true if this spec has been resolved.

     */

    public boolean isResolved() {

        return status == STATUS_RESOLVED;

    }

    /**

     * @return true if this spec has not yet been resolved.

     */

    public boolean isUnresolved() {

        return status == STATUS_UNRESOLVED;

    }

    /**

     * @return true if this spec is unresolvable due to error.

     */

    public boolean isErroneous() {

        return status == STATUS_ERROR;

    }

    public String getStatusString() {

        switch (status) {

            case STATUS_RESOLVED:

                return "resolved";

            case STATUS_UNRESOLVED:

                return "deferred";

            case STATUS_ERROR:

                return "erroneous";

        }

        return "unknown";

    }

    boolean isJavaIdentifier(String s) {

        return Utils.isJavaIdentifier(s);

    }

    public String errorMessageFor(Exception e) {

        if (e instanceof IllegalArgumentException) {

            return ("Invalid command syntax");

        } else if (e instanceof RuntimeException) {

            // A runtime exception that we were not expecting

            throw (RuntimeException)e;

        } else {

            return ("Internal error; unable to set" + this);

        }

    }

}