mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
69 lines
2.3 KiB
C++
69 lines
2.3 KiB
C++
/*
|
|
This file is part of solidity.
|
|
|
|
solidity is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
solidity is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with solidity. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
// SPDX-License-Identifier: GPL-3.0
|
|
#pragma once
|
|
|
|
#include <libsolidity/lsp/FileRepository.h>
|
|
|
|
#include <liblangutil/SourceLocation.h>
|
|
#include <liblangutil/CharStreamProvider.h>
|
|
|
|
#include <libsolutil/JSON.h>
|
|
|
|
#include <optional>
|
|
|
|
namespace solidity::lsp
|
|
{
|
|
|
|
class Transport;
|
|
class LanguageServer;
|
|
|
|
/**
|
|
* Helper base class for implementing handlers.
|
|
*/
|
|
class HandlerBase
|
|
{
|
|
public:
|
|
explicit HandlerBase(LanguageServer& _server): m_server{_server} {}
|
|
virtual ~HandlerBase() = default;
|
|
|
|
/// Callback to be invoked on every custom handler that can be used to decide whether to enable
|
|
/// or disable this feature on the server side.
|
|
///
|
|
/// @param _clientCapabilities JSON node to the root of the client advertised capabilities to be used
|
|
/// to decide if the implemented feature should be enabled or not.
|
|
/// @returns JSON object, with mapping to the capabilities to reply back with.
|
|
/// Use this to write the capabilities-reply with respect the implementation.
|
|
virtual Json::Value onReportCapabilities(Json::Value const& /*_clientCapabilities*/) { return Json::objectValue; }
|
|
|
|
Json::Value toRange(langutil::SourceLocation const& _location) const;
|
|
Json::Value toJson(langutil::SourceLocation const& _location) const;
|
|
|
|
/// @returns source unit name and the line column position as extracted
|
|
/// from the JSON-RPC parameters.
|
|
std::pair<std::string, langutil::LineColumn> extractSourceUnitNameAndLineColumn(Json::Value const& _params) const;
|
|
|
|
langutil::CharStreamProvider const& charStreamProvider() const noexcept;
|
|
FileRepository& fileRepository() const noexcept;
|
|
Transport& client() const noexcept;
|
|
|
|
protected:
|
|
LanguageServer& m_server;
|
|
};
|
|
|
|
}
|