classdef.cpp 104 KB
Newer Older
mueller's avatar
mueller committed
1 2
/******************************************************************************
 *
dimitri's avatar
dimitri committed
3
 * 
mueller's avatar
mueller committed
4
 *
dimitri's avatar
dimitri committed
5
 * Copyright (C) 1997-2010 by Dimitri van Heesch.
mueller's avatar
mueller 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's avatar
dimitri 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.
mueller's avatar
mueller committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 *
 */

#include <stdio.h>
#include <qfile.h>
#include <qregexp.h>
#include "classdef.h"
#include "classlist.h"
#include "entry.h"
#include "doxygen.h"
#include "membername.h"
#include "message.h"
#include "config.h"
#include "util.h"
#include "diagram.h"
#include "language.h"
mueller's avatar
mueller committed
31
#include "htmlhelp.h"
mueller's avatar
mueller committed
32 33
#include "example.h"
#include "outputlist.h"
dimitri's avatar
dimitri committed
34
#include "dot.h"
dimitri's avatar
dimitri committed
35 36
#include "defargs.h"
#include "debug.h"
dimitri's avatar
dimitri committed
37
#include "docparser.h"
dimitri's avatar
dimitri committed
38
#include "searchindex.h"
dimitri's avatar
dimitri committed
39
#include "vhdldocgen.h"
dimitri's avatar
dimitri committed
40 41 42
#include "layout.h"

//-----------------------------------------------------------------------------
mueller's avatar
mueller committed
43

dimitri's avatar
dimitri committed
44 45 46 47 48 49
//static inline MemberList *createNewMemberList(MemberList::ListType lt)
//{
//  MemberList *result = new MemberList(lt);
//  return result;
//}

dimitri's avatar
dimitri committed
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
class ClassDefImpl
{
  public:
    ClassDefImpl();
   ~ClassDefImpl();
    void init(const char *defFileName, const char *name,
              const QCString &ctStr, const char *fName);

    /*! file name that forms the base for the output file containing the
     *  class documentation. For compatibility with Qt (e.g. links via tag 
     *  files) this name cannot be derived from the class name directly.
     */
    QCString fileName;                   

    /*! Include information about the header file should be included
     *  in the documentation. 0 by default, set by setIncludeFile().
     */
    IncludeInfo *incInfo;                

    /*! List of base class (or super-classes) from which this class derives
     *  directly. 
     */
    BaseClassList *inherits;

    /*! List of sub-classes that directly derive from this class 
     */
    BaseClassList *inheritedBy;

    /*! Namespace this class is part of 
     *  (this is the inner most namespace in case of nested namespaces)
     */
    NamespaceDef  *nspace;              

    /*! File this class is defined in */
    FileDef *fileDef;

    /*! List of all members (including inherited members) */
    MemberNameInfoSDict *allMemberNameInfoSDict;

    /*! Template arguments of this class */
    ArgumentList *tempArgs;

dimitri's avatar
dimitri committed
92 93 94
    /*! Type constraints for template parameters */
    ArgumentList *typeConstraints;

dimitri's avatar
dimitri committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
    /*! Files that were used for generating the class documentation. */
    QStrList files;

    /*! Examples that use this class */
    ExampleSDict *exampleSDict;

    /*! Holds the kind of "class" this is. */
    ClassDef::CompoundType compType;

    /*! The protection level in which this class was found. 
     *  Typically Public, but for nested classes this can also be Protected
     *  or Private.
     */ 
    Protection prot;

    /*! The inner classes contained in this class. Will be 0 if there are
     *  no inner classes.
     */
    ClassSDict *innerClasses;

    /* classes for the collaboration diagram */
    UsesClassDict *usesImplClassDict;
    UsesClassDict *usedByImplClassDict;
    UsesClassDict *usesIntfClassDict;

    /*! Template instances that exists of this class, the key in the
     *  dictionary is the template argument list.
     */ 
    QDict<ClassDef> *templateInstances;

    /*! Template instances that exists of this class, as defined by variables.
     *  We do NOT want to document these individually. The key in the
     *  dictionary is the template argument list.
     */ 
    QDict<ClassDef> *variableInstances;

    QDict<int> *templBaseClassNames;

    /*! The class this class is an instance of. */
    ClassDef *templateMaster;

dimitri's avatar
dimitri committed
136
    /*! local class name which could be a typedef'ed alias name. */
dimitri's avatar
dimitri committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
    QCString className;

    /*! If this class is a Objective-C category, then this points to the
     *  class which is extended.
     */
    ClassDef *categoryOf;

    QList<MemberList> memberLists;

    /* user defined member groups */
    MemberGroupSDict *memberGroupSDict;

    /*! Is this an abstact class? */
    bool isAbstract;

    /*! Is the class part of an unnamed namespace? */
    bool isStatic;

dimitri's avatar
dimitri committed
155 156
    /*! Language used for this class */
    SrcLangExt lang;
dimitri's avatar
dimitri committed
157 158 159 160 161 162 163 164 165 166 167 168 169 170

    /*! TRUE if classes members are merged with those of the base classes. */
    bool membersMerged;

    /*! TRUE if the class is defined in a source file rather than a header file. */
    bool isLocal;

    bool isTemplArg;

    /*! Does this class group its user-grouped members
     *  as a sub-section of the normal (public/protected/..) 
     *  groups?
     */
    bool subGrouping; 
dimitri's avatar
dimitri committed
171

dimitri's avatar
dimitri committed
172
    /** Reason of existance is a "use" relation */
dimitri's avatar
dimitri committed
173
    bool usedOnly;
dimitri's avatar
dimitri committed
174 175 176

    /** List of titles to use for the summary */
    SDict<QCString> vhdlSummaryTitles;
dimitri's avatar
dimitri committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
};

void ClassDefImpl::init(const char *defFileName, const char *name,
                        const QCString &ctStr, const char *fName)
{
  if (fName)
  {
    fileName=stripExtension(fName);
  }
  else
  {
    fileName=ctStr+name;
  }
  exampleSDict = 0;
  inherits    = 0;
  inheritedBy = 0;
  allMemberNameInfoSDict = 0;
  incInfo=0;
  tempArgs=0;
dimitri's avatar
dimitri committed
196
  typeConstraints=0;
dimitri's avatar
dimitri committed
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
  prot=Public;
  nspace=0;
  fileDef=0;
  usesImplClassDict=0;
  usedByImplClassDict=0;
  usesIntfClassDict=0;
  memberGroupSDict = 0;
  innerClasses = 0;
  subGrouping=Config_getBool("SUBGROUPING");
  templateInstances = 0;
  variableInstances = 0;
  templateMaster =0;
  templBaseClassNames = 0;
  isAbstract = FALSE;
  isStatic = FALSE;
  isTemplArg = FALSE;
  membersMerged = FALSE;
  categoryOf = 0;
dimitri's avatar
dimitri committed
215
  usedOnly = FALSE;
dimitri's avatar
dimitri committed
216 217
  //QCString ns;
  //extractNamespaceName(name,className,ns);
dimitri's avatar
dimitri committed
218 219
  //printf("m_name=%s m_className=%s ns=%s\n",m_name.data(),m_className.data(),ns.data());

dimitri's avatar
dimitri committed
220
  if (getLanguageFromFileName(defFileName)!=SrcLangExt_Java && 
dimitri's avatar
dimitri committed
221 222 223 224 225 226 227 228 229 230
      guessSection(defFileName)==Entry::SOURCE_SEC)
  {
    isLocal=TRUE;
  }
  else
  {
    isLocal=FALSE;
  }
}

dimitri's avatar
dimitri committed
231
ClassDefImpl::ClassDefImpl() : vhdlSummaryTitles(17)
dimitri's avatar
dimitri committed
232
{
dimitri's avatar
dimitri committed
233
  vhdlSummaryTitles.setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
}

ClassDefImpl::~ClassDefImpl()
{
  delete inherits;
  delete inheritedBy;
  delete allMemberNameInfoSDict;
  delete exampleSDict;
  delete usesImplClassDict;
  delete usedByImplClassDict;
  delete usesIntfClassDict;
  delete incInfo;
  delete memberGroupSDict;
  delete innerClasses;
  delete templateInstances;
  delete variableInstances;
  delete templBaseClassNames;
  delete tempArgs;
dimitri's avatar
dimitri committed
252
  delete typeConstraints;
dimitri's avatar
dimitri committed
253
}
mueller's avatar
mueller committed
254 255

// constructs a new class definition
dimitri's avatar
dimitri committed
256 257 258
ClassDef::ClassDef(
    const char *defFileName,int defLine,
    const char *nm,CompoundType ct,
dimitri's avatar
dimitri committed
259 260 261
    const char *lref,const char *fName,
    bool isSymbol) 
 : Definition(defFileName,defLine,removeRedundantWhiteSpace(nm),0,0,isSymbol) 
mueller's avatar
mueller committed
262
{
dimitri's avatar
dimitri committed
263 264 265 266
  visited=FALSE;
  setReference(lref);
  m_impl = new ClassDefImpl;
  m_impl->compType = ct;
dimitri's avatar
dimitri committed
267
  m_impl->lang     = SrcLangExt_Unknown;
dimitri's avatar
dimitri committed
268 269
  m_impl->init(defFileName,name(),compoundTypeString(),fName);

mueller's avatar
mueller committed
270 271 272 273 274
}

// destroy the class definition
ClassDef::~ClassDef()
{
dimitri's avatar
dimitri committed
275
  delete m_impl;
mueller's avatar
mueller committed
276 277
}

dimitri's avatar
dimitri committed
278 279 280 281 282
QCString ClassDef::getMemberListFileName() const
{
  return convertNameToFile(compoundTypeString()+name()+"-members");
}

dimitri's avatar
dimitri committed
283 284
QCString ClassDef::displayName() const
{
dimitri's avatar
dimitri committed
285
  static bool optimizeOutputForJava = Config_getBool("OPTIMIZE_OUTPUT_JAVA");
dimitri's avatar
dimitri committed
286
  static bool vhdlOpt = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
dimitri's avatar
dimitri committed
287
  QCString n;
dimitri's avatar
dimitri committed
288 289 290 291
  if (vhdlOpt)
  {
    n = VhdlDocGen::getClassName(this);
  }
dimitri's avatar
dimitri committed
292
  else 
dimitri's avatar
dimitri committed
293
  {
dimitri's avatar
dimitri committed
294
    n=qualifiedNameWithTemplateParameters();
dimitri's avatar
dimitri committed
295
  }
dimitri's avatar
dimitri committed
296
  if (optimizeOutputForJava)
dimitri's avatar
dimitri committed
297 298 299
  {
    n=substitute(n,"::",".");
  }
dimitri's avatar
dimitri committed
300
  if (m_impl->compType==ClassDef::Protocol && n.right(2)=="-p")
dimitri's avatar
dimitri committed
301
  {
dimitri's avatar
dimitri committed
302
    n="<"+n.left(n.length()-2)+">";
dimitri's avatar
dimitri committed
303
  }
dimitri's avatar
dimitri committed
304
  //printf("ClassDef::displayName()=%s\n",n.data());
dimitri's avatar
dimitri committed
305
  return n;
dimitri's avatar
dimitri committed
306 307
}

mueller's avatar
mueller committed
308
// inserts a base class in the inheritance list
dimitri's avatar
dimitri committed
309
void ClassDef::insertBaseClass(ClassDef *cd,const char *n,Protection p,
mueller's avatar
mueller committed
310 311
                               Specifier s,const char *t)
{
dimitri's avatar
dimitri committed
312
  //printf("*** insert base class %s into %s\n",cd->name().data(),name().data());
dimitri's avatar
dimitri committed
313
  //inherits->inSort(new BaseClassDef(cd,p,s,t));
dimitri's avatar
dimitri committed
314
  if (m_impl->inherits==0)
dimitri's avatar
dimitri committed
315
  {
dimitri's avatar
dimitri committed
316 317
    m_impl->inherits = new BaseClassList;
    m_impl->inherits->setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
318
  }
dimitri's avatar
dimitri committed
319
  m_impl->inherits->append(new BaseClassDef(cd,n,p,s,t));
mueller's avatar
mueller committed
320 321
}

dimitri's avatar
dimitri committed
322 323
// inserts a sub class in the inherited list
void ClassDef::insertSubClass(ClassDef *cd,Protection p,
mueller's avatar
mueller committed
324 325
                                Specifier s,const char *t)
{
dimitri's avatar
dimitri committed
326
  //printf("*** insert sub class %s into %s\n",cd->name().data(),name().data());
dimitri's avatar
dimitri committed
327
  if (m_impl->inheritedBy==0)
dimitri's avatar
dimitri committed
328
  {
dimitri's avatar
dimitri committed
329 330
    m_impl->inheritedBy   = new BaseClassList;
    m_impl->inheritedBy->setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
331
  }
dimitri's avatar
dimitri committed
332
  m_impl->inheritedBy->inSort(new BaseClassDef(cd,0,p,s,t));
mueller's avatar
mueller committed
333 334
}

dimitri's avatar
dimitri committed
335 336
void ClassDef::addMembersToMemberGroup()
{
dimitri's avatar
dimitri committed
337
  QListIterator<MemberList> mli(m_impl->memberLists);
dimitri's avatar
dimitri committed
338 339 340 341 342
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if ((ml->listType()&MemberList::detailedLists)==0)
    {
dimitri's avatar
dimitri committed
343
      ::addMembersToMemberGroup(ml,&m_impl->memberGroupSDict,this);
dimitri's avatar
dimitri committed
344 345
    }
  }
dimitri's avatar
dimitri committed
346 347

  // add members inside sections to their groups
dimitri's avatar
dimitri committed
348
  if (m_impl->memberGroupSDict)
dimitri's avatar
dimitri committed
349
  {
dimitri's avatar
dimitri committed
350
    MemberGroupSDict::Iterator mgli(*m_impl->memberGroupSDict);
dimitri's avatar
dimitri committed
351 352
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
dimitri's avatar
dimitri committed
353
    {
dimitri's avatar
dimitri committed
354
      if (mg->allMembersInSameSection() && m_impl->subGrouping) 
dimitri's avatar
dimitri committed
355 356 357 358
      {
        //printf("addToDeclarationSection(%s)\n",mg->header().data());
        mg->addToDeclarationSection();
      }
dimitri's avatar
dimitri committed
359 360
    }
  }
dimitri's avatar
dimitri committed
361 362
}

mueller's avatar
mueller committed
363
// adds new member definition to the class
dimitri's avatar
dimitri committed
364 365 366 367
void ClassDef::internalInsertMember(MemberDef *md,
                                    Protection prot,
                                    bool addToAllList
                                   )
mueller's avatar
mueller committed
368
{
dimitri's avatar
dimitri committed
369
  //printf("insertInternalMember(%s) isHidden()=%d\n",md->name().data(),md->isHidden());
dimitri's avatar
dimitri committed
370 371
  if (md->isHidden()) return;

dimitri's avatar
dimitri committed
372 373 374 375 376 377 378 379 380 381
  static bool optVhdl    = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
  if (optVhdl)
  {
    QCString title=VhdlDocGen::trVhdlType(md->getMemberSpecifiers(),FALSE);
    if (!m_impl->vhdlSummaryTitles.find(title))
    {
      m_impl->vhdlSummaryTitles.append(title,new QCString(title));
    }
  }

mueller's avatar
mueller committed
382
  if (!isReference())
mueller's avatar
mueller committed
383
  {
dimitri's avatar
dimitri committed
384 385
    static bool extractPrivate = Config_getBool("EXTRACT_PRIVATE");

dimitri's avatar
dimitri committed
386 387 388
    /********************************************/
    /* insert member in the declaration section */
    /********************************************/
dimitri's avatar
dimitri committed
389
    if (md->isRelated() && (extractPrivate || prot!=Private))
mueller's avatar
mueller committed
390
    {
dimitri's avatar
dimitri committed
391
      addMemberToList(MemberList::related,md,TRUE);
mueller's avatar
mueller committed
392 393 394
    }
    else if (md->isFriend())
    {
dimitri's avatar
dimitri committed
395
      addMemberToList(MemberList::friends,md,TRUE);
mueller's avatar
mueller committed
396 397 398 399 400
    }
    else
    {
      switch (md->memberType())
      {
dimitri's avatar
dimitri committed
401
        case MemberDef::Signal: // Qt specific
dimitri's avatar
dimitri committed
402
          addMemberToList(MemberList::signals,md,TRUE);
mueller's avatar
mueller committed
403
          break;
dimitri's avatar
dimitri committed
404
        case MemberDef::DCOP:   // KDE2 specific
dimitri's avatar
dimitri committed
405
          addMemberToList(MemberList::dcopMethods,md,TRUE);
dimitri's avatar
dimitri committed
406
          break;
dimitri's avatar
dimitri committed
407
        case MemberDef::Property:
dimitri's avatar
dimitri committed
408
          addMemberToList(MemberList::properties,md,TRUE);
dimitri's avatar
dimitri committed
409
          break;
dimitri's avatar
dimitri committed
410
        case MemberDef::Event:
dimitri's avatar
dimitri committed
411
          addMemberToList(MemberList::events,md,TRUE);
dimitri's avatar
dimitri committed
412
          break;
dimitri's avatar
dimitri committed
413
        case MemberDef::Slot:   // Qt specific
dimitri's avatar
dimitri committed
414
          switch (prot)
mueller's avatar
mueller committed
415
          {
dimitri's avatar
dimitri committed
416
            case Protected: 
dimitri's avatar
dimitri committed
417
            case Package: // slots in packages are not possible!
dimitri's avatar
dimitri committed
418
              addMemberToList(MemberList::proSlots,md,TRUE);
dimitri's avatar
dimitri committed
419
              break;
dimitri's avatar
dimitri committed
420
            case Public:    
dimitri's avatar
dimitri committed
421
              addMemberToList(MemberList::pubSlots,md,TRUE);
dimitri's avatar
dimitri committed
422 423
              break;
            case Private:   
dimitri's avatar
dimitri committed
424
              addMemberToList(MemberList::priSlots,md,TRUE);
dimitri's avatar
dimitri committed
425
              break;
mueller's avatar
mueller committed
426 427 428 429 430
          }
          break;
        default: // any of the other members
          if (md->isStatic())
          {
dimitri's avatar
dimitri committed
431
            if (md->isVariable())
mueller's avatar
mueller committed
432
            {
dimitri's avatar
dimitri committed
433
              switch (prot)
dimitri's avatar
dimitri committed
434 435
              {
                case Protected: 
dimitri's avatar
dimitri committed
436
                  addMemberToList(MemberList::proStaticAttribs,md,TRUE);
dimitri's avatar
dimitri committed
437
                  break;
dimitri's avatar
dimitri committed
438
                case Package: 
dimitri's avatar
dimitri committed
439
                  addMemberToList(MemberList::pacStaticAttribs,md,TRUE);
dimitri's avatar
dimitri committed
440
                  break;
dimitri's avatar
dimitri committed
441
                case Public:    
dimitri's avatar
dimitri committed
442
                  addMemberToList(MemberList::pubStaticAttribs,md,TRUE);
dimitri's avatar
dimitri committed
443 444
                  break;
                case Private:   
dimitri's avatar
dimitri committed
445
                  addMemberToList(MemberList::priStaticAttribs,md,TRUE);
dimitri's avatar
dimitri committed
446 447 448 449 450
                  break;
              }
            }
            else // function
            {
dimitri's avatar
dimitri committed
451
              switch (prot)
dimitri's avatar
dimitri committed
452 453
              {
                case Protected: 
dimitri's avatar
dimitri committed
454
                  addMemberToList(MemberList::proStaticMethods,md,TRUE);
dimitri's avatar
dimitri committed
455
                  break;
dimitri's avatar
dimitri committed
456
                case Package: 
dimitri's avatar
dimitri committed
457
                  addMemberToList(MemberList::pacStaticMethods,md,TRUE);
dimitri's avatar
dimitri committed
458
                  break;
dimitri's avatar
dimitri committed
459
                case Public:    
dimitri's avatar
dimitri committed
460
                  addMemberToList(MemberList::pubStaticMethods,md,TRUE);
dimitri's avatar
dimitri committed
461 462
                  break;
                case Private:   
dimitri's avatar
dimitri committed
463
                  addMemberToList(MemberList::priStaticMethods,md,TRUE);
dimitri's avatar
dimitri committed
464 465
                  break;
              }
mueller's avatar
mueller committed
466 467
            }
          }
dimitri's avatar
dimitri committed
468
          else // not static
mueller's avatar
mueller committed
469
          {
dimitri's avatar
dimitri committed
470
            if (md->isVariable())
mueller's avatar
mueller committed
471
            {
dimitri's avatar
dimitri committed
472
              switch (prot)
dimitri's avatar
dimitri committed
473
              {
dimitri's avatar
dimitri committed
474
                case Protected: 
dimitri's avatar
dimitri committed
475
                  addMemberToList(MemberList::proAttribs,md,TRUE);
dimitri's avatar
dimitri committed
476
                  break;
dimitri's avatar
dimitri committed
477
                case Package:
dimitri's avatar
dimitri committed
478
                  addMemberToList(MemberList::pacAttribs,md,TRUE);
dimitri's avatar
dimitri committed
479
                  break;
dimitri's avatar
dimitri committed
480
                case Public:    
dimitri's avatar
dimitri committed
481
                  addMemberToList(MemberList::pubAttribs,md,TRUE);
dimitri's avatar
dimitri committed
482 483
                  break;
                case Private:   
dimitri's avatar
dimitri committed
484
                  addMemberToList(MemberList::priAttribs,md,TRUE);
dimitri's avatar
dimitri committed
485
                  break;
dimitri's avatar
dimitri committed
486 487
              }
            }
dimitri's avatar
dimitri committed
488
            else if (md->isTypedef() || md->isEnumerate() || md->isEnumValue())
dimitri's avatar
dimitri committed
489
            {
dimitri's avatar
dimitri committed
490
              switch (prot)
dimitri's avatar
dimitri committed
491
              {
dimitri's avatar
dimitri committed
492
                case Protected: 
dimitri's avatar
dimitri committed
493
                  addMemberToList(MemberList::proTypes,md,TRUE);
dimitri's avatar
dimitri committed
494
                  break;
dimitri's avatar
dimitri committed
495
                case Package: 
dimitri's avatar
dimitri committed
496
                  addMemberToList(MemberList::pacTypes,md,TRUE);
dimitri's avatar
dimitri committed
497
                  break;
dimitri's avatar
dimitri committed
498
                case Public:    
dimitri's avatar
dimitri committed
499
                  addMemberToList(MemberList::pubTypes,md,TRUE);
dimitri's avatar
dimitri committed
500 501
                  break;
                case Private:   
dimitri's avatar
dimitri committed
502
                  addMemberToList(MemberList::priTypes,md,TRUE);
dimitri's avatar
dimitri committed
503
                  break;
dimitri's avatar
dimitri committed
504 505 506 507
              }
            }
            else // member function
            {
dimitri's avatar
dimitri committed
508
              switch (prot)
dimitri's avatar
dimitri committed
509
              {
dimitri's avatar
dimitri committed
510
                case Protected: 
dimitri's avatar
dimitri committed
511
                  addMemberToList(MemberList::proMethods,md,TRUE);
dimitri's avatar
dimitri committed
512
                  break;
dimitri's avatar
dimitri committed
513
                case Package: 
dimitri's avatar
dimitri committed
514
                  addMemberToList(MemberList::pacMethods,md,TRUE);
dimitri's avatar
dimitri committed
515
                  break;
dimitri's avatar
dimitri committed
516
                case Public:    
dimitri's avatar
dimitri committed
517
                  addMemberToList(MemberList::pubMethods,md,TRUE);
dimitri's avatar
dimitri committed
518 519
                  break;
                case Private:   
dimitri's avatar
dimitri committed
520
                  addMemberToList(MemberList::priMethods,md,TRUE);
dimitri's avatar
dimitri committed
521
                  break;
dimitri's avatar
dimitri committed
522
              }
mueller's avatar
mueller committed
523 524
            }
          }
dimitri's avatar
dimitri committed
525 526 527 528 529 530 531
          break; 
      }
    }

    /*******************************************************/
    /* insert member in the detailed documentation section */
    /*******************************************************/
dimitri's avatar
dimitri committed
532 533
    if ((md->isRelated() && (extractPrivate || prot!=Private)) || md->isFriend())
    {
dimitri's avatar
dimitri committed
534
      addMemberToList(MemberList::relatedMembers,md,FALSE);
dimitri's avatar
dimitri committed
535 536 537 538 539
    }
    else
    {
      switch (md->memberType())
      {
dimitri's avatar
dimitri committed
540
        case MemberDef::Property:
dimitri's avatar
dimitri committed
541
          addMemberToList(MemberList::propertyMembers,md,FALSE);
dimitri's avatar
dimitri committed
542
          break;
dimitri's avatar
dimitri committed
543
        case MemberDef::Event:
dimitri's avatar
dimitri committed
544
          addMemberToList(MemberList::eventMembers,md,FALSE);
dimitri's avatar
dimitri committed
545
          break;
dimitri's avatar
dimitri committed
546 547
        case MemberDef::Signal: // fall through
        case MemberDef::DCOP:
dimitri's avatar
dimitri committed
548
          addMemberToList(MemberList::functionMembers,md,FALSE);
dimitri's avatar
dimitri committed
549 550
          break;
        case MemberDef::Slot:
dimitri's avatar
dimitri committed
551
          switch (prot)
dimitri's avatar
dimitri committed
552 553
          {
            case Protected: 
dimitri's avatar
dimitri committed
554
            case Package: 
dimitri's avatar
dimitri committed
555
            case Public:    
dimitri's avatar
dimitri committed
556
              addMemberToList(MemberList::functionMembers,md,FALSE);
dimitri's avatar
dimitri committed
557 558
              break;
            case Private:   
dimitri's avatar
dimitri committed
559
              if (extractPrivate)
dimitri's avatar
dimitri committed
560
              {
dimitri's avatar
dimitri committed
561
                addMemberToList(MemberList::functionMembers,md,FALSE);
dimitri's avatar
dimitri committed
562
              }
dimitri's avatar
dimitri committed
563 564 565 566
              break;
          }
          break;
        default: // any of the other members
dimitri's avatar
dimitri committed
567
          if (prot!=Private || extractPrivate)
dimitri's avatar
dimitri committed
568 569 570 571
          {
            switch (md->memberType())
            {
              case MemberDef::Typedef:
dimitri's avatar
dimitri committed
572
                addMemberToList(MemberList::typedefMembers,md,FALSE);
dimitri's avatar
dimitri committed
573 574
                break;
              case MemberDef::Enumeration:
dimitri's avatar
dimitri committed
575
                addMemberToList(MemberList::enumMembers,md,FALSE);
dimitri's avatar
dimitri committed
576 577
                break;
              case MemberDef::EnumValue:
dimitri's avatar
dimitri committed
578
                addMemberToList(MemberList::enumValMembers,md,FALSE);
dimitri's avatar
dimitri committed
579 580
                break;
              case MemberDef::Function:
dimitri's avatar
dimitri committed
581
                if (md->isConstructor() || md->isDestructor())
dimitri's avatar
dimitri committed
582
                {
dimitri's avatar
dimitri committed
583 584
                  MemberList *ml = createMemberList(MemberList::constructors);
                  ml->append(md);
dimitri's avatar
dimitri committed
585
                }
dimitri's avatar
dimitri committed
586
                else
dimitri's avatar
dimitri committed
587
                {
dimitri's avatar
dimitri committed
588
                  addMemberToList(MemberList::functionMembers,md,FALSE);
dimitri's avatar
dimitri committed
589
                }
dimitri's avatar
dimitri committed
590 591
                break;
              case MemberDef::Variable:
dimitri's avatar
dimitri committed
592
                addMemberToList(MemberList::variableMembers,md,FALSE);
dimitri's avatar
dimitri committed
593 594
                break;
              default:
dimitri's avatar
dimitri committed
595
                err("Unexpected member type %d found!\n",md->memberType());
dimitri's avatar
dimitri committed
596 597
            }
          }
mueller's avatar
mueller committed
598 599 600
          break; 
      }
    }
dimitri's avatar
dimitri committed
601 602 603 604 605 606

    /*************************************************/
    /* insert member in the appropriate member group */
    /*************************************************/
    // Note: this must be done AFTER inserting the member in the 
    // regular groups
dimitri's avatar
dimitri committed
607
    //addMemberToGroup(md,groupId);
dimitri's avatar
dimitri committed
608
    
mueller's avatar
mueller committed
609
  }
dimitri's avatar
dimitri committed
610

dimitri's avatar
dimitri committed
611 612
  if (md->virtualness()==Pure)
  {
dimitri's avatar
dimitri committed
613
    m_impl->isAbstract=TRUE;
dimitri's avatar
dimitri committed
614 615
  }

dimitri's avatar
dimitri committed
616
  //::addClassMemberNameToIndex(md);
dimitri's avatar
dimitri committed
617 618 619 620 621 622
  if (addToAllList && 
      !(Config_getBool("HIDE_FRIEND_COMPOUNDS") &&
        md->isFriend() &&
        (QCString(md->typeString())=="friend class" || 
         QCString(md->typeString())=="friend struct" ||
         QCString(md->typeString())=="friend union")))
dimitri's avatar
dimitri committed
623
  {
dimitri's avatar
dimitri committed
624
    //printf("=======> adding member %s to class %s\n",md->name().data(),name().data());
dimitri's avatar
dimitri committed
625 626 627
    MemberInfo *mi = new MemberInfo((MemberDef *)md,
                                     prot,md->virtualness(),FALSE);
    MemberNameInfo *mni=0;
dimitri's avatar
dimitri committed
628
    if (m_impl->allMemberNameInfoSDict==0)
dimitri's avatar
dimitri committed
629
    {
dimitri's avatar
dimitri committed
630 631
      m_impl->allMemberNameInfoSDict = new MemberNameInfoSDict(17);
      m_impl->allMemberNameInfoSDict->setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
632
    }
dimitri's avatar
dimitri committed
633
    if ((mni=m_impl->allMemberNameInfoSDict->find(md->name())))
dimitri's avatar
dimitri committed
634 635 636 637 638 639 640
    {
      mni->append(mi);
    }
    else
    {
      mni = new MemberNameInfo(md->name());
      mni->append(mi);
dimitri's avatar
dimitri committed
641
      m_impl->allMemberNameInfoSDict->append(mni->memberName(),mni);
dimitri's avatar
dimitri committed
642
    }
dimitri's avatar
dimitri committed
643 644 645
  }
}

dimitri's avatar
dimitri committed
646 647 648 649
void ClassDef::insertMember(MemberDef *md)
{
  internalInsertMember(md,md->protection(),TRUE);
}
dimitri's avatar
dimitri committed
650

mueller's avatar
mueller committed
651 652 653
// compute the anchors for all members
void ClassDef::computeAnchors()
{
dimitri's avatar
dimitri committed
654
  ClassDef *context = Config_getBool("INLINE_INHERITED_MEMB") ? this : 0;
dimitri's avatar
dimitri committed
655
  const char *letters = "abcdefghijklmnopqrstuvwxyz0123456789";
dimitri's avatar
dimitri committed
656
  QListIterator<MemberList> mli(m_impl->memberLists);
dimitri's avatar
dimitri committed
657 658 659 660 661 662 663 664 665 666
  MemberList *ml;
  int index = 0;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if ((ml->listType()&MemberList::detailedLists)==0)
    {
      setAnchors(context,letters[index++],ml);
    }
  }

dimitri's avatar
dimitri committed
667
  if (m_impl->memberGroupSDict)
dimitri's avatar
dimitri committed
668
  {
dimitri's avatar
dimitri committed
669
    MemberGroupSDict::Iterator mgli(*m_impl->memberGroupSDict);
dimitri's avatar
dimitri committed
670 671 672 673 674
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      mg->setAnchors(context);
    }
dimitri's avatar
dimitri committed
675
  }
mueller's avatar
mueller committed
676 677
}

dimitri's avatar
dimitri committed
678 679
void ClassDef::distributeMemberGroupDocumentation()
{
dimitri's avatar
dimitri committed
680
  if (m_impl->memberGroupSDict)
dimitri's avatar
dimitri committed
681
  {
dimitri's avatar
dimitri committed
682
    MemberGroupSDict::Iterator mgli(*m_impl->memberGroupSDict);
dimitri's avatar
dimitri committed
683 684 685 686 687
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      mg->distributeMemberGroupDocumentation();
    }
dimitri's avatar
dimitri committed
688 689 690
  }
}

dimitri's avatar
dimitri committed
691 692
void ClassDef::findSectionsInDocumentation()
{
dimitri's avatar
dimitri committed
693
  docFindSections(documentation(),this,0,docFile());
dimitri's avatar
dimitri committed
694
  if (m_impl->memberGroupSDict)
dimitri's avatar
dimitri committed
695
  {
dimitri's avatar
dimitri committed
696
    MemberGroupSDict::Iterator mgli(*m_impl->memberGroupSDict);
dimitri's avatar
dimitri committed
697 698 699 700 701 702
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      mg->findSectionsInDocumentation();
    }
  }
dimitri's avatar
dimitri committed
703
  QListIterator<MemberList> mli(m_impl->memberLists);
dimitri's avatar
dimitri committed
704 705 706 707 708 709 710 711
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if ((ml->listType()&MemberList::detailedLists)==0)
    {
      ml->findSectionsInDocumentation();
    }
  }
dimitri's avatar
dimitri committed
712 713
}

dimitri's avatar
dimitri committed
714

mueller's avatar
mueller committed
715 716 717
// add a file name to the used files set
void ClassDef::insertUsedFile(const char *f)
{
dimitri's avatar
dimitri committed
718 719
  if (m_impl->files.find(f)==-1) m_impl->files.append(f);
  if (m_impl->templateInstances)
dimitri's avatar
dimitri committed
720
  {
dimitri's avatar
dimitri committed
721
    QDictIterator<ClassDef> qdi(*m_impl->templateInstances);
dimitri's avatar
dimitri committed
722 723 724 725 726 727
    ClassDef *cd;
    for (qdi.toFirst();(cd=qdi.current());++qdi)
    {
      cd->insertUsedFile(f);
    }
  }
mueller's avatar
mueller committed
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
}

static void writeInheritanceSpecifier(OutputList &ol,BaseClassDef *bcd)
{
  if (bcd->prot!=Public || bcd->virt!=Normal)
  {
    ol.startTypewriter();
    ol.docify(" [");
    QStrList sl;
    if (bcd->prot==Protected)    sl.append("protected");
    else if (bcd->prot==Private) sl.append("private");
    if (bcd->virt==Virtual)      sl.append("virtual");
    const char *s=sl.first();
    while (s)
    {
      ol.docify(s);
      s=sl.next();
      if (s) ol.docify(", ");
    }
    ol.docify("]");
    ol.endTypewriter();
  }
}

dimitri's avatar
dimitri committed
752 753
void ClassDef::setIncludeFile(FileDef *fd,
             const char *includeName,bool local, bool force)
dimitri's avatar
dimitri committed
754
{
dimitri's avatar
dimitri committed
755
  //printf("ClassDef::setIncludeFile(%p,%s,%d,%d)\n",fd,includeName,local,force);
dimitri's avatar
dimitri committed
756 757 758
  if (!m_impl->incInfo) m_impl->incInfo=new IncludeInfo;
  if ((includeName && m_impl->incInfo->includeName.isEmpty()) ||
      (fd!=0 && m_impl->incInfo->fileDef==0)
dimitri's avatar
dimitri committed
759 760
     )
  {
dimitri's avatar
dimitri committed
761
    //printf("Setting file info\n");
dimitri's avatar
dimitri committed
762 763 764
    m_impl->incInfo->fileDef     = fd;
    m_impl->incInfo->includeName = includeName;
    m_impl->incInfo->local       = local;
dimitri's avatar
dimitri committed
765
  }
dimitri's avatar
dimitri committed
766
  if (force && includeName) m_impl->incInfo->includeName = includeName;
dimitri's avatar
dimitri committed
767 768
}

dimitri's avatar
dimitri committed
769
// TODO: fix this: a nested template class can have multiple outer templates
dimitri's avatar
dimitri committed
770 771 772 773 774
//ArgumentList *ClassDef::outerTemplateArguments() const
//{
//  int ti;
//  ClassDef *pcd=0;
//  int pi=0;
dimitri's avatar
dimitri committed
775
//  if (m_impl->tempArgs) return m_impl->tempArgs;
dimitri's avatar
dimitri committed
776 777 778 779 780 781 782 783 784 785
//  // find the outer most class scope
//  while ((ti=name().find("::",pi))!=-1 && 
//      (pcd=getClass(name().left(ti)))==0
//        ) pi=ti+2;
//  if (pcd)
//  {
//    return pcd->templateArguments();
//  }
//  return 0;
//}
dimitri's avatar
dimitri committed
786

dimitri's avatar
dimitri committed
787 788 789 790 791 792 793 794 795 796 797 798
static void searchTemplateSpecs(/*in*/  Definition *d,
                                /*out*/ QList<ArgumentList> &result,
                                /*out*/ QCString &name)
{
  if (d->definitionType()==Definition::TypeClass)
  {
    if (d->getOuterScope())
    {
      searchTemplateSpecs(d->getOuterScope(),result,name);
    }
    ClassDef *cd=(ClassDef *)d;
    if (!name.isEmpty()) name+="::";
dimitri's avatar
dimitri committed
799 800 801 802 803 804
    QCString clName = d->localName();
    if (clName.right(2)=="-g" || clName.right(2)=="-p")
    {
      clName = clName.left(clName.length()-2);
    }
    name+=clName;
dimitri's avatar
dimitri committed
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
    bool isSpecialization = d->localName().find('<')!=-1;
    if (cd->templateArguments()) 
    {
      result.append(cd->templateArguments());
      if (!isSpecialization)
      {
        name+=tempArgListToString(cd->templateArguments());
      }
    }
  }
  else
  {
    name+=d->qualifiedName();
  }
}
dimitri's avatar
dimitri committed
820

dimitri's avatar
dimitri committed
821 822
static void writeTemplateSpec(OutputList &ol,Definition *d,
            const QCString &type)
dimitri's avatar
dimitri committed
823
{
dimitri's avatar
dimitri committed
824 825 826 827
  QList<ArgumentList> specs;
  QCString name;
  searchTemplateSpecs(d,specs,name);
  if (specs.count()>0) // class has template scope specifiers
dimitri's avatar
dimitri committed
828 829
  {
    ol.startSubsubsection(); 
dimitri's avatar
dimitri committed
830 831 832
    QListIterator<ArgumentList> spi(specs);
    ArgumentList *al;
    for (spi.toFirst();(al=spi.current());++spi)
dimitri's avatar
dimitri committed
833
    {
dimitri's avatar
dimitri committed
834 835 836
      ol.docify("template<");
      Argument *a=al->first();
      while (a)
dimitri's avatar
dimitri committed
837
      {
dimitri's avatar
dimitri committed
838 839 840 841 842 843 844 845 846 847 848 849 850
        ol.docify(a->type);
        if (!a->name.isEmpty())
        {
          ol.docify(" ");
          ol.docify(a->name);
        }
        if (a->defval.length()!=0)
        {
          ol.docify(" = ");
          ol.docify(a->defval);
        } 
        a=al->next();
        if (a) ol.docify(", ");
dimitri's avatar
dimitri committed
851
      }
dimitri's avatar
dimitri committed
852
      ol.docify(">");
dimitri's avatar
dimitri committed
853 854
      ol.pushGeneratorState();
      ol.disableAllBut(OutputGenerator::Html);
dimitri's avatar
dimitri committed
855
      ol.lineBreak();
dimitri's avatar
dimitri committed
856
      ol.popGeneratorState();
dimitri's avatar
dimitri committed
857
    }
dimitri's avatar
dimitri committed
858
    ol.docify(type.lower()+" "+name);
dimitri's avatar
dimitri committed
859 860 861 862
    ol.endSubsubsection();
    ol.writeString("\n");
  }
}
dimitri's avatar
dimitri committed
863

dimitri's avatar
dimitri committed
864 865 866 867
void ClassDef::writeBriefDescription(OutputList &ol,bool exampleFlag)
{
  if (!briefDescription().isEmpty())
  {
dimitri's avatar
dimitri committed
868 869 870
    ol.startParagraph();
    ol.parseDoc(briefFile(),briefLine(),this,0,
                briefDescription(),TRUE,FALSE,0,TRUE,FALSE);
dimitri's avatar
dimitri committed
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
    ol.pushGeneratorState();
    ol.disable(OutputGenerator::RTF);
    ol.writeString(" \n");
    ol.enable(OutputGenerator::RTF);

    if (Config_getBool("REPEAT_BRIEF") || 
        !documentation().isEmpty() || 
        exampleFlag
       )
    {
      ol.disableAllBut(OutputGenerator::Html);
      ol.startTextLink(0,"_details");
      ol.parseText(theTranslator->trMore());
      ol.endTextLink();
    }
    ol.popGeneratorState();

dimitri's avatar
dimitri committed
888 889 890 891 892
    //ol.pushGeneratorState();
    //ol.disable(OutputGenerator::RTF);
    //ol.newParagraph(); // FIXME:PARA
    //ol.popGeneratorState();
    ol.endParagraph();
dimitri's avatar
dimitri committed
893 894 895 896
  }
  ol.writeSynopsis();
}

dimitri's avatar
dimitri committed
897
// write the detailed description for this class
dimitri's avatar
dimitri committed
898 899
void ClassDef::writeDetailedDescription(OutputList &ol, const QCString &pageType, bool exampleFlag, 
                                        const QCString &title)
dimitri's avatar
dimitri committed
900 901 902
{
  if ((!briefDescription().isEmpty() && Config_getBool("REPEAT_BRIEF")) || 
      !documentation().isEmpty() || 
dimitri's avatar
dimitri committed
903
      (Config_getBool("SOURCE_BROWSER") && getStartBodyLine()!=-1 && getBodyDef()) ||
dimitri's avatar
dimitri committed
904 905 906 907
      exampleFlag)
  {
    ol.writeRuler();
    ol.pushGeneratorState();
dimitri's avatar
dimitri committed
908
      ol.disableAllBut(OutputGenerator::Html);
dimitri's avatar
dimitri committed
909 910 911
      ol.writeAnchor(0,"_details");
    ol.popGeneratorState();
    ol.startGroupHeader();
dimitri's avatar
dimitri committed
912
    ol.parseText(title);
dimitri's avatar
dimitri committed
913
    ol.endGroupHeader();
dimitri's avatar
dimitri committed
914

dimitri's avatar
dimitri committed
915 916 917 918 919 920 921
    ol.startTextBlock();
    
    writeTemplateSpec(ol,this,pageType);
    
    // repeat brief description
    if (!briefDescription().isEmpty() && Config_getBool("REPEAT_BRIEF"))
    {
dimitri's avatar
dimitri committed
922
      ol.parseDoc(briefFile(),briefLine(),this,0,briefDescription(),FALSE,FALSE);
dimitri's avatar
dimitri committed
923 924 925 926
    }
    if (!briefDescription().isEmpty() && Config_getBool("REPEAT_BRIEF") &&
        !documentation().isEmpty())
    {
dimitri's avatar
dimitri committed
927 928
      ol.pushGeneratorState();
        ol.disable(OutputGenerator::Man);
dimitri's avatar
dimitri committed
929
        ol.disable(OutputGenerator::RTF);
dimitri's avatar
dimitri committed
930
        //ol.newParagraph(); // FIXME:PARA
dimitri's avatar
dimitri committed
931 932 933 934
        ol.enableAll();
        ol.disableAllBut(OutputGenerator::Man);
        ol.writeString("\n\n");
      ol.popGeneratorState();
dimitri's avatar
dimitri committed
935 936 937 938
    }
    // write documentation
    if (!documentation().isEmpty())
    {
dimitri's avatar
dimitri committed
939
      ol.parseDoc(docFile(),docLine(),this,0,documentation(),TRUE,FALSE);
dimitri's avatar
dimitri committed
940
    }
dimitri's avatar
dimitri committed
941 942 943
    // write type constraints
    writeTypeConstraints(ol,this,m_impl->typeConstraints);

dimitri's avatar
dimitri committed
944
    // write examples
dimitri's avatar
dimitri committed
945
    if (exampleFlag && m_impl->exampleSDict)
dimitri's avatar
dimitri committed
946
    {
dimitri's avatar
dimitri committed
947
      ol.startSimpleSect(BaseOutputDocInterface::Examples,0,0,theTranslator->trExamples()+": ");
dimitri's avatar
dimitri committed
948 949
      ol.startDescForItem();
      ol.startParagraph();
dimitri's avatar
dimitri committed
950
      writeExample(ol,m_impl->exampleSDict);
dimitri's avatar
dimitri committed
951 952
      ol.endParagraph();
      ol.endDescForItem();
dimitri's avatar
dimitri committed
953
      ol.endSimpleSect();
dimitri's avatar
dimitri committed
954
    }
dimitri's avatar
dimitri committed
955
    //ol.newParagraph();
dimitri's avatar
dimitri committed
956 957 958 959 960 961 962 963
    writeSourceDef(ol,name());
    ol.endTextBlock();
  }
  else
  {
    writeTemplateSpec(ol,this,pageType);
  }
}
dimitri's avatar
dimitri committed
964
    
dimitri's avatar
dimitri committed
965 966
void ClassDef::showUsedFiles(OutputList &ol)
{
dimitri's avatar
dimitri committed
967 968
  ol.pushGeneratorState();
  ol.disable(OutputGenerator::Man);
dimitri's avatar
dimitri committed
969
  bool fortranOpt = Config_getBool("OPTIMIZE_FOR_FORTRAN");
dimitri's avatar
dimitri committed
970 971 972 973 974

  ol.writeRuler();
  if (fortranOpt)
  {
    ol.parseText(theTranslator->trGeneratedFromFilesFortran(
dimitri's avatar
dimitri committed
975
          m_impl->lang==SrcLangExt_ObjC && m_impl->compType==Interface ? Class : m_impl->compType,
dimitri's avatar
dimitri committed
976
          m_impl->files.count()==1));
dimitri's avatar
dimitri committed
977 978 979 980
  }
  else
  {
    ol.parseText(theTranslator->trGeneratedFromFiles(
dimitri's avatar
dimitri committed
981
          m_impl->lang==SrcLangExt_ObjC && m_impl->compType==Interface ? Class : m_impl->compType,
dimitri's avatar
dimitri committed
982
          m_impl->files.count()==1));  
dimitri's avatar
dimitri committed
983
  }
dimitri's avatar
dimitri committed
984

dimitri's avatar
dimitri committed
985 986 987 988 989 990 991 992

  bool first=TRUE;
  const char *file = m_impl->files.first();
  while (file)
  {
    bool ambig;
    FileDef *fd=findFileDef(Doxygen::inputNameDict,file,ambig);
    if (fd)
dimitri's avatar
dimitri committed
993
    {
dimitri's avatar
dimitri committed
994
      if (first)
dimitri's avatar
dimitri committed
995
      {
dimitri's avatar
dimitri committed
996 997 998
        first=FALSE;   
        ol.startItemList();
      }
dimitri's avatar
dimitri committed
999

dimitri's avatar
dimitri committed
1000
      ol.startItemListItem();
dimitri's avatar
dimitri committed
1001 1002 1003 1004 1005
      QCString path=fd->getPath();
      if (Config_getBool("FULL_PATH_NAMES"))
      {
        ol.docify(stripFromPath(path));
      }
dimitri's avatar
dimitri committed
1006

dimitri's avatar
dimitri committed
1007 1008 1009 1010 1011
      QCString fname = fd->name();
      if (!fd->getVersion().isEmpty()) // append version if available
      {
        fname += " (" + fd->getVersion() + ")";
      }
dimitri's avatar
dimitri committed
1012

dimitri's avatar
dimitri committed
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
      // for HTML 
      ol.pushGeneratorState();
      ol.disableAllBut(OutputGenerator::Html);
      if (fd->generateSourceFile())
      {
        ol.writeObjectLink(0,fd->getSourceFileBase(),0,fname);
      }
      else if (fd->isLinkable())
      {
        ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),0,
            fname);
      }
      else
      {
        ol.docify(fname);
      }
      ol.popGeneratorState();
dimitri's avatar
dimitri committed
1030

dimitri's avatar
dimitri committed
1031 1032 1033 1034 1035 1036 1037
      // for other output formats
      ol.pushGeneratorState();
      ol.disable(OutputGenerator::Html);
      if (fd->isLinkable())
      {
        ol.writeObjectLink(fd->getReference(),fd->getOutputFileBase(),0,
            fname);
dimitri's avatar
dimitri committed
1038
      }
dimitri's avatar
dimitri committed
1039 1040 1041 1042 1043
      else
      {
        ol.docify(fname);
      }
      ol.popGeneratorState();
dimitri's avatar
dimitri committed
1044 1045

      ol.endItemListItem();
dimitri's avatar
dimitri committed
1046
    }
dimitri's avatar
dimitri committed
1047 1048 1049 1050
    file=m_impl->files.next();
  }
  if (!first) ol.endItemList();

dimitri's avatar
dimitri committed
1051
  ol.popGeneratorState();
dimitri's avatar
dimitri committed
1052 1053 1054
}


dimitri's avatar
dimitri committed
1055
void ClassDef::writeInheritanceGraph(OutputList &ol)
dimitri's avatar
dimitri committed
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
{
  // count direct inheritance relations
  int count=0;
  BaseClassDef *ibcd;
  if (m_impl->inheritedBy)
  {
    ibcd=m_impl->inheritedBy->first();
    while (ibcd)
    {
      ClassDef *icd=ibcd->classDef;
      if ( icd->isVisibleInHierarchy()) count++;
      ibcd=m_impl->inheritedBy->next();
    }
  }
  if (m_impl->inherits)
  {
    ibcd=m_impl->inherits->first();
    while (ibcd)
    {
      ClassDef *icd=ibcd->classDef;
      if ( icd->isVisibleInHierarchy()) count++;
      ibcd=m_impl->inherits->next();
    }
  }

  
  bool renderDiagram = FALSE;
dimitri's avatar
dimitri committed
1083 1084
  if (Config_getBool("HAVE_DOT") && 
      (Config_getBool("CLASS_DIAGRAMS") || Config_getBool("CLASS_GRAPH")))
dimitri's avatar
dimitri committed
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
    // write class diagram using dot
  {
    DotClassGraph inheritanceGraph(this,DotNode::Inheritance);
    if (!inheritanceGraph.isTrivial() && !inheritanceGraph.isTooBig())
    {
      ol.pushGeneratorState();
      ol.disable(OutputGenerator::Man);
      ol.startDotGraph();
      ol.parseText(theTranslator->trClassDiagram(displayName()));
      ol.endDotGraph(inheritanceGraph);
      ol.popGeneratorState();
      renderDiagram = TRUE;
    }
  }
  else if (Config_getBool("CLASS_DIAGRAMS") && count>0) 
    // write class diagram using build-in generator
  {
    ClassDiagram diagram(this); // create a diagram of this class.
    ol.startClassDiagram();
    ol.disable(OutputGenerator::Man);
    ol.parseText(theTranslator->trClassDiagram(displayName()));
    ol.enable(OutputGenerator::Man);
    ol.endClassDiagram(diagram,getOutputFileBase(),displayName());
    renderDiagram = TRUE;
  } 

dimitri's avatar
dimitri committed
1111 1112
  if (renderDiagram) // if we already show the inheritance relations graphically,
                     // then hide the text version
dimitri's avatar
dimitri committed
1113 1114 1115 1116 1117 1118
  {
    ol.disableAllBut(OutputGenerator::Man);
  }

  if (m_impl->inherits && (count=m_impl->inherits->count())>0)
  {
dimitri's avatar
dimitri committed
1119
    ol.startParagraph();
dimitri's avatar
dimitri committed
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134
    //parseText(ol,theTranslator->trInherits()+" ");

    QCString inheritLine = theTranslator->trInheritsList(m_impl->inherits->count());
    QRegExp marker("@[0-9]+");
    int index=0,newIndex,matchLen;
    // now replace all markers in inheritLine with links to the classes
    while ((newIndex=marker.match(inheritLine,index,&matchLen))!=-1)
    {
      ol.parseText(inheritLine.mid(index,newIndex-index));
      bool ok;
      uint entryIndex = inheritLine.mid(newIndex+1,matchLen-1).toUInt(&ok);
      BaseClassDef *bcd=m_impl->inherits->at(entryIndex);
      if (ok && bcd)
      {
        ClassDef *cd=bcd->classDef;
dimitri's avatar
dimitri committed
1135 1136 1137 1138 1139 1140

        // use the class name but with the template arguments as given
        // in the inheritance relation
        QCString displayName = insertTemplateSpecifierInScope(
            cd->name(),bcd->templSpecifiers);

dimitri's avatar
dimitri committed
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
        if (cd->isLinkable())
        {
          if (!Config_getString("GENERATE_TAGFILE").isEmpty()) 
          {
            Doxygen::tagFile << "    <base";
            if (bcd->prot==Protected)
            {
              Doxygen::tagFile << " protection=\"protected\"";
            }
            else if (bcd->prot==Private)
            {
              Doxygen::tagFile << " protection=\"private\"";
            }
            if (bcd->virt==Virtual)
            {
              Doxygen::tagFile << " virtualness=\"virtual\"";
            }
dimitri's avatar
dimitri committed
1158 1159
            Doxygen::tagFile << ">" << convertToXML(cd->name()) 
                             << "</base>" << endl;
dimitri's avatar
dimitri committed
1160
          }
dimitri's avatar
dimitri committed
1161 1162 1163
          ol.writeObjectLink(cd->getReference(),
                             cd->getOutputFileBase(),
                             0,
dimitri's avatar
dimitri committed
1164
                             displayName);
dimitri's avatar
dimitri committed
1165 1166 1167
        }
        else
        {
dimitri's avatar
dimitri committed
1168
          ol.docify(displayName);
dimitri's avatar
dimitri committed
1169 1170 1171 1172
        }
      }
      else
      {
dimitri's avatar
dimitri committed
1173
        err("error: invalid marker %d in inherits list!\n",entryIndex);
dimitri's avatar
dimitri committed
1174 1175 1176 1177
      }
      index=newIndex+matchLen;
    } 
    ol.parseText(inheritLine.right(inheritLine.length()-index));
dimitri's avatar
dimitri committed
1178
    ol.endParagraph();
dimitri's avatar
dimitri committed
1179 1180 1181 1182 1183
  }

  // write subclasses
  if (m_impl->inheritedBy && (count=m_impl->inheritedBy->count())>0)
  {
dimitri's avatar
dimitri committed
1184
    ol.startParagraph();
dimitri's avatar
dimitri committed
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
    QCString inheritLine = theTranslator->trInheritedByList(m_impl->inheritedBy->count());
    QRegExp marker("@[0-9]+");
    int index=0,newIndex,matchLen;
    // now replace all markers in inheritLine with links to the classes
    while ((newIndex=marker.match(inheritLine,index,&matchLen))!=-1)
    {
      ol.parseText(inheritLine.mid(index,newIndex-index));
      bool ok;
      uint entryIndex = inheritLine.mid(newIndex+1,matchLen-1).toUInt(&ok);
      BaseClassDef *bcd=m_impl->inheritedBy->at(entryIndex);
      if (ok && bcd)
      {
        ClassDef *cd=bcd->classDef;
        if (cd->isLinkable())
        {
          ol.writeObjectLink(cd->getReference(),cd->getOutputFileBase(),0,cd->displayName());
        }
        else
        {
          ol.docify(cd->displayName());
        }
        writeInheritanceSpecifier(ol,bcd);
      }
      index=newIndex+matchLen;
    } 
    ol.parseText(inheritLine.right(inheritLine.length()-index));
dimitri's avatar
dimitri committed
1211
    ol.endParagraph();
dimitri's avatar
dimitri committed
1212 1213
  }

dimitri's avatar
dimitri committed
1214
  if (renderDiagram) 
dimitri's avatar
dimitri committed
1215 1216 1217
  {
    ol.enableAll();
  }
dimitri's avatar
dimitri committed
1218
}
dimitri's avatar
dimitri committed
1219

dimitri's avatar
dimitri committed
1220 1221 1222
void ClassDef::writeCollaborationGraph(OutputList &ol)
{
  if (Config_getBool("HAVE_DOT") /*&& Config_getBool("COLLABORATION_GRAPH")*/)
dimitri's avatar
dimitri committed
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
  {
    DotClassGraph usageImplGraph(this,DotNode::Collaboration);
    if (!usageImplGraph.isTrivial())
    {
      ol.pushGeneratorState();
      ol.disable(OutputGenerator::Man);
      ol.startDotGraph();
      ol.parseText(theTranslator->trCollaborationDiagram(displayName()));
      ol.endDotGraph(usageImplGraph);
      ol.popGeneratorState();
    }
  }
dimitri's avatar
dimitri committed
1235
}
dimitri's avatar
dimitri committed
1236

dimitri's avatar
dimitri committed
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
void ClassDef::writeIncludeFiles(OutputList &ol)
{
  if (m_impl->incInfo /*&& Config_getBool("SHOW_INCLUDE_FILES")*/)
  {
    QCString nm=m_impl->incInfo->includeName.isEmpty() ? 
      (m_impl->incInfo->fileDef ?
       m_impl->incInfo->fileDef->docName().data() : "" 
      ) :
      m_impl->incInfo->includeName.data();
    if (!nm.isEmpty())
    {
dimitri's avatar
dimitri committed
1248
      ol.startParagraph();
dimitri's avatar
dimitri committed
1249
      ol.startTypewriter();
dimitri's avatar
dimitri committed
1250 1251
      SrcLangExt lang = getLanguageFromFileName(nm);
      bool isIDLorJava = lang==SrcLangExt_IDL || lang==SrcLangExt_Java;
dimitri's avatar
dimitri committed
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
      if (isIDLorJava)
      {
        ol.docify("import ");
      }
      else if (isObjectiveC())
      {
        ol.docify("#import ");
      }
      else
      {
        ol.docify("#include ");
      }
      if (m_impl->incInfo->local || isIDLorJava)
        ol.docify("\"");
      else
        ol.docify("<");
      ol.pushGeneratorState();
      ol.disable(OutputGenerator::Html);
      ol.docify(nm);
      ol.disableAllBut(OutputGenerator::Html);
      ol.enable(OutputGenerator::Html);
      if (m_impl->incInfo->fileDef)
      {
        ol.writeObjectLink(0,m_impl->incInfo->fileDef->includeName(),0,nm);
      }
      else
      {
        ol.docify(nm);
      }
      ol.popGeneratorState();
      if (m_impl->incInfo->local || isIDLorJava)
        ol.docify("\"");
      else
        ol.docify(">");
      if (isIDLorJava) 
        ol.docify(";");
      ol.endTypewriter();
dimitri's avatar
dimitri committed
1289
      ol.endParagraph();
dimitri's avatar
dimitri committed
1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302
    }
  }
}

void ClassDef::writeAllMembersLink(OutputList &ol)
{
  // write link to list of all members (HTML only)
  if (m_impl->allMemberNameInfoSDict &&
      !Config_getBool("OPTIMIZE_OUTPUT_FOR_C")
     )
  {
    ol.pushGeneratorState();
    ol.disableAllBut(OutputGenerator::Html);
dimitri's avatar
dimitri committed
1303
    ol.startParagraph();
dimitri's avatar
dimitri committed
1304 1305 1306
    ol.startTextLink(getMemberListFileName(),0);
    ol.parseText(theTranslator->trListOfAllMembers());
    ol.endTextLink();
dimitri's avatar
dimitri committed
1307
    ol.endParagraph();
dimitri's avatar
dimitri committed
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
    ol.enableAll();
    ol.popGeneratorState();
  }
}

void ClassDef::writeMemberGroups(OutputList &ol)
{
  // write user defined member groups
  if (m_impl->memberGroupSDict)
  {
dimitri's avatar
dimitri committed
1318
    m_impl->memberGroupSDict->sort();
dimitri's avatar
dimitri committed
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
    MemberGroupSDict::Iterator mgli(*m_impl->memberGroupSDict);
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      if (!mg->allMembersInSameSection() || !m_impl->subGrouping) // group is in its own section
      {
        mg->writeDeclarations(ol,this,0,0,0);
      }
      else // add this group to the corresponding member section
      {
        //printf("addToDeclarationSection(%s)\n",mg->header().data());
        //mg->addToDeclarationSection();
      }
    }
  }
}

void ClassDef::writeNestedClasses(OutputList &ol,const QCString &title)
{
  // nested classes
  if (m_impl->innerClasses) 
  {
    m_impl->innerClasses->writeDeclaration(ol,0,title,TRUE);
  }
}

void ClassDef::startMemberDocumentation(OutputList &ol)
{
  if (Config_getBool("SEPARATE_MEMBER_PAGES"))
  {
    ol.disable(OutputGenerator::Html);
    Doxygen::suppressDocWarnings = TRUE;
  }
}

void ClassDef::endMemberDocumentation(OutputList &ol)
{
  if (Config_getBool("SEPARATE_MEMBER_PAGES"))
  {
    ol.enable(OutputGenerator::Html);
    Doxygen::suppressDocWarnings = FALSE;
  }
}

void ClassDef::startMemberDeclarations(OutputList &ol)
{
  ol.startMemberSections();
}

void ClassDef::endMemberDeclarations(OutputList &ol)
{
  ol.endMemberSections();
}

void ClassDef::writeAuthorSection(OutputList &ol)
{
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Man);
  ol.writeString("\n");
  ol.startGroupHeader();
  ol.parseText(theTranslator->trAuthor(TRUE,TRUE));
  ol.endGroupHeader();
  ol.parseText(theTranslator->trGeneratedAutomatically(Config_getString("PROJECT_NAME")));
  ol.popGeneratorState();
dimitri's avatar
dimitri committed
1383 1384
}

dimitri's avatar
dimitri committed
1385 1386 1387

void ClassDef::writeSummaryLinks(OutputList &ol)
{
dimitri's avatar
dimitri committed
1388
  static bool vhdlOpt    = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
dimitri's avatar
dimitri committed
1389 1390 1391 1392 1393 1394
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
  QListIterator<LayoutDocEntry> eli(
      LayoutDocManager::instance().docEntries(LayoutDocManager::Class));
  LayoutDocEntry *lde;
  bool first=TRUE;
dimitri's avatar
dimitri committed
1395 1396
  
  if (!vhdlOpt)
dimitri's avatar
dimitri committed
1397
  {
dimitri's avatar
dimitri committed
1398
    for (eli.toFirst();(lde=eli.current());++eli)
dimitri's avatar
dimitri committed
1399
    {
dimitri's avatar
dimitri committed
1400 1401 1402 1403 1404 1405 1406 1407 1408
      if (lde->kind()==LayoutDocEntry::ClassNestedClasses && 
          m_impl->innerClasses  &&
          m_impl->innerClasses->declVisible()
         )
      {
        LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
        writeSummaryLink(ol,"nested-classes",ls->title,first);
      }
      else if (lde->kind()== LayoutDocEntry::MemberDecl)
dimitri's avatar
dimitri committed
1409
      {
dimitri's avatar
dimitri committed
1410 1411 1412 1413 1414 1415
        LayoutDocEntryMemberDecl *lmd = (LayoutDocEntryMemberDecl*)lde;
        MemberList * ml = getMemberList(lmd->type);
        if (ml && ml->declVisible())
        {
          writeSummaryLink(ol,ml->listTypeAsString(),lmd->title,first);
        }
dimitri's avatar
dimitri committed
1416 1417 1418
      }
    }
  }
dimitri's avatar
dimitri committed
1419 1420 1421 1422 1423 1424 1425 1426
  else // VDHL only
  {
    SDict<QCString>::Iterator li(m_impl->vhdlSummaryTitles);
    for (li.toFirst();li.current();++li)
    {
      writeSummaryLink(ol,li.current()->data(),li.current()->data(),first);
    }
  }
dimitri's avatar
dimitri committed
1427 1428 1429 1430 1431 1432 1433
  if (!first)
  {
    ol.writeString("  </div>\n");
  }
  ol.popGeneratorState();
}

mueller's avatar
mueller committed
1434 1435 1436
// write all documentation for this class
void ClassDef::writeDocumentation(OutputList &ol)
{
dimitri's avatar
dimitri committed
1437
  static bool generateTreeView = Config_getBool("GENERATE_TREEVIEW");
dimitri's avatar
dimitri committed
1438 1439
  static bool fortranOpt = Config_getBool("OPTIMIZE_FOR_FORTRAN");
  static bool vhdlOpt    = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
dimitri's avatar
dimitri committed
1440
  QCString pageType = " ";
dimitri's avatar
dimitri committed
1441 1442
  QCString pageTitle = " ";
    
dimitri's avatar
dimitri committed
1443 1444
  pageType += compoundTypeString();
  toupper(pageType.at(1));
dimitri's avatar
dimitri committed
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458
  if (fortranOpt)
  {
    pageTitle = theTranslator->trCompoundReferenceFortran(displayName(),
              m_impl->compType,
              m_impl->tempArgs != 0);  
  }
  else if (vhdlOpt)
  {
    // TODO: translate
    pageTitle = VhdlDocGen::getClassTitle(this)+" Reference";
  }
  else
  {
    pageTitle = theTranslator->trCompoundReference(displayName(),
dimitri's avatar
dimitri committed
1459
              m_impl->compType == Interface && m_impl->lang==SrcLangExt_ObjC ? Class : m_impl->compType,
dimitri's avatar
dimitri committed
1460
              m_impl->tempArgs != 0);
dimitri's avatar
dimitri committed
1461
  }
dimitri's avatar
dimitri committed
1462
  
dimitri's avatar
dimitri committed
1463 1464
  startFile(ol,getOutputFileBase(),name(),pageTitle,HLI_ClassVisible,!generateTreeView);  
  if (!generateTreeView)
dimitri's avatar
dimitri committed
1465
  {
dimitri's avatar
dimitri committed
1466 1467 1468 1469 1470
    if (getOuterScope()!=Doxygen::globalScope)
    {
      writeNavigationPath(ol);
    }
    ol.endQuickIndices();
dimitri's avatar
dimitri committed
1471
  }
dimitri's avatar
dimitri committed
1472 1473

  startTitle(ol,getOutputFileBase(),this);
dimitri's avatar
dimitri committed
1474
  ol.parseText(pageTitle);
dimitri's avatar
dimitri committed
1475
  addGroupListToTitle(ol,this);
mueller's avatar
mueller committed
1476
  endTitle(ol,getOutputFileBase(),name());
dimitri's avatar
dimitri committed
1477
  ol.startContents();
mueller's avatar
mueller committed
1478

dimitri's avatar
dimitri committed
1479 1480 1481
  {
    ol.pushGeneratorState();
    ol.disableAllBut(OutputGenerator::Html);
dimitri's avatar
dimitri committed
1482
    ol.writeString("<!-- doxytag: class=\"");
dimitri's avatar
dimitri committed
1483
    ol.docify(name());
dimitri's avatar
dimitri committed
1484
    ol.writeString("\" -->");
dimitri's avatar
dimitri committed
1485
    if (m_impl->inherits && m_impl->inherits->count()>0)
dimitri's avatar
dimitri committed
1486
    {
dimitri's avatar
dimitri committed
1487
      BaseClassListIterator bli(*m_impl->inherits);
dimitri's avatar
dimitri committed
1488
      ol.writeString("<!-- doxytag: inherits=\"");
dimitri's avatar
dimitri committed
1489 1490 1491 1492 1493 1494 1495 1496
      BaseClassDef *bcd=0;
      bool first=TRUE;
      for (bli.toFirst();(bcd=bli.current());++bli)
      {
        if (!first) ol.writeString(",");
        ol.docify(bcd->classDef->name());
        first=FALSE;
      }
dimitri's avatar
dimitri committed
1497
      ol.writeString("\" -->");
dimitri's avatar
dimitri committed
1498 1499 1500 1501
    }
    ol.popGeneratorState();
  }

dimitri's avatar
dimitri committed
1502 1503
  Doxygen::indexList.addIndexItem(this,0);

dimitri's avatar
dimitri committed
1504
  if (!Config_getString("GENERATE_TAGFILE").isEmpty()) 
dimitri's avatar
dimitri committed
1505
  {
dimitri's avatar
dimitri committed
1506
    Doxygen::tagFile << "  <compound kind=\"" << compoundTypeString();
dimitri's avatar
dimitri committed
1507 1508 1509
    Doxygen::tagFile << "\"";
    if (isObjectiveC()) { Doxygen::tagFile << " objc=\"yes\""; }
    Doxygen::tagFile << ">" << endl;
dimitri's avatar
dimitri committed
1510
    Doxygen::tagFile << "    <name>" << convertToXML(name()) << "</name>" << endl;
dimitri's avatar
dimitri committed
1511
    Doxygen::tagFile << "    <filename>" << convertToXML(getOutputFileBase()) << Doxygen::htmlFileExtension << "</filename>" << endl;
dimitri's avatar
dimitri committed
1512
    if (m_impl->tempArgs)
dimitri's avatar
dimitri committed
1513
    {
dimitri's avatar
dimitri committed
1514
      ArgumentListIterator ali(*m_impl->tempArgs);
dimitri's avatar
dimitri committed
1515 1516 1517 1518 1519 1520
      Argument *a;
      for (;(a=ali.current());++ali)
      {
        Doxygen::tagFile << "    <templarg>" << convertToXML(a->name) << "</templarg>" << endl;
      }
    }
dimitri's avatar
dimitri committed
1521 1522
  }

dimitri's avatar
dimitri committed
1523 1524 1525 1526 1527
  if (Doxygen::searchIndex)
  {
    Doxygen::searchIndex->setCurrentDoc(pageTitle,getOutputFileBase());
    Doxygen::searchIndex->addWord(localName(),TRUE);
  }
dimitri's avatar
dimitri committed
1528 1529 1530
  bool exampleFlag=hasExamples();

  //---------------------------------------- start flexible part -------------------------------
dimitri's avatar
dimitri committed
1531

dimitri's avatar
dimitri committed
1532 1533 1534 1535
  QListIterator<LayoutDocEntry> eli(
      LayoutDocManager::instance().docEntries(LayoutDocManager::Class));
  LayoutDocEntry *lde;
  for (eli.toFirst();(lde=eli.current());++eli)
mueller's avatar
mueller committed
1536
  {
dimitri's avatar
dimitri committed
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620
    switch (lde->kind())
    {
      case LayoutDocEntry::BriefDesc: 
        writeBriefDescription(ol,exampleFlag);
        break; 
      case LayoutDocEntry::ClassIncludes: 
        writeIncludeFiles(ol);
        break;
      case LayoutDocEntry::ClassInheritanceGraph: 
        writeInheritanceGraph(ol); 
        break; 
      case LayoutDocEntry::ClassCollaborationGraph: 
        writeCollaborationGraph(ol); 
        break; 
      case LayoutDocEntry::ClassAllMembersLink: 
        writeAllMembersLink(ol);
        break;
      case LayoutDocEntry::MemberDeclStart: 
        startMemberDeclarations(ol);
        break; 
      case LayoutDocEntry::MemberGroups: 
        writeMemberGroups(ol);
        break;
      case LayoutDocEntry::MemberDecl: 
        {
          LayoutDocEntryMemberDecl *lmd = (LayoutDocEntryMemberDecl*)lde;
          writeMemberDeclarations(ol,lmd->type,lmd->title,lmd->subscript);
        }
        break; 
      case LayoutDocEntry::ClassNestedClasses: 
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          writeNestedClasses(ol,ls->title);
        }
        break;
      case LayoutDocEntry::MemberDeclEnd: 
        endMemberDeclarations(ol);
        break;
      case LayoutDocEntry::DetailedDesc: 
        {
          LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
          writeDetailedDescription(ol,pageType,exampleFlag,ls->title);
        }
        break; 
      case LayoutDocEntry::MemberDefStart: 
        startMemberDocumentation(ol);
        break; 
      case LayoutDocEntry::MemberDef: 
        {
          LayoutDocEntryMemberDef *lmd = (LayoutDocEntryMemberDef*)lde;
          writeMemberDocumentation(ol,lmd->type,lmd->title);
        }
        break; 
      case LayoutDocEntry::MemberDefEnd: 
        endMemberDocumentation(ol);
        break;
      case LayoutDocEntry::ClassUsedFiles: 
        showUsedFiles(ol);
        break;
      case LayoutDocEntry::AuthorSection: 
        writeAuthorSection(ol);
        break;
      case LayoutDocEntry::NamespaceNestedNamespaces:
      case LayoutDocEntry::NamespaceClasses:
      case LayoutDocEntry::FileClasses:
      case LayoutDocEntry::FileNamespaces:
      case LayoutDocEntry::FileIncludes:
      case LayoutDocEntry::FileIncludeGraph:
      case LayoutDocEntry::FileIncludedByGraph: 
      case LayoutDocEntry::FileSourceLink:
      case LayoutDocEntry::GroupClasses: 
      case LayoutDocEntry::GroupNamespaces:
      case LayoutDocEntry::GroupDirs: 
      case LayoutDocEntry::GroupNestedGroups: 
      case LayoutDocEntry::GroupFiles:
      case LayoutDocEntry::GroupGraph: 
      case LayoutDocEntry::GroupPageDocs:
      case LayoutDocEntry::DirSubDirs:
      case LayoutDocEntry::DirFiles:
      case LayoutDocEntry::DirGraph:
        err("Internal inconsistency: member %d should not be part of "
            "LayoutDocManager::Class entry list\n",lde->kind());
        break;
    }
mueller's avatar
mueller committed
1621
  }
dimitri's avatar
dimitri committed
1622

dimitri's avatar
dimitri committed
1623 1624 1625 1626 1627
  if (!Config_getString("GENERATE_TAGFILE").isEmpty()) 
  {
    writeDocAnchorsToTagFile();
    Doxygen::tagFile << "  </compound>" << endl;
  }
dimitri's avatar
dimitri committed
1628 1629 1630 1631 1632 1633 1634

  ol.endContents();
    
  if (generateTreeView)
  {
    writeNavigationPath(ol);
  }
dimitri's avatar
dimitri committed
1635
 
dimitri's avatar
dimitri committed
1636
  endFile(ol,TRUE);
dimitri's avatar
dimitri committed
1637

dimitri's avatar
dimitri committed
1638 1639
  if (Config_getBool("SEPARATE_MEMBER_PAGES"))
  {
dimitri's avatar
dimitri committed
1640
    writeMemberPages(ol);
dimitri's avatar
dimitri committed
1641 1642
  }
}
dimitri's avatar
dimitri committed
1643

dimitri's avatar
dimitri committed
1644 1645 1646 1647 1648
void ClassDef::writeMemberPages(OutputList &ol)
{
  ///////////////////////////////////////////////////////////////////////////
  //// Member definitions on separate pages
  ///////////////////////////////////////////////////////////////////////////
dimitri's avatar
dimitri committed
1649

dimitri's avatar
dimitri committed
1650 1651 1652
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
  
dimitri's avatar
dimitri committed
1653
  QListIterator<MemberList> mli(m_impl->memberLists);
dimitri's avatar
dimitri committed
1654 1655 1656 1657 1658 1659 1660 1661
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()&MemberList::detailedLists)
    {
      ml->writeDocumentationPage(ol,name(),this);
    }
  }
mueller's avatar
mueller committed
1662

dimitri's avatar
dimitri committed
1663
  ol.popGeneratorState();
dimitri's avatar
dimitri committed
1664
}
dimitri's avatar
dimitri committed
1665

dimitri's avatar
dimitri committed
1666 1667
void ClassDef::writeQuickMemberLinks(OutputList &ol,MemberDef *currentMd) const
{
dimitri's avatar
dimitri committed
1668 1669
  static bool createSubDirs=Config_getBool("CREATE_SUBDIRS");

dimitri's avatar
dimitri committed
1670 1671
  ol.writeString("      <div class=\"navtab\">\n");
  ol.writeString("        <table>\n");
dimitri's avatar
dimitri committed
1672

dimitri's avatar
dimitri committed
1673
  if (m_impl->allMemberNameInfoSDict)
dimitri's avatar
dimitri committed
1674
  {
dimitri's avatar
dimitri committed
1675
    MemberNameInfoSDict::Iterator mnili(*m_impl->allMemberNameInfoSDict);
dimitri's avatar
dimitri committed
1676 1677
    MemberNameInfo *mni;
    for (;(mni=mnili.current());++mnili)
dimitri's avatar
dimitri committed
1678
    {
dimitri's avatar
dimitri committed
1679 1680 1681
      MemberNameInfoIterator mnii(*mni);
      MemberInfo *mi;
      for (mnii.toFirst();(mi=mnii.current());++mnii)
dimitri's avatar
dimitri committed
1682
      {
dimitri's avatar
dimitri committed
1683 1684
        MemberDef *md=mi->memberDef;
        if (md->getClassDef()==this && md->isLinkable())
dimitri's avatar
dimitri committed
1685
        {
dimitri's avatar
dimitri committed
1686 1687
          ol.writeString("          <tr><td class=\"navtab\">");
          if (md->isLinkableInProject())
dimitri's avatar
dimitri committed
1688
          {
dimitri's avatar
dimitri committed
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702
            if (md==currentMd) // selected item => highlight
            {
              ol.writeString("<a class=\"qindexHL\" ");
            }
            else
            {
              ol.writeString("<a class=\"qindex\" ");
            }
            ol.writeString("href=\"");
            if (createSubDirs) ol.writeString("../../");
            ol.writeString(md->getOutputFileBase()+Doxygen::htmlFileExtension+"#"+md->anchor());
            ol.writeString("\">");
            ol.writeString(md->name());
            ol.writeString("</a>");
dimitri's avatar
dimitri committed
1703
          }
dimitri's avatar
dimitri committed
1704
          ol.writeString("</td></tr>\n");
dimitri's avatar
dimitri committed
1705 1706 1707
        }
      }
    }
dimitri's avatar
dimitri committed
1708
  }
dimitri's avatar
dimitri committed
1709

dimitri's avatar
dimitri committed
1710 1711
  ol.writeString("        </table>\n");
  ol.writeString("      </div>\n");
dimitri's avatar
dimitri committed
1712
}
dimitri's avatar
dimitri committed
1713

dimitri's avatar
dimitri committed
1714 1715


dimitri's avatar
dimitri committed
1716 1717
void ClassDef::writeDocumentationForInnerClasses(OutputList &ol)
{
dimitri's avatar
dimitri committed
1718 1719
  // write inner classes after the parent, so the tag files contain
  // the definition in proper order!
dimitri's avatar
dimitri committed
1720
  if (m_impl->innerClasses)
dimitri's avatar
dimitri committed
1721
  {
dimitri's avatar
dimitri committed
1722
    ClassSDict::Iterator cli(*m_impl->innerClasses);
dimitri's avatar
dimitri committed
1723 1724 1725
    ClassDef *innerCd;
    for (cli.toFirst();(innerCd=cli.current());++cli)
    {
dimitri's avatar
dimitri committed
1726 1727 1728
      if (innerCd->isLinkableInProject() && innerCd->templateMaster()==0 &&
          (innerCd->protection()!=Private || Config_getBool("EXTRACT_PRIVATE"))
         )
dimitri's avatar
dimitri committed
1729
      {
dimitri's avatar
dimitri committed
1730
        msg("Generating docs for nested compound %s...\n",qPrint(innerCd->name()));
dimitri's avatar
dimitri committed
1731
        innerCd->writeDocumentation(ol);
dimitri's avatar
dimitri committed
1732
        innerCd->writeMemberList(ol);
dimitri's avatar
dimitri committed
1733
      }
dimitri's avatar
dimitri committed
1734
      innerCd->writeDocumentationForInnerClasses(ol);
dimitri's avatar
dimitri committed
1735 1736
    }
  }
mueller's avatar
mueller committed
1737 1738 1739 1740 1741
}

// write the list of all (inherited) members for this class
void ClassDef::writeMemberList(OutputList &ol)
{
dimitri's avatar
dimitri committed
1742 1743
  static bool cOpt    = Config_getBool("OPTIMIZE_OUTPUT_FOR_C");
  static bool vhdlOpt = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
dimitri's avatar
dimitri committed
1744
  static bool generateTreeView = Config_getBool("GENERATE_TREEVIEW");
dimitri's avatar
dimitri committed
1745
  if (m_impl->allMemberNameInfoSDict==0 || cOpt) return;
dimitri's avatar
dimitri committed
1746 1747
  // only for HTML
  ol.pushGeneratorState();
mueller's avatar
mueller committed
1748
  ol.disableAllBut(OutputGenerator::Html);
dimitri's avatar
dimitri committed
1749

dimitri's avatar
dimitri committed
1750
  QCString memListFile = getMemberListFileName();
dimitri's avatar
dimitri committed
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760
  startFile(ol,memListFile,memListFile,theTranslator->trMemberList(),
            HLI_ClassVisible,!generateTreeView,getOutputFileBase());  
  if (!generateTreeView)
  {
    if (getOuterScope()!=Doxygen::globalScope)
    {
      writeNavigationPath(ol);
    }
    ol.endQuickIndices();
  }
mueller's avatar
mueller committed
1761
  startTitle(ol,0);
dimitri's avatar
dimitri committed
1762
  ol.parseText(displayName()+" "+theTranslator->trMemberList());
mueller's avatar
mueller committed
1763
  endTitle(ol,0,0);
dimitri's avatar
dimitri committed
1764
  ol.startContents();
dimitri's avatar
dimitri committed
1765
  ol.parseText(theTranslator->trThisIsTheListOfAllMembers());
dimitri's avatar
dimitri committed
1766
  ol.writeObjectLink(getReference(),getOutputFileBase(),0,displayName());
dimitri's avatar
dimitri committed
1767
  ol.parseText(theTranslator->trIncludingInheritedMembers());
mueller's avatar
mueller committed
1768
  
dimitri's avatar
dimitri committed
1769
  //ol.startItemList();
dimitri's avatar
dimitri committed
1770
  ol.writeString("<table>\n");
mueller's avatar
mueller committed
1771
  
dimitri's avatar
dimitri committed
1772 1773
  //MemberNameInfo *mni=m_impl->allMemberNameInfoList->first();
  MemberNameInfoSDict::Iterator mnii(*m_impl->allMemberNameInfoSDict); 
dimitri's avatar
dimitri committed
1774 1775
  MemberNameInfo *mni;
  for (mnii.toFirst();(mni=mnii.current());++mnii)
mueller's avatar
mueller committed
1776 1777 1778 1779 1780
  {
    MemberInfo *mi=mni->first();
    while (mi)
    {
      MemberDef *md=mi->memberDef;
dimitri's avatar
dimitri committed
1781
      ClassDef  *cd=md->getClassDef();
dimitri's avatar
dimitri committed
1782
      Protection prot = mi->prot;
dimitri's avatar
dimitri committed
1783
      Specifier virt=md->virtualness();
mueller's avatar
mueller committed
1784
      
dimitri's avatar
dimitri committed
1785 1786
      //printf("%s: Member %s of class %s md->protection()=%d mi->prot=%d prot=%d inherited=%d\n",
      //    name().data(),md->name().data(),cd->name().data(),md->protection(),mi->prot,prot,mi->inherited);
mueller's avatar
mueller committed
1787 1788


dimitri's avatar
dimitri committed
1789
      if (cd && !md->name().isEmpty() && md->name()[0]!='@')
mueller's avatar
mueller committed
1790 1791
      {
        bool memberWritten=FALSE;
mueller's avatar
mueller committed
1792
        if (cd->isLinkable() && md->isLinkable()) 
mueller's avatar
mueller committed
1793 1794
          // create a link to the documentation
        {
mueller's avatar
mueller committed
1795
          QCString name=mi->ambiguityResolutionScope+md->name();
dimitri's avatar
dimitri committed
1796
          //ol.writeListItem();
dimitri's avatar
dimitri committed
1797
          ol.writeString("  <tr class=\"memlist\"><td>");
dimitri's avatar
dimitri committed
1798 1799 1800 1801 1802
          if (cd->isObjectiveC())
          {
            if (md->isObjCMethod())
            {
              if (md->isStatic())
dimitri's avatar
dimitri committed
1803
                ol.writeString("+&#160;</td><td>");
dimitri's avatar
dimitri committed
1804
              else
dimitri's avatar
dimitri committed
1805
                ol.writeString("-&#160;</td><td>");
dimitri's avatar
dimitri committed
1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836
            }
            else
              ol.writeString("</td><td>");
          }
          if (md->isObjCMethod())
          {
            ol.writeObjectLink(md->getReference(),
                md->getOutputFileBase(),
                md->anchor(),md->name());
          }
          else
          {
            //Definition *bd = md->getGroupDef();
            //if (bd==0) bd=cd;
            ol.writeObjectLink(md->getReference(),
                md->getOutputFileBase(),
                md->anchor(),name);

            if ( md->isFunction() || md->isSignal() || md->isSlot() ||
                (md->isFriend() && md->argsString())) 
              ol.docify(md->argsString());
            else if (md->isEnumerate())
              ol.parseText(" "+theTranslator->trEnumName());
            else if (md->isEnumValue())
              ol.parseText(" "+theTranslator->trEnumValue());
            else if (md->isTypedef())
              ol.docify(" typedef");
            else if (md->isFriend() && !strcmp(md->typeString(),"friend class"))
              ol.docify(" class");
            //ol.writeString("\n");
          }
dimitri's avatar
dimitri committed
1837
          ol.writeString("</td>");
mueller's avatar
mueller committed
1838 1839
          memberWritten=TRUE;
        }
dimitri's avatar
dimitri committed
1840 1841 1842 1843
        else if (!Config_getBool("HIDE_UNDOC_MEMBERS") && 
                  (md->protection()!=Private || Config_getBool("EXTRACT_PRIVATE") || md->isFriend()) 
                ) // no documentation, 
                  // generate link to the class instead.
mueller's avatar
mueller committed
1844
        {
dimitri's avatar
dimitri committed
1845 1846
          //ol.writeListItem();
          ol.writeString("  <tr bgcolor=\"#f0f0f0\"><td>");
dimitri's avatar
dimitri committed
1847 1848 1849 1850 1851
          if (cd->isObjectiveC())
          {
            if (md->isObjCMethod())
            {
              if (md->isStatic())
dimitri's avatar
dimitri committed
1852
                ol.writeString("+&#160;</td><td>");
dimitri's avatar
dimitri committed
1853
              else
dimitri's avatar
dimitri committed
1854
                ol.writeString("-&#160;</td><td>");
dimitri's avatar
dimitri committed
1855 1856 1857 1858
            }
            else
              ol.writeString("</td><td>");
          }
dimitri's avatar
dimitri committed
1859 1860 1861
          ol.startBold();
          ol.docify(md->name());
          ol.endBold();
dimitri's avatar
dimitri committed
1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872
          if (!md->isObjCMethod())
          {
            if ( md->isFunction() || md->isSignal() || md->isSlot() ) 
              ol.docify(md->argsString());
            else if (md->isEnumerate())
              ol.parseText(" "+theTranslator->trEnumName());
            else if (md->isEnumValue())
              ol.parseText(" "+theTranslator->trEnumValue());
            else if (md->isTypedef())
              ol.docify(" typedef");
          }
mueller's avatar
mueller committed
1873
          ol.writeString(" (");
dimitri's avatar
dimitri committed
1874
          ol.parseText(theTranslator->trDefinedIn()+" ");
mueller's avatar
mueller committed
1875
          if (cd->isLinkable())
mueller's avatar
mueller committed
1876
          {
dimitri's avatar
dimitri committed
1877 1878 1879 1880 1881
            ol.writeObjectLink(
                cd->getReference(),
                cd->getOutputFileBase(),
                0,
                cd->displayName());
mueller's avatar
mueller committed
1882 1883 1884
          }
          else
          {
dimitri's avatar
dimitri committed
1885
            ol.startBold();
dimitri's avatar
dimitri committed
1886
            ol.docify(cd->displayName());
dimitri's avatar
dimitri committed
1887
            ol.endBold();
mueller's avatar
mueller committed
1888 1889
          }
          ol.writeString(")");
dimitri's avatar
dimitri committed
1890
          ol.writeString("</td>");
mueller's avatar
mueller committed
1891 1892
          memberWritten=TRUE;
        }
dimitri's avatar
dimitri committed
1893 1894 1895
        if (memberWritten)
        {
          ol.writeString("<td>");
dimitri's avatar
dimitri committed
1896 1897 1898
          ol.writeObjectLink(cd->getReference(),
                             cd->getOutputFileBase(),
                             0,
dimitri's avatar
dimitri committed
1899 1900 1901
                             md->category() ? 
                                md->category()->displayName() : 
                                cd->displayName());
dimitri's avatar
dimitri committed
1902 1903 1904
          ol.writeString("</td>");
          ol.writeString("<td>");
        }
dimitri's avatar
dimitri committed
1905
        if (
dimitri's avatar
dimitri committed
1906
            (prot!=Public || (virt!=Normal && m_impl->lang!=SrcLangExt_ObjC) || 
dimitri's avatar
dimitri committed
1907
             md->isFriend() || md->isRelated() || md->isExplicit() ||
dimitri's avatar
dimitri committed
1908
             md->isMutable() || (md->isInline() && Config_getBool("INLINE_INFO")) ||
dimitri's avatar
dimitri committed
1909
             md->isSignal() || md->isSlot() ||
dimitri's avatar
dimitri committed
1910
             md->isStatic() || vhdlOpt
mueller's avatar
mueller committed
1911 1912 1913 1914 1915 1916
            )
            && memberWritten)
        {
          ol.startTypewriter();
          ol.docify(" [");
          QStrList sl;
dimitri's avatar
dimitri committed
1917 1918 1919
          if (vhdlOpt) sl.append(VhdlDocGen::trVhdlType(
                          md->getMemberSpecifiers())); //append vhdl type
          else if (md->isFriend()) sl.append("friend");
mueller's avatar
mueller committed
1920 1921 1922
          else if (md->isRelated()) sl.append("related");
          else
          {
dimitri's avatar
dimitri committed
1923
            if (Config_getBool("INLINE_INFO") && md->isInline())        
mueller's avatar
mueller committed
1924
                                       sl.append("inline");
dimitri's avatar
dimitri committed
1925 1926
            if (md->isExplicit())      sl.append("explicit");
            if (md->isMutable())       sl.append("mutable");
dimitri's avatar
dimitri committed
1927 1928
            if (prot==Protected)       sl.append("protected");
            else if (prot==Private)    sl.append("private");
dimitri's avatar
dimitri committed
1929
            else if (prot==Package)    sl.append("package");
dimitri's avatar
dimitri committed
1930
            if (virt==Virtual && 
dimitri's avatar
dimitri committed
1931
                m_impl->lang!=SrcLangExt_ObjC)             sl.append("virtual");
mueller's avatar
mueller committed
1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946
            else if (virt==Pure)       sl.append("pure virtual");
            if (md->isStatic())        sl.append("static");
            if (md->isSignal())        sl.append("signal");
            if (md->isSlot())          sl.append("slot");
          }
          const char *s=sl.first();
          while (s)
          {
            ol.docify(s);
            s=sl.next();
            if (s) ol.docify(", ");
          }
          ol.docify("]");
          ol.endTypewriter();
        }
dimitri's avatar
dimitri committed
1947 1948 1949 1950 1951
        if (memberWritten)
        {
          ol.writeString("</td>");
          ol.writeString("</tr>\n");
        }
mueller's avatar
mueller committed
1952 1953 1954 1955
      }
      mi=mni->next();
    }
  }
dimitri's avatar
dimitri committed
1956 1957 1958 1959
  //ol.endItemList();

  ol.writeString("</table>");
  
mueller's avatar
mueller committed
1960
  endFile(ol);
dimitri's avatar
dimitri committed
1961
  ol.popGeneratorState();
mueller's avatar
mueller committed
1962 1963 1964 1965 1966 1967 1968
}


// add a reference to an example
bool ClassDef::addExample(const char *anchor,const char *nameStr,
    const char *file)
{
dimitri's avatar
dimitri committed
1969
  if (m_impl->exampleSDict==0)
dimitri's avatar
dimitri committed
1970
  {
dimitri's avatar
dimitri committed
1971 1972
    m_impl->exampleSDict = new ExampleSDict;
    m_impl->exampleSDict->setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
1973
  }
dimitri's avatar
dimitri committed
1974
  if (!m_impl->exampleSDict->find(nameStr))
mueller's avatar
mueller committed
1975 1976 1977 1978 1979
  {
    Example *e=new Example;
    e->anchor=anchor;
    e->name=nameStr;
    e->file=file;
dimitri's avatar
dimitri committed
1980
    m_impl->exampleSDict->inSort(nameStr,e);
mueller's avatar
mueller committed
1981 1982 1983 1984 1985 1986 1987 1988
    return TRUE;
  }
  return FALSE;
}

// returns TRUE if this class is used in an example
bool ClassDef::hasExamples()
{
dimitri's avatar
dimitri committed
1989
  if (m_impl->exampleSDict==0) 
mueller's avatar
mueller committed
1990 1991
    return FALSE;
  else
dimitri's avatar
dimitri committed
1992
    return m_impl->exampleSDict->count()>0;
mueller's avatar
mueller committed
1993 1994 1995 1996 1997 1998
}


void ClassDef::setTemplateArguments(ArgumentList *al)
{
  if (al==0) return;
dimitri's avatar
dimitri committed
1999 2000
  if (!m_impl->tempArgs) delete m_impl->tempArgs; // delete old list if needed
  m_impl->tempArgs=new ArgumentList; 
mueller's avatar
mueller committed
2001 2002 2003 2004
  ArgumentListIterator ali(*al);
  Argument *a;
  for (;(a=ali.current());++ali)
  {
dimitri's avatar
dimitri committed
2005
    m_impl->tempArgs->append(new Argument(*a));
mueller's avatar
mueller committed
2006 2007 2008
  }
}

dimitri's avatar
dimitri committed
2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021
void ClassDef::setTypeConstraints(ArgumentList *al)
{
  if (al==0) return;
  if (!m_impl->typeConstraints) delete m_impl->typeConstraints;
  m_impl->typeConstraints = new ArgumentList;
  ArgumentListIterator ali(*al);
  Argument *a;
  for (;(a=ali.current());++ali)
  {
    m_impl->typeConstraints->append(new Argument(*a));
  }
}

dimitri's avatar
dimitri committed
2022 2023 2024
/*! Returns \c TRUE iff this class or a class inheriting from this class
 *  is \e not defined in an external tag file. 
 */
mueller's avatar
mueller committed
2025 2026
bool ClassDef::hasNonReferenceSuperClass()
{
dimitri's avatar
dimitri committed
2027
  bool found=!isReference() && isLinkableInProject() && !isHidden(); 
dimitri's avatar
dimitri committed
2028 2029 2030 2031
  if (found) 
  {
    return TRUE; // we're done if this class is not a reference
  }
dimitri's avatar
dimitri committed
2032
  if (m_impl->inheritedBy)
dimitri's avatar
dimitri committed
2033
  {
dimitri's avatar
dimitri committed
2034
    BaseClassListIterator bcli(*m_impl->inheritedBy);
dimitri's avatar
dimitri committed
2035
    for ( ; bcli.current() && !found ; ++bcli ) // for each super class
dimitri's avatar
dimitri committed
2036
    {
dimitri's avatar
dimitri committed
2037 2038 2039 2040
      ClassDef *bcd=bcli.current()->classDef;
      // recurse into the super class branch
      found = found || bcd->hasNonReferenceSuperClass(); 
      if (!found)
dimitri's avatar
dimitri committed
2041
      {
dimitri's avatar
dimitri committed
2042 2043 2044
        // look for template instances that might have non-reference super classes
        QDict<ClassDef> *cil = bcd->getTemplateInstances();
        if (cil)
dimitri's avatar
dimitri committed
2045
        {
dimitri's avatar
dimitri committed
2046 2047 2048 2049 2050 2051
          QDictIterator<ClassDef> tidi(*cil);
          for ( ; tidi.current() && !found ; ++tidi) // for each template instance
          {
            // recurse into the template instance branch
            found = found || tidi.current()->hasNonReferenceSuperClass();
          }
dimitri's avatar
dimitri committed
2052 2053 2054 2055
        }
      }
    }
  }
mueller's avatar
mueller committed
2056 2057
  return found;
}
mueller's avatar
mueller committed
2058

dimitri's avatar
dimitri committed
2059
/*! called from MemberDef::writeDeclaration() to (recusively) write the 
dimitri's avatar
dimitri committed
2060
 *  definition of an anonymous struct, union or class.
dimitri's avatar
dimitri committed
2061
 */
dimitri's avatar
dimitri committed
2062
void ClassDef::writeDeclaration(OutputList &ol,MemberDef *md,bool inGroup)
mueller's avatar
mueller committed
2063 2064
{
  //ol.insertMemberAlign();
dimitri's avatar
dimitri committed
2065 2066
  //printf("ClassName=`%s' inGroup=%d\n",name().data(),inGroup);

dimitri's avatar
dimitri committed
2067 2068
  //if (inGroup && md && md->getClassDef()==this) return;

dimitri's avatar
dimitri committed
2069
  ol.docify(compoundTypeString());
mueller's avatar
mueller committed
2070 2071 2072 2073 2074
  int ri=name().findRev("::");
  if (ri==-1) ri=name().length();
  QCString cn=name().right(name().length()-ri-2);
  if (!cn.isEmpty() && cn.at(0)!='@' && md)
  { 
dimitri's avatar
dimitri committed
2075 2076 2077 2078
    if (cn.right(2)=="-p" || cn.right(2)=="-g")
    {
      cn = cn.left(cn.length()-2);
    }
mueller's avatar
mueller committed
2079
    ol.docify(" ");
dimitri's avatar
dimitri committed
2080 2081 2082 2083 2084 2085 2086 2087 2088 2089
    if (isLinkable())
    {
      ol.writeObjectLink(0,0,md->anchor(),cn);
    }
    else
    {
      ol.startBold();
      ol.docify(cn);
      ol.endBold();
    }
mueller's avatar
mueller committed
2090 2091
  }
  ol.docify(" {");
dimitri's avatar
dimitri committed
2092
  ol.endMemberItem(); 
mueller's avatar
mueller committed
2093

dimitri's avatar
dimitri committed
2094
  // write user defined member groups
dimitri's avatar
dimitri committed
2095
  if (m_impl->memberGroupSDict)
dimitri's avatar
dimitri committed
2096
  {
dimitri's avatar
dimitri committed
2097
    MemberGroupSDict::Iterator mgli(*m_impl->memberGroupSDict);
dimitri's avatar
dimitri committed
2098 2099 2100 2101 2102 2103 2104 2105
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      mg->setInGroup(inGroup);
      mg->writePlainDeclarations(ol,this,0,0,0);
    }
  }

dimitri's avatar
dimitri committed
2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126
  writePlainMemberDeclaration(ol,MemberList::pubTypes,inGroup);
  writePlainMemberDeclaration(ol,MemberList::pubMethods,inGroup);
  writePlainMemberDeclaration(ol,MemberList::pubAttribs,inGroup);
  writePlainMemberDeclaration(ol,MemberList::pubSlots,inGroup);
  writePlainMemberDeclaration(ol,MemberList::signals,inGroup);
  writePlainMemberDeclaration(ol,MemberList::dcopMethods,inGroup);
  writePlainMemberDeclaration(ol,MemberList::properties,inGroup);
  writePlainMemberDeclaration(ol,MemberList::events,inGroup);
  writePlainMemberDeclaration(ol,MemberList::pubStaticMethods,inGroup);
  writePlainMemberDeclaration(ol,MemberList::pubStaticAttribs,inGroup);
  writePlainMemberDeclaration(ol,MemberList::proTypes,inGroup);
  writePlainMemberDeclaration(ol,MemberList::proMethods,inGroup);
  writePlainMemberDeclaration(ol,MemberList::proAttribs,inGroup);
  writePlainMemberDeclaration(ol,MemberList::proSlots,inGroup);
  writePlainMemberDeclaration(ol,MemberList::proStaticMethods,inGroup);
  writePlainMemberDeclaration(ol,MemberList::proStaticAttribs,inGroup);
  writePlainMemberDeclaration(ol,MemberList::pacTypes,inGroup);
  writePlainMemberDeclaration(ol,MemberList::pacMethods,inGroup);
  writePlainMemberDeclaration(ol,MemberList::pacAttribs,inGroup);
  writePlainMemberDeclaration(ol,MemberList::pacStaticMethods,inGroup);
  writePlainMemberDeclaration(ol,MemberList::pacStaticAttribs,inGroup);
dimitri's avatar
dimitri committed
2127
  if (Config_getBool("EXTRACT_PRIVATE"))
dimitri's avatar
dimitri committed
2128
  {
dimitri's avatar
dimitri committed
2129 2130 2131 2132 2133 2134 2135 2136 2137
    writePlainMemberDeclaration(ol,MemberList::priTypes,inGroup);
    writePlainMemberDeclaration(ol,MemberList::priMethods,inGroup);
    writePlainMemberDeclaration(ol,MemberList::priAttribs,inGroup);
    writePlainMemberDeclaration(ol,MemberList::priSlots,inGroup);
    writePlainMemberDeclaration(ol,MemberList::priStaticMethods,inGroup);
    writePlainMemberDeclaration(ol,MemberList::priStaticAttribs,inGroup);
  }
  writePlainMemberDeclaration(ol,MemberList::friends,inGroup);
  writePlainMemberDeclaration(ol,MemberList::related,inGroup);
mueller's avatar
mueller committed
2138
}
mueller's avatar
mueller committed
2139 2140

/*! a link to this class is possible within this project */
dimitri's avatar
dimitri committed
2141
bool ClassDef::isLinkableInProject() const
mueller's avatar
mueller committed
2142
{ 
dimitri's avatar
dimitri committed
2143 2144 2145 2146
  static bool extractPrivate = Config_getBool("EXTRACT_PRIVATE");
  static bool extractLocal   = Config_getBool("EXTRACT_LOCAL_CLASSES");
  static bool extractStatic  = Config_getBool("EXTRACT_STATIC");
  static bool hideUndoc      = Config_getBool("HIDE_UNDOC_CLASSES");
dimitri's avatar
dimitri committed
2147
  if (m_impl->templateMaster)
dimitri's avatar
dimitri committed
2148
  {
dimitri's avatar
dimitri committed
2149
    return m_impl->templateMaster->isLinkableInProject();
dimitri's avatar
dimitri committed
2150 2151 2152
  }
  else
  {
dimitri's avatar
dimitri committed
2153 2154 2155 2156 2157 2158 2159 2160
    return !name().isEmpty() &&                    /* has a name */
      !isArtificial() && !isHidden() &&            /* not hidden */
      name().find('@')==-1 &&                      /* not anonymous */
      (m_impl->prot!=Private || extractPrivate) && /* private */
      (!m_impl->isLocal      || extractLocal)   && /* local */
      (hasDocumentation()    || !hideUndoc)     && /* documented */ 
      (!m_impl->isStatic     || extractStatic)  && /* static */
      !isReference();                 /* not an external reference */
dimitri's avatar
dimitri committed
2161 2162 2163 2164 2165
  }
}

bool ClassDef::isLinkable() const
{
dimitri's avatar
dimitri committed
2166
  if (m_impl->templateMaster)
dimitri's avatar
dimitri committed
2167
  {
dimitri's avatar
dimitri committed
2168
    return m_impl->templateMaster->isLinkable();
dimitri's avatar
dimitri committed
2169 2170 2171 2172 2173
  }
  else
  {
    return isLinkableInProject() || isReference();
  }
mueller's avatar
mueller committed
2174 2175
}

dimitri's avatar
dimitri committed
2176

mueller's avatar
mueller committed
2177 2178
/*! the class is visible in a class diagram, or class hierarchy */
bool ClassDef::isVisibleInHierarchy() 
dimitri's avatar
dimitri committed
2179
{ 
dimitri's avatar
dimitri committed
2180 2181 2182 2183 2184 2185 2186
  static bool allExternals     = Config_getBool("ALLEXTERNALS");
  static bool extractPrivate   = Config_getBool("EXTRACT_PRIVATE");
  static bool hideUndocClasses = Config_getBool("HIDE_UNDOC_CLASSES");
  static bool extractStatic    = Config_getBool("EXTRACT_STATIC");

  return // show all classes or a subclass is visible
      (allExternals || hasNonReferenceSuperClass()) &&
dimitri's avatar
dimitri committed
2187
      // and not an anonymous compound
dimitri's avatar
dimitri committed
2188
      name().find('@')==-1 &&
dimitri's avatar
dimitri committed
2189
      // not an artificially introduced class
dimitri's avatar
dimitri committed
2190
      !isArtificial() &&
dimitri's avatar
dimitri committed
2191
      // and not privately inherited
dimitri's avatar
dimitri committed
2192
      (m_impl->prot!=Private || extractPrivate) &&
dimitri's avatar
dimitri committed
2193 2194
      // documented or shown anyway or documentation is external 
      (hasDocumentation() || 
dimitri's avatar
dimitri committed
2195
       !hideUndocClasses || 
dimitri's avatar
dimitri committed
2196
       (m_impl->templateMaster && m_impl->templateMaster->hasDocumentation()) || 
dimitri's avatar
dimitri committed
2197
       isReference()
dimitri's avatar
dimitri committed
2198 2199
      ) &&
      // is not part of an unnamed namespace or shown anyway
dimitri's avatar
dimitri committed
2200
      (!m_impl->isStatic || extractStatic);
mueller's avatar
mueller committed
2201
}
dimitri's avatar
dimitri committed
2202

dimitri's avatar
dimitri committed
2203 2204 2205 2206 2207
bool ClassDef::hasDocumentation() const
{
  return Definition::hasDocumentation();
}

dimitri's avatar
dimitri committed
2208 2209 2210 2211 2212
//----------------------------------------------------------------------
// recursive function:
// returns TRUE iff class definition `bcd' represents an (in)direct base 
// class of class definition `cd'.

dimitri's avatar
dimitri committed
2213
bool ClassDef::isBaseClass(ClassDef *bcd, bool followInstances,int level)
dimitri's avatar
dimitri committed
2214 2215
{
  bool found=FALSE;
dimitri's avatar
dimitri committed
2216
  //printf("isBaseClass(cd=%s) looking for %s\n",name().data(),bcd->name().data());
dimitri's avatar
dimitri committed
2217 2218
  if (level>256)
  {
dimitri's avatar
dimitri committed
2219
    err("Possible recursive class relation while inside %s and looking for %s\n",qPrint(name()),qPrint(bcd->name()));
dimitri's avatar
dimitri committed
2220
    abort();
dimitri's avatar
dimitri committed
2221 2222
    return FALSE;
  }
dimitri's avatar
dimitri committed
2223
  if (baseClasses())
dimitri's avatar
dimitri committed
2224
  {
dimitri's avatar
dimitri committed
2225 2226 2227 2228
    // Beware: trying to optimise the iterator away using ->first() & ->next()
    // causes bug 625531
    BaseClassListIterator bcli(*baseClasses());
    for ( ; bcli.current() && !found ; ++bcli)
dimitri's avatar
dimitri committed
2229
    {
dimitri's avatar
dimitri committed
2230
      ClassDef *ccd=bcli.current()->classDef;
dimitri's avatar
dimitri committed
2231 2232 2233 2234 2235 2236 2237
      if (!followInstances && ccd->templateMaster()) ccd=ccd->templateMaster();
      //printf("isBaseClass() baseclass %s\n",ccd->name().data());
      if (ccd==bcd) 
        found=TRUE;
      else 
        found=ccd->isBaseClass(bcd,followInstances,level+1);
    }
dimitri's avatar
dimitri committed
2238 2239 2240 2241 2242
  }
  return found;
}

//----------------------------------------------------------------------------
dimitri's avatar
dimitri committed
2243 2244 2245 2246

static bool isStandardFunc(MemberDef *md)
{
  return md->name()=="operator=" || // assignment operator
dimitri's avatar
dimitri committed
2247 2248
         md->isConstructor() ||     // constructor
         md->isDestructor();        // destructor
dimitri's avatar
dimitri committed
2249 2250
}

dimitri's avatar
dimitri committed
2251 2252 2253
/*! 
 * recusively merges the `all members' lists of a class base 
 * with that of this class. Must only be called for classes without
dimitri's avatar
dimitri committed
2254
 * subclasses!
dimitri's avatar
dimitri committed
2255
 */
dimitri's avatar
dimitri committed
2256
void ClassDef::mergeMembers()
dimitri's avatar
dimitri committed
2257
{
dimitri's avatar
dimitri committed
2258
  if (m_impl->membersMerged) return;
dimitri's avatar
dimitri committed
2259 2260 2261 2262 2263 2264 2265

  static bool optimizeOutputForJava = Config_getBool("OPTIMIZE_OUTPUT_JAVA");
  static bool vhdlOpt = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
  QCString sep="::";
  if (optimizeOutputForJava || vhdlOpt) sep=".";
  int sepLen = sep.length();

dimitri's avatar
dimitri committed
2266
  m_impl->membersMerged=TRUE;
dimitri's avatar
dimitri committed
2267 2268
  //printf("  mergeMembers for %s\n",name().data());
  bool inlineInheritedMembers = Config_getBool("INLINE_INHERITED_MEMB" );
dimitri's avatar
dimitri committed
2269
  if (baseClasses())
dimitri's avatar
dimitri committed
2270
  {
dimitri's avatar
dimitri committed
2271
    //printf("  => has base classes!\n");
dimitri's avatar
dimitri committed
2272 2273 2274 2275 2276
    BaseClassListIterator bcli(*baseClasses());
    BaseClassDef *bcd;
    for ( ; (bcd=bcli.current()) ; ++bcli )
    {
      ClassDef *bClass=bcd->classDef; 
dimitri's avatar
dimitri committed
2277

dimitri's avatar
dimitri committed
2278 2279
      // merge the members in the base class of this inheritance branch first
      bClass->mergeMembers();
dimitri's avatar
dimitri committed
2280

dimitri's avatar
dimitri committed
2281
      MemberNameInfoSDict *srcMnd  = bClass->memberNameInfoSDict();
dimitri's avatar
dimitri committed
2282
      MemberNameInfoSDict *dstMnd  = m_impl->allMemberNameInfoSDict;
dimitri's avatar
dimitri committed
2283

dimitri's avatar
dimitri committed
2284
      if (srcMnd)
dimitri's avatar
dimitri committed
2285
      {
dimitri's avatar
dimitri committed
2286 2287 2288
        MemberNameInfoSDict::Iterator srcMnili(*srcMnd);
        MemberNameInfo *srcMni;
        for ( ; (srcMni=srcMnili.current()) ; ++srcMnili)
dimitri's avatar
dimitri committed
2289
        {
dimitri's avatar
dimitri committed
2290
          //printf("    Base member name %s\n",srcMni->memberName());
dimitri's avatar
dimitri committed
2291
          MemberNameInfo *dstMni;
dimitri's avatar
dimitri committed
2292
          if (dstMnd!=0 && (dstMni=dstMnd->find(srcMni->memberName())))
dimitri's avatar
dimitri committed
2293 2294 2295 2296
            // a member with that name is already in the class.
            // the member may hide or reimplement the one in the sub class
            // or there may be another path to the base class that is already 
            // visited via another branch in the class hierarchy.
dimitri's avatar
dimitri committed
2297
          {
dimitri's avatar
dimitri committed
2298 2299 2300
            MemberNameInfoIterator srcMnii(*srcMni); 
            MemberInfo *srcMi;
            for ( ; (srcMi=srcMnii.current()) ; ++srcMnii )
dimitri's avatar
dimitri committed
2301
            {
dimitri's avatar
dimitri committed
2302 2303 2304 2305 2306 2307 2308 2309
              MemberDef *srcMd = srcMi->memberDef;
              bool found=FALSE;
              bool ambigue=FALSE;
              bool hidden=FALSE;
              MemberNameInfoIterator dstMnii(*dstMni); 
              MemberInfo *dstMi;
              ClassDef *srcCd = srcMd->getClassDef();
              for ( ; (dstMi=dstMnii.current()) && !found; ++dstMnii )
dimitri's avatar
dimitri committed
2310
              {
dimitri's avatar
dimitri committed
2311 2312 2313 2314 2315 2316 2317 2318
                MemberDef *dstMd = dstMi->memberDef;
                if (srcMd!=dstMd) // different members
                {
                  ClassDef *dstCd = dstMd->getClassDef();
                  //printf("  Is %s a base class of %s?\n",srcCd->name().data(),dstCd->name().data());
                  if (srcCd==dstCd || dstCd->isBaseClass(srcCd,TRUE)) 
                    // member is in the same or a base class
                  {
dimitri's avatar
dimitri committed
2319 2320
                    LockingPtr<ArgumentList> srcAl = srcMd->argumentList();
                    LockingPtr<ArgumentList> dstAl = dstMd->argumentList();
dimitri's avatar
dimitri committed
2321
                    found=matchArguments2(
dimitri's avatar
dimitri committed
2322 2323
                        srcMd->getOuterScope(),srcMd->getFileDef(),srcAl.pointer(),
                        dstMd->getOuterScope(),dstMd->getFileDef(),dstAl.pointer(),
dimitri's avatar
dimitri committed
2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339
                        TRUE
                        );
                    //printf("  Yes, matching (%s<->%s): %d\n",
                    //    argListToString(srcMd->argumentList()).data(),
                    //    argListToString(dstMd->argumentList()).data(),
                    //    found);
                    hidden = hidden  || !found;
                  }
                  else // member is in a non base class => multiple inheritance
                    // using the same base class.
                  {
                    //printf("$$ Existing member %s %s add scope %s\n",
                    //    dstMi->ambiguityResolutionScope.data(),
                    //    dstMd->name().data(),
                    //    dstMi->scopePath.left(dstMi->scopePath.find("::")+2).data());

dimitri's avatar
dimitri committed
2340
                    QCString scope=dstMi->scopePath.left(dstMi->scopePath.find(sep)+sepLen);
dimitri's avatar
dimitri committed
2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352
                    if (scope!=dstMi->ambiguityResolutionScope.left(scope.length()))
                      dstMi->ambiguityResolutionScope.prepend(scope);
                    ambigue=TRUE;
                  }
                }
                else // same members
                {
                  // do not add if base class is virtual or 
                  // if scope paths are equal or
                  // if base class is an interface (and thus implicitly virtual).
                  //printf("same member found srcMi->virt=%d dstMi->virt=%d\n",srcMi->virt,dstMi->virt);
                  if ((srcMi->virt!=Normal && dstMi->virt!=Normal) ||
dimitri's avatar
dimitri committed
2353
                      bClass->name()+sep+srcMi->scopePath == dstMi->scopePath ||
dimitri's avatar
dimitri committed
2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366
                      dstMd->getClassDef()->compoundType()==Interface
                     ) 
                  {
                    found=TRUE;
                  }
                  else // member can be reached via multiple paths in the 
                    // inheritance tree
                  {
                    //printf("$$ Existing member %s %s add scope %s\n",
                    //    dstMi->ambiguityResolutionScope.data(),
                    //    dstMd->name().data(),
                    //    dstMi->scopePath.left(dstMi->scopePath.find("::")+2).data());

dimitri's avatar
dimitri committed
2367
                    QCString scope=dstMi->scopePath.left(dstMi->scopePath.find(sep)+sepLen);
dimitri's avatar
dimitri committed
2368 2369 2370 2371 2372 2373 2374
                    if (scope!=dstMi->ambiguityResolutionScope.left(scope.length()))
                    {
                      dstMi->ambiguityResolutionScope.prepend(scope);
                    }
                    ambigue=TRUE;
                  }
                }
dimitri's avatar
dimitri committed
2375
              }
dimitri's avatar
dimitri committed
2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386
              //printf("member %s::%s hidden %d ambigue %d srcMi->ambigClass=%p\n",
              //    srcCd->name().data(),srcMd->name().data(),hidden,ambigue,srcMi->ambigClass);

              // TODO: fix the case where a member is hidden by inheritance
              //       of a member with the same name but with another prototype,
              //       while there is more than one path to the member in the 
              //       base class due to multiple inheritance. In this case
              //       it seems that the member is not reachable by prefixing a 
              //       scope name either (according to my compiler). Currently, 
              //       this case is shown anyway.
              if (!found && srcMd->protection()!=Private)
dimitri's avatar
dimitri committed
2387
              {
dimitri's avatar
dimitri committed
2388 2389 2390
                Protection prot=srcMd->protection();
                if (bcd->prot==Protected && prot==Public)       prot=bcd->prot;
                else if (bcd->prot==Private)                    prot=bcd->prot;
dimitri's avatar
dimitri committed
2391

dimitri's avatar
dimitri committed
2392
                if (inlineInheritedMembers)
dimitri's avatar
dimitri committed
2393
                {
dimitri's avatar
dimitri committed
2394 2395 2396 2397 2398
                  if (!isStandardFunc(srcMd))
                  {
                    //printf("    insertMember `%s'\n",srcMd->name().data());
                    internalInsertMember(srcMd,prot,FALSE);
                  }
dimitri's avatar
dimitri committed
2399
                }
dimitri's avatar
dimitri committed
2400

dimitri's avatar
dimitri committed
2401 2402
                Specifier virt=srcMi->virt;
                if (srcMi->virt==Normal && bcd->virt!=Normal) virt=bcd->virt;
dimitri's avatar
dimitri committed
2403

dimitri's avatar
dimitri committed
2404
                MemberInfo *newMi = new MemberInfo(srcMd,prot,virt,TRUE);
dimitri's avatar
dimitri committed
2405
                newMi->scopePath=bClass->name()+sep+srcMi->scopePath;
dimitri's avatar
dimitri committed
2406 2407 2408 2409 2410 2411 2412
                if (ambigue)
                {
                  //printf("$$ New member %s %s add scope %s::\n",
                  //     srcMi->ambiguityResolutionScope.data(),
                  //     srcMd->name().data(),
                  //     bClass->name().data());

dimitri's avatar
dimitri committed
2413
                  QCString scope=bClass->name()+sep;
dimitri's avatar
dimitri committed
2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424
                  if (scope!=srcMi->ambiguityResolutionScope.left(scope.length()))
                  {
                    newMi->ambiguityResolutionScope=
                      scope+srcMi->ambiguityResolutionScope.copy();
                  }
                }
                if (hidden)
                {
                  if (srcMi->ambigClass==0)
                  {
                    newMi->ambigClass=bClass;
dimitri's avatar
dimitri committed
2425
                    newMi->ambiguityResolutionScope=bClass->name()+sep;
dimitri's avatar
dimitri committed
2426 2427 2428 2429
                  }
                  else
                  {
                    newMi->ambigClass=srcMi->ambigClass;
dimitri's avatar
dimitri committed
2430
                    newMi->ambiguityResolutionScope=srcMi->ambigClass->name()+sep;
dimitri's avatar
dimitri committed
2431 2432 2433
                  }
                }
                dstMni->append(newMi);
dimitri's avatar
dimitri committed
2434
              }
dimitri's avatar
dimitri committed
2435
            }
dimitri's avatar
dimitri committed
2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447
          }
          else // base class has a member that is not in the sub class => copy
          {
            // create a deep copy of the list (only the MemberInfo's will be 
            // copied, not the actual MemberDef's)
            MemberNameInfo *newMni = 0;
            newMni = new MemberNameInfo(srcMni->memberName()); 

            // copy the member(s) from the base to the sub class
            MemberNameInfoIterator mnii(*srcMni);
            MemberInfo *mi;
            for (;(mi=mnii.current());++mnii)
dimitri's avatar
dimitri committed
2448
            {
dimitri's avatar
dimitri committed
2449 2450
              Protection prot = mi->prot;
              if (bcd->prot==Protected)
dimitri's avatar
dimitri committed
2451
              {
dimitri's avatar
dimitri committed
2452
                if (prot==Public) prot=Protected;
dimitri's avatar
dimitri committed
2453
              }
dimitri's avatar
dimitri committed
2454
              else if (bcd->prot==Private)
dimitri's avatar
dimitri committed
2455
              {
dimitri's avatar
dimitri committed
2456
                prot=Private;
dimitri's avatar
dimitri committed
2457
              }
dimitri's avatar
dimitri committed
2458 2459 2460
              //printf("%s::%s: prot=%d bcd->prot=%d result=%d\n",
              //    name().data(),mi->memberDef->name().data(),mi->prot,
              //    bcd->prot,prot);
dimitri's avatar
dimitri committed
2461

dimitri's avatar
dimitri committed
2462
              if (mi->prot!=Private)
dimitri's avatar
dimitri committed
2463
              {
dimitri's avatar
dimitri committed
2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476
                Specifier virt=mi->virt;
                if (mi->virt==Normal && bcd->virt!=Normal) virt=bcd->virt;

                if (inlineInheritedMembers)
                {
                  if (!isStandardFunc(mi->memberDef))
                  {
                    //printf("    insertMember `%s'\n",mi->memberDef->name().data());
                    internalInsertMember(mi->memberDef,prot,FALSE);
                  }
                }
                //printf("Adding!\n");
                MemberInfo *newMi=new MemberInfo(mi->memberDef,prot,virt,TRUE);
dimitri's avatar
dimitri committed
2477
                newMi->scopePath=bClass->name()+sep+mi->scopePath;
dimitri's avatar
dimitri committed
2478 2479 2480
                newMi->ambigClass=mi->ambigClass;
                newMi->ambiguityResolutionScope=mi->ambiguityResolutionScope.copy();
                newMni->append(newMi);
dimitri's avatar
dimitri committed
2481 2482
              }
            }
dimitri's avatar
dimitri committed
2483

dimitri's avatar
dimitri committed
2484 2485 2486 2487 2488 2489
            if (dstMnd==0)
            {
              m_impl->allMemberNameInfoSDict = new MemberNameInfoSDict(17);
              m_impl->allMemberNameInfoSDict->setAutoDelete(TRUE);
              dstMnd = m_impl->allMemberNameInfoSDict;
            }
dimitri's avatar
dimitri committed
2490 2491
            // add it to the dictionary
            dstMnd->append(newMni->memberName(),newMni);
dimitri's avatar
dimitri committed
2492 2493 2494 2495 2496
          }
        }
      }
    }
  }
dimitri's avatar
dimitri committed
2497
  //printf("  end mergeMembers\n");
dimitri's avatar
dimitri committed
2498 2499 2500
}

//----------------------------------------------------------------------------
dimitri's avatar
dimitri committed
2501

dimitri's avatar
dimitri committed
2502 2503 2504 2505
/*! Merges the members of a Objective-C category into this class.
 */
void ClassDef::mergeCategory(ClassDef *category)
{
dimitri's avatar
dimitri committed
2506
  category->setCategoryOf(this);
dimitri's avatar
dimitri committed
2507
  category->setArtificial(TRUE);
dimitri's avatar
dimitri committed
2508
    
dimitri's avatar
dimitri committed
2509
  MemberNameInfoSDict *srcMnd  = category->memberNameInfoSDict();
dimitri's avatar
dimitri committed
2510
  MemberNameInfoSDict *dstMnd  = m_impl->allMemberNameInfoSDict;
dimitri's avatar
dimitri committed
2511

dimitri's avatar
dimitri committed
2512
  if (srcMnd && dstMnd)
dimitri's avatar
dimitri committed
2513
  {
dimitri's avatar
dimitri committed
2514 2515 2516
    MemberNameInfoSDict::Iterator srcMnili(*srcMnd);
    MemberNameInfo *srcMni;
    for ( ; (srcMni=srcMnili.current()) ; ++srcMnili)
dimitri's avatar
dimitri committed
2517
    {
dimitri's avatar
dimitri committed
2518 2519
      MemberNameInfo *dstMni=dstMnd->find(srcMni->memberName());
      if (dstMni) // method is already defined in the class
dimitri's avatar
dimitri committed
2520
      {
dimitri's avatar
dimitri committed
2521
        // TODO: we should remove the other member and insert this one.
dimitri's avatar
dimitri committed
2522
      }
dimitri's avatar
dimitri committed
2523 2524
      else // new method name
      {
dimitri's avatar
dimitri committed
2525
        // create a deep copy of the list
dimitri's avatar
dimitri committed
2526 2527
        MemberNameInfo *newMni = 0;
        newMni = new MemberNameInfo(srcMni->memberName()); 
dimitri's avatar
dimitri committed
2528

dimitri's avatar
dimitri committed
2529 2530 2531 2532 2533
        // copy the member(s) from the category to this class
        MemberNameInfoIterator mnii(*srcMni);
        MemberInfo *mi;
        for (;(mi=mnii.current());++mnii)
        {
dimitri's avatar
dimitri committed
2534
          //printf("Adding '%s'\n",mi->memberDef->name().data());
dimitri's avatar
dimitri committed
2535 2536 2537
          MemberInfo *newMi=new MemberInfo(mi->memberDef,mi->prot,mi->virt,mi->inherited);
          newMi->scopePath=mi->scopePath;
          newMi->ambigClass=mi->ambigClass;
dimitri's avatar
dimitri committed
2538
          newMi->ambiguityResolutionScope=mi->ambiguityResolutionScope;
dimitri's avatar
dimitri committed
2539
          newMni->append(newMi);
dimitri's avatar
dimitri committed
2540 2541 2542
          mi->memberDef->moveTo(this);
          mi->memberDef->setCategory(category);
          internalInsertMember(mi->memberDef,mi->prot,FALSE);
dimitri's avatar
dimitri committed
2543 2544 2545 2546 2547
        }

        // add it to the dictionary
        dstMnd->append(newMni->memberName(),newMni);
      }
dimitri's avatar
dimitri committed
2548 2549 2550 2551 2552 2553
    }
  }
}

//----------------------------------------------------------------------------

dimitri's avatar
dimitri committed
2554 2555
void ClassDef::addUsedClass(ClassDef *cd,const char *accessName)
{
dimitri's avatar
dimitri committed
2556
  //printf("%s::addUsedClass(%s,%s)\n",name().data(),cd->name().data(),accessName);
dimitri's avatar
dimitri committed
2557
  if (m_impl->usesImplClassDict==0) 
dimitri's avatar
dimitri committed
2558
  {
dimitri's avatar
dimitri committed
2559 2560
    m_impl->usesImplClassDict = new UsesClassDict(17); 
    m_impl->usesImplClassDict->setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
2561
  }
dimitri's avatar
dimitri committed
2562
  UsesClassDef *ucd=m_impl->usesImplClassDict->find(cd->name());
dimitri's avatar
dimitri committed
2563
  if (ucd==0)
dimitri's avatar
dimitri committed
2564 2565
  {
     ucd = new UsesClassDef(cd);
dimitri's avatar
dimitri committed
2566
     m_impl->usesImplClassDict->insert(cd->name(),ucd);
dimitri's avatar
dimitri committed
2567 2568 2569 2570 2571 2572
     //printf("Adding used class %s to class %s\n",
     //    cd->name().data(),name().data());
  }
  ucd->addAccessor(accessName);
}

dimitri's avatar
dimitri committed
2573 2574
void ClassDef::addUsedByClass(ClassDef *cd,const char *accessName)
{
dimitri's avatar
dimitri committed
2575
  if (m_impl->usedByImplClassDict==0) 
dimitri's avatar
dimitri committed
2576
  {
dimitri's avatar
dimitri committed
2577 2578
    m_impl->usedByImplClassDict = new UsesClassDict(17); 
    m_impl->usedByImplClassDict->setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
2579
  }
dimitri's avatar
dimitri committed
2580
  UsesClassDef *ucd=m_impl->usedByImplClassDict->find(cd->name());
dimitri's avatar
dimitri committed
2581 2582 2583
  if (ucd==0)
  {
     ucd = new UsesClassDef(cd);
dimitri's avatar
dimitri committed
2584
     m_impl->usedByImplClassDict->insert(cd->name(),ucd);
dimitri's avatar
dimitri committed
2585 2586 2587 2588 2589 2590 2591
     //printf("Adding used by class %s to class %s\n",
     //    cd->name().data(),name().data());
  }
  ucd->addAccessor(accessName);
}


dimitri's avatar
dimitri committed
2592
#if 0
dimitri's avatar
dimitri committed
2593 2594 2595 2596 2597 2598 2599
/*! Builds up a dictionary of all classes that are used by the state of this 
 *  class (the "implementation"). 
 *  Must be called before mergeMembers() is called!
 */

void ClassDef::determineImplUsageRelation()
{
dimitri's avatar
dimitri committed
2600
  MemberNameInfoSDict::Iterator mnili(*m_impl->allMemberNameInfoSDict);
dimitri's avatar
dimitri committed
2601 2602 2603 2604 2605 2606 2607 2608 2609 2610
  MemberNameInfo *mni;
  for (;(mni=mnili.current());++mnili)
  {
    MemberNameInfoIterator mnii(*mni);
    MemberInfo *mi;
    for (mnii.toFirst();(mi=mnii.current());++mnii)
    {
      MemberDef *md=mi->memberDef;
      if (md->isVariable()) // for each member variable in this class
      {
dimitri's avatar
dimitri committed
2611
        QCString type=removeRedundantWhiteSpace(md->typeString());
dimitri's avatar
dimitri committed
2612 2613
        //printf("in class %s found var type=`%s' name=`%s'\n",
        //            name().data(),type.data(),md->name().data());
dimitri's avatar
dimitri committed
2614 2615 2616
        int pos=0;
        QCString usedClassName;
        QCString templSpec;
2617
        bool found=FALSE;
dimitri's avatar
dimitri committed
2618
        while (extractClassNameFromType(type,pos,usedClassName,templSpec)!=-1 && !found)
dimitri's avatar
dimitri committed
2619
        {
dimitri's avatar
dimitri committed
2620 2621 2622 2623
          //printf("usedClassName=`%s' templSpec=%s\n",usedClassName.data(),templSpec.data());
          // check if usedClassName is a template argument of its class
          ClassDef *cd=md->getClassDef();
          if (cd && cd->templateArguments())
dimitri's avatar
dimitri committed
2624
          {
dimitri's avatar
dimitri committed
2625 2626 2627 2628
            ArgumentListIterator ali(*cd->templateArguments());
            Argument *arg;
            int count=0;
            for (ali.toFirst();(arg=ali.current());++ali,++count)
dimitri's avatar
dimitri committed
2629
            {
dimitri's avatar
dimitri committed
2630
              if (arg->name==usedClassName) // type is a template argument
dimitri's avatar
dimitri committed
2631
              {
dimitri's avatar
dimitri committed
2632
                found=TRUE;
dimitri's avatar
dimitri committed
2633
                if (m_impl->usesImplClassDict==0) m_impl->usesImplClassDict = new UsesClassDict(257); 
dimitri's avatar
dimitri committed
2634 2635 2636 2637
                cd = new ClassDef(cd->getDefFileName(),cd->getDefLine(),
                    usedClassName,ClassDef::Class);
                cd->setIsTemplateBaseClass(count);
                UsesClassDef *ucd = new UsesClassDef(cd);
dimitri's avatar
dimitri committed
2638
                m_impl->usesImplClassDict->insert(cd->name(),ucd);
dimitri's avatar
dimitri committed
2639 2640 2641 2642 2643 2644 2645
                ucd->templSpecifiers = templSpec;
                ucd->addAccessor(md->name());
                Doxygen::hiddenClasses.append(cd);
                //printf("Adding used template argument %s to class %s\n",
                //    cd->name().data(),name().data());
                //printf("Adding accessor %s to class %s\n",
                //    md->name().data(),ucd->classDef->name().data());
dimitri's avatar
dimitri committed
2646
              }
dimitri's avatar
dimitri committed
2647
            }
dimitri's avatar
dimitri committed
2648 2649 2650 2651 2652
          }

          if (!found)
          {
            cd=0;
dimitri's avatar
dimitri committed
2653 2654
            if (getNamespaceDef()!=0)
            {
dimitri's avatar
dimitri committed
2655
              cd=getResolvedClass(getNamespaceDef()->name()+"::"+usedClassName,0,&templSpec);
dimitri's avatar
dimitri committed
2656
            }
dimitri's avatar
dimitri committed
2657 2658
            if (cd==0) cd=getResolvedClass(name()+"::"+usedClassName,0,&templSpec);
            if (cd==0) cd=getResolvedClass(usedClassName,0,&templSpec); // TODO: also try inbetween scopes!
dimitri's avatar
dimitri committed
2659
            //printf("Search for class %s result=%p\n",usedClassName.data(),cd);
dimitri's avatar
dimitri committed
2660
            if (cd) // class exists 
dimitri's avatar
dimitri committed
2661
            {
dimitri's avatar
dimitri committed
2662
              found=TRUE;
dimitri's avatar
dimitri committed
2663
              if (m_impl->usesImplClassDict==0) 
dimitri's avatar
dimitri committed
2664
              {
dimitri's avatar
dimitri committed
2665 2666
                m_impl->usesImplClassDict = new UsesClassDict(257); 
                m_impl->usesImplClassDict->setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
2667
              }
dimitri's avatar
dimitri committed
2668
              UsesClassDef *ucd=m_impl->usesImplClassDict->find(cd->name());
dimitri's avatar
dimitri committed
2669 2670 2671
              if (ucd==0 || ucd->templSpecifiers!=templSpec)
              {
                ucd = new UsesClassDef(cd);
dimitri's avatar
dimitri committed
2672
                m_impl->usesImplClassDict->insert(cd->name(),ucd);
dimitri's avatar
dimitri committed
2673 2674 2675 2676 2677 2678 2679
                ucd->templSpecifiers = templSpec;
                //printf("Adding used class %s to class %s\n",
                //    cd->name().data(),name().data());
              }
              ucd->addAccessor(md->name());
              //printf("Adding accessor %s to class %s\n",
              //    md->name().data(),ucd->classDef->name().data());
dimitri's avatar
dimitri committed
2680 2681 2682 2683 2684 2685 2686
            }
          }
        }
      }
    }
  }
#ifdef DUMP
dimitri's avatar
dimitri committed
2687
  if (m_impl->usesClassDict)
dimitri's avatar
dimitri committed
2688
  {
dimitri's avatar
dimitri committed
2689
    msg("Class %s uses the following classes:\n",name().data());
dimitri's avatar
dimitri committed
2690
    UsesClassDictIterator ucdi(*m_impl->usesClassDict);
dimitri's avatar
dimitri committed
2691 2692 2693
    UsesClassDef *ucd;
    for (;(ucd=ucdi.current());++ucdi)
    {
dimitri's avatar
dimitri committed
2694
      msg("  %s via ",ucd->classDef->name().data());
dimitri's avatar
dimitri committed
2695 2696 2697 2698
      QDictIterator<void> dvi(*ucd->accessors); 
      const char *s;
      for (;(s=dvi.currentKey());++dvi)
      {
dimitri's avatar
dimitri committed
2699
        msg("%s ",s);
dimitri's avatar
dimitri committed
2700
      }
dimitri's avatar
dimitri committed
2701
      msg("\n");
dimitri's avatar
dimitri committed
2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722
    }
  }
#endif
}

//----------------------------------------------------------------------------

// I have disabled this code because the graphs it renders quickly become
// too large to be of practical use.

void ClassDef::addUsedInterfaceClasses(MemberDef *md,const char *typeStr)
{
  QCString type = typeStr;
  static const QRegExp re("[a-z_A-Z][a-z_A-Z0-9:]*");
  int p=0,i,l;
  while ((i=re.match(type,p,&l))!=-1) // for each class name in the type
  {
    ClassDef *cd=getClass(name()+"::"+type.mid(i,l));
    if (cd==0) cd=getClass(type.mid(i,l)); // TODO: also try inbetween scopes!
    if (cd && cd!=this && !isBaseClass(cd))
    {
dimitri's avatar
dimitri committed
2723
      if (m_impl->usesIntfClassDict==0) 
dimitri's avatar
dimitri committed
2724
      {
dimitri's avatar
dimitri committed
2725
        m_impl->usesIntfClassDict = new UsesClassDict(257); 
dimitri's avatar
dimitri committed
2726
      }
dimitri's avatar
dimitri committed
2727
      UsesClassDef *ucd=m_impl->usesIntfClassDict->find(cd->name());
dimitri's avatar
dimitri committed
2728 2729 2730
      if (ucd==0)
      {
        ucd = new UsesClassDef(cd);
dimitri's avatar
dimitri committed
2731
        m_impl->usesIntfClassDict->insert(cd->name(),ucd);
dimitri's avatar
dimitri committed
2732 2733 2734 2735
        //printf("in class `%s' adding used intf class `%s'\n",
        //  name().data(),cd->name().data());
      }
      ucd->addAccessor(md->name());
dimitri's avatar
dimitri committed
2736 2737
      //printf("in class `%s' adding accessor `%s' to class `%s'\n",
      //    name().data(),md->name().data(),ucd->classDef->name().data());
dimitri's avatar
dimitri committed
2738 2739 2740 2741 2742 2743 2744
    }
    p=i+l;
  }
}

void ClassDef::determineIntfUsageRelation()
{
dimitri's avatar
dimitri committed
2745
  MemberNameInfoSDict::Iterator mnili(*m_impl->allMemberNameInfoList);
dimitri's avatar
dimitri committed
2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787
  MemberNameInfo *mni;
  for (;(mni=mnili.current());++mnili)
  {
    MemberNameInfoIterator mnii(*mni);
    MemberInfo *mi;
    for (mnii.toFirst();(mi=mnii.current());++mnii)
    {
      MemberDef *md=mi->memberDef;
      
      // compute the protection level for this member
      Protection protect=md->protection();
      if (mi->prot==Protected) // inherited protection
      {
        if (protect==Public) protect=Protected;
        else if (protect==Protected) protect=Private;
      }
      
      if (!md->name().isEmpty() && md->name()[0]!='@' && 
          (mi->prot!=Private && protect!=Private)
         )
      {
        // add classes found in the return type
        addUsedInterfaceClasses(md,md->typeString());
        ArgumentList *al = md->argumentList();
        if (al) // member has arguments
        {
          // add classes found in the types of the argument list
          ArgumentListIterator ali(*al);
          Argument *a;
          for (;(a=ali.current());++ali)
          {
            if (!a->type.isEmpty() && a->type.at(0)!='@')
            {
              addUsedInterfaceClasses(md,a->type);
            }
          }
        }
      }
    }
  }
}
#endif
dimitri's avatar
dimitri committed
2788

dimitri's avatar
dimitri committed
2789 2790
QCString ClassDef::compoundTypeString() const
{
dimitri's avatar
dimitri committed
2791
  if (m_impl->compType==Interface && m_impl->lang==SrcLangExt_ObjC) return "class";
dimitri's avatar
dimitri committed
2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806
  if (Config_getBool("OPTIMIZE_FOR_FORTRAN"))
  {
    switch (m_impl->compType)
    {
      case Class:     return "module";
      case Struct:    return "type";
      case Union:     return "union";
      case Interface: return "interface";
      case Protocol:  return "protocol";
      case Category:  return "category";
      case Exception: return "exception";
      default:        return "unknown";
    } 
  }
  else
dimitri's avatar
dimitri committed
2807
  {
dimitri's avatar
dimitri committed
2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818
    switch (m_impl->compType)
    {
      case Class:     return "class";
      case Struct:    return "struct";
      case Union:     return "union";
      case Interface: return "interface";
      case Protocol:  return "protocol";
      case Category:  return "category";
      case Exception: return "exception";
      default:        return "unknown";
    }
dimitri's avatar
dimitri committed
2819 2820 2821
  }
}

dimitri's avatar
dimitri committed
2822
QCString ClassDef::getOutputFileBase() const 
dimitri's avatar
dimitri committed
2823
{ 
dimitri's avatar
dimitri committed
2824
  if (m_impl->templateMaster)
dimitri's avatar
dimitri committed
2825
  {
dimitri's avatar
dimitri committed
2826
    return m_impl->templateMaster->getOutputFileBase();
dimitri's avatar
dimitri committed
2827 2828 2829
  }
  else if (isReference())
  {
dimitri's avatar
dimitri committed
2830
    return m_impl->fileName;
dimitri's avatar
dimitri committed
2831 2832 2833
  }
  else
  {
dimitri's avatar
dimitri committed
2834
    return convertNameToFile(m_impl->fileName); 
dimitri's avatar
dimitri committed
2835 2836 2837 2838
  }
}

QCString ClassDef::getInstanceOutputFileBase() const 
dimitri's avatar
dimitri committed
2839
{ 
dimitri's avatar
dimitri committed
2840 2841
  if (isReference())
  {
dimitri's avatar
dimitri committed
2842
    return m_impl->fileName;
dimitri's avatar
dimitri committed
2843 2844 2845
  }
  else
  {
dimitri's avatar
dimitri committed
2846
    return convertNameToFile(m_impl->fileName); 
dimitri's avatar
dimitri committed
2847
  }
dimitri's avatar
dimitri committed
2848 2849 2850 2851
}

QCString ClassDef::getFileBase() const 
{ 
dimitri's avatar
dimitri committed
2852
  if (m_impl->templateMaster)
dimitri's avatar
dimitri committed
2853
  {
dimitri's avatar
dimitri committed
2854
    return m_impl->templateMaster->getFileBase();
dimitri's avatar
dimitri committed
2855 2856 2857
  }
  else
  {
dimitri's avatar
dimitri committed
2858
    return m_impl->fileName; 
dimitri's avatar
dimitri committed
2859
  }
dimitri's avatar
dimitri committed
2860 2861 2862 2863
}

QCString ClassDef::getSourceFileBase() const 
{ 
dimitri's avatar
dimitri committed
2864
  if (m_impl->templateMaster)
dimitri's avatar
dimitri committed
2865
  {
dimitri's avatar
dimitri committed
2866
    return m_impl->templateMaster->getSourceFileBase();
dimitri's avatar
dimitri committed
2867 2868 2869
  }
  else
  {
dimitri's avatar
dimitri committed
2870
    return convertNameToFile(m_impl->fileName)+"_source"; 
dimitri's avatar
dimitri committed
2871
  }
dimitri's avatar
dimitri committed
2872 2873
}

dimitri's avatar
dimitri committed
2874
void ClassDef::setGroupDefForAllMembers(GroupDef *gd,Grouping::GroupPri_t pri,const QCString &fileName,int startLine,bool hasDocs)
dimitri's avatar
dimitri committed
2875 2876 2877
{
  gd->addClass(this);
  //printf("ClassDef::setGroupDefForAllMembers(%s)\n",gd->name().data());
dimitri's avatar
dimitri committed
2878 2879
  if (m_impl->allMemberNameInfoSDict==0) return;
  MemberNameInfoSDict::Iterator mnili(*m_impl->allMemberNameInfoSDict);
dimitri's avatar
dimitri committed
2880 2881 2882 2883 2884 2885 2886 2887
  MemberNameInfo *mni;
  for (;(mni=mnili.current());++mnili)
  {
    MemberNameInfoIterator mnii(*mni);
    MemberInfo *mi;
    for (mnii.toFirst();(mi=mnii.current());++mnii)
    {
      MemberDef *md=mi->memberDef;
dimitri's avatar
dimitri committed
2888
      md->setGroupDef(gd,pri,fileName,startLine,hasDocs);
dimitri's avatar
dimitri committed
2889 2890
      gd->insertMember(md,TRUE);
      ClassDef *innerClass = md->getClassDefOfAnonymousType();
dimitri's avatar
dimitri committed
2891
      if (innerClass) innerClass->setGroupDefForAllMembers(gd,pri,fileName,startLine,hasDocs);
dimitri's avatar
dimitri committed
2892 2893 2894 2895 2896 2897
    }
  }
}

void ClassDef::addInnerCompound(Definition *d)
{
dimitri's avatar
dimitri committed
2898
  //printf("**** %s::addInnerCompound(%s)\n",name().data(),d->name().data());
dimitri's avatar
dimitri committed
2899 2900 2901
  if (d->definitionType()==Definition::TypeClass) // only classes can be
                                                  // nested in classes.
  {
dimitri's avatar
dimitri committed
2902
    if (m_impl->innerClasses==0)
dimitri's avatar
dimitri committed
2903
    {
dimitri's avatar
dimitri committed
2904
      m_impl->innerClasses = new ClassSDict(17);
dimitri's avatar
dimitri committed
2905
    }
dimitri's avatar
dimitri committed
2906
    m_impl->innerClasses->inSort(d->localName(),(ClassDef *)d);
dimitri's avatar
dimitri committed
2907
  }
dimitri's avatar
dimitri committed
2908 2909 2910 2911
}

Definition *ClassDef::findInnerCompound(const char *name)
{
dimitri's avatar
dimitri committed
2912 2913 2914 2915 2916 2917 2918
  Definition *result=0;
  if (name==0) return 0;
  if (m_impl->innerClasses)
  {
    result = m_impl->innerClasses->find(name);
  }
  return result;
dimitri's avatar
dimitri committed
2919 2920
}

dimitri's avatar
dimitri committed
2921 2922
//void ClassDef::initTemplateMapping()
//{
dimitri's avatar
dimitri committed
2923
//  m_impl->templateMapping->clear();
dimitri's avatar
dimitri committed
2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937
//  ArgumentList *al = templateArguments();
//  if (al)
//  {
//    ArgumentListIterator ali(*al);
//    Argument *arg;
//    for (ali.toFirst();(arg=ali.current());++ali)
//    {
//      setTemplateArgumentMapping(arg->name,arg->defval);
//    }
//  }
//}
//void ClassDef::setTemplateArgumentMapping(const char *formal,const char *actual)
//{
//  //printf("ClassDef::setTemplateArgumentMapping(%s,%s)\n",formal,actual);
dimitri's avatar
dimitri committed
2938
//  if (m_impl->templateMapping && formal)
dimitri's avatar
dimitri committed
2939
//  {
dimitri's avatar
dimitri committed
2940
//    if (m_impl->templateMapping->find(formal))
dimitri's avatar
dimitri committed
2941
//    {
dimitri's avatar
dimitri committed
2942
//      m_impl->templateMapping->remove(formal);
dimitri's avatar
dimitri committed
2943
//    }
dimitri's avatar
dimitri committed
2944
//    m_impl->templateMapping->insert(formal,new QCString(actual));
dimitri's avatar
dimitri committed
2945 2946 2947 2948 2949
//  }
//}
//
//QCString ClassDef::getTemplateArgumentMapping(const char *formal) const
//{
dimitri's avatar
dimitri committed
2950
//  if (m_impl->templateMapping && formal)
dimitri's avatar
dimitri committed
2951
//  {
dimitri's avatar
dimitri committed
2952
//    QCString *s = m_impl->templateMapping->find(formal);
dimitri's avatar
dimitri committed
2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964
//    if (s)
//    {
//      return *s;
//    }
//  }
//  return "";
//}

ClassDef *ClassDef::insertTemplateInstance(const QCString &fileName,
    int startLine, const QCString &templSpec,bool &freshInstance)
{
  freshInstance = FALSE;
dimitri's avatar
dimitri committed
2965
  if (m_impl->templateInstances==0) 
dimitri's avatar
dimitri committed
2966
  {
dimitri's avatar
dimitri committed
2967
    m_impl->templateInstances = new QDict<ClassDef>(17);
dimitri's avatar
dimitri committed
2968
  }
dimitri's avatar
dimitri committed
2969
  ClassDef *templateClass=m_impl->templateInstances->find(templSpec);
dimitri's avatar
dimitri committed
2970 2971
  if (templateClass==0)
  {
dimitri's avatar
dimitri committed
2972
    Debug::print(Debug::Classes,0,"      New template instance class `%s'`%s'\n",name().data(),templSpec.data());
dimitri's avatar
dimitri committed
2973
    templateClass = new ClassDef(
dimitri's avatar
dimitri committed
2974
        fileName,startLine,localName()+templSpec,ClassDef::Class);
dimitri's avatar
dimitri committed
2975
    templateClass->setTemplateMaster(this);
dimitri's avatar
dimitri committed
2976
    templateClass->setOuterScope(getOuterScope());
dimitri's avatar
dimitri committed
2977
    templateClass->setHidden(isHidden());
dimitri's avatar
dimitri committed
2978
    m_impl->templateInstances->insert(templSpec,templateClass);
dimitri's avatar
dimitri committed
2979 2980 2981 2982 2983
    freshInstance=TRUE;
  }
  return templateClass;
}

dimitri's avatar
dimitri committed
2984 2985
ClassDef *ClassDef::getVariableInstance(const char *templSpec)
{
dimitri's avatar
dimitri committed
2986
  if (m_impl->variableInstances==0) 
dimitri's avatar
dimitri committed
2987
  {
dimitri's avatar
dimitri committed
2988 2989
    m_impl->variableInstances = new QDict<ClassDef>(17);
    m_impl->variableInstances->setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
2990
  }
dimitri's avatar
dimitri committed
2991
  ClassDef *templateClass=m_impl->variableInstances->find(templSpec);
dimitri's avatar
dimitri committed
2992 2993
  if (templateClass==0)
  {
dimitri's avatar
dimitri committed
2994
    Debug::print(Debug::Classes,0,"      New template variable instance class `%s'`%s'\n",qPrint(name()),qPrint(templSpec));
dimitri's avatar
dimitri committed
2995 2996 2997 2998
    templateClass = new ClassDef("<code>",1,name()+templSpec,
                        ClassDef::Class,0,0,FALSE);
    templateClass->addMembersToTemplateInstance( this, templSpec );
    templateClass->setTemplateMaster(this);
dimitri's avatar
dimitri committed
2999
    m_impl->variableInstances->insert(templSpec,templateClass);
dimitri's avatar
dimitri committed
3000 3001 3002 3003
  }
  return templateClass;
}

dimitri's avatar
dimitri committed
3004
void ClassDef::setTemplateBaseClassNames(QDict<int> *templateNames)
dimitri's avatar
dimitri committed
3005
{
dimitri's avatar
dimitri committed
3006
  if (templateNames==0) return;
dimitri's avatar
dimitri committed
3007
  if (m_impl->templBaseClassNames==0)
dimitri's avatar
dimitri committed
3008
  {
dimitri's avatar
dimitri committed
3009 3010
    m_impl->templBaseClassNames = new QDict<int>(17);
    m_impl->templBaseClassNames->setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
3011 3012 3013 3014
  }
  // make a deep copy of the dictionary.
  QDictIterator<int> qdi(*templateNames);
  for (;qdi.current();++qdi)
dimitri's avatar
dimitri committed
3015
  {
dimitri's avatar
dimitri committed
3016
    if (m_impl->templBaseClassNames->find(qdi.currentKey())==0)
dimitri's avatar
dimitri committed
3017
    {
dimitri's avatar
dimitri committed
3018
      m_impl->templBaseClassNames->insert(qdi.currentKey(),new int(*qdi.current()));
dimitri's avatar
dimitri committed
3019 3020 3021 3022
    }
  }
}

dimitri's avatar
dimitri committed
3023 3024
QDict<int> *ClassDef::getTemplateBaseClassNames() const
{
dimitri's avatar
dimitri committed
3025
  return m_impl->templBaseClassNames;
dimitri's avatar
dimitri committed
3026 3027 3028
}

void ClassDef::addMembersToTemplateInstance(ClassDef *cd,const char *templSpec)
dimitri's avatar
dimitri committed
3029
{
dimitri's avatar
dimitri committed
3030
  //printf("%s::addMembersToTemplateInstance(%s,%s)\n",name().data(),cd->name().data(),templSpec);
dimitri's avatar
dimitri committed
3031 3032
  if (cd->memberNameInfoSDict()==0) return;
  MemberNameInfoSDict::Iterator mnili(*cd->memberNameInfoSDict());
dimitri's avatar
dimitri committed
3033 3034
  MemberNameInfo *mni;
  for (;(mni=mnili.current());++mnili)
dimitri's avatar
dimitri committed
3035
  {
dimitri's avatar
dimitri committed
3036 3037 3038
    MemberNameInfoIterator mnii(*mni);
    MemberInfo *mi;
    for (mnii.toFirst();(mi=mnii.current());++mnii)
dimitri's avatar
dimitri committed
3039
    {
dimitri's avatar
dimitri committed
3040 3041 3042 3043 3044 3045 3046 3047 3048
      ArgumentList *actualArguments = new ArgumentList;
      stringToArgumentList(templSpec,actualArguments);
      MemberDef *md = mi->memberDef;
      MemberDef *imd = md->createTemplateInstanceMember(
                          cd->templateArguments(),actualArguments);
      delete actualArguments;
      //printf("%s->setMemberClass(%p)\n",imd->name().data(),this);
      imd->setMemberClass(this);
      imd->setTemplateMaster(md);
dimitri's avatar
dimitri committed
3049 3050
      imd->setDocumentation(md->documentation(),md->docFile(),md->docLine());
      imd->setBriefDescription(md->briefDescription(),md->briefFile(),md->briefLine());
dimitri's avatar
dimitri committed
3051
      imd->setInbodyDocumentation(md->inbodyDocumentation(),md->inbodyFile(),md->inbodyLine());
dimitri's avatar
dimitri committed
3052
      imd->setMemberSpecifiers(md->getMemberSpecifiers());
dimitri's avatar
dimitri committed
3053
      imd->setMemberGroupId(md->getMemberGroupId());
dimitri's avatar
dimitri committed
3054
      insertMember(imd);
dimitri's avatar
dimitri committed
3055 3056 3057
      //printf("Adding member=%s %s%s to class %s templSpec %s\n",
      //    imd->typeString(),imd->name().data(),imd->argsString(),
      //    imd->getClassDef()->name().data(),templSpec);
dimitri's avatar
dimitri committed
3058 3059
      // insert imd in the list of all members
      //printf("Adding member=%s class=%s\n",imd->name().data(),name().data());
dimitri's avatar
dimitri committed
3060
      MemberName *mn = Doxygen::memberNameSDict->find(imd->name());
dimitri's avatar
dimitri committed
3061
      if (mn==0)
dimitri's avatar
dimitri committed
3062 3063
      {
        mn = new MemberName(imd->name());
dimitri's avatar
dimitri committed
3064
        Doxygen::memberNameSDict->append(imd->name(),mn);
dimitri's avatar
dimitri committed
3065
      }
dimitri's avatar
dimitri committed
3066
      mn->append(imd);
dimitri's avatar
dimitri committed
3067 3068 3069 3070
    }
  }
}

dimitri's avatar
dimitri committed
3071
QCString ClassDef::getReference() const
dimitri's avatar
dimitri committed
3072
{
dimitri's avatar
dimitri committed
3073
  if (m_impl->templateMaster)
dimitri's avatar
dimitri committed
3074
  {
dimitri's avatar
dimitri committed
3075
    return m_impl->templateMaster->getReference();
dimitri's avatar
dimitri committed
3076 3077 3078 3079
  }
  else
  {
    return Definition::getReference();
dimitri's avatar
dimitri committed
3080
  }
dimitri's avatar
dimitri committed
3081 3082
}

dimitri's avatar
dimitri committed
3083 3084
bool ClassDef::isReference() const
{
dimitri's avatar
dimitri committed
3085
  if (m_impl->templateMaster)
dimitri's avatar
dimitri committed
3086
  {
dimitri's avatar
dimitri committed
3087
    return m_impl->templateMaster->isReference();
dimitri's avatar
dimitri committed
3088 3089 3090 3091 3092 3093 3094
  }
  else
  {
    return Definition::isReference();
  }
}

dimitri's avatar
dimitri committed
3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114
void ClassDef::getTemplateParameterLists(QList<ArgumentList> &lists) const
{
  Definition *d=getOuterScope();
  if (d)
  {
    if (d->definitionType()==Definition::TypeClass)
    {
      ClassDef *cd=(ClassDef *)d;
      cd->getTemplateParameterLists(lists);
    }
  }
  if (templateArguments())
  {
    lists.append(templateArguments());
  }
}

QCString ClassDef::qualifiedNameWithTemplateParameters(
    QList<ArgumentList> *actualParams) const
{
dimitri's avatar
dimitri committed
3115
  static bool optimizeOutputJava = Config_getBool("OPTIMIZE_OUTPUT_JAVA");
dimitri's avatar
dimitri committed
3116
  static bool hideScopeNames = Config_getBool("HIDE_SCOPE_NAMES");
dimitri's avatar
dimitri committed
3117
  //printf("qualifiedNameWithTemplateParameters() localName=%s\n",localName().data());
dimitri's avatar
dimitri committed
3118
  QCString scName;
dimitri's avatar
dimitri committed
3119 3120
  Definition *d=getOuterScope();
  if (d)
dimitri's avatar
dimitri committed
3121
  {
dimitri's avatar
dimitri committed
3122
    if (d->definitionType()==Definition::TypeClass)
dimitri's avatar
dimitri committed
3123
    {
dimitri's avatar
dimitri committed
3124 3125 3126 3127 3128 3129
      ClassDef *cd=(ClassDef *)d;
      scName = cd->qualifiedNameWithTemplateParameters(actualParams);
    }
    else if (!hideScopeNames)
    {
      scName = d->qualifiedName();
dimitri's avatar
dimitri committed
3130
    }
dimitri's avatar
dimitri committed
3131
  }
dimitri's avatar
dimitri committed
3132

dimitri's avatar
dimitri committed
3133 3134 3135 3136 3137 3138 3139
  QCString scopeSeparator;
  if (optimizeOutputJava)
    scopeSeparator=".";
  else
    scopeSeparator="::";

  if (!scName.isEmpty()) scName+=scopeSeparator;
dimitri's avatar
dimitri committed
3140

dimitri's avatar
dimitri committed
3141
  bool isSpecialization = localName().find('<')!=-1;
dimitri's avatar
dimitri committed
3142 3143 3144 3145 3146 3147 3148
  bool isGeneric = m_impl->lang==SrcLangExt_CSharp;

  QCString clName = className();
  if (isGeneric && clName.right(2)=="-g") 
  {
    clName = clName.left(clName.length()-2);
  }
dimitri's avatar
dimitri committed
3149
  //printf("m_impl->lang=%d clName=%s\n",m_impl->lang,clName.data());
dimitri's avatar
dimitri committed
3150 3151
  scName+=clName;
  ArgumentList *al=0;
dimitri's avatar
dimitri committed
3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169
  if (templateArguments())
  {
    if (actualParams && (al=actualParams->current()))
    {
      if (!isSpecialization)
      {
        scName+=tempArgListToString(al);
      }
      actualParams->next();
    }
    else
    {
      if (!isSpecialization)
      {
        scName+=tempArgListToString(templateArguments());
      }
    }
  }
dimitri's avatar
dimitri committed
3170
  //printf("qualifiedNameWithTemplateParameters: scope=%s qualifiedName=%s\n",name().data(),scName.data());
dimitri's avatar
dimitri committed
3171 3172 3173
  return scName;
}

dimitri's avatar
dimitri committed
3174 3175
QCString ClassDef::className() const
{
dimitri's avatar
dimitri committed
3176 3177 3178 3179 3180 3181 3182 3183
  if (m_impl->className.isEmpty())
  {
    return localName();
  }
  else
  {
    return m_impl->className;
  }
dimitri's avatar
dimitri committed
3184
};
dimitri's avatar
dimitri committed
3185

dimitri's avatar
dimitri committed
3186 3187 3188 3189 3190
void ClassDef::setClassName(const char *name)
{
  m_impl->className = name;
}

dimitri's avatar
dimitri committed
3191 3192
void ClassDef::addListReferences()
{
dimitri's avatar
dimitri committed
3193
  bool fortranOpt=Config_getBool("OPTIMIZE_FOR_FORTRAN");
dimitri's avatar
dimitri committed
3194 3195
  if (!isLinkableInProject()) return;
  //printf("ClassDef(%s)::addListReferences()\n",name().data());
dimitri's avatar
dimitri committed
3196 3197 3198
  {
    LockingPtr< QList<ListItemInfo> > xrefItems = xrefListItems();
    addRefItem(xrefItems.pointer(),
dimitri's avatar
dimitri committed
3199
             qualifiedName(),
dimitri's avatar
dimitri committed
3200 3201 3202
             fortranOpt?theTranslator->trType(TRUE,TRUE):
                        theTranslator->trClass(TRUE,TRUE),
             getOutputFileBase(),
dimitri's avatar
dimitri committed
3203 3204
             displayName(),
             0
dimitri's avatar
dimitri committed
3205
            );
dimitri's avatar
dimitri committed
3206 3207
  }
  if (m_impl->memberGroupSDict)
dimitri's avatar
dimitri committed
3208
  {
dimitri's avatar
dimitri committed
3209
    MemberGroupSDict::Iterator mgli(*m_impl->memberGroupSDict);
dimitri's avatar
dimitri committed
3210 3211 3212 3213 3214 3215
    MemberGroup *mg;
    for (;(mg=mgli.current());++mgli)
    {
      mg->addListReferences(this);
    }
  }
dimitri's avatar
dimitri committed
3216
  QListIterator<MemberList> mli(m_impl->memberLists);
dimitri's avatar
dimitri committed
3217 3218 3219 3220 3221 3222 3223 3224
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()&MemberList::detailedLists)
    {
      ml->addListReferences(this);
    }
  }
dimitri's avatar
dimitri committed
3225 3226
}

dimitri's avatar
dimitri committed
3227
MemberDef *ClassDef::getMemberByName(const QCString &name) const
dimitri's avatar
dimitri committed
3228 3229
{
  MemberDef *xmd = 0;
dimitri's avatar
dimitri committed
3230
  if (m_impl->allMemberNameInfoSDict)
dimitri's avatar
dimitri committed
3231
  {
dimitri's avatar
dimitri committed
3232
    MemberNameInfo *mni = m_impl->allMemberNameInfoSDict->find(name);
dimitri's avatar
dimitri committed
3233
    if (mni)
dimitri's avatar
dimitri committed
3234
    {
dimitri's avatar
dimitri committed
3235 3236 3237 3238 3239
      const int maxInheritanceDepth = 100000;
      int mdist=maxInheritanceDepth;
      MemberNameInfoIterator mnii(*mni);
      MemberInfo *mi;
      for (mnii.toFirst();(mi=mnii.current());++mnii)
dimitri's avatar
dimitri committed
3240
      {
dimitri's avatar
dimitri committed
3241 3242 3243 3244 3245 3246 3247 3248 3249
        ClassDef *mcd=mi->memberDef->getClassDef();
        int m=minClassDistance(this,mcd);
        //printf("found member in %s linkable=%d m=%d\n",
        //    mcd->name().data(),mcd->isLinkable(),m);
        if (m<mdist && mcd->isLinkable())
        {
          mdist=m;
          xmd=mi->memberDef;
        }
dimitri's avatar
dimitri committed
3250 3251 3252
      }
    }
  }
dimitri's avatar
dimitri committed
3253
  //printf("getMemberByName(%s)=%p\n",name.data(),xmd);
dimitri's avatar
dimitri committed
3254 3255 3256
  return xmd;
}

dimitri's avatar
dimitri committed
3257 3258 3259 3260 3261
bool ClassDef::isAccessibleMember(MemberDef *md)
{
  return md->getClassDef() && isBaseClass(md->getClassDef(),TRUE);
}

dimitri's avatar
dimitri committed
3262 3263
MemberList *ClassDef::createMemberList(MemberList::ListType lt)
{
dimitri's avatar
dimitri committed
3264 3265
  m_impl->memberLists.setAutoDelete(TRUE);
  QListIterator<MemberList> mli(m_impl->memberLists);
dimitri's avatar
dimitri committed
3266 3267 3268 3269 3270 3271 3272 3273 3274 3275
  MemberList *ml;
  for (mli.toFirst();(ml=mli.current());++mli)
  {
    if (ml->listType()==lt)
    {
      return ml;
    }
  }
  // not found, create a new member list
  ml = new MemberList(lt);
dimitri's avatar
dimitri committed
3276
  m_impl->memberLists.append(ml);
dimitri's avatar
dimitri committed
3277 3278 3279 3280 3281
  return ml;
}

MemberList *ClassDef::getMemberList(MemberList::ListType lt)
{
dimitri's avatar
dimitri committed
3282
  MemberList *ml = m_impl->memberLists.first();
dimitri's avatar
dimitri committed
3283 3284 3285 3286 3287 3288
  while (ml)
  {
    if (ml->listType()==lt)
    {
      return ml;
    }
dimitri's avatar
dimitri committed
3289
    ml = m_impl->memberLists.next();
dimitri's avatar
dimitri committed
3290 3291 3292 3293
  }
  return 0;
}

dimitri's avatar
dimitri committed
3294
void ClassDef::addMemberToList(MemberList::ListType lt,MemberDef *md,bool isBrief)
dimitri's avatar
dimitri committed
3295 3296
{
  static bool sortBriefDocs = Config_getBool("SORT_BRIEF_DOCS");
dimitri's avatar
dimitri committed
3297
  static bool sortMemberDocs = Config_getBool("SORT_MEMBER_DOCS");
dimitri's avatar
dimitri committed
3298
  MemberList *ml = createMemberList(lt);
dimitri's avatar
dimitri committed
3299 3300 3301
  ml->setNeedsSorting((isBrief && sortBriefDocs) || (!isBrief && sortMemberDocs));
  ml->append(md);

dimitri's avatar
dimitri committed
3302 3303
  // for members in the declaration lists we set the section, needed for member grouping
  if ((ml->listType()&MemberList::detailedLists)==0) md->setSectionList(this,ml);
dimitri's avatar
dimitri committed
3304 3305
}

dimitri's avatar
dimitri committed
3306 3307 3308 3309 3310 3311 3312 3313 3314 3315
void ClassDef::sortMemberLists()
{
  MemberList *ml = m_impl->memberLists.first();
  while (ml)
  {
    if (ml->needsSorting()) { ml->sort(); ml->setNeedsSorting(FALSE); }
    ml = m_impl->memberLists.next();
  }
}

dimitri's avatar
dimitri committed
3316 3317 3318
void ClassDef::writeMemberDeclarations(OutputList &ol,MemberList::ListType lt,const QCString &title,
               const char *subTitle)
{
dimitri's avatar
dimitri committed
3319
  static bool optimizeVhdl = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
dimitri's avatar
dimitri committed
3320
  MemberList * ml = getMemberList(lt);
dimitri's avatar
dimitri committed
3321 3322 3323 3324
  if (ml) 
  {
    if (optimizeVhdl) // use specific declarations function
    {
dimitri's avatar
dimitri committed
3325
      VhdlDocGen::writeVhdlDeclarations(ml,ol,0,this,0);
dimitri's avatar
dimitri committed
3326 3327 3328 3329 3330 3331
    }
    else // ise generic declaration function
    {
      ml->writeDeclarations(ol,this,0,0,0,title,subTitle); 
    }
  }
dimitri's avatar
dimitri committed
3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349
}

void ClassDef::writeMemberDocumentation(OutputList &ol,MemberList::ListType lt,const QCString &title)
{
  MemberList * ml = getMemberList(lt);
  if (ml) ml->writeDocumentation(ol,name(),this,title);
}

void ClassDef::writePlainMemberDeclaration(OutputList &ol,MemberList::ListType lt,bool inGroup)
{
  MemberList * ml = getMemberList(lt);
  if (ml) 
  {
    ml->setInGroup(inGroup);
    ml->writePlainDeclarations(ol,this,0,0,0); 
  }
}

dimitri's avatar
dimitri committed
3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446
bool ClassDef::isLocal() const 
{ 
  return m_impl->isLocal; 
}

ClassSDict *ClassDef::getInnerClasses() 
{ 
  return m_impl->innerClasses; 
}

ClassDef::CompoundType ClassDef::compoundType() const 
{ 
  return m_impl->compType; 
} 

BaseClassList *ClassDef::baseClasses() const
{ 
  return m_impl->inherits; 
}

BaseClassList *ClassDef::subClasses() const
{ 
  return m_impl->inheritedBy; 
}

MemberNameInfoSDict *ClassDef::memberNameInfoSDict() const
{ 
  return m_impl->allMemberNameInfoSDict; 
}

Protection ClassDef::protection() const 
{ 
  return m_impl->prot; 
}

ArgumentList *ClassDef::templateArguments() const 
{ 
  return m_impl->tempArgs; 
}

NamespaceDef *ClassDef::getNamespaceDef() const
{ 
  return m_impl->nspace; 
}

FileDef *ClassDef::getFileDef() const 
{ 
  return m_impl->fileDef; 
}

QDict<ClassDef> *ClassDef::getTemplateInstances() const 
{ 
  return m_impl->templateInstances; 
}

ClassDef *ClassDef::templateMaster() const 
{ 
  return m_impl->templateMaster; 
} 

bool ClassDef::isTemplate() const 
{ 
  return m_impl->tempArgs!=0; 
}

IncludeInfo *ClassDef::includeInfo() const 
{ 
  return m_impl->incInfo; 
}

UsesClassDict *ClassDef::usedImplementationClasses() const 
{ 
  return m_impl->usesImplClassDict; 
}

UsesClassDict *ClassDef::usedByImplementationClasses() const 
{ 
  return m_impl->usedByImplClassDict; 
}

UsesClassDict *ClassDef::usedInterfaceClasses() const
{
  return m_impl->usesIntfClassDict;
}

bool ClassDef::isTemplateArgument() const
{
  return m_impl->isTemplArg;
}

bool ClassDef::isAbstract() const 
{ 
  return m_impl->isAbstract; 
}

bool ClassDef::isObjectiveC() const 
{ 
dimitri's avatar
dimitri committed
3447 3448 3449 3450 3451 3452
  return m_impl->lang==SrcLangExt_ObjC; 
}

bool ClassDef::isCSharp() const 
{ 
  return m_impl->lang==SrcLangExt_CSharp; 
dimitri's avatar
dimitri committed
3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494
}

ClassDef *ClassDef::categoryOf() const 
{ 
  return m_impl->categoryOf; 
}

const QList<MemberList> &ClassDef::getMemberLists() const 
{ 
  return m_impl->memberLists; 
}

MemberGroupSDict *ClassDef::getMemberGroupSDict() const 
{ 
  return m_impl->memberGroupSDict; 
}

void ClassDef::setNamespace(NamespaceDef *nd) 
{ 
  m_impl->nspace = nd; 
}

void ClassDef::setFileDef(FileDef *fd) 
{ 
  m_impl->fileDef=fd; 
}

void ClassDef::setSubGrouping(bool enabled) 
{ 
  m_impl->subGrouping = enabled; 
}

void ClassDef::setProtection(Protection p) 
{ 
  m_impl->prot=p; 
}

void ClassDef::setIsStatic(bool b) 
{ 
  m_impl->isStatic=b; 
}

dimitri's avatar
dimitri committed
3495
void ClassDef::setLanguage(SrcLangExt lang) 
dimitri's avatar
dimitri committed
3496
{ 
dimitri's avatar
dimitri committed
3497
  m_impl->lang=lang; 
dimitri's avatar
dimitri committed
3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519
}

void ClassDef::setCompoundType(CompoundType t) 
{ 
  m_impl->compType = t; 
} 

void ClassDef::setTemplateMaster(ClassDef *tm) 
{ 
  m_impl->templateMaster=tm; 
}

void ClassDef::makeTemplateArgument(bool b) 
{ 
  m_impl->isTemplArg = b; 
}

void ClassDef::setCategoryOf(ClassDef *cd)
{
  m_impl->categoryOf = cd;
}

dimitri's avatar
dimitri committed
3520 3521 3522 3523 3524 3525 3526 3527 3528 3529
void ClassDef::setUsedOnly(bool b)
{
  m_impl->usedOnly = b;
}

bool ClassDef::isUsedOnly() const
{
  return m_impl->usedOnly;
}

dimitri's avatar
dimitri committed
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541
void ClassDef::reclassifyMember(MemberDef *md,MemberDef::MemberType t)
{
  md->setMemberType(t);
  MemberList *ml = m_impl->memberLists.first();
  while (ml)
  {
    ml->remove(md);
    ml = m_impl->memberLists.next();
  }
  insertMember(md);
}