updated C API to be more focused on supporting just some operations

4 files changed, 59 insertions, 18 deletions

diff --git a/generic/tcl.decls b/generic/tcl.decls
index afeae51..36e92fa 100644
--- a/generic/tcl.decls
+++ b/generic/tcl.decls
@@ -2318,8 +2318,10 @@ declare 629 {
     int Tcl_FSUnloadFile(Tcl_Interp *interp, Tcl_LoadHandle handlePtr)
 }
 
+# TIP #400
 declare 630 {
-    void* Tcl_ZlibStreamGetZstreamp(Tcl_ZlibStream zshandle)
+    void Tcl_ZlibStreamSetCompressionDictionary(Tcl_ZlibStream zhandle,
+	    Tcl_Obj *compressionDictionaryObj)
 }
 
 # ----- BASELINE -- FOR -- 8.6.0 ----- #
diff --git a/generic/tclDecls.h b/generic/tclDecls.h
index 0c1dedf..7c3e1de 100644
--- a/generic/tclDecls.h
+++ b/generic/tclDecls.h
@@ -1808,7 +1808,9 @@ EXTERN void *		Tcl_FindSymbol(Tcl_Interp *interp,
 EXTERN int		Tcl_FSUnloadFile(Tcl_Interp *interp,
 				Tcl_LoadHandle handlePtr);
 /* 630 */
-EXTERN void*		Tcl_ZlibStreamGetZstreamp(Tcl_ZlibStream zshandle);
+EXTERN void		Tcl_ZlibStreamSetCompressionDictionary(
+				Tcl_ZlibStream zhandle,
+				Tcl_Obj *compressionDictionaryObj);
 
 typedef struct TclStubHooks {
     const struct TclPlatStubs *tclPlatStubs;
@@ -2474,7 +2476,7 @@ typedef struct TclStubs {
     int (*tcl_LoadFile) (Tcl_Interp *interp, Tcl_Obj *pathPtr, const char *const symv[], int flags, void *procPtrs, Tcl_LoadHandle *handlePtr); /* 627 */
     void * (*tcl_FindSymbol) (Tcl_Interp *interp, Tcl_LoadHandle handle, const char *symbol); /* 628 */
     int (*tcl_FSUnloadFile) (Tcl_Interp *interp, Tcl_LoadHandle handlePtr); /* 629 */
-    void* (*tcl_ZlibStreamGetZstreamp) (Tcl_ZlibStream zshandle); /* 630 */
+    void (*tcl_ZlibStreamSetCompressionDictionary) (Tcl_ZlibStream zhandle, Tcl_Obj *compressionDictionaryObj); /* 630 */
 } TclStubs;
 
 #ifdef __cplusplus
@@ -3767,8 +3769,8 @@ extern const TclStubs *tclStubsPtr;
 	(tclStubsPtr->tcl_FindSymbol) /* 628 */
 #define Tcl_FSUnloadFile \
 	(tclStubsPtr->tcl_FSUnloadFile) /* 629 */
-#define Tcl_ZlibStreamGetZstreamp \
-	(tclStubsPtr->tcl_ZlibStreamGetZstreamp) /* 630 */
+#define Tcl_ZlibStreamSetCompressionDictionary \
+	(tclStubsPtr->tcl_ZlibStreamSetCompressionDictionary) /* 630 */
 
 #endif /* defined(USE_TCL_STUBS) */
 
diff --git a/generic/tclStubInit.c b/generic/tclStubInit.c
index a74101d..7fb0f1c 100644
--- a/generic/tclStubInit.c
+++ b/generic/tclStubInit.c
@@ -1340,7 +1340,7 @@ const TclStubs tclStubs = {
     Tcl_LoadFile, /* 627 */
     Tcl_FindSymbol, /* 628 */
     Tcl_FSUnloadFile, /* 629 */
-    Tcl_ZlibStreamGetZstreamp, /* 630 */
+    Tcl_ZlibStreamSetCompressionDictionary, /* 630 */
 };
 
 /* !END!: Do not edit above this line. */
diff --git a/generic/tclZlib.c b/generic/tclZlib.c
index 96cda4e..7785dea 100644
--- a/generic/tclZlib.c
+++ b/generic/tclZlib.c
@@ -67,10 +67,15 @@ typedef struct {
     Tcl_Obj *compDictObj;	/* Byte-array object containing compression
 				 * dictionary (not dictObj!) to use if
 				 * necessary. */
+    int flags;			/* Miscellaneous flag bits. */
     GzipHeader *gzHeaderPtr;	/* If we've allocated a gzip header
 				 * structure. */
 } ZlibStreamHandle;
 
+#define DICT_TO_SET	0x1	/* If we need to set a compression dictionary
+				 * in the low-level engine at the next
+				 * opportunity. */
+
 /*
  * Structure used for stacked channel compression and decompression.
  */
@@ -606,6 +611,7 @@ Tcl_ZlibStreamInit(
     zshPtr->currentInput = NULL;
     zshPtr->streamEnd = 0;
     zshPtr->compDictObj = NULL;
+    zshPtr->flags = 0;
     zshPtr->gzHeaderPtr = gzHeaderPtr;
     memset(&zshPtr->stream, 0, sizeof(z_stream));
 
@@ -974,22 +980,32 @@ Tcl_ZlibStreamChecksum(
 /*
  *----------------------------------------------------------------------
  *
- * Tcl_ZlibStreamGetZstreamp --
+ * Tcl_ZlibStreamSetCompressionDictionary --
  *
- *	Return the z_streamp for the stream (though not typed as such, so as
- *	to avoid type interface poisoning).  Shouldn't be used to poke around
- *	excessively.
+ *	Sets the compression dictionary for a stream. This will be used as
+ *	appropriate for the next compression or decompression action performed
+ *	on the stream.
  *
  *----------------------------------------------------------------------
  */
 
-void *
-Tcl_ZlibStreamGetZstreamp(
-    Tcl_ZlibStream zshandle)
+void
+Tcl_ZlibStreamSetCompressionDictionary(
+    Tcl_ZlibStream zhandle,
+    Tcl_Obj *compressionDictionaryObj)
 {
     ZlibStreamHandle *zshPtr = (ZlibStreamHandle *) zshandle;
 
-    return &zshPtr->stream;
+    if (compressionDictionaryObj != NULL) {
+	Tcl_IncrRefCount(compressionDictionaryObj);
+	zshPtr->flags |= DICT_TO_SET;
+    } else {
+	zshPtr->flags &= ~DICT_TO_SET;
+    }
+    if (zshPtr->compDictObj != NULL) {
+	Tcl_DecrRefCount(zshPtr->compDictObj);
+    }
+    zshPtr->compDictObj = compressionDictionaryObj;
 }
 
 /*
@@ -1028,6 +1044,17 @@ Tcl_ZlibStreamPut(
 	zshPtr->stream.next_in = Tcl_GetByteArrayFromObj(data, &size);
 	zshPtr->stream.avail_in = size;
 
+	if (zshPtr->flags & DICT_TO_SET) {
+	    e = SetDeflateDictionary(&zshPtr->stream, zshPtr->compDictObj);
+	    if (e != Z_OK) {
+		if (zshPtr->interp) {
+		    ConvertError(zshPtr->interp, e);
+		}
+		return TCL_ERROR;
+	    }
+	    zshPtr->flags &= ~DICT_TO_SET;
+	}
+
 	/*
 	 * Deflatebound doesn't seem to take various header sizes into
 	 * account, so we add 100 extra bytes.
@@ -1065,6 +1092,12 @@ Tcl_ZlibStreamPut(
 
 	    e = deflate(&zshPtr->stream, flush);
 	}
+	if (e != Z_OK) {
+	    if (zshPtr->interp) {
+		ConvertError(zshPtr->interp, e);
+	    }
+	    return TCL_ERROR;
+	}
 
 	/*
 	 * And append the final data block.
@@ -3345,11 +3378,15 @@ Tcl_ZlibAdler32(
     return 0;
 }
 
-void *
-Tcl_ZlibStreamGetZstreamp(
-    Tcl_ZlibStream zshandle)
+int
+Tcl_ZlibStreamSetCompressionDictionary(
+    Tcl_Interp *interp,
+    Tcl_ZlibStream zhandle,
+    Tcl_Obj *compressionDictionaryObj)
 {
-    return NULL;
+    Tcl_SetResult(interp, "unimplemented", TCL_STATIC);
+    Tcl_SetErrorCode(interp, "TCL", "UNIMPLEMENTED", NULL);
+    return TCL_ERROR;
 }
 #endif /* HAVE_ZLIB */