Fix evaluation of global operators in C++

[clayborg]

I will let Sean OK this as this is his area of expertise.

[paulherman]

Sean, could you please have a look?

Also, why is the comparison with "Class" and "id" (and return;) in FindExternalVisibleDecls in ClangASTSource.cpp and ClangExpressionDeclMap.cpp?

Thanks!

[paulherman]

Ping

[chaoren]

test/lang/cpp/global_operators/TestCppGlobalOperators.py

9

Please be careful of trailing whitespaces.

48

Please use self.get_process_working_directory() instead of cwd, so that this works for remote targets.

[spyffe]

This looks great to me. Thank you!

source/Expression/ClangASTSource.cpp

case DeclarationName::Identifier:
                 identifier_info->getBuiltinID() != 0)
             {
                 SetNoExternalVisibleDeclsForName(decl_ctx, clang_decl_name);
                 return false;
             }
         }
         break;
 
-    // Operator names.  Not important for now.
+    // Operator names.
     case DeclarationName::CXXOperatorName:
     case DeclarationName::CXXLiteralOperatorName:
-      SetNoExternalVisibleDeclsForName(decl_ctx, clang_decl_name);
-      return false;
+        break;
 
     // Using directives found in this context.
     // Tell Sema we didn't find any or we'll end up getting asked a *lot*.
     case DeclarationName::CXXUsingDirective:
       SetNoExternalVisibleDeclsForName(decl_ctx, clang_decl_name);
       return false;
 
     case DeclarationName::ObjCZeroArgSelector:
if (extern_c) {
         context = LinkageSpecDecl::Create(*ast,
                                           context,
                                           SourceLocation(),
                                           SourceLocation(),
                                           clang::LinkageSpecDecl::LanguageIDs::lang_c,
                                           false);
     }
 
+    // Pass the identifier info for functions the decl_name is needed for operators
+    clang::DeclarationName decl_name = m_decl_name.getNameKind() == DeclarationName::Identifier ? m_decl_name.getAsIdentifierInfo() : m_decl_name;
+
     clang::FunctionDecl *func_decl = FunctionDecl::Create (*ast,
                                                            context,
                                                            SourceLocation(),
                                                            SourceLocation(),
-                                                           m_decl_name.getAsIdentifierInfo(),
+                                                           decl_name,
                                                            qual_type,
                                                            NULL,
                                                            SC_Extern,
                                                            isInlineSpecified,
                                                            hasWrittenPrototype,
                                                            isConstexprSpecified);
 
     // We have to do more than just synthesize the FunctionDecl.  We have to

test/lang/cpp/global_operators/Makefile

+LEVEL = ../../../make
+
+CXX_SOURCES := main.cpp
+
+include $(LEVEL)/Makefile.rules

test/lang/cpp/global_operators/TestCppGlobalOperators.py

+"""
+Test that global operators are found and evaluated.
+"""
+import lldb
+from lldbtest import *
+import lldbutil
+
+class TestCppGlobalOperators(TestBase):
+    
+    mydir = TestBase.compute_mydir(__file__)
+    
+    @skipUnlessDarwin
+    @dsym_test
+    def test_with_dsym_and_run_command(self):
+        self.buildDsym()
+        self.check()
+
+    @dwarf_test
+    def test_with_dwarf_and_run_command(self):
+        self.buildDwarf()
+        self.check()
+
+    def setUp(self):
+        TestBase.setUp(self)
+
+    def check(self):
+        # Get main source file
+        src_file = "main.cpp"
+        src_file_spec = lldb.SBFileSpec(src_file)
+        self.assertTrue(src_file_spec.IsValid(), "Main source file")
+        
+        # Get the path of the executable
+        cwd = os.getcwd() 
+        exe_file = "a.out"
+        exe_path  = os.path.join(cwd, exe_file)
+        
+        # Load the executable
+        target = self.dbg.CreateTarget(exe_path)
+        self.assertTrue(target.IsValid(), VALID_TARGET)
+
+        # Break on main function
+        main_breakpoint = target.BreakpointCreateBySourceRegex("// break here", src_file_spec)
+        self.assertTrue(main_breakpoint.IsValid() and main_breakpoint.GetNumLocations() >= 1, VALID_BREAKPOINT)
+
+        # Launch the process
+        args = None
+        env = None
+        process = target.LaunchSimple(args, env, cwd)
+        self.assertTrue(process.IsValid(), PROCESS_IS_VALID)
+
+        # Get the thread of the process
+        self.assertTrue(process.GetState() == lldb.eStateStopped, PROCESS_STOPPED)
+        thread = lldbutil.get_stopped_thread(process, lldb.eStopReasonBreakpoint)
+
+        # Check if global operators are evaluated 
+        frame = thread.GetSelectedFrame()
+
+        test_result = frame.EvaluateExpression("operator==(s1, s2)")
+        self.assertTrue(test_result.IsValid() and test_result.GetValue() == "false", "operator==(s1, s2) = false")
+ 
+        test_result = frame.EvaluateExpression("operator==(s1, s3)")
+        self.assertTrue(test_result.IsValid() and test_result.GetValue() == "true", "operator==(s1, s3) = true")
+
+        test_result = frame.EvaluateExpression("operator==(s2, s3)")
+        self.assertTrue(test_result.IsValid() and test_result.GetValue() == "false", "operator==(s2, s3) = false")
+
+
+if __name__ == '__main__':
+    import atexit
+    lldb.SBDebugger.Initialize()
+    atexit.register(lambda: lldb.SBDebugger.Terminate())
+    unittest2.main()

test/lang/cpp/global_operators/main.cpp

+struct Struct {
+  int value;
+};
+
+bool operator==(const Struct &a, const Struct &b) {
+  return a.value == b.value;
+}
+
+int main() {
+  Struct s1, s2, s3;
+  s1.value = 3;
+  s2.value = 5;
+  s3.value = 3;
+  return 0; // break here
+}
+