------------------------------------------------------------------------------
--                                                                          --
--                          GNATCHECK COMPONENTS                            --
--                                                                          --
--              G N A T C H E C K . R U L E S . M E T R I C S               --
--                                                                          --
--                                 S p e c                                  --
--                                                                          --
--                     Copyright (C) 2008-2009, AdaCore                     --
--                                                                          --
-- GNATCHECK  is  free  software;  you can redistribute it and/or modify it --
-- under terms of the  GNU  General Public License as published by the Free --
-- Software Foundation;  either version 2, or ( at your option)  any  later --
-- version.  GNATCHECK  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 distributed with GNAT; see file  COPYING. If --
-- not,  write to the  Free Software Foundation,  51 Franklin Street, Fifth --
-- Floor, Boston, MA 02110-1301, USA.                                       --
--                                                                          --
-- GNATCHECK is maintained by AdaCore (http://www.adacore.com).             --
--                                                                          --
------------------------------------------------------------------------------

--  This package defines the gnatcheck rules based on metrics.

package Gnatcheck.Rules.Metrics is

   --  All the rules in this package have a positive numeric (integer or real,
   --  depending on a rule) parameter for +R option that specifies the upper
   --  or lower (also depending on a rule) limit for a given metric. -R option
   --  for metric rule does not have a parameter.

   -----------------------------------
   -- Metrics_Cyclomatic_Complexity --
   -----------------------------------

   type Metrics_Cyclomatic_Complexity_Rule_Type is new
     One_Integer_Parameter_Rule_Template with null record;

   procedure Rule_Check_Pre_Op
     (Rule    : in out Metrics_Cyclomatic_Complexity_Rule_Type;
      Element :        Asis.Element;
      Control : in out Traverse_Control;
      State   : in out Rule_Traversal_State);
   --  If cyclomatic complexity metric is applcable to the argument Element,
   --  checks if the metric value is not greater then is specified for this
   --  metric check. Flags a constract if this check fails.

   procedure Init_Rule (Rule : in out Metrics_Cyclomatic_Complexity_Rule_Type);

   Metrics_Cyclomatic_Complexity_Rule :
     aliased Metrics_Cyclomatic_Complexity_Rule_Type;

   ----------------------------------
   -- Metrics_Essential_Complexity --
   ----------------------------------

   type Metrics_Essential_Complexity_Rule_Type is new
     One_Integer_Parameter_Rule_Template with null record;

   procedure Rule_Check_Pre_Op
     (Rule    : in out Metrics_Essential_Complexity_Rule_Type;
      Element :        Asis.Element;
      Control : in out Traverse_Control;
      State   : in out Rule_Traversal_State);
   --  If essential complexity metric is applcable to the argument Element,
   --  checks if the metric value is not greater then is specified. Flags a
   --  constract if this check fails.

   procedure Init_Rule (Rule : in out Metrics_Essential_Complexity_Rule_Type);

   Metrics_Essential_Complexity_Rule :
     aliased Metrics_Essential_Complexity_Rule_Type;

   -------------------
   -- Metrics_LSLOC --
   -------------------

   type Metrics_LSLOC_Rule_Type is new One_Integer_Parameter_Rule_Template
     with null record;

   procedure Rule_Check_Pre_Op
     (Rule    : in out Metrics_LSLOC_Rule_Type;
      Element :        Asis.Element;
      Control : in out Traverse_Control;
      State   : in out Rule_Traversal_State);
   --  If LSLOC metric is applcable to the argument Element, checks if the
   --  metric value is not greater then is specified. Flags a constract if this
   --  check fails.

   procedure Init_Rule (Rule : in out Metrics_LSLOC_Rule_Type);

   Metrics_LSLOC_Rule : aliased Metrics_LSLOC_Rule_Type;

end Gnatcheck.Rules.Metrics;
