org.netbeans.modules.debugger.ui.WatchesReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org-netbeans-spi-debugger-ui Show documentation
The newest version!
/*
 * 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.modules.debugger.ui;

import java.awt.Point;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.netbeans.api.debugger.DebuggerManager;
import org.netbeans.api.debugger.Properties;
import org.netbeans.api.debugger.Watch;
import org.netbeans.api.debugger.Watch.Pin;
import org.netbeans.spi.debugger.DebuggerServiceRegistration;
import org.netbeans.spi.debugger.ui.EditorPin;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.URLMapper;


/**
 *
 * @author Jan Jancura
 */
@DebuggerServiceRegistration(types = Properties.Reader.class)
public class WatchesReader implements Properties.Reader {
    
    private static final Logger LOG = Logger.getLogger(WatchesReader.class.getName());

    private static final String PIN = "pin";                    // NOI18N
    private static final String PIN_URL = "url";                // NOI18N
    private static final String PIN_LINE = "line";              // NOI18N
    private static final String PIN_LOCATION_X = "locationX";   // NOI18N
    private static final String PIN_LOCATION_Y = "locationY";   // NOI18N
    private static final String PIN_COMMENT = "comment";        // NOI18N
    private static final String PIN_VP_ID = "valueProviderId";  // NOI18N
    
    public static PinReaderAccess PIN_READER_ACCESS;

    public String [] getSupportedClassNames () {
        return new String[] {
            Watch.class.getName (),
            EditorPin.class.getName()
        };
    }
    public Object read (String typeID, Properties properties) {
        if (typeID.equals (Watch.class.getName ())) {
            String expression = properties.getString (Watch.PROP_EXPRESSION, null);
            Pin pin = (Pin) properties.getObject(PIN, null);
            Watch watch;
            if (pin != null) {
                watch = DebuggerManager.getDebuggerManager().createPinnedWatch(expression, pin);
            } else {
                watch = DebuggerManager.getDebuggerManager().createWatch(expression);
            }
            watch.setEnabled(properties.getBoolean(Watch.PROP_ENABLED, true));
            return watch;
        }
        if (typeID.equals(EditorPin.class.getName())) {
            String urlStr = properties.getString(PIN_URL, null);
            URL url;
            try {
                url = new URL(urlStr);
            } catch (MalformedURLException ex) {
                LOG.log(Level.CONFIG, "urlStr = "+urlStr, ex);
                return null;
            }
            FileObject fo = URLMapper.findFileObject(url);
            if (fo == null) {
                return null;    // The file's gone.
            }
            int line = properties.getInt(PIN_LINE, 0);
            Point location = new Point(properties.getInt(PIN_LOCATION_X, 0),
                                       properties.getInt(PIN_LOCATION_Y, 0));
            EditorPin pin = new EditorPin(fo, line, location);
            String comment = properties.getString(PIN_COMMENT, null);
            if (comment != null) {
                pin.setComment(comment);
            }
            PIN_READER_ACCESS.setVpId(pin, properties.getString(PIN_VP_ID, null));
            return pin;
        }
        return null;
    }
    
    public void write (Object object, Properties properties) {
        if (object instanceof Watch) {
            Watch w = (Watch) object;
            properties.setString (
                Watch.PROP_EXPRESSION, 
                w.getExpression ()
            );
            properties.setBoolean(Watch.PROP_ENABLED, w.isEnabled());
            Watch.Pin pin = w.getPin();
            properties.setObject(PIN, pin);
        } else if (object instanceof EditorPin) {
            EditorPin pin = (EditorPin) object;
            properties.setString(PIN_URL, pin.getFile().toURL().toExternalForm());
            properties.setInt(PIN_LINE, pin.getLine());
            properties.setInt(PIN_LOCATION_X, pin.getLocation().x);
            properties.setInt(PIN_LOCATION_Y, pin.getLocation().y);
            String comment = pin.getComment();
            properties.setString(PIN_COMMENT, comment);
            properties.setString(PIN_VP_ID, PIN_READER_ACCESS.getVpId(pin));
        }
    }
    
    public static interface PinReaderAccess {

        String getVpId(EditorPin pin);

        void setVpId(EditorPin pin, String vpId);

    }

}