[libclang] add 'clang_getCursorTLSKind'

[frutiger]

Summary

Introduce the 'TLS Kind' property of variable declarations through
libclang. Additionally, provide a Python accessor for it, and test that
functionality.

[frutiger]

Exports 'TLSKind' in the 'all' array.

[compnerd]

bindings/python/tests/cindex/test_tls_kind.py

15

Can we add a test case for static TLS as well please? Also, I think that we should add a test case for __declspec(thread).

tools/libclang/CIndex.cpp

7426

This block is not properly formatted. Please clang-format your code.

[frutiger]

bindings/python/tests/cindex/test_tls_kind.py

15

I will add a test case for static TLS.

__declspec(thread) is not implemented as a TLS kind on a cursor; instead it is implemented as a child attribute of the cursor. Would you like me to add a test case for that here?

tools/libclang/CIndex.cpp

7426

I will fix this, thank you for the feedback.

[frutiger]

bindings/python/tests/cindex/test_tls_kind.py

15

Please ignore the above comment regarding __declspec(thread), it does indeed add a static TLS kind to the cursor.

[frutiger]

Add test cases for __declspec(thread) and static TLS. Clean up formatting to adhere to the project style.

[compnerd]

bindings/python/tests/cindex/test_tls_kind.py

33

Would be nicer to use x86_64-unknown-windows-msvc as the target.

[frutiger]

Use more specific target platform.

[nik]

include/clang-c/Index.h

2840

I was wondering what "TLS" is and had to look it up. If not adapting the function and enum name, then maybe at least write it out once in the documentation.

[frutiger]

Expand the acronym 'TLS' to 'thread-local storage' in documentation.

[compnerd]

Do you have commit rights or would you like me to commit this on your behalf?

[frutiger]

I do not have commit rights - please commit this yourself, thanks!

[compnerd]

SVN r313111

bindings/python/clang/cindex.py

 
         return self._loc
 
+    @property
+    def tls_kind(self):
+        """Return the thread-local storage (TLS) kind of this cursor."""
+        if not hasattr(self, '_tls_kind'):
+            self._tls_kind = conf.lib.clang_getCursorTLSKind(self)
+
+        return TLSKind.from_id(self._tls_kind)
+
     @property
     def extent(self):
         """

 RefQualifierKind.LVALUE = RefQualifierKind(1)
 RefQualifierKind.RVALUE = RefQualifierKind(2)
 
+class TLSKind(BaseEnumeration):
+    """Describes the kind of thread-local storage (TLS) of a cursor."""
+
+    # The unique kind objects, indexed by id.
+    _kinds = []
+    _name_map = None
+
+    def from_param(self):
+        return self.value
+
+    def __repr__(self):
+        return 'TLSKind.%s' % (self.name,)
+
+TLSKind.NONE = TLSKind(0)
+TLSKind.DYNAMIC = TLSKind(1)
+TLSKind.STATIC = TLSKind(2)
+
 class Type(Structure):
     """
     The type of an element in the abstract syntax tree.

     'Index',
     'SourceLocation',
     'SourceRange',
+    'TLSKind',
     'TokenKind',
     'Token',
     'TranslationUnitLoadError',

bindings/python/tests/cindex/test_tls_kind.py

+
+from clang.cindex import TLSKind
+from clang.cindex import Cursor
+from clang.cindex import TranslationUnit
+
+from .util import get_cursor
+from .util import get_tu
+
+def test_tls_kind():
+    """Ensure that thread-local storage kinds are available on cursors."""
+
+    tu = get_tu("""
+int tls_none;
+thread_local int tls_dynamic;
+_Thread_local int tls_static;
+""", lang = 'cpp')
+
+    tls_none = get_cursor(tu.cursor, 'tls_none')
+    assert tls_none.tls_kind == TLSKind.NONE;
+
+    tls_dynamic = get_cursor(tu.cursor, 'tls_dynamic')
+    assert tls_dynamic.tls_kind == TLSKind.DYNAMIC
+
+    tls_static = get_cursor(tu.cursor, 'tls_static')
+    assert tls_static.tls_kind == TLSKind.STATIC
+
+    # The following case tests '__declspec(thread)'.  Since it is a Microsoft
+    # specific extension, specific flags are required for the parser to pick
+    # these up.
+    flags = ['-fms-extensions', '-target', 'x86_64-unknown-windows-win32']
+    tu = get_tu("""
+__declspec(thread) int tls_declspec;
+""", lang = 'cpp', flags=flags)
+
+    tls_declspec = get_cursor(tu.cursor, 'tls_declspec')
+    assert tls_declspec.tls_kind == TLSKind.STATIC
+

include/clang-c/Index.h

  */
 CINDEX_LINKAGE enum CXLanguageKind clang_getCursorLanguage(CXCursor cursor);
 
+/**
+ * \brief Describe the "thread-local storage (TLS) kind" of the declaration
+ * referred to by a cursor.
+ */
+enum CXTLSKind {
+  CXTLS_None = 0,
+  CXTLS_Dynamic,
+  CXTLS_Static
+};
+
+/**
+ * \brief Determine the "thread-local storage (TLS) kind" of the declaration
+ * referred to by a cursor.
+ */
+CINDEX_LINKAGE enum CXTLSKind clang_getCursorTLSKind(CXCursor cursor);
+
 /**
  * \brief Returns the translation unit that a cursor originated from.
  */

tools/libclang/CIndex.cpp

   return CXLanguage_Invalid;
 }
 
+CXTLSKind clang_getCursorTLSKind(CXCursor cursor) {
+  const Decl *D = cxcursor::getCursorDecl(cursor);
+  if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
+    switch (VD->getTLSKind()) {
+    case VarDecl::TLS_None:
+      return CXTLS_None;
+    case VarDecl::TLS_Dynamic:
+      return CXTLS_Dynamic;
+    case VarDecl::TLS_Static:
+      return CXTLS_Static;
+    }
+  }
+
+  return CXTLS_None;
+}
+
  /// \brief If the given cursor is the "templated" declaration
  /// descibing a class or function template, return the class or
  /// function template.

tools/libclang/libclang.exports

 clang_getCursorResultType
 clang_getCursorSemanticParent
 clang_getCursorSpelling
+clang_getCursorTLSKind
 clang_getCursorType
 clang_getCursorUSR
 clang_getCursorVisibility