tracesrv/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/plugin/TraceHeaderContribution.java
author hgs
Fri, 08 Oct 2010 14:56:39 +0300
changeset 56 aa2539c91954
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
* Trace header contribution
hgs
parents:
diff changeset
    17
*
hgs
parents:
diff changeset
    18
*/
hgs
parents:
diff changeset
    19
package com.nokia.tracecompiler.plugin;
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
import com.nokia.tracecompiler.model.TraceModelExtension;
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
/**
hgs
parents:
diff changeset
    24
 * Interface which can be added to model by plug-in's to contribute data to the
hgs
parents:
diff changeset
    25
 * trace header
hgs
parents:
diff changeset
    26
 * 
hgs
parents:
diff changeset
    27
 */
hgs
parents:
diff changeset
    28
public interface TraceHeaderContribution extends TraceModelExtension {
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
	/**
hgs
parents:
diff changeset
    31
	 * List of possible contributions to the trace header file
hgs
parents:
diff changeset
    32
	 */
hgs
parents:
diff changeset
    33
	public enum TraceHeaderContributionType {
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
		/**
hgs
parents:
diff changeset
    36
		 * #define statements to be added to the header
hgs
parents:
diff changeset
    37
		 */
hgs
parents:
diff changeset
    38
		GLOBAL_DEFINES,
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
		/**
hgs
parents:
diff changeset
    41
		 * #include statements to be added to the header
hgs
parents:
diff changeset
    42
		 */
hgs
parents:
diff changeset
    43
		GLOBAL_INCLUDES,
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
		/**
hgs
parents:
diff changeset
    46
		 * Content for the main header file
hgs
parents:
diff changeset
    47
		 */
hgs
parents:
diff changeset
    48
		MAIN_HEADER_CONTENT
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
	}
hgs
parents:
diff changeset
    51
hgs
parents:
diff changeset
    52
	/**
hgs
parents:
diff changeset
    53
	 * Gets data to be added to the trace header
hgs
parents:
diff changeset
    54
	 * 
hgs
parents:
diff changeset
    55
	 * @param type
hgs
parents:
diff changeset
    56
	 *            the contribution type
hgs
parents:
diff changeset
    57
	 * @return the data to be added, depends on type
hgs
parents:
diff changeset
    58
	 */
hgs
parents:
diff changeset
    59
	public String[] getContribution(TraceHeaderContributionType type);
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
}