sootup.jimple.parser.JimpleStringAnalysisInputLocation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sootup.jimple.parser Show documentation
The newest version!
package sootup.jimple.parser;

/*-
 * #%L
 * Soot
 * %%
 * Copyright (C) 2018-2024 Markus Schmidt
 * %%
 * This program 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 2.1 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 General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nonnull;
import org.antlr.v4.runtime.CharStreams;
import sootup.core.frontend.OverridingClassSource;
import sootup.core.frontend.SootClassSource;
import sootup.core.inputlocation.AnalysisInputLocation;
import sootup.core.model.SourceType;
import sootup.core.transform.BodyInterceptor;
import sootup.core.types.ClassType;
import sootup.core.views.View;

/**
 * This AnalysisInputLocation encapsulates and represents a single Jimple "file" - the contents of
 * the Class are given via String.
 *
 * see JimpleStringAnalysisInputLocationTest for an example.
 */
public class JimpleStringAnalysisInputLocation implements AnalysisInputLocation {

  @Nonnull final Path path = Paths.get("only-in-memory.jimple");
  @Nonnull final List bodyInterceptors;
  @Nonnull private final OverridingClassSource classSource;
  @Nonnull final SourceType sourceType;

  public JimpleStringAnalysisInputLocation(@Nonnull String jimpleFileContents) {
    this(jimpleFileContents, SourceType.Application, Collections.emptyList());
  }

  public JimpleStringAnalysisInputLocation(
      @Nonnull String jimpleFileContents,
      @Nonnull SourceType sourceType,
      @Nonnull List bodyInterceptors) {
    this.bodyInterceptors = bodyInterceptors;
    this.sourceType = sourceType;

    try {
      JimpleConverter jimpleConverter = new JimpleConverter();
      classSource =
          jimpleConverter.run(
              CharStreams.fromString(jimpleFileContents), this, path, bodyInterceptors);
    } catch (Exception e) {
      throw new IllegalArgumentException("No valid Jimple given.", e);
    }
  }

  @Nonnull
  @Override
  public Optional getClassSource(
      @Nonnull ClassType type, @Nonnull View view) {
    return Optional.of(classSource);
  }

  @Nonnull
  @Override
  public Collection getClassSources(@Nonnull View view) {
    return Collections.singletonList(classSource);
  }

  @Nonnull
  @Override
  public SourceType getSourceType() {
    return sourceType;
  }

  @Nonnull
  @Override
  public List getBodyInterceptors() {
    return bodyInterceptors;
  }

  @Nonnull
  public ClassType getClassType() {
    return classSource.getClassType();
  }
}