1756630dfa
Summary:
According to [C128] "Virtual functions should specify exactly one
of `virtual`, `override`, or `final`", I've added override where a
virtual function is overriden but the explicit `override` keyword
was missing. Whenever both `virtual` and `override` were specified,
I removed `virtual`. As C.128 puts it:
> [...] writing more than one of these three is both redundant and
> a potential source of errors.
I anticipate a discussion about whether or not to add `override` to
destructors but I went for it because of an example in [ISOCPP1000].
Let me repeat the comment for you here:
Consider this code:
```
struct Base {
virtual ~Base(){}
};
struct SubClass : Base {
~SubClass() {
std::cout << "It works!\n";
}
};
int main() {
std::unique_ptr<Base> ptr = std::make_unique<SubClass>();
}
```
If for some odd reason somebody removes the `virtual` keyword from the
`Base` struct, the code will no longer print `It works!`. So adding
`override` to destructors actively protects us from accidentally
breaking our code at runtime.
[C128]: https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#c128-virtual-functions-should-specify-exactly-one-of-virtual-override-or-final
[ISOCPP1000]: https://github.com/isocpp/CppCoreGuidelines/issues/1000#issuecomment-476951555
Reviewers: teemperor, JDevlieghere, davide, shafik
Reviewed By: teemperor
Subscribers: kwk, arphaman, kadircet, lldb-commits
Tags: #lldb
Differential Revision: https://reviews.llvm.org/D61440
llvm-svn: 359868
119 lines
3.3 KiB
C++
119 lines
3.3 KiB
C++
//===-- StructuredDataDarwinLog.h -------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef StructuredDataDarwinLog_h
|
|
#define StructuredDataDarwinLog_h
|
|
|
|
#include "lldb/Target/StructuredDataPlugin.h"
|
|
|
|
#include <mutex>
|
|
|
|
// Forward declarations
|
|
namespace sddarwinlog_private {
|
|
class EnableCommand;
|
|
}
|
|
|
|
namespace lldb_private {
|
|
|
|
class StructuredDataDarwinLog : public StructuredDataPlugin {
|
|
friend sddarwinlog_private::EnableCommand;
|
|
|
|
public:
|
|
// Public static API
|
|
|
|
static void Initialize();
|
|
|
|
static void Terminate();
|
|
|
|
static ConstString GetStaticPluginName();
|
|
|
|
/// Return whether the DarwinLog functionality is enabled.
|
|
///
|
|
/// The DarwinLog functionality is enabled if the user expicitly enabled
|
|
/// it with the enable command, or if the user has the setting set
|
|
/// that controls if we always enable it for newly created/attached
|
|
/// processes.
|
|
///
|
|
/// \return
|
|
/// True if DarwinLog support is/will be enabled for existing or
|
|
/// newly launched/attached processes.
|
|
static bool IsEnabled();
|
|
|
|
// PluginInterface API
|
|
|
|
ConstString GetPluginName() override;
|
|
|
|
uint32_t GetPluginVersion() override;
|
|
|
|
// StructuredDataPlugin API
|
|
|
|
bool SupportsStructuredDataType(ConstString type_name) override;
|
|
|
|
void HandleArrivalOfStructuredData(
|
|
Process &process, ConstString type_name,
|
|
const StructuredData::ObjectSP &object_sp) override;
|
|
|
|
Status GetDescription(const StructuredData::ObjectSP &object_sp,
|
|
lldb_private::Stream &stream) override;
|
|
|
|
bool GetEnabled(ConstString type_name) const override;
|
|
|
|
void ModulesDidLoad(Process &process, ModuleList &module_list) override;
|
|
|
|
~StructuredDataDarwinLog() override;
|
|
|
|
private:
|
|
// Private constructors
|
|
|
|
StructuredDataDarwinLog(const lldb::ProcessWP &process_wp);
|
|
|
|
// Private static methods
|
|
|
|
static lldb::StructuredDataPluginSP CreateInstance(Process &process);
|
|
|
|
static void DebuggerInitialize(Debugger &debugger);
|
|
|
|
static bool InitCompletionHookCallback(void *baton,
|
|
StoppointCallbackContext *context,
|
|
lldb::user_id_t break_id,
|
|
lldb::user_id_t break_loc_id);
|
|
|
|
static Status FilterLaunchInfo(ProcessLaunchInfo &launch_info,
|
|
Target *target);
|
|
|
|
// Internal helper methods used by friend classes
|
|
void SetEnabled(bool enabled);
|
|
|
|
void AddInitCompletionHook(Process &process);
|
|
|
|
// Private methods
|
|
|
|
void DumpTimestamp(Stream &stream, uint64_t timestamp);
|
|
|
|
size_t DumpHeader(Stream &stream, const StructuredData::Dictionary &event);
|
|
|
|
size_t HandleDisplayOfEvent(const StructuredData::Dictionary &event,
|
|
Stream &stream);
|
|
|
|
/// Call the enable command again, using whatever settings were initially
|
|
/// made.
|
|
|
|
void EnableNow();
|
|
|
|
// Private data
|
|
bool m_recorded_first_timestamp;
|
|
uint64_t m_first_timestamp_seen;
|
|
bool m_is_enabled;
|
|
std::mutex m_added_breakpoint_mutex;
|
|
bool m_added_breakpoint;
|
|
lldb::user_id_t m_breakpoint_id;
|
|
};
|
|
}
|
|
|
|
#endif /* StructuredDataPluginDarwinLog_hpp */
|