summaryrefslogtreecommitdiffabout
path: root/doc/grecs_format_node_path.3
blob: ed687db40d86cb9b07d5fa607c09bde8165e3aaf (plain)
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
.\" This file is part of grecs -*- nroff -*-
.\" Copyright (C) 2007, 2009-2011 Sergey Poznyakoff
.\"
.\" Grecs 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; either version 3, or (at your option)
.\" any later version.
.\"
.\" Grecs 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 Grecs.  If not, see <http://www.gnu.org/licenses/>.
.\"
.TH GRECS_FORMAT_NODE_PATH 3 "May 19, 2011" "GRECS" "Grecs User Reference"
.SH NAME
grecs_format_node_path \- format and output statement pathname for the
node
.SH SYNOPSIS
.nf
.B #include <grecs.h>
.sp
.BI "void grecs_format_node_path(struct grecs_node " "*node" ", int " \
  "flag" ", "
.ti +17
.BI  "struct grecs_format_closure " "*clos" );
.sp
.BI "void grecs_print_node_path(struct grecs_node " "*node" ", int " \
  "flag" ", FILE " "*fp" );
.SH DESCRIPTION
\fBgrecs_format_node_path\fR computes the \fIstatement pathname\fR for
the \fInode\fR, and outputs it using the closure \fIclos\fR.  See
section \fBCLOSURE\fR in
.BR grecs_format_node (3),
for a description of struct grecs_format_closure.
.PP
\fBgrecs_print_node_path\fR is an alternative interface that outputs
the formatted data to the file.
.PP
The \fIflags\fR argument describes what character to use as a pathname
component separator and how to format the statement tag, if \fInode\fR
refers to a block statement.  See
.BR grecs_format_node (3),
for a discussion of available flags.
.SH "RETURN VALUE"
None.
.SH NOTES
This are auxiliary functions used by
.BR grecs_format_node (3)
and
.BR grecs_print_node (3),
correspondingly. They are is seldom needed in user programs.
.SH "SEE ALSO"
.BR grecs_format_node (3),
.BR grecs_stmt_path (5).
.SH AUTHORS
Sergey Poznyakoff
.SH "BUG REPORTS"
Report bugs to <gray+grecs@gnu.org.ua>.
.SH COLOPHON
The \fBGrecs\fR library is constantly changing, so this manual page
may be incorrect or out-of-date.  For the latest copy of \fBGrecs\fR
documentation, visit <http://www.gnu.org.ua/software/grecs>.
.SH COPYRIGHT
Copyright \(co 2011 Sergey Poznyakoff
.br
.na
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
.ad
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.\" Local variables:
.\" eval: (add-hook 'write-file-hooks 'time-stamp)
.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_]* [0-9] \""
.\" time-stamp-format: "%:B %:d, %:y"
.\" time-stamp-end: "\""
.\" time-stamp-line-limit: 20
.\" end:

Return to:

Send suggestions and report system problems to the System administrator.