Merge changes I0b78ceeb,Ic57e1efd

* changes:
  Add environment variable to force keeping ANSI codes
  Disable table mode in smart status if window size is not available
This commit is contained in:
Colin Cross 2021-09-22 18:19:15 +00:00 committed by Gerrit Code Review
commit fac6fd0927
7 changed files with 55 additions and 35 deletions

View file

@ -218,10 +218,16 @@ func distDir(outDir string) string {
}
}
func forceAnsiOutput() bool {
value := os.Getenv("SOONG_UI_ANSI_OUTPUT")
return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
}
func main() {
stdio := terminal.StdioImpl{}
output := terminal.NewStatusOutput(stdio.Stdout(), "", false, false)
output := terminal.NewStatusOutput(stdio.Stdout(), "", false, false,
forceAnsiOutput())
log := logger.New(output)
defer log.Cleanup()

View file

@ -164,7 +164,8 @@ func main() {
// Create a terminal output that mimics Ninja's.
output := terminal.NewStatusOutput(c.stdio().Stdout(), os.Getenv("NINJA_STATUS"), c.simpleOutput,
build.OsEnvironment().IsEnvTrue("ANDROID_QUIET_BUILD"))
build.OsEnvironment().IsEnvTrue("ANDROID_QUIET_BUILD"),
build.OsEnvironment().IsEnvTrue("SOONG_UI_ANSI_OUTPUT"))
// Attach a new logger instance to the terminal output.
log := logger.New(output)

View file

@ -48,7 +48,7 @@ type TestResults struct {
// Run runs a single build command. It emulates the "m" command line by calling into Soong UI directly.
func (t *Test) Run(logsDir string) {
output := terminal.NewStatusOutput(os.Stdout, "", false, false)
output := terminal.NewStatusOutput(os.Stdout, "", false, false, false)
log := logger.New(output)
defer log.Cleanup()

View file

@ -24,15 +24,17 @@ import (
type simpleStatusOutput struct {
writer io.Writer
formatter formatter
keepANSI bool
}
// NewSimpleStatusOutput returns a StatusOutput that represents the
// current build status similarly to Ninja's built-in terminal
// output.
func NewSimpleStatusOutput(w io.Writer, formatter formatter) status.StatusOutput {
func NewSimpleStatusOutput(w io.Writer, formatter formatter, keepANSI bool) status.StatusOutput {
return &simpleStatusOutput{
writer: w,
formatter: formatter,
keepANSI: keepANSI,
}
}
@ -54,7 +56,9 @@ func (s *simpleStatusOutput) FinishAction(result status.ActionResult, counts sta
progress := s.formatter.progress(counts) + str
output := s.formatter.result(result)
if !s.keepANSI {
output = string(stripAnsiEscapes([]byte(output)))
}
if output != "" {
fmt.Fprint(s.writer, progress, "\n", output)

View file

@ -77,7 +77,12 @@ func NewSmartStatusOutput(w io.Writer, formatter formatter) status.StatusOutput
s.requestedTableHeight = h
}
s.updateTermSize()
if w, h, ok := termSize(s.writer); ok {
s.termWidth, s.termHeight = w, h
s.computeTableHeight()
} else {
s.tableMode = false
}
if s.tableMode {
// Add empty lines at the bottom of the screen to scroll back the existing history
@ -296,14 +301,8 @@ func (s *smartStatusOutput) stopSigwinch() {
close(s.sigwinch)
}
func (s *smartStatusOutput) updateTermSize() {
if w, h, ok := termSize(s.writer); ok {
firstUpdate := s.termHeight == 0 && s.termWidth == 0
oldScrollingHeight := s.termHeight - s.tableHeight
s.termWidth, s.termHeight = w, h
if s.tableMode {
// computeTableHeight recomputes s.tableHeight based on s.termHeight and s.requestedTableHeight.
func (s *smartStatusOutput) computeTableHeight() {
tableHeight := s.requestedTableHeight
if tableHeight == 0 {
tableHeight = s.termHeight / 4
@ -317,10 +316,21 @@ func (s *smartStatusOutput) updateTermSize() {
tableHeight = s.termHeight - 1
}
s.tableHeight = tableHeight
}
// updateTermSize recomputes the table height after a SIGWINCH and pans any existing text if
// necessary.
func (s *smartStatusOutput) updateTermSize() {
if w, h, ok := termSize(s.writer); ok {
oldScrollingHeight := s.termHeight - s.tableHeight
s.termWidth, s.termHeight = w, h
if s.tableMode {
s.computeTableHeight()
scrollingHeight := s.termHeight - s.tableHeight
if !firstUpdate {
// If the scrolling region has changed, attempt to pan the existing text so that it is
// not overwritten by the table.
if scrollingHeight < oldScrollingHeight {
@ -332,7 +342,6 @@ func (s *smartStatusOutput) updateTermSize() {
}
}
}
}
}
func (s *smartStatusOutput) actionTable() {

View file

@ -26,12 +26,12 @@ import (
//
// statusFormat takes nearly all the same options as NINJA_STATUS.
// %c is currently unsupported.
func NewStatusOutput(w io.Writer, statusFormat string, forceSimpleOutput, quietBuild bool) status.StatusOutput {
func NewStatusOutput(w io.Writer, statusFormat string, forceSimpleOutput, quietBuild, forceKeepANSI bool) status.StatusOutput {
formatter := newFormatter(statusFormat, quietBuild)
if !forceSimpleOutput && isSmartTerminal(w) {
return NewSmartStatusOutput(w, formatter)
} else {
return NewSimpleStatusOutput(w, formatter)
return NewSimpleStatusOutput(w, formatter, forceKeepANSI)
}
}

View file

@ -94,7 +94,7 @@ func TestStatusOutput(t *testing.T) {
t.Run("smart", func(t *testing.T) {
smart := &fakeSmartTerminal{termWidth: 40}
stat := NewStatusOutput(smart, "", false, false)
stat := NewStatusOutput(smart, "", false, false, false)
tt.calls(stat)
stat.Flush()
@ -105,7 +105,7 @@ func TestStatusOutput(t *testing.T) {
t.Run("simple", func(t *testing.T) {
simple := &bytes.Buffer{}
stat := NewStatusOutput(simple, "", false, false)
stat := NewStatusOutput(simple, "", false, false, false)
tt.calls(stat)
stat.Flush()
@ -116,7 +116,7 @@ func TestStatusOutput(t *testing.T) {
t.Run("force simple", func(t *testing.T) {
smart := &fakeSmartTerminal{termWidth: 40}
stat := NewStatusOutput(smart, "", true, false)
stat := NewStatusOutput(smart, "", true, false, false)
tt.calls(stat)
stat.Flush()
@ -269,7 +269,7 @@ func TestSmartStatusOutputWidthChange(t *testing.T) {
os.Setenv(tableHeightEnVar, "")
smart := &fakeSmartTerminal{termWidth: 40}
stat := NewStatusOutput(smart, "", false, false)
stat := NewStatusOutput(smart, "", false, false, false)
smartStat := stat.(*smartStatusOutput)
smartStat.sigwinchHandled = make(chan bool)