/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
 * Other names may be trademarks of their respective owners.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 * 
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 */

package org.netbeans.lib.richexecution.program;

import org.netbeans.lib.richexecution.OS;
import org.netbeans.lib.richexecution.PtyExecutor;

/**
 * Description of a shell to be started under a pty.
 * <br>
 * On unix ...
 * <br>
 * The shell defined by <code>$SHELL</code> is started.
 * If <code>$SHELL</code> is empty <code>/bin/bash</code> is started.
 * <br>
 * On windows ...
 * <br>
 * <code>cmd.exe</code> is started.
 * <p>
 * Use {@link PtyExecutor} or subclasses thereof to run the program.
 * @author ivan
 */
public class Shell extends Program {

    private final static OS os = OS.get();
    private final String name;

    private static void error(String fmt, Object...args) {
        String msg = String.format(fmt, args);
        throw new IllegalStateException(msg);
    }


    public Shell() {
        String shell = System.getenv("SHELL");

        if (shell == null)
            shell = "/bin/bash";

        switch (os) {
            case WINDOWS:
                add("cmd.exe");
                add("/q");  // turn echo off
                add("/a");  // use ANSI
                name = "cmd.exe";
                break;

            case LINUX:
//		add("/usr/bin/strace");
//		add("-o");
//		add("/tmp/rich-cmd.tr");
                add(shell);
                name = basename(shell);
                break;
            case SOLARIS:
//		add("/usr/bin/truss");
//		add("-o");
//		add("/tmp/rich-cmd.tr");
                add(shell);
                name = basename(shell);
                break;
            case MACOS:
                add(shell);
                name = basename(shell);
                break;
            default:
                error("Unsupported os '%s'", os);
                name = "";
                break;
	}
    }

    /**
     * Return the basename of the shell being run.
     * @return the basename of the shell being run.
     */
    @Override
    public String name() {
        return name;
    }
}
