[deliverable/titan.core.git] / core / TitanLoggerControl.ttcn

/******************************************************************************
 * Copyright (c) 2000-2016 Ericsson Telecom AB
 * 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:
 *   Balasko, Jeno
 *   Raduly, Csaba
 *
 ******************************************************************************/
module TitanLoggerControl {
/*
This module allows modification of logger parameters during run-time.
The module defines a number of external functions which can be called from TTCN-3 code.
The implementation of these external funtions is built into the TITAN runtime.

This module needs to be included in the project; linking of the runtime is automatic.
*/

external function set_log_file(in charstring plugin, in charstring filename);

external function set_log_entity_name(in charstring plugin, in boolean b);

external function get_log_entity_name(in charstring plugin) return boolean;

type enumerated verbosity
{
  compact,
  full
};

external function set_matching_verbosity(in charstring plugin, in verbosity v);

external function get_matching_verbosity(in charstring plugin) return verbosity;

type enumerated Severity // copy-paste from Logger.hh
{
    NOTHING_TO_LOG(0), // for compatibility

    ACTION_UNQUALIFIED,

    DEFAULTOP_ACTIVATE,
    DEFAULTOP_DEACTIVATE,
    DEFAULTOP_EXIT,
    DEFAULTOP_UNQUALIFIED,

    ERROR_UNQUALIFIED,

    EXECUTOR_RUNTIME,
    EXECUTOR_CONFIGDATA,
    EXECUTOR_EXTCOMMAND,
    EXECUTOR_COMPONENT,
    EXECUTOR_LOGOPTIONS,
    EXECUTOR_UNQUALIFIED,

    FUNCTION_RND,
    FUNCTION_UNQUALIFIED,

    PARALLEL_PTC,
    PARALLEL_PORTCONN,
    PARALLEL_PORTMAP,
    PARALLEL_UNQUALIFIED,

    TESTCASE_START,
    TESTCASE_FINISH,
    TESTCASE_UNQUALIFIED,

    PORTEVENT_PQUEUE,
    PORTEVENT_MQUEUE,
    PORTEVENT_STATE,
    PORTEVENT_PMIN,
    PORTEVENT_PMOUT,
    PORTEVENT_PCIN,
    PORTEVENT_PCOUT,
    PORTEVENT_MMRECV,
    PORTEVENT_MMSEND,
    PORTEVENT_MCRECV,
    PORTEVENT_MCSEND,
    PORTEVENT_DUALRECV,
    PORTEVENT_DUALSEND,
    PORTEVENT_UNQUALIFIED,

    STATISTICS_VERDICT,
    STATISTICS_UNQUALIFIED,

    TIMEROP_READ,
    TIMEROP_START,
    TIMEROP_GUARD,
    TIMEROP_STOP,
    TIMEROP_TIMEOUT,
    TIMEROP_UNQUALIFIED,

    USER_UNQUALIFIED,

    VERDICTOP_GETVERDICT,
    VERDICTOP_SETVERDICT,
    VERDICTOP_FINAL,
    VERDICTOP_UNQUALIFIED,

    WARNING_UNQUALIFIED,

    // MATCHING and DEBUG should be at the end (not included in LOG_ALL)
    MATCHING_DONE,
    MATCHING_TIMEOUT,
    MATCHING_PCSUCCESS,
    MATCHING_PCUNSUCC,
    MATCHING_PMSUCCESS,
    MATCHING_PMUNSUCC,
    MATCHING_MCSUCCESS,
    MATCHING_MCUNSUCC,
    MATCHING_MMSUCCESS,
    MATCHING_MMUNSUCC,
    MATCHING_PROBLEM,
    MATCHING_UNQUALIFIED,

    DEBUG_ENCDEC,
    DEBUG_TESTPORT,
    DEBUG_UNQUALIFIED
};

type record of Severity Severities;

const Severities log_nothing    := {};

const Severities log_console_default :=
{
    ACTION_UNQUALIFIED,

    ERROR_UNQUALIFIED,

    TESTCASE_START, TESTCASE_FINISH, TESTCASE_UNQUALIFIED,

    STATISTICS_VERDICT, STATISTICS_UNQUALIFIED,
/*
    TIMEROP_READ, TIMEROP_START, TIMEROP_GUARD, TIMEROP_STOP, TIMEROP_TIMEOUT,
    TIMEROP_UNQUALIFIED,

    USER_UNQUALIFIED,

    VERDICTOP_GETVERDICT, VERDICTOP_SETVERDICT, VERDICTOP_FINAL, VERDICTOP_UNQUALIFIED,
*/
    WARNING_UNQUALIFIED
};

const Severities log_all :=
{
    ACTION_UNQUALIFIED,

    DEFAULTOP_ACTIVATE, DEFAULTOP_DEACTIVATE, DEFAULTOP_EXIT, DEFAULTOP_UNQUALIFIED,

    ERROR_UNQUALIFIED,

    EXECUTOR_RUNTIME, EXECUTOR_CONFIGDATA, EXECUTOR_EXTCOMMAND, EXECUTOR_COMPONENT,
    EXECUTOR_LOGOPTIONS, EXECUTOR_UNQUALIFIED,

    FUNCTION_RND, FUNCTION_UNQUALIFIED,

    PARALLEL_PTC, PARALLEL_PORTCONN, PARALLEL_PORTMAP, PARALLEL_UNQUALIFIED,

    TESTCASE_START, TESTCASE_FINISH, TESTCASE_UNQUALIFIED,

    PORTEVENT_PQUEUE, PORTEVENT_MQUEUE, PORTEVENT_STATE,
    PORTEVENT_PMIN, PORTEVENT_PMOUT, PORTEVENT_PCIN, PORTEVENT_PCOUT,
    PORTEVENT_MMRECV, PORTEVENT_MMSEND, PORTEVENT_MCRECV, PORTEVENT_MCSEND,
    PORTEVENT_DUALRECV, PORTEVENT_DUALSEND, PORTEVENT_UNQUALIFIED,

    STATISTICS_VERDICT, STATISTICS_UNQUALIFIED,

    TIMEROP_READ, TIMEROP_START, TIMEROP_GUARD, TIMEROP_STOP, TIMEROP_TIMEOUT,
    TIMEROP_UNQUALIFIED,

    USER_UNQUALIFIED,

    VERDICTOP_GETVERDICT, VERDICTOP_SETVERDICT, VERDICTOP_FINAL, VERDICTOP_UNQUALIFIED,

    WARNING_UNQUALIFIED
};

const Severities log_everything :=
{
    ACTION_UNQUALIFIED,

    DEFAULTOP_ACTIVATE, DEFAULTOP_DEACTIVATE, DEFAULTOP_EXIT, DEFAULTOP_UNQUALIFIED,

    ERROR_UNQUALIFIED,

    EXECUTOR_RUNTIME, EXECUTOR_CONFIGDATA, EXECUTOR_EXTCOMMAND, EXECUTOR_COMPONENT,
    EXECUTOR_LOGOPTIONS, EXECUTOR_UNQUALIFIED,

    FUNCTION_RND, FUNCTION_UNQUALIFIED,

    PARALLEL_PTC, PARALLEL_PORTCONN, PARALLEL_PORTMAP, PARALLEL_UNQUALIFIED,

    TESTCASE_START, TESTCASE_FINISH, TESTCASE_UNQUALIFIED,

    PORTEVENT_PQUEUE, PORTEVENT_MQUEUE, PORTEVENT_STATE,
    PORTEVENT_PMIN, PORTEVENT_PMOUT, PORTEVENT_PCIN, PORTEVENT_PCOUT,
    PORTEVENT_MMRECV, PORTEVENT_MMSEND, PORTEVENT_MCRECV, PORTEVENT_MCSEND,
    PORTEVENT_DUALRECV, PORTEVENT_DUALSEND, PORTEVENT_UNQUALIFIED,

    STATISTICS_VERDICT, STATISTICS_UNQUALIFIED,

    TIMEROP_READ, TIMEROP_START, TIMEROP_GUARD, TIMEROP_STOP, TIMEROP_TIMEOUT,
    TIMEROP_UNQUALIFIED,

    USER_UNQUALIFIED,

    VERDICTOP_GETVERDICT, VERDICTOP_SETVERDICT, VERDICTOP_FINAL, VERDICTOP_UNQUALIFIED,

    WARNING_UNQUALIFIED,

    // MATCHING and DEBUG should be at the end (not included in LOG_ALL)
    MATCHING_DONE,      MATCHING_TIMEOUT,
    MATCHING_PCSUCCESS, MATCHING_PCUNSUCC,
    MATCHING_PMSUCCESS, MATCHING_PMUNSUCC,
    MATCHING_MCSUCCESS, MATCHING_MCUNSUCC,
    MATCHING_MMSUCCESS, MATCHING_MMUNSUCC,
    MATCHING_PROBLEM,   MATCHING_UNQUALIFIED,

    DEBUG_ENCDEC, DEBUG_TESTPORT, DEBUG_UNQUALIFIED
};


// getters
external function get_console_mask(in charstring plugin) return Severities;
external function get_file_mask   (in charstring plugin) return Severities;

// setters
external function set_console_mask(in charstring plugin, in Severities s);
external function set_file_mask   (in charstring plugin, in Severities s);

// additive
external function add_to_console_mask(in charstring plugin, in Severities s);
external function add_to_file_mask   (in charstring plugin, in Severities s);

// subtractive
external function remove_from_console_mask(in charstring plugin, in Severities s);
external function remove_from_file_mask   (in charstring plugin, in Severities s);


}  // end of module
Commit	Line	Data
970ed795	1	/******************************************************************************
d44e3c4f	2	* Copyright (c) 2000-2016 Ericsson Telecom AB
970ed795 EL	3	* All rights reserved. This program and the accompanying materials
	4	* are made available under the terms of the Eclipse Public License v1.0
	5	* which accompanies this distribution, and is available at
	6	* http://www.eclipse.org/legal/epl-v10.html
d44e3c4f	7	*
	8	* Contributors:
	9	* Balasko, Jeno
	10	* Raduly, Csaba
	11	*
970ed795 EL	12	******************************************************************************/
	13	module TitanLoggerControl {
	14	/*
	15	This module allows modification of logger parameters during run-time.
	16	The module defines a number of external functions which can be called from TTCN-3 code.
	17	The implementation of these external funtions is built into the TITAN runtime.
	18
	19	This module needs to be included in the project; linking of the runtime is automatic.
	20	*/
	21
	22	external function set_log_file(in charstring plugin, in charstring filename);
	23
	24	external function set_log_entity_name(in charstring plugin, in boolean b);
	25
	26	external function get_log_entity_name(in charstring plugin) return boolean;
	27
	28	type enumerated verbosity
	29	{
	30	compact,
	31	full
	32	};
	33
	34	external function set_matching_verbosity(in charstring plugin, in verbosity v);
	35
	36	external function get_matching_verbosity(in charstring plugin) return verbosity;
	37
	38	type enumerated Severity // copy-paste from Logger.hh
	39	{
	40	NOTHING_TO_LOG(0), // for compatibility
	41
	42	ACTION_UNQUALIFIED,
	43
	44	DEFAULTOP_ACTIVATE,
	45	DEFAULTOP_DEACTIVATE,
	46	DEFAULTOP_EXIT,
	47	DEFAULTOP_UNQUALIFIED,
	48
	49	ERROR_UNQUALIFIED,
	50
	51	EXECUTOR_RUNTIME,
	52	EXECUTOR_CONFIGDATA,
	53	EXECUTOR_EXTCOMMAND,
	54	EXECUTOR_COMPONENT,
	55	EXECUTOR_LOGOPTIONS,
	56	EXECUTOR_UNQUALIFIED,
	57
	58	FUNCTION_RND,
	59	FUNCTION_UNQUALIFIED,
	60
	61	PARALLEL_PTC,
	62	PARALLEL_PORTCONN,
	63	PARALLEL_PORTMAP,
	64	PARALLEL_UNQUALIFIED,
	65
	66	TESTCASE_START,
	67	TESTCASE_FINISH,
	68	TESTCASE_UNQUALIFIED,
	69
	70	PORTEVENT_PQUEUE,
	71	PORTEVENT_MQUEUE,
	72	PORTEVENT_STATE,
	73	PORTEVENT_PMIN,
	74	PORTEVENT_PMOUT,
	75	PORTEVENT_PCIN,
76	PORTEVENT_PCOUT,
77	PORTEVENT_MMRECV,
78	PORTEVENT_MMSEND,
79	PORTEVENT_MCRECV,
80	PORTEVENT_MCSEND,
81	PORTEVENT_DUALRECV,
82	PORTEVENT_DUALSEND,
83	PORTEVENT_UNQUALIFIED,
84
85	STATISTICS_VERDICT,
86	STATISTICS_UNQUALIFIED,
87
88	TIMEROP_READ,
89	TIMEROP_START,
90	TIMEROP_GUARD,
91	TIMEROP_STOP,
92	TIMEROP_TIMEOUT,
93	TIMEROP_UNQUALIFIED,
94
95	USER_UNQUALIFIED,
96
97	VERDICTOP_GETVERDICT,
98	VERDICTOP_SETVERDICT,
99	VERDICTOP_FINAL,
100	VERDICTOP_UNQUALIFIED,
101
102	WARNING_UNQUALIFIED,
103
104	// MATCHING and DEBUG should be at the end (not included in LOG_ALL)
105	MATCHING_DONE,
106	MATCHING_TIMEOUT,
107	MATCHING_PCSUCCESS,
108	MATCHING_PCUNSUCC,
109	MATCHING_PMSUCCESS,
110	MATCHING_PMUNSUCC,
111	MATCHING_MCSUCCESS,
112	MATCHING_MCUNSUCC,
113	MATCHING_MMSUCCESS,
114	MATCHING_MMUNSUCC,
115	MATCHING_PROBLEM,
116	MATCHING_UNQUALIFIED,
117
118	DEBUG_ENCDEC,
119	DEBUG_TESTPORT,
120	DEBUG_UNQUALIFIED
121	};
122
123	type record of Severity Severities;
124
125	const Severities log_nothing := {};
126
127	const Severities log_console_default :=
128	{
129	ACTION_UNQUALIFIED,
130
131	ERROR_UNQUALIFIED,
132
133	TESTCASE_START, TESTCASE_FINISH, TESTCASE_UNQUALIFIED,
134
135	STATISTICS_VERDICT, STATISTICS_UNQUALIFIED,
136	/*
137	TIMEROP_READ, TIMEROP_START, TIMEROP_GUARD, TIMEROP_STOP, TIMEROP_TIMEOUT,
138	TIMEROP_UNQUALIFIED,
139
140	USER_UNQUALIFIED,
141
142	VERDICTOP_GETVERDICT, VERDICTOP_SETVERDICT, VERDICTOP_FINAL, VERDICTOP_UNQUALIFIED,
143	*/
144	WARNING_UNQUALIFIED
145	};
146
147	const Severities log_all :=
148	{
149	ACTION_UNQUALIFIED,
150
151	DEFAULTOP_ACTIVATE, DEFAULTOP_DEACTIVATE, DEFAULTOP_EXIT, DEFAULTOP_UNQUALIFIED,
152
153	ERROR_UNQUALIFIED,
154
155	EXECUTOR_RUNTIME, EXECUTOR_CONFIGDATA, EXECUTOR_EXTCOMMAND, EXECUTOR_COMPONENT,
156	EXECUTOR_LOGOPTIONS, EXECUTOR_UNQUALIFIED,
157
158	FUNCTION_RND, FUNCTION_UNQUALIFIED,
159
160	PARALLEL_PTC, PARALLEL_PORTCONN, PARALLEL_PORTMAP, PARALLEL_UNQUALIFIED,
161
162	TESTCASE_START, TESTCASE_FINISH, TESTCASE_UNQUALIFIED,
163
164	PORTEVENT_PQUEUE, PORTEVENT_MQUEUE, PORTEVENT_STATE,
165	PORTEVENT_PMIN, PORTEVENT_PMOUT, PORTEVENT_PCIN, PORTEVENT_PCOUT,
166	PORTEVENT_MMRECV, PORTEVENT_MMSEND, PORTEVENT_MCRECV, PORTEVENT_MCSEND,
167	PORTEVENT_DUALRECV, PORTEVENT_DUALSEND, PORTEVENT_UNQUALIFIED,
168
169	STATISTICS_VERDICT, STATISTICS_UNQUALIFIED,
170
171	TIMEROP_READ, TIMEROP_START, TIMEROP_GUARD, TIMEROP_STOP, TIMEROP_TIMEOUT,
172	TIMEROP_UNQUALIFIED,
173
174	USER_UNQUALIFIED,
175
176	VERDICTOP_GETVERDICT, VERDICTOP_SETVERDICT, VERDICTOP_FINAL, VERDICTOP_UNQUALIFIED,
177
178	WARNING_UNQUALIFIED
179	};
180
181	const Severities log_everything :=
182	{
183	ACTION_UNQUALIFIED,
184
185	DEFAULTOP_ACTIVATE, DEFAULTOP_DEACTIVATE, DEFAULTOP_EXIT, DEFAULTOP_UNQUALIFIED,
186
187	ERROR_UNQUALIFIED,
188
189	EXECUTOR_RUNTIME, EXECUTOR_CONFIGDATA, EXECUTOR_EXTCOMMAND, EXECUTOR_COMPONENT,
190	EXECUTOR_LOGOPTIONS, EXECUTOR_UNQUALIFIED,
191
192	FUNCTION_RND, FUNCTION_UNQUALIFIED,
193
194	PARALLEL_PTC, PARALLEL_PORTCONN, PARALLEL_PORTMAP, PARALLEL_UNQUALIFIED,
195
196	TESTCASE_START, TESTCASE_FINISH, TESTCASE_UNQUALIFIED,
197
198	PORTEVENT_PQUEUE, PORTEVENT_MQUEUE, PORTEVENT_STATE,
199	PORTEVENT_PMIN, PORTEVENT_PMOUT, PORTEVENT_PCIN, PORTEVENT_PCOUT,
200	PORTEVENT_MMRECV, PORTEVENT_MMSEND, PORTEVENT_MCRECV, PORTEVENT_MCSEND,
201	PORTEVENT_DUALRECV, PORTEVENT_DUALSEND, PORTEVENT_UNQUALIFIED,
202
203	STATISTICS_VERDICT, STATISTICS_UNQUALIFIED,
204
205	TIMEROP_READ, TIMEROP_START, TIMEROP_GUARD, TIMEROP_STOP, TIMEROP_TIMEOUT,
206	TIMEROP_UNQUALIFIED,
207
208	USER_UNQUALIFIED,
209
210	VERDICTOP_GETVERDICT, VERDICTOP_SETVERDICT, VERDICTOP_FINAL, VERDICTOP_UNQUALIFIED,
211
212	WARNING_UNQUALIFIED,
213
214	// MATCHING and DEBUG should be at the end (not included in LOG_ALL)
215	MATCHING_DONE, MATCHING_TIMEOUT,
216	MATCHING_PCSUCCESS, MATCHING_PCUNSUCC,
217	MATCHING_PMSUCCESS, MATCHING_PMUNSUCC,
218	MATCHING_MCSUCCESS, MATCHING_MCUNSUCC,
219	MATCHING_MMSUCCESS, MATCHING_MMUNSUCC,
220	MATCHING_PROBLEM, MATCHING_UNQUALIFIED,
221
222	DEBUG_ENCDEC, DEBUG_TESTPORT, DEBUG_UNQUALIFIED
223	};
224
225
226	// getters
227	external function get_console_mask(in charstring plugin) return Severities;
228	external function get_file_mask (in charstring plugin) return Severities;
229
230	// setters
231	external function set_console_mask(in charstring plugin, in Severities s);
232	external function set_file_mask (in charstring plugin, in Severities s);
233
234	// additive
235	external function add_to_console_mask(in charstring plugin, in Severities s);
236	external function add_to_file_mask (in charstring plugin, in Severities s);
237
238	// subtractive
239	external function remove_from_console_mask(in charstring plugin, in Severities s);
240	external function remove_from_file_mask (in charstring plugin, in Severities s);
241
242
243	} // end of module