MapServer/mapscript/php/php_mapscript_util.h at main · ax7476/MapServer · GitHub

History

364 lines (309 loc) · 12.6 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

/**********************************************************************

* $Id$

* Project: MapServer

* Purpose: PHP/MapScript extension for MapServer : Utility functions

* Header - macros

* Author: Daniel Morissette, DM Solutions Group (dmorissette@dmsolutions.ca)

**********************************************************************

* Permission is hereby granted, free of charge, to any person obtaining a

* copy of this software and associated documentation files (the "Software"),

* to deal in the Software without restriction, including without limitation

* the rights to use, copy, modify, merge, publish, distribute, sublicense,

* and/or sell copies of the Software, and to permit persons to whom the

* Software is furnished to do so, subject to the following conditions:

* The above copyright notice and this permission notice shall be included in

* all copies of this Software or works derived from this Software.

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

* DEALINGS IN THE SOFTWARE.

**********************************************************************/

#ifndef PHP_MAPSCRIPT_UTIL_H

#define PHP_MAPSCRIPT_UTIL_H

#include "php.h"

#include "php_globals.h"

#include "php_mapscript.h"

#if PHP_VERSION_ID < 70000

#if ZEND_MODULE_API_NO < 20010901

#define TSRMLS_D void

#define TSRMLS_DC

#define TSRMLS_C

#define TSRMLS_CC

#endif

/* Add pseudo refcount macros for PHP version < 5.3 */

#ifndef Z_REFCOUNT_PP

#define Z_REFCOUNT_PP(ppz) Z_REFCOUNT_P(*(ppz))

#define Z_SET_REFCOUNT_PP(ppz, rc) Z_SET_REFCOUNT_P(*(ppz), rc)

#define Z_ADDREF_PP(ppz) Z_ADDREF_P(*(ppz))

#define Z_DELREF_PP(ppz) Z_DELREF_P(*(ppz))

#define Z_ISREF_PP(ppz) Z_ISREF_P(*(ppz))

#define Z_SET_ISREF_PP(ppz) Z_SET_ISREF_P(*(ppz))

#define Z_UNSET_ISREF_PP(ppz) Z_UNSET_ISREF_P(*(ppz))

#define Z_SET_ISREF_TO_PP(ppz, isref) Z_SET_ISREF_TO_P(*(ppz), isref)

#define Z_REFCOUNT_P(pz) zval_refcount_p(pz)

#define Z_SET_REFCOUNT_P(pz, rc) zval_set_refcount_p(pz, rc)

#define Z_ADDREF_P(pz) zval_addref_p(pz)

#define Z_DELREF_P(pz) zval_delref_p(pz)

#define Z_ISREF_P(pz) zval_isref_p(pz)

#define Z_SET_ISREF_P(pz) zval_set_isref_p(pz)

#define Z_UNSET_ISREF_P(pz) zval_unset_isref_p(pz)

#define Z_SET_ISREF_TO_P(pz, isref) zval_set_isref_to_p(pz, isref)

#define Z_REFCOUNT(z) Z_REFCOUNT_P(&(z))

#define Z_SET_REFCOUNT(z, rc) Z_SET_REFCOUNT_P(&(z), rc)

#define Z_ADDREF(z) Z_ADDREF_P(&(z))

#define Z_DELREF(z) Z_DELREF_P(&(z))

#define Z_ISREF(z) Z_ISREF_P(&(z))

#define Z_SET_ISREF(z) Z_SET_ISREF_P(&(z))

#define Z_UNSET_ISREF(z) Z_UNSET_ISREF_P(&(z))

#define Z_SET_ISREF_TO(z, isref) Z_SET_ISREF_TO_P(&(z), isref)

#if defined(__GNUC__)

#define zend_always_inline inline __attribute__((always_inline))

#elif defined(_MSC_VER)

#define zend_always_inline __forceinline

#else

#define zend_always_inline inline

#endif

static zend_always_inline zend_uint zval_refcount_p(zval* pz)

{

return pz->refcount;

}

static zend_always_inline zend_uint zval_set_refcount_p(zval* pz, zend_uint rc)

{

return pz->refcount = rc;

}

static zend_always_inline zend_uint zval_addref_p(zval* pz)

{

return ++pz->refcount;

}

static zend_always_inline zend_uint zval_delref_p(zval* pz)

{

return --pz->refcount;

}

static zend_always_inline zend_bool zval_isref_p(zval* pz)

{

return pz->is_ref;

}

static zend_always_inline zend_bool zval_set_isref_p(zval* pz)

{

return pz->is_ref = 1;

}

static zend_always_inline zend_bool zval_unset_isref_p(zval* pz)

{

return pz->is_ref = 0;

}

static zend_always_inline zend_bool zval_set_isref_to_p(zval* pz, zend_bool isref)

{

return pz->is_ref = isref;

}

#endif

/* PHP >=5.3 replaced ZVAL_DELREF by Z_DELREF_P */

#if ZEND_MODULE_API_NO >= 20090626

#define ZVAL_DELREF Z_DELREF_P

#define ZVAL_ADDREF Z_ADDREF_P

#endif

#define MAPSCRIPT_REGISTER_CLASS(name, functions, class_entry, constructor) \

INIT_CLASS_ENTRY(ce, name, functions); \

class_entry = zend_register_internal_class(&ce TSRMLS_CC); \

class_entry->create_object = constructor;

#define MAPSCRIPT_ALLOC_OBJECT(zobj, object_type) \

zobj = ecalloc(1, sizeof(object_type));

#define MAPSCRIPT_FREE_OBJECT(zobj) \

zend_hash_destroy(zobj->std.properties); \

FREE_HASHTABLE(zobj->std.properties);

#endif /* PHP_VERSION_ID < 70000 */

#if PHP_VERSION_ID >= 70300

#define MAPSCRIPT_ADDREF(zv) if(!Z_ISUNDEF(zv)) GC_ADDREF(Z_COUNTED(zv))

#define MAPSCRIPT_ADDREF_P(p) if(!Z_ISUNDEF(*p)) GC_ADDREF(Z_COUNTED_P(p))

#else

#if PHP_VERSION_ID >= 70000

#define MAPSCRIPT_ADDREF(zv) if(!(Z_ISUNDEF(zv))) GC_REFCOUNT(Z_COUNTED(zv))++;

#define MAPSCRIPT_ADDREF_P(zv) if(!(Z_ISUNDEF(*zv))) GC_REFCOUNT(Z_COUNTED_P(zv))++;

#else

#define MAPSCRIPT_ADDREF(zobj) if (zobj) Z_ADDREF_P(zobj)

#define MAPSCRIPT_ADDREF_P(zv) MAPSCRIPT_ADDREF(zv)

#endif /* PHP_VERSION_ID >= 70000 */

#endif /* PHP_VERSION_ID >= 70300 */

#if PHP_VERSION_ID >= 70300

#define MAPSCRIPT_DELREF(zv) \

if (!(Z_ISUNDEF(zv))) \

{ \

zend_refcounted *_gc = Z_COUNTED(zv); \

GC_DELREF(_gc); \

if(GC_REFCOUNT(_gc) == 0) \

rc_dtor_func(_gc); \

ZVAL_UNDEF(&zv); \

}

#else

#if PHP_VERSION_ID >= 70000

#if PHP_VERSION_ID >= 70100

#define _zval_dtor_func_for_ptr _zval_dtor_func

#endif /* PHP_VERSION_ID >= 70100 */

#define MAPSCRIPT_DELREF(zv) \

if (!(Z_ISUNDEF(zv))) \

{ \

zend_refcounted *_gc = Z_COUNTED_P(&zv); \

if(--GC_REFCOUNT(_gc) == 0) \

_zval_dtor_func_for_ptr(_gc); \

ZVAL_UNDEF(&zv); \

}

#else

#define MAPSCRIPT_DELREF(zobj) \

if (zobj) \

{ \

if (Z_REFCOUNT_P(zobj) == 1) { \

zval_ptr_dtor(&zobj); \

} \

else { \

Z_DELREF_P(zobj); \

} \

zobj = NULL; \

}

#endif /* PHP_VERSION_ID >= 70000 */

#endif /* PHP_VERSION_ID >= 70300 */

#if PHP_VERSION_ID >= 70000

#define MAPSCRIPT_FREE_PARENT(parent) \

if (parent.child_ptr) \

ZVAL_UNDEF(parent.child_ptr); \

MAPSCRIPT_DELREF(parent.val);

#define MAPSCRIPT_MAKE_PARENT(zobj, ptr) \

if(zobj == NULL) \

ZVAL_UNDEF(&parent.val); \

else \

ZVAL_COPY_VALUE(&parent.val, zobj); \

parent.child_ptr = ptr;

#define MAPSCRIPT_INIT_PARENT(parent) \

ZVAL_UNDEF(&parent.val); \

parent.child_ptr = NULL;

#else

#define MAPSCRIPT_FREE_PARENT(parent) \

if (parent.child_ptr) \

*parent.child_ptr = NULL; \

MAPSCRIPT_DELREF(parent.val);

#define MAPSCRIPT_MAKE_PARENT(zobj, ptr) \

parent.val = zobj; \

parent.child_ptr = ptr;

#define MAPSCRIPT_INIT_PARENT(parent) \

parent.val = NULL; \

parent.child_ptr = NULL;

#endif

#if PHP_VERSION_ID >= 70000

#define MAPSCRIPT_CALL_METHOD_1(zobj, function_name, retval, arg1) \

zend_call_method_with_1_params(&zobj, Z_OBJCE(zobj), NULL, function_name, &retval, arg1);

#define MAPSCRIPT_CALL_METHOD_2(zobj, function_name, retval, arg1, arg2) \

zend_call_method_with_2_params(&zobj, Z_OBJCE(zobj), NULL, function_name, &retval, arg1, arg2);

#define MAPSCRIPT_CALL_METHOD_2_P(zobj, function_name, retval, arg1, arg2) \

zend_call_method_with_2_params(zobj, Z_OBJCE_P(zobj), NULL, function_name, &retval, arg1, arg2);

#else

#define MAPSCRIPT_CALL_METHOD_1(zobj, function_name, retval, arg1) \

zend_call_method_with_1_params(&zobj, Z_OBJCE_P(zobj), NULL, function_name, &retval, arg1);

#define MAPSCRIPT_CALL_METHOD_2(zobj, function_name, retval, arg1, arg2) \

zend_call_method_with_2_params(&zobj, Z_OBJCE_P(zobj), NULL, function_name, &retval, arg1, arg2);

#define MAPSCRIPT_CALL_METHOD_2_P(zobj, function_name, retval, arg1, arg2) \

MAPSCRIPT_CALL_METHOD_2(zobj, function_name, retval, arg1, arg2)

#endif /* PHP_VERSION_ID */

#define STRING_EQUAL(string1, string2) \

strcmp(string1, string2) == 0

/* helpers for getters */

#define IF_GET_STRING(property_name, value) \

if (strcmp(property, property_name)==0) \

{ \

MAPSCRIPT_RETVAL_STRING( (value ? value:"") , 1); \

} \

#define IF_GET_LONG(property_name, value) \

if (strcmp(property, property_name)==0) \

{ \

RETVAL_LONG(value); \

} \

#define IF_GET_DOUBLE(property_name, value) \

if (strcmp(property, property_name)==0) \

{ \

RETVAL_DOUBLE(value); \

} \

#if PHP_VERSION_ID >= 70000

#define IF_GET_OBJECT(property_name, mapscript_ce, php_object_storage, internal_object) \

if (strcmp(property, property_name)==0) \

{ \

if (Z_ISUNDEF(php_object_storage)) { \

mapscript_fetch_object(mapscript_ce, zobj, NULL, (void*)internal_object, \

&php_object_storage TSRMLS_CC); \

} \

RETURN_ZVAL(&php_object_storage, 1, 0); \

}

#else

#define IF_GET_OBJECT(property_name, mapscript_ce, php_object_storage, internal_object) \

if (strcmp(property, property_name)==0) \

{ \

if (!php_object_storage) { \

mapscript_fetch_object(mapscript_ce, zobj, NULL, (void*)internal_object, \

&php_object_storage TSRMLS_CC); \

} \

RETURN_ZVAL(php_object_storage, 1, 0); \

}

#endif

#if PHP_VERSION_ID >= 70000

#define CHECK_OBJECT(mapscript_ce, php_object_storage, internal_object) \

if (Z_ISUNDEF(php_object_storage)) { \

mapscript_fetch_object(mapscript_ce, zobj, NULL, (void*)internal_object, \

&php_object_storage TSRMLS_CC); \

}

#else

#define CHECK_OBJECT(mapscript_ce, php_object_storage, internal_object) \

if (!php_object_storage) { \

mapscript_fetch_object(mapscript_ce, zobj, NULL, (void*)internal_object, \

&php_object_storage TSRMLS_CC); \

}

#endif

/* helpers for setters */

#define IF_SET_STRING(property_name, internal, value) \

if (strcmp(property, property_name)==0) \

{ \

convert_to_string(value); \

if (internal) free(internal); \

if (Z_STRVAL_P(value)) \

internal = msStrdup(Z_STRVAL_P(value)); \

}

#define IF_SET_LONG(property_name, internal, value) \

if (strcmp(property, property_name)==0) \

{ \

convert_to_long(value); \

internal = Z_LVAL_P(value); \

}

#define IF_SET_DOUBLE(property_name, internal, value) \

if (strcmp(property, property_name)==0) \

{ \

convert_to_double(value); \

internal = Z_DVAL_P(value); \

}

#define IF_SET_BYTE(property_name, internal, value) \

if (strcmp(property, property_name)==0) \

{ \

convert_to_long(value); \

internal = (unsigned char)Z_LVAL_P(value); \

}

#define IF_SET_COLOR(property_name, internal, value) \

if (strcmp(property, property_name)==0) \

{ \

convert_to_long(value); \

/* validate the color value */ \

if (Z_LVAL_P(value) < 0 || Z_LVAL_P(value) > 255) { \

mapscript_throw_exception("Invalid color value. It must be between 0 and 255." TSRMLS_CC); \

return; \

} \

internal = Z_LVAL_P(value); \

}

#if PHP_VERSION_ID < 70000

zend_object_value mapscript_object_new(zend_object *zobj,

zend_class_entry *ce,

void (*zend_objects_free_object) TSRMLS_DC);

#endif /* PHP_VERSION_ID < 70000 */

int mapscript_extract_associative_array(HashTable *php, char **array);

#endif /* PHP_MAPSCRIPT_UTIL_H */

MapServer/mapscript/php/php_mapscript_util.h at main · ax7476/MapServer · GitHub

Expand file tree

Breadcrumbs

php_mapscript_util.h

Latest commit

History

Breadcrumbs

php_mapscript_util.h

File metadata and controls