tracesrv/tracecompiler/src/com.nokia.tracecompiler/src/com/nokia/tracecompiler/model/TraceParameter.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) 2009 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
* All trace objects may contain parameters
hgs
parents:
diff changeset
    17
*
hgs
parents:
diff changeset
    18
*/
hgs
parents:
diff changeset
    19
package com.nokia.tracecompiler.model;
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
/**
hgs
parents:
diff changeset
    22
 * Traces may contain parameters
hgs
parents:
diff changeset
    23
 * 
hgs
parents:
diff changeset
    24
 */
hgs
parents:
diff changeset
    25
public class TraceParameter extends TraceObject {
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
	/**
hgs
parents:
diff changeset
    28
	 * The type of this parameter
hgs
parents:
diff changeset
    29
	 */
hgs
parents:
diff changeset
    30
	private String type;
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
	/**
hgs
parents:
diff changeset
    33
	 * Hexadecimal (%p), pointer type
hgs
parents:
diff changeset
    34
	 */
hgs
parents:
diff changeset
    35
	public static final String POINTER = "void*"; //$NON-NLS-1$
hgs
parents:
diff changeset
    36
	
hgs
parents:
diff changeset
    37
	/**
hgs
parents:
diff changeset
    38
	 * Signed decimal (%d), 32-bit type
hgs
parents:
diff changeset
    39
	 */
hgs
parents:
diff changeset
    40
	public static final String SDEC32 = "int32"; //$NON-NLS-1$
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
	/**
hgs
parents:
diff changeset
    43
	 * Hexadecimal (%x), 32-bit type
hgs
parents:
diff changeset
    44
	 */
hgs
parents:
diff changeset
    45
	public static final String HEX32 = "hex32"; //$NON-NLS-1$
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
	/**
hgs
parents:
diff changeset
    48
	 * Unsigned decimal (%u), 32-bit type
hgs
parents:
diff changeset
    49
	 */
hgs
parents:
diff changeset
    50
	public static final String UDEC32 = "uint32"; //$NON-NLS-1$
hgs
parents:
diff changeset
    51
	
hgs
parents:
diff changeset
    52
	/**
hgs
parents:
diff changeset
    53
	 * Octal (%o), 32-bit type
hgs
parents:
diff changeset
    54
	 */
hgs
parents:
diff changeset
    55
	public static final String OCT32 = "oct32"; //$NON-NLS-1$	
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
	/**
hgs
parents:
diff changeset
    58
	 * Signed decimal (%hd), 16-bit type
hgs
parents:
diff changeset
    59
	 */
hgs
parents:
diff changeset
    60
	public static final String SDEC16 = "int16"; //$NON-NLS-1$
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
	/**
hgs
parents:
diff changeset
    63
	 * Hexadecimal (%hx), 16-bit type
hgs
parents:
diff changeset
    64
	 */
hgs
parents:
diff changeset
    65
	public static final String HEX16 = "hex16"; //$NON-NLS-1$
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
	/**
hgs
parents:
diff changeset
    68
	 * Unsigned decimal (%hu), 16-bit type
hgs
parents:
diff changeset
    69
	 */
hgs
parents:
diff changeset
    70
	public static final String UDEC16 = "uint16"; //$NON-NLS-1$
hgs
parents:
diff changeset
    71
	
hgs
parents:
diff changeset
    72
	/**
hgs
parents:
diff changeset
    73
	 * Octal (%ho), 16-bit type
hgs
parents:
diff changeset
    74
	 */
hgs
parents:
diff changeset
    75
	public static final String OCT16 = "oct16"; //$NON-NLS-1$	
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
	/**
hgs
parents:
diff changeset
    78
	 * Signed decimal (%hhd), 8-bit type
hgs
parents:
diff changeset
    79
	 */
hgs
parents:
diff changeset
    80
	public static final String SDEC8 = "int8"; //$NON-NLS-1$
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
	/**
hgs
parents:
diff changeset
    83
	 * Hexadecimal (%hhx), 8-bit type
hgs
parents:
diff changeset
    84
	 */
hgs
parents:
diff changeset
    85
	public static final String HEX8 = "hex8"; //$NON-NLS-1$
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
	/**
hgs
parents:
diff changeset
    88
	 * Unsigned decimal (%hhu), 8-bit type
hgs
parents:
diff changeset
    89
	 */
hgs
parents:
diff changeset
    90
	public static final String UDEC8 = "uint8"; //$NON-NLS-1$
hgs
parents:
diff changeset
    91
	
hgs
parents:
diff changeset
    92
	/**
hgs
parents:
diff changeset
    93
	 * Octal (%hho), 8-bit type
hgs
parents:
diff changeset
    94
	 */
hgs
parents:
diff changeset
    95
	public static final String OCT8 = "oct8"; //$NON-NLS-1$
hgs
parents:
diff changeset
    96
hgs
parents:
diff changeset
    97
	/**
hgs
parents:
diff changeset
    98
	 * Signed decimal (%ld), 64-bit type
hgs
parents:
diff changeset
    99
	 */
hgs
parents:
diff changeset
   100
	public static final String SDEC64 = "int64"; //$NON-NLS-1$
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
	/**
hgs
parents:
diff changeset
   103
	 * Time, 64-bit type
hgs
parents:
diff changeset
   104
	 */
hgs
parents:
diff changeset
   105
	public static final String TIME = "time"; //$NON-NLS-1$	
hgs
parents:
diff changeset
   106
	
hgs
parents:
diff changeset
   107
	/**
hgs
parents:
diff changeset
   108
	 * Hexadecimal (%lx), 64-bit type
hgs
parents:
diff changeset
   109
	 */
hgs
parents:
diff changeset
   110
	public static final String HEX64 = "hex64"; //$NON-NLS-1$
hgs
parents:
diff changeset
   111
hgs
parents:
diff changeset
   112
	/**
hgs
parents:
diff changeset
   113
	 * Unsigned decimal (%lu), 64-bit type
hgs
parents:
diff changeset
   114
	 */
hgs
parents:
diff changeset
   115
	public static final String UDEC64 = "uint64"; //$NON-NLS-1$
hgs
parents:
diff changeset
   116
	
hgs
parents:
diff changeset
   117
	/**
hgs
parents:
diff changeset
   118
	 * Octal (%lo), 64-bit type
hgs
parents:
diff changeset
   119
	 */
hgs
parents:
diff changeset
   120
	public static final String OCT64 = "oct64"; //$NON-NLS-1$	
hgs
parents:
diff changeset
   121
hgs
parents:
diff changeset
   122
	/**
hgs
parents:
diff changeset
   123
	 * Ascii string (%s) type
hgs
parents:
diff changeset
   124
	 */
hgs
parents:
diff changeset
   125
	public static final String ASCII = "ascii"; //$NON-NLS-1$
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
	/**
hgs
parents:
diff changeset
   128
	 * Unicode string (%S) type
hgs
parents:
diff changeset
   129
	 */
hgs
parents:
diff changeset
   130
	public static final String UNICODE = "unicode"; //$NON-NLS-1$
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
	/**
hgs
parents:
diff changeset
   133
	 * Fixed floating point (%f), 64-bit
hgs
parents:
diff changeset
   134
	 */
hgs
parents:
diff changeset
   135
	public static final String FLOAT_FIX = "ffix"; //$NON-NLS-1$
hgs
parents:
diff changeset
   136
hgs
parents:
diff changeset
   137
	/**
hgs
parents:
diff changeset
   138
	 * Exponent floating point (%e), 64-bit
hgs
parents:
diff changeset
   139
	 */
hgs
parents:
diff changeset
   140
	public static final String FLOAT_EXP = "fexp"; //$NON-NLS-1$
hgs
parents:
diff changeset
   141
hgs
parents:
diff changeset
   142
	/**
hgs
parents:
diff changeset
   143
	 * Fixed / exponential floating point (%g), 64-bit
hgs
parents:
diff changeset
   144
	 */
hgs
parents:
diff changeset
   145
	public static final String FLOAT_OPT = "fopt"; //$NON-NLS-1$
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
	/**
hgs
parents:
diff changeset
   148
	 * The trace this parameter belongs to
hgs
parents:
diff changeset
   149
	 */
hgs
parents:
diff changeset
   150
	private Trace owner;
hgs
parents:
diff changeset
   151
hgs
parents:
diff changeset
   152
	/**
hgs
parents:
diff changeset
   153
	 * Constructor
hgs
parents:
diff changeset
   154
	 * 
hgs
parents:
diff changeset
   155
	 * @param owner
hgs
parents:
diff changeset
   156
	 *            the object owning this parameter
hgs
parents:
diff changeset
   157
	 */
hgs
parents:
diff changeset
   158
	public TraceParameter(Trace owner) {
hgs
parents:
diff changeset
   159
		setModel(owner.getModel());
hgs
parents:
diff changeset
   160
		owner.addParameter(this);
hgs
parents:
diff changeset
   161
		this.owner = owner;
hgs
parents:
diff changeset
   162
	}
hgs
parents:
diff changeset
   163
hgs
parents:
diff changeset
   164
	/**
hgs
parents:
diff changeset
   165
	 * Constructor, which inserts the parameter into specified index
hgs
parents:
diff changeset
   166
	 * 
hgs
parents:
diff changeset
   167
	 * @param owner
hgs
parents:
diff changeset
   168
	 *            the object owning this parameter
hgs
parents:
diff changeset
   169
	 * @param index
hgs
parents:
diff changeset
   170
	 *            the parameter index
hgs
parents:
diff changeset
   171
	 */
hgs
parents:
diff changeset
   172
	TraceParameter(Trace owner, int index) {
hgs
parents:
diff changeset
   173
		setModel(owner.getModel());
hgs
parents:
diff changeset
   174
		owner.insertParameter(index, this);
hgs
parents:
diff changeset
   175
		this.owner = owner;
hgs
parents:
diff changeset
   176
	}
hgs
parents:
diff changeset
   177
hgs
parents:
diff changeset
   178
	/**
hgs
parents:
diff changeset
   179
	 * Gets the trace this parameter is associated to.
hgs
parents:
diff changeset
   180
	 * 
hgs
parents:
diff changeset
   181
	 * @return the trace
hgs
parents:
diff changeset
   182
	 */
hgs
parents:
diff changeset
   183
	public Trace getTrace() {
hgs
parents:
diff changeset
   184
		return owner;
hgs
parents:
diff changeset
   185
	}
hgs
parents:
diff changeset
   186
hgs
parents:
diff changeset
   187
	/**
hgs
parents:
diff changeset
   188
	 * Sets the parameter type. Generates propertyUpdated event to model
hgs
parents:
diff changeset
   189
	 * listeners if type changes
hgs
parents:
diff changeset
   190
	 * 
hgs
parents:
diff changeset
   191
	 * @see TraceModelListener#propertyUpdated(TraceObject, int)
hgs
parents:
diff changeset
   192
	 * @param type
hgs
parents:
diff changeset
   193
	 *            the parameter type
hgs
parents:
diff changeset
   194
	 * @throws TraceCompilerException 
hgs
parents:
diff changeset
   195
	 */
hgs
parents:
diff changeset
   196
	public void setType(String type) throws TraceCompilerException {
hgs
parents:
diff changeset
   197
		if (!type.equals(this.type)) {
hgs
parents:
diff changeset
   198
			removeTableReference();
hgs
parents:
diff changeset
   199
			this.type = type;
hgs
parents:
diff changeset
   200
			addTableReference();
hgs
parents:
diff changeset
   201
			getModel().notifyPropertyUpdated(this, TraceModelListener.TYPE);
hgs
parents:
diff changeset
   202
		}
hgs
parents:
diff changeset
   203
	}
hgs
parents:
diff changeset
   204
hgs
parents:
diff changeset
   205
	/**
hgs
parents:
diff changeset
   206
	 * Gets the parameter type
hgs
parents:
diff changeset
   207
	 * 
hgs
parents:
diff changeset
   208
	 * @return the parameter type
hgs
parents:
diff changeset
   209
	 */
hgs
parents:
diff changeset
   210
	public String getType() {
hgs
parents:
diff changeset
   211
		return type;
hgs
parents:
diff changeset
   212
	}
hgs
parents:
diff changeset
   213
hgs
parents:
diff changeset
   214
	/*
hgs
parents:
diff changeset
   215
	 * (non-Javadoc)
hgs
parents:
diff changeset
   216
	 * 
hgs
parents:
diff changeset
   217
	 * @see com.nokia.tracecompiler.model.TraceObject#reset()
hgs
parents:
diff changeset
   218
	 */
hgs
parents:
diff changeset
   219
	@Override
hgs
parents:
diff changeset
   220
	void reset() {
hgs
parents:
diff changeset
   221
		removeTableReference();
hgs
parents:
diff changeset
   222
		super.reset();
hgs
parents:
diff changeset
   223
	}
hgs
parents:
diff changeset
   224
hgs
parents:
diff changeset
   225
	/**
hgs
parents:
diff changeset
   226
	 * Adds a constant table reference
hgs
parents:
diff changeset
   227
	 */
hgs
parents:
diff changeset
   228
	private void addTableReference() {
hgs
parents:
diff changeset
   229
		if (type != null) {
hgs
parents:
diff changeset
   230
			TraceConstantTable table = getModel().findConstantTableByName(type);
hgs
parents:
diff changeset
   231
			if (table != null) {
hgs
parents:
diff changeset
   232
				table.addParameterReference(this);
hgs
parents:
diff changeset
   233
			}
hgs
parents:
diff changeset
   234
		}
hgs
parents:
diff changeset
   235
	}
hgs
parents:
diff changeset
   236
hgs
parents:
diff changeset
   237
	/**
hgs
parents:
diff changeset
   238
	 * Removes the constant table reference
hgs
parents:
diff changeset
   239
	 */
hgs
parents:
diff changeset
   240
	private void removeTableReference() {
hgs
parents:
diff changeset
   241
		if (type != null) {
hgs
parents:
diff changeset
   242
			TraceConstantTable table = getModel().findConstantTableByName(type);
hgs
parents:
diff changeset
   243
			if (table != null) {
hgs
parents:
diff changeset
   244
				table.removeParameterReference(this);
hgs
parents:
diff changeset
   245
			}
hgs
parents:
diff changeset
   246
		}
hgs
parents:
diff changeset
   247
	}
hgs
parents:
diff changeset
   248
hgs
parents:
diff changeset
   249
}