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 4230 of file pre.l.

4230 : p(std::make_unique<Private>())
4231{
4232 preYYlex_init_extra(&p->state,&p->yyscanner);
4233 addSearchDir(".");
4234}
void addSearchDir(const QCString &dir)
Definition pre.l:4223
std::unique_ptr< Private > p
Definition pre.h:38

References addSearchDir(), and p.

◆ ~Preprocessor()

Preprocessor::~Preprocessor ( )

Definition at line 4236 of file pre.l.

4237{
4238 preYYlex_destroy(p->yyscanner);
4239}

References p.

Member Function Documentation

◆ addSearchDir()

void Preprocessor::addSearchDir ( const QCString & dir)

Definition at line 4223 of file pre.l.

4224{
4225 YY_EXTRA_TYPE state = preYYget_extra(p->yyscanner);
4226 FileInfo fi(dir.str());
4227 if (fi.isDir()) state->pathList.push_back(fi.absFilePath());
4228}
const std::string & str() const
Definition qcstring.h:552

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 4241 of file pre.l.

4242{
4243 AUTO_TRACE("fileName={}",fileName);
4244 yyscan_t yyscanner = p->yyscanner;
4245 YY_EXTRA_TYPE state = preYYget_extra(p->yyscanner);
4246 struct yyguts_t *yyg = (struct yyguts_t*)p->yyscanner;
4247
4248#ifdef FLEX_DEBUG
4249 preYYset_debug(Debug::isFlagSet(Debug::Lex_pre)?1:0,yyscanner);
4250#endif
4251
4252 DebugLex debugLex(Debug::Lex_pre, __FILE__, qPrint(fileName));
4253 //printf("##########################\n%s\n####################\n",
4254 // qPrint(input));
4255
4256 state->macroExpansion = Config_getBool(MACRO_EXPANSION);
4257 state->expandOnlyPredef = Config_getBool(EXPAND_ONLY_PREDEF);
4258 state->skip=FALSE;
4259 state->curlyCount=0;
4260 state->lexRulesPart=false;
4261 state->nospaces=FALSE;
4262 state->inputBuf=&input;
4263 state->inputBufPos=0;
4264 state->outputBuf=&output;
4265 state->includeStack.clear();
4266 state->expandedDict.clear();
4267 state->contextDefines.clear();
4268 state->pragmaSet.clear();
4269 state->condGuardCount=0;
4270 state->condGuardErrorLine=0;
4271 while (!state->levelGuard.empty()) state->levelGuard.pop();
4272 while (!state->condStack.empty()) state->condStack.pop();
4273
4274 setFileName(yyscanner,fileName);
4275
4276 state->inputFileDef = state->yyFileDef;
4277 //yyextra->defineManager.startContext(state->fileName);
4278
4279 initPredefined(yyscanner,fileName);
4280
4281 state->yyLineNr = 1;
4282 state->yyColNr = 1;
4283 state->ifcount = 0;
4284
4285 BEGIN( Start );
4286
4287 state->expectGuard = guessSection(fileName).isHeader();
4288 state->guardName.clear();
4289 state->lastGuardName.clear();
4290 state->guardExpr.clear();
4291
4292 preYYlex(yyscanner);
4293
4294 while (!state->condStack.empty())
4295 {
4296 const std::unique_ptr<preYY_CondCtx> &ctx = state->condStack.top();
4297 QCString sectionInfo = " ";
4298 if (ctx->sectionId!=" ") sectionInfo.sprintf(" with label '%s' ",qPrint(ctx->sectionId.stripWhiteSpace()));
4299 warn(ctx->fileName,ctx->lineNr,"Conditional section{}does not have "
4300 "a corresponding \\endcond command within this file.",sectionInfo);
4301 state->condStack.pop();
4302 }
4303 // make sure we don't extend a \cond with missing \endcond over multiple files (see bug 624829)
4304 forceEndCondSection(yyscanner);
4305
4306 if (!state->levelGuard.empty())
4307 {
4308 if (yyextra->condGuardErrorLine!=0)
4309 {
4310 warn(yyextra->condGuardErrorFileName,yyextra->condGuardErrorLine,"{}",yyextra->condGuardErrorMessage);
4311 }
4312 else
4313 {
4314 warn(state->fileName,state->yyLineNr,"More #if's than #endif's found (might be in an included file).");
4315 }
4316 }
4317
4319 {
4320 std::lock_guard<std::mutex> lock(g_debugMutex);
4321 Debug::print(Debug::Preprocessor,0,"Preprocessor output of {} (size: {} bytes):\n",fileName,output.size());
4322 std::string contents;
4324 {
4325 contents=output;
4326 }
4327 else // need to add line numbers
4328 {
4329 int line=1;
4330 bool startOfLine = true;
4331 size_t content_size = output.size() +
4332 output.size()*6/40; // assuming 40 chars per line on average
4333 // and 6 chars extra for the line number
4334 contents.reserve(content_size);
4335 size_t pos=0;
4336 while (pos<output.size())
4337 {
4338 if (startOfLine)
4339 {
4340 char lineNrStr[15];
4341 snprintf(lineNrStr,15,"%05d ",line++);
4342 contents+=lineNrStr;
4343 }
4344 contents += output[pos];
4345 startOfLine = output[pos]=='\n';
4346 pos++;
4347 }
4348 }
4349 char end[2]={0,0};
4350 if (!contents.empty() && contents[contents.length()-1]!='\n')
4351 {
4352 end[0]='\n';
4353 }
4354 Debug::print(Debug::Preprocessor,0,"---------\n{}{}---------\n",contents,end);
4355 if (yyextra->contextDefines.size()>0)
4356 {
4357 Debug::print(Debug::Preprocessor,0,"Macros accessible in this file ({}):\n", fileName);
4358 Debug::print(Debug::Preprocessor,0,"---------\n");
4359 for (auto &kv : yyextra->contextDefines)
4360 {
4361 Debug::print(Debug::Preprocessor,0,"{} ",kv.second.name);
4362 }
4363 for (auto &kv : yyextra->localDefines)
4364 {
4365 Debug::print(Debug::Preprocessor,0,"{} ",kv.second.name);
4366 }
4367 Debug::print(Debug::Preprocessor,0,"\n---------\n");
4368 }
4369 else
4370 {
4371 Debug::print(Debug::Preprocessor,0,"No macros accessible in this file ({}).\n", fileName);
4372 }
4373 }
4374
4375 {
4376 std::lock_guard<std::mutex> lock(g_updateGlobals);
4377 for (const auto &inc : state->includeRelations)
4378 {
4379 auto toKind = [](bool local,bool imported) -> IncludeKind
4380 {
4381 if (local)
4382 {
4383 if (imported)
4384 {
4386 }
4388 }
4389 else if (imported)
4390 {
4392 }
4394 };
4395 if (inc->fromFileDef)
4396 {
4397 inc->fromFileDef->addIncludeDependency(inc->toFileDef,inc->includeName,toKind(inc->local,inc->imported));
4398 }
4399 if (inc->toFileDef && inc->fromFileDef)
4400 {
4401 inc->toFileDef->addIncludedByDependency(inc->fromFileDef,inc->fromFileDef->docName(),toKind(inc->local,inc->imported));
4402 }
4403 }
4404 // add the macro definition for this file to the global map
4405 Doxygen::macroDefinitions.emplace(state->fileName.str(),std::move(state->macroDefinitions));
4406 }
4407
4408 //yyextra->defineManager.endContext();
4409}
@ NoLineNo
Definition debug.h:42
@ Lex_pre
Definition debug.h:65
@ Preprocessor
Definition debug.h:30
static bool isFlagSet(const DebugMask mask)
Definition debug.cpp:133
static void print(DebugMask mask, int prio, fmt::format_string< Args... > fmt, Args &&... args)
Definition debug.h:77
static DefinesPerFileList macroDefinitions
Definition doxygen.h:135
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:48
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:4096
static void setFileName(yyscan_t yyscanner, const QCString &name)
Definition pre.l:2251
static void forceEndCondSection(yyscan_t yyscanner)
Definition pre.l:3952
static std::mutex g_updateGlobals
Definition pre.l:234
static std::mutex g_debugMutex
Definition pre.l:232
const char * qPrint(const char *s)
Definition qcstring.h:687
#define FALSE
Definition qcstring.h:34
EntryType guessSection(const QCString &name)
Definition util.cpp:338

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: