add clang_CXXMethod_isDeleted function

[anderslanglands]

Summary

Adds a function to check if a method has been deleted by copy-pasting the existing implementation of clang_CXXMethod_isDefaulted and changing it to call CXXMethod::isDeleted() instead.

[tbaeder]

clang/tools/libclang/CIndex.cpp

8870

[aaron.ballman]

Thanks for this! Can you add a release note to clang/docs/ReleaseNotes.rst and some test coverage for the change to clang/test/Index for the change? Also, it looks like precommit CI found a relevant failure that needs to be fixed:

******************** TEST 'Clang :: Index/availability.cpp' FAILED ********************
Script:
--
: 'RUN: at line 9';   c:\ws\w3\llvm-project\premerge-checks\build\bin\c-index-test.exe -test-print-type --std=c++11 C:\ws\w3\llvm-project\premerge-checks\clang\test\Index\availability.cpp | c:\ws\w3\llvm-project\premerge-checks\build\bin\filecheck.exe C:\ws\w3\llvm-project\premerge-checks\clang\test\Index\availability.cpp
--
Exit Code: 1
 
Command Output (stdout):
--
$ ":" "RUN: at line 9"
$ "c:\ws\w3\llvm-project\premerge-checks\build\bin\c-index-test.exe" "-test-print-type" "--std=c++11" "C:\ws\w3\llvm-project\premerge-checks\clang\test\Index\availability.cpp"
$ "c:\ws\w3\llvm-project\premerge-checks\build\bin\filecheck.exe" "C:\ws\w3\llvm-project\premerge-checks\clang\test\Index\availability.cpp"
# command stderr:
C:\ws\w3\llvm-project\premerge-checks\clang\test\Index\availability.cpp:12:11: error: CHECK: expected string not found in input
// CHECK: CXXMethod=foo:4:7 (unavailable) [type=int (){{.*}}] [typekind=FunctionProto] [resulttype=int] [resulttypekind=Int] [isPOD=0]
          ^
<stdin>:394:71: note: scanning from here
StructDecl=Foo:3:8 (Definition) [type=Foo] [typekind=Record] [isPOD=1] [isAnonRecDecl=0]
                                                                      ^
<stdin>:395:1: note: possible intended match here
CXXMethod=foo:4:7 (unavailable) (deleted) [type=int ()] [typekind=FunctionProto] [resulttype=int] [resulttypekind=Int] [isPOD=0] [isAnonRecDecl=0]
^
 
Input file: <stdin>
Check file: C:\ws\w3\llvm-project\premerge-checks\clang\test\Index\availability.cpp
 
-dump-input=help explains the following input dump.
 
Input was:
<<<<<<
            .
            .
            .
          389: macro definition=__STDCPP_DEFAULT_NEW_ALIGNMENT__ [type=] [typekind=Invalid] [isPOD=0] [isAnonRecDecl=0]
          390: macro definition=__STDCPP_THREADS__ [type=] [typekind=Invalid] [isPOD=0] [isAnonRecDecl=0]
          391: macro definition=__STDC_UTF_16__ [type=] [typekind=Invalid] [isPOD=0] [isAnonRecDecl=0]
          392: macro definition=__STDC_UTF_32__ [type=] [typekind=Invalid] [isPOD=0] [isAnonRecDecl=0]
          393: FunctionDecl=foo:1:6 (unavailable) [type=void ()] [typekind=FunctionProto] [resulttype=void] [resulttypekind=Void] [isPOD=0] [isAnonRecDecl=0]
          394: StructDecl=Foo:3:8 (Definition) [type=Foo] [typekind=Record] [isPOD=1] [isAnonRecDecl=0]
check:12'0                                                                           X~~~~~~~~~~~~~~~~~~ error: no match found
          395: CXXMethod=foo:4:7 (unavailable) (deleted) [type=int ()] [typekind=FunctionProto] [resulttype=int] [resulttypekind=Int] [isPOD=0] [isAnonRecDecl=0]
check:12'0     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
check:12'1     ?                                                                                                                                                   possible intended match
          396: CXXConstructor=Foo:5:3 (unavailable) (default constructor) (deleted) [type=void ()] [typekind=FunctionProto] [resulttype=void] [resulttypekind=Void] [isPOD=0] [isAnonRecDecl=0]
check:12'0     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>>>>>
 
error: command failed with exit status: 1
 
--
 
********************

[anderslanglands]

Updating based on review

• Add new function to release notes
• Fix failing test and add a new test specifically for this function

[tbaeder]

Looks like the new version you uploaded is only the changes to the last version. You need to merge that into your previous commit and upload a patch of that. (e.g. using git rebase -i or even just git commit --amend).

[anderslanglands]

squashing all commits into one to hopefully fix the revision

[tbaeder]

clang/docs/ReleaseNotes.rst

399

[anderslanglands]

Adding in the dyn_cast_is_present change I missed on the previous one

[anderslanglands]

OK that should all be good now. Thanks for your patience, it's my first time doing all this.

[aaron.ballman]

LGTM aside from the one minor nit.

Do you need someone to commit on your behalf? If so, what name and email address would you like used for patch attribution?

clang/docs/ReleaseNotes.rst

399

Looks like this change still needs to be applied.

[anderslanglands]

Adding missing backtick

[anderslanglands]

Yes it's probably safest if someone commits on my behalf, unless someone's got time to walk me through it. Just use Anders Langlands [e-mail] for attribution please.

clang/bindings/python/clang/cindex.py

def is_move_constructor(self):
         return conf.lib.clang_CXXConstructor_isMoveConstructor(self)
 
     def is_default_method(self):
         """Returns True if the cursor refers to a C++ member function or member
         function template that is declared '= default'.
         """
         return conf.lib.clang_CXXMethod_isDefaulted(self)
 
+    def is_deleted_method(self):
+        """Returns True if the cursor refers to a C++ member function or member
+        function template that is declared '= delete'.
+        """
+        return conf.lib.clang_CXXMethod_isDeleted(self)
+
     def is_mutable_field(self):
         """Returns True if the cursor refers to a C++ field that is declared
         'mutable'.
         """
         return conf.lib.clang_CXXField_isMutable(self)
 
     def is_pure_virtual_method(self):
         """Returns True if the cursor refers to a C++ member function or member
functionList = [
   ("clang_CXXMethod_isConst",
    [Cursor],
    bool),
 
   ("clang_CXXMethod_isDefaulted",
    [Cursor],
    bool),
 
+  ("clang_CXXMethod_isDeleted",
+   [Cursor],
+   bool),
+
   ("clang_CXXMethod_isPureVirtual",
    [Cursor],
    bool),
 
   ("clang_CXXMethod_isStatic",
    [Cursor],
    bool),
 

clang/docs/ReleaseNotes.rst

 
 clang-extdef-mapping
 --------------------
 
 libclang
 --------
 - Introduced the new function ``clang_getUnqualifiedType``, which mimics
   the behavior of ``QualType::getUnqualifiedType`` for ``CXType``.
 - Introduced the new function ``clang_getNonReferenceType``, which mimics
   the behavior of ``QualType::getNonReferenceType`` for ``CXType``.
+- Introduced the new function ``clang_CXXMethod_isDeleted``, which queries
+  whether the method is declared ``= delete``.
 
 Static Analyzer
 ---------------
 - Removed the deprecated ``-analyzer-store`` and
   ``-analyzer-opt-analyze-nested-blocks`` analyzer flags.
   ``scanbuild`` was also updated accordingly.
   Passing these flags will result in a hard error.
 

clang/include/clang-c/Index.h

 CINDEX_LINKAGE unsigned clang_CXXField_isMutable(CXCursor C);
 
 /**
  * Determine if a C++ method is declared '= default'.
  */
 CINDEX_LINKAGE unsigned clang_CXXMethod_isDefaulted(CXCursor C);
 
 /**
+ * Determine if a C++ method is declared '= delete'.
+ */
+CINDEX_LINKAGE unsigned clang_CXXMethod_isDeleted(CXCursor C);
+
+/**
  * Determine if a C++ member function or member function template is
  * pure virtual.
  */
 CINDEX_LINKAGE unsigned clang_CXXMethod_isPureVirtual(CXCursor C);
 
 /**
  * Determine if a C++ member function or member function template is
  * declared 'static'.

clang/test/Index/availability.cpp

 void foo() = delete;
 
 struct Foo {
   int foo() = delete;
   Foo() = delete;
 };
 
 
 // RUN: c-index-test -test-print-type --std=c++11 %s | FileCheck %s
 // CHECK: FunctionDecl=foo:1:6 (unavailable) [type=void ()] [typekind=FunctionProto] [resulttype=void] [resulttypekind=Void] [isPOD=0]
 // CHECK: StructDecl=Foo:3:8 (Definition) [type=Foo] [typekind=Record] [isPOD=1]
-// CHECK: CXXMethod=foo:4:7 (unavailable) [type=int (){{.*}}] [typekind=FunctionProto] [resulttype=int] [resulttypekind=Int] [isPOD=0]
-// CHECK: CXXConstructor=Foo:5:3 (unavailable) (default constructor) [type=void (){{.*}}] [typekind=FunctionProto] [resulttype=void] [resulttypekind=Void] [isPOD=0]
+// CHECK: CXXMethod=foo:4:7 (unavailable) (deleted) [type=int (){{.*}}] [typekind=FunctionProto] [resulttype=int] [resulttypekind=Int] [isPOD=0]
+// CHECK: CXXConstructor=Foo:5:3 (unavailable) (default constructor) (deleted) [type=void (){{.*}}] [typekind=FunctionProto] [resulttype=void] [resulttypekind=Void] [isPOD=0]

clang/test/Index/deletion.cpp

+struct Foo {
+  int foo() = delete;
+  int bar();
+  Foo() = delete;
+  Foo(int);
+};
+
+
+// RUN: c-index-test -test-print-type --std=c++11 %s | FileCheck %s
+// CHECK: StructDecl=Foo:1:8 (Definition) [type=Foo] [typekind=Record] [isPOD=1]
+// CHECK: CXXMethod=foo:2:7 (unavailable) (deleted) [type=int (){{.*}}] [typekind=FunctionProto] [resulttype=int] [resulttypekind=Int] [isPOD=0]
+// CHECK: CXXMethod=bar:3:7 [type=int (){{.*}}] [typekind=FunctionProto] [resulttype=int] [resulttypekind=Int] [isPOD=0]
+// CHECK: CXXConstructor=Foo:4:3 (unavailable) (default constructor) (deleted) [type=void (){{.*}}] [typekind=FunctionProto] [resulttype=void] [resulttypekind=Void] [isPOD=0]
+// CHECK: CXXConstructor=Foo:5:3 (converting constructor) [type=void (int){{.*}}] [typekind=FunctionProto] [resulttype=void] [resulttypekind=Void] [args= [int] [Int]] [isPOD=0]

clang/tools/c-index-test/c-index-test.c

else {
     if (clang_CXXConstructor_isCopyConstructor(Cursor))
       printf(" (copy constructor)");
     if (clang_CXXConstructor_isConvertingConstructor(Cursor))
       printf(" (converting constructor)");
     if (clang_CXXField_isMutable(Cursor))
       printf(" (mutable)");
     if (clang_CXXMethod_isDefaulted(Cursor))
       printf(" (defaulted)");
+    if (clang_CXXMethod_isDeleted(Cursor))
+      printf(" (deleted)");
     if (clang_CXXMethod_isStatic(Cursor))
       printf(" (static)");
     if (clang_CXXMethod_isVirtual(Cursor))
       printf(" (virtual)");
     if (clang_CXXMethod_isConst(Cursor))
       printf(" (const)");
     if (clang_CXXMethod_isPureVirtual(Cursor))
       printf(" (pure)");

clang/tools/libclang/CIndex.cpp

if (!clang_isDeclaration(C.kind))
     return 0;
 
   const Decl *D = cxcursor::getCursorDecl(C);
   const CXXMethodDecl *Method =
       D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
   return (Method && Method->isDefaulted()) ? 1 : 0;
 }
 
+unsigned clang_CXXMethod_isDeleted(CXCursor C) {
+  if (!clang_isDeclaration(C.kind))
+    return 0;
+
+  const Decl *D = cxcursor::getCursorDecl(C);
+  const CXXMethodDecl *Method =
+      D ? dyn_cast_if_present<CXXMethodDecl>(D->getAsFunction()) : nullptr;
+  return (Method && Method->isDeleted()) ? 1 : 0;
+}
+
 unsigned clang_CXXMethod_isStatic(CXCursor C) {
   if (!clang_isDeclaration(C.kind))
     return 0;
 
   const Decl *D = cxcursor::getCursorDecl(C);
   const CXXMethodDecl *Method =
       D ? dyn_cast_or_null<CXXMethodDecl>(D->getAsFunction()) : nullptr;
   return (Method && Method->isStatic()) ? 1 : 0;

clang/tools/libclang/libclang.map

LLVM_13 {
 
   local: *;
 };
 
 LLVM_16 {
   global:
     clang_getUnqualifiedType;
     clang_getNonReferenceType;
+    clang_CXXMethod_isDeleted;
 };
 
 # Example of how to add a new symbol version entry.  If you do add a new symbol
 # version, please update the example to depend on the version you added.
 # LLVM_X {
 # global:
 #   clang_newsymbol;
 # };