tmf: Make Callstack View pass timestamps and PIDs to symbol provider

[deliverable/tracecompass.git] / tmf / org.eclipse.tracecompass.tmf.ui / src / org / eclipse / tracecompass / tmf / ui / views / callstack / AbstractCallStackAnalysis.java

/*******************************************************************************
 * Copyright (c) 2014 Ericsson
 *
 * 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:
 *   Alexandre Montplaisir - Initial API and implementation
 *   Patrick Tasse - Add methods to get attribute paths
 *******************************************************************************/

package org.eclipse.tracecompass.tmf.ui.views.callstack;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.tracecompass.tmf.core.callstack.CallStackStateProvider;
import org.eclipse.tracecompass.tmf.core.statesystem.TmfStateSystemAnalysisModule;
import org.eclipse.tracecompass.tmf.ui.analysis.TmfAnalysisViewOutput;

/**
 * The base classes for analyses who want to populate the CallStack View.
 *
 * @author Alexandre Montplaisir
 */
@NonNullByDefault
public abstract class AbstractCallStackAnalysis extends TmfStateSystemAnalysisModule {

    private static final String[] DEFAULT_PROCESSES_PATTERN =
            new String[] { CallStackStateProvider.PROCESSES, "*" }; //$NON-NLS-1$

    private static final String DEFAULT_THREADS_PATTERN = ".*"; //$NON-NLS-1$

    private static final String[] DEFAULT_CALL_STACK_PATH =
            new String[] { CallStackStateProvider.CALL_STACK };

    /**
     * Abstract constructor (should only be called via the sub-classes'
     * constructors.
     */
    protected AbstractCallStackAnalysis() {
        super();
        registerOutput(new TmfAnalysisViewOutput(CallStackView.ID));
    }

    /**
     * The quark pattern to get the list of attributes representing the
     * different processes.
     *
     * It is passed as-is to
     * {@link org.eclipse.tracecompass.statesystem.core.ITmfStateSystem#getQuarks}
     * .
     * @return The quark pattern to find the processes attribute
     * @since 2.0
     */
    public String[] getProcessesPattern() {
        return DEFAULT_PROCESSES_PATTERN;
    }

    /**
     * The regex to match sub-attributes of each Process attributes representing
     * the threads of this process.
     *
     * This will be passed as-is to
     * {@link org.eclipse.tracecompass.statesystem.core.ITmfStateSystem#getSubAttributes(int, boolean, String)}
     *
     * @return The regex to pass
     * @since 2.0
     */
    public String getThreadsForProcessPattern() {
        return DEFAULT_THREADS_PATTERN;
    }

    /**
     * Get the call stack attribute path relative to a thread attribute found by
     * {@link #getThreadsForProcessPattern()}. Override this method if the state
     * system attributes do not match the default pattern defined by
     * {@link CallStackStateProvider}.
     *
     * @return the relative path of the call stack attribute
     * @since 2.0
     */
    public String[] getCallStackPathForThread() {
        return DEFAULT_CALL_STACK_PATH;
    }
}