Changeset 2655


Ignore:
Timestamp:
04/23/07 12:25:31 (13 years ago)
Author:
curtis
Message:

Merge FormatReader and FormatWriter debug logic into FormatHandler.

Location:
trunk/loci/formats
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • trunk/loci/formats/ClassList.java

    r2551 r2655  
    8686      try { c = Class.forName(line); } 
    8787      catch (ClassNotFoundException exc) { 
    88         if (FormatReader.debug) exc.printStackTrace(); 
     88        if (FormatHandler.debug) exc.printStackTrace(); 
    8989      } 
    9090      catch (NoClassDefFoundError err) { 
    91         if (FormatReader.debug) err.printStackTrace(); 
     91        if (FormatHandler.debug) err.printStackTrace(); 
    9292      } 
    9393      catch (ExceptionInInitializerError err) { 
    94         if (FormatReader.debug) err.printStackTrace(); 
     94        if (FormatHandler.debug) err.printStackTrace(); 
    9595      } 
    9696      if (c == null || (base != null && !base.isAssignableFrom(c))) { 
  • trunk/loci/formats/FileStitcher.java

    r2648 r2655  
    625625  /** Initializes the given file. */ 
    626626  protected void initFile(String id) throws FormatException, IOException { 
    627     if (FormatReader.debug) { 
     627    if (FormatHandler.debug) { 
    628628      System.out.println("calling FileStitcher.initFile(" + id + ")"); 
    629629    } 
  • trunk/loci/formats/FormatHandler.java

    r2538 r2655  
    2929/** Abstract superclass of all biological file format readers and writers. */ 
    3030public abstract class FormatHandler implements IFormatHandler { 
     31 
     32  // -- Static fields -- 
     33 
     34  /** Debugging flag. */ 
     35  public static boolean debug = false; 
     36 
     37  /** Debugging level. 1=basic, 2=extended, 3=everything, 4=insane. */ 
     38  public static int debugLevel = 1; 
    3139 
    3240  // -- Fields -- 
     
    7381    StatusListener[] l = getStatusListeners(); 
    7482    for (int i=0; i<l.length; i++) l[i].statusUpdated(e); 
     83  } 
     84 
     85  /** Issues a debugging statement. */ 
     86  protected void debug(String s) { 
     87    // NB: could use a logger class or other means of output here, if desired 
     88    String name = getClass().getName(); 
     89    String prefix = "loci.formats."; 
     90    if (name.startsWith(prefix)) { 
     91      name = name.substring(name.lastIndexOf(".") + 1); 
     92    } 
     93    String msg = System.currentTimeMillis() + ": " + name + ": " + s; 
     94    if (debugLevel > 3) trace(msg); 
     95    else System.out.println(msg); 
     96  } 
     97 
     98  /** Issues a stack trace. */ 
     99  protected void trace(String s) { 
     100    new Exception(s).printStackTrace(); 
    75101  } 
    76102 
     
    131157  } 
    132158 
     159  // -- Utility methods -- 
     160 
     161  /** Toggles debug mode (more verbose output and error messages). */ 
     162  public static void setDebug(boolean debug) { 
     163    FormatHandler.debug = debug; 
     164  } 
     165 
     166  /** 
     167   * Toggles debug mode verbosity (which kinds of output are produced). 
     168   * @param debugLevel 1=basic, 2=extended, 3=everything. 
     169   */ 
     170  public static void setDebugLevel(int debugLevel) { 
     171    FormatHandler.debugLevel = debugLevel; 
     172  } 
     173 
    133174} 
  • trunk/loci/formats/FormatReader.java

    r2648 r2655  
    3939  /** Default thumbnail width and height. */ 
    4040  protected static final int THUMBNAIL_DIMENSION = 128; 
    41  
    42   // -- Static fields -- 
    43  
    44   /** Debugging flag. */ 
    45   public static boolean debug = false; 
    46  
    47   /** Debugging level. 1=basic, 2=extended, 3=everything, 4=insane. */ 
    48   public static int debugLevel = 1; 
    4941 
    5042  // -- Fields -- 
     
    188180  } 
    189181 
    190   /** Issues a debugging statement. */ 
    191   protected void debug(String s) { 
    192     // NB: could use a logger class or other means of output here, if desired 
    193     String name = getClass().getName(); 
    194     String prefix = "loci.formats.in."; 
    195     if (name.startsWith(prefix)) name = name.substring(prefix.length()); 
    196     String msg = System.currentTimeMillis() + ": " + name + ": " + s; 
    197     if (debugLevel > 3) trace(msg); 
    198     else System.out.println(msg); 
    199   } 
    200  
    201   /** Issues a stack trace. */ 
    202   protected void trace(String s) { 
    203     new Exception(s).printStackTrace(); 
    204   } 
    205  
    206182  // -- IFormatReader API methods -- 
    207183 
     
    499475  } 
    500476 
    501   // -- Utility methods -- 
    502  
    503   /** Toggles debug mode (more verbose output and error messages). */ 
    504   public static void setDebug(boolean debug) { 
    505     FormatReader.debug = debug; 
    506   } 
    507  
    508   /** 
    509    * Toggles debug mode verbosity (which kinds of output are produced). 
    510    * @param debugLevel 1=basic, 2=extended, 3=everything. 
    511    */ 
    512   public static void setDebugLevel(int debugLevel) { 
    513     FormatReader.debugLevel = debugLevel; 
    514   } 
    515  
    516477  // -- Deprecated IFormatReader API methods -- 
    517478 
  • trunk/loci/formats/FormatTools.java

    r2606 r2655  
    141141          else if (args[i].equals("-normalize")) normalize = true; 
    142142          else if (args[i].equals("-fast")) fastBlit = true; 
    143           else if (args[i].equals("-debug")) FormatReader.setDebug(true); 
     143          else if (args[i].equals("-debug")) FormatHandler.setDebug(true); 
    144144          else if (args[i].equals("-level")) { 
    145145            try { 
    146               FormatReader.setDebugLevel(Integer.parseInt(args[++i])); 
     146              FormatHandler.setDebugLevel(Integer.parseInt(args[++i])); 
    147147            } 
    148148            catch (NumberFormatException exc) { } 
     
    170170      } 
    171171    } 
    172     if (FormatReader.debug) { 
    173       System.out.println("Debugging at level " + FormatReader.debugLevel); 
     172    if (FormatHandler.debug) { 
     173      System.out.println("Debugging at level " + FormatHandler.debugLevel); 
    174174    } 
    175175    if (id == null) { 
  • trunk/loci/formats/FormatWriter.java

    r2587 r2655  
    3333  implements IFormatWriter 
    3434{ 
    35  
    36   // -- Constants -- 
    37  
    38   /** Debugging flag. */ 
    39   public static boolean debug = false; 
    40  
    41   /** Debugging level. 1=basic, 2=extended, 3=everything, 4=insane. */ 
    42   public static int debugLevel = 1; 
    4335 
    4436  // -- Fields -- 
  • trunk/loci/formats/reader-guide.txt

    r2626 r2655  
    112112  RLE (PackBits). 
    113113 
    114 - Debugging statements can be added using FormatReader.debug(String). 
     114- Debugging statements can be added using FormatHandler.debug(String). 
    115115 
    116116- If you wish to convert a file's metadata to OME-XML (strongly encouraged), 
  • trunk/loci/formats/test/ReaderTest.java

    r2642 r2655  
    149149    } 
    150150    catch (Exception e) { 
    151       if (FormatReader.debug) e.printStackTrace(); 
     151      if (FormatHandler.debug) e.printStackTrace(); 
    152152      success = false; 
    153153    } 
     
    196196    } 
    197197    catch (Exception e) { 
    198       if (FormatReader.debug) e.printStackTrace(); 
     198      if (FormatHandler.debug) e.printStackTrace(); 
    199199      success = false; 
    200200    } 
     
    238238    } 
    239239    catch (Exception e) { 
    240       if (FormatReader.debug) e.printStackTrace(); 
     240      if (FormatHandler.debug) e.printStackTrace(); 
    241241      success = false; 
    242242    } 
     
    274274    } 
    275275    catch (Exception e) { 
    276       if (FormatReader.debug) e.printStackTrace(); 
     276      if (FormatHandler.debug) e.printStackTrace(); 
    277277      success = false; 
    278278    } 
     
    302302    } 
    303303    catch (Exception e) { 
    304       if (FormatReader.debug) e.printStackTrace(); 
     304      if (FormatHandler.debug) e.printStackTrace(); 
    305305      success = false; 
    306306    } 
     
    362362    } 
    363363    catch (Exception e) { 
    364       if (FormatReader.debug) e.printStackTrace(); 
     364      if (FormatHandler.debug) e.printStackTrace(); 
    365365      success = false; 
    366366    } 
     
    383383    catch (Exception e) { 
    384384      writeLog(id + " failed consistent metadata test"); 
    385       if (FormatReader.debug) e.printStackTrace(); 
     385      if (FormatHandler.debug) e.printStackTrace(); 
    386386      assertTrue(false); 
    387387    } 
     
    440440      } 
    441441      catch (Exception e) { 
    442         if (FormatReader.debug) e.printStackTrace(); 
     442        if (FormatHandler.debug) e.printStackTrace(); 
    443443 
    444444        configLine = new StringBuffer(); 
     
    454454        } 
    455455        catch (IOException exc) { 
    456           if (FormatReader.debug) exc.printStackTrace(); 
     456          if (FormatHandler.debug) exc.printStackTrace(); 
    457457          success = false; 
    458458        } 
     
    469469      } 
    470470      catch (Exception e) { 
    471         if (FormatReader.debug) e.printStackTrace(); 
     471        if (FormatHandler.debug) e.printStackTrace(); 
    472472        success = false; 
    473473      } 
     
    534534        } 
    535535        catch (Exception e) { 
    536           if (FormatReader.debug) e.printStackTrace(); 
     536          if (FormatHandler.debug) e.printStackTrace(); 
    537537          success = false; 
    538538        } 
     
    603603    } 
    604604    catch (Exception e) { 
    605       if (FormatReader.debug) e.printStackTrace(); 
     605      if (FormatHandler.debug) e.printStackTrace(); 
    606606      writeLog(id + " failed sane used files test"); 
    607607    } 
     
    644644    } 
    645645    catch (FormatException fe) { 
    646       if (FormatReader.debug) fe.printStackTrace(); 
     646      if (FormatHandler.debug) fe.printStackTrace(); 
    647647    } 
    648648    catch (IOException io) { 
    649       if (FormatReader.debug) io.printStackTrace(); 
     649      if (FormatHandler.debug) io.printStackTrace(); 
    650650    } 
    651651  } 
     
    695695      } 
    696696      catch (IOException e) { 
    697         if (FormatReader.debug) e.printStackTrace(); 
     697        if (FormatHandler.debug) e.printStackTrace(); 
    698698      } 
    699699    } 
     
    725725    Vector similarFiles = new Vector(); 
    726726    for (int i=0; i<subs.length; i++) { 
    727       if (FormatReader.debug) debug("Checking file " + subs[i]); 
     727      if (FormatHandler.debug) debug("Checking file " + subs[i]); 
    728728      subs[i] = root + (root.endsWith(File.separator) ? "" : File.separator) + 
    729729        subs[i]; 
     
    731731        similarFiles.contains(new Location(root, subs[i]).getAbsolutePath())) 
    732732      { 
    733         if (FormatReader.debug) debug(subs[i] + " is a bad file"); 
     733        if (FormatHandler.debug) debug(subs[i] + " is a bad file"); 
    734734        String[] matching = new FilePattern(subs[i]).getFiles(); 
    735735        for (int j=0; j<matching.length; j++) { 
     
    747747      else { 
    748748        if (ir.isThisType(subs[i])) { 
    749           if (FormatReader.debug) debug("Adding " + subs[i]); 
     749          if (FormatHandler.debug) debug("Adding " + subs[i]); 
    750750          files.add(file.getAbsolutePath()); 
    751751        } 
    752         else if (FormatReader.debug) debug(subs[i] + " has invalid type"); 
     752        else if (FormatHandler.debug) debug(subs[i] + " has invalid type"); 
    753753      } 
    754754      file = null; 
     
    765765      } 
    766766      catch (IOException io) { 
    767         if (FormatReader.debug) io.printStackTrace(); 
     767        if (FormatHandler.debug) io.printStackTrace(); 
    768768      } 
    769769    } 
     
    773773    } 
    774774    catch (IOException exc) { 
    775       if (FormatReader.debug) exc.printStackTrace(); 
     775      if (FormatHandler.debug) exc.printStackTrace(); 
    776776    } 
    777777  } 
     
    785785      for (int i=1; i<args.length; i++) { 
    786786        if (args[i].equals("-config")) ReaderTest.writeConfigFiles = true; 
    787         else if (args[i].equals("-debug")) FormatReader.setDebug(true); 
     787        else if (args[i].equals("-debug")) FormatHandler.setDebug(true); 
    788788        else if (args[i].equals("-xmlonly")) ReaderTest.testXML = true;  
    789789        else if (args[i].equals("-time")) { 
     
    799799    } 
    800800    System.out.print("Building file list..."); 
    801     if (FormatReader.debug) System.out.println(); 
     801    if (FormatHandler.debug) System.out.println(); 
    802802    getFiles(new Location(args[0]).getAbsolutePath(), files); 
    803803    System.out.println(files.size() + " found."); 
     
    825825        if (used != null) { 
    826826          for (int i=0; i<used.length; i++) { 
    827             if (FormatReader.debug) System.out.println("Removing " + used[i]); 
     827            if (FormatHandler.debug) System.out.println("Removing " + used[i]); 
    828828            files.removeElement(used[i]); 
    829829          } 
     
    833833      else { 
    834834        for (int i=0; i<used.length; i++) { 
    835           if (FormatReader.debug) System.out.println("Removing " + used[i]); 
     835          if (FormatHandler.debug) System.out.println("Removing " + used[i]); 
    836836          files.removeElement(used[i]); 
    837837        } 
Note: See TracChangeset for help on using the changeset viewer.