ldc2: Cosmetic fixes and support for compiler orverride
[h316.git] / pc-tools / ldc2 / src / main.cpp
index 282ce9a6eff410624f1cea52da3158d074dc864e..8b7da8788adc4e0753701545b23467a48f19bcd1 100644 (file)
-/* ldc2 preliminary main program */
-
-#include <vector>
-#include <string>
-
-#include <stdio.h>
-#include <unistd.h>
+/******************************************************************************
+ * 
+ * LDC2 source code
+ *
+ * $Date: 2010/01/04 02:10:59 $
+ * $Author: hachti $
+ *
+ * $Log: main.cpp,v $
+ * Revision 2.6  2010/01/04 02:10:59  hachti
+ * *** empty log message ***
+ *
+ * Revision 2.5  2008-10-01 13:30:14  hachti
+ * Added some includes
+ *
+ * Revision 2.4  2008-08-25 21:02:24  hachti
+ * *** empty log message ***
+ *
+ * Revision 2.3  2007-05-30 02:51:16  hachti
+ * Changed everything towards LDC2 use.
+ * Worked on the buildlib.sh.
+ * Centralized  buildlib.sh to a new lib/common directory.
+ *
+ * Revision 2.2  2007-03-26 03:20:31  hachti
+ * *** empty log message ***
+ *
+ * Revision 2.1  2007-03-26 01:15:21  hachti
+ * *** empty log message ***
+ *
+ * Revision 2.0  2007-03-26 01:00:40  hachti
+ * *** empty log message ***
+ *
+ *
+ ******************************************************************************/
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <fcntl.h>
+#include <unistd.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+
+#include <vector>
+#include <string>
+  
+#include "config.hh"
+#include "tool.hh"
 
 #include "tape_block.hh"
-#include "configuration_manager.hh"
+#include "data_block_0.hh"
 
 using namespace std;
 
-int dump_vector(vector<string> arguments){
-  int res=0;
-  for (vector<string>::iterator iter=arguments.begin();iter<arguments.end();iter++){
-    printf("%s\n",(*iter).c_str());
-    res=1;
+#ifndef BUILD_STAMP
+#define BUILD_STAMP ""
+#endif
+
+#ifndef VERSION
+#define VERSION "0.0"
+#endif
+
+#define ID_STRING "\n     ldc2 - The X16 object tape analyser\n\
+            (C) 2007 Philipp Hachtmann\n\n\
+     Version %s, built %s\n     %s\n\n"
+
+/******************************************************************************/
+
+static FILE * stdwarn;       //! Suppressable warning output file pointer.
+static vector<tape_block*> tape;     //! The whole tape contents.
+static vector<vector<tape_block*> > objects; //! Tape content in objects.
+
+static int errors  = 0;  //! Global error counter.
+static int warnings= 0;  //! Global warning counter.
+static int errcode = 0;  //! Error code for error exit routine.
+
+
+/******************************************************************************/
+/*!
+ *\brief Error exit routine.
+ *
+ * This routine tests the global error counter and terminates the program
+ * if necessary.
+ */
+void exit_on_error(){
+  if (errors){
+    fprintf(stderr,"Failed. (%i)\n",errcode);
+    exit(errcode);
   }
-  return res;
 }
 
+  
+/******************************************************************************/
+/*!
+ *\brief Read in Tape data and do some checks and messages.
+ *
+ * This routine reads in the tape data.
+ * During reading in, checksums are checked and
+ * /da001/ information is generated. No object integrity test.
+ * Tape block object pointers are put into the global vector 
+ * tape.
+ */
+void read_tape(){
 
-int main(int argc, char ** args){
+  tape_block * block=0;  //! Pointer to current block.
+  bool read_ahead=true;  //! Continue scanning for blocks.
+  int read_pointer=0;    //! Read position in input.
+  int block_start=0;     //! Start of block position in input.
+  int block_end=0;       //! End of block position in input.
+  int blocks_read=0;     //! Number of blocks read in.
   
-  /* Configuration data */
-  string config_file;
-  string infile, outfile;
-  int infile_set, outfile_set, config_file_set;
+  bool spaced=false;     //! Help flag for spaced messages. 
   
-  int 
-    do_help,
-    output_info,
-    output_called,
-    output_exported,
-    output_unsatisfied,
-    split_objects,
-    split_objects_numbered,
-    ignore_block_errors,
-    ignore_checksum_errors,
-    pause_on_checksum_error,
-    ignore_unknown_block_errors,
-    ignore_object_integrity_errors;
+  string message;        //! A warning or help message.
+
   
-  int in_fd, out_fd;
+  while(read_ahead){
 
-  in_fd=0;  /* stdin   {O _ \ */
-  out_fd=1; /* stdout  {O ^ / */
+         //  bool err_checksum=false;  //! Checksum error flag.
+         //    bool err_integrity=false; //! Integrity error flag.
+    
+    bool warning=false;       //! Warning flag.
+    bool error=false;         //! Error flag.
+    
+    // Try to generate block
+    try{
+      block=tape_block::gen_from_fd(in_fd);
+    }
+    
+    catch(tape_block::eof_legal_exception &e){
+      read_pointer+=e.get_consumed();
+      break; // Immediately leave read loop.
+    }
+    
+    catch(tape_block::io_error_exception){
+      if (in_fd){
+       fprintf(stderr,"Error: Could not read from \"%s\"!\n",
+               cfg_infile.c_str());
+      } else {
+       fprintf(stderr,"Error: Could not read from stdin!\n");
+      }
+      error=true;
+      errcode=2;
+      break; // Immediately leave read loop.
+    }
+    
+    catch(tape_block::eof_illegal_exception &e){
+      block=e.get_block();
+      //      err_integrity=true;
+      read_ahead=false;
+      if (cfg_ignore_block_errors){
+       message="Warning: Block integrity check failed!\n";
+       warning=true;
+      } else {
+       message="Error: Block integrity check failed!\n";
+       error=true;
+       errcode=3;
+      }
+    }
+    
+    catch(tape_block::checksum_error_exception &e){
+      block=e.get_block();
+      //      err_checksum=true;
+      if (cfg_ignore_checksum_errors){
+       message="Warning: Block checksum wrong!\n";
+       warning=true;
+      } else {
+       message="Error: Block checksum wrong!\n";
+       error=true;
+       read_ahead=false;
+       errcode=4;
+      }
+    }
+    
+    // Now let's check for block type
+    if ((!error)&&(!warning)&&!block->has_known_type()){
+      if (cfg_ignore_unknown_block_errors){
+       message="Warning: Unknown Block type!";
+       warning=true;
+      }else{
+       message="Error: Unknown Block type!";
+       error=true;
+       read_ahead=false;
+       errcode=5;
+      }
+    }
+    
+    // Count block.
+    blocks_read++;
+    tape.insert(tape.end(),block);
+    block_start=read_pointer+block->get_discarded_bytes();
+    block_end=block_start+block->get_raw_size()-1;
+    read_pointer=block_end+1;
 
-  configuration_manager ar("ldc2");
-  
-  /* Here come the configuration switches */
-  ar.add_option_switch("h","help",
-                      "Output this help text and exit.",
-                      &do_help,true,false);
-
-  ar.add_option_switch("a","output_info",
-                      "Print tape data information (default)",
-                      &output_info);
-
-  ar.add_option_switch("c","output_called",
-                      "Print all called symbols from the object(s).",
-                      &output_called);
-
-  ar.add_option_switch("e","output_exported",
-                      "Print all exported symbols from the object(s).",
-                      &output_exported);
-
-  ar.add_option_switch("u","output_unsatisfied",
-                      "List all unsatisfied symbols.",
-                      &output_unsatisfied);
-
-  ar.add_option_switch("s","split_objects",
-                      "Split input data into distinct object files.",
-                      &split_objects);
-
-  ar.add_option_switch("S","split_objects_numbered",
-                      "Split input data into distinct numbered files",
-                      &split_objects_numbered);
-
-  ar.add_option_switch("b","ignore_block_errors",
-                      "Ignore block integrity errors. This will output broken blocks,too",
-                      &ignore_block_errors);
-
-  ar.add_option_switch("k","ignore_checksum_errors",
-                      "Ignore block checksum errors. Errors will be converted to warnings.",
-                      &ignore_checksum_errors);
-
-  ar.add_option_switch("p","pause_on_checksum_error",
-                      "Wait for user input on checksum error.",
-                      &pause_on_checksum_error);
-  
-  ar.add_option_switch("n","ignore_unknown_block_errors",
-                      "Ignore errors caused by unknown block types. Errors will be converted to warnings.",
-                      &ignore_unknown_block_errors);
-
-  ar.add_option_switch("g","ignore_object_integrity_errors",
-                      "Ignore errors caused by objects without proper end block. \
-Errors will be converted to warnings.",
-                      &ignore_object_integrity_errors);
-  
-  ar.add_option_value("i","input_file",
-                     "specify input file",
-                 &infile_set,&infile,
-                 "<input-file>");
-                     
-  ar.add_option_value("o","output_file",
-                     "Specify output file.",
-                     &outfile_set,&outfile,
-                     "<output_file>");
-                     
-
-  ar.add_argument("File from where data is read",
-                 &infile_set,&infile,
-                 "<input-file>");
-
-  ar.add_argument("File to where output is redirected",
-                 &outfile_set,&outfile,
-                 "<output-file>");
-
-  ar.add_option_value("F","config_file",
-                     "Use the specified configuration file.", 
-                     &config_file_set,&config_file,
-                     "<file-name>");
+    FILE * fp=stdwarn;
+    if (error) fp=stderr;
+         
+    if (cfg_verbose||error||warning){
+      if (!spaced) fprintf(fp,"\n");
+      spaced=false;
+      fprintf(fp,"Block No.%03i:  Start:0x%04x  End:0x%04x  Size:0x%02x\n",
+             blocks_read-1,
+             block_start,
+             block_end,
+             block->get_raw_size());
+    }
+    
+    if (error)   fprintf(stderr,message.c_str());
+    if (warning) fprintf(stdwarn,message.c_str());
+        
+    if(error||warning){
+      dump_vector(block->get_description());
+    } else {
+      if(cfg_list_contents){
+       FILE * tmp_fp=fdopen(out_fd,"w");
+       dump_vector_fp(block->get_description(),tmp_fp);
+       if (!error&&!warning) spaced=false;
+      }
+    }
+
+    if (error||warning||cfg_verbose){
+      fprintf(fp,"\n");
+      spaced=true;
+    }
+    if (error) errors++;
+    if (warning) warnings++;
+  } // while....
+  if (cfg_verbose){
+    close(in_fd);
+    fprintf(stderr,"Reading finished.\n");
+    fprintf(stderr,"Bytes read:%i, Blocks read:%i\n",read_pointer,blocks_read);
+    }
+} // read_tape()
+
+
+/******************************************************************************/
+/*!
+ *\brief Do integrity test and object or block dumps.
+ */
+void process_tape(){
+  if (cfg_verbose) fprintf(stdwarn,"\nProcessing Data.\n");
   
-  // Process command line first time
-  if((dump_vector(ar.read_args(argc,args))||do_help)){
-    dump_vector(ar.get_help());
-    exit(1);
-  }
+  bool in_object=false;
+  char filename[100];
+  char filename_numbered[100];
+  string objname;
+  int unknown_count=-1;
+  int fd=-1, fd_numbered=-1;
+  int obj_no=0;
+  int obj_start_block;
   
-  // If user has a config file, use it.
-  if (config_file_set){
-    if(dump_vector(ar.read_file(config_file))){
-      dump_vector(ar.get_help());
-      exit(1);
+  for (unsigned int i=0; i<tape.size();i++){
+    tape_block * block=tape[i];
+
+      if (block->get_type()==tape_block::TBT_EOT){
+       objname="EOT";
+       if (in_object){
+         if (cfg_ignore_object_integrity_errors){
+           fprintf(stdwarn,"Warning: Object integrity error!\
+ (Object no %i, Block %i unexpected)\n",obj_no,i);
+           warnings++;
+         } else {
+           fprintf(stderr,"Error: Object integrity error!\
+ (Object no %i, Block %i unexpected)\n",obj_no,i);
+           errors++;
+           errcode=6;
+           return;
+         }
+       }
+      }
+    if (!in_object){ // object begin
+      
+      obj_no++;
+      obj_start_block=i;
+      
+      objname="UNKNOWN";
+      unknown_count++;
+      
+      vector<string>names=block->get_exported_symbols();
+      for (unsigned int a=0; a<names.size();a++){
+       objname=names[0];
+       if (objname!="      "){
+         objname=objname.substr(0,objname.find_last_not_of(" ")+1);
+         unknown_count--;
+         break;
+       }
+      }
+           
+      if (block->get_type()==tape_block::TBT_EOT){
+       objname="EOT";
+      }
+      
+      // Open file for split objects
+      if (cfg_split_objects && (block->get_type()!=tape_block::TBT_EOT)){
+       if (objname=="UNKNOWN")snprintf(filename,99,"UNKNOWN%02i",
+                                       unknown_count);
+       else snprintf(filename,99,"%s",objname.c_str());
+       if (fd>-1) close (fd);
+       if (cfg_verbose) fprintf(stdwarn,"Writing file: %s\n",filename);
+       fd=open(filename,O_WRONLY|O_CREAT|O_TRUNC,0666);
+       if (fd<0){
+         fprintf(stderr,"Error: could not open file \"%s\" for writing!\n",
+                 filename);
+         errors++;
+         errcode=1;
+         return;
+       }
+      }
+
+      // Open file for split objects numbered
+      snprintf(filename_numbered,99,"%03i0-%s",obj_no,objname.c_str());
+      if (cfg_split_objects_numbered){
+       close (fd_numbered);
+       if (cfg_verbose) fprintf(stdwarn,"Writing file: %s\n",filename_numbered);
+       fd_numbered=open(filename_numbered,O_WRONLY|O_CREAT|O_TRUNC,0666);
+       if (fd_numbered<0){
+         fprintf(stderr,"Error: could not open file \"%s\" for writing!\n",
+                 filename_numbered);
+         errors++;
+         errcode=1;
+         return;
+       }
+      }
+      in_object=true;
+    } // object begin
+    
+    // Output block data
+    if (cfg_split_objects){
+      try{
+       if (block->get_type()!=tape_block::TBT_EOT) // Don't want EOT here
+         block->dump_to_fd(fd);
+      }
+      catch (tape_block::io_error_exception e){
+       fprintf(stderr,"Error: could write to file \"%s\"!\n",
+               filename);
+       errors++;
+       errcode=1;
+       return;
+      }
+    } // if (cfg_split_objects)
+
+    // Output block data
+    if (cfg_split_objects_numbered){
+      try{
+       block->dump_to_fd(fd_numbered);
+      }
+      catch (tape_block::io_error_exception e){
+       fprintf(stderr,"Error: could write to file \"%s\"!\n",
+               filename_numbered);
+         errors++;
+         errcode=1;
+         return;
+      }
+    } // if (cfg_split_objects_numbered)
+
+    // Output individual block file if desired
+    if (cfg_split_blocks){
+      char fname[100];
+      snprintf(fname,99,"%03i0-%s-%03i.block",obj_no,objname.c_str(),
+              i-obj_start_block);
+      if (cfg_verbose) fprintf(stdwarn,"Writing file: %s\n",fname);
+      int fd_block=open(fname,O_WRONLY|O_TRUNC|O_CREAT,0666);
+      if (fd_block<0){
+         fprintf(stderr,"Error: could not open file \"%s\" for writing!\n",
+                 fname);
+         errors++;
+         errcode=1;
+         close(fd);
+         close(fd_numbered);
+         return;
+      }
+      try{
+       block->dump_to_fd(fd_block);
+      }
+      catch (tape_block::io_error_exception e){
+       fprintf(stderr,"Error: could write to file \"%s\"!\n",
+               fname);
+       errors++;
+       errcode=1;
+       close(fd);
+       close(fd_numbered);
+       return;
+      }
+      close(fd_block);
+    }
+    
+    if (block->is_endblock()||(block->get_type()==tape_block::TBT_EOT)) {
+      in_object=false; 
+      close(fd);
+      close(fd_numbered);
     }
-    // Process command line a second time to override values from config file.
-    if(dump_vector(ar.read_args(argc,args))||do_help){
-      dump_vector(ar.get_help());
-      exit(1);
+  } // for (...)
+  
+  if (in_object){
+    if (cfg_ignore_object_integrity_errors){
+      fprintf(stdwarn,"Warning: Object integrity error! Last object incomplete!\n");
+      warnings++;
+    } else {
+      fprintf(stdwarn,"Error: Object integrity error! Last Object incomplete!\n");
+      errors++;
+      errcode=6;
+      if (fd!=-1) close(fd);
+      if (fd_numbered!=-1) close(fd_numbered);
+      return;
     }
   }
+} // process_tape()
+
+/******************************************************************************/
+/*!
+ *\brief Everything that has to do with symbol listing.
+ */
+void process_symbols(){
+  vector<string>exported;
+  vector<string>called;
+  vector <string>unsatisfied;
 
+  if (cfg_verbose) fprintf(stdwarn,"\nProcessing Symbols.\n");  
 
+  for (unsigned int i=0; i<tape.size();i++){
+    merge_vector_unique(exported,tape[i]->get_exported_symbols());
+    merge_vector_unique(called,tape[i]->get_called_symbols());
+  }
   
-  if (infile_set==1){
-    printf("Opening file for input:%s\n",infile.c_str());
-    in_fd=open(infile.c_str(),O_RDONLY);
-    if (in_fd<0){
-      printf("Error: could not open file:%s\n",infile.c_str());
-      exit (3);
+  for (unsigned int icalled=0;icalled<called.size();icalled++){
+    bool found=false;
+    for (unsigned int iexported=0;iexported<exported.size();iexported++){
+      if (exported[iexported].compare(called[icalled])==0){
+       found=true;
+       break;
+      }
+    }
+    if (!found) {
+      bool present=false;
+      for (unsigned int i=0;i<unsatisfied.size();i++){
+       if (unsatisfied[i].compare(called[icalled])==0){
+         present=true;
+         break;
+       }
+      }
+      if (!present) unsatisfied.insert(unsatisfied.end(),called[icalled]);
     }
   }
   
+  FILE * outp=fdopen(out_fd,"w");
+
+  if (cfg_output_called){
+    dump_vector_fp(called,outp);
+  }
+
+  if (cfg_output_exported){
+    dump_vector_fp(exported,outp);
+  }
+
+  if (cfg_output_unsatisfied){
+    dump_vector_fp(unsatisfied,outp);
+  }
+
+} // process_symbols()
+
+/******************************************************************************/
+/*!
+ *\brief The main routine.
+ *
+ */
+int main(int argc, char ** args){
+
+  // Do all the configuration stuff
+  do_config(argc,args);
+
+  // Output a version message if desired
+  if (cfg_version){
+    fprintf(stderr, ID_STRING, VERSION, BUILD_DATE, BUILD_STAMP);
+    exit(0);
+  }
   
+  // Assign warning output according to configuration
+  if (cfg_quiet) stdwarn=fopen("/dev/null","w");
+  else stdwarn=stderr;
   
+  read_tape(); // Process input to completion.
+  exit_on_error();
   
-  vector<tape_block*> tape;
-  
-  
-  tape_block * block=0;
-  while(1){
-    block=tape_block::gen_from_fd(in_fd);
-    if (block->get_state()==tape_block::TBS_OK){
-      tape.insert(tape.end(),block);
-      dump_vector(block->get_description());
-    }
-    else break;
-  }
+  process_tape();
+  exit_on_error();
 
-  switch(block->get_state()){
-  case tape_block::TBS_EOF_LEGAL: printf("File successfully read.\n");
-    break;
-  case tape_block::TBS_EOF_ILLEGAL: printf("EOF while in block!\n");
-    break;
-  case tape_block::TBS_CHECKSUM:
-    printf("Checksum error!\n");
-    break;
-  case tape_block::TBS_DEFAULT:
-    printf("TBS_DEFAULT encountered ->> SEVERY INTERNAL ERROR!\n");
-    exit(88);
-  case tape_block::TBS_IOERR:
-    printf("I/O Error... Why?\n");
-    exit (43);
+  process_symbols();
+  exit_on_error();
+    
+  if (warnings>0){
+    fprintf(stdwarn,"Warnings:%i\n",warnings);
+    return 99;
   }
-
+  if (cfg_verbose) fprintf(stdwarn,"\nSuccess.\n");
   return 0;
+
+  /*
+   * All over this program, no memory is freed. This is not necessary because
+   * everything is allocated once and that's it.
+   * The classes support proper freeing of their internal buffers.
+   */
+
 } // main()
 
+/******************************************************************************/