blob: 64432f2d3cd5c6968791f754dadff9d0894f88be [file] [log] [blame]
//===-- BreakpointID.h ------------------------------------------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "lldb/lldb-private.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/Optional.h"
#include "llvm/ADT/StringRef.h"
namespace lldb_private {
// class BreakpointID
class BreakpointID {
BreakpointID(lldb::break_id_t bp_id = LLDB_INVALID_BREAK_ID,
lldb::break_id_t loc_id = LLDB_INVALID_BREAK_ID);
virtual ~BreakpointID();
lldb::break_id_t GetBreakpointID() const { return m_break_id; }
lldb::break_id_t GetLocationID() const { return m_location_id; }
void SetID(lldb::break_id_t bp_id, lldb::break_id_t loc_id) {
m_break_id = bp_id;
m_location_id = loc_id;
void SetBreakpointID(lldb::break_id_t bp_id) { m_break_id = bp_id; }
void SetBreakpointLocationID(lldb::break_id_t loc_id) {
m_location_id = loc_id;
void GetDescription(Stream *s, lldb::DescriptionLevel level);
static bool IsRangeIdentifier(llvm::StringRef str);
static bool IsValidIDExpression(llvm::StringRef str);
static llvm::ArrayRef<llvm::StringRef> GetRangeSpecifiers();
/// Takes an input string containing the description of a breakpoint or
/// breakpoint and location and returns a BreakpointID filled out with
/// the proper id and location.
/// \param[in] input
/// A string containing JUST the breakpoint description.
/// \return
/// If \p input was not a valid breakpoint ID string, returns
/// \b llvm::None. Otherwise returns a BreakpointID with members filled
/// out accordingly.
static llvm::Optional<BreakpointID>
ParseCanonicalReference(llvm::StringRef input);
/// Takes an input string and checks to see whether it is a breakpoint name.
/// If it is a mal-formed breakpoint name, error will be set to an appropriate
/// error string.
/// \param[in] str
/// A string containing JUST the breakpoint description.
/// \param[out] error
/// If the name is a well-formed breakpoint name, set to success,
/// otherwise set to an error.
/// \return
/// \b true if the name is a breakpoint name (as opposed to an ID or
/// range) false otherwise.
static bool StringIsBreakpointName(llvm::StringRef str, Status &error);
/// Takes a breakpoint ID and the breakpoint location id and returns
/// a string containing the canonical description for the breakpoint
/// or breakpoint location.
/// \param[out] break_id
/// This is the break id.
/// \param[out] break_loc_id
/// This is breakpoint location id, or LLDB_INVALID_BREAK_ID is no
/// location is to be specified.
static void GetCanonicalReference(Stream *s, lldb::break_id_t break_id,
lldb::break_id_t break_loc_id);
lldb::break_id_t m_break_id;
lldb::break_id_t m_location_id;
} // namespace lldb_private