------------------------------------------------------------------------------
------------------------------------------------------------------------------
-- Cheddar is a GNU GPL real-time scheduling analysis tool.
-- This program provides services to automatically check schedulability and
-- other performance criteria of real-time architecture models.
--
-- Copyright (C) 2002-2020, Frank Singhoff, Alain Plantec, Jerome Legrand,
--                          Hai Nam Tran, Stephane Rubini
--
-- The Cheddar project was started in 2002 by
-- Frank Singhoff, Lab-STICC UMR 6285, Université de Bretagne Occidentale
--
-- Cheddar has been published in the "Agence de Protection des Programmes/France" in 2008.
-- Since 2008, Ellidiss technologies also contributes to the development of
-- Cheddar and provides industrial support.
--
-- The full list of contributors and sponsors can be found in AUTHORS.txt and SPONSORS.txt
--
-- This program 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 2 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, write to the Free Software
-- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
--
--
-- Contact : cheddar@listes.univ-brest.fr
--
------------------------------------------------------------------------------
-- Last update :
--    $Rev$
--    $Date$
--    $Author: singhoff $
------------------------------------------------------------------------------
------------------------------------------------------------------------------

with Ada.Strings.Unbounded; use Ada.Strings.Unbounded;
with unbounded_strings;     use unbounded_strings;
with framework_config;      use framework_config;
with caches;                use caches;
with sets;

package cache_block_set is

   ------------------------------------------------------
   -- CACHE BLOCKS
   ------------------------------------------------------
   package cache_block_set is new sets
     (max_element    => framework_config.max_cache_size,
      element        => cache_block_ptr,
      free           => free,
      copy           => copy,
      put            => put,
      xml_string     => xml_string,
      xml_ref_string => xml_ref_string);

   use cache_block_set;

   type cache_blocks_set is new cache_block_set.set with private;

   subtype cache_blocks_range is cache_block_set.element_range;
   subtype cache_blocks_iterator is cache_block_set.iterator;

   --
   -- Exception
   --
   cache_block_not_found : exception;

   cache_block_must_be_defined : exception;

   invalid_parameter : exception;
   --
   -- Add
   --
   procedure add_cache_block
     (my_cache_blocks    : in out cache_blocks_set;
      a_cache_block      : in out cache_block_ptr;
      name               : in     Unbounded_String;
      cache_block_number : in     Natural);

   procedure add_cache_block
     (my_cache_blocks    : in out cache_blocks_set;
      name               : in     Unbounded_String;
      cache_block_number : in     Natural);

   --
   -- Update
   --
   procedure update_cache_block
     (my_cache_blocks    : in out cache_blocks_set;
      name               : in     Unbounded_String;
      cache_block_number : in     Natural);

   --
   -- Search
   --
   function search_cache_block
     (my_cache_blocks : in cache_blocks_set;
      name            : in Unbounded_String) return cache_block_ptr;

   function search_cache_block_by_id
     (my_cache_blocks : in cache_blocks_set;
      id              : in Unbounded_String) return cache_block_ptr;

   --
   -- Delete
   --
   procedure delete_cache_block
     (my_cache_blocks : in out cache_blocks_set;
      name            : in     Unbounded_String);

private
   type cache_blocks_set is new cache_block_set.set with null record;

end cache_block_set;