ScreenshotCommand.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient 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 2 of the License, or
 * (at your option) any later version.
 *
 * JXClient 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 JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.commands;
 
import com.realtime.crossfire.jxclient.gui.commands.ScreenshotFiles;
import com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer;
import com.realtime.crossfire.jxclient.server.crossfire.CrossfireServerConnection;
import java.awt.Color;
import java.awt.Graphics;
import java.awt.image.BufferedImage;
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
import javax.imageio.ImageIO;
import org.jetbrains.annotations.NotNull;
 
public class ScreenshotCommand extends AbstractCommand {
 
    @NotNull
    private final JXCWindowRenderer windowRenderer;
 
    @NotNull
    private final ScreenshotFiles screenshotFiles;
 
    public ScreenshotCommand(@NotNull final JXCWindowRenderer windowRenderer, @NotNull final CrossfireServerConnection crossfireServerConnection, @NotNull final ScreenshotFiles screenshotFiles) {
        super("screenshot", crossfireServerConnection);
        this.windowRenderer = windowRenderer;
        this.screenshotFiles = screenshotFiles;
    }
 
    @Override
    public boolean allArguments() {
        return true;
    }
 
    @Override
    public void execute(@NotNull final String args) {
        final Path file;
        if (args.isEmpty()) {
            try {
                file = screenshotFiles.getFile();
            } catch (final IOException ex) {
                drawInfoError("Failed to create screenshot filename: "+ex.getMessage());
                return;
            }
        } else {
            file = Paths.get(args);
        }
 
        final BufferedImage image = new BufferedImage(windowRenderer.getWindowWidth(), windowRenderer.getWindowHeight(), BufferedImage.TYPE_INT_RGB);
        final Graphics g = image.createGraphics();
        try {
            g.setColor(Color.black);
            g.fillRect(0, 0, windowRenderer.getWindowWidth(), windowRenderer.getWindowHeight());
            windowRenderer.redraw(g);
        } finally {
            g.dispose();
        }
        try {
            ImageIO.write(image, "png", file.toFile());
        } catch (final IOException ex) {
            drawInfoError("Cannot write screenshot "+file+": "+ex.getMessage());
            return;
        } catch (final NullPointerException ignored) { // ImageIO.write() crashes if the destination cannot be written to
            drawInfoError("Cannot write screenshot "+file);
            return;
        }
 
        drawInfo("Saved screenshot to "+file);
    }
 
    @NotNull
    @Override
    public String getHelp() {
        //noinspection StringBufferReplaceableByString
        final StringBuilder sb = new StringBuilder();
        sb.append("Creates a screenshot image\n");
        sb.append("\n");
        sb.append("Usage: screenshot\n");
        sb.append("Usage: screenshot <file>\n");
        sb.append("\n");
        sb.append("Write the current display contents into a PNG file. ");
        sb.append("If <file> is omitted, the file names 'screenshot0.png', ..., 'screenshot9.png' are used instead.\n");
        sb.append("Note: If the file already exists, it is overwritten without confirmation.\n");
        return sb.toString();
    }
 
}