Utilisez l'API de règles personnalisées pour COBOL Code
Review et l'API de modèle d'application COBOL (CAM) pour analyser les éléments de langage COBOL que vous avez sélectionnés pour votre règle personnalisée écrite par l'utilisateur.
Pourquoi et quand exécuter cette tâche
L'API de règles personnalisées pour COBOL Code Review
et l'API de modèle d'application COBOL sont complémentaires. Il est nécessaire d'avoir une bonne connaissance des deux pour implémenter une règle personnalisée écrite par l'utilisateur :
- API de règles personnalisées pour COBOL Code Review
Cette API fournit la classe de base pour les règles écrites par l'utilisateur et comprend des classes utiles pour manipuler les objets dans le modèle d'application COBOL (CAM).
Pour consulter la documentation de cette API, voir API de règles personnalisées pour COBOL Code Review.
- API de modèle d'application COBOL (CAM)
Cette API fournit des interfaces permettant d'accéder aux éléments d'un programme de code source COBOL pendant que ce dernier est en cours d'analyse par le composant COBOL Code Review.
Pour lire la documentation de cette API, voir API de modèle d'application COBOL.Remarque : Pour obtenir une vue d'ensemble de cette API, sélectionnez la rubrique "Package com.ibm.etools.cobol.application.model.cobol" et faites défiler jusqu'à la fin de la rubrique pour lire la section "Description".
Procédure
Pour implémenter l'analyse de code pour une règle personnalisée :
- Ouvrez la perspective de développement de plug-in.
- Dans l'Explorateur de packages, cliquez avec le bouton droit de la souris sur le fichier source Java™ qui a été généré pour votre règle personnalisée, puis cliquez sur . L'emplacement du fichier Java dans l'Explorateur de packages est . Par exemple : .
- Dans l'éditeur Java, ajoutez le code Java requis à chacune des méthodes visite() générées pour effectuer l'analyse de code nécessaire. Une méthode visit() est générée pour chaque sous-interface non abstraite de l'interface de modèle d'application COBOL correspondant à l'élément de langage COBOL que vous avez sélectionné. Par exemple, supposons que vous ayez sélectionné l'élément ACCEPT dans l'arborescence Programme dans la troisième page de l'assistant de création :
- L'interface de modèle d'application COBOL correspondant à ACCEPT est l'interface AcceptStmt.
- Les informations Javadoc de l'interface AcceptStmt indiquent, sous l'en-tête Toutes les sous-interfaces connues, que AcceptStmt possède deux sous-interfaces : AcceptDataTranferStmt et AcceptSystemInfoTransferStmt.
- Deux méthodes visit() sont générées, une pour chacune des deux sous-interfaces.
Remarque : - Les méthodes visit() appartiennent à l'interface ICOBOLVisitor du package com.ibm.rsar.analysis.codereview.cobol.custom.model.util, dans l'API de règles personnalisées pour COBOL Code Review. N'implémentez pas directement ICOBOLVisitor ;
sous-classez plutôt AbstractCOBOLVisitor. Les exemples suivants illustrent les méthodes visit() générées :
- boolean visit(com.ibm.etools.cobol.application.model.cobol.AcceptDataTransferStmt
n)
- boolean visit(com.ibm.etools.cobol.application.model.cobol.AcceptSystemInfoTransferStmt
n)
- Le noeud qui est transmis sous forme d'entrée à une méthode visit() est une sous-interface de l'interface ASTNode du package com.ibm.etools.cobol.application.model.cobol dans l'API de modèle d'application COBOL (CAM).
Lorsqu'un fichier source COBOL est analysé, l'analyseur de code lance une méthode visit() chaque fois qu'il rencontre une instance de l'interface ASTNode correspondante.
- Dans chaque méthode visit(), ajoutez le code Java correspondant aux fonctions suivantes :
- Lorsque vous avez terminé, fermez l'éditeur Java.