doc/ForEosSystemDeveloper/.content

   1 <H2> Content </H2>
   2 <UL>
   3         <LI> <A HREF="EosTutorial.html">Quick Tutorial </A>
   4         <LI> <A HREF="#EosSetting">Eos Environment Setting </A>
   5         <LI> <A HREF="#NewTool">When you create a new tool,</A>
   6         <LI> <A HREF="#AdminTool">When you admine a tool,(Under Contruction)</A>
   7         <LI> <A HREF="#NewObj">When you create a new object,</A>
   8         <LI> <A HREF="#NewObjMethod">When you add a new method of object,(Under Contruction)</A>
   9         <LI> <A HREF="#AdminObj">When you admine a object,(Under Contruction)</A>
  10         <LI> <A HREF="#OptionControlFile">OptionControlFile,</A>
  11         <LI> <A HREF="#MainFile">Main Source File,</A>
  12         <LI> <A HREF="#SomeTechiniques">Some Techiniques for Quick Bug-fix,</A>
  13         <LI> <A HREF="EosDirMaintain.html">When you maintain Eos directories,</A>
  14 </UL>
  15 <HR>
  16 <A NAME="EosSetting">
  17 <H2> Eos Enviroment Setting </H2>
  18 </A>
  19 <OL>
  20         <LI> Eos default setting
  21                 <DT> EOS_HOME
  22                         <DD> Eos home directory
  23                 <DT> EOS_HOST
  24                         <DD> Eos working station type
  25         <LI> When you want to create a new tool on another Eos,
  26                 <DT> EOS_ANOTHER_HOME
  27                         <DD> Anonther Eos home directory
  28 </OL>
  29 <HR>
  30 <A NAME="NewTool">
  31 <H2> When you create a new tool, </H2>
  32 </A>
  33 <A HREF="Rule.html">Rule</A>
  34 <OL>
  35         <LI> create new directories and proto-type source codes
  36                 <DD> <CODE> $ <A HREF="../DevelopmentTools/maketool.html">maketool</A> classname toolname new </CODE>
  37         <LI> change a working directory.
  38                 <DD> <CODE> $ cd $EOS_HOME/src/Tools/classname/toolname/src</CODE>
  39         <LI> When you want to add new arguments, you need to modify a file of <A HREF="#OptionControlFile">../Config/OptionControlFile </A>.
  40                 <DD> Now we are creating a interactive tool, makeOptionControlFile.  Wait a moment please.
  41         <LI> If you modify a file of OptionControlFile, you must update your new source codes.
  42                 <DD> <CODE>$ make update </CODE>
  43         <LI> modify <A HREF="#MainFile">toolname.c (a main-source file)</A>
  44                 <DD> This step is essential but cannot be auto-made.
  45         <LI> check file-dependency.
  46                 <DD> <CODE>$ make depend </CODE>
  47         <LI> build a new tool
  48                 <DD> <CODE>$ make </CODE>
  49         <LI> fix bugs in a main-source file.
  50                 <DD> This step is essential, too.  It may take many hours to fix bugs.  Eos supplies <A HREF="#SomeTechniques">some techniques</A> for the purpose of quick bug-fix, while the bug-fix step cannot be auto.
  51         <LI> install a new tool
  52                 <DD> <CODE>$ make install </CODE>
  53 </OL>
  54
  55 <HR>
  56 <A NAME="OptionControlFile">
  57 <H2><A HREF="ControlFileFormat.html">Control File Format </A></H2>
  58 </A>
  59         This control file is used to generate prototype-source code.
  60
  61 <HR>
  62 <A NAME="MainFile">
  63 <H2> Main Source File </H2>
  64 </A>
  65 <UL>
  66         <LI> Main source file
  67                 <DD> Default: <A HREF="Tool.c"> Tool.c</A>
  68                 <DT> ToolInfo
  69                         <DD> This struct includes the information of argmunets (argv) of main function
  70                 <DT> init0 (init.c)
  71                         <DD> Assign default values to ToolInfo
  72                 <DT> argCheck (argCheck.c)
  73                         <DD> Assign values to ToolInfo using the information of arguments (argv)
  74                 <DT> init1 (init.c)
  75                         <DD> Initialize ToolInfo following the information of arguments (ToolInfo).
  76 </UL>
  77
  78 <HR>
  79 <A NAME="SomeTechiniques">
  80 <H2> Some Techiniques for Quick Bug-fix </H2>
  81 </A>
  82 <OL>
  83         <LI> DEBUGPRINT function (#include "genUtil.h")
  84 <H3> Example </H3>
  85 <H4>If you begin to debug programs,</H4>
  86 <PRE>
  87 #define DEBUG
  88 #include "genUtil.h"
  89
  90 ................
  91 DEBUGPRINT("This step is OK");
  92 DEBUGPRINT1("This step is OK: %ld \n", mode);
  93 ................
  94
  95 DEBUGPRINT6("This step is OK: %ld %ld %ld %ld %ld %ld\n", mode1, mode2, mode3, mode4, mode5, mode6);
  96 ................
  97
  98 </PRE>
  99 <H4>If you finish to debug programs,</H4>
 100 <PRE>
 101 #undef DEBUG
 102 #include "genUtil.h"
 103
 104 ................
 105 DEBUGPRINT("This step is OK");
 106 DEBUGPRINT1("This step is OK: %ld \n", mode);
 107 ................
 108
 109 DEBUGPRINT6("This step is OK: %ld %ld %ld %ld %ld %ld\n", mode1, mode2, mode3, mode4, mode5, mode6);
 110 ................
 111
 112 </PRE>
 113 </OL>
 114 <HR>
 115