{# Macros for SHACL constraints, see ontospy/core/shacl_helper.py. Used by html-multi
   (a page per entity) and html-single (one page, imported "with context" after setting
   shacl_anchor_links, so that links go to anchors in the page, backlog #37) #}


{# the link to an entity: its page, or its anchor in the single page; a shape's anchor
   is prefixed, since a class can be a shape too (eg in QUDT) #}
{% macro href(entity) -%}
  {%- if shacl_anchor_links is defined and shacl_anchor_links -%}
    #{% if entity.slug.startswith("shape-") %}shape-{% endif %}{{entity.qname}}
  {%- else -%}
    {{entity.slug}}.html
  {%- endif -%}
{%- endmacro %}


{# a Term: linked to its page if the graph defines it, else in italics #}
{% macro term(t, css="rdfclass") -%}
  {%- if t.entity -%}
    <a title="{{t.node}}" href="{{ href(t.entity) }}" class="{{css}}">{{t.qname}}</a>
  {%- else -%}
    <i title="{{t.node}}">{{t.qname}}</i>
  {%- endif -%}
{%- endmacro %}


{# a value of a constraint: a Term, or text #}
{% macro value(v) -%}
  {%- if v.qname is defined -%}{{ term(v) }}{%- else -%}<code>{{v}}</code>{%- endif -%}
{%- endmacro %}


{# a list of (name, [values]), eg the constraints other than cardinality and type #}
{% macro constraint_list(items) -%}
  {%- for name, values in items %}
    <div class="shacl-constraint"><small><b>{{name}}</b></small>
    {% if name in ["sh:or", "sh:xone", "sh:and"] -%}
      {%- set sep = {"sh:or": " | ", "sh:xone": " xor ", "sh:and": " & "}[name] -%}
      ( {% for v in values %}<code>{{v}}</code>{% if not loop.last %}{{sep}}{% endif %}{% endfor %} )
    {%- else -%}
      {% for v in values %}{{ value(v) }}{% if not loop.last %}, {% endif %}{% endfor %}
    {%- endif %}
    </div>
  {%- endfor %}
{%- endmacro %}


{# the PROPERTY cell: the property, linked if defined in the ontology, or the path #}
{% macro path(constraint) -%}
  {%- set prop = constraint.property_obj.onto_property -%}
  {%- if prop -%}
    <a class="propcolor" title="{{prop.uri}}" href="{{ href(prop) }}">{{prop.qname}}</a>
  {%- else -%}
    <code title="{{constraint.property_obj.path}}">{{constraint.property_obj.qname}}</code>
  {%- endif -%}
{%- endmacro %}


{# the DESCRIPTION cell: the shape's sh:name and sh:description, else the property's comment #}
{% macro description(constraint) -%}
  {%- if constraint.sh_name %}<b>{{constraint.sh_name|sort|join(", ")}}</b><br>{% endif -%}
  {%- if constraint.sh_description -%}
    {% for x in constraint.sh_description|sort %}{{x}}{% if not loop.last %}<br>{% endif %}{% endfor %}
  {%- elif constraint.rdfs_comment -%}
    {% for x in constraint.rdfs_comment|sort %}{{x}}{% if not loop.last %}<br>{% endif %}{% endfor %}
  {%- endif -%}
  {%- if constraint.sh_message %}<div><small><b>sh:message</b> {{constraint.sh_message|sort|join("; ")}}</small></div>{% endif -%}
{%- endmacro %}


{# the VALUE TYPE cell: sh:datatype, sh:class, sh:node, sh:nodeKind #}
{% macro value_types(constraint) -%}
  {%- for t in constraint.value_types %}{{ term(t) }}{% if not loop.last %}<br>{% endif %}{% endfor -%}
{%- endmacro %}


{# a table of constraints, with a header row for each class (in a class's list) #}
{% macro constraints_table(constraints, with_property_info=False) -%}
  <div style="overflow-x: auto;">
  <table class="table table-bordered shacl-constraints">
    <tr class="table-classproperties">
      <th>PROPERTY</th>
      {% if with_property_info %}<th>PROPERTY TYPE</th>{% endif %}
      <th>DESCRIPTION</th>
      <th>MIN</th>
      <th>MAX</th>
      <th>VALUE TYPE</th>
      <th>OTHER CONSTRAINTS</th>
      {% if with_property_info %}<th>GLOBAL RANGE</th>{% endif %}
    </tr>
    {% for constraint in constraints %}
      <tr>
        {% if constraint.header %}
          <td colspan="{{ 8 if with_property_info else 6 }}">
            <small class="label label-info label-xs">{{constraint.header}}</small>
          </td>
        {% else %}
          <td>{{ path(constraint) }}</td>
          {% if with_property_info %}
            <td>{% for x in constraint.rdftype_qname|sort %}{{x}}{% if not loop.last %}<br>{% endif %}{% else %}--{% endfor %}</td>
          {% endif %}
          <td>{{ description(constraint) }}</td>
          <td>{{constraint.sh_minCount|sort|join(", ")|default("0", true)}}</td>
          <td>{{constraint.sh_maxCount|sort|join(", ")|default("*", true)}}</td>
          <td>{{ value_types(constraint) }}</td>
          <td>{{ constraint_list(constraint.other_constraints) }}</td>
          {% if with_property_info %}
            <td>
              {%- for t in constraint.rdfs_range|sort(attribute="qname") %}{{ term(t) }}{% if not loop.last %}<br>{% endif %}{% else %}<i>--</i>{% endfor -%}
            </td>
          {% endif %}
        {% endif %}
      </tr>
    {% endfor %}
  </table>
  </div>
{%- endmacro %}