Newer
Older
*rval = JSVAL_TRUE;
js_writebin(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
BYTE b;
WORD w;
DWORD l;
int32 val=0;
*rval = JSVAL_FALSE;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
if(p->fp==NULL)
return(JS_TRUE);
if(!JS_ValueToInt32(cx,argv[0],&val))
return(JS_FALSE);
if(argc>1) {
if(!JS_ValueToInt32(cx,argv[1],(int32*)&size))
return(JS_FALSE);
}
switch(size) {
case sizeof(BYTE):
b = (BYTE)val;
wr=fwrite(&b,1,size,p->fp);
w = (WORD)val;
if(p->network_byte_order)
w=htons(w);
wr=fwrite(&w,1,size,p->fp);
if(p->network_byte_order)
l=htonl(l);
wr=fwrite(&l,1,size,p->fp);
break;
default:
/* unknown size */
dbprintf(TRUE, p, "unsupported binary write size: %d",size);
*rval = JSVAL_TRUE;
return(JS_TRUE);
}
static JSBool
js_writeall(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
{
jsuint i;
jsuint limit;
JSObject* array;
jsval elemval;
private_t* p;
*rval = JSVAL_FALSE;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
if(p->fp==NULL)
return(JS_TRUE);
if(!JSVAL_IS_OBJECT(argv[0]))
return(JS_TRUE);
array = JSVAL_TO_OBJECT(argv[0]);
if(!JS_IsArrayObject(cx, array))
return(JS_TRUE);
if(!JS_GetArrayLength(cx, array, &limit))
return(JS_FALSE);
*rval = JSVAL_TRUE;
for(i=0;i<limit;i++) {
if(!JS_GetElement(cx, array, i, &elemval))
break;
js_writeln(cx, obj, 1, &elemval, rval);
if(*rval!=JSVAL_TRUE)
}
return(JS_TRUE);
}
js_lock(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
int32 offset=0;
int32 len=0;
*rval = JSVAL_FALSE;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
if(p->fp==NULL)
return(JS_TRUE);
/* offset */
if(argc) {
if(!JS_ValueToInt32(cx,argv[0],&offset))
return(JS_FALSE);
}
/* length */
if(argc>1) {
if(!JS_ValueToInt32(cx,argv[1],&len))
return(JS_FALSE);
}
if(len==0)
len=filelength(fileno(p->fp))-offset;
if(lock(fileno(p->fp),offset,len)==0)
*rval = JSVAL_TRUE;
js_unlock(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
int32 offset=0;
int32 len=0;
*rval = JSVAL_FALSE;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
if(p->fp==NULL)
return(JS_TRUE);
/* offset */
if(argc) {
if(!JS_ValueToInt32(cx,argv[0],&offset))
return(JS_FALSE);
}
/* length */
if(argc>1) {
if(!JS_ValueToInt32(cx,argv[1],&len))
return(JS_FALSE);
}
if(len==0)
len=filelength(fileno(p->fp))-offset;
if(unlock(fileno(p->fp),offset,len)==0)
*rval = JSVAL_TRUE;
return(JS_TRUE);
}
static JSBool
js_delete(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
{
private_t* p;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
if(p->fp!=NULL) { /* close it if it's open */
fclose(p->fp);
p->fp=NULL;
}
*rval = BOOLEAN_TO_JSVAL(remove(p->name)==0);
return(JS_TRUE);
}
static JSBool
js_flush(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
{
private_t* p;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
*rval = JSVAL_FALSE;
else
*rval = BOOLEAN_TO_JSVAL(fflush(p->fp)==0);
return(JS_TRUE);
}
static JSBool
js_rewind(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
{
private_t* p;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
return(JS_FALSE);
}
if(p->fp==NULL)
*rval = JSVAL_FALSE;
else {
*rval = JSVAL_TRUE;
rewind(p->fp);
}
return(JS_TRUE);
}
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
static JSBool
js_truncate(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
{
private_t* p;
int32 len=0;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
return(JS_FALSE);
}
if(argc) {
if(!JS_ValueToInt32(cx,argv[0],&len))
return(JS_FALSE);
}
*rval = JSVAL_FALSE;
if(p->fp!=NULL && chsize(fileno(p->fp),len)==0) {
fseek(p->fp,len,SEEK_SET);
*rval = JSVAL_TRUE;
}
return(JS_TRUE);
}
static JSBool
js_clear_error(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
{
private_t* p;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
*rval = JSVAL_FALSE;
else {
clearerr(p->fp);
*rval = JSVAL_TRUE;
}
return(JS_TRUE);
}
static JSBool
js_fprintf(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
{
char* cp;
private_t* p;
*rval = JSVAL_FALSE;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
if(p->fp==NULL)
return(JS_TRUE);
if((cp=js_sprintf(cx, 0, argc, argv))==NULL) {
JS_ReportError(cx,"js_sprintf failed");
*rval = INT_TO_JSVAL(fwrite(cp,1,strlen(cp),p->fp));
js_sprintf_free(cp);
return(JS_TRUE);
}
/* File Object Properites */
enum {
FILE_PROP_NAME
,FILE_PROP_MODE
,FILE_PROP_ETX
,FILE_PROP_EXISTS
,FILE_PROP_DATE
,FILE_PROP_IS_OPEN
,FILE_PROP_EOF
,FILE_PROP_ERROR
,FILE_PROP_DESCRIPTOR
,FILE_PROP_DEBUG
,FILE_PROP_POSITION
,FILE_PROP_LENGTH
,FILE_PROP_ATTRIBUTES
,FILE_PROP_YENCODED
,FILE_PROP_UUENCODED
,FILE_PROP_B64ENCODED
,FILE_PROP_ROT13
,FILE_PROP_NETWORK_ORDER
/* dynamically calculated */
,FILE_PROP_CHKSUM
,FILE_PROP_CRC16
,FILE_PROP_CRC32
,FILE_PROP_MD5_HEX
,FILE_PROP_MD5_B64
static JSBool js_file_set(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
int32 i=0;
jsint tiny;
private_t* p;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
tiny = JSVAL_TO_INT(id);
dbprintf(FALSE, p, "setting property %d",tiny);
switch(tiny) {
case FILE_PROP_DEBUG:
JS_ValueToBoolean(cx,*vp,&(p->debug));
case FILE_PROP_YENCODED:
JS_ValueToBoolean(cx,*vp,&(p->yencoded));
break;
case FILE_PROP_UUENCODED:
JS_ValueToBoolean(cx,*vp,&(p->uuencoded));
break;
case FILE_PROP_B64ENCODED:
JS_ValueToBoolean(cx,*vp,&(p->b64encoded));
break;
case FILE_PROP_ROT13:
JS_ValueToBoolean(cx,*vp,&(p->rot13));
break;
case FILE_PROP_NETWORK_ORDER:
JS_ValueToBoolean(cx,*vp,&(p->network_byte_order));
break;
case FILE_PROP_POSITION:
if(p->fp!=NULL) {
if(!JS_ValueToInt32(cx,*vp,&i))
return(JS_FALSE);
fseek(p->fp,i,SEEK_SET);
}
case FILE_PROP_DATE:
if(!JS_ValueToInt32(cx,*vp,&i))
return(JS_FALSE);
setfdate(p->name,i);
break;
if(p->fp!=NULL) {
if(!JS_ValueToInt32(cx,*vp,&i))
return(JS_FALSE);
chsize(fileno(p->fp),i);
}
break;
case FILE_PROP_ATTRIBUTES:
if(!JS_ValueToInt32(cx,*vp,&i))
return(JS_FALSE);
CHMOD(p->name,i);
if(!JS_ValueToInt32(cx,*vp,&i))
return(JS_FALSE);
p->etx = (uchar)i;
}
return(JS_TRUE);
}
static JSBool js_file_get(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
{
char str[128];
size_t i;
size_t rd;
long offset;
ulong sum=0;
ushort c16=0;
ulong c32=~0;
MD5 md5_ctx;
BYTE block[4096];
BYTE digest[MD5_DIGEST_SIZE];
JSString* js_str=NULL;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL) {
JS_ReportError(cx,getprivate_failure,WHERE);
tiny = JSVAL_TO_INT(id);
#if 0 /* just too much */
dbprintf(FALSE, sock, "getting property %d",tiny);
#endif
switch(tiny) {
case FILE_PROP_NAME:
if((js_str=JS_NewStringCopyZ(cx, p->name))==NULL)
return(JS_FALSE);
*vp = STRING_TO_JSVAL(js_str);
break;
case FILE_PROP_MODE:
if((js_str=JS_NewStringCopyZ(cx, p->mode))==NULL)
return(JS_FALSE);
*vp = STRING_TO_JSVAL(js_str);
break;
case FILE_PROP_EXISTS:
if(p->fp) /* open? */
*vp = JSVAL_TRUE;
*vp = BOOLEAN_TO_JSVAL(fexistcase(p->name));
break;
case FILE_PROP_DATE:
JS_NewNumberValue(cx,fdate(p->name),vp);
break;
case FILE_PROP_IS_OPEN:
*vp = BOOLEAN_TO_JSVAL(p->fp!=NULL);
break;
case FILE_PROP_EOF:
if(p->fp)
*vp = BOOLEAN_TO_JSVAL(feof(p->fp)!=0);
else
*vp = JSVAL_TRUE;
break;
case FILE_PROP_ERROR:
if(p->fp)
*vp = INT_TO_JSVAL(ferror(p->fp));
else
*vp = INT_TO_JSVAL(errno);
break;
case FILE_PROP_POSITION:
if(p->fp)
JS_NewNumberValue(cx,ftell(p->fp),vp);
else
*vp = INT_TO_JSVAL(-1);
break;
case FILE_PROP_LENGTH:
if(p->fp) /* open? */
JS_NewNumberValue(cx,filelength(fileno(p->fp)),vp);
JS_NewNumberValue(cx,flength(p->name),vp);
break;
case FILE_PROP_ATTRIBUTES:
JS_NewNumberValue(cx,getfattr(p->name),vp);
break;
case FILE_PROP_DEBUG:
*vp = BOOLEAN_TO_JSVAL(p->debug);
break;
case FILE_PROP_YENCODED:
*vp = BOOLEAN_TO_JSVAL(p->yencoded);
break;
case FILE_PROP_UUENCODED:
*vp = BOOLEAN_TO_JSVAL(p->uuencoded);
case FILE_PROP_B64ENCODED:
*vp = BOOLEAN_TO_JSVAL(p->b64encoded);
break;
case FILE_PROP_ROT13:
*vp = BOOLEAN_TO_JSVAL(p->rot13);
break;
case FILE_PROP_NETWORK_ORDER:
*vp = BOOLEAN_TO_JSVAL(p->network_byte_order);
break;
case FILE_PROP_DESCRIPTOR:
if(p->fp)
*vp = INT_TO_JSVAL(fileno(p->fp));
else
*vp = INT_TO_JSVAL(-1);
case FILE_PROP_ETX:
*vp = INT_TO_JSVAL(p->etx);
break;
case FILE_PROP_CHKSUM:
case FILE_PROP_CRC16:
case FILE_PROP_CRC32:
*vp = JSVAL_ZERO;
if(p->fp==NULL)
break;
/* fall-through */
case FILE_PROP_MD5_HEX:
case FILE_PROP_MD5_B64:
*vp = JSVAL_VOID;
if(p->fp==NULL)
break;
offset=ftell(p->fp); /* save current file position */
fseek(p->fp,0,SEEK_SET);
/* Initialization */
switch(tiny) {
case FILE_PROP_MD5_HEX:
case FILE_PROP_MD5_B64:
MD5_open(&md5_ctx);
break;
}
/* calculate */
while(!feof(p->fp)) {
if((rd=fread(block,1,sizeof(block),p->fp))<1)
break;
switch(tiny) {
case FILE_PROP_CHKSUM:
for(i=0;i<rd;i++)
sum+=block[i];
break;
case FILE_PROP_CRC16:
for(i=0;i<rd;i++)
c16=ucrc16(block[i],c16);
break;
case FILE_PROP_CRC32:
for(i=0;i<rd;i++)
c32=ucrc32(block[i],c32);
break;
case FILE_PROP_MD5_HEX:
case FILE_PROP_MD5_B64:
MD5_digest(&md5_ctx,block,rd);
break;
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
}
}
/* finalize */
switch(tiny) {
case FILE_PROP_CHKSUM:
JS_NewNumberValue(cx,sum,vp);
break;
case FILE_PROP_CRC16:
if(!JS_NewNumberValue(cx,c16,vp))
*vp=JSVAL_ZERO;
break;
case FILE_PROP_CRC32:
if(!JS_NewNumberValue(cx,~c32,vp))
*vp=JSVAL_ZERO;
break;
case FILE_PROP_MD5_HEX:
case FILE_PROP_MD5_B64:
MD5_close(&md5_ctx,digest);
if(tiny==FILE_PROP_MD5_HEX)
MD5_hex(str,digest);
else
b64_encode(str,sizeof(str)-1,digest,sizeof(digest));
js_str=JS_NewStringCopyZ(cx, str);
break;
}
fseek(p->fp,offset,SEEK_SET); /* restore saved file position */
if(js_str!=NULL)
*vp = STRING_TO_JSVAL(js_str);
break;
}
#define FILE_PROP_FLAGS JSPROP_ENUMERATE|JSPROP_READONLY
static jsSyncPropertySpec js_file_properties[] = {
/* name ,tinyid ,flags, ver */
{ "name" ,FILE_PROP_NAME ,FILE_PROP_FLAGS, 310},
{ "mode" ,FILE_PROP_MODE ,FILE_PROP_FLAGS, 310},
{ "exists" ,FILE_PROP_EXISTS ,FILE_PROP_FLAGS, 310},
{ "is_open" ,FILE_PROP_IS_OPEN ,FILE_PROP_FLAGS, 310},
{ "eof" ,FILE_PROP_EOF ,FILE_PROP_FLAGS, 310},
{ "error" ,FILE_PROP_ERROR ,FILE_PROP_FLAGS, 310},
{ "descriptor" ,FILE_PROP_DESCRIPTOR ,FILE_PROP_FLAGS, 310},
{ "etx" ,FILE_PROP_ETX ,JSPROP_ENUMERATE, 310},
{ "debug" ,FILE_PROP_DEBUG ,JSPROP_ENUMERATE, 310},
{ "position" ,FILE_PROP_POSITION ,JSPROP_ENUMERATE, 310},
{ "date" ,FILE_PROP_DATE ,JSPROP_ENUMERATE, 311},
{ "length" ,FILE_PROP_LENGTH ,JSPROP_ENUMERATE, 310},
{ "attributes" ,FILE_PROP_ATTRIBUTES ,JSPROP_ENUMERATE, 310},
{ "network_byte_order",FILE_PROP_NETWORK_ORDER,JSPROP_ENUMERATE, 311},
{ "rot13" ,FILE_PROP_ROT13 ,JSPROP_ENUMERATE, 311},
{ "uue" ,FILE_PROP_UUENCODED ,JSPROP_ENUMERATE, 311},
{ "yenc" ,FILE_PROP_YENCODED ,JSPROP_ENUMERATE, 311},
{ "base64" ,FILE_PROP_B64ENCODED ,JSPROP_ENUMERATE, 311},
/* dynamically calculated */
{ "crc16" ,FILE_PROP_CRC16 ,FILE_PROP_FLAGS, 311},
{ "crc32" ,FILE_PROP_CRC32 ,FILE_PROP_FLAGS, 311},
{ "chksum" ,FILE_PROP_CHKSUM ,FILE_PROP_FLAGS, 311},
{ "md5_hex" ,FILE_PROP_MD5_HEX ,FILE_PROP_FLAGS, 311},
{ "md5_base64" ,FILE_PROP_MD5_B64 ,FILE_PROP_FLAGS, 311},
#ifdef BUILD_JSDOCS
static char* file_prop_desc[] = {
"filename specified in constructor - <small>READ ONLY</small>"
,"mode string specified in <i>open</i> call - <small>READ ONLY</small>"
,"<i>true</i> if the file exists - <small>READ ONLY</small>"
,"<i>true</i> if the file has been opened successfully - <small>READ ONLY</small>"
,"<i>true</i> if the current file position is at the <i>end of file</i> - <small>READ ONLY</small>"
,"the last occurred error value (use clear_error to clear) - <small>READ ONLY</small>"
,"the open file descriptor (advanced use only) - <small>READ ONLY</small>"
,"end-of-text character (advanced use only), if non-zero used by <i>read</i>, <i>readln</i>, and <i>write</i>"
,"the current file position (offset in bytes), change value to seek within file"
,"last modified date/time (in time_t format)"
,"the current length of the file (in bytes)"
,"file mode/attributes"
,"set to <i>true</i> if binary data is to be written and read in Network Byte Order (big end first)"
,"set to <i>true</i> to enable automatic ROT13 translatation of text"
,"set to <i>true</i> to enable automatic Unix-to-Unix encode and decode on <tt>read</tt> and <tt>write</tt> calls"
,"set to <i>true</i> to enable automatic yEnc encode and decode on <tt>read</tt> and <tt>write</tt> calls"
,"set to <i>true</i> to enable automatic Base64 encode and decode on <tt>read</tt> and <tt>write</tt> calls"
,"calculated 16-bit CRC of file contents - <small>READ ONLY</small>"
,"calculated 32-bit CRC of file contents - <small>READ ONLY</small>"
,"calculated 32-bit checksum of file contents - <small>READ ONLY</small>"
,"calculated 128-bit MD5 digest of file contents as hexadecimal string - <small>READ ONLY</small>"
,"calculated 128-bit MD5 digest of file contents as base64-encoded string - <small>READ ONLY</small>"
static jsSyncMethodSpec js_file_functions[] = {
{"open", js_open, 1, JSTYPE_BOOLEAN, JSDOCSTR("[mode=<tt>\"w+\"</tt>] [,shareable=<tt>false</tt>] [,buffer_length]")
,JSDOCSTR("open file, <i>shareable</i> defaults to <i>false</i>, <i>buffer_length</i> defaults to 2048 bytes, "
"mode (default: <tt>'w+'</tt>) specifies the type of access requested for the file, as follows:<br>"
"<tt>r </tt> open for reading; if the file does not exist or cannot be found, the open call fails<br>"
"<tt>w </tt> open an empty file for writing; if the given file exists, its contents are destroyed<br>"
"<tt>a </tt> open for writing at the end of the file (appending); creates the file first if it doesnt exist<br>"
"<tt>r+</tt> open for both reading and writing (the file must exist)<br>"
"<tt>w+</tt> open an empty file for both reading and writing; if the given file exists, its contents are destroyed<br>"
"<tt>a+</tt> open for reading and appending<br>"
"<tt>b </tt> open in binary (untranslated) mode; translations involving carriage-return and linefeed characters are suppressed (e.g. <tt>r+b</tt>)<br>"
"<tt>e </tt> open a <i>non-shareable</i> file (that must not already exist) for <i>exclusive</i> access <i>(introduced in v3.12)</i><br>"
"<br><b>Note:</b> When using the <tt>iniSet</tt> methods to modify a <tt>.ini</tt> file, "
"the file must be opened for both reading and writing.<br>"
"<br><b>Note:</b> To open an existing or create a new file for both reading and writing, "
"use the <i>file_exists</i> function like so:<br>"
"<tt>file.open(file_exists(file.name) ? 'r+':'w+');</tt>"
,310
{"close", js_close, 0, JSTYPE_VOID, JSDOCSTR("")
,JSDOCSTR("close file")
,310
{"remove", js_delete, 0, JSTYPE_BOOLEAN, JSDOCSTR("")
,JSDOCSTR("remove the file from the disk")
,310
{"clearError", js_clear_error, 0, JSTYPE_ALIAS },
{"clear_error", js_clear_error, 0, JSTYPE_BOOLEAN, JSDOCSTR("")
,JSDOCSTR("clears the current error value (AKA clearError)")
,310
{"flush", js_flush, 0, JSTYPE_BOOLEAN, JSDOCSTR("")
,310
{"rewind", js_rewind, 0, JSTYPE_BOOLEAN, JSDOCSTR("")
,JSDOCSTR("repositions the file pointer (<i>position</i>) to the beginning of a file "
"and clears error and end-of-file indicators")
,311
{"truncate", js_truncate, 0, JSTYPE_BOOLEAN, JSDOCSTR("[length=<tt>0</tt>]")
,JSDOCSTR("changes the file <i>length</i> (default: 0) and repositions the file pointer "
"(<i>position</i>) to the new end-of-file")
,31301
},
{"lock", js_lock, 2, JSTYPE_BOOLEAN, JSDOCSTR("[offset=<tt>0</tt>] [,length=<i>file_length</i>-<i>offset</i>]")
,JSDOCSTR("lock file record for exclusive access (file must be opened <i>shareable</i>)")
,310
{"unlock", js_unlock, 2, JSTYPE_BOOLEAN, JSDOCSTR("[offset=<tt>0</tt>] [,length=<i>file_length</i>-<i>offset</i>]")
,JSDOCSTR("unlock file record for exclusive access")
,310
{"read", js_read, 0, JSTYPE_STRING, JSDOCSTR("[maxlen=<i>file_length</i>-<i>file_position</i>]")
,JSDOCSTR("read a string from file (optionally unix-to-unix or base64 decoding in the process), "
"<i>maxlen</i> defaults to the current length of the file minus the current file position")
,310
{"readln", js_readln, 0, JSTYPE_STRING, JSDOCSTR("[maxlen=<tt>512</tt>]")
,JSDOCSTR("read a line-feed terminated string, <i>maxlen</i> defaults to 512 characters")
,310
{"readBin", js_readbin, 0, JSTYPE_NUMBER, JSDOCSTR("[bytes=<tt>4</tt>]")
,JSDOCSTR("read a binary integer from the file, default number of <i>bytes</i> is 4 (32-bits)")
,310
{"readAll", js_readall, 0, JSTYPE_ARRAY, JSDOCSTR("")
,JSDOCSTR("read all lines into an array of strings")
,310
{"write", js_write, 1, JSTYPE_BOOLEAN, JSDOCSTR("text [,length=<i>text_length</i>]")
,JSDOCSTR("write a string to the file (optionally unix-to-unix or base64 decoding in the process)")
,310
{"writeln", js_writeln, 0, JSTYPE_BOOLEAN, JSDOCSTR("[text]")
,JSDOCSTR("write a line-feed terminated string to the file")
,310
{"writeBin", js_writebin, 1, JSTYPE_BOOLEAN, JSDOCSTR("value [,bytes=<tt>4</tt>]")
,JSDOCSTR("write a binary integer to the file, default number of <i>bytes</i> is 4 (32-bits)")
,310
{"writeAll", js_writeall, 0, JSTYPE_BOOLEAN, JSDOCSTR("array lines")
,JSDOCSTR("write an array of strings to file")
,310
{"printf", js_fprintf, 0, JSTYPE_NUMBER, JSDOCSTR("format [,args]")
,JSDOCSTR("write a formatted string to the file (ala fprintf) - "
"<small>CAUTION: for experienced C programmers ONLY</small>")
,310
{"iniGetSections", js_iniGetSections, 0, JSTYPE_ARRAY, JSDOCSTR("[prefix=<i>none</i>]")
,JSDOCSTR("parse all section names from a <tt>.ini</tt> file (format = '<tt>[section]</tt>') "
"and return the section names as an <i>array of strings</i>, "
"optionally, only those section names that begin with the specified <i>prefix</i>")
,311
{"iniGetKeys", js_iniGetKeys, 1, JSTYPE_ARRAY, JSDOCSTR("[section=<i>root</i>]")
,JSDOCSTR("parse all key names from the specified <i>section</i> in a <tt>.ini</tt> file "
"and return the key names as an <i>array of strings</i>. "
"if <i>section</i> is undefined, returns key names from the <i>root</i> section")
,311
{"iniGetValue", js_iniGetValue, 3, JSTYPE_UNDEF, JSDOCSTR("section, key [,default=<i>none</i>]")
,JSDOCSTR("parse a key from a <tt>.ini</tt> file and return its value (format = '<tt>key = value</tt>'). "
"returns the specified <i>default</i> value if the key or value is missing or invalid. "
"to parse a key from the <i>root</i> section, pass <i>null</i> for <i>section</i>. "
"will return a <i>bool</i>, <i>number</i>, <i>string</i>, or an <i>array of strings</i> "
"determined by the type of <i>default</i> value specified")
,311
{"iniSetValue", js_iniSetValue, 3, JSTYPE_BOOLEAN, JSDOCSTR("section, key, [value=<i>none</i>]")
,JSDOCSTR("set the specified <i>key</i> to the specified <i>value</i> in the specified <i>section</i> "
"of a <tt>.ini</tt> file. "
"to set a key in the <i>root</i> section, pass <i>null</i> for <i>section</i>. ")
,312
{"iniGetObject", js_iniGetObject, 1, JSTYPE_OBJECT, JSDOCSTR("[section=<i>root</i>]")
,JSDOCSTR("parse an entire section from a .ini file "
"and return all of its keys and values as properties of an object. "
"if <i>section</i> is undefined, returns key and values from the <i>root</i> section")
,311
{"iniSetObject", js_iniSetObject, 2, JSTYPE_BOOLEAN, JSDOCSTR("section, object")
,JSDOCSTR("write all the properties of the specified <i>object</i> as separate <tt>key=value</tt> pairs "
"in the specified <i>section</i> of a <tt>.ini</tt> file. "
"to write an object in the <i>root</i> section, pass <i>null</i> for <i>section</i>. ")
,312
{"iniGetAllObjects",js_iniGetAllObjects,1, JSTYPE_ARRAY, JSDOCSTR("[name_property] [,prefix=<i>none</i>]")
,JSDOCSTR("parse all sections from a .ini file and return all (non-<i>root</i>) sections "
"in an array of objects with each section's keys as properties of each object. "
"<i>name_property</i> is the name of the property to create to contain the section's name "
"(default is <tt>\"name\"</tt>), "
"the optional <i>prefix</i> has the same use as in the <tt>iniGetSections</tt> method, "
"if a <i>prefix</i> is specified, it is removed from each section's name" )
,311
{"iniSetAllObjects",js_iniSetAllObjects,1, JSTYPE_ARRAY, JSDOCSTR("object array [,name_property=<tt>\"name\"</tt>]")
,JSDOCSTR("write an array of objects to a .ini file, each object in its own section named "
"after the object's <i>name_property</i> (default: <tt>name</tt>)")
,312
},
{"iniRemoveKey", js_iniRemoveKey, 2, JSTYPE_BOOLEAN, JSDOCSTR("section, key")
,JSDOCSTR("remove specified <i>key</i> from specified <i>section</i> in <tt>.ini</tt> file.")
,31301
},
{"iniRemoveSection",js_iniRemoveSection,1, JSTYPE_BOOLEAN, JSDOCSTR("section")
,JSDOCSTR("remove specified <i>section</i> from <tt>.ini</tt> file.")
,31301
},
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
/* File Destructor */
static void js_finalize_file(JSContext *cx, JSObject *obj)
{
private_t* p;
if((p=(private_t*)JS_GetPrivate(cx,obj))==NULL)
return;
if(p->external==JS_FALSE && p->fp!=NULL)
fclose(p->fp);
dbprintf(FALSE, p, "closed: %s",p->name);
free(p);
JS_SetPrivate(cx, obj, NULL);
}
static JSClass js_file_class = {
"File" /* name */
,JSCLASS_HAS_PRIVATE /* flags */
,JS_PropertyStub /* addProperty */
,JS_PropertyStub /* delProperty */
,js_file_get /* getProperty */
,js_file_set /* setProperty */
,JS_EnumerateStub /* enumerate */
,JS_ResolveStub /* resolve */
,JS_ConvertStub /* convert */
,js_finalize_file /* finalize */
};
/* File Constructor (creates file descriptor) */
static JSBool
js_file_constructor(JSContext *cx, JSObject *obj, uintN argc, jsval *argv, jsval *rval)
{
JSString* str;
private_t* p;
if((str = JS_ValueToString(cx, argv[0]))==NULL) {
JS_ReportError(cx,"No filename specified");
return(JS_FALSE);
}
*rval = JSVAL_VOID;
if((p=(private_t*)calloc(1,sizeof(private_t)))==NULL) {
JS_ReportError(cx,"calloc failed");
return(JS_FALSE);
}
SAFECOPY(p->name,JS_GetStringBytes(str));
if(!JS_SetPrivate(cx, obj, p)) {
dbprintf(TRUE, p, "JS_SetPrivate failed");
return(JS_FALSE);
}
if(!js_DefineSyncProperties(cx, obj, js_file_properties)) {
dbprintf(TRUE, p, "js_DefineSyncProperties failed");
return(JS_FALSE);
}
if(!js_DefineSyncMethods(cx, obj, js_file_functions, FALSE)) {
dbprintf(TRUE, p, "js_DefineSyncMethods failed");
return(JS_FALSE);
}
#ifdef BUILD_JSDOCS
js_DescribeSyncObject(cx,obj,"Class used for opening, creating, reading, or writing files on the local file system<p>"
"Special features include:</h2><ol type=disc>"
"<li>Exclusive-access files (default) or shared files<ol type=circle>"
"<li>optional record-locking"
"<li>buffered or non-buffered I/O"
"</ol>"
"<li>Support for binary files<ol type=circle>"
"<li>native or network byte order (endian)"
"<li>automatic Unix-to-Unix (<i>UUE</i>), yEncode (<i>yEnc</i>) or Base64 encoding/decoding"
"</ol>"
"<li>Support for ASCII text files<ol type=circle>"
"<li>supports line-based I/O<ol type=square>"
"<li>entire file may be read or written as an array of strings"
"<li>individual lines may be read or written one line at a time"
"</ol>"
"<li>supports fixed-length records<ol type=square>"
"<li>optional end-of-text (<i>etx</i>) character for automatic record padding/termination"
"<li>Synchronet <tt>.dat</tt> files use an <i>etx</i> value of 3 (Ctrl-C)"
"</ol>"
"<li>supports <tt>.ini</tt> formated configuration files<ol type=square>"
"<li>concept and support of <i>root</i> ini sections added in v3.12"
"</ol>"
"<li>optional ROT13 encoding/translation"
"</ol>"
"<li>Dynamically-calculated industry standard checksums (e.g. CRC-16, CRC-32, MD5)"
"</ol>"
,310
js_DescribeSyncConstructor(cx,obj,"To create a new File object: <tt>var f = new File(<i>filename</i>)</tt>");
js_CreateArrayOfStrings(cx, obj, "_property_desc_list", file_prop_desc, JSPROP_READONLY);
#endif
dbprintf(FALSE, p, "object constructed");
return(JS_TRUE);
}
JSObject* DLLCALL js_CreateFileClass(JSContext* cx, JSObject* parent)
{
JSObject* sockobj;
sockobj = JS_InitClass(cx, parent, NULL
,&js_file_class
,js_file_constructor
,1 /* number of constructor args */
,NULL /* props, set in constructor */
,NULL /* funcs, set in constructor */
,NULL,NULL);
return(sockobj);
}
JSObject* DLLCALL js_CreateFileObject(JSContext* cx, JSObject* parent, char *name, FILE* fp)
{
JSObject* obj;
private_t* p;
obj = JS_DefineObject(cx, parent, name, &js_file_class, NULL
,JSPROP_ENUMERATE|JSPROP_READONLY);
if(obj==NULL)
return(NULL);
if(!js_DefineSyncProperties(cx, obj, js_file_properties))
if (!js_DefineSyncMethods(cx, obj, js_file_functions, FALSE))
return(NULL);
if((p=(private_t*)calloc(1,sizeof(private_t)))==NULL)
return(NULL);
p->fp=fp;
p->debug=JS_FALSE;
p->external=JS_TRUE;
if(!JS_SetPrivate(cx, obj, p)) {
dbprintf(TRUE, p, "JS_SetPrivate failed");
return(NULL);
}
dbprintf(FALSE, p, "object created");
return(obj);
}