<?xml version="1.0"?>
<!--
  Copyright (C) 2014-2023 Ryan Specialty, LLC.

  This file is part of tame-core.

  tame-core is free software: 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.

  This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
-->
<package xmlns="http://www.lovullo.com/rater"
         xmlns:c="http://www.lovullo.com/calc"
         xmlns:t="http://www.lovullo.com/rater/apply-template"
         core="true"
         title="Definition Conventions">


  \ref{_naming-convention_} defines a naming convention for a parameter that
    is enforced at compile-time.
  Conventions may have prefixes, suffixes, or both.
  If violated,
    the compiler will abort in error.

  <template name="_naming-convention_"
            desc="Error about naming convention violation">
    <param name="@name@"   desc="Given name" />
    <param name="@prefix@" desc="Required prefix" />
    <param name="@suffix@" desc="Required suffix" />

    <if name="@prefix@">
      <unless name="@name@" prefix="@prefix@">
        <error>
          naming convention violation:
          `<param-value name="@name@" />' must be prefixed with
          `<param-value name="@prefix@" />'.
        </error>
      </unless>
    </if>

    <if name="@suffix@">
      <unless name="@name@" suffix="@suffix@">
        <error>
          naming convention violation:
          `<param-value name="@name@" />' must be suffixed with
          `<param-value name="@suffix@" />'.
        </error>
      </unless>
    </if>
  </template>
</package>
