org.ow2.mind.doc.DefinitionTreeDocumentationGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mindoc Show documentation
Document generator for MIND
There is a newer version: 1.0
/**
 * Copyright (C) 2009 STMicroelectronics
 *
 * This file is part of "Mind Compiler" is free software: you can redistribute
 * it and/or modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 * Contact: [email protected]
 *
 * Authors: [email protected]
 * Contributors:
 */

package org.ow2.mind.doc;

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.apache.commons.io.DirectoryWalker;
import org.apache.commons.io.filefilter.FileFilterUtils;
import org.ow2.mind.io.BasicOutputFileLocator;

import com.google.inject.Inject;

public class DefinitionTreeDocumentationGenerator extends DirectoryWalker {

  @Inject
  DefinitionDocumentGenerator generator;

  public DefinitionTreeDocumentationGenerator() {
    super(FileFilterUtils.trueFileFilter(), FileFilterUtils.orFileFilter(
        FileFilterUtils.suffixFileFilter(".adl"),
        FileFilterUtils.suffixFileFilter(".itf")), -1);
  }

  public void generateDocumentation(final File sourceDirectories[],
      final File targetDirectory, final Map context) throws Exception {

    final Map ctx = new HashMap(context);
    ctx.put(BasicOutputFileLocator.OUTPUT_DIR_CONTEXT_KEY, targetDirectory);
    final URL urls[] = new URL[sourceDirectories.length];
    for (int i = 0; i < sourceDirectories.length; i++) {
      final File directory = sourceDirectories[i];
      urls[i] = directory.toURI().toURL();
    }

    final ClassLoader srcClassLoader = new URLClassLoader(urls,
        Launcher.class.getClassLoader());
    ctx.put("classloader", srcClassLoader);

    for (final File rootDirectory : sourceDirectories) {
      final List definitions = new LinkedList();

      walk(rootDirectory, definitions);

      ctx.put("sourceDirectory", rootDirectory);

      for (final File definition : definitions) {
        final String definitionName = HTMLDocumentationHelper
            .getDefinitionName(rootDirectory.getCanonicalPath(),
                definition.getCanonicalPath());

        Launcher.logger.finer("Generating documentation for " + definitionName);
        if (definition.getName().endsWith(".adl")) {
          generator.generateADLDocumentation(definitionName, ctx);
        } else if (definition.getName().endsWith(".itf")) {
          generator.generateIDLDocumentation(definitionName, ctx);
        }
      }
    }
  }

  @SuppressWarnings("unchecked")
  @Override
  protected void handleFile(final File file, final int depth,
      @SuppressWarnings("rawtypes") final Collection results)
      throws IOException {
    results.add(file);
  }

}