1 /* |
|
2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * |
|
16 * Formatting constants for traces |
|
17 * |
|
18 */ |
|
19 package com.nokia.tracecompiler.plugin; |
|
20 |
|
21 /** |
|
22 * Formatting constants for traces |
|
23 * |
|
24 */ |
|
25 public interface TraceFormatConstants { |
|
26 |
|
27 /** |
|
28 * Function name in upper case |
|
29 */ |
|
30 String FORMAT_FUNCTION_NAME_UPPER_CASE = "{$FN}"; //$NON-NLS-1$ |
|
31 |
|
32 /** |
|
33 * Function name in normal case |
|
34 */ |
|
35 String FORMAT_FUNCTION_NAME_NORMAL_CASE = "{$fn}"; //$NON-NLS-1$ |
|
36 |
|
37 /** |
|
38 * Class name in upper case |
|
39 */ |
|
40 String FORMAT_CLASS_NAME_UPPER_CASE = "{$CN}"; //$NON-NLS-1$ |
|
41 |
|
42 /** |
|
43 * Class name in normal case |
|
44 */ |
|
45 String FORMAT_CLASS_NAME_NORMAL_CASE = "{$cn}"; //$NON-NLS-1$ |
|
46 |
|
47 /** |
|
48 * Tag which is replaced by trace text when inserting a trace to source |
|
49 */ |
|
50 String FORMATTED_TRACE = "%FORMATTED_TRACE%"; //$NON-NLS-1$ |
|
51 |
|
52 /** |
|
53 * Tag which is replaced by parameters when inserting a trace to source |
|
54 */ |
|
55 String PARAMETERS_FORMAT = "%PARAMETERS%"; //$NON-NLS-1$ |
|
56 |
|
57 /** |
|
58 * Insert format for include header |
|
59 */ |
|
60 String INCLUDE_FORMAT = "%INCLUDE%"; //$NON-NLS-1$ |
|
61 |
|
62 /** |
|
63 * Tag which is replaced by parameter count when inserting a trace to source |
|
64 */ |
|
65 String PARAM_COUNT_FORMAT = "%PC%"; //$NON-NLS-1$ |
|
66 |
|
67 /** |
|
68 * Tag which is replaced by group name when inserting a trace to source |
|
69 */ |
|
70 String GROUP_FORMAT = "%GROUP%"; //$NON-NLS-1$ |
|
71 |
|
72 /** |
|
73 * Tag which is replaced by trace name when inserting a trace to source |
|
74 */ |
|
75 String NAME_FORMAT = "%NAME%"; //$NON-NLS-1$ |
|
76 |
|
77 /** |
|
78 * Tag which is replaced by state machine name when inserting a trace to |
|
79 * source |
|
80 */ |
|
81 String STATE_MACHINE_NAME_FORMAT = "%STATE_MACHINE_NAME%"; //$NON-NLS-1$ |
|
82 |
|
83 /** |
|
84 * Tag which is replaced by state machine state when inserting a trace to |
|
85 * source |
|
86 */ |
|
87 String STATE_MACHINE_STATE_FORMAT = "%STATE_MACHINE_STATE%"; //$NON-NLS-1$ |
|
88 |
|
89 /** |
|
90 * Tag which is replaced by event name when inserting a trace to source |
|
91 */ |
|
92 String EVENT_NAME_FORMAT = "%EVENT_NAME%"; //$NON-NLS-1$ |
|
93 |
|
94 /** |
|
95 * Tag which is replaced by event start trace name when inserting a trace to |
|
96 * source |
|
97 */ |
|
98 String EVENT_START_TRACE_NAME_FORMAT = "%EVENT_START_TRACE_NAME%"; //$NON-NLS-1$ |
|
99 |
|
100 /** |
|
101 * Tag which is replaced by trace text when inserting a trace to source |
|
102 */ |
|
103 String TEXT_FORMAT = "%TEXT%"; //$NON-NLS-1$ |
|
104 |
|
105 /** |
|
106 * Tag which is replaced with the data buffer pointer when formatting |
|
107 * complex traces into the trace header |
|
108 */ |
|
109 String DATA_BUFFER_FORMAT = "%DATA%"; //$NON-NLS-1$ |
|
110 |
|
111 /** |
|
112 * Tag which is replaced with the data buffer length when formatting complex |
|
113 * traces into the trace header |
|
114 */ |
|
115 String DATA_LENGTH_FORMAT = "%LENGTH%"; //$NON-NLS-1$ |
|
116 |
|
117 /** |
|
118 * Comment format which needs to be used. Otherwise the comment before / |
|
119 * after trace configuration will not work |
|
120 */ |
|
121 String COMMENT_FORMAT = " //"; //$NON-NLS-1$ |
|
122 |
|
123 } |
|