kstars/kstars/objectnamelist.h

   1 /***************************************************************************
   2                           objectnamelist.h  -  description
   3                              -------------------
   4     begin                : Mon Feb 18 2002
   5     copyright            : (C) 2002 by Thomas Kabelmann
   6     email                : tk78@gmx.de
   7  ***************************************************************************/
   8
   9 /***************************************************************************
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  ***************************************************************************/
  17
  18 #ifndef OBJECTNAMELIST_H
  19 #define OBJECTNAMELIST_H
  20
  21
  22 /**@class ObjectNameList
  23         *This class provides an interface like a QPtrList, but sorts objects internally
  24         *in 27 lists. The objects are sorted alphabetically. List 0 contains all objects
  25         *beginning not with a letter. List 1 - 26 contains objects beginning with a letter.
  26         *The number of the list is similar to positon of letter in alphabet. (A = 1 .. Z = 26 )
  27         *@author Thomas Kabelmann
  28         *@version 1.0
  29         */
  30
  31
  32 #include <qglobal.h>
  33 #include <qptrlist.h>
  34 #include <qstring.h>
  35
  36 class SkyObject;
  37 class SkyObjectName;
  38
  39 /**Reimplemented from QPtrList for sorting objects in the list. */
  40 template <class T> class SortedList : public QPtrList <T> {
  41  protected:
  42   int compareItems(QPtrCollection::Item item1, QPtrCollection::Item item2) {
  43     if ( *((T*)item1) == *((T*)item2) ) return 0;
  44     return ( *((T*)item1) < *((T*)item2) ) ? -1 : 1;
  45   }
  46 };
  47
  48 class ObjectNameList {
  49
  50         public:
  51         /** Constructor */
  52                 ObjectNameList();
  53
  54         /** Destructor */
  55                 ~ObjectNameList();
  56
  57         /**Appends a skyobject to the list.
  58                 *@param object pointer to the SkyObject to be appended to the list.
  59                 *@param useLongName if TRUE, use the longname of the object,
  60                 *rather than the primary name
  61                 */
  62                 void append(SkyObject *object, bool useLongName=false);
  63
  64         /**Select the list which contains objects whose names begin with the
  65                 *same letter as the argument.  The selected list ID is recorded in
  66                 *an internal variable, so it is persistent.
  67                 *@note This function is case insensitive.
  68                 *@note if no string is given, then the first list is selected, and
  69                 *also a flag is set so that all lists will be traversed by the next()
  70                 *function.
  71                 *@return pointer to the first object in the selected list.
  72                 *@param name the name to use in selecting a list.
  73                 */
  74                 SkyObjectName* first(const QString &name = QString::null);
  75
  76         /**Returns next object in the currently selected list.
  77                 *@return pointer to the next object in the current list, or NULL if
  78                 *the end of the list was reached.
  79                 *@note if the "all lists" flag is set, then it will traverse all lists
  80                 *before returning NULL.
  81                 */
  82                 SkyObjectName* next();
  83
  84         /**@return pointer to the object, if it is in one of the lists;
  85                 *otherwise return the NULL pointer.
  86                 *@note This function is case sensitive.
  87                 *@param name name of object to find.
  88                 *@return pointer to object with the given name
  89                 */
  90                 SkyObjectName* find(const QString &name = QString::null);
  91
  92         /**@short remove the named object from the list.
  93                 *@param name the name of the object to be removed.
  94                 *@note If the object is not found, then nothing happens.
  95                 */
  96                 void remove( const QString &name = QString::null );
  97
  98         /**Define the language which should be used for constellation names
  99                 */
 100                 enum Language { local = 0, latin = 1 };
 101
 102         /**Change constellation-name language option.
 103                 *@param lang the language to use (0=local; 1=latin)
 104                 */
 105                 void setLanguage( Language lang );
 106
 107         /**Change constellation-name language option.
 108                 *This function behaves just like the above function;
 109                 *it differs only in the data type of its argument.
 110                 *@param lang the language to use (0=local; 1=latin)
 111                 */
 112                 void setLanguage( bool lang );
 113
 114                 /**@return the total count of the number of named objects.
 115                         */
 116                 uint count() const { return amount; }
 117
 118         private:
 119
 120         /**Sorts the lists with objects for faster access.
 121                 *It's needed for find(). first() and find() call this function.
 122                 */
 123                 void sort();
 124
 125
 126         /**@return the list index which contains the object whose name matches the argument.
 127                 *@note this does not return the position within a list of names; it returns the ID
 128                 *of the list itself.
 129                 *@param name the name of the object whose index is to be found
 130                 */
 131                 int getIndex( const QString &name = QString::null );
 132
 133         /**Two modes are available:
 134                 *allLists = loop through the whole list if next() is called
 135                 *oneList = loop through one list if next is called
 136                 *If oneList is set, just check all objects which start with same letter to save cpu time.
 137                 */
 138                 enum Mode { allLists, oneList } mode;
 139
 140         /**Set mode
 141                 *@see first()
 142                 */
 143                 void setMode( Mode m );
 144
 145         /**Hold 2 pointer lists in memory. Number of lists can easily increased for adding more languages.
 146                 *First index is the language and second index is reserved for alphabetically sorted list.
 147                 * 0 = all objects beginning with a number
 148                 * 1 = A ... 26 = Z
 149                 */
 150                 SortedList <SkyObjectName> list[2][27];
 151
 152                 /**Hold status if list is unsorted or not.*/
 153                 bool unsorted[27];
 154
 155         /**
 156                 *Constellations has latin names and alloc extra SkyObjectNames which will stored in 2 list.
 157                 *But second list will not delete objects while clearing it, because most of objects in this list
 158                 *are in first list too. We just have to delete objects which are not in first list. These objects
 159                 *will stored in this list.
 160                 */
 161                 QPtrList <SkyObjectName> constellations;
 162
 163         /**
 164                 *Which list was accessed last time by first() or next()
 165                 */
 166                 int currentIndex;
 167
 168                 Language language;
 169
 170                 unsigned int amount;
 171 };
 172
 173 #endif