Comment : utiliser l'objet CodeModel pour analyser du code Visual Basic

Article
08/10/2011

L'utilisation de la hiérarchie des objets CodeModel2 est une alternative à la tâche parfois complexe qu'est l'analyse de texte dans un fichier code. Vous pouvez utiliser l'objet CodeModel2 :

pour analyser la structure de votre code ;
comme base pour documenter votre code.

Les procédures suivantes supposent que vous sachiez comment accéder à l'environnement de développement des macros et créer un projet macro. Pour plus d'informations, consultez Boîte de dialogue Ajouter le projet macro.

Les espaces de noms se trouvent à la racine de l'objet CodeModel2 ou sont imbriqués dans d'autres objets CodeNamespace. Ceci reflète les contraintes de syntaxe sur les espaces de noms. Un espace de noms est soit un bloc de code de niveau supérieur soit contenu dans un autre espace de noms. Pour utiliser les procédures suivantes, vous devez avoir ouvert un projet dans l'environnement de développement intégré (IDE) de Visual Studio.

Notes

Les boîtes de dialogue et les commandes de menu qui s'affichent peuvent être différentes de celles qui sont décrites dans l'aide, en fonction de vos paramètres actifs ou de l'édition utilisée. Ces procédures ont été développées avec les paramètres de développement généraux actifs. Pour modifier vos paramètres, choisissez Importation et exportation de paramètres dans le menu Outils. Pour plus d'informations, consultez Utilisation des paramètres.

Pour trouver tous les espaces de noms contenus dans votre projet

Écrivez une méthode récursive pour récupérer tous les espaces de noms d'une application.

L'objet CodeNamespace possède une propriété Members qui contient tous les CodeElements au premier niveau de l'espace de noms.

' 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

Notes

Vous trouverez tous les espaces de noms dans un même fichier source en utilisant la propriété FileCodeModel de l'objet ProjectItem associé au fichier source. L'utilisation de cette approche nécessite une légère modification de la méthode FindAllNamespaces .

Recherche de l'espace de noms par défaut

La procédure ci-dessus retourne uniquement les espaces de noms que vous avez définis dans votre application. Chaque projet Visual Basic contient également un espace de noms par défaut. Tous les éléments de code de votre application se trouvent dans l'espace de noms par défaut, alors que la collection CodeElements ne contient pas d'objet CodeNamespace pour celui-ci. L'espace de noms par défaut peut être récupéré de tout élément CodeType de niveau supérieur.

Pour trouver l'espace de noms par défaut de votre projet

Testez les éléments de code de niveau supérieur du projet. Tout élément de code qui constitue un CodeType retourne l'élément CodeNamespace pour le projet.

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

Recherche de classes

Les déclarations de classes et les espaces de noms sont récupérés par le biais de moyens semblables. Les classes peuvent être imbriquées dans d'autres classes. Vous pouvez donc trouver des classes définies à la fois dans les espaces de noms et dans d'autres classes.

Pour trouver toutes les classes contenues dans votre projet

Écrivez une méthode récursive, comme celle qui suit, pour trouver les déclarations de classe dans un projet.

' 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