khanat-opennel-code/code/tool/visual_studio_macros/nevrax_macros_howto.txt

Mode d'emploi des macros Nevrax
02/08/00 cado@nevrax.com
$Id: nevrax_macros_howto.txt,v 1.10 2001/05/22 12:08:47 cado Exp $
----------

Derni<EFBFBD>re mise <20> jour : 22/05/2001

1. Nouveaut<75>s du 22/05/2001
---------------------------

- NevraxNewClass: Pour faire en sorte que le r<>pertoire des
fichiers include soit le m<>me que celui des fichiers source,
sp<EFBFBD>cifier une cha<68>ne vide pour le r<>pertoire des fichiers
include (boite de dialogue n<>4)

- Il existe maintenant un fichier nevrax_macros_ryzom.dsm.
La seule diff<66>rence avec nevrax_macros.dsm est que le nom
du projet g<>n<EFBFBD>r<EFBFBD> dans l'en-t<>te des fichiers n'est pas
NEL mais RYZOM.

- (Windows 2000 uniquement) La macro NevraxToggleHCPP
recherche d<>sormais le fichier .h dans les trois
r<EFBFBD>pertoires suivants si le fichier .cpp fait partie de NeL :
  R:\code\nel\include\nel\<module>
  R:\code\nel\include_private\nel\<module>
  Le r<>pertoire du fichier .cpp
La recherche du .cpp correspondant <20> un .h appartenant <20>
NeL se fait dans :
  R:\code\nel\src\<module>
  Le r<>pertoire du fichier .h

Si le fichier ne fait pas partie de nel, la recherche ne
se fait que dans le m<>me r<>pertoire que le fichier de
d<EFBFBD>part.


1. Nouveaut<75> du 14/12/2000
--------------------------
- La macro NevraxNewClass stocke les r<>pertoires des sources
et des include dans le fichier de configuration
R:\code\tool\VisualStudioMacros\nevrax_new_class.cfg
(sauf si vous utilisez nevrax_macros_98.dsm).
IMPORTANT:
Avant de lancer la macro, il faut rajouter les r<>pertoires
par d<>faut (par exemple R:\code\nel\src et
R:\code\nel\include\nel) dans le fichier de config, <20> la
main.


2. Nouveaut<75>s du 18/09/2000
--------------------------
- La macro NevraxNewClass stocke votre nom dans un fichier
(R:\code\tool\VisualStudioMacros\nevrax_new_class.cfg)
(sauf si vous utilisez nevrax_macros_98.dsm).
- Lorsque vous sp<73>cifiez un r<>pertoire de travail (ex: misc,
net), la macro d<>finit le namespace correspondant, commen<65>ant
par RKn dans les fichiers .h et .cpp.
- Lorsque vous sp<73>cifiez un r<>pertoire de travail (ex: misc,
net), les fichiers .h et .cpp sont ajout<75>s dans le projet du
m<EFBFBD>me nom m<>me si ce n'est pas le projet actif.


3. Note du 13/09/2000
---------------------

Dans ce document, remplacez nevrax_macros.dsm par
nevrax_macros_98.dsm si la macro NevraxNewClass de
nevrax_macros.dsm g<>n<EFBFBD>re une erreur en instanciant
un objet ActiveX Automation "FileSystemObject".
Ce probl<62>me a <20>t<EFBFBD> constat<61> sous Windows 98, pas
sous Windows 2000.
Dans la version 98, il n'y a pas de test d'existence
des fichiers et r<>pertoires, et votre nom n'est pas
stock<EFBFBD> dans un fichier.


4. Nouveaut<75>s du 07/09/2000
---------------------------

- La macro NevraxNewClass vous demande et m<>morise votre nom, pour
l'ins<6E>rer dans le champ \name de Doxygen.
- La macro NevraxNewClass teste l'existence des r<>pertoires et des
fichiers : elle v<>rifie que les fichiers .h et .cpp n'existent pas
d<EFBFBD>j<EFBFBD>, que les r<>pertoires des fichiers include et source existent
bien, et vous informe quand le fichier .h de l'<27>ventuelle classe de
base n'existe pas.


5. Installation
---------------

a. Dans Visual Studio, menu Tools, Macros,
Options>>, Loaded Files,
Browse, R:\code\tool\VisualStudioMacros\nevrax_macros.dsm,
Close

b. (Facultatif) Raccourci clavier : Menu Tools, Macros, choisir
nevrax_macros dans la liste Macro File, s<>lectionner NevraxToggleHCPP,
Options>>, Keystrokes, dans "Press new shortcut key" taper la
combinaison Ctrl+< (touche Ctrl et touche <). Dans Current keys, on
voit s'afficher Ctrl+< ; Close

c. (Facultatif) Bouton suppl<70>mentaire : Menu Tools, Macros,
s<EFBFBD>lectionner NevraxNewClass (du fichier nevrax_macros), Options>>,
oolbars, glisser-d<>poser NevraxNewClass sur une barre d'outil de Visual
Studio, choisir une image pour le bouton (par exemple le petit crayon
jaune), OK, Close.


6. Utilisation
--------------

- NevraxToggleHCPP (raccourci-clavier "Ctrl-<" install<6C> en 1.b. ci-dessus)
  Cette macro sert <20> passer d'un .h <20> un .cpp et vice-versa.
  Elle est compatible avec l'arborescence de NeL.

- NevraxNewClass (bouton install<6C> en 1.c. ci-dessus)
  Cette macro est un assistant de cr<63>ation de classe, adapt<70>e pour
  NeL. Elle doit <20>tre utilis<69>e quand un projet C++ est ouvert.
  Les <20>tapes :
  1. Choix du nom de la classe. Ex: CMaClasse
  2. Confirmation du nom des fichiers .h et .cpp <20> cr<63>er. Ex: Pour
     CMaClasse, la macro propose ma_classe.
  3. Confirmation du r<>pertoire des sources .cpp. Par d<>faut :
     R:\code\nel\src
     Pour le r<>pertoire courant du projet, entrer un point (.)
  4. Confirmation du r<>pertoire des includes .h. Par d<>faut :
     R:\code\nel\include\nel
     Pour le r<>pertoire courant du projet, entrer un point (.)
  5. Choix ou confirmation du r<>pertoire de travail. Celui-ci doit
     <20>tre tap<61> une fois par session de Visual Studio, apr<70>s il est
     m<>moris<69>. Exs: misc ou system ou 3d ou ia ou network ou database
     Les r<>pertoires ainsi form<72>s (ex: R:\code\nel\src\misc et
     R:\code\nel\include\nel\misc) doivent d<>j<EFBFBD> exister, sans
     quoi Visual Studio d<>clenchera une "unknown error" lors de la
     sauvegarde du fichier.
     Pour le r<>pertoire courant du projet, ne rien entrer.
  6. Choix ou confirmation du nom du programmeur. Comme dans l'<27>tape
     pr<70>c<EFBFBD>dente, on le tape une seule fois par session de Visual
     Studio.
  7. Choix d'une classe de base (si la nouvelle classe doit <20>tre
     d<>riv<69>e d'une classe parente) (ex: CBaseClass) ou NO BASE CLASS.
  8. Si vous avez entr<74> une classe de base, vous devez entrer le
     nom du fichier include de cette classe. Ex: nel/misc/base_class
     N'oubliez pas le chemin d'acc<63>s (comme dans l'exemple ci-dessus).
  Remarque :
  Le bouton Annuler fonctionne seulement dans les <20>tapes 1,2,6,7,8
  (merci VBScript !). Si vous vous trompez en 3,4 ou 5, cliquez sur
  Annuler dans l'<27>tape 6.