stlsupport.cpp File Reference

#include "stlsupport.h"
#include "entry.h"
#include "config.h"

Include dependency graph for stlsupport.cpp:

Go to the source code of this file.

Classes
struct	STLInfo
	A struct contained the data for an STL class. More...

Functions
static void	addSTLMember (const std::shared_ptr< Entry > &root, const char *type, const char *name)
static void	addSTLIterator (const std::shared_ptr< Entry > &classEntry, const DString &name)
static void	addSTLClass (const std::shared_ptr< Entry > &root, const STLInfo *info)
static void	addSTLClasses (const std::shared_ptr< Entry > &root)
void	addSTLSupport (std::shared_ptr< Entry > &root)
	Add stub entries for the most used classes in the standard template library.

Variables
static STLInfo	g_stlinfo []

Function Documentation

addSTLClass()

void addSTLClass ( const std::shared_ptr< Entry > & root, const STLInfo * info )

static

Definition at line 166 of file stlsupport.cpp.

{
  //printf("Adding STL class %s\n",info->className);
  DString fullName = info->className;
  fullName.prepend("std::");
 
  // add fake Entry for the class
  std::shared_ptr<Entry> classEntry = std::make_shared<Entry>();
  classEntry->fileName  = "[STL]";
  classEntry->startLine = 1;
  classEntry->name      = fullName;
  classEntry->section = EntryType::makeClass();
  classEntry->brief     = "STL class";
  classEntry->hidden    = false;
  classEntry->artificial= true;
 
  // add template arguments to class
  if (info->templType1 != nullptr)
  {
    ArgumentList al;
    Argument a;
    a.type="typename";
    a.name=info->templType1;
    al.push_back(a);
    if (info->templType2 != nullptr) // another template argument
    {
      a.type="typename";
      a.name=info->templType2;
      al.push_back(a);
    }
    classEntry->tArgLists.push_back(al);
  }
  // add member variables
  if (info->templName1 != nullptr)
  {
    addSTLMember(classEntry,info->templType1,info->templName1);
  }
  if (info->templName2 != nullptr)
  {
    addSTLMember(classEntry,info->templType2,info->templName2);
  }
  if (fullName=="std::auto_ptr" ||
      fullName=="std::smart_ptr" ||
      fullName=="std::shared_ptr" ||
      fullName=="std::weak_ptr" ||
      fullName=="std::unique_ptr")
  {
    std::shared_ptr<Entry> memEntry = std::make_shared<Entry>();
    memEntry->name       = "operator->";
    memEntry->args       = "()";
    memEntry->type       = "T*";
    memEntry->protection = Protection::Public;
    memEntry->section = EntryType::makeFunction();
    memEntry->brief      = "STL member";
    memEntry->hidden     = false;
    memEntry->artificial = false;
    classEntry->moveToSubEntryAndKeep(memEntry);
  }
  Specifier virt = info->virtualInheritance ? Specifier::Virtual : Specifier::Normal;
  if (info->baseClass1 != nullptr)
  {
    classEntry->extends.emplace_back(info->baseClass1, Protection::Public, virt);
  }
  if (info->baseClass2 != nullptr)
  {
    classEntry->extends.emplace_back(info->baseClass2, Protection::Public, virt);
  }
  if (info->iterators)
  {
    // add iterator class
    addSTLIterator(classEntry,fullName+"::iterator");
    addSTLIterator(classEntry,fullName+"::const_iterator");
    addSTLIterator(classEntry,fullName+"::reverse_iterator");
    addSTLIterator(classEntry,fullName+"::const_reverse_iterator");
  }
  root->moveToSubEntryAndKeep(classEntry);
}

References addSTLClass(), addSTLIterator(), addSTLMember(), STLInfo::baseClass1, STLInfo::baseClass2, STLInfo::className, STLInfo::iterators, Argument::name, DString::prepend(), ArgumentList::push_back(), STLInfo::templName1, STLInfo::templName2, STLInfo::templType1, STLInfo::templType2, Argument::type, and STLInfo::virtualInheritance.

Referenced by addSTLClass(), and addSTLClasses().

addSTLClasses()

void addSTLClasses ( const std::shared_ptr< Entry > & root )

static

Definition at line 245 of file stlsupport.cpp.

{
  std::shared_ptr<Entry> namespaceEntry = std::make_shared<Entry>();
  namespaceEntry->fileName  = "[STL]";
  namespaceEntry->startLine = 1;
  namespaceEntry->name      = "std";
  namespaceEntry->section = EntryType::makeNamespace();
  namespaceEntry->brief     = "STL namespace";
  namespaceEntry->hidden    = false;
  namespaceEntry->artificial= true;
 
  STLInfo *info = g_stlinfo;
  while (info->className != nullptr)
  {
    addSTLClass(namespaceEntry,info);
    info++;
  }
 
  root->moveToSubEntryAndKeep(namespaceEntry);
}

References addSTLClass(), addSTLClasses(), STLInfo::className, and g_stlinfo.

Referenced by addSTLClasses(), and addSTLSupport().

addSTLIterator()

void addSTLIterator ( const std::shared_ptr< Entry > & classEntry, const DString & name )

static

Definition at line 153 of file stlsupport.cpp.

{
  std::shared_ptr<Entry> iteratorClassEntry = std::make_shared<Entry>();
  iteratorClassEntry->fileName  = "[STL]";
  iteratorClassEntry->startLine = 1;
  iteratorClassEntry->name      = name;
  iteratorClassEntry->section   = EntryType::makeClass();
  iteratorClassEntry->brief     = "STL iterator class";
  iteratorClassEntry->hidden    = false;
  iteratorClassEntry->artificial= true;
  classEntry->moveToSubEntryAndKeep(iteratorClassEntry);
}

References addSTLIterator().

Referenced by addSTLClass(), and addSTLIterator().

addSTLMember()

void addSTLMember ( const std::shared_ptr< Entry > & root, const char * type, const char * name )

static

Definition at line 140 of file stlsupport.cpp.

{
  std::shared_ptr<Entry> memEntry = std::make_shared<Entry>();
  memEntry->name       = name;
  memEntry->type       = type;
  memEntry->protection = Protection::Public;
  memEntry->section    = EntryType::makeVariable();
  memEntry->brief      = "STL member";
  memEntry->hidden     = false;
  memEntry->artificial = true;
  root->moveToSubEntryAndKeep(memEntry);
}

References addSTLMember().

Referenced by addSTLClass(), and addSTLMember().

addSTLSupport()

void addSTLSupport

(

std::shared_ptr< Entry > &

root

)

Add stub entries for the most used classes in the standard template library.

Parameters

root	Root of the entry tree to add the entries to.

Definition at line 266 of file stlsupport.cpp.

{
  if (Config_getBool(BUILTIN_STL_SUPPORT))
  {
    addSTLClasses(root);
  }
}

References addSTLClasses(), addSTLSupport(), and Config_getBool.

Referenced by addSTLSupport(), and parseInput().

Variable Documentation

g_stlinfo

STLInfo g_stlinfo[]

static

Definition at line 34 of file stlsupport.cpp.

Referenced by addSTLClasses().