tpia_map.h File Reference

#include <xData.h>

Go to the source code of this file.

Classes
struct	tpia_map_smr_s
struct	tpia_mapEntry_s
struct	tpia_map_s

Typedefs
typedef struct tpia_map_s	tpia_map
typedef struct tpia_mapEntry_s	tpia_mapEntry
typedef struct tpia_map_smr_s	tpia_map_smr

Enumerations
enum	tpia_map_status { tpia_map_status_Ok , tpia_map_status_memory , tpia_map_status_mapParsing , tpia_map_status_UnknownType }
enum	tpia_mapEntry_type { tpia_mapEntry_type_target , tpia_mapEntry_type_path }

Functions
tpia_map *	tpia_map_create (statusMessageReporting *smr)
int	tpia_map_initialize (statusMessageReporting *smr, tpia_map *map)
tpia_map *	tpia_map_readFile (statusMessageReporting *smr, const char *basePath, const char *mapFileName)
void *	tpia_map_free (statusMessageReporting *smr, tpia_map *map)
void	tpia_map_release (statusMessageReporting *smr, tpia_map *map)
tpia_mapEntry *	tpia_map_getFirstEntry (tpia_map *map)
tpia_mapEntry *	tpia_map_getNextEntry (tpia_mapEntry *entry)
int	tpia_map_addTarget (statusMessageReporting *smr, tpia_map *map, const char *method, const char *path, const char *evaluation, const char *projectile, const char *targetName)
int	tpia_map_addPath (statusMessageReporting *smr, tpia_map *map, const char *path, const char *projectile)
char *	tpia_map_findTarget (statusMessageReporting *smr, tpia_map *map, const char *evaluation, const char *projectile, const char *targetName)
tpia_map *	tpia_map_findAllOfTarget (statusMessageReporting *smr, tpia_map *map, const char *projectile, const char *targetName)
char *	tpia_map_getFullPath (statusMessageReporting *smr, tpia_map *map, const char *endPath)
int	tpia_map_walkTree (statusMessageReporting *smr, tpia_map *map, int(*handler)(tpia_mapEntry *entry, int level, void *userData), void *userData)
char *	tpia_map_toXMLString (statusMessageReporting *smr, tpia_map *map)
void	tpia_map_simpleWrite (FILE *f, tpia_map *map)

Typedef Documentation

tpia_map

typedef struct tpia_map_s tpia_map

Definition at line 53 of file tpia_map.h.

tpia_map_smr

typedef struct tpia_map_smr_s tpia_map_smr

Definition at line 55 of file tpia_map.h.

tpia_mapEntry

typedef struct tpia_mapEntry_s tpia_mapEntry

Definition at line 54 of file tpia_map.h.

Enumeration Type Documentation

tpia_map_status

enum tpia_map_status

Enumerator
tpia_map_status_Ok
tpia_map_status_memory
tpia_map_status_mapParsing
tpia_map_status_UnknownType

Definition at line 49 of file tpia_map.h.

                     { tpia_map_status_Ok, tpia_map_status_memory, tpia_map_status_mapParsing,
    tpia_map_status_UnknownType };

tpia_mapEntry_type

enum tpia_mapEntry_type

Enumerator
tpia_mapEntry_type_target
tpia_mapEntry_type_path

Definition at line 51 of file tpia_map.h.

{ tpia_mapEntry_type_target, tpia_mapEntry_type_path };

Function Documentation

tpia_map_addPath()

int tpia_map_addPath	(	statusMessageReporting *	smr,
		tpia_map *	map,
		const char *	path,
		const char *	projectile
	)

Definition at line 236 of file tpia_map.cc.

                                                                                                             {
 
    tpia_mapEntry *entry = _tpia_map_addEntry( smr, map, tpia_mapEntry_type_path, NULL, path, NULL, projectile, NULL );
 
    if( entry != NULL ) {
        if( ( entry->map = tpia_map_readFile( smr, map->path, entry->path ) ) == NULL ) entry = NULL;
    }
    return( entry != NULL );
}

Referenced by tpia_map_readFile().

tpia_map_addTarget()

int tpia_map_addTarget	(	statusMessageReporting *	smr,
		tpia_map *	map,
		const char *	method,
		const char *	path,
		const char *	evaluation,
		const char *	projectile,
		const char *	targetName
	)

Definition at line 229 of file tpia_map.cc.

                                                                                                                                                                               {
 
    return( _tpia_map_addEntry( smr, map, tpia_mapEntry_type_target, schema, path, evaluation, projectile, target ) != NULL );
}

Referenced by tpia_map_readFile().

tpia_map_create()

tpia_map * tpia_map_create

(

statusMessageReporting *

smr

)

Definition at line 59 of file tpia_map.cc.

                                                         {
 
    tpia_map *map;
    
    //if( ( map = xData_malloc2( smr, sizeof( tpia_map ), 0, "map" ) ) == NULL ) return( NULL );
    if( ( map = (tpia_map*) xData_malloc2( smr, sizeof( tpia_map ), 0, "map" ) ) == NULL ) return( NULL );
    //if( tpia_map_initialize( smr, map ) ) map = tpia_map_free( NULL, map );
    if( tpia_map_initialize( smr, map ) ) map = (tpia_map*) tpia_map_free( NULL, map );
    return( map );
}

Referenced by tpia_map_findAllOfTarget(), and tpia_map_readFile().

tpia_map_findAllOfTarget()

tpia_map * tpia_map_findAllOfTarget	(	statusMessageReporting *	smr,
		tpia_map *	map,
		const char *	projectile,
		const char *	targetName
	)

Definition at line 393 of file tpia_map.cc.

                                                                                                                                 {
/*
* Calling routine must free returned pointer.
*/
    int status;
    tpia_map *mapAllOfTarget;
    
    if( map->status != tpia_map_status_Ok ) return( NULL );
    if( ( mapAllOfTarget = tpia_map_create( smr ) ) == NULL ) return( NULL );
    status = _tpia_map_findAllOfTarget2( smr, mapAllOfTarget, map, projectile, targetName );
    //if( ( status != 0 ) ) mapAllOfTarget = tpia_map_free( smr, mapAllOfTarget );
    if( ( status != 0 ) ) mapAllOfTarget = (tpia_map*) tpia_map_free( smr, mapAllOfTarget );
    return( mapAllOfTarget );
}

Referenced by G4GIDI::getNamesOfAvailableLibraries().

tpia_map_findTarget()

char * tpia_map_findTarget	(	statusMessageReporting *	smr,
		tpia_map *	map,
		const char *	evaluation,
		const char *	projectile,
		const char *	targetName
	)

Definition at line 327 of file tpia_map.cc.

                                                                                                                                                {
/*
* Calling routine must free returned pointer.
*/
    char *path;
 
    if( map->status != tpia_map_status_Ok ) return( NULL );
 
    path = _tpia_map_findTarget2( smr, map, evaluation, projectile, targetName );
    if( ( path == NULL ) && smr_isOk( smr ) ) {
        if( evaluation == NULL ) {
            smr_setMessageInfo( smr, &(map->smrUserInterface), __FILE__, __LINE__, 1, "target %s for projectile %s not found", targetName, projectile ); }
        else {
            smr_setMessageInfo( smr, &(map->smrUserInterface), __FILE__, __LINE__, 1, "target %s for projectile %s and evaluation %s not found", targetName, projectile, evaluation );
        }
    }
    return( path );
}

Referenced by G4GIDI::dataFilename(), tpia_target_createReadFromMap(), and tpia_target_readFromMap().

tpia_map_free()

void * tpia_map_free	(	statusMessageReporting *	smr,
		tpia_map *	map
	)

Definition at line 184 of file tpia_map.cc.

                                                                  {
 
    tpia_map_release( smr, map );
    xData_free( smr, map );
    return( NULL );
}

Referenced by G4GIDI::getNamesOfAvailableLibraries(), tpia_depot_freeMap(), tpia_depot_release(), tpia_map_create(), tpia_map_findAllOfTarget(), tpia_map_readFile(), tpia_map_release(), and G4GIDI_map::~G4GIDI_map().

tpia_map_getFirstEntry()

tpia_mapEntry * tpia_map_getFirstEntry

(

tpia_map *

map

)

Definition at line 215 of file tpia_map.cc.

                                                       {
 
    return( map->mapEntries );
}

Referenced by G4GIDI::getNamesOfAvailableLibraries().

tpia_map_getFullPath()

char * tpia_map_getFullPath	(	statusMessageReporting *	smr,
		tpia_map *	map,
		const char *	endPath
	)

Definition at line 437 of file tpia_map.cc.

                                                                                              {
 
    char *path;
 
    if( endPath[0] == '/' ) {
        //if( ( path = xData_malloc2( smr, strlen( endPath ) + 1, 0, "path" ) ) == NULL ) return( NULL );
        if( ( path = (char*) xData_malloc2( smr, strlen( endPath ) + 1, 0, "path" ) ) == NULL ) return( NULL );
        path[0] = 0; }
    else {
        //if( ( path = xData_malloc2( smr, strlen( map->path ) + strlen( endPath ) + 2, 0, "path" ) ) == NULL ) return( NULL );
        if( ( path = (char*) xData_malloc2( smr, strlen( map->path ) + strlen( endPath ) + 2, 0, "path" ) ) == NULL ) return( NULL );
        strcpy( path, map->path );
        strcat( path, "/" );
    }
    strcat( path, endPath );
    return( path );
}

tpia_map_getNextEntry()

tpia_mapEntry * tpia_map_getNextEntry

(

tpia_mapEntry *

entry

)

Definition at line 222 of file tpia_map.cc.

                                                             {
 
    return( entry->next );
}

Referenced by G4GIDI::getNamesOfAvailableLibraries().

tpia_map_initialize()

int tpia_map_initialize	(	statusMessageReporting *	smr,
		tpia_map *	map
	)

Definition at line 73 of file tpia_map.cc.

                                                                   {
 
    memset( map, 0, sizeof( tpia_map ) );
    map->status = tpia_map_status_Ok;
    map->smrUserInterface.smrUserInterface = _tpia_map_smrUserInterface;
    map->smrUserInterface.map = map;
    map->path = NULL;
    map->mapFileName = NULL;
    map->numberOfEntries = 0;
    map->mapEntries = NULL;
    return( 0 );
}

Referenced by tpia_map_create().

tpia_map_readFile()

tpia_map * tpia_map_readFile	(	statusMessageReporting *	smr,
		const char *	basePath,
		const char *	mapFileName
	)

Definition at line 88 of file tpia_map.cc.

                                                                                                          {
/*
*   If an error occurrs, map is freed and NULL is returned.
*/
    int n = 0;
    xData_document *doc;
    xData_element *element;
    xData_element *child;
    tpia_map *map;
    const char *evaluation, *projectile, *targetName, *path, *schema;
#ifndef WIN32
    char realPath[2 * ( PATH_MAX + 1 )], *p = &(realPath[PATH_MAX+1]);
#endif
#ifdef WIN32
    char realPath[2 * ( _MAX_PATH + 1 )], *p = &(realPath[_MAX_PATH+1]);
#endif
 
    if( ( map = tpia_map_create( smr ) ) == NULL ) return( NULL );
 
    if( ( basePath == NULL ) || ( mapFileName[0] == '/' ) ) {
        strcpy( realPath, mapFileName ); }
    else {
        strcpy( realPath, basePath );
        strcat( realPath, "/" );
        strcat( realPath, mapFileName );
    }
#ifndef WIN32
    if( realpath( realPath, p ) == NULL ) {
        smr_setMessageError( smr, NULL, __FILE__, __LINE__, tpia_map_status_mapParsing, "No map file %s\n", mapFileName );
        //return( tpia_map_free( NULL, map ) );
        return( (tpia_map*) tpia_map_free( NULL, map ) );
    }
#endif
    n = strlen( p ) + 2;
    //if( ( map->path = xData_malloc2( smr, 2 * n, 0, "map->path" ) ) == NULL ) return( tpia_map_free( NULL, map ) );
    //if( ( map->path = (char*) xData_malloc2( smr, 2 * n, 0, "map->path" ) ) == NULL ) return( tpia_map_free( NULL, map ) );
    if( ( map->path = (char*) xData_malloc2( smr, 2 * n, 0, "map->path" ) ) == NULL ) return( (tpia_map*) tpia_map_free( NULL, map ) );
    map->mapFileName = &(map->path[n + 1]);
    strcpy( map->mapFileName, p );
    strcpy( map->path, p );
    if( ( p = strrchr( map->path, '/' ) ) != NULL ) {
        *p = 0; }
    else {
        strcpy( map->path, "." );
    }
 
    //if( ( doc = xData_parseReadFile( smr, map->mapFileName, NULL, NULL ) ) == NULL ) return( tpia_map_free( NULL, map ) );
    if( ( doc = xData_parseReadFile( smr, map->mapFileName, NULL, NULL ) ) == NULL ) return( (tpia_map*) tpia_map_free( NULL, map ) );
 
    element = xData_getDocumentsElement( doc );
    for( child = xData_getFirstElement( element ); child != NULL; child = xData_getNextElement( child ) ) {
        if( !strcmp( child->name, "path" ) ) {
            if( ( path = xData_getAttributesValueInElement( child , "path" ) ) == NULL ) {
                smr_setMessageError( smr, &(map->smrUserInterface), __FILE__, __LINE__, tpia_map_status_mapParsing, "path missing path attribute" );
                break;
            }
            if( ( projectile = xData_getAttributesValueInElement( child , "projectile" ) ) == NULL ) {
                smr_setMessageError( smr, &(map->smrUserInterface), __FILE__, __LINE__, tpia_map_status_mapParsing, "path missing projectile attribute" );
                break;
            }
            tpia_map_addPath( smr, map, path, projectile ); }
        else if( !strcmp( child->name, "target" ) ) {
            if( ( schema = xData_getAttributesValueInElement( child , "schema" ) ) == NULL ) {
                smr_setMessageError( smr, &(map->smrUserInterface), __FILE__, __LINE__, tpia_map_status_mapParsing, "target missing 'schema' attribute" );
                break;
            }
            if( ( path = xData_getAttributesValueInElement( child , "path" ) ) == NULL ) {
                smr_setMessageError( smr, &(map->smrUserInterface), __FILE__, __LINE__, tpia_map_status_mapParsing, "target missing 'path' attribute" );
                break;
            }
            if( ( evaluation = xData_getAttributesValueInElement( child , "evaluation" ) ) == NULL ) {
                smr_setMessageError( smr, &(map->smrUserInterface), __FILE__, __LINE__, tpia_map_status_mapParsing, "target missing 'evaluation' attribute" );
                break;
            }
            if( ( projectile = xData_getAttributesValueInElement( child , "projectile" ) ) == NULL ) {
                smr_setMessageError( smr, &(map->smrUserInterface), __FILE__, __LINE__, tpia_map_status_mapParsing, "target missing 'projectile' attribute" );
                break;
            }
            if( ( targetName = xData_getAttributesValueInElement( child , "target" ) ) == NULL ) {
                smr_setMessageError( smr, &(map->smrUserInterface), __FILE__, __LINE__, tpia_map_status_mapParsing, "target missing 'target' attribute" );
                break;
            }
            tpia_map_addTarget( smr, map, schema, path, evaluation, projectile, targetName ); }
        else {
            smr_setMessageError( smr, &(map->smrUserInterface), __FILE__, __LINE__, tpia_map_status_mapParsing, "invalid element = %s", child->name );
        }
        if( !smr_isOk( smr ) ) break;
    }
    xData_parseFree( smr, doc );
    //if( !smr_isOk( smr ) ) map = tpia_map_free( NULL, map );
    if( !smr_isOk( smr ) ) map = (tpia_map*) tpia_map_free( NULL, map );
    return( map );
}

Referenced by G4GIDI_map::G4GIDI_map(), tpia_depot_setMapFromFilename(), and tpia_map_addPath().

tpia_map_release()

void tpia_map_release	(	statusMessageReporting *	smr,
		tpia_map *	map
	)

Definition at line 193 of file tpia_map.cc.

                                                                    {
 
    tpia_mapEntry *entry, *next;
 
    if( map->path != NULL ) xData_free( NULL, map->path );
    for( entry = map->mapEntries; entry != NULL; entry = next ) {
        next = entry->next;
        if( entry->schema != NULL ) xData_free( NULL, entry->schema );
        if( entry->path != NULL ) xData_free( NULL, entry->path );
        if( entry->evaluation != NULL ) xData_free( NULL, entry->evaluation );
        if( entry->projectile != NULL ) xData_free( NULL, entry->projectile );
        if( entry->targetName != NULL ) xData_free( NULL, entry->targetName );
        if( entry->map != NULL ) tpia_map_free( smr, entry->map );
        xData_free( NULL, entry );
    }
    map->numberOfEntries = 0;
    map->mapEntries = NULL;
    map->status = tpia_map_status_Ok;
}

Referenced by tpia_map_free().

tpia_map_simpleWrite()

void tpia_map_simpleWrite	(	FILE *	f,
		tpia_map *	map
	)

Definition at line 527 of file tpia_map.cc.

{ _tpia_map_simpleWrite2( f, map, 0 ); }

tpia_map_toXMLString()

char * tpia_map_toXMLString	(	statusMessageReporting *	smr,
		tpia_map *	map
	)

Definition at line 478 of file tpia_map.cc.

                                                                         {
 
    tpia_mapEntry *entry;
    char *s, *p;
    char targetFormat[] = "<target schema=\"%s\" evaluation=\"%s\" projectile=\"%s\" target=\"%s\" path=\"%s\"/>\n";
    char pathFormat[] = "<path projectile=\"%s\" path=\"%s\"/>\n";
    char start[] = "<map>\n";
    char end[] = "</map>";
    int n = 0, nStart = strlen( start ), nEnd = strlen( end );
    int nTarget = strlen( targetFormat ) - 10, nPath = strlen( pathFormat ) - 4;
 
    if( map->status != tpia_map_status_Ok ) return( NULL );
 
    n = nStart + nEnd + 1;
    for( entry = map->mapEntries; entry != NULL; entry = entry->next ) {
        switch( entry->type ) {
        case tpia_mapEntry_type_target :
            n += strlen( entry->schema ) + strlen( entry->path ) + strlen( entry->evaluation ) + strlen( entry->projectile ) + strlen( entry->targetName ) + nTarget;
            break;
        case tpia_mapEntry_type_path :
            n += strlen( entry->path ) + strlen( entry->projectile ) + nPath;
            break;
        default :
            smr_setMessageInfo( smr, &(map->smrUserInterface), __FILE__, __LINE__, tpia_map_status_UnknownType, "unknown type = %d", entry->type );
            return( NULL );
        }
    }
 
    if( ( s = (char *) xData_malloc2( smr, n, 0, "xml string" ) ) == NULL ) return( NULL );
    p = s;
    strcpy( p, start );
    while( *p ) p++;
    for( entry = map->mapEntries; entry != NULL; entry = entry->next ) {
        switch( entry->type ) {
        case tpia_mapEntry_type_target :
            sprintf( p, targetFormat, entry->schema, entry->evaluation, entry->projectile, entry->targetName, entry->path );
            break;
        case tpia_mapEntry_type_path :
            sprintf( p, pathFormat, entry->projectile, entry->path );
            break;
        }
        while( *p ) p++;
    }
    strcpy( p, end );
    return( s );
}

tpia_map_walkTree()

int tpia_map_walkTree	(	statusMessageReporting *	smr,
		tpia_map *	map,
		int(*)(tpia_mapEntry *entry, int level, void *userData)	handler,
		void *	userData
	)

Definition at line 457 of file tpia_map.cc.

                                                                                                                                                      {
 
    return( _tpia_map_walkTree2( smr, map, 0, handler, userData ) );
}

Referenced by G4GIDI::getNamesOfAvailableTargets().