Merge pull request #352 from viest/dev

Feat: validation

Author: viest

config.m4

@@ -21,6 +21,7 @@ if test "$PHP_XLSWRITER" != "no"; then
     kernel/format.c \
     kernel/chart.c \
     kernel/help.c \
+    kernel/validation.c \
     "
 
     xls_read_sources="

config.w32

@@ -28,6 +28,7 @@ if (PHP_XLSWRITER != "no") {
                 read.c \
                 csv.c \
                 help.c \
+                validation.c \
                 ", "xlswriter");
 
         ADD_SOURCES(configure_module_dirname + "\\library\\libxlsxwriter\\third_party\\minizip", "\

include/validation.h

@@ -0,0 +1,20 @@
+/*
+  +----------------------------------------------------------------------+
+  | XlsWriter Extension                                                  |
+  +----------------------------------------------------------------------+
+  | Copyright (c) 2017-2018 The Viest                                    |
+  +----------------------------------------------------------------------+
+  | http://www.viest.me                                                  |
+  +----------------------------------------------------------------------+
+  | Author: viest <[email protected]>                                 |
+  +----------------------------------------------------------------------+
+*/
+
+#ifndef PHP_EXT_XLS_WRITER_VALIDATION_H
+#define PHP_EXT_XLS_WRITER_VALIDATION_H
+
+extern zend_class_entry *vtiful_validation_ce;
+
+VTIFUL_STARTUP_FUNCTION(validation);
+
+#endif // PHP_EXT_XLS_WRITER_VALIDATION_H

include/xlswriter.h

@@ -18,6 +18,7 @@
 #endif
 
 #include <php.h>
+#include "ext/date/php_date.h"
 
 #include "zend_smart_str.h"
 #include "zend_exceptions.h"
@@ -31,6 +32,7 @@
 
 #include "php_xlswriter.h"
 #include "excel.h"
+#include "validation.h"
 #include "exception.h"
 #include "format.h"
 #include "chart.h"
@@ -84,6 +86,10 @@ typedef struct {
     lxw_format  *format;
 } xls_resource_format_t;
 
+typedef struct {
+    lxw_data_validation *validation;
+} xls_resource_validation_t;
+
 typedef struct {
     lxw_chart *chart;
     lxw_chart_series *series;
@@ -107,6 +113,11 @@ typedef struct _vtiful_chart_object {
     zend_object zo;
 } chart_object;
 
+typedef struct _vtiful_validation_object {
+    xls_resource_validation_t ptr;
+    zend_object zo;
+} validation_object;
+
 static inline xls_object *php_vtiful_xls_fetch_object(zend_object *obj) {
     return (xls_object *)((char *)(obj) - XtOffsetOf(xls_object, zo));
 }
@@ -119,15 +130,20 @@ static inline chart_object *php_vtiful_chart_fetch_object(zend_object *obj) {
     return (chart_object *)((char *)(obj) - XtOffsetOf(chart_object, zo));
 }
 
+static inline validation_object *php_vtiful_validation_fetch_object(zend_object *obj) {
+    return (validation_object *)((char *)(obj) - XtOffsetOf(validation_object, zo));
+}
+
 #define REGISTER_CLASS_CONST_LONG(class_name, const_name, value) \
     zend_declare_class_constant_long(class_name, const_name, sizeof(const_name)-1, (zend_long)value);
 
 #define REGISTER_CLASS_PROPERTY_NULL(class_name, property_name, acc) \
     zend_declare_property_null(class_name, ZEND_STRL(property_name), acc);
 
-#define Z_XLS_P(zv)    php_vtiful_xls_fetch_object(Z_OBJ_P(zv));
-#define Z_CHART_P(zv)  php_vtiful_chart_fetch_object(Z_OBJ_P(zv));
-#define Z_FORMAT_P(zv) php_vtiful_format_fetch_object(Z_OBJ_P(zv));
+#define Z_XLS_P(zv)        php_vtiful_xls_fetch_object(Z_OBJ_P(zv));
+#define Z_CHART_P(zv)      php_vtiful_chart_fetch_object(Z_OBJ_P(zv));
+#define Z_FORMAT_P(zv)     php_vtiful_format_fetch_object(Z_OBJ_P(zv));
+#define Z_VALIDATION_P(zv) php_vtiful_validation_fetch_object(Z_OBJ_P(zv));
 
 #define WORKBOOK_NOT_INITIALIZED(xls_object_t)                                                                       \
     do {                                                                                                             \
@@ -209,6 +225,7 @@ static inline chart_object *php_vtiful_chart_fetch_object(zend_object *obj) {
 
 
 lxw_format           * zval_get_format(zval *handle);
+lxw_data_validation  * zval_get_validation(zval *resource);
 xls_resource_write_t * zval_get_resource(zval *handle);
 xls_resource_chart_t * zval_get_chart(zval *resource);
 
@@ -235,6 +252,7 @@ void printed_direction(xls_resource_write_t *res, unsigned int direction);
 void xls_file_path(zend_string *file_name, zval *dir_path, zval *file_path);
 void freeze_panes(xls_resource_write_t *res, zend_long row, zend_long column);
 void set_row(zend_string *range, double height, xls_resource_write_t *res, lxw_format *format);
+void validation(xls_resource_write_t *res, zend_string *range, lxw_data_validation *validation);
 void set_column(zend_string *range, double width, xls_resource_write_t *res, lxw_format *format);
 void merge_cells(zend_string *range, zval *value, xls_resource_write_t *res, lxw_format *format);
 void comment_writer(zend_string *comment, zend_long row, zend_long columns, xls_resource_write_t *res);
@@ -249,6 +267,7 @@ void url_writer(zend_long row, zend_long columns, xls_resource_write_t *res, zen
 
 lxw_error workbook_file(xls_resource_write_t *self);
 
+lxw_datetime timestamp_to_datetime(zend_long timestamp);
 zend_string* str_pick_up(zend_string *left, const char *right, size_t len);
 
 #endif

kernel/common.c

@@ -69,4 +69,20 @@ void call_object_method(zval *object, const char *function_name, uint32_t param_
 
     zval_ptr_dtor(&z_f_name);
 }
-/* }}} */
+/* }}} */
+
+lxw_datetime timestamp_to_datetime(zend_long timestamp)
+{
+    int yearLocal   = php_idate('Y', timestamp, 0);
+    int monthLocal  = php_idate('m', timestamp, 0);
+    int dayLocal    = php_idate('d', timestamp, 0);
+    int hourLocal   = php_idate('H', timestamp, 0);
+    int minuteLocal = php_idate('i', timestamp, 0);
+    int secondLocal = php_idate('s', timestamp, 0);
+
+    lxw_datetime datetime = {
+            yearLocal, monthLocal, dayLocal, hourLocal, minuteLocal, secondLocal
+    };
+
+    return datetime;
+}

kernel/excel.c

@@ -11,7 +11,6 @@
 */
 
 #include "xlswriter.h"
-#include "ext/date/php_date.h"
 
 zend_class_entry *vtiful_xls_ce;
 
@@ -267,6 +266,11 @@ ZEND_BEGIN_ARG_INFO_EX(xls_protection_arginfo, 0, 0, 0)
                 ZEND_ARG_INFO(0, password)
 ZEND_END_ARG_INFO()
 
+ZEND_BEGIN_ARG_INFO_EX(xls_validation_arginfo, 0, 0, 2)
+                ZEND_ARG_INFO(0, range)
+                ZEND_ARG_INFO(0, validation_resource)
+ZEND_END_ARG_INFO()
+
 ZEND_BEGIN_ARG_INFO_EX(xls_set_printed_portrait_arginfo, 0, 0, 0)
 ZEND_END_ARG_INFO()
 
@@ -640,16 +644,7 @@ PHP_METHOD(vtiful_xls, insertDate)
         format = zend_string_init(ZEND_STRL("yyyy-mm-dd hh:mm:ss"), 0);
     }
 
-    int yearLocal   = php_idate('Y', data->value.lval, 0);
-    int monthLocal  = php_idate('m', data->value.lval, 0);
-    int dayLocal    = php_idate('d', data->value.lval, 0);
-    int hourLocal   = php_idate('H', data->value.lval, 0);
-    int minuteLocal = php_idate('i', data->value.lval, 0);
-    int secondLocal = php_idate('s', data->value.lval, 0);
-
-    lxw_datetime datetime = {
-            yearLocal, monthLocal, dayLocal, hourLocal, minuteLocal, secondLocal
-    };
+    lxw_datetime datetime = timestamp_to_datetime(data->value.lval);
 
     if (format_handle) {
         datetime_writer(&datetime, row, column, format, &obj->write_ptr, zval_get_format(format_handle));
@@ -1172,6 +1167,28 @@ PHP_METHOD(vtiful_xls, setCurrentSheetIsFirst)
 }
 /* }}} */
 
+/** {{{ \Vtiful\Kernel\Excel::validation()
+ */
+PHP_METHOD(vtiful_xls, validation)
+{
+    zend_string *range = NULL;
+    zval *validation_handle = NULL;
+
+    ZEND_PARSE_PARAMETERS_START(2, 2)
+            Z_PARAM_STR(range)
+            Z_PARAM_RESOURCE(validation_handle)
+    ZEND_PARSE_PARAMETERS_END();
+
+    ZVAL_COPY(return_value, getThis());
+
+    xls_object *obj = Z_XLS_P(getThis());
+
+    WORKBOOK_NOT_INITIALIZED(obj);
+
+    validation(&obj->write_ptr, range, zval_get_validation(validation_handle));
+}
+/* }}} */
+
 #ifdef ENABLE_READER
 
 /** {{{ \Vtiful\Kernel\Excel::openFile()
@@ -1497,6 +1514,7 @@ zend_function_entry xls_methods[] = {
         PHP_ME(vtiful_xls, freezePanes,   xls_freeze_panes_arginfo,   ZEND_ACC_PUBLIC)
 
         PHP_ME(vtiful_xls, protection,    xls_protection_arginfo,     ZEND_ACC_PUBLIC)
+        PHP_ME(vtiful_xls, validation,    xls_validation_arginfo,     ZEND_ACC_PUBLIC)
 
         PHP_ME(vtiful_xls, zoom,          xls_sheet_zoom_arginfo,     ZEND_ACC_PUBLIC)
         PHP_ME(vtiful_xls, gridline,      xls_sheet_gridline_arginfo, ZEND_ACC_PUBLIC)

kernel/resource.c

@@ -38,6 +38,7 @@ lxw_format * zval_get_format(zval *handle)
 }
 /* }}} */
 
+/* {{{ */
 xls_resource_chart_t *zval_get_chart(zval *resource)
 {
     xls_resource_chart_t *res;
@@ -47,4 +48,18 @@ xls_resource_chart_t *zval_get_chart(zval *resource)
     }
 
     return res;
-}
+}
+/* }}} */
+
+/* {{{ */
+lxw_data_validation *zval_get_validation(zval *resource)
+{
+    lxw_data_validation *res;
+
+    if((res = (lxw_data_validation *)zend_fetch_resource(Z_RES_P(resource), VTIFUL_RESOURCE_NAME, le_xls_writer)) == NULL) {
+        zend_throw_exception(vtiful_exception_ce, "validation resources resolution fail", 210);
+    }
+
+    return res;
+}
+/* }}} */