vogue

README

vogue

A terminal IDE written in Go.

Documentation

Index

• Variables
• func ConfigFile(flag int, perm os.FileMode) (*os.File, error)
• type Buffer
  • func BufEmpty() *Buffer
  • func BufFile(path string) (*Buffer, error)
  • func (b *Buffer) FindLexer()
  • func (b *Buffer) Fresh(screen tcell.Screen)
  • func (b *Buffer) Key(evk *tcell.EventKey)
• type Config
  • func LoadConfig() (Config, error)
  • func (c Config) Get(name string, def interface{}) interface{}
  • func (c Config) GetStyle(name string, def tcell.Style) tcell.Style
  • func (c Config) Save() error
• type Status
  • func (s *Status) Fresh(screen tcell.Screen, style tcell.Style)
• type Tabs
  • func NewTabs() *Tabs
  • func (t *Tabs) Buffer() *Buffer
  • func (t *Tabs) Fresh(screen tcell.Screen, focus tcell.Style, style tcell.Style)
  • func (t *Tabs) Key(evk *tcell.EventKey)
• type Vogue
  • func NewVogue() (*Vogue, error)
  • func (v *Vogue) Fini()
  • func (v *Vogue) Fresh()
  • func (v *Vogue) Key(evk *tcell.EventKey)
  • func (v *Vogue) Mouse(evm *tcell.EventMouse)
  • func (v *Vogue) Run() error

Variables

var (
	BadPath   error = errors.New("bad path")
	Irregular error = errors.New("not a regular file")
)

var Empties int = 0

Functions

func ConfigFile

func ConfigFile(flag int, perm os.FileMode) (*os.File, error)

Types

type Buffer

type Buffer struct {
	Path  string
	Name  string
	Data  string
	Line  int
	Col   int
	Lexer chroma.Lexer
}

func BufEmpty

func BufEmpty() *Buffer

func BufFile

func BufFile(path string) (*Buffer, error)

func (*Buffer) FindLexer

func (b *Buffer) FindLexer()

func (*Buffer) Fresh

func (b *Buffer) Fresh(screen tcell.Screen)

func (*Buffer) Key

func (b *Buffer) Key(evk *tcell.EventKey)

type Config

type Config map[string]interface{}

func LoadConfig

func LoadConfig() (Config, error)

func (Config) Get

func (c Config) Get(name string, def interface{}) interface{}

func (Config) GetStyle

func (c Config) GetStyle(name string, def tcell.Style) tcell.Style

func (Config) Save

func (c Config) Save() error

type Status

type Status struct {
	Left   func() string
	Center func() string
	Right  func() string
}

func (*Status) Fresh

func (s *Status) Fresh(screen tcell.Screen, style tcell.Style)

type Tabs

type Tabs struct {
	Current int
	Buffers []*Buffer
}

func NewTabs

func NewTabs() *Tabs

func (*Tabs) Buffer

func (t *Tabs) Buffer() *Buffer

func (*Tabs) Fresh

func (t *Tabs) Fresh(screen tcell.Screen, focus tcell.Style, style tcell.Style)

func (*Tabs) Key

func (t *Tabs) Key(evk *tcell.EventKey)

type Vogue

type Vogue struct {
	Screen tcell.Screen

	Config Config

	Status *Status
	Tabs   *Tabs
}

func NewVogue

func NewVogue() (*Vogue, error)

func (*Vogue) Fini

func (v *Vogue) Fini()

func (*Vogue) Fresh

func (v *Vogue) Fresh()

func (*Vogue) Key

func (v *Vogue) Key(evk *tcell.EventKey)

func (*Vogue) Mouse

func (v *Vogue) Mouse(evm *tcell.EventMouse)

func (*Vogue) Run

func (v *Vogue) Run() error