-
Notifications
You must be signed in to change notification settings - Fork 8
/
utl_call_stack.sql
790 lines (525 loc) · 17.7 KB
/
utl_call_stack.sql
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
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
CREATE OR REPLACE PACKAGE utl_call_stack IS
/*
Exception: BAD_DEPTH_INDICATOR
This exception is raised when a provided depth is out of bounds.
- Dynamic and lexical depth are positive integer values.
- Error and backtrace depths are non-negative integer values
and are zero only in the absence of an exception.
*/
BAD_DEPTH_INDICATOR EXCEPTION;
pragma EXCEPTION_INIT(BAD_DEPTH_INDICATOR, -64610);
/*
Type: UNIT_QUALIFIED_NAME
This data structure is a varray whose individual elements are, in order,
the unit name, any lexical parents of the subprogram, and the subprogram
name.
For example, consider the following contrived PL/SQL procedure.
> procedure topLevel is
> function localFunction(...) returns varchar2 is
> function innerFunction(...) returns varchar2 is
> begin
> declare
> localVar pls_integer;
> begin
> ... (1)
> end;
> end;
> begin
> ...
> end;
The unit qualified name at (1) would be
> ["topLevel", "localFunction", "innerFunction"]
Note that the block enclosing (1) does not figure in the unit qualified
name.
If the unit were an anonymous block, the unit name would be "__anonymous_block"
*/
TYPE UNIT_QUALIFIED_NAME IS VARRAY(256) OF VARCHAR2(32767);
/*
Function: subprogram
Returns the unit-qualified name of the subprogram at the specified dynamic
depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The unit-qualified name of the subprogram at the specified dynamic depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>
*/
FUNCTION subprogram(dynamic_depth IN PLS_INTEGER) RETURN UNIT_QUALIFIED_NAME;
/*
Function: concatenate_subprogram
Convenience function to concatenate a unit-qualified name, a varray, into
a varchar2 comprising the names in the unit-qualified name, separated by
dots.
Parameters:
qualified_name - A unit-qualified name.
Returns:
A string of the form "UNIT.SUBPROGRAM.SUBPROGRAM...LOCAL_SUBPROGRAM".
*/
FUNCTION concatenate_subprogram(qualified_name IN UNIT_QUALIFIED_NAME)
RETURN VARCHAR2;
/*
Function: owner
Returns the owner name of the unit of the subprogram at the specified
dynamic depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The owner name of the unit of the subprogram at the specified dynamic
depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION owner(dynamic_depth IN PLS_INTEGER) RETURN VARCHAR2;
/*
Function: current_edition
Warning: not implemented. Always returns null.
Returns the current edition name of the unit of the subprogram at the
specified dynamic depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The current edition name of the unit of the subprogram at the specified
dynamic depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION current_edition(dynamic_depth IN PLS_INTEGER) RETURN VARCHAR2;
/*
Function: actual_edition
Returns the name of the edition in which the unit of the subprogram at the
specified dynamic depth is actual.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The name of the edition in which the unit of the subprogram at the
specified dynamic depth is actual.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION actual_edition(dynamic_depth IN PLS_INTEGER) RETURN VARCHAR2;
/*
Function: unit_line
Returns the line number of the unit of the subprogram at the specified
dynamic depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The line number of the unit of the subprogram at the specified dynamic
depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION unit_line(dynamic_depth IN PLS_INTEGER) RETURN PLS_INTEGER;
/*
Function: unit_type
Returns the type of the unit of the subprogram at the specified dynamic
depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The type of the unit of the subprogram at the specified dynamic depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION unit_type(dynamic_depth IN PLS_INTEGER) RETURN VARCHAR2;
/*
Function: dynamic_depth
Returns the number of subprograms on the call stack.
Parameters:
Returns:
The number of subprograms on the call stack.
*/
FUNCTION dynamic_depth RETURN PLS_INTEGER;
/*
Function: lexical_depth
Returns the lexical nesting depth of the subprogram at the specified dynamic
depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The lexical nesting depth of the subprogram at the specified dynamic
depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION lexical_depth(dynamic_depth IN PLS_INTEGER) RETURN PLS_INTEGER;
/*
Function: error_depth
Returns the number of errors on the error stack.
Parameters:
Returns:
The number of errors on the error stack.
*/
FUNCTION error_depth RETURN PLS_INTEGER;
/*
Function: error_number
Returns the error number of the error at the specified error depth.
Parameters:
error_depth - The depth in the error stack.
Returns:
The error number of the error at the specified error depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION error_number(error_depth IN PLS_INTEGER) RETURN PLS_INTEGER;
/*
Function: error_msg
Returns the error message of the error at the specified error depth.
Parameters:
error_depth - The depth in the error stack.
Returns:
The error message of the error at the specified error depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION error_msg(error_depth IN PLS_INTEGER) RETURN VARCHAR2;
/*
Function: backtrace_depth
Returns the number of backtrace items in the backtrace.
Parameters:
Returns:
The number of backtrace items in the backtrace, zero in the absence of
an exception.
*/
FUNCTION backtrace_depth RETURN PLS_INTEGER;
/*
Function: backtrace_unit
Returns the name of the unit at the specified backtrace depth.
Parameters:
backtrace_depth - The depth in the backtrace.
Returns:
The name of the unit at the specified backtrace depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>. Note that backtrace_unit(0); always raises
this exception.
*/
FUNCTION backtrace_unit(backtrace_depth IN PLS_INTEGER) RETURN VARCHAR2;
/*
Function: backtrace_line
Returns the line number of the unit at the specified backtrace depth.
Parameters:
backtrace_depth - The depth in the backtrace.
Returns:
The line number of the unit at the specified backtrace depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>. Note that backtrace_line(0); always raises
this exception.
*/
FUNCTION backtrace_line(backtrace_depth IN PLS_INTEGER) RETURN PLS_INTEGER;
/*
Function: backtrace_subprogram
Returns the unit-qualified name of the subprogram at the specified backtrace
depth.
Parameters:
backtrace_depth - The depth in the backtrace.
Returns:
The unit-qualified name of the subprogram at the specified backtrace depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>. Note that backtrace_line(0); always raises
this exception.
*/
FUNCTION backtrace_subprogram(backtrace_depth IN PLS_INTEGER) RETURN UNIT_QUALIFIED_NAME;
END;
/
CREATE OR REPLACE PACKAGE BODY utl_call_stack IS
CHAR_NEW_LINE constant char := chr( 10 );
FUNCTION get_subprograms( tCallLine in varchar2 ) RETURN UNIT_QUALIFIED_NAME IS
ret UNIT_QUALIFIED_NAME := UNIT_QUALIFIED_NAME();
tmp str_table;
BEGIN
tmp := p_stack.getSubprograms( tCallLine );
ret.extend( tmp.count + 1 );
if p_stack.getProgramType( tCallLine ) = 'ANONYMOUS BLOCK' then
ret( 1 ) := '__anonymous_block';
else
ret( 1 ) := p_stack.getProgram( tCallLine );
end if;
for i in 1 .. tmp.count loop
ret( i + 1 ) := tmp( i );
end loop;
return ret;
END;
PROCEDURE check_dynamic_depth( dynamic_depth in pls_integer ) IS
BEGIN
if dynamic_depth is null or dynamic_depth <= 0 or dynamic_depth > p_stack.getDynamicDepth - 3 then
raise BAD_DEPTH_INDICATOR;
end if;
END;
/*
Function: subprogram
Returns the unit-qualified name of the subprogram at the specified dynamic
depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The unit-qualified name of the subprogram at the specified dynamic depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>
*/
FUNCTION subprogram(dynamic_depth IN PLS_INTEGER) RETURN UNIT_QUALIFIED_NAME IS
BEGIN
check_dynamic_depth( dynamic_depth );
return get_subprograms( p_stack.getCallStack( dynamic_depth + 2 ) );
END;
/*
Function: concatenate_subprogram
Convenience function to concatenate a unit-qualified name, a varray, into
a varchar2 comprising the names in the unit-qualified name, separated by
dots.
Parameters:
qualified_name - A unit-qualified name.
Returns:
A string of the form "UNIT.SUBPROGRAM.SUBPROGRAM...LOCAL_SUBPROGRAM".
*/
FUNCTION concatenate_subprogram(qualified_name IN UNIT_QUALIFIED_NAME)
RETURN VARCHAR2 IS
ret varchar2( 4000 );
idx pls_integer := qualified_name.first;
BEGIN
while idx is not null loop
if ret is not null then
ret := ret || '.';
end if;
ret := ret || qualified_name( idx );
idx := qualified_name.next( idx );
end loop;
return ret;
END;
/*
Function: owner
Returns the owner name of the unit of the subprogram at the specified
dynamic depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The owner name of the unit of the subprogram at the specified dynamic
depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION owner(dynamic_depth IN PLS_INTEGER) RETURN VARCHAR2 IS
BEGIN
check_dynamic_depth( dynamic_depth );
return p_stack.getOwner( p_stack.getCallStack( dynamic_depth + 2 ) );
END;
/*
Function: current_edition
Warning: not implemented. Always returns null.
Returns the current edition name of the unit of the subprogram at the
specified dynamic depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The current edition name of the unit of the subprogram at the specified
dynamic depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION current_edition(dynamic_depth IN PLS_INTEGER) RETURN VARCHAR2 IS
BEGIN
check_dynamic_depth( dynamic_depth );
-- Not implemented.
return '';
END;
/*
Function: actual_edition
Returns the name of the edition in which the unit of the subprogram at the
specified dynamic depth is actual.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The name of the edition in which the unit of the subprogram at the
specified dynamic depth is actual.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION actual_edition(dynamic_depth IN PLS_INTEGER) RETURN VARCHAR2 IS
BEGIN
check_dynamic_depth( dynamic_depth );
-- Not implemented.
return '';
END;
/*
Function: unit_line
Returns the line number of the unit of the subprogram at the specified
dynamic depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The line number of the unit of the subprogram at the specified dynamic
depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION unit_line(dynamic_depth IN PLS_INTEGER) RETURN PLS_INTEGER IS
BEGIN
check_dynamic_depth( dynamic_depth );
return p_stack.getUnitLine( p_stack.getCallStack( dynamic_depth + 2 ) );
END;
/*
Function: unit_type
Returns the type of the unit of the subprogram at the specified dynamic
depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The type of the unit of the subprogram at the specified dynamic depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION unit_type(dynamic_depth IN PLS_INTEGER) RETURN VARCHAR2 IS
BEGIN
check_dynamic_depth( dynamic_depth );
return p_stack.getProgramType( p_stack.getCallStack( dynamic_depth + 2 ) );
END;
/*
Function: dynamic_depth
Returns the number of subprograms on the call stack.
Parameters:
Returns:
The number of subprograms on the call stack.
*/
FUNCTION dynamic_depth RETURN PLS_INTEGER IS
BEGIN
return p_stack.getDynamicDepth - 2;
END;
/*
Function: lexical_depth
Returns the lexical nesting depth of the subprogram at the specified dynamic
depth.
Parameters:
dynamic_depth - The depth in the call stack.
Returns:
The lexical nesting depth of the subprogram at the specified dynamic
depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION lexical_depth(dynamic_depth IN PLS_INTEGER) RETURN PLS_INTEGER IS
BEGIN
check_dynamic_depth( dynamic_depth );
return p_stack.getLexicalDepth( p_stack.getCallStack( dynamic_depth + 2 ) );
END;
PROCEDURE check_error_depth( error_depth in pls_integer ) IS
BEGIN
if error_depth is null or error_depth <= 0 or error_depth > p_stack.getErrorDepth then
raise BAD_DEPTH_INDICATOR;
end if;
END;
/*
Function: error_depth
Returns the number of errors on the error stack.
Parameters:
Returns:
The number of errors on the error stack.
*/
FUNCTION error_depth RETURN PLS_INTEGER IS
BEGIN
return p_stack.getErrorDepth;
END;
/*
Function: error_number
Returns the error number of the error at the specified error depth.
Parameters:
error_depth - The depth in the error stack.
Returns:
The error number of the error at the specified error depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION error_number(error_depth IN PLS_INTEGER) RETURN PLS_INTEGER IS
BEGIN
check_error_depth( error_depth );
return p_stack.getErrorCode( p_stack.getErrorStack( error_depth ) );
END;
/*
Function: error_msg
Returns the error message of the error at the specified error depth.
Parameters:
error_depth - The depth in the error stack.
Returns:
The error message of the error at the specified error depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>.
*/
FUNCTION error_msg(error_depth IN PLS_INTEGER) RETURN VARCHAR2 IS
BEGIN
check_error_depth( error_depth );
return p_stack.getErrorMessage( p_stack.getErrorStack( error_depth ) ) || CHAR_NEW_LINE;
END;
PROCEDURE check_backtrace_depth( backtrace_depth in pls_integer ) IS
BEGIN
if backtrace_depth is null or backtrace_depth <= 0 or backtrace_depth > p_stack.getBacktraceDepth then
raise BAD_DEPTH_INDICATOR;
end if;
END;
/*
Function: backtrace_depth
Returns the number of backtrace items in the backtrace.
Parameters:
Returns:
The number of backtrace items in the backtrace, zero in the absence of
an exception.
*/
FUNCTION backtrace_depth RETURN PLS_INTEGER IS
BEGIN
return p_stack.getBacktraceDepth;
END;
/*
Function: backtrace_unit
Returns the name of the unit at the specified backtrace depth.
Parameters:
backtrace_depth - The depth in the backtrace.
Returns:
The name of the unit at the specified backtrace depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>. Note that backtrace_unit(0); always raises
this exception.
*/
FUNCTION backtrace_unit(backtrace_depth IN PLS_INTEGER) RETURN VARCHAR2 IS
tCallLine varchar2( 4000 );
BEGIN
check_backtrace_depth( backtrace_depth );
tCallLine := p_stack.getBacktraceStack( p_stack.getBacktraceDepth - backtrace_depth + 1 );
if p_stack.getProgramType( tCallLine ) = 'ANONYMOUS BLOCK' then
return p_stack.getOwner( tCallLine ) || '.__anonymous_block';
else
return p_stack.getOwner( tCallLine ) || '.' || p_stack.getProgram( tCallLine );
end if;
END;
/*
Function: backtrace_line
Returns the line number of the unit at the specified backtrace depth.
Parameters:
backtrace_depth - The depth in the backtrace.
Returns:
The line number of the unit at the specified backtrace depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>. Note that backtrace_line(0); always raises
this exception.
*/
FUNCTION backtrace_line(backtrace_depth IN PLS_INTEGER) RETURN PLS_INTEGER IS
BEGIN
check_backtrace_depth( backtrace_depth );
return p_stack.getUnitLine( p_stack.getBacktraceStack( p_stack.getBacktraceDepth - backtrace_depth + 1 ) );
END;
/*
Function: backtrace_subprogram
Returns the unit-qualified name of the subprogram at the specified backtrace
depth.
Parameters:
backtrace_depth - The depth in the backtrace.
Returns:
The unit-qualified name of the subprogram at the specified backtrace depth.
Exception:
Raises <BAD_DEPTH_INDICATOR>. Note that backtrace_line(0); always raises
this exception.
*/
FUNCTION backtrace_subprogram(backtrace_depth IN PLS_INTEGER) RETURN UNIT_QUALIFIED_NAME IS
BEGIN
check_backtrace_depth( backtrace_depth );
return get_subprograms( p_stack.getBacktraceStack( p_stack.getBacktraceDepth - backtrace_depth + 1 ) );
END;
END;
/