Fix parsing expressions to evaluate with spaces and optional args (MI)

[ki.stfu]

Summary

When extracting options for long options (starting with --), the use of
MIUtilString::SplitConsiderQuotes to split all the arguments was being
conditioned on the option type to be expected. This was wrong as this caused
other options to be parsed incorrectly since it was not taking into account the
presence of quotes.

Patch by Ed Munoz <[e-mail]>

[edmunoz]

tools/lldb-mi/MICmdArgValOptionLong.cpp

190 ↗

(On Diff #70209)

We could use the size of vrwTxt.GetArgs() to reduce the number of calls to CMIUtilString::SplitConsiderQuotes in CMICmdArgContext.

I left it using the more expressive method name, but I'm open to changing it.

[ki.stfu]

lgtm

@edmunoz, good job. Thank you! Would you like me to commit?

[edmunoz]

In D24202#539629, @ki.stfu wrote:

lgtm

@edmunoz, good job. Thank you! Would you like me to commit?

Thanks! Yes, go ahead.

[ki.stfu]

Rebase againt ToT; Apply clang-format & autopep; Minor fix in condition

[ki.stfu]

tools/lldb-mi/MICmdArgValOptionLong.cpp

187–188 ↗

(On Diff #72136)

@edmunoz: I did it as you suggested.

lldb/trunk/packages/Python/lldbsuite/test/tools/lldb-mi/variable/TestMiVar.py

def test_lldbmi_eval(self):
         self.expect("\^done,numchild=\"0\",has_more=\"0\"")
         # Ensure -var-list-children also works with quotes
         self.runCmd("-var-list-children \"var2\"")
         self.expect("\^done,numchild=\"0\",has_more=\"0\"")
         self.runCmd("-data-evaluate-expression \"g_MyVar=30\"")
         self.expect("\^done,value=\"30\"")
         self.runCmd("-var-update --all-values var2")
         # self.expect("\^done,changelist=\[\{name=\"var2\",value=\"30\",in_scope=\"true\",type_changed=\"false\",has_more=\"0\"\}\]")
-        # #FIXME -var-update doesn't work
+        # FIXME -var-update doesn't work
         self.runCmd("-var-delete var2")
         self.expect("\^done")
         self.runCmd("-var-create var2 * g_MyVar")
         self.expect(
             "\^done,name=\"var2\",numchild=\"0\",value=\"30\",type=\"int\",thread-id=\"1\",has_more=\"0\"")
 
         # Print static "s_MyVar", modify, delete and create again
         self.runCmd("-data-evaluate-expression s_MyVar")
         self.expect("\^done,value=\"30\"")
         self.runCmd("-var-create var3 * s_MyVar")
         self.expect(
             "\^done,name=\"var3\",numchild=\"0\",value=\"30\",type=\"int\",thread-id=\"1\",has_more=\"0\"")
         self.runCmd("-var-evaluate-expression var3")
         self.expect("\^done,value=\"30\"")
         self.runCmd("-var-show-attributes var3")
         self.expect("\^done,status=\"editable\"")
         self.runCmd("-var-list-children var3")
         self.expect("\^done,numchild=\"0\",has_more=\"0\"")
         self.runCmd("-data-evaluate-expression \"s_MyVar=3\"")
         self.expect("\^done,value=\"3\"")
         self.runCmd("-var-update --all-values var3")
         # self.expect("\^done,changelist=\[\{name=\"var3\",value=\"3\",in_scope=\"true\",type_changed=\"false\",has_more=\"0\"\}\]")
-        # #FIXME -var-update doesn't work
+        # FIXME -var-update doesn't work
         self.runCmd("-var-delete var3")
         self.expect("\^done")
         self.runCmd("-var-create var3 * s_MyVar")
         self.expect(
             "\^done,name=\"var3\",numchild=\"0\",value=\"3\",type=\"int\",thread-id=\"1\",has_more=\"0\"")
 
         # Print local "b", modify, delete and create again
         self.runCmd("-data-evaluate-expression b")
         self.expect("\^done,value=\"20\"")
         self.runCmd("-var-create var4 * b")
         self.expect(
             "\^done,name=\"var4\",numchild=\"0\",value=\"20\",type=\"int\",thread-id=\"1\",has_more=\"0\"")
         self.runCmd("-var-evaluate-expression var4")
         self.expect("\^done,value=\"20\"")
         self.runCmd("-var-show-attributes var4")
         self.expect("\^done,status=\"editable\"")
         self.runCmd("-var-list-children var4")
         self.expect("\^done,numchild=\"0\",has_more=\"0\"")
         self.runCmd("-data-evaluate-expression \"b=2\"")
         self.expect("\^done,value=\"2\"")
         self.runCmd("-var-update --all-values var4")
         # self.expect("\^done,changelist=\[\{name=\"var4\",value=\"2\",in_scope=\"true\",type_changed=\"false\",has_more=\"0\"\}\]")
-        # #FIXME -var-update doesn't work
+        # FIXME -var-update doesn't work
         self.runCmd("-var-delete var4")
         self.expect("\^done")
         self.runCmd("-var-create var4 * b")
         self.expect(
             "\^done,name=\"var4\",numchild=\"0\",value=\"2\",type=\"int\",thread-id=\"1\",has_more=\"0\"")
 
         # Print temp "a + b"
         self.runCmd("-data-evaluate-expression \"a + b\"")
def test_lldbmi_eval(self):
         self.runCmd("-var-show-attributes var6")
         self.expect("\^done,status=\"editable\"")
         self.runCmd("-var-list-children --all-values var6")
         # FIXME: The name below is not correct. It should be "var.*argv[0]".
         # FIXME -var-list-children shows invalid thread-id
         self.expect(
             "\^done,numchild=\"1\",children=\[child=\{name=\"var6\.\*\$[0-9]+\",exp=\"\*\$[0-9]+\",numchild=\"0\",type=\"const char\",thread-id=\"4294967295\",value=\"47 '/'\",has_more=\"0\"\}\],has_more=\"0\"")
 
+        # Print an expression with spaces and optional arguments
+        self.runCmd("-data-evaluate-expression \"a + b\"")
+        self.expect("\^done,value=\"12\"")
+        self.runCmd("-var-create var7 * \"a + b\" --thread 1 --frame 0")
+        self.expect(
+            "\^done,name=\"var7\",numchild=\"0\",value=\"12\",type=\"int\",thread-id=\"1\",has_more=\"0\"")
+
     @skipIfWindows  # llvm.org/pr24452: Get lldb-mi tests working on Windows
     @skipIfFreeBSD  # llvm.org/pr22411: Failure presumably due to known thread races
     @skipIfLinux  # llvm.org/pr22841: lldb-mi tests fail on all Linux buildbots
     def test_lldbmi_var_update(self):
         """Test that 'lldb-mi --interpreter' works for -var-update."""
 
         self.spawnLldbMi(args=None)
 
def test_lldbmi_var_list_children(self):
         self.runCmd("-var-list-children var_complx 99 0")
         self.expect("\^done,numchild=\"0\",has_more=\"1\"")
         self.runCmd("-var-list-children var_complx 99 3")
         self.expect("\^done,numchild=\"0\",has_more=\"0\"")
 
         # Test that -var-list-children lists all children with their values
         # (and that from and to are optional)
         self.runCmd("-var-list-children --all-values var_complx")
-        self.expect("\^done,numchild=\"3\",children=\[child=\{name=\"var_complx\.i\",exp=\"i\",numchild=\"0\",type=\"int\",thread-id=\"1\",value=\"3\",has_more=\"0\"\},child=\{name=\"var_complx\.inner\",exp=\"inner\",numchild=\"1\",type=\"complex_type::\(anonymous struct\)\",thread-id=\"1\",value=\"\{\.\.\.\}\",has_more=\"0\"\},child=\{name=\"var_complx\.complex_ptr\",exp=\"complex_ptr\",numchild=\"3\",type=\"complex_type \*\",thread-id=\"1\",value=\"0x[0-9a-f]+\",has_more=\"0\"\}\],has_more=\"0\"")
+        self.expect(
+            "\^done,numchild=\"3\",children=\[child=\{name=\"var_complx\.i\",exp=\"i\",numchild=\"0\",type=\"int\",thread-id=\"1\",value=\"3\",has_more=\"0\"\},child=\{name=\"var_complx\.inner\",exp=\"inner\",numchild=\"1\",type=\"complex_type::\(anonymous struct\)\",thread-id=\"1\",value=\"\{\.\.\.\}\",has_more=\"0\"\},child=\{name=\"var_complx\.complex_ptr\",exp=\"complex_ptr\",numchild=\"3\",type=\"complex_type \*\",thread-id=\"1\",value=\"0x[0-9a-f]+\",has_more=\"0\"\}\],has_more=\"0\"")
         self.runCmd("-var-list-children --simple-values var_complx_array")
         self.expect(
             "\^done,numchild=\"2\",children=\[child=\{name=\"var_complx_array\.\[0\]\",exp=\"\[0\]\",numchild=\"3\",type=\"complex_type\",thread-id=\"1\",has_more=\"0\"\},child=\{name=\"var_complx_array\.\[1\]\",exp=\"\[1\]\",numchild=\"3\",type=\"complex_type\",thread-id=\"1\",has_more=\"0\"\}\],has_more=\"0\"")
         self.runCmd("-var-list-children 0 var_pcomplx")
-        self.expect("\^done,numchild=\"2\",children=\[child=\{name=\"var_pcomplx\.complex_type\",exp=\"complex_type\",numchild=\"3\",type=\"complex_type\",thread-id=\"1\",has_more=\"0\"\},child={name=\"var_pcomplx\.complx\",exp=\"complx\",numchild=\"3\",type=\"complex_type\",thread-id=\"1\",has_more=\"0\"\}\],has_more=\"0\"")
+        self.expect(
+            "\^done,numchild=\"2\",children=\[child=\{name=\"var_pcomplx\.complex_type\",exp=\"complex_type\",numchild=\"3\",type=\"complex_type\",thread-id=\"1\",has_more=\"0\"\},child={name=\"var_pcomplx\.complx\",exp=\"complx\",numchild=\"3\",type=\"complex_type\",thread-id=\"1\",has_more=\"0\"\}\],has_more=\"0\"")
 
         # Test that -var-list-children lists children without values
         self.runCmd("-var-list-children 0 var_complx 0 1")
         self.expect(
             "\^done,numchild=\"1\",children=\[child=\{name=\"var_complx\.i\",exp=\"i\",numchild=\"0\",type=\"int\",thread-id=\"1\",has_more=\"0\"\}\],has_more=\"1\"")
         self.runCmd("-var-list-children --no-values var_complx 0 1")
         self.expect(
             "\^done,numchild=\"1\",children=\[child=\{name=\"var_complx\.i\",exp=\"i\",numchild=\"0\",type=\"int\",thread-id=\"1\",has_more=\"0\"\}\],has_more=\"1\"")

lldb/trunk/tools/lldb-mi/MICmdArgValOptionLong.cpp

 //          nArgIndex   - (R)   The Nth arg position in argument context from
 //          the left.
 // Return:  MIstatus::success - Functional succeeded.
 //          MIstatus::failure - Functional failed.
 // Throws:  None.
 //--
 bool CMICmdArgValOptionLong::ExtractExpectedOptions(CMICmdArgContext &vrwTxt,
                                                     const MIuint nArgIndex) {
-  CMIUtilString::VecString_t vecOptions;
-  MIuint nOptionsPresent = 0;
-  if ((m_eExpectingOptionType != eArgValType_StringQuoted) &&
-      (m_eExpectingOptionType != eArgValType_StringQuotedNumber) &&
-      (m_eExpectingOptionType != eArgValType_StringQuotedNumberPath))
-    nOptionsPresent = vrwTxt.GetArgsLeftToParse().Split(" ", vecOptions);
-  else
-    nOptionsPresent =
-        vrwTxt.GetArgsLeftToParse().SplitConsiderQuotes(" ", vecOptions);
-  if (nOptionsPresent == 0)
+  CMIUtilString::VecString_t vecOptions = vrwTxt.GetArgs();
+  if (vecOptions.size() == 0)
     return MIstatus::failure;
 
   MIuint nArgIndexCnt = 0;
   MIuint nTypeCnt = 0;
   MIuint nTypeCnt2 = 0;
   MIuint nFoundNOptionsCnt = 0;
   CMIUtilString::VecString_t::const_iterator it = vecOptions.begin();
   while (it != vecOptions.end()) {