yamerl_node_map.erl

%-
% Copyright (c) 2012-2014 Yakaz
% Copyright (c) 2016-2022 Jean-Sébastien Pédron <jean-sebastien.pedron@dumbbell.fr>
% All rights reserved.
%
% Redistribution and use in source and binary forms, with or without
% modification, are permitted provided that the following conditions
% are met:
% 1. Redistributions of source code must retain the above copyright
%    notice, this list of conditions and the following disclaimer.
% 2. Redistributions in binary form must reproduce the above copyright
%    notice, this list of conditions and the following disclaimer in the
%    documentation and/or other materials provided with the distribution.
%
% THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
% ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
% ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
% FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
% DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
% OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
% HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
% LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
% OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
% SUCH DAMAGE.

%% @private

-module(yamerl_node_map).

-include("yamerl_errors.hrl").
-include("yamerl_tokens.hrl").
-include("yamerl_nodes.hrl").
-include("yamerl_constr.hrl").

%% Public API.
-export([
    tags/0,
    try_construct_token/3,
    construct_token/3,
    construct_node/3,
    node_pres/1
  ]).

-define(TAG, "tag:yaml.org,2002:map").

-record(map_builder,
        {format :: proplist | map,
         state  :: none | '$expecting_key' | {'$expecting_value', term()},
         keys   :: map(),
         data   :: proplists:proplist() | map()}).

%% -------------------------------------------------------------------
%% Public API.
%% -------------------------------------------------------------------

tags() -> [?TAG].

try_construct_token(Constr, Node,
  #yamerl_collection_start{kind = mapping} = Token) ->
    construct_token(Constr, Node, Token);
try_construct_token(_, _, _) ->
    unrecognized.

construct_token(Constr, undefined, #yamerl_collection_start{} = Token) ->
    Map = new_builder(Constr),
    Pres = yamerl_constr:get_pres_details(Token),
    Node = #unfinished_node{
      path = {map, undefined},
      pres = Pres,
      priv = Map
    },
    {unfinished, Node, false};
construct_token(_, #unfinished_node{priv = Map} = Node,
  #yamerl_mapping_key{}) ->
    Node1 = Node#unfinished_node{
      priv = Map#map_builder{state = '$expecting_key'}
    },
    {unfinished, Node1, false};
construct_token(_,
  #unfinished_node{priv = #map_builder{state = State} = Map} = Node,
  #yamerl_mapping_value{}) when State =/= '$expecting_key' ->
    Node1 = Node#unfinished_node{
      priv = Map#map_builder{
               state = {'$expecting_value', Map#map_builder.state}}
    },
    {unfinished, Node1, false};

construct_token(#yamerl_constr{detailed_constr = false},
  #unfinished_node{priv = #map_builder{state = none} = Builder},
  #yamerl_collection_end{}) ->
    Node = finalize_builder(Builder),
    {finished, Node};
construct_token(#yamerl_constr{detailed_constr = true},
  #unfinished_node{pres = Pres, priv = #map_builder{state = none} = Builder},
  #yamerl_collection_end{}) ->
    Map1 = finalize_builder(Builder),
    Node = #yamerl_map{
      module = ?MODULE,
      tag    = ?TAG,
      pres   = Pres,
      pairs  = Map1
    },
    {finished, Node};

construct_token(_, _, Token) ->
    Error = #yamerl_parsing_error{
      name   = not_a_mapping,
      token  = Token,
      text   = "Invalid mapping",
      line   = ?TOKEN_LINE(Token),
      column = ?TOKEN_COLUMN(Token)
    },
    throw(Error).

construct_node(_,
  #unfinished_node{path = {map, undefined},
    priv = #map_builder{state = '$expecting_key'} = Builder} = Node,
  Key) ->
    Node1 = Node#unfinished_node{
      path = {map, Key},
      priv = Builder#map_builder{state = Key}
    },
    {unfinished, Node1, false};
construct_node(Constr,
  #unfinished_node{path = {map, _},
    priv = #map_builder{state= {'$expecting_value', Key}} = Builder} = Node,
  Value) ->
    Map1 = set_kv(Constr, Key, Value, Builder),
    Node1 = Node#unfinished_node{
      path = {map, undefined},
      priv = Map1
    },
    {unfinished, Node1, false}.

node_pres(Node) ->
    ?NODE_PRES(Node).

node_as_proplist_or_map(#yamerl_constr{ext_options = Options}) ->
    proplists:get_value(map_node_format, Options, proplist).

new_builder(Constr) ->
    Format = node_as_proplist_or_map(Constr),
    Data = case Format of
        proplist -> [];
        map -> maps:new()
    end,
    #map_builder{
        format = Format,
        state = none,
        keys = maps:new(),
        data = Data}.

finalize_builder(#map_builder{data = Map}) when is_list(Map) ->
    lists:reverse(Map);
finalize_builder(#map_builder{data = Map}) ->
    Map.

set_kv(#yamerl_constr{detailed_constr = false, ext_options = Options},
       Key,
       Value,
       #map_builder{format = proplist, data = Map} = Builder) ->
    Map1 = case proplists:get_value(keep_duplicate_keys, Options, false) of
      true ->
         [{Key, Value} | Map];
      false ->
        case lists:keymember(Key, 1, Map) of
            true  -> lists:keyreplace(Key, 1, Map, {Key, Value});
            false -> [{Key, Value} | Map]
        end
    end,
    Builder#map_builder{state = none, data = Map1};
set_kv(#yamerl_constr{detailed_constr = false},
       Key,
       Value,
       #map_builder{format = map, data = Map} = Builder) ->
    Data = maps:put(Key, Value, Map),
    Builder#map_builder{state = none, data = Data};

set_kv(#yamerl_constr{detailed_constr = true, ext_options = Options},
       Key,
       Value,
       #map_builder{format = proplist, keys = Keys, data = Map} = Builder) ->
    RawKey = strip_key(Key),
    {Keys1, Map1} = case proplists:get_value(keep_duplicate_keys, Options, false) of
      true ->
        {Keys, [{Key, Value} | Map]};
      false ->
        case maps:is_key(RawKey, Keys) of
          false ->
              {maps:put(RawKey, Key, Keys),
              [{Key, Value} | Map]};
          true ->
              MapKey = maps:get(RawKey, Keys),
              Fun = fun({K, _V}) when K == MapKey ->
                      {Key, Value};
                  (Else) ->
                      Else
                  end,
              {maps:put(RawKey, Key, Keys),
              lists:map(Fun, Map)}
      end
    end,
    Builder#map_builder{state = none, keys = Keys1, data = Map1};

set_kv(#yamerl_constr{detailed_constr = true, ext_options = Options},
       Key,
       Value,
       #map_builder{format = map, keys = Keys, data = Map} = Builder) ->
    RawKey = strip_key(Key),
    {Keys1, Map1} = case proplists:get_value(keep_duplicate_keys, Options, false) of
      true ->
        {Keys, maps:put(Key, Value, Map)};
      false ->
        case maps:is_key(RawKey, Keys) of
          false ->
              {maps:put(RawKey, Key, Keys),
              maps:put(Key, Value, Map)};
          true ->
              MapKey = maps:get(RawKey, Keys),
              Maps1 = maps:put(Key, Value, maps:remove(MapKey, Map)),
              {maps:put(RawKey, Key, Keys),
              Maps1}
        end
    end,
    Builder#map_builder{state = none, keys = Keys1, data = Map1}.

%% Strip detailed construction info so that duplicate keys aren't added.
%%
%% TODO: Remove deep presentation info in structured nodes.
strip_key(Key) ->
    erlang:delete_element(#yamerl_str.pres, Key).