aboutsummaryrefslogtreecommitdiff
path: root/doc/grecs_format_node_path.3
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2011-05-19 09:49:20 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2011-05-19 09:49:20 +0300
commit304935a296997c9781688f08693ef70180dd24e4 (patch)
tree7b7801f3a97a780af1719826b2b9ef471151a352 /doc/grecs_format_node_path.3
parent6ef143bd53c35635b6d7edc6410d45fa58f54da2 (diff)
downloadgrecs-304935a296997c9781688f08693ef70180dd24e4.tar.gz
grecs-304935a296997c9781688f08693ef70180dd24e4.tar.bz2
Reimplement grecs_format_ familiy as output-independent functions.
* src/format.c (grecs_format_docstring): Rename to grecs_print_docstring. (grecs_format_simple_statement): Rename to grecs_print_simple_statement. (grecs_format_block_statement): Rename to grecs_print_block_statement. (grecs_format_statement_array): Rename to grecs_print_statement_array. (grecs_format_locus): Rename to grecs_print_locus. (grecs_format_node_path): Rename to grecs_print_node_path. (grecs_format_value): Rename to grecs_print_value. (grecs_format_node): Rename to grecs_print_node. (grecs_format_locus,grecs_format_node_path) (grecs_format_value,grecs_format_node): Reimplement as output-independent functions. All uses changed. * src/grecs.h: Update prototypes. * doc/grecs_format_locus.3: Update. * doc/grecs_format_node.3: Update. * doc/grecs_format_node_path.3: Update. * doc/grecs_format_value.3: Update.
Diffstat (limited to 'doc/grecs_format_node_path.3')
-rw-r--r--doc/grecs_format_node_path.323
1 files changed, 18 insertions, 5 deletions
diff --git a/doc/grecs_format_node_path.3 b/doc/grecs_format_node_path.3
index bf119e7..ed687db 100644
--- a/doc/grecs_format_node_path.3
+++ b/doc/grecs_format_node_path.3
@@ -14,7 +14,7 @@
.\" 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 4, 2011" "GRECS" "Grecs User Reference"
+.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
@@ -23,10 +23,21 @@ node
.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 to the file \fBfp\fR.
+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
@@ -36,9 +47,11 @@ for a discussion of available flags.
.SH "RETURN VALUE"
None.
.SH NOTES
-This is an auxiliary function used by
-.BR grecs_format_node (3).
-It is seldom needed in user programs.
+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).

Return to:

Send suggestions and report system problems to the System administrator.