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         Iterator first;
  36         Iterator last;
  37 };
  38
  39 template<typename Element>
  40 inline ArrayRange<Element> makeArrayRange( Element* first, Element* last ){
  41         return ArrayRange<Element>( first, last );
  42 }
  43
  44 template<typename Element>
  45 struct ArrayConstRange
  46 {
  47         typedef const Element* Iterator;
  48         ArrayConstRange( Iterator first, Iterator last )
  49                 : first( first ), last( last ){
  50         }
  51         Iterator first;
  52         Iterator last;
  53 };
  54
  55 template<typename Element>
  56 inline ArrayConstRange<Element> makeArrayRange( const Element* first, const Element* last ){
  57         return ArrayConstRange<Element>( first, last );
  58 }
  59
  60 #define ARRAY_SIZE( array ) ( sizeof( array ) / sizeof( *array ) )
  61 #define ARRAY_END( array ) ( array + ARRAY_SIZE( array ) )
  62 #define ARRAY_RANGE( array ) ( makeArrayRange( array, ARRAY_END( array ) ) )
  63
  64
  65 typedef ArrayConstRange<const char*> StringArrayRange;
  66 #define STRING_ARRAY_RANGE( array ) ( StringArrayRange( array, ARRAY_END( array ) ) )
  67
  68 typedef ArrayRange<const char> StringRange;
  69
  70 #endif