bgui/CAD/cad_file.c

   1 /*
   2  * @(#) $Header$
   3  *
   4  * Change AutoDoc program
   5  * cad_file.c
   6  *
   7  * (C) Copyright 1998 Manuel Lemos.
   8  * (C) Copyright 1996-1997 Ian J. Einman.
   9  * (C) Copyright 1993-1996 Jaba Development.
  10  * (C) Copyright 1993-1996 Jan van den Baard.
  11  * All Rights Reserved.
  12  *
  13  * $Log$
  14  * Revision 42.0  2000/05/09 22:10:51  mlemos
  15  * Bumped to revision 42.0 before handing BGUI to AROS team
  16  *
  17  * Revision 41.11  2000/05/09 20:23:13  mlemos
  18  * Bumped to revision 41.11
  19  *
  20  * Revision 1.2  2000/05/09 19:55:37  mlemos
  21  * Merged with the branch Manuel_Lemos_fixes.
  22  *
  23  * Revision 1.1.2.5  1999/08/21 19:26:19  mlemos
  24  * Integrated Anton Rolls changes to fix the command line argument template
  25  * handling and XML format support.
  26  *
  27  * Revision 1.1.2.4  1999/05/31 02:52:47  mlemos
  28  * Integrated Anton Rolls changes to generate documentation files in
  29  * AmigaGuide and HTML formats.
  30  *
  31  * Revision 1.1.2.3  1998/11/28 14:43:45  mlemos
  32  * Changed LoadCadDesc() so that it was no longer inserting tildes (~) and
  33  * stripping whitespace from the files as they were loaded.
  34  *
  35  * Revision 1.1.2.2  1998/10/01 04:41:35  mlemos
  36  * Made the file handling functions work when the program main window is not
  37  * opened and return a success value.
  38  *
  39  * Revision 1.1.2.1  1998/09/19 01:50:16  mlemos
  40  * Ian sources.
  41  *
  42  *
  43  *
  44  */
  45
  46 #include "cad.h"
  47
  48 /*
  49  * Import data.
  50  */
  51 extern Object        *LV_List, *WD_Main, *ST_Base;
  52 extern struct Window    *MainWindow;
  53 extern UBYTE          FileName[ 256 ], BaseName[ 64 ], GenName[ 256 ];
  54 extern ULONG          NumDesc;
  55
  56 /*
  57  * Save the CAD file.
  58  */
  59 BOOL SaveCadFile(BOOL window_opened)
  60 {
  61    BPTR        file;
  62    CADHEADER      ch;
  63    CADDESC                 cd;
  64    CADNODE                *cn;
  65
  66    SetIoErr(0);
  67    if(window_opened)
  68    {
  69       /*
  70        * Lock the window.
  71        */
  72       WindowBusy( WD_Main );
  73    }
  74
  75    /*
  76     * Open the file.
  77     */
  78    if ( file = Open( FileName, MODE_NEWFILE )) {
  79       /*
  80        * Prepare header.
  81        */
  82       ch.ch_Ident = ID_CADF;
  83       ch.ch_Version  = CADF_VERSION;
  84       ch.ch_NumDesc  = NumDesc;
  85       strcpy( ( char * )&ch.ch_BaseName[ 0 ], BaseName );
  86
  87       /*
  88        * Write the header.
  89        */
  90       if ( Write( file, ( UBYTE * )&ch, sizeof( CADHEADER )) == sizeof( CADHEADER )) {
  91          /*
  92           * Now write the descriptions one by one.
  93           */
  94          cn = ( CADNODE * )FirstEntry( LV_List );
  95
  96          do {
  97             /*
  98              * Prepare CADDESC.
  99              */
 100             strcpy( &cd.cd_Name[ 0 ], &cn->cn_Name[ 0 ] );
 101             cd.cd_Length = cn->cn_DataLength;
 102
 103             /*
 104              * Write the CADDESC.
 105              */
 106             if ( Write( file, ( UBYTE * )&cd, sizeof( CADDESC )) == sizeof( CADDESC )) {
 107                /*
 108                 * And the corresponding data.
 109                 */
 110                if ( cn->cn_DataLength ) {
 111                   if ( Write( file, cn->cn_Data, cn->cn_DataLength ) != cn->cn_DataLength ) {
 112                      if(window_opened)
 113                         DosRequest( "OK", ISEQ_C "Error writing\n\n`%s'", FileName );
 114                      break;
 115                   }
 116                }
 117             } else {
 118                if(window_opened)
 119                   DosRequest( "OK", ISEQ_C "Error writing\n\n`%s'", FileName );
 120                break;
 121             }
 122          } while ( cn = ( CADNODE * )NextEntry( LV_List, cn ));
 123       } else {
 124          if(window_opened)
 125             DosRequest( "OK", ISEQ_C "Error writing\n\n`%s'", FileName );
 126       }
 127
 128       /*
 129        * Close the file.
 130        */
 131       Close( file );
 132       /*
 133        * Delete the file on error.
 134        */
 135       {
 136          LONG error;
 137
 138          if ((error=IoErr()))
 139          {
 140             DeleteFile( FileName );
 141             SetIoErr(error);
 142          }
 143       }
 144
 145    } else {
 146       if(window_opened)
 147          DosRequest( "OK", ISEQ_C "Unable to open\n\n`%s'", FileName );
 148    }
 149
 150    if(window_opened)
 151    {
 152       /*
 153        * Unlock the window.
 154        */
 155       WindowReady( WD_Main );
 156    }
 157    return((BOOL)(IoErr()==0));
 158 }
 159
 160 /*
 161  * Load a single CADDESC.
 162  */
 163 STATIC CADNODE *LoadCadDesc( BPTR file )
 164 {
 165    CADDESC                 cd;
 166    CADNODE                *cn;
 167    UBYTE                  *buffer;
 168
 169    /*
 170     * Read the CADDESC.
 171     */
 172    if ( Read( file, ( UBYTE * )&cd, sizeof( CADDESC )) == sizeof( CADDESC )) {
 173       /*
 174        * Allocate node.
 175        */
 176       if ( cn = ( CADNODE * )AllocVec( sizeof( CADNODE ), MEMF_CLEAR )) {
 177          /*
 178           * Setup node name.
 179           */
 180          strcpy(cn->cn_Name, cd.cd_Name);
 181
 182          /*
 183           * Allocate data.
 184           */
 185          if (cd.cd_Length)
 186          {
 187             if (buffer = (UBYTE *)AllocVec(cd.cd_Length + 1, MEMF_CLEAR))
 188             {
 189                if (Read(file, buffer, cd.cd_Length) == cd.cd_Length)
 190                {
 191                   cn->cn_DataLength = strlen(buffer);
 192                   cn->cn_Data       = AllocVec(cn->cn_DataLength, 0);
 193                   strncpy(cn->cn_Data, buffer, cn->cn_DataLength);
 194                   FreeVec(buffer);
 195                   return cn;
 196                }
 197                FreeVec(cn->cn_Data);
 198             } else
 199                SetIoErr(ERROR_NO_FREE_STORE);
 200          } else
 201             return(cn);
 202          FreeVec(cn);
 203       } else
 204          SetIoErr(ERROR_NO_FREE_STORE);
 205    }
 206    return( NULL );
 207 }
 208
 209 /*
 210  * Load a CADLIST file.
 211  */
 212 BOOL LoadCadFile(BOOL window_opened)
 213 {
 214    BPTR        file;
 215    CADHEADER      ch;
 216    CADNODE                *cn;
 217    BOOL        err = FALSE;
 218    ULONG       i;
 219
 220    if(window_opened)
 221    {
 222       /*
 223        * Lock the window.
 224        */
 225       WindowBusy( WD_Main );
 226    }
 227
 228    BaseName[ 0 ] = '\0';
 229    NumDesc       = 0;
 230    ClearList( NULL, LV_List );
 231
 232    /*
 233     * Open the file.
 234     */
 235    if ( file = Open( FileName, MODE_OLDFILE )) {
 236       /*
 237        * Load header.
 238        */
 239       if ( Read( file, ( UBYTE * )&ch, sizeof( CADHEADER )) == sizeof( CADHEADER )) {
 240          /*
 241           * Check identifier and version.
 242           */
 243          if ( ch.ch_Ident == ID_CADF ) {
 244             if ( ch.ch_Version <= CADF_VERSION ) {
 245                /*
 246                 * Copy the base name.
 247                 */
 248                strcpy( BaseName, &ch.ch_BaseName[ 0 ] );
 249
 250                /*
 251                 * Read all CADDESCs.
 252                 */
 253                for ( i = 0; i < ch.ch_NumDesc; i++ ) {
 254                   /*
 255                    * Read CADDESC.
 256                    */
 257                   if ( cn = LoadCadDesc( file )) {
 258                      /*
 259                       * Add it to the list.
 260                       */
 261                      AddEntry( NULL, LV_List, cn, LVAP_TAIL );
 262                      NumDesc++;
 263                   } else {
 264                      err = TRUE;
 265                      if(window_opened)
 266                         DosRequest( "OK", ISEQ_C "Error reading\n\n`%s'", FileName );
 267                      break;
 268                   }
 269                }
 270             } else {
 271                err = TRUE;
 272                MyRequest( "OK", ISEQ_C "Unknown file version." );
 273             }
 274          } else {
 275             err = TRUE;
 276             MyRequest( "OK", ISEQ_C "Unknown file type." );
 277          }
 278       } else {
 279          err = TRUE;
 280          if(window_opened)
 281             DosRequest( "OK", ISEQ_C "Error reading\n\n`%s'", FileName );
 282       }
 283       Close( file );
 284    } else {
 285       err = TRUE;
 286       if(window_opened)
 287          DosRequest( "OK", ISEQ_C "Unable to open\n\n`%s'", FileName );
 288    }
 289
 290    if ( err ) {
 291       /*
 292        * Errors clear all data.
 293        */
 294       BaseName[ 0 ] = '\0';
 295       NumDesc       = 0;
 296       ClearList( NULL, LV_List );
 297    }
 298
 299    /*
 300     * Setup GUI.
 301     */
 302    SetGadgetAttrs(( struct Gadget * )ST_Base, MainWindow, NULL, STRINGA_TextVal, BaseName, TAG_END );
 303    SetGadgetAttrs(( struct Gadget * )LV_List, MainWindow, NULL, LISTV_Select, LISTV_Select_First, TAG_END );
 304
 305    if(window_opened)
 306    {
 307             RefreshList( MainWindow, LV_List );
 308
 309       /*
 310        * Unlock the window.
 311        */
 312       WindowReady( WD_Main );
 313    }
 314    return((BOOL)!err);
 315 }
 316
 317 /*
 318  * Generate autodoc.
 319  */
 320 BOOL Generate(BOOL window_opened, ULONG outputFormat)
 321 {
 322   BOOL result;
 323
 324    if(window_opened)
 325    {
 326       /*
 327        * Lock the window.
 328        */
 329       WindowBusy( WD_Main );
 330    }
 331
 332   switch( outputFormat )
 333   {
 334     case MATCH_DOC:
 335       result = GenerateDoc(window_opened);
 336       break;
 337
 338     case MATCH_GUIDE:
 339       result = GenerateGuide(window_opened);
 340       break;
 341
 342     case MATCH_HTML:
 343       result = GenerateHTML(window_opened);
 344       break;
 345
 346     case MATCH_XML:
 347       result = GenerateXML(window_opened);
 348       break;
 349
 350     default:
 351       result = FALSE; /* unsupported output format */
 352   }
 353
 354    if(window_opened)
 355    {
 356       /*
 357        * Unlock the window.
 358        */
 359       WindowReady( WD_Main );
 360    }
 361
 362    return( result );
 363 }
 364
 365 BOOL GenerateDoc(BOOL window_opened)
 366 {
 367    CADNODE  *cn;
 368    BPTR     file;
 369
 370    /*
 371     * Open the output file.
 372     */
 373    if ( file = Open( GenName, MODE_NEWFILE )) {
 374       /* set secondary error code to 0 - Anton
 375          (Who cares if the file doesn't exist yet? need to check this, though)
 376        */
 377       SetIoErr(0);
 378
 379       /*
 380        * Write table of contents.
 381        */
 382       MyFPrintf( file, "TABLE OF CONTENTS\n\n" );
 383
 384       cn = ( CADNODE * )FirstEntry( LV_List );
 385       do {
 386          MyFPrintf( file, "%s/%s\n", BaseName, &cn->cn_Name[ 0 ] );
 387       } while ( cn = ( CADNODE * )NextEntry( LV_List, cn ));
 388
 389       FPutC( file, '\n' );
 390
 391       /*
 392        * Write entries...
 393        */
 394       cn = ( CADNODE * )FirstEntry( LV_List );
 395       do {
 396          /*
 397           * Header.
 398           */
 399          MyFPrintf( file, "%lc%s/%s\n\n", 12, BaseName, &cn->cn_Name[ 0 ] );
 400
 401          /*
 402           * Data.
 403           */
 404          FWrite( file, cn->cn_Data, cn->cn_DataLength, 1 );
 405
 406          /*
 407           * Add an empty line.
 408           */
 409          FPutC( file, '\n' );
 410
 411          /*
 412           * Break on an error.
 413           */
 414          if ( IoErr()) {
 415             if(window_opened)
 416                DosRequest( "OK", ISEQ_C "Error during generation of\n\n`%s'", GenName );
 417             break;
 418          }
 419       } while ( cn = ( CADNODE * )NextEntry( LV_List, cn ));
 420
 421       /*
 422        * Close the file.
 423        */
 424       Close( file );
 425       {
 426          LONG error;
 427          /*
 428           * Delete the file upon error.
 429           */
 430          if ((error=IoErr()))
 431          {
 432             DeleteFile( GenName );
 433             SetIoErr(error);
 434          }
 435       }
 436    }
 437
 438    return((BOOL)(IoErr()==0));
 439 }
 440
 441
 442 /*
 443  * Generate HTML autodoc. - Anton.
 444  */
 445 BOOL GenerateHTML(BOOL window_opened)
 446 {
 447    CADNODE *cn;
 448    BPTR   file;
 449
 450    /*
 451     * Open the output file.
 452     */
 453    if ( file = Open( GenName, MODE_NEWFILE )) {
 454       /* set secondary error code to 0
 455          (Who cares if the file doesn't exist yet? need to check this, though) - Anton
 456        */
 457       SetIoErr(0);
 458
 459       /* Write html header stuff - Anton */
 460       MyFPrintf( file, "<html>\n  <head><title>");
 461       MyFPrintf(file, BaseName); /* put BaseName into html document title */
 462       MyFPrintf( file, "</title>\n  </head>\n<body>\n");
 463
 464       /*
 465        * Write table of contents.
 466        */
 467       MyFPrintf( file, "TABLE OF CONTENTS<br>\n<br>\n" );
 468
 469       cn = ( CADNODE * )FirstEntry( LV_List );
 470       do {
 471         /* name the table of contents entry and link to the actual doc entry */
 472          MyFPrintf( file, "<a name=toc%s><a href=#%s>", cn->cn_Name, cn->cn_Name);
 473          MyFPrintf( file, "%s/%s</a></a><br>\n", BaseName, cn->cn_Name );
 474       } while ( cn = ( CADNODE * )NextEntry( LV_List, cn ));
 475
 476       /*
 477        * Write entries...
 478        */
 479       cn = ( CADNODE * )FirstEntry( LV_List );
 480       do {
 481          /* html stuff before the actual node data. */
 482          MyFPrintf( file, "<a name=%s>", cn->cn_Name); /* name the link target here - Anton */
 483          MyFPrintf( file, "\n<hr>\n" ); /* horizontal rule and newline - Anton */
 484            /* link back to the table of contents - Anton */
 485          MyFPrintf( file, "\n<br>\n<a href=#toc%s>top</a> ", cn->cn_Name );
 486          MyFPrintf( file, "%s/%s<br>\n", BaseName, cn->cn_Name );
 487          MyFPrintf( file, "<pre>\n" ); /* preformatted text tag - Anton.*/
 488
 489          /* Data. */
 490          FWrite( file, cn->cn_Data, cn->cn_DataLength, 1 );
 491
 492          /* to do: search through the data, find "SEE ALSO" and match anything after this
 493             with any node names. If they match, make a link to it.
 494           */
 495
 496          /* end preformatted text tag, end <a name> tag, newline and horizontal rule- Anton */
 497          MyFPrintf( file, "</pre>\n</a><br>\n" );
 498
 499          /* Break on an error. */
 500          if ( IoErr()) {
 501             if(window_opened)
 502                DosRequest( "Go away!", ISEQ_C "Error during generation of\n\n`%s'", GenName );
 503             break;
 504          }
 505       } while ( cn = ( CADNODE * )NextEntry( LV_List, cn ));
 506
 507       MyFPrintf( file, "\n<hr>\n" ); /* final horizontal rule and newline - Anton */
 508       MyFPrintf( file, "</body>\n</html>"); /* finish off the html stuff. - Anton */
 509
 510       /* Close the file. */
 511       Close( file );
 512       {
 513          LONG error;
 514          /*
 515           * Delete the file upon error.
 516           */
 517          if ((error=IoErr()))
 518          {
 519             DeleteFile( GenName );
 520             SetIoErr(error);
 521          }
 522       }
 523    }
 524
 525    return((BOOL)(IoErr()==0));
 526 }
 527
 528 /*
 529  * Generate XML autodoc. - Anton.
 530  *
 531  * This functin is incomplete.
 532  */
 533 BOOL GenerateXML(BOOL window_opened)
 534 {
 535    BPTR   file;
 536
 537    /*
 538     * Open the output file.
 539     */
 540    if ( file = Open( GenName, MODE_NEWFILE )) {
 541       /* set secondary error code to 0
 542          (Who cares if the file doesn't exist yet? need to check this, though)
 543        */
 544       SetIoErr(0);
 545
 546       /* Write xml header stuff */
 547       /* QUOTE is defined in cad.h */
 548       /* encoding: ascii is a subset of UTF-8 and does not need to be specified. */
 549       /* Manuel recommends ISO-8859-1 encoding so it recognizes 8-bit characters */
 550       MyFPrintf( file, "<?xml version='1.0' encoding=\"ISO-8859-1\"?>\n\n");
 551
 552       /* stuff goes here */
 553       MyFPrintf( file, "<!DOCTYPE test [\n");
 554       MyFPrintf( file, "<!ELEMENT test (#PCDATA) >\n");
 555       MyFPrintf( file, "<!ENTITY % xx '&#37;'>\n");  /* not used - example of entity */
 556       MyFPrintf( file, "<test>This format has yet to be implemented</test>\n");
 557       MyFPrintf( file, "]>\n");
 558
 559       MyFPrintf( file, "\n</xml>"); /* finish off the xml stuff. */
 560
 561       /* Close the file. */
 562       Close( file );
 563       {
 564          LONG error;
 565          /*
 566           * Delete the file upon error.
 567           */
 568          if ((error=IoErr()))
 569          {
 570             DeleteFile( GenName );
 571             SetIoErr(error);
 572          }
 573       }
 574    }
 575
 576    return((BOOL)(IoErr()==0));
 577 }
 578
 579 /*
 580  * Generate amigaguide. (just the same as text for now.) - Anton
 581  *
 582  * Currently cad node names with slashes are a problem.
 583  * (interpreted by amigaguide as directory.)
 584  * I've remapped slashes now, but double clicking on a link with a slash still won't work.
 585  * (not a big problem).
 586  *
 587  * Ok, this will be confusing, because there are CADNODEs and there are
 588  * amigaguide nodes in the resulting file. So read carefully and don't
 589  * be fooled.
 590  *
 591  */
 592 BOOL GenerateGuide(BOOL window_opened)
 593 {
 594    CADNODE *cn;
 595    BPTR   file;
 596    UBYTE tempNodeName[32]; /* This will be copied from the CADNODE and slashes replaced */
 597
 598    /*
 599     * Open the output file.
 600     */
 601    if ( file = Open( GenName, MODE_NEWFILE )) {
 602       /* set secondary error code to 0 - Anton
 603          (Who cares if the file doesn't exist yet? need to check this, though)
 604        */
 605       SetIoErr(0);
 606
 607       /* guide header stuff */
 608       /* @database      to identify this file as amigaguide
 609          @tab 2         to make tabs look reasonable - a global attribute
 610          @node main     to begin the main node (which contains the Table of Contents)
 611        */
 612       MyFPrintf( file, "@database\n@tab 2\n@node main "QUOTE"%s"QUOTE"\n", FilePart(GenName));
 613
 614       /* if( We-Want-A-SearchGuide-Button ) { */
 615       /* add a nice search button */
 616       MyFPrintf( file, "@{"QUOTE" Search "QUOTE" SYSTEM "QUOTE"RUN >nil: SearchGuide %s"QUOTE"}\n", FilePart(GenName));
 617
 618       /* } */
 619
 620       /*
 621        * Write table of contents.
 622        */
 623       MyFPrintf( file, "TABLE OF CONTENTS\n\n" );
 624
 625       cn = ( CADNODE * )FirstEntry( LV_List );
 626       do
 627       {
 628          MyFPrintf( file, "@{"QUOTE"%s/%s"QUOTE" LINK ", BaseName, cn->cn_Name); /* button text */
 629
 630          /* if the node name contains a slash then we are in trouble */
 631          MapSlash( cn->cn_Name, tempNodeName ); /* This should get us out of trouble */
 632          MyFPrintf( file, QUOTE"%s"QUOTE"}", tempNodeName); /* node name */
 633
 634          MyFPrintf( file, "\n"); /* newline */
 635       } while ( cn = ( CADNODE * )NextEntry( LV_List, cn ));
 636
 637       MyFPrintf( file, "@endnode\n" ); /* end of the main node */
 638
 639       /*
 640        * Write entries...
 641        */
 642       cn = ( CADNODE * )FirstEntry( LV_List );
 643       do {
 644          /*
 645           * Header.
 646           */
 647
 648          MyFPrintf( file, "\n@node "QUOTE ); /* begin quote */
 649
 650          /* if the node name contains a slash then we are in trouble */
 651          MapSlash( cn->cn_Name, tempNodeName ); /* This should get us out of trouble */
 652          MyFPrintf( file, "%s", tempNodeName ); /* node name */
 653
 654          MyFPrintf( file, QUOTE" "QUOTE ); /* end quote, begin quote */
 655          MyFPrintf( file, "%s/%s", BaseName, cn->cn_Name ); /* node title */
 656          MyFPrintf( file, QUOTE"\n\n" ); /* end quote, newline */
 657
 658          /*
 659           * Data.
 660           */
 661          FWrite( file, cn->cn_Data, cn->cn_DataLength, 1 );
 662
 663
 664          MyFPrintf( file, "@endnode\n" ); /* end node, new line */
 665          /* (there must be a linefeed after the last node) */
 666
 667          /*
 668           * Break on an error.
 669           */
 670          if ( IoErr()) {
 671             if(window_opened)
 672                DosRequest( "Go away!", ISEQ_C "Error during generation of\n\n`%s'", GenName );
 673             break;
 674          }
 675       } while ( cn = ( CADNODE * )NextEntry( LV_List, cn ));
 676
 677       /*
 678        * Close the file.
 679        */
 680       Close( file );
 681       {
 682          LONG error;
 683          /*
 684           * Delete the file upon error.
 685           */
 686          if ((error=IoErr()))
 687          {
 688             DeleteFile( GenName );
 689             SetIoErr(error);
 690          }
 691       }
 692    }
 693
 694    return((BOOL)(IoErr()==0));
 695 }
 696
 697 /*
 698   support function for GenerateGuide()
 699   Copy source string to destination string, replacing slashes '/' with 'S'
 700   and ':' with 'C'
 701 */
 702 UBYTE *MapSlash(UBYTE *source, UBYTE *destination)
 703 {
 704   int i=0;
 705   do
 706   {
 707     switch(source[i])
 708     {
 709       case '/':
 710         destination[i] = 'S';
 711         break;
 712
 713       case ':':
 714         destination[i] = 'C';
 715         break;
 716
 717       default:
 718         destination[i] = source[i];
 719     }
 720   }while(source[i++] != '\0');
 721
 722   return (destination);
 723 }
 724