extraUtilReader.c File Reference

#include <stdio.h>
#include "extra.h"
#include "misc/vec/vec.h"

Include dependency graph for extraUtilReader.c:

Go to the source code of this file.

Classes
struct	Extra_FileReader_t_

Macros
#define	EXTRA_BUFFER_SIZE   4*1048576
	DECLARATIONS ///.
#define	EXTRA_OFFSET_SIZE   4096
#define	EXTRA_MINIMUM(a, b)

Enumerations
enum	Extra_CharType_t { EXTRA_CHAR_COMMENT , EXTRA_CHAR_NORMAL , EXTRA_CHAR_STOP , EXTRA_CHAR_CLEAN }

Functions
Extra_FileReader_t *	Extra_FileReaderAlloc (char *pFileName, char *pCharsComment, char *pCharsStop, char *pCharsClean)
	FUNCTION DEFINITIONS ///.
void	Extra_FileReaderFree (Extra_FileReader_t *p)
char *	Extra_FileReaderGetFileName (Extra_FileReader_t *p)
int	Extra_FileReaderGetFileSize (Extra_FileReader_t *p)
int	Extra_FileReaderGetCurPosition (Extra_FileReader_t *p)
int	Extra_FileReaderGetLineNumber (Extra_FileReader_t *p, int iToken)
void *	Extra_FileReaderGetTokens (Extra_FileReader_t *p)

Macro Definition Documentation

EXTRA_BUFFER_SIZE

#define EXTRA_BUFFER_SIZE   4*1048576

DECLARATIONS ///.

CFile****************************************************************

FileName [extraUtilReader.c]

SystemName [ABC: Logic synthesis and verification system.]

PackageName [extra]

Synopsis [File reading utilities.]

Author [Alan Mishchenko]

Affiliation [UC Berkeley]

Date [Ver. 1.0. Started - June 20, 2005.]

Revision [

Id

extraUtilReader.c,v 1.00 2005/06/20 00:00:00 alanmi Exp

]

Definition at line 35 of file extraUtilReader.c.

EXTRA_MINIMUM

#define EXTRA_MINIMUM	(		a,
			b )

Value:

(((a) < (b))? (a) : (b))

Definition at line 38 of file extraUtilReader.c.

EXTRA_OFFSET_SIZE

#define EXTRA_OFFSET_SIZE   4096

Definition at line 36 of file extraUtilReader.c.

Enumeration Type Documentation

Extra_CharType_t

enum Extra_CharType_t

Enumerator
EXTRA_CHAR_COMMENT
EXTRA_CHAR_NORMAL
EXTRA_CHAR_STOP
EXTRA_CHAR_CLEAN

Definition at line 64 of file extraUtilReader.c.

             { 
    EXTRA_CHAR_COMMENT,  // a character that begins the comment
    EXTRA_CHAR_NORMAL,   // a regular character
    EXTRA_CHAR_STOP,     // a character that delimits a series of tokens
    EXTRA_CHAR_CLEAN     // a character that should be cleaned
} Extra_CharType_t;

Function Documentation

Extra_FileReaderAlloc()

Extra_FileReader_t * Extra_FileReaderAlloc	(	char *	pFileName,
		char *	pCharsComment,
		char *	pCharsStop,
		char *	pCharsClean )

FUNCTION DEFINITIONS ///.

Function*************************************************************

Synopsis [Starts the file reader.]

Description []

SideEffects []

SeeAlso []

Definition at line 90 of file extraUtilReader.c.

{
    Extra_FileReader_t * p;
    FILE * pFile;
    char * pChar;
    int nCharsToRead;
    int RetValue;
    // check if the file can be opened
    pFile = fopen( pFileName, "rb" );
    if ( pFile == NULL )
    {
        printf( "Extra_FileReaderAlloc(): Cannot open input file \"%s\".\n", pFileName );
        return NULL;
    }
    // start the file reader    
    p = ABC_ALLOC( Extra_FileReader_t, 1 );
    memset( p, 0, sizeof(Extra_FileReader_t) );
    p->pFileName   = pFileName;
    p->pFile       = pFile;
    // set the character map
    memset( p->pCharMap, EXTRA_CHAR_NORMAL, 256 );
    for ( pChar = pCharsComment; *pChar; pChar++ )
        p->pCharMap[(unsigned char)*pChar] = EXTRA_CHAR_COMMENT;
    for ( pChar = pCharsStop; *pChar; pChar++ )
        p->pCharMap[(unsigned char)*pChar] = EXTRA_CHAR_STOP;
    for ( pChar = pCharsClean; *pChar; pChar++ )
        p->pCharMap[(unsigned char)*pChar] = EXTRA_CHAR_CLEAN;
    // get the file size, in bytes
    fseek( pFile, 0, SEEK_END );  
    p->nFileSize = ftell( pFile );  
    rewind( pFile ); 
    // allocate the buffer
    p->pBuffer = ABC_ALLOC( char, EXTRA_BUFFER_SIZE+1 );
    p->nBufferSize = EXTRA_BUFFER_SIZE;
    p->pBufferCur  = p->pBuffer;
    // determine how many chars to read
    nCharsToRead = EXTRA_MINIMUM(p->nFileSize, EXTRA_BUFFER_SIZE);
    // load the first part into the buffer
    RetValue = fread( p->pBuffer, nCharsToRead, 1, p->pFile );
    p->nFileRead = nCharsToRead;
    // set the ponters to the end and the stopping point
    p->pBufferEnd  = p->pBuffer + nCharsToRead;
    p->pBufferStop = (p->nFileRead == p->nFileSize)? p->pBufferEnd : p->pBuffer + EXTRA_BUFFER_SIZE - EXTRA_OFFSET_SIZE;
    // start the arrays
    p->vTokens = Vec_PtrAlloc( 100 );
    p->vLines = Vec_IntAlloc( 100 );
    p->nLineCounter = 1; // 1-based line counting
    return p;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Extra_FileReaderFree()

void Extra_FileReaderFree

(

Extra_FileReader_t *

p

)

Function*************************************************************

Synopsis [Stops the file reader.]

Description []

SideEffects []

SeeAlso []

Definition at line 152 of file extraUtilReader.c.

{
    if ( p->pFile )
        fclose( p->pFile );
    ABC_FREE( p->pBuffer );
    Vec_PtrFree( p->vTokens );
    Vec_IntFree( p->vLines );
    ABC_FREE( p );
}

Here is the caller graph for this function:

Extra_FileReaderGetCurPosition()

int Extra_FileReaderGetCurPosition

(

Extra_FileReader_t *

p

)

Function*************************************************************

Synopsis [Returns the current reading position.]

Description []

SideEffects []

SeeAlso []

Definition at line 205 of file extraUtilReader.c.

{
    return p->nFileRead - (p->pBufferEnd - p->pBufferCur);
}

Extra_FileReaderGetFileName()

char * Extra_FileReaderGetFileName

(

Extra_FileReader_t *

p

)

Function*************************************************************

Synopsis [Returns the file size.]

Description []

SideEffects []

SeeAlso []

Definition at line 173 of file extraUtilReader.c.

{
    return p->pFileName;
}

Extra_FileReaderGetFileSize()

int Extra_FileReaderGetFileSize

(

Extra_FileReader_t *

p

)

Function*************************************************************

Synopsis [Returns the file size.]

Description []

SideEffects []

SeeAlso []

Definition at line 189 of file extraUtilReader.c.

{
    return p->nFileSize;
}

Extra_FileReaderGetLineNumber()

int Extra_FileReaderGetLineNumber	(	Extra_FileReader_t *	p,
		int	iToken )

Function*************************************************************

Synopsis [Returns the line number for the given token.]

Description []

SideEffects []

SeeAlso []

Definition at line 221 of file extraUtilReader.c.

{
    assert( iToken >= 0 && iToken < p->vTokens->nSize );
    return p->vLines->pArray[iToken];
}

Extra_FileReaderGetTokens()

void * Extra_FileReaderGetTokens

(

Extra_FileReader_t *

p

)

Function*************************************************************

Synopsis [Returns the next set of tokens.]

Description []

SideEffects []

SeeAlso []

Definition at line 239 of file extraUtilReader.c.

{
    Vec_Ptr_t * vTokens;
    while ( (vTokens = (Vec_Ptr_t *)Extra_FileReaderGetTokens_int( p )) )
        if ( vTokens->nSize > 0 )
            break;
    return vTokens;
}