Doxygen
Loading...
Searching...
No Matches
Preprocessor Class Reference

#include <src/pre.h>

Classes

struct  Private
 

Public Member Functions

 Preprocessor ()
 
 ~Preprocessor ()
 
void processFile (const QCString &fileName, const std::string &input, std::string &output)
 
void addSearchDir (const QCString &dir)
 

Private Attributes

std::unique_ptr< Privatep
 

Detailed Description

Definition at line 27 of file pre.h.

Constructor & Destructor Documentation

◆ Preprocessor()

Preprocessor::Preprocessor ( )

Definition at line 3999 of file pre.l.

3999 : p(std::make_unique<Private>())
4000{
4001 preYYlex_init_extra(&p->state,&p->yyscanner);
4002 addSearchDir(".");
4003}
void addSearchDir(const QCString &dir)
Definition pre.l:3992
std::unique_ptr< Private > p
Definition pre.h:38

References addSearchDir(), and p.

◆ ~Preprocessor()

Preprocessor::~Preprocessor ( )

Definition at line 4005 of file pre.l.

4006{
4007 preYYlex_destroy(p->yyscanner);
4008}

References p.

Member Function Documentation

◆ addSearchDir()

void Preprocessor::addSearchDir ( const QCString & dir)

Definition at line 3992 of file pre.l.

3993{
3994 YY_EXTRA_TYPE state = preYYget_extra(p->yyscanner);
3995 FileInfo fi(dir.str());
3996 if (fi.isDir()) state->pathList.push_back(fi.absFilePath());
3997}
const std::string & str() const
Definition qcstring.h:537

References FileInfo::absFilePath(), FileInfo::isDir(), p, and QCString::str().

Referenced by parseFile(), and Preprocessor().

◆ processFile()

void Preprocessor::processFile ( const QCString & fileName,
const std::string & input,
std::string & output )

Definition at line 4010 of file pre.l.

4011{
4012 AUTO_TRACE("fileName={}",fileName);
4013 yyscan_t yyscanner = p->yyscanner;
4014 YY_EXTRA_TYPE state = preYYget_extra(p->yyscanner);
4015 struct yyguts_t *yyg = (struct yyguts_t*)p->yyscanner;
4016
4017#ifdef FLEX_DEBUG
4018 preYYset_debug(Debug::isFlagSet(Debug::Lex_pre)?1:0,yyscanner);
4019#endif
4020
4021 DebugLex debugLex(Debug::Lex_pre, __FILE__, qPrint(fileName));
4022 //printf("##########################\n%s\n####################\n",
4023 // qPrint(input));
4024
4025 state->macroExpansion = Config_getBool(MACRO_EXPANSION);
4026 state->expandOnlyPredef = Config_getBool(EXPAND_ONLY_PREDEF);
4027 state->skip=FALSE;
4028 state->curlyCount=0;
4029 state->lexRulesPart=false;
4030 state->nospaces=FALSE;
4031 state->inputBuf=&input;
4032 state->inputBufPos=0;
4033 state->outputBuf=&output;
4034 state->includeStack.clear();
4035 state->expandedDict.clear();
4036 state->contextDefines.clear();
4037 state->pragmaSet.clear();
4038 while (!state->condStack.empty()) state->condStack.pop();
4039
4040 setFileName(yyscanner,fileName);
4041
4042 state->inputFileDef = state->yyFileDef;
4043 //yyextra->defineManager.startContext(state->fileName);
4044
4045 initPredefined(yyscanner,fileName);
4046
4047 state->yyLineNr = 1;
4048 state->yyColNr = 1;
4049 state->ifcount = 0;
4050
4051 BEGIN( Start );
4052
4053 state->expectGuard = guessSection(fileName).isHeader();
4054 state->guardName.clear();
4055 state->lastGuardName.clear();
4056 state->guardExpr.clear();
4057
4058 preYYlex(yyscanner);
4059
4060 while (!state->condStack.empty())
4061 {
4062 const std::unique_ptr<preYY_CondCtx> &ctx = state->condStack.top();
4063 QCString sectionInfo = " ";
4064 if (ctx->sectionId!=" ") sectionInfo.sprintf(" with label '%s' ",qPrint(ctx->sectionId.stripWhiteSpace()));
4065 warn(ctx->fileName,ctx->lineNr,"Conditional section{}does not have "
4066 "a corresponding \\endcond command within this file.",sectionInfo);
4067 state->condStack.pop();
4068 }
4069 // make sure we don't extend a \cond with missing \endcond over multiple files (see bug 624829)
4070 forceEndCondSection(yyscanner);
4071
4072 if (!state->levelGuard.empty())
4073 {
4074 warn(state->fileName,state->yyLineNr,"More #if's than #endif's found (might be in an included file).");
4075 }
4076
4078 {
4079 std::lock_guard<std::mutex> lock(g_debugMutex);
4080 Debug::print(Debug::Preprocessor,0,"Preprocessor output of {} (size: {} bytes):\n",fileName,output.size());
4081 std::string contents;
4083 {
4084 contents=output;
4085 }
4086 else // need to add line numbers
4087 {
4088 int line=1;
4089 bool startOfLine = true;
4090 size_t content_size = output.size() +
4091 output.size()*6/40; // assuming 40 chars per line on average
4092 // and 6 chars extra for the line number
4093 contents.reserve(content_size);
4094 size_t pos=0;
4095 while (pos<output.size())
4096 {
4097 if (startOfLine)
4098 {
4099 char lineNrStr[15];
4100 snprintf(lineNrStr,15,"%05d ",line++);
4101 contents+=lineNrStr;
4102 }
4103 contents += output[pos];
4104 startOfLine = output[pos]=='\n';
4105 pos++;
4106 }
4107 }
4108 char end[2]={0,0};
4109 if (!contents.empty() && contents[contents.length()-1]!='\n')
4110 {
4111 end[0]='\n';
4112 }
4113 Debug::print(Debug::Preprocessor,0,"---------\n{}{}---------\n",contents,end);
4114 if (yyextra->contextDefines.size()>0)
4115 {
4116 Debug::print(Debug::Preprocessor,0,"Macros accessible in this file ({}):\n", fileName);
4117 Debug::print(Debug::Preprocessor,0,"---------\n");
4118 for (auto &kv : yyextra->contextDefines)
4119 {
4120 Debug::print(Debug::Preprocessor,0,"{} ",kv.second.name);
4121 }
4122 for (auto &kv : yyextra->localDefines)
4123 {
4124 Debug::print(Debug::Preprocessor,0,"{} ",kv.second.name);
4125 }
4126 Debug::print(Debug::Preprocessor,0,"\n---------\n");
4127 }
4128 else
4129 {
4130 Debug::print(Debug::Preprocessor,0,"No macros accessible in this file ({}).\n", fileName);
4131 }
4132 }
4133
4134 {
4135 std::lock_guard<std::mutex> lock(g_updateGlobals);
4136 for (const auto &inc : state->includeRelations)
4137 {
4138 auto toKind = [](bool local,bool imported) -> IncludeKind
4139 {
4140 if (local)
4141 {
4142 if (imported)
4143 {
4145 }
4147 }
4148 else if (imported)
4149 {
4151 }
4153 };
4154 if (inc->fromFileDef)
4155 {
4156 inc->fromFileDef->addIncludeDependency(inc->toFileDef,inc->includeName,toKind(inc->local,inc->imported));
4157 }
4158 if (inc->toFileDef && inc->fromFileDef)
4159 {
4160 inc->toFileDef->addIncludedByDependency(inc->fromFileDef,inc->fromFileDef->docName(),toKind(inc->local,inc->imported));
4161 }
4162 }
4163 // add the macro definition for this file to the global map
4164 Doxygen::macroDefinitions.emplace(state->fileName.str(),std::move(state->macroDefinitions));
4165 }
4166
4167 //yyextra->defineManager.endContext();
4168}
@ NoLineNo
Definition debug.h:42
@ Lex_pre
Definition debug.h:64
@ Preprocessor
Definition debug.h:30
static bool isFlagSet(const DebugMask mask)
Definition debug.cpp:132
static void print(DebugMask mask, int prio, fmt::format_string< Args... > fmt, Args &&... args)
Definition debug.h:76
static DefinesPerFileList macroDefinitions
Definition doxygen.h:137
QCString & sprintf(const char *format,...)
Definition qcstring.cpp:29
yyguts_t * yyscan_t
Definition code.l:24
#define Config_getBool(name)
Definition config.h:33
DirIterator end(const DirIterator &) noexcept
Definition dir.cpp:175
#define AUTO_TRACE(...)
Definition docnode.cpp:46
IncludeKind
Definition filedef.h:47
@ IncludeLocal
Definition filedef.h:50
@ ImportSystemObjC
Definition filedef.h:51
@ ImportLocalObjC
Definition filedef.h:52
@ IncludeSystem
Definition filedef.h:49
#define warn(file, line, fmt,...)
Definition message.h:97
static void initPredefined(yyscan_t yyscanner, const QCString &fileName)
Definition pre.l:3865
static void setFileName(yyscan_t yyscanner, const QCString &name)
Definition pre.l:2150
static void forceEndCondSection(yyscan_t yyscanner)
Definition pre.l:3721
static std::mutex g_updateGlobals
Definition pre.l:235
static std::mutex g_debugMutex
Definition pre.l:233
const char * qPrint(const char *s)
Definition qcstring.h:672
#define FALSE
Definition qcstring.h:34
EntryType guessSection(const QCString &name)
Definition util.cpp:349

References AUTO_TRACE, Config_getBool, end(), FALSE, forceEndCondSection(), g_debugMutex, g_updateGlobals, guessSection(), ImportLocalObjC, ImportSystemObjC, IncludeLocal, IncludeSystem, initPredefined(), Debug::isFlagSet(), Debug::Lex_pre, Doxygen::macroDefinitions, Debug::NoLineNo, p, Debug::Preprocessor, Debug::print(), qPrint(), setFileName(), QCString::size(), QCString::sprintf(), and warn.

Referenced by parseFile().

Member Data Documentation

◆ p

std::unique_ptr<Private> Preprocessor::p
private

Definition at line 38 of file pre.h.

Referenced by addSearchDir(), Preprocessor(), processFile(), and ~Preprocessor().


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