server

Documentation

Index

• type AddressImportResolver
• type CodeLensProvider
• type Command
• type CommandHandler
• type CompletionItemData
• type DiagnosticProvider
• type Document
  • func (d Document) HasAnyPrecedingStringsAtPosition(options []string, line, column int) bool
  • func (d Document) Offset(line, column int) (offset int)
• type InitializationOptionsHandler
• type ObjectStream
  • func NewObjectStream(writeObject func(obj interface{}) error, readObject func(v interface{}) error, ...) ObjectStream
  • func (o ObjectStream) Close() error
  • func (o ObjectStream) ReadObject(v interface{}) (err error)
  • func (o ObjectStream) WriteObject(obj interface{}) error
• type Option
  • func WithAddressImportResolver(resolver AddressImportResolver) Option
  • func WithCodeLensProvider(provider CodeLensProvider) Option
  • func WithCommand(command Command) Option
  • func WithDiagnosticProvider(provider DiagnosticProvider) Option
  • func WithInitializationOptionsHandler(handler InitializationOptionsHandler) Option
  • func WithStringImportResolver(resolver StringImportResolver) Option
• type Server
  • func NewServer() *Server
  • func (s *Server) CodeLens(_ protocol.Conn, params *protocol.CodeLensParams) (codeLenses []*protocol.CodeLens, err error)
  • func (s *Server) Completion(conn protocol.Conn, params *protocol.CompletionParams) (items []*protocol.CompletionItem, err error)
  • func (s *Server) Definition(_ protocol.Conn, params *protocol.TextDocumentPositionParams) (*protocol.Location, error)
  • func (s *Server) DidChangeTextDocument(conn protocol.Conn, params *protocol.DidChangeTextDocumentParams) error
  • func (s *Server) DidOpenTextDocument(conn protocol.Conn, params *protocol.DidOpenTextDocumentParams) error
  • func (s *Server) ExecuteCommand(conn protocol.Conn, params *protocol.ExecuteCommandParams) (interface{}, error)
  • func (*Server) Exit(_ protocol.Conn) error
  • func (s *Server) GetDocument(uri protocol.DocumentUri) (doc Document, ok bool)
  • func (s *Server) Hover(_ protocol.Conn, params *protocol.TextDocumentPositionParams) (*protocol.Hover, error)
  • func (s *Server) Initialize(conn protocol.Conn, params *protocol.InitializeParams) (*protocol.InitializeResult, error)
  • func (s *Server) ResolveCompletionItem(_ protocol.Conn, item *protocol.CompletionItem) (result *protocol.CompletionItem, err error)
  • func (s *Server) SetOptions(options ...Option) error
  • func (*Server) Shutdown(conn protocol.Conn) error
  • func (s *Server) SignatureHelp(_ protocol.Conn, _ *protocol.TextDocumentPositionParams) (*protocol.SignatureHelp, error)
  • func (s *Server) Start(stream jsonrpc2.ObjectStream) <-chan struct{}
  • func (s *Server) Stop() error
• type StdinStdoutReadWriterCloser
  • func (StdinStdoutReadWriterCloser) Close() error
  • func (StdinStdoutReadWriterCloser) Read(p []byte) (int, error)
  • func (StdinStdoutReadWriterCloser) Write(p []byte) (int, error)
• type StringImportResolver

Types

type AddressImportResolver

type AddressImportResolver func(location ast.AddressLocation) (string, error)

AddressImportResolver is a function that is used to resolve address imports

type CodeLensProvider

type CodeLensProvider func(uri protocol.DocumentUri, checker *sema.Checker) ([]*protocol.CodeLens, error)

CodeLensProvider is a function that is used to provide code lenses for the given checker

type Command

type Command struct {
	Name    string
	Handler CommandHandler
}

type CommandHandler

type CommandHandler func(conn protocol.Conn, args ...interface{}) (interface{}, error)

CommandHandler represents the form of functions that handle commands submitted from the client using workspace/executeCommand.

type CompletionItemData

type CompletionItemData struct {
	URI protocol.DocumentUri `json:"uri"`
}

type DiagnosticProvider

type DiagnosticProvider func(uri protocol.DocumentUri, checker *sema.Checker) ([]protocol.Diagnostic, error)

DiagnosticProvider is a function that is used to provide diagnostics for the given checker

type Document

type Document struct {
	Text string
}

Document represents an open document on the client. It contains all cached information about each document that is used to support CodeLens, transaction submission, and script execution.

func (Document) HasAnyPrecedingStringsAtPosition

func (d Document) HasAnyPrecedingStringsAtPosition(options []string, line, column int) bool

func (Document) Offset

func (d Document) Offset(line, column int) (offset int)

type InitializationOptionsHandler

type InitializationOptionsHandler func(initializationOptions interface{}) error

InitializationOptionsHandler is a function that is used to handle initialization options sent by the client

type ObjectStream

type ObjectStream struct {
	// contains filtered or unexported fields
}

func NewObjectStream

func NewObjectStream(
	writeObject func(obj interface{}) error,
	readObject func(v interface{}) error,
	close func() error,
) ObjectStream

func (ObjectStream) Close

func (o ObjectStream) Close() error

func (ObjectStream) ReadObject

func (o ObjectStream) ReadObject(v interface{}) (err error)

func (ObjectStream) WriteObject

func (o ObjectStream) WriteObject(obj interface{}) error

type Option

type Option func(*Server) error

func WithAddressImportResolver

func WithAddressImportResolver(resolver AddressImportResolver) Option

WithAddressImportResolver returns a server option that sets the given function as the function that is used to resolve address imports

func WithCodeLensProvider

func WithCodeLensProvider(provider CodeLensProvider) Option

WithCodeLensProvider returns a server option that adds the given function as a function that is used to generate code lenses

func WithCommand

func WithCommand(command Command) Option

WithCommand returns a server options that adds the given command to the set of commands provided by the server to the client.

If a command with the given name already exists, the option fails.

func WithDiagnosticProvider

func WithDiagnosticProvider(provider DiagnosticProvider) Option

WithDiagnosticProvider returns a server option that adds the given function as a function that is used to generate diagnostics

func WithInitializationOptionsHandler

func WithInitializationOptionsHandler(handler InitializationOptionsHandler) Option

WithInitializationOptionsHandler returns a server option that adds the given function as a function that is used to handle initialization options sent by the client

func WithStringImportResolver

func WithStringImportResolver(resolver StringImportResolver) Option

WithStringImportResolver returns a server option that sets the given function as the function that is used to resolve string imports

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer() *Server

func (*Server) CodeLens

func (s *Server) CodeLens(
	_ protocol.Conn,
	params *protocol.CodeLensParams,
) (
	codeLenses []*protocol.CodeLens,
	err error,
)

CodeLens is called every time the document contents change and returns a list of actions to be injected into the source as inline buttons.

func (*Server) Completion

func (s *Server) Completion(
	conn protocol.Conn,
	params *protocol.CompletionParams,
) (
	items []*protocol.CompletionItem,
	err error,
)

Completion is called to compute completion items at a given cursor position.

func (*Server) Definition

func (s *Server) Definition(
	_ protocol.Conn,
	params *protocol.TextDocumentPositionParams,
) (*protocol.Location, error)

Definition finds the definition of the type at the given location.

func (*Server) DidChangeTextDocument

func (s *Server) DidChangeTextDocument(
	conn protocol.Conn,
	params *protocol.DidChangeTextDocumentParams,
) error

DidChangeTextDocument is called whenever the current document changes. We parse and check the text and publish diagnostics about the document.

func (*Server) DidOpenTextDocument

func (s *Server) DidOpenTextDocument(conn protocol.Conn, params *protocol.DidOpenTextDocumentParams) error

DidOpenTextDocument is called whenever a new file is opened. We parse and check the text and publish diagnostics about the document.

func (*Server) ExecuteCommand

func (s *Server) ExecuteCommand(conn protocol.Conn, params *protocol.ExecuteCommandParams) (interface{}, error)

ExecuteCommand is called to execute a custom, server-defined command.

We register all the commands we support in registerCommands and populate their corresponding handler at server initialization.

func (*Server) Exit

func (*Server) Exit(_ protocol.Conn) error

Exit exits the process.

func (*Server) GetDocument

func (s *Server) GetDocument(uri protocol.DocumentUri) (doc Document, ok bool)

func (*Server) Hover

func (s *Server) Hover(
	_ protocol.Conn,
	params *protocol.TextDocumentPositionParams,
) (*protocol.Hover, error)

Hover returns contextual type information about the variable at the given location.

func (*Server) Initialize

func (s *Server) Initialize(
	conn protocol.Conn,
	params *protocol.InitializeParams,
) (
	*protocol.InitializeResult,
	error,
)

func (*Server) ResolveCompletionItem

func (s *Server) ResolveCompletionItem(
	_ protocol.Conn,
	item *protocol.CompletionItem,
) (
	result *protocol.CompletionItem,
	err error,
)

Completion is called to compute completion items at a given cursor position.

func (*Server) SetOptions

func (s *Server) SetOptions(options ...Option) error

func (*Server) Shutdown

func (*Server) Shutdown(conn protocol.Conn) error

Shutdown tells the server to stop accepting any new requests. This can only be followed by a call to Exit, which exits the process.

func (*Server) SignatureHelp

func (s *Server) SignatureHelp(
	_ protocol.Conn,
	_ *protocol.TextDocumentPositionParams,
) (*protocol.SignatureHelp, error)

TODO

func (*Server) Start

func (s *Server) Start(stream jsonrpc2.ObjectStream) <-chan struct{}

func (*Server) Stop

func (s *Server) Stop() error

type StdinStdoutReadWriterCloser

type StdinStdoutReadWriterCloser struct{}

StdinStdoutReadWriterCloser implements an io.ReadWriter and io.Closer around STDIN and STDOUT.

func (StdinStdoutReadWriterCloser) Close

func (StdinStdoutReadWriterCloser) Close() error

Close closes STDIN and STDOUT.

func (StdinStdoutReadWriterCloser) Read

func (StdinStdoutReadWriterCloser) Read(p []byte) (int, error)

Read reads from STDIN.

func (StdinStdoutReadWriterCloser) Write

func (StdinStdoutReadWriterCloser) Write(p []byte) (int, error)

Write writes to STDOUT.

type StringImportResolver

type StringImportResolver func(mainPath string, location ast.StringLocation) (string, error)

StringImportResolver is a function that is used to resolve string imports