tool/visual_studio_macros/nevrax_macros_howto.txt

   1 Mode d'emploi des macros Nevrax
   2 02/08/00 cado@nevrax.com
   3 $Id: nevrax_macros_howto.txt,v 1.10 2001/05/22 12:08:47 cado Exp $
   4 ----------
   5
   6 Dernière mise à jour : 22/05/2001
   7
   8 1. Nouveautés du 22/05/2001
   9 ---------------------------
  10
  11 - NevraxNewClass: Pour faire en sorte que le répertoire des
  12 fichiers include soit le même que celui des fichiers source,
  13 spécifier une chaîne vide pour le répertoire des fichiers
  14 include (boite de dialogue n°4)
  15
  16 - Il existe maintenant un fichier nevrax_macros_ryzom.dsm.
  17 La seule différence avec nevrax_macros.dsm est que le nom
  18 du projet généré dans l'en-tête des fichiers n'est pas
  19 NEL mais RYZOM.
  20
  21 - (Windows 2000 uniquement) La macro NevraxToggleHCPP
  22 recherche désormais le fichier .h dans les trois
  23 répertoires suivants si le fichier .cpp fait partie de NeL :
  24   R:\code\nel\include\nel\<module>
  25   R:\code\nel\include_private\nel\<module>
  26   Le répertoire du fichier .cpp
  27 La recherche du .cpp correspondant à un .h appartenant à
  28 NeL se fait dans :
  29   R:\code\nel\src\<module>
  30   Le répertoire du fichier .h
  31
  32 Si le fichier ne fait pas partie de nel, la recherche ne
  33 se fait que dans le même répertoire que le fichier de
  34 départ.
  35
  36
  37 1. Nouveauté du 14/12/2000
  38 --------------------------
  39 - La macro NevraxNewClass stocke les répertoires des sources
  40 et des include dans le fichier de configuration
  41 R:\code\tool\VisualStudioMacros\nevrax_new_class.cfg
  42 (sauf si vous utilisez nevrax_macros_98.dsm).
  43 IMPORTANT:
  44 Avant de lancer la macro, il faut rajouter les répertoires
  45 par défaut (par exemple R:\code\nel\src et
  46 R:\code\nel\include\nel) dans le fichier de config, à la
  47 main.
  48
  49
  50 2. Nouveautés du 18/09/2000
  51 --------------------------
  52 - La macro NevraxNewClass stocke votre nom dans un fichier
  53 (R:\code\tool\VisualStudioMacros\nevrax_new_class.cfg)
  54 (sauf si vous utilisez nevrax_macros_98.dsm).
  55 - Lorsque vous spécifiez un répertoire de travail (ex: misc,
  56 net), la macro définit le namespace correspondant, commençant
  57 par RKn dans les fichiers .h et .cpp.
  58 - Lorsque vous spécifiez un répertoire de travail (ex: misc,
  59 net), les fichiers .h et .cpp sont ajoutés dans le projet du
  60 même nom même si ce n'est pas le projet actif.
  61
  62
  63 3. Note du 13/09/2000
  64 ---------------------
  65
  66 Dans ce document, remplacez nevrax_macros.dsm par
  67 nevrax_macros_98.dsm si la macro NevraxNewClass de
  68 nevrax_macros.dsm génère une erreur en instanciant
  69 un objet ActiveX Automation "FileSystemObject".
  70 Ce problème a été constaté sous Windows 98, pas
  71 sous Windows 2000.
  72 Dans la version 98, il n'y a pas de test d'existence
  73 des fichiers et répertoires, et votre nom n'est pas
  74 stocké dans un fichier.
  75
  76
  77 4. Nouveautés du 07/09/2000
  78 ---------------------------
  79
  80 - La macro NevraxNewClass vous demande et mémorise votre nom, pour
  81 l'insérer dans le champ \name de Doxygen.
  82 - La macro NevraxNewClass teste l'existence des répertoires et des
  83 fichiers : elle vérifie que les fichiers .h et .cpp n'existent pas
  84 déjà, que les répertoires des fichiers include et source existent
  85 bien, et vous informe quand le fichier .h de l'éventuelle classe de
  86 base n'existe pas.
  87
  88
  89 5. Installation
  90 ---------------
  91
  92 a. Dans Visual Studio, menu Tools, Macros,
  93 Options>>, Loaded Files,
  94 Browse, R:\code\tool\VisualStudioMacros\nevrax_macros.dsm,
  95 Close
  96
  97 b. (Facultatif) Raccourci clavier : Menu Tools, Macros, choisir
  98 nevrax_macros dans la liste Macro File, sélectionner NevraxToggleHCPP,
  99 Options>>, Keystrokes, dans "Press new shortcut key" taper la
 100 combinaison Ctrl+< (touche Ctrl et touche <). Dans Current keys, on
 101 voit s'afficher Ctrl+< ; Close
 102
 103 c. (Facultatif) Bouton supplémentaire : Menu Tools, Macros,
 104 sélectionner NevraxNewClass (du fichier nevrax_macros), Options>>,
 105 oolbars, glisser-déposer NevraxNewClass sur une barre d'outil de Visual
 106 Studio, choisir une image pour le bouton (par exemple le petit crayon
 107 jaune), OK, Close.
 108
 109
 110 6. Utilisation
 111 --------------
 112
 113 - NevraxToggleHCPP (raccourci-clavier "Ctrl-<" installé en 1.b. ci-dessus)
 114   Cette macro sert à passer d'un .h à un .cpp et vice-versa.
 115   Elle est compatible avec l'arborescence de NeL.
 116
 117 - NevraxNewClass (bouton installé en 1.c. ci-dessus)
 118   Cette macro est un assistant de création de classe, adaptée pour
 119   NeL. Elle doit être utilisée quand un projet C++ est ouvert.
 120   Les étapes :
 121   1. Choix du nom de la classe. Ex: CMaClasse
 122   2. Confirmation du nom des fichiers .h et .cpp à créer. Ex: Pour
 123      CMaClasse, la macro propose ma_classe.
 124   3. Confirmation du répertoire des sources .cpp. Par défaut :
 125      R:\code\nel\src
 126      Pour le répertoire courant du projet, entrer un point (.)
 127   4. Confirmation du répertoire des includes .h. Par défaut :
 128      R:\code\nel\include\nel
 129      Pour le répertoire courant du projet, entrer un point (.)
 130   5. Choix ou confirmation du répertoire de travail. Celui-ci doit
 131      être tapé une fois par session de Visual Studio, après il est
 132      mémorisé. Exs: misc ou system ou 3d ou ia ou network ou database
 133      Les répertoires ainsi formés (ex: R:\code\nel\src\misc et
 134      R:\code\nel\include\nel\misc) doivent déjà exister, sans
 135      quoi Visual Studio déclenchera une "unknown error" lors de la
 136      sauvegarde du fichier.
 137      Pour le répertoire courant du projet, ne rien entrer.
 138   6. Choix ou confirmation du nom du programmeur. Comme dans l'étape
 139      précédente, on le tape une seule fois par session de Visual
 140      Studio.
 141   7. Choix d'une classe de base (si la nouvelle classe doit être
 142      dérivée d'une classe parente) (ex: CBaseClass) ou NO BASE CLASS.
 143   8. Si vous avez entré une classe de base, vous devez entrer le
 144      nom du fichier include de cette classe. Ex: nel/misc/base_class
 145      N'oubliez pas le chemin d'accès (comme dans l'exemple ci-dessus).
 146   Remarque :
 147   Le bouton Annuler fonctionne seulement dans les étapes 1,2,6,7,8
 148   (merci VBScript !). Si vous vous trompez en 3,4 ou 5, cliquez sur
 149   Annuler dans l'étape 6.