Annotation For xvfs.c.rvt

Origin for each line in xvfs.c.rvt from check-in e5b6962adf:

1ecab39ce5 2019-05-02    1: #include <xvfs-core.h>
303b2de493 2019-05-02    2: #include <unistd.h>
32b55a907b 2019-05-02    3: #include <string.h>
303b2de493 2019-05-02    4: #include <tcl.h>
32b55a907b 2019-05-02    5: 
32b55a907b 2019-05-02    6: #define XVFS_NAME_LOOKUP_ERROR (-1)
32b55a907b 2019-05-02    7: #define MIN(a, b) (((a) < (b)) ? (a) : (b))
303b2de493 2019-05-02    8: 
303b2de493 2019-05-02    9: typedef enum {
303b2de493 2019-05-02   10: 	XVFS_FILE_TYPE_REG,
303b2de493 2019-05-02   11: 	XVFS_FILE_TYPE_DIR
303b2de493 2019-05-02   12: } xvfs_file_type_t;
303b2de493 2019-05-02   13: 
303b2de493 2019-05-02   14: typedef Tcl_WideInt xvfs_size_t;
303b2de493 2019-05-02   15: 
303b2de493 2019-05-02   16: struct xvfs_file_data {
303b2de493 2019-05-02   17: 	const char          *name;
303b2de493 2019-05-02   18: 	xvfs_file_type_t    type;
303b2de493 2019-05-02   19: 	xvfs_size_t         size;
32b55a907b 2019-05-02   20: 	union {
32b55a907b 2019-05-02   21: 		const unsigned char *fileContents;
32b55a907b 2019-05-02   22: 		const char          **dirChildren;
32b55a907b 2019-05-02   23: 	} data;
303b2de493 2019-05-02   24: };
47dcf5fc27 2019-05-01   25: 
47dcf5fc27 2019-05-01   26: <?
47dcf5fc27 2019-05-01   27: 	package require xvfs
47dcf5fc27 2019-05-01   28: 	xvfs::main $argv
47dcf5fc27 2019-05-01   29: ?>
32b55a907b 2019-05-02   30: static long xvfs_<?= $::xvfs::fsName ?>_nameToIndex(const char *path) {
32b55a907b 2019-05-02   31: 	if (path == NULL) {
32b55a907b 2019-05-02   32: 		return(XVFS_NAME_LOOKUP_ERROR);
32b55a907b 2019-05-02   33: 	}
32b55a907b 2019-05-02   34: 
32b55a907b 2019-05-02   35: <?	for {set index 0} {$index < [llength $::xvfs::outputFiles]} {incr index} {
32b55a907b 2019-05-02   36: 		set outputFile [lindex $::xvfs::outputFiles $index]
32b55a907b 2019-05-02   37: ?>
32b55a907b 2019-05-02   38: 	if (strcmp(path, "<?= [::xvfs::sanitizeCString $outputFile] ?>") == 0) {
32b55a907b 2019-05-02   39: 		return(<?= $index ?>);
32b55a907b 2019-05-02   40: 	}
32b55a907b 2019-05-02   41: <?	} ?>
32b55a907b 2019-05-02   42: 	return(XVFS_NAME_LOOKUP_ERROR);
32b55a907b 2019-05-02   43: }
32b55a907b 2019-05-02   44: 
32b55a907b 2019-05-02   45: static const char **xvfs_<?= $::xvfs::fsName ?>_getChildren(const char *path, Tcl_WideInt *count) {
32b55a907b 2019-05-02   46: 	struct xvfs_file_data *fileInfo;
32b55a907b 2019-05-02   47: 	long inode;
32b55a907b 2019-05-02   48: 
32b55a907b 2019-05-02   49: 	/*
32b55a907b 2019-05-02   50: 	 * Validate input parameters
32b55a907b 2019-05-02   51: 	 */
32b55a907b 2019-05-02   52: 	if (count == NULL) {
32b55a907b 2019-05-02   53: 		return(NULL);
32b55a907b 2019-05-02   54: 	}
32b55a907b 2019-05-02   55: 	
32b55a907b 2019-05-02   56: 	/*
32b55a907b 2019-05-02   57: 	 * Get the inode from the lookup function
32b55a907b 2019-05-02   58: 	 */
32b55a907b 2019-05-02   59: 	inode = xvfs_<?= $::xvfs::fsName ?>_nameToIndex(path);
32b55a907b 2019-05-02   60: 	if (inode == XVFS_NAME_LOOKUP_ERROR) {
32b55a907b 2019-05-02   61: 		return(NULL);
32b55a907b 2019-05-02   62: 	}
32b55a907b 2019-05-02   63: 	
32b55a907b 2019-05-02   64: 	fileInfo = &xvfs_<?= $::xvfs::fsName ?>_data[inode];
303b2de493 2019-05-02   65: 
32b55a907b 2019-05-02   66: 	/*
32b55a907b 2019-05-02   67: 	 * Ensure this is a directory
32b55a907b 2019-05-02   68: 	 */
32b55a907b 2019-05-02   69: 	if (fileInfo->type != XVFS_FILE_TYPE_DIR) {
32b55a907b 2019-05-02   70: 		return(NULL);
32b55a907b 2019-05-02   71: 	}
32b55a907b 2019-05-02   72: 	
32b55a907b 2019-05-02   73: 	*count = fileInfo->size;
32b55a907b 2019-05-02   74: 	return(fileInfo->data.dirChildren);
47dcf5fc27 2019-05-01   75: }
47dcf5fc27 2019-05-01   76: 
32b55a907b 2019-05-02   77: static const unsigned char *xvfs_<?= $::xvfs::fsName ?>_getData(const char *path, Tcl_WideInt start, Tcl_WideInt *length) {
32b55a907b 2019-05-02   78: 	struct xvfs_file_data *fileInfo;
32b55a907b 2019-05-02   79: 	Tcl_WideInt resultLength;
32b55a907b 2019-05-02   80: 	long inode;
32b55a907b 2019-05-02   81: 
32b55a907b 2019-05-02   82: 	/*
32b55a907b 2019-05-02   83: 	 * Validate input parameters
32b55a907b 2019-05-02   84: 	 */
32b55a907b 2019-05-02   85: 	if (start < 0) {
32b55a907b 2019-05-02   86: 		return(NULL);
32b55a907b 2019-05-02   87: 	}
32b55a907b 2019-05-02   88: 	
32b55a907b 2019-05-02   89: 	if (length == NULL) {
32b55a907b 2019-05-02   90: 		return(NULL);
32b55a907b 2019-05-02   91: 	}
32b55a907b 2019-05-02   92: 	
32b55a907b 2019-05-02   93: 	if (*length < 0) {
32b55a907b 2019-05-02   94: 		return(NULL);
32b55a907b 2019-05-02   95: 	}
32b55a907b 2019-05-02   96: 	
32b55a907b 2019-05-02   97: 	/*
32b55a907b 2019-05-02   98: 	 * Get the inode from the lookup function
32b55a907b 2019-05-02   99: 	 */
32b55a907b 2019-05-02  100: 	inode = xvfs_<?= $::xvfs::fsName ?>_nameToIndex(path);
32b55a907b 2019-05-02  101: 	if (inode == XVFS_NAME_LOOKUP_ERROR) {
32b55a907b 2019-05-02  102: 		return(NULL);
32b55a907b 2019-05-02  103: 	}
32b55a907b 2019-05-02  104: 	
32b55a907b 2019-05-02  105: 	fileInfo = &xvfs_<?= $::xvfs::fsName ?>_data[inode];
32b55a907b 2019-05-02  106: 
32b55a907b 2019-05-02  107: 	/*
32b55a907b 2019-05-02  108: 	 * Ensure this is a file that can be read
32b55a907b 2019-05-02  109: 	 */
32b55a907b 2019-05-02  110: 	if (fileInfo->type != XVFS_FILE_TYPE_REG) {
32b55a907b 2019-05-02  111: 		return(NULL);
32b55a907b 2019-05-02  112: 	}
32b55a907b 2019-05-02  113: 
32b55a907b 2019-05-02  114: 	/*
32b55a907b 2019-05-02  115: 	 * Validate the length
32b55a907b 2019-05-02  116: 	 */
32b55a907b 2019-05-02  117: 	if (start > fileInfo->size) {
32b55a907b 2019-05-02  118: 		*length = -1;
32b55a907b 2019-05-02  119: 		return(NULL);
32b55a907b 2019-05-02  120: 	}
32b55a907b 2019-05-02  121: 
32b55a907b 2019-05-02  122: 	if (*length == 0) {
32b55a907b 2019-05-02  123: 		resultLength = fileInfo->size - start;
32b55a907b 2019-05-02  124: 	} else {
32b55a907b 2019-05-02  125: 		resultLength = MIN(fileInfo->size - start, *length);
32b55a907b 2019-05-02  126: 	}
32b55a907b 2019-05-02  127: 	*length = resultLength;
32b55a907b 2019-05-02  128: 	
32b55a907b 2019-05-02  129: 	/*
32b55a907b 2019-05-02  130: 	 * Return the data
32b55a907b 2019-05-02  131: 	 */
32b55a907b 2019-05-02  132: 	return(fileInfo->data.fileContents + start);
47dcf5fc27 2019-05-01  133: }
47dcf5fc27 2019-05-01  134: 
69e476dcd5 2019-05-02  135: int Xvfs_<?= $::xvfs::fsName ?>_Init(Tcl_Interp *interp) {
e5b6962adf 2019-05-02  136: 	struct Xvfs_FSInfo fsInfo = {
e5b6962adf 2019-05-02  137: 		.protocolVersion = XVFS_PROTOCOL_VERSION,
e5b6962adf 2019-05-02  138: 		.fsName          = "<?= $::xvfs::fsName ?>",
e5b6962adf 2019-05-02  139: 		.getChildrenProc = xvfs_<?= $::xvfs::fsName ?>_getChildren,
e5b6962adf 2019-05-02  140: 		.getDataProc     = xvfs_<?= $::xvfs::fsName ?>_getData
e5b6962adf 2019-05-02  141: 	};
f74a2e47ab 2019-05-02  142: 	int register_ret;
e5b6962adf 2019-05-02  143: 
e5b6962adf 2019-05-02  144: #ifdef USE_TCL_STUBS
e5b6962adf 2019-05-02  145: 	const char *tclInitStubs_ret;
e5b6962adf 2019-05-02  146: 	/* Initialize Stubs */
e5b6962adf 2019-05-02  147: 	tclInitStubs_ret = Tcl_InitStubs(interp, TCL_PATCH_LEVEL, 0);
e5b6962adf 2019-05-02  148: 	if (!tclInitStubs_ret) {
e5b6962adf 2019-05-02  149: 		return(TCL_ERROR);
e5b6962adf 2019-05-02  150: 	}
e5b6962adf 2019-05-02  151: #endif
f74a2e47ab 2019-05-02  152: 	
e5b6962adf 2019-05-02  153: 	register_ret = Xvfs_Register(interp, &fsInfo);
f74a2e47ab 2019-05-02  154: 	if (register_ret != TCL_OK) {
f74a2e47ab 2019-05-02  155: 		return(register_ret);
f74a2e47ab 2019-05-02  156: 	}
f74a2e47ab 2019-05-02  157: 	
f74a2e47ab 2019-05-02  158: 	return(TCL_OK);
47dcf5fc27 2019-05-01  159: }