[clang][ExtractAPI] Nested types are not handled

[daniel-grumberg]

Currently ExtractAPI fails to handle nested types like:

struct MyStruct {
  struct {
    int a;
  }
}

What we would like is for the nested struct to be have a relationship to the parent context of memberOf and for the path components to reflect the nesting.

[llvmbot]

@llvm/issue-subscribers-good-first-issue

[Unique-Usman]

Hi Daniel, this is my first time on llvm, I will like to make this my first contribution, can you please guide me in solving this?

[daniel-grumberg]

If this is your first time both using LLVM as a client and contributing it would make sense to do something a bit easier first. Maybe #61478 would be a better fit. I removed the good first issue label as I think this is a bit too complex for that.

[chaitanyav]

@daniel-grumberg can i look into this?.

[daniel-grumberg]

Go for it @chaitanyav!

[chaitanyav]

@daniel-grumberg can i get an example of how the fragment should look in this case?

[daniel-grumberg]

Sorry for the delayed response. There is no precedent here, so whatever you think would be best. I would imagine something similar to what you did in https://reviews.llvm.org/D146385:

struct {
...
};

If you have a better idea let us know.

[chaitanyav]

Please let me know what you think

struct Foo {
  struct {
    int a;
  };
};

{
  "metadata": {
    "formatVersion": {
      "major": 0,
      "minor": 5,
      "patch": 3
    },
    "generator": "clang version 17.0.0 (git@github.com:llvm/llvm-project.git b2420c67e4b00d8eca7fb1af54aa520ea43c21d2)"
  },
  "module": {
    "name": "",
    "platform": {
      "architecture": "x86_64",
      "operatingSystem": {
        "name": "unknown"
      },
      "vendor": ""
    }
  },
  "relationships": [
    {
      "kind": "memberOf",
      "source": "c:@S@Foo@FI@",
      "target": "c:@S@Foo",
      "targetFallback": "Foo"
    },
    {
      "kind": "memberOf",
      "source": "c:@S@Foo@Sa@FI@a",
      "target": "c:@S@Foo@Sa",
      "targetFallback": ""
    }
  ],
  "symbols": [
    {
      "accessLevel": "public",
      "declarationFragments": [
        {
          "kind": "keyword",
          "spelling": "struct"
        },
        {
          "kind": "text",
          "spelling": " "
        },
        {
          "kind": "identifier",
          "spelling": "Foo"
        },
        {
          "kind": "text",
          "spelling": ";"
        }
      ],
      "identifier": {
        "interfaceLanguage": "c",
        "precise": "c:@S@Foo"
      },
      "kind": {
        "displayName": "Structure",
        "identifier": "c.struct"
      },
      "location": {
        "position": {
          "character": 8,
          "line": 1
        },
        "uri": "file://./issue_61477.h"
      },
      "names": {
        "navigator": [
          {
            "kind": "identifier",
            "spelling": "Foo"
          }
        ],
        "subHeading": [
          {
            "kind": "identifier",
            "spelling": "Foo"
          }
        ],
        "title": "Foo"
      },
      "pathComponents": [
        "Foo"
      ]
    },
    {
      "accessLevel": "public",
      "declarationFragments": [
        {
          "kind": "keyword",
          "spelling": "struct"
        },
        {
          "kind": "text",
          "spelling": " "
        },
        {
          "kind": "identifier",
          "spelling": ""
        },
        {
          "kind": "text",
          "spelling": ";"
        }
      ],
      "identifier": {
        "interfaceLanguage": "c",
        "precise": "c:@S@Foo@FI@"
      },
      "kind": {
        "displayName": "Instance Property",
        "identifier": "c.property"
      },
      "location": {
        "position": {
          "character": 3,
          "line": 2
        },
        "uri": "file://./issue_61477.h"
      },
      "names": {
        "navigator": [
          {
            "kind": "identifier",
            "spelling": ""
          }
        ],
        "title": ""
      },
      "pathComponents": [
        "Foo",
        ""
      ]
    },
    {
      "accessLevel": "public",
      "declarationFragments": [
        {
          "kind": "keyword",
          "spelling": "struct"
        },
        {
          "kind": "text",
          "spelling": " "
        },
        {
          "kind": "identifier",
          "spelling": ""
        },
        {
          "kind": "text",
          "spelling": ";"
        }
      ],
      "identifier": {
        "interfaceLanguage": "c",
        "precise": "c:@S@Foo@Sa"
      },
      "kind": {
        "displayName": "Structure",
        "identifier": "c.struct"
      },
      "location": {
        "position": {
          "character": 3,
          "line": 2
        },
        "uri": "file://./issue_61477.h"
      },
      "names": {
        "navigator": [
          {
            "kind": "identifier",
            "spelling": ""
          }
        ],
        "title": ""
      },
      "pathComponents": [
        ""
      ]
    },
    {
      "accessLevel": "public",
      "declarationFragments": [
        {
          "kind": "typeIdentifier",
          "preciseIdentifier": "c:I",
          "spelling": "int"
        },
        {
          "kind": "text",
          "spelling": " "
        },
        {
          "kind": "identifier",
          "spelling": "a"
        }
      ],
      "identifier": {
        "interfaceLanguage": "c",
        "precise": "c:@S@Foo@Sa@FI@a"
      },
      "kind": {
        "displayName": "Instance Property",
        "identifier": "c.property"
      },
      "location": {
        "position": {
          "character": 8,
          "line": 3
        },
        "uri": "file://./issue_61477.h"
      },
      "names": {
        "navigator": [
          {
            "kind": "identifier",
            "spelling": "a"
          }
        ],
        "subHeading": [
          {
            "kind": "identifier",
            "spelling": "a"
          }
        ],
        "title": "a"
      },
      "pathComponents": [
        "",
        "a"
      ]
    }
  ]
}                     

[daniel-grumberg]

For the following code:

struct Foo {
  struct {
    int a;
  } prop;
};

• The declaration fragments for Foo shouldn't change from what they were before.
• The declaration fragments for the anonymous nested struct should be:

  struct {
  ...
  };
  

  and the path components should read ["Foo", some anonymous name]
• The declaration fragments for prop should be:

  struct {
  ...
  } prop;
  

  and the path components should read ["Foo", "prop"]
• The declaration fragments for a should read int a; and the path components shoudl read ["Foo", anonymous name of struct, "a"]

[chaitanyav]

thanks Daniel, will work through this.