pluie-yaml/src/vala/Pluie/Yaml.NodeSequence.vala

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *
 *  @software  : lib-yaml    <https://git.pluie.org/pluie/lib-yaml>
 *  @version   : 0.3
 *  @date      : 2018
 *  @licence   : GPLv3.0     <http://www.gnu.org/licenses/>
 *  @author    : a-Sansara   <[dev]at[pluie]dot[org]>
 *  @copyright : pluie.org   <http://www.pluie.org/>
 * 
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *
 *  This file is part of lib-yaml.
 *  
 *  lib-yaml is free software (free as in speech) : you can redistribute it
 *  and/or modify it under the terms of the GNU General Public License as
 *  published by the Free Software Foundation, either version 3 of the License,
 *  or (at your option) any later version.
 *  
 *  lib-yaml is distributed in the hope that it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 *  more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with lib-yaml.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 */

using Pluie;
using Gee;

/**
 * a class representing a sequence node
 */
public class Pluie.Yaml.NodeSequence : Yaml.BaseNode, Yaml.NodeCollection
{

    /**
     * sequence collection for Yaml.NodeSequence node
     */
    public ArrayList<Yaml.Node> list { get; internal set; }

    /**
     * construct a sequence node
     * @param parent the parent node
     * @param name the current name (key) of sequence node
     */
    public NodeSequence (Yaml.Node? parent = null, string? name = null)
    {
        base (parent, NODE_TYPE.SEQUENCE);
        this.name = name;
    }

    /**
     * remove a child
     * @param child  the child to remove
     */
    protected override bool remove_child (Yaml.Node child)
    {
        bool done = true;
        if (this.list.contains (child)) {
            done = this.list.remove (child);
        }
        return done;
    }

    /**
     * add a child node to current collection (mapping or sequence) node
     * @param child the Yaml.Node child to add
     */
    public override bool add (Yaml.Node node)
    {
        if (this.list == null) {
            this.list = new ArrayList<Yaml.Node> ();
        }
        node.on_change_parent ();
        node.level = this.level + 1;
        node.parent = this;
        return this.list.add (node);
    }

    /**
     * add a child Yaml.NodeScalar containing specifiyed data
     * @param data the scalar data
     * @return the scalar node
     */
    public Yaml.Node  add_scalar (string? data = null)
    {
        Yaml.Node scalar = new Yaml.NodeScalar (this, data); 
        this.add (scalar);
        return scalar;
    }

    /**
     * retriew a child node throught specifiyed index
     * @param index index of searched child
     * @return the child node
     */
    public Yaml.Node item (int index)
    {
        return this.list.get (index);
    }

    /**
     * retriew the first child node
     * @return the first child node
     */
    public Yaml.Node first ()
    {
        return this.list.first ();
    }


    /**
     * retriew the last child node
     * @return the last child node
     */
    public Yaml.Node last ()
    {
        return this.list.last ();
    }

    /**
     * display childs
     */
    public void display_childs (bool root = true)
    {
        if (root) {
            of.action ("display_childs sequence\n");
        }
        of.echo (this.to_string ());
        if (this.list!= null && this.list.size > 0) {
            foreach (Yaml.Node child in this.list) {
                if (child.node_type.is_mapping ()) (child as Yaml.NodeMap).display_childs (false);
                else if (child.node_type.is_sequence ()) (child as Yaml.NodeSequence).display_childs (false);
                else if (child.node_type.is_single_pair ()) {
                    of.echo (child.to_string ());
                    of.echo ((child as Yaml.NodeSinglePair).scalar ().to_string ());
                }
                else {
                    of.echo (child.to_string ());
                }
            }
        }
        else {
            of.echo (of.s_indent ()+"node has no childs");
        }
    }

    /**
     * count childnodes
     */
    public int get_size () {
        return this.list == null ? 0 : this.list.size;
    }

    /**
     * check if current node contains the specifiyed child node
     * @param child
     */
    public override bool contains (Yaml.Node child) {
        return this.list.contains (child);
    }

    /**
     * retriew the next sibling of specifiyed child node
     * @param   child
     */
    public Yaml.Node? child_next_sibling (Yaml.Node child)
    {
        Yaml.Node? target = null;
        if (this.list.size > 0 && this.list.contains (child)) {
            int index = this.list.index_of (child);
            target = this.list.get(index+1);
        }
        return target;
    }

    /**
     * retriew the previous sibling of specifiyed child node
     * @param   child
     */
    public Yaml.Node? child_previous_sibling (Yaml.Node child)
    {
        Yaml.Node? target = null;
        if (this.list.size > 0 && this.list.contains (child)) {
            int index = this.list.index_of (child);
            if (index > 0) {
                target = this.list.get(index-1);
            }
        }
        return target;
    }

    /**
     * clone current node
     * @param   the name of clone
     */
    public override Yaml.Node clone_node (string? name = null)
    {
        var key = name != null ? name : this.name;
        Yaml.Node clone = new Yaml.NodeSequence (this.parent, key);
        if (this.list!= null && this.list.size > 0) {
            foreach (Yaml.Node child in this.list) {
                var n = child.clone_node();
                n.parent = clone;
                clone.add(n);
            }
        }
        return clone;
    }

}