org.sonar.plugins.findbugs.resource.DebugExtensionExtractor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-findbugs-plugin

SpotBugs is a program that uses static analysis to look for bugs in Java code. It can detect a variety of common coding mistakes, including thread synchronization problems, misuse of API methods.

There is a newer version: 4.3.0

Show newest version

/*
 * SonarQube Findbugs Plugin
 * Copyright (C) 2012 SonarSource
 * [email protected]
 *
 * 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 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.plugins.findbugs.resource;

import edu.umd.cs.findbugs.classfile.engine.asm.FindBugsASM;

import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassVisitor;

import javax.annotation.Nullable;
import java.io.IOException;
import java.io.InputStream;

/**
 * Load SourceDebugExtension section from class file.
 *
 * SourceDebugExtension is use to store optionally the line of code mapping.
 * The code content if not empty is must likely format according to JSR45 (SMAP).
 */
public class DebugExtensionExtractor {

    @Nullable
    public String getDebugExtFromClass(InputStream classIn) throws IOException {

        AbstractClassVisitor visitor = new AbstractClassVisitor();
        try {
            ClassReader classReader = new ClassReader(classIn);
            classReader.accept(visitor, 0);

            return visitor.debug;
        }
        catch (Exception e) {
            throw new ClassMetadataLoadingException(e);
        }
    }

    private static class AbstractClassVisitor extends ClassVisitor {
        protected String debug;

        public AbstractClassVisitor() {
            super(FindBugsASM.ASM_VERSION);
        }

        @Override
        public void visitSource(String source, String debug) {
            super.visitSource(source, debug);
            
            this.debug  = debug;
        }
    }
}