Merge branch 'q3map2help' into 'master'
[xonotic/netradiant.git] / include / mapfile.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_MAPFILE_H )
23 #define INCLUDED_MAPFILE_H
24
25 #include <limits>
26
27 #include "iscenegraph.h"
28 #include "generic/callback.h"
29
30 const std::size_t MAPFILE_MAX_CHANGES = std::numeric_limits<std::size_t>::max();
31
32 class MapFile
33 {
34 public:
35 STRING_CONSTANT( Name, "MapFile" );
36
37 virtual void save() = 0;
38 virtual bool saved() const = 0;
39 virtual void changed() = 0;
40 virtual void setChangedCallback( const Callback<void()>& changed ) = 0;
41 virtual std::size_t changes() const = 0;
42 };
43
44 #include "scenelib.h"
45
46 inline MapFile* Node_getMapFile( scene::Node& node ){
47         return NodeTypeCast<MapFile>::cast( node );
48 }
49
50 template<typename Iterator>
51 inline MapFile* path_find_mapfile( Iterator first, Iterator last ){
52         Iterator i = last;
53         for (;; )
54         {
55                 --i;
56
57                 MapFile* map = Node_getMapFile( *i );
58                 if ( map != 0 ) {
59                         return map;
60                 }
61
62                 if ( i == first ) {
63                         break;
64                 }
65         }
66         ERROR_MESSAGE( "failed to find parent mapfile for path" );
67         return 0;
68 }
69
70
71
72 #endif