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

#include "qtbc.h"
#include "membergroup.h"
#include "memberlist.h"
#include "outputlist.h"
#include "util.h"
#include "classdef.h"
#include "namespacedef.h"
#include "filedef.h"
#include "language.h"
27
#include "groupdef.h"
Dimitri van Heesch's avatar
Dimitri van Heesch committed
28
#include "doxygen.h"
29
#include "docparser.h"
30
#include "marshal.h"
Dimitri van Heesch's avatar
Dimitri van Heesch committed
31 32
#include "entry.h"
#include "md5.h"
33

34 35 36 37 38 39
//static QCString idToName(int id)
//{
//  QCString result;
//  result.sprintf("mgroup_%d",id);
//  return result;
//}
40

41 42 43 44
MemberGroup::MemberGroup()
{
}

45
MemberGroup::MemberGroup(Definition *parent,
46
      int id,const char *hdr,const char *d,const char *docFile) 
47
{
48
  //printf("New member group id=%d header=%s desc=%s\n",id,hdr,d);
49
  memberList      = new MemberList(MemberList::memberGroup);
50 51 52 53 54 55
  grpId           = id;
  grpHeader       = hdr;
  doc             = d;
  scope           = 0;
  inSameSection   = TRUE;
  inDeclSection   = 0;
56
  m_numDecMembers = -1;
57
  m_numDocMembers = -1;
58
  m_parent        = parent;
59
  m_docFile       = docFile;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
60
  m_xrefListItems = 0;
61
  //printf("Member group docs=`%s'\n",doc.data());
62 63 64 65 66 67 68
}

MemberGroup::~MemberGroup()
{
  delete memberList;
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
69
void MemberGroup::insertMember(MemberDef *md)
70
{
71
  //printf("MemberGroup::insertMember m_parent=%s memberList=%p count=%d"
72
  //       " member section list: %p\n",
73 74
  //       m_parent ? m_parent->name().data() : "<null>",
  //       memberList->first() ? memberList->first()->getSectionList(m_parent) : 0,
75
  //       memberList->count(),
76
  //       md->getSectionList(m_parent));
77
  MemberDef *firstMd = memberList->first();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
78
  if (inSameSection && memberList->count()>0 && 
Dimitri van Heesch's avatar
Dimitri van Heesch committed
79
      firstMd->getSectionList(m_parent)!=md->getSectionList(m_parent))
Dimitri van Heesch's avatar
Dimitri van Heesch committed
80 81 82 83 84
  {
    inSameSection=FALSE;
  }
  else if (inDeclSection==0)
  {
Dimitri van Heesch's avatar
Dimitri van Heesch committed
85
    inDeclSection = md->getSectionList(m_parent);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
86
    //printf("inDeclSection=%p type=%d\n",inDeclSection,inDeclSection->listType());
Dimitri van Heesch's avatar
Dimitri van Heesch committed
87
  }
88
  memberList->append(md);
89 90 91 92 93

  // copy the group of the first member in the memberGroup
  GroupDef *gd;
  if (firstMd && (gd=firstMd->getGroupDef()))
  {
94 95 96
    md->setGroupDef(gd, firstMd->getGroupPri(), 
                    firstMd->getGroupFileName(), firstMd->getGroupStartLine(), 
                    firstMd->getGroupHasDocs());
97 98
    gd->insertMember(md);
  }
99 100 101
}


Dimitri van Heesch's avatar
Dimitri van Heesch committed
102
void MemberGroup::setAnchors(ClassDef *context)
103
{
Dimitri van Heesch's avatar
Dimitri van Heesch committed
104
  ::setAnchors(context,'z',memberList,grpId);
105
}
106 107 108

void MemberGroup::writeDeclarations(OutputList &ol,
               ClassDef *cd,NamespaceDef *nd,FileDef *fd,GroupDef *gd)
109
{
110
  //printf("MemberGroup::writeDeclarations() memberList->count()=%d\n",memberList->count());
111 112 113
  QCString ldoc = doc;
  if (!ldoc.isEmpty()) ldoc.prepend("<a name=\""+anchor()+"\"></a>");
  memberList->writeDeclarations(ol,cd,nd,fd,gd,grpHeader,ldoc/*,TRUE,TRUE*/);
114 115
}

116
void MemberGroup::writePlainDeclarations(OutputList &ol,
117 118
               ClassDef *cd,NamespaceDef *nd,FileDef *fd,GroupDef *gd
              )
119
{
120
  //printf("MemberGroup::writePlainDeclarations() memberList->count()=%d\n",memberList->count());
121 122 123 124 125 126 127
  memberList->writePlainDeclarations(ol,cd,nd,fd,gd);
}

void MemberGroup::writeDocumentation(OutputList &ol,const char *scopeName,
               Definition *container)
{
  memberList->writeDocumentation(ol,scopeName,container,0);
128
}
129

130 131 132 133 134 135
void MemberGroup::writeDocumentationPage(OutputList &ol,const char *scopeName,
               Definition *container)
{
  memberList->writeDocumentationPage(ol,scopeName,container);
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
136 137 138 139 140 141 142
/*! Add this group as a subsection of the declaration section, instead
 *  of rendering it in its own section
 */
void MemberGroup::addToDeclarationSection()
{
  if (inDeclSection)
  {
143 144
    //printf("Adding group %p to list %p (type=%d)\n",this,
    //                              inDeclSection,inDeclSection->listType());
Dimitri van Heesch's avatar
Dimitri van Heesch committed
145 146 147 148
    inDeclSection->addMemberGroup(this);
  }
}

149
int MemberGroup::countDecMembers(/*bool sectionPerType*/)
Dimitri van Heesch's avatar
Dimitri van Heesch committed
150
{
151
  if (m_numDecMembers==-1) /* number of member not cached */
Dimitri van Heesch's avatar
Dimitri van Heesch committed
152
  {
153 154
    memberList->countDecMembers(/*TRUE,TRUE,sectionPerType*/);
    m_numDecMembers = memberList->numDecMembers();
Dimitri van Heesch's avatar
Dimitri van Heesch committed
155
  }
156
  return m_numDecMembers;
Dimitri van Heesch's avatar
Dimitri van Heesch committed
157
}
158

159 160 161 162 163 164 165 166 167 168
int MemberGroup::countDocMembers()
{
  if (m_numDocMembers==-1)
  {
    memberList->countDocMembers();
    m_numDocMembers = memberList->numDocMembers();
  }
  return m_numDocMembers;
}

169 170
void MemberGroup::distributeMemberGroupDocumentation()
{
171
  //printf("MemberGroup::distributeMemberGroupDocumentation() %s\n",grpHeader.data());
172
  MemberDef *md=memberList->first();
173
  while (md)
174
  {
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
    //printf("checking md=%s\n",md->name().data());
    // find the first member of the group with documentation
    if (!md->documentation().isEmpty()       ||
        !md->briefDescription().isEmpty()    ||
        !md->inbodyDocumentation().isEmpty()
       )
    {
      //printf("found it!\n");
      break;
    }
    md=memberList->next();
  }
  if (md) // distribute docs of md to other members of the list
  {
    //printf("Member %s has documentation!\n",md->name().data());
    MemberDef *omd=memberList->first();
191 192
    while (omd)
    {
193 194 195 196
      if (md!=omd && omd->documentation().isEmpty() && 
                     omd->briefDescription().isEmpty() && 
                     omd->inbodyDocumentation().isEmpty()
         )
197
      {
198
        //printf("Copying documentation to member %s\n",omd->name().data());
199 200
        omd->setBriefDescription(md->briefDescription(),md->briefFile(),md->briefLine());
        omd->setDocumentation(md->documentation(),md->docFile(),md->docLine());
201
        omd->setInbodyDocumentation(md->inbodyDocumentation(),md->inbodyFile(),md->inbodyLine());
202 203 204 205 206
      }
      omd=memberList->next();
    }
  }
}
207

Dimitri van Heesch's avatar
Dimitri van Heesch committed
208 209 210
int MemberGroup::varCount() const
{
  return memberList->varCount();
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
}

int MemberGroup::funcCount() const      
{ 
  return memberList->funcCount(); 
}

int MemberGroup::enumCount() const      
{ 
  return memberList->enumCount(); 
}

int MemberGroup::enumValueCount() const 
{ 
  return memberList->enumValueCount(); 
}

int MemberGroup::typedefCount() const   
{ 
  return memberList->typedefCount(); 
}

int MemberGroup::protoCount() const     
{ 
  return memberList->protoCount(); 
}

int MemberGroup::defineCount() const    
{ 
  return memberList->defineCount(); 
}

int MemberGroup::friendCount() const    
{ 
  return memberList->friendCount(); 
}

int MemberGroup::numDecMembers() const  
{ 
  return memberList->numDecMembers(); 
}

int MemberGroup::numDocMembers() const  
{ 
  return memberList->numDocMembers(); 
}

void MemberGroup::setInGroup(bool b)
{
  memberList->setInGroup(b);
}
262

Dimitri van Heesch's avatar
Dimitri van Heesch committed
263 264 265 266
QCString MemberGroup::anchor() const
{
  uchar md5_sig[16];
  QCString sigStr(33);
267 268 269
  QCString locHeader = grpHeader;
  if (locHeader.isEmpty()) locHeader="[NOHEADER]";
  MD5Buffer((const unsigned char *)locHeader.data(),locHeader.length(),md5_sig);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
270 271 272 273
  MD5SigToString(md5_sig,sigStr.data(),33);
  return "amgrp"+sigStr;
}

274 275 276
void MemberGroup::addListReferences(Definition *def)
{
  memberList->addListReferences(def);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
277 278
  if (m_xrefListItems && def)
  {
279 280 281 282 283 284
    QCString name = def->getOutputFileBase()+"#"+anchor();
    addRefItem(m_xrefListItems,
        name,
        theTranslator->trGroup(TRUE,TRUE),
        name,
        grpHeader,0);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
285
  }
286
}
287 288 289

void MemberGroup::findSectionsInDocumentation()
{
290
  docFindSections(doc,0,this,m_docFile);
291 292 293
  memberList->findSectionsInDocumentation();
}

294 295 296 297 298 299 300 301 302 303 304 305 306 307
void MemberGroup::marshal(StorageIntf *s)
{
  marshalMemberList(s,memberList);
  marshalObjPointer(s,inDeclSection); // reference only
  marshalInt(s,grpId);
  marshalQCString(s,grpHeader);
  marshalQCString(s,fileName);
  marshalObjPointer(s,scope);
  marshalQCString(s,doc);
  marshalBool(s,inSameSection);
  marshalInt(s,m_numDecMembers);
  marshalInt(s,m_numDocMembers);
  marshalObjPointer(s,m_parent);
  marshalQCString(s,m_docFile);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
308
  marshalItemInfoList (Doxygen::symbolStorage,m_xrefListItems);
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
}

void MemberGroup::unmarshal(StorageIntf *s)
{
  memberList      = unmarshalMemberList(s);
  inDeclSection   = (MemberList *)unmarshalObjPointer(s); 
  grpId           = unmarshalInt(s);
  grpHeader       = unmarshalQCString(s);
  fileName        = unmarshalQCString(s);
  scope           = (Definition *)unmarshalObjPointer(s);
  doc             = unmarshalQCString(s);
  inSameSection   = unmarshalBool(s);
  m_numDecMembers = unmarshalInt(s);
  m_numDocMembers = unmarshalInt(s);
  m_parent        = (Definition *)unmarshalObjPointer(s);
  m_docFile       = unmarshalQCString(s);
Dimitri van Heesch's avatar
Dimitri van Heesch committed
325
  m_xrefListItems = unmarshalItemInfoList (Doxygen::symbolStorage);
326 327
}

Dimitri van Heesch's avatar
Dimitri van Heesch committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
void MemberGroup::setRefItems(const QList<ListItemInfo> *sli)
{
  if (sli)
  {
    // deep copy the list
    if (m_xrefListItems==0) 
    {
      m_xrefListItems=new QList<ListItemInfo>;
      m_xrefListItems->setAutoDelete(TRUE);
    }
    QListIterator<ListItemInfo> slii(*sli);
    ListItemInfo *lii;
    for (slii.toFirst();(lii=slii.current());++slii)
    {
      m_xrefListItems->append(new ListItemInfo(*lii));
    } 
  }
}
//--------------------------------------------------------------------------

void MemberGroupInfo::setRefItems(const QList<ListItemInfo> *sli)
{
  if (!sli) return;
  if (m_sli==0)
  {
    m_sli = new QList<ListItemInfo>;
    m_sli->setAutoDelete(TRUE);
  }
  QListIterator<ListItemInfo> slii(*sli);
  ListItemInfo *ili;
  for (slii.toFirst();(ili=slii.current());++slii)
  {
    m_sli->append(new ListItemInfo(*ili));
  }
}