net.morimekta.console.util.STTY Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of console-util Show documentation

Utilities helping with various *nix console topics. Mostly geared toward expressive and interactive command line applications.

There is a newer version: 3.1.1

Show newest version

/*
 * Copyright (c) 2016, Stein Eldar Johnsen
 *
 * 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 net.morimekta.console.util;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.MoreObjects;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.UncheckedIOException;

import static java.nio.charset.StandardCharsets.UTF_8;

/**
 * A terminal controller helper.
 */
public class STTY {
    private final Runtime runtime;

    public STTY() {
        this(Runtime.getRuntime());
    }

    @VisibleForTesting
    public STTY(Runtime runtime) {
        this.runtime = runtime;
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(STTY.class).toString();
    }

    /**
     * Set the current STTY mode, and return the closable switcher to turn back.
     *
     * @param mode The STTY mode to set.
     * @return The mode switcher.
     */
    public STTYModeSwitcher setSTTYMode(STTYMode mode) {
        try {
            return new STTYModeSwitcher(mode, runtime);
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }


    /**
     * Get the terminal size.
     *
     * @return the terminal size.
     * @throws UncheckedIOException If getting the terminal size failed.
     */
    public TerminalSize getTerminalSize() {
        try {
            return getTerminalSize(runtime);
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

    /**
     * @return True if this is an interactive TTY terminal.
     */
    public boolean isInteractive() {
        try {
            // Just check that is does not throw an exception.
            getTerminalSize(runtime);
            return true;
        } catch (IOException e) {
            return false;
        }
    }

    @VisibleForTesting
    protected static TerminalSize getTerminalSize(Runtime runtime) throws IOException {
        String[] cmd = new String[]{"/bin/sh", "-c", "stty size