bpp::BashppServer Class Reference

The main server class for handling LSP requests and notifications. More...

#include <BashppServer.h>

Collaboration diagram for bpp::BashppServer:

Classes
struct	DebounceState
class	DebounceStateMap
struct	NotificationHandlerEntry
struct	RequestHandlerEntry

Public Member Functions
	BashppServer ()=default
	~BashppServer ()=default
	BashppServer (const BashppServer &other)=delete
BashppServer &	operator= (const BashppServer &other)=delete
	BashppServer (BashppServer &&other) noexcept=delete
BashppServer &	operator= (BashppServer &&other) noexcept=delete
void	mainLoop ()
void	setLogFile (const std::string &path)
void	setTargetBashVersion (const BashVersion &version)
void	setThreadCount (size_t num_threads)
GenericResponseMessage	shutdown (const GenericRequestMessage &request)
void	exit (const GenericNotificationMessage &notification)
void	cleanup ()
void	processMessage (const std::string &message)
GenericResponseMessage	handleInitialize (const GenericRequestMessage &request)
GenericResponseMessage	handleDefinition (const GenericRequestMessage &request)
GenericResponseMessage	handleHover (const GenericRequestMessage &request)
GenericResponseMessage	handleDocumentSymbol (const GenericRequestMessage &request)
GenericResponseMessage	handleRename (const GenericRequestMessage &request)
GenericResponseMessage	handleReferences (const GenericRequestMessage &request)
GenericResponseMessage	handleCompletion (const GenericRequestMessage &request)
CompletionList	handleATCompletion (const CompletionParams &params)
CompletionList	handleDOTCompletion (const CompletionParams &params)
void	handleDidOpen (const GenericNotificationMessage &request)
void	handleDidChange (const GenericNotificationMessage &request)
void	handleDidChangeWatchedFiles (const GenericNotificationMessage &request)
void	handleDidClose (const GenericNotificationMessage &request)
void	handleDidSave (const GenericNotificationMessage &request)
void	sendResponse (const GenericResponseMessage &response)
void	sendNotification (const GenericNotificationMessage &notification)
void	publishDiagnostics (std::shared_ptr< bpp::bpp_program > program)
void	add_include_path (const std::string &path)
void	set_suppress_warnings (bool suppress)
template<typename... Args>
void	log (Args &&... args)

Private Types
using	RequestHandler = GenericResponseMessage(BashppServer::*)(const GenericRequestMessage &)
using	NotificationHandler = void(BashppServer::*)(const GenericNotificationMessage &)

Private Member Functions
void	_sendMessage (const std::string &message)
void	processRequest (const GenericRequestMessage &request)
void	processNotification (const GenericNotificationMessage &notification)

Static Private Member Functions
static std::string	readHeaderLine (std::streambuf *buffer)
static GenericResponseMessage	invalidRequestHandler (const GenericRequestMessage &request)
static void	invalidNotificationHandler (const GenericNotificationMessage &request)

Private Attributes
pid_t	pid = getpid()
std::atomic< bool >	exiting = false
std::atomic< bool >	shutdown_requested = false
std::istream *	input_stream = &std::cin
std::ostream *	output_stream = &std::cout
std::unique_ptr< ThreadPool >	thread_pool = std::make_unique<ThreadPool>(std::thread::hardware_concurrency())
ProgramPool	program_pool = ProgramPool(10)
std::ofstream	log_file
DebounceStateMap	debounce_states = DebounceStateMap(&program_pool)
std::atomic< bool >	processing_didChange {false}
CompletionList	default_completion_list

Static Private Attributes
static std::mutex	output_mutex
static std::mutex	log_mutex
static constexpr std::array< RequestHandlerEntry, 8 >	request_handlers
	Maps request types to the functions that handle them.
static constexpr std::array< NotificationHandlerEntry, 6 >	notification_handlers
	Maps notification types to the functions that handle them.

Detailed Description

The main server class for handling LSP requests and notifications.

This class manages the server's lifecycle, handles incoming messages, processes requests and notifications, logs, and maintains the state of the server.

Member Typedef Documentation

NotificationHandler

using bpp::BashppServer::NotificationHandler = void (BashppServer::*)(const GenericNotificationMessage&)

private

RequestHandler

using bpp::BashppServer::RequestHandler = GenericResponseMessage (BashppServer::*)(const GenericRequestMessage&)

private

Constructor & Destructor Documentation

BashppServer() [1/3]

bpp::BashppServer::BashppServer ( )

default

~BashppServer()

bpp::BashppServer::~BashppServer ( )

default

BashppServer() [2/3]

bpp::BashppServer::BashppServer ( const BashppServer &  other )

delete

BashppServer() [3/3]

bpp::BashppServer::BashppServer ( BashppServer &&  other )

deletenoexcept

Member Function Documentation

_sendMessage()

void bpp::BashppServer::_sendMessage ( const std::string &  message )

private

add_include_path()

void bpp::BashppServer::add_include_path

(

const std::string &

path

)

cleanup()

void bpp::BashppServer::cleanup

(

)

exit()

void bpp::BashppServer::exit

(

const GenericNotificationMessage &

notification

)

handleATCompletion()

CompletionList bpp::BashppServer::handleATCompletion

(

const CompletionParams &

params

)

handleCompletion()

GenericResponseMessage bpp::BashppServer::handleCompletion

(

const GenericRequestMessage &

request

)

handleDefinition()

GenericResponseMessage bpp::BashppServer::handleDefinition

(

const GenericRequestMessage &

request

)

handleDidChange()

void bpp::BashppServer::handleDidChange

(

const GenericNotificationMessage &

request

)

handleDidChangeWatchedFiles()

void bpp::BashppServer::handleDidChangeWatchedFiles

(

const GenericNotificationMessage &

request

)

handleDidClose()

void bpp::BashppServer::handleDidClose

(

const GenericNotificationMessage &

request

)

handleDidOpen()

void bpp::BashppServer::handleDidOpen

(

const GenericNotificationMessage &

request

)

handleDidSave()

void bpp::BashppServer::handleDidSave

(

const GenericNotificationMessage &

request

)

handleDocumentSymbol()

GenericResponseMessage bpp::BashppServer::handleDocumentSymbol

(

const GenericRequestMessage &

request

)

handleDOTCompletion()

CompletionList bpp::BashppServer::handleDOTCompletion

(

const CompletionParams &

params

)

handleHover()

GenericResponseMessage bpp::BashppServer::handleHover

(

const GenericRequestMessage &

request

)

handleInitialize()

GenericResponseMessage bpp::BashppServer::handleInitialize

(

const GenericRequestMessage &

request

)

handleReferences()

GenericResponseMessage bpp::BashppServer::handleReferences

(

const GenericRequestMessage &

request

)

handleRename()

GenericResponseMessage bpp::BashppServer::handleRename

(

const GenericRequestMessage &

request

)

invalidNotificationHandler()

void bpp::BashppServer::invalidNotificationHandler ( const GenericNotificationMessage &  request )

staticprivate

invalidRequestHandler()

GenericResponseMessage bpp::BashppServer::invalidRequestHandler ( const GenericRequestMessage &  request )

staticprivate

log()

template<typename... Args>

void bpp::BashppServer::log ( Args &&...  args )

inline

mainLoop()

void bpp::BashppServer::mainLoop

(

)

operator=() [1/2]

BashppServer & bpp::BashppServer::operator= ( BashppServer &&  other )

deletenoexcept

operator=() [2/2]

BashppServer & bpp::BashppServer::operator= ( const BashppServer &  other )

delete

processMessage()

void bpp::BashppServer::processMessage

(

const std::string &

message

)

processNotification()

void bpp::BashppServer::processNotification ( const GenericNotificationMessage &  notification )

private

processRequest()

void bpp::BashppServer::processRequest ( const GenericRequestMessage &  request )

private

publishDiagnostics()

void bpp::BashppServer::publishDiagnostics

(

std::shared_ptr< bpp::bpp_program >

program

)

readHeaderLine()

std::string bpp::BashppServer::readHeaderLine ( std::streambuf *  buffer )

staticprivate

sendNotification()

void bpp::BashppServer::sendNotification

(

const GenericNotificationMessage &

notification

)

sendResponse()

void bpp::BashppServer::sendResponse

(

const GenericResponseMessage &

response

)

set_suppress_warnings()

void bpp::BashppServer::set_suppress_warnings

(

bool

suppress

)

setLogFile()

void bpp::BashppServer::setLogFile

(

const std::string &

path

)

setTargetBashVersion()

void bpp::BashppServer::setTargetBashVersion

(

const BashVersion &

version

)

setThreadCount()

void bpp::BashppServer::setThreadCount

(

size_t

num_threads

)

shutdown()

GenericResponseMessage bpp::BashppServer::shutdown

(

const GenericRequestMessage &

request

)

Member Data Documentation

debounce_states

DebounceStateMap bpp::BashppServer::debounce_states = DebounceStateMap(&program_pool)

private

default_completion_list

CompletionList bpp::BashppServer::default_completion_list

private

exiting

std::atomic<bool> bpp::BashppServer::exiting = false

private

input_stream

std::istream* bpp::BashppServer::input_stream = &std::cin

private

log_file

std::ofstream bpp::BashppServer::log_file

private

log_mutex

std::mutex bpp::BashppServer::log_mutex

staticprivate

notification_handlers

constexpr std::array<NotificationHandlerEntry, 6> bpp::BashppServer::notification_handlers

staticconstexprprivate

Initial value:

= {{
            {"textDocument/didOpen",            &BashppServer::handleDidOpen},
            {"textDocument/didChange",          &BashppServer::handleDidChange},
            {"workspace/didChangeWatchedFiles", &BashppServer::handleDidChangeWatchedFiles},
            {"textDocument/didSave",            &BashppServer::handleDidSave},
            {"textDocument/didClose",           &BashppServer::handleDidClose},
            {"exit",                            &BashppServer::exit}
        }}

Maps notification types to the functions that handle them.

output_mutex

std::mutex bpp::BashppServer::output_mutex

staticprivate

output_stream

std::ostream* bpp::BashppServer::output_stream = &std::cout

private

pid

pid_t bpp::BashppServer::pid = getpid()

private

processing_didChange

std::atomic<bool> bpp::BashppServer::processing_didChange {false}

private

program_pool

ProgramPool bpp::BashppServer::program_pool = ProgramPool(10)

private

request_handlers

constexpr std::array<RequestHandlerEntry, 8> bpp::BashppServer::request_handlers

staticconstexprprivate

Initial value:

= {{
            {"initialize",                  &BashppServer::handleInitialize},
            {"textDocument/definition",     &BashppServer::handleDefinition},
            {"textDocument/completion",     &BashppServer::handleCompletion},
            {"textDocument/hover",          &BashppServer::handleHover},
            {"textDocument/documentSymbol", &BashppServer::handleDocumentSymbol},
            {"textDocument/rename",         &BashppServer::handleRename},
            {"textDocument/references",     &BashppServer::handleReferences},
            {"shutdown",                    &BashppServer::shutdown}
        }}

Maps request types to the functions that handle them.

shutdown_requested

std::atomic<bool> bpp::BashppServer::shutdown_requested = false

private

thread_pool

std::unique_ptr<ThreadPool> bpp::BashppServer::thread_pool = std::make_unique<ThreadPool>(std::thread::hardware_concurrency())

private

---

The documentation for this class was generated from the following files:

• src/lsp/BashppServer.h
• src/lsp/BashppServer.cpp
• src/lsp/handlers/handleCompletion.cpp
• src/lsp/handlers/handledDidClose.cpp
• src/lsp/handlers/handleDefinition.cpp
• src/lsp/handlers/handleDidChange.cpp
• src/lsp/handlers/handleDidChangeWatchedFiles.cpp
• src/lsp/handlers/handleDidOpen.cpp
• src/lsp/handlers/handleDidSave.cpp
• src/lsp/handlers/handleDocumentSymbol.cpp
• src/lsp/handlers/handleHover.cpp
• src/lsp/handlers/handleInitialize.cpp
• src/lsp/handlers/handleReference.cpp
• src/lsp/handlers/handleRename.cpp