[SourceKit] Add documentation range in structure (SR-2487)

This PR adds the “key.docoffset” and “key.doclength” keys for declaration structures.

Author: marcelofabri

include/swift/IDE/SyntaxModel.h

@@ -137,6 +137,7 @@ struct SyntaxStructureNode {
   CharSourceRange BodyRange;
   CharSourceRange NameRange;
   CharSourceRange TypeRange;
+  CharSourceRange DocRange;
   std::vector<CharSourceRange> InheritedTypeRanges;
   std::vector<SyntaxStructureElement> Elements;
 

lib/IDE/SyntaxModel.cpp

@@ -418,6 +418,21 @@ CharSourceRange parameterNameRangeOfCallArg(const TupleExpr *TE,
   return CharSourceRange();
 }
 
+static CharSourceRange findDocCommentRange(DeclAttributes Attrs) {
+  for (auto Attr : Attrs) {
+    if (auto DocAttr = dyn_cast_or_null<RawDocCommentAttr>(Attr)) {
+      return DocAttr->getCommentRange();
+    }
+  }
+  return CharSourceRange();
+}
+
+static void setDecl(SyntaxStructureNode &N, Decl *D) {
+  N.Dcl = D;
+  N.Attrs = D->getAttrs();
+  N.DocRange = findDocCommentRange(D->getAttrs());
+}
+
 } // anonymous namespace
 
 bool SyntaxModelContext::walk(SyntaxModelWalker &Walker) {
@@ -753,7 +768,7 @@ bool ModelASTWalker::walkToDeclPre(Decl *D) {
     } else {
       // Pass Function / Method structure node.
       SyntaxStructureNode SN;
-      SN.Dcl = D;
+      setDecl(SN, D);
       const DeclContext *DC = AFD->getDeclContext();
       if (DC->isTypeContext()) {
         if (FD && FD->isStatic()) {
@@ -772,12 +787,11 @@ bool ModelASTWalker::walkToDeclPre(Decl *D) {
                                                      AFD->getBodySourceRange());
       SN.NameRange = charSourceRangeFromSourceRange(SM,
                           AFD->getSignatureSourceRange());
-      SN.Attrs = AFD->getAttrs();
       pushStructureNode(SN, AFD);
     }
   } else if (auto *NTD = dyn_cast<NominalTypeDecl>(D)) {
     SyntaxStructureNode SN;
-    SN.Dcl = D;
+    setDecl(SN, D);
     SN.Kind = syntaxStructureKindFromNominalTypeDecl(NTD);
     SN.Range = charSourceRangeFromSourceRange(SM, NTD->getSourceRange());
     SN.BodyRange = innerCharSourceRangeFromSourceRange(SM, NTD->getBraces());
@@ -792,12 +806,11 @@ bool ModelASTWalker::walkToDeclPre(Decl *D) {
       SN.Elements.emplace_back(SyntaxStructureElementKind::TypeRef, TR);
     }
 
-    SN.Attrs = NTD->getAttrs();
     pushStructureNode(SN, NTD);
 
   } else if (auto *ED = dyn_cast<ExtensionDecl>(D)) {
     SyntaxStructureNode SN;
-    SN.Dcl = D;
+    setDecl(SN, D);
     SN.Kind = SyntaxStructureKind::Extension;
     SN.Range = charSourceRangeFromSourceRange(SM, ED->getSourceRange());
     SN.BodyRange = innerCharSourceRangeFromSourceRange(SM, ED->getBraces());
@@ -811,7 +824,6 @@ bool ModelASTWalker::walkToDeclPre(Decl *D) {
       SN.Elements.emplace_back(SyntaxStructureElementKind::TypeRef, TR);
     }
 
-    SN.Attrs = ED->getAttrs();
     pushStructureNode(SN, ED);
 
   } else if (auto *PD = dyn_cast<ParamDecl>(D)) {
@@ -832,7 +844,7 @@ bool ModelASTWalker::walkToDeclPre(Decl *D) {
     const DeclContext *DC = VD->getDeclContext();
     if (DC->isTypeContext() || DC->isModuleScopeContext()) {
       SyntaxStructureNode SN;
-      SN.Dcl = D;
+      setDecl(SN, D);
       SourceRange SR;
       if (auto *PBD = VD->getParentPatternBinding())
         SR = PBD->getSourceRange();
@@ -863,7 +875,6 @@ bool ModelASTWalker::walkToDeclPre(Decl *D) {
       } else {
         SN.Kind = SyntaxStructureKind::GlobalVariable;
       }
-      SN.Attrs = VD->getAttrs();
       pushStructureNode(SN, VD);
     }
 
@@ -915,7 +926,7 @@ bool ModelASTWalker::walkToDeclPre(Decl *D) {
 
   } else if (auto *EnumCaseD = dyn_cast<EnumCaseDecl>(D)) {
     SyntaxStructureNode SN;
-    SN.Dcl = D;
+    setDecl(SN, D);
     SN.Kind = SyntaxStructureKind::EnumCase;
     SN.Range = charSourceRangeFromSourceRange(SM, D->getSourceRange());
 
@@ -939,7 +950,7 @@ bool ModelASTWalker::walkToDeclPre(Decl *D) {
         if (EnumElemD->getName().empty())
           continue;
         SyntaxStructureNode SN;
-        SN.Dcl = EnumElemD;
+        setDecl(SN, EnumElemD);
         SN.Kind = SyntaxStructureKind::EnumElement;
         SN.Range = charSourceRangeFromSourceRange(SM,
                                                   EnumElemD->getSourceRange());
@@ -956,23 +967,21 @@ bool ModelASTWalker::walkToDeclPre(Decl *D) {
     }
   } else if (auto *TypeAliasD = dyn_cast<TypeAliasDecl>(D)) {
     SyntaxStructureNode SN;
-    SN.Dcl = TypeAliasD;
+    setDecl(SN, D);
     SN.Kind = SyntaxStructureKind::TypeAlias;
     SN.Range = charSourceRangeFromSourceRange(SM,
                                               TypeAliasD->getSourceRange());
     SN.NameRange = CharSourceRange(TypeAliasD->getNameLoc(),
                                    TypeAliasD->getName().getLength());
-    SN.Attrs = TypeAliasD->getAttrs();
     pushStructureNode(SN, TypeAliasD);
   } else if (auto *SubscriptD = dyn_cast<SubscriptDecl>(D)) {
     SyntaxStructureNode SN;
-    SN.Dcl = SubscriptD;
+    setDecl(SN, D);
     SN.Kind = SyntaxStructureKind::Subscript;
     SN.Range = charSourceRangeFromSourceRange(SM,
                                               SubscriptD->getSourceRange());
     SN.BodyRange = innerCharSourceRangeFromSourceRange(SM,
                                                SubscriptD->getBracesRange());
-    SN.Attrs = SubscriptD->getAttrs();
     pushStructureNode(SN, SubscriptD);
   }
 

test/SourceKit/DocumentStructure/structure.swift.placeholders.response

@@ -77,7 +77,9 @@
       key.offset: 225,
       key.length: 36,
       key.nameoffset: 229,
-      key.namelength: 7
+      key.namelength: 7,
+      key.docoffset: 91,
+      key.doclength: 133
     },
     {
       key.kind: source.lang.swift.expr.array,

test/SourceKit/DocumentStructure/structure.swift.response

@@ -397,6 +397,8 @@
       key.namelength: 11,
       key.bodyoffset: 703,
       key.bodylength: 186,
+      key.docoffset: 663,
+      key.doclength: 19,
       key.substructure: [
         {
           key.kind: source.lang.swift.syntaxtype.comment.mark,
@@ -415,6 +417,8 @@
           key.namelength: 16,
           key.bodyoffset: 762,
           key.bodylength: 125,
+          key.docoffset: 708,
+          key.doclength: 19,
           key.substructure: [
             {
               key.kind: source.lang.swift.decl.var.parameter,
@@ -557,7 +561,9 @@
       key.offset: 1079,
       key.length: 15,
       key.nameoffset: 1089,
-      key.namelength: 4
+      key.namelength: 4,
+      key.docoffset: 1059,
+      key.doclength: 18
     },
     {
       key.kind: source.lang.swift.decl.function.free,
@@ -892,6 +898,8 @@
       key.namelength: 13,
       key.bodyoffset: 1444,
       key.bodylength: 27,
+      key.docoffset: 1387,
+      key.doclength: 18,
       key.inheritedtypes: [
         {
           key.name: "NSObject"

test/SourceKit/DocumentStructure/structure_object_literals.swift.response

@@ -11,7 +11,9 @@
       key.length: 65,
       key.typename: "S",
       key.nameoffset: 148,
-      key.namelength: 5
+      key.namelength: 5,
+      key.docoffset: 0,
+      key.doclength: 142
     },
     {
       key.kind: source.lang.swift.expr.object_literal,