Skip to content

Commit

Permalink
Remove deprecated mapscript functions (metadata)
Browse files Browse the repository at this point in the history
  • Loading branch information
@geographika
geographika committed May 18, 2021
1 parent c862b04 commit 918637a
Show file tree
Hide file tree
Showing 6 changed files with 2 additions and 241 deletions.
4 changes: 2 additions & 2 deletions mapscript/java/examples/DrawMap.java
View file
Expand Up @@ -21,8 +21,8 @@ public static void main(String[] args) {
//map.getImagecolor().setRGB(153, 153, 204);
//styleObj st = map.getLayer(1).getClass(0).getStyle(0);
//st.getColor().setHex("#000000");
if( map.getLayer(1).getMetaData("hidden") != null ) {
System.out.println("Layer 1 is hidden? "+map.getLayer(1).getMetaData("hidden"));
if( map.getLayer(1).getMetadata().get("hidden") != null ) {
System.out.println("Layer 1 is hidden? "+map.getLayer(1).getMetadata().get("hidden"));
}
int i=0;
//for (i=0; i<100; i++) {
Expand Down
20 changes: 0 additions & 20 deletions mapscript/python/pyextend.i
View file
Expand Up @@ -394,26 +394,6 @@ def fromstring(data, mappath=None):

return retval;
}

/**
\**Deprecated** - replaced by the :func:`imageObj.write` method
*/
PyObject *saveToString() {
int size=0;
unsigned char *imgbytes;
PyObject *imgstring;

imgbytes = msSaveImageBuffer(self, &size, self->format);
if (size == 0)
{
msSetError(MS_IMGERR, "failed to get image buffer", "saveToString()");
return NULL;
}
imgstring = PyBytes_FromStringAndSize((const char*) imgbytes, size);
free(imgbytes);
return imgstring;
}

}


Expand Down
62 changes: 0 additions & 62 deletions mapscript/python/tests/cases/map_test.py
View file
Expand Up @@ -196,68 +196,6 @@ def testDrawEmptyMap(self):
self.assertRaises(mapscript.MapServerError, self.map.draw)


class MapMetaDataTestCase(MapTestCase):

def testInvalidKeyAccess(self):
"""MapMetaDataTestCase.testInvalidKeyAccess: an invalid map metadata key returns proper error"""
self.assertRaises(mapscript.MapServerError, self.map.getMetaData, 'foo')

def testFirstKeyAccess(self):
"""MapMetaDataTestCase.testFirstKeyAccess: first metadata key is correct value"""
key = self.map.getFirstMetaDataKey()
assert key == 'key1'
val = self.map.getMetaData(key)
assert val == 'value1'

def testLastKeyAccess(self):
"""MapMetaDataTestCase.testLastKeyAccess: last metadata key is correct value"""
key = self.map.getFirstMetaDataKey()
for i in range(4):
key = self.map.getNextMetaDataKey(key)
assert key is not None
key = self.map.getNextMetaDataKey(key)
assert key is None

def testMapMetaData(self):
"""MapMetaDataTestCase.testMapMetaData: map metadata keys are correct values"""
keys = []
key = self.map.getFirstMetaDataKey()
if key is not None:
keys.append(key)
while 1:
key = self.map.getNextMetaDataKey(key)
if not key:
break
keys.append(key)
assert keys == ['key1', 'key2', 'key3', 'key4', 'ows_enable_request'], keys

def testLayerMetaData(self):
"""MapMetaDataTestCase.testLayerMetaData: layer metadata keys are correct values"""
keys = []
key = self.map.getLayer(1).getFirstMetaDataKey()
if key is not None:
keys.append(key)
while 1:
key = self.map.getLayer(1).getNextMetaDataKey(key)
if not key:
break
keys.append(key)
assert keys == ['key1', 'key2', 'key3', 'key4'], keys

def testClassMetaData(self):
"""MapMetaDataTestCase.testClassMetaData: class metadata keys are correct values"""
keys = []
key = self.map.getLayer(1).getClass(0).getFirstMetaDataKey()
if key is not None:
keys.append(key)
while 1:
key = self.map.getLayer(1).getClass(0).getNextMetaDataKey(key)
if not key:
break
keys.append(key)
assert keys == ['key1', 'key2', 'key3', 'key4'], keys


class NoFontSetTestCase(unittest.TestCase):

def testNoGetFontSetFile(self):
Expand Down
32 changes: 0 additions & 32 deletions mapscript/swiginc/class.i
View file
Expand Up @@ -161,38 +161,6 @@
return msGetExpressionString(&(self->text));
}

/// \**To be removed in 8.0** - use the metadata property
char *getMetaData(char *name) {
char *value = NULL;
if (!name) {
msSetError(MS_HASHERR, "NULL key", "getMetaData");
}

value = (char *) msLookupHashTable(&(self->metadata), name);
if (!value) {
msSetError(MS_HASHERR, "Key %s does not exist", "getMetaData", name);
return NULL;
}
return value;
}

/// \**To be removed** - use the metadata property
int setMetaData(char *name, char *value) {
if (msInsertHashTable(&(self->metadata), name, value) == NULL)
return MS_FAILURE;
return MS_SUCCESS;
}

/// \**To be removed** - use the metadata property
char *getFirstMetaDataKey() {
return (char *) msFirstKeyFromHashTable(&(self->metadata));
}

/// \**To be removed** - use the metadata property
char *getNextMetaDataKey(char *lastkey) {
return (char *) msNextKeyFromHashTable(&(self->metadata), lastkey);
}

/// Draw the legend icon onto *image* at *dstx*, *dsty*. Returns :data:`MS_SUCCESS` or :data:`MS_FAILURE`
int drawLegendIcon(mapObj *map, layerObj *layer, int width, int height, imageObj *dstImage, int dstX, int dstY) {
if(layer->sizeunits != MS_PIXELS) {
Expand Down
88 changes: 0 additions & 88 deletions mapscript/swiginc/layer.i
View file
Expand Up @@ -627,89 +627,7 @@

return msLayerSetExtent(self, minx, miny, maxx, maxy);
}

/*
The following metadata methods are no longer needed since we have
promoted the metadata member of layerObj to a first-class mapscript
object. See hashtable.i. Not yet scheduled for deprecation but
perhaps in the next major release? --SG
*/

/**
.. note::
Function is deprecated and will be removed in a future version.
Replaced by direct metadata access, see :class:`hashTableObj`
*/
char *getMetaData(char *name)
{
char *value = NULL;
if (!name) {
msSetError(MS_HASHERR, "NULL key", "getMetaData");
}

value = (char *) msLookupHashTable(&(self->metadata), name);
/*
Umberto, 05/17/2006
Exceptions should be reserved for situations when a serious error occurred
and normal program flow must be interrupted.
In this case returning null should be more that enough.
*/
#ifndef SWIGJAVA
if (!value) {
msSetError(MS_HASHERR, "Key %s does not exist", "getMetaData", name);
return NULL;
}
#endif
return value;
}

/**
.. note::

Function is deprecated and will be removed in a future version.
Replaced by direct metadata access, see :class:`hashTableObj`
*/
int setMetaData(char *name, char *value)
{
if (msInsertHashTable(&(self->metadata), name, value) == NULL)
return MS_FAILURE;
return MS_SUCCESS;
}

/**
.. note::
Function is deprecated and will be removed in a future version.
Replaced by direct metadata access, see :class:`hashTableObj`
*/
int removeMetaData(char *name)
{
return(msRemoveHashTable(&(self->metadata), name));
}

/**
.. note::
Function is deprecated and will be removed in a future version.
Replaced by direct metadata access, see :class:`hashTableObj`
*/
char *getFirstMetaDataKey()
{
return (char *) msFirstKeyFromHashTable(&(self->metadata));
}

/**
.. note::
Function is deprecated and will be removed in a future version.
Replaced by direct metadata access, see :class:`hashTableObj`
*/
char *getNextMetaDataKey(char *lastkey)
{
return (char *) msNextKeyFromHashTable(&(self->metadata), lastkey);
}

%newobject getWMSFeatureInfoURL;
/**
Return a WMS GetFeatureInfo URL (works only for WMS layers) *clickX*, *clickY*
Expand Down Expand Up @@ -808,12 +726,6 @@
msLayerSetProcessingKey( self, key, value );
}

/// Deprecated
void setProcessing(const char *directive )
{
msLayerAddProcessing( self, directive );
}

/// Adds a new processing directive line to a layer, similar to the PROCESSING directive
/// in a map file. Processing directives supported are specific to the layer type and
/// underlying renderer.
Expand Down
37 changes: 0 additions & 37 deletions mapscript/swiginc/map.i
View file
Expand Up @@ -481,43 +481,6 @@
return msGMLWriteQuery(self, filename, ns);
}

/// Deprecated
char *getMetaData(char *name) {
char *value = NULL;
if (!name) {
msSetError(MS_HASHERR, "NULL key", "getMetaData");
}

value = (char *) msLookupHashTable(&(self->web.metadata), name);
if (!value) {
msSetError(MS_HASHERR, "Key %s does not exist", "getMetaData", name);
return NULL;
}
return value;
}

/// Deprecated
int setMetaData(char *name, char *value) {
if (msInsertHashTable(&(self->web.metadata), name, value) == NULL)
return MS_FAILURE;
return MS_SUCCESS;
}

/// Deprecated
int removeMetaData(char *name) {
return(msRemoveHashTable(&(self->web.metadata), name));
}

/// Deprecated
char *getFirstMetaDataKey() {
return (char *) msFirstKeyFromHashTable(&(self->web.metadata));
}

/// Deprecated
char *getNextMetaDataKey(char *lastkey) {
return (char *) msNextKeyFromHashTable(&(self->web.metadata), lastkey);
}

/// Load symbols defined in filename into map symbolset. The existing symbolset is cleared.
/// Returns :data:`MS_SUCCESS` or :data:`MS_FAILURE`
int setSymbolSet(char *szFileName) {
Expand Down

0 comments on commit 918637a

Please sign in to comment.