Roslyn: How to make codefix on context in different project?












1














I am trying to write a proprietary analyzer and codefix for the following problem. Bare in mind this is my first time using Roslyn APIs. I'll gladly accept any general tips and advice.



There is a huge code base with thousands of classes and a requirement for a change in the class inheritance hierarchy. I need to change the top base class of certain inheritance chains from System.Object to System.MarshalByRefObject.
The problem is that the reasoning of whether the change is needed down in one of the subclasses. The AnalyzeSymbol method, is passed SymbolAnalysisContext that points to one subclass, but the codefix is needed elsewhere.



I tried to pass the location of the baseclass declaration as AdditionalLocations property to the Diagnostic that I report. This works, sort of. I am able to retrieve this location on the CodeFixProvider side, but only if the location is in the same project. If the Declaration of the baseclass is in different project, as most of the time it is, the AdditionalLocations property is empty.



Example in code:

Derived class is flagged by the analyzer, here the dummy reason is the interface IVisible.



// Project A
class BaseClass
{
...
}


// Project B
class DerivedClass : BaseClass, API.IVisible
{
...
}


The expected codefix is this:



// Project A
class BaseClass : System.MarshalByRefObject
{
...
}


// Project B
class DerivedClass : BaseClass, API.IVisible
{
...
}


What is the correct way to point to a different context for the CodeFixProvider? Is there a better way to do this sort of refactoring?










share|improve this question





























    1














    I am trying to write a proprietary analyzer and codefix for the following problem. Bare in mind this is my first time using Roslyn APIs. I'll gladly accept any general tips and advice.



    There is a huge code base with thousands of classes and a requirement for a change in the class inheritance hierarchy. I need to change the top base class of certain inheritance chains from System.Object to System.MarshalByRefObject.
    The problem is that the reasoning of whether the change is needed down in one of the subclasses. The AnalyzeSymbol method, is passed SymbolAnalysisContext that points to one subclass, but the codefix is needed elsewhere.



    I tried to pass the location of the baseclass declaration as AdditionalLocations property to the Diagnostic that I report. This works, sort of. I am able to retrieve this location on the CodeFixProvider side, but only if the location is in the same project. If the Declaration of the baseclass is in different project, as most of the time it is, the AdditionalLocations property is empty.



    Example in code:

    Derived class is flagged by the analyzer, here the dummy reason is the interface IVisible.



    // Project A
    class BaseClass
    {
    ...
    }


    // Project B
    class DerivedClass : BaseClass, API.IVisible
    {
    ...
    }


    The expected codefix is this:



    // Project A
    class BaseClass : System.MarshalByRefObject
    {
    ...
    }


    // Project B
    class DerivedClass : BaseClass, API.IVisible
    {
    ...
    }


    What is the correct way to point to a different context for the CodeFixProvider? Is there a better way to do this sort of refactoring?










    share|improve this question



























      1












      1








      1







      I am trying to write a proprietary analyzer and codefix for the following problem. Bare in mind this is my first time using Roslyn APIs. I'll gladly accept any general tips and advice.



      There is a huge code base with thousands of classes and a requirement for a change in the class inheritance hierarchy. I need to change the top base class of certain inheritance chains from System.Object to System.MarshalByRefObject.
      The problem is that the reasoning of whether the change is needed down in one of the subclasses. The AnalyzeSymbol method, is passed SymbolAnalysisContext that points to one subclass, but the codefix is needed elsewhere.



      I tried to pass the location of the baseclass declaration as AdditionalLocations property to the Diagnostic that I report. This works, sort of. I am able to retrieve this location on the CodeFixProvider side, but only if the location is in the same project. If the Declaration of the baseclass is in different project, as most of the time it is, the AdditionalLocations property is empty.



      Example in code:

      Derived class is flagged by the analyzer, here the dummy reason is the interface IVisible.



      // Project A
      class BaseClass
      {
      ...
      }


      // Project B
      class DerivedClass : BaseClass, API.IVisible
      {
      ...
      }


      The expected codefix is this:



      // Project A
      class BaseClass : System.MarshalByRefObject
      {
      ...
      }


      // Project B
      class DerivedClass : BaseClass, API.IVisible
      {
      ...
      }


      What is the correct way to point to a different context for the CodeFixProvider? Is there a better way to do this sort of refactoring?










      share|improve this question















      I am trying to write a proprietary analyzer and codefix for the following problem. Bare in mind this is my first time using Roslyn APIs. I'll gladly accept any general tips and advice.



      There is a huge code base with thousands of classes and a requirement for a change in the class inheritance hierarchy. I need to change the top base class of certain inheritance chains from System.Object to System.MarshalByRefObject.
      The problem is that the reasoning of whether the change is needed down in one of the subclasses. The AnalyzeSymbol method, is passed SymbolAnalysisContext that points to one subclass, but the codefix is needed elsewhere.



      I tried to pass the location of the baseclass declaration as AdditionalLocations property to the Diagnostic that I report. This works, sort of. I am able to retrieve this location on the CodeFixProvider side, but only if the location is in the same project. If the Declaration of the baseclass is in different project, as most of the time it is, the AdditionalLocations property is empty.



      Example in code:

      Derived class is flagged by the analyzer, here the dummy reason is the interface IVisible.



      // Project A
      class BaseClass
      {
      ...
      }


      // Project B
      class DerivedClass : BaseClass, API.IVisible
      {
      ...
      }


      The expected codefix is this:



      // Project A
      class BaseClass : System.MarshalByRefObject
      {
      ...
      }


      // Project B
      class DerivedClass : BaseClass, API.IVisible
      {
      ...
      }


      What is the correct way to point to a different context for the CodeFixProvider? Is there a better way to do this sort of refactoring?







      c# roslyn roslyn-code-analysis codefixprovider






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited Nov 22 at 11:41

























      asked Nov 22 at 11:24









      Venca Mareš

      134




      134





























          active

          oldest

          votes











          Your Answer






          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "1"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: true,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: 10,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });














          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53429912%2froslyn-how-to-make-codefix-on-context-in-different-project%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown






























          active

          oldest

          votes













          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes
















          draft saved

          draft discarded




















































          Thanks for contributing an answer to Stack Overflow!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          To learn more, see our tips on writing great answers.





          Some of your past answers have not been well-received, and you're in danger of being blocked from answering.


          Please pay close attention to the following guidance:


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53429912%2froslyn-how-to-make-codefix-on-context-in-different-project%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          Different font size/position of beamer's navigation symbols template's content depending on regular/plain...

          Berounka

          I want to find a topological embedding $f : X rightarrow Y$ and $g: Y rightarrow X$, yet $X$ is not...