strio.c revision 1
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi * Copyright (c) 2000-2002, 2004, 2005 Sendmail, Inc. and its suppliers.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi * All rights reserved.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi * Copyright (c) 1990, 1993
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi * The Regents of the University of California. All rights reserved.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi * This code is derived from software contributed to Berkeley by
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi * Chris Torek.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi * By using this file, you agree to the terms and conditions set
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi * forth in the LICENSE file which can be found at the top level of
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi * the sendmail distribution.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi#pragma ident "%Z%%M% %I% %E% SMI"
d14abf155341d55053c76eeec58b787a456b753bRobert MustacchiSM_IDSTR(id, "@(#)$Id: strio.c,v 1.44 2005/06/09 21:40:19 ca Exp $")
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchistatic int sm_strsetmode __P((SM_FILE_T*, const int *));
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchistatic int sm_strgetmode __P((SM_FILE_T*, int *));
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Cookie structure for the "strio" file type
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** SM_STRGROW -- increase storage space for string
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Parameters:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** s -- current cookie
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** size -- new storage size request
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** true iff successful.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchistatic bool sm_strgrow __P((SM_STR_OBJ_T *, size_t));
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi register void *p;
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi return false;
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** SM_STRREAD -- read a portion of the string
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Parameters:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** fp -- the file pointer
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** buf -- location to place read data
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** n -- number of bytes to read
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Failure: -1 and sets errno
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Success: >=0, number of bytes read
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi if (!(s->strio_flags & SMRD) && !(s->strio_flags & SMRW))
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi len = SM_MIN(s->strio_size - s->strio_offset, n);
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi (void) memmove(buf, s->strio_base + s->strio_offset, len);
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** SM_STRWRITE -- write a portion of the string
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Parameters:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** fp -- the file pointer
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** buf -- location of data for writing
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** n -- number of bytes to write
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Failure: -1 and sets errno
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Success: >=0, number of bytes written
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi if (!(s->strio_flags & SMWR) && !(s->strio_flags & SMRW))
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi (void) memmove(s->strio_base + s->strio_offset, buf, n);
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** SM_STRSEEK -- position the offset pointer for the string
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Only SM_IO_SEEK_SET, SM_IO_SEEK_CUR and SM_IO_SEEK_END are valid
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** values for whence.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Parameters:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** fp -- the file pointer
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** offset -- number of bytes offset from "base"
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** whence -- determines "base" for 'offset'
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Failure: -1 and sets errno
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Success: >=0, number of bytes read
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi if (ret < 0 || ret > (off_t)(size_t)(-1)) /* XXX ugly */
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi /* errno set by sm_strgrow */
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** SM_STROPEN -- open a string file type
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Parameters:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** fp -- file pointer open to be associated with
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** info -- initial contents (NULL for none)
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** flags -- flags for methods of access (was mode)
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** rpool -- resource pool to use memory from (if applicable)
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Success: 0 (zero)
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Failure: -1 and sets errno
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi s = sm_rpool_malloc_x(rpool, sizeof(SM_STR_OBJ_T));
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi#else /* SM_RPOOL */
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi#endif /* SM_RPOOL */
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi s->strio_end = s->strio_base + s->strio_size;
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** SM_STRCLOSE -- close the string file type and free resources
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Parameters:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** fp -- file pointer
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Success: 0 (zero)
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi#endif /* !SM_RPOOL */
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** SM_STRSETMODE -- set mode info for the file
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Note: changing the mode can be a safe way to have the "parent"
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** set up a string that the "child" is not to modify
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Parameters:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** fp -- the file pointer
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** mode -- location of new mode to set
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Success: 0 (zero)
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Failure: -1 and sets errno
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** SM_STRGETMODE -- get mode info for the file
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Parameters:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** fp -- the file pointer
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** mode -- location to store current mode
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Success: 0 (zero)
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Failure: -1 and sets errno
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** SM_STRSETINFO -- set info for the file
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Currently only SM_IO_WHAT_MODE is supported for 'what'.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Parameters:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** fp -- the file pointer
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** what -- type of information to set
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** valp -- location to data for doing set
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Failure: -1 and sets errno
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Success: sm_strsetmode() return [0 (zero)]
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** SM_STRGETINFO -- get info for the file
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Currently only SM_IO_WHAT_MODE is supported for 'what'.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Parameters:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** fp -- the file pointer
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** what -- type of information requested
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** valp -- location to return information in
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Failure: -1 and sets errno
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Success: sm_strgetmode() return [0 (zero)]
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** SM_STRIO_INIT -- initializes a write-only string type
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Original comments below. This function does not appear to be used anywhere.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** The same functionality can be done by changing the mode of the file.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** ------------
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** sm_strio_init initializes an SM_FILE_T structure as a write-only file
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** that writes into the specified buffer:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** - Use sm_io_putc, sm_io_fprintf, etc, to write into the buffer.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Attempts to write more than size-1 characters into the buffer will fail
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** silently (no error is reported).
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** - Use sm_io_fflush to nul terminate the string in the buffer
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** (the write pointer is not advanced).
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** No memory is allocated either by sm_strio_init or by sm_io_{putc,write} etc.
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** Parameters:
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** fp -- file pointer
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** buf -- memory location for stored data
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi** size -- size of 'buf'
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi fp->f_bf.smb_base = fp->f_p = (unsigned char *) buf;
d14abf155341d55053c76eeec58b787a456b753bRobert Mustacchi fp->f_bf.smb_size = fp->f_w = (size ? size - 1 : 0);