definition.cpp 50 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-2012 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
 *
 */

mueller's avatar
mueller committed
18
#include "qtbc.h"
mueller's avatar
mueller committed
19
#include <ctype.h>
dimitri's avatar
dimitri committed
20
#include <qregexp.h>
dimitri's avatar
dimitri committed
21
#include "md5.h"
dimitri's avatar
dimitri committed
22 23
#include <stdio.h>
#include <stdlib.h>
dimitri's avatar
dimitri committed
24
#include <assert.h>
mueller's avatar
mueller committed
25
#include "config.h"
mueller's avatar
mueller committed
26
#include "definition.h"
mueller's avatar
mueller committed
27
#include "doxygen.h"
mueller's avatar
mueller committed
28 29 30
#include "language.h"
#include "message.h"
#include "outputlist.h"
dimitri's avatar
dimitri committed
31
#include "code.h"
dimitri's avatar
dimitri committed
32
#include "util.h"
dimitri's avatar
dimitri committed
33
#include "groupdef.h"
dimitri's avatar
dimitri committed
34
#include "pagedef.h"
dimitri's avatar
dimitri committed
35
#include "section.h"
dimitri's avatar
dimitri committed
36
#include "htags.h"
dimitri's avatar
dimitri committed
37
#include "parserintf.h"
dimitri's avatar
dimitri committed
38
#include "marshal.h"
dimitri's avatar
dimitri committed
39
#include "debug.h"
dimitri's avatar
dimitri committed
40
#include "vhdldocgen.h"
dimitri's avatar
dimitri committed
41

dimitri's avatar
dimitri committed
42 43 44
#define START_MARKER 0x4445465B // DEF[
#define END_MARKER   0x4445465D // DEF]

dimitri's avatar
dimitri committed
45
//-----------------------------------------------------------------------------------------
dimitri's avatar
dimitri committed
46 47 48 49

class DefinitionImpl
{
  public:
dimitri's avatar
dimitri committed
50 51
    DefinitionImpl();
   ~DefinitionImpl();
dimitri's avatar
dimitri committed
52
    void init(const char *df, const char *n);
dimitri's avatar
dimitri committed
53

dimitri's avatar
dimitri committed
54
    SectionDict *sectionDict;  // dictionary of all sections, not accessible
dimitri's avatar
dimitri committed
55

dimitri's avatar
dimitri committed
56 57 58 59
    MemberSDict *sourceRefByDict;       
    MemberSDict *sourceRefsDict;        
    QList<ListItemInfo> *xrefListItems; 
    GroupList *partOfGroups;            
dimitri's avatar
dimitri committed
60

dimitri's avatar
dimitri committed
61 62 63 64
    DocInfo   *details;    // not exported
    DocInfo   *inbodyDocs; // not exported
    BriefInfo *brief;      // not exported
    BodyInfo  *body;       // not exported
dimitri's avatar
dimitri committed
65
    QCString   docSignatures;
dimitri's avatar
dimitri committed
66 67

    QCString localName;      // local (unqualified) name of the definition
dimitri's avatar
dimitri committed
68
                             // in the future m_name should become m_localName
dimitri's avatar
dimitri committed
69 70 71 72
    QCString qualifiedName;
    QCString ref;   // reference to external documentation

    bool hidden;
dimitri's avatar
dimitri committed
73
    bool isArtificial;
dimitri's avatar
dimitri committed
74

dimitri's avatar
dimitri committed
75
    Definition *outerScope;  // not owner
dimitri's avatar
dimitri committed
76 77 78 79

    // where the item was found
    QCString defFileName;
    QCString defFileExt;
dimitri's avatar
dimitri committed
80 81

    SrcLangExt lang;
dimitri's avatar
dimitri committed
82 83
};

dimitri's avatar
dimitri committed
84 85 86
DefinitionImpl::DefinitionImpl() 
  : sectionDict(0), sourceRefByDict(0), sourceRefsDict(0), 
    xrefListItems(0), partOfGroups(0),
dimitri's avatar
dimitri committed
87
    details(0), inbodyDocs(0), brief(0), body(0), 
dimitri's avatar
dimitri committed
88 89 90 91 92 93 94 95 96 97 98 99 100 101
    outerScope(0)
{
}

DefinitionImpl::~DefinitionImpl()
{
  delete sectionDict;
  delete sourceRefByDict;
  delete sourceRefsDict;
  delete partOfGroups;
  delete xrefListItems;
  delete brief;
  delete details;
  delete body;
dimitri's avatar
dimitri committed
102
  delete inbodyDocs;
dimitri's avatar
dimitri committed
103 104
}

dimitri's avatar
dimitri committed
105
void DefinitionImpl::init(const char *df, const char *n)
dimitri's avatar
dimitri committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
{
  defFileName = df;
  int lastDot = defFileName.findRev('.');
  if (lastDot!=-1)
  {
    defFileExt = defFileName.mid(lastDot);
  }
  QCString name = n;
  if (name!="<globalScope>") 
  {
    //extractNamespaceName(m_name,m_localName,ns);
    localName=stripScope(n);
  }
  else
  {
    localName=n;
  }
  //printf("m_localName=%s\n",m_localName.data());

dimitri's avatar
dimitri committed
125 126 127 128 129 130 131 132 133 134 135 136
  brief           = 0;
  details         = 0;
  body            = 0;
  inbodyDocs      = 0;
  sourceRefByDict = 0;
  sourceRefsDict  = 0;
  sectionDict     = 0, 
  outerScope      = Doxygen::globalScope;
  partOfGroups    = 0;
  xrefListItems   = 0;
  hidden          = FALSE;
  isArtificial    = FALSE;
dimitri's avatar
dimitri committed
137
  lang            = SrcLangExt_Unknown;
dimitri's avatar
dimitri committed
138 139
}

dimitri's avatar
dimitri committed
140 141
//-----------------------------------------------------------------------------------------

dimitri's avatar
dimitri committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
static bool matchExcludedSymbols(const char *name)
{
  static QStrList &exclSyms = Config_getList("EXCLUDE_SYMBOLS");
  if (exclSyms.count()==0) return FALSE; // nothing specified
  const char *pat = exclSyms.first();
  QCString symName = name;
  while (pat)
  {
    QCString pattern = pat;
    bool forceStart=FALSE;
    bool forceEnd=FALSE;
    if (pattern.at(0)=='^') 
      pattern=pattern.mid(1),forceStart=TRUE;
    if (pattern.at(pattern.length()-1)=='$') 
      pattern=pattern.left(pattern.length()-1),forceEnd=TRUE;
    if (pattern.find('*')!=-1) // wildcard mode
    {
      QRegExp re(substitute(pattern,"*",".*"),TRUE);
      int i,pl;
      i = re.match(symName,0,&pl);
      //printf("  %d = re.match(%s) pattern=%s\n",i,symName.data(),pattern.data());
      if (i!=-1) // wildcard match
      {
        int sl=symName.length();
        // check if it is a whole word match
        if ((i==0     || pattern.at(0)=='*'    || (!isId(symName.at(i-1))  && !forceStart)) &&
            (i+pl==sl || pattern.at(i+pl)=='*' || (!isId(symName.at(i+pl)) && !forceEnd))
           )
        {
          //printf("--> name=%s pattern=%s match at %d\n",symName.data(),pattern.data(),i);
          return TRUE;
        }
      }
    }
    else if (!pattern.isEmpty()) // match words
    {
      int i = symName.find(pattern);
      if (i!=-1) // we have a match!
      {
        int pl=pattern.length();
        int sl=symName.length();
        // check if it is a whole word match
        if ((i==0     || (!isId(symName.at(i-1))  && !forceStart)) &&
            (i+pl==sl || (!isId(symName.at(i+pl)) && !forceEnd))
           )
        {
          //printf("--> name=%s pattern=%s match at %d\n",symName.data(),pattern.data(),i);
          return TRUE; 
        }
      }
    }
    pat = exclSyms.next();
  }
  //printf("--> name=%s: no match\n",name);
  return FALSE;
}

dimitri's avatar
dimitri committed
199
void Definition::addToMap(const char *name,Definition *d)
dimitri's avatar
dimitri committed
200
{
dimitri's avatar
dimitri committed
201
  bool vhdlOpt = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
dimitri's avatar
dimitri committed
202
  QCString symbolName = name;
dimitri's avatar
dimitri committed
203
  int index=computeQualifiedIndex(symbolName);
dimitri's avatar
dimitri committed
204
  if (!vhdlOpt && index!=-1) symbolName=symbolName.mid(index+2);
dimitri's avatar
dimitri committed
205 206
  if (!symbolName.isEmpty()) 
  {
dimitri's avatar
dimitri committed
207 208 209 210
    //printf("******* adding symbol `%s' (%p)\n",symbolName.data(),d);
    DefinitionIntf *di=Doxygen::symbolMap->find(symbolName);
    //printf("  addToMap(%p): looking for symbol %s: %p\n",d,symbolName.data(),di);
    if (di==0) // new Symbol
dimitri's avatar
dimitri committed
211
    {
dimitri's avatar
dimitri committed
212 213
      //printf("  new symbol!\n");
      Doxygen::symbolMap->insert(symbolName,d);
dimitri's avatar
dimitri committed
214
    }
dimitri's avatar
dimitri committed
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
    else // existing symbol
    {
      //printf("  existing symbol: ");
      if (di->definitionType()==DefinitionIntf::TypeSymbolList) // already multiple symbols
      {
        //printf("adding to exiting list\n");
        DefinitionList *dl = (DefinitionList*)di;
        dl->append(d);
      }
      else // going from one to two symbols
      {
        Doxygen::symbolMap->take(symbolName);
        DefinitionList *dl = new DefinitionList;
        //printf("replacing symbol by list %p with elements %p and %p\n",dl,di,d);
        dl->append((Definition*)di);
        dl->append(d);
        Doxygen::symbolMap->insert(symbolName,dl);
      }
    }

    // auto resize if needed
    static int sizeIndex=9;
    if (Doxygen::symbolMap->size()>SDict_primes[sizeIndex])
    {
      Doxygen::symbolMap->resize(SDict_primes[++sizeIndex]);
    }

dimitri's avatar
dimitri committed
242
    d->_setSymbolName(symbolName);
dimitri's avatar
dimitri committed
243 244 245
  }
}

dimitri's avatar
dimitri committed
246
void Definition::removeFromMap(Definition *d)
dimitri's avatar
dimitri committed
247
{
dimitri's avatar
dimitri committed
248
  QString symbolName = d->m_symbolName;
dimitri's avatar
dimitri committed
249 250
  if (!symbolName.isEmpty()) 
  {
dimitri's avatar
dimitri committed
251
    //printf("******* removing symbol `%s' (%p)\n",symbolName.data(),d);
dimitri's avatar
dimitri committed
252 253
    DefinitionIntf *di=Doxygen::symbolMap->find(symbolName);
    if (di)
dimitri's avatar
dimitri committed
254
    {
dimitri's avatar
dimitri committed
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
      if (di!=d) // symbolName not unique
      {
        //printf("  removing from list: %p!\n",di);
        DefinitionList *dl = (DefinitionList*)di;
        bool b = dl->removeRef(d);
        ASSERT(b==TRUE);
        if (dl->isEmpty())
        {
          Doxygen::symbolMap->take(symbolName);
        }
      }
      else // symbolName unique
      {
        //printf("  removing symbol %p\n",di);
        Doxygen::symbolMap->take(symbolName);
      }
dimitri's avatar
dimitri committed
271 272 273 274
    }
  }
}

dimitri's avatar
dimitri committed
275
Definition::Definition(const char *df,int dl,
dimitri's avatar
dimitri committed
276 277
                       const char *name,const char *b,
                       const char *d,bool isSymbol)
mueller's avatar
mueller committed
278
{
dimitri's avatar
dimitri committed
279
  m_name = name;
dimitri's avatar
dimitri committed
280
  m_defLine = dl;
dimitri's avatar
dimitri committed
281
  m_impl = new DefinitionImpl;
dimitri's avatar
dimitri committed
282
  m_impl->init(df,name);
dimitri's avatar
dimitri committed
283
  m_isSymbol = isSymbol;
dimitri's avatar
dimitri committed
284
  if (isSymbol) addToMap(name,this);
dimitri's avatar
dimitri committed
285
  _setBriefDescription(b,df,dl);
dimitri's avatar
dimitri committed
286
  _setDocumentation(d,df,dl,TRUE,FALSE);
dimitri's avatar
dimitri committed
287 288 289 290
  if (matchExcludedSymbols(name)) 
  {
    m_impl->hidden = TRUE;
  }
mueller's avatar
mueller committed
291 292 293 294
}

Definition::~Definition()
{
dimitri's avatar
dimitri committed
295 296 297 298 299 300 301 302 303
  if (m_isSymbol) 
  {
    removeFromMap(this);
  }
  if (m_impl)
  {
    delete m_impl;
    m_impl=0;
  }
mueller's avatar
mueller committed
304
}
mueller's avatar
mueller committed
305

dimitri's avatar
dimitri committed
306 307 308 309 310 311
void Definition::setName(const char *name)
{
  if (name==0) return;
  m_name = name;
}

dimitri's avatar
dimitri committed
312
void Definition::addSectionsToDefinition(QList<SectionInfo> *anchorList)
mueller's avatar
mueller committed
313 314
{
  if (!anchorList) return;
dimitri's avatar
dimitri committed
315
  makeResident();
dimitri's avatar
dimitri committed
316
  //printf("%s: addSectionsToDefinition(%d)\n",name().data(),anchorList->count());
dimitri's avatar
dimitri committed
317 318
  SectionInfo *si=anchorList->first();
  while (si)
mueller's avatar
mueller committed
319
  {
dimitri's avatar
dimitri committed
320 321 322
    //printf("Add section `%s' to definition `%s'\n",
    //    si->label.data(),name().data());
    SectionInfo *gsi=Doxygen::sectionDict.find(si->label);
dimitri's avatar
dimitri committed
323
    //printf("===== label=%s gsi=%p\n",si->label.data(),gsi);
dimitri's avatar
dimitri committed
324
    if (gsi==0)
mueller's avatar
mueller committed
325
    {
dimitri's avatar
dimitri committed
326
      gsi = new SectionInfo(*si);
dimitri's avatar
dimitri committed
327
      Doxygen::sectionDict.append(si->label,gsi);
mueller's avatar
mueller committed
328
    }
dimitri's avatar
dimitri committed
329
    if (m_impl->sectionDict==0) 
dimitri's avatar
dimitri committed
330
    {
dimitri's avatar
dimitri committed
331
      m_impl->sectionDict = new SectionDict(17);
dimitri's avatar
dimitri committed
332
    }
dimitri's avatar
dimitri committed
333
    if (m_impl->sectionDict->find(gsi->label)==0)
dimitri's avatar
dimitri committed
334
    {
dimitri's avatar
dimitri committed
335
      m_impl->sectionDict->append(gsi->label,gsi);
dimitri's avatar
dimitri committed
336
      gsi->definition = this;
dimitri's avatar
dimitri committed
337
    }
dimitri's avatar
dimitri committed
338
    si=anchorList->next();
mueller's avatar
mueller committed
339 340
  }
}
mueller's avatar
mueller committed
341

dimitri's avatar
dimitri committed
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
bool Definition::hasSections() const
{
  makeResident();
  //printf("Definition::hasSections(%s) #sections=%d\n",name().data(),
  //    m_impl->sectionDict ? m_impl->sectionDict->count() : 0);
  if (m_impl->sectionDict==0) return FALSE;
  SDict<SectionInfo>::Iterator li(*m_impl->sectionDict);
  SectionInfo *si;
  for (li.toFirst();(si=li.current());++li)
  {
    if (si->type==SectionInfo::Section || 
        si->type==SectionInfo::Subsection || 
        si->type==SectionInfo::Subsubsection ||
        si->type==SectionInfo::Paragraph)
    {
      return TRUE;
    }
  }
  return FALSE;
}

void Definition::addSectionsToIndex()
{
  makeResident();
  if (m_impl->sectionDict==0) return;
  //printf("Definition::addSectionsToIndex()\n");
  SDict<SectionInfo>::Iterator li(*m_impl->sectionDict);
  SectionInfo *si;
dimitri's avatar
dimitri committed
370
  int level=1;
dimitri's avatar
dimitri committed
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
  for (li.toFirst();(si=li.current());++li)
  {
    if (si->type==SectionInfo::Section       || 
        si->type==SectionInfo::Subsection    || 
        si->type==SectionInfo::Subsubsection ||
        si->type==SectionInfo::Paragraph)
    {
      //printf("  level=%d title=%s\n",level,si->title.data());
      int nextLevel = (int)si->type;
      if (nextLevel>level)
      {
        Doxygen::indexList.incContentsDepth();
      }
      else if (nextLevel<level)
      {
        Doxygen::indexList.decContentsDepth();
      }
      Doxygen::indexList.addContentsItem(TRUE,si->title,
                                         getReference(),
                                         getOutputFileBase(),
                                         si->label,
                                         FALSE,
                                         TRUE);
      level = nextLevel;
    }
  }
dimitri's avatar
dimitri committed
397
  while (level>1)
dimitri's avatar
dimitri committed
398 399 400 401 402 403
  {
    Doxygen::indexList.decContentsDepth();
    level--;
  }
}

dimitri's avatar
dimitri committed
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
void Definition::writeToc(OutputList &ol)
{
  makeResident();
  if (m_impl->sectionDict==0) return;
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);
  ol.writeString("<div class=\"toc\">");
  ol.writeString("<h3>");
  ol.writeString(theTranslator->trRTFTableOfContents());
  ol.writeString("</h3>\n");
  ol.writeString("<ul>");
  SDict<SectionInfo>::Iterator li(*m_impl->sectionDict);
  SectionInfo *si;
  int level=1;
  char cs[2];
  cs[1]='\0';
  bool inLi[5]={ FALSE, FALSE, FALSE, FALSE };
  for (li.toFirst();(si=li.current());++li)
  {
    if (si->type==SectionInfo::Section       || 
        si->type==SectionInfo::Subsection    || 
        si->type==SectionInfo::Subsubsection ||
        si->type==SectionInfo::Paragraph)
    {
      //printf("  level=%d title=%s\n",level,si->title.data());
      int nextLevel = (int)si->type;
      if (nextLevel>level)
      {
        ol.writeString("<ul>");
      }
      else if (nextLevel<level)
      {
        if (inLi[level]) ol.writeString("</li>\n");
        inLi[level]=FALSE;
        ol.writeString("</ul>\n");
      }
      cs[0]='0'+nextLevel;
      if (inLi[nextLevel]) ol.writeString("</li>\n");
      ol.writeString("<li class=\"level"+QCString(cs)+"\"><a href=\"#"+si->label+"\">"+si->title+"</a>");
      inLi[nextLevel]=TRUE;
      level = nextLevel;
    }
  }
  while (level>1)
  {
    if (inLi[level]) ol.writeString("</li>\n");
    inLi[level]=FALSE;
    ol.writeString("</ul>\n");
    level--;
  }
  if (inLi[level]) ol.writeString("</li>\n");
  inLi[level]=FALSE;
  ol.writeString("</ul>\n");
  ol.writeString("</div>\n");
  ol.popGeneratorState();
}

dimitri's avatar
dimitri committed
461 462
void Definition::writeDocAnchorsToTagFile()
{
dimitri's avatar
dimitri committed
463
  makeResident();
dimitri's avatar
dimitri committed
464
  if (!Config_getString("GENERATE_TAGFILE").isEmpty() && m_impl->sectionDict)
dimitri's avatar
dimitri committed
465
  {
dimitri's avatar
dimitri committed
466
    //printf("%s: writeDocAnchorsToTagFile(%d)\n",name().data(),m_sectionDict->count());
dimitri's avatar
dimitri committed
467
    SDict<SectionInfo>::Iterator sdi(*m_impl->sectionDict);
dimitri's avatar
dimitri committed
468 469 470
    SectionInfo *si;
    for (;(si=sdi.current());++sdi)
    {
dimitri's avatar
dimitri committed
471 472
      if (!si->generated)
      {
dimitri's avatar
dimitri committed
473
        //printf("write an entry!\n");
dimitri's avatar
dimitri committed
474
        if (definitionType()==TypeMember) Doxygen::tagFile << "  ";
dimitri's avatar
dimitri committed
475 476 477
        Doxygen::tagFile << "    <docanchor file=\"" 
                         << si->fileName << "\">" << si->label 
                         << "</docanchor>" << endl;
dimitri's avatar
dimitri committed
478
      }
dimitri's avatar
dimitri committed
479 480 481 482
    }
  }
}

dimitri's avatar
dimitri committed
483
bool Definition::_docsAlreadyAdded(const QCString &doc)
dimitri's avatar
dimitri committed
484 485 486
{
  uchar md5_sig[16];
  QCString sigStr(33);
dimitri's avatar
dimitri committed
487 488 489 490
  // to avoid mismatches due to differences in indenting, we first remove
  // double whitespaces...
  QCString docStr = doc.simplifyWhiteSpace();
  MD5Buffer((const unsigned char *)docStr.data(),docStr.length(),md5_sig);
dimitri's avatar
dimitri committed
491 492 493 494 495 496 497 498 499 500 501 502 503
  MD5SigToString(md5_sig,sigStr.data(),33);
  if (m_impl->docSignatures.find(sigStr)==-1) // new docs, add signature to prevent re-adding it
  {
    m_impl->docSignatures+=":"+sigStr;
    return FALSE;
  }
  else
  {
    return TRUE;
  }
}

void Definition::_setDocumentation(const char *d,const char *docFile,int docLine,
dimitri's avatar
dimitri committed
504 505
                                   bool stripWhiteSpace,bool atTop)
{
dimitri's avatar
dimitri committed
506
  if (d==0) return;
dimitri's avatar
dimitri committed
507
  //printf("Definition::setDocumentation(%s,%s,%d,%d)\n",d,docFile,docLine,stripWhiteSpace);
dimitri's avatar
dimitri committed
508
  QCString doc = d;
dimitri's avatar
dimitri committed
509
  if (stripWhiteSpace)
dimitri's avatar
dimitri committed
510
  {
dimitri's avatar
dimitri committed
511
    doc = stripLeadingAndTrailingEmptyLines(doc);
dimitri's avatar
dimitri committed
512
  }
dimitri's avatar
dimitri committed
513 514
  else // don't strip whitespace
  {
dimitri's avatar
dimitri committed
515
    doc=d;
dimitri's avatar
dimitri committed
516
  }
dimitri's avatar
dimitri committed
517
  if (!_docsAlreadyAdded(doc))
dimitri's avatar
dimitri committed
518
  {
dimitri's avatar
dimitri committed
519 520 521 522 523 524 525
    //printf("setting docs for %s: `%s'\n",name().data(),m_doc.data());
    if (m_impl->details==0)
    {
      m_impl->details = new DocInfo;
    }
    if (m_impl->details->doc.isEmpty()) // fresh detailed description
    {
dimitri's avatar
dimitri committed
526
      m_impl->details->doc = doc;
dimitri's avatar
dimitri committed
527 528 529
    }
    else if (atTop) // another detailed description, append it to the start
    {
dimitri's avatar
dimitri committed
530
      m_impl->details->doc = doc+"\n\n"+m_impl->details->doc;
dimitri's avatar
dimitri committed
531 532 533
    }
    else // another detailed description, append it to the end
    {
dimitri's avatar
dimitri committed
534
      m_impl->details->doc += "\n\n"+doc;
dimitri's avatar
dimitri committed
535 536 537 538 539 540
    }
    if (docLine!=-1) // store location if valid
    {
      m_impl->details->file = docFile;
      m_impl->details->line = docLine;
    }
dimitri's avatar
dimitri committed
541 542 543 544 545
    else
    {
      m_impl->details->file = docFile;
      m_impl->details->line = 1;
    }
dimitri's avatar
dimitri committed
546
  }
dimitri's avatar
dimitri committed
547
}
dimitri's avatar
dimitri committed
548

dimitri's avatar
dimitri committed
549 550 551 552
void Definition::setDocumentation(const char *d,const char *docFile,int docLine,bool stripWhiteSpace)
{
  if (d==0) return;
  makeResident();
dimitri's avatar
dimitri committed
553
  _setDocumentation(d,docFile,docLine,stripWhiteSpace,FALSE);
dimitri's avatar
dimitri committed
554 555
}

dimitri's avatar
dimitri committed
556 557
#define uni_isupper(c) (QChar(c).category()==QChar::Letter_Uppercase)

dimitri's avatar
dimitri committed
558 559 560 561 562 563 564 565 566 567 568 569
// do a UTF-8 aware search for the last real character and return TRUE 
// if that is a multibyte one.
static bool lastCharIsMultibyte(const QCString &s)
{
  int l = s.length();
  int p = 0;
  int pp = -1;
  while ((p=nextUtf8CharPosition(s,l,p))<l) pp=p;
  if (pp==-1 || ((uchar)s[pp])<0x80) return FALSE;
  return TRUE;
}

dimitri's avatar
dimitri committed
570 571
void Definition::_setBriefDescription(const char *b,const char *briefFile,int briefLine)
{
dimitri's avatar
dimitri committed
572 573 574 575
  static QCString outputLanguage = Config_getEnum("OUTPUT_LANGUAGE");
  static bool needsDot = outputLanguage!="Japanese" && 
                         outputLanguage!="Chinese" &&
                         outputLanguage!="Korean";
dimitri's avatar
dimitri committed
576 577 578 579
  QCString brief = b;
  brief = brief.stripWhiteSpace();
  if (brief.isEmpty()) return;
  int bl = brief.length();
dimitri's avatar
dimitri committed
580
  if (bl>0 && needsDot) // add punctuation if needed
mueller's avatar
mueller committed
581
  {
dimitri's avatar
dimitri committed
582 583
    int c = brief.at(bl-1);
    switch(c)
mueller's avatar
mueller committed
584
    {
dimitri's avatar
dimitri committed
585
      case '.': case '!': case '?': case '>': case ':': case ')': break;
dimitri's avatar
dimitri committed
586
      default: 
dimitri's avatar
dimitri committed
587
        if (uni_isupper(brief.at(0)) && !lastCharIsMultibyte(brief)) brief+='.'; 
dimitri's avatar
dimitri committed
588
        break;
mueller's avatar
mueller committed
589 590
    }
  }
dimitri's avatar
dimitri committed
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609

  if (m_impl->brief && !m_impl->brief->doc.isEmpty())
  {
      //printf("adding to details\n");
      _setDocumentation(brief,briefFile,briefLine,FALSE,TRUE);
  }
  else if (!_docsAlreadyAdded(brief))
  {
    //fprintf(stderr,"Definition::setBriefDescription(%s,%s,%d)\n",b,briefFile,briefLine);
    if (m_impl->brief==0)
    {
      m_impl->brief = new BriefInfo;
    }
    m_impl->brief->doc=brief;
    if (briefLine!=-1)
    {
      m_impl->brief->file = briefFile;
      m_impl->brief->line = briefLine;
    }
dimitri's avatar
dimitri committed
610 611 612 613 614
    else
    {
      m_impl->brief->file = briefFile;
      m_impl->brief->line = 1;
    }
dimitri's avatar
dimitri committed
615
  }
dimitri's avatar
dimitri committed
616 617 618 619 620 621 622
}

void Definition::setBriefDescription(const char *b,const char *briefFile,int briefLine) 
{ 
  if (b==0) return;
  makeResident();
  _setBriefDescription(b,briefFile,briefLine);
mueller's avatar
mueller committed
623
}
mueller's avatar
mueller committed
624

dimitri's avatar
dimitri committed
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
void Definition::_setInbodyDocumentation(const char *doc,const char *inbodyFile,int inbodyLine)
{
  if (m_impl->inbodyDocs==0)
  {
    m_impl->inbodyDocs = new DocInfo;
  }
  if (m_impl->inbodyDocs->doc.isEmpty()) // fresh inbody docs
  {
    m_impl->inbodyDocs->doc  = doc;
    m_impl->inbodyDocs->file = inbodyFile;
    m_impl->inbodyDocs->line = inbodyLine;
  }
  else // another inbody documentation fragment, append this to the end
  {
    m_impl->inbodyDocs->doc += QCString("\n\n")+doc;
  }
}

void Definition::setInbodyDocumentation(const char *d,const char *inbodyFile,int inbodyLine)
{
  if (d==0) return;
  makeResident();
  _setInbodyDocumentation(d,inbodyFile,inbodyLine);
}

mueller's avatar
mueller committed
650
/*! Reads a fragment of code from file \a fileName starting at 
dimitri's avatar
dimitri committed
651
 * line \a startLine and ending at line \a endLine (inclusive). The fragment is
mueller's avatar
mueller committed
652 653 654
 * stored in \a result. If FALSE is returned the code fragment could not be
 * found.
 *
dimitri's avatar
dimitri committed
655
 * The file is scanned for a opening bracket ('{') from \a startLine onward
mueller's avatar
mueller committed
656 657 658
 * The line actually containing the bracket is returned via startLine.
 * The file is scanned for a closing bracket ('}') from \a endLine backward.
 * The line actually containing the bracket is returned via endLine.
dimitri's avatar
dimitri committed
659
 * Note that for VHDL code the bracket search is not done.
mueller's avatar
mueller committed
660 661 662 663
 */
static bool readCodeFragment(const char *fileName,
                      int &startLine,int &endLine,QCString &result)
{
dimitri's avatar
dimitri committed
664
  static bool filterSourceFiles = Config_getBool("FILTER_SOURCE_FILES");
mueller's avatar
mueller committed
665 666
  //printf("readCodeFragment(%s,%d,%d)\n",fileName,startLine,endLine);
  if (fileName==0 || fileName[0]==0) return FALSE; // not a valid file name
dimitri's avatar
dimitri committed
667
  QCString filter = getFileFilter(fileName,TRUE);
dimitri's avatar
dimitri committed
668 669
  FILE *f=0;
  bool usePipe = !filter.isEmpty() && filterSourceFiles;
dimitri's avatar
dimitri committed
670
  SrcLangExt lang = getLanguageFromFileName(fileName);
dimitri's avatar
dimitri committed
671 672
  if (!usePipe) // no filter given or wanted
  {
dimitri's avatar
dimitri committed
673
    f = portable_fopen(fileName,"r");
dimitri's avatar
dimitri committed
674 675 676 677 678 679 680
  }
  else // use filter
  {
    QCString cmd=filter+" \""+fileName+"\"";
    Debug::print(Debug::ExtCmd,0,"Executing popen(`%s`)\n",cmd.data());
    f = portable_popen(cmd,"r");
  }
dimitri's avatar
dimitri committed
681 682 683 684 685
  bool found = lang==SrcLangExt_VHDL   || 
               lang==SrcLangExt_Tcl    || 
               lang==SrcLangExt_Python || 
               lang==SrcLangExt_Fortran;  
               // for VHDL, TCL, Python, and Fortran no bracket search is possible
dimitri's avatar
dimitri committed
686
  if (f)
mueller's avatar
mueller committed
687 688
  {
    int c=0;
dimitri's avatar
dimitri committed
689
    int col=0;
mueller's avatar
mueller committed
690 691
    int lineNr=1;
    // skip until the startLine has reached
dimitri's avatar
dimitri committed
692
    while (lineNr<startLine && !feof(f))
mueller's avatar
mueller committed
693
    {
dimitri's avatar
dimitri committed
694
      while ((c=fgetc(f))!='\n' && c!=EOF) /* skip */;
mueller's avatar
mueller committed
695 696
      lineNr++; 
    }
dimitri's avatar
dimitri committed
697
    if (!feof(f))
mueller's avatar
mueller committed
698
    {
dimitri's avatar
dimitri committed
699
      // skip until the opening bracket or lonely : is found
dimitri's avatar
dimitri committed
700
      char cn=0;
dimitri's avatar
dimitri committed
701
      while (lineNr<=endLine && !feof(f) && !found)
mueller's avatar
mueller committed
702
      {
dimitri's avatar
dimitri committed
703
        int pc=0;
dimitri's avatar
dimitri committed
704
        while ((c=fgetc(f))!='{' && c!=':' && c!=EOF) 
dimitri's avatar
dimitri committed
705
        {
dimitri's avatar
dimitri committed
706
          //printf("parsing char `%c'\n",c);
dimitri's avatar
dimitri committed
707 708 709 710 711 712
          if (c=='\n') 
          {
            lineNr++,col=0; 
          }
          else if (c=='\t') 
          {
dimitri's avatar
dimitri committed
713
            col+=Config_getInt("TAB_SIZE") - (col%Config_getInt("TAB_SIZE"));
dimitri's avatar
dimitri committed
714
          }
dimitri's avatar
dimitri committed
715 716 717 718 719 720 721 722 723 724 725 726 727
          else if (pc=='/' && c=='/') // skip single line comment
          {
            while ((c=fgetc(f))!='\n' && c!=EOF) pc=c;
            if (c=='\n') lineNr++,col=0;
          }
          else if (pc=='/' && c=='*') // skip C style comment
          {
            while (((c=fgetc(f))!='/' || pc!='*') && c!=EOF) 
            {
              if (c=='\n') lineNr++,col=0;
              pc=c;
            }
          }
dimitri's avatar
dimitri committed
728 729 730 731
          else
          {
            col++;
          }
dimitri's avatar
dimitri committed
732
          pc = c;
dimitri's avatar
dimitri committed
733
        }
dimitri's avatar
dimitri committed
734 735
        if (c==':')
        {
dimitri's avatar
dimitri committed
736
          cn=fgetc(f);
dimitri's avatar
dimitri committed
737 738
          if (cn!=':') found=TRUE;
        }
dimitri's avatar
dimitri committed
739
        else if (c=='{')   // } so vi matching brackets has no problem
dimitri's avatar
dimitri committed
740 741 742
        {
          found=TRUE;
        }
mueller's avatar
mueller committed
743
      }
dimitri's avatar
dimitri committed
744
      //printf(" -> readCodeFragment(%s,%d,%d) lineNr=%d\n",fileName,startLine,endLine,lineNr);
dimitri's avatar
dimitri committed
745
      if (found) 
mueller's avatar
mueller committed
746
      {
dimitri's avatar
dimitri committed
747 748 749 750 751 752 753 754 755
        // For code with more than one line,
        // fill the line with spaces until we are at the right column
        // so that the opening brace lines up with the closing brace
        if (endLine!=startLine)
        {
          QCString spaces;
          spaces.fill(' ',col);
          result+=spaces;
        }
mueller's avatar
mueller committed
756 757
        // copy until end of line
        result+=c;
dimitri's avatar
dimitri committed
758 759 760 761 762
        if (c==':') 
        {
          result+=cn;
          if (cn=='\n') lineNr++;
        }
mueller's avatar
mueller committed
763 764 765
        startLine=lineNr;
        const int maxLineLength=4096;
        char lineStr[maxLineLength];
dimitri's avatar
dimitri committed
766
        do 
mueller's avatar
mueller committed
767
        {
dimitri's avatar
dimitri committed
768
          //printf("reading line %d in range %d-%d\n",lineNr,startLine,endLine);
dimitri's avatar
dimitri committed
769
          int size_read;
dimitri's avatar
dimitri committed
770 771
          do 
          {
dimitri's avatar
dimitri committed
772
            // read up to maxLineLength-1 bytes, the last byte being zero
dimitri's avatar
dimitri committed
773
            char *p = fgets(lineStr, maxLineLength,f);
dimitri's avatar
dimitri committed
774 775 776 777 778
            //printf("  read %s",p);
            if (p) 
            {
              size_read=qstrlen(p); 
            }
dimitri's avatar
dimitri committed
779
            else  // nothing read
dimitri's avatar
dimitri committed
780 781
            {
              size_read=-1;
dimitri's avatar
dimitri committed
782
              lineStr[0]='\0';
dimitri's avatar
dimitri committed
783
            }
dimitri's avatar
dimitri committed
784 785 786
            result+=lineStr;
          } while (size_read == (maxLineLength-1));

mueller's avatar
mueller committed
787
          lineNr++; 
dimitri's avatar
dimitri committed
788
        } while (lineNr<=endLine && !feof(f));
dimitri's avatar
dimitri committed
789

dimitri's avatar
dimitri committed
790 791 792 793
        // strip stuff after closing bracket
        int newLineIndex = result.findRev('\n');
        int braceIndex   = result.findRev('}');
        if (braceIndex > newLineIndex) 
dimitri's avatar
dimitri committed
794
        {
dimitri's avatar
dimitri committed
795
          result.truncate(braceIndex+1);
mueller's avatar
mueller committed
796
        }
dimitri's avatar
dimitri committed
797
        endLine=lineNr-1;
mueller's avatar
mueller committed
798 799
      }
    }
dimitri's avatar
dimitri committed
800 801 802
    if (usePipe) 
    {
      portable_pclose(f); 
dimitri's avatar
dimitri committed
803 804
      Debug::print(Debug::FilterOutput, 0, "Filter output\n");
      Debug::print(Debug::FilterOutput,0,"-------------\n%s\n-------------\n",result.data());
dimitri's avatar
dimitri committed
805 806 807 808 809
    }
    else 
    {
      fclose(f);
    }
mueller's avatar
mueller committed
810
  }
dimitri's avatar
dimitri committed
811
  result = transcodeCharacterStringToUTF8(result);
dimitri's avatar
dimitri committed
812
  return found;
mueller's avatar
mueller committed
813 814
}

mueller's avatar
mueller committed
815
/*! Write a reference to the source code defining this definition */
dimitri's avatar
dimitri committed
816
void Definition::writeSourceDef(OutputList &ol,const char *)
mueller's avatar
mueller committed
817
{
dimitri's avatar
dimitri committed
818 819
  static bool sourceBrowser = Config_getBool("SOURCE_BROWSER");
  static bool latexSourceCode = Config_getBool("LATEX_SOURCE_CODE");
dimitri's avatar
dimitri committed
820
  makeResident();
dimitri's avatar
dimitri committed
821
  ol.pushGeneratorState();
mueller's avatar
mueller committed
822
  //printf("Definition::writeSourceRef %d %p\n",bodyLine,bodyDef);
dimitri's avatar
dimitri committed
823
  if (sourceBrowser && 
dimitri's avatar
dimitri committed
824
      m_impl->body && m_impl->body->startLine!=-1 && m_impl->body->fileDef)
mueller's avatar
mueller committed
825 826 827 828 829 830
  {
    QCString refText = theTranslator->trDefinedAtLineInSourceFile();
    int lineMarkerPos = refText.find("@0");
    int fileMarkerPos = refText.find("@1");
    if (lineMarkerPos!=-1 && fileMarkerPos!=-1) // should always pass this.
    {
dimitri's avatar
dimitri committed
831
      QCString lineStr,anchorStr;
dimitri's avatar
dimitri committed
832 833
      lineStr.sprintf("%d",m_impl->body->startLine);
      anchorStr.sprintf(Htags::useHtags ? "L%d" : "l%05d",m_impl->body->startLine);
dimitri's avatar
dimitri committed
834
      ol.startParagraph();
mueller's avatar
mueller committed
835 836 837
      if (lineMarkerPos<fileMarkerPos) // line marker before file marker
      {
        // write text left from linePos marker
dimitri's avatar
dimitri committed
838
        ol.parseText(refText.left(lineMarkerPos)); 
dimitri's avatar
dimitri committed
839 840 841 842 843 844 845 846
        ol.pushGeneratorState();
        ol.disable(OutputGenerator::RTF); 
        ol.disable(OutputGenerator::Man); 
        if (!latexSourceCode)
        {
          ol.disable(OutputGenerator::Latex);
        }
        // write line link (HTML, LaTeX optionally)
dimitri's avatar
dimitri committed
847
        ol.writeObjectLink(0,m_impl->body->fileDef->getSourceFileBase(),
mueller's avatar
mueller committed
848 849 850
            anchorStr,lineStr);
        ol.enableAll();
        ol.disable(OutputGenerator::Html);
dimitri's avatar
dimitri committed
851 852 853 854 855
        if (latexSourceCode) 
        {
          ol.disable(OutputGenerator::Latex);
        }
        // write normal text (Man/RTF, Latex optionally)
mueller's avatar
mueller committed
856
        ol.docify(lineStr);
dimitri's avatar
dimitri committed
857
        ol.popGeneratorState();
mueller's avatar
mueller committed
858 859
        
        // write text between markers
dimitri's avatar
dimitri committed
860
        ol.parseText(refText.mid(lineMarkerPos+2,
mueller's avatar
mueller committed
861 862
              fileMarkerPos-lineMarkerPos-2));

dimitri's avatar
dimitri committed
863 864 865 866 867 868 869 870
        ol.pushGeneratorState();
        ol.disable(OutputGenerator::RTF); 
        ol.disable(OutputGenerator::Man); 
        if (!latexSourceCode)
        {
          ol.disable(OutputGenerator::Latex);
        }
        // write line link (HTML, LaTeX optionally)
dimitri's avatar
dimitri committed
871 872
        ol.writeObjectLink(0,m_impl->body->fileDef->getSourceFileBase(),
            0,m_impl->body->fileDef->name());
mueller's avatar
mueller committed
873 874
        ol.enableAll();
        ol.disable(OutputGenerator::Html);
dimitri's avatar
dimitri committed
875 876 877 878 879
        if (latexSourceCode) 
        {
          ol.disable(OutputGenerator::Latex);
        }
        // write normal text (Man/RTF, Latex optionally)
dimitri's avatar
dimitri committed
880
        ol.docify(m_impl->body->fileDef->name());
dimitri's avatar
dimitri committed
881
        ol.popGeneratorState();
mueller's avatar
mueller committed
882 883
        
        // write text right from file marker
dimitri's avatar
dimitri committed
884
        ol.parseText(refText.right(
mueller's avatar
mueller committed
885 886 887 888 889
              refText.length()-fileMarkerPos-2)); 
      }
      else // file marker before line marker
      {
        // write text left from file marker
dimitri's avatar
dimitri committed
890
        ol.parseText(refText.left(fileMarkerPos)); 
dimitri's avatar
dimitri committed
891 892 893 894 895 896 897
        ol.pushGeneratorState();
        ol.disable(OutputGenerator::RTF); 
        ol.disable(OutputGenerator::Man); 
        if (!latexSourceCode)
        {
          ol.disable(OutputGenerator::Latex);
        }
mueller's avatar
mueller committed
898
        // write file link (HTML only)
dimitri's avatar
dimitri committed
899 900
        ol.writeObjectLink(0,m_impl->body->fileDef->getSourceFileBase(),
            0,m_impl->body->fileDef->name());
mueller's avatar
mueller committed
901 902
        ol.enableAll();
        ol.disable(OutputGenerator::Html);
dimitri's avatar
dimitri committed
903 904 905 906
        if (latexSourceCode) 
        {
          ol.disable(OutputGenerator::Latex);
        }
mueller's avatar
mueller committed
907
        // write normal text (Latex/Man only)
dimitri's avatar
dimitri committed
908
        ol.docify(m_impl->body->fileDef->name());
dimitri's avatar
dimitri committed
909
        ol.popGeneratorState();
mueller's avatar
mueller committed
910 911
        
        // write text between markers
dimitri's avatar
dimitri committed
912
        ol.parseText(refText.mid(fileMarkerPos+2,
mueller's avatar
mueller committed
913 914
              lineMarkerPos-fileMarkerPos-2)); 

dimitri's avatar
dimitri committed
915 916 917 918 919 920 921
        ol.pushGeneratorState();
        ol.disable(OutputGenerator::RTF); 
        ol.disable(OutputGenerator::Man); 
        if (!latexSourceCode)
        {
          ol.disable(OutputGenerator::Latex);
        }
mueller's avatar
mueller committed
922 923
        ol.disableAllBut(OutputGenerator::Html); 
        // write line link (HTML only)
dimitri's avatar
dimitri committed
924
        ol.writeObjectLink(0,m_impl->body->fileDef->getSourceFileBase(),
mueller's avatar
mueller committed
925 926 927
            anchorStr,lineStr);
        ol.enableAll();
        ol.disable(OutputGenerator::Html);
dimitri's avatar
dimitri committed
928 929 930 931
        if (latexSourceCode) 
        {
          ol.disable(OutputGenerator::Latex);
        }
mueller's avatar
mueller committed
932 933
        // write normal text (Latex/Man only)
        ol.docify(lineStr);
dimitri's avatar
dimitri committed
934
        ol.popGeneratorState();
mueller's avatar
mueller committed
935 936

        // write text right from linePos marker
dimitri's avatar
dimitri committed
937
        ol.parseText(refText.right(
mueller's avatar
mueller committed
938 939
              refText.length()-lineMarkerPos-2)); 
      }
dimitri's avatar
dimitri committed
940
      ol.endParagraph();
mueller's avatar
mueller committed
941 942 943
    }
    else
    {
dimitri's avatar
dimitri committed
944
      err("error: translation error: invalid markers in trDefinedInSourceFile()\n");
mueller's avatar
mueller committed
945 946
    }
  }
dimitri's avatar
dimitri committed
947 948 949
  ol.popGeneratorState();
}

dimitri's avatar
dimitri committed
950 951 952
void Definition::setBodySegment(int bls,int ble) 
{
  //printf("setBodySegment(%d,%d) for %s\n",bls,ble,name().data());
dimitri's avatar
dimitri committed
953
  makeResident();
dimitri's avatar
dimitri committed
954 955 956
  if (m_impl->body==0) m_impl->body = new BodyInfo;
  m_impl->body->startLine=bls; 
  m_impl->body->endLine=ble; 
dimitri's avatar
dimitri committed
957 958 959 960
}

void Definition::setBodyDef(FileDef *fd)         
{
dimitri's avatar
dimitri committed
961
  makeResident();
dimitri's avatar
dimitri committed
962 963
  if (m_impl->body==0) m_impl->body = new BodyInfo;
  m_impl->body->fileDef=fd; 
dimitri's avatar
dimitri committed
964 965
}

dimitri's avatar
dimitri committed
966 967 968
/*! Write code of this definition into the documentation */
void Definition::writeInlineCode(OutputList &ol,const char *scopeName)
{
dimitri's avatar
dimitri committed
969
  makeResident();
dimitri's avatar
dimitri committed
970
  ol.pushGeneratorState();
dimitri's avatar
dimitri committed
971
  //printf("Source Fragment %s: %d-%d bodyDef=%p\n",name().data(),
dimitri's avatar
dimitri committed
972
  //        m_startBodyLine,m_endBodyLine,m_bodyDef);
dimitri's avatar
dimitri committed
973
  if (Config_getBool("INLINE_SOURCES") && 
dimitri's avatar
dimitri committed
974 975
      m_impl->body && m_impl->body->startLine!=-1 && 
      m_impl->body->endLine>=m_impl->body->startLine && m_impl->body->fileDef)
mueller's avatar
mueller committed
976 977
  {
    QCString codeFragment;
dimitri's avatar
dimitri committed
978 979
    int actualStart=m_impl->body->startLine,actualEnd=m_impl->body->endLine;
    if (readCodeFragment(m_impl->body->fileDef->absFilePath(),
mueller's avatar
mueller committed
980 981 982
          actualStart,actualEnd,codeFragment)
       )
    {
dimitri's avatar
dimitri committed
983 984
      //printf("Adding code fragement '%s' ext='%s'\n",
      //    codeFragment.data(),m_impl->defFileExt.data());
dimitri's avatar
dimitri committed
985
      ParserInterface *pIntf = Doxygen::parserManager->getParser(m_impl->defFileExt);
dimitri's avatar
dimitri committed
986
      pIntf->resetCodeParserState();
mueller's avatar
mueller committed
987
      //printf("Read:\n`%s'\n\n",codeFragment.data());
dimitri's avatar
dimitri committed
988 989
      MemberDef *thisMd = 0;
      if (definitionType()==TypeMember) thisMd = (MemberDef *)this;
dimitri's avatar
dimitri committed
990 991 992 993 994 995 996 997

      // vhdl  parser can' t start at an arbitrary point in the source code
      if(this->getLanguage()==SrcLangExt_VHDL)
      {
        if (thisMd) VhdlDocGen::writeCodeFragment(ol,actualStart,codeFragment,thisMd);
        return;
      }

mueller's avatar
mueller committed
998
      ol.startCodeFragment();
dimitri's avatar
dimitri committed
999 1000 1001 1002 1003
      pIntf->parseCode(ol,               // codeOutIntf
                       scopeName,        // scope
                       codeFragment,     // input
                       FALSE,            // isExample
                       0,                // exampleName
dimitri's avatar
dimitri committed
1004
                       m_impl->body->fileDef,  // fileDef
dimitri's avatar
dimitri committed
1005 1006 1007
                       actualStart,      // startLine
                       actualEnd,        // endLine
                       TRUE,             // inlineFragment
dimitri's avatar
dimitri committed
1008 1009
                       thisMd,           // memberDef
                       FALSE             // show line numbers
dimitri's avatar
dimitri committed
1010
                      );
mueller's avatar
mueller committed
1011 1012 1013
      ol.endCodeFragment();
    }
  }
dimitri's avatar
dimitri committed
1014
  ol.popGeneratorState();
mueller's avatar
mueller committed
1015 1016
}

dimitri's avatar
dimitri committed
1017 1018 1019
/*! Write a reference to the source code fragments in which this 
 *  definition is used.
 */
dimitri's avatar
dimitri committed
1020
void Definition::_writeSourceRefList(OutputList &ol,const char *scopeName,
dimitri's avatar
dimitri committed
1021
    const QCString &text,MemberSDict *members,bool /*funcOnly*/)
dimitri's avatar
dimitri committed
1022
{
dimitri's avatar
dimitri committed
1023 1024 1025
  LockingPtr<Definition> lock(this,this); // since this can be a memberDef 
                                          // accessing other memberDefs prevent
                                          // it from being flushed to disk
dimitri's avatar
dimitri committed
1026 1027 1028 1029 1030
  static bool latexSourceCode = Config_getBool("LATEX_SOURCE_CODE"); 
  static bool sourceBrowser   = Config_getBool("SOURCE_BROWSER");
  static bool refLinkSource   = Config_getBool("REFERENCES_LINK_SOURCE");
  ol.pushGeneratorState();
  if (members)
dimitri's avatar
dimitri committed
1031
  {
dimitri's avatar
dimitri committed
1032 1033
    members->sort();

dimitri's avatar
dimitri committed
1034
    ol.startParagraph();
dimitri's avatar
dimitri committed
1035
    ol.parseText(text);
dimitri's avatar
dimitri committed
1036 1037
    ol.docify(" ");

dimitri's avatar
dimitri committed
1038
    QCString ldefLine=theTranslator->trWriteList(members->count());
dimitri's avatar
dimitri committed
1039 1040 1041 1042

    QRegExp marker("@[0-9]+");
    int index=0,newIndex,matchLen;
    // now replace all markers in inheritLine with links to the classes
dimitri's avatar
dimitri committed
1043
    while ((newIndex=marker.match(ldefLine,index,&matchLen))!=-1)
dimitri's avatar
dimitri committed
1044 1045
    {
      bool ok;
dimitri's avatar
dimitri committed
1046
      ol.parseText(ldefLine.mid(index,newIndex-index));
dimitri's avatar
dimitri committed
1047
      uint entryIndex = ldefLine.mid(newIndex+1,matchLen-1).toUInt(&ok);
dimitri's avatar
dimitri committed
1048
      MemberDef *md=members->at(entryIndex);
dimitri's avatar
dimitri committed
1049 1050 1051 1052
      if (ok && md)
      {
        QCString scope=md->getScopeString();
        QCString name=md->name();
dimitri's avatar
dimitri committed
1053
        //printf("class=%p scope=%s scopeName=%s\n",md->getClassDef(),scope.data(),scopeName);
dimitri's avatar
dimitri committed
1054 1055
        if (!scope.isEmpty() && scope!=scopeName)
        {
dimitri's avatar
dimitri committed
1056
          name.prepend(scope+getLanguageSpecificSeparator(m_impl->lang));
dimitri's avatar
dimitri committed
1057
        }
dimitri's avatar
dimitri committed
1058 1059 1060 1061
        if (!md->isObjCMethod() &&
            (md->isFunction() || md->isSlot() || 
             md->isPrototype() || md->isSignal()
            )
dimitri's avatar
dimitri committed
1062 1063 1064 1065
           ) 
        {
          name+="()";
        }
dimitri's avatar
dimitri committed
1066 1067
        //Definition *d = md->getOutputFileBase();
        //if (d==Doxygen::globalScope) d=md->getBodyDef();
dimitri's avatar
dimitri committed
1068 1069 1070 1071 1072
        if (sourceBrowser &&
            !(md->isLinkable() && !refLinkSource) && 
            md->getStartBodyLine()!=-1 && 
            md->getBodyDef()
           )
dimitri's avatar
dimitri committed
1073
        {
dimitri's avatar
dimitri committed
1074
          //printf("md->getBodyDef()=%p global=%p\n",md->getBodyDef(),Doxygen::globalScope); 
dimitri's avatar
dimitri committed
1075 1076
          // for HTML write a real link
          ol.pushGeneratorState();
dimitri's avatar
dimitri committed
1077
          //ol.disableAllBut(OutputGenerator::Html);
dimitri's avatar
dimitri committed
1078 1079 1080 1081 1082 1083 1084

          ol.disable(OutputGenerator::RTF); 
          ol.disable(OutputGenerator::Man); 
          if (!latexSourceCode)
          {
            ol.disable(OutputGenerator::Latex);
          }
dimitri's avatar
dimitri committed
1085 1086
          QCString lineStr,anchorStr;
          anchorStr.sprintf("l%05d",md->getStartBodyLine());
dimitri's avatar
dimitri committed
1087
          //printf("Write object link to %s\n",md->getBodyDef()->getSourceFileBase().data());
dimitri's avatar
dimitri committed
1088
          ol.writeObjectLink(0,md->getBodyDef()->getSourceFileBase(),anchorStr,name);
dimitri's avatar
dimitri committed
1089 1090 1091 1092
          ol.popGeneratorState();

          // for the other output formats just mention the name
          ol.pushGeneratorState();
dimitri's avatar
dimitri committed
1093 1094
          ol.disable(OutputGenerator::Html);
          if (latexSourceCode)
dimitri's avatar
dimitri committed
1095 1096
          {
            ol.disable(OutputGenerator::Latex);
dimitri's avatar
dimitri committed
1097
          }
dimitri's avatar
dimitri committed
1098 1099
          ol.docify(name);
          ol.popGeneratorState();
dimitri's avatar
dimitri committed
1100
        }
dimitri's avatar
dimitri committed
1101
        else if (md->isLinkable() /*&& d && d->isLinkable()*/)
dimitri's avatar
dimitri committed
1102 1103 1104
        {
          // for HTML write a real link
          ol.pushGeneratorState();
dimitri's avatar
dimitri committed
1105 1106 1107 1108 1109 1110
          //ol.disableAllBut(OutputGenerator::Html); 
          ol.disable(OutputGenerator::RTF); 
          ol.disable(OutputGenerator::Man); 
          if (!latexSourceCode)
          {
            ol.disable(OutputGenerator::Latex);
dimitri's avatar
dimitri committed
1111 1112
          }

dimitri's avatar
dimitri committed
1113
          ol.writeObjectLink(md->getReference(),
dimitri's avatar
dimitri committed
1114 1115
              md->getOutputFileBase(),
              md->anchor(),name);
dimitri's avatar
dimitri committed
1116 1117 1118 1119 1120
          ol.popGeneratorState();

          // for the other output formats just mention the name
          ol.pushGeneratorState();
          ol.disable(OutputGenerator::Html);
dimitri's avatar
dimitri committed
1121 1122
          if (latexSourceCode)
          {
dimitri's avatar
dimitri committed
1123
            ol.disable(OutputGenerator::Latex);
dimitri's avatar
dimitri committed
1124
          }
dimitri's avatar
dimitri committed
1125 1126 1127
          ol.docify(name);
          ol.popGeneratorState();
        }
dimitri's avatar
dimitri committed
1128 1129 1130 1131 1132 1133 1134
        else
        {
          ol.docify(name);
        }
      }
      index=newIndex+matchLen;
    } 
dimitri's avatar
dimitri committed
1135
    ol.parseText(ldefLine.right(ldefLine.length()-index));
dimitri's avatar
dimitri committed
1136
    ol.writeString(".");
dimitri's avatar
dimitri committed
1137
    ol.endParagraph();
dimitri's avatar
dimitri committed
1138 1139 1140 1141
  }
  ol.popGeneratorState();
}

dimitri's avatar
dimitri committed
1142 1143
void Definition::writeSourceReffedBy(OutputList &ol,const char *scopeName)
{
dimitri's avatar
dimitri committed
1144
  makeResident();
dimitri's avatar
dimitri committed
1145 1146
  if (Config_getBool("REFERENCED_BY_RELATION"))
  {
dimitri's avatar
dimitri committed
1147
    _writeSourceRefList(ol,scopeName,theTranslator->trReferencedBy(),m_impl->sourceRefByDict,FALSE);
dimitri's avatar
dimitri committed
1148
  }
dimitri's avatar
dimitri committed
1149 1150 1151 1152
}

void Definition::writeSourceRefs(OutputList &ol,const char *scopeName)
{
dimitri's avatar
dimitri committed
1153
  makeResident();
dimitri's avatar
dimitri committed
1154 1155
  if (Config_getBool("REFERENCES_RELATION"))
  {
dimitri's avatar
dimitri committed
1156
    _writeSourceRefList(ol,scopeName,theTranslator->trReferences(),m_impl->sourceRefsDict,TRUE);
dimitri's avatar
dimitri committed
1157
  }
dimitri's avatar
dimitri committed
1158 1159
}

dimitri's avatar
dimitri committed
1160
bool Definition::hasDocumentation() const
mueller's avatar
mueller committed
1161
{ 
dimitri's avatar
dimitri committed
1162
  static bool extractAll    = Config_getBool("EXTRACT_ALL"); 
dimitri's avatar
dimitri committed
1163
  //static bool sourceBrowser = Config_getBool("SOURCE_BROWSER");
dimitri's avatar
dimitri committed
1164
  makeResident();
dimitri's avatar
dimitri committed
1165
  bool hasDocs = 
dimitri's avatar
dimitri committed
1166 1167 1168
         (m_impl->details    && !m_impl->details->doc.isEmpty())    || // has detailed docs
         (m_impl->brief      && !m_impl->brief->doc.isEmpty())      || // has brief description
         (m_impl->inbodyDocs && !m_impl->inbodyDocs->doc.isEmpty()) || // has inbody docs
dimitri's avatar
dimitri committed
1169 1170 1171 1172
         extractAll //||                   // extract everything
  //       (sourceBrowser && m_impl->body && 
  //        m_impl->body->startLine!=-1 && m_impl->body->fileDef)
         ; // link to definition
dimitri's avatar
dimitri committed
1173
  return hasDocs;
mueller's avatar
mueller committed
1174 1175
}

dimitri's avatar
dimitri committed
1176 1177
bool Definition::hasUserDocumentation() const
{
dimitri's avatar
dimitri committed
1178
  makeResident();
dimitri's avatar
dimitri committed
1179
  bool hasDocs = 
dimitri's avatar
dimitri committed
1180 1181 1182
         (m_impl->details    && !m_impl->details->doc.isEmpty()) ||
         (m_impl->brief      && !m_impl->brief->doc.isEmpty())   ||
         (m_impl->inbodyDocs && !m_impl->inbodyDocs->doc.isEmpty());
dimitri's avatar
dimitri committed
1183 1184 1185
  return hasDocs;
}

dimitri's avatar
dimitri committed
1186
void Definition::addSourceReferencedBy(MemberDef *md)
dimitri's avatar
dimitri committed
1187 1188 1189
{
  if (md)
  {
dimitri's avatar
dimitri committed
1190
    makeResident();
dimitri's avatar
dimitri committed
1191 1192
    QCString name  = md->name();
    QCString scope = md->getScopeString();
dimitri's avatar
dimitri committed
1193 1194 1195 1196 1197 1198

    if (!scope.isEmpty())
    {
      name.prepend(scope+"::");
    }

dimitri's avatar
dimitri committed
1199
    if (m_impl->sourceRefByDict==0)
dimitri's avatar
dimitri committed
1200
    {
dimitri's avatar
dimitri committed
1201
      m_impl->sourceRefByDict = new MemberSDict;
dimitri's avatar
dimitri committed
1202
    }
dimitri's avatar
dimitri committed
1203
    if (m_impl->sourceRefByDict->find(name)==0)
dimitri's avatar
dimitri committed
1204
    {
dimitri's avatar
dimitri committed
1205
      m_impl->sourceRefByDict->append(name,md);
dimitri's avatar
dimitri committed
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
    }
  }
}

void Definition::addSourceReferences(MemberDef *md)
{
  if (md)
  {
    QCString name  = md->name();
    QCString scope = md->getScopeString();
dimitri's avatar
dimitri committed
1216
    makeResident();
dimitri's avatar
dimitri committed
1217 1218 1219 1220 1221 1222

    if (!scope.isEmpty())
    {
      name.prepend(scope+"::");
    }

dimitri's avatar
dimitri committed
1223
    if (m_impl->sourceRefsDict==0)
dimitri's avatar
dimitri committed
1224
    {
dimitri's avatar
dimitri committed
1225
      m_impl->sourceRefsDict = new MemberSDict;
dimitri's avatar
dimitri committed
1226
    }
dimitri's avatar
dimitri committed
1227
    if (m_impl->sourceRefsDict->find(name)==0)
dimitri's avatar
dimitri committed
1228
    {
dimitri's avatar
dimitri committed
1229
      m_impl->sourceRefsDict->append(name,md);
dimitri's avatar
dimitri committed
1230 1231 1232 1233
    }
  }
}

dimitri's avatar
dimitri committed
1234 1235 1236 1237 1238 1239 1240
Definition *Definition::findInnerCompound(const char *)
{
  return 0;
}

void Definition::addInnerCompound(Definition *)
{
dimitri's avatar
dimitri committed
1241
  err("error: Definition::addInnerCompound() called\n");
dimitri's avatar
dimitri committed
1242 1243
}

dimitri's avatar
dimitri committed
1244
QCString Definition::qualifiedName() const
dimitri's avatar
dimitri committed
1245
{
dimitri's avatar
dimitri committed
1246 1247
  //static int count=0;
  //count++;
dimitri's avatar
dimitri committed
1248
  makeResident();
dimitri's avatar
dimitri committed
1249 1250
  if (!m_impl->qualifiedName.isEmpty()) 
  {
dimitri's avatar
dimitri committed
1251
    //count--;
dimitri's avatar
dimitri committed
1252 1253
    return m_impl->qualifiedName;
  }
dimitri's avatar
dimitri committed
1254
  
dimitri's avatar
dimitri committed
1255
  //printf("start %s::qualifiedName() localName=%s\n",name().data(),m_impl->localName.data());
dimitri's avatar
dimitri committed
1256
  if (m_impl->outerScope==0) 
dimitri's avatar
dimitri committed
1257
  {
dimitri's avatar
dimitri committed
1258 1259
    if (m_impl->localName=="<globalScope>") 
    {
dimitri's avatar
dimitri committed
1260
      //count--;
dimitri's avatar
dimitri committed
1261 1262 1263 1264
      return "";
    }
    else 
    {
dimitri's avatar
dimitri committed
1265
      //count--;
dimitri's avatar
dimitri committed
1266 1267
      return m_impl->localName; 
    }
dimitri's avatar
dimitri committed
1268
  }
dimitri's avatar
dimitri committed
1269

dimitri's avatar
dimitri committed
1270
  if (m_impl->outerScope->name()=="<globalScope>")
dimitri's avatar
dimitri committed
1271
  {
dimitri's avatar
dimitri committed
1272
    m_impl->qualifiedName = m_impl->localName;
dimitri's avatar
dimitri committed
1273 1274 1275
  }
  else
  {
dimitri's avatar
dimitri committed
1276 1277 1278
    m_impl->qualifiedName = m_impl->outerScope->qualifiedName()+
           getLanguageSpecificSeparator(getLanguage())+
           m_impl->localName;
dimitri's avatar
dimitri committed
1279
  }
dimitri's avatar
dimitri committed
1280
  //printf("end %s::qualifiedName()=%s\n",name().data(),m_impl->qualifiedName.data());
dimitri's avatar
dimitri committed
1281
  //count--;
dimitri's avatar
dimitri committed
1282
  return m_impl->qualifiedName;
dimitri's avatar
dimitri committed
1283 1284
};

dimitri's avatar
dimitri committed
1285 1286
void Definition::setOuterScope(Definition *d) 
{
dimitri's avatar
dimitri committed
1287
  makeResident();
dimitri's avatar
dimitri committed
1288
  if (m_impl->outerScope!=d)
dimitri's avatar
dimitri committed
1289
  { 
dimitri's avatar
dimitri committed
1290 1291
    m_impl->qualifiedName.resize(0); // flush cached scope name
    m_impl->outerScope = d; 
dimitri's avatar
dimitri committed
1292
  }
dimitri's avatar
dimitri committed
1293
  m_impl->hidden = m_impl->hidden || d->isHidden();
dimitri's avatar
dimitri committed
1294 1295
}

dimitri's avatar
dimitri committed
1296 1297
QCString Definition::localName() const
{
dimitri's avatar
dimitri committed
1298
  makeResident();
dimitri's avatar
dimitri committed
1299
  return m_impl->localName;
dimitri's avatar
dimitri committed
1300 1301
}

dimitri's avatar
dimitri committed
1302 1303
void Definition::makePartOfGroup(GroupDef *gd)
{
dimitri's avatar
dimitri committed
1304
  makeResident();
dimitri's avatar
dimitri committed
1305 1306
  if (m_impl->partOfGroups==0) m_impl->partOfGroups = new GroupList;
  m_impl->partOfGroups->append(gd);
dimitri's avatar
dimitri committed
1307 1308
}

dimitri's avatar
dimitri committed
1309 1310
void Definition::setRefItems(const QList<ListItemInfo> *sli)
{
dimitri's avatar
dimitri committed
1311
  //printf("%s::setRefItems()\n",name().data());
dimitri's avatar
dimitri committed
1312 1313
  if (sli)
  {
dimitri's avatar
dimitri committed
1314
    makeResident();
dimitri's avatar
dimitri committed
1315
    // deep copy the list
dimitri's avatar
dimitri committed
1316
    if (m_impl->xrefListItems==0) 
dimitri's avatar
dimitri committed
1317
    {
dimitri's avatar
dimitri committed
1318 1319
      m_impl->xrefListItems=new QList<ListItemInfo>;
      m_impl->xrefListItems->setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
1320 1321 1322 1323 1324
    }
    QListIterator<ListItemInfo> slii(*sli);
    ListItemInfo *lii;
    for (slii.toFirst();(lii=slii.current());++slii)
    {
dimitri's avatar
dimitri committed
1325
      m_impl->xrefListItems->append(new ListItemInfo(*lii));
dimitri's avatar
dimitri committed
1326 1327 1328 1329
    } 
  }
}

dimitri's avatar
dimitri committed
1330 1331
void Definition::mergeRefItems(Definition *d)
{
dimitri's avatar
dimitri committed
1332
  //printf("%s::mergeRefItems()\n",name().data());
dimitri's avatar
dimitri committed
1333 1334
  LockingPtr< QList<ListItemInfo> > xrefList = d->xrefListItems();
  if (xrefList!=0)
dimitri's avatar
dimitri committed
1335
  {
dimitri's avatar
dimitri committed
1336
    makeResident();
dimitri's avatar
dimitri committed
1337
    // deep copy the list
dimitri's avatar
dimitri committed
1338
    if (m_impl->xrefListItems==0) 
dimitri's avatar
dimitri committed
1339
    {
dimitri's avatar
dimitri committed
1340 1341
      m_impl->xrefListItems=new QList<ListItemInfo>;
      m_impl->xrefListItems->setAutoDelete(TRUE);
dimitri's avatar
dimitri committed
1342
    }
dimitri's avatar
dimitri committed
1343
    QListIterator<ListItemInfo> slii(*xrefList);
dimitri's avatar
dimitri committed
1344 1345 1346
    ListItemInfo *lii;
    for (slii.toFirst();(lii=slii.current());++slii)
    {
dimitri's avatar
dimitri committed
1347
      if (_getXRefListId(lii->type)==-1)
dimitri's avatar
dimitri committed
1348
      {
dimitri's avatar
dimitri committed
1349
        m_impl->xrefListItems->append(new ListItemInfo(*lii));
dimitri's avatar
dimitri committed
1350 1351 1352 1353 1354
      }
    } 
  }
}

dimitri's avatar
dimitri committed
1355
int Definition::_getXRefListId(const char *listName) const
dimitri's avatar
dimitri committed
1356
{
dimitri's avatar
dimitri committed
1357
  makeResident();
dimitri's avatar
dimitri committed
1358
  if (m_impl->xrefListItems)
dimitri's avatar
dimitri committed
1359
  {
dimitri's avatar
dimitri committed
1360
    QListIterator<ListItemInfo> slii(*m_impl->xrefListItems);
dimitri's avatar
dimitri committed
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
    ListItemInfo *lii;
    for (slii.toFirst();(lii=slii.current());++slii)
    {
      if (strcmp(lii->type,listName)==0)
      {
        return lii->itemId;
      }
    }
  }
  return -1;
}

dimitri's avatar
dimitri committed
1373
LockingPtr< QList<ListItemInfo> > Definition::xrefListItems() const
dimitri's avatar
dimitri committed
1374
{
dimitri's avatar
dimitri committed
1375 1376
  makeResident();
  return LockingPtr< QList<ListItemInfo> >(this,m_impl->xrefListItems);
dimitri's avatar
dimitri committed
1377
}
dimitri's avatar
dimitri committed
1378

dimitri's avatar
dimitri committed
1379 1380 1381

QCString Definition::convertNameToFile(const char *name,bool allowDots) const
{
dimitri's avatar
dimitri committed
1382
  makeResident();
dimitri's avatar
dimitri committed
1383
  if (!m_impl->ref.isEmpty())
dimitri's avatar
dimitri committed
1384 1385 1386 1387 1388 1389 1390 1391 1392
  {
    return name;
  }
  else
  {
    return ::convertNameToFile(name,allowDots);
  }
}

dimitri's avatar
dimitri committed
1393
QCString Definition::pathFragment() const
dimitri's avatar
dimitri committed
1394
{
dimitri's avatar
dimitri committed
1395
  makeResident();
dimitri's avatar
dimitri committed
1396
  QCString result;
dimitri's avatar
dimitri committed
1397
  if (m_impl->outerScope && m_impl->outerScope!=Doxygen::globalScope)
dimitri's avatar
dimitri committed
1398
  {
dimitri's avatar
dimitri committed
1399 1400 1401 1402 1403 1404
    result = m_impl->outerScope->pathFragment();
  }
  if (isLinkable())
  {
    if (!result.isEmpty()) result+="/";
    if (definitionType()==Definition::TypeGroup && ((const GroupDef*)this)->groupTitle())
dimitri's avatar
dimitri committed
1405
    {
dimitri's avatar
dimitri committed
1406 1407 1408 1409 1410
      result+=((const GroupDef*)this)->groupTitle();
    }
    else if (definitionType()==Definition::TypePage && !((const PageDef*)this)->title().isEmpty())
    {
      result+=((const PageDef*)this)->title();
dimitri's avatar
dimitri committed
1411 1412 1413
    }
    else
    {
dimitri's avatar
dimitri committed
1414
      result+=m_impl->localName;
dimitri's avatar
dimitri committed
1415
    }
dimitri's avatar
dimitri committed
1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
  }
  else
  {
    result+=m_impl->localName;
  }
  return result;
}

void Definition::writePathFragment(OutputList &ol) const
{
  makeResident();
  if (m_impl->outerScope && m_impl->outerScope!=Doxygen::globalScope)
  {
    m_impl->outerScope->writePathFragment(ol);
dimitri's avatar
dimitri committed
1430
  }
dimitri's avatar
dimitri committed
1431
  ol.writeString("      <li class=\"navelem\">");
dimitri's avatar
dimitri committed
1432 1433
  if (isLinkable())
  {
dimitri's avatar
dimitri committed
1434 1435 1436 1437
    if (definitionType()==Definition::TypeGroup && ((const GroupDef*)this)->groupTitle())
    {
      ol.writeObjectLink(getReference(),getOutputFileBase(),0,((const GroupDef*)this)->groupTitle());
    }
dimitri's avatar
dimitri committed
1438 1439 1440 1441
    else if (definitionType()==Definition::TypePage && !((const PageDef*)this)->title().isEmpty())
    {
      ol.writeObjectLink(getReference(),getOutputFileBase(),0,((const PageDef*)this)->title());
    }
dimitri's avatar
dimitri committed
1442 1443
    else if (definitionType()==Definition::TypeClass)
    {
dimitri's avatar
dimitri committed
1444 1445 1446 1447 1448 1449
      QCString name = m_impl->localName;
      if (name.right(2)=="-p" || name.right(2)=="-g")
      {
        name = name.left(name.length()-2);
      }
      ol.writeObjectLink(getReference(),getOutputFileBase(),0,name);
dimitri's avatar
dimitri committed
1450
    }
dimitri's avatar
dimitri committed
1451 1452
    else
    {
dimitri's avatar
dimitri committed
1453
      ol.writeObjectLink(getReference(),getOutputFileBase(),0,m_impl->localName);
dimitri's avatar
dimitri committed
1454
    }
dimitri's avatar
dimitri committed
1455 1456 1457 1458
  }
  else
  {
    ol.startBold();
dimitri's avatar
dimitri committed
1459
    ol.docify(m_impl->localName);
dimitri's avatar
dimitri committed
1460 1461
    ol.endBold();
  }
dimitri's avatar
dimitri committed
1462
  ol.writeString("      </li>\n");
dimitri's avatar
dimitri committed
1463 1464
}

dimitri's avatar
dimitri committed
1465
void Definition::writeNavigationPath(OutputList &ol) const
dimitri's avatar
dimitri committed
1466
{
dimitri's avatar
dimitri committed
1467 1468
  static bool generateTreeView = Config_getBool("GENERATE_TREEVIEW");

dimitri's avatar
dimitri committed
1469 1470 1471
  ol.pushGeneratorState();
  ol.disableAllBut(OutputGenerator::Html);

dimitri's avatar
dimitri committed
1472 1473 1474 1475
  if (generateTreeView)
  {
    ol.writeString("</div>\n");
  }
dimitri's avatar
dimitri committed
1476 1477 1478 1479
  //if (showSearchInfo)
  //{
  //  ol.writeSearchInfo();
  //}
dimitri's avatar
dimitri committed
1480 1481

  ol.writeString("  <div id=\"nav-path\" class=\"navpath\">\n");
dimitri's avatar
dimitri committed
1482
  ol.writeString("    <ul>\n");
dimitri's avatar
dimitri committed
1483
  writePathFragment(ol);
dimitri's avatar
dimitri committed
1484
  if (!generateTreeView)
dimitri's avatar
dimitri committed
1485 1486 1487 1488
  {
    ol.writeString("    </ul>\n");
    ol.writeString("  </div>\n");
  }
dimitri's avatar
dimitri committed
1489 1490 1491 1492

  ol.popGeneratorState();
}

dimitri's avatar
dimitri committed
1493 1494
QCString Definition::symbolName() const 
{ 
dimitri's avatar
dimitri committed
1495
  return m_symbolName; 
dimitri's avatar
dimitri committed
1496 1497
}

dimitri's avatar
dimitri committed
1498 1499
//----------------------

dimitri's avatar
dimitri committed
1500 1501
QCString Definition::documentation() const 
{ 
dimitri's avatar
dimitri committed
1502
  makeResident();
dimitri's avatar
dimitri committed
1503 1504 1505 1506 1507
  return m_impl->details ? m_impl->details->doc : QCString(""); 
}

int Definition::docLine() const 
{ 
dimitri's avatar
dimitri committed
1508
  makeResident();
dimitri's avatar
dimitri committed
1509 1510 1511 1512 1513
  return m_impl->details ? m_impl->details->line : 1; 
}

QCString Definition::docFile() const 
{ 
dimitri's avatar
dimitri committed
1514 1515
  makeResident();
  return m_impl->details ? m_impl->details->file : QCString("<"+m_name+">"); 
dimitri's avatar
dimitri committed
1516 1517
}

dimitri's avatar
dimitri committed
1518 1519
//----------------------

dimitri's avatar
dimitri committed
1520 1521
QCString Definition::briefDescription() const 
{ 
dimitri's avatar
dimitri committed
1522
  makeResident();
dimitri's avatar
dimitri committed
1523 1524 1525
  return m_impl->brief ? m_impl->brief->doc : QCString(""); 
}

dimitri's avatar
dimitri committed
1526 1527 1528
QCString Definition::briefDescriptionAsTooltip() const
{
  makeResident();
dimitri's avatar
dimitri committed
1529 1530 1531
  LockingPtr<Definition> lock(this,this); // since this can be a memberDef 
                                          // accessing other memberDefs prevent
                                          // it from being flushed to disk
dimitri's avatar
dimitri committed
1532 1533 1534 1535 1536 1537 1538
  if (m_impl->brief)
  {
    if (m_impl->brief->tooltip.isEmpty() && !m_impl->brief->doc.isEmpty())
    {
      static bool reentering=FALSE; 
      if (!reentering)
      {
dimitri's avatar
dimitri committed
1539 1540
        MemberDef *md = definitionType()==TypeMember ? (MemberDef*)this : 0;
        const Definition *scope = definitionType()==TypeMember ? getOuterScope() : this;
dimitri's avatar
dimitri committed
1541 1542
        reentering=TRUE; // prevent requests for tooltips while parsing a tooltip
        m_impl->brief->tooltip = parseCommentAsText(
dimitri's avatar
dimitri committed
1543
            scope,md,
dimitri's avatar
dimitri committed
1544 1545 1546 1547 1548 1549 1550 1551 1552
            m_impl->brief->doc,
            m_impl->brief->file,
            m_impl->brief->line);
        reentering=FALSE;
      }
    }
    return m_impl->brief->tooltip;
  }
  return QCString("");
dimitri's avatar
dimitri committed
1553 1554
}

dimitri's avatar
dimitri committed
1555 1556
int Definition::briefLine() const 
{ 
dimitri's avatar
dimitri committed
1557
  makeResident();
dimitri's avatar
dimitri committed
1558 1559 1560 1561 1562
  return m_impl->brief ? m_impl->brief->line : 1; 
}

QCString Definition::briefFile() const 
{ 
dimitri's avatar
dimitri committed
1563 1564
  makeResident();
  return m_impl->brief ? m_impl->brief->file : QCString("<"+m_name+">"); 
dimitri's avatar
dimitri committed
1565 1566
}

dimitri's avatar
dimitri committed
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589
//----------------------

QCString Definition::inbodyDocumentation() const
{
  makeResident();
  return m_impl->inbodyDocs ? m_impl->inbodyDocs->doc : QCString(""); 
}

int Definition::inbodyLine() const 
{ 
  makeResident();
  return m_impl->inbodyDocs ? m_impl->inbodyDocs->line : 1; 
}

QCString Definition::inbodyFile() const 
{ 
  makeResident();
  return m_impl->inbodyDocs ? m_impl->inbodyDocs->file : QCString("<"+m_name+">"); 
}


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

dimitri's avatar
dimitri committed
1590 1591
QCString Definition::getDefFileName() const 
{ 
dimitri's avatar
dimitri committed
1592
  makeResident();
dimitri's avatar
dimitri committed
1593 1594 1595 1596 1597
  return m_impl->defFileName; 
}

QCString Definition::getDefFileExtension() const 
{ 
dimitri's avatar
dimitri committed
1598
  makeResident();
dimitri's avatar
dimitri committed
1599 1600 1601 1602 1603
  return m_impl->defFileExt; 
}

bool Definition::isHidden() const
{
dimitri's avatar
dimitri committed
1604
  makeResident();
dimitri's avatar
dimitri committed
1605 1606 1607 1608 1609
  return m_impl->hidden;
}

bool Definition::isVisibleInProject() const 
{ 
dimitri's avatar
dimitri committed
1610
  return isLinkableInProject() && !m_impl->hidden; 
dimitri's avatar
dimitri committed
1611 1612 1613 1614
}

bool Definition::isVisible() const
{ 
dimitri's avatar
dimitri committed
1615
  return isLinkable() && !m_impl->hidden; 
dimitri's avatar
dimitri committed
1616 1617
}

dimitri's avatar
dimitri committed
1618 1619 1620 1621 1622
bool Definition::isArtificial() const
{
  return m_impl->isArtificial;
}

dimitri's avatar
dimitri committed
1623 1624
QCString Definition::getReference() const 
{ 
dimitri's avatar
dimitri committed
1625
  makeResident();
dimitri's avatar
dimitri committed
1626 1627 1628 1629 1630
  return m_impl->ref; 
}

bool Definition::isReference() const 
{ 
dimitri's avatar
dimitri committed
1631
  makeResident();
dimitri's avatar
dimitri committed
1632 1633 1634 1635 1636
  return !m_impl->ref.isEmpty(); 
}

int Definition::getStartBodyLine() const         
{ 
dimitri's avatar
dimitri committed
1637
  makeResident();
dimitri's avatar
dimitri committed
1638 1639 1640 1641 1642
  return m_impl->body ? m_impl->body->startLine : -1; 
}

int Definition::getEndBodyLine() const           
{ 
dimitri's avatar
dimitri committed
1643
  makeResident();
dimitri's avatar
dimitri committed
1644 1645 1646 1647 1648
  return m_impl->body ? m_impl->body->endLine : -1; 
}

FileDef *Definition::getBodyDef()                
{ 
dimitri's avatar
dimitri committed
1649
  makeResident();
dimitri's avatar
dimitri committed
1650 1651 1652
  return m_impl->body ? m_impl->body->fileDef : 0; 
}

dimitri's avatar
dimitri committed
1653
LockingPtr<GroupList> Definition::partOfGroups() const 
dimitri's avatar
dimitri committed
1654
{ 
dimitri's avatar
dimitri committed
1655 1656
  makeResident();
  return LockingPtr<GroupList>(this,m_impl->partOfGroups); 
dimitri's avatar
dimitri committed
1657 1658 1659 1660
}

Definition *Definition::getOuterScope() const 
{ 
dimitri's avatar
dimitri committed
1661
  makeResident();
dimitri's avatar
dimitri committed
1662 1663 1664
  return m_impl->outerScope; 
}

dimitri's avatar
dimitri committed
1665
LockingPtr<MemberSDict> Definition::getReferencesMembers() const 
dimitri's avatar
dimitri committed
1666
{ 
dimitri's avatar
dimitri committed
1667 1668
  makeResident();
  return LockingPtr<MemberSDict>(this,m_impl->sourceRefsDict); 
dimitri's avatar
dimitri committed
1669 1670
}

dimitri's avatar
dimitri committed
1671
LockingPtr<MemberSDict> Definition::getReferencedByMembers() const 
dimitri's avatar
dimitri committed
1672
{ 
dimitri's avatar
dimitri committed
1673 1674
  makeResident();
  return LockingPtr<MemberSDict>(this,m_impl->sourceRefByDict); 
dimitri's avatar
dimitri committed
1675 1676 1677 1678
}

void Definition::setReference(const char *r) 
{ 
dimitri's avatar
dimitri committed
1679
  makeResident();
dimitri's avatar
dimitri committed
1680 1681 1682
  m_impl->ref=r; 
}

dimitri's avatar
dimitri committed
1683 1684
SrcLangExt Definition::getLanguage() const
{
dimitri's avatar
dimitri committed
1685
  makeResident();
dimitri's avatar
dimitri committed
1686 1687 1688
  return m_impl->lang;
}

dimitri's avatar
dimitri committed
1689 1690
void Definition::setHidden(bool b) 
{ 
dimitri's avatar
dimitri committed
1691
  makeResident();
dimitri's avatar
dimitri committed
1692
  m_impl->hidden = m_impl->hidden || b; 
dimitri's avatar
dimitri committed
1693 1694
}

dimitri's avatar
dimitri committed
1695 1696 1697 1698 1699 1700
void Definition::setArtificial(bool b)
{
  makeResident();
  m_impl->isArtificial = b;
}

dimitri's avatar
dimitri committed
1701 1702
void Definition::setLocalName(const QCString name) 
{ 
dimitri's avatar
dimitri committed
1703
  makeResident();
dimitri's avatar
dimitri committed
1704 1705 1706
  m_impl->localName=name; 
}

dimitri's avatar
dimitri committed
1707 1708 1709 1710 1711 1712
void Definition::setLanguage(SrcLangExt lang) 
{ 
  makeResident();
  m_impl->lang=lang; 
}

dimitri's avatar
dimitri committed
1713 1714 1715 1716
void Definition::makeResident() const
{
}

dimitri's avatar
dimitri committed
1717 1718 1719
//---------------

void Definition::_setSymbolName(const QCString &name) 
dimitri's avatar
dimitri committed
1720
{ 
dimitri's avatar
dimitri committed
1721
  m_symbolName=name; 
dimitri's avatar
dimitri committed
1722
}
dimitri's avatar
dimitri committed
1723

dimitri's avatar
dimitri committed
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735
void Definition::flushToDisk() const
{
  //printf("%p: Definition::flushToDisk()\n",this);
  Definition *that = (Definition *)this;
  //printf("Definition::flushToDisk(): pos=%d\n",(int)m_storagePos); 
  marshalUInt(Doxygen::symbolStorage,START_MARKER);
  marshalSectionDict  (Doxygen::symbolStorage,m_impl->sectionDict);
  marshalMemberSDict  (Doxygen::symbolStorage,m_impl->sourceRefByDict);
  marshalMemberSDict  (Doxygen::symbolStorage,m_impl->sourceRefsDict);
  marshalItemInfoList (Doxygen::symbolStorage,m_impl->xrefListItems);
  marshalGroupList    (Doxygen::symbolStorage,m_impl->partOfGroups);
  marshalDocInfo      (Doxygen::symbolStorage,m_impl->details);
dimitri's avatar
dimitri committed
1736
  marshalDocInfo      (Doxygen::symbolStorage,m_impl->inbodyDocs);
dimitri's avatar
dimitri committed
1737
  marshalBriefInfo    (Doxygen::symbolStorage,m_impl->brief);
dimitri's avatar
dimitri committed
1738
  marshalBodyInfo     (Doxygen::symbolStorage,m_impl->body);
dimitri's avatar
dimitri committed
1739
  marshalQCString     (Doxygen::symbolStorage,m_impl->docSignatures);
dimitri's avatar
dimitri committed
1740 1741 1742 1743
  marshalQCString     (Doxygen::symbolStorage,m_impl->localName);
  marshalQCString     (Doxygen::symbolStorage,m_impl->qualifiedName);
  marshalQCString     (Doxygen::symbolStorage,m_impl->ref);
  marshalBool         (Doxygen::symbolStorage,m_impl->hidden);
dimitri's avatar
dimitri committed
1744
  marshalBool         (Doxygen::symbolStorage,m_impl->isArtificial);
dimitri's avatar
dimitri committed
1745 1746 1747
  marshalObjPointer   (Doxygen::symbolStorage,m_impl->outerScope);
  marshalQCString     (Doxygen::symbolStorage,m_impl->defFileName);
  marshalQCString     (Doxygen::symbolStorage,m_impl->defFileExt);
dimitri's avatar
dimitri committed
1748
  marshalInt          (Doxygen::symbolStorage,(int)m_impl->lang);
dimitri's avatar
dimitri committed
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767
  marshalUInt(Doxygen::symbolStorage,END_MARKER);
  delete that->m_impl;
  that->m_impl = 0;
}

void Definition::loadFromDisk() const
{
  //printf("%p: Definition::loadFromDisk()\n",this);
  Definition *that = (Definition *)this;
  assert(m_impl==0);
  that->m_impl = new DefinitionImpl;
  uint marker = unmarshalUInt(Doxygen::symbolStorage);
  assert(marker==START_MARKER);
  m_impl->sectionDict     = unmarshalSectionDict  (Doxygen::symbolStorage);
  m_impl->sourceRefByDict = unmarshalMemberSDict  (Doxygen::symbolStorage);
  m_impl->sourceRefsDict  = unmarshalMemberSDict  (Doxygen::symbolStorage);
  m_impl->xrefListItems   = unmarshalItemInfoList (Doxygen::symbolStorage);
  m_impl->partOfGroups    = unmarshalGroupList    (Doxygen::symbolStorage);
  m_impl->details         = unmarshalDocInfo      (Doxygen::symbolStorage);
dimitri's avatar
dimitri committed
1768
  m_impl->inbodyDocs      = unmarshalDocInfo      (Doxygen::symbolStorage);
dimitri's avatar
dimitri committed
1769
  m_impl->brief           = unmarshalBriefInfo    (Doxygen::symbolStorage);
dimitri's avatar
dimitri committed
1770
  m_impl->body            = unmarshalBodyInfo     (Doxygen::symbolStorage);
dimitri's avatar
dimitri committed
1771
  m_impl->docSignatures   = unmarshalQCString     (Doxygen::symbolStorage);
dimitri's avatar
dimitri committed
1772 1773 1774 1775
  m_impl->localName       = unmarshalQCString     (Doxygen::symbolStorage);
  m_impl->qualifiedName   = unmarshalQCString     (Doxygen::symbolStorage);
  m_impl->ref             = unmarshalQCString     (Doxygen::symbolStorage);
  m_impl->hidden          = unmarshalBool         (Doxygen::symbolStorage);
dimitri's avatar
dimitri committed
1776
  m_impl->isArtificial    = unmarshalBool         (Doxygen::symbolStorage);
dimitri's avatar
dimitri committed
1777 1778 1779
  m_impl->outerScope      = (Definition *)unmarshalObjPointer   (Doxygen::symbolStorage);
  m_impl->defFileName     = unmarshalQCString     (Doxygen::symbolStorage);
  m_impl->defFileExt      = unmarshalQCString     (Doxygen::symbolStorage);
dimitri's avatar
dimitri committed
1780
  m_impl->lang            = (SrcLangExt)unmarshalInt(Doxygen::symbolStorage);
dimitri's avatar
dimitri committed
1781 1782 1783 1784
  marker = unmarshalUInt(Doxygen::symbolStorage);
  assert(marker==END_MARKER);
}