OpenTTD: src/story_base.h Source File

OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

story_base.h
Go to the documentation of this file.
1 /* $Id: story_base.h 25621 2013-07-21 15:21:55Z zuu $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD 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, version 2.
6 * OpenTTD 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.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
9
12 #ifndef STORY_BASE_H
13 #define STORY_BASE_H
14
15 #include "company_type.h"
16 #include "story_type.h"
17 #include "date_type.h"
18 #include "core/pool_type.hpp"
19
20 typedef Pool<StoryPageElement, StoryPageElementID, 64, 64000> StoryPageElementPool;
21 typedef Pool<StoryPage, StoryPageID, 64, 64000> StoryPagePool;
22 extern StoryPageElementPool _story_page_element_pool;
23 extern StoryPagePool _story_page_pool;
24 extern uint32 _story_page_element_next_sort_value;
25 extern uint32 _story_page_next_sort_value;
26
27 /*
28 * Each story page element is one of these types.
29 */
30 enum StoryPageElementType {
31 SPET_TEXT = 0,
32 SPET_LOCATION,
33 SPET_GOAL,
34 SPET_END,
35 INVALID_SPET = 0xFF,
36 };
37
39 template <> struct EnumPropsT<StoryPageElementType> : MakeEnumPropsT<StoryPageElementType, byte, SPET_TEXT, SPET_END, INVALID_SPET, 8> {};
40 typedef TinyEnumT<StoryPageElementType> StoryPageElementTypeByte;
41
47 struct StoryPageElement : StoryPageElementPool::PoolItem<&_story_page_element_pool> {
48 uint32 sort_value;
49 StoryPageID page;
50 StoryPageElementTypeByte type;
51
52 uint32 referenced_id;
53 char *text;
54
58 inline StoryPageElement() { }
59
63 inline ~StoryPageElement() { free(this->text); }
64 };
65
66 #define FOR_ALL_STORY_PAGE_ELEMENTS_FROM(var, start) FOR_ALL_ITEMS_FROM(StoryPageElement, story_page_element_index, var, start)
67 #define FOR_ALL_STORY_PAGE_ELEMENTS(var) FOR_ALL_STORY_PAGE_ELEMENTS_FROM(var, 0)
68
70 struct StoryPage : StoryPagePool::PoolItem<&_story_page_pool> {
71 uint32 sort_value;
72 Date date;
73 CompanyByte company;
74
75 char *title;
76
80 inline StoryPage() { }
81
85 inline ~StoryPage()
86 {
87 if (!this->CleaningPool()) {
88 StoryPageElement *spe;
89 FOR_ALL_STORY_PAGE_ELEMENTS(spe) {
90 if (spe->page == this->index) delete spe;
91 }
92 }
93 free(this->title);
94 }
95 };
96
97 #define FOR_ALL_STORY_PAGES_FROM(var, start) FOR_ALL_ITEMS_FROM(StoryPage, story_page_index, var, start)
98 #define FOR_ALL_STORY_PAGES(var) FOR_ALL_STORY_PAGES_FROM(var, 0)
99
100 #endif /* STORY_BASE_H */
101