Types.cc 10.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper is free software: you can redistribute it and/or modify      *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper 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.  See the            *
 *  GNU Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision$                                                         *
 *   $Author$                                                      *
 *   $Date$                   *
 *                                                                           *
\*===========================================================================*/
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59




//=============================================================================
//
//  Types
//
//=============================================================================

/**
 * \file Types.cc
 * This File contains the basic functions to handle datatypes
 */


//== INCLUDES =================================================================

60
#include "TypesInternal.hh"
61
#include "DataTypes.hh"
62
#include <map>
63
#include <QCoreApplication>
64
#include <OpenFlipper/common/GlobalOptions.hh>
65 66 67 68 69


/** This field defines the start id for custom datatypes. It starts high to avoid conflicts with previously
 * hardcoded versions.
 */
70
static int nextTypeId_ = 2;
71 72 73

/** This map maps an dataType id to an typeName
 */
74
static std::map< unsigned int, QString > typeToString;
75

76
/** This map maps an dataType name to its id in the types vector
77
 */
78 79 80 81 82
static std::map< QString , unsigned int > stringToTypeInfo;

/** This map maps an dataType id to its id in the types vector
 */
static std::map< unsigned int , unsigned int > typeToTypeInfo;
83 84 85 86 87

class TypeInfo {

  public:

88
  TypeInfo(DataType _type, QString _name, QString _iconName, QString _readableName ) :
89 90
    type(_type),
    name(_name),
91 92 93 94 95 96 97
    iconName(_iconName),
    readableName(_readableName)
  {
    // Use internal name if no external name is given
    if ( _readableName == "" )
      readableName = _name;
  }
98 99 100 101 102 103 104 105 106

  /// The id of the datatype
  DataType type;

  /// The name of the datatype
  QString  name;

  /// The icon of the datatype
  QString  iconName;
107 108
  
  QIcon    icon;
109

110
  /// Human readable name
111
  QString readableName;
112 113
};

114 115
static QIcon dummyIcon;

116 117 118 119
static std::vector< TypeInfo > types;

//== Functions =========================================================

120 121 122 123 124 125 126
void initializeTypes() {
  stringToTypeInfo["Unknown"] = types.size();
  typeToTypeInfo[DATA_UNKNOWN]   = types.size();
  types.push_back( TypeInfo(DATA_UNKNOWN            ,"Unknown"        ,"Unknown.png", QCoreApplication::translate("Types","Unknown")) );

  stringToTypeInfo["Group"]  = types.size();
  typeToTypeInfo[DATA_GROUP] = types.size();
Jan Möbius's avatar
Jan Möbius committed
127
  types.push_back( TypeInfo(DATA_GROUP           ,"Group"          ,"group.png", QCoreApplication::translate("Types","Group")) );
128 129 130 131 132 133 134 135 136 137

  stringToTypeInfo["All"]  = types.size();
  typeToTypeInfo[DATA_ALL] = types.size();
  types.push_back( TypeInfo(DATA_ALL             ,"All"            ,"Unknown.png", QCoreApplication::translate("Types","All")) );

  typeToString[DATA_UNKNOWN] = "Unknown";
  typeToString[DATA_GROUP] = "Group";
  typeToString[DATA_ALL] = "All";
  
  // Preload the static icons
Jan Möbius's avatar
Jan Möbius committed
138
  setTypeIcon(DATA_GROUP,"group.png");
139 140
}

141
/// Adds a datatype and returns the id for the new type
142
DataType addDataType(QString _name, QString _readableName) {
143
  
144 145 146 147
  int type = nextTypeId_;

  stringToTypeInfo[ _name ] = types.size();
  typeToTypeInfo[ type ] = types.size();
148
  types.push_back( TypeInfo(type, _name, "Unknown.png", _readableName ));
149 150 151

  typeToString[type] = _name;

152
  nextTypeId_ *= 2;
153
  return( type );
154 155
}

156
/// Get the id of a type with given name
157
DataType typeId(QString _name) {
158 159 160 161 162

  std::map<QString, unsigned int>::iterator index = stringToTypeInfo.find( _name );

  if ( index != stringToTypeInfo.end() )
    return types[ index->second ].type;
163
  else {
Jan Möbius's avatar
Jan Möbius committed
164 165 166
    #ifdef DEBUG
      std::cerr << "Unknown Data type with name " << _name.toStdString() << std::endl;
    #endif
167
    return DATA_UNKNOWN;
168
  }
169 170 171 172 173 174 175 176 177
}

/// Get the name of a type with given id
QString typeName(DataType _id) {

  std::map<unsigned int, QString>::iterator name = typeToString.find(_id);

  if ( name != typeToString.end() )
    return name->second;
178
  else {
179
    #ifdef DEBUG
180
    std::cerr << "Unable to retrieve typeName for id " << _id << std::endl;
181
    #endif
182
    return "Unknown";
183
  }
184 185
}

186

187 188 189 190 191
/// Return the number of registered types
uint typeCount() {
  return types.size();
}

192
/// Get the icon of a given dataType
193
QString typeIconName(QString  _name) {
194 195 196 197 198 199 200

  std::map<QString, unsigned int>::iterator index = stringToTypeInfo.find( _name );

  if ( index != stringToTypeInfo.end() )
    return types[ index->second ].iconName;
  else
    return "Unknown.png";
201 202
}

203
/// get the icon of a given dataType
204
QString typeIconName(DataType _id) {
205 206 207 208 209 210 211

  std::map<unsigned int, unsigned int>::iterator index = typeToTypeInfo.find(_id);

  if ( index != typeToTypeInfo.end() )
    return types[ index->second ].iconName;
  else
    return "Unknown.png";
212 213
}

214 215 216 217 218 219 220 221 222 223 224
/// get the icon of a given dataType
QIcon& typeIcon(DataType _id) {
  
  std::map<unsigned int, unsigned int>::iterator index = typeToTypeInfo.find(_id);
  
  if ( index != typeToTypeInfo.end() )
    return types[ index->second ].icon;
  else
    return dummyIcon;
}

225
/// Set the icon for a given dataType
226 227
void setTypeIcon( DataType _id   , QString _icon ) {

228 229
  std::map<unsigned int, unsigned int>::iterator index = typeToTypeInfo.find(_id);

230
  if ( index != typeToTypeInfo.end() ) {
231
    types[ index->second ].iconName = _icon;
232 233
    types[ index->second ].icon = QIcon( OpenFlipper::Options::iconDirStr() + QDir::separator() + _icon );
  } else
234
    std::cerr << "Could not set icon for DataType. Type not found!" << std::endl;
235 236
}

237
/// Set the icon for a given dataType
238 239
void setTypeIcon( QString  _name , QString _icon ) {

240 241
  std::map<QString, unsigned int>::iterator index = stringToTypeInfo.find( _name );

242
  if ( index != stringToTypeInfo.end() ) {
243
    types[ index->second ].iconName = _icon;
244 245
    types[ index->second ].icon = QIcon( OpenFlipper::Options::iconDirStr() + QDir::separator() + _icon );
  } else
246
    std::cerr << "Could not set icon for DataType. Type not found!" << std::endl;
247 248
}

249 250 251 252 253 254 255 256 257 258 259



/// Get DataType Human readable name ( this name might change. Use the typeName insted! )
QString dataTypeName( DataType _id ) {

  std::map<unsigned int, unsigned int>::iterator index = typeToTypeInfo.find(_id);

  if ( index != typeToTypeInfo.end() )
    return types[ index->second ].readableName ;
  else
260 261
    std::cerr << "Could not get human name for DataType. Type not found!" << std::endl;

262 263 264 265 266 267 268 269 270 271 272
  return QString(QCoreApplication::translate("Types","Unknown Type"));
}

/// Get DataType Human readable name ( this name might change. Use the typeName insted! )
QString dataTypeName( QString  _typeName ) {

  std::map<QString, unsigned int>::iterator index = stringToTypeInfo.find( _typeName );

  if ( index != stringToTypeInfo.end() )
    return types[ index->second ].readableName ;
  else
273 274
    std::cerr << "Could not get human name for DataType. Type not found!" << std::endl;

275 276 277 278 279 280 281 282 283 284 285 286 287
  return QString(QCoreApplication::translate("Types","Unknown Type"));
}



/// Set the icon for a given dataType
void setDataTypeName( DataType _id   , QString _name ) {

  std::map<unsigned int, unsigned int>::iterator index = typeToTypeInfo.find(_id);

  if ( index != typeToTypeInfo.end() )
    types[ index->second ].readableName = _name;
  else
288
    std::cerr << "Could not set human name for DataType. Type not found!" << std::endl;
289 290 291 292 293 294 295 296 297 298
}

/// Set the icon for a given dataType
void setDataTypeName( QString  _typeName , QString _name ) {

  std::map<QString, unsigned int>::iterator index = stringToTypeInfo.find( _typeName );

  if ( index != stringToTypeInfo.end() )
    types[ index->second ].readableName = _name;
  else
299
    std::cerr << "Could not set human name for DataType. Type not found!" << std::endl;
300 301
}

302 303
//=============================================================================
//=============================================================================