1 | /* |
---|
2 | orxonox - the future of 3D-vertical-scrollers |
---|
3 | |
---|
4 | Copyright (C) 2004 orx |
---|
5 | |
---|
6 | This program is free software; you can redistribute it and/or modify |
---|
7 | it under the terms of the GNU General Public License as published by |
---|
8 | the Free Software Foundation; either version 2, or (at your option) |
---|
9 | any later version. |
---|
10 | |
---|
11 | ### File Specific: |
---|
12 | main-programmer: Benjamin Grauer |
---|
13 | co-programmer: ... |
---|
14 | */ |
---|
15 | |
---|
16 | #include "load_param_class_description.h" |
---|
17 | |
---|
18 | #include "multi_type.h" |
---|
19 | #include "debug.h" |
---|
20 | |
---|
21 | /** |
---|
22 | * @brief A list, that holds all the classes that are loadable (classes not objects!!) |
---|
23 | */ |
---|
24 | LoadParamClassDescription::ClassDescriptionMap LoadParamClassDescription::_classList; |
---|
25 | |
---|
26 | /** |
---|
27 | * @brief if the description of Parameters should be executed |
---|
28 | */ |
---|
29 | bool LoadParamClassDescription::_createParametersDescription = false; |
---|
30 | |
---|
31 | /** |
---|
32 | * @param className the name of the class to be loadable |
---|
33 | */ |
---|
34 | LoadParamClassDescription::LoadParamClassDescription(const std::string& className) |
---|
35 | : _className(className) |
---|
36 | { } |
---|
37 | |
---|
38 | /** |
---|
39 | * deletes a classDescription (deletes all the parameterDescriptions as well |
---|
40 | */ |
---|
41 | LoadParamClassDescription::~LoadParamClassDescription() |
---|
42 | {} |
---|
43 | |
---|
44 | void LoadParamClassDescription::deleteAllDescriptions() |
---|
45 | { |
---|
46 | LoadParamClassDescription::_classList.clear(); |
---|
47 | } |
---|
48 | |
---|
49 | |
---|
50 | |
---|
51 | void LoadParamClassDescription::describeClass(const ClassID& classID, |
---|
52 | const std::string& paramName, |
---|
53 | const std::string& descriptionText) |
---|
54 | { |
---|
55 | ParamDescriptionMap::iterator it = LoadParamClassDescription::getParamDescription(classID, paramName); |
---|
56 | |
---|
57 | (*it).second.setDescription(descriptionText); |
---|
58 | } |
---|
59 | |
---|
60 | |
---|
61 | void LoadParamClassDescription::setValuesOf(const ClassID& classID, |
---|
62 | const std::string& paramName, |
---|
63 | unsigned int paramCount, |
---|
64 | const MultiType* const defaultValues, |
---|
65 | bool retVal) |
---|
66 | { |
---|
67 | ParamDescriptionMap::iterator it = LoadParamClassDescription::getParamDescription(classID, paramName); |
---|
68 | (*it).second.setValues(paramCount, defaultValues, retVal); |
---|
69 | } |
---|
70 | |
---|
71 | |
---|
72 | /** |
---|
73 | * @brief finds the Iterator to the ParameterDescription paramName matching classID |
---|
74 | * @param classID the ClassID to match. |
---|
75 | * @param paramName the name of the parameter in the Class. |
---|
76 | * @returns the iterator on match. |
---|
77 | * |
---|
78 | * @note this function creates the Element classID.name()::paramName on the go if it does not exist. |
---|
79 | */ |
---|
80 | LoadParamClassDescription::ParamDescriptionMap::iterator |
---|
81 | LoadParamClassDescription::getParamDescription(const ClassID& classID, const std::string& paramName) |
---|
82 | { |
---|
83 | /// Locate the ClassDescription first |
---|
84 | ClassDescriptionMap::iterator classIt = LoadParamClassDescription::_classList.find(classID); |
---|
85 | if (classIt == LoadParamClassDescription::_classList.end()) |
---|
86 | { |
---|
87 | LoadParamClassDescription::_classList[classID] = LoadParamClassDescription(classID.name()); |
---|
88 | classIt = LoadParamClassDescription::_classList.find(classID); |
---|
89 | } |
---|
90 | // At this position the class-iterator should point to a valid usefull position. |
---|
91 | assert(classIt != LoadParamClassDescription::_classList.end()); |
---|
92 | |
---|
93 | /// Now locate the description with paramName. |
---|
94 | ParamDescriptionMap::iterator paramIt = (*classIt).second._parameters.find(paramName); |
---|
95 | if (paramIt == (*classIt).second._parameters.end()) |
---|
96 | { |
---|
97 | (*classIt).second._parameters[paramName] = LoadParamDescription(paramName); |
---|
98 | paramIt = (*classIt).second._parameters.find(paramName); |
---|
99 | } |
---|
100 | // at this position the param-iterator should |
---|
101 | assert (paramIt != (*classIt).second._parameters.end()); |
---|
102 | |
---|
103 | return (paramIt); |
---|
104 | } |
---|
105 | |
---|
106 | |
---|
107 | |
---|
108 | |
---|
109 | /** |
---|
110 | * @brief prints out all loadable Classes, and their parameters |
---|
111 | * @param fileName prints the output to a File |
---|
112 | * @todo implement it |
---|
113 | */ |
---|
114 | void LoadParamClassDescription::printAll(const std::string& fileName) |
---|
115 | { |
---|
116 | PRINT(0)("===============================================================\n"); |
---|
117 | PRINT(0)(" Listing all the Loadable Options (loaded since Game started).\n\n"); |
---|
118 | for (ClassDescriptionMap::const_iterator classIt = LoadParamClassDescription::_classList.begin(); |
---|
119 | classIt != LoadParamClassDescription::_classList.end(); |
---|
120 | classIt ++) |
---|
121 | { |
---|
122 | PRINT(0)("<%s>\n", (*classIt).second._className.c_str()); |
---|
123 | for (ParamDescriptionMap::const_iterator param = (*classIt).second._parameters.begin(); |
---|
124 | param != (*classIt).second._parameters.end(); |
---|
125 | ++param) |
---|
126 | { |
---|
127 | (*param).second.print(); |
---|
128 | } |
---|
129 | PRINT(0)("</%s>\n\n", (*classIt).second._className.c_str()); |
---|
130 | } |
---|
131 | PRINT(0)("===============================================================\n"); |
---|
132 | } |
---|