e99772f9bf09219c532812c859fbeea513c67e65vboxsync/* $Id$ */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/** @file
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * IPRT Testcase / Tool - Source Code Massager Stream Code.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/*
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Copyright (C) 2012 Oracle Corporation
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * available from http://www.virtualbox.org. This file is free software;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * you can redistribute it and/or modify it under the terms of the GNU
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * General Public License (GPL) as published by the Free Software
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#ifndef ___scmstream_h___
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#define ___scmstream_h___
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <iprt/types.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncRT_C_DECLS_BEGIN
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/** End of line marker type. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsynctypedef enum SCMEOL
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync SCMEOL_NONE = 0,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync SCMEOL_LF = 1,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync SCMEOL_CRLF = 2
e99772f9bf09219c532812c859fbeea513c67e65vboxsync} SCMEOL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/** Pointer to an end of line marker type. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsynctypedef SCMEOL *PSCMEOL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Line record.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsynctypedef struct SCMSTREAMLINE
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** The offset of the line. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t off;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** The line length, excluding the LF character.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @todo This could be derived from the offset of the next line if that wasn't
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * so tedious. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cch;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** The end of line marker type. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync SCMEOL enmEol;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync} SCMSTREAMLINE;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/** Pointer to a line record. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsynctypedef SCMSTREAMLINE *PSCMSTREAMLINE;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Source code massager stream.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsynctypedef struct SCMSTREAM
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Pointer to the file memory. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync char *pch;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** The current stream position. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t off;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** The current stream size. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cb;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** The size of the memory pb points to. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbAllocated;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Line records. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PSCMSTREAMLINE paLines;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** The current line. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t iLine;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** The current stream size given in lines. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cLines;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** The sizeof the the memory backing paLines. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cLinesAllocated;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Set if write-only, clear if read-only. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync bool fWriteOrRead;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Set if the memory pb points to is from RTFileReadAll. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync bool fFileMemory;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Set if fully broken into lines. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync bool fFullyLineated;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Stream status code (IPRT). */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync} SCMSTREAM;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/** Pointer to a SCM stream. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsynctypedef SCMSTREAM *PSCMSTREAM;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/** Pointer to a const SCM stream. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsynctypedef SCMSTREAM const *PCSCMSTREAM;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamInitForReading(PSCMSTREAM pStream, const char *pszFilename);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamInitForWriting(PSCMSTREAM pStream, PCSCMSTREAM pRelatedStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncvoid ScmStreamDelete(PSCMSTREAM pStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamGetStatus(PCSCMSTREAM pStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncvoid ScmStreamRewindForReading(PSCMSTREAM pStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncvoid ScmStreamRewindForWriting(PSCMSTREAM pStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncbool ScmStreamIsText(PSCMSTREAM pStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamCheckItegrity(PSCMSTREAM pStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamWriteToFile(PSCMSTREAM pStream, const char *pszFilenameFmt, ...);
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsyncint ScmStreamWriteToStdOut(PSCMSTREAM pStream);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncsize_t ScmStreamTell(PSCMSTREAM pStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncsize_t ScmStreamTellLine(PSCMSTREAM pStream);
b20cc298c1a3191a4e6ce780c19313117902675dvboxsyncsize_t ScmStreamTellOffsetOfLine(PSCMSTREAM pStream, size_t iLine);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncsize_t ScmStreamSize(PSCMSTREAM pStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncsize_t ScmStreamCountLines(PSCMSTREAM pStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamSeekAbsolute(PSCMSTREAM pStream, size_t offAbsolute);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamSeekRelative(PSCMSTREAM pStream, ssize_t offRelative);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamSeekByLine(PSCMSTREAM pStream, size_t iLine);
711c3306c03131891af1dbbe733668098e1cdef9vboxsyncbool ScmStreamIsAtStartOfLine(PSCMSTREAM pStream);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncconst char *ScmStreamGetLineByNo(PSCMSTREAM pStream, size_t iLine, size_t *pcchLine, PSCMEOL penmEol);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncconst char *ScmStreamGetLine(PSCMSTREAM pStream, size_t *pcchLine, PSCMEOL penmEol);
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsyncunsigned ScmStreamGetCh(PSCMSTREAM pStream);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsyncconst char *ScmStreamGetCur(PSCMSTREAM pStream);
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsyncunsigned ScmStreamPeekCh(PSCMSTREAM pStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamRead(PSCMSTREAM pStream, void *pvBuf, size_t cbToRead);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncbool ScmStreamIsWhiteLine(PSCMSTREAM pStream, size_t iLine);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncSCMEOL ScmStreamGetEol(PSCMSTREAM pStream);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncSCMEOL ScmStreamGetEolByLine(PSCMSTREAM pStream, size_t iLine);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamPutLine(PSCMSTREAM pStream, const char *pchLine, size_t cchLine, SCMEOL enmEol);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamWrite(PSCMSTREAM pStream, const char *pchBuf, size_t cchBuf);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamPutCh(PSCMSTREAM pStream, char ch);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsyncssize_t ScmStreamPrintf(PSCMSTREAM pStream, const char *pszFormat, ...);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsyncssize_t ScmStreamPrintfV(PSCMSTREAM pStream, const char *pszFormat, va_list va);
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint ScmStreamCopyLines(PSCMSTREAM pDst, PSCMSTREAM pSrc, size_t cLines);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsyncbool ScmStreamCMatchingWordM1(PSCMSTREAM pStream, const char *pszWord, size_t cchWord);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsyncconst char *ScmStreamCGetWord(PSCMSTREAM pStream, size_t *pcchWord);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsyncconst char *ScmStreamCGetWordM1(PSCMSTREAM pStream, size_t *pcchWord);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncRT_C_DECLS_END
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#endif
e99772f9bf09219c532812c859fbeea513c67e65vboxsync