RNA: use string-join to simplify operator register
authorCampbell Barton <ideasman42@gmail.com>
Wed, 23 Aug 2017 08:17:42 +0000 (18:17 +1000)
committerCampbell Barton <ideasman42@gmail.com>
Wed, 23 Aug 2017 09:18:22 +0000 (19:18 +1000)
Also sanity check macro-operator ID's.

source/blender/makesrna/intern/rna_wm.c
source/blender/windowmanager/WM_api.h
source/blender/windowmanager/intern/wm_operators.c

index a7afc405048ffb4da16d3941894f8bfb6d8356af..2114c22b428d23cc5d78b4833239fa82e27c2e99 100644 (file)
@@ -32,6 +32,7 @@
 #include "DNA_windowmanager_types.h"
 
 #include "BLI_utildefines.h"
+#include "BLI_string_utils.h"
 
 #include "BLT_translation.h"
 
@@ -1124,8 +1125,8 @@ static StructRNA *rna_Operator_register(
        struct {
                char idname[OP_MAX_TYPENAME];
                char name[OP_MAX_TYPENAME];
-               char descr[RNA_DYN_DESCR_MAX];
-               char ctxt[RNA_DYN_DESCR_MAX];
+               char description[RNA_DYN_DESCR_MAX];
+               char translation_context[RNA_DYN_DESCR_MAX];
                char undo_group[OP_MAX_TYPENAME];
        } temp_buffers;
 
@@ -1133,15 +1134,15 @@ static StructRNA *rna_Operator_register(
        dummyop.type = &dummyot;
        dummyot.idname = temp_buffers.idname; /* only assigne the pointer, string is NULL'd */
        dummyot.name = temp_buffers.name; /* only assigne the pointer, string is NULL'd */
-       dummyot.description = temp_buffers.descr; /* only assigne the pointer, string is NULL'd */
-       dummyot.translation_context = temp_buffers.ctxt; /* only assigne the pointer, string is NULL'd */
+       dummyot.description = temp_buffers.description; /* only assigne the pointer, string is NULL'd */
+       dummyot.translation_context = temp_buffers.translation_context; /* only assigne the pointer, string is NULL'd */
        dummyot.undo_group = temp_buffers.undo_group; /* only assigne the pointer, string is NULL'd */
        RNA_pointer_create(NULL, &RNA_Operator, &dummyop, &dummyotr);
 
        /* clear in case they are left unset */
-       temp_buffers.idname[0] = temp_buffers.name[0] = temp_buffers.descr[0] = temp_buffers.undo_group[0] = '\0';
+       temp_buffers.idname[0] = temp_buffers.name[0] = temp_buffers.description[0] = temp_buffers.undo_group[0] = '\0';
        /* We have to set default op context! */
-       strcpy(temp_buffers.ctxt, BLT_I18NCONTEXT_OPERATOR_DEFAULT);
+       strcpy(temp_buffers.translation_context, BLT_I18NCONTEXT_OPERATOR_DEFAULT);
 
        /* validate the python class */
        if (validate(&dummyotr, data, have_function) != 0)
@@ -1156,72 +1157,31 @@ static StructRNA *rna_Operator_register(
        if (!RNA_struct_available_or_report(reports, identifier)) {
                return NULL;
        }
+       if (!WM_operator_py_idname_ok_or_report(reports, identifier, temp_buffers.idname)) {
+               return NULL;
+       }
 
-       {   /* convert foo.bar to FOO_OT_bar
-                * allocate the description and the idname in 1 go */
-
-               /* inconveniently long name sanity check */
-               {
-                       char *ch = temp_buffers.idname;
-                       int i;
-                       int dot = 0;
-                       for (i = 0; *ch; i++) {
-                               if ((*ch >= 'a' && *ch <= 'z') || (*ch >= '0' && *ch <= '9') || *ch == '_') {
-                                       /* pass */
-                               }
-                               else if (*ch == '.') {
-                                       dot++;
-                               }
-                               else {
-                                       BKE_reportf(reports, RPT_ERROR,
-                                                   "Registering operator class: '%s', invalid bl_idname '%s', at position %d",
-                                                   identifier, temp_buffers.idname, i);
-                                       return NULL;
-                               }
-
-                               ch++;
-                       }
-
-                       if (i > ((int)sizeof(dummyop.idname)) - 3) {
-                               BKE_reportf(reports, RPT_ERROR, "Registering operator class: '%s', invalid bl_idname '%s', "
-                                           "is too long, maximum length is %d", identifier, temp_buffers.idname,
-                                           (int)sizeof(dummyop.idname) - 3);
-                               return NULL;
-                       }
-
-                       if (dot != 1) {
-                               BKE_reportf(reports, RPT_ERROR,
-                                           "Registering operator class: '%s', invalid bl_idname '%s', must contain 1 '.' character",
-                                           identifier, temp_buffers.idname);
-                               return NULL;
-                       }
-               }
-               /* end sanity check */
-
-               {
-                       const uint idname_len = strlen(temp_buffers.idname) + 4;
-                       const uint name_len = strlen(temp_buffers.name) + 1;
-                       const uint desc_len = strlen(temp_buffers.descr) + 1;
-                       const uint ctxt_len = strlen(temp_buffers.ctxt) + 1;
-                       const uint undo_group_len = strlen(temp_buffers.undo_group) + 1;
-                       /* 2 terminators and 3 to convert a.b -> A_OT_b */
-                       char *ch = MEM_mallocN(
-                               sizeof(char) * (idname_len + name_len + desc_len + ctxt_len + undo_group_len), __func__);
-                       WM_operator_bl_idname(ch, temp_buffers.idname); /* convert the idname from python */
-                       dummyot.idname = ch;
-                       ch += idname_len;
-                       memcpy(ch, temp_buffers.name, name_len);
-                       dummyot.name = ch;
-                       ch += name_len;
-                       memcpy(ch, temp_buffers.descr, desc_len);
-                       dummyot.description = ch;
-                       ch += desc_len;
-                       memcpy(ch, temp_buffers.ctxt, ctxt_len);
-                       dummyot.translation_context = ch;
-                       ch += ctxt_len;
-                       memcpy(ch, temp_buffers.undo_group, undo_group_len);
-                       dummyot.undo_group = ch;
-               }
+       /* Convert foo.bar to FOO_OT_bar
+        * allocate all strings at once. */
+       {
+               char idname_conv[sizeof(dummyop.idname)];
+               WM_operator_bl_idname(idname_conv, temp_buffers.idname); /* convert the idname from python */
+               const char *strings[] = {
+                       idname_conv,
+                       temp_buffers.name,
+                       temp_buffers.description,
+                       temp_buffers.translation_context,
+                       temp_buffers.undo_group,
+               };
+               char *strings_table[ARRAY_SIZE(strings)];
+               BLI_string_join_array_by_sep_char_with_tableN('\0', strings_table, strings, ARRAY_SIZE(strings));
+
+               dummyot.idname = strings_table[0];  /* allocated string stored here */
+               dummyot.name = strings_table[1];
+               dummyot.description = strings_table[2];
+               dummyot.translation_context = strings_table[3];
+               dummyot.undo_group = strings_table[4];
+               BLI_assert(ARRAY_SIZE(strings) == 5);
        }
 
        /* XXX, this doubles up with the operator name [#29666]
@@ -1297,8 +1257,8 @@ static StructRNA *rna_MacroOperator_register(
        struct {
                char idname[OP_MAX_TYPENAME];
                char name[OP_MAX_TYPENAME];
-               char descr[RNA_DYN_DESCR_MAX];
-               char ctxt[RNA_DYN_DESCR_MAX];
+               char description[RNA_DYN_DESCR_MAX];
+               char translation_context[RNA_DYN_DESCR_MAX];
                char undo_group[OP_MAX_TYPENAME];
        } temp_buffers;
 
@@ -1306,15 +1266,15 @@ static StructRNA *rna_MacroOperator_register(
        dummyop.type = &dummyot;
        dummyot.idname = temp_buffers.idname; /* only assigne the pointer, string is NULL'd */
        dummyot.name = temp_buffers.name; /* only assigne the pointer, string is NULL'd */
-       dummyot.description = temp_buffers.descr; /* only assigne the pointer, string is NULL'd */
-       dummyot.translation_context = temp_buffers.ctxt; /* only assigne the pointer, string is NULL'd */
+       dummyot.description = temp_buffers.description; /* only assigne the pointer, string is NULL'd */
+       dummyot.translation_context = temp_buffers.translation_context; /* only assigne the pointer, string is NULL'd */
        dummyot.undo_group = temp_buffers.undo_group; /* only assigne the pointer, string is NULL'd */
        RNA_pointer_create(NULL, &RNA_Macro, &dummyop, &dummyotr);
 
        /* clear in case they are left unset */
-       temp_buffers.idname[0] = temp_buffers.name[0] = temp_buffers.descr[0] = temp_buffers.undo_group[0] = '\0';
+       temp_buffers.idname[0] = temp_buffers.name[0] = temp_buffers.description[0] = temp_buffers.undo_group[0] = '\0';
        /* We have to set default op context! */
-       strcpy(temp_buffers.ctxt, BLT_I18NCONTEXT_OPERATOR_DEFAULT);
+       strcpy(temp_buffers.translation_context, BLT_I18NCONTEXT_OPERATOR_DEFAULT);
 
        /* validate the python class */
        if (validate(&dummyotr, data, have_function) != 0)
@@ -1335,31 +1295,31 @@ static StructRNA *rna_MacroOperator_register(
        if (!RNA_struct_available_or_report(reports, identifier)) {
                return NULL;
        }
+       if (!WM_operator_py_idname_ok_or_report(reports, identifier, temp_buffers.idname)) {
+               return NULL;
+       }
 
-       {   /* convert foo.bar to FOO_OT_bar
-                * allocate the description and the idname in 1 go */
-               const uint idname_len = strlen(temp_buffers.idname) + 4;
-               const uint name_len = strlen(temp_buffers.name) + 1;
-               const uint desc_len = strlen(temp_buffers.descr) + 1;
-               const uint ctxt_len = strlen(temp_buffers.ctxt) + 1;
-               const uint undo_group_len = strlen(temp_buffers.undo_group) + 1;
-               /* 2 terminators and 3 to convert a.b -> A_OT_b */
-               char *ch = MEM_mallocN(
-                       sizeof(char) * (idname_len + name_len + desc_len + ctxt_len + undo_group_len), __func__);
-               WM_operator_bl_idname(ch, temp_buffers.idname); /* convert the idname from python */
-               dummyot.idname = ch;
-               ch += idname_len;
-               memcpy(ch, temp_buffers.name, name_len);
-               dummyot.name = ch;
-               ch += name_len;
-               memcpy(ch, temp_buffers.descr, desc_len);
-               dummyot.description = ch;
-               ch += desc_len;
-               memcpy(ch, temp_buffers.ctxt, ctxt_len);
-               dummyot.translation_context = ch;
-               ch += ctxt_len;
-               memcpy(ch, temp_buffers.undo_group, undo_group_len);
-               dummyot.undo_group = ch;
+       /* Convert foo.bar to FOO_OT_bar
+        * allocate all strings at once. */
+       {
+               char idname_conv[sizeof(dummyop.idname)];
+               WM_operator_bl_idname(idname_conv, temp_buffers.idname); /* convert the idname from python */
+               const char *strings[] = {
+                       idname_conv,
+                       temp_buffers.name,
+                       temp_buffers.description,
+                       temp_buffers.translation_context,
+                       temp_buffers.undo_group,
+               };
+               char *strings_table[ARRAY_SIZE(strings)];
+               BLI_string_join_array_by_sep_char_with_tableN('\0', strings_table, strings, ARRAY_SIZE(strings));
+
+               dummyot.idname = strings_table[0];  /* allocated string stored here */
+               dummyot.name = strings_table[1];
+               dummyot.description = strings_table[2];
+               dummyot.translation_context = strings_table[3];
+               dummyot.undo_group = strings_table[4];
+               BLI_assert(ARRAY_SIZE(strings) == 5);
        }
 
        /* XXX, this doubles up with the operator name [#29666]
index a91c30c280750817255b640e859904fd9615b74d..7c1c388bcba9639e53099f463d3404ef74c328b3 100644 (file)
@@ -354,6 +354,7 @@ bool         WM_operator_pystring_abbreviate(char *str, int str_len_max);
 char           *WM_prop_pystring_assign(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
 void           WM_operator_bl_idname(char *to, const char *from);
 void           WM_operator_py_idname(char *to, const char *from);
+bool        WM_operator_py_idname_ok_or_report(struct ReportList *reports, const char *classname, const char *idname);
 
 /* *************** uilist types ******************** */
 void                WM_uilisttype_init(void);
index cd3bebb48ee29e535fd1ae16184b9de32b69dce5..9314e7af5333f8c702d0fe3724f9128a93216de1 100644 (file)
@@ -572,6 +572,46 @@ void WM_operator_bl_idname(char *to, const char *from)
                to[0] = 0;
 }
 
+/**
+ * Sanity check to ensure #WM_operator_bl_idname won't fail.
+ * \returns true when there are no problems with \a idname, otherwise report an error.
+ */
+bool WM_operator_py_idname_ok_or_report(ReportList *reports, const char *classname, const char *idname)
+{
+       const char *ch = idname;
+       int dot = 0;
+       int i;
+       for (i = 0; *ch; i++, ch++) {
+               if ((*ch >= 'a' && *ch <= 'z') || (*ch >= '0' && *ch <= '9') || *ch == '_') {
+                       /* pass */
+               }
+               else if (*ch == '.') {
+                       dot++;
+               }
+               else {
+                       BKE_reportf(reports, RPT_ERROR,
+                                   "Registering operator class: '%s', invalid bl_idname '%s', at position %d",
+                                   classname, idname, i);
+                       return false;
+               }
+       }
+
+       if (i > (MAX_NAME - 3)) {
+               BKE_reportf(reports, RPT_ERROR, "Registering operator class: '%s', invalid bl_idname '%s', "
+                           "is too long, maximum length is %d", classname, idname,
+                           MAX_NAME - 3);
+               return false;
+       }
+
+       if (dot != 1) {
+               BKE_reportf(reports, RPT_ERROR,
+                           "Registering operator class: '%s', invalid bl_idname '%s', must contain 1 '.' character",
+                           classname, idname);
+               return false;
+       }
+       return true;
+}
+
 /**
  * Print a string representation of the operator, with the args that it runs so python can run it again.
  *