libs/generic/arrayrange.h

   1 /*
   2 Copyright (C) 2001-2006, William Joseph.
   3 All Rights Reserved.
   4
   5 This file is part of GtkRadiant.
   6
   7 GtkRadiant is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2 of the License, or
  10 (at your option) any later version.
  11
  12 GtkRadiant is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GtkRadiant; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20 */
  21
  22 #if !defined(INCLUDED_GENERIC_ARRAYRANGE_H)
  23 #define INCLUDED_GENERIC_ARRAYRANGE_H
  24
  25 /// \file
  26 /// \brief Macros for automatically converting a compile-time-sized array to a range.
  27
  28 template<typename Element>
  29 struct ArrayRange
  30 {
  31   typedef Element* Iterator;
  32   ArrayRange(Iterator first, Iterator last)
  33     : first(first), last(last)
  34   {
  35   }
  36   Iterator first;
  37   Iterator last;
  38 };
  39
  40 template<typename Element>
  41 inline ArrayRange<Element> makeArrayRange(Element* first, Element* last)
  42 {
  43   return ArrayRange<Element>(first, last);
  44 }
  45
  46 template<typename Element>
  47 struct ArrayConstRange
  48 {
  49   typedef const Element* Iterator;
  50   ArrayConstRange(Iterator first, Iterator last)
  51     : first(first), last(last)
  52   {
  53   }
  54   Iterator first;
  55   Iterator last;
  56 };
  57
  58 template<typename Element>
  59 inline ArrayConstRange<Element> makeArrayRange(const Element* first, const Element* last)
  60 {
  61   return ArrayConstRange<Element>(first, last);
  62 }
  63
  64 #define ARRAY_SIZE(array) (sizeof(array) / sizeof(*array))
  65 #define ARRAY_END(array) (array + ARRAY_SIZE(array))
  66 #define ARRAY_RANGE(array) (makeArrayRange(array, ARRAY_END(array)))
  67
  68
  69 typedef ArrayConstRange<const char*> StringArrayRange;
  70 #define STRING_ARRAY_RANGE(array) (StringArrayRange(array, ARRAY_END(array)))
  71
  72 typedef ArrayRange<const char> StringRange;
  73
  74 #endif