{% extends "base.html" %}
{% set current_name = obj.name %}
{% block title %}{{ obj.name }}{% endblock %}

{% macro type_badge(obj_type) %}
  {% if obj_type == 'function_block' %}<span class="badge badge-fb">Function Block</span>
  {% elif obj_type == 'program' %}<span class="badge badge-prg">Program</span>
  {% elif obj_type == 'function' %}<span class="badge badge-fn">Function</span>
  {% elif obj_type == 'interface' %}<span class="badge badge-itf">Interface</span>
  {% elif obj_type == 'gvl' %}<span class="badge badge-gvl">GVL</span>
  {% elif obj_type == 'struct' %}<span class="badge badge-struct">Struct</span>
  {% elif obj_type == 'enum' %}<span class="badge badge-enum">Enum</span>
  {% endif %}
{% endmacro %}

{% macro var_table(vars, title, badge_class="") %}
  {% if vars %}
  <h3>
    {{ title }}
    {% if badge_class %}<span class="badge {{ badge_class }}" style="font-size:0.55rem;vertical-align:middle;">{{ title }}</span>{% endif %}
  </h3>
  <table>
    <thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead>
    <tbody>
      {% for v in vars %}
      <tr>
        <td><code>{{ v.name }}</code></td>
        <td>{{ v.var_type | link_type }}</td>
        <td class="description">{{ v.comment }}</td>
      </tr>
      {% endfor %}
    </tbody>
  </table>
  {% endif %}
{% endmacro %}

{% block content %}
<h1>
  {{ obj.name }}&ensp;{{ type_badge(obj.obj_type) }}
  {% if obj.visibility %}<span class="badge badge-{% if obj.visibility == 'PUBLIC' %}pub{% elif obj.visibility == 'PRIVATE' %}priv{% else %}prot{% endif %}">{{ obj.visibility }}</span>{% endif %}
  {% if obj.is_abstract %}<span class="badge badge-prot">ABSTRACT</span>{% endif %}
  {% if obj.is_final %}<span class="badge badge-prot">FINAL</span>{% endif %}
</h1>

{% if obj.extends or obj.implements %}
<p style="color: var(--text-dim); font-size: 0.85rem; margin-bottom: 0.75rem;">
  {% if obj.extends %}Extends <a href="{{ obj.extends }}.html">{{ obj.extends }}</a>{% endif %}
  {% if obj.extends and obj.implements %}&ensp;&mdash;&ensp;{% endif %}
  {% if obj.implements %}Implements {% for iface in obj.implements %}<a href="{{ iface }}.html">{{ iface }}</a>{% if not loop.last %}, {% endif %}{% endfor %}{% endif %}
</p>
{% endif %}

{% if obj.comment.description %}
  <p class="description">{{ obj.comment.description }}</p>
{% endif %}

{% if obj.comment.remarks %}
  <p class="description"><strong>Remarks:</strong> {{ obj.comment.remarks }}</p>
{% endif %}

<hr>

{# Variable tables #}
{{ var_table(obj.inputs,  'Inputs') }}
{{ var_table(obj.inout,   'In/Out') }}
{{ var_table(obj.outputs, 'Outputs') }}
{{ var_table(obj.variables, 'Variables') }}

{# Methods #}
{% if obj.methods %}
<h2>Methods</h2>
{% for method in obj.methods %}
<div class="item-card">
  <div class="item-card-header">
    {{ method.name }}
    {% if method.visibility %}<span class="badge badge-{% if method.visibility == 'PUBLIC' %}pub{% elif method.visibility == 'PRIVATE' %}priv{% else %}prot{% endif %}">{{ method.visibility }}</span>{% endif %}
    {% if method.is_abstract %}<span class="badge badge-prot">ABSTRACT</span>{% endif %}
    {% if method.is_final %}<span class="badge badge-prot">FINAL</span>{% endif %}
    {% if method.return_type %}
      <span class="item-return-type">: {{ method.return_type | link_type }}</span>
    {% endif %}
  </div>
  <div class="item-card-body">
    {% if method.comment.description %}
      <p class="description">{{ method.comment.description }}</p>
    {% endif %}

    {{ var_table(method.inputs,  'Parameters') }}
    {{ var_table(method.inout,   'In/Out') }}
    {{ var_table(method.outputs, 'Outputs') }}

    {% if method.comment.returns %}
      <p><strong>Returns:</strong> {{ method.comment.returns }}</p>
    {% endif %}

    {% if method.body %}
      <h3>Implementation</h3>
      <pre><code>{{ method.body }}</code></pre>
    {% endif %}
  </div>
</div>
{% endfor %}
{% endif %}

{# Properties #}
{% if obj.properties %}
<h2>Properties</h2>
{% for prop in obj.properties %}
<div class="item-card">
  <div class="item-card-header">
    {{ prop.name }}
    {% if prop.visibility %}<span class="badge badge-{% if prop.visibility == 'PUBLIC' %}pub{% elif prop.visibility == 'PRIVATE' %}priv{% else %}prot{% endif %}">{{ prop.visibility }}</span>{% endif %}
    {% if prop.has_get %}<span class="badge badge-get">GET</span>{% endif %}
    {% if prop.has_set %}<span class="badge badge-set">SET</span>{% endif %}
    {% if prop.return_type %}
      <span class="item-return-type">: {{ prop.return_type | link_type }}</span>
    {% endif %}
  </div>
  {% if prop.comment.description %}
  <div class="item-card-body">
    <p class="description">{{ prop.comment.description }}</p>
  </div>
  {% endif %}
</div>
{% endfor %}
{% endif %}

{# Actions #}
{% if obj.actions %}
<h2>Actions</h2>
<ul>
  {% for action in obj.actions %}
  <li>{{ action }}</li>
  {% endfor %}
</ul>
{% endif %}

{# Used by #}
{% if obj.used_by %}
<h2>Used by</h2>
<ul>
  {% for name in obj.used_by | sort %}
  <li><a href="{{ name }}.html">{{ name }}</a></li>
  {% endfor %}
</ul>
{% endif %}

{# Declaration source #}
<h2>Declaration</h2>
<pre><code>{{ obj.declaration }}</code></pre>

{% endblock %}