Return to string_enquote.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / libpdel / util

Initial revision

.\" Copyright (c) 2001-2002 Packet Design, LLC.
.\" All rights reserved.
.\" 
.\" Subject to the following obligations and disclaimer of warranty,
.\" use and redistribution of this software, in source or object code
.\" forms, with or without modifications are expressly permitted by
.\" Packet Design; provided, however, that:
.\" 
.\"    (i)  Any and all reproductions of the source or object code
.\"         must include the copyright notice above and the following
.\"         disclaimer of warranties; and
.\"    (ii) No rights are granted, in any manner or form, to use
.\"         Packet Design trademarks, including the mark "PACKET DESIGN"
.\"         on advertising, endorsements, or otherwise except as such
.\"         appears in the above copyright notice or in the software.
.\" 
.\" THIS SOFTWARE IS BEING PROVIDED BY PACKET DESIGN "AS IS", AND
.\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, PACKET DESIGN MAKES NO
.\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING
.\" THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED
.\" WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
.\" OR NON-INFRINGEMENT.  PACKET DESIGN DOES NOT WARRANT, GUARANTEE,
.\" OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS
.\" OF THE USE OF THIS SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY,
.\" RELIABILITY OR OTHERWISE.  IN NO EVENT SHALL PACKET DESIGN BE
.\" LIABLE FOR ANY DAMAGES RESULTING FROM OR ARISING OUT OF ANY USE
.\" OF THIS SOFTWARE, INCLUDING WITHOUT LIMITATION, ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE, OR CONSEQUENTIAL
.\" DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, LOSS OF
.\" USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY THEORY OF
.\" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
.\" THE USE OF THIS SOFTWARE, EVEN IF PACKET DESIGN IS ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" Author: Archie Cobbs <archie@freebsd.org>
.\"
.\" $Id: string_enquote.3,v 1.1 2012/02/21 23:25:53 misho Exp $
.\"
.Dd April 22, 2002
.Dt STRING_ENQUOTE 3
.Os
.Sh NAME
.Nm string_enquote ,
.Nm string_dequote
.Nd doubly quoted string conversion routines
.Sh LIBRARY
PDEL Library (libpdel, \-lpdel)
.Sh SYNOPSIS
.In stdio.h
.In pdel/util/string_quote.h
.Ft "char *"
.Fn string_enquote "const char *str" "const char *mtype"
.Ft "char *"
.Fn string_dequote "FILE *input" "const char *mtype"
.Sh DESCRIPTION
These routines handle converting strings to and from a printable form,
namely, doubly-quoted strings with C backslash escapes.
.Pp
.Fn string_enquote
encodes the string
.Fa str
using only printable characters and returns the result, which will begin
and end with a double quote character.
The returned string is allocated with
.Xr typed_mem 3
type
.Fa mtype
and must be freed by the caller.
.Pp
.Fn string_dequote
reads and parses a doubly-quoted string from
.Fa input
and returns the result, allocated with 
.Xr typed_mem 3
type
.Fa mtype .
The caller must free the returned string.
The input stream is assumed to be pointing at the character after the
opening double quote character.
Upon return, it will be pointing to the character after the closing double
quote character.
.Pp
.Fn string_dequote
parses in a liberal manner and does not detect parse errors.
Any malformed backslash escapes are passed through unchanged.
In other words, if 
.Fn string_dequote
is passed a string that was produced by
.Fn string_enquote ,
it guarantees to reproduce the original string;
however, it will successfully parse any input string.
.Sh RETURN VALUES
If there was a system error,
.Fn string_enquote
and
.Fn string_dequote
return
.Dv NULL
with
.Va errno
set to the appropriate value.
.Fn string_dequote
also returns
.Dv NULL
if the end of file is encountered before the closing quote character,
in which case
.Va errno
is set to
.Er EINVAL .
.Sh SEE ALSO
.Xr string_fp 3 ,
.Xr libpdel 3 ,
.Xr typed_mem 3
.Sh HISTORY
The PDEL library was developed at Packet Design, LLC.
.Dv "http://www.packetdesign.com/"
.Sh AUTHORS
.An Archie Cobbs Aq archie@freebsd.org