pax_global_header00006660000000000000000000000064145134336250014520gustar00rootroot0000000000000052 comment=a7c02353c47bc4ec6b30dc9628154ae4fe760c11 go-isatty-0.0.20/000077500000000000000000000000001451343362500135175ustar00rootroot00000000000000go-isatty-0.0.20/.github/000077500000000000000000000000001451343362500150575ustar00rootroot00000000000000go-isatty-0.0.20/.github/FUNDING.yml000066400000000000000000000013151451343362500166740ustar00rootroot00000000000000# These are supported funding model platforms github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] patreon: mattn # Replace with a single Patreon username open_collective: # Replace with a single Open Collective username ko_fi: # Replace with a single Ko-fi username tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry liberapay: # Replace with a single Liberapay username issuehunt: # Replace with a single IssueHunt username otechie: # Replace with a single Otechie username custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] go-isatty-0.0.20/.github/workflows/000077500000000000000000000000001451343362500171145ustar00rootroot00000000000000go-isatty-0.0.20/.github/workflows/test.yml000066400000000000000000000013121451343362500206130ustar00rootroot00000000000000name: test on: push: pull_request: jobs: test: runs-on: ${{ matrix.os }} strategy: fail-fast: false matrix: os: - ubuntu-latest - macos-latest - windows-latest go: - '1.20' - '1.19' - '1.18' - '1.17' steps: - uses: actions/setup-go@v2 with: go-version: ${{ matrix.go }} - uses: actions/checkout@v2 - name: test shell: bash run: | ./go.test.sh - name: upload coverage report uses: codecov/codecov-action@v2 with: env_vars: OS,GO env: OS: ${{ matrix.os }} GO: ${{ matrix.go }} go-isatty-0.0.20/LICENSE000066400000000000000000000021131451343362500145210ustar00rootroot00000000000000Copyright (c) Yasuhiro MATSUMOTO MIT License (Expat) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. go-isatty-0.0.20/README.md000066400000000000000000000021001451343362500147670ustar00rootroot00000000000000# go-isatty [![Godoc Reference](https://godoc.org/github.com/mattn/go-isatty?status.svg)](http://godoc.org/github.com/mattn/go-isatty) [![Codecov](https://codecov.io/gh/mattn/go-isatty/branch/master/graph/badge.svg)](https://codecov.io/gh/mattn/go-isatty) [![Coverage Status](https://coveralls.io/repos/github/mattn/go-isatty/badge.svg?branch=master)](https://coveralls.io/github/mattn/go-isatty?branch=master) [![Go Report Card](https://goreportcard.com/badge/mattn/go-isatty)](https://goreportcard.com/report/mattn/go-isatty) isatty for golang ## Usage ```go package main import ( "fmt" "github.com/mattn/go-isatty" "os" ) func main() { if isatty.IsTerminal(os.Stdout.Fd()) { fmt.Println("Is Terminal") } else if isatty.IsCygwinTerminal(os.Stdout.Fd()) { fmt.Println("Is Cygwin/MSYS2 Terminal") } else { fmt.Println("Is Not Terminal") } } ``` ## Installation ``` $ go get github.com/mattn/go-isatty ``` ## License MIT ## Author Yasuhiro Matsumoto (a.k.a mattn) ## Thanks * k-takata: base idea for IsCygwinTerminal https://github.com/k-takata/go-iscygpty go-isatty-0.0.20/doc.go000066400000000000000000000001001451343362500146020ustar00rootroot00000000000000// Package isatty implements interface to isatty package isatty go-isatty-0.0.20/example_test.go000066400000000000000000000004621451343362500165420ustar00rootroot00000000000000package isatty_test import ( "fmt" "os" "github.com/mattn/go-isatty" ) func Example() { if isatty.IsTerminal(os.Stdout.Fd()) { fmt.Println("Is Terminal") } else if isatty.IsCygwinTerminal(os.Stdout.Fd()) { fmt.Println("Is Cygwin/MSYS2 Terminal") } else { fmt.Println("Is Not Terminal") } } go-isatty-0.0.20/go.mod000066400000000000000000000001141451343362500146210ustar00rootroot00000000000000module github.com/mattn/go-isatty go 1.15 require golang.org/x/sys v0.6.0 go-isatty-0.0.20/go.sum000066400000000000000000000002271451343362500146530ustar00rootroot00000000000000golang.org/x/sys v0.6.0 h1:MVltZSvRTcU2ljQOhs94SXPftV6DCNnZViHeQps87pQ= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= go-isatty-0.0.20/go.test.sh000077500000000000000000000004211451343362500154360ustar00rootroot00000000000000#!/usr/bin/env bash set -e echo "" > coverage.txt for d in $(go list ./... | grep -v vendor); do go test -race -coverprofile=profile.out -covermode=atomic "$d" if [ -f profile.out ]; then cat profile.out >> coverage.txt rm profile.out fi done go-isatty-0.0.20/isatty_bsd.go000066400000000000000000000011411451343362500162100ustar00rootroot00000000000000//go:build (darwin || freebsd || openbsd || netbsd || dragonfly || hurd) && !appengine && !tinygo // +build darwin freebsd openbsd netbsd dragonfly hurd // +build !appengine // +build !tinygo package isatty import "golang.org/x/sys/unix" // IsTerminal return true if the file descriptor is terminal. func IsTerminal(fd uintptr) bool { _, err := unix.IoctlGetTermios(int(fd), unix.TIOCGETA) return err == nil } // IsCygwinTerminal return true if the file descriptor is a cygwin or msys2 // terminal. This is also always false on this environment. func IsCygwinTerminal(fd uintptr) bool { return false } go-isatty-0.0.20/isatty_others.go000066400000000000000000000010241451343362500167440ustar00rootroot00000000000000//go:build (appengine || js || nacl || tinygo || wasm) && !windows // +build appengine js nacl tinygo wasm // +build !windows package isatty // IsTerminal returns true if the file descriptor is terminal which // is always false on js and appengine classic which is a sandboxed PaaS. func IsTerminal(fd uintptr) bool { return false } // IsCygwinTerminal() return true if the file descriptor is a cygwin or msys2 // terminal. This is also always false on this environment. func IsCygwinTerminal(fd uintptr) bool { return false } go-isatty-0.0.20/isatty_others_test.go000066400000000000000000000004721451343362500200110ustar00rootroot00000000000000//go:build !windows // +build !windows package isatty import ( "os" "testing" ) func TestTerminal(t *testing.T) { // test for non-panic t.Log("os.Stdout:", IsTerminal(os.Stdout.Fd())) } func TestCygwinPipeName(t *testing.T) { if IsCygwinTerminal(os.Stdout.Fd()) { t.Fatal("should be false always") } } go-isatty-0.0.20/isatty_plan9.go000066400000000000000000000007751451343362500164770ustar00rootroot00000000000000//go:build plan9 // +build plan9 package isatty import ( "syscall" ) // IsTerminal returns true if the given file descriptor is a terminal. func IsTerminal(fd uintptr) bool { path, err := syscall.Fd2path(int(fd)) if err != nil { return false } return path == "/dev/cons" || path == "/mnt/term/dev/cons" } // IsCygwinTerminal return true if the file descriptor is a cygwin or msys2 // terminal. This is also always false on this environment. func IsCygwinTerminal(fd uintptr) bool { return false } go-isatty-0.0.20/isatty_solaris.go000066400000000000000000000011061451343362500171150ustar00rootroot00000000000000//go:build solaris && !appengine // +build solaris,!appengine package isatty import ( "golang.org/x/sys/unix" ) // IsTerminal returns true if the given file descriptor is a terminal. // see: https://src.illumos.org/source/xref/illumos-gate/usr/src/lib/libc/port/gen/isatty.c func IsTerminal(fd uintptr) bool { _, err := unix.IoctlGetTermio(int(fd), unix.TCGETA) return err == nil } // IsCygwinTerminal return true if the file descriptor is a cygwin or msys2 // terminal. This is also always false on this environment. func IsCygwinTerminal(fd uintptr) bool { return false } go-isatty-0.0.20/isatty_tcgets.go000066400000000000000000000010301451343362500167260ustar00rootroot00000000000000//go:build (linux || aix || zos) && !appengine && !tinygo // +build linux aix zos // +build !appengine // +build !tinygo package isatty import "golang.org/x/sys/unix" // IsTerminal return true if the file descriptor is terminal. func IsTerminal(fd uintptr) bool { _, err := unix.IoctlGetTermios(int(fd), unix.TCGETS) return err == nil } // IsCygwinTerminal return true if the file descriptor is a cygwin or msys2 // terminal. This is also always false on this environment. func IsCygwinTerminal(fd uintptr) bool { return false } go-isatty-0.0.20/isatty_windows.go000066400000000000000000000064521451343362500171440ustar00rootroot00000000000000//go:build windows && !appengine // +build windows,!appengine package isatty import ( "errors" "strings" "syscall" "unicode/utf16" "unsafe" ) const ( objectNameInfo uintptr = 1 fileNameInfo = 2 fileTypePipe = 3 ) var ( kernel32 = syscall.NewLazyDLL("kernel32.dll") ntdll = syscall.NewLazyDLL("ntdll.dll") procGetConsoleMode = kernel32.NewProc("GetConsoleMode") procGetFileInformationByHandleEx = kernel32.NewProc("GetFileInformationByHandleEx") procGetFileType = kernel32.NewProc("GetFileType") procNtQueryObject = ntdll.NewProc("NtQueryObject") ) func init() { // Check if GetFileInformationByHandleEx is available. if procGetFileInformationByHandleEx.Find() != nil { procGetFileInformationByHandleEx = nil } } // IsTerminal return true if the file descriptor is terminal. func IsTerminal(fd uintptr) bool { var st uint32 r, _, e := syscall.Syscall(procGetConsoleMode.Addr(), 2, fd, uintptr(unsafe.Pointer(&st)), 0) return r != 0 && e == 0 } // Check pipe name is used for cygwin/msys2 pty. // Cygwin/MSYS2 PTY has a name like: // \{cygwin,msys}-XXXXXXXXXXXXXXXX-ptyN-{from,to}-master func isCygwinPipeName(name string) bool { token := strings.Split(name, "-") if len(token) < 5 { return false } if token[0] != `\msys` && token[0] != `\cygwin` && token[0] != `\Device\NamedPipe\msys` && token[0] != `\Device\NamedPipe\cygwin` { return false } if token[1] == "" { return false } if !strings.HasPrefix(token[2], "pty") { return false } if token[3] != `from` && token[3] != `to` { return false } if token[4] != "master" { return false } return true } // getFileNameByHandle use the undocomented ntdll NtQueryObject to get file full name from file handler // since GetFileInformationByHandleEx is not available under windows Vista and still some old fashion // guys are using Windows XP, this is a workaround for those guys, it will also work on system from // Windows vista to 10 // see https://stackoverflow.com/a/18792477 for details func getFileNameByHandle(fd uintptr) (string, error) { if procNtQueryObject == nil { return "", errors.New("ntdll.dll: NtQueryObject not supported") } var buf [4 + syscall.MAX_PATH]uint16 var result int r, _, e := syscall.Syscall6(procNtQueryObject.Addr(), 5, fd, objectNameInfo, uintptr(unsafe.Pointer(&buf)), uintptr(2*len(buf)), uintptr(unsafe.Pointer(&result)), 0) if r != 0 { return "", e } return string(utf16.Decode(buf[4 : 4+buf[0]/2])), nil } // IsCygwinTerminal() return true if the file descriptor is a cygwin or msys2 // terminal. func IsCygwinTerminal(fd uintptr) bool { if procGetFileInformationByHandleEx == nil { name, err := getFileNameByHandle(fd) if err != nil { return false } return isCygwinPipeName(name) } // Cygwin/msys's pty is a pipe. ft, _, e := syscall.Syscall(procGetFileType.Addr(), 1, fd, 0, 0) if ft != fileTypePipe || e != 0 { return false } var buf [2 + syscall.MAX_PATH]uint16 r, _, e := syscall.Syscall6(procGetFileInformationByHandleEx.Addr(), 4, fd, fileNameInfo, uintptr(unsafe.Pointer(&buf)), uintptr(len(buf)*2), 0, 0) if r == 0 || e != 0 { return false } l := *(*uint32)(unsafe.Pointer(&buf)) return isCygwinPipeName(string(utf16.Decode(buf[2 : 2+l/2]))) } go-isatty-0.0.20/isatty_windows_test.go000066400000000000000000000020441451343362500201740ustar00rootroot00000000000000//go:build windows // +build windows package isatty import ( "testing" ) func TestCygwinPipeName(t *testing.T) { tests := []struct { name string result bool }{ {``, false}, {`\msys-`, false}, {`\cygwin-----`, false}, {`\msys-x-PTY5-pty1-from-master`, false}, {`\cygwin-x-PTY5-from-master`, false}, {`\cygwin-x-pty2-from-toaster`, false}, {`\cygwin--pty2-from-master`, false}, {`\\cygwin-x-pty2-from-master`, false}, {`\cygwin-x-pty2-from-master-`, true}, // for the feature {`\cygwin-e022582115c10879-pty4-from-master`, true}, {`\msys-e022582115c10879-pty4-to-master`, true}, {`\cygwin-e022582115c10879-pty4-to-master`, true}, {`\Device\NamedPipe\cygwin-e022582115c10879-pty4-from-master`, true}, {`\Device\NamedPipe\msys-e022582115c10879-pty4-to-master`, true}, {`Device\NamedPipe\cygwin-e022582115c10879-pty4-to-master`, false}, } for _, test := range tests { want := test.result got := isCygwinPipeName(test.name) if want != got { t.Fatalf("isatty(%q): got %v, want %v:", test.name, got, want) } } }