1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
|
/***************************************************************************
breakpoint.c - breakpoint implementation
-------------------
begin : Fri Nov 2 2001
copyright : (C) 2001 by Keith Isdale
email : k_isdale@tpg.com.au
***************************************************************************/
#include "xsldbg.h"
#include "breakpoint.h"
#include "arraylist.h"
#include "options.h"
extern int xsldbgValidateBreakpoints; /*located in debugXSL.c*/
/*-----------------------------------------------------------
Private functions
-----------------------------------------------------------*/
/**
* lineNoItemNew:
*
* Returns a new hash table for break points
*/
xmlHashTablePtr lineNoItemNew(void);
/**
* lineNoItemFree:
* @item: valid hashtable of break points
*
* Free @item and all its contents
*/
void lineNoItemFree(void *item);
/**
* lineNoItemDelete:
* @breakPointHash: Is valid
* @breakPtr: Is valid
*
* Returns 1 if able to delete @breakPtr from @breakPointHash,
* 0 otherwise
*/
int lineNoItemDelete(xmlHashTablePtr breakPointHash,
breakPointPtr breakPtr);
/**
* lineNoItemAdd:
* @breakPointHash: is valid
* @breakPtr: is valid
*
* Add breakpoint to hash
*
* Returns 1 if able to add @breakPtr to @breakPointHash,
* 0 otherwise
*/
int lineNoItemAdd(xmlHashTablePtr breakPointHash, breakPointPtr breakPtr);
/*-----------------------------------------------------------
Breakpoint debugger functions
-----------------------------------------------------------*/
/* This is our major structure, it is a list of hash tables. Each
hash table has breakpoints with the same line number. A line
number is used as an index into this list to get the right hash table.
Then its just a matter of a simple hash table lookup */
arrayListPtr breakList;
/* keep track of what break point id we're up to*/
int breakPointCounter = 0;
/* What is the current breakpoint is only valid up to the start of
xsldbg command prompt. ie don't use it after deletion of breakpoints */
breakPointPtr activeBreakPointItem = NULL;
/**
* lineNoItemNew:
*
* Returns a new hash table for break points
*/
xmlHashTablePtr
lineNoItemNew(void)
{
xmlHashTablePtr hash;
hash = xmlHashCreate(4);
return hash;
}
/**
* lineNoItemFree:
* @item: valid hashtable of break points
*
* Free @item and all its contents
*/
void
lineNoItemFree(void *item)
{
xmlHashTablePtr hash = (xmlHashTablePtr) item;
if (item) {
#if 0
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Freeing breakpoint line hash"
" with %d elements \n", xmlHashSize(item));
#endif
#endif
xmlHashFree(hash, breakPointItemFree);
}
}
/**
* lineNoItemDelete:
* @breakPointHash: is valid
* @breakPtr: is valid
*
* Returns 1 if able to delete @breakPtr from @breakPointHash,
* 0 otherwise
*/
int
lineNoItemDelete(xmlHashTablePtr breakPointHash, breakPointPtr breakPtr)
{
int result = 0;
if (breakPointHash && breakPtr) {
if (xmlHashRemoveEntry(breakPointHash, breakPtr->url,
breakPointItemFree) == 0){
result = 1;
}else{
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,"lineNoItemDelete failed");
#endif
}
}else {
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext, "lineNoItemDelete failed args %d %d", breakPointHash, breakPtr);
#endif
}
return result;
}
/**
* lineNoItemAdd:
* @breakPointHash: is valid
* @breakPtr: is valid
*
* Returns 1 if able to add @breakPtr to @breakPointHash,
* 0 otherwise
*/
int
lineNoItemAdd(xmlHashTablePtr breakPointHash, breakPointPtr breakPtr)
{
int result = 0;
if (breakPointHash && breakPtr) {
if (xmlHashAddEntry(breakPointHash, breakPtr->url, breakPtr) == 0)
result = 1;
}
return result;
}
/**
* breakPointGetLineNoHash:
* @lineNo: Line number of of breakpoints of interest
*
* Return A hash of breakpoints with same line number
*
* Returns A hash of breakpoints with a line number of @lineNo
*/
xmlHashTablePtr
breakPointGetLineNoHash(long lineNo)
{
if (!breakList) {
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Error: Breakpoints structures not initialized\n");
#endif
return NULL;
} else
return (xmlHashTablePtr) arrayListGet(breakList, lineNo);
}
/**
* breakPointInit:
*
* Returns 1 if breakpoints have been initialized properly and all
* memory required has been obtained,
* 0 otherwise
*/
int
breakPointInit(void)
{
int result = 0;
/* the average file has 395 lines of code so add 100 lines now */
breakList = arrayListNew(100, lineNoItemFree);
if (breakList) {
/*
* We don't need to do any thing else, as its done when we add the
* breakPoints
*/
result = 1;
} else {
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Unable to intialize breakPoints: memory error\n");
#endif
}
return result;
}
/**
* breakPointFree:
*
* Free all memory used by breakPoints
*/
void
breakPointFree(void)
{
if (breakList)
arrayListFree(breakList);
breakList = NULL;
}
/**
* breakPointEmpty:
*
* Empty the break point collection
*
* Returns 1 if able to empty the breakpoint list of its contents,
* 0 otherwise
*/
int
breakPointEmpty(void)
{
return arrayListEmpty(breakList);
}
/**
* breakPointItemNew:
*
* Create a new break point item
* Returns valid break point with default values set if successful,
* NULL otherwise
*/
breakPointPtr
breakPointItemNew(void)
{
breakPointPtr breakPtr = (breakPointPtr) xmlMalloc(sizeof(breakPoint));
if (breakPtr) {
breakPtr->url = NULL;
breakPtr->lineNo = -1;
breakPtr->templateName = NULL;
breakPtr->modeName = NULL;
breakPtr->flags = BREAKPOINT_ENABLED;
breakPtr->id = ++breakPointCounter;
breakPtr->type = DEBUG_BREAK_SOURCE;
}
return breakPtr;
}
/**
* breakPointItemFree:
* @payload: valid breakPointPtr
* @name: not used
*
* Free memory associated with this break point
*/
void
breakPointItemFree(void *payload, xmlChar * name)
{
Q_UNUSED(name);
if (payload) {
breakPointPtr breakPtr = (breakPointPtr) payload;
if (breakPtr->url)
xmlFree(breakPtr->url);
if (breakPtr->templateName)
xmlFree(breakPtr->templateName);
if (breakPtr->modeName)
xmlFree(breakPtr->modeName);
xmlFree(breakPtr);
}
}
/**
* breakPointActiveBreakPoint:
*
* Get the active break point
*
* Returns The last break point that we stoped at
*
* Depreciated
*/
breakPointPtr
breakPointActiveBreakPoint(void)
{
/* This function is depreciated */
return NULL; /* activeBreakPointItem; */
}
/**
* breakPointSetActiveBreakPoint:
* @breakPtr: Is valid break point or NULL
*
* Set the active break point
*
* Depreciated
*/
void
breakPointSetActiveBreakPoint(breakPointPtr breakPtr)
{
Q_UNUSED(breakPtr);
/*
* activeBreakPointItem = breakPtr;
*/
}
/**
* breakPointAdd:
* @url: Non-null, non-empty file name that has been loaded by
* debugger
* @lineNumber: @lineNumber >= 0 and is available in url specified and
* points to an xml element
* @templateName: The template name of breakPoint or NULL
* @modeName : The mode of breakpoint or NULL
* @type: Valid BreakPointTypeEnum
*
* Add break point at file and line number specified
*
* Returns 1 if successful,
* 0 otherwise
*/
int
breakPointAdd(const xmlChar * url, long lineNumber,
const xmlChar * templateName,
const xmlChar * modeName,
BreakPointTypeEnum type)
{
int result = 0, breakPointType = type;
xmlHashTablePtr breakPointHash = NULL; /* hash of breakPoints */
breakPointPtr breakPtr;
if (!breakList) {
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Error: Breakpoints structures not initialized\n");
#endif
return result;
}
if (!url || (lineNumber == -1)) {
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Error: Invalid url or line number to breakPointAdd\n");
#endif
return result;
}
/* if breakpoint already exists then don;t add it */
if (breakPointIsPresent(url, lineNumber)) {
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Warning: Breakpoint at file %s: line %d exists\n",
url, lineNumber);
#endif
return result;
}
breakPtr = breakPointItemNew();
if (breakPtr) {
breakPtr->url = (xmlChar *) xmlMemStrdup((char *) url);
breakPtr->lineNo = lineNumber;
if (templateName)
breakPtr->templateName =
xmlStrdup( templateName);
else
breakPtr->templateName = NULL;
if (modeName)
breakPtr->modeName =
xmlStrdup(modeName);
else
breakPtr->modeName = NULL;
breakPtr->type = BreakPointTypeEnum(breakPointType);
/* add new breakPoint to the right hash table */
breakPointHash = breakPointGetLineNoHash(lineNumber);
if (breakPointHash) {
result = lineNoItemAdd(breakPointHash, breakPtr);
} else {
/* Grow breakList size */
int lineIndex;
int newEntries = breakList->count;
xmlHashTablePtr hash;
result = 1;
if ((lineNumber < breakList->count) && breakList->count) {
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Error: Unable to find breakpoint line hash at %d\n",
lineNumber);
#endif
} else {
if (breakList->count + newEntries < lineNumber)
newEntries = lineNumber - breakList->count + 1;
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
/*
* xsltGenericError(xsltGenericErrorContext,
* "Size of line list was %d adding %d entries\n",
* breakList->count, newEntries);
*/
#endif
lineIndex = 0;
while ((lineIndex < newEntries) && result) {
hash = lineNoItemNew();
if (hash) {
result = result && arrayListAdd(breakList, hash);
} else {
result = 0;
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Error: Unable to create hash table breakPoint list: memory error\n");
#endif
return result;
}
lineIndex++;
}
/* find the newly added hashtable of breakpoints */
breakPointHash = breakPointGetLineNoHash(lineNumber);
if (breakPointHash) {
result = lineNoItemAdd(breakPointHash, breakPtr);
} else {
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Error: Unable to create new breakPoint:interal error\n");
#endif
return result;
}
}
}
} else {
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Error: Unable to create new breakPoint: memory error\n");
#endif
}
if (result && (optionsGetIntOption(OPTIONS_GDB) > 1) &&
(xsldbgValidateBreakpoints != BREAKPOINTS_BEING_VALIDATED)){
breakPointPrint(breakPtr);
xsldbgGenericErrorFunc("\n");
}
return result;
}
/**
* breakPointDelete:
* @breakPtr: Is valid
*
* Delete the break point specified if it can be found using
* @breakPoint's url and lineNo
*
* Returns 1 if successful,
* 0 otherwise
*/
int
breakPointDelete(breakPointPtr breakPtr)
{
int result = 0;
xmlHashTablePtr breakPointHash; /* hash of breakPoints */
if (!breakPtr)
return result;
breakPointHash = breakPointGetLineNoHash(breakPtr->lineNo);
if (breakPointHash) {
result = lineNoItemDelete(breakPointHash, breakPtr);
} else {
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Error: Breakpoint not found: xslDeleteBreakPoint\n");
#endif
}
return result;
}
/**
* breakPointEnable:
* @breakPtr: A valid breakpoint
* @enable: Enable break point if 1, disable if 0, toggle if -1
*
* Enable or disable a break point
*
* Returns 1 if successful,
* 0 otherwise
*/
int
breakPointEnable(breakPointPtr breakPtr, int enable)
{
int result = 0;
if (breakPtr) {
int enableFlag = 1;
if (enable != XSL_TOGGLE_BREAKPOINT){
enableFlag = enable;
}else {
if (breakPtr->flags & BREAKPOINT_ENABLED)
enableFlag = 0;
}
if (enableFlag)
breakPtr->flags |= BREAKPOINT_ENABLED;
else
breakPtr->flags = breakPtr->flags & (BREAKPOINT_ALLFLAGS ^ BREAKPOINT_ENABLED);
result = 1;
}
return result;
}
/**
* breakPointLinesCount:
*
* Return the number of hash tables of break points with the same line number
*
* Returns The number of hash tables of break points with the same line number
*/
int
breakPointLinesCount(void)
{
if (!breakList) {
#ifdef WITH_XSLDBG_DEBUG_BREAKPOINTS
xsltGenericError(xsltGenericErrorContext,
"Error: Breakpoints structures not initialized\n");
#endif
return 0;
} else
return arrayListCount(breakList);
}
/**
* breakPointLinesList:
*
* Returns The list of hash tables for break points
* Dangerous function to use!!
*/
arrayListPtr
breakPointLineList(void)
{
return breakList;
}
/**
* breakPointGet:
* @url: Non-null, non-empty file name that has been loaded by
* debugger
* @lineNumber: lineNumber >= 0 and is available in @url
*
* Get a break point for the breakpoint collection
*
* Returns break point if break point exists at location specified,
* NULL otherwise
*/
breakPointPtr
breakPointGet(const xmlChar * url, long lineNumber)
{
xmlHashTablePtr breakHash = breakPointGetLineNoHash(lineNumber);
breakPointPtr breakPtr = NULL;
if (!breakHash || !url)
return breakPtr;
breakPtr = (breakPointPtr)xmlHashLookup(breakHash, url);
return breakPtr;
}
/**
* breakPointPrint:
* @breakPtr: A valid break point
*
* Print the details of @breakPtr
*
* Returns 1 if successful,
* 0 otherwise
*/
int
breakPointPrint(breakPointPtr breakPtr)
{
int result = 0;
const char *breakStatusText[2] = {
I18N_NOOP("disabled"),
I18N_NOOP("enabled")
};
const char *breakTemplate="";
const char *breakMode = "";
const char *breakStatus;
if (!breakPtr)
return result;
if (breakPtr->templateName){
if (breakPtr->modeName)
breakMode = (const char*)breakPtr->modeName;
breakTemplate = (const char*)breakPtr->templateName;
}
breakStatus = breakStatusText[breakPtr->flags & BREAKPOINT_ENABLED];
if (breakPtr->url)
xsldbgGenericErrorFunc(i18n("Breakpoint %1 %2 for template: \"%3\" mode: \"%4\" in file \"%5\" at line %6").tqarg(breakPtr->id).tqarg(i18n(breakStatus)).tqarg(xsldbgText(breakTemplate)).tqarg(xsldbgText(breakMode)).tqarg(xsldbgUrl(breakPtr->url)).tqarg(breakPtr->lineNo));
else
xsldbgGenericErrorFunc(i18n("Breakpoint %1 %2 for template: \"%3\" mode: \"%4\"").tqarg(breakPtr->id).tqarg(i18n(breakStatus)).tqarg(xsldbgText(breakTemplate)).tqarg(xsldbgText(breakMode)));
return ++result;
}
/**
* breakPointIsPresent:
* @url: Non-null, non-empty file name that has been loaded by
* debugger
* @lineNumber: @lineNumber >= 0 and is available in @url
*
* Determine if there is a break point at file and line number specified
*
* Returns 1 if successful,
* 0 otherwise
*/
int
breakPointIsPresent(const xmlChar * url, long lineNumber)
{
int result = 0;
if (!url || (lineNumber == -1))
return result;
result = (breakPointGet(url, lineNumber) != NULL);
return result;
}
/**
* breakPointIsPresentNode:
* @node: node != NULL
*
* Determine if a node is a break point
*
* Returns 1 on success,
* 0 otherwise
*/
int
breakPointIsPresentNode(xmlNodePtr node)
{
int result = 0;
if (!node || !node->doc)
return result;
if (xmlGetLineNo(node) == -1)
return result;
if (node->doc->URL) {
result = breakPointIsPresent(node->doc->URL, xmlGetLineNo(node));
}
return result;
}
|