BasicIDLLocator.java

/**
 * 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 <http://www.gnu.org/licenses/>.
 *
 * Contact: mind@ow2.org
 *
 * Authors: Matthieu Leclercq
 * Contributors: 
 */

package org.ow2.mind.idl;

import static org.objectweb.fractal.adl.util.ClassLoaderHelper.getClassLoader;
import static org.ow2.mind.PathHelper.fullyQualifiedNameToPath;
import static org.ow2.mind.PathHelper.isRelative;
import static org.ow2.mind.PathHelper.isValid;

import java.io.IOException;
import java.net.URL;
import java.util.Enumeration;
import java.util.Map;

import org.ow2.mind.InputResource;
import org.ow2.mind.NameHelper;
import org.ow2.mind.PathHelper;

import com.google.common.collect.Lists;

/**
 * Basic implementation of the {@link IDLLocator} interface for MIND IDL.
 */
public class BasicIDLLocator implements IDLLocator {

  protected static final String SOURCE_ITF_EXTENSION = ".itf";
  protected static final String BINARY_ITF_EXTENSION = ".itfdef";
  protected static final String BINARY_IDT_EXTENSION = ".idtdef";

  // ---------------------------------------------------------------------------
  // Static Methods
  // ---------------------------------------------------------------------------

  public static String getItfSourceName(final String name) {
    return fullyQualifiedNameToPath(name, SOURCE_ITF_EXTENSION);
  }

  public static String getItfBinaryName(final String name) {
    return fullyQualifiedNameToPath(name, BINARY_ITF_EXTENSION);
  }

  public static String getHeaderBinaryName(final String path) {
    return PathHelper.replaceExtension(path, BINARY_IDT_EXTENSION);
  }

  // ---------------------------------------------------------------------------
  // Implementation of the IDLLocator interface
  // ---------------------------------------------------------------------------

  public Iterable<String> getResourceKind() {
    return Lists.newArrayList(IDLLocator.IDT_RESOURCE_KIND,
        IDLLocator.ITF_RESOURCE_KIND);
  }

  public URL findSourceItf(final String name, final Map<Object, Object> context) {
    if (!NameHelper.isValid(name))
      throw new IllegalArgumentException("\"" + name + "\" is not a valid name");

    try {
      /*
       * Usual case was with getResource. However, the Maven plugin case is more
       * complex: when using elements from fractal-runtime, it would find
       * matches in the fractal-runtime.jar in the Maven cache + matches in the
       * compiler's distribution 'runtime' folder. We get all possible contents,
       * and return a file-system entry only, thus discarding jar contents.
       */
      final Enumeration<URL> urls = getClassLoader(this, context).getResources(
          getItfSourceName(name).substring(1));

      while (urls.hasMoreElements()) {
        final URL url = urls.nextElement();
        if (url.getProtocol().equals("file")) return url;
      }
    } catch (final IOException e) {
      // ignore ('null' case handled at higher level)
    }

    return null;
  }

  public URL findBinaryItf(final String name, final Map<Object, Object> context) {
    if (!NameHelper.isValid(name))
      throw new IllegalArgumentException("\"" + name + "\" is not a valid name");

    return getClassLoader(this, context).getResource(
        getItfBinaryName(name).substring(1));
  }

  public URL findSourceHeader(final String path,
      final Map<Object, Object> context) {
    if (!isValid(path))
      throw new IllegalArgumentException("\"" + path + "\" is not a valid path");
    if (isRelative(path))
      throw new IllegalArgumentException("\"" + path
          + "\" is not an absolute path");

    try {
      /*
       * Usual case was with getResource. However, the Maven plugin case is more
       * complex: when using elements from fractal-runtime, it would find
       * matches in the fractal-runtime.jar in the Maven cache + matches in the
       * compiler's distribution 'runtime' folder. We get all possible contents,
       * and return a file-system entry only, thus discarding jar contents.
       */
      final Enumeration<URL> urls = getClassLoader(this, context).getResources(
          path.substring(1));

      while (urls.hasMoreElements()) {
        final URL url = urls.nextElement();
        if (url.getProtocol().equals("file")) return url;
      }
    } catch (final IOException e) {
      // ignore ('null' case handled at higher level)
    }

    return null;
  }

  public URL findBinaryHeader(final String path,
      final Map<Object, Object> context) {
    if (!isValid(path))
      throw new IllegalArgumentException("\"" + path + "\" is not a valid path");
    if (isRelative(path))
      throw new IllegalArgumentException("\"" + path
          + "\" is not an absolute path");

    return getClassLoader(this, context).getResource(
        getHeaderBinaryName(path).substring(1));
  }

  public URL findResource(final String name, final Map<Object, Object> context) {
    if (name.startsWith("/"))
      return findSourceHeader(name, context);
    else
      return findSourceItf(name, context);
  }

  public InputResource toInterfaceInputResource(final String name) {
    return new InputResource(IDLLocator.ITF_RESOURCE_KIND, name);
  }

  public InputResource toSharedTypeInputResource(final String name) {
    return new InputResource(IDLLocator.IDT_RESOURCE_KIND, name);
  }
}