valitydev/yamerl
14
0
Fork 0
mirror of https://github.com/valitydev/yamerl.git synced 2024-11-06 02:45:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
57c050ec7a
yamerl/include/yamerl_nodes.hrl
Jean-Sébastien Pédron e1f286861e
Update copyright everywhere
2016-07-20 09:10:22 +02:00

294 lines
12 KiB
Erlang
Raw Blame History

%-
% Copyright (c) 2012-2014 Yakaz
% Copyright (c) 2016 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.
-ifndef(yamerl_nodes_hrl).
-define(yamerl_nodes_hrl, true).
-include("yamerl_types.hrl").
%% CAUTION:
%% Records defined in this file have default values for all members.
%% Those default values are often bad values but this is needed so that
%% Erlang won't add "undefined" in our back to the allowed values in the
%% type specifications.
%% -------------------------------------------------------------------
%% Nodes specifications.
%% -------------------------------------------------------------------
%% String (Failsafe Schema).
-record(yamerl_str, {
module = undefined :: atom(),
tag = "!" :: tag_uri(),
pres = [] :: list(),
text = "" :: unicode_string()
}).
-type yamerl_str() :: #yamerl_str{}.
-type yamerl_simple_str() :: unicode_string().
%% Null (Core Schema).
-record(yamerl_null, {
module = undefined :: atom(),
tag = "!" :: tag_uri(),
pres = [] :: list()
}).
-type yamerl_null() :: #yamerl_null{}.
-type yamerl_simple_null() :: null.
%% Boolean (Core Schema).
-record(yamerl_bool, {
module = undefined :: atom(),
tag = "!" :: tag_uri(),
pres = [] :: list(),
value = true :: boolean()
}).
-type yamerl_bool() :: #yamerl_bool{}.
-type yamerl_simple_bool() :: boolean().
%% Integer (Core Schema).
-record(yamerl_int, {
module = undefined :: atom(),
tag = "!" :: tag_uri(),
pres = [] :: list(),
value = 0 :: integer()
}).
-type yamerl_int() :: #yamerl_int{}.
-type yamerl_simple_int() :: integer().
%% Float (Core Schema).
-record(yamerl_float, {
module = undefined :: atom(),
tag = "!" :: tag_uri(),
pres = [] :: list(),
value = 0.0 :: float() | '+inf' | '-inf' | 'nan'
}).
-type yamerl_float() :: #yamerl_float{}.
-type yamerl_simple_float() :: float().
%% Erlang atom.
-record(yamerl_erlang_atom, {
module = undefined :: atom(),
tag = "!" :: tag_uri(),
pres = [] :: list(),
name :: atom()
}).
-type yamerl_erlang_atom() :: #yamerl_erlang_atom{}.
-type yamerl_simple_erlang_atom() :: atom().
%% Erlang anonymous function.
-record(yamerl_erlang_fun, {
module = undefined :: atom(),
tag = "!" :: tag_uri(),
pres = [] :: list(),
function :: function(),
text :: unicode_string()
}).
-type yamerl_erlang_fun() :: #yamerl_erlang_fun{}.
-type yamerl_simple_erlang_fun() :: function().
%% Timestamp.
-type year() :: non_neg_integer(). %% Types from stdlib/src/calendar.erl.
-type month() :: 1..12.
-type day() :: 1..31.
-type hour() :: 0..23.
-type minute() :: 0..59.
-type second() :: 0..59.
-record(yamerl_timestamp, {
module = undefined :: atom(),
tag = "!" :: tag_uri(),
pres = [] :: list(),
year :: year() | undefined,
month :: month() | undefined,
day :: day() | undefined,
hour = 0 :: hour(),
minute = 0 :: minute(),
second = 0 :: second(),
frac = 0 :: non_neg_integer(),
tz = 0 :: integer()
}).
-type yamerl_timestamp() :: #yamerl_timestamp{}.
-type yamerl_simple_timestamp() :: calendar:datetime()
| {undefined, calendar:time()}.
%% Sequence (Failsafe Schema).
-record(yamerl_seq, {
module = undefined :: atom(),
tag = "!" :: tag_uri(),
pres = [] :: list(),
entries = [] :: [yamerl_node()],
count = 0 :: non_neg_integer()
}).
-type yamerl_seq() :: #yamerl_seq{}.
-type yamerl_simple_seq() :: [yamerl_simple_node()].
-type yamerl_partial_seq() :: {
atom(),
{seq, non_neg_integer()},
[
yamerl_node()
| yamerl_simple_node()
| '$insert_here'
]
}.
%% Mapping (Failsafe Schema).
-record(yamerl_map, {
module = undefined :: atom(),
tag = "!" :: tag_uri(),
pres = [] :: list(),
pairs = [] :: [{yamerl_node(), yamerl_node()}]
}).
-type yamerl_map() :: #yamerl_map{}.
-type yamerl_simple_map() :: [{
yamerl_simple_node(),
yamerl_simple_node()
}].
-type yamerl_partial_map() :: {
atom(),
{map,
yamerl_node()
| yamerl_simple_node()
| undefined},
[{
yamerl_node()
| yamerl_simple_node()
| '$insert_here',
yamerl_node()
| yamerl_simple_node()
| '$insert_here' | undefined
}]
}.
%% Document.
-record(yamerl_doc, {
root = undefined :: yamerl_node()
| yamerl_simple_node() | undefined
}).
-type yamerl_doc() :: #yamerl_doc{root :: yamerl_node()}.
-type yamerl_simple_doc() :: yamerl_simple_node().
-type yamerl_partial_doc() :: #yamerl_doc{}.
%% -------------------------------------------------------------------
%% Final data type specifications.
%% -------------------------------------------------------------------
-type yamerl_user_node() :: tuple().
-type yamerl_user_simple_node() :: term().
-type yamerl_node() :: yamerl_seq()
| yamerl_map()
| yamerl_str()
| yamerl_null()
| yamerl_bool()
| yamerl_int()
| yamerl_float()
| yamerl_timestamp()
| yamerl_erlang_atom()
| yamerl_erlang_fun()
| yamerl_user_node().
-type yamerl_simple_node() :: yamerl_simple_seq()
| yamerl_simple_map()
| yamerl_simple_str()
| yamerl_simple_null()
| yamerl_simple_bool()
| yamerl_simple_int()
| yamerl_simple_float()
| yamerl_simple_timestamp()
| yamerl_simple_erlang_atom()
| yamerl_simple_erlang_fun()
| yamerl_user_simple_node().
-type yamerl_partial_node() :: yamerl_partial_seq()
| yamerl_partial_map()
| yamerl_str()
| yamerl_null()
| yamerl_bool()
| yamerl_int()
| yamerl_float()
| yamerl_timestamp()
| yamerl_erlang_atom()
| yamerl_erlang_fun()
| yamerl_user_node()
| yamerl_simple_str()
| yamerl_simple_null()
| yamerl_simple_bool()
| yamerl_simple_int()
| yamerl_simple_float()
| yamerl_simple_timestamp()
| yamerl_simple_erlang_atom()
| yamerl_simple_erlang_fun()
| yamerl_user_simple_node().
%% -------------------------------------------------------------------
%% Macros to access common members of the node records.
%% -------------------------------------------------------------------
-define(NODE_MOD(N), element(#yamerl_str.module, N)).
-define(NODE_TAG(N), element(#yamerl_str.tag, N)).
-define(NODE_PRES(N), element(#yamerl_str.pres, N)).
%% -------------------------------------------------------------------
%% List of modules implementing the Core Schema nodes.
%% -------------------------------------------------------------------
-define(FAILSAFE_SCHEMA_MODS, [
yamerl_node_str,
yamerl_node_seq,
yamerl_node_map
]).
-define(JSON_SCHEMA_MODS, [
yamerl_node_null_json,
yamerl_node_bool_json,
yamerl_node_int_json,
yamerl_node_float_json,
yamerl_node_str_json,
yamerl_node_seq,
yamerl_node_map
]).
-define(CORE_SCHEMA_MODS, [
yamerl_node_null,
yamerl_node_bool,
yamerl_node_int,
yamerl_node_float,
yamerl_node_str,
yamerl_node_seq,
yamerl_node_map
]).
-define(YAML11_SCHEMA_MODS, [
yamerl_node_null,
yamerl_node_bool_ext,
yamerl_node_int_ext,
yamerl_node_float_ext,
yamerl_node_str,
yamerl_node_seq,
yamerl_node_map
]).
-endif.
Reference in New Issue View Git Blame Copy Permalink