groupdef.h

Go to the documentation of this file.

/******************************************************************************
 *
 * Copyright (C) 1997-2026 by Dimitri van Heesch.
 *
 * 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.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */
 
#ifndef GROUPDEF_H
#define GROUPDEF_H
 
#include <memory>
 
#include "definition.h"
#include "linkedmap.h"
 
class ClassDef;
class ClassLinkedRefMap;
class ConceptDef;
class ConceptLinkedRefMap;
class DirDef;
class DirList;
class Entry;
class FileDef;
class FileList;
class GroupList;
class MemberDef;
class MemberGroupList;
class MemberList;
class MemberLists;
class ModuleDef;
class ModuleLinkedRefMap;
class NamespaceDef;
class NamespaceLinkedRefMap;
class OutputList;
class PageDef;
class PageLinkedRefMap;
 
/** A model of a group of symbols. */
class GroupDef : public DefinitionMutable, public Definition
{
  public:
    ABSTRACT_BASE_CLASS(GroupDef)
 
    virtual DString groupTitle() const = 0;
    virtual DString groupTitleAsText() const = 0;
    virtual void setGroupTitle( const DString &newtitle ) = 0;
    virtual bool hasGroupTitle( ) const = 0;
    virtual void addFile(FileDef *def) = 0;
    virtual bool containsFile(const FileDef *def) const = 0;
    virtual bool addClass(ClassDef *def) = 0;
    virtual bool addConcept(ConceptDef *def) = 0;
    virtual bool addModule(ModuleDef *def) = 0;
    virtual bool addNamespace(NamespaceDef *def) = 0;
    virtual void addGroup(GroupDef *def) = 0;
    virtual void addPage(PageDef *def) = 0;
    virtual void addExample(PageDef *def) = 0;
    virtual void addDir(DirDef *dd) = 0;
    virtual bool insertMember(MemberDef *def,bool docOnly=false) = 0;
    virtual void removeMember(MemberDef *md) = 0;
    virtual bool findGroup(const GroupDef *def) const = 0;
    virtual void writeDocumentation(OutputList &ol) = 0;
    virtual void writeMemberPages(OutputList &ol, int hierarchyLevel) = 0;
    virtual void writeTagFile(TextStream &) = 0;
    virtual size_t numDocMembers() const = 0;
    virtual bool isVisibleInHierarchy() const = 0;
    virtual bool isASubGroup() const = 0;
    virtual void computeAnchors() = 0;
    virtual void countMembers() = 0;
 
    virtual void addMembersToMemberGroup() = 0;
    virtual void distributeMemberGroupDocumentation() = 0;
    virtual void findSectionsInDocumentation() = 0;
 
    virtual void addListReferences() = 0;
    virtual void addRequirementReferences() = 0;
    virtual void sortMemberLists() = 0;
    virtual bool subGrouping() const = 0;
 
    virtual void setGroupScope(Definition *d) = 0;
    virtual Definition *getGroupScope() const = 0;
 
    virtual MemberList *getMemberList(MemberListType lt) const = 0;
    virtual const MemberLists &getMemberLists() const = 0;
 
    /* user defined member groups */
    virtual const MemberGroupList &getMemberGroups() const = 0;
 
    virtual const FileList &getFiles() const = 0;
    virtual const ClassLinkedRefMap &getClasses() const = 0;
    virtual const ConceptLinkedRefMap &getConcepts() const = 0;
    virtual const ModuleLinkedRefMap &getModules() const = 0;
    virtual const NamespaceLinkedRefMap &getNamespaces() const = 0;
    virtual const GroupList &getSubGroups() const = 0;
    virtual const PageLinkedRefMap &getPages() const = 0;
    virtual const DirList & getDirs() const = 0;
    virtual const PageLinkedRefMap &getExamples() const = 0;
    virtual bool hasDetailedDescription() const = 0;
    virtual void sortSubGroups() = 0;
 
    // group graph related members
    virtual bool hasGroupGraph() const = 0;
    virtual void overrideGroupGraph(bool e) = 0;
};
 
std::unique_ptr<GroupDef> createGroupDef(const DString &fileName,int line,const DString &name,
                                         const DString &title,const DString &refFileName=DString());
 
// --- Cast functions
 
GroupDef            *toGroupDef(Definition *d);
const GroupDef      *toGroupDef(const Definition *d);
 
// ------------------
 
class GroupLinkedMap final : public LinkedMap<GroupDef>
{
};
 
class GroupList final : public std::vector<GroupDef *>
{
};
 
void addClassToGroups    (const Entry *root,ClassDef *cd);
void addConceptToGroups  (const Entry *root,ConceptDef *cd);
void addModuleToGroups   (const Entry *root,ModuleDef *mod);
void addNamespaceToGroups(const Entry *root,NamespaceDef *nd);
void addGroupToGroups    (const Entry *root,GroupDef *subGroup);
void addMemberToGroups   (const Entry *root,MemberDef *md);
void addPageToGroups     (const Entry *root,PageDef *pd);
void addExampleToGroups  (const Entry *root,PageDef *eg);
void addDirToGroups      (const Entry *root,DirDef *dd);
 
#endif