AInsertLineResolution.java

/*******************************************************************************
 * Copyright (c) 2008, 2017 Alexander Kurtakov and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Alexander Kurtakov - initial API and implementation
 *******************************************************************************/
package org.eclipse.linuxtools.internal.rpm.rpmlint.resolutions;

import org.eclipse.core.resources.IMarker;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.linuxtools.internal.rpm.rpmlint.RpmlintLog;
import org.eclipse.linuxtools.rpm.ui.editor.parser.Specfile;
import org.eclipse.linuxtools.rpm.ui.editor.parser.SpecfileParser;
import org.eclipse.ui.IEditorPart;

/**
 * Defines the common functionality for a resolution which fix is only inserting line.
 *
 */
public abstract class AInsertLineResolution extends ARpmlintResolution {

    /**
     * Returns the line to be inserted for the fix.
     * Note: If there are some whitespace requirements for this line(e.g. an empty line after it)
     * just append it to the real fix.
     *
     * @return The entire line for the fix.
     */
    public abstract String getLineToInsert();

    /**
     * Returns the number of the line, which will succeed the inserted line.
     *
     * @param editor The Specfile editor if it's needed for determining the correct place.
     * @return The number of the line following the inserted line.
     */
    public abstract int getLineNumberForInsert(Specfile editor);

    /**
     * Inserts an entire line at a given position as a resolution for a problem.
     *
     * @see org.eclipse.ui.IMarkerResolution#run(org.eclipse.core.resources.IMarker)
     */
    @Override
    public void run(IMarker marker) {
        IEditorPart editor = getEditor(marker);
        if (editor == null) {
            return;
        }
        // Get the document
        IDocument doc = (IDocument) editor.getAdapter(IDocument.class);

        try {
            int index = doc.getLineOffset(getLineNumberForInsert(new SpecfileParser().parse(doc)));
            doc.replace(index, 0, getLineToInsert());
        } catch (BadLocationException e) {
            RpmlintLog.logError(e);
        }
    }

}