83 lines
2.2 KiB
Groff
83 lines
2.2 KiB
Groff
.\"
|
|
.\" libdivecomputer
|
|
.\"
|
|
.\" Copyright (C) 2017 Kristaps Dzonsons <kristaps@bsd.lv>
|
|
.\"
|
|
.\" This library is free software; you can redistribute it and/or
|
|
.\" modify it under the terms of the GNU Lesser General Public
|
|
.\" License as published by the Free Software Foundation; either
|
|
.\" version 2.1 of the License, or (at your option) any later version.
|
|
.\"
|
|
.\" This library 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
|
|
.\" Lesser General Public License for more details.
|
|
.\"
|
|
.\" You should have received a copy of the GNU Lesser General Public
|
|
.\" License along with this library; if not, write to the Free Software
|
|
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
.\" MA 02110-1301 USA
|
|
.\"
|
|
.Dd January 5, 2017
|
|
.Dt DC_PARSER_NEW 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm dc_parser_new ,
|
|
.Nm dc_parser_new2
|
|
.Nd create a parser for a single dive
|
|
.Sh LIBRARY
|
|
.Lb libdivecomputer
|
|
.Sh SYNOPSIS
|
|
.In libdivecomputer/parser.h
|
|
.Ft dc_status_t
|
|
.Fo dc_parser_new
|
|
.Fa "dc_parser_t **parser"
|
|
.Fa "dc_device_t *device"
|
|
.Fc
|
|
.Ft dc_status_t
|
|
.Fo dc_parser_new2
|
|
.Fa "dc_parser_t **parser"
|
|
.Fa "dc_context_t *context"
|
|
.Fa "dc_descriptor_t *descriptor"
|
|
.Fa "unsigned int devtime"
|
|
.Fa "dc_ticks_t systime"
|
|
.Fc
|
|
.Sh DESCRIPTION
|
|
Creates a parser for a single dive extracted from the dive computer with
|
|
.Xr dc_device_foreach 3 .
|
|
The parser operates on the data extracted: it does not touch the device
|
|
directly to acquire data.
|
|
Thus, there are two forms of invocation:
|
|
.Nm dc_parser_new ,
|
|
which extracts relevant values from the
|
|
.Fa device
|
|
parameter; and
|
|
.Nm dc_parser_new2 ,
|
|
which is given device values (model, etc.) directly.
|
|
.Pp
|
|
After filling in the
|
|
.Fa parser
|
|
parameter, one usually sets parser data with
|
|
.Xr dc_parser_set_data 3 .
|
|
The pointer must later be freed with
|
|
.Xr dc_parser_destroy 3 .
|
|
.Sh RETURN VALUES
|
|
These return
|
|
.Dv DC_STATUS_OK ,
|
|
and fill in the
|
|
.Fa parser
|
|
pointer on success.
|
|
Otherwise, an error is returned.
|
|
.Sh SEE ALSO
|
|
.Xr dc_device_foreach 3 ,
|
|
.Xr dc_parser_destroy 3
|
|
.Sh AUTHORS
|
|
The
|
|
.Lb libdivecomputer
|
|
library was written by
|
|
.An Jef Driesen ,
|
|
.Mt jef@libdivecomputer.org .
|
|
The manpages were written by
|
|
.An Kristaps Dzonsons ,
|
|
.Mt kristaps@bsd.lv .
|