1//===-- BreakpointID.cpp ----------------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include <stdio.h>
10
11#include "lldb/Breakpoint/Breakpoint.h"
12#include "lldb/Breakpoint/BreakpointID.h"
13#include "lldb/Utility/Status.h"
14#include "lldb/Utility/Stream.h"
15
16using namespace lldb;
17using namespace lldb_private;
18
19BreakpointID::BreakpointID(break_id_t bp_id, break_id_t loc_id)
20    : m_break_id(bp_id), m_location_id(loc_id) {}
21
22BreakpointID::~BreakpointID() = default;
23
24static llvm::StringRef g_range_specifiers[] = {"-", "to", "To", "TO"};
25
26// Tells whether or not STR is valid to use between two strings representing
27// breakpoint IDs, to indicate a range of breakpoint IDs.  This is broken out
28// into a separate function so that we can easily change or add to the format
29// for specifying ID ranges at a later date.
30
31bool BreakpointID::IsRangeIdentifier(llvm::StringRef str) {
32  for (auto spec : g_range_specifiers) {
33    if (spec == str)
34      return true;
35  }
36
37  return false;
38}
39
40bool BreakpointID::IsValidIDExpression(llvm::StringRef str) {
41  return BreakpointID::ParseCanonicalReference(str).hasValue();
42}
43
44llvm::ArrayRef<llvm::StringRef> BreakpointID::GetRangeSpecifiers() {
45  return llvm::makeArrayRef(g_range_specifiers);
46}
47
48void BreakpointID::GetDescription(Stream *s, lldb::DescriptionLevel level) {
49  if (level == eDescriptionLevelVerbose)
50    s->Printf("%p BreakpointID:", static_cast<void *>(this));
51
52  if (m_break_id == LLDB_INVALID_BREAK_ID)
53    s->PutCString("<invalid>");
54  else if (m_location_id == LLDB_INVALID_BREAK_ID)
55    s->Printf("%i", m_break_id);
56  else
57    s->Printf("%i.%i", m_break_id, m_location_id);
58}
59
60void BreakpointID::GetCanonicalReference(Stream *s, break_id_t bp_id,
61                                         break_id_t loc_id) {
62  if (bp_id == LLDB_INVALID_BREAK_ID)
63    s->PutCString("<invalid>");
64  else if (loc_id == LLDB_INVALID_BREAK_ID)
65    s->Printf("%i", bp_id);
66  else
67    s->Printf("%i.%i", bp_id, loc_id);
68}
69
70llvm::Optional<BreakpointID>
71BreakpointID::ParseCanonicalReference(llvm::StringRef input) {
72  break_id_t bp_id;
73  break_id_t loc_id = LLDB_INVALID_BREAK_ID;
74
75  if (input.empty())
76    return llvm::None;
77
78  // If it doesn't start with an integer, it's not valid.
79  if (input.consumeInteger(0, bp_id))
80    return llvm::None;
81
82  // period is optional, but if it exists, it must be followed by a number.
83  if (input.consume_front(".")) {
84    if (input.consumeInteger(0, loc_id))
85      return llvm::None;
86  }
87
88  // And at the end, the entire string must have been consumed.
89  if (!input.empty())
90    return llvm::None;
91
92  return BreakpointID(bp_id, loc_id);
93}
94
95bool BreakpointID::StringIsBreakpointName(llvm::StringRef str, Status &error) {
96  error.Clear();
97  if (str.empty())
98  {
99    error.SetErrorStringWithFormat("Empty breakpoint names are not allowed");
100    return false;
101  }
102
103  // First character must be a letter or _
104  if (!isalpha(str[0]) && str[0] != '_')
105  {
106    error.SetErrorStringWithFormat("Breakpoint names must start with a "
107                                   "character or underscore: %s",
108                                   str.str().c_str());
109    return false;
110  }
111
112  // Cannot contain ., -, or space.
113  if (str.find_first_of(".- ") != llvm::StringRef::npos) {
114    error.SetErrorStringWithFormat("Breakpoint names cannot contain "
115                                   "'.' or '-': \"%s\"",
116                                   str.str().c_str());
117    return false;
118  }
119
120  return true;
121}
122