1*0b57cec5SDimitry Andric //===-- OptionValuePathMappings.cpp ---------------------------------------===//
2*0b57cec5SDimitry Andric //
3*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
8*0b57cec5SDimitry Andric 
9*0b57cec5SDimitry Andric #include "lldb/Interpreter/OptionValuePathMappings.h"
10*0b57cec5SDimitry Andric 
11*0b57cec5SDimitry Andric #include "lldb/Host/FileSystem.h"
12*0b57cec5SDimitry Andric #include "lldb/Utility/Args.h"
13*0b57cec5SDimitry Andric #include "lldb/Utility/FileSpec.h"
14*0b57cec5SDimitry Andric #include "lldb/Utility/Stream.h"
15*0b57cec5SDimitry Andric 
16*0b57cec5SDimitry Andric using namespace lldb;
17*0b57cec5SDimitry Andric using namespace lldb_private;
18*0b57cec5SDimitry Andric 
VerifyPathExists(const char * path)19*0b57cec5SDimitry Andric static bool VerifyPathExists(const char *path) {
20*0b57cec5SDimitry Andric   if (path && path[0])
21*0b57cec5SDimitry Andric     return FileSystem::Instance().Exists(path);
22*0b57cec5SDimitry Andric   else
23*0b57cec5SDimitry Andric     return false;
24*0b57cec5SDimitry Andric }
25*0b57cec5SDimitry Andric 
DumpValue(const ExecutionContext * exe_ctx,Stream & strm,uint32_t dump_mask)26*0b57cec5SDimitry Andric void OptionValuePathMappings::DumpValue(const ExecutionContext *exe_ctx,
27*0b57cec5SDimitry Andric                                         Stream &strm, uint32_t dump_mask) {
28*0b57cec5SDimitry Andric   if (dump_mask & eDumpOptionType)
29*0b57cec5SDimitry Andric     strm.Printf("(%s)", GetTypeAsCString());
30*0b57cec5SDimitry Andric   if (dump_mask & eDumpOptionValue) {
31*0b57cec5SDimitry Andric     if (dump_mask & eDumpOptionType)
32*0b57cec5SDimitry Andric       strm.Printf(" =%s", (m_path_mappings.GetSize() > 0) ? "\n" : "");
33*0b57cec5SDimitry Andric     m_path_mappings.Dump(&strm);
34*0b57cec5SDimitry Andric   }
35*0b57cec5SDimitry Andric }
36*0b57cec5SDimitry Andric 
37*0b57cec5SDimitry Andric llvm::json::Value
ToJSON(const ExecutionContext * exe_ctx)38*0b57cec5SDimitry Andric OptionValuePathMappings::ToJSON(const ExecutionContext *exe_ctx) {
39*0b57cec5SDimitry Andric   return m_path_mappings.ToJSON();
40*0b57cec5SDimitry Andric }
41*0b57cec5SDimitry Andric 
SetValueFromString(llvm::StringRef value,VarSetOperationType op)42*0b57cec5SDimitry Andric Status OptionValuePathMappings::SetValueFromString(llvm::StringRef value,
43*0b57cec5SDimitry Andric                                                    VarSetOperationType op) {
44*0b57cec5SDimitry Andric   Status error;
45*0b57cec5SDimitry Andric   Args args(value.str());
46*0b57cec5SDimitry Andric   const size_t argc = args.GetArgumentCount();
47*0b57cec5SDimitry Andric 
48*0b57cec5SDimitry Andric   switch (op) {
49*0b57cec5SDimitry Andric   case eVarSetOperationClear:
50*0b57cec5SDimitry Andric     Clear();
51*0b57cec5SDimitry Andric     NotifyValueChanged();
52*0b57cec5SDimitry Andric     break;
53*0b57cec5SDimitry Andric 
54*0b57cec5SDimitry Andric   case eVarSetOperationReplace:
55*0b57cec5SDimitry Andric     // Must be at least one index + 1 pair of paths, and the pair count must be
56*0b57cec5SDimitry Andric     // even
57*0b57cec5SDimitry Andric     if (argc >= 3 && (((argc - 1) & 1) == 0)) {
58*0b57cec5SDimitry Andric       uint32_t idx;
59*0b57cec5SDimitry Andric       const uint32_t count = m_path_mappings.GetSize();
60*0b57cec5SDimitry Andric       if (!llvm::to_integer(args.GetArgumentAtIndex(0), idx) || idx > count) {
61*0b57cec5SDimitry Andric         error.SetErrorStringWithFormat(
62*0b57cec5SDimitry Andric             "invalid file list index %s, index must be 0 through %u",
63*0b57cec5SDimitry Andric             args.GetArgumentAtIndex(0), count);
64*0b57cec5SDimitry Andric       } else {
65*0b57cec5SDimitry Andric         bool changed = false;
66*0b57cec5SDimitry Andric         for (size_t i = 1; i < argc; idx++, i += 2) {
67*0b57cec5SDimitry Andric           const char *orginal_path = args.GetArgumentAtIndex(i);
68*0b57cec5SDimitry Andric           const char *replace_path = args.GetArgumentAtIndex(i + 1);
69*0b57cec5SDimitry Andric           if (VerifyPathExists(replace_path)) {
70*0b57cec5SDimitry Andric             if (!m_path_mappings.Replace(orginal_path, replace_path, idx,
71*0b57cec5SDimitry Andric                                          m_notify_changes))
72*0b57cec5SDimitry Andric               m_path_mappings.Append(orginal_path, replace_path,
73*0b57cec5SDimitry Andric                                      m_notify_changes);
74*0b57cec5SDimitry Andric             changed = true;
75*0b57cec5SDimitry Andric           } else {
76*0b57cec5SDimitry Andric             std::string previousError =
77*0b57cec5SDimitry Andric                 error.Fail() ? std::string(error.AsCString()) + "\n" : "";
78*0b57cec5SDimitry Andric             error.SetErrorStringWithFormat(
79*0b57cec5SDimitry Andric                 "%sthe replacement path doesn't exist: \"%s\"",
80*0b57cec5SDimitry Andric                 previousError.c_str(), replace_path);
81*0b57cec5SDimitry Andric           }
82*0b57cec5SDimitry Andric         }
83*0b57cec5SDimitry Andric         if (changed)
84*0b57cec5SDimitry Andric           NotifyValueChanged();
85*0b57cec5SDimitry Andric       }
86*0b57cec5SDimitry Andric     } else {
87*0b57cec5SDimitry Andric       error.SetErrorString("replace operation takes an array index followed by "
88*0b57cec5SDimitry Andric                            "one or more path pairs");
89*0b57cec5SDimitry Andric     }
90*0b57cec5SDimitry Andric     break;
91*0b57cec5SDimitry Andric 
92*0b57cec5SDimitry Andric   case eVarSetOperationAssign:
93*0b57cec5SDimitry Andric     if (argc < 2 || (argc & 1)) {
94*0b57cec5SDimitry Andric       error.SetErrorString("assign operation takes one or more path pairs");
95*0b57cec5SDimitry Andric       break;
96*0b57cec5SDimitry Andric     }
97*0b57cec5SDimitry Andric     m_path_mappings.Clear(m_notify_changes);
98*0b57cec5SDimitry Andric     // Fall through to append case
99*0b57cec5SDimitry Andric     [[fallthrough]];
100*0b57cec5SDimitry Andric   case eVarSetOperationAppend:
101*0b57cec5SDimitry Andric     if (argc < 2 || (argc & 1)) {
102*0b57cec5SDimitry Andric       error.SetErrorString("append operation takes one or more path pairs");
103*0b57cec5SDimitry Andric       break;
104*0b57cec5SDimitry Andric     } else {
105*0b57cec5SDimitry Andric       bool changed = false;
106*0b57cec5SDimitry Andric       for (size_t i = 0; i < argc; i += 2) {
107*0b57cec5SDimitry Andric         const char *orginal_path = args.GetArgumentAtIndex(i);
108*0b57cec5SDimitry Andric         const char *replace_path = args.GetArgumentAtIndex(i + 1);
109*0b57cec5SDimitry Andric         if (VerifyPathExists(replace_path)) {
110*0b57cec5SDimitry Andric           m_path_mappings.Append(orginal_path, replace_path, m_notify_changes);
111*0b57cec5SDimitry Andric           m_value_was_set = true;
112*0b57cec5SDimitry Andric           changed = true;
113*0b57cec5SDimitry Andric         } else {
114*0b57cec5SDimitry Andric           std::string previousError =
115*0b57cec5SDimitry Andric               error.Fail() ? std::string(error.AsCString()) + "\n" : "";
116*0b57cec5SDimitry Andric           error.SetErrorStringWithFormat(
117*0b57cec5SDimitry Andric               "%sthe replacement path doesn't exist: \"%s\"",
118*0b57cec5SDimitry Andric               previousError.c_str(), replace_path);
119*0b57cec5SDimitry Andric         }
120*0b57cec5SDimitry Andric       }
121*0b57cec5SDimitry Andric       if (changed)
122*0b57cec5SDimitry Andric         NotifyValueChanged();
123*0b57cec5SDimitry Andric     }
124*0b57cec5SDimitry Andric     break;
125*0b57cec5SDimitry Andric 
126*0b57cec5SDimitry Andric   case eVarSetOperationInsertBefore:
127*0b57cec5SDimitry Andric   case eVarSetOperationInsertAfter:
128*0b57cec5SDimitry Andric     // Must be at least one index + 1 pair of paths, and the pair count must be
129*0b57cec5SDimitry Andric     // even
130*0b57cec5SDimitry Andric     if (argc >= 3 && (((argc - 1) & 1) == 0)) {
131*0b57cec5SDimitry Andric       uint32_t idx;
132*0b57cec5SDimitry Andric       const uint32_t count = m_path_mappings.GetSize();
133*0b57cec5SDimitry Andric       if (!llvm::to_integer(args.GetArgumentAtIndex(0), idx) || idx > count) {
134*0b57cec5SDimitry Andric         error.SetErrorStringWithFormat(
135*0b57cec5SDimitry Andric             "invalid file list index %s, index must be 0 through %u",
136*0b57cec5SDimitry Andric             args.GetArgumentAtIndex(0), count);
137*0b57cec5SDimitry Andric       } else {
138*0b57cec5SDimitry Andric         bool changed = false;
139*0b57cec5SDimitry Andric         if (op == eVarSetOperationInsertAfter)
140*0b57cec5SDimitry Andric           ++idx;
141*0b57cec5SDimitry Andric         for (size_t i = 1; i < argc; i += 2) {
142*0b57cec5SDimitry Andric           const char *orginal_path = args.GetArgumentAtIndex(i);
143*0b57cec5SDimitry Andric           const char *replace_path = args.GetArgumentAtIndex(i + 1);
144*0b57cec5SDimitry Andric           if (VerifyPathExists(replace_path)) {
145*0b57cec5SDimitry Andric             m_path_mappings.Insert(orginal_path, replace_path, idx,
146*0b57cec5SDimitry Andric                                    m_notify_changes);
147*0b57cec5SDimitry Andric             changed = true;
148*0b57cec5SDimitry Andric             idx++;
149*0b57cec5SDimitry Andric           } else {
150*0b57cec5SDimitry Andric             std::string previousError =
151*0b57cec5SDimitry Andric                 error.Fail() ? std::string(error.AsCString()) + "\n" : "";
152*0b57cec5SDimitry Andric             error.SetErrorStringWithFormat(
153*0b57cec5SDimitry Andric                 "%sthe replacement path doesn't exist: \"%s\"",
154*0b57cec5SDimitry Andric                 previousError.c_str(), replace_path);
155*0b57cec5SDimitry Andric           }
156*0b57cec5SDimitry Andric         }
157*0b57cec5SDimitry Andric         if (changed)
158*0b57cec5SDimitry Andric           NotifyValueChanged();
159*0b57cec5SDimitry Andric       }
160*0b57cec5SDimitry Andric     } else {
161*0b57cec5SDimitry Andric       error.SetErrorString("insert operation takes an array index followed by "
162*0b57cec5SDimitry Andric                            "one or more path pairs");
163*0b57cec5SDimitry Andric     }
164*0b57cec5SDimitry Andric     break;
165*0b57cec5SDimitry Andric 
166*0b57cec5SDimitry Andric   case eVarSetOperationRemove:
167*0b57cec5SDimitry Andric     if (argc > 0) {
168*0b57cec5SDimitry Andric       std::vector<int> remove_indexes;
169*0b57cec5SDimitry Andric       for (size_t i = 0; i < argc; ++i) {
170*0b57cec5SDimitry Andric         int idx;
171*0b57cec5SDimitry Andric         if (!llvm::to_integer(args.GetArgumentAtIndex(i), idx) || idx < 0 ||
172*0b57cec5SDimitry Andric             idx >= (int)m_path_mappings.GetSize()) {
173*0b57cec5SDimitry Andric           error.SetErrorStringWithFormat(
174*0b57cec5SDimitry Andric               "invalid array index '%s', aborting remove operation",
175*0b57cec5SDimitry Andric               args.GetArgumentAtIndex(i));
176*0b57cec5SDimitry Andric           break;
177*0b57cec5SDimitry Andric         } else
178*0b57cec5SDimitry Andric           remove_indexes.push_back(idx);
179*0b57cec5SDimitry Andric       }
180*0b57cec5SDimitry Andric 
181*0b57cec5SDimitry Andric       // Sort and then erase in reverse so indexes are always valid
182*0b57cec5SDimitry Andric       llvm::sort(remove_indexes);
183*0b57cec5SDimitry Andric       for (auto index : llvm::reverse(remove_indexes))
184*0b57cec5SDimitry Andric         m_path_mappings.Remove(index, m_notify_changes);
185*0b57cec5SDimitry Andric       NotifyValueChanged();
186*0b57cec5SDimitry Andric     } else {
187*0b57cec5SDimitry Andric       error.SetErrorString("remove operation takes one or more array index");
188*0b57cec5SDimitry Andric     }
189*0b57cec5SDimitry Andric     break;
190*0b57cec5SDimitry Andric 
191*0b57cec5SDimitry Andric   case eVarSetOperationInvalid:
192*0b57cec5SDimitry Andric     error = OptionValue::SetValueFromString(value, op);
193*0b57cec5SDimitry Andric     break;
194*0b57cec5SDimitry Andric   }
195*0b57cec5SDimitry Andric   return error;
196*0b57cec5SDimitry Andric }
197*0b57cec5SDimitry Andric