41
|
1 |
/*
|
|
2 |
* Copyright (c) 2007 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 |
* Access to configuration of TraceCompiler
|
|
17 |
*
|
|
18 |
*/
|
|
19 |
package com.nokia.tracecompiler.engine;
|
|
20 |
|
|
21 |
/**
|
|
22 |
* Access to configuration of TraceCompiler
|
|
23 |
*
|
|
24 |
*/
|
|
25 |
public interface TraceCompilerEngineConfiguration {
|
|
26 |
|
|
27 |
/**
|
|
28 |
* Name of the currently selected source formatter
|
|
29 |
*/
|
|
30 |
public String FORMATTER_NAME = "TraceCompiler.sourceFormatter"; //$NON-NLS-1$
|
|
31 |
|
|
32 |
/**
|
|
33 |
* Environment root
|
|
34 |
*/
|
|
35 |
public String ENVIRONMENT_ROOT = "TraceCompiler.environmentRoot"; //$NON-NLS-1$
|
|
36 |
|
|
37 |
/**
|
|
38 |
* Printf support flag
|
|
39 |
*/
|
|
40 |
public String PRINTF_SUPPORT = "TraceCompiler.printfSupport"; //$NON-NLS-1$
|
|
41 |
|
|
42 |
/**
|
|
43 |
* Printf extension macro
|
|
44 |
*/
|
|
45 |
public String PRINTF_EXTENSION = "TraceCompiler.printfMacro"; //$NON-NLS-1$
|
|
46 |
|
|
47 |
/**
|
|
48 |
* Console UI mode flag
|
|
49 |
*/
|
|
50 |
public String CONSOLE_UI_MODE = "TraceCompiler.consoleUI"; //$NON-NLS-1$
|
|
51 |
|
|
52 |
/**
|
|
53 |
* Flag to show the project files in view
|
|
54 |
*/
|
|
55 |
public boolean SHOW_PROJECT_FILES = false;
|
|
56 |
|
|
57 |
/**
|
|
58 |
* Compiler flag to show hidden parameters in view
|
|
59 |
*/
|
|
60 |
public boolean SHOW_HIDDEN_PARAMETERS_IN_VIEW = false;
|
|
61 |
|
|
62 |
/**
|
|
63 |
* Compiler flag to show location tag in view
|
|
64 |
*/
|
|
65 |
public boolean SHOW_LOCATION_TAG_IN_VIEW = false;
|
|
66 |
|
|
67 |
/**
|
|
68 |
* Assertions events are enabled
|
|
69 |
*/
|
|
70 |
public boolean ASSERTIONS_ENABLED = true;
|
|
71 |
|
|
72 |
/**
|
|
73 |
* Trace location assertions are enabled
|
|
74 |
*/
|
|
75 |
public boolean GLOBAL_LOCATION_ASSERTS = false;
|
|
76 |
|
|
77 |
/**
|
|
78 |
* Traces the view state
|
|
79 |
*/
|
|
80 |
public boolean TRACE_VIEW_STATE = false;
|
|
81 |
|
|
82 |
/**
|
|
83 |
* Allow changes to source formatter
|
|
84 |
*/
|
|
85 |
public boolean ALLOW_FORMAT_CHANGE = false;
|
|
86 |
|
|
87 |
/**
|
|
88 |
* Comment after trace
|
|
89 |
*/
|
|
90 |
public String COMMENT_POSITION_AFTER_TRACE = "before"; //$NON-NLS-1$
|
|
91 |
|
|
92 |
/**
|
|
93 |
* Comment before trace
|
|
94 |
*/
|
|
95 |
public String COMMENT_POSITION_BEFORE_TRACE = "after"; //$NON-NLS-1$
|
|
96 |
|
|
97 |
/**
|
|
98 |
* Flag which determines if the configuration is available
|
|
99 |
*
|
|
100 |
* @return true if available, false if not
|
|
101 |
*/
|
|
102 |
public boolean isAvailable();
|
|
103 |
|
|
104 |
/**
|
|
105 |
* Stores a boolean flag into properties
|
|
106 |
*
|
|
107 |
* @param flagName
|
|
108 |
* name for the flag
|
|
109 |
* @param flag
|
|
110 |
* flag to be stored
|
|
111 |
*/
|
|
112 |
public void setFlag(String flagName, boolean flag);
|
|
113 |
|
|
114 |
/**
|
|
115 |
* Gets a configuration flag based on flag name
|
|
116 |
*
|
|
117 |
* @param flagName
|
|
118 |
* the confiugration flag name
|
|
119 |
* @return the flag value
|
|
120 |
*/
|
|
121 |
public boolean getFlag(String flagName);
|
|
122 |
|
|
123 |
/**
|
|
124 |
* Stores an integer value into properties
|
|
125 |
*
|
|
126 |
* @param valueName
|
|
127 |
* name for the value
|
|
128 |
* @param value
|
|
129 |
* value to be stored
|
|
130 |
*/
|
|
131 |
public void setValue(String valueName, int value);
|
|
132 |
|
|
133 |
/**
|
|
134 |
* Gets a configuration value based on value name
|
|
135 |
*
|
|
136 |
* @param valueName
|
|
137 |
* configuration value name
|
|
138 |
* @return the value
|
|
139 |
*/
|
|
140 |
public int getValue(String valueName);
|
|
141 |
|
|
142 |
/**
|
|
143 |
* Stores text into properties
|
|
144 |
*
|
|
145 |
* @param textName
|
|
146 |
* name for the text
|
|
147 |
* @param text
|
|
148 |
* text to be stored
|
|
149 |
*/
|
|
150 |
public void setText(String textName, String text);
|
|
151 |
|
|
152 |
/**
|
|
153 |
* Gets a text entry based on property name
|
|
154 |
*
|
|
155 |
* @param textName
|
|
156 |
* configuration value name
|
|
157 |
* @return the text
|
|
158 |
*/
|
|
159 |
public String getText(String textName);
|
|
160 |
|
|
161 |
/**
|
|
162 |
* Checks if the given entry exists in configuration.
|
|
163 |
*
|
|
164 |
* @param entryName
|
|
165 |
* the name of the entry
|
|
166 |
* @return true if entry exists, false otherwise
|
|
167 |
*/
|
|
168 |
public boolean hasEntry(String entryName);
|
|
169 |
|
|
170 |
/**
|
|
171 |
* Adds a configuration listener to this configuration
|
|
172 |
*
|
|
173 |
* @param configurationListener
|
|
174 |
* the listener to be added
|
|
175 |
*/
|
|
176 |
public void addConfigurationListener(
|
|
177 |
TraceCompilerEngineConfigurationListener configurationListener);
|
|
178 |
|
|
179 |
/**
|
|
180 |
* Removes an existing configuration listener
|
|
181 |
*
|
|
182 |
* @param configurationListener
|
|
183 |
* the listener to be removed
|
|
184 |
*/
|
|
185 |
public void removeConfigurationListener(
|
|
186 |
TraceCompilerEngineConfigurationListener configurationListener);
|
|
187 |
|
|
188 |
}
|