Procedura: utilizzare l'oggetto CodeModel per analizzare codice Visual Basic

Articolo
09/12/2008

Aggiornamento: novembre 2007

L'utilizzo della gerarchia di oggetti CodeModel2 rappresenta un'alternativa all'operazione, potenzialmente complessa, di analisi del testo in un file di codice. È possibile utilizzare l'oggetto CodeModel2 nei seguenti casi:

Per analizzare la struttura del codice.
Come base per la documentazione del codice.

Nelle procedure riportate di seguito si presume che l'utente sia in grado di accedere all'ambiente di sviluppo delle macro e di creare un progetto macro. Per ulteriori informazioni, vedere Finestra di dialogo Aggiungi progetto macro.

Gli spazi dei nomi sono contenuti al livello principale dell'oggetto CodeModel2 oppure nidificati in altri oggetti CodeNamespace. Da questo derivano i vincoli di sintassi sugli spazi dei nomi. Uno spazio dei nomi può essere un blocco di codice di primo livello oppure uno spazio dei nomi contenuto in un altro spazio dei nomi. Per utilizzare le routine elencate di seguito, è necessario che un progetto sia aperto nell'ambiente di sviluppo integrato (IDE, Integrated Development Environment) di Visual Studio.

Nota:
È possibile che le finestre di dialogo e i comandi di menu visualizzati siano diversi rispetto a quelli descritti nella Guida in linea a seconda delle impostazioni attive o dell'edizione del programma. Queste routine sono state sviluppate con le Impostazioni generali per lo sviluppo attive. Per modificare le impostazioni, scegliere Importa/Esporta impostazioni dal menu Strumenti. Per ulteriori informazioni, vedere Impostazioni di Visual Studio.

È possibile che le finestre di dialogo e i comandi di menu visualizzati siano diversi rispetto a quelli descritti nella Guida in linea a seconda delle impostazioni attive o dell'edizione del programma. Queste routine sono state sviluppate con le Impostazioni generali per lo sviluppo attive. Per modificare le impostazioni, scegliere Importa/Esporta impostazioni dal menu Strumenti. Per ulteriori informazioni, vedere Impostazioni di Visual Studio.

Per trovare tutti gli spazi dei nomi contenuti in un progetto

Scrivere un metodo ricorsivo per recuperare tutti gli spazi dei nomi presenti in un'applicazione.

L'oggetto CodeNamespace dispone di una proprietà Members che contiene tutti i CodeElements nel primo livello dello spazio dei nomi.

' Macro editor
Sub FindAllNamespaces()
   Dim cm As CodeModel
   cm = DTE.Solution.Projects.Item(1).CodeModel

   ' Look for all the namespaces in the CodeElements
   ' of the project.
   Dim list As String
   Dim ce As CodeElement
   For Each ce In cm.CodeElements
      If TypeOf ce Is CodeNamespace Then
         GetNamespace(CType(ce, CodeNamespace), list)
      End If
   Next

   MsgBox(list)
End Sub

Sub GetNamespace(ByVal ns As CodeNamespace, ByRef list As String)
   ' Add this namespace to the list.
   list &= ns.Name & ControlChars.CrLf
   Dim aspace As CodeNamespace
   Dim ce As CodeElement
   ' Look for more namespaces.
   For Each ce In ns.Members
      If TypeOf ce Is CodeNamespace Then
         GetNamespace(CType(ce, CodeNamespace), list)
      End If
   Next
End Sub

Nota:
È possibile trovare tutti gli spazi dei nomi in un file di origine utilizzando la proprietà FileCodeModel dell'oggetto ProjectItem associato al file di origine. L'utilizzo di tale approccio richiederà una piccola modifica al metodo FindAllNamespaces.

Ricerca dello spazio dei nomi predefinito

Tramite la routine illustrata in precedenza vengono restituiti solo gli spazi dei nomi definiti nell'applicazione. In ciascun progetto Visual Basic è contenuto anche uno spazio dei nomi predefinito. Tutti gli elementi di codice dell'applicazione sono contenuti nello spazio dei nomi predefinito, sebbene nell'insieme CodeElements non sia presente un oggetto CodeNamespace a esso associato. È possibile recuperare lo spazio dei nomi predefinito da qualsiasi elemento CodeType di primo livello.

Per trovare lo spazio dei nomi predefinito per il progetto

Verificare gli elementi di codice di primo livello del progetto. Qualsiasi elemento di codice CodeType restituisce l'elemento CodeNamespace per il progetto.

Sub FindDefaultNamespace()
   Dim cm As CodeModel
   cm = DTE.Solution.Projects.Item(1).CodeModel

   Dim ce As CodeElement
   Dim ct As CodeType = Nothing
   Dim defNameSpace As CodeNamespace
   For Each ce In cm.CodeElements
      If TypeOf ce Is CodeType Then
         ct = CType(ce, CodeType)
         defNameSpace = ct.Namespace
      End If
   Next

   If Not IsNothing(defNameSpace) Then
      MsgBox(defNameSpace.Name)
   End If
End Sub

Ricerca delle classi

Gli spazi dei nomi e le dichiarazioni di classe vengono recuperate in modo analogo. Poiché le classi potrebbero essere nidificate in altre classi, è possibile trovare classi definite sia negli spazi dei nomi sia in altre classi.

Per trovare tutte le classi contenute in un progetto

Scrivere un metodo ricorsivo, come quello riportato di seguito, per trovare le dichiarazioni di classe in un progetto.

' Macro editor
Sub FindAllClasses()
   Dim cm As CodeModel
   cm = DTE.Solution.Projects.Item(1).CodeModel

   ' Look for all the namespaces and classes in the 
   ' project.
   Dim list As String
   Dim ce As CodeElement
   For Each ce In cm.CodeElements
      If (TypeOf ce Is CodeNamespace) Or (TypeOf ce Is CodeClass) Then
         ' Determine whether that namespace or class 
         ' contains other classes.
         GetClass(ce, list)
      End If
   Next

   MsgBox(list)
End Sub

Sub GetClass(ByVal ct As CodeElement, ByRef list As String)
   ' ct could be a namespace or a class. Add it to the list
   ' if it is a class.
   If (TypeOf ct Is CodeClass) Then
      list &= ct.Name & ControlChars.CrLf
   End If

   ' Determine whether there are nested namespaces or classes that 
   ' might contain other classes.
   Dim aspace As CodeNamespace
   Dim ce As CodeElement
   Dim cn As CodeNamespace
   Dim cc As CodeClass
   Dim elements As CodeElements
   If (TypeOf ct Is CodeNamespace) Then
      cn = CType(ct, CodeNamespace)
      elements = cn.Members
   Else
      cc = CType(ct, CodeClass)
      elements = cc.Members
   End If

   For Each ce In elements
      If (TypeOf ce Is CodeNamespace) Or (TypeOf ce Is CodeClass) Then
         GetClass(ce, list)
      End If
   Next
End Sub