Using a shared helper method to streamline the generated code

CHANGELOG.md

@@ -1,5 +1,30 @@
+## v7.1.0
+- Using a shared helper method to streamline the generated code
+
+## v7.0.0
+- Using a dedicated wrapper for i18n strings to streamline the generated code
+
+## v6.1.0
+- Removed redundant accessor interface declarations in generated slices
+
+## v5.0.0
+- Splitting one huge codegenerated file into multiple ones
+
+## v4.10.0
+- Added @flt_i18n token to support translations
+
+## v4.9.2
+- Added @cs_obsolete token, that mark fields with [Obsolete]. @cs_obsolete:"Comment" will add summary with "Comment" to field
+
+## v4.9.1
+- Fixing nested diffable POD structs being incorrectly marked as clean in GetDiff
+
+## v4.8.2
+- Fixing thread safety possible issue when reading an array of enums 
+- Fixing bug when the target enum array property wouldn't be cleared before reading data 
+
 ## v4.8.0
 - Using C# built-in initialization routines instead of MetaIO's methods
 
 ## v4.7.0
-- Array comparison generated code now takes bitfields token into account for array entries 
+- Array comparison generated code now takes bitfields token into account for array entries 

README.md

@@ -2,9 +2,10 @@ This package is used for code generation of C# meta structs using Twig templates
 
 Usage example:
 
-    $code = \metagen_cs\codegen(null, get_meta(), 
+    $output = \metagen_cs\codegen(null, get_meta(), 
     [
       'namespace' => 'BitGames.Autogen'
     ]);
-    file_put_contents('bundle.cs', $code);
+    foreach($output as $name => $text)
+      file_put_contents($name, $text); 
 

src/codegen.inc.php

@@ -2,7 +2,7 @@
 namespace metagen_cs;
 use Exception;
 
-function codegen(?string $cache_dir, \mtgMetaInfo $meta, array $options = []) : string
+function codegen(?string $cache_dir, \mtgMetaInfo $meta, array $options = []) : array
 {
   $twig = get_twig();
 
@@ -15,7 +15,21 @@ function codegen(?string $cache_dir, \mtgMetaInfo $meta, array $options = []) :
   if(!isset($options['namespace']))
     $options['namespace'] = 'BitGames.Autogen';
 
-  return $twig->render('codegen_bundle.twig', $options);
+  $sliced_units = slice_units($meta->getUnits(), 50);
+
+  $output = array();
+
+  foreach($sliced_units as $slice_idx => $slice_units)
+  {
+    $slice_options = $options;
+    $slice_options['slice_idx'] = $slice_idx;
+    $slice_options['slice_units'] = $slice_units;
+    $output['types_'.$slice_idx.'.cs'] = $twig->render('codegen_types_slice.twig', $slice_options);
+  }
+
+  $output['factory.cs'] = $twig->render('codegen_factory.twig', $options);
+
+  return $output;
 }
 
 function get_twig(array $inc_path = []) : \Twig\Environment
@@ -55,6 +69,7 @@ function supported_tokens() : array
     'cs_propget_interface',
     'cs_propset_interface',
     'cs_propgetset_interface',
+    'cs_obsolete',
     //TODO:
     //'i18n'
   ];
@@ -122,9 +137,18 @@ function _add_twig_support(\Twig\Environment $twig)
     }
   ));
   $twig->addFilter(new \Twig\TwigFilter('cs_type', 
+    function($type, $fld = null)  
+    {
+      return cs_type($type, $fld);
+    }
+  ));
+  $twig->addFilter(new \Twig\TwigFilter('cs_simple_type', 
     function($type) 
     {
-      return cs_type($type);
+      if($type instanceof \mtgArrType)
+        return cs_simple_type($type->getValue());
+      else
+        return cs_simple_type($type);
     }
   ));
   $twig->addFilter(new \Twig\TwigFilter('cs_type_prefix', 
@@ -189,10 +213,14 @@ function _add_twig_support(\Twig\Environment $twig)
   ));
 }
 
-function cs_type(\mtgType $type)
+function cs_type(\mtgType $type, $fld = null)
 {
   if($type instanceof \mtgBuiltinType || $type instanceof \mtgUserType)
+  {
+    if($fld != null && $fld->hasToken("flt_i18n"))
+      return "MetaI18NString";
     return cs_simple_type($type);
+  }
   else if($type instanceof \mtgArrType)
     return "List<" . cs_simple_type($type->getValue()) . ">";
   else
@@ -232,7 +260,7 @@ function cs_simple_type(\mtgType $type)
       case "bool":
         return "bool";
       case "blob":
-        return "byte[]";
+        return "ArraySegment<byte>";
     }
     throw new Exception("Unknown type '{$type}'");
   }
@@ -343,7 +371,7 @@ function var_reset($name, \mtgType $type, $default = null)
         $str .= " = ".trim($default, '"').";";
       }
       else
-        $str .= ' = null;';
+        $str .= ' = default;';
     }
     else 
       throw new Exception("Unknown type '$type'");
@@ -395,16 +423,16 @@ function var_reset($name, \mtgType $type, $default = null)
 
     if($default)
     {
-      $default = is_array($default) ? $default : json_decode($default, true);
-      if(is_array($default))
+      $default_val = is_array($default) ? $default : json_decode($default, true);
+      if(is_array($default_val))
       {
-        foreach($default as $k => $v)
+        foreach($default_val as $k => $v)
         {
           $kf = $type->getField($k); 
           $str .= var_reset("$name." . $kf->getName(), $kf->getType(), $v);
         }
       }
-      else if($default === null)
+      else if(is_null_str($default))
         $str .= "$name = null; ";
       else
         throw new Exception("Bad default value for struct: " . var_export($default, true));
@@ -417,7 +445,7 @@ function var_reset($name, \mtgType $type, $default = null)
 
 function is_null_str($default)
 {
-  return is_string($default) && json_decode($default, true) === null;
+  return is_string($default) && strtolower($default) === 'null';
 }
 
 function var_sync($fname, \mtgType $type, $buf, array $tokens, $opts)
@@ -427,7 +455,10 @@ function var_sync($fname, \mtgType $type, $buf, array $tokens, $opts)
   $str = '';
   if($type instanceof \mtgBuiltinType)
   {
-    $str .= "MetaIO.Sync({$buf}, ref {$fname}, \"{$key_name}\", {$opts});\n";
+    if($type->isString() && array_key_exists('flt_i18n', $tokens))
+      $str .= "$fname.SyncSingular({$buf}, \"{$key_name}\", {$opts});\n"; //TODO: plurals support
+    else
+      $str .= "MetaIO.Sync({$buf}, ref {$fname}, \"{$key_name}\", {$opts});\n";
   }
   else if($type instanceof \mtgMetaStruct)
   {
@@ -440,7 +471,7 @@ function var_sync($fname, \mtgType $type, $buf, array $tokens, $opts)
   {
     $str .= "int __tmp_{$fname} = (int)$fname;\n";
     $str .= "MetaIO.Sync({$buf}, ref __tmp_{$fname}, \"{$key_name}\", {$opts});\n";
-    $str .= "if($buf.is_read) {$fname} = ({$type->getName()})__tmp_{$fname};\n";
+    $str .= "if($buf.is_read) {$fname} = (".cs_type($type).")__tmp_{$fname};\n";
   }
   else if($type instanceof \mtgArrType)
   {
@@ -453,7 +484,7 @@ function var_sync($fname, \mtgType $type, $buf, array $tokens, $opts)
         $str .= "{\n";
         $str .= "var tmp_enums_list = new List<int>(); if(!{$buf}.is_read) { foreach(var _enum_tmp in {$fname}) tmp_enums_list.Add((int)_enum_tmp); }\n";
         $str .= "MetaIO.Sync({$buf}, tmp_enums_list, \"{$key_name}\", {$opts});\n";
-        $str .= "if({$buf}.is_read) { {$fname}.Clear(); foreach(var _int_tmp in MetaIO.tmp_enums_list) {$fname}.Add(({$type->getValue()->getName()}) _int_tmp); }\n";
+        $str .= "if({$buf}.is_read) { {$fname}.Clear(); foreach(var _int_tmp in tmp_enums_list) {$fname}.Add(({$type->getValue()->getName()}) _int_tmp); }\n";
         $str .= "}\n";
       }
       else
@@ -581,6 +612,11 @@ class AccessorInterfaceField
     return $this->field->getName();
   }
 
+  function hasToken($token) 
+  {
+    return $this->field->hasToken($token);
+  }
+
   function getCamelFieldName()
   {
     $name_parts = explode("_", $this->field->getName());
@@ -703,3 +739,41 @@ function get_field_index(\mtgMetaStruct $struct, string $field_name): int
   }
   return -1;
 }
+
+function paginate($total, $step)
+{
+  //pages are returned as an array where each element is in interval [N, Y)
+  $pages = array();
+
+  $steps = (int)($total/$step);
+  $rest = $total % $step;
+
+  for($i=1;$i<=$steps;++$i)
+    $pages[] = array(($i-1)*$step, $i*$step);
+
+  if($rest != 0)
+    $pages[]  = array(($i-1)*$step, ($i-1)*$step + $rest);
+
+  return $pages;
+}
+
+//slices array like this: [[idx0,[..]], [idx1,[..]], ...]
+function slice_units(array $units, $max)
+{
+  $pages = paginate(sizeof($units), $max);
+  
+  $sliced = array();
+
+  $units_keys = array_keys($units);
+
+  foreach($pages as $idx => $page)
+  {
+    $slice = array();
+    for($i = $page[0];$i<$page[1];++$i)
+    {
+      $slice[] = $units[$units_keys[$i]];
+    }
+    $sliced[$idx] = $slice;  
+  }
+  return $sliced;
+}

tpl/codegen_factory.twig

@@ -1,6 +1,7 @@
 //THIS FILE IS GENERATED AUTOMATICALLY, DO NOT TOUCH IT!
 using System.Collections.Generic;
 using metagen;
+using System;
 
 {%- import "macro.twig" as macro -%}
 
@@ -8,7 +9,9 @@ using metagen;
 namespace {{namespace}} {
 {% endif %}
 
-{{ macro.decl_units(meta) }}
+{%- for ai in get_all_declarable_accessor_interfaces(meta) ~%}
+  {{ macro.decl_accessor_interface(ai) }}
+{%- endfor ~%}
 
 static public class AutogenBundle 
 {

tpl/codegen_types_slice.twig

@@ -0,0 +1,16 @@
+//THIS FILE IS GENERATED AUTOMATICALLY, DO NOT TOUCH IT!
+using System.Collections.Generic;
+using metagen;
+using System;
+
+{%- import "macro.twig" as macro -%}
+
+{% if namespace is defined ~%}
+namespace {{namespace}} {
+{% endif %}
+
+{{ macro.decl_units(slice_units) }}
+
+{% if namespace is defined ~%}
+} //namespace {{namespace}}
+{% endif %}

tpl/macro.twig

@@ -1,6 +1,6 @@
-{% macro decl_units(meta) %}
+{% macro decl_units(units) %}
 
-{%- for u in meta.getunits ~%}
+{%- for u in units ~%}
   {%- if u.object is instanceof('\\mtgMetaStruct') -%}
   {{ _self.decl_struct(u.object) }}
   {%- elseif u.object is instanceof('\\mtgMetaEnum') -%}
@@ -10,10 +10,6 @@
   {%- endif ~%}
 {%- endfor ~%}
 
-{%- for ai in get_all_declarable_accessor_interfaces(meta) ~%}
-  {{ _self.decl_accessor_interface(ai) }}
-{%- endfor ~%}
-
 {% endmacro %}
 
 {% macro decl_struct(o, extra = '') %}
@@ -160,17 +156,27 @@ public FieldsMask fields_mask;
 
 {%- macro decl_struct_field(o, f) -%}
 {{_self.attributes(f)}}
-public {{f.type|cs_type|obscure_type(f)}} {{f.name}} {% if not has_token(o, 'POD') -%} {{_self.decl_init_value(f)}} {%- endif -%};
+public {{f.type|cs_type(f)|obscure_type(f)}} {{f.name}} {% if not has_token(o, 'POD') -%} {{_self.decl_init_value(f)}} {%- endif -%};
 {%- endmacro -%}
 
 {% macro decl_init_value(f) %}
 {%- if f.type is instanceof('\\mtgBuiltinType') -%}
-{%- if f.type.isstring -%} = ""{%- endif -%}
+{%- if f.type.isstring -%}
+  {% if has_token(f, 'flt_i18n') -%}
+    {%- if has_token(f, 'default') -%}
+= new({{token(f, 'default')}})
+    {%- else -%}
+= new()
+    {%- endif -%}
+  {%- else -%}
+= ""
+{%- endif ~%}
+{%- endif -%}
 {%- else -%}
 {%- if has_token(f, 'default') and token(f, 'default') == 'null'  -%}
 /*null*/
 {%- else -%}
-= new {{f.type|cs_type}}()
+= new {{f.type|cs_type(f)}}()
 {%- endif -%}
 {%- endif -%}
 {% endmacro %}
@@ -180,7 +186,11 @@ public {{f.type|cs_type|obscure_type(f)}} {{f.name}} {% if not has_token(o, 'POD
 base.Reset();
 {%- endif -%}
 {%- for f in o.fields ~%}
+{% if has_token(f, 'flt_i18n') -%}
+{{f.name}}?.Reset();
+{%- else ~%}
 {{var_reset(f.name, f.type, token_or(f, 'default', null))}}
+{%- endif ~%}
 {%- endfor -%}
 {%- if has_token(o, 'bitfields') ~%} 
 ResetFieldMask();
@@ -188,6 +198,12 @@ ResetFieldMask();
 {% endmacro %}
 
 {%- macro attributes(o) %}
+{% if has_token(o, "cs_obsolete") %}
+/// <summary>
+/// {{token(o, "cs_obsolete")}}
+/// </summary>
+[Obsolete]
+{% endif %}
 {%- if has_token(o, 'cs_attributes') -%} 
 {%- for attr in token(o, 'cs_attributes')|split(',') -%} 
 [{{attr}}]
@@ -303,14 +319,7 @@ base.SyncFields(ctx);
     int fields_amount = {{fields_count(o)}};
     var primary_id_mask = FieldsMask.MakeClean(fields_amount); 
     SetPrimaryFieldsChanged(ref primary_id_mask);
-    for(int i = 0; i < fields_amount; i++)
-    {
-      bool is_primary_id = primary_id_mask.IsDirty(i);
-      if(!is_primary_id && fields_mask.IsDirty(i))
-        return true;
-    }
-    
-    return false;
+    return FieldsMask.CheckContentsChanged(fields_amount, ref primary_id_mask, ref fields_mask);
   }
 
   public void SetDirtyMask()
@@ -349,13 +358,20 @@ public enum {{o.name}}
 }
 {% endmacro %}
 
-{% macro decl_rpc(o) %}
+{% macro decl_rpc(o, is_global = true) %}
 
+{% if is_global %}
 {{_self.decl_struct(o.req)}}
 {{_self.decl_struct(o.rsp)}}
+{% endif %}
 
 public class {{o.name}} : IRpc
 {
+{% if not is_global %}
+  {{_self.decl_struct(o.req)}}
+  {{_self.decl_struct(o.rsp)}}
+{% endif %}
+
   public IRpcError error = null;
   public {{o.req.name}} req = new {{o.req.name}}();
   public {{o.rsp.name}} rsp = new {{o.rsp.name}}();
@@ -452,7 +468,7 @@ public class {{o.name}} : IRpc
       }
       else if(old > item)
       {
-        item.SetDirtyMask();
+        item.SetDirtyMaskDeep();
         if(changed != null)
           changed.Add(item);
         i++;
@@ -476,7 +492,7 @@ public class {{o.name}} : IRpc
     for(; i < items.Count; i++)
     {
       var item = items[i];
-      item.SetDirtyMask();
+      item.SetDirtyMaskDeep();
       if(changed != null)
         changed.Add(item);
       has_diff = true;
@@ -525,10 +541,48 @@ public class {{o.name}} : IRpc
 {{has_token(o, 'bitfields')?'CompareAndMarkFields':'IsEqual'}}
 {%- endmacro %}
 
-{%- macro field_compare(o, f, field_idx) -%}
+{% macro field_compare_array_bitfields_nested_diffable(o, f, field_idx) %}
+    {
+      int {{f.name}}_count_a = a.{{f.name}} == null ? 0 : a.{{f.name}}.Count;
+      int {{f.name}}_count_b = b.{{f.name}} == null ? 0 : b.{{f.name}}.Count;
 
-  {% if f.type is instanceof('\\mtgArrType') ~%}
-    {% if has_token(o, 'bitfields') ~%}
+      //For NESTED arrays of DIFFABLE structs:
+      //for DB compatibility we must add the WHOLE ARRAY to the diff if ANY ELEMENT of the array has changed.
+      //That means marking each element's fields_mask as dirty
+
+      //Changed size means the array has changed, no furhter checks required.
+      bool {{f.name}}_equal = {{f.name}}_count_a == {{f.name}}_count_b;
+
+      //For same size arrays - check contents for changes.
+      if({{f.name}}_equal)
+      {
+        for(int i=0;i<{{f.name}}_count_a && i<{{f.name}}_count_b;++i)
+        {
+          var tmp_{{f.name}} = a.{{f.name}}[i];
+          if(!CompareAndMarkFields(ref tmp_{{f.name}}, b.{{f.name}}[i]))
+          {
+            {{f.name}}_equal = false;
+            break;
+          }
+        }
+      }
+
+      //If change detected - mark top-level field as changed and add the whole array to the diff
+      if(!{{f.name}}_equal)
+      {
+        MetaIO.SetFieldDirty(ref a.fields_mask, {{field_idx}});
+        for(int i=0; i<{{f.name}}_count_a;++i)
+        {
+          var tmp_{{f.name}} = a.{{f.name}}[i];
+          tmp_{{f.name}}.SetDirtyMaskDeep();
+          a.{{f.name}}[i] = tmp_{{f.name}};
+          is_equal = false;
+        }
+      }
+    }
+{%- endmacro %}
+
+{% macro field_compare_array_bitfields_nested_plain(o, f, field_idx) %}
     if(a.{{f.name}} == null ||
        b.{{f.name}} == null ||
        a.{{f.name}}.Count != b.{{f.name}}.Count)
@@ -558,7 +612,9 @@ public class {{o.name}} : IRpc
         {%- endif -%}
       }
     }
-    {% else ~%}
+{%- endmacro %}
+
+{% macro field_compare_array_plain(o, f, field_idx) %}
     if(a.{{f.name}} == null || 
        b.{{f.name}} == null || 
        a.{{f.name}}.Count != b.{{f.name}}.Count) 
@@ -574,6 +630,19 @@ public class {{o.name}} : IRpc
           return false;
       {%- endif -%}
     }
+{%- endmacro %}
+
+{%- macro field_compare(o, f, field_idx) -%}
+
+  {% if f.type is instanceof('\\mtgArrType') ~%}
+    {% if has_token(o, 'bitfields') ~%}
+      {% if has_token(f.type.value, 'bitfields') ~%}
+        {{_self.field_compare_array_bitfields_nested_diffable(o, f, field_idx)}}
+      {% else ~%}
+        {{_self.field_compare_array_bitfields_nested_plain(o, f, field_idx)}}
+      {% endif ~%}
+    {% else ~%}
+      {{_self.field_compare_array_plain(o, f, field_idx)}}
     {% endif ~%}
 
   {% elseif f.type is instanceof('\\mtgMetaStruct') ~%}
@@ -668,12 +737,12 @@ public interface {{ai.interfacename}}
 {
   {%- for aif in ai.fields ~%}
   {% if aif.is_accessor -%}
-  {{aif.field.type|cs_type}} Get{{aif.camelfieldname}}();
-  void Set{{aif.camelfieldname}}({{aif.field.type|cs_type}} v);
+  {{aif.field.type|cs_type(aif)}} Get{{aif.camelfieldname}}();
+  void Set{{aif.camelfieldname}}({{aif.field.type|cs_type(aif)}} v);
   {% endif -%}
 
   {%- if aif.is_propget -%}
-  {{aif.field.type|cs_type}} {{aif.camelfieldname}} {
+  {{aif.field.type|cs_type(aif)}} {{aif.camelfieldname}} {
   {%- if aif.is_propget -%}
     get;
   {%- endif %}
@@ -690,18 +759,18 @@ public interface {{ai.interfacename}}
 {%- for ai in get_accessor_interfaces(o) ~%}
 {%- for aif in ai.fields ~%}
 {% if aif.is_accessor %}
-  public {{aif.field.type|cs_type}} Get{{aif.camelfieldname}}()
+  public {{aif.field.type|cs_type(aif)}} Get{{aif.camelfieldname}}()
   {
     return {{aif.field.name}};
   }
-  public void Set{{aif.camelfieldname}}({{aif.field.type|cs_type}} v)
+  public void Set{{aif.camelfieldname}}({{aif.field.type|cs_type(aif)}} v)
   {
     this.{{aif.field.name}} = v;
   }
 {% endif %}
 
 {% if aif.is_propget or aif.is_propset %}
-  public {{aif.field.type|cs_type}} {{aif.camelfieldname}} {
+  public {{aif.field.type|cs_type(aif)}} {{aif.camelfieldname}} {
   {%- if aif.is_propget -%}
     get => this.{{aif.field.name}};
   {%- endif -%}
@@ -713,4 +782,3 @@ public interface {{ai.interfacename}}
 {% endfor %}
 {%- endfor ~%}
 {% endmacro %}
-