Descobrindo o Código usando o modelo de Código (Visual C#)

  • Artigo

O Visual Studio o modelo de código oferece a clientes de automação a capacidade de descobrir as definições de código em um projeto e modificar esses elementos de código. O modelo de código atualiza todos os objetos referenciados automaticamente quando modificações são feitas no editor de código. Por exemplo, se referir a um objeto de classe e posterior, um usuário adiciona uma nova função, ele é listado entre os membros. O modelo de código permite que os clientes de automação evitar a implementação de um analisador para Visual Studio linguagens a fim de descobrir as definições de alto nível em um projeto, como classes, interfaces, estruturas, métodos, propriedades e assim por diante.

O Visual Studio modelo de código do núcleo evita a áreas específicas do idioma de código, para que isso não acontecer, por exemplo, fornecem um modelo de objeto para instruções de funções ou fornecer detalhes completos sobre os parâmetros. Para os parâmetros, o modelo de código expõe apenas o tipo e o nome do parâmetro e nenhuma informação é fornecida sobre se o parâmetro é entrado, saída, opcional e assim por diante. Visual C++oferece uma versão estendida do modelo de código principal que se destina aos Visual C++ projetos. Para obter informações sobre isso, consulte Modelo do Visual C++ de código.

Examinando e edição de código com o modelo de código

O modelo de código é principalmente baseado em texto em que o programa ou o código do projeto é armazenado em arquivos de texto. Você pode encontrar o código do projeto usando o modelo de projeto para visitar cada item de projeto e, em seguida, verifique se o item de projeto contém o código usando FileCodeModel. Se um item de projeto contém elementos de código, esses elementos podem retornar os objetos do editor e o modelo de código pode usar o modelo de automação do editor de texto para modificar o código ou executar a análise localizadas. Usando o modelo de objeto do Editor, você pode solicitar o elemento de código que contém o ponto de inserção do editor ou um TextPoint o objeto no nível de função ou classe.

O ponto de entrada principal para o Visual Studio o modelo de código do núcleo é o CodeModel objeto. Geral CodeElements coleção é usada em vários lugares no modelo de código. Há um de cada a CodeElements nível e no nível de classe ou interface que retorna os membros desses objetos. Cada elemento de um CodeElements coleção é um CodeElement2 o objeto e cada CodeElement2 objeto tem um Kind propriedade que identifica seu tipo, seja ela uma classe, interface, struct, função, propriedade, variável e assim por diante.

Modelos de código específicos do idioma

Visual C++Fornece uma extensão ao modelo de código principal para o destino Visual C++-código específico. Por exemplo, se Language indica que um elemento de código fornecido é um Visual C++ objeto do modelo de código, e Kind = vsCMElementClass, e em seguida, você pode escolher para ambos QueryInterface (QI) para CodeClass da Visual Studio modelo de código ou QI de VCCodeClass da Visual C++ modelo de código de idioma específico. Para obter mais informações sobre o Visual C++-modelo de código específico, consulte How to: Manipular o Código usando o modelo de Código do Visual C++ (Visual C#) e Modelo do Visual C++ de código.

Notas para o modelo de código de Visual Studio

  • Somente o Visual C++ executa a implementação do modelo de código específicos de linguagem de modelagem de implementações de linguagem da Microsoft.

  • Alguns idiomas não implementam todo o Visual Studio modelo de código. Tópicos da Ajuda destaque exceções quando existirem. A maioria das diferenças entre implementações do modelo de código são devido a diferenças funcionais entre os idiomas. Por exemplo, você não pode adicionar funções para CodeNamespace objetos em Visual Basic ou Visual C# porque somente Visual C++ definições de função de nível superior de recursos.

Descrição

Este suplemento percorre os elementos de código de um Visual Studio arquivo. Para executar o exemplo, você deve ter um código de arquivo aberto no Visual Studio editor de código. Para obter mais informações sobre como executar os exemplos, consulte How to: Compilar e executar os exemplos de código de modelo de objeto de automação.

Código

// Add-in code.
using System.Windows.Forms;
public void OnConnection(object application,
 Extensibility.ext_ConnectMode connectMode, object addInInst, ref
 System.Array custom)
{
    _applicationObject = (_DTE2)application;
    _addInInstance = (AddIn)addInInst;
    // Pass the applicationObject member variable to the code example.
    OutlineCode((DTE2)_applicationObject); 
}

public void OutlineCode( DTE2 dte ) 
{ 
    FileCodeModel fileCM = 
      dte.ActiveDocument.ProjectItem.FileCodeModel; 
    CodeElements elts = null; 
    elts = fileCM.CodeElements; 
    CodeElement elt = null; 
    int i = 0; 
    MessageBox.Show( "about to walk top-level code elements ..."); 
    for ( i=1; i<=fileCM.CodeElements.Count; i++ ) 
    { 
        elt = elts.Item( i ); 
        CollapseElt( elt, elts, i ); 
    } 
} 

public void CollapseElt( CodeElement elt, CodeElements elts, long loc ) 
{ 
    EditPoint epStart = null; 
    EditPoint epEnd = null; 
    epStart = elt.StartPoint.CreateEditPoint(); 
    // Do this because we move it later.
    epEnd = elt.EndPoint.CreateEditPoint(); 
    epStart.EndOfLine(); 
    if ( ( ( elt.IsCodeType ) & ( elt.Kind !=
      vsCMElement.vsCMElementDelegate ) ) ) 
    { 
        MessageBox.Show( "got type but not a delegate, 
          named : " + elt.Name); 
        CodeType ct = null; 
        ct = ( ( EnvDTE.CodeType )( elt ) ); 
        CodeElements mems = null; 
        mems = ct.Members; 
        int i = 0; 
        for ( i=1; i<=ct.Members.Count; i++ ) 
        { 
            CollapseElt( mems.Item( i ), mems, i ); 
        } 
    } 
    else if ( ( elt.Kind == vsCMElement.vsCMElementNamespace ) ) 
    { 
        MessageBox.Show( "got a namespace, named: " + elt.Name); 
        CodeNamespace cns = null; 
        cns = ( ( EnvDTE.CodeNamespace )( elt ) ); 
        MessageBox.Show( "set cns = elt, named: " + cns.Name); 

        CodeElements mems_vb = null; 
        mems_vb = cns.Members; 
        MessageBox.Show( "got cns.members"); 
        int i = 0; 

        for ( i=1; i<=cns.Members.Count; i++ ) 
        { 
            CollapseElt( mems_vb.Item( i ), mems_vb, i ); 
        } 
    } 
}

Valores de elemento de modelo de código podem alterar.

Os valores atribuídos a elementos de modelo de código, como, por exemplo, classes, estruturas, funções, atributos, delegados e assim por diante, podem ser alterados depois de fazer determinados tipos de edições. Conseqüentemente, você não pode presumir que os valores permanecerá estáticos.

Se você atribuir um elemento de modelo de código para uma variável local, por exemplo, e em seguida, definir um valor de propriedade para essa variável local, a variável local não pode conter um elemento de modelo de código válido quando a referência mais tarde. Na verdade, ele ainda pode conter um elemento de modelo de código diferente.

Considere uma classe que contém uma função chamada "MyFunction." qual é atribuída a um CodeFunction variável e, em seguida o Name propriedade da CodeFunction é definida como o valor "YourFunction". Após a atribuição de variável, você é garantidas não mais que a variável local representa o mesmo CodeFunction. Posteriormente, acessando o valor da propriedade pode retornar E_FAIL como resultado.

A abordagem recomendada para lidar com essa situação é explicitamente reatribuir a variável local para o elemento de modelo de código correto antes de acessar os seus valores de propriedade. A seguir mostra um exemplo de como fazer isso. (O código está na forma de um add-in).

Descrição

Este suplemento demonstra a maneira correta de valores de acesso CodeElements para que o valor correto é recuperado. Para obter mais informações sobre como executar os exemplos, consulte How to: Compilar e executar os exemplos de código de modelo de objeto de automação.

Código

[Visual Basic]

Public Sub OnConnection(ByVal application As Object, ByVal _
  connectMode As ext_ConnectMode, ByVal addInInst As Object, _
  ByRef custom As Array) Implements IDTExtensibility2.OnConnection
    _applicationObject = CType(application, DTE2)
    _addInInstance = CType(addInInst, AddIn)
    ReassignValue(_applicationObject)
End Sub

Sub ReassignValue(ByVal dte As DTE2)
    ' Before running, create a new Windows application project,
    ' and then add a function to it named MyFunction.
    Try
        Dim myFCM As FileCodeModel = _
          dte.ActiveDocument.ProjectItem.FileCodeModel
        ' Change the MyFunction name in Form1 class to
        ' the name, OtherFunction.
        Dim myClass1 As CodeClass = _
          CType(myFCM.CodeElements.Item("Form1"), CodeClass2)
        Dim myFunction As CodeFunction = _
          CType(myClass1.Members.Item("MyFunction"), CodeFunction2)
        myFunction.Name = "OtherFunction"
        myFunction = CType(myClass1.Members.Item("OtherFunction"), _
          CodeFunction2)
    Catch ex As Exception
        MsgBox(ex.ToString)
    End Try
End Sub

[C#]

public void OnConnection(object application, ext_ConnectMode 
  connectMode, object addInInst, ref Array custom)
{
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;
    ReassignValue(_applicationObject);
}

// Before running, create a new Windows application project,
// and then add a function to it named MyFunction.
public void ReassignValue(DTE2 dte)
{
    try
    {
        FileCodeModel myFCM = 
          dte.ActiveDocument.ProjectItem.FileCodeModel;
        // Change the MyFunction name in Form1 class to
        // the name, OtherFunction.
        CodeClass myClass1 = 
          (CodeClass2)myFCM.CodeElements.Item("Form1");
        CodeFunction myFunction = 
          (CodeFunction2)myClass1.Members.Item("MyFunction");
        myFunction.Name = "OtherFunction";
        myFunction = 
          (CodeFunction2)myClass1.Members.Item("OtherFunction");
    }
    catch (Exception ex)
    {
        System.Windows.Forms.MessageBox.Show(ex.Message);
    }
}
ObservaçãoObservação

Definindo as propriedades de elementos filho do elemento de modelo seu código não apresentam esse comportamento. Somente as propriedades que afetam diretamente o CodeElement — como, por exemplo, o nome do elemento, o tipo de uma função, a assinatura de um método, etc. — apresentam esse comportamento não-determinístico.

Além disso, este exemplo só funcionará se o novo nome da CodeElement é única entre seus irmãos. Isso ocorre porque o Item propriedade retorna a primeira correspondência, que não funciona para sobrecarregado de propriedades/métodos, classes parciais ou espaços para nome com o mesmo nome.

Consulte também

Tarefas

How to: Compilar o Código de exemplo para extensibilidade do modelo de Código do Visual C++

How to: Criar um Adicionar-

Walkthrough: Criando um assistente

How to: Manipular o Código usando o modelo de Código do Visual C++ (Visual C#)

How to: Manipular o Código usando o Visual C++ Código Model (Visual Basic)

Conceitos

Descobrindo o Código usando o modelo de Código (Visual Basic)

Modelo do Visual C++ de código

Automation Object Model Chart

Outros recursos

Criar e controlar o ambiente Windows

Criação de assistentes e ins Adicionar-

Automation and Extensibility Reference