Mercurial > hg > truffle
view graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/impl/LineToSourceSectionMap.java @ 18485:e3c95cbbb50c
Truffle Instrumentation: major API revision, based around the Probe and Instrument classes; add Instrumentable API for language implementors, with most details automated; reimplemented to handle AST splitting automatically; more JUnit tests.
author | Michael Van De Vanter <michael.van.de.vanter@oracle.com> |
---|---|
date | Sun, 23 Nov 2014 16:07:23 -0800 |
parents | |
children |
line wrap: on
line source
/* * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code 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 Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package com.oracle.truffle.api.instrument.impl; import java.io.*; import java.util.*; import com.oracle.truffle.api.instrument.*; import com.oracle.truffle.api.instrument.Probe.*; import com.oracle.truffle.api.source.*; /** * A mapping from {@link LineLocation} (a line number in a specific piece of {@link Source} code) to * a collection of {@link SourceSection}s that exist on that line. This class assumes that all nodes * are instrumented as it uses the {@link ProbeListener} interface to determine the source sections * that exist in the file. */ public class LineToSourceSectionMap implements ProbeListener { private static final boolean TRACE = false; private static final PrintStream OUT = System.out; private static void trace(String msg) { OUT.println("LineToSourceSectionMap: " + msg); } /** * Map: Source line ==> source sections that exist on the line. */ private final Map<LineLocation, Collection<SourceSection>> lineToSourceSectionsMap = new HashMap<>(); public LineToSourceSectionMap() { } public void startASTProbing(Source source) { } public void newProbeInserted(Probe probe) { final SourceSection sourceSection = probe.getProbedSourceSection(); if (sourceSection != null && !(sourceSection instanceof NullSourceSection)) { final LineLocation lineLocation = sourceSection.getLineLocation(); if (TRACE) { trace("NEW " + lineLocation.getShortDescription() + " Probe=" + probe); } this.addSourceSectionToLine(lineLocation, sourceSection); } } public void probeTaggedAs(Probe probe, SyntaxTag tag, Object tagValue) { // This map ignores tags, but this subclasses can override this method to operate on tags. } public void endASTProbing(Source source) { } /** * Adds a source section to the given line. * <p> * If the line already exists in the internal {@link #lineToSourceSectionsMap}, this source * section will be added to the existing collection. If no line already exists in the internal * map, then a new key is added along with a new collection containing the source section. * <p> * This class does not check if a source section has already been added to a line. * * @param line The {@link LineLocation} to attach the source section to. * @param sourceSection The {@link SourceSection} to attach for that line location. */ protected void addSourceSectionToLine(LineLocation line, SourceSection sourceSection) { if (!lineToSourceSectionsMap.containsKey(line)) { // Key does not exist, add new source section list final ArrayList<SourceSection> newSourceSectionList = new ArrayList<>(2); newSourceSectionList.add(sourceSection); lineToSourceSectionsMap.put(line, newSourceSectionList); } else { // Source section list exists, add to existing final Collection<SourceSection> existingSourceSectionList = lineToSourceSectionsMap.get(line); existingSourceSectionList.add(sourceSection); } } /** * Returns a collection of {@link SourceSection}s at the given {@link LineLocation}, an empty * list if none. * * @param line The line to check. * @return the source sections at the given line. */ public Collection<SourceSection> getSourceSectionsAtLine(LineLocation line) { Collection<SourceSection> sourceSectionList = lineToSourceSectionsMap.get(line); if (sourceSectionList == null) { return Collections.emptyList(); } return sourceSectionList; } /** * Convenience method to get source sections according to a int line number. Returns a * collection of {@link SourceSection}s at the given line number. If there are no source * sections at that line, an empty list is returned. * * @param lineNumber The line number to check. * @return A collection of source sections at the given line. */ public Collection<SourceSection> getSourceSectionsAtLineNumber(int lineNumber) { final Set<LineLocation> keySet = lineToSourceSectionsMap.keySet(); if (keySet.size() == 0) { return Collections.emptyList(); } final ArrayList<SourceSection> sourceSections = new ArrayList<>(); for (LineLocation line : keySet) { if (line.getLineNumber() == lineNumber) { sourceSections.addAll(lineToSourceSectionsMap.get(line)); } } return sourceSections; } }