neovim/test/functional/ui/screen_basic_spec.lua

local helpers = require('test.functional.helpers')(after_each)
local Screen = require('test.functional.ui.screen')
local spawn, set_session, clear = helpers.spawn, helpers.set_session, helpers.clear
local feed, execute = helpers.feed, helpers.execute
local insert = helpers.insert
local eq = helpers.eq
local eval = helpers.eval

describe('Initial screen', function()
  local screen
  local nvim_argv = {helpers.nvim_prog, '-u', 'NONE', '-i', 'NONE', '-N',
                     '--cmd', 'set shortmess+=I background=light noswapfile belloff= noshowcmd noruler',
                     '--embed'}

  before_each(function()
    local screen_nvim = spawn(nvim_argv)
    set_session(screen_nvim)
    screen = Screen.new()
    screen:attach()
    screen:set_default_attr_ids( {
      [0] = {bold=true, foreground=255},
      [1] = {bold=true, reverse=true},
    } )
  end)

  after_each(function()
    screen:detach()
  end)

  it('is the default initial screen', function()
      screen:expect([[
      ^                                                     |
      {0:~                                                    }|
      {0:~                                                    }|
      {0:~                                                    }|
      {0:~                                                    }|
      {0:~                                                    }|
      {0:~                                                    }|
      {0:~                                                    }|
      {0:~                                                    }|
      {0:~                                                    }|
      {0:~                                                    }|
      {0:~                                                    }|
      {1:[No Name]                                            }|
                                                           |
    ]])
  end)
end)

describe('Screen', function()
  local screen

  before_each(function()
    clear()
    screen = Screen.new()
    screen:attach()
    screen:set_default_attr_ids( {
      [0] = {bold=true, foreground=255},
      [1] = {bold=true, reverse=true},
      [2] = {bold=true},
      [3] = {reverse=true},
      [4] = {background = Screen.colors.LightGrey, underline = true},
      [5] = {background = Screen.colors.LightGrey, underline = true, bold = true, foreground = Screen.colors.Fuchsia},
      [6] = {bold = true, foreground = Screen.colors.Fuchsia},
      [7] = {bold = true, foreground = Screen.colors.SeaGreen},
    } )
  end)

  after_each(function()
    screen:detach()
  end)

  describe(':suspend', function()
    it('is forwarded to the UI', function()
      local function check()
        if not screen.suspended then
          return 'Screen was not suspended'
        end
      end
      execute('suspend')
      screen:wait(check)
      screen.suspended = false
      feed('<c-z>')
      screen:wait(check)
    end)
  end)

  describe('bell/visual bell', function()
    it('is forwarded to the UI', function()
      feed('<left>')
      screen:wait(function()
        if not screen.bell or screen.visual_bell then
          return 'Bell was not sent'
        end
      end)
      screen.bell = false
      execute('set visualbell')
      feed('<left>')
      screen:wait(function()
        if not screen.visual_bell or screen.bell then
          return 'Visual bell was not sent'
        end
      end)
    end)
  end)

  describe(':set title', function()
    it('is forwarded to the UI', function()
      local expected = 'test-title'
      execute('set titlestring='..expected)
      execute('set title')
      screen:wait(function()
        local actual = screen.title
        if actual ~= expected then
          return 'Expected title to be "'..expected..'" but was "'..actual..'"'
        end
      end)
    end)

    it('has correct default title with unnamed file', function()
      local expected = '[No Name] - NVIM'
      execute('set title')
      screen:wait(function()
        local actual = screen.title
        if actual ~= expected then
          return 'Expected title to be "'..expected..'" but was "'..actual..'"'
        end
      end)
    end)

    it('has correct default title with named file', function()
      local expected = 'myfile (/mydir) - NVIM'
      execute('set title')
      execute('file /mydir/myfile')
      screen:wait(function()
        local actual = screen.title
        if actual ~= expected then
          return 'Expected title to be "'..expected..'" but was "'..actual..'"'
        end
      end)
    end)
  end)

  describe(':set icon', function()
    it('is forwarded to the UI', function()
      local expected = 'test-icon'
      execute('set iconstring='..expected)
      execute('set icon')
      screen:wait(function()
        local actual = screen.icon
        if actual ~= expected then
          return 'Expected title to be "'..expected..'" but was "'..actual..'"'
        end
      end)
    end)
  end)

  describe('window', function()
    describe('split', function()
      it('horizontal', function()
        execute('sp')
        screen:expect([[
          ^                                                     |
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {1:[No Name]                                            }|
                                                               |
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {3:[No Name]                                            }|
          :sp                                                  |
        ]])
      end)

      it('horizontal and resize', function()
        execute('sp')
        execute('resize 8')
        screen:expect([[
          ^                                                     |
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {1:[No Name]                                            }|
                                                               |
          {0:~                                                    }|
          {0:~                                                    }|
          {3:[No Name]                                            }|
          :resize 8                                            |
        ]])
      end)

      it('horizontal and vertical', function()
        execute('sp', 'vsp', 'vsp')
        screen:expect([[
          ^                    {3:|}                {3:|}               |
          {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
          {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
          {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
          {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
          {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
          {1:[No Name]            }{3:[No Name]        [No Name]      }|
                                                               |
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {3:[No Name]                                            }|
                                                               |
        ]])
        insert('hello')
        screen:expect([[
          hell^o               {3:|}hello           {3:|}hello          |
          {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
          {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
          {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
          {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
          {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
          {1:[No Name] [+]        }{3:[No Name] [+]    [No Name] [+]  }|
          hello                                                |
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {0:~                                                    }|
          {3:[No Name] [+]                                        }|
                                                               |
        ]])
      end)
    end)
  end)

  describe('tabnew', function()
    it('creates a new buffer', function()
      execute('sp', 'vsp', 'vsp')
      insert('hello')
      screen:expect([[
        hell^o               {3:|}hello           {3:|}hello          |
        {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
        {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
        {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
        {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
        {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
        {1:[No Name] [+]        }{3:[No Name] [+]    [No Name] [+]  }|
        hello                                                |
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {3:[No Name] [+]                                        }|
                                                             |
      ]])
      execute('tabnew')
      insert('hello2')
      feed('h')
      screen:expect([[
        {4: }{5:4}{4:+ [No Name] }{2: + [No Name] }{3:                         }{4:X}|
        hell^o2                                               |
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
                                                             |
      ]])
      execute('tabprevious')
      screen:expect([[
        {2: }{6:4}{2:+ [No Name] }{4: + [No Name] }{3:                         }{4:X}|
        hell^o               {3:|}hello           {3:|}hello          |
        {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
        {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
        {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
        {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
        {0:~                   }{3:|}{0:~               }{3:|}{0:~              }|
        {1:[No Name] [+]        }{3:[No Name] [+]    [No Name] [+]  }|
        hello                                                |
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {3:[No Name] [+]                                        }|
                                                             |
      ]])
    end)
  end)

  describe('insert mode', function()
    it('move to next line with <cr>', function()
      feed('iline 1<cr>line 2<cr>')
      screen:expect([[
        line 1                                               |
        line 2                                               |
        ^                                                     |
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {2:-- INSERT --}                                         |
      ]])
    end)
  end)

  describe('normal mode', function()
    -- https://code.google.com/p/vim/issues/detail?id=339
    it("setting 'ruler' doesn't reset the preferred column", function()
      execute('set virtualedit=')
      feed('i0123456<cr>789<esc>kllj')
      execute('set ruler')
      feed('k')
      screen:expect([[
        0123^456                                              |
        789                                                  |
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        :set ruler                         1,5           All |
      ]])
    end)
  end)

  describe('command mode', function()
    it('typing commands', function()
      feed(':ls')
      screen:expect([[
                                                             |
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        :ls^                                                  |
      ]])
    end)

    it('execute command with multi-line output', function()
      feed(':ls<cr>')
      screen:expect([[
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        {0:~                                                    }|
        :ls                                                  |
          1 %a   "[No Name]"                    line 1       |
        {7:Press ENTER or type command to continue}^              |
      ]])
      feed('<cr>') --  skip the "Press ENTER..." state or tests will hang
    end)
  end)

  describe('scrolling and clearing', function()
    before_each(function()
      insert([[
      Inserting
      text
      with
      many
      lines
      to
      test
      scrolling
      and
      clearing
      in
      split
      windows
      ]])
      execute('sp', 'vsp', 'vsp')
      screen:expect([[
        and                 {3:|}and             {3:|}and            |
        clearing            {3:|}clearing        {3:|}clearing       |
        in                  {3:|}in              {3:|}in             |
        split               {3:|}split           {3:|}split          |
        windows             {3:|}windows         {3:|}windows        |
        ^                    {3:|}                {3:|}               |
        {1:[No Name] [+]        }{3:[No Name] [+]    [No Name] [+]  }|
        clearing                                             |
        in                                                   |
        split                                                |
        windows                                              |
                                                             |
        {3:[No Name] [+]                                        }|
                                                             |
      ]])
    end)

    it('only affects the current scroll region', function()
      feed('6k')
      screen:expect([[
        ^scrolling           {3:|}and             {3:|}and            |
        and                 {3:|}clearing        {3:|}clearing       |
        clearing            {3:|}in              {3:|}in             |
        in                  {3:|}split           {3:|}split          |
        split               {3:|}windows         {3:|}windows        |
        windows             {3:|}                {3:|}               |
        {1:[No Name] [+]        }{3:[No Name] [+]    [No Name] [+]  }|
        clearing                                             |
        in                                                   |
        split                                                |
        windows                                              |
                                                             |
        {3:[No Name] [+]                                        }|
                                                             |
      ]])
      feed('<c-w>l')
      screen:expect([[
        scrolling           {3:|}and                 {3:|}and        |
        and                 {3:|}clearing            {3:|}clearing   |
        clearing            {3:|}in                  {3:|}in         |
        in                  {3:|}split               {3:|}split      |
        split               {3:|}windows             {3:|}windows    |
        windows             {3:|}^                    {3:|}           |
        {3:[No Name] [+]        }{1:[No Name] [+]        }{3:<Name] [+] }|
        clearing                                             |
        in                                                   |
        split                                                |
        windows                                              |
                                                             |
        {3:[No Name] [+]                                        }|
                                                             |
      ]])
      feed('gg')
      screen:expect([[
        scrolling           {3:|}^Inserting           {3:|}and        |
        and                 {3:|}text                {3:|}clearing   |
        clearing            {3:|}with                {3:|}in         |
        in                  {3:|}many                {3:|}split      |
        split               {3:|}lines               {3:|}windows    |
        windows             {3:|}to                  {3:|}           |
        {3:[No Name] [+]        }{1:[No Name] [+]        }{3:<Name] [+] }|
        clearing                                             |
        in                                                   |
        split                                                |
        windows                                              |
                                                             |
        {3:[No Name] [+]                                        }|
                                                             |
      ]])
      feed('7j')
      screen:expect([[
        scrolling           {3:|}with                {3:|}and        |
        and                 {3:|}many                {3:|}clearing   |
        clearing            {3:|}lines               {3:|}in         |
        in                  {3:|}to                  {3:|}split      |
        split               {3:|}test                {3:|}windows    |
        windows             {3:|}^scrolling           {3:|}           |
        {3:[No Name] [+]        }{1:[No Name] [+]        }{3:<Name] [+] }|
        clearing                                             |
        in                                                   |
        split                                                |
        windows                                              |
                                                             |
        {3:[No Name] [+]                                        }|
                                                             |
      ]])
      feed('2j')
      screen:expect([[
        scrolling           {3:|}lines               {3:|}and        |
        and                 {3:|}to                  {3:|}clearing   |
        clearing            {3:|}test                {3:|}in         |
        in                  {3:|}scrolling           {3:|}split      |
        split               {3:|}and                 {3:|}windows    |
        windows             {3:|}^clearing            {3:|}           |
        {3:[No Name] [+]        }{1:[No Name] [+]        }{3:<Name] [+] }|
        clearing                                             |
        in                                                   |
        split                                                |
        windows                                              |
                                                             |
        {3:[No Name] [+]                                        }|
                                                             |
      ]])
      feed('5k')
      screen:expect([[
        scrolling           {3:|}^lines               {3:|}and        |
        and                 {3:|}to                  {3:|}clearing   |
        clearing            {3:|}test                {3:|}in         |
        in                  {3:|}scrolling           {3:|}split      |
        split               {3:|}and                 {3:|}windows    |
        windows             {3:|}clearing            {3:|}           |
        {3:[No Name] [+]        }{1:[No Name] [+]        }{3:<Name] [+] }|
        clearing                                             |
        in                                                   |
        split                                                |
        windows                                              |
                                                             |
        {3:[No Name] [+]                                        }|
                                                             |
      ]])
      feed('k')
      screen:expect([[
        scrolling           {3:|}^many                {3:|}and        |
        and                 {3:|}lines               {3:|}clearing   |
        clearing            {3:|}to                  {3:|}in         |
        in                  {3:|}test                {3:|}split      |
        split               {3:|}scrolling           {3:|}windows    |
        windows             {3:|}and                 {3:|}           |
        {3:[No Name] [+]        }{1:[No Name] [+]        }{3:<Name] [+] }|
        clearing                                             |
        in                                                   |
        split                                                |
        windows                                              |
                                                             |
        {3:[No Name] [+]                                        }|
                                                             |
      ]])
    end)
  end)

  describe('resize', function()
    before_each(function()
      screen:try_resize(25, 5)
      feed('iresize')
    end)

    it('rebuilds the whole screen', function()
      screen:expect([[
        resize^                   |
        {0:~                        }|
        {0:~                        }|
        {0:~                        }|
        {2:-- INSERT --}             |
      ]])
    end)

    it('has minimum width/height values', function()
      screen:try_resize(1, 1)
      screen:expect([[
        {2:-- INS^ERT --}|
                    |
      ]])
      feed('<esc>:ls')
      screen:expect([[
        resize      |
        :ls^         |
      ]])
    end)
  end)

  describe('mode change', function()
    before_each(function()
      screen:try_resize(25, 5)
    end)

    it('works in normal mode', function()
      screen:expect([[
        ^                         |
        {0:~                        }|
        {0:~                        }|
        {0:~                        }|
                                 |
      ]],nil,nil,function ()
        eq("normal", screen.mode)
      end)
    end)

    it('works in insert mode', function()
      feed('i')
      screen:expect([[
        ^                         |
        {0:~                        }|
        {0:~                        }|
        {0:~                        }|
        {2:-- INSERT --}             |
      ]],nil,nil,function ()
        eq("insert", screen.mode)
      end)

      feed('word<esc>')
      screen:expect([[
        wor^d                     |
        {0:~                        }|
        {0:~                        }|
        {0:~                        }|
                                 |
      ]], nil, nil, function ()
        eq("normal", screen.mode)
      end)
    end)

    it('works in replace mode', function()
      feed('R')
      screen:expect([[
        ^                         |
        {0:~                        }|
        {0:~                        }|
        {0:~                        }|
        {2:-- REPLACE --}            |
      ]], nil, nil, function ()
        eq("replace", screen.mode)
      end)

      feed('word<esc>')
      screen:expect([[
        wor^d                     |
        {0:~                        }|
        {0:~                        }|
        {0:~                        }|
                                 |
      ]], nil, nil, function ()
        eq("normal", screen.mode)
      end)
    end)

    it('works in cmdline mode', function()
      feed(':')
      screen:expect([[
                                 |
        {0:~                        }|
        {0:~                        }|
        {0:~                        }|
        :^                        |
      ]],nil,nil,function ()
        eq("cmdline", screen.mode)
      end)

      feed('<esc>/')
      screen:expect([[
                                 |
        {0:~                        }|
        {0:~                        }|
        {0:~                        }|
        /^                        |
      ]],nil,nil,function ()
        eq("cmdline", screen.mode)
      end)


      feed('<esc>?')
      screen:expect([[
                                 |
        {0:~                        }|
        {0:~                        }|
        {0:~                        }|
        ?^                        |
      ]],nil,nil,function ()
        eq("cmdline", screen.mode)
      end)

      feed('<esc>')
      screen:expect([[
        ^                         |
        {0:~                        }|
        {0:~                        }|
        {0:~                        }|
                                 |
      ]],nil,nil,function ()
        eq("normal", screen.mode)
      end)
    end)
  end)

  it('nvim_ui_attach() handles very large width/height #2180', function()
    screen:detach()
    screen = Screen.new(999, 999)
    screen:attach()
    eq(999, eval('&lines'))
    eq(999, eval('&columns'))
  end)
end)