diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..3d47f986c41db29ec6dc0d5036bf760b3a1cf366
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,6 @@
+.idea/
+target/
+.settings/
+*.iml
+.project
+.classpath
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
new file mode 100644
index 0000000000000000000000000000000000000000..0f57dc0274f7e2b5a05242a47d4fabb331bcca5a
--- /dev/null
+++ b/pom.xml
@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <!-- Inherited Icy Parent POM -->
+ <parent>
+ <groupId>org.bioimageanalysis.icy</groupId>
+ <artifactId>parent-pom-plugin</artifactId>
+ <version>1.0.3</version>
+ </parent>
+
+ <!-- Project Information -->
+ <artifactId>microscope-remote</artifactId>
+ <version>2.3.1</version>
+
+ <packaging>jar</packaging>
+
+ <name>Microscope Remote</name>
+ <description>Move your XY Stage and Focus Device with your mouse. </description>
+ <url>http://icy.bioimageanalysis.org/plugin/microscope-remote/</url>
+ <inceptionYear>2020</inceptionYear>
+
+ <organization>
+ <name>Institut Pasteur</name>
+ <url>https://pasteur.fr</url>
+ </organization>
+
+ <licenses>
+ <license>
+ <name>GNU GPLv3</name>
+ <url>https://www.gnu.org/licenses/gpl-3.0.en.html</url>
+ <distribution>repo</distribution>
+ </license>
+ </licenses>
+
+ <developers>
+ <developer>
+ <id>sdallongeville</id>
+ <name>Stéphane Dallongeville</name>
+ <url>https://research.pasteur.fr/fr/member/stephane-dallongeville/</url>
+ <roles>
+ <role>founder</role>
+ <role>lead</role>
+ <role>architect</role>
+ <role>developer</role>
+ <role>debugger</role>
+ <role>tester</role>
+ <role>maintainer</role>
+ <role>support</role>
+ </roles>
+ </developer>
+ </developers>
+
+ <!-- Project properties -->
+ <properties>
+
+ </properties>
+
+ <!-- Project build configuration -->
+ <build>
+
+ </build>
+
+ <!-- List of project's dependencies -->
+ <dependencies>
+ <!-- The core of Icy -->
+ <dependency>
+ <groupId>org.bioimageanalysis.icy</groupId>
+ <artifactId>icy-kernel</artifactId>
+ </dependency>
+
+ <dependency>
+ <groupId>org.bioimageanalysis.icy</groupId>
+ <artifactId>micromanager</artifactId>
+ <version>1.9.0</version>
+ </dependency>
+
+ </dependencies>
+
+ <!-- Icy Maven repository (to find parent POM) -->
+ <repositories>
+ <repository>
+ <id>icy</id>
+ <name>Icy's Nexus</name>
+ <url>https://icy-nexus.pasteur.fr/repository/Icy/</url>
+ </repository>
+ </repositories>
+</project>
\ No newline at end of file
diff --git a/src/main/java/plugins/tprovoost/Microscopy/MicroscopeRemote/MicroscopeRemotePlugin.java b/src/main/java/plugins/tprovoost/Microscopy/MicroscopeRemote/MicroscopeRemotePlugin.java
new file mode 100644
index 0000000000000000000000000000000000000000..601ac96de0db514eec4101d81135dcf65b555096
--- /dev/null
+++ b/src/main/java/plugins/tprovoost/Microscopy/MicroscopeRemote/MicroscopeRemotePlugin.java
@@ -0,0 +1,52 @@
+package plugins.tprovoost.Microscopy.MicroscopeRemote;
+
+import icy.gui.frame.IcyFrameAdapter;
+import icy.gui.frame.IcyFrameEvent;
+import plugins.tprovoost.Microscopy.MicroManagerForIcy.MicroscopePlugin;
+import plugins.tprovoost.Microscopy.gui.RemoteFrame;
+
+/**
+ * @author Irsath Nguyen
+ */
+public class MicroscopeRemotePlugin extends MicroscopePlugin
+{
+ // static instance
+ static RemoteFrame instance = null;
+
+ public MicroscopeRemotePlugin()
+ {
+ if (instance == null)
+ {
+ // Creation of the frame.
+ instance = new RemoteFrame(this);
+
+ // Add a listener on the frame : when the frame is closed
+ // the plugin is removed from the GUI plugin
+ instance.addFrameListener(new IcyFrameAdapter()
+ {
+ @Override
+ public void icyFrameClosed(IcyFrameEvent e)
+ {
+ shutdown();
+ }
+ });
+ }
+ }
+
+ @Override
+ public void start()
+ {
+ if (instance != null)
+ instance.toFront();
+ }
+
+ @Override
+ public void shutdown()
+ {
+ super.shutdown();
+
+ if (instance != null)
+ instance.dispose();
+ instance = null;
+ }
+}
diff --git a/src/main/java/plugins/tprovoost/Microscopy/gui/InverterCheckBox.java b/src/main/java/plugins/tprovoost/Microscopy/gui/InverterCheckBox.java
new file mode 100644
index 0000000000000000000000000000000000000000..417b1b31742e1a4efb4bc08a933b842f37483248
--- /dev/null
+++ b/src/main/java/plugins/tprovoost/Microscopy/gui/InverterCheckBox.java
@@ -0,0 +1,78 @@
+package plugins.tprovoost.Microscopy.gui;
+
+import java.awt.Color;
+import java.awt.Font;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.RenderingHints;
+import java.awt.image.BufferedImage;
+
+import javax.swing.JCheckBox;
+
+public class InverterCheckBox extends JCheckBox {
+
+ /** */
+ private static final long serialVersionUID = 4893333197103321565L;
+
+ private static int knobLength = 40;
+ private static int knobHeight = 20;
+ private static int buttonSize = 20;
+
+ // IMAGES
+ private BufferedImage imgBtnInvertOn;
+ private BufferedImage imgBtnInvertOff;
+ private BufferedImage imgLightOn;
+ private BufferedImage imgLightOff;
+
+ public InverterCheckBox(String string) {
+ super(string);
+ }
+
+ public void setImages(BufferedImage imgBtnInvertOn,
+ BufferedImage imgBtnInvertOff, BufferedImage imgLightOn,
+ BufferedImage imgLightOff) {
+ this.imgBtnInvertOn = imgBtnInvertOn;
+ this.imgBtnInvertOff = imgBtnInvertOff;
+ this.imgLightOn = imgLightOn;
+ this.imgLightOff = imgLightOff;
+ }
+
+ @Override
+ protected void paintComponent(Graphics g) {
+ super.paintComponent(g);
+ boolean selected = isSelected();
+ String text = getText();
+ Font f = new Font("Arial", Font.BOLD, 16);
+ int actualWidthIdx = 30;
+ int height = getHeight();
+
+ Graphics2D g2 = (Graphics2D) g.create();
+ g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING,RenderingHints.VALUE_ANTIALIAS_ON);
+ g2.setFont(f);
+ FontMetrics fm = g2.getFontMetrics();
+ g2.setColor(new Color(39, 39, 39, 255));
+ g2.fillRect(0, 0, getWidth(), height);
+ g2.setColor(Color.lightGray);
+
+ // Draw the knob
+ if (selected) {
+ g2.drawImage(imgBtnInvertOn, actualWidthIdx - 20, height / 2- knobHeight / 2, knobLength, knobHeight, null);
+ } else {
+ g2.drawImage(imgBtnInvertOff, actualWidthIdx - 20, height / 2- knobHeight / 2, knobLength, knobHeight, null);
+ }
+ actualWidthIdx += 20;
+
+ // draw the text
+ g2.drawString(text, actualWidthIdx += 20, height / 2 + fm.getHeight()/ 2);
+ actualWidthIdx += 120;
+
+ // draw the light
+ if (selected) {
+ g2.drawImage(imgLightOn, actualWidthIdx + 20, height / 2- buttonSize / 2, buttonSize, buttonSize, null);
+ } else {
+ g2.drawImage(imgLightOff, actualWidthIdx + 20, height / 2- buttonSize / 2, buttonSize, buttonSize, null);
+ }
+ g2.dispose();
+ }
+}
\ No newline at end of file
diff --git a/src/main/java/plugins/tprovoost/Microscopy/gui/MemoryButton.java b/src/main/java/plugins/tprovoost/Microscopy/gui/MemoryButton.java
new file mode 100644
index 0000000000000000000000000000000000000000..75d0325a1d4885a4099a660934133bcd741e2393
--- /dev/null
+++ b/src/main/java/plugins/tprovoost/Microscopy/gui/MemoryButton.java
@@ -0,0 +1,157 @@
+package plugins.tprovoost.Microscopy.gui;
+
+import java.awt.Color;
+import java.awt.Font;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.RenderingHints;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseListener;
+import java.awt.image.BufferedImage;
+
+import javax.swing.JButton;
+
+import icy.gui.frame.progress.AnnounceFrame;
+import icy.gui.frame.progress.FailedAnnounceFrame;
+import icy.type.point.Point3D;
+import plugins.tprovoost.Microscopy.MicroManager.tools.StageMover;
+
+public class MemoryButton extends JButton implements MouseListener
+{
+
+ /** Default serial UID */
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * When the button is pressed, the {@link System#nanoTime()} is stored in
+ * this variable.
+ */
+ long datePressed = 0;
+
+ // IMAGES FOR DRAWING
+ private BufferedImage imgMemBtnOn = null;
+ private BufferedImage imgMemBtnOff = null;
+
+ /** This variable contains the value of the 3D point in this memory button. */
+ private Point3D.Double memoryButtonPoint;
+
+ public MemoryButton(String string, BufferedImage imgMemBtnOn, BufferedImage imgMemBtnOff)
+ {
+ super(string);
+
+ this.imgMemBtnOn = imgMemBtnOn;
+ this.imgMemBtnOff = imgMemBtnOff;
+ setOpaque(true);
+ addMouseListener(this);
+ }
+
+ private void forgetPoint()
+ {
+ memoryButtonPoint = null;
+ setSelected(false);
+ }
+
+ private void rememberPoint() throws Exception
+ {
+ Point3D.Double xyz = StageMover.getXYZ();
+ if (memoryButtonPoint == null)
+ memoryButtonPoint = xyz;
+ else
+ memoryButtonPoint.setLocation(xyz);
+ setSelected(true);
+ }
+
+ private void gotoPoint() throws Exception
+ {
+ if (memoryButtonPoint != null)
+ {
+ StageMover.moveXYAbsolute(memoryButtonPoint.x, memoryButtonPoint.y);
+ StageMover.moveZAbsolute(memoryButtonPoint.z);
+ }
+ }
+
+ @Override
+ public void mouseEntered(MouseEvent e)
+ {
+ }
+
+ @Override
+ public void mouseExited(MouseEvent e)
+ {
+ }
+
+ @Override
+ public void mouseClicked(MouseEvent e)
+ {
+ }
+
+ @Override
+ public void mousePressed(MouseEvent e)
+ {
+ if (e.isControlDown())
+ forgetPoint();
+ else
+ datePressed = System.nanoTime();
+ }
+
+ @Override
+ public void mouseReleased(MouseEvent e)
+ {
+ // quick press ?
+ if (System.nanoTime() - datePressed < 1500000000L)
+ {
+ try
+ {
+ gotoPoint();
+ }
+ catch (Exception e1)
+ {
+ new AnnounceFrame("Error while going to the saved point.");
+ }
+ }
+ else
+ {
+ // long press
+ try
+ {
+ rememberPoint();
+ }
+ catch (Exception e1)
+ {
+ new FailedAnnounceFrame("Failed to save position, please try again", 3);
+ }
+ }
+ }
+
+ @Override
+ public void paint(Graphics g)
+ {
+ super.paint(g);
+ boolean selected = isSelected();
+ int width = getWidth();
+ int height = getHeight();
+ Graphics2D g2 = (Graphics2D) g.create();
+ g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
+
+ if (selected)
+ {
+ g2.drawImage(imgMemBtnOn, 0, 0, width, height, null);
+ g2.setColor(Color.black);
+
+ }
+ else
+ {
+ g2.drawImage(imgMemBtnOff, 0, 0, width, height, null);
+ g2.setColor(Color.LIGHT_GRAY);
+
+ }
+
+ g2.setFont(new Font("Arial", Font.BOLD, 20));
+ FontMetrics fm = g2.getFontMetrics();
+ String toDisplay = getText();
+ g2.drawString(toDisplay, width / 2 - fm.charsWidth(toDisplay.toCharArray(), 0, toDisplay.length()) / 2,
+ height / 2 + fm.getHeight() / 3);
+ g2.dispose();
+ }
+}
\ No newline at end of file
diff --git a/src/main/java/plugins/tprovoost/Microscopy/gui/PanelMoverXY.java b/src/main/java/plugins/tprovoost/Microscopy/gui/PanelMoverXY.java
new file mode 100644
index 0000000000000000000000000000000000000000..5a1d2f32b654c0dbb80ae27b126bda7a60a926a0
--- /dev/null
+++ b/src/main/java/plugins/tprovoost/Microscopy/gui/PanelMoverXY.java
@@ -0,0 +1,246 @@
+package plugins.tprovoost.Microscopy.gui;
+
+import java.awt.Color;
+import java.awt.Dimension;
+import java.awt.GradientPaint;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.MultipleGradientPaint.CycleMethod;
+import java.awt.Paint;
+import java.awt.RadialGradientPaint;
+import java.awt.RenderingHints;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseListener;
+import java.awt.event.MouseMotionListener;
+import java.awt.geom.AffineTransform;
+import java.awt.geom.Point2D;
+import java.awt.image.BufferedImage;
+
+import javax.swing.JPanel;
+
+import plugins.tprovoost.Microscopy.MicroManager.MicroManager;
+import plugins.tprovoost.Microscopy.MicroManager.tools.StageMover;
+
+/**
+ * @author Irsath Nguyen
+ */
+public class PanelMoverXY extends JPanel implements MouseListener, MouseMotionListener, Runnable
+{
+
+ /**
+ * Generated serial UID
+ */
+ private static final long serialVersionUID = -5025582239086787935L;
+
+ private BufferedImage imgXYBg = null;
+ private static final int SIZE_PANEL_MOVER = 200;
+
+ /** Movement Vector */
+ private Point2D vector;
+ private RemoteFrame frame;
+ private Thread moveThread;
+
+ public PanelMoverXY(RemoteFrame frame)
+ {
+ super();
+
+ this.frame = frame;
+ vector = new Point2D.Double(0, 0);
+ setOpaque(true);
+ setDoubleBuffered(true);
+ setSize(new Dimension(SIZE_PANEL_MOVER, SIZE_PANEL_MOVER));
+ setPreferredSize(new Dimension(SIZE_PANEL_MOVER, SIZE_PANEL_MOVER));
+ addMouseListener(this);
+ addMouseMotionListener(this);
+
+ imgXYBg = frame.plugin.getImageResource(RemoteFrame.currentPath + "remote_backgroundXY.png");
+ moveThread = new Thread(this, "Remote XY mover");
+ moveThread.start();
+ }
+
+ @Override
+ public void paintComponent(Graphics g)
+ {
+ super.paintComponent(g);
+ int w = getWidth();
+ int h = getHeight();
+ AffineTransform at;
+ Graphics2D g2 = (Graphics2D) g.create();
+ g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
+ g2.setColor(new Color(39, 39, 39));
+ g2.fillRect(0, 0, w, h);
+
+ if (imgXYBg != null)
+ {
+ g2.drawImage(imgXYBg, 0, 0, w, h, null);
+ int stickBallDiameter = w / 5;
+ Point2D centerBall = new Point2D.Double(w / 2d + vector.getX(), h / 2d + vector.getY());
+ g2.setColor(Color.darkGray);
+ double normVector = norm(vector);
+ if (vector.getX() != 0 || vector.getY() != 0)
+ {
+ g2.setColor(Color.blue);
+ // ----------
+ // draw stick
+ // ----------
+ Graphics2D g3 = (Graphics2D) g2.create();
+ at = AffineTransform.getTranslateInstance(centerBall.getX(), centerBall.getY());
+ at.rotate(-vector.getX(), -vector.getY());
+ at.translate(0, -stickBallDiameter / 4);
+ g3.transform(at);
+ g3.setPaint(new GradientPaint(new Point2D.Double(0, 0), Color.BLACK, new Point2D.Double(0,
+ (getWidth() / 5) / 4), Color.LIGHT_GRAY, true));
+ g3.fillRoundRect(0, 0, (int) normVector, stickBallDiameter / 2, stickBallDiameter / 2,
+ stickBallDiameter / 2);
+ g3.dispose();
+ }
+ // ---------
+ // draw ball
+ // ---------
+ Paint defaultPaint = g2.getPaint();
+ Point2D centerGradient = new Point2D.Double(centerBall.getX(), centerBall.getY());
+ float radiusGradient = stickBallDiameter / 2;
+ Point2D focusSpotLightGradient;
+ if (Math.abs(vector.getX()) <= 1 && Math.abs(vector.getY()) <= 1)
+ {
+ focusSpotLightGradient = new Point2D.Double(centerBall.getX(), centerBall.getY());
+ }
+ else
+ {
+ focusSpotLightGradient = new Point2D.Double(centerBall.getX() + vector.getX() * (radiusGradient - 5)
+ / normVector, centerBall.getY() + vector.getY() / normVector * (radiusGradient - 5));
+ }
+ float[] dist = {0.1f, 0.3f, 1.0f};
+ Color[] colors = {new Color(0.9f, 0.9f, 0.9f), Color.LIGHT_GRAY, Color.DARK_GRAY};
+ RadialGradientPaint p = new RadialGradientPaint(centerGradient, radiusGradient, focusSpotLightGradient,
+ dist, colors, CycleMethod.NO_CYCLE);
+ g2.setPaint(p);
+ g2.fillOval((int) centerBall.getX() - stickBallDiameter / 2, (int) centerBall.getY() - stickBallDiameter
+ / 2, stickBallDiameter, stickBallDiameter);
+ g2.setPaint(defaultPaint);
+ g2.setColor(Color.BLACK);
+ g2.drawOval((int) centerBall.getX() - stickBallDiameter / 2, (int) centerBall.getY() - stickBallDiameter
+ / 2, stickBallDiameter, stickBallDiameter);
+ }
+ g2.dispose();
+ }
+
+ public void applyMovementXY() throws Exception
+ {
+ double vx = vector.getX();
+ double vy = vector.getY();
+ if (vx == 0 && vy == 0)// no movement, do not send a signal
+ return;
+
+ double normV = norm(vector);
+ double x = vx / normV;
+ double y = vy / normV;
+
+ double movementX;
+ double movementY;
+ double percent = norm(vector) * frame._sliderSpeed.getValue();
+ double pxSize = MicroManager.getPixelSize();
+
+ if (pxSize == 0d)
+ {
+ movementX = x * 0.001 * percent * percent;
+ movementY = y * 0.001 * percent * percent;
+ }
+ else
+ {
+ movementX = x * 0.001 * pxSize * percent * percent;
+ movementY = y * 0.001 * pxSize * percent * percent;
+ }
+
+ StageMover.moveXYRelative(movementX, movementY, true);
+ }
+
+ private double norm(Point2D vector)
+ {
+ double x = vector.getX();
+ double y = vector.getY();
+ return Math.sqrt(x * x + y * y);
+ }
+
+ @Override
+ public void mouseDragged(MouseEvent e)
+ {
+ int x = e.getX();
+ int y = e.getY();
+ int width = getWidth();
+ int height = getHeight();
+
+ if (x < 0)
+ x = 0;
+ if (x > width)
+ x = width;
+
+ if (y < 0)
+ y = 0;
+ if (y > height)
+ y = height;
+ vector.setLocation(x - width / 2, y - height / 2);
+ repaint();
+ }
+
+ @Override
+ public void mousePressed(MouseEvent e)
+ {
+ vector.setLocation(e.getX() - (getWidth() / 2), e.getY() - (getHeight() / 2));
+ repaint();
+ }
+
+ @Override
+ public void mouseReleased(MouseEvent e)
+ {
+ vector.setLocation(0, 0);
+ repaint();
+ }
+
+ @Override
+ public void mouseMoved(MouseEvent e)
+ {
+ }
+
+ @Override
+ public void mouseClicked(MouseEvent e)
+ {
+ }
+
+ @Override
+ public void mouseEntered(MouseEvent e)
+ {
+ }
+
+ @Override
+ public void mouseExited(MouseEvent e)
+ {
+ }
+
+ @Override
+ public void run()
+ {
+ while (!moveThread.isInterrupted())
+ {
+ try
+ {
+ applyMovementXY();
+ Thread.sleep(1);
+ }
+ catch (InterruptedException e)
+ {
+ moveThread.interrupt();
+ }
+ catch (Exception e)
+ {
+ System.err.println(e.getMessage());
+ }
+ }
+ }
+
+ public void shutdown()
+ {
+ // end process
+ moveThread.interrupt();
+ }
+}
diff --git a/src/main/java/plugins/tprovoost/Microscopy/gui/PanelMoverZ.java b/src/main/java/plugins/tprovoost/Microscopy/gui/PanelMoverZ.java
new file mode 100644
index 0000000000000000000000000000000000000000..f6dabc537242f7f313b8fb112366d2273b5c8e1e
--- /dev/null
+++ b/src/main/java/plugins/tprovoost/Microscopy/gui/PanelMoverZ.java
@@ -0,0 +1,202 @@
+package plugins.tprovoost.Microscopy.gui;
+
+import java.awt.Color;
+import java.awt.Cursor;
+import java.awt.Dimension;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.RenderingHints;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseListener;
+import java.awt.event.MouseMotionListener;
+import java.awt.image.BufferedImage;
+
+import javax.swing.JPanel;
+
+import plugins.tprovoost.Microscopy.MicroManager.tools.StageMover;
+
+/**
+ * @author Irsath Nguyen
+ */
+public class PanelMoverZ extends JPanel implements MouseListener, MouseMotionListener, Runnable
+{
+ /**
+ * Generated serial UID
+ */
+ private static final long serialVersionUID = -5025582239086787935L;
+
+ // CONSTANTS
+ private static final int SIZE_PANEL_MOVERZ_W = 50;
+ private static final int SIZE_PANEL_MOVERZ_H = 200;
+
+ private static final double BARS_NUMBER = 200;
+
+ private BufferedImage imgZBg = null;
+ private BufferedImage imgZBar = null;
+
+ /** Movement Vector */
+ int oldY;
+
+ private int startPos = 0;
+ private RemoteFrame frame;
+ private Thread moveThread;
+ private double offZ = 0d;
+
+ public PanelMoverZ(RemoteFrame frame)
+ {
+ super();
+
+ this.frame = frame;
+ setOpaque(true);
+ setDoubleBuffered(true);
+ setSize(new Dimension(SIZE_PANEL_MOVERZ_W, SIZE_PANEL_MOVERZ_H));
+ setPreferredSize(new Dimension(SIZE_PANEL_MOVERZ_W, SIZE_PANEL_MOVERZ_H));
+ addMouseListener(this);
+ addMouseMotionListener(this);
+
+ imgZBg = frame.plugin.getImageResource(RemoteFrame.currentPath + "remote_backgroundZ.png");
+ imgZBar = frame.plugin.getImageResource(RemoteFrame.currentPath + "singleBarZ.png");
+ moveThread = new Thread(this, "Remote Z mover");
+ moveThread.start();
+ }
+
+ @Override
+ public void paintComponent(Graphics g)
+ {
+ super.paintComponent(g);
+ int w = getWidth();
+ int h = getHeight();
+ Graphics2D g2 = (Graphics2D) g.create();
+ g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
+ g2.setColor(new Color(39, 39, 39));
+ g2.fillRect(0, 0, w, h);
+
+ if (imgZBg != null && imgZBar != null)
+ {
+ // draw the background + joystick
+ g2.drawImage(imgZBg, 0, 0, w, h, null);
+ double ecartNormal = (double) h / 8d;
+ double lastPos = h / 2d + startPos;
+ for (int i = 0; i < BARS_NUMBER; ++i)
+ {
+ g2.drawImage(imgZBar, 0, (int) lastPos, w, imgZBar.getHeight(null) * w / imgZBar.getWidth(null), null);
+ lastPos = lastPos + ecartNormal / (1d + 0.1 * i * i);
+ if (lastPos > h)
+ break;
+ }
+ lastPos = h / 2d + startPos;
+ for (int i = 0; i < BARS_NUMBER; ++i)
+ {
+ g2.drawImage(imgZBar, 0, (int) lastPos, w, imgZBar.getHeight(null) * w / imgZBar.getWidth(null), null);
+ lastPos = lastPos - ecartNormal / (1d + 0.1 * i * i);
+ if (lastPos < 0)
+ break;
+ }
+ }
+ g2.dispose();
+ }
+
+ @Override
+ public void mouseDragged(MouseEvent e)
+ {
+ final int movY = e.getY() - oldY;
+ if (movY == 0)
+ return;
+
+ oldY = e.getY();
+ double ecartNormal = getHeight() / 8d / 2d;
+ if (movY > 0)
+ {
+ ++startPos;
+ if (startPos > ecartNormal)
+ startPos = (int) -ecartNormal;
+ }
+ else
+ {
+ --startPos;
+ if (startPos < -ecartNormal)
+ startPos = (int) ecartNormal;
+ }
+ final int percent = frame._sliderSpeed.getValue();
+
+ synchronized (this)
+ {
+ offZ += movY * 0.1 * percent * percent;
+ }
+
+ repaint();
+ }
+
+ @Override
+ public void mouseMoved(MouseEvent e)
+ {
+ }
+
+ @Override
+ public void mouseClicked(MouseEvent e)
+ {
+ }
+
+ @Override
+ public void mouseEntered(MouseEvent e)
+ {
+ }
+
+ @Override
+ public void mouseExited(MouseEvent e)
+ {
+ }
+
+ @Override
+ public void mousePressed(MouseEvent e)
+ {
+ oldY = e.getY();
+ setCursor(new Cursor(Cursor.N_RESIZE_CURSOR | Cursor.S_RESIZE_CURSOR));
+ repaint();
+ }
+
+ @Override
+ public void mouseReleased(MouseEvent e)
+ {
+ setCursor(Cursor.getDefaultCursor());
+ repaint();
+ }
+
+ @Override
+ public void run()
+ {
+ while (!moveThread.isInterrupted())
+ {
+ final double off;
+
+ synchronized (this)
+ {
+ off = offZ;
+ offZ = 0d;
+ }
+
+ if (off != 0d)
+ {
+ try
+ {
+ StageMover.moveZRelative(off, false);
+ Thread.sleep(1);
+ }
+ catch (InterruptedException e)
+ {
+ moveThread.interrupt();
+ }
+ catch (Exception e)
+ {
+ System.err.println(e.getMessage());
+ }
+ }
+ }
+ }
+
+ public void shutdown()
+ {
+ // end process
+ moveThread.interrupt();
+ }
+}
diff --git a/src/main/java/plugins/tprovoost/Microscopy/gui/RemoteFrame.java b/src/main/java/plugins/tprovoost/Microscopy/gui/RemoteFrame.java
new file mode 100644
index 0000000000000000000000000000000000000000..3627cffe94dda5311ef5f3231899cc4da0a06886
--- /dev/null
+++ b/src/main/java/plugins/tprovoost/Microscopy/gui/RemoteFrame.java
@@ -0,0 +1,370 @@
+package plugins.tprovoost.Microscopy.gui;
+
+import java.awt.Color;
+import java.awt.Dimension;
+import java.awt.Font;
+import java.awt.FontMetrics;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.GridLayout;
+import java.awt.RenderingHints;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.image.BufferedImage;
+import java.util.prefs.Preferences;
+
+import javax.swing.BorderFactory;
+import javax.swing.Box;
+import javax.swing.BoxLayout;
+import javax.swing.JButton;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+import javax.swing.JSlider;
+import javax.swing.SwingConstants;
+import javax.swing.event.ChangeEvent;
+import javax.swing.event.ChangeListener;
+
+import icy.gui.frame.IcyFrame;
+import icy.gui.util.GuiUtil;
+import icy.image.ImageUtil;
+import icy.network.NetworkUtil;
+import icy.resource.icon.IcyIcon;
+import icy.type.point.Point3D;
+import icy.util.StringUtil;
+import plugins.tprovoost.Microscopy.MicroManager.tools.StageMover;
+import plugins.tprovoost.Microscopy.MicroManager.tools.StageMover.StageListener;
+import plugins.tprovoost.Microscopy.MicroManagerForIcy.MicroscopePlugin;
+import plugins.tprovoost.Microscopy.MicroscopeRemote.MicroscopeRemotePlugin;
+
+/**
+ * This class is the core of the Remote Plugin. Three different threads are
+ * running while using this class:
+ * <ul>
+ * <li>Refreshing the coordinates.</li>
+ * <li>Moving the XY Stage</li>
+ * <li>Moving the Z Stage.</li>
+ * </ul>
+ *
+ * @author Thomas Provoost
+ */
+public class RemoteFrame extends IcyFrame implements StageListener
+{
+ // -------
+ // GUI
+ // -------
+ MicroscopePlugin plugin;
+ public JSlider _sliderSpeed;
+ private JLabel _lblX;
+ private JLabel _lblY;
+ private JLabel _lblZ;
+ private InverterCheckBox _cbInvertX;
+ private InverterCheckBox _cbInvertY;
+ private InverterCheckBox _cbInvertZ;
+
+ // --------
+ // IMAGES
+ // --------
+ public Color transparentColor = new Color(255, 255, 255, 0);
+ private BufferedImage imgRemoteBg = null;
+ private BufferedImage imgSliderKnob = null;
+ private BufferedImage imgMemBtnOn = null;
+ private BufferedImage imgMemBtnOff = null;
+ private BufferedImage imgInvertSwitchOn = null;
+ private BufferedImage imgInvertSwitchOff = null;
+ private BufferedImage imgInvertLightOn = null;
+ private BufferedImage imgInvertLightOff = null;
+
+ // CONSTANTS
+ public final static String currentPath = "plugins/tprovoost/Microscopy/images/";
+
+ // -----------
+ // PREFERENCES
+ // -----------
+ private Preferences _prefs;
+ private PanelMoverXY panelMoverXY;
+ private PanelMoverZ panelMoverZ;
+ private static final String REMOTE = "prefs_remote";
+ private static final String SPEED = "speed";
+
+ public RemoteFrame(MicroscopeRemotePlugin plugin)
+ {
+ super("Remote", false, true, false, true);
+
+ this.plugin = plugin;
+
+ // LOAD ALL IMAGES
+ imgRemoteBg = plugin.getImageResource(currentPath + "RemoteFull_2.png");
+ imgMemBtnOn = plugin.getImageResource(currentPath + "memoryOn.png");
+ imgMemBtnOff = plugin.getImageResource(currentPath + "memoryOff.png");
+ imgInvertSwitchOn = plugin.getImageResource(currentPath + "btn_switchOn.png");
+ imgInvertSwitchOff = plugin.getImageResource(currentPath + "btn_switchOff.png");
+ imgInvertLightOn = plugin.getImageResource(currentPath + "btnRound.png");
+ imgInvertLightOff = plugin.getImageResource(currentPath + "btnRound_off.png");
+ imgSliderKnob = plugin.getImageResource(currentPath + "knob.png");
+
+ initializeGui();
+ setVisible(true);
+ addToDesktopPane();
+ requestFocus();
+ loadPreferences();
+ StageMover.addListener(this);
+ }
+
+ private void initializeGui()
+ {
+ // -------------
+ // MOUSE MOVER
+ // ------------
+ panelMoverXY = new PanelMoverXY(RemoteFrame.this);
+ panelMoverZ = new PanelMoverZ(RemoteFrame.this);
+
+ JPanel panelMover = GuiUtil.generatePanel();
+ panelMover.setLayout(new BoxLayout(panelMover, BoxLayout.X_AXIS));
+ panelMover.add(panelMoverXY);
+ panelMover.add(Box.createRigidArea(new Dimension(20, 10)));
+ panelMover.add(panelMoverZ);
+ panelMover.setOpaque(false);
+ panelMover.setBackground(transparentColor);
+
+ // ---------
+ // SPEED
+ // ---------
+ JPanel panel_speed = GuiUtil.generatePanel();
+ panel_speed.setLayout(new BoxLayout(panel_speed, BoxLayout.X_AXIS));
+ panel_speed.setOpaque(false);
+
+ _sliderSpeed = new JSlider(1, 10, 1)
+ {
+ private static final long serialVersionUID = 1L;
+ private BufferedImage toDraw;
+ int heightKnob;
+
+ {
+ heightKnob = (int) (imgSliderKnob.getHeight(null) / 1.5);
+ toDraw = ImageUtil.scale(imgSliderKnob, heightKnob * 2, heightKnob);
+ }
+
+ @Override
+ protected void paintComponent(Graphics g)
+ {
+ ((Graphics2D) g).drawImage(toDraw, null, (int) ((getValue() - 1) * (getWidth() / getMaximum())),
+ getHeight() / 2 - heightKnob / 2);
+ }
+ };
+ _sliderSpeed.setOpaque(false);
+ final JLabel lbl_value = new JLabel(" " + _sliderSpeed.getValue());
+
+ _sliderSpeed.addChangeListener(new ChangeListener()
+ {
+ @Override
+ public void stateChanged(ChangeEvent changeevent)
+ {
+ lbl_value.setText("" + _sliderSpeed.getValue());
+ }
+ });
+
+ panel_speed.add(_sliderSpeed);
+ panel_speed.add(Box.createHorizontalGlue());
+ panel_speed.add(lbl_value);
+ panel_speed.add(Box.createHorizontalGlue());
+
+ // -------------------
+ // INVERT CHEBKBOXES
+ // -------------------
+ _cbInvertX = new InverterCheckBox("Invert X-Axis");
+ _cbInvertX.setImages(imgInvertSwitchOn, imgInvertSwitchOff, imgInvertLightOn, imgInvertLightOff);
+ _cbInvertX.addActionListener(new ActionListener()
+ {
+ @Override
+ public void actionPerformed(ActionEvent arg0)
+ {
+ StageMover.setInvertX(_cbInvertX.isSelected());
+ }
+ });
+
+ _cbInvertY = new InverterCheckBox("Invert Y-Axis");
+ _cbInvertY.setImages(imgInvertSwitchOn, imgInvertSwitchOff, imgInvertLightOn, imgInvertLightOff);
+ _cbInvertY.addActionListener(new ActionListener()
+ {
+ @Override
+ public void actionPerformed(ActionEvent arg0)
+ {
+ StageMover.setInvertY(_cbInvertY.isSelected());
+ }
+ });
+
+ _cbInvertZ = new InverterCheckBox("Invert Z-Axis");
+ _cbInvertZ.setImages(imgInvertSwitchOn, imgInvertSwitchOff, imgInvertLightOn, imgInvertLightOff);
+ _cbInvertZ.addActionListener(new ActionListener()
+ {
+ @Override
+ public void actionPerformed(ActionEvent arg0)
+ {
+ StageMover.setInvertZ(_cbInvertZ.isSelected());
+ }
+ });
+
+ JPanel panelInvert = GuiUtil.generatePanel();
+ panelInvert.setOpaque(false);
+ panelInvert.setLayout(new GridLayout(3, 1));
+ panelInvert.setMaximumSize(new Dimension(Integer.MAX_VALUE, 60));
+ panelInvert.add(_cbInvertX);
+ panelInvert.add(_cbInvertY);
+ panelInvert.add(_cbInvertZ);
+
+ // MEMORY BUTTONS
+ MemoryButton btnM1 = new MemoryButton("M1", imgMemBtnOn, imgMemBtnOff);
+ MemoryButton btnM2 = new MemoryButton("M2", imgMemBtnOn, imgMemBtnOff);
+ MemoryButton btnM3 = new MemoryButton("M3", imgMemBtnOn, imgMemBtnOff);
+ MemoryButton btnM4 = new MemoryButton("M4", imgMemBtnOn, imgMemBtnOff);
+
+ JButton btnHelp = new JButton(new IcyIcon(imgMemBtnOff))
+ {
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ public void paint(Graphics g)
+ {
+ int w = getWidth();
+ int h = getHeight();
+ Graphics2D g2 = (Graphics2D) g;
+ g2.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
+ g2.drawImage(imgMemBtnOff, 0, 0, w, h, null);
+ g2.setFont(new Font("Arial", Font.BOLD, 16));
+ FontMetrics fm = g2.getFontMetrics();
+ g2.setColor(Color.LIGHT_GRAY);
+ g2.drawString("?", getWidth() / 2 - fm.charWidth('?') / 2, getHeight() / 2 + fm.getHeight() / 3);
+ }
+ };
+ btnHelp.addActionListener(new ActionListener()
+ {
+ @Override
+ public void actionPerformed(ActionEvent actionevent)
+ {
+ NetworkUtil.openBrowser(plugin.getDescriptor().getWeb());
+ }
+ });
+
+ JPanel panelMemoryButtons = new JPanel(new GridLayout(1, 4));
+ panelMemoryButtons.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
+ panelMemoryButtons.setOpaque(false);
+ panelMemoryButtons.setPreferredSize(new Dimension(60, 40));
+ panelMemoryButtons.add(btnM1);
+ panelMemoryButtons.add(btnM2);
+ panelMemoryButtons.add(btnM3);
+ panelMemoryButtons.add(btnM4);
+ panelMemoryButtons.add(btnHelp);
+
+ // -----------
+ // COORDINATES
+ // ----------
+ Point3D.Double pos;
+ try
+ {
+ pos = StageMover.getXYZ();
+ }
+ catch (Exception e)
+ {
+ pos = new Point3D.Double();
+ }
+
+ _lblX = new JLabel("X: " + StringUtil.toString(pos.x, 2) + " µm");
+ _lblY = new JLabel("Y: " + StringUtil.toString(pos.y, 2) + " µm");
+ _lblZ = new JLabel("Z: " + StringUtil.toString(pos.z, 2) + " µm");
+ _lblX.setHorizontalAlignment(SwingConstants.CENTER);
+ _lblY.setHorizontalAlignment(SwingConstants.CENTER);
+ _lblZ.setHorizontalAlignment(SwingConstants.CENTER);
+
+ JPanel panelCoords = new JPanel(new GridLayout(3, 1));
+ panelCoords.setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
+ panelCoords.setOpaque(false);
+ panelCoords.setBackground(transparentColor);
+ panelCoords.add(_lblX);
+ panelCoords.add(_lblY);
+ panelCoords.add(Box.createVerticalGlue());
+ panelCoords.add(_lblZ);
+
+ JPanel panelAll = new JPanel()
+ {
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ protected void paintComponent(Graphics g)
+ {
+ checkInverts();
+ g.drawImage(imgRemoteBg, 0, 0, getWidth(), getHeight(), null);
+ }
+ };
+ panelAll.setLayout(new BoxLayout(panelAll, BoxLayout.Y_AXIS));
+ panelAll.setBackground(Color.BLACK);
+ panelAll.add(panelMover);
+ panelAll.add(panel_speed);
+ panelAll.add(panelMemoryButtons);
+ panelAll.add(panelInvert);
+ panelAll.add(Box.createVerticalGlue());
+ panelAll.add(panelCoords);
+
+ add(panelAll);
+
+ pack();
+ validate();
+ center();
+ }
+
+ /**
+ * Load preferences : speed, invertX and invertY.
+ */
+ private void loadPreferences()
+ {
+ Preferences root = Preferences.userNodeForPackage(getClass());
+ _prefs = root.node(root.absolutePath() + "/" + REMOTE);
+ _sliderSpeed.setValue(_prefs.getInt(SPEED, 1));
+ checkInverts();
+ }
+
+ @Override
+ public void stateChanged()
+ {
+ super.stateChanged();
+ pack();
+ }
+
+ @Override
+ public void onClosed()
+ {
+ panelMoverXY.shutdown();
+ panelMoverZ.shutdown();
+ _prefs.putInt(SPEED, _sliderSpeed.getValue());
+ StageMover.removeListener(this);
+ }
+
+ private void checkInverts()
+ {
+ _cbInvertX.setSelected(StageMover.isInvertX());
+ _cbInvertY.setSelected(StageMover.isInvertY());
+ _cbInvertZ.setSelected(StageMover.isInvertZ());
+ }
+
+ @Override
+ public void onStagePositionChanged(String s, double z)
+ {
+ _lblZ.setText("Z: " + StringUtil.toString(z, 2) + " �m");
+ }
+
+ @Override
+ public void onXYStagePositionChanged(String s, double x, double y)
+ {
+ _lblX.setText("X: " + StringUtil.toString(x, 2) + " �m");
+ _lblY.setText("Y: " + StringUtil.toString(y, 2) + " �m");
+ }
+
+ @Override
+ public void onXYStagePositionChangedRelative(String s, double d, double d1)
+ {
+ }
+
+ @Override
+ public void onStagePositionChangedRelative(String s, double d)
+ {
+ }
+}
\ No newline at end of file
diff --git a/src/main/java/plugins/tprovoost/Microscopy/images/RemoteFull_2.png b/src/main/java/plugins/tprovoost/Microscopy/images/RemoteFull_2.png
new file mode 100644
index 0000000000000000000000000000000000000000..0c21f1f4af31dc8a2b8d6aa0e496c90ee63c9af2
Binary files /dev/null and b/src/main/java/plugins/tprovoost/Microscopy/images/RemoteFull_2.png differ
diff --git a/src/main/java/plugins/tprovoost/Microscopy/images/btnRound.png b/src/main/java/plugins/tprovoost/Microscopy/images/btnRound.png
new file mode 100644
index 0000000000000000000000000000000000000000..a21ec0420a29d08d813797f335db55625ec2c025
Binary files /dev/null and b/src/main/java/plugins/tprovoost/Microscopy/images/btnRound.png differ
diff --git a/src/main/java/plugins/tprovoost/Microscopy/images/btnRound_off.png b/src/main/java/plugins/tprovoost/Microscopy/images/btnRound_off.png
new file mode 100644
index 0000000000000000000000000000000000000000..66b47aec151605f0694ef0730d5006b4e0be954f
Binary files /dev/null and b/src/main/java/plugins/tprovoost/Microscopy/images/btnRound_off.png differ
diff --git a/src/main/java/plugins/tprovoost/Microscopy/images/btn_switchOff.png b/src/main/java/plugins/tprovoost/Microscopy/images/btn_switchOff.png
new file mode 100644
index 0000000000000000000000000000000000000000..0efab3d048bfa4eecfae6a02dbcd24e11450eb91
Binary files /dev/null and b/src/main/java/plugins/tprovoost/Microscopy/images/btn_switchOff.png differ
diff --git a/src/main/java/plugins/tprovoost/Microscopy/images/btn_switchOn.png b/src/main/java/plugins/tprovoost/Microscopy/images/btn_switchOn.png
new file mode 100644
index 0000000000000000000000000000000000000000..e6eb44aaab3e786ead3dad5472bdfb3eb625f349
Binary files /dev/null and b/src/main/java/plugins/tprovoost/Microscopy/images/btn_switchOn.png differ
diff --git a/src/main/java/plugins/tprovoost/Microscopy/images/knob.png b/src/main/java/plugins/tprovoost/Microscopy/images/knob.png
new file mode 100644
index 0000000000000000000000000000000000000000..f6c0a0a1e676fc6c0cbce4e0c8020927ac4cbaf2
Binary files /dev/null and b/src/main/java/plugins/tprovoost/Microscopy/images/knob.png differ
diff --git a/src/main/java/plugins/tprovoost/Microscopy/images/memoryOff.png b/src/main/java/plugins/tprovoost/Microscopy/images/memoryOff.png
new file mode 100644
index 0000000000000000000000000000000000000000..039bb30baa45b36521799a0fb20c3379f497119a
Binary files /dev/null and b/src/main/java/plugins/tprovoost/Microscopy/images/memoryOff.png differ
diff --git a/src/main/java/plugins/tprovoost/Microscopy/images/memoryOn.png b/src/main/java/plugins/tprovoost/Microscopy/images/memoryOn.png
new file mode 100644
index 0000000000000000000000000000000000000000..a5645c2de0749aa66460a3a9f659f57eae0a3c1e
Binary files /dev/null and b/src/main/java/plugins/tprovoost/Microscopy/images/memoryOn.png differ
diff --git a/src/main/java/plugins/tprovoost/Microscopy/images/remote_backgroundXY.png b/src/main/java/plugins/tprovoost/Microscopy/images/remote_backgroundXY.png
new file mode 100644
index 0000000000000000000000000000000000000000..ce0908c49d7fcf9e9a5d696ad93913d83b04a0c5
Binary files /dev/null and b/src/main/java/plugins/tprovoost/Microscopy/images/remote_backgroundXY.png differ
diff --git a/src/main/java/plugins/tprovoost/Microscopy/images/remote_backgroundZ.png b/src/main/java/plugins/tprovoost/Microscopy/images/remote_backgroundZ.png
new file mode 100644
index 0000000000000000000000000000000000000000..ac02bb544c65054d7ae99bd231397bc31ca55264
Binary files /dev/null and b/src/main/java/plugins/tprovoost/Microscopy/images/remote_backgroundZ.png differ
diff --git a/src/main/java/plugins/tprovoost/Microscopy/images/singleBarZ.png b/src/main/java/plugins/tprovoost/Microscopy/images/singleBarZ.png
new file mode 100644
index 0000000000000000000000000000000000000000..1d38152321978360b7127d5d42bad31567157e94
Binary files /dev/null and b/src/main/java/plugins/tprovoost/Microscopy/images/singleBarZ.png differ
diff --git a/src/main/resources/LICENSE b/src/main/resources/LICENSE
new file mode 100644
index 0000000000000000000000000000000000000000..9cecc1d4669ee8af2ca727a5d8cde10cd8b2d7cc
--- /dev/null
+++ b/src/main/resources/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ {one line to give the program's name and a brief idea of what it does.}
+ Copyright (C) {year} {name of author}
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program 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 for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ {project} Copyright (C) {year} {fullname}
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.