DefineManager Class Reference

Singleton that manages the defines available while proprocessing files. More...

Classes
class	DefinesPerFile

Public Member Functions
void	startContext (const char *fileName)
void	endContext ()
void	addFileToContext (const char *fileName)
void	addDefine (const char *fileName, Define *def)
void	addInclude (const char *fromFileName, const char *toFileName)
Define *	isDefined (const char *name) const
const DefineDict &	defineContext () const

Static Public Member Functions
static DefineManager &	instance ()
static void	deleteInstance ()

Private Member Functions
void	collectDefinesForFile (const char *fileName, DefineDict *dict)
DefinesPerFile *	find (const char *fileName) const
	DefineManager ()
virtual	~DefineManager ()

Private Attributes
QDict< DefinesPerFile >	m_fileMap
DefineDict	m_contextDefines

Static Private Attributes
static DefineManager *	theInstance = 0

Friends
class	DefinesPerFile

Detailed Description

Singleton that manages the defines available while proprocessing files.

Definition at line 2595 of file pre.cpp.

Constructor & Destructor Documentation

DefineManager::DefineManager ( )

inlineprivate

Creates a new DefineManager object

Definition at line 2777 of file pre.cpp.

                    : m_fileMap(1009), m_contextDefines(1009)
    {
      m_fileMap.setAutoDelete(TRUE);
    }

virtual DefineManager::~DefineManager ( )

inlineprivatevirtual

Destroys the object

Definition at line 2783 of file pre.cpp.

    {
    }

Member Function Documentation

void DefineManager::addDefine ( const char *  fileName, Define *  def  )

inline

Add a define to the manager object.

Parameters

fileName	The file in which the define was found
def	The Define object to add.

Definition at line 2703 of file pre.cpp.

    {
      if (fileName==0) return;
      //printf("DefineManager::addDefine(%s,%s)\n",fileName,def->name.data());
      Define *d = m_contextDefines.find(def->name);
      if (d!=0) // redefine
      {
        m_contextDefines.remove(d->name);
      }
      m_contextDefines.insert(def->name,def);

      DefinesPerFile *dpf = m_fileMap.find(fileName);
      if (dpf==0)
      {
        dpf = new DefinesPerFile;
        m_fileMap.insert(fileName,dpf);
      }
      dpf->addDefine(def);
    }

void DefineManager::addFileToContext ( const char *  fileName )

inline

Add an included file to the current context. If the file has been pre-processed already, all defines are added to the context.

Parameters

fileName

The name of the include file to add to the context.

Definition at line 2680 of file pre.cpp.

    {
      if (fileName==0) return;
      //printf("DefineManager::addFileToContext(%s)\n",fileName);
      DefinesPerFile *dpf = m_fileMap.find(fileName);
      if (dpf==0)
      {
        //printf("New file!\n");
        dpf = new DefinesPerFile;
        m_fileMap.insert(fileName,dpf);
      }
      else
      {
        //printf("existing file!\n");
        QDict<void> includeStack(17);
        dpf->collectDefines(&m_contextDefines,includeStack);
      }
    }

void DefineManager::addInclude ( const char *  fromFileName, const char *  toFileName  )

inline

Add an include relation to the manager object.

Parameters

fromFileName	file name in which the include was found.
toFileName	file name that is included.

Definition at line 2727 of file pre.cpp.

    {
      //printf("DefineManager::addInclude(%s,%s)\n",fromFileName,toFileName);
      if (fromFileName==0 || toFileName==0) return;
      DefinesPerFile *dpf = m_fileMap.find(fromFileName);
      if (dpf==0)
      {
        dpf = new DefinesPerFile;
        m_fileMap.insert(fromFileName,dpf);
      }
      dpf->addInclude(toFileName);
    }

void DefineManager::collectDefinesForFile ( const char *  fileName, DefineDict *  dict  )

inlineprivate

Helper function to collect all define for a given file

Definition at line 2758 of file pre.cpp.

    {
      if (fileName==0) return;
      DefinesPerFile *dpf = m_fileMap.find(fileName);
      if (dpf)
      {
        QDict<void> includeStack(17);
        dpf->collectDefines(dict,includeStack);
      }
    }

const DefineDict& DefineManager::defineContext ( ) const

inline

Returns a reference to the defines found in the current context.

Definition at line 2750 of file pre.cpp.

    {
      return m_contextDefines;
    }

static void DefineManager::deleteInstance ( )

inlinestatic

Deletes the singleton

Definition at line 2645 of file pre.cpp.

    {
      delete theInstance;
      theInstance = 0;
    }

void DefineManager::endContext ( )

inline

Ends the context started with startContext() freeing any defines collected within in this context.

Definition at line 2670 of file pre.cpp.

    {
      //printf("DefineManager::endContext()\n");
      m_contextDefines.clear();
    }

DefinesPerFile* DefineManager::find ( const char *  fileName ) const

inlineprivate

Helper function to return the DefinesPerFile object for a given file name.

Definition at line 2770 of file pre.cpp.

    {
      if (fileName==0) return 0;
      return m_fileMap.find(fileName);
    }

static DefineManager& DefineManager::instance ( )

inlinestatic

Returns a reference to the singleton

Definition at line 2639 of file pre.cpp.

    {
      if (theInstance==0) theInstance = new DefineManager;
      return *theInstance;
    }

Define* DefineManager::isDefined ( const char *  name ) const

inline

Returns a Define object given its name or 0 if the Define does not exist.

Definition at line 2742 of file pre.cpp.

    {
      Define *d = m_contextDefines.find(name);
      if (d && d->undef) d=0;
      //printf("isDefined(%s)=%p\n",name,d);
      return d;
    }

void DefineManager::startContext ( const char *  fileName )

inline

Starts a context in which defines are collected. Called at the start of a new file that is preprocessed.

Parameters

fileName

the name of the file to process.

Definition at line 2654 of file pre.cpp.

    {
      //printf("DefineManager::startContext()\n");
      m_contextDefines.clear();
      if (fileName==0) return;
      DefinesPerFile *dpf = m_fileMap.find(fileName);
      if (dpf==0)
      {
        //printf("New file!\n");
        dpf = new DefinesPerFile;
        m_fileMap.insert(fileName,dpf);
      }
    }

Friends And Related Function Documentation

friend class DefinesPerFile

friend

Definition at line 2637 of file pre.cpp.

Member Data Documentation

DefineDict DefineManager::m_contextDefines

private

Definition at line 2788 of file pre.cpp.

QDict<DefinesPerFile> DefineManager::m_fileMap

private

Definition at line 2787 of file pre.cpp.

DefineManager * DefineManager::theInstance = 0

staticprivate

Singleton instance

Definition at line 2755 of file pre.cpp.

---

The documentation for this class was generated from the following file:

• doxygen-1.8.11/build/generated_src/pre.cpp