home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 5 / 05.iso / a / a031 / template.exe / DS_DOC.COD < prev    next >
Encoding:
Text File  |  1992-03-10  |  15.5 KB  |  475 lines
  1. //
  2. // Module Name: DS_DOC.COD
  3. // Description: Document template for dBASE IV 1.5
  4. // Notes      : Stand alone file to produce Application documentation
  5. //              compile and use separately
  6. //
  7.  
  8. Application Documentation Template
  9. ----------------------------------
  10. Version 1.5
  11. Borland International (c) 1987, 1988, 1989, 1990, 1991
  12.  
  13. {
  14.  include "applctn.def"  // Applicaton Selectors
  15.  include "builtin.def"  // Builtin Functions
  16.  
  17.  var  bnl_formname,     // Name of BNL file to newframe if argument() has value
  18.       arg_list;
  19.  
  20.  arg_list = argument()
  21.  if arg_list != "" then
  22.    bnl_formname = token( ",", arg_list, 1 )
  23.    if !newframe( bnl_formname ) then
  24.      return -1;
  25.    endif
  26.  endif
  27.  
  28. //--------------------------
  29. // Declare global variables.
  30. //--------------------------
  31. var ask_user,   // Variable to get input from user.
  32.     barcount,   // Counter for printing bar menus.
  33.     cnt,        // Counter variable
  34.     crlf,       // Line feed character.
  35.     global_View,// View from application object.
  36.     global_NDX, // Index string from application object.
  37.     global_Ord, // Order string from application object.
  38.     graph_prt,  // Logical variable (0,1) to determine what type of box to draw.
  39.     line,       // Variable to grab image from Screen()
  40.     linecnt,    // Line counter
  41.     mdoc,       // Variable to store name of application object.
  42.     mspace, mspace2, // Space variables for graphics box dump
  43.     org_appl,   // Store application frame name if we started on one.
  44.     pagecnt,    // Page count.
  45.     print_head, // Logical variable (0,1) to test printing of heading.
  46.     forflag, barflag,// Logical Variables for graphics box dump
  47.     scrn_size,  // Size of screen we are generating on
  48.     display,    // Type of display
  49.     default_drv,// dBASE default drive
  50.     temp_strng, // Variable to temporary string
  51.     temp_strng2;// Variable to temporary string
  52. //------------------------------------------------
  53. // Assign default values to some of the variables.
  54. //------------------------------------------------
  55. temp_strng = temp_strng2 = ask_user = "";
  56. global_View = Appl_View;  // Set global application dbf/view
  57. global_NDX  = Appl_NDX;   // Set global application ndx
  58. global_Ord  = Appl_Order; // Set global application Order
  59. crlf = chr(10);           // Store Linefeed chr(10) to variable
  60. pagecnt = 1;              // Set page count to 1
  61. display=numset(_flgcolor);
  62. // Test screen size if display > 2 screen is 43 lines
  63. if display > ega25 then scrn_size = 43 else scrn_size = 25 endif;
  64.  
  65. default_drv = strset(_defdrive);
  66. if filedrive(menu_name) or !default_drv then
  67.    mdoc = alltrim(menu_name);
  68. else
  69.    mdoc = default_drv + ":" + alltrim(menu_name);
  70. endif
  71. mdoc = upper(mdoc);
  72.  
  73. //-------------------------------------------------------
  74. // Check to see if documentation file is already on disk.
  75. //-------------------------------------------------------
  76. if fileexist(mdoc+".DOC") and numset(_safety) then // dBASE safety on
  77.    do while not at(upper(ask_user),"YN")
  78.      ask_user = ASKUSER("Documentation file "+mdoc+".DOC already exists...Overwrite it (Y/N)?","N",1);
  79.    enddo
  80.    if upper(ask_user) == "N" then
  81.      pause(gen_request + any_key);
  82.      goto NoGen;
  83.    endif
  84. endif
  85. //-------------------------------------------------------
  86. // Ask user if he has a IBM graphics compatible printer
  87. //  graph_prt = 0 means no graphics, 1 means use graphics
  88. //-------------------------------------------------------
  89. ask_user="";
  90. do while not at(upper(ask_user),"YN")
  91.   ask_user = ASKUSER("Do you have an IBM graphics compatible printer (Y/N)?","N",1);
  92. enddo
  93. if upper(ask_user) == "N" then graph_prt=0; else graph_prt=1; endif
  94. //-----------------
  95. // Open output file
  96. //-----------------
  97. if not create(mdoc+".DOC") then // File was read only
  98.     pause(fileroot(mdoc)+".DOC" + read_only + any_key);
  99.     goto nogen;
  100. endif
  101. }
  102. //------------------------------------------------
  103. // Print page number and author information
  104. //------------------------------------------------
  105. Page: {str(pagecnt)}  Date: {ltrim(substr(date(),1,8))}
  106.  
  107.  
  108. Application Documentation for System: {fileroot(mdoc)}.PRG
  109.  
  110. {if Appl_Authr then}
  111. Application Author: {Appl_Authr}
  112. {endif}
  113. {if Appl_Cpyrt then}
  114. Copyright Notice..: {Appl_Cpyrt}
  115. {endif}
  116. {if Appl_versn then}
  117. dBASE Version.....: {Appl_versn}
  118. {endif}
  119.  
  120. //------------------------------------
  121. // Start processing application object
  122. //------------------------------------
  123. {if Menu_Type == app then}
  124.  
  125. Display Application Sign-On Banner: {if Disp_Sign}Yes{else}No{endif}
  126. {  org_appl=Menu_Name+".APP";
  127.    if Disp_Sign then
  128.      print(crlf);
  129.      scrndump();
  130.    endif
  131. }
  132.  
  133. Main Menu to Open {if Disp_Sign then}after Sign-On{endif}: {upper(Menu_Main)}
  134.  
  135. {  endofpage();}
  136. Sets for Application:
  137. ---------------------
  138.   Bell         {if Set_Bell}OFF{else}ON {endif}\
  139. {  if Set_BellFR and Set_BellDr then}
  140.   Frequency {Set_BellFR} Duration {Set_BellDr}
  141. {  else print(crlf);
  142.    endif}
  143.   Carry        {if Set_Carry}ON{else}OFF{endif}
  144.   Centry       {if Set_Centry}ON{else}OFF{endif}
  145.   Confirm      {if Set_Confrm}ON{else}OFF{endif}
  146.   Delimiters   {if Set_Delim}ON   Character {Set_DelChr}{else}OFF{endif}
  147.   Display Size {scrn_size} lines
  148.   Drive        {if run_drive then}{upper(Run_Drive)}:{endif}
  149.   Escape       {if Set_Escape}OFF{else}ON{endif}
  150.   Path         {upper(Run_Path)}
  151.   Safety       {if Set_Safety}OFF{else}ON{endif}
  152.  
  153. {  endofpage();}
  154. Starting Colors for Application:
  155. --------------------------------
  156. // Call udf color() to get the all the different colors from the object.
  157.  Color Settings:
  158.    Text           : {color(Clr_Text)}
  159.    Heading        : {color(Clr_Heading)}
  160.    Highlight      : {color(Clr_Hghlight)}
  161. {  endofpage();}
  162.    Box            : {color(Clr_Box)}
  163.    Messages       : {color(Clr_Messages)}
  164.    Information    : {color(Clr_Info)}
  165.    Fields         : {color(Clr_Fields)}
  166.  
  167. {  endofpage();}
  168. // If user filled in application view
  169. {  if Appl_View then}
  170. Database/View: {Appl_View}
  171. {  endif}
  172. {  if Appl_NDX then endofpage();}
  173. Index File(s): {Appl_NDX}
  174. {  endif}
  175. {  if Appl_Order then endofpage();}
  176. Index Order: {Appl_Order}
  177. {  endif}
  178.  
  179. {  endofpage();
  180.    print(replicate("=",79)+crlf);
  181.    if not FILEEXIST(Menu_Main) then
  182.       pause(no_main_menu + any_key);
  183.       return 8; // resource file not found
  184.    endif
  185.    newframe(Menu_Main);
  186.  endif // if Menu_Type == app}
  187.  
  188. Menu/Picklist definitions follow:
  189. {print(replicate("-",33)+crlf);}
  190. //------------------------------------------------------------------------
  191. // This foreach TREE loop will start a menu tree walk of all objects
  192. //  referenced by the application.  This is the Main loop of any template
  193. //  that processes all menu objects.
  194. //------------------------------------------------------------------------
  195. {foreach TREE menu
  196.    pageject();  // A new menu is next
  197.    ++pagecnt;
  198.    print(crlf + "Page: " + str(pagecnt) + "  Date: " +
  199.          ltrim(substr(date(),1,8)) + crlf+crlf);
  200.    temp_strng ="Layout Report for ";
  201.    case Menu_Type of
  202.    case popup:temp_strng = temp_strng + "Popup Menu: ";
  203.    case bar:  temp_strng = temp_strng + "Horizontal Bar Menu: ";
  204.    case btch: temp_strng = ""; temp_strng = temp_strng +
  205.               "Multiple Action Summary for Batch Object: ";
  206.    endcase
  207.    temp_strng = temp_strng + upper(Menu_Name);
  208.    print(temp_strng+crlf);
  209.    print(replicate("-",len(temp_strng))+crlf);}
  210.  
  211. {  scrndump(); // a user defined function to print a object on the screen}
  212.  
  213. {  endofpage();}
  214. Setup for {upper(Menu_Name)} follows:
  215. {print(replicate("-", len(Menu_Name+" follows:") + 10)+crlf);}
  216.  
  217. {  lmarg(2);}
  218. {  if Menu_desc then}
  219. Description: {Menu_desc}
  220. {  endif}
  221. {  if Menu_Prmpt then}
  222. Message Line Prompt for Menu: {Menu_Prmpt}
  223. {  endif}
  224.  
  225. //
  226. // We use the inheritance paradigm for opening dbf/views.  If the dbf/view
  227. // does not change from one object to another or from action to action we don't
  228. // want to keep opening them.
  229. //
  230. {  if menu_ovride == 1 then}
  231. //   if there is data in menu_view and that data does not equal the global_view
  232. //   have dBASE open the new database.
  233. {    if Menu_View and Menu_View != global_View then endofpage();}
  234. Database/View: {Menu_View}
  235. {    endif}
  236. {    if Menu_NDX and Menu_NDX != global_NDX then endofpage();}
  237. Index File(s): {Menu_NDX}
  238. {    endif}
  239. {    if Menu_Order and Menu_Order != global_Ord then endofpage();}
  240. Index Order: {Menu_Order}
  241. {    endif}
  242.  
  243. {  endif}
  244. {  if menu_ovride == 2 then}
  245. Use database/view and index file(s) in effect at run time.
  246.  
  247. {  endif}
  248. {  lmarg(0);}
  249. {  endofpage();}
  250. Colors for Menu/Picklist:
  251. -------------------------
  252. {  endofpage();}
  253.  Color Settings:
  254.    Text           : {color(Clr_Text)}
  255.    Heading        : {color(Clr_Heading)}
  256.    Highlight      : {color(Clr_Hghlight)}
  257.    Box            : {color(Clr_Box)}
  258.    Messages       : {color(Clr_Messages)}
  259.    Information    : {color(Clr_Info)}
  260.    Fields         : {color(Clr_Fields)}
  261.  
  262. {  endofpage();
  263.   // See if menu_type is a Popup or Bar menu
  264.    if Menu_Type == popup or Menu_Type == bar then
  265.  
  266.      temp_strng = "Help Defined for Menu "+upper(Menu_Name)+":";
  267.      temp_strng2 = replicate("-",len(Menu_Name)+23);
  268.      // Call udf get_text to print Help for object
  269.      get_frame(@menu_help,temp_strng, temp_strng2);
  270.  
  271.      temp_strng = "Before Menu dBASE Code "+upper(Menu_Name)+":";
  272.      temp_strng2 = replicate("-",len(Menu_Name)+24);
  273.      get_frame(@menu_before,temp_strng, temp_strng2);
  274.  
  275.      temp_strng = "After Menu dBASE Code "+upper(Menu_Name)+":";
  276.      get_frame(@menu_after,temp_strng, temp_strng2);
  277.  
  278.      print(crlf);
  279.   endif
  280.  
  281.   lmarg(0); temp_strng = "";
  282.   if Menu_Type == popup or Menu_Type == bar then
  283.      temp_strng ="Bar actions for Menu " + upper(Menu_Name) + " follow:";
  284.   endif
  285.   if Menu_Type == f_pick or Menu_Type == s_pick or Menu_Type == v_pick then
  286.      // Below is a another way to do the previous lines test
  287.      // if at(alltrim(str(Menu_Type)),"345") then
  288.      temp_strng = "Picklist specification for " + upper(Menu_Name) + " follows:";
  289.   endif
  290.   if Menu_Type == btch then
  291.      temp_strng ="Batch actions for Menu "+upper(Menu_Name)+" follow:";
  292.   endif
  293.   if len(temp_strng) > 0 then
  294.      print(temp_strng + crlf);
  295.      print(replicate("-",len(temp_strng))+crlf);
  296.   endif
  297. }
  298. //
  299. {  if Menu_Type == f_pick then}
  300. Files Picklist
  301. --------------
  302.   File Specification: {upper(Pick_File)}
  303.  
  304. {  endif}
  305. {  if Menu_Type == s_pick then}
  306. Structure Picklist
  307. ------------------
  308.   Field Specification: {upper(Pick_Field)}
  309.  
  310. {  endif}
  311. {  if Menu_Type == v_pick then}
  312. Values Picklist
  313. ---------------
  314.   Field to List Values for: {upper(Pick_Value)}
  315.  
  316. {  endif}
  317. {  endofpage();}
  318. {
  319.    barcount = 1;
  320.    //-------------------------------------------------------------------------
  321.    // Loop through each bar in the menu - each bar is a field in the generator
  322.    //-------------------------------------------------------------------------
  323.    foreach Fld_Element flds in menu
  324.      lmarg(1);
  325.      if at(alltrim(str(Menu_Type)),"279") then // Popup, Bar or Batch Menu
  326.        if Menu_Type == btch then // Batch object
  327.          temp_strng ="Batch Action: " + alltrim(str(barcount))
  328.        else
  329.          // Bar or Popup object
  330.           temp_strng ="Bar: "+alltrim(str(barcount))
  331.        endif
  332.       print(temp_strng + crlf);
  333.      endif
  334.      lmarg(2);
  335. }
  336. {    endofpage();}
  337. Prompt: {ltrim(Fld_Pictur)}
  338. {    endofpage();}
  339. Action: \
  340. {    case Menu_Act of}
  341. {    case textno:}Text only defined for this option - NO ACTION
  342. {    case  open:}
  343. // Output type of menu/picklist to open
  344. Open a \
  345. {         case Open_Type of}
  346. {           case 0:}Bar Menu \
  347. {           case 1:}Popup Menu \
  348. {           case 2:}Files Picklist \
  349. {           case 3:}Sturcture Picklist \
  350. {           case 4:}Values Picklist \
  351. {         endcase}
  352. Named: {Open_Menu}
  353. {    case  brow: include "dd_brow.cod";
  354.      case  edit: include "dd_edit.cod";
  355.      case  rept: include "dd_rept.cod";
  356.      case  labl: include "dd_labl.cod";
  357.      case  disp: include "dd_list.cod";
  358.      case  appd: include "dd_apnd.cod";
  359.      case rcopy: include "dd_copy.cod";
  360.      case  repl: include "dd_repl.cod";
  361.      case  dele: include "dd_dele.cod";
  362.      case  reca: include "dd_recl.cod";
  363.      case  pack: include "dd_pack.cod";
  364.      case  indx:}New Index File {NDX_File}
  365.    Index Key:
  366.      {NDX_KEY} \
  367. {              if NDX_tag}TAG {NDX_tag} OF {NDX_tagIn}{endif} \
  368. {              if NDX_Unique then} UNIQUE{endif} \
  369. {              if NDX_Descnd}DESCENDING{endif}
  370. {    case  rndx:}Reindex Current DBF:
  371. {    case  sort:include "dd_sort.cod";
  372.      case  impt:include "dd_impt.cod";
  373.      case  expt:include "dd_expt.cod";
  374.      case fcopy:include "dd_fcopy.cod";
  375.      case  dodB:}
  376. Run dBASE Program: DO {PRG_File}\
  377. {      if PRG_Parms then}
  378.  WITH {PRG_Parms}
  379. {      else}
  380.  {// leave this space here}
  381. {      endif}
  382. {    case  indB:}
  383. Insert the following dBASE code:
  384. ----------------------------------------
  385.  
  386. {                db_inlin();}
  387. {    case  xdos:}
  388. Run Dos Program - {DOS_File}\
  389. {      if DOS_Parm then}
  390.  {DOS_Parm}
  391. {      else}
  392.  { //leave this space here}
  393. {      endif}
  394. {    case  Call:}
  395. Call Binary Program - {Bin_File}.bin\
  396. {      if Bin_Parms then}
  397.  WITH {Bin_Parms}
  398. {      else}
  399.  { //leave this space here}
  400. {      endif}
  401. {    case  retu:}Return to calling program
  402. {    case  quit:}Quit to DOS:
  403. {    case batch:}Call Batch Named: {fileroot(upper(Batch_Name))}
  404. {    case plmac:}Play Back a NPI macro {Macro_Name}
  405. {    endcase}
  406. {    endofpage();}
  407. {    if ItemSkipIf then}
  408. Bypass item on condition: {ItemSkipIf}
  409. {    endif
  410.  endofpage();
  411.  include "ds_tpost.cod"
  412.  include "ds_order.cod"
  413.  endofpage();
  414.  if Wndow_Name}
  415. Window {Wndow_Name} FROM {nul2zero(Wndow_X1)},{nul2zero(Wndow_Y1)} TO \
  416. {nul2zero(Wndow_X2)},{nul2zero(Wndow_Y2)} \
  417. { case Wndow_Bord of}{0:}Single{1:}Double{2:}Panel{3:}"{Wndow_Char}"{4:}None{endcase}
  418. {endif}
  419. {    if Item_Prmpt then}
  420. Message Line Prompt for Item: {Item_Prmpt}
  421. {    endif}
  422. //
  423. //   See if the user wants the Item view
  424. {    if item_ovride == 1 then}
  425. //     See if menu level and item level dbf/view are different
  426. {      if Item_View and Item_View != Menu_View then endofpage();}
  427. New Database/View: {Item_View}
  428. {      endif}
  429. {      if Item_NDX and Item_NDX != Menu_NDX then endofpage();}
  430. New Index File(s): {Item_NDX}
  431. {      endif}
  432. {      if Item_Order and Item_Order != Menu_Order then endofpage();}
  433. New Index Order: {Item_Order}
  434. {      endif}
  435. {    endif}
  436. {    if item_ovride == 2 then}
  437. Use database/view and index file(s) in effect at run time.
  438. {    endif}
  439. //------------------------------------------------------------------
  440. // Next four functions are user defined see ds_udf.cod
  441. //------------------------------------------------------------------
  442. {    endofpage();  // Check for end of page
  443.  
  444.      temp_strng = "Help text defined for this item:";
  445.      temp_strng2 = replicate("-",32);
  446.      get_item(@item_help,temp_strng, temp_strng2, flds);
  447.  
  448.      temp_strng = "Before dBASE Code for this item:";
  449.      get_item(@Item_Befor,temp_strng, temp_strng2, flds);
  450.  
  451.      temp_strng = "After dBASE Code for this item:";
  452.      get_item(@Item_After,temp_strng, temp_strng2, flds);
  453.  
  454.      lmarg(0);
  455.      print(replicate("-",80)+crlf+crlf);
  456.      barcount = barcount + 1;
  457.      endofpage();
  458.    next flds;    // end of foreach Fld_Element
  459.  next menu; // end of fortree loop
  460. }
  461.  
  462. End of Application Documentation
  463. {pause(gen_complete + any_key);
  464. // Jump label for no generation.
  465.  NoGen:
  466.  return 0;
  467. //
  468. // ------------------------------
  469. // User defined functions follow.
  470. // ------------------------------
  471. //
  472. include "ds_udf.cod";
  473. }
  474. // EOP DS_DOC.COD
  475.