define.h 2.34 KB
Newer Older
Dimitri van Heesch's avatar
Dimitri van Heesch committed
1 2
/******************************************************************************
 *
3
 * 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
4
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
5
 * Copyright (C) 1997-2014 by Dimitri van Heesch.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
6 7 8 9 10 11 12
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
13 14
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
Dimitri van Heesch's avatar
Dimitri van Heesch committed
15 16 17 18 19 20 21
 *
 */

#ifndef DEFINE_H
#define DEFINE_H

#include <qdict.h>
Dimitri van Heesch's avatar
Dimitri van Heesch committed
22
#include <qlist.h>
Dimitri van Heesch's avatar
Dimitri van Heesch committed
23 24 25

class FileDef;

Dimitri van Heesch's avatar
Dimitri van Heesch committed
26
/** A class representing a macro definition. */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
27 28 29 30 31 32 33
class Define
{
  public:
    Define();
    Define(const Define &d);
   ~Define();
    bool hasDocumentation();
34 35 36 37 38 39 40
    QCString name;
    QCString definition;
    QCString fileName;
    QCString doc;
    QCString brief;
    QCString args;
    QCString anchor;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
41 42
    FileDef *fileDef;
    int lineNr;
43
    int columnNr;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
44 45 46
    int nargs;
    bool undef;
    bool varArgs;
47 48
    bool isPredefined;
    bool nonRecursive;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
49 50
};

Dimitri van Heesch's avatar
Dimitri van Heesch committed
51
/** A list of Define objects. */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
52 53 54 55 56
class DefineList : public QList<Define>
{
  public:
    DefineList() : QList<Define>() {}
   ~DefineList() {}
57 58
  private:
    int compareValues(const Define *d1,const Define *d2) const
Dimitri van Heesch's avatar
Dimitri van Heesch committed
59
    {
60
      return qstricmp(d1->name,d2->name);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
61 62 63
    }
};

Dimitri van Heesch's avatar
Dimitri van Heesch committed
64
/** A list of Define objects associated with a specific name. */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
65 66 67 68 69 70
class DefineName : public QList<Define>
{
  public:
    DefineName(const char *n) : QList<Define>() { name=n; }
   ~DefineName() {}
    const char *nameString() const { return name; }
71 72 73

  private:
    int compareValues(const Define *d1,const Define *d2) const
Dimitri van Heesch's avatar
Dimitri van Heesch committed
74
    {
75
      return qstricmp(d1->name,d2->name);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
76
    }
77
    QCString name;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
78 79
};

Dimitri van Heesch's avatar
Dimitri van Heesch committed
80
/** A list of DefineName objects. */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
81 82 83 84 85
class DefineNameList : public QList<DefineName>
{
  public:
    DefineNameList() : QList<DefineName>() {}
   ~DefineNameList() {}
86 87
  private:
    int compareValues(const DefineName *n1,const DefineName *n2) const
Dimitri van Heesch's avatar
Dimitri van Heesch committed
88
    {
89
      return qstricmp(n1->nameString(),n2->nameString());
Dimitri van Heesch's avatar
Dimitri van Heesch committed
90 91 92
    }
};

Dimitri van Heesch's avatar
Dimitri van Heesch committed
93
/** An unsorted dictionary of Define objects. */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
94
typedef QDict<Define> DefineDict;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
95 96

/** A sorted dictionary of DefineName object. */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
97 98 99
typedef QDict<DefineName> DefineNameDict;

#endif