libjava/classpath/tools/gnu/classpath/tools/javah/Printer.java

   1 /* Print.java - abstract base class for printing classes
   2  Copyright (C) 2006 Free Software Foundation, Inc.
   3
   4  This file is part of GNU Classpath.
   5
   6  GNU Classpath is free software; you can redistribute it and/or modify
   7  it under the terms of the GNU General Public License as published by
   8  the Free Software Foundation; either version 2, or (at your option)
   9  any later version.
  10
  11  GNU Classpath is distributed in the hope that it will be useful, but
  12  WITHOUT ANY WARRANTY; without even the implied warranty of
  13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  General Public License for more details.
  15
  16  You should have received a copy of the GNU General Public License
  17  along with GNU Classpath; see the file COPYING.  If not, write to the
  18  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19  02110-1301 USA.
  20
  21  Linking this library statically or dynamically with other modules is
  22  making a combined work based on this library.  Thus, the terms and
  23  conditions of the GNU General Public License cover the whole
  24  combination.
  25
  26  As a special exception, the copyright holders of this library give you
  27  permission to link this library with independent modules to produce an
  28  executable, regardless of the license terms of these independent
  29  modules, and to copy and distribute the resulting executable under
  30  terms of your choice, provided that you also meet, for each linked
  31  independent module, the terms and conditions of the license of that
  32  module.  An independent module is a module which is not derived from
  33  or based on this library.  If you modify this library, you may extend
  34  this exception to your version of the library, but you are not
  35  obligated to do so.  If you do not wish to do so, delete this
  36  exception statement from your version. */
  37
  38
  39 package gnu.classpath.tools.javah;
  40
  41 import java.io.File;
  42 import java.io.FileNotFoundException;
  43 import java.io.FileOutputStream;
  44 import java.io.IOException;
  45 import java.io.PrintStream;
  46
  47 public abstract class Printer
  48 {
  49   protected Main classpath;
  50
  51   /**
  52    * The {@link File} object that denotes either a directory (when the
  53    * <code>-d</code> option was used), or a file (when the <code>-o</code>
  54    * option was used) on the command line.
  55    */
  56   protected File outputFileObject;
  57
  58   /**
  59    * Set to <code>true</code> if the field <code>outputFileObject</code> denotes
  60    * a directory; i.e. for each input class file, one JNI header file will be
  61    * generated in that directory.
  62    * <p>
  63    * Set to <code>false</code> if the field <code>outputFileObject</code>
  64    * denotes a file; i.e. all generated headers will be written to that file.
  65    */
  66   protected boolean isDirectory;
  67
  68   /**
  69    * Set to <code>true</code> if the output file(s) should always be written.
  70    * <p>
  71    * When set to <code>false</code>, the contents of the header/stub are only
  72    * written to the file if it does not already exist.
  73    */
  74   protected boolean force;
  75
  76   /**
  77    * Set to <code>true</code> if all output is directed to one file, and the
  78    * common preamble text has already been generated.
  79    */
  80   protected boolean wrotePreamble;
  81
  82   protected Printer(Main classpath, File outFile, boolean isDir, boolean force)
  83   {
  84     this.classpath = classpath;
  85     if (outFile == null)
  86       throw new IllegalArgumentException("File argument MUST NOT be null");
  87     outputFileObject = outFile;
  88     isDirectory = isDir;
  89     if (! isDirectory)
  90       {
  91         File parent = outputFileObject.getParentFile();
  92         if (parent != null)
  93           parent.mkdirs();
  94       }
  95     this.force = force;
  96   }
  97
  98   public abstract void printClass(ClassWrapper klass) throws IOException;
  99
 100   protected abstract void writePreambleImpl(PrintStream ps);
 101
 102   protected abstract PrintStream getPrintStreamImpl(FileOutputStream fos,
 103                                                     ClassWrapper klass);
 104
 105   protected PrintStream getPrintStream(String fullName, ClassWrapper klass)
 106       throws FileNotFoundException
 107   {
 108     PrintStream result;
 109     FileOutputStream fos;
 110     if (isDirectory)
 111       {
 112         File outFile = new File(outputFileObject, fullName);
 113         if (outFile.exists() && ! force)
 114           return null;
 115         File parent = outFile.getParentFile();
 116         if (parent != null)
 117           parent.mkdirs();
 118         fos = new FileOutputStream(outFile);
 119         result = getPrintStreamImpl(fos, klass);
 120         writePreamble(result);
 121       }
 122     else
 123       {
 124         // the first time we open this file, wrotePreamble is false
 125         fos = new FileOutputStream(outputFileObject, wrotePreamble);
 126         result = getPrintStreamImpl(fos, klass);
 127         if (! wrotePreamble)
 128           writePreamble(result);
 129       }
 130     return result;
 131   }
 132
 133   protected void writePreamble(PrintStream out)
 134   {
 135     writePreambleImpl(out);
 136     wrotePreamble = true;
 137   }
 138 }