JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
added: tem_merge(), tem_merge_file()
[wfpl.git] / template.php
index 5ac7f80..af66590 100644 (file)
@@ -57,15 +57,14 @@ function parse_template_file($filename) {
        return parse_template(file_get_contents($filename));
 }
 
-# We parse the template string into a tree of strings and sub-templates.  
+# We parse the template string into a tree of strings and sub-templates.
 # A template is a hash with a name string, a pieces array, and possibly 
 # an args array.
 
 function parse_template($string) {
        $tem =& tem_push();
        $tem['pieces'] = array();
-       # note: for some reason this captures '<!--' but not '-->'.
-       $matches = preg_split("/(<!--)?(~[^~]*~)(?(1)-->)/", $string, -1, PREG_SPLIT_DELIM_CAPTURE);
+       $matches = preg_split('/(<!--)?(~[^~]*~)(?(1)-->)/', preg_replace('/<!--(~[^~]*~)-->/', '$1', $string), -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
        foreach($matches as $match) {
                if($match == '~~') $match = '~';
                if(substr($match,0,1) == '~' and strlen($match) > 2) {
@@ -85,13 +84,13 @@ function parse_template($string) {
                                array_pop($args);  # drop '}'
                                $cur = $tem['name'];
                                if($name && $name != $cur) {
-                                       die("Invalid template: tried to close '$name', but '$cur' is current.");
+                                       die("Invalid template: tried to close '$name', but '$cur' is current.");
                                }
                                $tem =& $tem['parent'];
                        } else {  # value slot
                                $tem['pieces'][] = array('name' => $name, 'args' => $args);
                        }
-               } elseif($match and $match != '<!--') {  # static string
+               } else {  # static string
                        $tem['pieces'][] = $match;
                }
        }
@@ -209,7 +208,7 @@ function &tem_row_data($tem, $context)
        if(count($tem['args'])) {
                $auto_func = "tem_auto_" . $tem['args'][0];
                function_exists($auto_func)
-                       or die("ERROR: template auto function '$auto_func' not found.<br>\n");
+                       or die("ERROR: template auto function '$auto_func' not found.<br>\n");
        }
        if($auto_func) $value = $auto_func($scope['data'][$key], $key, $scope);
        else $value = $scope['data'][$key];
@@ -234,13 +233,17 @@ function tem_encoded_data($tag, $context)
 }
 
 
+function is_sub_template($piece) {
+       return is_array($piece) and $piece['pieces'];
+}
 
 # Return a hash containing the top-level sub-templates of tem.
-function top_sub_templates($tem) {
+function top_sub_templates($tem, $is_sub = 'is_sub_template') {
+       function_exists($is_sub) or die("no such function '$is_sub'.");
        $subs = array();
        foreach($tem['pieces'] as $piece) {
-               if(is_array($piece) and $piece['pieces']) {
-                       $subs[$piece['name']] = $piece;
+               if($is_sub($piece)) {
+                       $subs[$piece['name']] = $piece;
                }
        }
        return $subs;
@@ -275,18 +278,32 @@ function merge_templates($main, $tem) {
 #      <!--~rows {~-->
 #              <!--~row {~-->
 #                      row content...
-#                      <!--~separator sep {~--><hr><!--~}"-->
+#                      <!--~separator sep {~--><hr><!--~}~-->
 #              <!--~}~-->
 #      <!--~}~-->
 #
 function tem_auto_sep(&$value, $key, $context) {
        $rows =& $context['parent']['parent'];
        if($rows['cur'] != count($rows['rows'])-1)  # last row?
-               return $value = true;  # show once
+               return $value = true;  # show once
+}
+
+# auto-show once, only when this is the first row of the parent
+function tem_auto_last(&$value, $key, $context) {
+       $rows =& $context['parent']['parent'];
+       if($rows['cur'] == count($rows['rows'])-1)  # last row?
+               return $value = true;  # show once
+}
+
+# auto-show once, only when this is the last row of the parent
+function tem_auto_first(&$value, $key, $context) {
+       $rows =& $context['parent']['parent'];
+       if($rows['cur'] == 0)  # first row?
+               return $value = true;  # show once
 }
 
 # 'show' sections will be shown unless the corresponding data value
-# is false.  We check only for false; 0 or '' will not work.
+# is false (only false, not 0 or '' or array()).
 
 function tem_auto_show(&$value) {
        if($value !== false) $value = array(array());
@@ -297,8 +314,8 @@ function tem_auto_show(&$value) {
 # alternates between 'even' and 'odd'.
 
 function tem_auto_evenodd(&$values) {
-       $even = false;
-       foreach($values as &$value) {
+       $even = true;
+       if($values) foreach($values as &$value) {
                $value['evenodd'] = $even ? 'even' : 'odd';
                $even = !$even;
        }
@@ -312,6 +329,14 @@ function tem_auto_evenodd(&$values) {
 # Backward Compatibility
 # ----------------------
 
+function is_shown($piece) {
+       return $piece['args'][0] == 'hide';
+}
+
+function is_shown_sub_template($piece) {
+       return is_sub_template($piece) and is_shown($piece);
+}
+
 # Old-style templates don't show unless explicitly requested.
 function tem_auto_hide(&$value, $key, $context) {
        unset($context['data'][$key]);
@@ -322,10 +347,12 @@ function tem_auto_hide(&$value, $key, $context) {
 # so hide it and insert a value slot for its expansion(s).
 function &tem_is_old_sub($name, &$template) {
        foreach($template['pieces'] as $key => &$piece) {
-               if(is_array($piece) and $piece['pieces']) {
+               if(is_sub_template($piece)) {
                        if($piece['name'] == $name) {
-                               if($piece['args'][0] != 'hide') {  # if we haven't already
+                               if(!is_shown($piece)) {
+                                       # hide template unless explicitly show()n.
                                        $piece['args'] = array('hide');
+                                       # insert a value slot with the same name (for the expansion).
                                        $var = array('name' => $name, 'args' => array());
                                        array_splice($template['pieces'], $key, 0, array($var));
                                }
@@ -335,6 +362,7 @@ function &tem_is_old_sub($name, &$template) {
                        if($tem) return $tem;
                }
        }
+       return false;
 }
 
 class tem {
@@ -342,9 +370,9 @@ class tem {
        var $data; 
 
        function tem() {
-               $this->template = array();
+               $this->template = array('pieces' => array());
                $this->data = array();
-       }
+       }
        
        function set($key, $value) {
                $this->data[$key] = $value;
@@ -368,7 +396,9 @@ class tem {
 
        function show($name) {
                $tem = tem_is_old_sub($name, $this->template);
-               $this->data[$name] .= fill_template($tem, $this->data);
+               if($tem) {
+                       $this->data[$name] .= fill_template($tem, $this->data);
+               }
        }
 
        function show_separated($name) {
@@ -403,7 +433,8 @@ class tem {
        # supporting both new and old semantics.
        function merge($tem) {
                # append expansions to $this->data (old style)
-               $subs = $tem->top_subs();
+
+               $subs = $tem->top_subs('is_shown_sub_template');
                if($subs) foreach($subs as $name => $val) {
                        $this->append($name, $val);
                        unset($tem->data[$name]);  # so array_merge() won't overwrite things
@@ -414,13 +445,20 @@ class tem {
                $this->template = merge_templates($this->template, $tem->template);
        }
 
-       function top_sub_names() {
-               return array_keys(top_sub_templates($this->template));
+       # see merge() above
+       function merge_file($filename) {
+               $other_tem = new tem();
+               $other_tem->load($filename);
+               $this->merge($other_tem);
+       }
+
+       function top_sub_names($is_sub = 'is_sub_template') {
+               return array_keys(top_sub_templates($this->template, $is_sub));
        }
 
-       function top_subs() {
+       function top_subs($is_sub = 'is_sub_template') {
                $ret = array();
-               $names = $this->top_sub_names();
+               $names = $this->top_sub_names($is_sub);
                foreach($names as $name) {
                        $ret[$name] = $this->get($name);
                }
@@ -479,6 +517,16 @@ function tem_load($filename) {
        $GLOBALS['wfpl_template']->load($filename);
 }
 
+function tem_merge($tem) {
+       tem_init();
+       $GLOBALS['wfpl_template']->merge($tem);
+}
+
+function tem_merge_file($filename) {
+       tem_init();
+       $GLOBALS['wfpl_template']->merge_file($filename);
+}
+
 function tem_output($filename = false) {
        tem_init();
        $GLOBALS['wfpl_template']->output($filename);