org.netbeans.api.debugger.DebuggerEngine Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.api.debugger;
import java.util.Collections;
import java.util.List;
import org.netbeans.spi.debugger.ContextProvider;
/**
* Debugger Engine represents implementation of one debugger (Java Debugger,
* CPP Debugger). It can support debugging of one or more
* {@link Session}s, in one or more languages.
* It provides root of threads hierarchy (call stacks, locals)
* and manages debugger actions.
*
*
* Description of DebuggerEngine
*
* Description
*
* Functionality
*
* Support for actions:
* DebuggerEngine manages list of actions ({@link #getActionsManager}).
* Debugger action (implemented by
* {@link org.netbeans.spi.debugger.ActionsProvider}) can be registerred to
* DebuggerEngine during a start of debugger. See
* {@link org.netbeans.spi.debugger.ActionsProvider}.
* ActionsManager can be used to call some debugger action
* ({@link ActionsManager#doAction}) and to distinguish availability of action
* ({@link ActionsManager#isEnabled}).
* Example how to call Kill Action on this engine:
*
* engine.getActionsManager ().doAction (ActionsManager.ACTION_KILL);
*
*
* Support for aditional services:
* DebuggerEngine is final class. That is why the standard method how to
* extend its functionality is using lookup methods ({@link #lookup(String,Class)} and
* {@link #lookupFirst(String,Class)}).
* There are two ways how to register some service provider for some
* type of DebuggerEngine:
*
* - Register 'live' instance of service provider during creation of
* new instance of DebuggerEngine (see method
* {@link org.netbeans.spi.debugger.DebuggerEngineProvider#getServices}).
*
* - Register service provider in Manifest-inf/debugger/<type ID>
* folder. See Debugger SPI for more information about
* registration.
*
*
*
* Support for listening:
* DebuggerEngine propagates all changes to two type of listeners - general
* {@link java.beans.PropertyChangeListener} and specific
* {@link ActionsManagerListener}.
*
*
*
* Clinents / Providers
*
* This class is final, so it does not have any external provider.
* Debugger Plug-ins and UI modules are clients of this class.
*
*
*
* Lifecycle
*
* A new instance(s) of DebuggerEngine class are created in Debugger Core
* module only, during the process of starting of debugging (see
* {@link DebuggerManager#startDebugging}.
*
* DebuggerEngine is removed automatically from {@link DebuggerManager} when the
* the last action is ({@link ActionsManager#ACTION_KILL}).
*
*
* Evolution
*
* No method should be removed from this class, but some functionality can
* be added in future.
*
*
*
* @author Jan Jancura
*/
public final class DebuggerEngine implements ContextProvider {
// variables ...............................................................
private Lookup privateLookup;
private Lookup lookup;
private ActionsManager actionsManager;
private Session s;
DebuggerEngine (
String typeID,
Session s,
Object[] services,
Lookup sessionLookup
) {
Object[] services1 = new Object [services.length + 1];
System.arraycopy (services, 0, services1, 0, services.length);
services1 [services1.length - 1] = this;
this.privateLookup = new Lookup.Compound (
new Lookup.Instance (services1),
new Lookup.MetaInf (typeID)
);
this.lookup = new Lookup.Compound (
privateLookup,
sessionLookup
);
this.s = s;
}
Lookup getLookup() {
return lookup;
}
Lookup getPrivateLookup() {
return privateLookup;
}
// /**
// * Returns list of services of given type.
// *
// * @param service a type of service to look for
// * @return list of services of given type
// */
// public List lookup (Class service) {
// return lookup.lookup (null, service);
// }
//
// /**
// * Returns one service of given type.
// *
// * @param service a type of service to look for
// * @return ne service of given type
// */
// public Object lookupFirst (Class service) {
// return lookup.lookupFirst (null, service);
// }
/**
* Returns list of services of given type from given folder.
*
* @param service a type of service to look for
* @return list of services of given type
*/
public List lookup(String folder, Class service) {
if (service.equals(Session.class)) {
return (List) Collections.singletonList(s);
}
return lookup.lookup (folder, service);
}
/**
* Returns one service of given type from given folder.
*
* @param service a type of service to look for
* @return ne service of given type
*/
public T lookupFirst(String folder, Class service) {
if (service.equals(Session.class)) {
return (T) s;
}
return lookup.lookupFirst (folder, service);
}
// main public methods .....................................................
public synchronized ActionsManager getActionsManager () {
if (actionsManager == null)
actionsManager = new ActionsManager (lookup);
return actionsManager;
}
// innerclasses ............................................................
/**
* This class notifies about DebuggerEngine remove from the system, and
* about changes in language support. Instance of Destructor can be
* obtained from: {@link org.netbeans.spi.debugger.DebuggerEngineProvider#setDestructor(DebuggerEngine.Destructor)}, or
* {@link org.netbeans.spi.debugger.DelegatingDebuggerEngineProvider#setDestructor(DebuggerEngine.Destructor)}.
*/
public class Destructor {
/**
* Removes DebuggerEngine form all sessions.
*/
public void killEngine () {
Session[] ss = DebuggerManager.getDebuggerManager ().getSessions ();
int i, k = ss.length;
for (i = 0; i < k; i++)
ss [i].removeEngine (DebuggerEngine.this);
getActionsManager ().destroy ();
}
/**
* Removes given language support from given session.
*
* @param s a session
* @param language a language to be removed
*/
public void killLanguage (Session s, String language) {
s.removeLanguage (language, DebuggerEngine.this);
getActionsManager ().destroy ();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy