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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_pldbg_stats">
<refmeta>
<refentrytitle>pldbg_stats</refentrytitle>
<refmiscinfo>debug</refmiscinfo>
</refmeta>
<refnamediv>
<refname>pldbg_stats</refname>
<refpurpose>Makes an array of line/count information based on current coverage.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_pldbg_stats">
<funcprototype id="fproto_pldbg_stats">
<funcdef>any <function>pldbg_stats</function></funcdef>
<paramdef><optional>in <parameter>name</parameter> varchar</optional></paramdef>
<paramdef><optional>in <parameter>add_line_info</parameter> integer</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_pldbg_stats">
<title>Description</title>
<para>This function is used to make an array of line/count information
based on the current coverage statistics. If the procedure
<computeroutput>name</computeroutput> is given (first param), then the
result will contain only coverage statistic for that procedure. if
the procedure name is not supplied or supplied as NULL then the result
will contain coverage data for all procedures having statistic. The
<computeroutput>add_line_info</computeroutput> flag is used to add code
excerpt on line info.</para>
</refsect1>
<refsect1 id="params_pldbg_stats">
<title>Parameters</title>
<refsect2><title>name</title>
<para>Optional name of procedure for producing selective information.</para>
</refsect2>
<refsect2><title>outdir</title>
<para>Optional flag to control output existence. If this flag is set to
1 then code excerpts will be contained in the output.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_pldbg_stats"><title>Return Types</title>
<para>An array (or vector) is returned containing the line/count information
of the selected coverage data. The format is as follows:</para>
<programlisting><![CDATA[
(
("PRODECURE_NAME" "file_name" <times executed> <total lines> ) -- procedure info
((<line no> <no executed> "<line excerpt>" ) .... ) -- line statistics
(("CALLER PROCEDURE" <counts> ) .... ) -- caller statistics
...
)
]]></programlisting>
</refsect1>
<!--
<refsect1 id="errors_pldbg_stats">
<title>Errors</title>
In case of non-function-specific errors, i.e. only common
parameter errors are signalled, comment out the table below
otherwise add the unique error values as individual errorcodes
<para>This function can generate the following errors:</para>
<errorcode></errorcode>
</refsect1>
<refsect1 id="examples_pldbg_stats">
<title>Examples</title>
<example id="ex_pldbg_stats"><title></title>
<para></para>
<screen><![CDATA[
]]>
</screen>
</example>
</refsect1>
-->
<refsect1 id="seealso_pldbg_stats">
<title>See Also</title>
<para><link linkend="fn_cov_load"><function>cov_load()</function></link></para>
<para><link linkend="fn_cov_store"><function>cov_store()</function></link></para>
<para><link linkend="fn_cov_report"><function>cov_report()</function></link></para>
<para><link linkend="fn_pldbg_stats_load"><function>pldbg_stats_load()</function></link></para>
</refsect1>
</refentry>
|
