8b3af63b89
A lot of comments in LLDB are surrounded by an ASCII line to delimit the begging and end of the comment. Its use is not really consistent across the code base, sometimes the lines are longer, sometimes they are shorter and sometimes they are omitted. Furthermore, it looks kind of weird with the 80 column limit, where the comment actually extends past the line, but not by much. Furthermore, when /// is used for Doxygen comments, it looks particularly odd. And when // is used, it incorrectly gives the impression that it's actually a Doxygen comment. I assume these lines were added to improve distinguishing between comments and code. However, given that todays editors and IDEs do a great job at highlighting comments, I think it's worth to drop this for the sake of consistency. The alternative is fixing all the inconsistencies, which would create a lot more churn. Differential revision: https://reviews.llvm.org/D60508 llvm-svn: 358135
57 lines
1.5 KiB
C++
57 lines
1.5 KiB
C++
//===-- LogMessageOsLog.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 LogMessageOsLog_h
|
|
#define LogMessageOsLog_h
|
|
|
|
#include "DarwinLogInterfaces.h"
|
|
|
|
#include "ActivityStreamSPI.h"
|
|
#include "LogMessage.h"
|
|
|
|
using ActivityStreamEntry = struct os_activity_stream_entry_s;
|
|
|
|
/// Provides a unified wrapper around os_log()-style log messages.
|
|
///
|
|
/// The lifetime of this class is intended to be very short. The caller
|
|
/// must ensure that the passed in ActivityStore and ActivityStreamEntry
|
|
/// outlive this LogMessageOsLog entry.
|
|
|
|
class LogMessageOsLog : public LogMessage {
|
|
public:
|
|
static void SetFormatterFunction(os_log_copy_formatted_message_t format_func);
|
|
|
|
LogMessageOsLog(const ActivityStore &activity_store,
|
|
ActivityStreamEntry &entry);
|
|
|
|
// API methods
|
|
|
|
bool HasActivity() const override;
|
|
|
|
const char *GetActivity() const override;
|
|
|
|
std::string GetActivityChain() const override;
|
|
|
|
bool HasCategory() const override;
|
|
|
|
const char *GetCategory() const override;
|
|
|
|
bool HasSubsystem() const override;
|
|
|
|
const char *GetSubsystem() const override;
|
|
|
|
const char *GetMessage() const override;
|
|
|
|
private:
|
|
const ActivityStore &m_activity_store;
|
|
ActivityStreamEntry &m_entry;
|
|
mutable std::string m_message;
|
|
};
|
|
|
|
#endif /* LogMessageOsLog_h */
|