/home/doxygen/libascend/compiler/importhandler.h

Go to the documentation of this file.

/*  ASCEND modelling environment
    Copyright (C) 2006 Carnegie Mellon University

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2, or (at your option)
    any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.
*//*
    by John Pye
    Created Sept 7, 2006
*/

#ifndef IMPORTHANDLER_H
#define IMPORTHANDLER_H

#include <utilities/ascConfig.h>
#include <general/ospath.h>

/*------------------------------------------------------------------------------
  DATA STRUCTURES AND TYPES
*/

typedef char *ImportHandlerCreateFilenameFn(const char *partialname);

typedef int ImportHandlerImportFn(const struct FilePath *fp,const char *initfunc, const char *partialpath);

struct ImportHandler{
    const char *name; 
    ImportHandlerCreateFilenameFn *filenamefn; 
    ImportHandlerImportFn *importfn; 
};

extern struct ImportHandler **ImportHandlerLibrary;

ASC_DLLSPEC int importhandler_add(struct ImportHandler *handler);

int importhandler_attemptimport(const char *partialname,const char *defaultpath, const char *pathenvvar);

/*------------------------------------------------------------------------------
  FUNCTIONS FOR IMPORT OF DLL/SO external libraries
*/
ImportHandlerCreateFilenameFn importhandler_extlib_filename;
ImportHandlerImportFn importhandler_extlib_import;

/*------------------------------------------------------------------------------
  LIST-BASED FUNCTIONS related to IMPORT handler 'library'
*/

int importhandler_remove(const char *name);
struct ImportHandler *importhandler_lookup(const char *name);
ASC_DLLSPEC int importhandler_destroylibrary();
int importhandler_createlibrary();
int importhandler_printlibrary(FILE *fp);
int importhandler_printhandler(FILE *fp, struct ImportHandler *);

/*------------------------------------------------------------------------------
  PATH SEARCH ROUTINES
*/

struct FilePath *importhandler_findinpath(const char *partialname
        , char *defaultpath, char *envv, struct ImportHandler **handler
);

/*------------------------------------------------------------------------------
  SHARED POINTER TABLE
*/

ASC_DLLSPEC int importhandler_createsharedpointertable();

ASC_DLLSPEC int importhandler_setsharedpointer(const char *key, void *ptr);

ASC_DLLSPEC void *importhandler_getsharedpointer(const char *key);

#endif

---