17c478bd9Sstevel@tonic-gate #ifndef ioutil_h 27c478bd9Sstevel@tonic-gate #define ioutil_h 37c478bd9Sstevel@tonic-gate 47c478bd9Sstevel@tonic-gate /* 57c478bd9Sstevel@tonic-gate * Copyright (c) 2000, 2001, 2002, 2003, 2004 by Martin C. Shepherd. 6*1da57d55SToomas Soome * 77c478bd9Sstevel@tonic-gate * All rights reserved. 8*1da57d55SToomas Soome * 97c478bd9Sstevel@tonic-gate * Permission is hereby granted, free of charge, to any person obtaining a 107c478bd9Sstevel@tonic-gate * copy of this software and associated documentation files (the 117c478bd9Sstevel@tonic-gate * "Software"), to deal in the Software without restriction, including 127c478bd9Sstevel@tonic-gate * without limitation the rights to use, copy, modify, merge, publish, 137c478bd9Sstevel@tonic-gate * distribute, and/or sell copies of the Software, and to permit persons 147c478bd9Sstevel@tonic-gate * to whom the Software is furnished to do so, provided that the above 157c478bd9Sstevel@tonic-gate * copyright notice(s) and this permission notice appear in all copies of 167c478bd9Sstevel@tonic-gate * the Software and that both the above copyright notice(s) and this 177c478bd9Sstevel@tonic-gate * permission notice appear in supporting documentation. 18*1da57d55SToomas Soome * 197c478bd9Sstevel@tonic-gate * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 207c478bd9Sstevel@tonic-gate * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 217c478bd9Sstevel@tonic-gate * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT 227c478bd9Sstevel@tonic-gate * OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 237c478bd9Sstevel@tonic-gate * HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL 247c478bd9Sstevel@tonic-gate * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING 257c478bd9Sstevel@tonic-gate * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, 267c478bd9Sstevel@tonic-gate * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION 277c478bd9Sstevel@tonic-gate * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 28*1da57d55SToomas Soome * 297c478bd9Sstevel@tonic-gate * Except as contained in this notice, the name of a copyright holder 307c478bd9Sstevel@tonic-gate * shall not be used in advertising or otherwise to promote the sale, use 317c478bd9Sstevel@tonic-gate * or other dealings in this Software without prior written authorization 327c478bd9Sstevel@tonic-gate * of the copyright holder. 337c478bd9Sstevel@tonic-gate */ 347c478bd9Sstevel@tonic-gate 357c478bd9Sstevel@tonic-gate /*....................................................................... 367c478bd9Sstevel@tonic-gate * Callback functions of the following type can be registered to write 377c478bd9Sstevel@tonic-gate * to a terminal, when the default blocking writes to a local terminal 387c478bd9Sstevel@tonic-gate * aren't appropriate. In particular, if you don't want gl_get_line() 397c478bd9Sstevel@tonic-gate * to block, then this function should return before writing the 407c478bd9Sstevel@tonic-gate * specified number of characters if doing otherwise would involve 417c478bd9Sstevel@tonic-gate * waiting. 427c478bd9Sstevel@tonic-gate * 437c478bd9Sstevel@tonic-gate * Input: 447c478bd9Sstevel@tonic-gate * data void * The anonymous data pointer that was registered with 457c478bd9Sstevel@tonic-gate * this callback function. 467c478bd9Sstevel@tonic-gate * s const char * The string to be written. Beware that this string 477c478bd9Sstevel@tonic-gate * may not have a terminating '\0' character. 487c478bd9Sstevel@tonic-gate * n int The length of the prefix of s[] to attempt to 497c478bd9Sstevel@tonic-gate * write. 507c478bd9Sstevel@tonic-gate * Output: 517c478bd9Sstevel@tonic-gate * return int The number of characters written from s[]. This 527c478bd9Sstevel@tonic-gate * should normally be a number in the range 0 to n. 537c478bd9Sstevel@tonic-gate * To signal that an I/O error occurred, return -1. 547c478bd9Sstevel@tonic-gate */ 557c478bd9Sstevel@tonic-gate #define GL_WRITE_FN(fn) int (fn)(void *data, const char *s, int n) 567c478bd9Sstevel@tonic-gate typedef GL_WRITE_FN(GlWriteFn); 577c478bd9Sstevel@tonic-gate 587c478bd9Sstevel@tonic-gate /* 597c478bd9Sstevel@tonic-gate * The following output callback function requires a (FILE *) callback 607c478bd9Sstevel@tonic-gate * data argument, and writes to this stream using the fwrite stdio 617c478bd9Sstevel@tonic-gate * function. 627c478bd9Sstevel@tonic-gate */ 637c478bd9Sstevel@tonic-gate GL_WRITE_FN(_io_write_stdio); 647c478bd9Sstevel@tonic-gate 657c478bd9Sstevel@tonic-gate /* 667c478bd9Sstevel@tonic-gate * Left justify text within the bounds of the terminal adding optional 677c478bd9Sstevel@tonic-gate * indentation, prefixes and suffixes to each line if requested. 687c478bd9Sstevel@tonic-gate */ 697c478bd9Sstevel@tonic-gate int _io_display_text(GlWriteFn *write_fn, void *data, int indentation, 707c478bd9Sstevel@tonic-gate const char *prefix, const char *suffix, int fill_char, 717c478bd9Sstevel@tonic-gate int term_width, int start, const char *string); 727c478bd9Sstevel@tonic-gate 737c478bd9Sstevel@tonic-gate #endif 74