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 $
----------

Dernire mise  jour : 22/05/2001

1. Nouveauts du 22/05/2001
---------------------------

- NevraxNewClass: Pour faire en sorte que le rpertoire des
fichiers include soit le mme que celui des fichiers source,
spcifier une chane vide pour le rpertoire des fichiers
include (boite de dialogue n4)

- Il existe maintenant un fichier nevrax_macros_ryzom.dsm.
La seule diffrence avec nevrax_macros.dsm est que le nom
du projet gnr dans l'en-tte des fichiers n'est pas
NEL mais RYZOM.

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

Si le fichier ne fait pas partie de nel, la recherche ne
se fait que dans le mme rpertoire que le fichier de
dpart.


1. Nouveaut du 14/12/2000
--------------------------
- La macro NevraxNewClass stocke les rpertoires 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 rpertoires
par dfaut (par exemple R:\code\nel\src et
R:\code\nel\include\nel) dans le fichier de config,  la
main.


2. Nouveauts 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 spcifiez un rpertoire de travail (ex: misc,
net), la macro dfinit le namespace correspondant, commenant
par RKn dans les fichiers .h et .cpp.
- Lorsque vous spcifiez un rpertoire de travail (ex: misc,
net), les fichiers .h et .cpp sont ajouts dans le projet du
mme nom mme 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 gnre une erreur en instanciant
un objet ActiveX Automation "FileSystemObject".
Ce problme a t constat sous Windows 98, pas
sous Windows 2000.
Dans la version 98, il n'y a pas de test d'existence
des fichiers et rpertoires, et votre nom n'est pas
stock dans un fichier.


4. Nouveauts du 07/09/2000
---------------------------

- La macro NevraxNewClass vous demande et mmorise votre nom, pour
l'insrer dans le champ \name de Doxygen.
- La macro NevraxNewClass teste l'existence des rpertoires et des
fichiers : elle vrifie que les fichiers .h et .cpp n'existent pas
dj, que les rpertoires des fichiers include et source existent
bien, et vous informe quand le fichier .h de l'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, slectionner 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 supplmentaire : Menu Tools, Macros,
slectionner NevraxNewClass (du fichier nevrax_macros), Options>>,
oolbars, glisser-dposer 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 en 1.b. ci-dessus)
  Cette macro sert  passer d'un .h  un .cpp et vice-versa.
  Elle est compatible avec l'arborescence de NeL.

- NevraxNewClass (bouton install en 1.c. ci-dessus)
  Cette macro est un assistant de cration de classe, adapte pour
  NeL. Elle doit tre utilise quand un projet C++ est ouvert.
  Les tapes :
  1. Choix du nom de la classe. Ex: CMaClasse
  2. Confirmation du nom des fichiers .h et .cpp  crer. Ex: Pour
     CMaClasse, la macro propose ma_classe.
  3. Confirmation du rpertoire des sources .cpp. Par dfaut :
     R:\code\nel\src
     Pour le rpertoire courant du projet, entrer un point (.)
  4. Confirmation du rpertoire des includes .h. Par dfaut :
     R:\code\nel\include\nel
     Pour le rpertoire courant du projet, entrer un point (.)
  5. Choix ou confirmation du rpertoire de travail. Celui-ci doit
     tre tap une fois par session de Visual Studio, aprs il est
     mmoris. Exs: misc ou system ou 3d ou ia ou network ou database
     Les rpertoires ainsi forms (ex: R:\code\nel\src\misc et
     R:\code\nel\include\nel\misc) doivent dj exister, sans
     quoi Visual Studio dclenchera une "unknown error" lors de la
     sauvegarde du fichier.
     Pour le rpertoire courant du projet, ne rien entrer.
  6. Choix ou confirmation du nom du programmeur. Comme dans l'tape
     prcdente, on le tape une seule fois par session de Visual
     Studio.
  7. Choix d'une classe de base (si la nouvelle classe doit tre
     drive d'une classe parente) (ex: CBaseClass) ou NO BASE CLASS.
  8. Si vous avez entr 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'accs (comme dans l'exemple ci-dessus).
  Remarque :
  Le bouton Annuler fonctionne seulement dans les tapes 1,2,6,7,8
  (merci VBScript !). Si vous vous trompez en 3,4 ou 5, cliquez sur
  Annuler dans l'tape 6.
