blob: 8476fc49e9d1fd39fa78622dc8644b90be409b82 [file] [log] [blame]
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
* The Original Code is the Netscape Portable Runtime (NSPR).
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998-2000
* the Initial Developer. All Rights Reserved.
* Contributor(s):
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
* ***** END LICENSE BLOCK ***** */
** Class definitions to format ASCII data.
#if defined(_RCASCII_H)
#define _RCASCII_H
** RCFormatStuff
** This class maintains no state - that is the responsibility of
** the class' client. For each call to Sx_printf(), the StuffFunction
** will be called for each embedded "%" in the 'fmt' string and once
** for each interveaning literal.
class PR_IMPLEMENT(RCFormatStuff)
virtual ~RCFormatStuff();
** Process the arbitrary argument list using as indicated by
** the 'fmt' string. Each segment of the processing the stuff
** function is called with the relavent translation.
virtual PRInt32 Sx_printf(void *state, const char *fmt, ...);
** The 'state' argument is not processed by the runtime. It
** is merely passed from the Sx_printf() call. It is intended
** to be used by the client to figure out what to do with the
** new string.
** The new string ('stuff') is ASCII translation driven by the
** Sx_printf()'s 'fmt' string. It is not guaranteed to be a null
** terminated string.
** The return value is the number of bytes copied from the 'stuff'
** string. It is accumulated for each of the calls to the stuff
** function and returned from the original caller of Sx_printf().
virtual PRSize StuffFunction(
void *state, const char *stuff, PRSize stufflen) = 0;
}; /* RCFormatStuff */
** RCFormatBuffer
** The caller is supplying the buffer, the runtime is doing all
** the conversion. The object contains no state, so is reusable
** and reentrant.
class PR_IMPLEMENT(RCFormatBuffer): public RCFormatStuff
virtual ~RCFormatBuffer();
** Format the trailing arguments as indicated by the 'fmt'
** string. Put the result in 'buffer'. Return the number
** of bytes moved into 'buffer'. 'buffer' will always be
** a properly terminated string even if the convresion fails.
virtual PRSize Sn_printf(
char *buffer, PRSize length, const char *fmt, ...);
virtual char *Sm_append(char *buffer, const char *fmt, ...);
** This class overrides the stuff function, does not preserve
** its virtual-ness and no longer allows the clients to call
** it in the clear. In other words, it is now the implementation
** for this class.
PRSize StuffFunction(void*, const char*, PRSize);
}; /* RCFormatBuffer */
** RCFormat
** The runtime is supplying the buffer. The object has state - the
** buffer. Each operation must run to completion before the object
** can be reused. When it is, the buffer is reset (whatever that
** means). The result of a conversion is available via the extractor.
** After extracted, the memory still belongs to the class - if the
** caller wants to retain or modify, it must first be copied.
class PR_IMPLEMENT(RCFormat): pubic RCFormatBuffer
virtual ~RCFormat();
** Translate the trailing arguments according to the 'fmt'
** string and store the results in the object.
virtual PRSize Sm_printf(const char *fmt, ...);
** Extract the latest translation.
** The object does not surrender the memory occupied by
** the string. If the caller wishes to modify the data,
** it must first be copied.
const char*();
char *buffer;
RCFormat(const RCFormat&);
RCFormat& operator=(const RCFormat&);
}; /* RCFormat */
** RCPrint
** The output is formatted and then written to an associated file
** descriptor. The client can provide a suitable file descriptor
** or can indicate that the output should be directed to one of
** the well-known "console" devices.
class PR_IMPLEMENT(RCPrint): public RCFormat
virtual ~RCPrint();
RCPrint(RCIO* output);
RCPrint(RCFileIO::SpecialFile output);
virtual PRSize Printf(const char *fmt, ...);
}; /* RCPrint */
#endif /* defined(_RCASCII_H) */
/* RCAscii.h */