org.ow2.mind.idl.BasicIncludeResolver Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of idl-frontend Show documentation
Front-end components for the IDL language of the Mind programming model.
The newest version!
/**
 * 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: Matthieu Leclercq
 * Contributors: 
 */

package org.ow2.mind.idl;

import static org.ow2.mind.PathHelper.toAbsolute;
import static org.ow2.mind.idl.ast.IDLASTHelper.getIncludedPath;

import java.net.URL;
import java.util.Map;

import org.objectweb.fractal.adl.ADLException;
import org.objectweb.fractal.adl.NodeFactory;
import org.ow2.mind.PathHelper;
import org.ow2.mind.PathHelper.InvalidRelativPathException;
import org.ow2.mind.error.ErrorManager;
import org.ow2.mind.idl.ast.IDL;
import org.ow2.mind.idl.ast.IDLASTHelper;
import org.ow2.mind.idl.ast.Include;

import com.google.inject.Inject;

public class BasicIncludeResolver implements IncludeResolver {

  @Inject
  protected ErrorManager       errorManagerItf;

  @Inject
  protected NodeFactory        nodeFactoryItf;

  @Inject
  protected RecursiveIDLLoader recursiveIdlLoaderItf;

  @Inject
  protected IDLLoader          idlLoaderItf;

  @Inject
  protected IDLLocator         idlLocatorItf;

  // ---------------------------------------------------------------------------
  // Implementation of the IncludeResolver interface
  // ---------------------------------------------------------------------------

  public IDL resolve(final Include include, final IDL encapsulatingIDL,
      final String encapsulatingName, final Map context)
      throws ADLException {
    final String encapsulatingIDLName;
    if (encapsulatingName == null) {
      if (encapsulatingIDL == null) {
        throw new IllegalArgumentException(
            "encapsulatingIDL and encapsulatingName cannot be both null");
      }
      encapsulatingIDLName = encapsulatingIDL.getName();
    } else {
      encapsulatingIDLName = encapsulatingName;
    }

    String path = getIncludedPath(include);
    if (!PathHelper.isValid(path)) {
      errorManagerItf.logError(IDLErrors.INVALID_INCLUDE, include, path);
      return IDLASTHelper.newUnresolvedIDLNode(nodeFactoryItf, path);
    }

    final String encapsulatingDir;
    if (encapsulatingIDLName.startsWith("/")) {
      encapsulatingDir = PathHelper.getParent(encapsulatingIDLName);
    } else {
      encapsulatingDir = PathHelper
          .fullyQualifiedNameToDirName(encapsulatingIDLName);
    }

    if (path.startsWith("/")) {
      // absolute path.
      final URL url = idlLocatorItf.findSourceHeader(path, context);
      if (url == null) {
        errorManagerItf.logError(IDLErrors.IDL_NOT_FOUND, include, path);
        return IDLASTHelper.newUnresolvedIDLNode(nodeFactoryItf, path);
      }
    } else {
      // look-for header relatively to encapsulatingDir
      String relPath = null;
      try {
        relPath = toAbsolute(encapsulatingDir, path);
      } catch (final InvalidRelativPathException e) {
        errorManagerItf.logError(IDLErrors.INVALID_INCLUDE, include, path);
        return IDLASTHelper.newUnresolvedIDLNode(nodeFactoryItf, path);
      }
      URL url = idlLocatorItf.findSourceHeader(relPath, context);
      if (url != null) {
        // IDL found with relPath
        path = relPath;
      } else if (path.startsWith("./") || path.startsWith("../")) {
        // the path starts with "./" or "../" which force a resolution
        // relatively to encapsulatingDir. the file has not been found.
        errorManagerItf.logError(IDLErrors.IDL_NOT_FOUND, include, path);
        return IDLASTHelper.newUnresolvedIDLNode(nodeFactoryItf, path);
      } else {
        // look-for header relatively to source-path
        path = "/" + path;
        url = idlLocatorItf.findSourceHeader(path, context);
        if (url == null) {
          errorManagerItf.logError(IDLErrors.IDL_NOT_FOUND, include, path);
          return IDLASTHelper.newUnresolvedIDLNode(nodeFactoryItf, path);
        }
      }
    }

    IDLASTHelper.setIncludePathPreserveDelimiter(include, path);

    try {
      if (encapsulatingIDL != null) {
        return recursiveIdlLoaderItf.load(encapsulatingIDL, path, context);
      } else {
        return idlLoaderItf.load(path, context);
      }
    } catch (final ADLException e) {
      // Log an error only if the exception is IDL_NOT_FOUND
      if (e.getError().getTemplate() == IDLErrors.IDL_NOT_FOUND) {
        errorManagerItf.logError(IDLErrors.IDL_NOT_FOUND, include, path);
      }
      return IDLASTHelper.newUnresolvedIDLNode(nodeFactoryItf, path);
    }
  }
}